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

package/src/resources/auth-configs.ts

@@ -6,22 +6,30 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class AuthConfigs extends APIResource {
+  /**
+   * Create new authentication configuration
+   */
   create(body: AuthConfigCreateParams, options?: RequestOptions): APIPromise<AuthConfigCreateResponse> {
     return this._client.post('/api/v3/auth_configs', { body, ...options });
   }
 
+  /**
+   * Get single authentication configuration by ID
+   */
   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> {
+  /**
+   * Update an authentication configuration
+   */
+  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
+   */
   list(
     query: AuthConfigListParams | null | undefined = {},
     options?: RequestOptions,
@@ -29,15 +37,21 @@ export class AuthConfigs extends APIResource {
     return this._client.get('/api/v3/auth_configs', { query, ...options });
   }
 
-  delete(nanoid: string, options?: RequestOptions): APIPromise<AuthConfigDeleteResponse> {
+  /**
+   * Delete an authentication configuration
+   */
+  delete(nanoid: string, options?: RequestOptions): APIPromise<unknown> {
     return this._client.delete(path`/api/v3/auth_configs/${nanoid}`, options);
   }
 
+  /**
+   * Enable or disable an authentication configuration
+   */
   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 +79,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 {
@@ -81,6 +100,8 @@ export interface AuthConfigRetrieveResponse {
    */
   id: string;
 
+  deprecated_params: AuthConfigRetrieveResponse.DeprecatedParams;
+
   /**
    * The name of the auth config
    */
@@ -95,6 +116,11 @@ export interface AuthConfigRetrieveResponse {
 
   toolkit: AuthConfigRetrieveResponse.Toolkit;
 
+  /**
+   * The type of the auth config
+   */
+  type: 'default' | 'custom';
+
   /**
    * The unique id of the auth config
    */
@@ -135,9 +161,21 @@ export interface AuthConfigRetrieveResponse {
    * The date and time the auth config was last updated
    */
   last_updated_at?: string;
+
+  restrict_to_following_tools?: Array<string>;
 }
 
 export namespace AuthConfigRetrieveResponse {
+  export interface DeprecatedParams {
+    default_connector_id: string | null;
+
+    expected_input_fields?: Array<Record<string, unknown>>;
+
+    member_uuid?: string;
+
+    toolkit_id?: string;
+  }
+
   export interface Toolkit {
     /**
      * The logo of the app
@@ -151,11 +189,7 @@ export namespace AuthConfigRetrieveResponse {
   }
 }
 
-export interface AuthConfigUpdateResponse {
-  message: string;
-
-  success: boolean;
-}
+export type AuthConfigUpdateResponse = unknown;
 
 export interface AuthConfigListResponse {
   items: Array<AuthConfigListResponse.Item>;
@@ -172,6 +206,8 @@ export namespace AuthConfigListResponse {
      */
     id: string;
 
+    deprecated_params: Item.DeprecatedParams;
+
     /**
      * The name of the auth config
      */
@@ -186,6 +222,11 @@ export namespace AuthConfigListResponse {
 
     toolkit: Item.Toolkit;
 
+    /**
+     * The type of the auth config
+     */
+    type: 'default' | 'custom';
+
     /**
      * The unique id of the auth config
      */
@@ -226,9 +267,21 @@ export namespace AuthConfigListResponse {
      * The date and time the auth config was last updated
      */
     last_updated_at?: string;
+
+    restrict_to_following_tools?: Array<string>;
   }
 
   export namespace Item {
+    export interface DeprecatedParams {
+      default_connector_id: string | null;
+
+      expected_input_fields?: Array<Record<string, unknown>>;
+
+      member_uuid?: string;
+
+      toolkit_id?: string;
+    }
+
     export interface Toolkit {
       /**
        * The logo of the app
@@ -243,17 +296,9 @@ export namespace AuthConfigListResponse {
   }
 }
 
-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 +323,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 +354,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 +388,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
    */