Skip to content

Commit e8db31f

Browse files
fern-api[bot]jverce
fern-api[bot]
and
jverce
authored
Fix the Connect proxy and token schemas (#53)
* Fix the Connect proxy response schema The response from the Connect proxy endpoint is transparent, so the body is free-form, and the status and headers come back as part of the HTTP response itself. * Fix the Connect token specs The Connect token paths live under the project scope, so their paths should contain `{project_id}`, and not have it inside the request body. --------- Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Jay Vercellone <jverce@users.noreply.github.com> Co-authored-by: Jay Vercellone <jay@pipedream.com>
1 parent 9c50a8a commit e8db31f

File tree

22 files changed

+112
-60
lines changed

22 files changed

+112
-60
lines changed

‎.fernignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
.prettierrc.yml
66
LICENSE
77

8-
src/api/resources/proxy/client/Client.ts
8+
src/api/resources/proxy/client/*
99
src/index.ts
1010
src/wrapper

‎README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ const client = new PipedreamClient({
2626
clientId: "YOUR_CLIENT_ID",
2727
clientSecret: "YOUR_CLIENT_SECRET",
2828
projectEnvironment: "YOUR_PROJECT_ENVIRONMENT",
29+
projectId: "YOUR_PROJECT_ID",
2930
});
3031
await client.accounts.create({
3132
app_slug: "app_slug",
@@ -78,6 +79,7 @@ const client = new PipedreamClient({
7879
clientId: "YOUR_CLIENT_ID",
7980
clientSecret: "YOUR_CLIENT_SECRET",
8081
projectEnvironment: "YOUR_PROJECT_ENVIRONMENT",
82+
projectId: "YOUR_PROJECT_ID",
8183
});
8284
const response = await client.apps.list();
8385
for await (const item of response) {
@@ -105,6 +107,18 @@ const response = await client.accounts.create(..., {
105107
});
106108
```
107109

110+
### Additional Query String Parameters
111+
112+
If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
113+
114+
```typescript
115+
const response = await client.accounts.create(..., {
116+
queryParams: {
117+
'customQueryParamKey': 'custom query param value'
118+
}
119+
});
120+
```
121+
108122
### Retries
109123

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

162176
### Runtime Compatibility
163177

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

167180
- Node.js 18+
168181
- Vercel

‎reference.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ await client.accounts.create({
289289
<dl>
290290
<dd>
291291

292-
**request:** `Pipedream.CreateAccountRequest`
292+
**request:** `Pipedream.CreateAccountOpts`
293293

294294
</dd>
295295
</dl>
@@ -2148,7 +2148,6 @@ await client.proxy.patch("url_64", {
21482148
```typescript
21492149
await client.tokens.create({
21502150
external_user_id: "external_user_id",
2151-
project_id: "project_id",
21522151
});
21532152
```
21542153

@@ -2165,7 +2164,7 @@ await client.tokens.create({
21652164
<dl>
21662165
<dd>
21672166

2168-
**request:** `Pipedream.CreateTokenRequest`
2167+
**request:** `Pipedream.CreateTokenOpts`
21692168

21702169
</dd>
21712170
</dl>

‎src/Client.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ export declare namespace PipedreamClient {
4242
abortSignal?: AbortSignal;
4343
/** Override the x-pd-environment header */
4444
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
45+
/** Additional query string parameters to include in the request. */
46+
queryParams?: Record<string, unknown>;
4547
/** Additional headers to include in the request. */
4648
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
4749
}

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

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ export declare namespace Accounts {
3030
abortSignal?: AbortSignal;
3131
/** Override the x-pd-environment header */
3232
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
33+
/** Additional query string parameters to include in the request. */
34+
queryParams?: Record<string, unknown>;
3335
/** Additional headers to include in the request. */
3436
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
3537
}
@@ -104,7 +106,7 @@ export class Accounts {
104106
}),
105107
requestOptions?.headers,
106108
),
107-
queryParameters: _queryParams,
109+
queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
108110
timeoutMs:
109111
requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
110112
maxRetries: requestOptions?.maxRetries,
@@ -157,7 +159,7 @@ export class Accounts {
157159
}
158160

159161
/**
160-
* @param {Pipedream.CreateAccountRequest} request
162+
* @param {Pipedream.CreateAccountOpts} request
161163
* @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
162164
*
163165
* @example
@@ -168,14 +170,14 @@ export class Accounts {
168170
* })
169171
*/
170172
public create(
171-
request: Pipedream.CreateAccountRequest,
173+
request: Pipedream.CreateAccountOpts,
172174
requestOptions?: Accounts.RequestOptions,
173175
): core.HttpResponsePromise<Pipedream.Account> {
174176
return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
175177
}
176178

