Skip to content

Commit d4ff05d

Browse files
fern-api[bot]jverce
fern-api[bot]
and
jverce
authored
Revisit types (#86)
* Remove `x-async-handle` logic * Unnest payload entries for action runs, and prop config/reload * Unnest query params for Connect token validation * Add missing configurable prop types and fields --------- Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Jay Vercellone <jay@pipedream.com>
1 parent 0736dbc commit d4ff05d

File tree

63 files changed

+1209
-291
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+1209
-291
lines changed

‎MIGRATE.md‎

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

837837
```bash
838-
npm install @pipedream/sdk-v2@npm:@pipedream/sdk@^2.0.0-rc.7 --save
838+
npm install @pipedream/sdk-v2@npm:@pipedream/sdk@^2.0.0-rc.8 --save
839839
```
840840

841841
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.7",
3+
"version": "2.0.0-rc.8",
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
@@ -73,8 +73,8 @@ export class PipedreamClient {
7373
"x-pd-environment": _options?.projectEnvironment,
7474
"X-Fern-Language": "JavaScript",
7575
"X-Fern-SDK-Name": "@pipedream/sdk",
76-
"X-Fern-SDK-Version": "2.0.0-rc.7",
77-
"User-Agent": "@pipedream/sdk/2.0.0-rc.7",
76+
"X-Fern-SDK-Version": "2.0.0-rc.8",
77+
"User-Agent": "@pipedream/sdk/2.0.0-rc.8",
7878
"X-Fern-Runtime": core.RUNTIME.type,
7979
"X-Fern-Runtime-Version": core.RUNTIME.version,
8080
},

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

Lines changed: 14 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -231,30 +231,27 @@ export class Actions {
231231
}
232232

233233
/**
234-
* @param {Pipedream.ActionsConfigurePropRequest} request
234+
* @param {Pipedream.ConfigurePropOpts} request
235235
* @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
236236
*
237237
* @example
238238
* await client.actions.configureProp({
239-
* body: {
240-
* id: "id",
241-
* externalUserId: "external_user_id",
242-
* propName: "prop_name"
243-
* }
239+
* id: "id",
240+
* externalUserId: "external_user_id",
241+
* propName: "prop_name"
244242
* })
245243
*/
246244
public configureProp(
247-
request: Pipedream.ActionsConfigurePropRequest,
245+
request: Pipedream.ConfigurePropOpts,
248246
requestOptions?: Actions.RequestOptions,
249247
): core.HttpResponsePromise<Pipedream.ConfigurePropResponse> {
250248
return core.HttpResponsePromise.fromPromise(this.__configureProp(request, requestOptions));
251249
}
252250

253251
private async __configureProp(
254-
request: Pipedream.ActionsConfigurePropRequest,
252+
request: Pipedream.ConfigurePropOpts,
255253
requestOptions?: Actions.RequestOptions,
256254
): Promise<core.WithRawResponse<Pipedream.ConfigurePropResponse>> {
257-
const { asyncHandle, body: _body } = request;
258255
const _response = await core.fetcher({
259256
url: core.url.join(
260257
(await core.Supplier.get(this._options.baseUrl)) ??
@@ -267,15 +264,14 @@ export class Actions {
267264
this._options?.headers,
268265
mergeOnlyDefinedHeaders({
269266
Authorization: await this._getAuthorizationHeader(),
270-
"x-async-handle": asyncHandle != null ? asyncHandle : undefined,
271267
"x-pd-environment": requestOptions?.projectEnvironment,
272268
}),
273269
requestOptions?.headers,
274270
),
275271
contentType: "application/json",
276272
queryParameters: requestOptions?.queryParams,
277273
requestType: "json",
278-
body: serializers.ConfigurePropOpts.jsonOrThrow(_body, {
274+
body: serializers.ConfigurePropOpts.jsonOrThrow(request, {
279275
unrecognizedObjectKeys: "strip",
280276
omitUndefined: true,
281277
}),
@@ -324,29 +320,26 @@ export class Actions {
324320
}
325321

326322
/**
327-
* @param {Pipedream.ActionsReloadPropsRequest} request
323+
* @param {Pipedream.ReloadPropsOpts} request
328324
* @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
329325
*
330326
* @example
331327
* await client.actions.reloadProps({
332-
* body: {
333-
* id: "id",
334-
* externalUserId: "external_user_id"
335-
* }
328+
* id: "id",
329+
* externalUserId: "external_user_id"
336330
* })
337331
*/
338332
public reloadProps(
339-
request: Pipedream.ActionsReloadPropsRequest,
333+
request: Pipedream.ReloadPropsOpts,
340334
requestOptions?: Actions.RequestOptions,
341335
): core.HttpResponsePromise<Pipedream.ReloadPropsResponse> {
342336
return core.HttpResponsePromise.fromPromise(this.__reloadProps(request, requestOptions));
343337
}
344338

345339
private async __reloadProps(
346-
request: Pipedream.ActionsReloadPropsRequest,
340+
request: Pipedream.ReloadPropsOpts,
347341
requestOptions?: Actions.RequestOptions,
348342
): Promise<core.WithRawResponse<Pipedream.ReloadPropsResponse>> {
349-
const { asyncHandle, body: _body } = request;
350343
const _response = await core.fetcher({
351344
url: core.url.join(
352345
(await core.Supplier.get(this._options.baseUrl)) ??
@@ -359,15 +352,14 @@ export class Actions {
359352
this._options?.headers,
360353
mergeOnlyDefinedHeaders({
361354
Authorization: await this._getAuthorizationHeader(),
362-
"x-async-handle": asyncHandle != null ? asyncHandle : undefined,
363355
"x-pd-environment": requestOptions?.projectEnvironment,
364356
}),
365357
requestOptions?.headers,
366358
),
367359
contentType: "application/json",
368360
queryParameters: requestOptions?.queryParams,
369361
requestType: "json",
370-
body: serializers.ReloadPropsOpts.jsonOrThrow(_body, {
362+
body: serializers.ReloadPropsOpts.jsonOrThrow(request, {
371363
unrecognizedObjectKeys: "strip",
372364
omitUndefined: true,
373365
}),
@@ -436,7 +428,6 @@ export class Actions {
436428
request: Pipedream.RunActionOpts,
437429
requestOptions?: Actions.RequestOptions,
438430
): Promise<core.WithRawResponse<Pipedream.RunActionResponse>> {
439-
const { asyncHandle, ..._body } = request;
440431
const _response = await core.fetcher({
441432
url: core.url.join(
442433
(await core.Supplier.get(this._options.baseUrl)) ??
@@ -449,15 +440,14 @@ export class Actions {
449440
this._options?.headers,
450441
mergeOnlyDefinedHeaders({
451442
Authorization: await this._getAuthorizationHeader(),
452-
"x-async-handle": asyncHandle != null ? asyncHandle : undefined,
453443
"x-pd-environment": requestOptions?.projectEnvironment,
454444
}),
455445
requestOptions?.headers,
456446
),
457447
contentType: "application/json",
458448
queryParameters: requestOptions?.queryParams,
459449
requestType: "json",
460-
body: serializers.RunActionOpts.jsonOrThrow(_body, {
450+
body: serializers.RunActionOpts.jsonOrThrow(request, {
461451
unrecognizedObjectKeys: "strip",
462452
omitUndefined: true,
463453
}),

‎src/api/resources/actions/client/requests/ActionsConfigurePropRequest.ts‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎src/api/resources/actions/client/requests/ActionsReloadPropsRequest.ts‎

Lines changed: 0 additions & 19 deletions
This file was deleted.

‎src/api/resources/actions/client/requests/RunActionOpts.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ import * as Pipedream from "../../../../index.js";
1212
* }
1313
*/
1414
export interface RunActionOpts {
15-
asyncHandle?: string;
1615
/** The action component ID */
1716
id: string;
1817
/** The external user ID */

‎src/api/resources/actions/client/requests/index.ts‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
11
export { type ActionsListRequest } from "./ActionsListRequest.js";
2-
export { type ActionsConfigurePropRequest } from "./ActionsConfigurePropRequest.js";
3-
export { type ActionsReloadPropsRequest } from "./ActionsReloadPropsRequest.js";
42
export { type RunActionOpts } from "./RunActionOpts.js";

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

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -231,30 +231,27 @@ export class Components {
231231
}
232232

233233
/**
234-
* @param {Pipedream.ComponentsConfigurePropRequest} request
234+
* @param {Pipedream.ConfigurePropOpts} request
235235
* @param {Components.RequestOptions} requestOptions - Request-specific configuration.
236236
*
237237
* @example
238238
* await client.components.configureProp({
239-
* body: {
240-
* id: "id",
241-
* externalUserId: "external_user_id",
242-
* propName: "prop_name"
243-
* }
239+
* id: "id",
240+
* externalUserId: "external_user_id",
241+
* propName: "prop_name"
244242
* })
245243
*/
246244
public configureProp(
247-
request: Pipedream.ComponentsConfigurePropRequest,
245+
request: Pipedream.ConfigurePropOpts,
248246
requestOptions?: Components.RequestOptions,
249247
): core.HttpResponsePromise<Pipedream.ConfigurePropResponse> {
250248
return core.HttpResponsePromise.fromPromise(this.__configureProp(request, requestOptions));
251249
}
252250

253251
private async __configureProp(
254-
request: Pipedream.ComponentsConfigurePropRequest,
252+
request: Pipedream.ConfigurePropOpts,
255253
requestOptions?: Components.RequestOptions,
256254
): Promise<core.WithRawResponse<Pipedream.ConfigurePropResponse>> {
257-
const { asyncHandle, body: _body } = request;
258255
const _response = await core.fetcher({
259256
url: core.url.join(
260257
(await core.Supplier.get(this._options.baseUrl)) ??
@@ -267,15 +264,14 @@ export class Components {
267264
this._options?.headers,
268265
mergeOnlyDefinedHeaders({
269266
Authorization: await this._getAuthorizationHeader(),
270-
"x-async-handle": asyncHandle != null ? asyncHandle : undefined,
271267
"x-pd-environment": requestOptions?.projectEnvironment,
272268
}),
273269
requestOptions?.headers,
274270
),
275271
contentType: "application/json",
276272
queryParameters: requestOptions?.queryParams,
277273
requestType: "json",
278-
body: serializers.ConfigurePropOpts.jsonOrThrow(_body, {
274+
body: serializers.ConfigurePropOpts.jsonOrThrow(request, {
279275
unrecognizedObjectKeys: "strip",
280276
omitUndefined: true,
281277
}),
@@ -324,29 +320,26 @@ export class Components {
324320
}
325321

326322
/**
327-
* @param {Pipedream.ComponentsReloadPropsRequest} request
323+
* @param {Pipedream.ReloadPropsOpts} request
328324
* @param {Components.RequestOptions} requestOptions - Request-specific configuration.
329325
*
330326
* @example
331327
* await client.components.reloadProps({
332-
* body: {
333-
* id: "id",
334-
* externalUserId: "external_user_id"
335-
* }
328+
* id: "id",
329+
* externalUserId: "external_user_id"
336330
* })
337331
*/
338332
public reloadProps(
339-
request: Pipedream.ComponentsReloadPropsRequest,
333+
request: Pipedream.ReloadPropsOpts,
340334
requestOptions?: Components.RequestOptions,
341335
): core.HttpResponsePromise<Pipedream.ReloadPropsResponse> {
342336
return core.HttpResponsePromise.fromPromise(this.__reloadProps(request, requestOptions));
343337
}
344338

345339
private async __reloadProps(
346-
request: Pipedream.ComponentsReloadPropsRequest,
340+
request: Pipedream.ReloadPropsOpts,
347341
requestOptions?: Components.RequestOptions,
348342
): Promise<core.WithRawResponse<Pipedream.ReloadPropsResponse>> {
349-
const { asyncHandle, body: _body } = request;
350343
const _response = await core.fetcher({
351344
url: core.url.join(
352345
(await core.Supplier.get(this._options.baseUrl)) ??
@@ -359,15 +352,14 @@ export class Components {
359352
this._options?.headers,
360353
mergeOnlyDefinedHeaders({
361354
Authorization: await this._getAuthorizationHeader(),
362-
"x-async-handle": asyncHandle != null ? asyncHandle : undefined,
363355
"x-pd-environment": requestOptions?.projectEnvironment,
364356
}),
365357
requestOptions?.headers,
366358
),
367359
contentType: "application/json",
368360
queryParameters: requestOptions?.queryParams,
369361
requestType: "json",
370-
body: serializers.ReloadPropsOpts.jsonOrThrow(_body, {
362+
body: serializers.ReloadPropsOpts.jsonOrThrow(request, {
371363
unrecognizedObjectKeys: "strip",
372364
omitUndefined: true,
373365
}),

‎src/api/resources/components/client/requests/ComponentsConfigurePropRequest.ts‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)