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

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

@@ -5,83 +5,175 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 
 export class Trigger extends APIResource {
+  /**
+   * Updates the trigger enablement status for the current project. Use this endpoint
+   * to enable or disable triggers for automated workflows within a project.
+   *
+   * @example
+   * ```ts
+   * const trigger = await client.org.project.trigger.update({
+   *   enabled: true,
+   * });
+   * ```
+   */
   update(params: TriggerUpdateParams, options?: RequestOptions): APIPromise<TriggerUpdateResponse> {
     const { enabled } = params;
     return this._client.patch('/api/v3/org/project/trigger', { query: { enabled }, ...options });
   }
 
+  /**
+   * Retrieves the current project details including its trigger enablement status.
+   * Use this endpoint to check whether triggers are currently enabled or disabled
+   * for a project.
+   *
+   * @example
+   * ```ts
+   * const triggers = await client.org.project.trigger.list();
+   * ```
+   */
   list(options?: RequestOptions): APIPromise<TriggerListResponse> {
     return this._client.get('/api/v3/org/project/trigger', options);
   }
 }
 
 export interface TriggerUpdateResponse {
+  /**
+   * Unique identifier for the project
+   */
   id: string;
 
-  auto_id: number;
-
+  /**
+   * ISO timestamp when the project was created
+   */
   created_at: string;
 
+  /**
+   * Whether this project has been soft-deleted
+   */
   deleted: boolean;
 
+  /**
+   * Email address associated with the project
+   */
   email: string;
 
+  /**
+   * URL where event webhook notifications will be sent (can be null)
+   */
   event_webhook_url: string | null;
 
+  /**
+   * Name of the project
+   */
   name: string;
 
-  nano_id: string | null;
-
+  /**
+   * Identifier of the organization that owns this project
+   */
   org_id: string;
 
+  /**
+   * ISO timestamp when the project was last updated
+   */
   updated_at: string;
 
+  /**
+   * Secret key used to sign webhook payloads for verification
+   */
   webhook_secret: string | null;
 
+  /**
+   * URL where webhook events will be sent (can be null)
+   */
   webhook_url: string | null;
 
+  /**
+   * Indicates if the webhook configuration is using the new format
+   */
   is_new_webhook?: boolean;
 
+  /**
+   * ISO timestamp when the project last subscribed to updates
+   */
   last_subscribed_at?: string | null;
 
+  /**
+   * Whether triggers are enabled for this project
+   */
   triggers_enabled?: boolean;
 }
 
 export interface TriggerListResponse {
+  /**
+   * Unique identifier for the project
+   */
   id: string;
 
-  auto_id: number;
-
+  /**
+   * ISO timestamp when the project was created
+   */
   created_at: string;
 
+  /**
+   * Whether this project has been soft-deleted
+   */
   deleted: boolean;
 
+  /**
+   * Email address associated with the project
+   */
   email: string;
 
+  /**
+   * URL where event webhook notifications will be sent (can be null)
+   */
   event_webhook_url: string | null;
 
+  /**
+   * Name of the project
+   */
   name: string;
 
-  nano_id: string | null;
-
+  /**
+   * Identifier of the organization that owns this project
+   */
   org_id: string;
 
+  /**
+   * ISO timestamp when the project was last updated
+   */
   updated_at: string;
 
+  /**
+   * Secret key used to sign webhook payloads for verification
+   */
   webhook_secret: string | null;
 
+  /**
+   * URL where webhook events will be sent (can be null)
+   */
   webhook_url: string | null;
 
+  /**
+   * Indicates if the webhook configuration is using the new format
+   */
   is_new_webhook?: boolean;
 
+  /**
+   * ISO timestamp when the project last subscribed to updates
+   */
   last_subscribed_at?: string | null;
 
+  /**
+   * Whether triggers are enabled for this project
+   */
   triggers_enabled?: boolean;
 }
 
 export interface TriggerUpdateParams {
   /**
-   * Enabled
+   * Boolean flag indicating whether triggers should be enabled (true) or disabled
+   * (false) for the project
    */
   enabled: boolean;
 }

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

@@ -6,114 +6,188 @@ import { RequestOptions } from '../../../internal/request-options';
 
 export class Webhook extends APIResource {
   /**
-   * Get the webhook URL for a project
+   * Retrieves the webhook URL and secret for the current project. Webhooks come in
+   * two types: "trigger" webhooks are used for integration trigger events, while
+   * "event" webhooks receive system notifications about project events. The response
+   * includes both the URL and the secret key used to verify webhook signatures.
+   *
+   * @example
+   * ```ts
+   * const webhook = await client.org.project.webhook.retrieve({
+   *   type: 'trigger',
+   * });
+   * ```
    */
   retrieve(query: WebhookRetrieveParams, options?: RequestOptions): APIPromise<WebhookRetrieveResponse> {
     return this._client.get('/api/v3/org/project/webhook', { query, ...options });
   }
 
+  /**
+   * Updates the webhook URL for the current project based on the specified type
+   * (trigger or event). Webhook URLs are endpoints that receive notifications about
+   * events in your project. "Trigger" webhooks receive integration trigger events,
+   * while "event" webhooks receive system notifications. This endpoint allows you to
+   * set or change these notification destinations.
+   *
+   * @example
+   * ```ts
+   * const webhook = await client.org.project.webhook.update({
+   *   type: 'trigger',
+   *   webhook_url: 'https://example.com/api/webhooks/triggers',
+   * });
+   * ```
+   */
   update(body: WebhookUpdateParams, options?: RequestOptions): APIPromise<WebhookUpdateResponse> {
     return this._client.post('/api/v3/org/project/webhook/update', { body, ...options });
   }
 
+  /**
+   * Removes a webhook URL (trigger or event) from the project configuration. This
+   * operation sets the specified webhook URL to null in the database but preserves
+   * the webhook secret. After deletion, the project will no longer receive webhook
+   * notifications of the specified type until a new URL is configured.
+   *
+   * @example
+   * ```ts
+   * const webhook = await client.org.project.webhook.delete({
+   *   type: 'trigger',
+   * });
+   * ```
+   */
   delete(body: WebhookDeleteParams, options?: RequestOptions): APIPromise<WebhookDeleteResponse> {
     return this._client.delete('/api/v3/org/project/webhook', { body, ...options });
   }
 
+  /**
+   * Generates a new webhook secret for the project, invalidating the previous one.
+   * Webhook secrets are used to verify the authenticity of incoming webhook payloads
+   * through signature verification. This endpoint should be used when you need to
+   * rotate your webhook secret for security purposes. After refreshing, you must
+   * update your webhook verification logic to use the new secret.
+   *
+   * @example
+   * ```ts
+   * const response = await client.org.project.webhook.refresh();
+   * ```
+   */
   refresh(options?: RequestOptions): APIPromise<WebhookRefreshResponse> {
     return this._client.post('/api/v3/org/project/webhook/refresh', options);
   }
 }
 
+/**
+ * Response containing webhook URL configuration and secret
+ */
 export interface WebhookRetrieveResponse {
   /**
-   * Status of the webhook
+   * Indicates whether the webhook was found and retrieved successfully
    */
   status: 'success' | 'not found';
 
+  /**
+   * The webhook configuration containing either trigger or event webhook URL
+   */
   url: WebhookRetrieveResponse.UnionMember0 | WebhookRetrieveResponse.UnionMember1;
 
   /**
-   * Webhook secret
+   * The secret key that should be used to verify webhook signatures
    */
   webhook_secret: string;
 }
 
 export namespace WebhookRetrieveResponse {
   export interface UnionMember0 {
+    /**
+     * Identifies this as a trigger webhook response
+     */
     type: 'trigger';
 
     /**
-     * Webhook URL
+     * The URL endpoint where trigger notifications will be delivered
      */
     webhook_url?: string;
   }
 
   export interface UnionMember1 {
+    /**
+     * Identifies this as an event webhook response
+     */
     type: 'event';
 
     /**
-     * Event webhook URL
+     * The URL endpoint where event notifications will be delivered
      */
     event_webhook_url?: string;
   }
 }
 
+/**
+ * Response indicating the status of the webhook URL update operation
+ */
 export interface WebhookUpdateResponse {
   /**
-   * Status message
+   * Human-readable description of the update operation result
    */
   message: string;
 
   /**
-   * Whether the operation was successful
+   * Indicates if the webhook URL update was completed successfully
    */
   success: boolean;
 }
 
+/**
+ * Response indicating successful webhook URL deletion
+ */
 export interface WebhookDeleteResponse {
+  /**
+   * Indicates the webhook URL was successfully removed
+   */
   status: 'success';
 }
 
+/**
+ * Response containing the newly generated webhook secret
+ */
 export interface WebhookRefreshResponse {
   /**
-   * Status message
+   * Human-readable description of the refresh operation result
    */
   message: string;
 
   /**
-   * Whether the operation was successful
+   * Indicates if the webhook secret was successfully refreshed
    */
   success: boolean;
 
   /**
-   * Webhook secret
+   * The new secret key that should be used to verify incoming webhook payloads
    */
   webhook_secret: string;
 }
 
 export interface WebhookRetrieveParams {
   /**
-   * Type of the webhook
+   * Type of webhook to retrieve (trigger or event)
    */
   type: 'trigger' | 'event';
 }
 
 export interface WebhookUpdateParams {
   /**
-   * Type of the webhook
+   * Specifies which webhook type to update (trigger or event)
    */
   type: 'trigger' | 'event';
 
   /**
-   * Webhook URL
+   * Valid URL that will receive webhook payloads. Must include https:// protocol.
    */
   webhook_url: string;
 }
 
 export interface WebhookDeleteParams {
   /**
-   * Type of the webhook
+   * Specifies which webhook type to remove from the project configuration
    */
   type: 'trigger' | 'event';
 }

package/src/resources/team-members.ts

@@ -6,6 +6,9 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class TeamMembers extends APIResource {
+  /**
+   * Update the details of an existing team member
+   */
   update(
     id: string,
     body: TeamMemberUpdateParams,
@@ -14,14 +17,23 @@ export class TeamMembers extends APIResource {
     return this._client.put(path`/api/v3/team-members/update/${id}`, { body, ...options });
   }
 
+  /**
+   * Retrieve a list of all team members in the current organization
+   */
   list(options?: RequestOptions): APIPromise<TeamMemberListResponse> {
     return this._client.get('/api/v3/team-members/list', options);
   }
 
+  /**
+   * Send an invitation to a new team member to join the organization
+   */
   invite(body: TeamMemberInviteParams, options?: RequestOptions): APIPromise<TeamMemberInviteResponse> {
     return this._client.post('/api/v3/team-members/invite', { body, ...options });
   }
 
+  /**
+   * Remove a team member from the organization and revoke their access
+   */
   remove(id: string, options?: RequestOptions): APIPromise<TeamMemberRemoveResponse> {
     return this._client.delete(path`/api/v3/team-members/remove/${id}`, options);
   }