pulse-ts-sdk 1.0.8 → 1.0.10

package/dist/cjs/api/resources/results/client/requests/GetPdfResultsRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         jobId: "jobId"
+ *     }
+ */
+export interface GetPdfResultsRequest {
+    /** Job identifier from a form endpoint. */
+    jobId: string;
+}

package/dist/cjs/api/resources/results/client/requests/GetPdfResultsRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/results/client/requests/index.d.ts

@@ -0,0 +1 @@
+export type { GetPdfResultsRequest } from "./GetPdfResultsRequest.js";

package/dist/cjs/api/resources/results/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/results/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/dist/cjs/api/resources/results/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/webhooks/client/Client.js

@@ -71,7 +71,7 @@ class WebhooksClient {
     }
     __createWebhookLink(requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            var _a, _b, _c, _d, _e, _f, _g, _h;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
@@ -79,10 +79,14 @@ class WebhooksClient {
                 method: "POST",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
+                    ? requestOptions.timeoutInSeconds * 1000
+                    : ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
+                        ? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
+                        : undefined,
+                maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {

package/dist/cjs/api/types/AsyncSubmissionResponse.d.ts

@@ -10,6 +10,8 @@ export interface AsyncSubmissionResponse {
     message?: string;
     /** **Deprecated** — Timestamp indicating when the job was accepted. Retained for backward compatibility. Use `GET /job/{jobId}` for timing details. */
     queuedAt?: string;
+    /** Number of credits consumed by this request. Only present when the organization has the credit billing system enabled. */
+    credits_used?: number | null;
 }
 export declare namespace AsyncSubmissionResponse {
     /** Initial status reported by the server. */

package/dist/cjs/api/types/ExtractInput.d.ts

@@ -6,7 +6,7 @@ export interface ExtractInput {
     file?: string;
     /** Public or pre-signed URL that Pulse will download and extract. Required unless file is provided. */
     fileUrl?: string;
-    /** Extraction model to use. When set to `enterprise-preview`, routes the request through Pulse's self-hosted VPC extraction model instead of the default cloud-based service. If omitted or set to any other value, the default model is used. */
+    /** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
     model?: ExtractInput.Model;
     /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
     pages?: string;
@@ -14,6 +14,8 @@ export interface ExtractInput {
     figureProcessing?: ExtractInput.FigureProcessing;
     /** Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`. */
     extensions?: ExtractInput.Extensions;
+    /** Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names. */
+    spreadsheet?: ExtractInput.Spreadsheet;
     /** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
     storage?: ExtractInput.Storage;
     /** If true, returns immediately with a job_id for polling via GET /job/{jobId}. Otherwise processes synchronously. */
@@ -42,9 +44,10 @@ export interface ExtractInput {
     thinking?: boolean;
 }
 export declare namespace ExtractInput {
-    /** Extraction model to use. When set to `enterprise-preview`, routes the request through Pulse's self-hosted VPC extraction model instead of the default cloud-based service. If omitted or set to any other value, the default model is used. */
+    /** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
     const Model: {
-        readonly EnterprisePreview: "enterprise-preview";
+        readonly Default: "default";
+        readonly PulseUltra2: "pulse-ultra-2";
     };
     type Model = (typeof Model)[keyof typeof Model];
     /**
@@ -60,8 +63,6 @@ export declare namespace ExtractInput {
      * Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`.
      */
     interface Extensions {
-        /** Merge tables that span multiple pages into a single table. */
-        mergeTables?: boolean;
         /** Link footnote markers to their corresponding footnote text. */
         footnoteReferences?: boolean;
         /** Chunking configuration. When provided, the document is split into chunks using the specified strategies. Results appear in `response.extensions.chunking`. */
@@ -103,6 +104,17 @@ export declare namespace ExtractInput {
             returnXml?: boolean;
         }
     }
+    /**
+     * Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names.
+     */
+    interface Spreadsheet {
+        /** Include rows that are hidden in the Excel workbook. */
+        includeHiddenRows?: boolean;
+        /** Include columns that are hidden in the Excel workbook. */
+        includeHiddenCols?: boolean;
+        /** Include sheets that are hidden in the Excel workbook. */
+        includeHiddenSheets?: boolean;
+    }
     /**
      * Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
      */

package/dist/cjs/api/types/ExtractInput.js

@@ -4,9 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExtractInput = void 0;
 var ExtractInput;
 (function (ExtractInput) {
-    /** Extraction model to use. When set to `enterprise-preview`, routes the request through Pulse's self-hosted VPC extraction model instead of the default cloud-based service. If omitted or set to any other value, the default model is used. */
+    /** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
     ExtractInput.Model = {
-        EnterprisePreview: "enterprise-preview",
+        Default: "default",
+        PulseUltra2: "pulse-ultra-2",
     };
     let Extensions;
     (function (Extensions) {

package/dist/cjs/api/types/ExtractLargeResultResponse.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Returned instead of the full extraction result when the document has 70 or more pages.  The `url` field is a single-use download link; fetch it once to retrieve the complete `ExtractResultCore` payload. Subsequent requests to the same URL return 410 Gone.
+ */
+export interface ExtractLargeResultResponse {
+    /** Always `true` for large document responses. */
+    is_url: boolean;
+    /** Single-use URL to download the full extraction result.  After one successful download the resource is deleted and further requests return 410 Gone. */
+    url: string;
+    /** Extraction identifier (when storage is enabled). */
+    extraction_id?: string;
+    /** Number of pages in the document. */
+    page_count?: number;
+    /** Billing tier and usage information. */
+    plan_info?: ExtractLargeResultResponse.PlanInfo;
+}
+export declare namespace ExtractLargeResultResponse {
+    /**
+     * Billing tier and usage information.
+     */
+    interface PlanInfo {
+        tier?: string;
+        pages_used?: number;
+        note?: string;
+    }
+}

package/dist/cjs/api/types/ExtractLargeResultResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ExtractOptions.d.ts

@@ -2,7 +2,7 @@
  * Common extraction options shared by synchronous and asynchronous endpoints.
  */
 export interface ExtractOptions {
-    /** Extraction model to use. When set to `enterprise-preview`, routes the request through Pulse's self-hosted VPC extraction model instead of the default cloud-based service. If omitted or set to any other value, the default model is used. */
+    /** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
     model?: ExtractOptions.Model;
     /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
     pages?: string;
@@ -10,6 +10,8 @@ export interface ExtractOptions {
     figureProcessing?: ExtractOptions.FigureProcessing;
     /** Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`. */
     extensions?: ExtractOptions.Extensions;
+    /** Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names. */
+    spreadsheet?: ExtractOptions.Spreadsheet;
     /** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
     storage?: ExtractOptions.Storage;
     /** If true, returns immediately with a job_id for polling via GET /job/{jobId}. Otherwise processes synchronously. */
@@ -38,9 +40,10 @@ export interface ExtractOptions {
     thinking?: boolean;
 }
 export declare namespace ExtractOptions {
-    /** Extraction model to use. When set to `enterprise-preview`, routes the request through Pulse's self-hosted VPC extraction model instead of the default cloud-based service. If omitted or set to any other value, the default model is used. */
+    /** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
     const Model: {
-        readonly EnterprisePreview: "enterprise-preview";
+        readonly Default: "default";
+        readonly PulseUltra2: "pulse-ultra-2";
     };
     type Model = (typeof Model)[keyof typeof Model];
     /**
@@ -56,8 +59,6 @@ export declare namespace ExtractOptions {
      * Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`.
      */
     interface Extensions {
-        /** Merge tables that span multiple pages into a single table. */
-        mergeTables?: boolean;
         /** Link footnote markers to their corresponding footnote text. */
         footnoteReferences?: boolean;
         /** Chunking configuration. When provided, the document is split into chunks using the specified strategies. Results appear in `response.extensions.chunking`. */
@@ -99,6 +100,17 @@ export declare namespace ExtractOptions {
             returnXml?: boolean;
         }
     }
+    /**
+     * Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names.
+     */
+    interface Spreadsheet {
+        /** Include rows that are hidden in the Excel workbook. */
+        includeHiddenRows?: boolean;
+        /** Include columns that are hidden in the Excel workbook. */
+        includeHiddenCols?: boolean;
+        /** Include sheets that are hidden in the Excel workbook. */
+        includeHiddenSheets?: boolean;
+    }
     /**
      * Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
      */

package/dist/cjs/api/types/ExtractOptions.js

@@ -4,9 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExtractOptions = void 0;
 var ExtractOptions;
 (function (ExtractOptions) {
-    /** Extraction model to use. When set to `enterprise-preview`, routes the request through Pulse's self-hosted VPC extraction model instead of the default cloud-based service. If omitted or set to any other value, the default model is used. */
+    /** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
     ExtractOptions.Model = {
-        EnterprisePreview: "enterprise-preview",
+        Default: "default",
+        PulseUltra2: "pulse-ultra-2",
     };
     let Extensions;
     (function (Extensions) {

package/dist/cjs/api/types/ExtractResponse.d.ts

@@ -1,6 +1,6 @@
 import type * as Pulse from "../index.js";
 /**
- * Full extraction result returned by the synchronous `/extract` endpoint. Contains the extracted markdown, optional extensions output, bounding boxes, and storage metadata.
+ * Full extraction result returned by the synchronous `/extract` endpoint. Inherits all core fields and adds deprecated backward-compatibility fields.
  */
 export interface ExtractResponse {
     /** Primary markdown content extracted from the document. Always present in the new format. */
@@ -19,6 +19,8 @@ export interface ExtractResponse {
     plan_info?: ExtractResponse.PlanInfo;
     /** Non-fatal warnings generated during extraction. Includes deprecation notices when legacy input parameters are used, as well as processing warnings (e.g. word-level bounding box limitations). */
     warnings?: string[];
+    /** Number of credits consumed by this request. Only present when the organization has the credit billing system enabled. */
+    credits_used?: number | null;
     /** **Deprecated** — Use `extensions.altOutputs.html` instead. HTML representation of the extracted content. Present when the legacy `returnHtml` input was used. */
     html?: string;
     /** **Deprecated** — Use `extensions.chunking` instead. Document content split into chunks. Present when the legacy `chunking` input was used. */
@@ -45,8 +47,6 @@ export declare namespace ExtractResponse {
     interface Extensions {
         /** Chunk results by strategy. Present when `extensions.chunking` was provided in the request. */
         chunking?: Extensions.Chunking;
-        /** Merge tables result/metadata. Present when `extensions.mergeTables` was enabled. */
-        mergeTables?: Record<string, unknown>;
         /** List of detected footnotes with their in-text references. Present when `extensions.footnoteReferences` was enabled. Each item links a footnote paragraph to the body-text paragraphs that reference it, using bounding-box text IDs. */
         footnoteReferences?: Extensions.FootnoteReferences.Item[];
         /** Alternate output formats. Each key corresponds to an enabled alt output. */

package/dist/cjs/api/types/ExtractResultCore.d.ts

@@ -0,0 +1,112 @@
+/**
+ * Core extraction result fields shared by the synchronous `/extract` endpoint and the pipeline extract step.
+ */
+export interface ExtractResultCore {
+    /** Primary markdown content extracted from the document. Always present in the new format. */
+    markdown?: string;
+    /** Output from enabled extensions. Each key corresponds to an extension that was enabled in the request under `extensions.*`. Only keys for enabled extensions are present. */
+    extensions?: ExtractResultCore.Extensions;
+    /** Positional bounding-box data for text, titles, headers, footers, images, and tables. Used by the frontend for annotation overlays. */
+    bounding_boxes?: Record<string, unknown>;
+    /** Persisted extraction ID. Present when storage is enabled (default). Use this ID with `/split` and `/schema` endpoints. */
+    extraction_id?: string;
+    /** URL to view the extraction on the Pulse platform. Present when storage is enabled. */
+    extraction_url?: string;
+    /** Number of pages processed. */
+    page_count?: number;
+    /** Billing tier and usage information. */
+    plan_info?: ExtractResultCore.PlanInfo;
+    /** Non-fatal warnings generated during extraction. Includes deprecation notices when legacy input parameters are used, as well as processing warnings (e.g. word-level bounding box limitations). */
+    warnings?: string[];
+    /** Number of credits consumed by this request. Only present when the organization has the credit billing system enabled. */
+    credits_used?: number | null;
+}
+export declare namespace ExtractResultCore {
+    /**
+     * Output from enabled extensions. Each key corresponds to an extension that was enabled in the request under `extensions.*`. Only keys for enabled extensions are present.
+     */
+    interface Extensions {
+        /** Chunk results by strategy. Present when `extensions.chunking` was provided in the request. */
+        chunking?: Extensions.Chunking;
+        /** List of detected footnotes with their in-text references. Present when `extensions.footnoteReferences` was enabled. Each item links a footnote paragraph to the body-text paragraphs that reference it, using bounding-box text IDs. */
+        footnoteReferences?: Extensions.FootnoteReferences.Item[];
+        /** Alternate output formats. Each key corresponds to an enabled alt output. */
+        altOutputs?: Extensions.AltOutputs;
+    }
+    namespace Extensions {
+        /**
+         * Chunk results by strategy. Present when `extensions.chunking` was provided in the request.
+         */
+        interface Chunking {
+            /** Semantically-segmented chunks. */
+            semantic?: string[];
+            /** Chunks split by document headers/headings. */
+            header?: string[];
+            /** One chunk per page. */
+            page?: string[];
+            /** Recursively-split chunks respecting size limits. */
+            recursive?: string[];
+        }
+        type FootnoteReferences = FootnoteReferences.Item[];
+        namespace FootnoteReferences {
+            interface Item {
+                /** The footnote marker symbol (e.g. "*", "†", "1", "#"). */
+                symbol?: string;
+                /** The bounding-box text ID (e.g. "txt-15") of the footnote explanation paragraph. */
+                footnoteTextId?: string;
+                /** Bounding-box text IDs of body-text paragraphs that contain a reference to this footnote marker. */
+                referenceTextIds?: string[];
+            }
+        }
+        /**
+         * Alternate output formats. Each key corresponds to an enabled alt output.
+         */
+        interface AltOutputs {
+            /** Word-level bounding box data. Present when `extensions.altOutputs.wlbb` was enabled and input is a PDF. */
+            wlbb?: AltOutputs.Wlbb;
+            /** HTML representation of the document. Present when `extensions.altOutputs.returnHtml` was enabled. */
+            html?: string;
+            /** XML representation of the document. Present when `extensions.altOutputs.returnXml` was enabled. (WIP) */
+            xml?: string;
+        }
+        namespace AltOutputs {
+            /**
+             * Word-level bounding box data. Present when `extensions.altOutputs.wlbb` was enabled and input is a PDF.
+             */
+            interface Wlbb {
+                /** List of detected words with their positions. */
+                words?: Wlbb.Words.Item[];
+                /** Error message if word-level extraction failed. */
+                error?: string;
+            }
+            namespace Wlbb {
+                type Words = Words.Item[];
+                namespace Words {
+                    interface Item {
+                        /** Unique identifier for the word (e.g. "w-1", "w-2", …). */
+                        id?: string;
+                        /** The recognised word text. */
+                        text?: string;
+                        /** 1-indexed page number in the original document. */
+                        page_number?: number;
+                        /** Flat 4-corner polygon: [x1,y1, x2,y2, x3,y3, x4,y4]. All coordinates normalised to 0–1 range. */
+                        bounding_box?: number[];
+                        /** Recognition confidence score (0–1). */
+                        average_word_confidence?: number;
+                    }
+                }
+            }
+        }
+    }
+    /**
+     * Billing tier and usage information.
+     */
+    interface PlanInfo {
+        /** Current plan tier name. */
+        tier?: string;
+        /** Cumulative pages used after this extraction. */
+        pages_used?: number;
+        /** Human-readable plan note. */
+        note?: string;
+    }
+}

package/dist/cjs/api/types/ExtractResultCore.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/FormCell.d.ts

@@ -0,0 +1,40 @@
+import type * as Pulse from "../index.js";
+/**
+ * A single detected cell on a form page. Cells are produced by Pulse
+ * cell detection during a `/form/detect`, `/form/fill`, or
+ * `/form/clear` call and may be passed back via `form_fields` to
+ * override what Pulse uses when filling or clearing.
+ *
+ * All coordinate fields (`bounding_box`, `checkbox_coord`) are
+ * normalized to `[0, 1]` relative to the page width / height, so
+ * they're independent of the renderer's pixel resolution. Multiply
+ * by your render width / height to convert to your own pixel space.
+ * `page_number` is 1-indexed.
+ */
+export interface FormCell {
+    /** 1-indexed page the cell belongs to. */
+    page_number?: number;
+    /** Cell bounding box `[x1, y1, x2, y2]` normalized to the range `[0, 1]` (top-left origin). Same shape as the `bounding_box` field returned by `/extract`. */
+    bounding_box?: number[];
+    /** Current text content of the cell. Empty string for unfilled cells. */
+    text?: string;
+    /** Detected cell type. Common values are `text`, `checkbox`, and `signature`. Additional values may be returned as the detector evolves. */
+    type?: FormCell.Type;
+    /** Row index inside the detected table this cell belongs to, when the cell sits in a tabular region. */
+    row?: number;
+    /** Column index inside the detected table this cell belongs to, when the cell sits in a tabular region. */
+    col?: number;
+    /** Index of the detected table on the page this cell belongs to (0-indexed). Cells outside any detected table may omit this field. */
+    table_idx?: number;
+    /** Only present when `type == "checkbox"`. One entry per individual checkbox inside this cell — a single cell often contains multiple checkboxes (e.g. a "Filing Status" row with Single / MFJ / MFS / HoH / QSS). The cell-level `text` is the raw OCR'd line covering the whole cell; per-box labels live here on each detail. */
+    checkbox_details?: Pulse.FormCheckboxDetail[];
+}
+export declare namespace FormCell {
+    /** Detected cell type. Common values are `text`, `checkbox`, and `signature`. Additional values may be returned as the detector evolves. */
+    const Type: {
+        readonly Text: "text";
+        readonly Checkbox: "checkbox";
+        readonly Signature: "signature";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/cjs/api/types/FormCell.js

@@ -0,0 +1,13 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormCell = void 0;
+var FormCell;
+(function (FormCell) {
+    /** Detected cell type. Common values are `text`, `checkbox`, and `signature`. Additional values may be returned as the detector evolves. */
+    FormCell.Type = {
+        Text: "text",
+        Checkbox: "checkbox",
+        Signature: "signature",
+    };
+})(FormCell || (exports.FormCell = FormCell = {}));

package/dist/cjs/api/types/FormCheckboxDetail.d.ts

@@ -0,0 +1,11 @@
+/**
+ * A single checkbox inside a `FormCell` of `type == "checkbox"`. Bundles the checkbox's normalized center coordinate, current selection state, and the per-box text label.
+ */
+export interface FormCheckboxDetail {
+    /** Normalized `[x, y]` center of the checkbox (in `[0, 1]`, top-left origin), in the same coordinate system as `FormCell.bounding_box`. */
+    center_coord?: number[];
+    /** `true` when the checkbox is currently filled in (selected), `false` otherwise. */
+    selected?: boolean;
+    /** Per-checkbox text label (e.g. `"Individual/sole proprietor"`, `"S corporation"`). May be an empty string when no label could be confidently associated with this specific box. */
+    text?: string;
+}

package/dist/cjs/api/types/FormCheckboxDetail.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/FormClearMultipartInput.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Multipart `/form/clear` request. Use this variant to upload a
+ * PDF directly via `file`. Provide exactly one of `file`,
+ * `file_url`, or `form_id`.
+ */
+export interface FormClearMultipartInput {
+    /** PDF file to upload directly. */
+    file?: string;
+    /** Alternative to `file`: a public or pre-signed URL Pulse will download. */
+    file_url?: string;
+    /** Reference to a previously processed form. Mutually exclusive with `file` / `file_url`. */
+    form_id?: string;
+    /** Optional natural language description of what to clear. When omitted, Pulse clears everything user-filled deterministically. */
+    instructions?: string;
+    /** Optional JSON-encoded array of `FormCell` objects to override detected cells. Multipart bodies must serialise this field as a string. */
+    form_fields?: string;
+    /** Restrict the operation to a subset of pages, e.g. `"1-3,5"`. */
+    page_range?: string;
+    /** Set to `"true"` to run asynchronously and receive `{job_id, status}` immediately. */
+    async?: string;
+}

package/dist/cjs/api/types/FormClearMultipartInput.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/FormDetectMultipartInput.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Multipart `/form/detect` request. Use this variant to upload a
+ * PDF directly via `file`.
+ */
+export interface FormDetectMultipartInput {
+    /** PDF file to upload directly. */
+    file?: string;
+    /** Alternative to `file`: a public or pre-signed URL Pulse will download. */
+    file_url?: string;
+    /** Reference to a previously processed form. Mutually exclusive with `file` / `file_url`. */
+    form_id?: string;
+    /** Restrict the operation to a subset of pages, e.g. `"1-3,5"`. */
+    page_range?: string;
+    /** Set to `"true"` to run asynchronously and receive `{job_id, status}` immediately. */
+    async?: string;
+}

package/dist/cjs/api/types/FormDetectMultipartInput.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/FormFillMultipartInput.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Multipart `/form/fill` request. Use this variant to upload a
+ * PDF directly via `file`. Provide exactly one of `file`,
+ * `file_url`, or `form_id`.
+ */
+export interface FormFillMultipartInput {
+    /** PDF file to upload directly. */
+    file?: string;
+    /** Alternative to `file`: a public or pre-signed URL Pulse will download. */
+    file_url?: string;
+    /** Reference to a previously processed form. Mutually exclusive with `file` / `file_url`. */
+    form_id?: string;
+    /** Required natural-language fill prompt. */
+    instructions?: string;
+    /** Optional JSON-encoded array of `FormCell` objects to override detected cells. Multipart bodies must serialise this field as a string. */
+    form_fields?: string;
+    /** Restrict the operation to a subset of pages, e.g. `"1-3,5"`. */
+    page_range?: string;
+    /** Set to `"true"` to run asynchronously and receive `{job_id, status}` immediately. */
+    async?: string;
+}

package/dist/cjs/api/types/FormFillMultipartInput.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/FormFillSharedOptions.d.ts

@@ -0,0 +1,12 @@
+import type * as Pulse from "../index.js";
+/**
+ * Cell-level overrides accepted by `/form/fill` and `/form/clear`.
+ */
+export interface FormFillSharedOptions {
+    /** Optional override for the cells used when filling / clearing. When omitted, Pulse uses the cells stored on the referenced `form_id` (fast path) or runs detection on the uploaded PDF. Useful for editing detected cells before filling. */
+    form_fields?: Pulse.FormCell[];
+    /** Restrict the operation to a subset of pages. Accepts comma-separated page numbers and ranges, e.g. `"1-3,5"`. Alias: `pages`. */
+    page_range?: string;
+    /** When `true`, the endpoint returns immediately with `{job_id, status: "pending"}` (HTTP 202) and processes the job in the background. Poll [GET /job/{jobId}](api:GET/job/{jobId}) for the result. Default `false` — return the full result inline. */
+    async?: boolean;
+}

package/dist/cjs/api/types/FormFillSharedOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/FormPlanInfo.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Cumulative billing snapshot for the calling organization. Sourced from the `pulse-org-stats` aggregate table maintained asynchronously by the org-stats Lambda; the in-flight request's contribution is added on top so every response reflects post-request state.
+ */
+export interface FormPlanInfo {
+    /** Billing tier, e.g. `"trial"`, `"pulse_ultra_2"`. */
+    tier?: string;
+    /** Total credits consumed by the organization to date, including this request. The primary billing metric going forward. */
+    total_credits_used?: number;
+    /** Total pages processed by the organization to date, including this request. Kept for backward compatibility with clients that haven't migrated to `total_credits_used`. */
+    pages_used?: number;
+}

package/dist/cjs/api/types/FormPlanInfo.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/FormResult.d.ts

@@ -0,0 +1,24 @@
+import type * as Pulse from "../index.js";
+/**
+ * Result body returned by `/form/detect`, `/form/fill`, and
+ * `/form/clear`. For async jobs (`async: true`) the same shape is
+ * served back under `result` on
+ * [GET /job/{jobId}](api:GET/job/{jobId}).
+ */
+export interface FormResult {
+    /** ID of the form record produced by this run. Pass to a subsequent `/form/detect`, `/form/fill`, or `/form/clear` call as the single input source to iterate without re-uploading the PDF. */
+    form_id?: string;
+    /** Number of pages in the output PDF. */
+    page_count?: number;
+    /** URL to download the resulting PDF binary. Always points at [GET /results/{jobId}/pdf](api:GET/results/{jobId}/pdf) for the originating job. Authenticated callers can replay this URL until the underlying artifact is garbage-collected. */
+    pdf_url?: string;
+    /** Detected cells of the resulting PDF (refreshed from the filled/cleared output for fill/clear, or freshly detected for `/form/detect`). Use these as a starting point for further edits. */
+    form_fields?: Pulse.FormCell[];
+    /** Number of cells that were filled by this run. Present on `/form/fill` responses only. */
+    fields_filled?: number;
+    /** Number of cells that were cleared by this run. Present on `/form/clear` responses only. */
+    fields_cleared?: number;
+    /** Number of credits consumed by **this request**. Detect charges 1 credit per page; fill and clear charge 3 credits per page. */
+    credits_used?: number;
+    plan_info?: Pulse.FormPlanInfo;
+}

package/dist/cjs/api/types/FormResult.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });