@pidgeon-ai/sdk 1.43.0 → 1.43.1

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/dist/index.d.cts CHANGED
@@ -10236,9 +10236,9 @@ declare const messagesReplyAll: <ThrowOnError extends boolean = false>(options:
10236
10236
  */
10237
10237
  declare const messagesForward: <ThrowOnError extends boolean = false>(options: Options<MessagesForwardData, ThrowOnError>) => RequestResult<MessagesForwardResponses, MessagesForwardErrors, ThrowOnError>;
10238
10238
  /**
10239
- * The message as it arrived
10239
+ * The message as MIME
10240
10240
  *
10241
- * `message/rfc822`, not JSON — the point is bytes nobody re-encoded. Received mail is the archived original while it is kept; sent mail, and received mail past its retention, is rebuilt from the stored message. `X-Pidgeon-Reconstructed` says which: a rebuild is not the signed bytes and cannot verify DKIM.
10241
+ * `message/rfc822`, not JSON. An API key gets the message rebuilt from the stored message, with a canary token in its text (/docs/firewall): the original bytes cannot carry one, so `X-Pidgeon-Reconstructed` is `true` and a rebuild cannot verify DKIM. The message’s `authentication` is our check of the original’s signatures.
10242
10242
  */
10243
10243
  declare const messagesRaw: <ThrowOnError extends boolean = false>(options: Options<MessagesRawData, ThrowOnError>) => RequestResult<MessagesRawResponses, MessagesRawErrors, ThrowOnError>;
10244
10244
  /**
package/dist/index.d.ts CHANGED
@@ -10236,9 +10236,9 @@ declare const messagesReplyAll: <ThrowOnError extends boolean = false>(options:
10236
10236
  */
10237
10237
  declare const messagesForward: <ThrowOnError extends boolean = false>(options: Options<MessagesForwardData, ThrowOnError>) => RequestResult<MessagesForwardResponses, MessagesForwardErrors, ThrowOnError>;
10238
10238
  /**
10239
- * The message as it arrived
10239
+ * The message as MIME
10240
10240
  *
10241
- * `message/rfc822`, not JSON — the point is bytes nobody re-encoded. Received mail is the archived original while it is kept; sent mail, and received mail past its retention, is rebuilt from the stored message. `X-Pidgeon-Reconstructed` says which: a rebuild is not the signed bytes and cannot verify DKIM.
10241
+ * `message/rfc822`, not JSON. An API key gets the message rebuilt from the stored message, with a canary token in its text (/docs/firewall): the original bytes cannot carry one, so `X-Pidgeon-Reconstructed` is `true` and a rebuild cannot verify DKIM. The message’s `authentication` is our check of the original’s signatures.
10242
10242
  */
10243
10243
  declare const messagesRaw: <ThrowOnError extends boolean = false>(options: Options<MessagesRawData, ThrowOnError>) => RequestResult<MessagesRawResponses, MessagesRawErrors, ThrowOnError>;
10244
10244
  /**