@pidgeon-ai/sdk 1.19.2 → 1.21.0

package/dist/index.d.cts

@@ -1985,6 +1985,12 @@ type IdentitiesCreateData = {
          */
         pod_id?: string | null;
     };
+    headers?: {
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
+    };
     path?: never;
     query?: never;
     url: '/identities';
@@ -2011,7 +2017,7 @@ type IdentitiesCreateErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -2828,6 +2834,12 @@ type PodsCreateData = {
          */
         client_id?: string | null;
     };
+    headers?: {
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
+    };
     path?: never;
     query?: never;
     url: '/pods';
@@ -2854,7 +2866,7 @@ type PodsCreateErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -3056,6 +3068,12 @@ type LabelsCreateData = {
         name: string;
         colour?: 'slate' | 'red' | 'amber' | 'green' | 'teal' | 'blue' | 'violet' | 'pink';
     };
+    headers?: {
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
+    };
     path?: never;
     query?: never;
     url: '/labels';
@@ -3078,7 +3096,7 @@ type LabelsCreateErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -3487,6 +3505,12 @@ type MessagesSendData = {
          */
         in_reply_to_message_id?: string | null;
     };
+    headers?: {
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
+    };
     path?: never;
     query?: never;
     url: '/messages';
@@ -3722,7 +3746,10 @@ type MessagesAwaitData = {
          * Also return a matching message filed as spam. Without it, one is counted in `held_back` instead, with its id.
          */
         include_spam?: 'true' | 'false';
-        after?: string;
+        /**
+         * Only messages that arrived after this: the `cursor` a previous call returned, or `now`. Without it, the wait first looks back 2 minutes and returns the newest matching message from then, so a code that beat you to the call is not missed.
+         */
+        after?: 'now' | string;
         timeout?: number;
     };
     url: '/messages/await';
@@ -3911,6 +3938,12 @@ type MessagesReplyData = {
          */
         attachment_ids?: Array<string>;
     };
+    headers?: {
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
+    };
     path: {
         id: string;
     };
@@ -3935,7 +3968,7 @@ type MessagesReplyErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -3988,6 +4021,12 @@ type MessagesReplyAllData = {
          */
         attachment_ids?: Array<string>;
     };
+    headers?: {
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
+    };
     path: {
         id: string;
     };
@@ -4012,7 +4051,7 @@ type MessagesReplyAllErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -4065,6 +4104,12 @@ type MessagesForwardData = {
          */
         attachment_ids?: Array<string>;
     };
+    headers?: {
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
+    };
     path: {
         id: string;
     };
@@ -4089,7 +4134,7 @@ type MessagesForwardErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -4461,6 +4506,12 @@ type DomainsCreateData = {
         domain: string;
         inbound_enabled?: boolean;
     };
+    headers?: {
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
+    };
     path?: never;
     query?: never;
     url: '/domains';
@@ -4487,7 +4538,7 @@ type DomainsCreateErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -4906,6 +4957,12 @@ type RoutingCreateData = {
         destination_identity_id?: string;
         destination_webhook_id?: string;
     };
+    headers?: {
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
+    };
     path?: never;
     query?: never;
     url: '/routing-rules';
@@ -4932,7 +4989,7 @@ type RoutingCreateErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -6220,7 +6277,13 @@ type WebhooksCreateData = {
          * The address this belongs to.
          */
         identity_id?: string | null;
-        event_types?: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.bounced' | 'message.rejected' | 'message.complained' | 'message.spam' | 'message.invitation' | 'message.archived' | 'message.deleted' | 'calendar.event.created' | 'calendar.event.updated' | 'calendar.event.deleted' | 'calendar.event.starting' | 'calendar.event.ending' | 'calendar.event.responded' | 'thread.created' | 'thread.updated' | 'thread.assigned' | 'thread.unassigned' | 'identity.created' | 'identity.updated' | 'identity.suspended' | 'identity.transferred' | 'domain.verified'>;
+        event_types?: Array<'message.received' | 'message.sent' | 'message.delivered' | 'message.bounced' | 'message.rejected' | 'message.complained' | 'message.read' | 'message.handed_off' | 'message.spam' | 'message.invitation' | 'message.archived' | 'message.deleted' | 'calendar.event.created' | 'calendar.event.updated' | 'calendar.event.deleted' | 'calendar.event.starting' | 'calendar.event.ending' | 'calendar.event.responded' | 'thread.created' | 'thread.updated' | 'thread.assigned' | 'thread.unassigned' | 'identity.created' | 'identity.updated' | 'identity.suspended' | 'identity.transferred' | 'domain.verified'>;
+    };
+    headers?: {
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
     };
     path?: never;
     query?: never;
