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

package/resources/triggers-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"triggers-types.js","sourceRoot":"","sources":["../src/resources/triggers-types.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;OAGG;IACH,QAAQ,CAAC,IAAY,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,YAAY,CAAC,OAAwB;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AAtBD,sCAsBC"}
+{"version":3,"file":"triggers-types.js","sourceRoot":"","sources":["../src/resources/triggers-types.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAY,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CAAC,OAAwB;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AA5CD,sCA4CC"}

package/resources/triggers-types.mjs

@@ -5,16 +5,38 @@ export class TriggersTypes extends APIResource {
     /**
      * Retrieve detailed information about a specific trigger type using its slug
      * identifier
+     *
+     * @example
+     * ```ts
+     * const triggersType = await client.triggersTypes.retrieve(
+     *   'SLACK_NEW_MESSAGE',
+     * );
+     * ```
      */
     retrieve(slug, options) {
         return this._client.get(path `/api/v3/triggers_types/${slug}`, options);
     }
     /**
-     * Retrieve a list of available trigger types with optional filtering by toolkit
+     * Retrieve a list of available trigger types with optional filtering by toolkit.
+     * Results are paginated and can be filtered by toolkit.
+     *
+     * @example
+     * ```ts
+     * const triggersTypes = await client.triggersTypes.list();
+     * ```
      */
     list(query = {}, options) {
         return this._client.get('/api/v3/triggers_types', { query, ...options });
     }
+    /**
+     * Retrieves a list of all available trigger type enum values that can be used
+     * across the API
+     *
+     * @example
+     * ```ts
+     * const response = await client.triggersTypes.retrieveEnum();
+     * ```
+     */
     retrieveEnum(options) {
         return this._client.get('/api/v3/triggers_types/list/enum', options);
     }

package/resources/triggers-types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"triggers-types.mjs","sourceRoot":"","sources":["../src/resources/triggers-types.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;OAGG;IACH,QAAQ,CAAC,IAAY,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,YAAY,CAAC,OAAwB;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF"}
+{"version":3,"file":"triggers-types.mjs","sourceRoot":"","sources":["../src/resources/triggers-types.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAY,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CAAC,OAAwB;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF"}

package/src/client.ts

@@ -70,6 +70,7 @@ import {
 import {
   ToolkitListParams,
   ToolkitListResponse,
+  ToolkitRetrieveCategoriesParams,
   ToolkitRetrieveCategoriesResponse,
   ToolkitRetrieveResponse,
   Toolkits,
@@ -99,11 +100,8 @@ import { formatRequestDetails, loggerFor } from './internal/utils/log';
 import { isEmptyObj } from './internal/utils/values';
 import {
   Mcp,
-  McpCreateParams,
-  McpCreateResponse,
   McpDeleteResponse,
-  McpListParams,
-  McpListResponse,
+  McpRetrieveAppParams,
   McpRetrieveAppResponse,
   McpRetrieveResponse,
   McpUpdateParams,
@@ -115,9 +113,6 @@ import { Org } from './resources/org/org';
 import {
   TriggerInstanceListActiveParams,
   TriggerInstanceListActiveResponse,
-  TriggerInstanceRemoveUpsertResponse,
-  TriggerInstanceUpdateStatusParams,
-  TriggerInstanceUpdateStatusResponse,
   TriggerInstanceUpsertParams,
   TriggerInstanceUpsertResponse,
   TriggerInstances,
@@ -876,6 +871,7 @@ export declare namespace Composio {
     type ToolkitListResponse as ToolkitListResponse,
     type ToolkitRetrieveCategoriesResponse as ToolkitRetrieveCategoriesResponse,
     type ToolkitListParams as ToolkitListParams,
+    type ToolkitRetrieveCategoriesParams as ToolkitRetrieveCategoriesParams,
   };
 
   export {
@@ -895,11 +891,8 @@ export declare namespace Composio {
   export {
     TriggerInstances as TriggerInstances,
     type TriggerInstanceListActiveResponse as TriggerInstanceListActiveResponse,
-    type TriggerInstanceRemoveUpsertResponse as TriggerInstanceRemoveUpsertResponse,
-    type TriggerInstanceUpdateStatusResponse as TriggerInstanceUpdateStatusResponse,
     type TriggerInstanceUpsertResponse as TriggerInstanceUpsertResponse,
     type TriggerInstanceListActiveParams as TriggerInstanceListActiveParams,
-    type TriggerInstanceUpdateStatusParams as TriggerInstanceUpdateStatusParams,
     type TriggerInstanceUpsertParams as TriggerInstanceUpsertParams,
   };
 
@@ -913,16 +906,13 @@ export declare namespace Composio {
 
   export {
     Mcp as Mcp,
-    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 McpRetrieveAppParams as McpRetrieveAppParams,
     type McpValidateParams as McpValidateParams,
   };
 

package/src/resources/auth-configs.ts

@@ -8,20 +8,44 @@ import { path } from '../internal/utils/path';
 export class AuthConfigs extends APIResource {
   /**
    * Create new authentication configuration
+   *
+   * @example
+   * ```ts
+   * const authConfig = await client.authConfigs.create({
+   *   toolkit: { slug: 'slug' },
+   * });
+   * ```
    */
   create(body: AuthConfigCreateParams, options?: RequestOptions): APIPromise<AuthConfigCreateResponse> {
     return this._client.post('/api/v3/auth_configs', { body, ...options });
   }
 
   /**
-   * Get single authentication configuration by ID
+   * Retrieves detailed information about a specific authentication configuration
+   * using its unique identifier.
+   *
+   * @example
+   * ```ts
+   * const authConfig = await client.authConfigs.retrieve(
+   *   'nanoid',
+   * );
+   * ```
    */
   retrieve(nanoid: string, options?: RequestOptions): APIPromise<AuthConfigRetrieveResponse> {
     return this._client.get(path`/api/v3/auth_configs/${nanoid}`, options);
   }
 
   /**
-   * Update an authentication configuration
+   * Modifies an existing authentication configuration with new credentials or other
+   * settings. Only specified fields will be updated.
+   *
+   * @example
+   * ```ts
+   * const authConfig = await client.authConfigs.update(
+   *   'nanoid',
+   *   { credentials: { foo: 'bar' }, type: 'custom' },
+   * );
+   * ```
    */
   update(nanoid: string, body: AuthConfigUpdateParams, options?: RequestOptions): APIPromise<unknown> {
     return this._client.patch(path`/api/v3/auth_configs/${nanoid}`, { body, ...options });
@@ -29,6 +53,11 @@ export class AuthConfigs extends APIResource {
 
   /**
    * List authentication configurations with optional filters
+   *
+   * @example
+   * ```ts
+   * const authConfigs = await client.authConfigs.list();
+   * ```
    */
   list(
     query: AuthConfigListParams | null | undefined = {},
@@ -38,14 +67,31 @@ export class AuthConfigs extends APIResource {
   }
 
   /**
-   * Delete an authentication configuration
+   * Soft-deletes an authentication configuration by marking it as deleted in the
+   * database. This operation cannot be undone.
+   *
+   * @example
+   * ```ts
+   * const authConfig = await client.authConfigs.delete(
+   *   'nanoid',
+   * );
+   * ```
    */
   delete(nanoid: string, options?: RequestOptions): APIPromise<unknown> {
     return this._client.delete(path`/api/v3/auth_configs/${nanoid}`, options);
   }
 
   /**
-   * Enable or disable an authentication configuration
+   * Updates the status of an authentication configuration to either enabled or
+   * disabled. Disabled configurations cannot be used for new connections.
+   *
+   * @example
+   * ```ts
+   * const response = await client.authConfigs.updateStatus(
+   *   'ENABLED',
+   *   { nanoid: 'nanoid' },
+   * );
+   * ```
    */
   updateStatus(
     status: 'ENABLED' | 'DISABLED',
@@ -96,36 +142,48 @@ export namespace AuthConfigCreateResponse {
 
 export interface AuthConfigRetrieveResponse {
   /**
-   * The unique id of the auth config
+   * The unique ID of the authentication configuration
    */
   id: string;
 
+  /**
+   * Deprecated parameters maintained for backward compatibility
+   */
   deprecated_params: AuthConfigRetrieveResponse.DeprecatedParams;
 
   /**
-   * The name of the auth config
+   * The display name of the authentication configuration
    */
   name: string;
 
   /**
-   * The number of connections for the auth config
+   * The number of active connections using this auth config
    */
   no_of_connections: number;
 
+  /**
+   * Current status of the authentication configuration
+   */
   status: 'ENABLED' | 'DISABLED';
 
+  /**
+   * Information about the associated integration
+   */
   toolkit: AuthConfigRetrieveResponse.Toolkit;
 
   /**
-   * The type of the auth config
+   * The type of the authentication configuration (custom or default)
    */
   type: 'default' | 'custom';
 
   /**
-   * The unique id of the auth config
+   * The UUID of the authentication configuration (for backward compatibility)
    */
   uuid: string;
 
+  /**
+   * The authentication scheme used (e.g., OAuth2, API Key, etc.)
+   */
   auth_scheme?:
     | 'OAUTH2'
     | 'OAUTH1'
@@ -142,48 +200,79 @@ export interface AuthConfigRetrieveResponse {
     | 'SNOWFLAKE';
 
   /**
-   * The date and time the auth config was created
+   * ISO 8601 date-time when the auth config was created
    */
   created_at?: string;
 
   /**
-   * The user who created the auth config
+   * The identifier of the user who created the auth config
    */
   created_by?: string;
 
+  /**
+   * The authentication credentials (tokens, keys, etc.) - may be partially hidden
+   * for security
+   */
   credentials?: Record<string, unknown>;
 
+  /**
+   * Fields expected during connection initialization
+   */
   expected_input_fields?: Array<unknown>;
 
+  /**
+   * Whether this authentication configuration is managed by Composio or the user
+   */
   is_composio_managed?: boolean;
 
   /**
-   * The date and time the auth config was last updated
+   * 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 {
+  /**
+   * Deprecated parameters maintained for backward compatibility
+   */
   export interface DeprecatedParams {
+    /**
+     * Deprecated: Default connector ID
+     */
     default_connector_id: string | null;
 
+    /**
+     * Deprecated: Fields expected during connection initialization
+     */
     expected_input_fields?: Array<Record<string, unknown>>;
 
+    /**
+     * Deprecated: Member UUID
+     */
     member_uuid?: string;
 
+    /**
+     * Deprecated: Toolkit ID
+     */
     toolkit_id?: string;
   }
 
+  /**
+   * Information about the associated integration
+   */
   export interface Toolkit {
     /**
-     * The logo of the app
+     * The URL to the integration app's logo image
      */
     logo: string;
 
     /**
-     * The unique key of the app
+     * The unique identifier of the integration app
      */
     slug: string;
   }
@@ -202,36 +291,48 @@ export interface AuthConfigListResponse {
 export namespace AuthConfigListResponse {
   export interface Item {
     /**
-     * The unique id of the auth config
+     * The unique ID of the authentication configuration
      */
     id: string;
 
+    /**
+     * Deprecated parameters maintained for backward compatibility
+     */
     deprecated_params: Item.DeprecatedParams;
 
     /**
-     * The name of the auth config
+     * The display name of the authentication configuration
      */
     name: string;
 
     /**
-     * The number of connections for the auth config
+     * The number of active connections using this auth config
      */
     no_of_connections: number;
 
+    /**
+     * Current status of the authentication configuration
+     */
     status: 'ENABLED' | 'DISABLED';
 
+    /**
+     * Information about the associated integration
+     */
     toolkit: Item.Toolkit;
 
     /**
-     * The type of the auth config
+     * The type of the authentication configuration (custom or default)
      */
     type: 'default' | 'custom';
 
     /**
-     * The unique id of the auth config
+     * The UUID of the authentication configuration (for backward compatibility)
      */
     uuid: string;
 
+    /**
+     * The authentication scheme used (e.g., OAuth2, API Key, etc.)
+     */
     auth_scheme?:
       | 'OAUTH2'
       | 'OAUTH1'
@@ -248,48 +349,79 @@ export namespace AuthConfigListResponse {
       | 'SNOWFLAKE';
 
     /**
-     * The date and time the auth config was created
+     * ISO 8601 date-time when the auth config was created
      */
     created_at?: string;
 
     /**
-     * The user who created the auth config
+     * The identifier of the user who created the auth config
      */
     created_by?: string;
 
+    /**
+     * The authentication credentials (tokens, keys, etc.) - may be partially hidden
+     * for security
+     */
     credentials?: Record<string, unknown>;
 
+    /**
+     * Fields expected during connection initialization
+     */
     expected_input_fields?: Array<unknown>;
 
+    /**
+     * Whether this authentication configuration is managed by Composio or the user
+     */
     is_composio_managed?: boolean;
 
     /**
-     * The date and time the auth config was last updated
+     * 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 {
+    /**
+     * Deprecated parameters maintained for backward compatibility
+     */
     export interface DeprecatedParams {
+      /**
+       * Deprecated: Default connector ID
+       */
       default_connector_id: string | null;
 
+      /**
+       * Deprecated: Fields expected during connection initialization
+       */
       expected_input_fields?: Array<Record<string, unknown>>;
 
+      /**
+       * Deprecated: Member UUID
+       */
       member_uuid?: string;
 
+      /**
+       * Deprecated: Toolkit ID
+       */
       toolkit_id?: string;
     }
 
+    /**
+     * Information about the associated integration
+     */
     export interface Toolkit {
       /**
-       * The logo of the app
+       * The URL to the integration app's logo image
        */
       logo: string;
 
       /**
-       * The unique key of the app
+       * The unique identifier of the integration app
        */
       slug: string;
     }
@@ -405,6 +537,11 @@ export interface AuthConfigListParams {
    */
   limit?: string;
 
+  /**
+   * Show disabled auth configs
+   */
+  show_disabled?: boolean;
+
   /**
    * The slug of the toolkit to filter by
    */
@@ -412,6 +549,9 @@ export interface AuthConfigListParams {
 }
 
 export interface AuthConfigUpdateStatusParams {
+  /**
+   * The unique identifier of the authentication configuration to update
+   */
   nanoid: string;
 }