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

package/src/resources/mcp/mcp.ts

@@ -0,0 +1,562 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as CommandAPI from './command';
+import { Command, CommandGenerateParams, CommandGenerateResponse } from './command';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Mcp extends APIResource {
+  command: CommandAPI.Command = new CommandAPI.Command(this._client);
+
+  /**
+   * Create a new MCP server
+   */
+  create(body: McpCreateParams, options?: RequestOptions): APIPromise<McpCreateResponse> {
+    return this._client.post('/api/v3/mcp/create', { body, ...options });
+  }
+
+  /**
+   * Get MCP server details by ID
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<McpRetrieveResponse> {
+    return this._client.get(path`/api/v3/mcp/${id}`, options);
+  }
+
+  /**
+   * Update MCP server configuration
+   */
+  update(
+    id: string,
+    body: McpUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<McpUpdateResponse> {
+    return this._client.patch(path`/api/v3/mcp/${id}`, { body, ...options });
+  }
+
+  /**
+   * List MCP servers with optional filters
+   */
+  list(query: McpListParams | null | undefined = {}, options?: RequestOptions): APIPromise<McpListResponse> {
+    return this._client.get('/api/v3/mcp/list', { query, ...options });
+  }
+
+  /**
+   * Delete an MCP server
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<McpDeleteResponse> {
+    return this._client.delete(path`/api/v3/mcp/${id}`, options);
+  }
+
+  /**
+   * List MCP servers for a specific app
+   */
+  retrieveApp(appKey: string, options?: RequestOptions): APIPromise<McpRetrieveAppResponse> {
+    return this._client.get(path`/api/v3/mcp/app/${appKey}`, options);
+  }
+
+  /**
+   * Validate MCP server and retrieve connection details
+   */
+  validate(
+    uuid: string,
+    params: McpValidateParams,
+    options?: RequestOptions,
+  ): APIPromise<McpValidateResponse> {
+    const { 'x-composio-admin-token': xComposioAdminToken } = params;
+    return this._client.get(path`/api/v3/mcp/validate/${uuid}`, {
+      ...options,
+      headers: buildHeaders([{ 'x-composio-admin-token': xComposioAdminToken }, options?.headers]),
+    });
+  }
+}
+
+export interface McpCreateResponse {
+  /**
+   * The ID of the MCP server
+   */
+  id: string;
+
+  /**
+   * The app IDs associated with the server
+   */
+  apps: Array<string>;
+
+  /**
+   * The member ID who created the server
+   */
+  member_id: string;
+
+  /**
+   * The name of the MCP server
+   */
+  name: string;
+
+  /**
+   * Signed URL for the MCP server
+   */
+  signed_url: string;
+
+  /**
+   * Last update timestamp of the MCP server
+   */
+  updated_at: string;
+
+  /**
+   * The URL of the MCP server
+   */
+  url: string;
+
+  /**
+   * Auth configuration
+   */
+  auth_configs?: Record<string, unknown>;
+
+  /**
+   * Connected account IDs
+   */
+  connected_account_ids?: Array<string>;
+}
+
+export interface McpRetrieveResponse {
+  /**
+   * The ID of the MCP server
+   */
+  id: string;
+
+  /**
+   * The app IDs associated with the server
+   */
+  apps: Array<string>;
+
+  /**
+   * Client ID associated with the MCP server
+   */
+  client_id: string;
+
+  /**
+   * Creation timestamp of the MCP server
+   */
+  created_at: string;
+
+  /**
+   * Whether the MCP server is deleted
+   */
+  deleted: boolean;
+
+  /**
+   * The member ID who created the server
+   */
+  member_id: string;
+
+  /**
+   * The name of the MCP server
+   */
+  name: string;
+
+  /**
+   * Last update timestamp of the MCP server
+   */
+  updated_at: string;
+
+  /**
+   * The URL of the MCP server
+   */
+  url: string;
+
+  /**
+   * Actions available for the MCP server
+   */
+  actions?: Record<string, unknown>;
+
+  /**
+   * Auth configuration
+   */
+  auth_configs?: Record<string, unknown>;
+
+  /**
+   * Connected account IDs
+   */
+  connected_account_ids?: Array<string>;
+
+  /**
+   * Whether custom auth headers are enabled
+   */
+  custom_auth_headers?: boolean;
+
+  /**
+   * Entity IDs associated with the server
+   */
+  entity_ids?: Array<string>;
+}
+
+export interface McpUpdateResponse {
+  /**
+   * The ID of the MCP server
+   */
+  id: string;
+
+  /**
+   * The app IDs associated with the server
+   */
+  apps: Array<string>;
+
+  /**
+   * Client ID associated with the MCP server
+   */
+  client_id: string;
+
+  /**
+   * Creation timestamp of the MCP server
+   */
+  created_at: string;
+
+  /**
+   * Whether the MCP server is deleted
+   */
+  deleted: boolean;
+
+  /**
+   * The member ID who created the server
+   */
+  member_id: string;
+
+  /**
+   * The name of the MCP server
+   */
+  name: string;
+
+  /**
+   * Last update timestamp of the MCP server
+   */
+  updated_at: string;
+
+  /**
+   * The URL of the MCP server
+   */
+  url: string;
+
+  /**
+   * Actions available for the MCP server
+   */
+  actions?: Record<string, unknown>;
+
+  /**
+   * Auth configuration
+   */
+  auth_configs?: Record<string, unknown>;
+
+  /**
+   * Connected account IDs
+   */
+  connected_account_ids?: Array<string>;
+
+  /**
+   * Whether custom auth headers are enabled
+   */
+  custom_auth_headers?: boolean;
+
+  /**
+   * Entity IDs associated with the server
+   */
+  entity_ids?: Array<string>;
+}
+
+export interface McpListResponse {
+  items: Array<McpListResponse.Item>;
+}
+
+export namespace McpListResponse {
+  export interface Item {
+    /**
+     * The ID of the MCP server
+     */
+    id: string;
+
+    /**
+     * The app IDs associated with the server
+     */
+    apps: Array<string>;
+
+    /**
+     * The member ID who created the server
+     */
+    member_id: string;
+
+    /**
+     * The name of the MCP server
+     */
+    name: string;
+
+    /**
+     * Last update timestamp of the MCP server
+     */
+    updated_at: string;
+
+    /**
+     * The URL of the MCP server
+     */
+    url: string;
+
+    /**
+     * Actions available for the MCP server
+     */
+    actions?: Array<string>;
+
+    /**
+     * Auth configuration
+     */
+    auth_configs?: Record<string, unknown>;
+
+    /**
+     * Connected account IDs
+     */
+    connected_account_ids?: Array<string>;
+  }
+}
+
+export interface McpDeleteResponse {
+  /**
+   * Operation success status
+   */
+  success: boolean;
+}
+
+export interface McpRetrieveAppResponse {
+  items: Array<McpRetrieveAppResponse.Item>;
+}
+
+export namespace McpRetrieveAppResponse {
+  export interface Item {
+    /**
+     * The ID of the MCP server
+     */
+    id: string;
+
+    /**
+     * The app IDs associated with the server
+     */
+    apps: Array<string>;
+
+    /**
+     * The member ID who created the server
+     */
+    member_id: string;
+
+    /**
+     * The name of the MCP server
+     */
+    name: string;
+
+    /**
+     * Last update timestamp of the MCP server
+     */
+    updated_at: string;
+
+    /**
+     * The URL of the MCP server
+     */
+    url: string;
+
+    /**
+     * Actions available for the MCP server
+     */
+    actions?: Array<string>;
+
+    /**
+     * Auth configuration
+     */
+    auth_configs?: Record<string, unknown>;
+
+    /**
+     * Connected account IDs
+     */
+    connected_account_ids?: Array<string>;
+  }
+}
+
+export interface McpValidateResponse {
+  /**
+   * The ID of the MCP server
+   */
+  id: string;
+
+  client: McpValidateResponse.Client;
+
+  /**
+   * The name of the MCP server
+   */
+  name: string;
+
+  /**
+   * The URL of the MCP server
+   */
+  url: string;
+
+  userData: McpValidateResponse.UserData;
+
+  actions?: Array<string> | null;
+
+  apps?: Array<string>;
+
+  connectedAccountIds?: Array<string> | null;
+
+  customAuthHeaders?: boolean;
+
+  entityIds?: Array<string> | null;
+}
+
+export namespace McpValidateResponse {
+  export interface Client {
+    /**
+     * The client ID
+     */
+    id: string;
+
+    /**
+     * The organization ID
+     */
+    orgId: string;
+  }
+
+  export interface UserData {
+    /**
+     * The user ID
+     */
+    id: string;
+
+    /**
+     * The API key
+     */
+    apiKey: string;
+
+    /**
+     * The user email
+     */
+    email: string;
+  }
+}
+
+export interface McpCreateParams {
+  /**
+   * Name of the MCP server
+   */
+  name: string;
+
+  /**
+   * Actions available for the server
+   */
+  actions?: Array<string>;
+
+  /**
+   * App IDs associated with the server
+   */
+  apps?: Array<string>;
+
+  /**
+   * Auth configurations
+   */
+  auth_configs?: Record<string, unknown>;
+
+  /**
+   * Connected account IDs
+   */
+  connected_account_ids?: Array<string>;
+
+  /**
+   * Whether to use custom auth headers
+   */
+  custom_auth_headers?: boolean;
+
+  /**
+   * Entity IDs
+   */
+  entity_ids?: Array<string>;
+
+  /**
+   * Time to live for the server
+   */
+  ttl?: '1d' | '3d' | '1 month' | 'no expiration';
+}
+
+export interface McpUpdateParams {
+  /**
+   * Actions available for the server
+   */
+  actions?: Array<string>;
+
+  /**
+   * App IDs associated with the server
+   */
+  apps?: Array<string>;
+
+  /**
+   * Name of the MCP server
+   */
+  name?: string;
+}
+
+export interface McpListParams {
+  /**
+   * App IDs to filter by
+   */
+  app_id?: Array<string> | null;
+
+  /**
+   * Connected account IDs to filter by
+   */
+  connected_account_id?: Array<string> | null;
+
+  /**
+   * Cursor for pagination
+   */
+  cursor?: number | null;
+
+  /**
+   * Entity IDs to filter by
+   */
+  entity_id?: Array<string> | null;
+
+  /**
+   * Integration ID to filter by
+   */
+  integration_id?: string;
+
+  /**
+   * Limit for pagination
+   */
+  limit?: number | null;
+}
+
+export interface McpValidateParams {
+  /**
+   * Admin token
+   */
+  'x-composio-admin-token': string;
+}
+
+Mcp.Command = Command;
+
+export declare namespace Mcp {
+  export {
+    type McpCreateResponse as McpCreateResponse,
+    type McpRetrieveResponse as McpRetrieveResponse,
+    type McpUpdateResponse as McpUpdateResponse,
+    type McpListResponse as McpListResponse,
+    type McpDeleteResponse as McpDeleteResponse,
+    type McpRetrieveAppResponse as McpRetrieveAppResponse,
+    type McpValidateResponse as McpValidateResponse,
+    type McpCreateParams as McpCreateParams,
+    type McpUpdateParams as McpUpdateParams,
+    type McpListParams as McpListParams,
+    type McpValidateParams as McpValidateParams,
+  };
+
+  export {
+    Command as Command,
+    type CommandGenerateResponse as CommandGenerateResponse,
+    type CommandGenerateParams as CommandGenerateParams,
+  };
+}

package/src/resources/mcp.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './mcp/index';

package/src/resources/migration.ts

@@ -0,0 +1,37 @@
+// 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 Migration extends APIResource {
+  /**
+   * Convert a legacy UUID to its corresponding NanoId for migration purposes
+   */
+  retrieveNanoid(
+    query: MigrationRetrieveNanoidParams,
+    options?: RequestOptions,
+  ): APIPromise<MigrationRetrieveNanoidResponse> {
+    return this._client.get('/api/v3/migration/get-nanoid', { query, ...options });
+  }
+}
+
+export interface MigrationRetrieveNanoidResponse {
+  /**
+   * The NanoId corresponding to the provided UUID.
+   */
+  nanoid: string;
+}
+
+export interface MigrationRetrieveNanoidParams {
+  type: 'CONNECTED_ACCOUNT' | 'AUTH_CONFIG' | 'TRIGGER_INSTANCE';
+
+  uuid: string;
+}
+
+export declare namespace Migration {
+  export {
+    type MigrationRetrieveNanoidResponse as MigrationRetrieveNanoidResponse,
+    type MigrationRetrieveNanoidParams as MigrationRetrieveNanoidParams,
+  };
+}

package/src/resources/org/api-key.ts

@@ -5,10 +5,17 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
 export class APIKey extends APIResource {
+  /**
+   * Retrieve the API key for the current organization (admin only)
+   */
   retrieve(options?: RequestOptions): APIPromise<APIKeyRetrieveResponse> {
     return this._client.get('/api/v3/org/api_key', options);
   }
 
+  /**
+   * Generate a new API key for the organization, invalidating the previous one
+   * (admin only)
+   */
   regenerate(options?: RequestOptions): APIPromise<APIKeyRegenerateResponse> {
     return this._client.post('/api/v3/org/api_key/regenerate', options);
   }

package/src/resources/org/project/project.ts

@@ -33,14 +33,23 @@ export class Project extends APIResource {
   webhook: WebhookAPI.Webhook = new WebhookAPI.Webhook(this._client);
   trigger: TriggerAPI.Trigger = new TriggerAPI.Trigger(this._client);
 
+  /**
+   * Create a new project within the organization with the specified name
+   */
   create(body: ProjectCreateParams, options?: RequestOptions): APIPromise<ProjectCreateResponse> {
     return this._client.post('/api/v3/org/project/new', { body, ...options });
   }
 
+  /**
+   * Retrieve detailed information about a specific project using its ID
+   */
   retrieve(projectID: string, options?: RequestOptions): APIPromise<ProjectRetrieveResponse> {
     return this._client.get(path`/api/v3/org/project/${projectID}`, options);
   }
 
+  /**
+   * Retrieve a list of all projects within the current organization
+   */
   list(options?: RequestOptions): APIPromise<ProjectListResponse> {
     return this._client.get('/api/v3/org/project/list', options);
   }
@@ -53,8 +62,6 @@ export class Project extends APIResource {
 export interface ProjectCreateResponse {
   id: string;
 
-  auto_id: number;
-
   created_at: string;
 
   deleted: boolean;
@@ -65,8 +72,6 @@ export interface ProjectCreateResponse {
 
   name: string;
 
-  nano_id: string | null;
-
   org_id: string;
 
   updated_at: string;
@@ -85,8 +90,6 @@ export interface ProjectCreateResponse {
 export interface ProjectRetrieveResponse {
   id: string;
 
-  auto_id: number;
-
   created_at: string;
 
   deleted: boolean;
@@ -97,8 +100,6 @@ export interface ProjectRetrieveResponse {
 
   name: string;
 
-  nano_id: string | null;
-
   org_id: string;
 
   updated_at: string;
@@ -122,8 +123,6 @@ export namespace ProjectListResponse {
   export interface Data {
     id: string;
 
-    auto_id: number;
-
     created_at: string;
 
     deleted: boolean;
@@ -134,8 +133,6 @@ export namespace ProjectListResponse {
 
     name: string;
 
-    nano_id: string | null;
-
     org_id: string;
 
     updated_at: string;

package/src/resources/org/project/trigger.ts

@@ -18,8 +18,6 @@ export class Trigger extends APIResource {
 export interface TriggerUpdateResponse {
   id: string;
 
-  auto_id: number;
-
   created_at: string;
 
   deleted: boolean;
@@ -30,8 +28,6 @@ export interface TriggerUpdateResponse {
 
   name: string;
 
-  nano_id: string | null;
-
   org_id: string;
 
   updated_at: string;
@@ -50,8 +46,6 @@ export interface TriggerUpdateResponse {
 export interface TriggerListResponse {
   id: string;
 
-  auto_id: number;
-
   created_at: string;
 
   deleted: boolean;
@@ -62,8 +56,6 @@ export interface TriggerListResponse {
 
   name: string;
 
-  nano_id: string | null;
-
   org_id: string;
 
   updated_at: string;