@productcraft/waitlist 0.2.2 → 0.2.4

package/dist/index.d.ts

@@ -850,7 +850,10 @@ interface components {
             url: string;
         };
         CreateWebhookEndpointDto: {
-            /** @example Production receiver */
+            /**
+             * @description A label for people.
+             * @example Production receiver
+             */
             description?: string | null;
             /**
              * @description Create it switched off.
@@ -922,10 +925,136 @@ interface components {
              */
             state: "ready" | "incomplete" | "off";
         };
+        /**
+         * EntryApprovedEvent
+         * @description An entry was approved: by you, or automatically when the waitlist does not need approval. Every real delivery also carries the keys of the previous webhook body (`event`, `occurred_at`, `entry`) until its sunset; read `type`, `created_at` and `data` instead.
+         * @example {
+         *       "created_at": "2026-11-05T09:00:00.000Z",
+         *       "data": {
+         *         "entry": {
+         *           "created_at": "2026-10-17T10:00:00.000Z",
+         *           "email": "ada@example.com",
+         *           "id": "1d0b7828-0e1a-407b-8706-aeb7ff619088",
+         *           "is_test": false,
+         *           "name": "Ada Lovelace",
+         *           "position": 4,
+         *           "referral_code": "464QTHE0",
+         *           "referral_count": 0,
+         *           "referred_by_entry_id": null,
+         *           "status": "approved",
+         *           "updated_at": "2026-10-17T10:00:00.000Z"
+         *         },
+         *         "waitlist_id": "33a8b309-8753-4f08-90d7-9dc484eff392"
+         *       },
+         *       "id": "evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f",
+         *       "type": "entry.approved",
+         *       "waitlist_id": "33a8b309-8753-4f08-90d7-9dc484eff392",
+         *       "workspace_id": "9b2f6c1e-0d6a-4a63-9a43-2f1c3e4d5a6b"
+         *     }
+         */
+        EntryApprovedEvent: {
+            /**
+             * Format: date-time
+             * @description When the event happened (the same on every retry).
+             * @example 2026-11-05T09:00:00.000Z
+             */
+            created_at: string;
+            data: components["schemas"]["EntryEventDataDto"];
+            /**
+             * @description The event id, also sent as `webhook-id`; the same on every retry and replay.
+             * @example evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f
+             */
+            id: string;
+            /** @description Present and true only on a delivery made by "Send test"; its `data` is the catalogue example. */
+            test?: boolean;
+            /**
+             * @description The event type. Switch on it to narrow the event.
+             * @enum {string}
+             */
+            type: "entry.approved";
+            /**
+             * Format: uuid
+             * @description The waitlist, so you can route without opening `data` (also in `data.waitlist_id`). Absent on "Send test" deliveries.
+             */
+            waitlist_id?: string;
+            /**
+             * Format: uuid
+             * @description The workspace the waitlist belongs to. Absent on "Send test" deliveries.
+             */
+            workspace_id?: string;
+        };
         EntryCountResponseDto: {
             /** @description Number of entries on the waitlist. Test entries are left out unless `include_test=true`. */
             count: number;
         };