@@ -6248,7 +6311,7 @@ type WebhooksCreateErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -6655,6 +6718,12 @@ type MessagesRespondToInvitationData = {
         status: 'accepted' | 'declined' | 'tentative';
         comment?: string;
     };
+    headers?: {
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
+    };
     path: {
         id: string;
     };
@@ -6679,7 +6748,7 @@ type MessagesRespondToInvitationErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -6916,6 +6985,12 @@ type CalendarCreateEventData = {
             rdates?: Array<string>;
         } | null;
     };
+    headers?: {
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
+    };
     path: {
         id: string;
     };
@@ -6940,7 +7015,7 @@ type CalendarCreateEventErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -6977,6 +7052,10 @@ type CalendarRespondToEventData = {
          * The `etag` you last read. A stale one is a `409` naming the current version — two agents on one mailbox is the case this product is for, and last-write-wins loses a meeting.
          */
         'If-Match'?: string;
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
     };
     path: {
         id: string;
@@ -7003,7 +7082,7 @@ type CalendarRespondToEventErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -7168,6 +7247,10 @@ type CalendarDeleteEventData = {
          * The `etag` you last read. A stale one is a `409` naming the current version — two agents on one mailbox is the case this product is for, and last-write-wins loses a meeting.
          */
         'If-Match'?: string;
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
     };
     path: {
         id: string;
@@ -7199,7 +7282,7 @@ type CalendarDeleteEventErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -7318,6 +7401,10 @@ type CalendarUpdateEventData = {
          * The `etag` you last read. A stale one is a `409` naming the current version — two agents on one mailbox is the case this product is for, and last-write-wins loses a meeting.
          */
         'If-Match'?: string;
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
     };
     path: {
         id: string;
@@ -7349,7 +7436,7 @@ type CalendarUpdateEventErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -7480,6 +7567,12 @@ type DraftsCreateData = {
          */
         attachment_ids?: Array<string>;
     };
+    headers?: {
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
+    };
     path?: never;
     query?: never;
     url: '/drafts';
@@ -7502,7 +7595,7 @@ type DraftsCreateErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -7715,6 +7808,12 @@ type DraftsUpdateResponses = {
 type DraftsUpdateResponse = DraftsUpdateResponses[keyof DraftsUpdateResponses];
 type DraftsSendData = {
     body?: never;
+    headers?: {
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
+    };
     path: {
         id: string;
     };
@@ -7739,7 +7838,7 @@ type DraftsSendErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -7821,6 +7920,12 @@ type DraftsScheduleData = {
     body: {
         send_at: string;
     };
+    headers?: {
+        /**
+         * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
+         */
+        'Idempotency-Key'?: string;
+    };
     path: {
         id: string;
     };
@@ -7845,7 +7950,7 @@ type DraftsScheduleErrors = {
      */
     404: Error;
     /**
-     * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
+     * This `Idempotency-Key` was used with a different request, or that request is still running. Nothing was sent by this call.
      */
     409: Error;
     /**
@@ -8354,7 +8459,7 @@ declare const messagesUndo: <ThrowOnError extends boolean = false>(options: Opti
 /**
  * Wait for the next message
  *
- * Holds the request open until a message matching the filters arrives at the address, or `timeout` seconds pass — one call where you would otherwise poll. The message carries `extracted`: verification codes and links, most likely first. Pass the returned `cursor` as `after` on the next call so nothing arriving between calls is missed. Answers 200 with `message: null` and `timed_out: true` when nothing came. A matching message filed as spam is not returned unless you pass `include_spam=true`; it is counted in `held_back`, with its id, so a timeout never hides mail that arrived.
+ * Holds the request open until a message matching the filters arrives at the address, or `timeout` seconds pass — one call where you would otherwise poll. The message carries `extracted`: verification codes and links, most likely first. Without `after`, it first looks back 2 minutes and returns the newest matching message from then, because a code often lands before the call is made; narrow it with `from`, `subject_contains` or `has_code` so an earlier email is not taken for the one you want, or pass `after=now` to wait only for new mail. Pass the returned `cursor` as `after` on the next call so nothing arriving between calls is missed. Answers 200 with `message: null` and `timed_out: true` when nothing came. A matching message filed as spam is not returned unless you pass `include_spam=true`; it is counted in `held_back`, with its id, so a timeout never hides mail that arrived.
  */
 declare const messagesAwait: <ThrowOnError extends boolean = false>(options: Options<MessagesAwaitData, ThrowOnError>) => RequestResult<MessagesAwaitResponses, MessagesAwaitErrors, ThrowOnError>;
 /**