Add support for workflow invocations (#56)

* Add `workflows` namespace that contains the "invoke" and "invoke for
external user" cases already present in the v1 SDK
* Document the new functionality in the reference doc
* Bump major version (release candidate)

Author: jverce

.fernignore

@@ -5,6 +5,9 @@
 .prettierrc.yml
 LICENSE
 
+src/api/resources/index.ts
 src/api/resources/proxy/client/*
+src/api/resources/workflows/client/*
+src/api/types/index.ts
 src/index.ts
 src/wrapper

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pipedream/sdk",
-    "version": "2.0.0",
+    "version": "2.0.0-rc.1",
     "private": false,
     "repository": "github:PipedreamHQ/pipedream-sdk-typescript",
     "type": "commonjs",
@@ -39,17 +39,17 @@
         "test:wire": "jest --selectProjects wire"
     },
     "devDependencies": {
-        "webpack": "^5.97.1",
-        "ts-loader": "^9.5.1",
-        "jest": "^29.7.0",
         "@jest/globals": "^29.7.0",
         "@types/jest": "^29.5.14",
-        "ts-jest": "^29.3.4",
+        "@types/node": "^18.19.70",
+        "jest": "^29.7.0",
         "jest-environment-jsdom": "^29.7.0",
         "msw": "^2.8.4",
-        "@types/node": "^18.19.70",
         "prettier": "^3.4.2",
-        "typescript": "~5.7.2"
+        "ts-jest": "^29.3.4",
+        "ts-loader": "^9.5.1",
+        "typescript": "~5.7.2",
+        "webpack": "^5.97.1"
     },
     "browser": {
         "fs": false,

reference.md

@@ -2291,3 +2291,139 @@ await client.oauthTokens.create({
 </dd>
 </dl>
 </details>
+
+## Workflows
+
+<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">invoke</a>({ ...params }, authType?) -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+// Invoke with URL
+await client.workflows.invoke({
+    urlOrEndpoint: "https://en-your-endpoint.m.pipedream.net",
+    body: {
+        foo: 123,
+        bar: "abc",
+        baz: null,
+    },
+    headers: {
+        Accept: "application/json",
+    },
+});
+
+// Invoke with endpoint ID
+await client.workflows.invoke({
+    urlOrEndpoint: "en123",
+    body: {
+        message: "Hello, World\!",
+    },
+}, Pipedream.HTTPAuthType.OAuth);
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pipedream.InvokeWorkflowOpts`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**authType:** `Pipedream.HTTPAuthType` — The type of authorization to use for the request (defaults to None)
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Workflows.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">invokeForExternalUser</a>({ ...params }) -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.workflows.invokeForExternalUser({
+    urlOrEndpoint: "https://your-workflow-url.m.pipedream.net",
+    externalUserId: "your-external-user-id",
+    body: {
+        foo: 123,
+        bar: "abc",
+        baz: null,
+    },
+    headers: {
+        Accept: "application/json",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pipedream.InvokeWorkflowForExternalUserOpts`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Workflows.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>

src/Client.ts

@@ -51,7 +51,7 @@ export declare namespace PipedreamClient {
 
 export class PipedreamClient {
     protected readonly _options: PipedreamClient.Options;
-    private readonly _oauthTokenProvider: core.OAuthTokenProvider;
+    protected readonly _oauthTokenProvider: core.OAuthTokenProvider;
     protected _appCategories: AppCategories | undefined;
     protected _apps: Apps | undefined;
     protected _accounts: Accounts | undefined;

src/api/resources/index.ts

@@ -11,6 +11,7 @@ export * as projects from "./projects/index.js";
 export * as proxy from "./proxy/index.js";
 export * as tokens from "./tokens/index.js";
 export * as oauthTokens from "./oauthTokens/index.js";
+export * as workflows from "./workflows/index.js";
 export * from "./apps/client/requests/index.js";
 export * from "./accounts/client/requests/index.js";
 export * from "./components/client/requests/index.js";
@@ -20,3 +21,4 @@ export * from "./deployedTriggers/client/requests/index.js";
 export * from "./proxy/client/requests/index.js";
 export * from "./tokens/client/requests/index.js";
 export * from "./oauthTokens/client/requests/index.js";
+export * from "./workflows/client/requests/index.js";