@composio/client 0.1.0-alpha.27 → 0.1.0-alpha.29

package/src/resources/tools.ts

@@ -402,6 +402,11 @@ export interface ToolProxyResponse {
 export type ToolRetrieveEnumResponse = string;
 
 export interface ToolListParams {
+  /**
+   * Filter tools by auth config id
+   */
+  auth_config_ids?: Array<string> | null;
+
   /**
    * Cursor for pagination. The cursor is a base64 encoded string of the page and
    * limit. The page is the page number and the limit is the number of items per
@@ -469,6 +474,18 @@ export interface ToolExecuteParams {
    */
   custom_auth_params?: ToolExecuteParams.CustomAuthParams;
 
+  /**
+   * Custom connection data for tools that support custom connection data
+   */
+  custom_connection_data?:
+    | ToolExecuteParams.UnionMember0
+    | ToolExecuteParams.UnionMember1
+    | ToolExecuteParams.UnionMember2
+    | ToolExecuteParams.UnionMember3
+    | ToolExecuteParams.UnionMember4
+    | ToolExecuteParams.UnionMember5
+    | ToolExecuteParams.UnionMember6;
+
   /**
    * Natural language description of the task to perform (mutually exclusive with
    * arguments)
@@ -492,8 +509,6 @@ export namespace ToolExecuteParams {
    * authentication
    */
   export interface CustomAuthParams {
-    parameters: Array<CustomAuthParams.Parameter>;
-
     /**
      * The base URL (root address) what you should use while making http requests to
      * the connected account. For example, for gmail, it would be
@@ -506,6 +521,8 @@ export namespace ToolExecuteParams {
      * Note: This is very rarely needed and is only required by very few apps.
      */
     body?: { [key: string]: unknown };
+
+    parameters?: Array<CustomAuthParams.Parameter>;
   }
 
   export namespace CustomAuthParams {
@@ -526,6 +543,482 @@ export namespace ToolExecuteParams {
       value: string | number;
     }
   }
+
+  export interface UnionMember0 {
+    authScheme: 'OAUTH2';
+
+    toolkitSlug: string;
+
+    val: UnionMember0.Val;
+  }
+
+  export namespace UnionMember0 {
+    export interface Val {
+      access_token: string;
+
+      account_id?: string;
+
+      account_url?: string;
+
+      api_url?: string;
+
+      /**
+       * for slack user scopes
+       */
+      authed_user?: Val.AuthedUser;
+
+      base_url?: string;
+
+      borneo_dashboard_url?: string;
+
+      COMPANYDOMAIN?: string;
+
+      dc?: string;
+
+      domain?: string;
+
+      expires_in?: number | string | null;
+
+      extension?: string;
+
+      form_api_base_url?: string;
+
+      id_token?: string;
+
+      instanceEndpoint?: string;
+
+      instanceName?: string;
+
+      /**
+       * Whether to return the redirect url without shortening
+       */
+      long_redirect_url?: boolean;
+
+      proxy_password?: string;
+
+      proxy_username?: string;
+
+      refresh_token?: string | null;
+
+      region?: string;
+
+      scope?: string | Array<string>;
+
+      server_location?: string;
+
+      shop?: string;
+
+      site_name?: string;
+
+      /**
+       * The oauth2 state prefix for the connection
+       */
+      state_prefix?: string;
+
+      subdomain?: string;
+
+      token_type?: string;
+
+      version?: string;
+
+      webhook_signature?: string;
+
+      your_server?: string;
+
+      'your-domain'?: string;
+
+      [k: string]: unknown;
+    }
+
+    export namespace Val {
+      /**
+       * for slack user scopes
+       */
+      export interface AuthedUser {
+        access_token?: string;
+
+        scope?: string;
+      }
+    }
+  }
+
+  export interface UnionMember1 {
+    authScheme: 'API_KEY';
+
+    toolkitSlug: string;
+
+    val: UnionMember1.Val;
+  }
+
+  export namespace UnionMember1 {
+    export interface Val {
+      account_id?: string;
+
+      account_url?: string;
+
+      api_key?: string;
+
+      api_url?: string;
+
+      base_url?: string;
+
+      basic_encoded?: string;
+
+      bearer_token?: string;
+
+      borneo_dashboard_url?: string;
+
+      COMPANYDOMAIN?: string;
+
+      dc?: string;
+
+      domain?: string;
+
+      extension?: string;
+
+      form_api_base_url?: string;
+
+      generic_api_key?: string;
+
+      instanceEndpoint?: string;
+
+      instanceName?: string;
+
+      proxy_password?: string;
+
+      proxy_username?: string;
+
+      region?: string;
+
+      server_location?: string;
+
+      shop?: string;
+
+      site_name?: string;
+
+      subdomain?: string;
+
+      version?: string;
+
+      your_server?: string;
+
+      'your-domain'?: string;
+
+      [k: string]: unknown;
+    }
+  }
+
+  export interface UnionMember2 {
+    authScheme: 'BASIC_WITH_JWT';
+
+    toolkitSlug: string;
+
+    val: UnionMember2.Val;
+  }
+
+  export namespace UnionMember2 {
+    export interface Val {
+      password: string;
+
+      username: string;
+
+      account_id?: string;
+
+      account_url?: string;
+
+      api_url?: string;
+
+      base_url?: string;
+
+      borneo_dashboard_url?: string;
+
+      COMPANYDOMAIN?: string;
+
+      dc?: string;
+
+      domain?: string;
+
+      extension?: string;
+
+      form_api_base_url?: string;
+
+      instanceEndpoint?: string;
+
+      instanceName?: string;
+
+      proxy_password?: string;
+
+      proxy_username?: string;
+
+      region?: string;
+
+      server_location?: string;
+
+      shop?: string;
+
+      site_name?: string;
+
+      subdomain?: string;
+
+      version?: string;
+
+      your_server?: string;
+
+      'your-domain'?: string;
+
+      [k: string]: unknown;
+    }
+  }
+
+  export interface UnionMember3 {
+    authScheme: 'BASIC';
+
+    toolkitSlug: string;
+
+    val: UnionMember3.Val;
+  }
+
+  export namespace UnionMember3 {
+    export interface Val {
+      password: string;
+
+      username: string;
+
+      account_id?: string;
+
+      account_url?: string;
+
+      api_url?: string;
+
+      base_url?: string;
+
+      borneo_dashboard_url?: string;
+
+      COMPANYDOMAIN?: string;
+
+      dc?: string;
+
+      domain?: string;
+
+      extension?: string;
+
+      form_api_base_url?: string;
+
+      instanceEndpoint?: string;
+
+      instanceName?: string;
+
+      proxy_password?: string;
+
+      proxy_username?: string;
+
+      region?: string;
+
+      server_location?: string;
+
+      shop?: string;
+
+      site_name?: string;
+
+      subdomain?: string;
+
+      version?: string;
+
+      your_server?: string;
+
+      'your-domain'?: string;
+
+      [k: string]: unknown;
+    }
+  }
+
+  export interface UnionMember4 {
+    authScheme: 'BEARER_TOKEN';
+
+    toolkitSlug: string;
+
+    val: UnionMember4.Val;
+  }
+
+  export namespace UnionMember4 {
+    export interface Val {
+      token: string;
+
+      account_id?: string;
+
+      account_url?: string;
+
+      api_url?: string;
+
+      base_url?: string;
+
+      borneo_dashboard_url?: string;
+
+      COMPANYDOMAIN?: string;
+
+      dc?: string;
+
+      domain?: string;
+
+      extension?: string;
+
+      form_api_base_url?: string;
+
+      instanceEndpoint?: string;
+
+      instanceName?: string;
+
+      proxy_password?: string;
+
+      proxy_username?: string;
+
+      region?: string;
+
+      server_location?: string;
+
+      shop?: string;
+
+      site_name?: string;
+
+      subdomain?: string;
+
+      version?: string;
+
+      your_server?: string;
+
+      'your-domain'?: string;
+
+      [k: string]: unknown;
+    }
+  }
+
+  export interface UnionMember5 {
+    authScheme: 'OAUTH1';
+
+    toolkitSlug: string;
+
+    val: UnionMember5.Val;
+  }
+
+  export namespace UnionMember5 {
+    export interface Val {
+      oauth_token: string;
+
+      oauth_token_secret: string;
+
+      account_id?: string;
+
+      account_url?: string;
+
+      api_url?: string;
+
+      base_url?: string;
+
+      borneo_dashboard_url?: string;
+
+      callback_url?: string;
+
+      COMPANYDOMAIN?: string;
+
+      consumer_key?: string;
+
+      dc?: string;
+
+      domain?: string;
+
+      extension?: string;
+
+      form_api_base_url?: string;
+
+      instanceEndpoint?: string;
+
+      instanceName?: string;
+
+      oauth_verifier?: string;
+
+      proxy_password?: string;
+
+      proxy_username?: string;
+
+      redirectUrl?: string;
+
+      region?: string;
+
+      server_location?: string;
+
+      shop?: string;
+
+      site_name?: string;
+
+      subdomain?: string;
+
+      version?: string;
+
+      your_server?: string;
+
+      'your-domain'?: string;
+
+      [k: string]: unknown;
+    }
+  }
+
+  export interface UnionMember6 {
+    authScheme: 'NO_AUTH';
+
+    toolkitSlug: string;
+
+    val: UnionMember6.Val;
+  }
+
+  export namespace UnionMember6 {
+    export interface Val {
+      account_id?: string;
+
+      account_url?: string;
+
+      api_url?: string;
+
+      base_url?: string;
+
+      borneo_dashboard_url?: string;
+
+      COMPANYDOMAIN?: string;
+
+      dc?: string;
+
+      domain?: string;
+
+      extension?: string;
+
+      form_api_base_url?: string;
+
+      instanceEndpoint?: string;
+
+      instanceName?: string;
+
+      proxy_password?: string;
+
+      proxy_username?: string;
+
+      region?: string;
+
+      server_location?: string;
+
+      shop?: string;
+
+      site_name?: string;
+
+      subdomain?: string;
+
+      version?: string;
+
+      your_server?: string;
+
+      'your-domain'?: string;
+
+      [k: string]: unknown;
+    }
+  }
 }
 
 export interface ToolGetInputParams {
@@ -563,7 +1056,7 @@ export interface ToolProxyParams {
   /**
    * The HTTP method to use for the request
    */
-  method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+  method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD';
 
   /**
    * The request body (for POST, PUT, and PATCH requests)
@@ -576,6 +1069,15 @@ export interface ToolProxyParams {
    */
   connected_account_id?: string;
 
+  custom_connection_data?:
+    | ToolProxyParams.UnionMember0
+    | ToolProxyParams.UnionMember1
+    | ToolProxyParams.UnionMember2
+    | ToolProxyParams.UnionMember3
+    | ToolProxyParams.UnionMember4
+    | ToolProxyParams.UnionMember5
+    | ToolProxyParams.UnionMember6;
+
   /**
    * Additional HTTP headers or query parameters to include in the request
    */
@@ -583,6 +1085,482 @@ export interface ToolProxyParams {
 }
 
 export namespace ToolProxyParams {
+  export interface UnionMember0 {
+    authScheme: 'OAUTH2';
+
+    toolkitSlug: string;
+
+    val: UnionMember0.Val;
+  }
+
+  export namespace UnionMember0 {
+    export interface Val {
+      access_token: string;
+
+      account_id?: string;
+
+      account_url?: string;
+
+      api_url?: string;
+
+      /**
+       * for slack user scopes
+       */
+      authed_user?: Val.AuthedUser;
+
+      base_url?: string;
+
+      borneo_dashboard_url?: string;
+
+      COMPANYDOMAIN?: string;
+
+      dc?: string;
+
+      domain?: string;
+
+      expires_in?: number | string | null;
+
+      extension?: string;
+
+      form_api_base_url?: string;
+
+      id_token?: string;
+
+      instanceEndpoint?: string;
+
+      instanceName?: string;
+
+      /**
+       * Whether to return the redirect url without shortening
+       */
+      long_redirect_url?: boolean;
+
+      proxy_password?: string;
+
+      proxy_username?: string;
+
+      refresh_token?: string | null;
+
+      region?: string;
+
+      scope?: string | Array<string>;
+
+      server_location?: string;
+
+      shop?: string;
+
+      site_name?: string;
+
+      /**
+       * The oauth2 state prefix for the connection
+       */
+      state_prefix?: string;
+
+      subdomain?: string;
+
+      token_type?: string;
+
+      version?: string;
+
+      webhook_signature?: string;
+
+      your_server?: string;
+
+      'your-domain'?: string;
+
+      [k: string]: unknown;
+    }
+
+    export namespace Val {
+      /**
+       * for slack user scopes
+       */
+      export interface AuthedUser {
+        access_token?: string;
+
+        scope?: string;
+      }
+    }
+  }
+
+  export interface UnionMember1 {
+    authScheme: 'API_KEY';
+
+    toolkitSlug: string;
+
+    val: UnionMember1.Val;
+  }
+
+  export namespace UnionMember1 {
+    export interface Val {
+      account_id?: string;
+
+      account_url?: string;
+
+      api_key?: string;
+
+      api_url?: string;
+
+      base_url?: string;
+
+      basic_encoded?: string;
+
+      bearer_token?: string;
+
+      borneo_dashboard_url?: string;
+
+      COMPANYDOMAIN?: string;
+
+      dc?: string;
+
+      domain?: string;
+
+      extension?: string;
+
+      form_api_base_url?: string;
+
+      generic_api_key?: string;
+
+      instanceEndpoint?: string;
+
+      instanceName?: string;
+
+      proxy_password?: string;
+
+      proxy_username?: string;
+
+      region?: string;
+
+      server_location?: string;
+
+      shop?: string;
+
+      site_name?: string;
+
+      subdomain?: string;
+
+      version?: string;
+
+      your_server?: string;
+
+      'your-domain'?: string;
+
+      [k: string]: unknown;
+    }
+  }
+
+  export interface UnionMember2 {
+    authScheme: 'BASIC_WITH_JWT';
+
+    toolkitSlug: string;
+
+    val: UnionMember2.Val;
+  }
+
+  export namespace UnionMember2 {
+    export interface Val {
+      password: string;
+
+      username: string;
+
+      account_id?: string;
+
+      account_url?: string;
+
+      api_url?: string;
+
+      base_url?: string;
+
+      borneo_dashboard_url?: string;
+
+      COMPANYDOMAIN?: string;
+
+      dc?: string;
+
+      domain?: string;
+
+      extension?: string;
+
+      form_api_base_url?: string;
+
+      instanceEndpoint?: string;
+
+      instanceName?: string;
+
+      proxy_password?: string;
+
+      proxy_username?: string;
+
+      region?: string;
+
+      server_location?: string;
+
+      shop?: string;
+
+      site_name?: string;
+
+      subdomain?: string;
+
+      version?: string;
+
+      your_server?: string;
+
+      'your-domain'?: string;
+
+      [k: string]: unknown;
+    }
+  }
+
+  export interface UnionMember3 {
+    authScheme: 'BASIC';
+
+    toolkitSlug: string;
+
+    val: UnionMember3.Val;
+  }
+
+  export namespace UnionMember3 {
+    export interface Val {
+      password: string;
+
+      username: string;
+
+      account_id?: string;
+
+      account_url?: string;
+
+      api_url?: string;
+
+      base_url?: string;
+
+      borneo_dashboard_url?: string;
+
+      COMPANYDOMAIN?: string;
+
+      dc?: string;
+
+      domain?: string;
+
+      extension?: string;
+
+      form_api_base_url?: string;
+
+      instanceEndpoint?: string;
+
+      instanceName?: string;
+
+      proxy_password?: string;
+
+      proxy_username?: string;
+
+      region?: string;
+
+      server_location?: string;
+
+      shop?: string;
+
+      site_name?: string;
+
+      subdomain?: string;
+
+      version?: string;
+
+      your_server?: string;
+
+      'your-domain'?: string;
+
+      [k: string]: unknown;
+    }
+  }
+
+  export interface UnionMember4 {
+    authScheme: 'BEARER_TOKEN';
+
+    toolkitSlug: string;
+
+    val: UnionMember4.Val;
+  }
+
+  export namespace UnionMember4 {
+    export interface Val {
+      token: string;
+
+      account_id?: string;
+
+      account_url?: string;
+
+      api_url?: string;
+
+      base_url?: string;
+
+      borneo_dashboard_url?: string;
+
+      COMPANYDOMAIN?: string;
+
+      dc?: string;
+
+      domain?: string;
+
+      extension?: string;
+
+      form_api_base_url?: string;
+
+      instanceEndpoint?: string;
+
+      instanceName?: string;
+
+      proxy_password?: string;
+
+      proxy_username?: string;
+
+      region?: string;
+
+      server_location?: string;
+
+      shop?: string;
+
+      site_name?: string;
+
+      subdomain?: string;
+
+      version?: string;
+
+      your_server?: string;
+
+      'your-domain'?: string;
+
+      [k: string]: unknown;
+    }
+  }
+
+  export interface UnionMember5 {
+    authScheme: 'OAUTH1';
+
+    toolkitSlug: string;
+
+    val: UnionMember5.Val;
+  }
+
+  export namespace UnionMember5 {
+    export interface Val {
+      oauth_token: string;
+
+      oauth_token_secret: string;
+
+      account_id?: string;
+
+      account_url?: string;
+
+      api_url?: string;
+
+      base_url?: string;
+
+      borneo_dashboard_url?: string;
+
+      callback_url?: string;
+
+      COMPANYDOMAIN?: string;
+
+      consumer_key?: string;
+
+      dc?: string;
+
+      domain?: string;
+
+      extension?: string;
+
+      form_api_base_url?: string;
+
+      instanceEndpoint?: string;
+
+      instanceName?: string;
+
+      oauth_verifier?: string;
+
+      proxy_password?: string;
+
+      proxy_username?: string;
+
+      redirectUrl?: string;
+
+      region?: string;
+
+      server_location?: string;
+
+      shop?: string;
+
+      site_name?: string;
+
+      subdomain?: string;
+
+      version?: string;
+
+      your_server?: string;
+
+      'your-domain'?: string;
+
+      [k: string]: unknown;
+    }
+  }
+
+  export interface UnionMember6 {
+    authScheme: 'NO_AUTH';
+
+    toolkitSlug: string;
+
+    val: UnionMember6.Val;
+  }
+
+  export namespace UnionMember6 {
+    export interface Val {
+      account_id?: string;
+
+      account_url?: string;
+
+      api_url?: string;
+
+      base_url?: string;
+
+      borneo_dashboard_url?: string;
+
+      COMPANYDOMAIN?: string;
+
+      dc?: string;
+
+      domain?: string;
+
+      extension?: string;
+
+      form_api_base_url?: string;
+
+      instanceEndpoint?: string;
+
+      instanceName?: string;
+
+      proxy_password?: string;
+
+      proxy_username?: string;
+
+      region?: string;
+
+      server_location?: string;
+
+      shop?: string;
+
+      site_name?: string;
+
+      subdomain?: string;
+
+      version?: string;
+
+      your_server?: string;
+
+      'your-domain'?: string;
+
+      [k: string]: unknown;
+    }
+  }
+
   export interface Parameter {
     /**
      * Parameter name