pulse-ts-sdk 1.0.8 → 1.0.10

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

@@ -0,0 +1,131 @@
+"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. 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.
+     *
+     * For form jobs (`/form/detect`, `/form/fill`, `/form/clear`)
+     * you don't need this endpoint at all — `GET /job/{jobId}`
+     * already returns the full `FormResult` inline under `result`,
+     * and the `pdf_url` field points at
+     * [GET /results/{jobId}/pdf](api:GET/results/{jobId}/pdf) for the
+     * binary.
+     *
+     * @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;
+            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: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
+                    ? requestOptions.timeoutInSeconds * 1000
+                    : ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
+                        ? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
+                        : undefined,
+                maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.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,57 @@
+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, tables) 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
+     * - `extract` → `split` → `schema` — extract, split by topic, apply per-topic schemas
+     * - `extract` → `tables` — extract then extract structured tables
+     * - `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/cjs/api/resources/pipeline/client/Client.js

@@ -0,0 +1,151 @@
+"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, tables) 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
+     * - `extract` → `split` → `schema` — extract, split by topic, apply per-topic schemas
+     * - `extract` → `tables` — extract then extract structured tables
+     * - `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;
+            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: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
+                    ? requestOptions.timeoutInSeconds * 1000
+                    : ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
+                        ? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
+                        : undefined,
+                maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.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/resources/results/client/Client.d.ts

@@ -0,0 +1,27 @@
+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 ResultsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class ResultsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<ResultsClient.Options>;
+    constructor(options?: ResultsClient.Options);
+    /**
+     * Download the PDF binary produced by a `/form/detect`,
+     * `/form/fill`, or `/form/clear` job. The `pdf_url` field on a
+     * `FormResult` points at this endpoint — you can hand it
+     * directly to a browser, embed it in an `<iframe>`, or fetch the
+     * bytes from a backend.
+     *
+     * Returns `404` for non-form jobs (no PDF was produced) and for
+     * form jobs whose PDF artifact is no longer available.
+     * @throws {@link Pulse.NotFoundError}
+     * @throws {@link Pulse.InternalServerError}
+     */
+    getPdf(request: Pulse.GetPdfResultsRequest, requestOptions?: ResultsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __getPdf;
+}

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

@@ -0,0 +1,116 @@
+"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.ResultsClient = 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 ResultsClient {
+    constructor(options = {}) {
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
+    }
+    /**
+     * Download the PDF binary produced by a `/form/detect`,
+     * `/form/fill`, or `/form/clear` job. The `pdf_url` field on a
+     * `FormResult` points at this endpoint — you can hand it
+     * directly to a browser, embed it in an `<iframe>`, or fetch the
+     * bytes from a backend.
+     *
+     * Returns `404` for non-form jobs (no PDF was produced) and for
+     * form jobs whose PDF artifact is no longer available.
+     * @throws {@link Pulse.NotFoundError}
+     * @throws {@link Pulse.InternalServerError}
+     */
+    getPdf(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getPdf(request, requestOptions));
+    }
+    __getPdf(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            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, `results/${core.url.encodePathParam(jobId)}/pdf`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                responseType: "binary-response",
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
+                    ? requestOptions.timeoutInSeconds * 1000
+                    : ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
+                        ? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
+                        : undefined,
+                maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.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 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", "/results/{jobId}/pdf");
+        });
+    }
+}
+exports.ResultsClient = ResultsClient;

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

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

package/dist/cjs/api/resources/results/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);