Skip to content

Commit acc9221

Browse files
fern-api[bot]jverce
fern-api[bot]
and
jverce
authored
Update custom client to the new args (#33)
Renamed the environment arguments to match the Fern naming convention. --------- Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Jay Vercellone <jay@pipedream.com>
1 parent 57a06de commit acc9221

File tree

29 files changed

+251
-166
lines changed

29 files changed

+251
-166
lines changed

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import { PipedreamClient } from "@pipedream/sdk";
2525
const client = new PipedreamClient({
2626
clientId: "YOUR_CLIENT_ID",
2727
clientSecret: "YOUR_CLIENT_SECRET",
28-
xPdEnvironment: "YOUR_X_PD_ENVIRONMENT",
28+
projectEnvironment: "YOUR_PROJECT_ENVIRONMENT",
2929
});
3030
await client.accounts.create({
3131
app_slug: "app_slug",
@@ -77,15 +77,15 @@ import { PipedreamClient } from "@pipedream/sdk";
7777
const client = new PipedreamClient({
7878
clientId: "YOUR_CLIENT_ID",
7979
clientSecret: "YOUR_CLIENT_SECRET",
80-
xPdEnvironment: "YOUR_X_PD_ENVIRONMENT",
80+
projectEnvironment: "YOUR_PROJECT_ENVIRONMENT",
8181
});
8282
const response = await client.apps.list();
8383
for await (const item of response) {
8484
console.log(item);
8585
}
8686

8787
// Or you can manually iterate page-by-page
88-
const page = await client.apps.list();
88+
let page = await client.apps.list();
8989
while (page.hasNextPage()) {
9090
page = page.getNextPage();
9191
}

‎package.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,17 @@
3939
"test:wire": "jest --selectProjects wire"
4040
},
4141
"devDependencies": {
42+
"webpack": "^5.97.1",
43+
"ts-loader": "^9.5.1",
44+
"jest": "^29.7.0",
4245
"@jest/globals": "^29.7.0",
4346
"@types/jest": "^29.5.14",
44-
"@types/node": "^18.19.70",
45-
"jest": "^29.7.0",
47+
"ts-jest": "^29.3.4",
4648
"jest-environment-jsdom": "^29.7.0",
4749
"msw": "^2.8.4",
50+
"@types/node": "^18.19.70",
4851
"prettier": "^3.4.2",
49-
"ts-jest": "^29.3.4",
50-
"ts-loader": "^9.5.1",
51-
"typescript": "~5.7.2",
52-
"webpack": "^5.97.1"
52+
"typescript": "~5.7.2"
5353
},
5454
"browser": {
5555
"fs": false,

‎reference.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ for await (const item of response) {
111111
}
112112

113113
// Or you can manually iterate page-by-page
114-
const page = await client.apps.list();
114+
let page = await client.apps.list();
115115
while (page.hasNextPage()) {
116116
page = page.getNextPage();
117117
}
@@ -218,7 +218,7 @@ for await (const item of response) {
218218
}
219219

220220
// Or you can manually iterate page-by-page
221-
const page = await client.accounts.list();
221+
let page = await client.accounts.list();
222222
while (page.hasNextPage()) {
223223
page = page.getNextPage();
224224
}
@@ -531,7 +531,7 @@ for await (const item of response) {
531531
}
532532

533533
// Or you can manually iterate page-by-page
534-
const page = await client.components.list();
534+
let page = await client.components.list();
535535
while (page.hasNextPage()) {
536536
page = page.getNextPage();
537537
}
@@ -745,7 +745,7 @@ for await (const item of response) {
745745
}
746746

747747
// Or you can manually iterate page-by-page
748-
const page = await client.actions.list();
748+
let page = await client.actions.list();
749749
while (page.hasNextPage()) {
750750
page = page.getNextPage();
751751
}
@@ -1010,7 +1010,7 @@ for await (const item of response) {
10101010
}
10111011

10121012
// Or you can manually iterate page-by-page
1013-
const page = await client.triggers.list();
1013+
let page = await client.triggers.list();
10141014
while (page.hasNextPage()) {
10151015
page = page.getNextPage();
10161016
}
@@ -1277,7 +1277,7 @@ for await (const item of response) {
12771277
}
12781278

12791279
// Or you can manually iterate page-by-page
1280-
const page = await client.deployedTriggers.list({
1280+
let page = await client.deployedTriggers.list({
12811281
external_user_id: "external_user_id",
12821282
});
12831283
while (page.hasNextPage()) {

‎src/Client.ts‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
import * as environments from "./environments.js";
66
import * as core from "./core/index.js";
7+
import * as Pipedream from "./api/index.js";
78
import { OauthTokens } from "./api/resources/oauthTokens/client/Client.js";
89
import { mergeHeaders } from "./core/headers.js";
910
import { AppCategories } from "./api/resources/appCategories/client/Client.js";
@@ -27,7 +28,7 @@ export declare namespace PipedreamClient {
2728
clientSecret?: core.Supplier<string>;
2829
projectId: string;
2930
/** Override the x-pd-environment header */
30-
xPdEnvironment?: core.Supplier<string | undefined>;
31+
projectEnvironment?: core.Supplier<Pipedream.ProjectEnvironment | undefined>;
3132
/** Additional headers to include in requests. */
3233
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
3334
}
@@ -40,7 +41,7 @@ export declare namespace PipedreamClient {
4041
/** A hook to abort the request. */
4142
abortSignal?: AbortSignal;
4243
/** Override the x-pd-environment header */
43-
xPdEnvironment?: string | undefined;
44+
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
4445
/** Additional headers to include in the request. */
4546
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
4647
}
@@ -67,7 +68,7 @@ export class PipedreamClient {
6768
..._options,
6869
headers: mergeHeaders(
6970
{
70-
"x-pd-environment": _options?.xPdEnvironment,
71+
"x-pd-environment": _options?.projectEnvironment,
7172
"X-Fern-Language": "JavaScript",
7273
"X-Fern-SDK-Name": "@pipedream/sdk",
7374
"X-Fern-SDK-Version": "1.7.1",

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export declare namespace Accounts {
1616
projectId: string;
1717
token?: core.Supplier<core.BearerToken | undefined>;
1818
/** Override the x-pd-environment header */
19-
xPdEnvironment?: core.Supplier<string | undefined>;
19+
projectEnvironment?: core.Supplier<Pipedream.ProjectEnvironment | undefined>;
2020
/** Additional headers to include in requests. */
2121
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
2222
}
@@ -29,7 +29,7 @@ export declare namespace Accounts {
2929
/** A hook to abort the request. */
3030
abortSignal?: AbortSignal;
3131
/** Override the x-pd-environment header */
32-
xPdEnvironment?: string | undefined;
32+
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
3333
/** Additional headers to include in the request. */
3434
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
3535
}
@@ -100,7 +100,7 @@ export class Accounts {
100100
this._options?.headers,
101101
mergeOnlyDefinedHeaders({
102102
Authorization: await this._getAuthorizationHeader(),
103-
"x-pd-environment": requestOptions?.xPdEnvironment,
103+
"x-pd-environment": requestOptions?.projectEnvironment,
104104
}),
105105
requestOptions?.headers,
106106
),
@@ -204,7 +204,7 @@ export class Accounts {
204204
this._options?.headers,
205205
mergeOnlyDefinedHeaders({
206206
Authorization: await this._getAuthorizationHeader(),
207-
"x-pd-environment": requestOptions?.xPdEnvironment,
207+
"x-pd-environment": requestOptions?.projectEnvironment,
208208
}),
209209
requestOptions?.headers,
210210
),
@@ -286,7 +286,7 @@ export class Accounts {
286286
this._options?.headers,
287287
mergeOnlyDefinedHeaders({
288288
Authorization: await this._getAuthorizationHeader(),
289-
"x-pd-environment": requestOptions?.xPdEnvironment,
289+
"x-pd-environment": requestOptions?.projectEnvironment,
290290
}),
291291
requestOptions?.headers,
292292
),
@@ -353,7 +353,7 @@ export class Accounts {
353353
this._options?.headers,
354354
mergeOnlyDefinedHeaders({
355355
Authorization: await this._getAuthorizationHeader(),
356-
"x-pd-environment": requestOptions?.xPdEnvironment,
356+
"x-pd-environment": requestOptions?.projectEnvironment,
357357
}),
358358
requestOptions?.headers,
359359
),
@@ -419,7 +419,7 @@ export class Accounts {
419419
this._options?.headers,
420420
mergeOnlyDefinedHeaders({
421421
Authorization: await this._getAuthorizationHeader(),
422-
"x-pd-environment": requestOptions?.xPdEnvironment,
422+
"x-pd-environment": requestOptions?.projectEnvironment,
423423
}),
424424
requestOptions?.headers,
425425
),

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export declare namespace Actions {
1616
projectId: string;
1717
token?: core.Supplier<core.BearerToken | undefined>;
1818
/** Override the x-pd-environment header */
19-
xPdEnvironment?: core.Supplier<string | undefined>;
19+
projectEnvironment?: core.Supplier<Pipedream.ProjectEnvironment | undefined>;
2020
/** Additional headers to include in requests. */
2121
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
2222
}
@@ -29,7 +29,7 @@ export declare namespace Actions {
2929
/** A hook to abort the request. */
3030
abortSignal?: AbortSignal;
3131
/** Override the x-pd-environment header */
32-
xPdEnvironment?: string | undefined;
32+
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
3333
/** Additional headers to include in the request. */
3434
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
3535
}
@@ -86,7 +86,7 @@ export class Actions {
8686
this._options?.headers,
8787
mergeOnlyDefinedHeaders({
8888
Authorization: await this._getAuthorizationHeader(),
89-
"x-pd-environment": requestOptions?.xPdEnvironment,
89+
"x-pd-environment": requestOptions?.projectEnvironment,
9090
}),
9191
requestOptions?.headers,
9292
),
@@ -172,7 +172,7 @@ export class Actions {
172172
this._options?.headers,
173173
mergeOnlyDefinedHeaders({
174174
Authorization: await this._getAuthorizationHeader(),
175-
"x-pd-environment": requestOptions?.xPdEnvironment,
175+
"x-pd-environment": requestOptions?.projectEnvironment,
176176
}),
177177
requestOptions?.headers,
178178
),
@@ -249,7 +249,7 @@ export class Actions {
249249
mergeOnlyDefinedHeaders({
250250
Authorization: await this._getAuthorizationHeader(),
251251
"x-async-handle": asyncHandle != null ? asyncHandle : undefined,
252-
"x-pd-environment": requestOptions?.xPdEnvironment,
252+
"x-pd-environment": requestOptions?.projectEnvironment,
253253
}),
254254
requestOptions?.headers,
255255
),
@@ -328,7 +328,7 @@ export class Actions {
328328
mergeOnlyDefinedHeaders({
329329
Authorization: await this._getAuthorizationHeader(),
330330
"x-async-handle": asyncHandle != null ? asyncHandle : undefined,
331-
"x-pd-environment": requestOptions?.xPdEnvironment,
331+
"x-pd-environment": requestOptions?.projectEnvironment,
332332
}),
333333
requestOptions?.headers,
334334
),
@@ -405,7 +405,7 @@ export class Actions {
405405
mergeOnlyDefinedHeaders({
406406
Authorization: await this._getAuthorizationHeader(),
407407
"x-async-handle": asyncHandle != null ? asyncHandle : undefined,
408-
"x-pd-environment": requestOptions?.xPdEnvironment,
408+
"x-pd-environment": requestOptions?.projectEnvironment,
409409
}),
410410
requestOptions?.headers,
411411
),

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export declare namespace AppCategories {
1616
projectId: string;
1717
token?: core.Supplier<core.BearerToken | undefined>;
1818
/** Override the x-pd-environment header */
19-
xPdEnvironment?: core.Supplier<string | undefined>;
19+
projectEnvironment?: core.Supplier<Pipedream.ProjectEnvironment | undefined>;
2020
/** Additional headers to include in requests. */
2121
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
2222
}
@@ -29,7 +29,7 @@ export declare namespace AppCategories {
2929
/** A hook to abort the request. */
3030
abortSignal?: AbortSignal;
3131
/** Override the x-pd-environment header */
32-
xPdEnvironment?: string | undefined;
32+
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
3333
/** Additional headers to include in the request. */
3434
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
3535
}
@@ -69,7 +69,7 @@ export class AppCategories {
6969
this._options?.headers,
7070
mergeOnlyDefinedHeaders({
7171
Authorization: await this._getAuthorizationHeader(),
72-
"x-pd-environment": requestOptions?.xPdEnvironment,
72+
"x-pd-environment": requestOptions?.projectEnvironment,
7373
}),
7474
requestOptions?.headers,
7575
),
@@ -136,7 +136,7 @@ export class AppCategories {
136136
this._options?.headers,
137137
mergeOnlyDefinedHeaders({
138138
Authorization: await this._getAuthorizationHeader(),
139-
"x-pd-environment": requestOptions?.xPdEnvironment,
139+
"x-pd-environment": requestOptions?.projectEnvironment,
140140
}),
141141
requestOptions?.headers,
142142
),

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export declare namespace Apps {
1616
projectId: string;
1717
token?: core.Supplier<core.BearerToken | undefined>;
1818
/** Override the x-pd-environment header */
19-
xPdEnvironment?: core.Supplier<string | undefined>;
19+
projectEnvironment?: core.Supplier<Pipedream.ProjectEnvironment | undefined>;
2020
/** Additional headers to include in requests. */
2121
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
2222
}
@@ -29,7 +29,7 @@ export declare namespace Apps {
2929
/** A hook to abort the request. */
3030
abortSignal?: AbortSignal;
3131
/** Override the x-pd-environment header */
32-
xPdEnvironment?: string | undefined;
32+
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
3333
/** Additional headers to include in the request. */
3434
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
3535
}
@@ -102,7 +102,7 @@ export class Apps {
102102
this._options?.headers,
103103
mergeOnlyDefinedHeaders({
104104
Authorization: await this._getAuthorizationHeader(),
105-
"x-pd-environment": requestOptions?.xPdEnvironment,
105+
"x-pd-environment": requestOptions?.projectEnvironment,
106106
}),
107107
requestOptions?.headers,
108108
),
@@ -183,7 +183,7 @@ export class Apps {
183183
this._options?.headers,
184184
mergeOnlyDefinedHeaders({
185185
Authorization: await this._getAuthorizationHeader(),
186-
"x-pd-environment": requestOptions?.xPdEnvironment,
186+
"x-pd-environment": requestOptions?.projectEnvironment,
187187
}),
188188
requestOptions?.headers,
189189
),

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export declare namespace Components {
1616
projectId: string;
1717
token?: core.Supplier<core.BearerToken | undefined>;
1818
/** Override the x-pd-environment header */
19-
xPdEnvironment?: core.Supplier<string | undefined>;
19+
projectEnvironment?: core.Supplier<Pipedream.ProjectEnvironment | undefined>;
2020
/** Additional headers to include in requests. */
2121
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
2222
}
@@ -29,7 +29,7 @@ export declare namespace Components {
2929
/** A hook to abort the request. */
3030
abortSignal?: AbortSignal;
3131
/** Override the x-pd-environment header */
32-
xPdEnvironment?: string | undefined;
32+
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
3333
/** Additional headers to include in the request. */
3434
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
3535
}
@@ -86,7 +86,7 @@ export class Components {
8686
this._options?.headers,
8787
mergeOnlyDefinedHeaders({
8888
Authorization: await this._getAuthorizationHeader(),
89-
"x-pd-environment": requestOptions?.xPdEnvironment,
89+
"x-pd-environment": requestOptions?.projectEnvironment,
9090
}),
9191
requestOptions?.headers,
9292
),
@@ -172,7 +172,7 @@ export class Components {
172172
this._options?.headers,
173173
mergeOnlyDefinedHeaders({
174174
Authorization: await this._getAuthorizationHeader(),
175-
"x-pd-environment": requestOptions?.xPdEnvironment,
175+
"x-pd-environment": requestOptions?.projectEnvironment,
176176
}),
177177
requestOptions?.headers,
178178
),
@@ -249,7 +249,7 @@ export class Components {
249249
mergeOnlyDefinedHeaders({
250250
Authorization: await this._getAuthorizationHeader(),
251251
"x-async-handle": asyncHandle != null ? asyncHandle : undefined,
252-
"x-pd-environment": requestOptions?.xPdEnvironment,
252+
"x-pd-environment": requestOptions?.projectEnvironment,
253253
}),
254254
requestOptions?.headers,
255255
),
@@ -328,7 +328,7 @@ export class Components {
328328
mergeOnlyDefinedHeaders({
329329
Authorization: await this._getAuthorizationHeader(),
330330
"x-async-handle": asyncHandle != null ? asyncHandle : undefined,
331-
"x-pd-environment": requestOptions?.xPdEnvironment,
331+
"x-pd-environment": requestOptions?.projectEnvironment,
332332
}),
333333
requestOptions?.headers,
334334
),

0 commit comments

Comments
 (0)