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

package/src/resources/connected-accounts.ts

@@ -8,6 +8,15 @@ import { path } from '../internal/utils/path';
 export class ConnectedAccounts extends APIResource {
   /**
    * Create a new connected account
+   *
+   * @example
+   * ```ts
+   * const connectedAccount =
+   *   await client.connectedAccounts.create({
+   *     auth_config: { id: 'id' },
+   *     connection: {},
+   *   });
+   * ```
    */
   create(
     body: ConnectedAccountCreateParams,
@@ -17,7 +26,16 @@ export class ConnectedAccounts extends APIResource {
   }
 
   /**
-   * Get connected account details by ID
+   * Retrieves comprehensive details of a connected account, including authentication
+   * configuration, connection status, and all parameters needed for API requests.
+   *
+   * @example
+   * ```ts
+   * const connectedAccount =
+   *   await client.connectedAccounts.retrieve(
+   *     'con_1a2b3c4d5e6f',
+   *   );
+   * ```
    */
   retrieve(nanoid: string, options?: RequestOptions): APIPromise<ConnectedAccountRetrieveResponse> {
     return this._client.get(path`/api/v3/connected_accounts/${nanoid}`, options);
@@ -25,6 +43,12 @@ export class ConnectedAccounts extends APIResource {
 
   /**
    * List connected accounts with optional filters
+   *
+   * @example
+   * ```ts
+   * const connectedAccounts =
+   *   await client.connectedAccounts.list();
+   * ```
    */
   list(
     query: ConnectedAccountListParams | null | undefined = {},
@@ -34,21 +58,49 @@ export class ConnectedAccounts extends APIResource {
   }
 
   /**
-   * Delete a connected account
+   * Soft-deletes a connected account by marking it as deleted in the database. This
+   * prevents the account from being used for API calls but preserves the record for
+   * audit purposes.
+   *
+   * @example
+   * ```ts
+   * const connectedAccount =
+   *   await client.connectedAccounts.delete('con_1a2b3c4d5e6f');
+   * ```
    */
   delete(nanoid: string, options?: RequestOptions): APIPromise<ConnectedAccountDeleteResponse> {
     return this._client.delete(path`/api/v3/connected_accounts/${nanoid}`, options);
   }
 
   /**
-   * Refresh authentication for a connected account
+   * Initiates a new authentication flow for a connected account when credentials
+   * have expired or become invalid. This may generate a new authentication URL for
+   * OAuth flows or refresh tokens for other auth schemes.
+   *
+   * @example
+   * ```ts
+   * const response = await client.connectedAccounts.refresh(
+   *   'con_1a2b3c4d5e6f',
+   * );
+   * ```
    */
   refresh(nanoid: string, options?: RequestOptions): APIPromise<ConnectedAccountRefreshResponse> {
     return this._client.post(path`/api/v3/connected_accounts/${nanoid}/refresh`, options);
   }
 
   /**
-   * Enable or disable a connected account
+   * Updates the status of a connected account to either enabled (active) or disabled
+   * (inactive). Disabled accounts cannot be used for API calls but remain in the
+   * database.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.connectedAccounts.updateStatus(
+   *     'con_1a2b3c4d5e6f',
+   *     { enabled: true },
+   *   );
+   * ```
    */
   updateStatus(
     nanoID: string,
@@ -81,7 +133,7 @@ export interface ConnectedAccountCreateResponse {
   /**
    * The status of the connected account
    */
-  status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'INITIATED' | 'EXPIRED' | 'FAILED';
+  status: 'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED';
 }
 
 export namespace ConnectedAccountCreateResponse {
@@ -117,22 +169,23 @@ export interface ConnectedAccountRetrieveResponse {
   data: Record<string, unknown>;
 
   /**
-   * Whether the connected account is disabled
+   * Whether the connected account is disabled. When true, the account cannot be used
+   * for API calls
    */
   is_disabled: boolean;
 
   /**
-   * The init data of the connection
+   * The initialization data of the connection, including configuration parameters
    */
   params: Record<string, unknown>;
 
   /**
    * The status of the connection
    */
-  status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'INITIATED' | 'EXPIRED' | 'FAILED';
+  status: 'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED';
 
   /**
-   * The reason the connected account is disabled
+   * The reason why the connected account is disabled, if applicable
    */
   status_reason: string | null;
 
@@ -258,7 +311,7 @@ export namespace ConnectedAccountListResponse {
     /**
      * The status of the connection
      */
-    status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'INITIATED' | 'EXPIRED' | 'FAILED';
+    status: 'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED';
 
     /**
      * The reason the connection is disabled
@@ -353,33 +406,40 @@ export namespace ConnectedAccountListResponse {
   }
 }
 
+/**
+ * Response returned after successfully deleting a connected account
+ */
 export interface ConnectedAccountDeleteResponse {
   /**
-   * The success of the update
+   * Indicates whether the connected account was successfully deleted
    */
   success: boolean;
 }
 
 export interface ConnectedAccountRefreshResponse {
   /**
-   * The id of the connected account
+   * The unique identifier of the connected account
    */
   id: string;
 
   /**
-   * The redirect URL of the app (previously named redirect_uri)
+   * The URL to which the user should be redirected to complete the authentication
+   * process (null for auth schemes that do not require redirection)
    */
   redirect_url: string | null;
 
   /**
-   * The status of the connected account
+   * The current status of the connected account (e.g., active, pending, failed)
    */
-  status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'INITIATED' | 'EXPIRED' | 'FAILED';
+  status: 'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED';
 }
 
+/**
+ * Response returned after successfully updating a connected account status
+ */
 export interface ConnectedAccountUpdateStatusResponse {
   /**
-   * The success of the update
+   * Indicates whether the connected account status was successfully updated
    */
   success: boolean;
 }
@@ -456,7 +516,7 @@ export interface ConnectedAccountListParams {
   /**
    * The status of the connected account
    */
-  statuses?: Array<'ACTIVE' | 'INACTIVE' | 'DELETED' | 'INITIATED' | 'EXPIRED' | 'FAILED'> | null;
+  statuses?: Array<'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED'> | null;
 
   /**
    * The toolkit slugs of the connected accounts
@@ -470,6 +530,9 @@ export interface ConnectedAccountListParams {
 }
 
 export interface ConnectedAccountUpdateStatusParams {
+  /**
+   * Set to true to enable the account or false to disable it
+   */
   enabled: boolean;
 }
 

package/src/resources/files.ts

@@ -6,7 +6,13 @@ import { RequestOptions } from '../internal/request-options';
 
 export class Files extends APIResource {
   /**
-   * List files with optional app and action filters
+   * Retrieves a list of files associated with the authenticated project. Results can
+   * be filtered by toolkit and tool slugs.
+   *
+   * @example
+   * ```ts
+   * const files = await client.files.list();
+   * ```
    */
   list(
     query: FileListParams | null | undefined = {},
@@ -16,7 +22,19 @@ export class Files extends APIResource {
   }
 
   /**
-   * Create presigned URL for request file upload to S3
+   * Generates a presigned URL for uploading a file to S3. This endpoint handles
+   * deduplication by checking if a file with the same MD5 hash already exists.
+   *
+   * @example
+   * ```ts
+   * const response = await client.files.createPresignedURL({
+   *   filename: 'photo.jpg',
+   *   md5: 'd41d8cd98f00b204e9800998ecf8427e',
+   *   mimetype: 'image/jpeg',
+   *   tool_slug: 'resize-image',
+   *   toolkit_slug: 'image-processing',
+   * });
+   * ```
    */
   createPresignedURL(
     body: FileCreatePresignedURLParams,
@@ -37,27 +55,29 @@ export interface FileListResponse {
 export namespace FileListResponse {
   export interface Item {
     /**
-     * Name of the original file.
+     * Name of the original file. Example: "document.docx"
      */
     filename: string;
 
     /**
-     * MD5 of a file.
+     * MD5 hash of the file for integrity verification. Example:
+     * "d41d8cd98f00b204e9800998ecf8427e"
      */
     md5: string;
 
     /**
-     * Mime type of the original file.
+     * Mime type of the original file. Example:
+     * "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
      */
     mimetype: string;
 
     /**
-     * Name of the action where this file belongs to.
+     * Slug of the action where this file belongs to. Example: "convert-to-pdf"
      */
     tool_slug: string;
 
     /**
-     * Slug of the app where this file belongs to.
+     * Slug of the app where this file belongs to. Example: "file-converter"
      */
     toolkit_slug: string;
   }
@@ -71,57 +91,69 @@ export type FileCreatePresignedURLResponse =
 export namespace FileCreatePresignedURLResponse {
   export interface UnionMember0 {
     /**
-     * ID of the request file
+     * ID of the request file. Example: "f1e2d3c4b5a6"
      */
     id: string;
 
     /**
-     * URL of the existing request file
+     * URL of the existing request file. Example:
+     * "https://storage.example.com/projects/123/files/photo-1234.jpg"
      */
     existingUrl: string;
 
     /**
-     * S3 upload location
+     * S3 upload location. Example: "projects/123/files/photo-1234.jpg"
      */
     key: string;
 
+    /**
+     * Indicates the file already exists and does not need to be uploaded again
+     */
     type: 'existing';
   }
 
   export interface UnionMember1 {
     /**
-     * ID of the request file
+     * ID of the request file. Example: "f1e2d3c4b5a6"
      */
     id: string;
 
     /**
-     * S3 upload location
+     * S3 upload location. Example: "projects/123/files/photo-1234.jpg"
      */
     key: string;
 
     /**
-     * Presigned URL for upload
+     * Presigned URL for upload. Example:
+     * "https://storage.example.com/projects/123/files/photo-1234.jpg?X-Amz-Algorithm=..."
      */
     newPresignedUrl: string;
 
+    /**
+     * Indicates this is a new file that needs to be uploaded
+     */
     type: 'new';
   }
 
   export interface UnionMember2 {
     /**
-     * ID of the request file
+     * ID of the request file. Example: "f1e2d3c4b5a6"
      */
     id: string;
 
     /**
-     * S3 upload location
+     * S3 upload location. Example: "projects/123/files/photo-1234.jpg"
      */
     key: string;
 
+    /**
+     * Indicates this file exists but needs to be updated with a new version
+     */
     type: 'update';
 
     /**
-     * Presigned URL for upload
+     * Presigned URL for upload. Example:
+     * "https://storage.example.com/projects/123/files/photo-1234.jpg?X-Amz-Algorithm=..."
      */
     updatePresignedUrl: string;
   }
@@ -129,39 +161,40 @@ export namespace FileCreatePresignedURLResponse {
 
 export interface FileListParams {
   /**
-   * Name of the action where this file belongs to.
+   * Filter files by action slug. Example: "convert-to-pdf"
    */
   tool_slug?: string;
 
   /**
-   * Slug of the app where this file belongs to.
+   * Filter files by app slug. Example: "file-converter"
    */
   toolkit_slug?: string;
 }
 
 export interface FileCreatePresignedURLParams {
   /**
-   * Name of the original file.
+   * Name of the original file. Example: "photo.jpg"
    */
   filename: string;
 
   /**
-   * MD5 of a file.
+   * MD5 hash of the file for deduplication and integrity verification. Example:
+   * "d41d8cd98f00b204e9800998ecf8427e"
    */
   md5: string;
 
   /**
-   * Mime type of the original file.
+   * Mime type of the original file. Example: "image/jpeg"
    */
   mimetype: string;
 
   /**
-   * Slug of the action where this file belongs to.
+   * Slug of the action where this file belongs to. Example: "resize-image"
    */
   tool_slug: string;
 
   /**
-   * Slug of the app where this file belongs to.
+   * Slug of the app where this file belongs to. Example: "image-processing"
    */
   toolkit_slug: string;
 }

package/src/resources/index.ts

@@ -34,16 +34,13 @@ export {
 } from './files';
 export {
   Mcp,
-  type McpCreateResponse,
   type McpRetrieveResponse,
   type McpUpdateResponse,
-  type McpListResponse,
   type McpDeleteResponse,
   type McpRetrieveAppResponse,
   type McpValidateResponse,
-  type McpCreateParams,
   type McpUpdateParams,
-  type McpListParams,
+  type McpRetrieveAppParams,
   type McpValidateParams,
 } from './mcp/mcp';
 export {
@@ -67,6 +64,7 @@ export {
   type ToolkitListResponse,
   type ToolkitRetrieveCategoriesResponse,
   type ToolkitListParams,
+  type ToolkitRetrieveCategoriesParams,
 } from './toolkits';
 export {
   Tools,
@@ -84,11 +82,8 @@ export {
 export {
   TriggerInstances,
   type TriggerInstanceListActiveResponse,
-  type TriggerInstanceRemoveUpsertResponse,
-  type TriggerInstanceUpdateStatusResponse,
   type TriggerInstanceUpsertResponse,
   type TriggerInstanceListActiveParams,
-  type TriggerInstanceUpdateStatusParams,
   type TriggerInstanceUpsertParams,
 } from './trigger-instances/trigger-instances';
 export {

package/src/resources/mcp/command.ts

@@ -1,50 +1,5 @@
 // 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 Command extends APIResource {
-  /**
-   * Generate CLI command to set up MCP server
-   */
-  generate(body: CommandGenerateParams, options?: RequestOptions): APIPromise<CommandGenerateResponse> {
-    return this._client.post('/api/v3/mcp/command/generate', { body, ...options });
-  }
-}
-
-export interface CommandGenerateResponse {
-  /**
-   * The generated command to run
-   */
-  command?: string;
-
-  /**
-   * The URL for the MCP server
-   */
-  url?: string;
-}
-
-export interface CommandGenerateParams {
-  /**
-   * The ID of the MCP server
-   */
-  id: string;
-
-  /**
-   * MCP client to generate command for
-   */
-  mcp_client: 'cursor' | 'claude' | 'windsurf';
-
-  /**
-   * Time to live for the command
-   */
-  ttl?: '1d' | '3d' | '1 month' | 'no expiration';
-}
-
-export declare namespace Command {
-  export {
-    type CommandGenerateResponse as CommandGenerateResponse,
-    type CommandGenerateParams as CommandGenerateParams,
-  };
-}
+export class Command extends APIResource {}

package/src/resources/mcp/index.ts

@@ -1,17 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Command, type CommandGenerateResponse, type CommandGenerateParams } from './command';
+export { Command } from './command';
 export {
   Mcp,
-  type McpCreateResponse,
   type McpRetrieveResponse,
   type McpUpdateResponse,
-  type McpListResponse,
   type McpDeleteResponse,
   type McpRetrieveAppResponse,
   type McpValidateResponse,
-  type McpCreateParams,
   type McpUpdateParams,
-  type McpListParams,
+  type McpRetrieveAppParams,
   type McpValidateParams,
 } from './mcp';