pulse-ts-sdk 1.0.7 → 1.0.9

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "pulse-ts-sdk",
-        "X-Fern-SDK-Version": "1.0.7",
-        "User-Agent": "pulse-ts-sdk/1.0.7",
+        "X-Fern-SDK-Version": "1.0.9",
+        "User-Agent": "pulse-ts-sdk/1.0.9",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/Client.d.ts

@@ -1,6 +1,8 @@
 import * as Pulse from "./api/index.js";
 import { BatchClient } from "./api/resources/batch/client/Client.js";
 import { JobsClient } from "./api/resources/jobs/client/Client.js";
+import { LargeResultsClient } from "./api/resources/largeResults/client/Client.js";
+import { PipelineClient } from "./api/resources/pipeline/client/Client.js";
 import { WebhooksClient } from "./api/resources/webhooks/client/Client.js";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
 import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
@@ -13,11 +15,15 @@ export declare namespace PulseClient {
 export declare class PulseClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<PulseClient.Options>;
     protected _batch: BatchClient | undefined;
+    protected _pipeline: PipelineClient | undefined;
     protected _jobs: JobsClient | undefined;
+    protected _largeResults: LargeResultsClient | undefined;
     protected _webhooks: WebhooksClient | undefined;
     constructor(options?: PulseClient.Options);
     get batch(): BatchClient;
+    get pipeline(): PipelineClient;
     get jobs(): JobsClient;
+    get largeResults(): LargeResultsClient;
     get webhooks(): WebhooksClient;
     /**
      * The primary endpoint for the Pulse API. Parses uploaded documents or remote

package/dist/cjs/Client.js

@@ -47,7 +47,9 @@ exports.PulseClient = void 0;
 const Pulse = __importStar(require("./api/index.js"));
 const Client_js_1 = require("./api/resources/batch/client/Client.js");
 const Client_js_2 = require("./api/resources/jobs/client/Client.js");
-const Client_js_3 = require("./api/resources/webhooks/client/Client.js");
+const Client_js_3 = require("./api/resources/largeResults/client/Client.js");
+const Client_js_4 = require("./api/resources/pipeline/client/Client.js");
+const Client_js_5 = require("./api/resources/webhooks/client/Client.js");
 const BaseClient_js_1 = require("./BaseClient.js");
 const headers_js_1 = require("./core/headers.js");
 const core = __importStar(require("./core/index.js"));
@@ -63,13 +65,21 @@ class PulseClient {
         var _a;
         return ((_a = this._batch) !== null && _a !== void 0 ? _a : (this._batch = new Client_js_1.BatchClient(this._options)));
     }
+    get pipeline() {
+        var _a;
+        return ((_a = this._pipeline) !== null && _a !== void 0 ? _a : (this._pipeline = new Client_js_4.PipelineClient(this._options)));
+    }
     get jobs() {
         var _a;
         return ((_a = this._jobs) !== null && _a !== void 0 ? _a : (this._jobs = new Client_js_2.JobsClient(this._options)));
     }
+    get largeResults() {
+        var _a;
+        return ((_a = this._largeResults) !== null && _a !== void 0 ? _a : (this._largeResults = new Client_js_3.LargeResultsClient(this._options)));
+    }
     get webhooks() {
         var _a;
-        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_3.WebhooksClient(this._options)));
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_5.WebhooksClient(this._options)));
     }
     /**
      * The primary endpoint for the Pulse API. Parses uploaded documents or remote
@@ -118,6 +128,9 @@ class PulseClient {
             if (request.extensions != null) {
                 _request.append("extensions", (0, json_js_1.toJson)(request.extensions));
             }
+            if (request.spreadsheet != null) {
+                _request.append("spreadsheet", (0, json_js_1.toJson)(request.spreadsheet));
+            }
             if (request.storage != null) {
                 _request.append("storage", (0, json_js_1.toJson)(request.storage));
             }
@@ -239,6 +252,9 @@ class PulseClient {
             if (request.extensions != null) {
                 _request.append("extensions", (0, json_js_1.toJson)(request.extensions));
             }
+            if (request.spreadsheet != null) {
+                _request.append("spreadsheet", (0, json_js_1.toJson)(request.spreadsheet));
+            }
             if (request.storage != null) {
                 _request.append("storage", (0, json_js_1.toJson)(request.storage));
             }

package/dist/cjs/api/client/requests/ExtractAsyncRequest.d.ts

@@ -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/cjs/api/client/requests/ExtractRequest.d.ts

@@ -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/cjs/api/errors/GoneError.d.ts

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

package/dist/cjs/api/errors/GoneError.js

@@ -0,0 +1,54 @@
+"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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GoneError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+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;
+    }
+}
+exports.GoneError = GoneError;

package/dist/cjs/api/errors/index.d.ts

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

package/dist/cjs/api/errors/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BadRequestError.js"), exports);
 __exportStar(require("./ForbiddenError.js"), exports);
+__exportStar(require("./GoneError.js"), exports);
 __exportStar(require("./InternalServerError.js"), exports);
 __exportStar(require("./NotFoundError.js"), exports);
 __exportStar(require("./TooManyRequestsError.js"), exports);

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

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

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

@@ -36,10 +36,14 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.webhooks = exports.jobs = exports.batch = void 0;
+exports.webhooks = exports.pipeline = exports.largeResults = exports.jobs = exports.batch = void 0;
 __exportStar(require("./batch/client/requests/index.js"), exports);
 exports.batch = __importStar(require("./batch/index.js"));
 __exportStar(require("./jobs/client/requests/index.js"), exports);
 exports.jobs = __importStar(require("./jobs/index.js"));
+__exportStar(require("./largeResults/client/requests/index.js"), exports);
+exports.largeResults = __importStar(require("./largeResults/index.js"));
+__exportStar(require("./pipeline/client/requests/index.js"), exports);
+exports.pipeline = __importStar(require("./pipeline/index.js"));
 exports.webhooks = __importStar(require("./webhooks/index.js"));
 __exportStar(require("./webhooks/types/index.js"), exports);

package/dist/cjs/api/resources/largeResults/client/Client.d.ts

@@ -0,0 +1,35 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Pulse from "../../../index.js";
+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/cjs/api/resources/largeResults/client/Client.js

@@ -0,0 +1,121 @@
+"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.LargeResultsClient = 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 LargeResultsClient {
+    constructor(options = {}) {
+        this._options = (0, BaseClient_js_1.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 = (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, `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 (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/large_results/{jobId}");
+        });
+    }
+}
+exports.LargeResultsClient = LargeResultsClient;

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

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

package/dist/cjs/api/resources/largeResults/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/largeResults/client/requests/GetLargeResultLargeResultsRequest.d.ts

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

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

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

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

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

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

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

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

@@ -0,0 +1,55 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Pulse from "../../../index.js";
+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;
+}