+        /**
+         * EntryCreatedEvent
+         * @description Someone joined a waitlist. On a waitlist that does not need approval, entry.approved follows straight away. Every real delivery also carries the keys of the previous webhook body (`event`, `occurred_at`, `entry`) until its sunset; read `type`, `created_at` and `data` instead.
+         * @example {
+         *       "created_at": "2026-11-05T09:00:00.000Z",
+         *       "data": {
+         *         "entry": {
+         *           "created_at": "2026-10-17T10:00:00.000Z",
+         *           "email": "ada@example.com",
+         *           "id": "1d0b7828-0e1a-407b-8706-aeb7ff619088",
+         *           "is_test": false,
+         *           "name": "Ada Lovelace",
+         *           "position": 4,
+         *           "referral_code": "464QTHE0",
+         *           "referral_count": 0,
+         *           "referred_by_entry_id": null,
+         *           "status": "pending",
+         *           "updated_at": "2026-10-17T10:00:00.000Z"
+         *         },
+         *         "waitlist_id": "33a8b309-8753-4f08-90d7-9dc484eff392"
+         *       },
+         *       "id": "evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f",
+         *       "type": "entry.created",
+         *       "waitlist_id": "33a8b309-8753-4f08-90d7-9dc484eff392",
+         *       "workspace_id": "9b2f6c1e-0d6a-4a63-9a43-2f1c3e4d5a6b"
+         *     }
+         */
+        EntryCreatedEvent: {
+            /**
+             * Format: date-time
+             * @description When the event happened (the same on every retry).
+             * @example 2026-11-05T09:00:00.000Z
+             */
+            created_at: string;
+            data: components["schemas"]["EntryEventDataDto"];
+            /**
+             * @description The event id, also sent as `webhook-id`; the same on every retry and replay.
+             * @example evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f
+             */
+            id: string;
+            /** @description Present and true only on a delivery made by "Send test"; its `data` is the catalogue example. */
+            test?: boolean;
+            /**
+             * @description The event type. Switch on it to narrow the event.
+             * @enum {string}
+             */
+            type: "entry.created";
+            /**
+             * Format: uuid
+             * @description The waitlist, so you can route without opening `data` (also in `data.waitlist_id`). Absent on "Send test" deliveries.
+             */
+            waitlist_id?: string;
+            /**
+             * Format: uuid
+             * @description The workspace the waitlist belongs to. Absent on "Send test" deliveries.
+             */
+            workspace_id?: string;
+        };
+        EntryEventDataDto: {
+            /** @description The entry, as it is after the event. */
+            entry: components["schemas"]["WebhookEntryDto"];
+            /**
+             * Format: uuid
+             * @description The waitlist the entry belongs to.
+             * @example 33a8b309-8753-4f08-90d7-9dc484eff392
+             */
+            waitlist_id: string;
+        };
         EntryListPaginationDto: {
             has_more: boolean;
             next_cursor: string | null;
@@ -934,6 +1063,64 @@ interface components {
             data: components["schemas"]["EntryResponseDto"][];
             pagination: components["schemas"]["EntryListPaginationDto"];
         };
+        /**
+         * EntryRejectedEvent
+         * @description An entry was rejected. Every real delivery also carries the keys of the previous webhook body (`event`, `occurred_at`, `entry`) until its sunset; read `type`, `created_at` and `data` instead.
+         * @example {
+         *       "created_at": "2026-11-05T09:00:00.000Z",
+         *       "data": {
+         *         "entry": {
+         *           "created_at": "2026-10-17T10:00:00.000Z",
+         *           "email": "ada@example.com",
+         *           "id": "1d0b7828-0e1a-407b-8706-aeb7ff619088",
+         *           "is_test": false,
+         *           "name": "Ada Lovelace",
+         *           "position": 4,
+         *           "referral_code": "464QTHE0",
+         *           "referral_count": 0,
+         *           "referred_by_entry_id": null,
+         *           "status": "rejected",
+         *           "updated_at": "2026-10-17T10:00:00.000Z"
+         *         },
+         *         "waitlist_id": "33a8b309-8753-4f08-90d7-9dc484eff392"
+         *       },
+         *       "id": "evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f",
+         *       "type": "entry.rejected",
+         *       "waitlist_id": "33a8b309-8753-4f08-90d7-9dc484eff392",
+         *       "workspace_id": "9b2f6c1e-0d6a-4a63-9a43-2f1c3e4d5a6b"
+         *     }
+         */
+        EntryRejectedEvent: {
+            /**
+             * Format: date-time
+             * @description When the event happened (the same on every retry).
+             * @example 2026-11-05T09:00:00.000Z
+             */
+            created_at: string;
+            data: components["schemas"]["EntryEventDataDto"];
+            /**
+             * @description The event id, also sent as `webhook-id`; the same on every retry and replay.
+             * @example evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f
+             */
+            id: string;
+            /** @description Present and true only on a delivery made by "Send test"; its `data` is the catalogue example. */
+            test?: boolean;
+            /**
+             * @description The event type. Switch on it to narrow the event.
+             * @enum {string}
+             */
+            type: "entry.rejected";
+            /**
+             * Format: uuid
+             * @description The waitlist, so you can route without opening `data` (also in `data.waitlist_id`). Absent on "Send test" deliveries.
+             */
+            waitlist_id?: string;
+            /**
+             * Format: uuid
+             * @description The workspace the waitlist belongs to. Absent on "Send test" deliveries.
+             */
+            workspace_id?: string;
+        };
         EntryResponseDto: {
             created_at: string;
             email: string;
@@ -960,6 +1147,8 @@ interface components {
             waitlist_id: string;
             workspace_id: string;
         };
+        /** @enum {string} */
+        EntryStatus: "pending" | "approved" | "rejected";
         ErrorParamDto: {
             /**
              * @description The failed rule (class-validator constraint name, e.g. `isEmail`, `isUuid`, `whitelistValidation` for a field the operation does not declare), or `invalid`.
@@ -1054,15 +1243,19 @@ interface components {
             webhook_id: string;
         };
         ListWebhookEndpointsResponseDto: {
+            /** @description The endpoints, newest first. */
             data: components["schemas"]["WebhookEndpointDto"][];
             /** @description Always one page (an endpoint limit applies). */
             pagination: components["schemas"]["WebhookPaginationDto"];
         };
         ListWebhookEventTypesResponseDto: {
+            /** @description Every event type this product sends. */
             data: components["schemas"]["WebhookEventTypeDto"][];
         };
         ListWebhookEventsResponseDto: {
+            /** @description The events, newest first. */
             data: components["schemas"]["WebhookEventDto"][];
+            /** @description The cursor for the next page. */
             pagination: components["schemas"]["WebhookPaginationDto"];
         };
         NotificationTestResponseDto: {
@@ -1222,6 +1415,7 @@ interface components {
         ReplayWebhookEventResponseDto: {
             /** @description One attempt per endpoint it was sent to. */
             attempts: components["schemas"]["WebhookDeliveryAttemptDto"][];
+            /** @description The replayed event (the same id as the original). */
             event_id: string;
         };
         RotateWebhookSecretDto: {
@@ -1338,6 +1532,7 @@ interface components {
             url?: string;
         };
         UpdateWebhookEndpointDto: {
+            /** @description A new label; null clears it. */
             description?: string | null;
             /** @description Switch it on or off. Switching on also clears an automatic disable. */
             enabled?: boolean;
@@ -1345,6 +1540,7 @@ interface components {
             event_types?: ("entry.created" | "entry.approved" | "entry.rejected")[];
             /**
              * Format: uri
+             * @description A new absolute https:// URL on a public host.
              * @example https://api.acme.com/webhooks
              */
             url?: string;
@@ -1394,7 +1590,7 @@ interface components {
             waitlist_id: string;
         };
         /** @description Error codes this API returns (open set: a client must accept codes it does not know; new codes are not a breaking change). Each is documented at https://productcraft.co/docs/errors#<code>. */
-        WaitlistErrorCode: ("BAD_REQUEST" | "VALIDATION_ERROR" | "UNAUTHORIZED" | "PAYMENT_REQUIRED" | "FORBIDDEN" | "NOT_FOUND" | "METHOD_NOT_ALLOWED" | "NOT_ACCEPTABLE" | "REQUEST_TIMEOUT" | "CONFLICT" | "GONE" | "PRECONDITION_FAILED" | "PAYLOAD_TOO_LARGE" | "UNSUPPORTED_MEDIA_TYPE" | "UNPROCESSABLE_ENTITY" | "PRECONDITION_REQUIRED" | "RATE_LIMITED" | "INTERNAL_SERVER_ERROR" | "NOT_IMPLEMENTED" | "BAD_GATEWAY" | "SERVICE_UNAVAILABLE" | "GATEWAY_TIMEOUT" | "SERVICE_NOT_ENABLED" | "INVALID_CREDENTIALS" | "SESSION_REVOKED" | "MCP_NOT_PERMITTED" | "MCP_WORKSPACE_MISMATCH" | "PAK_NOT_PERMITTED" | "ACTIONS_NOT_GRANTABLE" | "IDEMPOTENCY_KEY_REUSE" | "IDEMPOTENCY_KEY_REQUIRED" | "WEBHOOK_ENDPOINT_LIMIT" | "WEBHOOK_ENDPOINT_NOT_FOUND" | "WEBHOOK_ENDPOINT_NOT_SUBSCRIBED" | "WEBHOOK_EVENT_NOT_FOUND" | "WEBHOOK_EVENT_TYPE_UNKNOWN" | "MAIL_UNREACHABLE" | "ORIGIN_NOT_ALLOWED" | "WAITLIST_NOT_FOUND" | "domain_not_verified_by_provider" | "from_domain_not_verified" | "no_default_sender") | string;
+        WaitlistErrorCode: ("BAD_REQUEST" | "VALIDATION_ERROR" | "UNAUTHORIZED" | "PAYMENT_REQUIRED" | "FORBIDDEN" | "NOT_FOUND" | "METHOD_NOT_ALLOWED" | "NOT_ACCEPTABLE" | "REQUEST_TIMEOUT" | "CONFLICT" | "GONE" | "PRECONDITION_FAILED" | "PAYLOAD_TOO_LARGE" | "UNSUPPORTED_MEDIA_TYPE" | "UNPROCESSABLE_ENTITY" | "PRECONDITION_REQUIRED" | "RATE_LIMITED" | "INTERNAL_SERVER_ERROR" | "NOT_IMPLEMENTED" | "BAD_GATEWAY" | "SERVICE_UNAVAILABLE" | "GATEWAY_TIMEOUT" | "SERVICE_NOT_ENABLED" | "INVALID_CREDENTIALS" | "SESSION_REVOKED" | "MCP_NOT_PERMITTED" | "MCP_WORKSPACE_MISMATCH" | "PAK_NOT_PERMITTED" | "ACTIONS_NOT_GRANTABLE" | "IDEMPOTENCY_KEY_REUSE" | "IDEMPOTENCY_KEY_REQUIRED" | "IDEMPOTENCY_IN_PROGRESS" | "WEBHOOK_ENDPOINT_LIMIT" | "WEBHOOK_ENDPOINT_NOT_FOUND" | "WEBHOOK_ENDPOINT_NOT_SUBSCRIBED" | "WEBHOOK_EVENT_NOT_FOUND" | "WEBHOOK_EVENT_TYPE_UNKNOWN" | "MAIL_UNREACHABLE" | "ORIGIN_NOT_ALLOWED" | "WAITLIST_NOT_FOUND" | "domain_not_verified_by_provider" | "from_domain_not_verified" | "no_default_sender") | string;
         WaitlistListPaginationDto: {
             has_more: boolean;
             next_cursor: string | null;
@@ -1557,6 +1753,8 @@ interface components {
              */
             window: "1d" | "7d" | "30d";
         };
+        /** @enum {string} */
+        WebhookAttemptTrigger: "automatic" | "replay" | "test";
         WebhookCreateResponseDto: {
             /** @description Whether it receives events (`enabled` on the new routes). */
             active: boolean;
@@ -1585,18 +1783,37 @@ interface components {
         WebhookDeliveryAttemptDto: {
             /** @description 1 for the first delivery; retries and replays count up. */
             attempt_number: number;
-            /** Format: date-time */
+            /**
+             * Format: date-time
+             * @description When the attempt was made.
+             */
             attempted_at: string;
-            /** Format: uuid */
+            /**
+             * Format: uuid
+             * @description The endpoint it was delivered to.
+             */
             endpoint_id: string;
-            /** @example request timed out */
+            /**
+             * @description Why the attempt failed when no 2xx came back; null on success.
+             * @example request timed out
+             */
             error_message: string | null;
-            /** @example evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f */
+            /**
+             * @description The event that was delivered.
+             * @example evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f
+             */
             event_id: string;
-            /** @example user.created */
+            /**
+             * @description The event's type.
+             * @example user.created
+             */
             event_type: string;
-            /** Format: uuid */
+            /**
+             * Format: uuid
+             * @description The attempt's id.
+             */
             id: string;
+            /** @description Milliseconds until the response; null when none came back. */
             latency_ms: number | null;
             /** @description The first 1 KiB of the response body. */
             response_body: string | null;
@@ -1604,11 +1821,8 @@ interface components {
             status_code: number | null;
             /** @description True for a 2xx response. */
             succeeded: boolean;
-            /**
-             * @description `automatic` (first delivery or a retry), `replay` or `test`.
-             * @enum {string}
-             */
-            trigger: "automatic" | "replay" | "test";
+            /** @description `automatic` (first delivery or a retry), `replay` or `test`. */
+            trigger: components["schemas"]["WebhookAttemptTrigger"];
             /**
              * Format: uri
              * @description Where it was sent.
@@ -1619,17 +1833,28 @@ interface components {
             data: components["schemas"]["LegacyWebhookDeliveryAttemptDto"][];
             pagination: components["schemas"]["PaginationDto"];
         };
+        /** @enum {string} */
+        WebhookEndpointDisabledReason: "manual" | "failing";
         WebhookEndpointDto: {
             /** @description Failed automatic deliveries in a row; a success resets it. */
             consecutive_failures: number;
-            /** Format: date-time */
+            /**
+             * Format: date-time
+             * @description When the endpoint was created.
+             */
             created_at: string;
-            /** @example Production receiver */
+            /**
+             * @description A label for people; null when unset.
+             * @example Production receiver
+             */
             description: string | null;
-            /** Format: date-time */
+            /**
+             * Format: date-time
+             * @description When it was switched off; null while enabled.
+             */
             disabled_at: string | null;
-            /** @enum {string|null} */
-            disabled_reason: "manual" | "failing" | null;
+            /** @description `manual`: switched off by a caller. `failing`: switched off automatically after failed deliveries. Null while enabled. */
+            disabled_reason: components["schemas"]["WebhookEndpointDisabledReason"] | null;
             /** @description The on/off switch (`PATCH … { enabled }`). */
             enabled: boolean;
             /**
@@ -1642,7 +1867,10 @@ interface components {
              * @description Start of the current failure streak.
              */
             first_failure_at: string | null;
-            /** Format: uuid */
+            /**
+             * Format: uuid
+             * @description The endpoint's id.
+             */
             id: string;
             /** @description True for endpoints carried over from the product's previous webhook system: they also receive the old signature header until its sunset date. */
             legacy_signature: boolean;
@@ -1665,30 +1893,42 @@ interface components {
              * @example x9Q=
              */
             signing_secret_hint: string;
+            /** @description `enabled` receives events. `disabled` was switched off. `auto_disabled` was switched off after 20 failed deliveries in a row or 24 hours of failures; `PATCH { enabled: true }` turns it back on. */
+            status: components["schemas"]["WebhookEndpointStatus"];
             /**
-             * @description `enabled` receives events. `disabled` was switched off. `auto_disabled` was switched off after 20 failed deliveries in a row or 24 hours of failures; `PATCH { enabled: true }` turns it back on.
-             * @enum {string}
+             * Format: date-time
+             * @description When the endpoint last changed.
              */
-            status: "enabled" | "disabled" | "auto_disabled";
-            /** Format: date-time */
             updated_at: string;
             /**
              * Format: uri
+             * @description Where events are sent.
              * @example https://api.acme.com/webhooks
              */
             url: string;
         };
+        /** @enum {string} */
+        WebhookEndpointStatus: "enabled" | "disabled" | "auto_disabled";
         WebhookEndpointWithSecretDto: {
             /** @description Failed automatic deliveries in a row; a success resets it. */
             consecutive_failures: number;
-            /** Format: date-time */
+            /**
+             * Format: date-time
+             * @description When the endpoint was created.
+             */
             created_at: string;
-            /** @example Production receiver */
+            /**
+             * @description A label for people; null when unset.
+             * @example Production receiver
+             */
             description: string | null;
-            /** Format: date-time */
+            /**
+             * Format: date-time
+             * @description When it was switched off; null while enabled.
+             */
             disabled_at: string | null;
-            /** @enum {string|null} */
-            disabled_reason: "manual" | "failing" | null;
+            /** @description `manual`: switched off by a caller. `failing`: switched off automatically after failed deliveries. Null while enabled. */
+            disabled_reason: components["schemas"]["WebhookEndpointDisabledReason"] | null;
             /** @description The on/off switch (`PATCH … { enabled }`). */
             enabled: boolean;
             /**
@@ -1701,7 +1941,10 @@ interface components {
              * @description Start of the current failure streak.
              */
             first_failure_at: string | null;
-            /** Format: uuid */
+            /**
+             * Format: uuid
+             * @description The endpoint's id.
+             */
             id: string;
             /** @description True for endpoints carried over from the product's previous webhook system: they also receive the old signature header until its sunset date. */
             legacy_signature: boolean;
@@ -1729,31 +1972,101 @@ interface components {
              * @example x9Q=
              */
             signing_secret_hint: string;
+            /** @description `enabled` receives events. `disabled` was switched off. `auto_disabled` was switched off after 20 failed deliveries in a row or 24 hours of failures; `PATCH { enabled: true }` turns it back on. */
+            status: components["schemas"]["WebhookEndpointStatus"];
             /**
-             * @description `enabled` receives events. `disabled` was switched off. `auto_disabled` was switched off after 20 failed deliveries in a row or 24 hours of failures; `PATCH { enabled: true }` turns it back on.
-             * @enum {string}
+             * Format: date-time
+             * @description When the endpoint last changed.
              */
-            status: "enabled" | "disabled" | "auto_disabled";
-            /** Format: date-time */
             updated_at: string;
             /**
              * Format: uri
+             * @description Where events are sent.
              * @example https://api.acme.com/webhooks
              */
             url: string;
         };
+        WebhookEntryDto: {
+            /**
+             * Format: date-time
+             * @description When the entry was created.
+             * @example 2026-10-17T10:00:00.000Z
+             */
+            created_at: string;
+            /**
+             * Format: email
+             * @description The email address that signed up.
+             * @example ada@example.com
+             */
+            email: string;
+            /**
+             * Format: uuid
+             * @description The entry id.
+             * @example 1d0b7828-0e1a-407b-8706-aeb7ff619088
+             */
+            id: string;
+            /**
+             * @description True for an entry made with "Add test signup" (those send no webhooks unless asked).
+             * @example false
+             */
+            is_test: boolean;
+            /**
+             * @description The name given at signup.
+             * @example Ada Lovelace
+             */
+            name: string;
+            /**
+             * @description Place in the queue, 1 first.
+             * @example 4
+             */
+            position: number;
+            /**
+             * @description The code this entry shares to refer others.
+             * @example 464QTHE0
+             */
+            referral_code: string;
+            /**
+             * @description How many signups used this entry's referral code.
+             * @example 0
+             */
+            referral_count: number;
+            /**
+             * Format: uuid
+             * @description The entry whose referral code this one signed up with; null when none.
+             * @example null
+             */
+            referred_by_entry_id: string | null;
+            /**
+             * @description Review status after this event: `pending`, `approved` or `rejected`.
+             * @example pending
+             */
+            status: components["schemas"]["EntryStatus"];
+            /**
+             * Format: date-time
+             * @description When the entry last changed.
+             * @example 2026-10-17T10:00:00.000Z
+             */
+            updated_at: string;
+        };
         WebhookEventDeliveryDto: {
             /** @description Number of the latest attempt; retries and replays count up. */
             attempt_number: number;
-            /** Format: date-time */
+            /**
+             * Format: date-time
+             * @description When the latest attempt was made.
+             */
             attempted_at: string;
-            /** Format: uuid */
+            /**
+             * Format: uuid
+             * @description The endpoint.
+             */
             endpoint_id: string;
             /**
              * Format: date-time
              * @description When the next automatic attempt is due; null when none is queued.
              */
             next_attempt_at: string | null;
+            /** @description HTTP status of the latest attempt; null when no response came back. */
             status_code: number | null;
             /** @description True when the latest attempt got a 2xx. */
             succeeded: boolean;
@@ -1761,7 +2074,10 @@ interface components {
         WebhookEventDetailDto: {
             /** @description Every attempt, newest first. */
             attempts: components["schemas"]["WebhookDeliveryAttemptDto"][];
-            /** Format: date-time */
+            /**
+             * Format: date-time
+             * @description When the event happened.
+             */
             created_at: string;
             /** @description Latest attempt per endpoint (an endpoint whose first attempt is still queued is not listed yet). */
             deliveries: components["schemas"]["WebhookEventDeliveryDto"][];
@@ -1774,21 +2090,21 @@ interface components {
             payload: {
                 [key: string]: unknown;
             };
-            /**
-             * @description `pending`: a delivery is queued. `failed`: the latest attempt to some endpoint failed and none is queued. `delivered`: every endpoint answered 2xx. `not_sent`: no endpoint subscribed.
-             * @enum {string}
-             */
-            status: "pending" | "delivered" | "failed" | "not_sent";
+            /** @description `pending`: a delivery is queued. `failed`: the latest attempt to some endpoint failed and none is queued. `delivered`: every endpoint answered 2xx. `not_sent`: no endpoint subscribed. */
+            status: components["schemas"]["WebhookEventStatus"];
             /** @description Made by "Send test". */
             test: boolean;
             /**
+             * @description The event type (one of this product's catalogue).
              * @example entry.created
-             * @enum {string}
              */
-            type: "entry.created" | "entry.approved" | "entry.rejected";
+            type: components["schemas"]["WebhookEventType"];
         };
         WebhookEventDto: {
-            /** Format: date-time */
+            /**
+             * Format: date-time
+             * @description When the event happened.
+             */
             created_at: string;
             /** @description Latest attempt per endpoint (an endpoint whose first attempt is still queued is not listed yet). */
             deliveries: components["schemas"]["WebhookEventDeliveryDto"][];
@@ -1801,36 +2117,43 @@ interface components {
             payload: {
                 [key: string]: unknown;
             };
-            /**
-             * @description `pending`: a delivery is queued. `failed`: the latest attempt to some endpoint failed and none is queued. `delivered`: every endpoint answered 2xx. `not_sent`: no endpoint subscribed.
-             * @enum {string}
-             */
-            status: "pending" | "delivered" | "failed" | "not_sent";
+            /** @description `pending`: a delivery is queued. `failed`: the latest attempt to some endpoint failed and none is queued. `delivered`: every endpoint answered 2xx. `not_sent`: no endpoint subscribed. */
+            status: components["schemas"]["WebhookEventStatus"];
             /** @description Made by "Send test". */
             test: boolean;
             /**
+             * @description The event type (one of this product's catalogue).
              * @example entry.created
-             * @enum {string}
              */
-            type: "entry.created" | "entry.approved" | "entry.rejected";
+            type: components["schemas"]["WebhookEventType"];
         };
+        /** @enum {string} */
+        WebhookEventStatus: "pending" | "delivered" | "failed" | "not_sent";
+        /**
+         * @description Every event type this product sends; `x-webhooks` maps each to its payload schema. New types can be added, so treat it as open.
+         * @enum {string}
+         */
+        WebhookEventType: "entry.created" | "entry.approved" | "entry.rejected";
         WebhookEventTypeDto: {
             /**
              * @description Group shown in the event picker.
              * @example Users
              */
             category: string;
-            /** @example A user signed up or was created by an admin. */
+            /**
+             * @description When this event is sent.
+             * @example A user signed up or was created by an admin.
+             */
             description: string;
             /** @description An example `data` object; "Send test" delivers exactly this. */
             example: {
                 [key: string]: unknown;
             };
             /**
+             * @description The event type (one of this product's catalogue).
              * @example entry.created
-             * @enum {string}
              */
-            type: "entry.created" | "entry.approved" | "entry.rejected";
+            type: components["schemas"]["WebhookEventType"];
         };
         WebhookListResponseDto: {
             data: components["schemas"]["WebhookResponseDto"][];
@@ -2238,6 +2561,8 @@ interface operations {
             /** @description Accepted by Mail and queued for delivery. */
             202: {
                 headers: {
+                    /** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
+                    "Idempotent-Replay"?: "true";
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -2285,9 +2610,11 @@ interface operations {
                     "application/json": components["schemas"]["ErrorResponseDto"];
                 };
             };
-            /** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
+            /** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
             409: {
                 headers: {
+                    /** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
+                    "Retry-After"?: number;
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -2387,6 +2714,8 @@ interface operations {
             /** @description Waitlist created. */
             201: {
                 headers: {
+                    /** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
+                    "Idempotent-Replay"?: "true";
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -2414,9 +2743,11 @@ interface operations {
                     "application/json": components["schemas"]["ErrorResponseDto"];
                 };
             };
-            /** @description Slug already taken in this workspace. */
+            /** @description Slug already taken in this workspace. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
             409: {
                 headers: {
+                    /** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
+                    "Retry-After"?: number;
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -3114,6 +3445,8 @@ interface operations {
             /** @description Test entry created. */
             201: {
                 headers: {
+                    /** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
+                    "Idempotent-Replay"?: "true";
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -3151,9 +3484,11 @@ interface operations {
                     "application/json": components["schemas"]["ErrorResponseDto"];
                 };
             };
-            /** @description Idempotency-Key reused with a different body. */
+            /** @description Idempotency-Key reused with a different body. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
             409: {
                 headers: {
+                    /** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
+                    "Retry-After"?: number;
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -3401,6 +3736,8 @@ interface operations {
             /** @description Webhook created. Includes plaintext `signing_secret` exactly once. */
             201: {
                 headers: {
+                    /** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
+                    "Idempotent-Replay"?: "true";
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -3408,9 +3745,11 @@ interface operations {
                     "application/json": components["schemas"]["WebhookCreateResponseDto"];
                 };
             };
-            /** @description The workspace already has 10 webhooks. */
+            /** @description The workspace already has 10 webhooks. Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
             409: {
                 headers: {
+                    /** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
+                    "Retry-After"?: number;
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -3492,6 +3831,8 @@ interface operations {
         responses: {
             201: {
                 headers: {
+                    /** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
+                    "Idempotent-Replay"?: "true";
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -3529,9 +3870,11 @@ interface operations {
                     "application/json": components["schemas"]["ErrorResponseDto"];
                 };
             };
-            /** @description Already 10 endpoints (`WEBHOOK_ENDPOINT_LIMIT`), or Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
+            /** @description Already 10 endpoints (`WEBHOOK_ENDPOINT_LIMIT`), or Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
             409: {
                 headers: {
+                    /** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
+                    "Retry-After"?: number;
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -3697,6 +4040,8 @@ interface operations {
         responses: {
             200: {
                 headers: {
+                    /** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
+                    "Idempotent-Replay"?: "true";
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -3744,9 +4089,11 @@ interface operations {
                     "application/json": components["schemas"]["ErrorResponseDto"];
                 };
             };
-            /** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
+            /** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
             409: {
                 headers: {
+                    /** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
+                    "Retry-After"?: number;
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -3787,6 +4134,8 @@ interface operations {
         responses: {
             200: {
                 headers: {
+                    /** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
+                    "Idempotent-Replay"?: "true";
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -3834,9 +4183,11 @@ interface operations {
                     "application/json": components["schemas"]["ErrorResponseDto"];
                 };
             };
-            /** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
+            /** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
             409: {
                 headers: {
+                    /** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
+                    "Retry-After"?: number;
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -3868,6 +4219,8 @@ interface operations {
             /** @description The attempt, successful or not. */
             200: {
                 headers: {
+                    /** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
+                    "Idempotent-Replay"?: "true";
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -3915,9 +4268,11 @@ interface operations {
                     "application/json": components["schemas"]["ErrorResponseDto"];
                 };
             };
-            /** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
+            /** @description Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
             409: {
                 headers: {
+                    /** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
+                    "Retry-After"?: number;
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -3976,11 +4331,13 @@ interface operations {
                 type?: ("entry.created" | "entry.approved" | "entry.rejected")[];
                 /** @description Only events sent (or queued) to this endpoint. */
                 endpoint_id?: string;
-                status?: "pending" | "delivered" | "failed" | "not_sent";
+                /** @description Only events in this delivery status. */
+                status?: components["schemas"]["WebhookEventStatus"];
                 /** @description Only events created at or after this instant. */
                 created_after?: string;
                 /** @description Only events created before this instant. */
                 created_before?: string;
+                /** @description Page size. */
                 limit?: number;
                 /** @description The previous page's `pagination.next_cursor`. */
                 cursor?: string;
@@ -4119,6 +4476,8 @@ interface operations {
         responses: {
             200: {
                 headers: {
+                    /** @description `true` when this response is a replay of an earlier request with the same `Idempotency-Key`. */
+                    "Idempotent-Replay"?: "true";
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };
@@ -4166,9 +4525,11 @@ interface operations {
                     "application/json": components["schemas"]["ErrorResponseDto"];
                 };
             };
-            /** @description `endpoint_id` is switched off or does not receive this event type (`WEBHOOK_ENDPOINT_NOT_SUBSCRIBED`), or Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). */
+            /** @description `endpoint_id` is switched off or does not receive this event type (`WEBHOOK_ENDPOINT_NOT_SUBSCRIBED`), or Idempotency-Key reused with a different body (`IDEMPOTENCY_KEY_REUSE`). Idempotency: `IDEMPOTENCY_KEY_REUSE` when this `Idempotency-Key` was already used with a different body or route; `IDEMPOTENCY_IN_PROGRESS` while another request with the same key is still running (retry after `Retry-After` seconds, with the same key). */
             409: {
                 headers: {
+                    /** @description Seconds to wait before retrying with the same key (sent with `IDEMPOTENCY_IN_PROGRESS`). */
+                    "Retry-After"?: number;
                     "X-Request-Id": components["headers"]["RequestId"];
                     [name: string]: unknown;
                 };