@pidgeon-ai/sdk 1.43.1 → 1.45.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/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.
@@ -2332,7 +2370,11 @@ type AttachmentText = {
2332
2370
  */
2333
2371
  size: number;
2334
2372
  /**
2335
- * The file as text. With `body=clean`, hidden characters removed and lines posing as a chat turn marked, under a first line saying what changed.
2373
+ * How it was read. `pdf`: the text layer, a form feed between pages. `docx`: headers, body and footers, table rows tab-separated; footnotes and comments left out. `xlsx`: each sheet as `## Sheet: <name>` and CSV, dates as Excel serial numbers.
2374
+ */
2375
+ format: 'text' | 'pdf' | 'docx' | 'xlsx';
2376
+ /**
2377
+ * The file as text. With `body=clean`, hidden characters removed and lines posing as a chat turn marked, under a first line saying what changed; for a document, also what it hid from a person opening it (a hidden Word run, a hidden sheet, row or column).
2336
2378
  */
2337
2379
  text: string;
2338
2380
  /**
@@ -10682,9 +10724,9 @@ declare const attachmentsCompleteUpload: <ThrowOnError extends boolean = false>(
10682
10724
  */
10683
10725
  declare const attachmentsDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<AttachmentsDownloadUrlData, ThrowOnError>) => RequestResult<AttachmentsDownloadUrlResponses, AttachmentsDownloadUrlErrors, ThrowOnError>;
10684
10726
  /**
10685
- * Read a text attachment
10727
+ * Read an attachment as text
10686
10728
  *
10687
- * A CSV, a log, JSON or another text format, as text — up to 5 MB, and the first 200,000 characters of it. Screened by Pidgeon Firewall with the sender of the message it came with, because a file in an email is mail a model reads: `firewall` says whether it tries to steer you, and `body=clean` returns it with hidden characters removed and lines posing as a chat turn marked. HTML, PDF, Office files and images are refused; `GET /attachments/{id}` gives a link to those.
10729
+ * A CSV, a log, JSON or another text format (up to 5 MB), or a PDF, a `.docx` or an `.xlsx` (up to 10 MB), as text: the first 200,000 characters of it. Screened by Pidgeon Firewall with the sender of the message it came with, because a file in an email is mail a model reads: `firewall` says whether it tries to steer you, and `body=clean` returns it with hidden content removed. Text a document hides from a person (a hidden Word run, a hidden sheet, row or column) counts as hidden text. Where the address holds suspicious mail, a flagged attachment holds its message, and a key is answered `403 held`. A scanned or password-protected PDF, `.doc`, `.xls`, PowerPoint, HTML and images are refused; `GET /attachments/{id}` gives a link to those.
10688
10730
  */
10689
10731
  declare const attachmentsText: <ThrowOnError extends boolean = false>(options: Options<AttachmentsTextData, ThrowOnError>) => RequestResult<AttachmentsTextResponses, AttachmentsTextErrors, ThrowOnError>;
10690
10732
 
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.
@@ -2332,7 +2370,11 @@ type AttachmentText = {
2332
2370
  */
2333
2371
  size: number;
2334
2372
  /**
2335
- * The file as text. With `body=clean`, hidden characters removed and lines posing as a chat turn marked, under a first line saying what changed.
2373
+ * How it was read. `pdf`: the text layer, a form feed between pages. `docx`: headers, body and footers, table rows tab-separated; footnotes and comments left out. `xlsx`: each sheet as `## Sheet: <name>` and CSV, dates as Excel serial numbers.
2374
+ */
2375
+ format: 'text' | 'pdf' | 'docx' | 'xlsx';
2376
+ /**
2377
+ * The file as text. With `body=clean`, hidden characters removed and lines posing as a chat turn marked, under a first line saying what changed; for a document, also what it hid from a person opening it (a hidden Word run, a hidden sheet, row or column).
2336
2378
  */
2337
2379
  text: string;
2338
2380
  /**
@@ -10682,9 +10724,9 @@ declare const attachmentsCompleteUpload: <ThrowOnError extends boolean = false>(
10682
10724
  */
10683
10725
  declare const attachmentsDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<AttachmentsDownloadUrlData, ThrowOnError>) => RequestResult<AttachmentsDownloadUrlResponses, AttachmentsDownloadUrlErrors, ThrowOnError>;
10684
10726
  /**
10685
- * Read a text attachment
10727
+ * Read an attachment as text
10686
10728
  *
10687
- * A CSV, a log, JSON or another text format, as text — up to 5 MB, and the first 200,000 characters of it. Screened by Pidgeon Firewall with the sender of the message it came with, because a file in an email is mail a model reads: `firewall` says whether it tries to steer you, and `body=clean` returns it with hidden characters removed and lines posing as a chat turn marked. HTML, PDF, Office files and images are refused; `GET /attachments/{id}` gives a link to those.
10729
+ * A CSV, a log, JSON or another text format (up to 5 MB), or a PDF, a `.docx` or an `.xlsx` (up to 10 MB), as text: the first 200,000 characters of it. Screened by Pidgeon Firewall with the sender of the message it came with, because a file in an email is mail a model reads: `firewall` says whether it tries to steer you, and `body=clean` returns it with hidden content removed. Text a document hides from a person (a hidden Word run, a hidden sheet, row or column) counts as hidden text. Where the address holds suspicious mail, a flagged attachment holds its message, and a key is answered `403 held`. A scanned or password-protected PDF, `.doc`, `.xls`, PowerPoint, HTML and images are refused; `GET /attachments/{id}` gives a link to those.
10688
10730
  */
10689
10731
  declare const attachmentsText: <ThrowOnError extends boolean = false>(options: Options<AttachmentsTextData, ThrowOnError>) => RequestResult<AttachmentsTextResponses, AttachmentsTextErrors, ThrowOnError>;
10690
10732