pulse-ts-sdk 1.0.6 → 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)
@@ -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.6",
-        "User-Agent": "pulse-ts-sdk/1.0.6",
+        "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

@@ -100,10 +100,20 @@ 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.
      *
@@ -125,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.

package/dist/cjs/Client.js

@@ -400,10 +400,20 @@ 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.
      *
@@ -471,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.

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 });

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

@@ -4,8 +4,10 @@ import type * as Pulse from "../../index.js";
  *     {}
  */
 export interface SchemaInput {
-    /** ID of saved extraction to apply the schema to. Use for single-mode schema extraction. */
+    /** ID of a saved extraction OR a batch extract job. When a batch extract ID is provided, the system auto-detects it and combines all completed child extractions into a single schema application. */
     extraction_id?: string;
+    /** Explicit list of extraction IDs to combine. The markdown and bounding boxes from all extractions are merged and the schema is applied to the composite content. Citations use `extraction_id-bb_id` format to disambiguate across source documents. */
+    extraction_ids?: string[];
     /** ID of saved split (from a prior `/split` call). Use for split-mode schema extraction. */
     split_id?: string;
     /** Inline schema configuration for single mode. Required (with extraction_id) if schema_config_id is not provided. */

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

@@ -1,3 +1,4 @@
+export type { DownloadSchemaExcelRequest } from "./DownloadSchemaExcelRequest.js";
 export type { ExtractAsyncRequest } from "./ExtractAsyncRequest.js";
 export type { ExtractRequest } from "./ExtractRequest.js";
 export type { SchemaInput } from "./SchemaInput.js";

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

@@ -1,9 +1,11 @@
 /**
- * Inline schema configuration.
+ * Inline schema configuration. Provide `input_schema` (JSON Schema) OR `excel_template` (base64 .xlsx) — not both. When `excel_template` is provided, the JSON Schema is auto-generated from the spreadsheet's column headers.
  */
 export interface SchemaConfig {
-    /** JSON Schema defining the structured data to extract. */
-    input_schema: Record<string, unknown>;
+    /** JSON Schema defining the structured data to extract. Required unless `excel_template` is provided. */
+    input_schema?: Record<string, unknown>;
+    /** Base64-encoded Excel template (.xlsx). When provided, the template's column headers are used to auto-generate the JSON Schema and a filled copy of the template is returned in the response as `excel_output_url`. Mutually exclusive with `input_schema`. */
+    excel_template?: string;
     /** Natural language prompt with additional extraction instructions. */
     schema_prompt?: string;
     /** Enable extended reasoning for complex extractions. */

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

@@ -9,4 +9,8 @@ export interface SingleSchemaResponse {
     version: number;
     /** Extracted values and citations. */
     schema_output: Pulse.StructuredOutputResult;
+    /** Present when multiple extractions were combined (via batch extract auto-detection or explicit `extraction_ids` input). Lists all source extraction IDs that contributed to the result. */
+    extraction_ids?: string[];
+    /** API path to download the filled Excel template (e.g. `/schema/{schema_id}/excel`). Requires the same API key authentication. Only present when `excel_template` was provided in the request. */
+    excel_output_url?: string;
 }

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.6";
+export declare const SDK_VERSION = "1.0.7";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "1.0.6";
+exports.SDK_VERSION = "1.0.7";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "pulse-ts-sdk",
-        "X-Fern-SDK-Version": "1.0.6",
-        "User-Agent": "pulse-ts-sdk/1.0.6",
+        "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/esm/Client.d.mts

@@ -100,10 +100,20 @@ 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.
      *
@@ -125,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.

package/dist/esm/Client.mjs

@@ -364,10 +364,20 @@ export 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.
      *
@@ -435,6 +445,55 @@ export class PulseClient {
             return 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 = 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 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.

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

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

package/dist/esm/api/client/requests/DownloadSchemaExcelRequest.mjs

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

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

@@ -4,8 +4,10 @@ import type * as Pulse from "../../index.mjs";
  *     {}
  */
 export interface SchemaInput {
-    /** ID of saved extraction to apply the schema to. Use for single-mode schema extraction. */
+    /** ID of a saved extraction OR a batch extract job. When a batch extract ID is provided, the system auto-detects it and combines all completed child extractions into a single schema application. */
     extraction_id?: string;
+    /** Explicit list of extraction IDs to combine. The markdown and bounding boxes from all extractions are merged and the schema is applied to the composite content. Citations use `extraction_id-bb_id` format to disambiguate across source documents. */
+    extraction_ids?: string[];
     /** ID of saved split (from a prior `/split` call). Use for split-mode schema extraction. */
     split_id?: string;
     /** Inline schema configuration for single mode. Required (with extraction_id) if schema_config_id is not provided. */

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

@@ -1,3 +1,4 @@
+export type { DownloadSchemaExcelRequest } from "./DownloadSchemaExcelRequest.mjs";
 export type { ExtractAsyncRequest } from "./ExtractAsyncRequest.mjs";
 export type { ExtractRequest } from "./ExtractRequest.mjs";
 export type { SchemaInput } from "./SchemaInput.mjs";

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

@@ -1,9 +1,11 @@
 /**
- * Inline schema configuration.
+ * Inline schema configuration. Provide `input_schema` (JSON Schema) OR `excel_template` (base64 .xlsx) — not both. When `excel_template` is provided, the JSON Schema is auto-generated from the spreadsheet's column headers.
  */
 export interface SchemaConfig {
-    /** JSON Schema defining the structured data to extract. */
-    input_schema: Record<string, unknown>;
+    /** JSON Schema defining the structured data to extract. Required unless `excel_template` is provided. */
+    input_schema?: Record<string, unknown>;
+    /** Base64-encoded Excel template (.xlsx). When provided, the template's column headers are used to auto-generate the JSON Schema and a filled copy of the template is returned in the response as `excel_output_url`. Mutually exclusive with `input_schema`. */
+    excel_template?: string;
     /** Natural language prompt with additional extraction instructions. */
     schema_prompt?: string;
     /** Enable extended reasoning for complex extractions. */

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

@@ -9,4 +9,8 @@ export interface SingleSchemaResponse {
     version: number;
     /** Extracted values and citations. */
     schema_output: Pulse.StructuredOutputResult;
+    /** Present when multiple extractions were combined (via batch extract auto-detection or explicit `extraction_ids` input). Lists all source extraction IDs that contributed to the result. */
+    extraction_ids?: string[];
+    /** API path to download the filled Excel template (e.g. `/schema/{schema_id}/excel`). Requires the same API key authentication. Only present when `excel_template` was provided in the request. */
+    excel_output_url?: string;
 }

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.6";
+export declare const SDK_VERSION = "1.0.7";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.0.6";
+export const SDK_VERSION = "1.0.7";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pulse-ts-sdk",
-    "version": "1.0.6",
+    "version": "1.0.7",
     "private": false,
     "repository": {
         "type": "git",

package/reference.md

@@ -231,10 +231,20 @@ inferred from the input:
 **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.
 
@@ -287,6 +297,74 @@ await client.schema();
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.<a href="/src/Client.ts">downloadSchemaExcel</a>({ ...params }) -> core.BinaryResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.downloadSchemaExcel({
+    schemaId: "schemaId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pulse.DownloadSchemaExcelRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PulseClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>