pulse-ts-sdk 1.0.7 → 1.0.9

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

@@ -0,0 +1,145 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PipelineClient = void 0;
+const BaseClient_js_1 = require("../../../../BaseClient.js");
+const headers_js_1 = require("../../../../core/headers.js");
+const core = __importStar(require("../../../../core/index.js"));
+const environments = __importStar(require("../../../../environments.js"));
+const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatusCodeError.js");
+const errors = __importStar(require("../../../../errors/index.js"));
+const Pulse = __importStar(require("../../../index.js"));
+class PipelineClient {
+    constructor(options = {}) {
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
+    }
+    /**
+     * Chain multiple processing steps (extract, schema, split) into a single
+     * request with inline configurations. No saved pipeline required.
+     *
+     * The `steps` object defines what to run and in what order. Outputs flow
+     * forward automatically — you never need to pass extraction IDs between
+     * steps.
+     *
+     * **Supported step combinations:**
+     * - `extract` — extract a single document
+     * - `extract` → `schema` — extract then apply structured schema
+     * - `extract` → `split` — extract then split into topics
+     * - `batch_extract` → `schema` — extract multiple files, combine into one schema output
+     *
+     * **Document input:**
+     * - Single file: provide `fileUrl` in JSON or `file` via multipart
+     * - Multiple files (batch_extract): provide `fileUrls` in JSON or multiple `file` fields via multipart
+     *
+     * Set `async: true` to return immediately with a `job_id` for polling via
+     * `GET /job/{jobId}`.
+     *
+     * Set `autoDelete: true` for zero-retention mode — all stored artifacts
+     * are deleted immediately after you receive the results. Requires
+     * `save_extractions` to be disabled for your organization.
+     *
+     * Requires the `enable_adhoc_pipeline` feature flag.
+     *
+     * @param {Pulse.PipelineExecuteInput} request
+     * @param {PipelineClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pulse.BadRequestError}
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.ForbiddenError}
+     * @throws {@link Pulse.TooManyRequestsError}
+     *
+     * @example
+     *     await client.pipeline.execute({
+     *         steps: {}
+     *     })
+     */
+    execute(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__execute(request, requestOptions));
+    }
+    __execute(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            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({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PulseEnvironment.Default, "pipeline/execute"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pulse.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pulse.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pulse.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Pulse.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PulseError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/pipeline/execute");
+        });
+    }
+}
+exports.PipelineClient = PipelineClient;

package/dist/cjs/api/resources/pipeline/client/index.d.ts

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

package/dist/cjs/api/resources/pipeline/client/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("./requests/index.js"), exports);

package/dist/cjs/api/resources/pipeline/client/requests/PipelineExecuteInput.d.ts

@@ -0,0 +1,17 @@
+import type * as Pulse from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         steps: {}
+ *     }
+ */
+export interface PipelineExecuteInput {
+    /** URL of the document to process. Use with `extract` step. */
+    file_url?: string;
+    /** Ordered step definitions. Key order determines execution order. */
+    steps: Pulse.PipelineSteps;
+    /** If true, returns immediately with a `job_id` for polling via `GET /job/{jobId}`. */
+    async?: boolean;
+    /** If true, all stored artifacts are deleted immediately after you receive the results. The inline data in the response is unaffected. Requires `save_extractions` to be disabled for your organization. */
+    auto_delete?: boolean;
+}

package/dist/cjs/api/resources/pipeline/client/requests/PipelineExecuteInput.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/pipeline/client/requests/index.d.ts

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

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

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

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

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

package/dist/cjs/api/resources/pipeline/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/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/BatchFileUpload.d.ts

@@ -0,0 +1,6 @@
+export interface BatchFileUpload {
+    /** Original filename including extension (e.g. `report.pdf`). */
+    filename: string;
+    /** Base64-encoded file content. */
+    content: string;
+}

package/dist/cjs/api/types/BatchFileUpload.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/BatchInputSource.d.ts

