@composio/client 0.1.0-alpha.26 → 0.1.0-alpha.28

package/src/client.ts

@@ -33,6 +33,14 @@ import {
   AuthConfigUpdateStatusResponse,
   AuthConfigs,
 } from './resources/auth-configs';
+import {
+  Cli,
+  CliCreateSessionResponse,
+  CliGetSessionParams,
+  CliGetSessionResponse,
+  CliLinkSessionParams,
+  CliLinkSessionResponse,
+} from './resources/cli';
 import {
   ConnectedAccountCreateParams,
   ConnectedAccountCreateResponse,
@@ -293,7 +301,7 @@ export class Composio {
    * Create a new client instance re-using the same options given to the current client with optional overriding.
    */
   withOptions(options: Partial<ClientOptions>): this {
-    return new (this.constructor as any as new (props: ClientOptions) => typeof this)({
+    const client = new (this.constructor as any as new (props: ClientOptions) => typeof this)({
       ...this._options,
       environment: options.environment ? options.environment : undefined,
       baseURL: options.environment ? undefined : this.baseURL,
@@ -306,6 +314,7 @@ export class Composio {
       apiKey: this.apiKey,
       ...options,
     });
+    return client;
   }
 
   /**
@@ -320,19 +329,10 @@ export class Composio {
   }
 
   protected validateHeaders({ values, nulls }: NullableHeaders) {
-    if (this.apiKey && values.get('x-api-key')) {
-      return;
-    }
-    if (nulls.has('x-api-key')) {
-      return;
-    }
-
-    throw new Error(
-      'Could not resolve authentication method. Expected the apiKey to be set. Or for the "x-api-key" headers to be explicitly omitted',
-    );
+    return;
   }
 
-  protected authHeaders(opts: FinalRequestOptions): NullableHeaders | undefined {
+  protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
     if (this.apiKey == null) {
       return undefined;
     }
@@ -451,7 +451,9 @@ export class Composio {
 
     await this.prepareOptions(options);
 
-    const { req, url, timeout } = this.buildRequest(options, { retryCount: maxRetries - retriesRemaining });
+    const { req, url, timeout } = await this.buildRequest(options, {
+      retryCount: maxRetries - retriesRemaining,
+    });
 
     await this.prepareRequest(req, { url, options });
 
@@ -529,7 +531,7 @@ export class Composio {
     } with status ${response.status} in ${headersTime - startTime}ms`;
 
     if (!response.ok) {
-      const shouldRetry = this.shouldRetry(response);
+      const shouldRetry = await this.shouldRetry(response);
       if (retriesRemaining && shouldRetry) {
         const retryMessage = `retrying, ${retriesRemaining} attempts remaining`;
 
@@ -628,7 +630,7 @@ export class Composio {
     }
   }
 
-  private shouldRetry(response: Response): boolean {
+  private async shouldRetry(response: Response): Promise<boolean> {
     // Note this is not a standard header.
     const shouldRetryHeader = response.headers.get('x-should-retry');
 
@@ -705,10 +707,10 @@ export class Composio {
     return sleepSeconds * jitter * 1000;
   }
 
-  buildRequest(
+  async buildRequest(
     inputOptions: FinalRequestOptions,
     { retryCount = 0 }: { retryCount?: number } = {},
-  ): { req: FinalizedRequestInit; url: string; timeout: number } {
+  ): Promise<{ req: FinalizedRequestInit; url: string; timeout: number }> {
     const options = { ...inputOptions };
     const { method, path, query, defaultBaseURL } = options;
 
@@ -716,7 +718,7 @@ export class Composio {
     if ('timeout' in options) validatePositiveInteger('timeout', options.timeout);
     options.timeout = options.timeout ?? this.timeout;
     const { bodyHeaders, body } = this.buildBody({ options });
-    const reqHeaders = this.buildHeaders({ options: inputOptions, method, bodyHeaders, retryCount });
+    const reqHeaders = await this.buildHeaders({ options: inputOptions, method, bodyHeaders, retryCount });
 
     const req: FinalizedRequestInit = {
       method,
@@ -732,7 +734,7 @@ export class Composio {
     return { req, url, timeout: options.timeout };
   }
 
-  private buildHeaders({
+  private async buildHeaders({
     options,
     method,
     bodyHeaders,
@@ -742,7 +744,7 @@ export class Composio {
     method: HTTPMethod;
     bodyHeaders: HeadersLike;
     retryCount: number;
-  }): Headers {
+  }): Promise<Headers> {
     let idempotencyHeaders: HeadersLike = {};
     if (this.idempotencyHeader && method !== 'get') {
       if (!options.idempotencyKey) options.idempotencyKey = this.defaultIdempotencyKey();
@@ -758,7 +760,7 @@ export class Composio {
         ...(options.timeout ? { 'X-Stainless-Timeout': String(Math.trunc(options.timeout / 1000)) } : {}),
         ...getPlatformHeaders(),
       },
-      this.authHeaders(options),
+      await this.authHeaders(options),
       this._options.defaultHeaders,
       bodyHeaders,
       options.headers,
@@ -836,6 +838,7 @@ export class Composio {
   mcp: API.Mcp = new API.Mcp(this);
   files: API.Files = new API.Files(this);
   migration: API.Migration = new API.Migration(this);
+  cli: API.Cli = new API.Cli(this);
 }
 Composio.AuthConfigs = AuthConfigs;
 Composio.ConnectedAccounts = ConnectedAccounts;
@@ -848,6 +851,7 @@ Composio.TriggersTypes = TriggersTypes;
 Composio.Mcp = Mcp;
 Composio.Files = Files;
 Composio.Migration = Migration;
+Composio.Cli = Cli;
 export declare namespace Composio {
   export type RequestOptions = Opts.RequestOptions;
 
@@ -959,4 +963,13 @@ export declare namespace Composio {
     type MigrationRetrieveNanoidResponse as MigrationRetrieveNanoidResponse,
     type MigrationRetrieveNanoidParams as MigrationRetrieveNanoidParams,
   };
+
+  export {
+    Cli as Cli,
+    type CliCreateSessionResponse as CliCreateSessionResponse,
+    type CliGetSessionResponse as CliGetSessionResponse,
+    type CliLinkSessionResponse as CliLinkSessionResponse,
+    type CliGetSessionParams as CliGetSessionParams,
+    type CliLinkSessionParams as CliLinkSessionParams,
+  };
 }

package/src/resources/auth-configs.ts

@@ -166,6 +166,8 @@ export interface AuthConfigRetrieveResponse {
    */
   status: 'ENABLED' | 'DISABLED';
 
+  tool_access_config: AuthConfigRetrieveResponse.ToolAccessConfig;
+
   /**
    * Information about the associated integration
    */
@@ -227,11 +229,6 @@ export interface AuthConfigRetrieveResponse {
    * 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 {
@@ -260,6 +257,20 @@ export namespace AuthConfigRetrieveResponse {
     toolkit_id?: string;
   }
 
+  export interface ToolAccessConfig {
+    /**
+     * The actions that the user can perform on the auth config. If passed, this will
+     * update the actions that the user can perform on the auth config.
+     */
+    tools_available_for_execution?: Array<string>;
+
+    /**
+     * Tools used to generate the minimum required scopes for the auth config (only
+     * valid for OAuth). If passed, this will update the scopes.
+     */
+    tools_for_connected_account_creation?: Array<string>;
+  }
+
   /**
    * Information about the associated integration
    */
@@ -317,6 +328,8 @@ export namespace AuthConfigListResponse {
      */
     status: 'ENABLED' | 'DISABLED';
 
+    tool_access_config: Item.ToolAccessConfig;
+
     /**
      * Information about the associated integration
      */
@@ -378,11 +391,6 @@ export namespace AuthConfigListResponse {
      * 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 {
@@ -411,6 +419,20 @@ export namespace AuthConfigListResponse {
       toolkit_id?: string;
     }
 
+    export interface ToolAccessConfig {
+      /**
+       * The actions that the user can perform on the auth config. If passed, this will
+       * update the actions that the user can perform on the auth config.
+       */
+      tools_available_for_execution?: Array<string>;
+
+      /**
+       * Tools used to generate the minimum required scopes for the auth config (only
+       * valid for OAuth). If passed, this will update the scopes.
+       */
+      tools_for_connected_account_creation?: Array<string>;
+    }
+
     /**
      * Information about the associated integration
      */
@@ -456,10 +478,17 @@ export namespace AuthConfigCreateParams {
      */
     name?: string;
 
-    /**
-     * The actions that the user can perform on the auth config
-     */
-    restrict_to_following_tools?: Array<string>;
+    tool_access_config?: UnionMember0.ToolAccessConfig;
+  }
+
+  export namespace UnionMember0 {
+    export interface ToolAccessConfig {
+      /**
+       * Tools used to generate the minimum required scopes for the auth config (only
+       * valid for OAuth). If passed, this will update the scopes.
+       */
+      tools_for_connected_account_creation?: Array<string>;
+    }
   }
 
   export interface UnionMember1 {
@@ -487,10 +516,7 @@ export namespace AuthConfigCreateParams {
 
     proxy_config?: UnionMember1.ProxyConfig;
 
-    /**
-     * The actions that the user can perform on the auth config
-     */
-    restrict_to_following_tools?: Array<string>;
+    tool_access_config?: UnionMember1.ToolAccessConfig;
   }
 
   export namespace UnionMember1 {
@@ -505,6 +531,14 @@ export namespace AuthConfigCreateParams {
        */
       proxy_auth_key?: string;
     }
+
+    export interface ToolAccessConfig {
+      /**
+       * Tools used to generate the minimum required scopes for the auth config (only
+       * valid for OAuth). If passed, this will update the scopes.
+       */
+      tools_for_connected_account_creation?: Array<string>;
+    }
   }
 }
 
@@ -516,15 +550,47 @@ export declare namespace AuthConfigUpdateParams {
 
     type: 'custom';
 
-    restrict_to_following_tools?: Array<string>;
+    tool_access_config?: Variant0.ToolAccessConfig;
   }
 
-  export interface Variant1 {
-    scopes: string;
+  export namespace Variant0 {
+    export interface ToolAccessConfig {
+      /**
+       * The actions that the user can perform on the auth config. If passed, this will
+       * update the actions that the user can perform on the auth config.
+       */
+      tools_available_for_execution?: Array<string>;
 
+      /**
+       * Tools used to generate the minimum required scopes for the auth config (only
+       * valid for OAuth). If passed, this will update the scopes.
+       */
+      tools_for_connected_account_creation?: Array<string>;
+    }
+  }
+
+  export interface Variant1 {
     type: 'default';
 
-    restrict_to_following_tools?: Array<string>;
+    scopes?: string;
+
+    tool_access_config?: Variant1.ToolAccessConfig;
+  }
+
+  export namespace Variant1 {
+    export interface ToolAccessConfig {
+      /**
+       * The actions that the user can perform on the auth config. If passed, this will
+       * update the actions that the user can perform on the auth config.
+       */
+      tools_available_for_execution?: Array<string>;
+
+      /**
+       * Tools used to generate the minimum required scopes for the auth config (only
+       * valid for OAuth). If passed, this will update the scopes.
+       */
+      tools_for_connected_account_creation?: Array<string>;
+    }
   }
 }
 
@@ -557,7 +623,7 @@ export interface AuthConfigListParams {
   /**
    * Show disabled auth configs
    */
-  show_disabled?: boolean;
+  show_disabled?: boolean | null;
 
   /**
    * The slug of the toolkit to filter by

package/src/resources/cli.ts

@@ -0,0 +1,206 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Cli extends APIResource {
+  /**
+   * Generates a new CLI session with a random 6-character code. This endpoint is the
+   * first step in the CLI authentication flow, creating a session that can later be
+   * linked to a user account. The generated code is displayed to the user in the CLI
+   * and should be entered in the web interface to complete authentication.
+   *
+   * @example
+   * ```ts
+   * const response = await client.cli.createSession();
+   * ```
+   */
+  createSession(options?: RequestOptions): APIPromise<CliCreateSessionResponse> {
+    return this._client.post('/api/v3/cli/create-session', options);
+  }
+
+  /**
+   * Retrieves the current state of a CLI session using either the session ID (UUID)
+   * or the 6-character code. This endpoint is used by both the CLI client to check
+   * if the session has been linked, and by the web interface to display session
+   * details before linking.
+   *
+   * @example
+   * ```ts
+   * const response = await client.cli.getSession({
+   *   id: 'ABC123',
+   * });
+   * ```
+   */
+  getSession(query: CliGetSessionParams, options?: RequestOptions): APIPromise<CliGetSessionResponse> {
+    return this._client.get('/api/v3/cli/get-session', { query, ...options });
+  }
+
+  /**
+   * Links a pending CLI session to the currently authenticated user. This is the
+   * final step in the CLI authentication flow, where the user enters the code in the
+   * web interface and their account is associated with the CLI session, allowing the
+   * CLI to act on their behalf.
+   *
+   * @example
+   * ```ts
+   * const response = await client.cli.linkSession({
+   *   id: 'ABC123',
+   * });
+   * ```
+   */
+  linkSession(body: CliLinkSessionParams, options?: RequestOptions): APIPromise<CliLinkSessionResponse> {
+    return this._client.put('/api/v3/cli/link-session', { body, ...options });
+  }
+}
+
+export interface CliCreateSessionResponse {
+  /**
+   * Unique identifier for the CLI session. UUID v4 format used for tracking and
+   * retrieval.
+   */
+  id: string;
+
+  /**
+   * The 6-character hexadecimal code used for CLI login
+   */
+  code: string;
+
+  /**
+   * The ISO timestamp when the session expires
+   */
+  expiresAt: string;
+
+  /**
+   * The current status of the session
+   */
+  status: 'pending' | 'linked';
+}
+
+export interface CliGetSessionResponse {
+  /**
+   * The unique identifier for the CLI session
+   */
+  id: string;
+
+  /**
+   * Information about the linked account, if any. Null if the session status is
+   * "pending".
+   */
+  account: CliGetSessionResponse.Account | null;
+
+  /**
+   * The 6-character hexadecimal code used for CLI login
+   */
+  code: string;
+
+  /**
+   * The ISO timestamp when the session expires
+   */
+  expiresAt: string;
+
+  /**
+   * The current status of the session
+   */
+  status: 'pending' | 'linked';
+}
+
+export namespace CliGetSessionResponse {
+  /**
+   * Information about the linked account, if any. Null if the session status is
+   * "pending".
+   */
+  export interface Account {
+    /**
+     * The ID of the linked account
+     */
+    id: string;
+
+    /**
+     * The email address of the linked account
+     */
+    email: string;
+
+    /**
+     * The display name of the linked account
+     */
+    name: string;
+  }
+}
+
+export interface CliLinkSessionResponse {
+  /**
+   * The unique identifier for the CLI session
+   */
+  id: string;
+
+  /**
+   * Information about the linked account. Always present for successful responses
+   * from this endpoint.
+   */
+  account: CliLinkSessionResponse.Account;
+
+  /**
+   * The 6-character hexadecimal code used for CLI login
+   */
+  code: string;
+
+  /**
+   * The ISO timestamp when the session expires
+   */
+  expiresAt: string;
+
+  /**
+   * The current status of the session
+   */
+  status: 'pending' | 'linked';
+}
+
+export namespace CliLinkSessionResponse {
+  /**
+   * Information about the linked account. Always present for successful responses
+   * from this endpoint.
+   */
+  export interface Account {
+    /**
+     * The ID of the linked account
+     */
+    id: string;
+
+    /**
+     * The email address of the linked account
+     */
+    email: string;
+
+    /**
+     * The display name of the linked account
+     */
+    name: string;
+  }
+}
+
+export interface CliGetSessionParams {
+  /**
+   * CLI session ID (UUID format) or 6-character code to check. Both formats are
+   * supported for flexibility in client implementations.
+   */
+  id: string;
+}
+
+export interface CliLinkSessionParams {
+  /**
+   * The CLI session ID or code to link to the current user
+   */
+  id: string;
+}
+
+export declare namespace Cli {
+  export {
+    type CliCreateSessionResponse as CliCreateSessionResponse,
+    type CliGetSessionResponse as CliGetSessionResponse,
+    type CliLinkSessionResponse as CliLinkSessionResponse,
+    type CliGetSessionParams as CliGetSessionParams,
+    type CliLinkSessionParams as CliLinkSessionParams,
+  };
+}

package/src/resources/index.ts

@@ -13,6 +13,14 @@ export {
   type AuthConfigListParams,
   type AuthConfigUpdateStatusParams,
 } from './auth-configs';
+export {
+  Cli,
+  type CliCreateSessionResponse,
+  type CliGetSessionResponse,
+  type CliLinkSessionResponse,
+  type CliGetSessionParams,
+  type CliLinkSessionParams,
+} from './cli';
 export {
   ConnectedAccounts,
   type ConnectedAccountCreateResponse,

package/src/resources/mcp/mcp.ts

@@ -403,7 +403,7 @@ export interface McpListResponse {
   /**
    * Current page number being returned
    */
-  current_page: string;
+  current_page: number;
 
   /**
    * Array of MCP server configurations
@@ -413,7 +413,7 @@ export interface McpListResponse {
   /**
    * Total number of pages in the paginated response
    */
-  total_pages: string;
+  total_pages: number;
 }
 
 export namespace McpListResponse {
@@ -514,7 +514,7 @@ export interface McpRetrieveAppResponse {
   /**
    * Current page number being returned
    */
-  current_page: string;
+  current_page: number;
 
   /**
    * Array of MCP server configurations
@@ -524,7 +524,7 @@ export interface McpRetrieveAppResponse {
   /**
    * Total number of pages in the paginated response
    */
-  total_pages: string;
+  total_pages: number;
 }
 
 export namespace McpRetrieveAppResponse {

package/src/resources/toolkits.ts

@@ -81,6 +81,12 @@ export interface ToolkitRetrieveResponse {
    */
   auth_config_details?: Array<ToolkitRetrieveResponse.AuthConfigDetail>;
 
+  /**
+   * If evaluation of base URL needs some connection info (like shopify), please
+   * create the connection and get the base URL from there
+   */
+  base_url?: string;
+
   /**
    * List of authentication methods that Composio manages for this toolkit
    */

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
@@ -563,7 +568,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)

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0-alpha.26'; // x-release-please-version
+export const VERSION = '0.1.0-alpha.28'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-alpha.26";
+export declare const VERSION = "0.1.0-alpha.28";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-alpha.26";
+export declare const VERSION = "0.1.0-alpha.28";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.1.0-alpha.26'; // x-release-please-version
+exports.VERSION = '0.1.0-alpha.28'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.1.0-alpha.26'; // x-release-please-version
+export const VERSION = '0.1.0-alpha.28'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map