@pidgeon-ai/sdk 1.31.2 → 1.31.4

package/dist/index.d.cts

@@ -1218,7 +1218,7 @@ type SetupLink = {
     width: number | null;
     height: number | null;
     /**
-     * `provider` — that zone’s DNS provider does not support Domain Connect, which is the common case. `unconfigured` — it does, and this deployment is not registered as a service provider, which is ours to fix. Null when `supported` is true.
+     * `provider` — that zone’s DNS provider does not support Domain Connect, which is the common case, or has not approved Pidgeon’s template yet. `unconfigured` — it does, and this deployment has no key to sign the request with, which is ours to fix. Null when `supported` is true.
      */
     reason: 'provider' | 'unconfigured' | null;
 };
@@ -4208,7 +4208,7 @@ type MessagesAwaitData = {
          */
         include_unauthenticated?: 'true' | 'false';
         /**
-         * Only messages that arrived after this: the `cursor` a previous call returned, or `now`. Without it, the wait first looks back 2 minutes and returns the newest matching message from then, so a code that beat you to the call is not missed.
+         * Only messages that arrived after this: the `cursor` a previous call returned, or `now`. Without it, the wait first looks back 2 minutes and returns the newest matching message from then, so a code that beat you to the call is not missed. To wait for mail you are about to cause, take a cursor with `now` first.
          */
         after?: 'now' | string;
         timeout?: number;
@@ -9155,7 +9155,7 @@ declare const messagesUndo: <ThrowOnError extends boolean = false>(options: Opti
 /**
  * Wait for the next message
  *
- * Holds the request open until a message matching the filters arrives at the address, or `timeout` seconds pass — one call where you would otherwise poll. The message carries `extracted`: verification codes and links, most likely first. 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.
+ * 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.
  */
 declare const messagesAwait: <ThrowOnError extends boolean = false>(options: Options<MessagesAwaitData, ThrowOnError>) => RequestResult<MessagesAwaitResponses, MessagesAwaitErrors, ThrowOnError>;
 /**

package/dist/index.d.ts

@@ -1218,7 +1218,7 @@ type SetupLink = {
     width: number | null;
     height: number | null;
     /**
-     * `provider` — that zone’s DNS provider does not support Domain Connect, which is the common case. `unconfigured` — it does, and this deployment is not registered as a service provider, which is ours to fix. Null when `supported` is true.
+     * `provider` — that zone’s DNS provider does not support Domain Connect, which is the common case, or has not approved Pidgeon’s template yet. `unconfigured` — it does, and this deployment has no key to sign the request with, which is ours to fix. Null when `supported` is true.
      */
     reason: 'provider' | 'unconfigured' | null;
 };
@@ -4208,7 +4208,7 @@ type MessagesAwaitData = {
          */
         include_unauthenticated?: 'true' | 'false';
         /**
-         * Only messages that arrived after this: the `cursor` a previous call returned, or `now`. Without it, the wait first looks back 2 minutes and returns the newest matching message from then, so a code that beat you to the call is not missed.
+         * Only messages that arrived after this: the `cursor` a previous call returned, or `now`. Without it, the wait first looks back 2 minutes and returns the newest matching message from then, so a code that beat you to the call is not missed. To wait for mail you are about to cause, take a cursor with `now` first.
          */
         after?: 'now' | string;
         timeout?: number;
@@ -9155,7 +9155,7 @@ declare const messagesUndo: <ThrowOnError extends boolean = false>(options: Opti
 /**
  * Wait for the next message
  *
- * Holds the request open until a message matching the filters arrives at the address, or `timeout` seconds pass — one call where you would otherwise poll. The message carries `extracted`: verification codes and links, most likely first. 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.
+ * 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.
  */
 declare const messagesAwait: <ThrowOnError extends boolean = false>(options: Options<MessagesAwaitData, ThrowOnError>) => RequestResult<MessagesAwaitResponses, MessagesAwaitErrors, ThrowOnError>;
 /**