Skip to content

Commit 16904da

Browse files
authored
Fix typo in SDK docs for getAccountById (#15357)
* Remove the unsupported opts from the Connect docs * Add JSDoc example in the SDK with the actually supported params * Bump patch version of the SDK
1 parent def58b8 commit 16904da

File tree

5 files changed

+23
-12
lines changed

5 files changed

+23
-12
lines changed

docs-v2/pages/connect/api.mdx

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -597,8 +597,6 @@ const pd = createBackendClient({
597597
});
598598

599599
const account = await pd.getAccountById(accountId, {
600-
app: "github", // optional, filter by app
601-
external_user_id: "user-abc-123", // optional, filter by external user ID
602600
include_credentials: true, // optional, set to true to include credentials
603601
});
604602

@@ -622,8 +620,6 @@ const pd = createBackendClient({
622620
const accountId = "{account_id}"; // Replace with your account ID
623621

624622
const account = await pd.getAccountById(accountId, {
625-
app: "github", // optional, filter by app
626-
external_user_id: "user-abc-123", // optional, filter by external user ID
627623
include_credentials: true, // optional, set to true to include credentials
628624
});
629625

@@ -2397,4 +2393,4 @@ curl -X DELETE \
23972393

23982394
##### Response
23992395

2400-
Pipedream returns a `204 No Content` response on successful deletion
2396+
Pipedream returns a `204 No Content` response on successful deletion

packages/sdk/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
# Changelog
44

5+
## [1.1.6] - 2025-01-21
6+
7+
### Changed
8+
9+
- Fixed the docs of the `getAccountById` method in the backend client to remove
10+
arguments that are not actually supported.
11+
512
## [1.1.5] - 2025-01-14
613

714
### Changed

packages/sdk/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": "1.1.5",
3+
"version": "1.1.6",
44
"description": "Pipedream SDK",
55
"main": "dist/server/server/index.js",
66
"module": "dist/server/server/index.js",

packages/sdk/src/server/index.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,13 +262,22 @@ export class BackendClient extends BaseClient {
262262
* Retrieves a specific account by ID.
263263
*
264264
* @param accountId - The ID of the account to retrieve.
265+
* @param params - Additional options for the request.
265266
* @returns A promise resolving to the account.
266267
*
267268
* @example
268269
* ```typescript
269270
* const account = await client.getAccountById("account-id");
270271
* console.log(account);
271272
* ```
273+
*
274+
* @example
275+
* ```typescript
276+
* const account = await client.getAccountById("account-id", {
277+
* include_credentials: true,
278+
* });
279+
* console.log(account);
280+
* ```
272281
*/
273282
public getAccountById(
274283
accountId: string,

pnpm-lock.yaml

Lines changed: 5 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)