@pidgeon-ai/sdk 1.43.0 → 1.44.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 +18 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +42 -4
- package/dist/index.d.ts +42 -4
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -686,7 +686,7 @@ type Message = {
|
|
|
686
686
|
version: number;
|
|
687
687
|
} | null;
|
|
688
688
|
/**
|
|
689
|
-
* Verification codes and links found in the message, most likely first — read from the new text, never the quoted history. Empty lists when nothing was found.
|
|
689
|
+
* Verification codes and links found in the message, most likely first — read from the new text, never the quoted history — and the original inside a forward. Empty lists when nothing was found.
|
|
690
690
|
*/
|
|
691
691
|
extracted: {
|
|
692
692
|
/**
|
|
@@ -717,6 +717,25 @@ type Message = {
|
|
|
717
717
|
*/
|
|
718
718
|
text: string | null;
|
|
719
719
|
}>;
|
|
720
|
+
/**
|
|
721
|
+
* The email somebody forwarded, when this message is an inline forward (Gmail, Apple Mail or Outlook, in English or German): `from` here is the original sender, where the message’s own `from` is the person who forwarded it. `null` when this is not a forward, or the original names no sender address. With `body=clean`, `null` when the Firewall found the message suspicious.
|
|
722
|
+
*/
|
|
723
|
+
forwarded: {
|
|
724
|
+
/**
|
|
725
|
+
* The original sender’s address, lower-cased.
|
|
726
|
+
*/
|
|
727
|
+
from: string;
|
|
728
|
+
from_name: string | null;
|
|
729
|
+
/**
|
|
730
|
+
* As the forwarding client printed it, not parsed.
|
|
731
|
+
*/
|
|
732
|
+
date: string | null;
|
|
733
|
+
subject: string | null;
|
|
734
|
+
/**
|
|
735
|
+
* The original’s text, without its header block.
|
|
736
|
+
*/
|
|
737
|
+
text: string;
|
|
738
|
+
} | null;
|
|
720
739
|
};
|
|
721
740
|
/**
|
|
722
741
|
* ISO-8601, UTC.
|
|
@@ -939,7 +958,7 @@ type AwaitedMessage = {
|
|
|
939
958
|
version: number;
|
|
940
959
|
} | null;
|
|
941
960
|
/**
|
|
942
|
-
* Verification codes and links found in the message, most likely first — read from the new text, never the quoted history. Empty lists when nothing was found.
|
|
961
|
+
* Verification codes and links found in the message, most likely first — read from the new text, never the quoted history — and the original inside a forward. Empty lists when nothing was found.
|
|
943
962
|
*/
|
|
944
963
|
extracted: {
|
|
945
964
|
/**
|
|
@@ -970,6 +989,25 @@ type AwaitedMessage = {
|
|
|
970
989
|
*/
|
|
971
990
|
text: string | null;
|
|
972
991
|
}>;
|
|
992
|
+
/**
|
|
993
|
+
* The email somebody forwarded, when this message is an inline forward (Gmail, Apple Mail or Outlook, in English or German): `from` here is the original sender, where the message’s own `from` is the person who forwarded it. `null` when this is not a forward, or the original names no sender address. With `body=clean`, `null` when the Firewall found the message suspicious.
|
|
994
|
+
*/
|
|
995
|
+
forwarded: {
|
|
996
|
+
/**
|
|
997
|
+
* The original sender’s address, lower-cased.
|
|
998
|
+
*/
|
|
999
|
+
from: string;
|
|
1000
|
+
from_name: string | null;
|
|
1001
|
+
/**
|
|
1002
|
+
* As the forwarding client printed it, not parsed.
|
|
1003
|
+
*/
|
|
1004
|
+
date: string | null;
|
|
1005
|
+
subject: string | null;
|
|
1006
|
+
/**
|
|
1007
|
+
* The original’s text, without its header block.
|
|
1008
|
+
*/
|
|
1009
|
+
text: string;
|
|
1010
|
+
} | null;
|
|
973
1011
|
};
|
|
974
1012
|
/**
|
|
975
1013
|
* ISO-8601, UTC.
|
|
@@ -10236,9 +10274,9 @@ declare const messagesReplyAll: <ThrowOnError extends boolean = false>(options:
|
|
|
10236
10274
|
*/
|
|
10237
10275
|
declare const messagesForward: <ThrowOnError extends boolean = false>(options: Options<MessagesForwardData, ThrowOnError>) => RequestResult<MessagesForwardResponses, MessagesForwardErrors, ThrowOnError>;
|
|
10238
10276
|
/**
|
|
10239
|
-
* The message as
|
|
10277
|
+
* The message as MIME
|
|
10240
10278
|
*
|
|
10241
|
-
* `message/rfc822`, not JSON
|
|
10279
|
+
* `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
10280
|
*/
|
|
10243
10281
|
declare const messagesRaw: <ThrowOnError extends boolean = false>(options: Options<MessagesRawData, ThrowOnError>) => RequestResult<MessagesRawResponses, MessagesRawErrors, ThrowOnError>;
|
|
10244
10282
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -686,7 +686,7 @@ type Message = {
|
|
|
686
686
|
version: number;
|
|
687
687
|
} | null;
|
|
688
688
|
/**
|
|
689
|
-
* Verification codes and links found in the message, most likely first — read from the new text, never the quoted history. Empty lists when nothing was found.
|
|
689
|
+
* Verification codes and links found in the message, most likely first — read from the new text, never the quoted history — and the original inside a forward. Empty lists when nothing was found.
|
|
690
690
|
*/
|
|
691
691
|
extracted: {
|
|
692
692
|
/**
|
|
@@ -717,6 +717,25 @@ type Message = {
|
|
|
717
717
|
*/
|
|
718
718
|
text: string | null;
|
|
719
719
|
}>;
|
|
720
|
+
/**
|
|
721
|
+
* The email somebody forwarded, when this message is an inline forward (Gmail, Apple Mail or Outlook, in English or German): `from` here is the original sender, where the message’s own `from` is the person who forwarded it. `null` when this is not a forward, or the original names no sender address. With `body=clean`, `null` when the Firewall found the message suspicious.
|
|
722
|
+
*/
|
|
723
|
+
forwarded: {
|
|
724
|
+
/**
|
|
725
|
+
* The original sender’s address, lower-cased.
|
|
726
|
+
*/
|
|
727
|
+
from: string;
|
|
728
|
+
from_name: string | null;
|
|
729
|
+
/**
|
|
730
|
+
* As the forwarding client printed it, not parsed.
|
|
731
|
+
*/
|
|
732
|
+
date: string | null;
|
|
733
|
+
subject: string | null;
|
|
734
|
+
/**
|
|
735
|
+
* The original’s text, without its header block.
|
|
736
|
+
*/
|
|
737
|
+
text: string;
|
|
738
|
+
} | null;
|
|
720
739
|
};
|
|
721
740
|
/**
|
|
722
741
|
* ISO-8601, UTC.
|
|
@@ -939,7 +958,7 @@ type AwaitedMessage = {
|
|
|
939
958
|
version: number;
|
|
940
959
|
} | null;
|
|
941
960
|
/**
|
|
942
|
-
* Verification codes and links found in the message, most likely first — read from the new text, never the quoted history. Empty lists when nothing was found.
|
|
961
|
+
* Verification codes and links found in the message, most likely first — read from the new text, never the quoted history — and the original inside a forward. Empty lists when nothing was found.
|
|
943
962
|
*/
|
|
944
963
|
extracted: {
|
|
945
964
|
/**
|
|
@@ -970,6 +989,25 @@ type AwaitedMessage = {
|
|
|
970
989
|
*/
|
|
971
990
|
text: string | null;
|
|
972
991
|
}>;
|
|
992
|
+
/**
|
|
993
|
+
* The email somebody forwarded, when this message is an inline forward (Gmail, Apple Mail or Outlook, in English or German): `from` here is the original sender, where the message’s own `from` is the person who forwarded it. `null` when this is not a forward, or the original names no sender address. With `body=clean`, `null` when the Firewall found the message suspicious.
|
|
994
|
+
*/
|
|
995
|
+
forwarded: {
|
|
996
|
+
/**
|
|
997
|
+
* The original sender’s address, lower-cased.
|
|
998
|
+
*/
|
|
999
|
+
from: string;
|
|
1000
|
+
from_name: string | null;
|
|
1001
|
+
/**
|
|
1002
|
+
* As the forwarding client printed it, not parsed.
|
|
1003
|
+
*/
|
|
1004
|
+
date: string | null;
|
|
1005
|
+
subject: string | null;
|
|
1006
|
+
/**
|
|
1007
|
+
* The original’s text, without its header block.
|
|
1008
|
+
*/
|
|
1009
|
+
text: string;
|
|
1010
|
+
} | null;
|
|
973
1011
|
};
|
|
974
1012
|
/**
|
|
975
1013
|
* ISO-8601, UTC.
|
|
@@ -10236,9 +10274,9 @@ declare const messagesReplyAll: <ThrowOnError extends boolean = false>(options:
|
|
|
10236
10274
|
*/
|
|
10237
10275
|
declare const messagesForward: <ThrowOnError extends boolean = false>(options: Options<MessagesForwardData, ThrowOnError>) => RequestResult<MessagesForwardResponses, MessagesForwardErrors, ThrowOnError>;
|
|
10238
10276
|
/**
|
|
10239
|
-
* The message as
|
|
10277
|
+
* The message as MIME
|
|
10240
10278
|
*
|
|
10241
|
-
* `message/rfc822`, not JSON
|
|
10279
|
+
* `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
10280
|
*/
|
|
10243
10281
|
declare const messagesRaw: <ThrowOnError extends boolean = false>(options: Options<MessagesRawData, ThrowOnError>) => RequestResult<MessagesRawResponses, MessagesRawErrors, ThrowOnError>;
|
|
10244
10282
|
/**
|