@composio/client 0.1.0-alpha.6 → 0.1.0-alpha.60

package/src/resources/trigger-instances/index.ts

@@ -1,19 +1,15 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
-  Handle,
-  type HandleRetrieveResponse,
-  type HandleExecuteResponse,
-  type HandleRetrieveParams,
-  type HandleExecuteParams,
-} from './handle';
+  Manage,
+  type ManageUpdateResponse,
+  type ManageDeleteResponse,
+  type ManageUpdateParams,
+} from './manage';
 export {
   TriggerInstances,
   type TriggerInstanceListActiveResponse,
-  type TriggerInstanceRemoveUpsertResponse,
-  type TriggerInstanceUpdateStatusResponse,
   type TriggerInstanceUpsertResponse,
   type TriggerInstanceListActiveParams,
-  type TriggerInstanceUpdateStatusParams,
   type TriggerInstanceUpsertParams,
 } from './trigger-instances';

package/src/resources/trigger-instances/manage.ts

@@ -0,0 +1,72 @@
+// 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';
+import { path } from '../../internal/utils/path';
+
+export class Manage extends APIResource {
+  /**
+   * Updates the status of a trigger instance to enable or disable it. Disabling a
+   * trigger pauses event listening without deleting the trigger configuration.
+   * Re-enabling restores the trigger to its active state. Use this for temporary
+   * maintenance or to control trigger execution.
+   *
+   * @example
+   * ```ts
+   * const manage = await client.triggerInstances.manage.update(
+   *   'triggerId',
+   *   { status: 'enable' },
+   * );
+   * ```
+   */
+  update(
+    triggerID: string,
+    body: ManageUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ManageUpdateResponse> {
+    return this._client.patch(path`/api/v3/trigger_instances/manage/${triggerID}`, { body, ...options });
+  }
+
+  /**
+   * Permanently deletes a trigger instance. This stops the trigger from listening
+   * for events and removes it from your project. Use the PATCH endpoint with status
+   * "disable" if you want to temporarily pause a trigger instead.
+   *
+   * @example
+   * ```ts
+   * const manage = await client.triggerInstances.manage.delete(
+   *   'triggerId',
+   * );
+   * ```
+   */
+  delete(triggerID: string, options?: RequestOptions): APIPromise<ManageDeleteResponse> {
+    return this._client.delete(path`/api/v3/trigger_instances/manage/${triggerID}`, options);
+  }
+}
+
+export interface ManageUpdateResponse {
+  /**
+   * Status of the operation
+   */
+  status: 'success';
+}
+
+export interface ManageDeleteResponse {
+  /**
+   * The ID of the deleted trigger instance
+   */
+  trigger_id: string;
+}
+
+export interface ManageUpdateParams {
+  status: 'enable' | 'disable';
+}
+
+export declare namespace Manage {
+  export {
+    type ManageUpdateResponse as ManageUpdateResponse,
+    type ManageDeleteResponse as ManageDeleteResponse,
+    type ManageUpdateParams as ManageUpdateParams,
+  };
+}

package/src/resources/trigger-instances/trigger-instances.ts

@@ -1,21 +1,26 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as HandleAPI from './handle';
-import {
-  Handle,
-  HandleExecuteParams,
-  HandleExecuteResponse,
-  HandleRetrieveParams,
-  HandleRetrieveResponse,
-} from './handle';
+import * as ManageAPI from './manage';
+import { Manage, ManageDeleteResponse, ManageUpdateParams, ManageUpdateResponse } from './manage';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class TriggerInstances extends APIResource {
-  handle: HandleAPI.Handle = new HandleAPI.Handle(this._client);
+  manage: ManageAPI.Manage = new ManageAPI.Manage(this._client);
 
+  /**
+   * Retrieves all active trigger instances for your project. Triggers listen for
+   * events from connected accounts (e.g., new emails, Slack messages, GitHub
+   * commits) and can invoke webhooks or workflows. Use filters to find triggers for
+   * specific users, connected accounts, or trigger types.
+   *
+   * @example
+   * ```ts
+   * const response = await client.triggerInstances.listActive();
+   * ```
+   */
   listActive(
     query: TriggerInstanceListActiveParams | null | undefined = {},
     options?: RequestOptions,
@@ -23,22 +28,23 @@ export class TriggerInstances extends APIResource {
     return this._client.get('/api/v3/trigger_instances/active', { query, ...options });
   }
 
-  removeUpsert(slug: string, options?: RequestOptions): APIPromise<TriggerInstanceRemoveUpsertResponse> {
-    return this._client.delete(path`/api/v3/trigger_instances/${slug}/upsert`, options);
-  }
-
-  updateStatus(
-    status: 'enable' | 'disable',
-    params: TriggerInstanceUpdateStatusParams,
-    options?: RequestOptions,
-  ): APIPromise<TriggerInstanceUpdateStatusResponse> {
-    const { slug } = params;
-    return this._client.patch(path`/api/v3/trigger_instances/${slug}/status/${status}`, options);
-  }
-
+  /**
+   * Creates a new trigger instance or updates an existing one with the same
+   * configuration. Triggers listen for events from external services (webhooks or
+   * polling) and can invoke your workflows. If a matching trigger already exists and
+   * is disabled, it will be re-enabled. Requires a connected account ID to associate
+   * the trigger with a specific user connection.
+   *
+   * @example
+   * ```ts
+   * const response = await client.triggerInstances.upsert(
+   *   'slug',
+   * );
+   * ```
+   */
   upsert(
     slug: string,
-    body: TriggerInstanceUpsertParams,
+    body: TriggerInstanceUpsertParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<TriggerInstanceUpsertResponse> {
     return this._client.post(path`/api/v3/trigger_instances/${slug}/upsert`, { body, ...options });
@@ -46,11 +52,15 @@ export class TriggerInstances extends APIResource {
 }
 
 export interface TriggerInstanceListActiveResponse {
+  current_page: number;
+
   items: Array<TriggerInstanceListActiveResponse.Item>;
 
-  next_cursor: string | null;
+  total_items: number;
 
   total_pages: number;
+
+  next_cursor?: string | null;
 }
 
 export namespace TriggerInstanceListActiveResponse {
@@ -63,140 +73,258 @@ export namespace TriggerInstanceListActiveResponse {
     /**
      * ID of the connected account this trigger is associated with
      */
+    connected_account_id: string;
+
+    /**
+     * UUID of the connected account this trigger is associated with
+     */
+    connected_account_uuid: string;
+
+    /**
+     * @deprecated DEPRECATED: This parameter will be removed in a future version.
+     * Please use connected_account_id instead.
+     */
     connectedAccountId: string;
 
     /**
      * ISO 8601 timestamp when the trigger instance was disabled, if applicable
      */
+    disabled_at: string | null;
+
+    /**
+     * @deprecated DEPRECATED: This parameter will be removed in a future version.
+     * Please use disabled_at instead.
+     */
     disabledAt: string | null;
 
     /**
      * State of the trigger instance
      */
-    state: Record<string, unknown>;
+    state: { [key: string]: unknown };
 
     /**
      * Configuration for the trigger
      */
-    triggerConfig: Record<string, unknown>;
+    trigger_config: { [key: string]: unknown };
 
     /**
      * Name of the trigger
      */
+    trigger_name: string;
+
+    /**
+     * @deprecated DEPRECATED: This parameter will be removed in a future version.
+     * Please use trigger_config instead.
+     */
+    triggerConfig: { [key: string]: unknown };
+
+    /**
+     * @deprecated DEPRECATED: This parameter will be removed in a future version.
+     * Please use trigger_name instead.
+     */
     triggerName: string;
 
     /**
      * ISO 8601 timestamp when the trigger instance was updated
      */
+    updated_at: string;
+
+    /**
+     * @deprecated DEPRECATED: This parameter will be removed in a future version.
+     * Please use updated_at instead.
+     */
     updatedAt: string;
 
+    /**
+     * ID of the user this trigger is associated with
+     */
+    user_id: string;
+
+    /**
+     * Deprecated fields for the trigger instance
+     */
+    deprecated?: Item.Deprecated;
+
     /**
      * Additional data associated with the trigger instance
      */
-    triggerData?: string;
+    trigger_data?: string;
 
     /**
      * Unique identifier of the trigger instance
      */
     uuid?: string;
   }
+
+  export namespace Item {
+    /**
+     * Deprecated fields for the trigger instance
+     */
+    export interface Deprecated {
+      /**
+       * Deprecated created_at for the trigger instance
+       */
+      createdAt: string;
+    }
+  }
 }
 
-export interface TriggerInstanceRemoveUpsertResponse {
+export interface TriggerInstanceUpsertResponse {
+  deprecated: TriggerInstanceUpsertResponse.Deprecated;
+
   /**
    * ID of the updated trigger
    */
-  triggerId: string;
+  trigger_id: string;
+}
+
+export namespace TriggerInstanceUpsertResponse {
+  export interface Deprecated {
+    /**
+     * ID of the updated trigger
+     */
+    uuid: string;
+  }
 }
 
-export interface TriggerInstanceUpdateStatusResponse {
+export interface TriggerInstanceListActiveParams {
   /**
-   * Status of the operation
+   * Array of auth config IDs to filter triggers by
    */
-  status: 'success';
-}
+  auth_config_ids?: Array<string> | null;
 
-export interface TriggerInstanceUpsertResponse {
   /**
-   * ID of the updated trigger
+   * DEPRECATED: This parameter will be removed in a future version. Please use
+   * auth_config_ids instead.
    */
-  triggerId: string;
-}
+  authConfigIds?: Array<string> | null;
+
+  /**
+   * Array of connected account IDs to filter triggers by
+   */
+  connected_account_ids?: Array<string> | null;
 
-export interface TriggerInstanceListActiveParams {
   /**
-   * Comma-separated list of auth config IDs to filter triggers by
+   * DEPRECATED: This parameter will be removed in a future version. Please use
+   * connected_account_ids instead.
    */
-  authConfigIds?: string;
+  connectedAccountIds?: Array<string> | null;
 
   /**
-   * Comma-separated list of connected account IDs to filter triggers by
+   * 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
+   * page. The cursor is used to paginate through the items. The cursor is not
+   * required for the first page.
    */
-  connectedAccountIds?: string;
+  cursor?: string;
 
   /**
-   * Number of items to return per page.
+   * DEPRECATED: This parameter will be removed in a future version. Please use
+   * auth_config_ids instead.
    */
-  limit?: number;
+  deprecatedAuthConfigUuids?: Array<string> | null;
 
   /**
-   * Page number for pagination. Starts from 1.
+   * DEPRECATED: This parameter will be removed in a future version. Please use
+   * connected_account_ids instead.
    */
-  page?: number;
+  deprecatedConnectedAccountUuids?: Array<string> | null;
+
+  /**
+   * Number of items per page, max allowed is 1000
+   */
+  limit?: number | null;
 
   /**
    * When set to true, includes disabled triggers in the response.
    */
+  show_disabled?: boolean | null;
+
+  /**
+   * DEPRECATED: This parameter will be removed in a future version. Please use
+   * show_disabled instead.
+   */
   showDisabled?: boolean | null;
 
   /**
-   * Comma-separated list of trigger IDs to filter triggers by
+   * Array of trigger IDs to filter triggers by
    */
-  triggerIds?: string;
+  trigger_ids?: Array<string> | null;
 
   /**
-   * Comma-separated list of trigger names to filter triggers by
+   * Array of trigger names to filter triggers by. Case-insensitive (internally
+   * normalized to uppercase).
    */
-  triggerNames?: string;
-}
+  trigger_names?: Array<string> | null;
+
+  /**
+   * DEPRECATED: This parameter will be removed in a future version. Please use
+   * trigger_ids instead.
+   */
+  triggerIds?: Array<string> | null;
 
-export interface TriggerInstanceUpdateStatusParams {
   /**
-   * The slug of the trigger instance
+   * DEPRECATED: This parameter will be removed in a future version. Please use
+   * trigger_names instead.
    */
-  slug: string;
+  triggerNames?: Array<string> | null;
+
+  /**
+   * Array of user IDs to filter triggers by
+   */
+  user_ids?: Array<string> | null;
 }
 
 export interface TriggerInstanceUpsertParams {
   /**
-   * Connection ID
+   * Connected account nanoid
+   */
+  connected_account_id?: string;
+
+  /**
+   * @deprecated DEPRECATED: This parameter will be removed in a future version.
+   * Please use connected_account_id instead.
    */
-  connectedAuthId: string;
+  connectedAuthId?: string;
+
+  /**
+   * Toolkit version specification. Supports "latest" string or a record mapping
+   * toolkit slugs to specific versions.
+   */
+  toolkit_versions?: string | { [key: string]: string } | null;
 
   /**
    * Trigger configuration
    */
-  triggerConfig: Record<string, unknown>;
+  trigger_config?: { [key: string]: unknown };
+
+  /**
+   * @deprecated DEPRECATED: This parameter will be removed in a future version.
+   * Please use trigger_config instead.
+   */
+  triggerConfig?: { [key: string]: unknown };
+
+  /**
+   * @deprecated DEPRECATED: This parameter will be removed in a future version.
+   * Please use toolkit_versions instead.
+   */
+  version?: string;
 }
 
-TriggerInstances.Handle = Handle;
+TriggerInstances.Manage = Manage;
 
 export declare namespace TriggerInstances {
   export {
     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,
   };
 
   export {
-    Handle as Handle,
-    type HandleRetrieveResponse as HandleRetrieveResponse,
-    type HandleExecuteResponse as HandleExecuteResponse,
-    type HandleRetrieveParams as HandleRetrieveParams,
-    type HandleExecuteParams as HandleExecuteParams,
+    Manage as Manage,
+    type ManageUpdateResponse as ManageUpdateResponse,
+    type ManageDeleteResponse as ManageDeleteResponse,
+    type ManageUpdateParams as ManageUpdateParams,
   };
 }