177179
private async __create(
178-
request: Pipedream.CreateAccountRequest,
180+
request: Pipedream.CreateAccountOpts,
179181
requestOptions?: Accounts.RequestOptions,
180182
): Promise<core.WithRawResponse<Pipedream.Account>> {
181183
const { app_id: appId, external_user_id: externalUserId, oauth_app_id: oauthAppId, ..._body } = request;
@@ -209,7 +211,7 @@ export class Accounts {
209211
requestOptions?.headers,
210212
),
211213
contentType: "application/json",
212-
queryParameters: _queryParams,
214+
queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
213215
requestType: "json",
214216
body: _body,
215217
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -290,7 +292,7 @@ export class Accounts {
290292
}),
291293
requestOptions?.headers,
292294
),
293-
queryParameters: _queryParams,
295+
queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
294296
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
295297
maxRetries: requestOptions?.maxRetries,
296298
abortSignal: requestOptions?.abortSignal,
@@ -357,6 +359,7 @@ export class Accounts {
357359
}),
358360
requestOptions?.headers,
359361
),
362+
queryParameters: requestOptions?.queryParams,
360363
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
361364
maxRetries: requestOptions?.maxRetries,
362365
abortSignal: requestOptions?.abortSignal,
@@ -423,6 +426,7 @@ export class Accounts {
423426
}),
424427
requestOptions?.headers,
425428
),
429+
queryParameters: requestOptions?.queryParams,
426430
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
427431
maxRetries: requestOptions?.maxRetries,
428432
abortSignal: requestOptions?.abortSignal,

‎src/api/resources/accounts/client/requests/CreateAccountRequest.ts renamed to ‎src/api/resources/accounts/client/requests/CreateAccountOpts.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* connect_token: "connect_token"
1111
* }
1212
*/
13-
export interface CreateAccountRequest {
13+
export interface CreateAccountOpts {
1414
/**
1515
* The app slug or ID to filter accounts by.
1616
*/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
export { type AccountsListRequest } from "./AccountsListRequest.js";
2-
export { type CreateAccountRequest } from "./CreateAccountRequest.js";
2+
export { type CreateAccountOpts } from "./CreateAccountOpts.js";
33
export { type AccountsRetrieveRequest } from "./AccountsRetrieveRequest.js";

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ export declare namespace Actions {
3030
abortSignal?: AbortSignal;
3131
/** Override the x-pd-environment header */
3232
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
33+
/** Additional query string parameters to include in the request. */
34+
queryParams?: Record<string, unknown>;
3335
/** Additional headers to include in the request. */
3436
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
3537
}
@@ -90,7 +92,7 @@ export class Actions {
9092
}),
9193
requestOptions?.headers,
9294
),
93-
queryParameters: _queryParams,
95+
queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
9496
timeoutMs:
9597
requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
9698
maxRetries: requestOptions?.maxRetries,
@@ -176,6 +178,7 @@ export class Actions {
176178
}),
177179
requestOptions?.headers,
178180
),
181+
queryParameters: requestOptions?.queryParams,
179182
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
180183
maxRetries: requestOptions?.maxRetries,
181184
abortSignal: requestOptions?.abortSignal,
@@ -254,6 +257,7 @@ export class Actions {
254257
requestOptions?.headers,
255258
),
256259
contentType: "application/json",
260+
queryParameters: requestOptions?.queryParams,
257261
requestType: "json",
258262
body: _body,
259263
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -333,6 +337,7 @@ export class Actions {
333337
requestOptions?.headers,
334338
),
335339
contentType: "application/json",
340+
queryParameters: requestOptions?.queryParams,
336341
requestType: "json",
337342
body: _body,
338343
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -410,6 +415,7 @@ export class Actions {
410415
requestOptions?.headers,
411416
),
412417
contentType: "application/json",
418+
queryParameters: requestOptions?.queryParams,
413419
requestType: "json",
414420
body: _body,
415421
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ export declare namespace AppCategories {
3030
abortSignal?: AbortSignal;
3131
/** Override the x-pd-environment header */
3232
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
33+
/** Additional query string parameters to include in the request. */
34+
queryParams?: Record<string, unknown>;
3335
/** Additional headers to include in the request. */
3436
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
3537
}
@@ -73,6 +75,7 @@ export class AppCategories {
7375
}),
7476
requestOptions?.headers,
7577
),
78+
queryParameters: requestOptions?.queryParams,
7679
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
7780
maxRetries: requestOptions?.maxRetries,
7881
abortSignal: requestOptions?.abortSignal,
@@ -140,6 +143,7 @@ export class AppCategories {
140143
}),
141144
requestOptions?.headers,
142145
),
146+
queryParameters: requestOptions?.queryParams,
143147
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
144148
maxRetries: requestOptions?.maxRetries,
145149
abortSignal: requestOptions?.abortSignal,

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ export declare namespace Apps {
3030
abortSignal?: AbortSignal;
3131
/** Override the x-pd-environment header */
3232
projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
33+
/** Additional query string parameters to include in the request. */
34+
queryParams?: Record<string, unknown>;
3335
/** Additional headers to include in the request. */
3436
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
3537
}
@@ -106,7 +108,7 @@ export class Apps {
106108
}),
107109
requestOptions?.headers,
108110
),
109-
queryParameters: _queryParams,
111+
queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
110112
timeoutMs:
111113
requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
112114
maxRetries: requestOptions?.maxRetries,
@@ -187,6 +189,7 @@ export class Apps {
187189
}),
188190
requestOptions?.headers,
189191
),
192+
queryParameters: requestOptions?.queryParams,
190193
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
191194
maxRetries: requestOptions?.maxRetries,
192195
abortSignal: requestOptions?.abortSignal,

0 commit comments

Comments
 (0)