@composio/client 0.1.0-alpha.1 → 0.1.0-alpha.11

package/src/resources/auth-configs.ts

@@ -6,22 +6,59 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class AuthConfigs extends APIResource {
+  /**
+   * Create new authentication configuration
+   *
+   * @example
+   * ```ts
+   * const authConfig = await client.authConfigs.create({
+   *   toolkit: { slug: 'slug' },
+   * });
+   * ```
+   */
   create(body: AuthConfigCreateParams, options?: RequestOptions): APIPromise<AuthConfigCreateResponse> {
     return this._client.post('/api/v3/auth_configs', { body, ...options });
   }
 
+  /**
+   * Retrieves detailed information about a specific authentication configuration
+   * using its unique identifier.
+   *
+   * @example
+   * ```ts
+   * const authConfig = await client.authConfigs.retrieve(
+   *   'nanoid',
+   * );
+   * ```
+   */
   retrieve(nanoid: string, options?: RequestOptions): APIPromise<AuthConfigRetrieveResponse> {
     return this._client.get(path`/api/v3/auth_configs/${nanoid}`, options);
   }
 
-  update(
-    nanoid: string,
-    body: AuthConfigUpdateParams,
-    options?: RequestOptions,
-  ): APIPromise<AuthConfigUpdateResponse> {
+  /**
+   * Modifies an existing authentication configuration with new credentials or other
+   * settings. Only specified fields will be updated.
+   *
+   * @example
+   * ```ts
+   * const authConfig = await client.authConfigs.update(
+   *   'nanoid',
+   *   { credentials: { foo: 'bar' }, type: 'custom' },
+   * );
+   * ```
+   */
+  update(nanoid: string, body: AuthConfigUpdateParams, options?: RequestOptions): APIPromise<unknown> {
     return this._client.patch(path`/api/v3/auth_configs/${nanoid}`, { body, ...options });
   }
 
+  /**
+   * List authentication configurations with optional filters
+   *
+   * @example
+   * ```ts
+   * const authConfigs = await client.authConfigs.list();
+   * ```
+   */
   list(
     query: AuthConfigListParams | null | undefined = {},
     options?: RequestOptions,
@@ -29,15 +66,38 @@ export class AuthConfigs extends APIResource {
     return this._client.get('/api/v3/auth_configs', { query, ...options });
   }
 
-  delete(nanoid: string, options?: RequestOptions): APIPromise<AuthConfigDeleteResponse> {
+  /**
+   * Soft-deletes an authentication configuration by marking it as deleted in the
+   * database. This operation cannot be undone.
+   *
+   * @example
+   * ```ts
+   * const authConfig = await client.authConfigs.delete(
+   *   'nanoid',
+   * );
+   * ```
+   */
+  delete(nanoid: string, options?: RequestOptions): APIPromise<unknown> {
     return this._client.delete(path`/api/v3/auth_configs/${nanoid}`, options);
   }
 
+  /**
+   * Updates the status of an authentication configuration to either enabled or
+   * disabled. Disabled configurations cannot be used for new connections.
+   *
+   * @example
+   * ```ts
+   * const response = await client.authConfigs.updateStatus(
+   *   'ENABLED',
+   *   { nanoid: 'nanoid' },
+   * );
+   * ```
+   */
   updateStatus(
     status: 'ENABLED' | 'DISABLED',
     params: AuthConfigUpdateStatusParams,
     options?: RequestOptions,
-  ): APIPromise<AuthConfigUpdateStatusResponse> {
+  ): APIPromise<unknown> {
     const { nanoid } = params;
     return this._client.patch(path`/api/v3/auth_configs/${nanoid}/${status}`, options);
   }
@@ -65,6 +125,11 @@ export namespace AuthConfigCreateResponse {
      * Whether the auth config is managed by Composio
      */
     is_composio_managed: boolean;
+
+    /**
+     * The actions that the user can perform on the auth config
+     */
+    restrict_to_following_tools?: Array<string>;
   }
 
   export interface Toolkit {
@@ -77,29 +142,48 @@ export namespace AuthConfigCreateResponse {
 
 export interface AuthConfigRetrieveResponse {
   /**
-   * The unique id of the auth config
+   * The unique ID of the authentication configuration
    */
   id: string;
 
   /**
-   * The name of the auth config
+   * Deprecated parameters maintained for backward compatibility
+   */
+  deprecated_params: AuthConfigRetrieveResponse.DeprecatedParams;
+
+  /**
+   * The display name of the authentication configuration
    */
   name: string;
 
   /**
-   * The number of connections for the auth config
+   * The number of active connections using this auth config
    */
   no_of_connections: number;
 
+  /**
+   * Current status of the authentication configuration
+   */
   status: 'ENABLED' | 'DISABLED';
 
+  /**
+   * Information about the associated integration
+   */
   toolkit: AuthConfigRetrieveResponse.Toolkit;
 
   /**
-   * The unique id of the auth config
+   * The type of the authentication configuration (custom or default)
+   */
+  type: 'default' | 'custom';
+
+  /**
+   * The UUID of the authentication configuration (for backward compatibility)
    */
   uuid: string;
 
+  /**
+   * The authentication scheme used (e.g., OAuth2, API Key, etc.)
+   */
   auth_scheme?:
     | 'OAUTH2'
     | 'OAUTH1'
@@ -116,46 +200,85 @@ export interface AuthConfigRetrieveResponse {
     | 'SNOWFLAKE';
 
   /**
-   * The date and time the auth config was created
+   * ISO 8601 date-time when the auth config was created
    */
   created_at?: string;
 
   /**
-   * The user who created the auth config
+   * The identifier of the user who created the auth config
    */
   created_by?: string;
 
+  /**
+   * The authentication credentials (tokens, keys, etc.) - may be partially hidden
+   * for security
+   */
   credentials?: Record<string, unknown>;
 
+  /**
+   * Fields expected during connection initialization
+   */
   expected_input_fields?: Array<unknown>;
 
+  /**
+   * Whether this authentication configuration is managed by Composio or the user
+   */
   is_composio_managed?: boolean;
 
   /**
-   * The date and time the auth config was last updated
+   * ISO 8601 date-time when the auth config was last updated
    */
   last_updated_at?: string;
+
+  /**
+   * List of tool IDs this auth config is restricted to use with
+   */
+  restrict_to_following_tools?: Array<string>;
 }
 
 export namespace AuthConfigRetrieveResponse {
+  /**
+   * Deprecated parameters maintained for backward compatibility
+   */
+  export interface DeprecatedParams {
+    /**
+     * Deprecated: Default connector ID
+     */
+    default_connector_id: string | null;
+
+    /**
+     * Deprecated: Fields expected during connection initialization
+     */
+    expected_input_fields?: Array<Record<string, unknown>>;
+
+    /**
+     * Deprecated: Member UUID
+     */
+    member_uuid?: string;
+
+    /**
+     * Deprecated: Toolkit ID
+     */
+    toolkit_id?: string;
+  }
+
+  /**
+   * Information about the associated integration
+   */
   export interface Toolkit {
     /**
-     * The logo of the app
+     * The URL to the integration app's logo image
      */
     logo: string;
 
     /**
-     * The unique key of the app
+     * The unique identifier of the integration app
      */
     slug: string;
   }
 }
 
-export interface AuthConfigUpdateResponse {
-  message: string;
-
-  success: boolean;
-}
+export type AuthConfigUpdateResponse = unknown;
 
 export interface AuthConfigListResponse {
   items: Array<AuthConfigListResponse.Item>;
@@ -168,29 +291,48 @@ export interface AuthConfigListResponse {
 export namespace AuthConfigListResponse {
   export interface Item {
     /**
-     * The unique id of the auth config
+     * The unique ID of the authentication configuration
      */
     id: string;
 
     /**
-     * The name of the auth config
+     * Deprecated parameters maintained for backward compatibility
+     */
+    deprecated_params: Item.DeprecatedParams;
+
+    /**
+     * The display name of the authentication configuration
      */
     name: string;
 
     /**
-     * The number of connections for the auth config
+     * The number of active connections using this auth config
      */
     no_of_connections: number;
 
+    /**
+     * Current status of the authentication configuration
+     */
     status: 'ENABLED' | 'DISABLED';
 
+    /**
+     * Information about the associated integration
+     */
     toolkit: Item.Toolkit;
 
     /**
-     * The unique id of the auth config
+     * The type of the authentication configuration (custom or default)
+     */
+    type: 'default' | 'custom';
+
+    /**
+     * The UUID of the authentication configuration (for backward compatibility)
      */
     uuid: string;
 
+    /**
+     * The authentication scheme used (e.g., OAuth2, API Key, etc.)
+     */
     auth_scheme?:
       | 'OAUTH2'
       | 'OAUTH1'
@@ -207,53 +349,88 @@ export namespace AuthConfigListResponse {
       | 'SNOWFLAKE';
 
     /**
-     * The date and time the auth config was created
+     * ISO 8601 date-time when the auth config was created
      */
     created_at?: string;
 
     /**
-     * The user who created the auth config
+     * The identifier of the user who created the auth config
      */
     created_by?: string;
 
+    /**
+     * The authentication credentials (tokens, keys, etc.) - may be partially hidden
+     * for security
+     */
     credentials?: Record<string, unknown>;
 
+    /**
+     * Fields expected during connection initialization
+     */
     expected_input_fields?: Array<unknown>;
 
+    /**
+     * Whether this authentication configuration is managed by Composio or the user
+     */
     is_composio_managed?: boolean;
 
     /**
-     * The date and time the auth config was last updated
+     * ISO 8601 date-time when the auth config was last updated
      */
     last_updated_at?: string;
+
+    /**
+     * List of tool IDs this auth config is restricted to use with
+     */
+    restrict_to_following_tools?: Array<string>;
   }
 
   export namespace Item {
+    /**
+     * Deprecated parameters maintained for backward compatibility
+     */
+    export interface DeprecatedParams {
+      /**
+       * Deprecated: Default connector ID
+       */
+      default_connector_id: string | null;
+
+      /**
+       * Deprecated: Fields expected during connection initialization
+       */
+      expected_input_fields?: Array<Record<string, unknown>>;
+
+      /**
+       * Deprecated: Member UUID
+       */
+      member_uuid?: string;
+
+      /**
+       * Deprecated: Toolkit ID
+       */
+      toolkit_id?: string;
+    }
+
+    /**
+     * Information about the associated integration
+     */
     export interface Toolkit {
       /**
-       * The logo of the app
+       * The URL to the integration app's logo image
        */
       logo: string;
 
       /**
-       * The unique key of the app
+       * The unique identifier of the integration app
        */
       slug: string;
     }
   }
 }
 
-export interface AuthConfigDeleteResponse {
-  message: string;
-
-  success: boolean;
-}
-
-export interface AuthConfigUpdateStatusResponse {
-  message: string;
+export type AuthConfigDeleteResponse = unknown;
 
-  success: boolean;
-}
+export type AuthConfigUpdateStatusResponse = unknown;
 
 export interface AuthConfigCreateParams {
   toolkit: AuthConfigCreateParams.Toolkit;
@@ -278,6 +455,11 @@ export namespace AuthConfigCreateParams {
      * The name of the integration
      */
     name?: string;
+
+    /**
+     * The actions that the user can perform on the auth config
+     */
+    restrict_to_following_tools?: Array<string>;
   }
 
   export interface UnionMember1 {
@@ -304,19 +486,31 @@ export namespace AuthConfigCreateParams {
      * The name of the integration
      */
     name?: string;
+
+    /**
+     * The actions that the user can perform on the auth config
+     */
+    restrict_to_following_tools?: Array<string>;
   }
 }
 
-export interface AuthConfigUpdateParams {
-  auth_config: AuthConfigUpdateParams.AuthConfig;
-}
+export type AuthConfigUpdateParams = AuthConfigUpdateParams.Variant0 | AuthConfigUpdateParams.Variant1;
 
-export namespace AuthConfigUpdateParams {
-  export interface AuthConfig {
-    /**
-     * Authentication configuration
-     */
-    credentials?: Record<string, unknown>;
+export declare namespace AuthConfigUpdateParams {
+  export interface Variant0 {
+    credentials: Record<string, unknown>;
+
+    type: 'custom';
+
+    restrict_to_following_tools?: Array<string>;
+  }
+
+  export interface Variant1 {
+    scopes: string;
+
+    type: 'default';
+
+    restrict_to_following_tools?: Array<string>;
   }
 }
 
@@ -326,6 +520,13 @@ export interface AuthConfigListParams {
    */
   cursor?: string;
 
+  /**
+   * The app id to filter by
+   */
+  deprecated_app_id?: string;
+
+  deprecated_status?: string;
+
   /**
    * Whether to filter by composio managed auth configs
    */
@@ -336,6 +537,11 @@ export interface AuthConfigListParams {
    */
   limit?: string;
 
+  /**
+   * Show disabled auth configs
+   */
+  show_disabled?: boolean;
+
   /**
    * The slug of the toolkit to filter by
    */
@@ -343,6 +549,9 @@ export interface AuthConfigListParams {
 }
 
 export interface AuthConfigUpdateStatusParams {
+  /**
+   * The unique identifier of the authentication configuration to update
+   */
   nanoid: string;
 }