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

package/src/resources/triggers-types.ts

@@ -9,13 +9,26 @@ 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: string, options?: RequestOptions): APIPromise<TriggersTypeRetrieveResponse> {
     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: TriggersTypeListParams | null | undefined = {},
@@ -24,33 +37,75 @@ export class TriggersTypes extends APIResource {
     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?: RequestOptions): APIPromise<string> {
     return this._client.get('/api/v3/triggers_types/list/enum', options);
   }
 }
 
 export interface TriggersTypeRetrieveResponse {
+  /**
+   * Configuration parameters required for the trigger
+   */
   config: Record<string, unknown>;
 
+  /**
+   * Detailed description of what the trigger does and when it fires
+   */
   description: string;
 
+  /**
+   * Step-by-step instructions on how to set up and use this trigger
+   */
   instructions: string;
 
+  /**
+   * Display name of the trigger type
+   */
   name: string;
 
+  /**
+   * Structure of the event payload that will be delivered by this trigger
+   */
   payload: Record<string, unknown>;
 
+  /**
+   * Unique identifier for the trigger type
+   */
   slug: string;
 
+  /**
+   * Information about the toolkit that contains this trigger
+   */
   toolkit: TriggersTypeRetrieveResponse.Toolkit;
 }
 
 export namespace TriggersTypeRetrieveResponse {
+  /**
+   * Information about the toolkit that contains this trigger
+   */
   export interface Toolkit {
+    /**
+     * URL to the toolkit logo image
+     */
     logo: string;
 
+    /**
+     * Name of the toolkit that contains this trigger
+     */
     name: string;
 
+    /**
+     * Unique identifier for the associated toolkit
+     */
     uuid: string;
   }
 }
@@ -65,39 +120,78 @@ export interface TriggersTypeListResponse {
 
 export namespace TriggersTypeListResponse {
   export interface Item {
+    /**
+     * Configuration schema required to set up this trigger
+     */
     config: Record<string, unknown>;
 
+    /**
+     * Detailed description of what the trigger does
+     */
     description: string;
 
+    /**
+     * Human-readable name of the trigger
+     */
     name: string;
 
+    /**
+     * Schema of the data payload this trigger will deliver when it fires
+     */
     payload: Record<string, unknown>;
 
+    /**
+     * Unique identifier for the trigger type
+     */
     slug: string;
 
+    /**
+     * Information about the toolkit that provides this trigger
+     */
     toolkit: Item.Toolkit;
 
+    /**
+     * The trigger mechanism - either webhook (event-based) or poll (scheduled check)
+     */
     type: 'webhook' | 'poll';
   }
 
   export namespace Item {
+    /**
+     * Information about the toolkit that provides this trigger
+     */
     export interface Toolkit {
+      /**
+       * Name of the parent toolkit
+       */
       name: string;
 
+      /**
+       * Unique identifier for the parent toolkit
+       */
       slug: string;
     }
   }
 }
 
+/**
+ * JSON string containing all trigger enum values
+ */
 export type TriggersTypeRetrieveEnumResponse = string;
 
 export interface TriggersTypeListParams {
+  /**
+   * Pagination cursor for fetching next page of results
+   */
   cursor?: string;
 
+  /**
+   * Number of items to return per page
+   */
   limit?: number | null;
 
   /**
-   * Array of toolkit slugs
+   * Array of toolkit slugs to filter triggers by
    */
   toolkit_slugs?: Array<string> | null;
 }

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-alpha.10";
+export declare const VERSION = "0.1.0-alpha.11";
 //# 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.10'; // x-release-please-version
+exports.VERSION = '0.1.0-alpha.11'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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