Skip to content

🌿 Fern Regeneration -- July 25, 2025 #53

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 3 commits into from
Jul 25, 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
2 changes: 1 addition & 1 deletion .fernignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
.prettierrc.yml
LICENSE

src/api/resources/proxy/client/Client.ts
src/api/resources/proxy/client/*
src/index.ts
src/wrapper
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ const client = new PipedreamClient({
clientId: "YOUR_CLIENT_ID",
clientSecret: "YOUR_CLIENT_SECRET",
projectEnvironment: "YOUR_PROJECT_ENVIRONMENT",
projectId: "YOUR_PROJECT_ID",
});
await client.accounts.create({
app_slug: "app_slug",
Expand Down Expand Up @@ -78,6 +79,7 @@ const client = new PipedreamClient({
clientId: "YOUR_CLIENT_ID",
clientSecret: "YOUR_CLIENT_SECRET",
projectEnvironment: "YOUR_PROJECT_ENVIRONMENT",
projectId: "YOUR_PROJECT_ID",
});
const response = await client.apps.list();
for await (const item of response) {
Expand Down Expand Up @@ -105,6 +107,18 @@ const response = await client.accounts.create(..., {
});
```

### Additional Query String Parameters

If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.

```typescript
const response = await client.accounts.create(..., {
queryParams: {
'customQueryParamKey': 'custom query param value'
}
});
```

### Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
Expand Down Expand Up @@ -161,8 +175,7 @@ console.log(rawResponse.headers['X-My-Header']);

### Runtime Compatibility

The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
runtimes:
The SDK works in the following runtimes:

- Node.js 18+
- Vercel
Expand Down
5 changes: 2 additions & 3 deletions reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ await client.accounts.create({
<dl>
<dd>

**request:** `Pipedream.CreateAccountRequest`
**request:** `Pipedream.CreateAccountOpts`

</dd>
</dl>
Expand Down Expand Up @@ -2148,7 +2148,6 @@ await client.proxy.patch("url_64", {
```typescript
await client.tokens.create({
external_user_id: "external_user_id",
project_id: "project_id",
});
```

Expand All @@ -2165,7 +2164,7 @@ await client.tokens.create({
<dl>
<dd>

**request:** `Pipedream.CreateTokenRequest`
**request:** `Pipedream.CreateTokenOpts`

</dd>
</dl>
Expand Down
2 changes: 2 additions & 0 deletions src/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ export declare namespace PipedreamClient {
abortSignal?: AbortSignal;
/** Override the x-pd-environment header */
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
/** Additional query string parameters to include in the request. */
queryParams?: Record<string, unknown>;
/** Additional headers to include in the request. */
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
}
Expand Down
16 changes: 10 additions & 6 deletions src/api/resources/accounts/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ export declare namespace Accounts {
abortSignal?: AbortSignal;
/** Override the x-pd-environment header */
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
/** Additional query string parameters to include in the request. */
queryParams?: Record<string, unknown>;
/** Additional headers to include in the request. */
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
}
Expand Down Expand Up @@ -104,7 +106,7 @@ export class Accounts {
}),
requestOptions?.headers,
),
queryParameters: _queryParams,
queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
timeoutMs:
requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
Expand Down Expand Up @@ -157,7 +159,7 @@ export class Accounts {
}

/**
* @param {Pipedream.CreateAccountRequest} request
* @param {Pipedream.CreateAccountOpts} request
* @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
*
* @example
Expand All @@ -168,14 +170,14 @@ export class Accounts {
* })
*/
public create(
request: Pipedream.CreateAccountRequest,
request: Pipedream.CreateAccountOpts,
requestOptions?: Accounts.RequestOptions,
): core.HttpResponsePromise<Pipedream.Account> {
return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
}

