Skip to content

Add support for workflow invocations #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .fernignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
14 changes: 7 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down Expand Up @@ -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,
Expand Down
136 changes: 136 additions & 0 deletions reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
2 changes: 1 addition & 1 deletion src/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 2 additions & 0 deletions src/api/resources/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand All @@ -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";
Loading