@composio/client 0.1.0-alpha.10 → 0.1.0-alpha.12

package/resources/connected-accounts.d.mts

@@ -4,26 +4,78 @@ import { RequestOptions } from "../internal/request-options.mjs";
 export declare class ConnectedAccounts extends APIResource {
     /**
      * Create a new connected account
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.create({
+     *     auth_config: { id: 'id' },
+     *     connection: {},
+     *   });
+     * ```
      */
     create(body: ConnectedAccountCreateParams, options?: RequestOptions): APIPromise<ConnectedAccountCreateResponse>;
     /**
-     * Get connected account details by ID
+     * Retrieves comprehensive details of a connected account, including authentication
+     * configuration, connection status, and all parameters needed for API requests.
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.retrieve(
+     *     'con_1a2b3c4d5e6f',
+     *   );
+     * ```
      */
     retrieve(nanoid: string, options?: RequestOptions): APIPromise<ConnectedAccountRetrieveResponse>;
     /**
      * List connected accounts with optional filters
+     *
+     * @example
+     * ```ts
+     * const connectedAccounts =
+     *   await client.connectedAccounts.list();
+     * ```
      */
     list(query?: ConnectedAccountListParams | null | undefined, options?: RequestOptions): APIPromise<ConnectedAccountListResponse>;
     /**
-     * Delete a connected account
+     * Soft-deletes a connected account by marking it as deleted in the database. This
+     * prevents the account from being used for API calls but preserves the record for
+     * audit purposes.
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.delete('con_1a2b3c4d5e6f');
+     * ```
      */
     delete(nanoid: string, options?: RequestOptions): APIPromise<ConnectedAccountDeleteResponse>;
     /**
-     * Refresh authentication for a connected account
+     * Initiates a new authentication flow for a connected account when credentials
+     * have expired or become invalid. This may generate a new authentication URL for
+     * OAuth flows or refresh tokens for other auth schemes.
+     *
+     * @example
+     * ```ts
+     * const response = await client.connectedAccounts.refresh(
+     *   'con_1a2b3c4d5e6f',
+     * );
+     * ```
      */
     refresh(nanoid: string, options?: RequestOptions): APIPromise<ConnectedAccountRefreshResponse>;
     /**
-     * Enable or disable a connected account
+     * Updates the status of a connected account to either enabled (active) or disabled
+     * (inactive). Disabled accounts cannot be used for API calls but remain in the
+     * database.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.connectedAccounts.updateStatus(
+     *     'con_1a2b3c4d5e6f',
+     *     { enabled: true },
+     *   );
+     * ```
      */
     updateStatus(nanoID: string, body: ConnectedAccountUpdateStatusParams, options?: RequestOptions): APIPromise<ConnectedAccountUpdateStatusResponse>;
 }