private async __create(
request: Pipedream.CreateAccountRequest,
request: Pipedream.CreateAccountOpts,
requestOptions?: Accounts.RequestOptions,
): Promise<core.WithRawResponse<Pipedream.Account>> {
const { app_id: appId, external_user_id: externalUserId, oauth_app_id: oauthAppId, ..._body } = request;
Expand Down Expand Up @@ -209,7 +211,7 @@ export class Accounts {
requestOptions?.headers,
),
contentType: "application/json",
queryParameters: _queryParams,
queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
requestType: "json",
body: _body,
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
Expand Down Expand Up @@ -290,7 +292,7 @@ export class Accounts {
}),
requestOptions?.headers,
),
queryParameters: _queryParams,
queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
abortSignal: requestOptions?.abortSignal,
Expand Down Expand Up @@ -357,6 +359,7 @@ export class Accounts {
}),
requestOptions?.headers,
),
queryParameters: requestOptions?.queryParams,
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
abortSignal: requestOptions?.abortSignal,
Expand Down Expand Up @@ -423,6 +426,7 @@ export class Accounts {
}),
requestOptions?.headers,
),
queryParameters: requestOptions?.queryParams,
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
abortSignal: requestOptions?.abortSignal,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
* connect_token: "connect_token"
* }
*/
export interface CreateAccountRequest {
export interface CreateAccountOpts {
/**
* The app slug or ID to filter accounts by.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/api/resources/accounts/client/requests/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
export { type AccountsListRequest } from "./AccountsListRequest.js";
export { type CreateAccountRequest } from "./CreateAccountRequest.js";
export { type CreateAccountOpts } from "./CreateAccountOpts.js";
export { type AccountsRetrieveRequest } from "./AccountsRetrieveRequest.js";
8 changes: 7 additions & 1 deletion src/api/resources/actions/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ export declare namespace Actions {
abortSignal?: AbortSignal;
/** Override the x-pd-environment header */
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
/** Additional query string parameters to include in the request. */
queryParams?: Record<string, unknown>;
/** Additional headers to include in the request. */
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
}
Expand Down Expand Up @@ -90,7 +92,7 @@ export class Actions {
}),
requestOptions?.headers,
),
queryParameters: _queryParams,
queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
timeoutMs:
requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
Expand Down Expand Up @@ -176,6 +178,7 @@ export class Actions {
}),
requestOptions?.headers,
),
queryParameters: requestOptions?.queryParams,
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
abortSignal: requestOptions?.abortSignal,
Expand Down Expand Up @@ -254,6 +257,7 @@ export class Actions {
requestOptions?.headers,
),
contentType: "application/json",
queryParameters: requestOptions?.queryParams,
requestType: "json",
body: _body,
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
Expand Down Expand Up @@ -333,6 +337,7 @@ export class Actions {
requestOptions?.headers,
),
contentType: "application/json",
queryParameters: requestOptions?.queryParams,
requestType: "json",
body: _body,
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
Expand Down Expand Up @@ -410,6 +415,7 @@ export class Actions {
requestOptions?.headers,
),
contentType: "application/json",
queryParameters: requestOptions?.queryParams,
requestType: "json",
body: _body,
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
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 @@ -30,6 +30,8 @@ export declare namespace AppCategories {
abortSignal?: AbortSignal;
/** Override the x-pd-environment header */
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
/** Additional query string parameters to include in the request. */
queryParams?: Record<string, unknown>;
/** Additional headers to include in the request. */
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
}
Expand Down Expand Up @@ -73,6 +75,7 @@ export class AppCategories {
}),
requestOptions?.headers,
),
queryParameters: requestOptions?.queryParams,
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
abortSignal: requestOptions?.abortSignal,
Expand Down Expand Up @@ -140,6 +143,7 @@ export class AppCategories {
}),
requestOptions?.headers,
),
queryParameters: requestOptions?.queryParams,
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
abortSignal: requestOptions?.abortSignal,
Expand Down
5 changes: 4 additions & 1 deletion src/api/resources/apps/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ export declare namespace Apps {
abortSignal?: AbortSignal;
/** Override the x-pd-environment header */
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
/** Additional query string parameters to include in the request. */
queryParams?: Record<string, unknown>;
/** Additional headers to include in the request. */
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
}
Expand Down Expand Up @@ -106,7 +108,7 @@ export class Apps {
}),
requestOptions?.headers,
),
queryParameters: _queryParams,
queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
timeoutMs:
requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
Expand Down Expand Up @@ -187,6 +189,7 @@ export class Apps {
}),
requestOptions?.headers,
),
queryParameters: requestOptions?.queryParams,
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
abortSignal: requestOptions?.abortSignal,
Expand Down
7 changes: 6 additions & 1 deletion src/api/resources/components/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ export declare namespace Components {
abortSignal?: AbortSignal;
/** Override the x-pd-environment header */
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
/** Additional query string parameters to include in the request. */
queryParams?: Record<string, unknown>;
/** Additional headers to include in the request. */
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
}
Expand Down Expand Up @@ -90,7 +92,7 @@ export class Components {
}),
requestOptions?.headers,
),
queryParameters: _queryParams,
queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
timeoutMs:
requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
Expand Down Expand Up @@ -176,6 +178,7 @@ export class Components {
}),
requestOptions?.headers,
),
queryParameters: requestOptions?.queryParams,
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
abortSignal: requestOptions?.abortSignal,
Expand Down Expand Up @@ -254,6 +257,7 @@ export class Components {
requestOptions?.headers,
),
contentType: "application/json",
queryParameters: requestOptions?.queryParams,
requestType: "json",
body: _body,
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
Expand Down Expand Up @@ -333,6 +337,7 @@ export class Components {
requestOptions?.headers,
),
contentType: "application/json",
queryParameters: requestOptions?.queryParams,
requestType: "json",
body: _body,
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
Expand Down
Loading