@pidgeon-ai/sdk 1.32.0 → 1.33.0

package/dist/index.d.cts

@@ -2387,6 +2387,10 @@ type IdentitiesCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type IdentitiesCreateError = IdentitiesCreateErrors[keyof IdentitiesCreateErrors];
 type IdentitiesCreateResponses = {
@@ -3268,6 +3272,10 @@ type PodsCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type PodsCreateError = PodsCreateErrors[keyof PodsCreateErrors];
 type PodsCreateResponses = {
@@ -3555,6 +3563,10 @@ type LabelsCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type LabelsCreateError = LabelsCreateErrors[keyof LabelsCreateErrors];
 type LabelsCreateResponses = {
@@ -4005,6 +4017,10 @@ type MessagesSendErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type MessagesSendError = MessagesSendErrors[keyof MessagesSendErrors];
 type MessagesSendResponses = {
@@ -4457,6 +4473,10 @@ type MessagesReplyErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type MessagesReplyError = MessagesReplyErrors[keyof MessagesReplyErrors];
 type MessagesReplyResponses = {
@@ -4553,6 +4573,10 @@ type MessagesReplyAllErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type MessagesReplyAllError = MessagesReplyAllErrors[keyof MessagesReplyAllErrors];
 type MessagesReplyAllResponses = {
@@ -4649,6 +4673,10 @@ type MessagesForwardErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type MessagesForwardError = MessagesForwardErrors[keyof MessagesForwardErrors];
 type MessagesForwardResponses = {
@@ -5053,6 +5081,10 @@ type DomainsCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type DomainsCreateError = DomainsCreateErrors[keyof DomainsCreateErrors];
 type DomainsCreateResponses = {
@@ -5504,6 +5536,10 @@ type RoutingCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type RoutingCreateError = RoutingCreateErrors[keyof RoutingCreateErrors];
 type RoutingCreateResponses = {
@@ -5999,6 +6035,10 @@ type KeysCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type KeysCreateError = KeysCreateErrors[keyof KeysCreateErrors];
 type KeysCreateResponses = {
@@ -6211,6 +6251,10 @@ type KeysRotateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type KeysRotateError = KeysRotateErrors[keyof KeysRotateErrors];
 type KeysRotateResponses = {
@@ -6306,6 +6350,10 @@ type TestInboundErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type TestInboundError = TestInboundErrors[keyof TestInboundErrors];
 type TestInboundResponses = {
@@ -6984,6 +7032,10 @@ type WebhooksCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type WebhooksCreateError = WebhooksCreateErrors[keyof WebhooksCreateErrors];
 type WebhooksCreateResponses = {
@@ -7421,6 +7473,10 @@ type MessagesRespondToInvitationErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type MessagesRespondToInvitationError = MessagesRespondToInvitationErrors[keyof MessagesRespondToInvitationErrors];
 type MessagesRespondToInvitationResponses = {
@@ -7688,6 +7744,10 @@ type CalendarCreateEventErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type CalendarCreateEventError = CalendarCreateEventErrors[keyof CalendarCreateEventErrors];
 type CalendarCreateEventResponses = {
@@ -7759,6 +7819,10 @@ type CalendarRespondToEventErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type CalendarRespondToEventError = CalendarRespondToEventErrors[keyof CalendarRespondToEventErrors];
 type CalendarRespondToEventResponses = {
@@ -7959,6 +8023,10 @@ type CalendarDeleteEventErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type CalendarDeleteEventError = CalendarDeleteEventErrors[keyof CalendarDeleteEventErrors];
 type CalendarDeleteEventResponses = {
@@ -8113,6 +8181,10 @@ type CalendarUpdateEventErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type CalendarUpdateEventError = CalendarUpdateEventErrors[keyof CalendarUpdateEventErrors];
 type CalendarUpdateEventResponses = {
@@ -8281,6 +8353,10 @@ type DraftsCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type DraftsCreateError = DraftsCreateErrors[keyof DraftsCreateErrors];
 type DraftsCreateResponses = {
@@ -8537,6 +8613,10 @@ type DraftsSendErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type DraftsSendError = DraftsSendErrors[keyof DraftsSendErrors];
 type DraftsSendResponses = {
@@ -8649,6 +8729,10 @@ type DraftsScheduleErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type DraftsScheduleError = DraftsScheduleErrors[keyof DraftsScheduleErrors];
 type DraftsScheduleResponses = {
@@ -9131,7 +9215,7 @@ declare const messagesListInThread: <ThrowOnError extends boolean = false>(optio
 /**
  * Send a message
  *
- * Idempotent with an `Idempotency-Key` header. Answers `202` with the id, the thread and anything **rejected** — addresses the provider would not accept at hand-off, so read it before assuming every recipient got it. A recipient this address is not allowed to write to is a different thing and refuses the whole send: `403` with `blocked` when a rule says no, `not_permitted` when the send policy does. Nothing is sent to anybody in that case.
+ * Idempotent with an `Idempotency-Key` header. Answers `202` with the id, the thread and anything **rejected** — addresses the provider would not accept at hand-off, so read it before assuming every recipient got it. A recipient this address is not allowed to write to is a different thing and refuses the whole send: `403` with `blocked` when a rule says no, `not_permitted` when the send policy does. Nothing is sent to anybody in that case. With a test key, `rejected@` at any domain is always rejected and `bounce@` bounces, and `Pidgeon-Test-Fail` causes a 429, a 503, a slow answer or a lost one: https://pidgeon.ai/docs/test-mode#causing-failures.
  */
 declare const messagesSend: <ThrowOnError extends boolean = false>(options: Options<MessagesSendData, ThrowOnError>) => RequestResult<MessagesSendResponses, MessagesSendErrors, ThrowOnError>;
 /**

package/dist/index.d.ts

@@ -2387,6 +2387,10 @@ type IdentitiesCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type IdentitiesCreateError = IdentitiesCreateErrors[keyof IdentitiesCreateErrors];
 type IdentitiesCreateResponses = {
@@ -3268,6 +3272,10 @@ type PodsCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type PodsCreateError = PodsCreateErrors[keyof PodsCreateErrors];
 type PodsCreateResponses = {
@@ -3555,6 +3563,10 @@ type LabelsCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type LabelsCreateError = LabelsCreateErrors[keyof LabelsCreateErrors];
 type LabelsCreateResponses = {
@@ -4005,6 +4017,10 @@ type MessagesSendErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type MessagesSendError = MessagesSendErrors[keyof MessagesSendErrors];
 type MessagesSendResponses = {
@@ -4457,6 +4473,10 @@ type MessagesReplyErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type MessagesReplyError = MessagesReplyErrors[keyof MessagesReplyErrors];
 type MessagesReplyResponses = {
@@ -4553,6 +4573,10 @@ type MessagesReplyAllErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type MessagesReplyAllError = MessagesReplyAllErrors[keyof MessagesReplyAllErrors];
 type MessagesReplyAllResponses = {
@@ -4649,6 +4673,10 @@ type MessagesForwardErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type MessagesForwardError = MessagesForwardErrors[keyof MessagesForwardErrors];
 type MessagesForwardResponses = {
@@ -5053,6 +5081,10 @@ type DomainsCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type DomainsCreateError = DomainsCreateErrors[keyof DomainsCreateErrors];
 type DomainsCreateResponses = {
@@ -5504,6 +5536,10 @@ type RoutingCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type RoutingCreateError = RoutingCreateErrors[keyof RoutingCreateErrors];
 type RoutingCreateResponses = {
@@ -5999,6 +6035,10 @@ type KeysCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type KeysCreateError = KeysCreateErrors[keyof KeysCreateErrors];
 type KeysCreateResponses = {
@@ -6211,6 +6251,10 @@ type KeysRotateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type KeysRotateError = KeysRotateErrors[keyof KeysRotateErrors];
 type KeysRotateResponses = {
@@ -6306,6 +6350,10 @@ type TestInboundErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type TestInboundError = TestInboundErrors[keyof TestInboundErrors];
 type TestInboundResponses = {
@@ -6984,6 +7032,10 @@ type WebhooksCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type WebhooksCreateError = WebhooksCreateErrors[keyof WebhooksCreateErrors];
 type WebhooksCreateResponses = {
@@ -7421,6 +7473,10 @@ type MessagesRespondToInvitationErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type MessagesRespondToInvitationError = MessagesRespondToInvitationErrors[keyof MessagesRespondToInvitationErrors];
 type MessagesRespondToInvitationResponses = {
@@ -7688,6 +7744,10 @@ type CalendarCreateEventErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type CalendarCreateEventError = CalendarCreateEventErrors[keyof CalendarCreateEventErrors];
 type CalendarCreateEventResponses = {
@@ -7759,6 +7819,10 @@ type CalendarRespondToEventErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type CalendarRespondToEventError = CalendarRespondToEventErrors[keyof CalendarRespondToEventErrors];
 type CalendarRespondToEventResponses = {
@@ -7959,6 +8023,10 @@ type CalendarDeleteEventErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type CalendarDeleteEventError = CalendarDeleteEventErrors[keyof CalendarDeleteEventErrors];
 type CalendarDeleteEventResponses = {
@@ -8113,6 +8181,10 @@ type CalendarUpdateEventErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type CalendarUpdateEventError = CalendarUpdateEventErrors[keyof CalendarUpdateEventErrors];
 type CalendarUpdateEventResponses = {
@@ -8281,6 +8353,10 @@ type DraftsCreateErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type DraftsCreateError = DraftsCreateErrors[keyof DraftsCreateErrors];
 type DraftsCreateResponses = {
@@ -8537,6 +8613,10 @@ type DraftsSendErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type DraftsSendError = DraftsSendErrors[keyof DraftsSendErrors];
 type DraftsSendResponses = {
@@ -8649,6 +8729,10 @@ type DraftsScheduleErrors = {
      * Something this needs is not answering right now. Retry in a moment.
      */
     503: Error;
+    /**
+     * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
+     */
+    504: Error;
 };
 type DraftsScheduleError = DraftsScheduleErrors[keyof DraftsScheduleErrors];
 type DraftsScheduleResponses = {
@@ -9131,7 +9215,7 @@ declare const messagesListInThread: <ThrowOnError extends boolean = false>(optio
 /**
  * Send a message
  *
- * Idempotent with an `Idempotency-Key` header. Answers `202` with the id, the thread and anything **rejected** — addresses the provider would not accept at hand-off, so read it before assuming every recipient got it. A recipient this address is not allowed to write to is a different thing and refuses the whole send: `403` with `blocked` when a rule says no, `not_permitted` when the send policy does. Nothing is sent to anybody in that case.
+ * Idempotent with an `Idempotency-Key` header. Answers `202` with the id, the thread and anything **rejected** — addresses the provider would not accept at hand-off, so read it before assuming every recipient got it. A recipient this address is not allowed to write to is a different thing and refuses the whole send: `403` with `blocked` when a rule says no, `not_permitted` when the send policy does. Nothing is sent to anybody in that case. With a test key, `rejected@` at any domain is always rejected and `bounce@` bounces, and `Pidgeon-Test-Fail` causes a 429, a 503, a slow answer or a lost one: https://pidgeon.ai/docs/test-mode#causing-failures.
  */
 declare const messagesSend: <ThrowOnError extends boolean = false>(options: Options<MessagesSendData, ThrowOnError>) => RequestResult<MessagesSendResponses, MessagesSendErrors, ThrowOnError>;
 /**