@mobilerun/sdk 5.1.0 → 5.2.1

package/resources/webhooks/webhooks.d.mts

@@ -7,7 +7,10 @@ import { RequestOptions } from "../../internal/request-options.mjs";
 export declare class Webhooks extends APIResource {
     deliveries: DeliveriesAPI.Deliveries;
     /**
-     * Register a webhook subscription
+     * Creates a webhook subscription with a delivery URL and an optional list of event
+     * types to subscribe to (defaults to all when omitted). The response includes the
+     * generated signing secret, which is returned only once at creation time and
+     * cannot be retrieved later.
      *
      * @example
      * ```ts
@@ -18,7 +21,9 @@ export declare class Webhooks extends APIResource {
      */
     create(body: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse>;
     /**
-     * Get a webhook subscription
+     * Returns a single webhook subscription by id, including its URL, subscribed event
+     * types, state, and system-observed delivery health. The signing secret is never
+     * included.
      *
      * @example
      * ```ts
@@ -29,7 +34,10 @@ export declare class Webhooks extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<WebhookRetrieveResponse>;
     /**
-     * Update a webhook subscription
+     * Updates a webhook subscription. Any combination of the subscribed event types,
+     * state (ACTIVE or DISABLED), and description may be changed, and at least one
+     * field must be supplied. Setting state to ACTIVE re-enables a subscription that
+     * was auto-blocked after sustained delivery failures.
      *
      * @example
      * ```ts
@@ -40,7 +48,10 @@ export declare class Webhooks extends APIResource {
      */
     update(id: string, body?: WebhookUpdateParams | null | undefined, options?: RequestOptions): APIPromise<WebhookUpdateResponse>;
     /**
-     * List your webhook subscriptions
+     * Returns a paginated list of your webhook subscriptions, optionally filtered by
+     * status (active, failing, blocked, or disabled) and/or by `search` (a
+     * case-insensitive substring match against the URL or description). The response
+     * also includes per-status counts across all of your subscriptions.
      *
      * @example
      * ```ts
@@ -49,7 +60,8 @@ export declare class Webhooks extends APIResource {
      */
     list(query?: WebhookListParams | null | undefined, options?: RequestOptions): APIPromise<WebhookListResponse>;
     /**
-     * Delete a webhook subscription
+     * Deletes a webhook subscription so it stops receiving deliveries. Returns 204 No
+     * Content on success.
      *
      * @example
      * ```ts
@@ -60,7 +72,9 @@ export declare class Webhooks extends APIResource {
      */
     delete(id: string, options?: RequestOptions): APIPromise<void>;
     /**
-     * List subscribable event types per source
+     * Returns the catalog of event types that webhook subscriptions can subscribe to,
+     * grouped by source. Use the returned type identifiers as the `eventTypes` values
+     * when creating or updating a webhook.
      *
      * @example
      * ```ts
@@ -69,7 +83,9 @@ export declare class Webhooks extends APIResource {
      */
     eventTypes(options?: RequestOptions): APIPromise<WebhookEventTypesResponse>;
     /**
-     * Rotate the signing secret (returned once)
+     * Generates a new signing secret for the webhook subscription and returns it once
+     * in the response. The previous secret is replaced immediately, so any signature
+     * verification on your endpoint must be updated to use the new value.
      *
      * @example
      * ```ts
@@ -80,7 +96,9 @@ export declare class Webhooks extends APIResource {
      */
     rotateSecret(id: string, options?: RequestOptions): APIPromise<WebhookRotateSecretResponse>;
     /**
-     * Send a one-shot test delivery
+     * Sends a single test payload to the webhook subscription URL to verify
+     * connectivity. The response reports whether the attempt succeeded along with the
+     * returned HTTP status code or error, if any.
      *
      * @example
      * ```ts
@@ -100,6 +118,10 @@ export declare namespace WebhookCreateResponse {
         blockedAt: string | null;
         blockedReason: string | null;
         createdAt: string;
+        /**
+         * Id of the actor who created this endpoint. Null when no creator was recorded.
+         */
+        createdBy: string | null;
         description: string | null;
         eventTypes: Array<string>;
         /**
@@ -126,6 +148,10 @@ export declare namespace WebhookRetrieveResponse {
         blockedAt: string | null;
         blockedReason: string | null;
         createdAt: string;
+        /**
+         * Id of the actor who created this endpoint. Null when no creator was recorded.
+         */
+        createdBy: string | null;
         description: string | null;
         eventTypes: Array<string>;
         /**
@@ -148,6 +174,10 @@ export declare namespace WebhookUpdateResponse {
         blockedAt: string | null;
         blockedReason: string | null;
         createdAt: string;
+        /**
+         * Id of the actor who created this endpoint. Null when no creator was recorded.
+         */
+        createdBy: string | null;
         description: string | null;
         eventTypes: Array<string>;
         /**
@@ -179,6 +209,10 @@ export declare namespace WebhookListResponse {
         blockedAt: string | null;
         blockedReason: string | null;
         createdAt: string;
+        /**
+         * Id of the actor who created this endpoint. Null when no creator was recorded.
+         */
+        createdBy: string | null;
         description: string | null;
         eventTypes: Array<string>;
         /**
@@ -197,7 +231,7 @@ export interface WebhookEventTypesResponse {
 }
 export declare namespace WebhookEventTypesResponse {
     interface Data {
-        schemaVersion: number;
+        schemaVersion: 1;
         sources: Array<Data.Source>;
     }
     namespace Data {
@@ -208,8 +242,16 @@ export declare namespace WebhookEventTypesResponse {
         namespace Source {
             interface Event {
                 description: string;
+                surfaces: Event.Surfaces;
                 type: string;
             }
+            namespace Event {
+                interface Surfaces {
+                    feed: boolean;
+                    toast: boolean;
+                    webhook: boolean;
+                }
+            }
         }
     }
 }
@@ -222,6 +264,10 @@ export declare namespace WebhookRotateSecretResponse {
         blockedAt: string | null;
         blockedReason: string | null;
         createdAt: string;
+        /**
+         * Id of the actor who created this endpoint. Null when no creator was recorded.
+         */
+        createdBy: string | null;
         description: string | null;
         eventTypes: Array<string>;
         /**
@@ -260,8 +306,20 @@ export interface WebhookUpdateParams {
     state?: 'ACTIVE' | 'DISABLED';
 }
 export interface WebhookListParams {
+    /**
+     * Only include webhooks created by this actor id. Mutually exclusive with `mine`.
+     */
+    createdBy?: string;
+    /**
+     * When true, only include webhooks created by you (not just owned by your org).
+     */
+    mine?: 'true' | 'false';
     page?: number;
     pageSize?: number;
+    /**
+     * Case-insensitive substring match against the URL or description.
+     */
+    search?: string;
     status?: 'active' | 'failing' | 'blocked' | 'disabled';
 }
 export declare namespace Webhooks {

package/resources/webhooks/webhooks.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"webhooks.d.mts","sourceRoot":"","sources":["../../src/resources/webhooks/webhooks.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EACL,UAAU,EACV,4BAA4B,EAC5B,8BAA8B,EAC9B,kBAAkB,EAClB,oBAAoB,EACpB,8BAA8B,EAC9B,gCAAgC,EAChC,mBAAmB,EACnB,qBAAqB,EACtB,yBAAqB;AACtB,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,QAAS,SAAQ,WAAW;IACvC,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInF;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;OAOG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAI3E;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAI3F;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAG5F;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,mBAAmB,CAAC,MAAM,CAAC;IAEnC,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAEvC,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;CAC/B;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,MAAM;QACrB,MAAM,EAAE,MAAM,CAAC;QAEf,OAAO,EAAE,MAAM,CAAC;QAEhB,QAAQ,EAAE,MAAM,CAAC;QAEjB,OAAO,EAAE,MAAM,CAAC;QAEhB,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,IAAI;QACnB,aAAa,EAAE,MAAM,CAAC;QAEtB,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,MAAM;YACrB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAE5B,MAAM,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,MAAM,CAAC;YACtB,UAAiB,KAAK;gBACpB,WAAW,EAAE,MAAM,CAAC;gBAEpB,IAAI,EAAE,MAAM,CAAC;aACd;SACF;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,OAAO,EAAE,OAAO,CAAC;KAClB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B,KAAK,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;CAC/B;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;CACxD;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"webhooks.d.mts","sourceRoot":"","sources":["../../src/resources/webhooks/webhooks.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EACL,UAAU,EACV,4BAA4B,EAC5B,8BAA8B,EAC9B,kBAAkB,EAClB,oBAAoB,EACpB,8BAA8B,EAC9B,gCAAgC,EAChC,mBAAmB,EACnB,qBAAqB,EACtB,yBAAqB;AACtB,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,QAAS,SAAQ,WAAW;IACvC,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInF;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAI3E;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAI3F;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAG5F;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,mBAAmB,CAAC,MAAM,CAAC;IAEnC,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAEvC,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;CAC/B;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,MAAM;QACrB,MAAM,EAAE,MAAM,CAAC;QAEf,OAAO,EAAE,MAAM,CAAC;QAEhB,QAAQ,EAAE,MAAM,CAAC;QAEjB,OAAO,EAAE,MAAM,CAAC;QAEhB,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,IAAI;QACnB,aAAa,EAAE,CAAC,CAAC;QAEjB,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,MAAM;YACrB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAE5B,MAAM,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,MAAM,CAAC;YACtB,UAAiB,KAAK;gBACpB,WAAW,EAAE,MAAM,CAAC;gBAEpB,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC;gBAEzB,IAAI,EAAE,MAAM,CAAC;aACd;YAED,UAAiB,KAAK,CAAC;gBACrB,UAAiB,QAAQ;oBACvB,IAAI,EAAE,OAAO,CAAC;oBAEd,KAAK,EAAE,OAAO,CAAC;oBAEf,OAAO,EAAE,OAAO,CAAC;iBAClB;aACF;SACF;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,OAAO,EAAE,OAAO,CAAC;KAClB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B,KAAK,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;CAC/B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAExB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;CACxD;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/webhooks/webhooks.d.ts

@@ -7,7 +7,10 @@ import { RequestOptions } from "../../internal/request-options.js";
 export declare class Webhooks extends APIResource {
     deliveries: DeliveriesAPI.Deliveries;
     /**
-     * Register a webhook subscription
+     * Creates a webhook subscription with a delivery URL and an optional list of event
+     * types to subscribe to (defaults to all when omitted). The response includes the
+     * generated signing secret, which is returned only once at creation time and
+     * cannot be retrieved later.
      *
      * @example
      * ```ts
@@ -18,7 +21,9 @@ export declare class Webhooks extends APIResource {
      */
     create(body: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse>;
     /**
-     * Get a webhook subscription
+     * Returns a single webhook subscription by id, including its URL, subscribed event
+     * types, state, and system-observed delivery health. The signing secret is never
+     * included.
      *
      * @example
      * ```ts
@@ -29,7 +34,10 @@ export declare class Webhooks extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<WebhookRetrieveResponse>;
     /**
-     * Update a webhook subscription
+     * Updates a webhook subscription. Any combination of the subscribed event types,
+     * state (ACTIVE or DISABLED), and description may be changed, and at least one
+     * field must be supplied. Setting state to ACTIVE re-enables a subscription that
+     * was auto-blocked after sustained delivery failures.
      *
      * @example
      * ```ts
@@ -40,7 +48,10 @@ export declare class Webhooks extends APIResource {
      */
     update(id: string, body?: WebhookUpdateParams | null | undefined, options?: RequestOptions): APIPromise<WebhookUpdateResponse>;
     /**
-     * List your webhook subscriptions
+     * Returns a paginated list of your webhook subscriptions, optionally filtered by
+     * status (active, failing, blocked, or disabled) and/or by `search` (a
+     * case-insensitive substring match against the URL or description). The response
+     * also includes per-status counts across all of your subscriptions.
      *
      * @example
      * ```ts
@@ -49,7 +60,8 @@ export declare class Webhooks extends APIResource {
      */
     list(query?: WebhookListParams | null | undefined, options?: RequestOptions): APIPromise<WebhookListResponse>;
     /**
-     * Delete a webhook subscription
+     * Deletes a webhook subscription so it stops receiving deliveries. Returns 204 No
+     * Content on success.
      *
      * @example
      * ```ts
@@ -60,7 +72,9 @@ export declare class Webhooks extends APIResource {
      */
     delete(id: string, options?: RequestOptions): APIPromise<void>;
     /**
-     * List subscribable event types per source
+     * Returns the catalog of event types that webhook subscriptions can subscribe to,
+     * grouped by source. Use the returned type identifiers as the `eventTypes` values
+     * when creating or updating a webhook.
      *
      * @example
      * ```ts
@@ -69,7 +83,9 @@ export declare class Webhooks extends APIResource {
      */
     eventTypes(options?: RequestOptions): APIPromise<WebhookEventTypesResponse>;
     /**
-     * Rotate the signing secret (returned once)
+     * Generates a new signing secret for the webhook subscription and returns it once
+     * in the response. The previous secret is replaced immediately, so any signature
+     * verification on your endpoint must be updated to use the new value.
      *
      * @example
      * ```ts
@@ -80,7 +96,9 @@ export declare class Webhooks extends APIResource {
      */
     rotateSecret(id: string, options?: RequestOptions): APIPromise<WebhookRotateSecretResponse>;
     /**
-     * Send a one-shot test delivery
+     * Sends a single test payload to the webhook subscription URL to verify
+     * connectivity. The response reports whether the attempt succeeded along with the
+     * returned HTTP status code or error, if any.
      *
      * @example
      * ```ts
@@ -100,6 +118,10 @@ export declare namespace WebhookCreateResponse {
         blockedAt: string | null;
         blockedReason: string | null;
         createdAt: string;
+        /**
+         * Id of the actor who created this endpoint. Null when no creator was recorded.
+         */
+        createdBy: string | null;
         description: string | null;
         eventTypes: Array<string>;
         /**
@@ -126,6 +148,10 @@ export declare namespace WebhookRetrieveResponse {
         blockedAt: string | null;
         blockedReason: string | null;
         createdAt: string;
+        /**
+         * Id of the actor who created this endpoint. Null when no creator was recorded.
+         */
+        createdBy: string | null;
         description: string | null;
         eventTypes: Array<string>;
         /**
@@ -148,6 +174,10 @@ export declare namespace WebhookUpdateResponse {
         blockedAt: string | null;
         blockedReason: string | null;
         createdAt: string;
+        /**
+         * Id of the actor who created this endpoint. Null when no creator was recorded.
+         */
+        createdBy: string | null;
         description: string | null;
         eventTypes: Array<string>;
         /**
@@ -179,6 +209,10 @@ export declare namespace WebhookListResponse {
         blockedAt: string | null;
         blockedReason: string | null;
         createdAt: string;
+        /**
+         * Id of the actor who created this endpoint. Null when no creator was recorded.
+         */
+        createdBy: string | null;
         description: string | null;
         eventTypes: Array<string>;
         /**
@@ -197,7 +231,7 @@ export interface WebhookEventTypesResponse {
 }
 export declare namespace WebhookEventTypesResponse {
     interface Data {
-        schemaVersion: number;
+        schemaVersion: 1;
         sources: Array<Data.Source>;
     }
     namespace Data {
@@ -208,8 +242,16 @@ export declare namespace WebhookEventTypesResponse {
         namespace Source {
             interface Event {
                 description: string;
+                surfaces: Event.Surfaces;
                 type: string;
             }
+            namespace Event {
+                interface Surfaces {
+                    feed: boolean;
+                    toast: boolean;
+                    webhook: boolean;
+                }
+            }
         }
     }
 }
@@ -222,6 +264,10 @@ export declare namespace WebhookRotateSecretResponse {
         blockedAt: string | null;
         blockedReason: string | null;
         createdAt: string;
+        /**
+         * Id of the actor who created this endpoint. Null when no creator was recorded.
+         */
+        createdBy: string | null;
         description: string | null;
         eventTypes: Array<string>;
         /**
@@ -260,8 +306,20 @@ export interface WebhookUpdateParams {
     state?: 'ACTIVE' | 'DISABLED';
 }
 export interface WebhookListParams {
+    /**
+     * Only include webhooks created by this actor id. Mutually exclusive with `mine`.
+     */
+    createdBy?: string;
+    /**
+     * When true, only include webhooks created by you (not just owned by your org).
+     */
+    mine?: 'true' | 'false';
     page?: number;
     pageSize?: number;
+    /**
+     * Case-insensitive substring match against the URL or description.
+     */
+    search?: string;
     status?: 'active' | 'failing' | 'blocked' | 'disabled';
 }
 export declare namespace Webhooks {

package/resources/webhooks/webhooks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../../src/resources/webhooks/webhooks.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,aAAa,wBAAqB;AAC9C,OAAO,EACL,UAAU,EACV,4BAA4B,EAC5B,8BAA8B,EAC9B,kBAAkB,EAClB,oBAAoB,EACpB,8BAA8B,EAC9B,gCAAgC,EAChC,mBAAmB,EACnB,qBAAqB,EACtB,wBAAqB;AACtB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,QAAS,SAAQ,WAAW;IACvC,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInF;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;OAOG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAI3E;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAI3F;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAG5F;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,mBAAmB,CAAC,MAAM,CAAC;IAEnC,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAEvC,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;CAC/B;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,MAAM;QACrB,MAAM,EAAE,MAAM,CAAC;QAEf,OAAO,EAAE,MAAM,CAAC;QAEhB,QAAQ,EAAE,MAAM,CAAC;QAEjB,OAAO,EAAE,MAAM,CAAC;QAEhB,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,IAAI;QACnB,aAAa,EAAE,MAAM,CAAC;QAEtB,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,MAAM;YACrB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAE5B,MAAM,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,MAAM,CAAC;YACtB,UAAiB,KAAK;gBACpB,WAAW,EAAE,MAAM,CAAC;gBAEpB,IAAI,EAAE,MAAM,CAAC;aACd;SACF;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,OAAO,EAAE,OAAO,CAAC;KAClB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B,KAAK,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;CAC/B;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;CACxD;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../../src/resources/webhooks/webhooks.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,aAAa,wBAAqB;AAC9C,OAAO,EACL,UAAU,EACV,4BAA4B,EAC5B,8BAA8B,EAC9B,kBAAkB,EAClB,oBAAoB,EACpB,8BAA8B,EAC9B,gCAAgC,EAChC,mBAAmB,EACnB,qBAAqB,EACtB,wBAAqB;AACtB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,QAAS,SAAQ,WAAW;IACvC,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInF;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAI3E;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAI3F;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAG5F;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,mBAAmB,CAAC,MAAM,CAAC;IAEnC,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAEvC,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;CAC/B;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,MAAM;QACrB,MAAM,EAAE,MAAM,CAAC;QAEf,OAAO,EAAE,MAAM,CAAC;QAEhB,QAAQ,EAAE,MAAM,CAAC;QAEjB,OAAO,EAAE,MAAM,CAAC;QAEhB,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,IAAI;QACnB,aAAa,EAAE,CAAC,CAAC;QAEjB,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,MAAM;YACrB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAE5B,MAAM,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,MAAM,CAAC;YACtB,UAAiB,KAAK;gBACpB,WAAW,EAAE,MAAM,CAAC;gBAEpB,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC;gBAEzB,IAAI,EAAE,MAAM,CAAC;aACd;YAED,UAAiB,KAAK,CAAC;gBACrB,UAAiB,QAAQ;oBACvB,IAAI,EAAE,OAAO,CAAC;oBAEd,KAAK,EAAE,OAAO,CAAC;oBAEf,OAAO,EAAE,OAAO,CAAC;iBAClB;aACF;SACF;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAE1C;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,cAAc,EAAE,OAAO,CAAC;QAExB,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;QAEzC,SAAS,EAAE,MAAM,CAAC;QAElB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,OAAO,EAAE,OAAO,CAAC;KAClB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B,KAAK,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;CAC/B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAExB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;CACxD;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/webhooks/webhooks.js

@@ -14,7 +14,10 @@ class Webhooks extends resource_1.APIResource {
         this.deliveries = new DeliveriesAPI.Deliveries(this._client);
     }
     /**
-     * Register a webhook subscription
+     * Creates a webhook subscription with a delivery URL and an optional list of event
+     * types to subscribe to (defaults to all when omitted). The response includes the
+     * generated signing secret, which is returned only once at creation time and
+     * cannot be retrieved later.
      *
      * @example
      * ```ts
@@ -27,7 +30,9 @@ class Webhooks extends resource_1.APIResource {
         return this._client.post('/webhooks', { body, ...options });
     }
     /**
-     * Get a webhook subscription
+     * Returns a single webhook subscription by id, including its URL, subscribed event
+     * types, state, and system-observed delivery health. The signing secret is never
+     * included.
      *
      * @example
      * ```ts
@@ -40,7 +45,10 @@ class Webhooks extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/webhooks/${id}`, options);
     }
     /**
-     * Update a webhook subscription
+     * Updates a webhook subscription. Any combination of the subscribed event types,
+     * state (ACTIVE or DISABLED), and description may be changed, and at least one
+     * field must be supplied. Setting state to ACTIVE re-enables a subscription that
+     * was auto-blocked after sustained delivery failures.
      *
      * @example
      * ```ts
@@ -53,7 +61,10 @@ class Webhooks extends resource_1.APIResource {
         return this._client.patch((0, path_1.path) `/webhooks/${id}`, { body, ...options });
     }
     /**
-     * List your webhook subscriptions
+     * Returns a paginated list of your webhook subscriptions, optionally filtered by
+     * status (active, failing, blocked, or disabled) and/or by `search` (a
+     * case-insensitive substring match against the URL or description). The response
+     * also includes per-status counts across all of your subscriptions.
      *
      * @example
      * ```ts
@@ -64,7 +75,8 @@ class Webhooks extends resource_1.APIResource {
         return this._client.get('/webhooks', { query, ...options });
     }
     /**
-     * Delete a webhook subscription
+     * Deletes a webhook subscription so it stops receiving deliveries. Returns 204 No
+     * Content on success.
      *
      * @example
      * ```ts
@@ -80,7 +92,9 @@ class Webhooks extends resource_1.APIResource {
         });
     }
     /**
-     * List subscribable event types per source
+     * Returns the catalog of event types that webhook subscriptions can subscribe to,
+     * grouped by source. Use the returned type identifiers as the `eventTypes` values
+     * when creating or updating a webhook.
      *
      * @example
      * ```ts
@@ -91,7 +105,9 @@ class Webhooks extends resource_1.APIResource {
         return this._client.get('/event-types', options);
     }
     /**
-     * Rotate the signing secret (returned once)
+     * Generates a new signing secret for the webhook subscription and returns it once
+     * in the response. The previous secret is replaced immediately, so any signature
+     * verification on your endpoint must be updated to use the new value.
      *
      * @example
      * ```ts
@@ -104,7 +120,9 @@ class Webhooks extends resource_1.APIResource {
         return this._client.post((0, path_1.path) `/webhooks/${id}/rotate-secret`, options);
     }
     /**
-     * Send a one-shot test delivery
+     * Sends a single test payload to the webhook subscription URL to verify
+     * connectivity. The response reports whether the attempt succeeded along with the
+     * returned HTTP status code or error, if any.
      *
      * @example
      * ```ts

package/resources/webhooks/webhooks.js.map

@@ -1 +1 @@
-{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../src/resources/webhooks/webhooks.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,uEAA8C;AAC9C,gDAUsB;AAEtB,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuHpF,CAAC;IArHC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,OAAwB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AAxHD,4BAwHC;AAwQD,QAAQ,CAAC,UAAU,GAAG,uBAAU,CAAC"}
+{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../src/resources/webhooks/webhooks.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,uEAA8C;AAC9C,gDAUsB;AAEtB,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyIpF,CAAC;IAvIC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAwB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AA1ID,4BA0IC;AA4TD,QAAQ,CAAC,UAAU,GAAG,uBAAU,CAAC"}

package/resources/webhooks/webhooks.mjs

@@ -10,7 +10,10 @@ export class Webhooks extends APIResource {
         this.deliveries = new DeliveriesAPI.Deliveries(this._client);
     }
     /**
-     * Register a webhook subscription
+     * Creates a webhook subscription with a delivery URL and an optional list of event
+     * types to subscribe to (defaults to all when omitted). The response includes the
+     * generated signing secret, which is returned only once at creation time and
+     * cannot be retrieved later.
      *
      * @example
      * ```ts
@@ -23,7 +26,9 @@ export class Webhooks extends APIResource {
         return this._client.post('/webhooks', { body, ...options });
     }
     /**
-     * Get a webhook subscription
+     * Returns a single webhook subscription by id, including its URL, subscribed event
+     * types, state, and system-observed delivery health. The signing secret is never
+     * included.
      *
      * @example
      * ```ts
@@ -36,7 +41,10 @@ export class Webhooks extends APIResource {
         return this._client.get(path `/webhooks/${id}`, options);
     }
     /**
-     * Update a webhook subscription
+     * Updates a webhook subscription. Any combination of the subscribed event types,
+     * state (ACTIVE or DISABLED), and description may be changed, and at least one
+     * field must be supplied. Setting state to ACTIVE re-enables a subscription that
+     * was auto-blocked after sustained delivery failures.
      *
      * @example
      * ```ts
@@ -49,7 +57,10 @@ export class Webhooks extends APIResource {
         return this._client.patch(path `/webhooks/${id}`, { body, ...options });
     }
     /**
-     * List your webhook subscriptions
+     * Returns a paginated list of your webhook subscriptions, optionally filtered by
+     * status (active, failing, blocked, or disabled) and/or by `search` (a
+     * case-insensitive substring match against the URL or description). The response
+     * also includes per-status counts across all of your subscriptions.
      *
      * @example
      * ```ts
@@ -60,7 +71,8 @@ export class Webhooks extends APIResource {
         return this._client.get('/webhooks', { query, ...options });
     }
     /**
-     * Delete a webhook subscription
+     * Deletes a webhook subscription so it stops receiving deliveries. Returns 204 No
+     * Content on success.
      *
      * @example
      * ```ts
@@ -76,7 +88,9 @@ export class Webhooks extends APIResource {
         });
     }
     /**
-     * List subscribable event types per source
+     * Returns the catalog of event types that webhook subscriptions can subscribe to,
+     * grouped by source. Use the returned type identifiers as the `eventTypes` values
+     * when creating or updating a webhook.
      *
      * @example
      * ```ts
@@ -87,7 +101,9 @@ export class Webhooks extends APIResource {
         return this._client.get('/event-types', options);
     }
     /**
-     * Rotate the signing secret (returned once)
+     * Generates a new signing secret for the webhook subscription and returns it once
+     * in the response. The previous secret is replaced immediately, so any signature
+     * verification on your endpoint must be updated to use the new value.
      *
      * @example
      * ```ts
@@ -100,7 +116,9 @@ export class Webhooks extends APIResource {
         return this._client.post(path `/webhooks/${id}/rotate-secret`, options);
     }
     /**
-     * Send a one-shot test delivery
+     * Sends a single test payload to the webhook subscription URL to verify
+     * connectivity. The response reports whether the attempt succeeded along with the
+     * returned HTTP status code or error, if any.
      *
      * @example
      * ```ts

package/resources/webhooks/webhooks.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"webhooks.mjs","sourceRoot":"","sources":["../../src/resources/webhooks/webhooks.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EACL,UAAU,GASX,yBAAqB;AAEtB,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuHpF,CAAC;IArHC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,OAAwB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AAwQD,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC"}
+{"version":3,"file":"webhooks.mjs","sourceRoot":"","sources":["../../src/resources/webhooks/webhooks.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EACL,UAAU,GASX,yBAAqB;AAEtB,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyIpF,CAAC;IAvIC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAwB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AA4TD,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC"}