@pidgeon-ai/sdk 1.50.0 → 1.51.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
@@ -657,7 +657,7 @@ type Identity = {
657
657
  */
658
658
  receive_policy: string;
659
659
  /**
660
- * Minutes before a send that is not a reply may go to somebody this address just wrote to; sooner is refused `429 recipient_cooldown`. 0 is off. Default 10.
660
+ * The window in minutes in which this address sends one person at most three messages that are not replies; the fourth is refused `429 recipient_cooldown`. 0 is off. Default 10.
661
661
  */
662
662
  recipient_cooldown_minutes: number;
663
663
  /**
@@ -2477,7 +2477,7 @@ type PodCreated = {
2477
2477
  */
2478
2478
  receive_policy: string;
2479
2479
  /**
2480
- * Minutes before a send that is not a reply may go to somebody this address just wrote to; sooner is refused `429 recipient_cooldown`. 0 is off. Default 10.
2480
+ * The window in minutes in which this address sends one person at most three messages that are not replies; the fourth is refused `429 recipient_cooldown`. 0 is off. Default 10.
2481
2481
  */
2482
2482
  recipient_cooldown_minutes: number;
2483
2483
  /**
@@ -3243,7 +3243,7 @@ type IdentitiesUpdateData = {
3243
3243
  */
3244
3244
  receive_policy?: 'open' | 'list';
3245
3245
  /**
3246
- * Minutes before a send that is not a reply may go to somebody this address just wrote to (`429 recipient_cooldown`). 0 turns it off; at most 1440. Default 10. A key with admin on the address may lengthen it; shortening it or turning it off needs its owner.
3246
+ * The window in minutes in which this address sends one person at most three messages that are not replies; the fourth is `429 recipient_cooldown`. 0 turns it off; at most 1440. Default 10. A key with admin on the address may lengthen it; shortening it or turning it off needs its owner.
3247
3247
  */
3248
3248
  recipient_cooldown_minutes?: number;
3249
3249
  /**
@@ -5717,7 +5717,12 @@ type MessagesRawData = {
5717
5717
  path: {
5718
5718
  id: string;
5719
5719
  };
5720
- query?: never;
5720
+ query?: {
5721
+ /**
5722
+ * original: only the header section of the message as it arrived, with no body, so its DKIM signatures (the agent declaration’s among them) can be checked, as /verify does. 404 when the original is no longer kept.
5723
+ */
5724
+ headers?: 'original';
5725
+ };
5721
5726
  url: '/messages/{id}/raw';
5722
5727
  };
5723
5728
  type MessagesRawErrors = {
@@ -10740,7 +10745,7 @@ declare const messagesForward: <ThrowOnError extends boolean = false>(options: O
10740
10745
  /**
10741
10746
  * The message as MIME
10742
10747
  *
10743
- * `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.
10748
+ * `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. `headers=original` returns only the original’s header section, for any caller: the signed agent declaration, checkable as /verify checks it, with no body to stamp.
10744
10749
  */
10745
10750
  declare const messagesRaw: <ThrowOnError extends boolean = false>(options: Options<MessagesRawData, ThrowOnError>) => RequestResult<MessagesRawResponses, MessagesRawErrors, ThrowOnError>;
10746
10751
  /**
package/dist/index.d.ts CHANGED
@@ -657,7 +657,7 @@ type Identity = {
657
657
  */
658
658
  receive_policy: string;
659
659
  /**
660
- * Minutes before a send that is not a reply may go to somebody this address just wrote to; sooner is refused `429 recipient_cooldown`. 0 is off. Default 10.
660
+ * The window in minutes in which this address sends one person at most three messages that are not replies; the fourth is refused `429 recipient_cooldown`. 0 is off. Default 10.
661
661
  */
662
662
  recipient_cooldown_minutes: number;
663
663
  /**
@@ -2477,7 +2477,7 @@ type PodCreated = {
2477
2477
  */
2478
2478
  receive_policy: string;
2479
2479
  /**
2480
- * Minutes before a send that is not a reply may go to somebody this address just wrote to; sooner is refused `429 recipient_cooldown`. 0 is off. Default 10.
2480
+ * The window in minutes in which this address sends one person at most three messages that are not replies; the fourth is refused `429 recipient_cooldown`. 0 is off. Default 10.
2481
2481
  */
2482
2482
  recipient_cooldown_minutes: number;
2483
2483
  /**
@@ -3243,7 +3243,7 @@ type IdentitiesUpdateData = {
3243
3243
  */
3244
3244
  receive_policy?: 'open' | 'list';
3245
3245
  /**
3246
- * Minutes before a send that is not a reply may go to somebody this address just wrote to (`429 recipient_cooldown`). 0 turns it off; at most 1440. Default 10. A key with admin on the address may lengthen it; shortening it or turning it off needs its owner.
3246
+ * The window in minutes in which this address sends one person at most three messages that are not replies; the fourth is `429 recipient_cooldown`. 0 turns it off; at most 1440. Default 10. A key with admin on the address may lengthen it; shortening it or turning it off needs its owner.
3247
3247
  */
3248
3248
  recipient_cooldown_minutes?: number;
3249
3249
  /**
@@ -5717,7 +5717,12 @@ type MessagesRawData = {
5717
5717
  path: {
5718
5718
  id: string;
5719
5719
  };
5720
- query?: never;
5720
+ query?: {
5721
+ /**
5722
+ * original: only the header section of the message as it arrived, with no body, so its DKIM signatures (the agent declaration’s among them) can be checked, as /verify does. 404 when the original is no longer kept.
5723
+ */
5724
+ headers?: 'original';
5725
+ };
5721
5726
  url: '/messages/{id}/raw';
5722
5727
  };
5723
5728
  type MessagesRawErrors = {
@@ -10740,7 +10745,7 @@ declare const messagesForward: <ThrowOnError extends boolean = false>(options: O
10740
10745
  /**
10741
10746
  * The message as MIME
10742
10747
  *
10743
- * `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.
10748
+ * `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. `headers=original` returns only the original’s header section, for any caller: the signed agent declaration, checkable as /verify checks it, with no body to stamp.
10744
10749
  */
10745
10750
  declare const messagesRaw: <ThrowOnError extends boolean = false>(options: Options<MessagesRawData, ThrowOnError>) => RequestResult<MessagesRawResponses, MessagesRawErrors, ThrowOnError>;
10746
10751
  /**