Skip to content
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

Fix typo in SDK docs for getAccountById #15357

Merged
merged 1 commit into from
Jan 21, 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
6 changes: 1 addition & 5 deletions docs-v2/pages/connect/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -597,8 +597,6 @@ const pd = createBackendClient({
});

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

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

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

Expand Down Expand Up @@ -2397,4 +2393,4 @@ curl -X DELETE \

##### Response

Pipedream returns a `204 No Content` response on successful deletion
Pipedream returns a `204 No Content` response on successful deletion
7 changes: 7 additions & 0 deletions packages/sdk/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

# Changelog

## [1.1.6] - 2025-01-21

### Changed

- Fixed the docs of the `getAccountById` method in the backend client to remove
arguments that are not actually supported.

## [1.1.5] - 2025-01-14

### Changed
Expand Down
2 changes: 1 addition & 1 deletion packages/sdk/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@pipedream/sdk",
"version": "1.1.5",
"version": "1.1.6",
"description": "Pipedream SDK",
"main": "dist/server/server/index.js",
"module": "dist/server/server/index.js",
Expand Down
9 changes: 9 additions & 0 deletions packages/sdk/src/server/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -262,13 +262,22 @@ export class BackendClient extends BaseClient {
* Retrieves a specific account by ID.
*
* @param accountId - The ID of the account to retrieve.
* @param params - Additional options for the request.
* @returns A promise resolving to the account.
*
* @example
* ```typescript
* const account = await client.getAccountById("account-id");
* console.log(account);
* ```
*
* @example
* ```typescript
* const account = await client.getAccountById("account-id", {
* include_credentials: true,
* });
* console.log(account);
* ```
*/
public getAccountById(
accountId: string,
Expand Down
14 changes: 6 additions & 8 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading