@pidgeon-ai/sdk 1.45.0 → 1.47.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 +21 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +16 -12
- package/dist/index.d.ts +16 -12
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1015,6 +1015,10 @@ type AwaitedMessage = {
|
|
|
1015
1015
|
created_at: string;
|
|
1016
1016
|
} | null;
|
|
1017
1017
|
timed_out: boolean;
|
|
1018
|
+
/**
|
|
1019
|
+
* Only on `after: "now"` with `has_code: "true"` and `timeout` above 5: true when the message arrived up to 60 seconds before the call and no key had read it yet, so a code that beat your wait is still yours.
|
|
1020
|
+
*/
|
|
1021
|
+
looked_back?: boolean;
|
|
1018
1022
|
/**
|
|
1019
1023
|
* Pass as `after` on the next call, so a message arriving between two calls is not missed.
|
|
1020
1024
|
*/
|
|
@@ -4532,7 +4536,7 @@ type MessagesSendErrors = {
|
|
|
4532
4536
|
*/
|
|
4533
4537
|
401: Error;
|
|
4534
4538
|
/**
|
|
4535
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
4539
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
4536
4540
|
*/
|
|
4537
4541
|
403: Error;
|
|
4538
4542
|
/**
|
|
@@ -5032,7 +5036,7 @@ type MessagesReplyErrors = {
|
|
|
5032
5036
|
*/
|
|
5033
5037
|
401: Error;
|
|
5034
5038
|
/**
|
|
5035
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
5039
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
5036
5040
|
*/
|
|
5037
5041
|
403: Error;
|
|
5038
5042
|
/**
|
|
@@ -5132,7 +5136,7 @@ type MessagesReplyAllErrors = {
|
|
|
5132
5136
|
*/
|
|
5133
5137
|
401: Error;
|
|
5134
5138
|
/**
|
|
5135
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
5139
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
5136
5140
|
*/
|
|
5137
5141
|
403: Error;
|
|
5138
5142
|
/**
|
|
@@ -5232,7 +5236,7 @@ type MessagesForwardErrors = {
|
|
|
5232
5236
|
*/
|
|
5233
5237
|
401: Error;
|
|
5234
5238
|
/**
|
|
5235
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
5239
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
5236
5240
|
*/
|
|
5237
5241
|
403: Error;
|
|
5238
5242
|
/**
|
|
@@ -8203,7 +8207,7 @@ type MessagesRespondToInvitationErrors = {
|
|
|
8203
8207
|
*/
|
|
8204
8208
|
401: Error;
|
|
8205
8209
|
/**
|
|
8206
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8210
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8207
8211
|
*/
|
|
8208
8212
|
403: Error;
|
|
8209
8213
|
/**
|
|
@@ -8482,7 +8486,7 @@ type CalendarCreateEventErrors = {
|
|
|
8482
8486
|
*/
|
|
8483
8487
|
401: Error;
|
|
8484
8488
|
/**
|
|
8485
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8489
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8486
8490
|
*/
|
|
8487
8491
|
403: Error;
|
|
8488
8492
|
/**
|
|
@@ -8553,7 +8557,7 @@ type CalendarRespondToEventErrors = {
|
|
|
8553
8557
|
*/
|
|
8554
8558
|
401: Error;
|
|
8555
8559
|
/**
|
|
8556
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8560
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8557
8561
|
*/
|
|
8558
8562
|
403: Error;
|
|
8559
8563
|
/**
|
|
@@ -8765,7 +8769,7 @@ type CalendarDeleteEventErrors = {
|
|
|
8765
8769
|
*/
|
|
8766
8770
|
401: Error;
|
|
8767
8771
|
/**
|
|
8768
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8772
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8769
8773
|
*/
|
|
8770
8774
|
403: Error;
|
|
8771
8775
|
/**
|
|
@@ -8923,7 +8927,7 @@ type CalendarUpdateEventErrors = {
|
|
|
8923
8927
|
*/
|
|
8924
8928
|
401: Error;
|
|
8925
8929
|
/**
|
|
8926
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8930
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8927
8931
|
*/
|
|
8928
8932
|
403: Error;
|
|
8929
8933
|
/**
|
|
@@ -9383,7 +9387,7 @@ type DraftsSendErrors = {
|
|
|
9383
9387
|
*/
|
|
9384
9388
|
401: Error;
|
|
9385
9389
|
/**
|
|
9386
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
9390
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
9387
9391
|
*/
|
|
9388
9392
|
403: Error;
|
|
9389
9393
|
/**
|
|
@@ -10246,7 +10250,7 @@ declare const messagesUndo: <ThrowOnError extends boolean = false>(options: Opti
|
|
|
10246
10250
|
/**
|
|
10247
10251
|
* Wait for the next message
|
|
10248
10252
|
*
|
|
10249
|
-
* 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. To wait for mail you are about to cause, take a cursor first: call with `after=now&timeout=1`, keep the `cursor`, submit the form or send, then wait with that cursor as `after`, so the mail cannot arrive before the wait starts. 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. A message matches `from` only when it passed DMARC, because anybody can write a `From:`; one that did not is counted in `held_back.unauthenticated`, and `include_unauthenticated=true` returns it.
|
|
10253
|
+
* 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. To wait for mail you are about to cause, take a cursor first: call with `after=now&timeout=1`, keep the `cursor`, submit the form or send, then wait with that cursor as `after`, so the mail cannot arrive before the wait starts. 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. With `after=now`, `has_code=true` and a `timeout` above 5, it also takes a code that arrived up to 60 seconds before the call and that no key has read, and says so with `looked_back: true`: a code that beat the wait is not lost. 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. A message matches `from` only when it passed DMARC, because anybody can write a `From:`; one that did not is counted in `held_back.unauthenticated`, and `include_unauthenticated=true` returns it.
|
|
10250
10254
|
*/
|
|
10251
10255
|
declare const messagesAwait: <ThrowOnError extends boolean = false>(options: Options<MessagesAwaitData, ThrowOnError>) => RequestResult<MessagesAwaitResponses, MessagesAwaitErrors, ThrowOnError>;
|
|
10252
10256
|
/**
|
|
@@ -10304,7 +10308,7 @@ declare const threadsGet: <ThrowOnError extends boolean = false>(options: Option
|
|
|
10304
10308
|
/**
|
|
10305
10309
|
* Update a thread
|
|
10306
10310
|
*
|
|
10307
|
-
* Its status and who owns it — the state a conversation carries. Handing it to a person notifies them: the assignee if you name one, otherwise everybody who can answer as the address. `reason` is shown in that notification.
|
|
10311
|
+
* Its status and who owns it — the state a conversation carries. Handing it to a person notifies them: the assignee if you name one, otherwise everybody who can answer as the address. `reason` is shown in that notification. While a person has the conversation (it is `human` with an assignee, or in `human_review`), a key may not set `owner_type` to anything else: `403 taken_over`. The person hands it back.
|
|
10308
10312
|
*/
|
|
10309
10313
|
declare const threadsUpdate: <ThrowOnError extends boolean = false>(options: Options<ThreadsUpdateData, ThrowOnError>) => RequestResult<ThreadsUpdateResponses, ThreadsUpdateErrors, ThrowOnError>;
|
|
10310
10314
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -1015,6 +1015,10 @@ type AwaitedMessage = {
|
|
|
1015
1015
|
created_at: string;
|
|
1016
1016
|
} | null;
|
|
1017
1017
|
timed_out: boolean;
|
|
1018
|
+
/**
|
|
1019
|
+
* Only on `after: "now"` with `has_code: "true"` and `timeout` above 5: true when the message arrived up to 60 seconds before the call and no key had read it yet, so a code that beat your wait is still yours.
|
|
1020
|
+
*/
|
|
1021
|
+
looked_back?: boolean;
|
|
1018
1022
|
/**
|
|
1019
1023
|
* Pass as `after` on the next call, so a message arriving between two calls is not missed.
|
|
1020
1024
|
*/
|
|
@@ -4532,7 +4536,7 @@ type MessagesSendErrors = {
|
|
|
4532
4536
|
*/
|
|
4533
4537
|
401: Error;
|
|
4534
4538
|
/**
|
|
4535
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
4539
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
4536
4540
|
*/
|
|
4537
4541
|
403: Error;
|
|
4538
4542
|
/**
|
|
@@ -5032,7 +5036,7 @@ type MessagesReplyErrors = {
|
|
|
5032
5036
|
*/
|
|
5033
5037
|
401: Error;
|
|
5034
5038
|
/**
|
|
5035
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
5039
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
5036
5040
|
*/
|
|
5037
5041
|
403: Error;
|
|
5038
5042
|
/**
|
|
@@ -5132,7 +5136,7 @@ type MessagesReplyAllErrors = {
|
|
|
5132
5136
|
*/
|
|
5133
5137
|
401: Error;
|
|
5134
5138
|
/**
|
|
5135
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
5139
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
5136
5140
|
*/
|
|
5137
5141
|
403: Error;
|
|
5138
5142
|
/**
|
|
@@ -5232,7 +5236,7 @@ type MessagesForwardErrors = {
|
|
|
5232
5236
|
*/
|
|
5233
5237
|
401: Error;
|
|
5234
5238
|
/**
|
|
5235
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
5239
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
5236
5240
|
*/
|
|
5237
5241
|
403: Error;
|
|
5238
5242
|
/**
|
|
@@ -8203,7 +8207,7 @@ type MessagesRespondToInvitationErrors = {
|
|
|
8203
8207
|
*/
|
|
8204
8208
|
401: Error;
|
|
8205
8209
|
/**
|
|
8206
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8210
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8207
8211
|
*/
|
|
8208
8212
|
403: Error;
|
|
8209
8213
|
/**
|
|
@@ -8482,7 +8486,7 @@ type CalendarCreateEventErrors = {
|
|
|
8482
8486
|
*/
|
|
8483
8487
|
401: Error;
|
|
8484
8488
|
/**
|
|
8485
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8489
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8486
8490
|
*/
|
|
8487
8491
|
403: Error;
|
|
8488
8492
|
/**
|
|
@@ -8553,7 +8557,7 @@ type CalendarRespondToEventErrors = {
|
|
|
8553
8557
|
*/
|
|
8554
8558
|
401: Error;
|
|
8555
8559
|
/**
|
|
8556
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8560
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8557
8561
|
*/
|
|
8558
8562
|
403: Error;
|
|
8559
8563
|
/**
|
|
@@ -8765,7 +8769,7 @@ type CalendarDeleteEventErrors = {
|
|
|
8765
8769
|
*/
|
|
8766
8770
|
401: Error;
|
|
8767
8771
|
/**
|
|
8768
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8772
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8769
8773
|
*/
|
|
8770
8774
|
403: Error;
|
|
8771
8775
|
/**
|
|
@@ -8923,7 +8927,7 @@ type CalendarUpdateEventErrors = {
|
|
|
8923
8927
|
*/
|
|
8924
8928
|
401: Error;
|
|
8925
8929
|
/**
|
|
8926
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8930
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
8927
8931
|
*/
|
|
8928
8932
|
403: Error;
|
|
8929
8933
|
/**
|
|
@@ -9383,7 +9387,7 @@ type DraftsSendErrors = {
|
|
|
9383
9387
|
*/
|
|
9384
9388
|
401: Error;
|
|
9385
9389
|
/**
|
|
9386
|
-
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
9390
|
+
* Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
|
|
9387
9391
|
*/
|
|
9388
9392
|
403: Error;
|
|
9389
9393
|
/**
|
|
@@ -10246,7 +10250,7 @@ declare const messagesUndo: <ThrowOnError extends boolean = false>(options: Opti
|
|
|
10246
10250
|
/**
|
|
10247
10251
|
* Wait for the next message
|
|
10248
10252
|
*
|
|
10249
|
-
* 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. To wait for mail you are about to cause, take a cursor first: call with `after=now&timeout=1`, keep the `cursor`, submit the form or send, then wait with that cursor as `after`, so the mail cannot arrive before the wait starts. 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. A message matches `from` only when it passed DMARC, because anybody can write a `From:`; one that did not is counted in `held_back.unauthenticated`, and `include_unauthenticated=true` returns it.
|
|
10253
|
+
* 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. To wait for mail you are about to cause, take a cursor first: call with `after=now&timeout=1`, keep the `cursor`, submit the form or send, then wait with that cursor as `after`, so the mail cannot arrive before the wait starts. 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. With `after=now`, `has_code=true` and a `timeout` above 5, it also takes a code that arrived up to 60 seconds before the call and that no key has read, and says so with `looked_back: true`: a code that beat the wait is not lost. 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. A message matches `from` only when it passed DMARC, because anybody can write a `From:`; one that did not is counted in `held_back.unauthenticated`, and `include_unauthenticated=true` returns it.
|
|
10250
10254
|
*/
|
|
10251
10255
|
declare const messagesAwait: <ThrowOnError extends boolean = false>(options: Options<MessagesAwaitData, ThrowOnError>) => RequestResult<MessagesAwaitResponses, MessagesAwaitErrors, ThrowOnError>;
|
|
10252
10256
|
/**
|
|
@@ -10304,7 +10308,7 @@ declare const threadsGet: <ThrowOnError extends boolean = false>(options: Option
|
|
|
10304
10308
|
/**
|
|
10305
10309
|
* Update a thread
|
|
10306
10310
|
*
|
|
10307
|
-
* Its status and who owns it — the state a conversation carries. Handing it to a person notifies them: the assignee if you name one, otherwise everybody who can answer as the address. `reason` is shown in that notification.
|
|
10311
|
+
* Its status and who owns it — the state a conversation carries. Handing it to a person notifies them: the assignee if you name one, otherwise everybody who can answer as the address. `reason` is shown in that notification. While a person has the conversation (it is `human` with an assignee, or in `human_review`), a key may not set `owner_type` to anything else: `403 taken_over`. The person hands it back.
|
|
10308
10312
|
*/
|
|
10309
10313
|
declare const threadsUpdate: <ThrowOnError extends boolean = false>(options: Options<ThreadsUpdateData, ThrowOnError>) => RequestResult<ThreadsUpdateResponses, ThreadsUpdateErrors, ThrowOnError>;
|
|
10310
10314
|
/**
|