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

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

@@ -2,46 +2,142 @@ import { APIResource } from "../../../core/resource.js";
 import { APIPromise } from "../../../core/api-promise.js";
 import { RequestOptions } from "../../../internal/request-options.js";
 export declare 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>;
+    /**
+     * 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>;
 }
 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/resources/org/project/trigger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"trigger.d.ts","sourceRoot":"","sources":["../../../src/resources/org/project/trigger.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAKhG,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGhE;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,OAAO,CAAC;IAEjB,KAAK,EAAE,MAAM,CAAC;IAEd,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,MAAM,EAAE,MAAM,CAAC;IAEf,UAAU,EAAE,MAAM,CAAC;IAEnB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,OAAO,CAAC;IAEjB,KAAK,EAAE,MAAM,CAAC;IAEd,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,MAAM,EAAE,MAAM,CAAC;IAEf,UAAU,EAAE,MAAM,CAAC;IAEnB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"trigger.d.ts","sourceRoot":"","sources":["../../../src/resources/org/project/trigger.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAKhG;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGhE;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/org/project/trigger.js

@@ -4,10 +4,31 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Trigger = void 0;
 const resource_1 = require("../../../core/resource.js");
 class Trigger extends resource_1.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, options) {
         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) {
         return this._client.get('/api/v3/org/project/trigger', options);
     }

package/resources/org/project/trigger.js.map

@@ -1 +1 @@
-{"version":3,"file":"trigger.js","sourceRoot":"","sources":["../../../src/resources/org/project/trigger.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,MAAa,OAAQ,SAAQ,sBAAW;IACtC,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;CACF;AATD,0BASC"}
+{"version":3,"file":"trigger.js","sourceRoot":"","sources":["../../../src/resources/org/project/trigger.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;CACF;AA9BD,0BA8BC"}

package/resources/org/project/trigger.mjs

@@ -1,10 +1,31 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../../../core/resource.mjs";
 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, options) {
         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) {
         return this._client.get('/api/v3/org/project/trigger', options);
     }

package/resources/org/project/trigger.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"trigger.mjs","sourceRoot":"","sources":["../../../src/resources/org/project/trigger.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;CACF"}
+{"version":3,"file":"trigger.mjs","sourceRoot":"","sources":["../../../src/resources/org/project/trigger.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;CACF"}

package/resources/org/project/webhook.d.mts

@@ -3,86 +3,160 @@ import { APIPromise } from "../../../core/api-promise.mjs";
 import { RequestOptions } from "../../../internal/request-options.mjs";
 export declare 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
 }
+/**
+ * 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 declare namespace WebhookRetrieveResponse {
     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;
     }
     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/resources/org/project/webhook.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"webhook.d.mts","sourceRoot":"","sources":["../../../src/resources/org/project/webhook.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIrG,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGtE;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAEhC,GAAG,EAAE,uBAAuB,CAAC,YAAY,GAAG,uBAAuB,CAAC,YAAY,CAAC;IAEjF;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,YAAY;QAC3B,IAAI,EAAE,SAAS,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,YAAY;QAC3B,IAAI,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"webhook.d.mts","sourceRoot":"","sources":["../../../src/resources/org/project/webhook.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIrG;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGtE;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAEhC;;OAEG;IACH,GAAG,EAAE,uBAAuB,CAAC,YAAY,GAAG,uBAAuB,CAAC,YAAY,CAAC;IAEjF;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,YAAY;QAC3B;;WAEG;QACH,IAAI,EAAE,SAAS,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,YAAY;QAC3B;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

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

@@ -3,86 +3,160 @@ import { APIPromise } from "../../../core/api-promise.js";
 import { RequestOptions } from "../../../internal/request-options.js";
 export declare 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
 }
+/**
+ * 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 declare namespace WebhookRetrieveResponse {
     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;
     }
     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/resources/org/project/webhook.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webhook.d.ts","sourceRoot":"","sources":["../../../src/resources/org/project/webhook.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIrG,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGtE;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAEhC,GAAG,EAAE,uBAAuB,CAAC,YAAY,GAAG,uBAAuB,CAAC,YAAY,CAAC;IAEjF;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,YAAY;QAC3B,IAAI,EAAE,SAAS,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,YAAY;QAC3B,IAAI,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"webhook.d.ts","sourceRoot":"","sources":["../../../src/resources/org/project/webhook.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIrG;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGtE;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAEhC;;OAEG;IACH,GAAG,EAAE,uBAAuB,CAAC,YAAY,GAAG,uBAAuB,CAAC,YAAY,CAAC;IAEjF;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,YAAY;QAC3B;;WAEG;QACH,IAAI,EAAE,SAAS,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,YAAY;QAC3B;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}