Skip to content

Commit bda3a62

Browse files
Fix the reload props response schema (#102)
* Fix the reload props response schema * Add endpoint descriptions * Bump version --------- Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Jay Vercellone <[email protected]>
1 parent 20cffe7 commit bda3a62

File tree

21 files changed

+147
-31
lines changed

21 files changed

+147
-31
lines changed

MIGRATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -849,7 +849,7 @@ incrementally without breaking your existing codebase. To do this, you can
849849
install the new SDK with an alias:
850850

851851
```bash
852-
npm install @pipedream/sdk-v2@npm:@pipedream/sdk@^2.0.0-rc.9 --save
852+
npm install @pipedream/sdk-v2@npm:@pipedream/sdk@^2.0.0-rc.10 --save
853853
```
854854

855855
Then, in your code, you can import the new SDK with the alias:

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@pipedream/sdk",
3-
"version": "2.0.0-rc.9",
3+
"version": "2.0.0-rc.10",
44
"private": false,
55
"repository": "github:PipedreamHQ/pipedream-sdk-typescript",
66
"type": "commonjs",

src/Client.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ export class PipedreamClient {
7474
"x-pd-environment": _options?.projectEnvironment,
7575
"X-Fern-Language": "JavaScript",
7676
"X-Fern-SDK-Name": "@pipedream/sdk",
77-
"X-Fern-SDK-Version": "2.0.0-rc.9",
78-
"User-Agent": "@pipedream/sdk/2.0.0-rc.9",
77+
"X-Fern-SDK-Version": "2.0.0-rc.10",
78+
"User-Agent": "@pipedream/sdk/2.0.0-rc.10",
7979
"X-Fern-Runtime": core.RUNTIME.type,
8080
"X-Fern-Runtime-Version": core.RUNTIME.version,
8181
},

src/api/resources/accounts/client/Client.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ export class Accounts {
4646
}
4747

4848
/**
49+
* Retrieve all connected accounts for the project with optional filtering
50+
*
4951
* @param {Pipedream.AccountsListRequest} request
5052
* @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
5153
*
@@ -159,6 +161,8 @@ export class Accounts {
159161
}
160162

161163
/**
164+
* Connect a new account for an external user in the project
165+
*
162166
* @param {Pipedream.CreateAccountOpts} request
163167
* @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
164168
*
@@ -263,6 +267,8 @@ export class Accounts {
263267
}
264268

265269
/**
270+
* Get the details for a specific connected account
271+
*
266272
* @param {string} accountId
267273
* @param {Pipedream.AccountsRetrieveRequest} request
268274
* @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
@@ -352,6 +358,8 @@ export class Accounts {
352358
}
353359

354360
/**
361+
* Remove a connected account and its associated credentials
362+
*
355363
* @param {string} accountId
356364
* @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
357365
*
@@ -420,6 +428,8 @@ export class Accounts {
420428
}
421429

422430
/**
431+
* Remove all connected accounts for a specific app
432+
*
423433
* @param {string} appId
424434
* @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
425435
*

src/api/resources/actions/client/Client.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ export class Actions {
4646
}
4747

4848
/**
49+
* Retrieve available actions with optional search and app filtering
50+
*
4951
* @param {Pipedream.ActionsListRequest} request
5052
* @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
5153
*
@@ -153,6 +155,8 @@ export class Actions {
153155
}
154156

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

235239
/**
240+
* Retrieve remote options for a given prop for a action
241+
*
236242
* @param {Pipedream.ConfigurePropOpts} request
237243
* @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
238244
*
@@ -323,6 +329,8 @@ export class Actions {
323329
}
324330

325331
/**
332+
* Reload the prop definition based on the currently configured props
333+
*
326334
* @param {Pipedream.ReloadPropsOpts} request
327335
* @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
328336
*
@@ -412,6 +420,8 @@ export class Actions {
412420
}
413421

414422
/**
423+
* Execute an action with the provided configuration and return results
424+
*
415425
* @param {Pipedream.RunActionOpts} request
416426
* @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
417427
*

src/api/resources/appCategories/client/Client.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ export class AppCategories {
4646
}
4747

4848
/**
49+
* Retrieve all available categories for integrated apps
50+
*
4951
* @param {AppCategories.RequestOptions} requestOptions - Request-specific configuration.
5052
*
5153
* @example
@@ -121,6 +123,8 @@ export class AppCategories {
121123
}
122124

123125
/**
126+
* Get details of a specific app category by its ID
127+
*
124128
* @param {string} id - The ID of the app category to retrieve
125129
* @param {AppCategories.RequestOptions} requestOptions - Request-specific configuration.
126130
*

src/api/resources/apps/client/Client.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ export class Apps {
4646
}
4747

4848
/**
49+
* Retrieve all available apps with optional filtering and sorting
50+
*
4951
* @param {Pipedream.AppsListRequest} request
5052
* @param {Apps.RequestOptions} requestOptions - Request-specific configuration.
5153
*
@@ -165,6 +167,8 @@ export class Apps {
165167
}
166168

167169
/**
170+
* Get detailed information about a specific app by ID or name slug
171+
*
168172
* @param {string} appId - The name slug or ID of the app (e.g., 'slack', 'github')
169173
* @param {Apps.RequestOptions} requestOptions - Request-specific configuration.
170174
*

src/api/resources/components/client/Client.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ export class Components {
4646
}
4747

4848
/**
49+
* Retrieve available components with optional search and app filtering
50+
*
4951
* @param {Pipedream.ComponentsListRequest} request
5052
* @param {Components.RequestOptions} requestOptions - Request-specific configuration.
5153
*
@@ -153,6 +155,8 @@ export class Components {
153155
}
154156

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

235239
/**
240+
* Retrieve remote options for a given prop for a component
241+
*
236242
* @param {Pipedream.ConfigurePropOpts} request
237243
* @param {Components.RequestOptions} requestOptions - Request-specific configuration.
238244
*
@@ -323,6 +329,8 @@ export class Components {
323329
}
324330

325331
/**
332+
* Reload the prop definition based on the currently configured props
333+
*
326334
* @param {Pipedream.ReloadPropsOpts} request
327335
* @param {Components.RequestOptions} requestOptions - Request-specific configuration.
328336
*

src/api/resources/deployedTriggers/client/Client.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ export class DeployedTriggers {
4646
}
4747

4848
/**
49+
* Retrieve all deployed triggers for a specific external user
50+
*
4951
* @param {Pipedream.DeployedTriggersListRequest} request
5052
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
5153
*
@@ -150,6 +152,8 @@ export class DeployedTriggers {
150152
}
151153

152154
/**
155+
* Get details of a specific deployed trigger by its ID
156+
*
153157
* @param {string} triggerId
154158
* @param {Pipedream.DeployedTriggersRetrieveRequest} request
155159
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
@@ -238,6 +242,8 @@ export class DeployedTriggers {
238242
}
239243

240244
/**
245+
* Modify the configuration of a deployed trigger, including active status
246+
*
241247
* @param {string} triggerId
242248
* @param {Pipedream.UpdateTriggerOpts} request
243249
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
@@ -332,6 +338,8 @@ export class DeployedTriggers {
332338
}
333339

334340
/**
341+
* Remove a deployed trigger and stop receiving events
342+
*
335343
* @param {string} triggerId
336344
* @param {Pipedream.DeployedTriggersDeleteRequest} request
337345
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
@@ -415,6 +423,8 @@ export class DeployedTriggers {
415423
}
416424

417425
/**
426+
* Retrieve recent events emitted by a deployed trigger
427+
*
418428
* @param {string} triggerId
419429
* @param {Pipedream.DeployedTriggersListEventsRequest} request
420430
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
@@ -507,6 +517,8 @@ export class DeployedTriggers {
507517
}
508518

509519
/**
520+
* Get workflows connected to receive events from this trigger
521+
*
510522
* @param {string} triggerId
511523
* @param {Pipedream.DeployedTriggersListWorkflowsRequest} request
512524
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
@@ -595,6 +607,8 @@ export class DeployedTriggers {
595607
}
596608

597609
/**
610+
* Connect or disconnect workflows to receive trigger events
611+
*
598612
* @param {string} triggerId
599613
* @param {Pipedream.UpdateTriggerWorkflowsOpts} request
600614
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
@@ -690,6 +704,8 @@ export class DeployedTriggers {
690704
}
691705

692706
/**
707+
* Get webhook URLs configured to receive trigger events
708+
*
693709
* @param {string} triggerId
694710
* @param {Pipedream.DeployedTriggersListWebhooksRequest} request
695711
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.
@@ -778,6 +794,8 @@ export class DeployedTriggers {
778794
}
779795

780796
/**
797+
* Configure webhook URLs to receive trigger events
798+
*
781799
* @param {string} triggerId
782800
* @param {Pipedream.UpdateTriggerWebhooksOpts} request
783801
* @param {DeployedTriggers.RequestOptions} requestOptions - Request-specific configuration.

src/api/resources/oauthTokens/client/Client.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ export class OauthTokens {
4646
}
4747

4848
/**
49+
* Exchange OAuth credentials for an access token
50+
*
4951
* @param {Pipedream.CreateOAuthTokenOpts} request
5052
* @param {OauthTokens.RequestOptions} requestOptions - Request-specific configuration.
5153
*

0 commit comments

Comments
 (0)