@pidgeon-ai/sdk 1.44.0 → 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
@@ -2370,7 +2370,11 @@ type AttachmentText = {
2370
2370
  */
2371
2371
  size: number;
2372
2372
  /**
2373
- * 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).
2374
2378
  */
2375
2379
  text: string;
2376
2380
  /**
@@ -10720,9 +10724,9 @@ declare const attachmentsCompleteUpload: <ThrowOnError extends boolean = false>(
10720
10724
  */
10721
10725
  declare const attachmentsDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<AttachmentsDownloadUrlData, ThrowOnError>) => RequestResult<AttachmentsDownloadUrlResponses, AttachmentsDownloadUrlErrors, ThrowOnError>;
10722
10726
  /**
10723
- * Read a text attachment
10727
+ * Read an attachment as text
10724
10728
  *
10725
- * 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.
10726
10730
  */
10727
10731
  declare const attachmentsText: <ThrowOnError extends boolean = false>(options: Options<AttachmentsTextData, ThrowOnError>) => RequestResult<AttachmentsTextResponses, AttachmentsTextErrors, ThrowOnError>;
10728
10732
 
package/dist/index.d.ts CHANGED
@@ -2370,7 +2370,11 @@ type AttachmentText = {
2370
2370
  */
2371
2371
  size: number;
2372
2372
  /**
2373
- * 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).
2374
2378
  */
2375
2379
  text: string;
2376
2380
  /**
@@ -10720,9 +10724,9 @@ declare const attachmentsCompleteUpload: <ThrowOnError extends boolean = false>(
10720
10724
  */
10721
10725
  declare const attachmentsDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<AttachmentsDownloadUrlData, ThrowOnError>) => RequestResult<AttachmentsDownloadUrlResponses, AttachmentsDownloadUrlErrors, ThrowOnError>;
10722
10726
  /**
10723
- * Read a text attachment
10727
+ * Read an attachment as text
10724
10728
  *
10725
- * 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.
10726
10730
  */
10727
10731
  declare const attachmentsText: <ThrowOnError extends boolean = false>(options: Options<AttachmentsTextData, ThrowOnError>) => RequestResult<AttachmentsTextResponses, AttachmentsTextErrors, ThrowOnError>;
10728
10732