Skip to content
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
2 changes: 1 addition & 1 deletion MIGRATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -849,7 +849,7 @@ incrementally without breaking your existing codebase. To do this, you can
install the new SDK with an alias:

```bash
npm install @pipedream/sdk-v2@npm:@pipedream/sdk@^2.0.0-rc.9 --save
npm install @pipedream/sdk-v2@npm:@pipedream/sdk@^2.0.0-rc.10 --save
```

Then, in your code, you can import the new SDK with the alias:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@pipedream/sdk",
"version": "2.0.0-rc.9",
"version": "2.0.0-rc.10",
"private": false,
"repository": "github:PipedreamHQ/pipedream-sdk-typescript",
"type": "commonjs",
Expand Down
4 changes: 2 additions & 2 deletions src/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ export class PipedreamClient {
"x-pd-environment": _options?.projectEnvironment,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@pipedream/sdk",
"X-Fern-SDK-Version": "2.0.0-rc.9",
"User-Agent": "@pipedream/sdk/2.0.0-rc.9",
"X-Fern-SDK-Version": "2.0.0-rc.10",
"User-Agent": "@pipedream/sdk/2.0.0-rc.10",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
},
Expand Down
10 changes: 10 additions & 0 deletions src/api/resources/accounts/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ export class Accounts {
}

/**
* Retrieve all connected accounts for the project with optional filtering
*
* @param {Pipedream.AccountsListRequest} request
* @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -159,6 +161,8 @@ export class Accounts {
}

/**
* Connect a new account for an external user in the project
*
* @param {Pipedream.CreateAccountOpts} request
* @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -263,6 +267,8 @@ export class Accounts {
}

/**
* Get the details for a specific connected account
*
* @param {string} accountId
* @param {Pipedream.AccountsRetrieveRequest} request
* @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
Expand Down Expand Up @@ -352,6 +358,8 @@ export class Accounts {
}

/**
* Remove a connected account and its associated credentials
*
* @param {string} accountId
* @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -420,6 +428,8 @@ export class Accounts {
}

/**
* Remove all connected accounts for a specific app
*
* @param {string} appId
* @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down
10 changes: 10 additions & 0 deletions src/api/resources/actions/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ export class Actions {
}

/**
* Retrieve available actions with optional search and app filtering
*
* @param {Pipedream.ActionsListRequest} request
* @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -153,6 +155,8 @@ export class Actions {
}

/**
* Get detailed configuration for a specific action by its key
*
* @param {string} componentId - The key that uniquely identifies the component (e.g., 'slack-send-message')
* @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -233,6 +237,8 @@ export class Actions {
}

/**
* Retrieve remote options for a given prop for a action
*
* @param {Pipedream.ConfigurePropOpts} request
* @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -323,6 +329,8 @@ export class Actions {
}

/**
* Reload the prop definition based on the currently configured props
*
* @param {Pipedream.ReloadPropsOpts} request
* @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -412,6 +420,8 @@ export class Actions {
}

/**
* Execute an action with the provided configuration and return results
*
* @param {Pipedream.RunActionOpts} request
* @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down
4 changes: 4 additions & 0 deletions src/api/resources/appCategories/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ export class AppCategories {
}

/**
* Retrieve all available categories for integrated apps
*
* @param {AppCategories.RequestOptions} requestOptions - Request-specific configuration.
*
* @example
Expand Down Expand Up @@ -121,6 +123,8 @@ export class AppCategories {
}

/**
* Get details of a specific app category by its ID
*
* @param {string} id - The ID of the app category to retrieve
* @param {AppCategories.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down
4 changes: 4 additions & 0 deletions src/api/resources/apps/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ export class Apps {
}

/**
* Retrieve all available apps with optional filtering and sorting
*
* @param {Pipedream.AppsListRequest} request
* @param {Apps.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -165,6 +167,8 @@ export class Apps {
}

/**
* Get detailed information about a specific app by ID or name slug
*
* @param {string} appId - The name slug or ID of the app (e.g., 'slack', 'github')
* @param {Apps.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down
8 changes: 8 additions & 0 deletions src/api/resources/components/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ export class Components {
}

/**
* Retrieve available components with optional search and app filtering
*
* @param {Pipedream.ComponentsListRequest} request
* @param {Components.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -153,6 +155,8 @@ export class Components {
}

/**
* Get detailed configuration for a specific component by its key
*
* @param {string} componentId - The key that uniquely identifies the component (e.g., 'slack-send-message')
* @param {Components.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -233,6 +237,8 @@ export class Components {
}

/**
* Retrieve remote options for a given prop for a component
*
* @param {Pipedream.ConfigurePropOpts} request
* @param {Components.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -323,6 +329,8 @@ export class Components {
}

/**
* Reload the prop definition based on the currently configured props
*
* @param {Pipedream.ReloadPropsOpts} request
* @param {Components.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down
18 changes: 18 additions & 0 deletions src/api/resources/deployedTriggers/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ export class DeployedTriggers {
}

/**
* Retrieve all deployed triggers for a specific external user
*
* @param {Pipedream.DeployedTriggersListRequest} request
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -150,6 +152,8 @@ export class DeployedTriggers {
}

/**
* Get details of a specific deployed trigger by its ID
*
* @param {string} triggerId
* @param {Pipedream.DeployedTriggersRetrieveRequest} request
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
Expand Down Expand Up @@ -238,6 +242,8 @@ export class DeployedTriggers {
}

/**
* Modify the configuration of a deployed trigger, including active status
*
* @param {string} triggerId
* @param {Pipedream.UpdateTriggerOpts} request
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
Expand Down Expand Up @@ -332,6 +338,8 @@ export class DeployedTriggers {
}

/**
* Remove a deployed trigger and stop receiving events
*
* @param {string} triggerId
* @param {Pipedream.DeployedTriggersDeleteRequest} request
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
Expand Down Expand Up @@ -415,6 +423,8 @@ export class DeployedTriggers {
}

/**
* Retrieve recent events emitted by a deployed trigger
*
* @param {string} triggerId
* @param {Pipedream.DeployedTriggersListEventsRequest} request
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
Expand Down Expand Up @@ -507,6 +517,8 @@ export class DeployedTriggers {
}

/**
* Get workflows connected to receive events from this trigger
*
* @param {string} triggerId
* @param {Pipedream.DeployedTriggersListWorkflowsRequest} request
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
Expand Down Expand Up @@ -595,6 +607,8 @@ export class DeployedTriggers {
}

/**
* Connect or disconnect workflows to receive trigger events
*
* @param {string} triggerId
* @param {Pipedream.UpdateTriggerWorkflowsOpts} request
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
Expand Down Expand Up @@ -690,6 +704,8 @@ export class DeployedTriggers {
}

/**
* Get webhook URLs configured to receive trigger events
*
* @param {string} triggerId
* @param {Pipedream.DeployedTriggersListWebhooksRequest} request
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
Expand Down Expand Up @@ -778,6 +794,8 @@ export class DeployedTriggers {
}

/**
* Configure webhook URLs to receive trigger events
*
* @param {string} triggerId
* @param {Pipedream.UpdateTriggerWebhooksOpts} request
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
Expand Down
2 changes: 2 additions & 0 deletions src/api/resources/oauthTokens/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ export class OauthTokens {
}

/**
* Exchange OAuth credentials for an access token
*
* @param {Pipedream.CreateOAuthTokenOpts} request
* @param {OauthTokens.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down
2 changes: 2 additions & 0 deletions src/api/resources/projects/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ export class Projects {
}

/**
* Retrieve project configuration and environment details
*
* @param {Projects.RequestOptions} requestOptions - Request-specific configuration.
*
* @example
Expand Down
4 changes: 4 additions & 0 deletions src/api/resources/tokens/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ export class Tokens {
}

/**
* Generate a Connect token to use for client-side authentication
*
* @param {Pipedream.CreateTokenOpts} request
* @param {Tokens.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -134,6 +136,8 @@ export class Tokens {
}

/**
* Confirm the validity of a Connect token
*
* @param {Pipedream.ConnectToken} ctok
* @param {Pipedream.TokensValidateRequest} request
* @param {Tokens.RequestOptions} requestOptions - Request-specific configuration.
Expand Down
10 changes: 10 additions & 0 deletions src/api/resources/triggers/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ export class Triggers {
}

/**
* Retrieve available triggers with optional search and app filtering
*
* @param {Pipedream.TriggersListRequest} request
* @param {Triggers.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -153,6 +155,8 @@ export class Triggers {
}

/**
* Get detailed configuration for a specific trigger by its key
*
* @param {string} componentId - The key that uniquely identifies the component (e.g., 'slack-send-message')
* @param {Triggers.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -233,6 +237,8 @@ export class Triggers {
}

/**
* Retrieve remote options for a given prop for a trigger
*
* @param {Pipedream.ConfigurePropOpts} request
* @param {Triggers.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -323,6 +329,8 @@ export class Triggers {
}

/**
* Reload the prop definition based on the currently configured props
*
* @param {Pipedream.ReloadPropsOpts} request
* @param {Triggers.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -412,6 +420,8 @@ export class Triggers {
}

/**
* Deploy a trigger to listen for and emit events
*
* @param {Pipedream.DeployTriggerOpts} request
* @param {Triggers.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down
2 changes: 2 additions & 0 deletions src/api/resources/users/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ export class Users {
}

/**
* Remove an external user and all their associated accounts and resources
*
* @param {string} externalUserId
* @param {Users.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down
15 changes: 15 additions & 0 deletions src/api/types/DynamicProps.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
/**
* This file was auto-generated by Fern from our API Definition.
*/

import * as Pipedream from "../index.js";

/**
* Dynamic properties of a saved component
*/
export interface DynamicProps {
/** The unique ID of the dynamic prop */
id?: string;
/** The updated configurable properties */
configurableProps?: Pipedream.ConfigurableProp[];
}
7 changes: 5 additions & 2 deletions src/api/types/ReloadPropsResponse.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ import * as Pipedream from "../index.js";
* Response from reloading component props
*/
export interface ReloadPropsResponse {
/** The updated configurable properties */
configurableProps?: Pipedream.ConfigurableProp[];
/** Any logs produced during the configuration of the prop */
observations?: Record<string, unknown>;
/** Any errors that occurred during configuration */
errors?: string[];
dynamicProps?: Pipedream.DynamicProps;
}
1 change: 1 addition & 0 deletions src/api/types/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ export * from "./ConnectToken.js";
export * from "./CreateOAuthTokenResponse.js";
export * from "./CreateTokenResponse.js";
export * from "./DeleteTriggerOpts.js";
export * from "./DynamicProps.js";
export * from "./HTTPAuthType.js";
export * from "./DeployedComponent.js";
export * from "./DeployTriggerResponse.js";
Expand Down
Loading