Skip to content
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
9 changes: 9 additions & 0 deletions packages/sdk/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
<!-- markdownlint-disable MD024 -->
# Changelog

## [1.0.4] - 2024-11-15

### Changed

- Improved the docs of the `getAccountById` method in the backend client to
clarify the behavior of the new argument.
- Fixed the exported `HTTPAuthType` enum so that it can be used by the consumers
of the SDK.

## [1.0.3] - 2024-11-14

### Added
Expand Down
4 changes: 2 additions & 2 deletions packages/sdk/package-lock.json

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

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.0.3",
"version": "1.0.4",
"description": "Pipedream SDK",
"main": "dist/server/index.js",
"module": "dist/server/index.js",
Expand Down
12 changes: 10 additions & 2 deletions packages/sdk/src/server/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export type BackendClientOpts = {
/**
* Different ways in which customers can authorize requests to HTTP endpoints
*/
export const enum HTTPAuthType {
export enum HTTPAuthType {
None = "none",
StaticBearer = "static_bearer_token",
OAuth = "oauth"
Expand Down Expand Up @@ -140,7 +140,7 @@ export type ConnectTokenResponse = {
/**
* The types of authentication that Pipedream apps support.
*/
export const enum AppAuthType {
export enum AppAuthType {
OAuth = "oauth",
Keys = "keys",
None = "none",
Expand Down Expand Up @@ -602,13 +602,21 @@ export class BackendClient {
* Retrieves a specific account by ID.
*
* @param accountId - The ID of the account to retrieve.
* @param params - The query parameters for retrieving the account.
* @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.credentials);
*/
public getAccountById(
accountId: string,
Expand Down
Loading