@@ -1,12 +1,13 @@
+import type * as Pulse from "../index.js";
 /**
  * Input source for batch file enumeration. Provide exactly one of
- * `s3_prefix`, `local_path`, or `file_urls`.
+ * `s3_prefix`, `file_urls`, or `files`.
  */
 export interface BatchInputSource {
     /** S3 URI prefix (e.g. `s3://bucket/folder/`). All supported files under this prefix will be processed. */
     s3_prefix?: string;
-    /** Absolute path to a local directory. All supported files in the directory will be processed. */
-    local_path?: string;
     /** Explicit list of file URLs to download and process. */
     file_urls?: string[];
+    /** Inline file uploads. Each entry contains a filename and base64-encoded file content. Use this when the client has local files that need to be sent to a remote API server. */
+    files?: Pulse.BatchFileUpload[];
 }

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

@@ -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. */
@@ -60,8 +62,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 +103,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/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

@@ -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. */
@@ -56,8 +58,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 +99,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/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/GoneErrorBody.d.ts

@@ -0,0 +1,9 @@
+export interface GoneErrorBody {
+    error?: GoneErrorBody.Error_;
+}
+export declare namespace GoneErrorBody {
+    interface Error_ {
+        code?: string;
+        message?: string;
+    }
+}

package/dist/cjs/api/types/GoneErrorBody.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/JobStatusResponse.d.ts

@@ -10,7 +10,7 @@ export interface JobStatusResponse {
     created_at: string;
     /** Timestamp of the last status update, if available. */
     updated_at?: string;
-    /** Structured payload that contains output when the job is completed. */
+    /** Structured payload returned when the job completes.  For large extractions (70+ pages) this object contains `is_url: true` and a single-use `url` to download the full result via `GET /large_results/{jobId}`. */
     result?: Record<string, unknown>;
     /** Error message describing why the job failed, if applicable. */
     error?: string;

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

@@ -0,0 +1,13 @@
+/**
+ * Result from the batch_extract step in a pipeline.
+ */
+export interface PipelineBatchExtractResult {
+    /** List of extraction IDs for each processed file. */
+    extraction_ids?: string[];
+    /** Number of files processed. */
+    total_files?: number;
+    /** Step execution time in seconds. */
+    latency?: number;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/PipelineBatchExtractResult.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/PipelineExecuteMultipartInput.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Multipart form-data request body for ad-hoc pipeline execution. Upload file(s) directly and provide step configs as a JSON string.
+ */
+export interface PipelineExecuteMultipartInput {
+    /** Document file to upload. For batch_extract, multiple `file` fields can be provided. */
+    file?: string;
+    /** JSON string containing the step configurations (same structure as `PipelineSteps`). */
+    steps: string;
+    /** Set to `"true"` for async execution. */
+    async?: string;
+    /** Set to `"true"` for zero-retention mode. */
+    auto_delete?: string;
+}

package/dist/cjs/api/types/PipelineExecuteMultipartInput.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/PipelineExecuteResponse.d.ts

@@ -0,0 +1,21 @@
+import type * as Pulse from "../index.js";
+/**
+ * Synchronous pipeline execution result. Contains the status, total latency, and results from each step.
+ */
+export interface PipelineExecuteResponse {
+    /** Pipeline execution status. */
+    status: PipelineExecuteResponse.Status;
+    /** Total pipeline execution time in seconds. */
+    total_latency?: number;
+    /** Per-step results. */
+    results: Pulse.PipelineResults;
+    /** Present and true when auto-delete mode was used. Confirms that artifacts have been purged. */
+    auto_delete?: boolean;
+}
+export declare namespace PipelineExecuteResponse {
+    /** Pipeline execution status. */
+    const Status: {
+        readonly Completed: "completed";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

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

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PipelineExecuteResponse = void 0;
+var PipelineExecuteResponse;
+(function (PipelineExecuteResponse) {
+    /** Pipeline execution status. */
+    PipelineExecuteResponse.Status = {
+        Completed: "completed",
+    };
+})(PipelineExecuteResponse || (exports.PipelineExecuteResponse = PipelineExecuteResponse = {}));