@composio/client 0.1.0-alpha.62 → 0.1.0-alpha.64

package/resources/connected-accounts.d.mts

@@ -30,7 +30,7 @@ export declare class ConnectedAccounts extends APIResource {
      * ```ts
      * const connectedAccount =
      *   await client.connectedAccounts.retrieve(
-     *     'con_1a2b3c4d5e6f',
+     *     'ca_1a2b3c4d5e6f',
      *   );
      * ```
      */
@@ -56,10 +56,31 @@ export declare class ConnectedAccounts extends APIResource {
      * @example
      * ```ts
      * const connectedAccount =
-     *   await client.connectedAccounts.delete('con_1a2b3c4d5e6f');
+     *   await client.connectedAccounts.delete('ca_1a2b3c4d5e6f');
      * ```
      */
     delete(nanoid: string, options?: RequestOptions): APIPromise<ConnectedAccountDeleteResponse>;
+    /**
+     * Update a connected account. Supports updating the alias and/or credentials. Only
+     * specified fields will be updated. Set a credential field to null to remove it.
+     * Alias must be unique within the same project, entity, and toolkit scope.
+     *
+     * @example
+     * ```ts
+     * const response = await client.connectedAccounts.patch(
+     *   'ca_1a2b3c4d5e6f',
+     *   {
+     *     connection: {
+     *       state: {
+     *         authScheme: 'BEARER_TOKEN',
+     *         val: { token: 'new_access_token' },
+     *       },
+     *     },
+     *   },
+     * );
+     * ```
+     */
+    patch(nanoid: string, body?: ConnectedAccountPatchParams | null | undefined, options?: RequestOptions): APIPromise<ConnectedAccountPatchResponse>;
     /**
      * Initiates a new authentication flow for a connected account when credentials
      * have expired or become invalid. This may generate a new authentication URL for
@@ -68,7 +89,7 @@ export declare class ConnectedAccounts extends APIResource {
      * @example
      * ```ts
      * const response = await client.connectedAccounts.refresh(
-     *   'con_1a2b3c4d5e6f',
+     *   'ca_1a2b3c4d5e6f',
      * );
      * ```
      */
@@ -82,7 +103,7 @@ export declare class ConnectedAccounts extends APIResource {
      * ```ts
      * const response =
      *   await client.connectedAccounts.updateStatus(
-     *     'con_1a2b3c4d5e6f',
+     *     'ca_1a2b3c4d5e6f',
      *     { enabled: true },
      *   );
      * ```
@@ -2427,6 +2448,10 @@ export interface ConnectedAccountRetrieveResponse {
      * The id of the connection
      */
     id: string;
+    /**
+     * A user-defined alias for the connected account
+     */
+    alias: string | null;
     auth_config: ConnectedAccountRetrieveResponse.AuthConfig;
     /**
      * The created at of the connection
@@ -2474,6 +2499,11 @@ export interface ConnectedAccountRetrieveResponse {
      * anymore, you will only be able to read via userId not get it back
      */
     user_id: string;
+    /**
+     * A short, token-friendly identifier for multi-account disambiguation, typically
+     * toolkit-prefixed with 1-2 words (e.g., "gmail_red-castle")
+     */
+    word_id: string | null;
     /**
      * @deprecated
      */
@@ -4840,6 +4870,10 @@ export declare namespace ConnectedAccountListResponse {
          * The id of the connection
          */
         id: string;
+        /**
+         * A user-defined alias for the connected account
+         */
+        alias: string | null;
         auth_config: Item.AuthConfig;
         /**
          * The created at of the connection
@@ -4880,6 +4914,11 @@ export declare namespace ConnectedAccountListResponse {
          * anymore, you will only be able to read via userId not get it back
          */
         user_id: string;
+        /**
+         * A short, token-friendly identifier for multi-account disambiguation, typically
+         * toolkit-prefixed with 1-2 words (e.g., "gmail_red-castle")
+         */
+        word_id: string | null;
         /**
          * @deprecated
          */
@@ -7243,6 +7282,21 @@ export interface ConnectedAccountDeleteResponse {
      */
     success: boolean;
 }
+export interface ConnectedAccountPatchResponse {
+    /**
+     * The unique identifier of the updated connected account
+     */
+    id: string;
+    /**
+     * The current status of the connected account after the update (ACTIVE, EXPIRED,
+     * INACTIVE, etc.)
+     */
+    status: string;
+    /**
+     * Whether the update was successful
+     */
+    success: boolean;
+}
 /**
  * Response schema for a refreshed connected account authentication
  */
@@ -7287,6 +7341,11 @@ export declare namespace ConnectedAccountCreateParams {
         id: string;
     }
     interface Connection {
+        /**
+         * A human-readable alias for this connected account. Must be unique per entity and
+         * toolkit within the project.
+         */
+        alias?: string;
         /**
          * The URL to redirect to after connection completion
          */
@@ -9647,6 +9706,75 @@ export interface ConnectedAccountListParams {
      */
     user_ids?: Array<string> | null;
 }
+export interface ConnectedAccountPatchParams {
+    /**
+     * A human-readable alias for this connected account. Pass an empty string to clear
+     * the alias. Must be unique per entity and toolkit within the project.
+     */
+    alias?: string;
+    connection?: ConnectedAccountPatchParams.Connection;
+}
+export declare namespace ConnectedAccountPatchParams {
+    interface Connection {
+        state: Connection.State;
+    }
+    namespace Connection {
+        interface State {
+            /**
+             * The auth scheme of the connected account. Must match the connection's actual
+             * auth scheme.
+             */
+            authScheme: 'BEARER_TOKEN' | 'API_KEY' | 'BASIC' | 'BASIC_WITH_JWT' | 'GOOGLE_SERVICE_ACCOUNT' | 'SERVICE_ACCOUNT';
+            /**
+             * Credential fields to update. Only provided fields are changed — omitted fields
+             * are preserved. Set a field to null to remove it.
+             */
+            val: State.Val;
+        }
+        namespace State {
+            /**
+             * Credential fields to update. Only provided fields are changed — omitted fields
+             * are preserved. Set a field to null to remove it.
+             */
+            interface Val {
+                token?: string | null;
+                account_id?: string | null;
+                account_url?: string | null;
+                api_key?: string | null;
+                api_url?: string | null;
+                application_id?: string | null;
+                base_url?: string | null;
+                basic_encoded?: string | null;
+                bearer_token?: string | null;
+                borneo_dashboard_url?: string | null;
+                COMPANYDOMAIN?: string | null;
+                credentials_json?: string | null;
+                dc?: string | null;
+                domain?: string | null;
+                extension?: string | null;
+                form_api_base_url?: string | null;
+                generic_api_key?: string | null;
+                installation_id?: string | null;
+                instanceEndpoint?: string | null;
+                instanceName?: string | null;
+                password?: string | null;
+                private_key?: string | null;
+                proxy_password?: string | null;
+                proxy_username?: string | null;
+                region?: string | null;
+                server_location?: string | null;
+                shop?: string | null;
+                site_name?: string | null;
+                subdomain?: string | null;
+                username?: string | null;
+                version?: string | null;
+                your_server?: string | null;
+                'your-domain'?: string | null;
+                [k: string]: unknown;
+            }
+        }
+    }
+}
 export interface ConnectedAccountRefreshParams {
     /**
      * Query param
@@ -9669,6 +9797,6 @@ export interface ConnectedAccountUpdateStatusParams {
     enabled: boolean;
 }
 export declare namespace ConnectedAccounts {
-    export { type ConnectedAccountCreateResponse as ConnectedAccountCreateResponse, type ConnectedAccountRetrieveResponse as ConnectedAccountRetrieveResponse, type ConnectedAccountListResponse as ConnectedAccountListResponse, type ConnectedAccountDeleteResponse as ConnectedAccountDeleteResponse, type ConnectedAccountRefreshResponse as ConnectedAccountRefreshResponse, type ConnectedAccountUpdateStatusResponse as ConnectedAccountUpdateStatusResponse, type ConnectedAccountCreateParams as ConnectedAccountCreateParams, type ConnectedAccountListParams as ConnectedAccountListParams, type ConnectedAccountRefreshParams as ConnectedAccountRefreshParams, type ConnectedAccountUpdateStatusParams as ConnectedAccountUpdateStatusParams, };
+    export { type ConnectedAccountCreateResponse as ConnectedAccountCreateResponse, type ConnectedAccountRetrieveResponse as ConnectedAccountRetrieveResponse, type ConnectedAccountListResponse as ConnectedAccountListResponse, type ConnectedAccountDeleteResponse as ConnectedAccountDeleteResponse, type ConnectedAccountPatchResponse as ConnectedAccountPatchResponse, type ConnectedAccountRefreshResponse as ConnectedAccountRefreshResponse, type ConnectedAccountUpdateStatusResponse as ConnectedAccountUpdateStatusResponse, type ConnectedAccountCreateParams as ConnectedAccountCreateParams, type ConnectedAccountListParams as ConnectedAccountListParams, type ConnectedAccountPatchParams as ConnectedAccountPatchParams, type ConnectedAccountRefreshParams as ConnectedAccountRefreshParams, type ConnectedAccountUpdateStatusParams as ConnectedAccountUpdateStatusParams, };
 }
 //# sourceMappingURL=connected-accounts.d.mts.map