pulse-ts-sdk 1.0.7 → 1.0.9

package/dist/esm/api/client/requests/ExtractAsyncRequest.d.mts

@@ -16,6 +16,8 @@ export interface ExtractAsyncRequest {
     figureProcessing?: ExtractAsyncRequest.FigureProcessing;
     /** Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`. */
     extensions?: ExtractAsyncRequest.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?: ExtractAsyncRequest.Spreadsheet;
     /** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
     storage?: ExtractAsyncRequest.Storage;
     /** If true, returns immediately with a job_id for polling via GET /job/{jobId}. Otherwise processes synchronously. */
@@ -62,8 +64,6 @@ export declare namespace ExtractAsyncRequest {
      * 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`. */
@@ -105,6 +105,17 @@ export declare namespace ExtractAsyncRequest {
             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/esm/api/client/requests/ExtractRequest.d.mts

@@ -16,6 +16,8 @@ export interface ExtractRequest {
     figureProcessing?: ExtractRequest.FigureProcessing;
     /** Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`. */
     extensions?: ExtractRequest.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?: ExtractRequest.Spreadsheet;
     /** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
     storage?: ExtractRequest.Storage;
     /** If true, returns immediately with a job_id for polling via GET /job/{jobId}. Otherwise processes synchronously. */
@@ -62,8 +64,6 @@ export declare namespace ExtractRequest {
      * 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`. */
@@ -105,6 +105,17 @@ export declare namespace ExtractRequest {
             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/esm/api/errors/GoneError.d.mts

@@ -0,0 +1,6 @@
+import type * as core from "../../core/index.mjs";
+import * as errors from "../../errors/index.mjs";
+import type * as Pulse from "../index.mjs";
+export declare class GoneError extends errors.PulseError {
+    constructor(body: Pulse.GoneErrorBody, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/GoneError.mjs

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.mjs";
+export class GoneError extends errors.PulseError {
+    constructor(body, rawResponse) {
+        super({
+            message: "GoneError",
+            statusCode: 410,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}

package/dist/esm/api/errors/index.d.mts

@@ -1,5 +1,6 @@
 export * from "./BadRequestError.mjs";
 export * from "./ForbiddenError.mjs";
+export * from "./GoneError.mjs";
 export * from "./InternalServerError.mjs";
 export * from "./NotFoundError.mjs";
 export * from "./TooManyRequestsError.mjs";

package/dist/esm/api/errors/index.mjs

@@ -1,5 +1,6 @@
 export * from "./BadRequestError.mjs";
 export * from "./ForbiddenError.mjs";
+export * from "./GoneError.mjs";
 export * from "./InternalServerError.mjs";
 export * from "./NotFoundError.mjs";
 export * from "./TooManyRequestsError.mjs";

package/dist/esm/api/resources/index.d.mts

@@ -2,5 +2,9 @@ export * from "./batch/client/requests/index.mjs";
 export * as batch from "./batch/index.mjs";
 export * from "./jobs/client/requests/index.mjs";
 export * as jobs from "./jobs/index.mjs";
+export * from "./largeResults/client/requests/index.mjs";
+export * as largeResults from "./largeResults/index.mjs";
+export * from "./pipeline/client/requests/index.mjs";
+export * as pipeline from "./pipeline/index.mjs";
 export * as webhooks from "./webhooks/index.mjs";
 export * from "./webhooks/types/index.mjs";

package/dist/esm/api/resources/index.mjs

@@ -2,5 +2,9 @@ export * from "./batch/client/requests/index.mjs";
 export * as batch from "./batch/index.mjs";
 export * from "./jobs/client/requests/index.mjs";
 export * as jobs from "./jobs/index.mjs";
+export * from "./largeResults/client/requests/index.mjs";
+export * as largeResults from "./largeResults/index.mjs";
+export * from "./pipeline/client/requests/index.mjs";
+export * as pipeline from "./pipeline/index.mjs";
 export * as webhooks from "./webhooks/index.mjs";
 export * from "./webhooks/types/index.mjs";

package/dist/esm/api/resources/largeResults/client/Client.d.mts

@@ -0,0 +1,35 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Pulse from "../../../index.mjs";
+export declare namespace LargeResultsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class LargeResultsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<LargeResultsClient.Options>;
+    constructor(options?: LargeResultsClient.Options);
+    /**
+     * Download the full result for a large extraction (70+ pages).
+     *
+     * When `/extract` or `GET /job/{jobId}` returns `is_url: true`, fetch
+     * the complete result from the URL provided.  The URL is single-use:
+     * after a successful download the resource is deleted and subsequent
+     * requests return 410 Gone.
+     *
+     * @param {Pulse.GetLargeResultLargeResultsRequest} request
+     * @param {LargeResultsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pulse.NotFoundError}
+     * @throws {@link Pulse.GoneError}
+     * @throws {@link Pulse.InternalServerError}
+     *
+     * @example
+     *     await client.largeResults.getLargeResult({
+     *         jobId: "jobId"
+     *     })
+     */
+    getLargeResult(request: Pulse.GetLargeResultLargeResultsRequest, requestOptions?: LargeResultsClient.RequestOptions): core.HttpResponsePromise<Pulse.ExtractResultCore>;
+    private __getLargeResult;
+}

package/dist/esm/api/resources/largeResults/client/Client.mjs

@@ -0,0 +1,84 @@
+// This file was auto-generated by Fern from our API Definition.
+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());
+    });
+};
+import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import { mergeHeaders } from "../../../../core/headers.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as environments from "../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
+import * as errors from "../../../../errors/index.mjs";
+import * as Pulse from "../../../index.mjs";
+export class LargeResultsClient {
+    constructor(options = {}) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    /**
+     * Download the full result for a large extraction (70+ pages).
+     *
+     * When `/extract` or `GET /job/{jobId}` returns `is_url: true`, fetch
+     * the complete result from the URL provided.  The URL is single-use:
+     * after a successful download the resource is deleted and subsequent
+     * requests return 410 Gone.
+     *
+     * @param {Pulse.GetLargeResultLargeResultsRequest} request
+     * @param {LargeResultsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pulse.NotFoundError}
+     * @throws {@link Pulse.GoneError}
+     * @throws {@link Pulse.InternalServerError}
+     *
+     * @example
+     *     await client.largeResults.getLargeResult({
+     *         jobId: "jobId"
+     *     })
+     */
+    getLargeResult(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getLargeResult(request, requestOptions));
+    }
+    __getLargeResult(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { jobId } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = 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, `large_results/${core.url.encodePathParam(jobId)}`),
+                method: "GET",
+                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,
+                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 404:
+                        throw new Pulse.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 410:
+                        throw new Pulse.GoneError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pulse.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PulseError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/large_results/{jobId}");
+        });
+    }
+}

package/dist/esm/api/resources/largeResults/client/index.d.mts

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

package/dist/esm/api/resources/largeResults/client/index.mjs

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

package/dist/esm/api/resources/largeResults/client/requests/GetLargeResultLargeResultsRequest.d.mts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         jobId: "jobId"
+ *     }
+ */
+export interface GetLargeResultLargeResultsRequest {
+    /** Job identifier from the extraction response. */
+    jobId: string;
+}

package/dist/esm/api/resources/largeResults/client/requests/GetLargeResultLargeResultsRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/largeResults/client/requests/index.d.mts

@@ -0,0 +1 @@
+export type { GetLargeResultLargeResultsRequest } from "./GetLargeResultLargeResultsRequest.mjs";

package/dist/esm/api/resources/largeResults/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/largeResults/index.d.mts

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

package/dist/esm/api/resources/largeResults/index.mjs

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

package/dist/esm/api/resources/pipeline/client/Client.d.mts

@@ -0,0 +1,55 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Pulse from "../../../index.mjs";
+export declare namespace PipelineClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class PipelineClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<PipelineClient.Options>;
+    constructor(options?: PipelineClient.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: Pulse.PipelineExecuteInput, requestOptions?: PipelineClient.RequestOptions): core.HttpResponsePromise<Pulse.PipelineExecuteResponse>;
+    private __execute;
+}

package/dist/esm/api/resources/pipeline/client/Client.mjs

@@ -0,0 +1,108 @@
+// This file was auto-generated by Fern from our API Definition.
+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());
+    });
+};
+import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import { mergeHeaders } from "../../../../core/headers.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as environments from "../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
+import * as errors from "../../../../errors/index.mjs";
+import * as Pulse from "../../../index.mjs";
+export class PipelineClient {
+    constructor(options = {}) {
+        this._options = 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 = 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 handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/pipeline/execute");
+        });
+    }
+}

package/dist/esm/api/resources/pipeline/client/index.d.mts

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

package/dist/esm/api/resources/pipeline/client/index.mjs

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

package/dist/esm/api/resources/pipeline/client/requests/PipelineExecuteInput.d.mts

@@ -0,0 +1,17 @@
+import type * as Pulse from "../../../../index.mjs";
+/**
+ * @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/esm/api/resources/pipeline/client/requests/PipelineExecuteInput.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/pipeline/client/requests/index.d.mts

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

package/dist/esm/api/resources/pipeline/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/pipeline/index.d.mts

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

package/dist/esm/api/resources/pipeline/index.mjs

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

package/dist/esm/api/types/AsyncSubmissionResponse.d.mts

@@ -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/esm/api/types/BatchFileUpload.d.mts

@@ -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/esm/api/types/BatchFileUpload.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/BatchInputSource.d.mts

@@ -1,12 +1,13 @@
+import type * as Pulse from "../index.mjs";
 /**
  * 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/esm/api/types/ExtractInput.d.mts

@@ -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/esm/api/types/ExtractLargeResultResponse.d.mts

@@ -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/esm/api/types/ExtractLargeResultResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};