@pidgeon-ai/sdk 1.46.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 +8 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +5 -1
- package/dist/index.d.ts +5 -1
- 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
|
*/
|
|
@@ -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
|
/**
|
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
|
*/
|
|
@@ -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
|
/**
|