Skip to content

Commit 4fcc4f1

Browse files
authored
Fix broken export (#14663)
- Fixed the exported `HTTPAuthType` enum so that it can be used by the consumers of the SDK. - Improved the docs of the `getAccountById` method in the backend client to clarify the behavior of the new argument.
1 parent be43604 commit 4fcc4f1

File tree

4 files changed

+22
-5
lines changed

4 files changed

+22
-5
lines changed

packages/sdk/CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
<!-- markdownlint-disable MD024 -->
22
# Changelog
33

4+
## [1.0.4] - 2024-11-15
5+
6+
### Changed
7+
8+
- Improved the docs of the `getAccountById` method in the backend client to
9+
clarify the behavior of the new argument.
10+
- Fixed the exported `HTTPAuthType` enum so that it can be used by the consumers
11+
of the SDK.
12+
413
## [1.0.3] - 2024-11-14
514

615
### Added

packages/sdk/package-lock.json

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

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

packages/sdk/src/server/index.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export type BackendClientOpts = {
5353
/**
5454
* Different ways in which customers can authorize requests to HTTP endpoints
5555
*/
56-
export const enum HTTPAuthType {
56+
export enum HTTPAuthType {
5757
None = "none",
5858
StaticBearer = "static_bearer_token",
5959
OAuth = "oauth"
@@ -140,7 +140,7 @@ export type ConnectTokenResponse = {
140140
/**
141141
* The types of authentication that Pipedream apps support.
142142
*/
143-
export const enum AppAuthType {
143+
export enum AppAuthType {
144144
OAuth = "oauth",
145145
Keys = "keys",
146146
None = "none",
@@ -602,13 +602,21 @@ export class BackendClient {
602602
* Retrieves a specific account by ID.
603603
*
604604
* @param accountId - The ID of the account to retrieve.
605+
* @param params - The query parameters for retrieving the account.
605606
* @returns A promise resolving to the account.
606607
*
607608
* @example
608609
* ```typescript
609610
* const account = await client.getAccountById("account-id");
610611
* console.log(account);
611612
* ```
613+
*
614+
* @example
615+
* ```typescript
616+
* const account = await client.getAccountById("account-id", {
617+
* include_credentials: true,
618+
* });
619+
* console.log(account.credentials);
612620
*/
613621
public getAccountById(
614622
accountId: string,

0 commit comments

Comments
 (0)