Many bug fixes and features (#204)

* Add `default` and `options` fields to several configurable prop types that were missing them * Rename the `appId` leftovers, replacing it with `app` where applicable * Add the `ToolAnnotation` type and corresponding field in the component definition --------- Co-authored-by: Jay Vercellone <jay@pipedream.com>

Author: fern-api[bot]

README.md

@@ -1,6 +1,6 @@
 {
  "name": "@pipedream/sdk",
- "version": "2.0.10",
+ "version": "2.0.11",
  "private": false,
  "repository": "github:PipedreamHQ/pipedream-sdk-typescript",
  "type": "commonjs",

package.json

@@ -54,7 +54,15 @@ export class Accounts {
  * @throws {@link Pipedream.TooManyRequestsError}
  *
  * @example
- * await client.accounts.list()
+ * await client.accounts.list({
+ * externalUserId: "external_user_id",
+ * oauthAppId: "oauth_app_id",
+ * after: "after",
+ * before: "before",
+ * limit: 1,
+ * app: "app",
+ * includeCredentials: true
+ * })
  */
  public async list(
  request: Pipedream.AccountsListRequest = {},
@@ -64,11 +72,8 @@ export class Accounts {
  async (
  request: Pipedream.AccountsListRequest,
  ): Promise<core.WithRawResponse<Pipedream.ListAccountsResponse>> => {
- const { app, externalUserId, oauthAppId, after, before, limit, includeCredentials } = request;
+ const { externalUserId, oauthAppId, after, before, limit, app, includeCredentials } = request;
  const _queryParams: Record<string, string | string[] | object | object[] | null> = {};
- if (app != null) {
- _queryParams["app"] = app;
- }
  if (externalUserId != null) {
  _queryParams["external_user_id"] = externalUserId;
  }
@@ -84,6 +89,9 @@ export class Accounts {
  if (limit != null) {
  _queryParams["limit"] = limit.toString();
  }
+ if (app != null) {
+ _queryParams["app"] = app;
+ }
  if (includeCredentials != null) {
  _queryParams["include_credentials"] = includeCredentials.toString();
  }
@@ -158,11 +166,11 @@ export class Accounts {
  response: dataWithRawResponse.data,
  rawResponse: dataWithRawResponse.rawResponse,
  hasNextPage: (response) =>
- response?.pageInfo?.endCursor != null &&
- !(typeof response?.pageInfo?.endCursor === "string" && response?.pageInfo?.endCursor === ""),
+ response?.pageInfo.endCursor != null &&
+ !(typeof response?.pageInfo.endCursor === "string" && response?.pageInfo.endCursor === ""),
  getItems: (response) => response?.data ?? [],
  loadPage: (response) => {
- return list(core.setObjectProperty(request, "after", response?.pageInfo?.endCursor));
+ return list(core.setObjectProperty(request, "after", response?.pageInfo.endCursor));
  },
  });
  }
@@ -177,6 +185,8 @@ export class Accounts {
  *
  * @example
  * await client.accounts.create({
+ * externalUserId: "external_user_id",
+ * oauthAppId: "oauth_app_id",
  * appSlug: "app_slug",
  * cfmapJson: "cfmap_json",
  * connectToken: "connect_token"
@@ -193,12 +203,8 @@ export class Accounts {
  request: Pipedream.CreateAccountOpts,
  requestOptions?: Accounts.RequestOptions,
  ): Promise<core.WithRawResponse<Pipedream.Account>> {
- const { appId, externalUserId, oauthAppId, ..._body } = request;
+ const { externalUserId, oauthAppId, ..._body } = request;
  const _queryParams: Record<string, string | string[] | object | object[] | null> = {};
- if (appId != null) {
- _queryParams["app_id"] = appId;
- }
-
  if (externalUserId != null) {
  _queryParams["external_user_id"] = externalUserId;
  }
@@ -290,7 +296,9 @@ export class Accounts {
  * @throws {@link Pipedream.TooManyRequestsError}
  *
  * @example
- * await client.accounts.retrieve("account_id")
+ * await client.accounts.retrieve("account_id", {
+ * includeCredentials: true
+ * })
  */
  public retrieve(
  accountId: string,

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

@@ -4,11 +4,17 @@
 
 /**
  * @example
- * {}
+ * {
+ * externalUserId: "external_user_id",
+ * oauthAppId: "oauth_app_id",
+ * after: "after",
+ * before: "before",
+ * limit: 1,
+ * app: "app",
+ * includeCredentials: true
+ * }
  */
 export interface AccountsListRequest {
- /** The app slug or ID to filter accounts by. */
- app?: string;
  externalUserId?: string;
  /** The OAuth app ID to filter by, if applicable */
  oauthAppId?: string;
@@ -18,6 +24,8 @@ export interface AccountsListRequest {
  before?: string;
  /** The maximum number of results to return */
  limit?: number;
+ /** The app slug or ID to filter accounts by. */
+ app?: string;
  /** Whether to retrieve the account's credentials or not */
  includeCredentials?: boolean;
 }

src/api/resources/accounts/client/requests/AccountsListRequest.ts

@@ -4,7 +4,9 @@
 
 /**
  * @example
- * {}
+ * {
+ * includeCredentials: true
+ * }
  */
 export interface AccountsRetrieveRequest {
  /** Whether to retrieve the account's credentials or not */

src/api/resources/accounts/client/requests/AccountsRetrieveRequest.ts

@@ -5,14 +5,14 @@
 /**
  * @example
  * {
+ * externalUserId: "external_user_id",
+ * oauthAppId: "oauth_app_id",
  * appSlug: "app_slug",
  * cfmapJson: "cfmap_json",
  * connectToken: "connect_token"
  * }
  */
 export interface CreateAccountOpts {
- /** The app slug or ID to filter accounts by. */
- appId?: string;
  externalUserId?: string;
  /** The OAuth app ID to filter by, if applicable */
  oauthAppId?: string;

src/api/resources/accounts/client/requests/CreateAccountOpts.ts

@@ -54,7 +54,13 @@ export class Actions {
  * @throws {@link Pipedream.TooManyRequestsError}
  *
  * @example
- * await client.actions.list()
+ * await client.actions.list({
+ * after: "after",
+ * before: "before",
+ * limit: 1,
+ * q: "q",
+ * app: "app"
+ * })
  */
  public async list(
  request: Pipedream.ActionsListRequest = {},
@@ -152,11 +158,11 @@ export class Actions {
  response: dataWithRawResponse.data,
  rawResponse: dataWithRawResponse.rawResponse,
  hasNextPage: (response) =>
- response?.pageInfo?.endCursor != null &&
- !(typeof response?.pageInfo?.endCursor === "string" && response?.pageInfo?.endCursor === ""),
+ response?.pageInfo.endCursor != null &&
+ !(typeof response?.pageInfo.endCursor === "string" && response?.pageInfo.endCursor === ""),
  getItems: (response) => response?.data ?? [],
  loadPage: (response) => {
- return list(core.setObjectProperty(request, "after", response?.pageInfo?.endCursor));
+ return list(core.setObjectProperty(request, "after", response?.pageInfo.endCursor));
  },
  });
  }

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

@@ -4,7 +4,13 @@
 
 /**
  * @example
- * {}
+ * {
+ * after: "after",
+ * before: "before",
+ * limit: 1,
+ * q: "q",
+ * app: "app"
+ * }
  */
 export interface ActionsListRequest {
  /** The cursor to start from for pagination */

src/api/resources/actions/client/requests/ActionsListRequest.ts

@@ -52,7 +52,14 @@ export class Apps {
  * @param {Apps.RequestOptions} requestOptions - Request-specific configuration.
  *
  * @example
- * await client.apps.list()
+ * await client.apps.list({
+ * after: "after",
+ * before: "before",
+ * limit: 1,
+ * q: "q",
+ * sortKey: "name",
+ * sortDirection: "asc"
+ * })
  */
  public async list(
  request: Pipedream.AppsListRequest = {},
@@ -157,11 +164,11 @@ export class Apps {
  response: dataWithRawResponse.data,
  rawResponse: dataWithRawResponse.rawResponse,
  hasNextPage: (response) =>
- response?.pageInfo?.endCursor != null &&
- !(typeof response?.pageInfo?.endCursor === "string" && response?.pageInfo?.endCursor === ""),
+ response?.pageInfo.endCursor != null &&
+ !(typeof response?.pageInfo.endCursor === "string" && response?.pageInfo.endCursor === ""),
  getItems: (response) => response?.data ?? [],
  loadPage: (response) => {
- return list(core.setObjectProperty(request, "after", response?.pageInfo?.endCursor));
+ return list(core.setObjectProperty(request, "after", response?.pageInfo.endCursor));
  },
  });
  }

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

@@ -6,7 +6,14 @@ import * as Pipedream from "../../../../index.js";
 
 /**
  * @example
- * {}
+ * {
+ * after: "after",
+ * before: "before",
+ * limit: 1,
+ * q: "q",
+ * sortKey: "name",
+ * sortDirection: "asc"
+ * }
  */
 export interface AppsListRequest {
  /** The cursor to start from for pagination */