@composio/client 0.1.0-alpha.73 → 0.1.0-alpha.75

package/resources/connected-accounts.d.ts

@@ -60,7 +60,8 @@ export declare class ConnectedAccounts extends APIResource {
     /**
      * 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.
+     * audit purposes. Pass `?revoke_on_delete=true` to also revoke the account's
+     * upstream credentials via a background job.
      *
      * @example
      * ```ts
@@ -68,17 +69,11 @@ export declare class ConnectedAccounts extends APIResource {
      *   await client.connectedAccounts.delete('ca_1a2b3c4d5e6f');
      * ```
      */
-    delete(nanoid: string, options?: RequestOptions): APIPromise<ConnectedAccountDeleteResponse>;
+    delete(nanoid: string, params?: ConnectedAccountDeleteParams | null | undefined, options?: RequestOptions): APIPromise<ConnectedAccountDeleteResponse>;
     /**
-     * Update a connected account. Supports updating alias, credentials, sharing model
-     * (`experimental.account_type`), and per-user ACL
-     * (`experimental.acl_config_for_shared`). Only specified fields are updated. Set a
-     * credential field to null to remove it. Alias must be unique within the same
-     * project, entity, and toolkit scope. Toggling `experimental.account_type` between
-     * PRIVATE and SHARED reuses the stored credentials — no re-auth is required.
-     * Demoting SHARED → PRIVATE atomically clears the stored ACL; supplying
-     * `acl_config_for_shared` in the same call is rejected as
-     * `acl_config_for_shared is only valid on SHARED connections`.
+     * 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
@@ -134,11 +129,6 @@ export interface ConnectedAccountCreateResponse {
      * The connection data of the connected account
      */
     connectionData: ConnectedAccountCreateResponse.UnionMember0 | ConnectedAccountCreateResponse.UnionMember1 | ConnectedAccountCreateResponse.UnionMember2 | ConnectedAccountCreateResponse.UnionMember3 | ConnectedAccountCreateResponse.UnionMember4 | ConnectedAccountCreateResponse.UnionMember5 | ConnectedAccountCreateResponse.UnionMember6 | ConnectedAccountCreateResponse.UnionMember7 | ConnectedAccountCreateResponse.UnionMember8 | ConnectedAccountCreateResponse.UnionMember9 | ConnectedAccountCreateResponse.UnionMember10 | ConnectedAccountCreateResponse.UnionMember11 | ConnectedAccountCreateResponse.UnionMember12 | ConnectedAccountCreateResponse.UnionMember13;
-    /**
-     * @deprecated DEPRECATED: This field will be removed in a future version. Please
-     * use id and auth_config.id instead.
-     */
-    deprecated: ConnectedAccountCreateResponse.Deprecated;
     /**
      * @deprecated DEPRECATED: This field will be removed in a future version
      */
@@ -151,6 +141,11 @@ export interface ConnectedAccountCreateResponse {
      * @deprecated DEPRECATED: This field will be removed in a future version
      */
     status: 'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED' | 'INACTIVE' | 'REVOKED';
+    /**
+     * @deprecated DEPRECATED: This field will be removed in a future version. Please
+     * use id and auth_config.id instead.
+     */
+    deprecated?: ConnectedAccountCreateResponse.Deprecated;
     /**
      * Experimental features - not stable, may be modified or removed in future
      * versions.
@@ -2369,14 +2364,14 @@ export declare namespace ConnectedAccountCreateResponse {
         }
         interface UnionMember2 {
             access_token: string;
-            client_id: string;
-            client_secret: string;
             status: 'ACTIVE';
             account_id?: string;
             account_url?: string;
             api_url?: string;
             base_url?: string;
             borneo_dashboard_url?: string;
+            client_id?: string;
+            client_secret?: string;
             COMPANYDOMAIN?: string;
             dc?: string;
             domain?: string;
@@ -2402,14 +2397,14 @@ export declare namespace ConnectedAccountCreateResponse {
         }
         interface UnionMember3 {
             access_token: string;
-            client_id: string;
-            client_secret: string;
             status: 'INACTIVE';
             account_id?: string;
             account_url?: string;
             api_url?: string;
             base_url?: string;
             borneo_dashboard_url?: string;
+            client_id?: string;
+            client_secret?: string;
             COMPANYDOMAIN?: string;
             dc?: string;
             domain?: string;
@@ -2606,6 +2601,17 @@ export interface ConnectedAccountRetrieveResponse {
      * versions.
      */
     experimental?: ConnectedAccountRetrieveResponse.Experimental;
+    /**
+     * OAuth scopes requested when this connection was most recently initiated (create
+     * or refresh). Absent for connections created before scope snapshots were captured
+     * and for non-OAuth auth schemes.
+     */
+    requested_scopes?: Array<string>;
+    /**
+     * OAuth user-token scopes requested at the most recent initiation. Only meaningful
+     * for Slackbot auth configs (user-token scopes); absent otherwise.
+     */
+    requested_user_scopes?: Array<string>;
     /**
      * The endpoint to make test request for verification
      */
@@ -4856,14 +4862,14 @@ export declare namespace ConnectedAccountRetrieveResponse {
         }
         interface UnionMember2 {
             access_token: string;
-            client_id: string;
-            client_secret: string;
             status: 'ACTIVE';
             account_id?: string;
             account_url?: string;
             api_url?: string;
             base_url?: string;
             borneo_dashboard_url?: string;
+            client_id?: string;
+            client_secret?: string;
             COMPANYDOMAIN?: string;
             dc?: string;
             domain?: string;
@@ -4889,14 +4895,14 @@ export declare namespace ConnectedAccountRetrieveResponse {
         }
         interface UnionMember3 {
             access_token: string;
-            client_id: string;
-            client_secret: string;
             status: 'INACTIVE';
             account_id?: string;
             account_url?: string;
             api_url?: string;
             base_url?: string;
             borneo_dashboard_url?: string;
+            client_id?: string;
+            client_secret?: string;
             COMPANYDOMAIN?: string;
             dc?: string;
             domain?: string;
@@ -7349,14 +7355,14 @@ export declare namespace ConnectedAccountListResponse {
             }
             interface UnionMember2 {
                 access_token: string;
-                client_id: string;
-                client_secret: string;
                 status: 'ACTIVE';
                 account_id?: string;
                 account_url?: string;
                 api_url?: string;
                 base_url?: string;
                 borneo_dashboard_url?: string;
+                client_id?: string;
+                client_secret?: string;
                 COMPANYDOMAIN?: string;
                 dc?: string;
                 domain?: string;
@@ -7382,14 +7388,14 @@ export declare namespace ConnectedAccountListResponse {
             }
             interface UnionMember3 {
                 access_token: string;
-                client_id: string;
-                client_secret: string;
                 status: 'INACTIVE';
                 account_id?: string;
                 account_url?: string;
                 api_url?: string;
                 base_url?: string;
                 borneo_dashboard_url?: string;
+                client_id?: string;
+                client_secret?: string;
                 COMPANYDOMAIN?: string;
                 dc?: string;
                 domain?: string;
@@ -7528,6 +7534,13 @@ export interface ConnectedAccountDeleteResponse {
      * Indicates whether the connected account was successfully deleted
      */
     success: boolean;
+    /**
+     * Identifier of the background revoke job started for this delete. Present only
+     * when `revoke_on_delete=true`. Track the job and its per-connection results from
+     * the Composio dashboard — a programmatic endpoint to poll this job is not yet
+     * generally available.
+     */
+    revoke_job_id?: string;
 }
 export interface ConnectedAccountPatchResponse {
     /**
@@ -9882,14 +9895,14 @@ export declare namespace ConnectedAccountCreateParams {
             }
             interface UnionMember2 {
                 access_token: string;
-                client_id: string;
-                client_secret: string;
                 status: 'ACTIVE';
                 account_id?: string;
                 account_url?: string;
                 api_url?: string;
                 base_url?: string;
                 borneo_dashboard_url?: string;
+                client_id?: string;
+                client_secret?: string;
                 COMPANYDOMAIN?: string;
                 dc?: string;
                 domain?: string;
@@ -9915,14 +9928,14 @@ export declare namespace ConnectedAccountCreateParams {
             }
             interface UnionMember3 {
                 access_token: string;
-                client_id: string;
-                client_secret: string;
                 status: 'INACTIVE';
                 account_id?: string;
                 account_url?: string;
                 api_url?: string;
                 base_url?: string;
                 borneo_dashboard_url?: string;
+                client_id?: string;
+                client_secret?: string;
                 COMPANYDOMAIN?: string;
                 dc?: string;
                 domain?: string;
@@ -10048,6 +10061,15 @@ export interface ConnectedAccountListParams {
      */
     user_ids?: Array<string> | null;
 }
+export interface ConnectedAccountDeleteParams {
+    /**
+     * When `true`, the delete also starts a background job that revokes the upstream
+     * credentials of every connected account in scope, and the response carries a
+     * `revoke_job_id`. Defaults to `false`. Revocation is irreversible — recovering a
+     * deleted entity does not restore working credentials.
+     */
+    revoke_on_delete?: boolean | null;
+}
 export interface ConnectedAccountPatchParams {
     /**
      * A human-readable alias for this connected account. Pass an empty string to clear
@@ -10085,39 +10107,21 @@ export declare namespace ConnectedAccountPatchParams {
              */
             interface Val {
                 token?: string | null;
-                account_id?: string | null;
-                account_url?: string | null;
                 api_key?: string | null;
-                api_url?: string | null;
+                api_key_prefix?: 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;
+                generic_id?: string | null;
+                generic_secret?: string | null;
+                generic_token?: 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;
+                user_agent?: string | null;
                 username?: string | null;
-                version?: string | null;
-                your_server?: string | null;
-                'your-domain'?: string | null;
-                [k: string]: unknown;
             }
         }
     }
@@ -10126,12 +10130,6 @@ export declare namespace ConnectedAccountPatchParams {
      * versions.
      */
     interface Experimental {
-        /**
-         * Mutate the sharing model. PRIVATE → SHARED promotes the existing connection
-         * without re-auth; SHARED → PRIVATE revokes all non-creator access and clears the
-         * stored ACL atomically. Omit to leave unchanged.
-         */
-        account_type?: 'PRIVATE' | 'SHARED';
         /**
          * Access control for SHARED connections. Resolution rule (only fires when caller
          * != creator): user in not_allowed_user_ids → DENY; allow_all_users=true → ALLOW;
@@ -10186,6 +10184,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 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, };
+    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 ConnectedAccountDeleteParams as ConnectedAccountDeleteParams, type ConnectedAccountPatchParams as ConnectedAccountPatchParams, type ConnectedAccountRefreshParams as ConnectedAccountRefreshParams, type ConnectedAccountUpdateStatusParams as ConnectedAccountUpdateStatusParams, };
 }
 //# sourceMappingURL=connected-accounts.d.ts.map