@pidgeon-ai/sdk 1.32.0 → 1.34.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +95 -1
- package/dist/index.d.ts +95 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -437,6 +437,10 @@ type Identity = {
|
|
|
437
437
|
* The pod this address is in. Every workspace has one to start with and every address is in one, so this is never null.
|
|
438
438
|
*/
|
|
439
439
|
pod_id: string;
|
|
440
|
+
/**
|
|
441
|
+
* A test address, made by a test key: it counts against no plan, takes only test mail (a test send or `POST /test/inbound`), and is deleted a day after it was made.
|
|
442
|
+
*/
|
|
443
|
+
test: boolean;
|
|
440
444
|
};
|
|
441
445
|
type Message = {
|
|
442
446
|
id: string;
|
|
@@ -1913,6 +1917,10 @@ type PodCreated = {
|
|
|
1913
1917
|
* The pod this address is in. Every workspace has one to start with and every address is in one, so this is never null.
|
|
1914
1918
|
*/
|
|
1915
1919
|
pod_id: string;
|
|
1920
|
+
/**
|
|
1921
|
+
* A test address, made by a test key: it counts against no plan, takes only test mail (a test send or `POST /test/inbound`), and is deleted a day after it was made.
|
|
1922
|
+
*/
|
|
1923
|
+
test: boolean;
|
|
1916
1924
|
} | null;
|
|
1917
1925
|
/**
|
|
1918
1926
|
* A pod key for it, or null when the call asked for none.
|
|
@@ -2387,6 +2395,10 @@ type IdentitiesCreateErrors = {
|
|
|
2387
2395
|
* Something this needs is not answering right now. Retry in a moment.
|
|
2388
2396
|
*/
|
|
2389
2397
|
503: Error;
|
|
2398
|
+
/**
|
|
2399
|
+
* 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.
|
|
2400
|
+
*/
|
|
2401
|
+
504: Error;
|
|
2390
2402
|
};
|
|
2391
2403
|
type IdentitiesCreateError = IdentitiesCreateErrors[keyof IdentitiesCreateErrors];
|
|
2392
2404
|
type IdentitiesCreateResponses = {
|
|
@@ -3268,6 +3280,10 @@ type PodsCreateErrors = {
|
|
|
3268
3280
|
* Something this needs is not answering right now. Retry in a moment.
|
|
3269
3281
|
*/
|
|
3270
3282
|
503: Error;
|
|
3283
|
+
/**
|
|
3284
|
+
* 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.
|
|
3285
|
+
*/
|
|
3286
|
+
504: Error;
|
|
3271
3287
|
};
|
|
3272
3288
|
type PodsCreateError = PodsCreateErrors[keyof PodsCreateErrors];
|
|
3273
3289
|
type PodsCreateResponses = {
|
|
@@ -3555,6 +3571,10 @@ type LabelsCreateErrors = {
|
|
|
3555
3571
|
* Something this needs is not answering right now. Retry in a moment.
|
|
3556
3572
|
*/
|
|
3557
3573
|
503: Error;
|
|
3574
|
+
/**
|
|
3575
|
+
* 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.
|
|
3576
|
+
*/
|
|
3577
|
+
504: Error;
|
|
3558
3578
|
};
|
|
3559
3579
|
type LabelsCreateError = LabelsCreateErrors[keyof LabelsCreateErrors];
|
|
3560
3580
|
type LabelsCreateResponses = {
|
|
@@ -4005,6 +4025,10 @@ type MessagesSendErrors = {
|
|
|
4005
4025
|
* Something this needs is not answering right now. Retry in a moment.
|
|
4006
4026
|
*/
|
|
4007
4027
|
503: Error;
|
|
4028
|
+
/**
|
|
4029
|
+
* 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.
|
|
4030
|
+
*/
|
|
4031
|
+
504: Error;
|
|
4008
4032
|
};
|
|
4009
4033
|
type MessagesSendError = MessagesSendErrors[keyof MessagesSendErrors];
|
|
4010
4034
|
type MessagesSendResponses = {
|
|
@@ -4457,6 +4481,10 @@ type MessagesReplyErrors = {
|
|
|
4457
4481
|
* Something this needs is not answering right now. Retry in a moment.
|
|
4458
4482
|
*/
|
|
4459
4483
|
503: Error;
|
|
4484
|
+
/**
|
|
4485
|
+
* 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.
|
|
4486
|
+
*/
|
|
4487
|
+
504: Error;
|
|
4460
4488
|
};
|
|
4461
4489
|
type MessagesReplyError = MessagesReplyErrors[keyof MessagesReplyErrors];
|
|
4462
4490
|
type MessagesReplyResponses = {
|
|
@@ -4553,6 +4581,10 @@ type MessagesReplyAllErrors = {
|
|
|
4553
4581
|
* Something this needs is not answering right now. Retry in a moment.
|
|
4554
4582
|
*/
|
|
4555
4583
|
503: Error;
|
|
4584
|
+
/**
|
|
4585
|
+
* 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.
|
|
4586
|
+
*/
|
|
4587
|
+
504: Error;
|
|
4556
4588
|
};
|
|
4557
4589
|
type MessagesReplyAllError = MessagesReplyAllErrors[keyof MessagesReplyAllErrors];
|
|
4558
4590
|
type MessagesReplyAllResponses = {
|
|
@@ -4649,6 +4681,10 @@ type MessagesForwardErrors = {
|
|
|
4649
4681
|
* Something this needs is not answering right now. Retry in a moment.
|
|
4650
4682
|
*/
|
|
4651
4683
|
503: Error;
|
|
4684
|
+
/**
|
|
4685
|
+
* 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.
|
|
4686
|
+
*/
|
|
4687
|
+
504: Error;
|
|
4652
4688
|
};
|
|
4653
4689
|
type MessagesForwardError = MessagesForwardErrors[keyof MessagesForwardErrors];
|
|
4654
4690
|
type MessagesForwardResponses = {
|
|
@@ -5053,6 +5089,10 @@ type DomainsCreateErrors = {
|
|
|
5053
5089
|
* Something this needs is not answering right now. Retry in a moment.
|
|
5054
5090
|
*/
|
|
5055
5091
|
503: Error;
|
|
5092
|
+
/**
|
|
5093
|
+
* 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.
|
|
5094
|
+
*/
|
|
5095
|
+
504: Error;
|
|
5056
5096
|
};
|
|
5057
5097
|
type DomainsCreateError = DomainsCreateErrors[keyof DomainsCreateErrors];
|
|
5058
5098
|
type DomainsCreateResponses = {
|
|
@@ -5504,6 +5544,10 @@ type RoutingCreateErrors = {
|
|
|
5504
5544
|
* Something this needs is not answering right now. Retry in a moment.
|
|
5505
5545
|
*/
|
|
5506
5546
|
503: Error;
|
|
5547
|
+
/**
|
|
5548
|
+
* 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.
|
|
5549
|
+
*/
|
|
5550
|
+
504: Error;
|
|
5507
5551
|
};
|
|
5508
5552
|
type RoutingCreateError = RoutingCreateErrors[keyof RoutingCreateErrors];
|
|
5509
5553
|
type RoutingCreateResponses = {
|
|
@@ -5999,6 +6043,10 @@ type KeysCreateErrors = {
|
|
|
5999
6043
|
* Something this needs is not answering right now. Retry in a moment.
|
|
6000
6044
|
*/
|
|
6001
6045
|
503: Error;
|
|
6046
|
+
/**
|
|
6047
|
+
* 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.
|
|
6048
|
+
*/
|
|
6049
|
+
504: Error;
|
|
6002
6050
|
};
|
|
6003
6051
|
type KeysCreateError = KeysCreateErrors[keyof KeysCreateErrors];
|
|
6004
6052
|
type KeysCreateResponses = {
|
|
@@ -6211,6 +6259,10 @@ type KeysRotateErrors = {
|
|
|
6211
6259
|
* Something this needs is not answering right now. Retry in a moment.
|
|
6212
6260
|
*/
|
|
6213
6261
|
503: Error;
|
|
6262
|
+
/**
|
|
6263
|
+
* 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.
|
|
6264
|
+
*/
|
|
6265
|
+
504: Error;
|
|
6214
6266
|
};
|
|
6215
6267
|
type KeysRotateError = KeysRotateErrors[keyof KeysRotateErrors];
|
|
6216
6268
|
type KeysRotateResponses = {
|
|
@@ -6306,6 +6358,10 @@ type TestInboundErrors = {
|
|
|
6306
6358
|
* Something this needs is not answering right now. Retry in a moment.
|
|
6307
6359
|
*/
|
|
6308
6360
|
503: Error;
|
|
6361
|
+
/**
|
|
6362
|
+
* 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.
|
|
6363
|
+
*/
|
|
6364
|
+
504: Error;
|
|
6309
6365
|
};
|
|
6310
6366
|
type TestInboundError = TestInboundErrors[keyof TestInboundErrors];
|
|
6311
6367
|
type TestInboundResponses = {
|
|
@@ -6984,6 +7040,10 @@ type WebhooksCreateErrors = {
|
|
|
6984
7040
|
* Something this needs is not answering right now. Retry in a moment.
|
|
6985
7041
|
*/
|
|
6986
7042
|
503: Error;
|
|
7043
|
+
/**
|
|
7044
|
+
* 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.
|
|
7045
|
+
*/
|
|
7046
|
+
504: Error;
|
|
6987
7047
|
};
|
|
6988
7048
|
type WebhooksCreateError = WebhooksCreateErrors[keyof WebhooksCreateErrors];
|
|
6989
7049
|
type WebhooksCreateResponses = {
|
|
@@ -7421,6 +7481,10 @@ type MessagesRespondToInvitationErrors = {
|
|
|
7421
7481
|
* Something this needs is not answering right now. Retry in a moment.
|
|
7422
7482
|
*/
|
|
7423
7483
|
503: Error;
|
|
7484
|
+
/**
|
|
7485
|
+
* 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.
|
|
7486
|
+
*/
|
|
7487
|
+
504: Error;
|
|
7424
7488
|
};
|
|
7425
7489
|
type MessagesRespondToInvitationError = MessagesRespondToInvitationErrors[keyof MessagesRespondToInvitationErrors];
|
|
7426
7490
|
type MessagesRespondToInvitationResponses = {
|
|
@@ -7688,6 +7752,10 @@ type CalendarCreateEventErrors = {
|
|
|
7688
7752
|
* Something this needs is not answering right now. Retry in a moment.
|
|
7689
7753
|
*/
|
|
7690
7754
|
503: Error;
|
|
7755
|
+
/**
|
|
7756
|
+
* 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.
|
|
7757
|
+
*/
|
|
7758
|
+
504: Error;
|
|
7691
7759
|
};
|
|
7692
7760
|
type CalendarCreateEventError = CalendarCreateEventErrors[keyof CalendarCreateEventErrors];
|
|
7693
7761
|
type CalendarCreateEventResponses = {
|
|
@@ -7759,6 +7827,10 @@ type CalendarRespondToEventErrors = {
|
|
|
7759
7827
|
* Something this needs is not answering right now. Retry in a moment.
|
|
7760
7828
|
*/
|
|
7761
7829
|
503: Error;
|
|
7830
|
+
/**
|
|
7831
|
+
* 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.
|
|
7832
|
+
*/
|
|
7833
|
+
504: Error;
|
|
7762
7834
|
};
|
|
7763
7835
|
type CalendarRespondToEventError = CalendarRespondToEventErrors[keyof CalendarRespondToEventErrors];
|
|
7764
7836
|
type CalendarRespondToEventResponses = {
|
|
@@ -7959,6 +8031,10 @@ type CalendarDeleteEventErrors = {
|
|
|
7959
8031
|
* Something this needs is not answering right now. Retry in a moment.
|
|
7960
8032
|
*/
|
|
7961
8033
|
503: Error;
|
|
8034
|
+
/**
|
|
8035
|
+
* 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.
|
|
8036
|
+
*/
|
|
8037
|
+
504: Error;
|
|
7962
8038
|
};
|
|
7963
8039
|
type CalendarDeleteEventError = CalendarDeleteEventErrors[keyof CalendarDeleteEventErrors];
|
|
7964
8040
|
type CalendarDeleteEventResponses = {
|
|
@@ -8113,6 +8189,10 @@ type CalendarUpdateEventErrors = {
|
|
|
8113
8189
|
* Something this needs is not answering right now. Retry in a moment.
|
|
8114
8190
|
*/
|
|
8115
8191
|
503: Error;
|
|
8192
|
+
/**
|
|
8193
|
+
* 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.
|
|
8194
|
+
*/
|
|
8195
|
+
504: Error;
|
|
8116
8196
|
};
|
|
8117
8197
|
type CalendarUpdateEventError = CalendarUpdateEventErrors[keyof CalendarUpdateEventErrors];
|
|
8118
8198
|
type CalendarUpdateEventResponses = {
|
|
@@ -8281,6 +8361,10 @@ type DraftsCreateErrors = {
|
|
|
8281
8361
|
* Something this needs is not answering right now. Retry in a moment.
|
|
8282
8362
|
*/
|
|
8283
8363
|
503: Error;
|
|
8364
|
+
/**
|
|
8365
|
+
* 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.
|
|
8366
|
+
*/
|
|
8367
|
+
504: Error;
|
|
8284
8368
|
};
|
|
8285
8369
|
type DraftsCreateError = DraftsCreateErrors[keyof DraftsCreateErrors];
|
|
8286
8370
|
type DraftsCreateResponses = {
|
|
@@ -8537,6 +8621,10 @@ type DraftsSendErrors = {
|
|
|
8537
8621
|
* Something this needs is not answering right now. Retry in a moment.
|
|
8538
8622
|
*/
|
|
8539
8623
|
503: Error;
|
|
8624
|
+
/**
|
|
8625
|
+
* 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.
|
|
8626
|
+
*/
|
|
8627
|
+
504: Error;
|
|
8540
8628
|
};
|
|
8541
8629
|
type DraftsSendError = DraftsSendErrors[keyof DraftsSendErrors];
|
|
8542
8630
|
type DraftsSendResponses = {
|
|
@@ -8649,6 +8737,10 @@ type DraftsScheduleErrors = {
|
|
|
8649
8737
|
* Something this needs is not answering right now. Retry in a moment.
|
|
8650
8738
|
*/
|
|
8651
8739
|
503: Error;
|
|
8740
|
+
/**
|
|
8741
|
+
* 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.
|
|
8742
|
+
*/
|
|
8743
|
+
504: Error;
|
|
8652
8744
|
};
|
|
8653
8745
|
type DraftsScheduleError = DraftsScheduleErrors[keyof DraftsScheduleErrors];
|
|
8654
8746
|
type DraftsScheduleResponses = {
|
|
@@ -8968,6 +9060,8 @@ declare const identitiesList: <ThrowOnError extends boolean = false>(options?: O
|
|
|
8968
9060
|
* Create an address
|
|
8969
9061
|
*
|
|
8970
9062
|
* Idempotent with an `Idempotency-Key` header: the same key returns the first result rather than creating a second address.
|
|
9063
|
+
*
|
|
9064
|
+
* Needs a key with admin over the account, or over its pod. A **test key** creates a test address (`test: true`): outside your plan’s counts, at most 100 at once, taking only test mail, and deleted a day after it was made.
|
|
8971
9065
|
*/
|
|
8972
9066
|
declare const identitiesCreate: <ThrowOnError extends boolean = false>(options: Options<IdentitiesCreateData, ThrowOnError>) => RequestResult<IdentitiesCreateResponses, IdentitiesCreateErrors, ThrowOnError>;
|
|
8973
9067
|
/**
|
|
@@ -9131,7 +9225,7 @@ declare const messagesListInThread: <ThrowOnError extends boolean = false>(optio
|
|
|
9131
9225
|
/**
|
|
9132
9226
|
* Send a message
|
|
9133
9227
|
*
|
|
9134
|
-
* 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.
|
|
9228
|
+
* 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.
|
|
9135
9229
|
*/
|
|
9136
9230
|
declare const messagesSend: <ThrowOnError extends boolean = false>(options: Options<MessagesSendData, ThrowOnError>) => RequestResult<MessagesSendResponses, MessagesSendErrors, ThrowOnError>;
|
|
9137
9231
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -437,6 +437,10 @@ type Identity = {
|
|
|
437
437
|
* The pod this address is in. Every workspace has one to start with and every address is in one, so this is never null.
|
|
438
438
|
*/
|
|
439
439
|
pod_id: string;
|
|
440
|
+
/**
|
|
441
|
+
* A test address, made by a test key: it counts against no plan, takes only test mail (a test send or `POST /test/inbound`), and is deleted a day after it was made.
|
|
442
|
+
*/
|
|
443
|
+
test: boolean;
|
|
440
444
|
};
|
|
441
445
|
type Message = {
|
|
442
446
|
id: string;
|
|
@@ -1913,6 +1917,10 @@ type PodCreated = {
|
|
|
1913
1917
|
* The pod this address is in. Every workspace has one to start with and every address is in one, so this is never null.
|
|
1914
1918
|
*/
|
|
1915
1919
|
pod_id: string;
|
|
1920
|
+
/**
|
|
1921
|
+
* A test address, made by a test key: it counts against no plan, takes only test mail (a test send or `POST /test/inbound`), and is deleted a day after it was made.
|
|
1922
|
+
*/
|
|
1923
|
+
test: boolean;
|
|
1916
1924
|
} | null;
|
|
1917
1925
|
/**
|
|
1918
1926
|
* A pod key for it, or null when the call asked for none.
|
|
@@ -2387,6 +2395,10 @@ type IdentitiesCreateErrors = {
|
|
|
2387
2395
|
* Something this needs is not answering right now. Retry in a moment.
|
|
2388
2396
|
*/
|
|
2389
2397
|
503: Error;
|
|
2398
|
+
/**
|
|
2399
|
+
* 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.
|
|
2400
|
+
*/
|
|
2401
|
+
504: Error;
|
|
2390
2402
|
};
|
|
2391
2403
|
type IdentitiesCreateError = IdentitiesCreateErrors[keyof IdentitiesCreateErrors];
|
|
2392
2404
|
type IdentitiesCreateResponses = {
|
|
@@ -3268,6 +3280,10 @@ type PodsCreateErrors = {
|
|
|
3268
3280
|
* Something this needs is not answering right now. Retry in a moment.
|
|
3269
3281
|
*/
|
|
3270
3282
|
503: Error;
|
|
3283
|
+
/**
|
|
3284
|
+
* 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.
|
|
3285
|
+
*/
|
|
3286
|
+
504: Error;
|
|
3271
3287
|
};
|
|
3272
3288
|
type PodsCreateError = PodsCreateErrors[keyof PodsCreateErrors];
|
|
3273
3289
|
type PodsCreateResponses = {
|
|
@@ -3555,6 +3571,10 @@ type LabelsCreateErrors = {
|
|
|
3555
3571
|
* Something this needs is not answering right now. Retry in a moment.
|
|
3556
3572
|
*/
|
|
3557
3573
|
503: Error;
|
|
3574
|
+
/**
|
|
3575
|
+
* 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.
|
|
3576
|
+
*/
|
|
3577
|
+
504: Error;
|
|
3558
3578
|
};
|
|
3559
3579
|
type LabelsCreateError = LabelsCreateErrors[keyof LabelsCreateErrors];
|
|
3560
3580
|
type LabelsCreateResponses = {
|
|
@@ -4005,6 +4025,10 @@ type MessagesSendErrors = {
|
|
|
4005
4025
|
* Something this needs is not answering right now. Retry in a moment.
|
|
4006
4026
|
*/
|
|
4007
4027
|
503: Error;
|
|
4028
|
+
/**
|
|
4029
|
+
* 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.
|
|
4030
|
+
*/
|
|
4031
|
+
504: Error;
|
|
4008
4032
|
};
|
|
4009
4033
|
type MessagesSendError = MessagesSendErrors[keyof MessagesSendErrors];
|
|
4010
4034
|
type MessagesSendResponses = {
|
|
@@ -4457,6 +4481,10 @@ type MessagesReplyErrors = {
|
|
|
4457
4481
|
* Something this needs is not answering right now. Retry in a moment.
|
|
4458
4482
|
*/
|
|
4459
4483
|
503: Error;
|
|
4484
|
+
/**
|
|
4485
|
+
* 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.
|
|
4486
|
+
*/
|
|
4487
|
+
504: Error;
|
|
4460
4488
|
};
|
|
4461
4489
|
type MessagesReplyError = MessagesReplyErrors[keyof MessagesReplyErrors];
|
|
4462
4490
|
type MessagesReplyResponses = {
|
|
@@ -4553,6 +4581,10 @@ type MessagesReplyAllErrors = {
|
|
|
4553
4581
|
* Something this needs is not answering right now. Retry in a moment.
|
|
4554
4582
|
*/
|
|
4555
4583
|
503: Error;
|
|
4584
|
+
/**
|
|
4585
|
+
* 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.
|
|
4586
|
+
*/
|
|
4587
|
+
504: Error;
|
|
4556
4588
|
};
|
|
4557
4589
|
type MessagesReplyAllError = MessagesReplyAllErrors[keyof MessagesReplyAllErrors];
|
|
4558
4590
|
type MessagesReplyAllResponses = {
|
|
@@ -4649,6 +4681,10 @@ type MessagesForwardErrors = {
|
|
|
4649
4681
|
* Something this needs is not answering right now. Retry in a moment.
|
|
4650
4682
|
*/
|
|
4651
4683
|
503: Error;
|
|
4684
|
+
/**
|
|
4685
|
+
* 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.
|
|
4686
|
+
*/
|
|
4687
|
+
504: Error;
|
|
4652
4688
|
};
|
|
4653
4689
|
type MessagesForwardError = MessagesForwardErrors[keyof MessagesForwardErrors];
|
|
4654
4690
|
type MessagesForwardResponses = {
|
|
@@ -5053,6 +5089,10 @@ type DomainsCreateErrors = {
|
|
|
5053
5089
|
* Something this needs is not answering right now. Retry in a moment.
|
|
5054
5090
|
*/
|
|
5055
5091
|
503: Error;
|
|
5092
|
+
/**
|
|
5093
|
+
* 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.
|
|
5094
|
+
*/
|
|
5095
|
+
504: Error;
|
|
5056
5096
|
};
|
|
5057
5097
|
type DomainsCreateError = DomainsCreateErrors[keyof DomainsCreateErrors];
|
|
5058
5098
|
type DomainsCreateResponses = {
|
|
@@ -5504,6 +5544,10 @@ type RoutingCreateErrors = {
|
|
|
5504
5544
|
* Something this needs is not answering right now. Retry in a moment.
|
|
5505
5545
|
*/
|
|
5506
5546
|
503: Error;
|
|
5547
|
+
/**
|
|
5548
|
+
* 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.
|
|
5549
|
+
*/
|
|
5550
|
+
504: Error;
|
|
5507
5551
|
};
|
|
5508
5552
|
type RoutingCreateError = RoutingCreateErrors[keyof RoutingCreateErrors];
|
|
5509
5553
|
type RoutingCreateResponses = {
|
|
@@ -5999,6 +6043,10 @@ type KeysCreateErrors = {
|
|
|
5999
6043
|
* Something this needs is not answering right now. Retry in a moment.
|
|
6000
6044
|
*/
|
|
6001
6045
|
503: Error;
|
|
6046
|
+
/**
|
|
6047
|
+
* 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.
|
|
6048
|
+
*/
|
|
6049
|
+
504: Error;
|
|
6002
6050
|
};
|
|
6003
6051
|
type KeysCreateError = KeysCreateErrors[keyof KeysCreateErrors];
|
|
6004
6052
|
type KeysCreateResponses = {
|
|
@@ -6211,6 +6259,10 @@ type KeysRotateErrors = {
|
|
|
6211
6259
|
* Something this needs is not answering right now. Retry in a moment.
|
|
6212
6260
|
*/
|
|
6213
6261
|
503: Error;
|
|
6262
|
+
/**
|
|
6263
|
+
* 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.
|
|
6264
|
+
*/
|
|
6265
|
+
504: Error;
|
|
6214
6266
|
};
|
|
6215
6267
|
type KeysRotateError = KeysRotateErrors[keyof KeysRotateErrors];
|
|
6216
6268
|
type KeysRotateResponses = {
|
|
@@ -6306,6 +6358,10 @@ type TestInboundErrors = {
|
|
|
6306
6358
|
* Something this needs is not answering right now. Retry in a moment.
|
|
6307
6359
|
*/
|
|
6308
6360
|
503: Error;
|
|
6361
|
+
/**
|
|
6362
|
+
* 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.
|
|
6363
|
+
*/
|
|
6364
|
+
504: Error;
|
|
6309
6365
|
};
|
|
6310
6366
|
type TestInboundError = TestInboundErrors[keyof TestInboundErrors];
|
|
6311
6367
|
type TestInboundResponses = {
|
|
@@ -6984,6 +7040,10 @@ type WebhooksCreateErrors = {
|
|
|
6984
7040
|
* Something this needs is not answering right now. Retry in a moment.
|
|
6985
7041
|
*/
|
|
6986
7042
|
503: Error;
|
|
7043
|
+
/**
|
|
7044
|
+
* 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.
|
|
7045
|
+
*/
|
|
7046
|
+
504: Error;
|
|
6987
7047
|
};
|
|
6988
7048
|
type WebhooksCreateError = WebhooksCreateErrors[keyof WebhooksCreateErrors];
|
|
6989
7049
|
type WebhooksCreateResponses = {
|
|
@@ -7421,6 +7481,10 @@ type MessagesRespondToInvitationErrors = {
|
|
|
7421
7481
|
* Something this needs is not answering right now. Retry in a moment.
|
|
7422
7482
|
*/
|
|
7423
7483
|
503: Error;
|
|
7484
|
+
/**
|
|
7485
|
+
* 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.
|
|
7486
|
+
*/
|
|
7487
|
+
504: Error;
|
|
7424
7488
|
};
|
|
7425
7489
|
type MessagesRespondToInvitationError = MessagesRespondToInvitationErrors[keyof MessagesRespondToInvitationErrors];
|
|
7426
7490
|
type MessagesRespondToInvitationResponses = {
|
|
@@ -7688,6 +7752,10 @@ type CalendarCreateEventErrors = {
|
|
|
7688
7752
|
* Something this needs is not answering right now. Retry in a moment.
|
|
7689
7753
|
*/
|
|
7690
7754
|
503: Error;
|
|
7755
|
+
/**
|
|
7756
|
+
* 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.
|
|
7757
|
+
*/
|
|
7758
|
+
504: Error;
|
|
7691
7759
|
};
|
|
7692
7760
|
type CalendarCreateEventError = CalendarCreateEventErrors[keyof CalendarCreateEventErrors];
|
|
7693
7761
|
type CalendarCreateEventResponses = {
|
|
@@ -7759,6 +7827,10 @@ type CalendarRespondToEventErrors = {
|
|
|
7759
7827
|
* Something this needs is not answering right now. Retry in a moment.
|
|
7760
7828
|
*/
|
|
7761
7829
|
503: Error;
|
|
7830
|
+
/**
|
|
7831
|
+
* 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.
|
|
7832
|
+
*/
|
|
7833
|
+
504: Error;
|
|
7762
7834
|
};
|
|
7763
7835
|
type CalendarRespondToEventError = CalendarRespondToEventErrors[keyof CalendarRespondToEventErrors];
|
|
7764
7836
|
type CalendarRespondToEventResponses = {
|
|
@@ -7959,6 +8031,10 @@ type CalendarDeleteEventErrors = {
|
|
|
7959
8031
|
* Something this needs is not answering right now. Retry in a moment.
|
|
7960
8032
|
*/
|
|
7961
8033
|
503: Error;
|
|
8034
|
+
/**
|
|
8035
|
+
* 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.
|
|
8036
|
+
*/
|
|
8037
|
+
504: Error;
|
|
7962
8038
|
};
|
|
7963
8039
|
type CalendarDeleteEventError = CalendarDeleteEventErrors[keyof CalendarDeleteEventErrors];
|
|
7964
8040
|
type CalendarDeleteEventResponses = {
|
|
@@ -8113,6 +8189,10 @@ type CalendarUpdateEventErrors = {
|
|
|
8113
8189
|
* Something this needs is not answering right now. Retry in a moment.
|
|
8114
8190
|
*/
|
|
8115
8191
|
503: Error;
|
|
8192
|
+
/**
|
|
8193
|
+
* 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.
|
|
8194
|
+
*/
|
|
8195
|
+
504: Error;
|
|
8116
8196
|
};
|
|
8117
8197
|
type CalendarUpdateEventError = CalendarUpdateEventErrors[keyof CalendarUpdateEventErrors];
|
|
8118
8198
|
type CalendarUpdateEventResponses = {
|
|
@@ -8281,6 +8361,10 @@ type DraftsCreateErrors = {
|
|
|
8281
8361
|
* Something this needs is not answering right now. Retry in a moment.
|
|
8282
8362
|
*/
|
|
8283
8363
|
503: Error;
|
|
8364
|
+
/**
|
|
8365
|
+
* 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.
|
|
8366
|
+
*/
|
|
8367
|
+
504: Error;
|
|
8284
8368
|
};
|
|
8285
8369
|
type DraftsCreateError = DraftsCreateErrors[keyof DraftsCreateErrors];
|
|
8286
8370
|
type DraftsCreateResponses = {
|
|
@@ -8537,6 +8621,10 @@ type DraftsSendErrors = {
|
|
|
8537
8621
|
* Something this needs is not answering right now. Retry in a moment.
|
|
8538
8622
|
*/
|
|
8539
8623
|
503: Error;
|
|
8624
|
+
/**
|
|
8625
|
+
* 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.
|
|
8626
|
+
*/
|
|
8627
|
+
504: Error;
|
|
8540
8628
|
};
|
|
8541
8629
|
type DraftsSendError = DraftsSendErrors[keyof DraftsSendErrors];
|
|
8542
8630
|
type DraftsSendResponses = {
|
|
@@ -8649,6 +8737,10 @@ type DraftsScheduleErrors = {
|
|
|
8649
8737
|
* Something this needs is not answering right now. Retry in a moment.
|
|
8650
8738
|
*/
|
|
8651
8739
|
503: Error;
|
|
8740
|
+
/**
|
|
8741
|
+
* 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.
|
|
8742
|
+
*/
|
|
8743
|
+
504: Error;
|
|
8652
8744
|
};
|
|
8653
8745
|
type DraftsScheduleError = DraftsScheduleErrors[keyof DraftsScheduleErrors];
|
|
8654
8746
|
type DraftsScheduleResponses = {
|
|
@@ -8968,6 +9060,8 @@ declare const identitiesList: <ThrowOnError extends boolean = false>(options?: O
|
|
|
8968
9060
|
* Create an address
|
|
8969
9061
|
*
|
|
8970
9062
|
* Idempotent with an `Idempotency-Key` header: the same key returns the first result rather than creating a second address.
|
|
9063
|
+
*
|
|
9064
|
+
* Needs a key with admin over the account, or over its pod. A **test key** creates a test address (`test: true`): outside your plan’s counts, at most 100 at once, taking only test mail, and deleted a day after it was made.
|
|
8971
9065
|
*/
|
|
8972
9066
|
declare const identitiesCreate: <ThrowOnError extends boolean = false>(options: Options<IdentitiesCreateData, ThrowOnError>) => RequestResult<IdentitiesCreateResponses, IdentitiesCreateErrors, ThrowOnError>;
|
|
8973
9067
|
/**
|
|
@@ -9131,7 +9225,7 @@ declare const messagesListInThread: <ThrowOnError extends boolean = false>(optio
|
|
|
9131
9225
|
/**
|
|
9132
9226
|
* Send a message
|
|
9133
9227
|
*
|
|
9134
|
-
* 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.
|
|
9228
|
+
* 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.
|
|
9135
9229
|
*/
|
|
9136
9230
|
declare const messagesSend: <ThrowOnError extends boolean = false>(options: Options<MessagesSendData, ThrowOnError>) => RequestResult<MessagesSendResponses, MessagesSendErrors, ThrowOnError>;
|
|
9137
9231
|
/**
|