@@ -45,7 +97,7 @@ export interface ConnectedAccountCreateResponse {
     /**
      * The status of the connected account
      */
-    status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'INITIATED' | 'EXPIRED' | 'FAILED';
+    status: 'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED';
 }
 export declare namespace ConnectedAccountCreateResponse {
     interface Deprecated {
@@ -74,19 +126,20 @@ export interface ConnectedAccountRetrieveResponse {
      */
     data: Record<string, unknown>;
     /**
-     * Whether the connected account is disabled
+     * Whether the connected account is disabled. When true, the account cannot be used
+     * for API calls
      */
     is_disabled: boolean;
     /**
-     * The init data of the connection
+     * The initialization data of the connection, including configuration parameters
      */
     params: Record<string, unknown>;
     /**
      * The status of the connection
      */
-    status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'INITIATED' | 'EXPIRED' | 'FAILED';
+    status: 'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED';
     /**
-     * The reason the connected account is disabled
+     * The reason why the connected account is disabled, if applicable
      */
     status_reason: string | null;
     toolkit: ConnectedAccountRetrieveResponse.Toolkit;
@@ -176,7 +229,7 @@ export declare namespace ConnectedAccountListResponse {
         /**
          * The status of the connection
          */
-        status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'INITIATED' | 'EXPIRED' | 'FAILED';
+        status: 'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED';
         /**
          * The reason the connection is disabled
          */
@@ -242,29 +295,36 @@ export declare namespace ConnectedAccountListResponse {
         }
     }
 }
+/**
+ * Response returned after successfully deleting a connected account
+ */
 export interface ConnectedAccountDeleteResponse {
     /**
-     * The success of the update
+     * Indicates whether the connected account was successfully deleted
      */
     success: boolean;
 }
 export interface ConnectedAccountRefreshResponse {
     /**
-     * The id of the connected account
+     * The unique identifier of the connected account
      */
     id: string;
     /**
-     * The redirect URL of the app (previously named redirect_uri)
+     * The URL to which the user should be redirected to complete the authentication
+     * process (null for auth schemes that do not require redirection)
      */
     redirect_url: string | null;
     /**
-     * The status of the connected account
+     * The current status of the connected account (e.g., active, pending, failed)
      */
-    status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'INITIATED' | 'EXPIRED' | 'FAILED';
+    status: 'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED';
 }
+/**
+ * Response returned after successfully updating a connected account status
+ */
 export interface ConnectedAccountUpdateStatusResponse {
     /**
-     * The success of the update
+     * Indicates whether the connected account status was successfully updated
      */
     success: boolean;
 }
@@ -327,7 +387,7 @@ export interface ConnectedAccountListParams {
     /**
      * The status of the connected account
      */
-    statuses?: Array<'ACTIVE' | 'INACTIVE' | 'DELETED' | 'INITIATED' | 'EXPIRED' | 'FAILED'> | null;
+    statuses?: Array<'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED'> | null;
     /**
      * The toolkit slugs of the connected accounts
      */
@@ -338,6 +398,9 @@ export interface ConnectedAccountListParams {
     user_ids?: Array<string> | null;
 }
 export interface ConnectedAccountUpdateStatusParams {
+    /**
+     * Set to true to enable the account or false to disable it
+     */
     enabled: boolean;
 }
 export declare namespace ConnectedAccounts {

package/resources/connected-accounts.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"connected-accounts.d.mts","sourceRoot":"","sources":["../src/resources/connected-accounts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gCAAgC,CAAC;IAIhG;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAI5F;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI9F;;OAEG;IACH,YAAY,CACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,kCAAkC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;CAGpD;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,8BAA8B,CAAC,UAAU,CAAC;IAEtD;;;OAGG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;CAChF;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,UAAU;QACzB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,gCAAgC,CAAC,UAAU,CAAC;IAEzD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE9B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;IAE/E;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,OAAO,EAAE,gCAAgC,CAAC,OAAO,CAAC;IAElD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,gCAAgC,CAAC,UAAU,CAAC;IAEzD;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,yBAAiB,gCAAgC,CAAC;IAChD,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EACP,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,SAAS,GACT,OAAO,GACP,cAAc,GACd,cAAc,GACd,wBAAwB,GACxB,SAAS,GACT,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,WAAW,CAAC;QAEhB;;WAEG;QACH,mBAAmB,EAAE,OAAO,CAAC;QAE7B;;WAEG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC;KACpC;IAED,UAAiB,UAAU,CAAC;QAC1B,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C,KAAK,EAAE,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;IAEhD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC;QAE7B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAE9B;;WAEG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;QAE/E;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QAEtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC;QAE7B;;WAEG;QACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;KAChC;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,UAAU;YACzB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,EACP,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,SAAS,GACT,OAAO,GACP,cAAc,GACd,cAAc,GACd,wBAAwB,GACxB,SAAS,GACT,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,WAAW,CAAC;YAEhB;;eAEG;YACH,mBAAmB,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,WAAW,EAAE,OAAO,CAAC;YAErB,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC;SACpC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,UAAU;gBACzB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;aACd;SACF;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,UAAU;YACzB;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;CAChF;AAED,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,WAAW,EAAE,4BAA4B,CAAC,UAAU,CAAC;IAErD,UAAU,EAAE,4BAA4B,CAAC,UAAU,CAAC;CACrD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAE/B;;WAEG;QACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;QAEpC;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,GAAG,YAAY,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC,GAAG,IAAI,CAAC;IAEhG;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,kCAAkC;IACjD,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;CACH"}
+{"version":3,"file":"connected-accounts.d.mts","sourceRoot":"","sources":["../src/resources/connected-accounts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gCAAgC,CAAC;IAIhG;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAI5F;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI9F;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,kCAAkC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;CAGpD;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,8BAA8B,CAAC,UAAU,CAAC;IAEtD;;;OAGG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,cAAc,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;CACxE;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,UAAU;QACzB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,gCAAgC,CAAC,UAAU,CAAC;IAEzD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE9B;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,cAAc,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IAEvE;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,OAAO,EAAE,gCAAgC,CAAC,OAAO,CAAC;IAElD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,gCAAgC,CAAC,UAAU,CAAC;IAEzD;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,yBAAiB,gCAAgC,CAAC;IAChD,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EACP,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,SAAS,GACT,OAAO,GACP,cAAc,GACd,cAAc,GACd,wBAAwB,GACxB,SAAS,GACT,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,WAAW,CAAC;QAEhB;;WAEG;QACH,mBAAmB,EAAE,OAAO,CAAC;QAE7B;;WAEG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC;KACpC;IAED,UAAiB,UAAU,CAAC;QAC1B,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C,KAAK,EAAE,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;IAEhD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC;QAE7B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAE9B;;WAEG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,MAAM,EAAE,cAAc,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;QAEvE;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QAEtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC;QAE7B;;WAEG;QACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;KAChC;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,UAAU;YACzB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,EACP,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,SAAS,GACT,OAAO,GACP,cAAc,GACd,cAAc,GACd,wBAAwB,GACxB,SAAS,GACT,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,WAAW,CAAC;YAEhB;;eAEG;YACH,mBAAmB,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,WAAW,EAAE,OAAO,CAAC;YAErB,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC;SACpC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,UAAU;gBACzB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;aACd;SACF;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,UAAU;YACzB;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,cAAc,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;CACxE;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,WAAW,EAAE,4BAA4B,CAAC,UAAU,CAAC;IAErD,UAAU,EAAE,4BAA4B,CAAC,UAAU,CAAC;CACrD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAE/B;;WAEG;QACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;QAEpC;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,GAAG,YAAY,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC;IAExF;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;CACH"}

package/resources/connected-accounts.d.ts

@@ -4,26 +4,78 @@ import { RequestOptions } from "../internal/request-options.js";
 export declare class ConnectedAccounts extends APIResource {
     /**
      * Create a new connected account
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.create({
+     *     auth_config: { id: 'id' },
+     *     connection: {},
+     *   });
+     * ```
      */
     create(body: ConnectedAccountCreateParams, options?: RequestOptions): APIPromise<ConnectedAccountCreateResponse>;
     /**
-     * Get connected account details by ID
+     * Retrieves comprehensive details of a connected account, including authentication
+     * configuration, connection status, and all parameters needed for API requests.
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.retrieve(
+     *     'con_1a2b3c4d5e6f',
+     *   );
+     * ```
      */
     retrieve(nanoid: string, options?: RequestOptions): APIPromise<ConnectedAccountRetrieveResponse>;
     /**
      * List connected accounts with optional filters
+     *
+     * @example
+     * ```ts
+     * const connectedAccounts =
+     *   await client.connectedAccounts.list();
+     * ```
      */
     list(query?: ConnectedAccountListParams | null | undefined, options?: RequestOptions): APIPromise<ConnectedAccountListResponse>;
     /**
-     * Delete a connected account
+     * Soft-deletes a connected account by marking it as deleted in the database. This
+     * prevents the account from being used for API calls but preserves the record for
+     * audit purposes.
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.delete('con_1a2b3c4d5e6f');
+     * ```
      */
     delete(nanoid: string, options?: RequestOptions): APIPromise<ConnectedAccountDeleteResponse>;
     /**
-     * Refresh authentication for a connected account
+     * Initiates a new authentication flow for a connected account when credentials
+     * have expired or become invalid. This may generate a new authentication URL for
+     * OAuth flows or refresh tokens for other auth schemes.
+     *
+     * @example
+     * ```ts
+     * const response = await client.connectedAccounts.refresh(
+     *   'con_1a2b3c4d5e6f',
+     * );
+     * ```
      */
     refresh(nanoid: string, options?: RequestOptions): APIPromise<ConnectedAccountRefreshResponse>;
     /**
-     * Enable or disable a connected account
+     * Updates the status of a connected account to either enabled (active) or disabled
+     * (inactive). Disabled accounts cannot be used for API calls but remain in the
+     * database.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.connectedAccounts.updateStatus(
+     *     'con_1a2b3c4d5e6f',
+     *     { enabled: true },
+     *   );
+     * ```
      */
     updateStatus(nanoID: string, body: ConnectedAccountUpdateStatusParams, options?: RequestOptions): APIPromise<ConnectedAccountUpdateStatusResponse>;
 }
@@ -45,7 +97,7 @@ export interface ConnectedAccountCreateResponse {
     /**
      * The status of the connected account
      */
-    status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'INITIATED' | 'EXPIRED' | 'FAILED';
+    status: 'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED';
 }
 export declare namespace ConnectedAccountCreateResponse {
     interface Deprecated {
@@ -74,19 +126,20 @@ export interface ConnectedAccountRetrieveResponse {
      */
     data: Record<string, unknown>;
     /**
-     * Whether the connected account is disabled
+     * Whether the connected account is disabled. When true, the account cannot be used
+     * for API calls
      */
     is_disabled: boolean;
     /**
-     * The init data of the connection
+     * The initialization data of the connection, including configuration parameters
      */
     params: Record<string, unknown>;
     /**
      * The status of the connection
      */
-    status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'INITIATED' | 'EXPIRED' | 'FAILED';
+    status: 'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED';
     /**
-     * The reason the connected account is disabled
+     * The reason why the connected account is disabled, if applicable
      */
     status_reason: string | null;
     toolkit: ConnectedAccountRetrieveResponse.Toolkit;
@@ -176,7 +229,7 @@ export declare namespace ConnectedAccountListResponse {
         /**
          * The status of the connection
          */
-        status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'INITIATED' | 'EXPIRED' | 'FAILED';
+        status: 'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED';
         /**
          * The reason the connection is disabled
          */
@@ -242,29 +295,36 @@ export declare namespace ConnectedAccountListResponse {
         }
     }
 }
+/**
+ * Response returned after successfully deleting a connected account
+ */
 export interface ConnectedAccountDeleteResponse {
     /**
-     * The success of the update
+     * Indicates whether the connected account was successfully deleted
      */
     success: boolean;
 }
 export interface ConnectedAccountRefreshResponse {
     /**
-     * The id of the connected account
+     * The unique identifier of the connected account
      */
     id: string;
     /**
-     * The redirect URL of the app (previously named redirect_uri)
+     * The URL to which the user should be redirected to complete the authentication
+     * process (null for auth schemes that do not require redirection)
      */
     redirect_url: string | null;
     /**
-     * The status of the connected account
+     * The current status of the connected account (e.g., active, pending, failed)
      */
-    status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'INITIATED' | 'EXPIRED' | 'FAILED';
+    status: 'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED';
 }
+/**
+ * Response returned after successfully updating a connected account status
+ */
 export interface ConnectedAccountUpdateStatusResponse {
     /**
-     * The success of the update
+     * Indicates whether the connected account status was successfully updated
      */
     success: boolean;
 }
@@ -327,7 +387,7 @@ export interface ConnectedAccountListParams {
     /**
      * The status of the connected account
      */
-    statuses?: Array<'ACTIVE' | 'INACTIVE' | 'DELETED' | 'INITIATED' | 'EXPIRED' | 'FAILED'> | null;
+    statuses?: Array<'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED'> | null;
     /**
      * The toolkit slugs of the connected accounts
      */
@@ -338,6 +398,9 @@ export interface ConnectedAccountListParams {
     user_ids?: Array<string> | null;
 }
 export interface ConnectedAccountUpdateStatusParams {
+    /**
+     * Set to true to enable the account or false to disable it
+     */
     enabled: boolean;
 }
 export declare namespace ConnectedAccounts {

package/resources/connected-accounts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connected-accounts.d.ts","sourceRoot":"","sources":["../src/resources/connected-accounts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gCAAgC,CAAC;IAIhG;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAI5F;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI9F;;OAEG;IACH,YAAY,CACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,kCAAkC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;CAGpD;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,8BAA8B,CAAC,UAAU,CAAC;IAEtD;;;OAGG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;CAChF;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,UAAU;QACzB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,gCAAgC,CAAC,UAAU,CAAC;IAEzD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE9B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;IAE/E;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,OAAO,EAAE,gCAAgC,CAAC,OAAO,CAAC;IAElD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,gCAAgC,CAAC,UAAU,CAAC;IAEzD;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,yBAAiB,gCAAgC,CAAC;IAChD,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EACP,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,SAAS,GACT,OAAO,GACP,cAAc,GACd,cAAc,GACd,wBAAwB,GACxB,SAAS,GACT,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,WAAW,CAAC;QAEhB;;WAEG;QACH,mBAAmB,EAAE,OAAO,CAAC;QAE7B;;WAEG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC;KACpC;IAED,UAAiB,UAAU,CAAC;QAC1B,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C,KAAK,EAAE,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;IAEhD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC;QAE7B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAE9B;;WAEG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;QAE/E;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QAEtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC;QAE7B;;WAEG;QACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;KAChC;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,UAAU;YACzB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,EACP,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,SAAS,GACT,OAAO,GACP,cAAc,GACd,cAAc,GACd,wBAAwB,GACxB,SAAS,GACT,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,WAAW,CAAC;YAEhB;;eAEG;YACH,mBAAmB,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,WAAW,EAAE,OAAO,CAAC;YAErB,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC;SACpC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,UAAU;gBACzB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;aACd;SACF;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,UAAU;YACzB;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;CAChF;AAED,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,WAAW,EAAE,4BAA4B,CAAC,UAAU,CAAC;IAErD,UAAU,EAAE,4BAA4B,CAAC,UAAU,CAAC;CACrD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAE/B;;WAEG;QACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;QAEpC;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,GAAG,YAAY,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC,GAAG,IAAI,CAAC;IAEhG;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,kCAAkC;IACjD,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;CACH"}
+{"version":3,"file":"connected-accounts.d.ts","sourceRoot":"","sources":["../src/resources/connected-accounts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gCAAgC,CAAC;IAIhG;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAI5F;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI9F;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,kCAAkC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;CAGpD;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,8BAA8B,CAAC,UAAU,CAAC;IAEtD;;;OAGG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,cAAc,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;CACxE;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,UAAU;QACzB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,gCAAgC,CAAC,UAAU,CAAC;IAEzD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE9B;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,cAAc,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IAEvE;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,OAAO,EAAE,gCAAgC,CAAC,OAAO,CAAC;IAElD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,gCAAgC,CAAC,UAAU,CAAC;IAEzD;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,yBAAiB,gCAAgC,CAAC;IAChD,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EACP,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,SAAS,GACT,OAAO,GACP,cAAc,GACd,cAAc,GACd,wBAAwB,GACxB,SAAS,GACT,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,WAAW,CAAC;QAEhB;;WAEG;QACH,mBAAmB,EAAE,OAAO,CAAC;QAE7B;;WAEG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC;KACpC;IAED,UAAiB,UAAU,CAAC;QAC1B,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C,KAAK,EAAE,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;IAEhD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC;QAE7B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAE9B;;WAEG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,MAAM,EAAE,cAAc,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;QAEvE;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QAEtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC;QAE7B;;WAEG;QACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;KAChC;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,UAAU;YACzB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,EACP,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,SAAS,GACT,OAAO,GACP,cAAc,GACd,cAAc,GACd,wBAAwB,GACxB,SAAS,GACT,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,WAAW,CAAC;YAEhB;;eAEG;YACH,mBAAmB,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,WAAW,EAAE,OAAO,CAAC;YAErB,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC;SACpC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,UAAU;gBACzB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;aACd;SACF;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,UAAU;YACzB;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,cAAc,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;CACxE;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,WAAW,EAAE,4BAA4B,CAAC,UAAU,CAAC;IAErD,UAAU,EAAE,4BAA4B,CAAC,UAAU,CAAC;CACrD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAE/B;;WAEG;QACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;QAEpC;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,GAAG,YAAY,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC;IAExF;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;CACH"}

package/resources/connected-accounts.js

@@ -7,36 +7,88 @@ const path_1 = require("../internal/utils/path.js");
 class ConnectedAccounts extends resource_1.APIResource {
     /**
      * Create a new connected account
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.create({
+     *     auth_config: { id: 'id' },
+     *     connection: {},
+     *   });
+     * ```
      */
     create(body, options) {
         return this._client.post('/api/v3/connected_accounts', { body, ...options });
     }
     /**
-     * Get connected account details by ID
+     * Retrieves comprehensive details of a connected account, including authentication
+     * configuration, connection status, and all parameters needed for API requests.
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.retrieve(
+     *     'con_1a2b3c4d5e6f',
+     *   );
+     * ```
      */
     retrieve(nanoid, options) {
         return this._client.get((0, path_1.path) `/api/v3/connected_accounts/${nanoid}`, options);
     }
     /**
      * List connected accounts with optional filters
+     *
+     * @example
+     * ```ts
+     * const connectedAccounts =
+     *   await client.connectedAccounts.list();
+     * ```
      */
     list(query = {}, options) {
         return this._client.get('/api/v3/connected_accounts', { query, ...options });
     }
     /**
-     * Delete a connected account
+     * Soft-deletes a connected account by marking it as deleted in the database. This
+     * prevents the account from being used for API calls but preserves the record for
+     * audit purposes.
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.delete('con_1a2b3c4d5e6f');
+     * ```
      */
     delete(nanoid, options) {
         return this._client.delete((0, path_1.path) `/api/v3/connected_accounts/${nanoid}`, options);
     }
     /**
-     * Refresh authentication for a connected account
+     * Initiates a new authentication flow for a connected account when credentials
+     * have expired or become invalid. This may generate a new authentication URL for
+     * OAuth flows or refresh tokens for other auth schemes.
+     *
+     * @example
+     * ```ts
+     * const response = await client.connectedAccounts.refresh(
+     *   'con_1a2b3c4d5e6f',
+     * );
+     * ```
      */
     refresh(nanoid, options) {
         return this._client.post((0, path_1.path) `/api/v3/connected_accounts/${nanoid}/refresh`, options);
     }
     /**
-     * Enable or disable a connected account
+     * Updates the status of a connected account to either enabled (active) or disabled
+     * (inactive). Disabled accounts cannot be used for API calls but remain in the
+     * database.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.connectedAccounts.updateStatus(
+     *     'con_1a2b3c4d5e6f',
+     *     { enabled: true },
+     *   );
+     * ```
      */
     updateStatus(nanoID, body, options) {
         return this._client.patch((0, path_1.path) `/api/v3/connected_accounts/${nanoID}/status`, { body, ...options });

package/resources/connected-accounts.js.map

@@ -1 +1 @@
-{"version":3,"file":"connected-accounts.js","sourceRoot":"","sources":["../src/resources/connected-accounts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,iBAAkB,SAAQ,sBAAW;IAChD;;OAEG;IACH,MAAM,CACJ,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,MAAc,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,MAAc,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED;;OAEG;IACH,YAAY,CACV,MAAc,EACd,IAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;CACF;AApDD,8CAoDC"}
+{"version":3,"file":"connected-accounts.js","sourceRoot":"","sources":["../src/resources/connected-accounts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,iBAAkB,SAAQ,sBAAW;IAChD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAc,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,MAAc,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,MAAc,EACd,IAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;CACF;AAxGD,8CAwGC"}

package/resources/connected-accounts.mjs

@@ -4,36 +4,88 @@ import { path } from "../internal/utils/path.mjs";
 export class ConnectedAccounts extends APIResource {
     /**
      * Create a new connected account
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.create({
+     *     auth_config: { id: 'id' },
+     *     connection: {},
+     *   });
+     * ```
      */
     create(body, options) {
         return this._client.post('/api/v3/connected_accounts', { body, ...options });
     }
     /**
-     * Get connected account details by ID
+     * Retrieves comprehensive details of a connected account, including authentication
+     * configuration, connection status, and all parameters needed for API requests.
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.retrieve(
+     *     'con_1a2b3c4d5e6f',
+     *   );
+     * ```
      */
     retrieve(nanoid, options) {
         return this._client.get(path `/api/v3/connected_accounts/${nanoid}`, options);
     }
     /**
      * List connected accounts with optional filters
+     *
+     * @example
+     * ```ts
+     * const connectedAccounts =
+     *   await client.connectedAccounts.list();
+     * ```
      */
     list(query = {}, options) {
         return this._client.get('/api/v3/connected_accounts', { query, ...options });
     }
     /**
-     * Delete a connected account
+     * Soft-deletes a connected account by marking it as deleted in the database. This
+     * prevents the account from being used for API calls but preserves the record for
+     * audit purposes.
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.delete('con_1a2b3c4d5e6f');
+     * ```
      */
     delete(nanoid, options) {
         return this._client.delete(path `/api/v3/connected_accounts/${nanoid}`, options);
     }
     /**
-     * Refresh authentication for a connected account
+     * Initiates a new authentication flow for a connected account when credentials
+     * have expired or become invalid. This may generate a new authentication URL for
+     * OAuth flows or refresh tokens for other auth schemes.
+     *
+     * @example
+     * ```ts
+     * const response = await client.connectedAccounts.refresh(
+     *   'con_1a2b3c4d5e6f',
+     * );
+     * ```
      */
     refresh(nanoid, options) {
         return this._client.post(path `/api/v3/connected_accounts/${nanoid}/refresh`, options);
     }
     /**
-     * Enable or disable a connected account
+     * Updates the status of a connected account to either enabled (active) or disabled
+     * (inactive). Disabled accounts cannot be used for API calls but remain in the
+     * database.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.connectedAccounts.updateStatus(
+     *     'con_1a2b3c4d5e6f',
+     *     { enabled: true },
+     *   );
+     * ```
      */
     updateStatus(nanoID, body, options) {
         return this._client.patch(path `/api/v3/connected_accounts/${nanoID}/status`, { body, ...options });

package/resources/connected-accounts.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"connected-accounts.mjs","sourceRoot":"","sources":["../src/resources/connected-accounts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAChD;;OAEG;IACH,MAAM,CACJ,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,MAAc,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,MAAc,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,8BAA8B,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED;;OAEG;IACH,YAAY,CACV,MAAc,EACd,IAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,8BAA8B,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;CACF"}
+{"version":3,"file":"connected-accounts.mjs","sourceRoot":"","sources":["../src/resources/connected-accounts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAChD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAc,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,MAAc,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,8BAA8B,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,MAAc,EACd,IAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,8BAA8B,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;CACF"}