Skip to content

Commit e6c8fb1

Browse files
Add types for props (#139)
* Add new types for configurable prop options, including nested values under `__lv` * Add new types for configured props, and all the possible values --------- Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Jay Vercellone <jay@pipedream.com>
1 parent 36b39d9 commit e6c8fb1

Some content is hidden

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

57 files changed

+638
-132
lines changed

MIGRATE.md

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

846846
```bash
847-
npm install @pipedream/sdk-v2@npm:@pipedream/sdk@^2.0.0-rc.11 --save
847+
npm install @pipedream/sdk-v2@npm:@pipedream/sdk@^2.0.0-rc.12 --save
848848
```
849849

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

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FPipedreamHQ%2Fpipedream-sdk-typescript)
44
[![npm shield](https://img.shields.io/npm/v/@pipedream/sdk)](https://www.npmjs.com/package/@pipedream/sdk)
55

6-
The Pipedream TypeScript library provides convenient access to the Pipedream API from TypeScript.
6+
The Pipedream TypeScript library provides convenient access to the Pipedream APIs from TypeScript.
77

88
## Installation
99

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.11",
3+
"version": "2.0.0-rc.12",
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.11",
78-
"User-Agent": "@pipedream/sdk/2.0.0-rc.11",
77+
"X-Fern-SDK-Version": "2.0.0-rc.12",
78+
"User-Agent": "@pipedream/sdk/2.0.0-rc.12",
7979
"X-Fern-Runtime": core.RUNTIME.type,
8080
"X-Fern-Runtime-Version": core.RUNTIME.version,
8181
},

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ export interface RunActionOpts {
1616
id: string;
1717
/** The external user ID */
1818
externalUserId: string;
19-
/** The configured properties for the action */
20-
configuredProps?: Record<string, unknown>;
19+
configuredProps?: Pipedream.ConfiguredProps;
2120
/** The ID for dynamic props */
2221
dynamicPropsId?: string;
2322
stashId?: Pipedream.RunActionOptsStashId;

src/api/resources/deployedTriggers/client/requests/UpdateTriggerOpts.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
* This file was auto-generated by Fern from our API Definition.
33
*/
44

5+
import * as Pipedream from "../../../../index.js";
6+
57
/**
68
* @example
79
* {
@@ -13,8 +15,7 @@ export interface UpdateTriggerOpts {
1315
externalUserId: string;
1416
/** Whether the trigger should be active */
1517
active?: boolean;
16-
/** The configured properties for the trigger */
17-
configuredProps?: Record<string, unknown>;
18+
configuredProps?: Pipedream.ConfiguredProps;
1819
/** The name of the trigger */
1920
name?: string;
2021
}

src/api/resources/triggers/client/requests/DeployTriggerOpts.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
* This file was auto-generated by Fern from our API Definition.
33
*/
44

5+
import * as Pipedream from "../../../../index.js";
6+
57
/**
68
* @example
79
* {
@@ -14,8 +16,7 @@ export interface DeployTriggerOpts {
1416
id: string;
1517
/** The external user ID */
1618
externalUserId: string;
17-
/** The configured properties for the trigger */
18-
configuredProps?: Record<string, unknown>;
19+
configuredProps?: Pipedream.ConfiguredProps;
1920
/** The ID for dynamic props */
2021
dynamicPropsId?: string;
2122
/** Optional webhook URL to receive trigger events */

src/api/types/Account.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ import * as Pipedream from "../index.js";
88
* End user account data, returned from the API.
99
*/
1010
export interface Account {
11-
/** The unique ID of the account. */
12-
id: string;
11+
id: Pipedream.AccountId;
1312
/** The custom name of the account if set. */
1413
name?: string;
1514
/** The external ID associated with the account. */

src/api/types/AccountId.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/**
2+
* This file was auto-generated by Fern from our API Definition.
3+
*/
4+
5+
/**
6+
* The unique ID of the account.
7+
*/
8+
export type AccountId = string;

src/api/types/ConfigurePropOptions.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
/**
2+
* This file was auto-generated by Fern from our API Definition.
3+
*/
4+
5+
import * as Pipedream from "../index.js";
6+
7+
/**
8+
* Available options (with labels) for the configured prop
9+
*/
10+
export type ConfigurePropOptions = Pipedream.ConfigurePropOptionsItem[] | undefined;

0 commit comments

Comments
 (0)