pulse-ts-sdk 1.0.5 → 1.0.7

package/README.md

@@ -13,6 +13,7 @@ The Pulse TypeScript library provides convenient access to the Pulse APIs from T
 - [Request and Response Types](#request-and-response-types)
 - [Exception Handling](#exception-handling)
 - [File Uploads](#file-uploads)
+- [Binary Response](#binary-response)
 - [Advanced](#advanced)
   - [Additional Headers](#additional-headers)
   - [Additional Query String Parameters](#additional-query-string-parameters)
@@ -54,7 +55,7 @@ following namespace:
 ```typescript
 import { Pulse } from "pulse-ts-sdk";
 
-const request: Pulse.GetJobRequest = {
+const request: Pulse.BatchExtractInput = {
     ...
 };
 ```
@@ -120,6 +121,395 @@ The metadata is used to set the `Content-Length`, `Content-Type`, and `Content-D
 For example, `fs.ReadStream` has a `path` property which the SDK uses to retrieve the file size from the filesystem without loading it into memory.
 
 
+## Binary Response
+
+You can consume binary data from endpoints using the `BinaryResponse` type which lets you choose how to consume the data:
+
+```typescript
+const response = await client.downloadSchemaExcel(...);
+const stream: ReadableStream<Uint8Array> = response.stream();
+// const arrayBuffer: ArrayBuffer = await response.arrayBuffer();
+// const blob: Blob = response.blob();
+// const bytes: Uint8Array = response.bytes();
+// You can only use the response body once, so you must choose one of the above methods.
+// If you want to check if the response body has been used, you can use the following property.
+const bodyUsed = response.bodyUsed;
+```
+<details>
+<summary>Save binary response to a file</summary>
+
+<blockquote>
+<details>
+<summary>Node.js</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream (most-efficient)</summary>
+
+```ts
+import { createWriteStream } from 'fs';
+import { Readable } from 'stream';
+import { pipeline } from 'stream/promises';
+
+const response = await client.downloadSchemaExcel(...);
+
+const stream = response.stream();
+const nodeStream = Readable.fromWeb(stream);
+const writeStream = createWriteStream('path/to/file');
+
+await pipeline(nodeStream, writeStream);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+import { writeFile } from 'fs/promises';
+
+const response = await client.downloadSchemaExcel(...);
+
+const arrayBuffer = await response.arrayBuffer();
+await writeFile('path/to/file', Buffer.from(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+import { writeFile } from 'fs/promises';
+
+const response = await client.downloadSchemaExcel(...);
+
+const blob = await response.blob();
+const arrayBuffer = await blob.arrayBuffer();
+await writeFile('output.bin', Buffer.from(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+import { writeFile } from 'fs/promises';
+
+const response = await client.downloadSchemaExcel(...);
+
+const bytes = await response.bytes();
+await writeFile('path/to/file', bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bun</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream (most-efficient)</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const stream = response.stream();
+await Bun.write('path/to/file', stream);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const arrayBuffer = await response.arrayBuffer();
+await Bun.write('path/to/file', arrayBuffer);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const blob = await response.blob();
+await Bun.write('path/to/file', blob);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const bytes = await response.bytes();
+await Bun.write('path/to/file', bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Deno</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream (most-efficient)</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const stream = response.stream();
+const file = await Deno.open('path/to/file', { write: true, create: true });
+await stream.pipeTo(file.writable);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const arrayBuffer = await response.arrayBuffer();
+await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const blob = await response.blob();
+const arrayBuffer = await blob.arrayBuffer();
+await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const bytes = await response.bytes();
+await Deno.writeFile('path/to/file', bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Browser</summary>
+
+<blockquote>
+<details>
+<summary>Blob (most-efficient)</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const blob = await response.blob();
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ReadableStream</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const stream = response.stream();
+const reader = stream.getReader();
+const chunks = [];
+
+while (true) {
+  const { done, value } = await reader.read();
+  if (done) break;
+  chunks.push(value);
+}
+
+const blob = new Blob(chunks);
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const arrayBuffer = await response.arrayBuffer();
+const blob = new Blob([arrayBuffer]);
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const bytes = await response.bytes();
+const blob = new Blob([bytes]);
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<details>
+<summary>Convert binary response to text</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const stream = response.stream();
+const text = await new Response(stream).text();
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const arrayBuffer = await response.arrayBuffer();
+const text = new TextDecoder().decode(arrayBuffer);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const blob = await response.blob();
+const text = await blob.text();
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.downloadSchemaExcel(...);
+
+const bytes = await response.bytes();
+const text = new TextDecoder().decode(bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+
 ## Advanced
 
 ### Additional Headers

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.5",
-        "User-Agent": "pulse-ts-sdk/1.0.5",
+        "X-Fern-SDK-Version": "1.0.7",
+        "User-Agent": "pulse-ts-sdk/1.0.7",
         "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,4 +1,5 @@
 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 { WebhooksClient } from "./api/resources/webhooks/client/Client.js";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
@@ -11,9 +12,11 @@ export declare namespace PulseClient {
 }
 export declare class PulseClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<PulseClient.Options>;
+    protected _batch: BatchClient | undefined;
     protected _jobs: JobsClient | undefined;
     protected _webhooks: WebhooksClient | undefined;
     constructor(options?: PulseClient.Options);
+    get batch(): BatchClient;
     get jobs(): JobsClient;
     get webhooks(): WebhooksClient;
     /**
@@ -24,6 +27,9 @@ export declare class PulseClient {
      * Set `async: true` to return immediately with a job_id for polling via
      * GET /job/{jobId}. Otherwise processes synchronously.
      *
+     * To process many files at once, see [Batch Extract](api:POST/batch/extract)
+     * or the [Batch Processing guide](/batch).
+     *
      * @param {Pulse.ExtractRequest} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -68,6 +74,9 @@ export declare class PulseClient {
      *
      * Set `async: true` to return immediately with a job_id for polling.
      *
+     * To split many extractions at once, see [Batch Split](api:POST/batch/split)
+     * or the [Batch Processing guide](/batch).
+     *
      * @param {Pulse.SplitInput} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -91,13 +100,27 @@ export declare class PulseClient {
      * **Single mode** — Provide `extraction_id` + `schema_config` (or
      * `schema_config_id`) to apply one schema to the entire document.
      *
+     * **Multi-extraction mode** — Provide a batch extract ID as `extraction_id`
+     * (auto-detected) or an explicit `extraction_ids` list. The content from all
+     * extractions is combined and the schema is applied to the composite. Citations
+     * use `extraction_id-bb_id` format to disambiguate across source documents.
+     *
      * **Split mode** — Provide `split_id` + `split_schema_config` to apply
      * different schemas to different page groups from a prior `/split` call.
      * Each topic can have its own schema, prompt, and effort setting.
      *
+     * **Excel template mode** — Provide `excel_template` (base64 .xlsx) in
+     * `schema_config` instead of `input_schema`. The schema is auto-generated
+     * from the template's column headers, and a filled copy is returned as
+     * `excel_output_url`.
+     *
      * Creates a versioned schema record that can be retrieved later.
      * Set `async: true` to return immediately with a job_id for polling.
      *
+     * To apply schemas across many extractions or splits at once, see
+     * [Batch Schema](api:POST/batch/schema) or the
+     * [Batch Processing guide](/batch).
+     *
      * @param {Pulse.SchemaInput} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -112,6 +135,16 @@ export declare class PulseClient {
      */
     schema(request?: Pulse.SchemaInput, requestOptions?: PulseClient.RequestOptions): core.HttpResponsePromise<Pulse.SchemaResponse>;
     private __schema;
+    /**
+     * Download the filled Excel template produced by a schema extraction that
+     * used `excel_template` in its `schema_config`. Requires the same API key
+     * authentication as other endpoints. The caller must belong to the org
+     * that owns the underlying extraction.
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.NotFoundError}
+     */
+    downloadSchemaExcel(request: Pulse.DownloadSchemaExcelRequest, requestOptions?: PulseClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __downloadSchemaExcel;
     /**
      * Extract tables from a previously completed extraction. Processes the
      * extraction's document content and returns structured table data.
@@ -122,6 +155,10 @@ export declare class PulseClient {
      * Set `async: true` to return immediately with a `tables_id` for
      * polling via `GET /job/{tables_id}`.
      *
+     * To extract tables from many extractions at once, see
+     * [Batch Tables](api:POST/batch/tables) or the
+     * [Batch Processing guide](/batch).
+     *
      * @param {Pulse.TablesInput} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/Client.js

@@ -45,8 +45,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PulseClient = void 0;
 const Pulse = __importStar(require("./api/index.js"));
-const Client_js_1 = require("./api/resources/jobs/client/Client.js");
-const Client_js_2 = require("./api/resources/webhooks/client/Client.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 BaseClient_js_1 = require("./BaseClient.js");
 const headers_js_1 = require("./core/headers.js");
 const core = __importStar(require("./core/index.js"));
@@ -58,13 +59,17 @@ class PulseClient {
     constructor(options = {}) {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
+    get batch() {
+        var _a;
+        return ((_a = this._batch) !== null && _a !== void 0 ? _a : (this._batch = new Client_js_1.BatchClient(this._options)));
+    }
     get jobs() {
         var _a;
-        return ((_a = this._jobs) !== null && _a !== void 0 ? _a : (this._jobs = new Client_js_1.JobsClient(this._options)));
+        return ((_a = this._jobs) !== null && _a !== void 0 ? _a : (this._jobs = new Client_js_2.JobsClient(this._options)));
     }
     get webhooks() {
         var _a;
-        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_2.WebhooksClient(this._options)));
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_3.WebhooksClient(this._options)));
     }
     /**
      * The primary endpoint for the Pulse API. Parses uploaded documents or remote
@@ -74,6 +79,9 @@ class PulseClient {
      * Set `async: true` to return immediately with a job_id for polling via
      * GET /job/{jobId}. Otherwise processes synchronously.
      *
+     * To process many files at once, see [Batch Extract](api:POST/batch/extract)
+     * or the [Batch Processing guide](/batch).
+     *
      * @param {Pulse.ExtractRequest} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -98,6 +106,9 @@ class PulseClient {
             if (request.fileUrl != null) {
                 _request.append("fileUrl", request.fileUrl);
             }
+            if (request.model != null) {
+                _request.append("model", request.model);
+            }
             if (request.pages != null) {
                 _request.append("pages", request.pages);
             }
@@ -216,6 +227,9 @@ class PulseClient {
             if (request.fileUrl != null) {
                 _request.append("fileUrl", request.fileUrl);
             }
+            if (request.model != null) {
+                _request.append("model", request.model);
+            }
             if (request.pages != null) {
                 _request.append("pages", request.pages);
             }
@@ -314,6 +328,9 @@ class PulseClient {
      *
      * Set `async: true` to return immediately with a job_id for polling.
      *
+     * To split many extractions at once, see [Batch Split](api:POST/batch/split)
+     * or the [Batch Processing guide](/batch).
+     *
      * @param {Pulse.SplitInput} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -383,13 +400,27 @@ class PulseClient {
      * **Single mode** — Provide `extraction_id` + `schema_config` (or
      * `schema_config_id`) to apply one schema to the entire document.
      *
+     * **Multi-extraction mode** — Provide a batch extract ID as `extraction_id`
+     * (auto-detected) or an explicit `extraction_ids` list. The content from all
+     * extractions is combined and the schema is applied to the composite. Citations
+     * use `extraction_id-bb_id` format to disambiguate across source documents.
+     *
      * **Split mode** — Provide `split_id` + `split_schema_config` to apply
      * different schemas to different page groups from a prior `/split` call.
      * Each topic can have its own schema, prompt, and effort setting.
      *
+     * **Excel template mode** — Provide `excel_template` (base64 .xlsx) in
+     * `schema_config` instead of `input_schema`. The schema is auto-generated
+     * from the template's column headers, and a filled copy is returned as
+     * `excel_output_url`.
+     *
      * Creates a versioned schema record that can be retrieved later.
      * Set `async: true` to return immediately with a job_id for polling.
      *
+     * To apply schemas across many extractions or splits at once, see
+     * [Batch Schema](api:POST/batch/schema) or the
+     * [Batch Processing guide](/batch).
+     *
      * @param {Pulse.SchemaInput} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -450,6 +481,55 @@ class PulseClient {
             return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/schema");
         });
     }
+    /**
+     * Download the filled Excel template produced by a schema extraction that
+     * used `excel_template` in its `schema_config`. Requires the same API key
+     * authentication as other endpoints. The caller must belong to the org
+     * that owns the underlying extraction.
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.NotFoundError}
+     */
+    downloadSchemaExcel(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__downloadSchemaExcel(request, requestOptions));
+    }
+    __downloadSchemaExcel(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { schemaId } = 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, `schema/${core.url.encodePathParam(schemaId)}/excel`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                responseType: "binary-response",
+                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 401:
+                        throw new Pulse.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Pulse.NotFoundError(_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", "/schema/{schemaId}/excel");
+        });
+    }
     /**
      * Extract tables from a previously completed extraction. Processes the
      * extraction's document content and returns structured table data.
@@ -460,6 +540,10 @@ class PulseClient {
      * Set `async: true` to return immediately with a `tables_id` for
      * polling via `GET /job/{tables_id}`.
      *
+     * To extract tables from many extractions at once, see
+     * [Batch Tables](api:POST/batch/tables) or the
+     * [Batch Processing guide](/batch).
+     *
      * @param {Pulse.TablesInput} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         schemaId: "schemaId"
+ *     }
+ */
+export interface DownloadSchemaExcelRequest {
+    /** The schema ID returned from a prior `POST /schema` call. */
+    schemaId: string;
+}

package/dist/cjs/api/client/requests/DownloadSchemaExcelRequest.js

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