pulse-ts-sdk 1.0.10 → 1.0.11

package/README.md

@@ -55,7 +55,7 @@ following namespace:
 ```typescript
 import { Pulse } from "pulse-ts-sdk";
 
-const request: Pulse.FormDetectJsonInput = {
+const request: Pulse.FormDetectMultipartInput = {
     ...
 };
 ```
@@ -89,7 +89,7 @@ import { createReadStream } from "fs";
 import { PulseClient } from "pulse-ts-sdk";
 
 const client = new PulseClient({ apiKey: "YOUR_API_KEY" });
-await client.extract({});
+await client.form.detect({});
 ```
 The client accepts a variety of types for file upload parameters:
 * Stream types: `fs.ReadStream`, `stream.Readable`, and `ReadableStream`

package/dist/cjs/Client.js

@@ -129,6 +129,9 @@ class PulseClient {
             if (request.model != null) {
                 _request.append("model", request.model);
             }
+            if (request.extractionConfigId != null) {
+                _request.append("extractionConfigId", request.extractionConfigId);
+            }
             if (request.pages != null) {
                 _request.append("pages", request.pages);
             }
@@ -151,7 +154,7 @@ class PulseClient {
                 _request.append("structuredOutput", (0, json_js_1.toJson)(request.structuredOutput));
             }
             if (request.schema != null) {
-                _request.append("schema", typeof request.schema === "string" ? request.schema : (0, json_js_1.toJson)(request.schema));
+                _request.append("schema", (0, json_js_1.toJson)(request.schema));
             }
             if (request.schemaPrompt != null) {
                 _request.append("schemaPrompt", request.schemaPrompt);
@@ -257,6 +260,9 @@ class PulseClient {
             if (request.model != null) {
                 _request.append("model", request.model);
             }
+            if (request.extractionConfigId != null) {
+                _request.append("extractionConfigId", request.extractionConfigId);
+            }
             if (request.pages != null) {
                 _request.append("pages", request.pages);
             }
@@ -279,7 +285,7 @@ class PulseClient {
                 _request.append("structuredOutput", (0, json_js_1.toJson)(request.structuredOutput));
             }
             if (request.schema != null) {
-                _request.append("schema", typeof request.schema === "string" ? request.schema : (0, json_js_1.toJson)(request.schema));
+                _request.append("schema", (0, json_js_1.toJson)(request.schema));
             }
             if (request.schemaPrompt != null) {
                 _request.append("schemaPrompt", request.schemaPrompt);

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

@@ -10,6 +10,8 @@ export interface ExtractAsyncRequest {
     fileUrl?: string;
     /** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
     model?: ExtractAsyncRequest.Model;
+    /** UUID of a saved extraction configuration (a "preset"). When provided, the server loads the saved configuration and applies its options on top of any inline parameters supplied in this request. Inline parameters always take precedence over preset values for the same field. Saved configs are managed via the platform UI or the `input_extractions` admin endpoints. */
+    extractionConfigId?: string;
     /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
     pages?: string;
     /** Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response. */

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

@@ -10,6 +10,8 @@ export interface ExtractRequest {
     fileUrl?: string;
     /** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
     model?: ExtractRequest.Model;
+    /** UUID of a saved extraction configuration (a "preset"). When provided, the server loads the saved configuration and applies its options on top of any inline parameters supplied in this request. Inline parameters always take precedence over preset values for the same field. Saved configs are managed via the platform UI or the `input_extractions` admin endpoints. */
+    extractionConfigId?: string;
     /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
     pages?: string;
     /** Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response. */

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

@@ -23,11 +23,17 @@ export declare class FormClient {
      * path and reuse the cached cells.
      *
      * **Input modes** — provide exactly one of:
-     * - `form_id` (JSON) — re-detect cells on a previously stored
-     *   PDF. Useful when callers want to refresh layout after editing
-     *   or when chaining detect calls.
-     * - `file` (multipart) or `file_url` (JSON or multipart) — start
-     *   from a raw PDF.
+     * - `form_id` — re-detect cells on a previously stored PDF.
+     *   Useful when callers want to refresh layout after editing or
+     *   when chaining detect calls.
+     * - `file_url` — public or pre-signed URL Pulse will download.
+     * - `file` — direct binary upload of the PDF.
+     *
+     * All three input modes ride on the same `multipart/form-data`
+     * request body. (Callers sending `Content-Type: application/json`
+     * with `form_id` / `file_url` are still accepted server-side for
+     * backward compatibility, but the SDKs only model the multipart
+     * form.)
      *
      * Optional `page_range` (alias `pages`, e.g. `"1-3,5"`) restricts
      * the operation to a subset of pages.
@@ -39,7 +45,7 @@ export declare class FormClient {
      * Billed at **1 credit per page**. Requires the `form_filler`
      * feature flag to be enabled for your organization.
      *
-     * @param {Pulse.FormDetectJsonInput} request
+     * @param {Pulse.FormDetectMultipartInput} request
      * @param {FormClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pulse.BadRequestError}
@@ -50,9 +56,10 @@ export declare class FormClient {
      * @throws {@link Pulse.InternalServerError}
      *
      * @example
-     *     await client.form.detect()
+     *     import { createReadStream } from "fs";
+     *     await client.form.detect({})
      */
-    detect(request?: Pulse.FormDetectJsonInput, requestOptions?: FormClient.RequestOptions): core.HttpResponsePromise<Pulse.FormResult>;
+    detect(request: Pulse.FormDetectMultipartInput, requestOptions?: FormClient.RequestOptions): core.HttpResponsePromise<Pulse.FormResult>;
     private __detect;
     /**
      * Fill the fields of a PDF form with values inferred from a natural
@@ -61,13 +68,20 @@ export declare class FormClient {
      * are rendered as an overlay using detected cells from OCR).
      *
      * **Input modes** — provide exactly one of:
-     * - `form_id` (JSON) — reuse a previously processed form from a
-     *   prior `/form/detect`, `/form/fill`, or `/form/clear` call.
-     *   Skips re-detection (fast path); the cached `form_fields` are
+     * - `form_id` — reuse a previously processed form from a prior
+     *   `/form/detect`, `/form/fill`, or `/form/clear` call. Skips
+     *   re-detection (fast path); the cached `form_fields` are
      *   reused.
-     * - `file` (multipart) or `file_url` (JSON or multipart) — start
-     *   from a raw PDF. Pulse runs cell detection internally before
-     *   filling.
+     * - `file_url` — public or pre-signed URL of a PDF Pulse will
+     *   download.
+     * - `file` — direct binary upload of the PDF. Pulse runs cell
+     *   detection internally before filling.
+     *
+     * All three input modes ride on the same `multipart/form-data`
+     * request body. (Callers sending `Content-Type: application/json`
+     * with `form_id` / `file_url` are still accepted server-side for
+     * backward compatibility, but the SDKs only model the multipart
+     * form.)
      *
      * Optional `form_fields` lets callers supply or edit the detected
      * cells before filling. Optional `page_range` (alias `pages`,
@@ -81,7 +95,7 @@ export declare class FormClient {
      * Billed at **3 credits per page**. Requires the `form_filler`
      * feature flag to be enabled for your organization.
      *
-     * @param {Pulse.FormFillJsonInput} request
+     * @param {Pulse.FormFillMultipartInput} request
      * @param {FormClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pulse.BadRequestError}
@@ -92,11 +106,12 @@ export declare class FormClient {
      * @throws {@link Pulse.InternalServerError}
      *
      * @example
+     *     import { createReadStream } from "fs";
      *     await client.form.fill({
      *         instructions: "instructions"
      *     })
      */
-    fill(request: Pulse.FormFillJsonInput, requestOptions?: FormClient.RequestOptions): core.HttpResponsePromise<Pulse.FormResult>;
+    fill(request: Pulse.FormFillMultipartInput, requestOptions?: FormClient.RequestOptions): core.HttpResponsePromise<Pulse.FormResult>;
     private __fill;
     /**
      * Remove user-entered data from a PDF form, leaving the blank
@@ -106,11 +121,18 @@ export declare class FormClient {
      * preserved.
      *
      * **Input modes** — provide exactly one of:
-     * - `form_id` (JSON) — reuse a previously processed form from a
-     *   prior `/form/detect`, `/form/fill`, or `/form/clear` call
-     *   (fast path; cached layout reused).
-     * - `file` (multipart) or `file_url` (JSON or multipart) — start
-     *   from a raw PDF.
+     * - `form_id` — reuse a previously processed form from a prior
+     *   `/form/detect`, `/form/fill`, or `/form/clear` call (fast
+     *   path; cached layout reused).
+     * - `file_url` — public or pre-signed URL of a PDF Pulse will
+     *   download.
+     * - `file` — direct binary upload of the PDF.
+     *
+     * All three input modes ride on the same `multipart/form-data`
+     * request body. (Callers sending `Content-Type: application/json`
+     * with `form_id` / `file_url` are still accepted server-side for
+     * backward compatibility, but the SDKs only model the multipart
+     * form.)
      *
      * `instructions` is optional. When omitted, Pulse clears every
      * user-filled field deterministically (no LLM call) on AcroForm
@@ -130,7 +152,7 @@ export declare class FormClient {
      * Billed at **3 credits per page**. Requires the `form_filler`
      * feature flag to be enabled for your organization.
      *
-     * @param {Pulse.FormClearJsonInput} request
+     * @param {Pulse.FormClearMultipartInput} request
      * @param {FormClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pulse.BadRequestError}
@@ -141,8 +163,9 @@ export declare class FormClient {
      * @throws {@link Pulse.InternalServerError}
      *
      * @example
-     *     await client.form.clear()
+     *     import { createReadStream } from "fs";
+     *     await client.form.clear({})
      */
-    clear(request?: Pulse.FormClearJsonInput, requestOptions?: FormClient.RequestOptions): core.HttpResponsePromise<Pulse.FormResult>;
+    clear(request: Pulse.FormClearMultipartInput, requestOptions?: FormClient.RequestOptions): core.HttpResponsePromise<Pulse.FormResult>;
     private __clear;
 }

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

@@ -68,11 +68,17 @@ class FormClient {
      * path and reuse the cached cells.
      *
      * **Input modes** — provide exactly one of:
-     * - `form_id` (JSON) — re-detect cells on a previously stored
-     *   PDF. Useful when callers want to refresh layout after editing
-     *   or when chaining detect calls.
-     * - `file` (multipart) or `file_url` (JSON or multipart) — start
-     *   from a raw PDF.
+     * - `form_id` — re-detect cells on a previously stored PDF.
+     *   Useful when callers want to refresh layout after editing or
+     *   when chaining detect calls.
+     * - `file_url` — public or pre-signed URL Pulse will download.
+     * - `file` — direct binary upload of the PDF.
+     *
+     * All three input modes ride on the same `multipart/form-data`
+     * request body. (Callers sending `Content-Type: application/json`
+     * with `form_id` / `file_url` are still accepted server-side for
+     * backward compatibility, but the SDKs only model the multipart
+     * form.)
      *
      * Optional `page_range` (alias `pages`, e.g. `"1-3,5"`) restricts
      * the operation to a subset of pages.
@@ -84,7 +90,7 @@ class FormClient {
      * Billed at **1 credit per page**. Requires the `form_filler`
      * feature flag to be enabled for your organization.
      *
-     * @param {Pulse.FormDetectJsonInput} request
+     * @param {Pulse.FormDetectMultipartInput} request
      * @param {FormClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pulse.BadRequestError}
@@ -95,24 +101,42 @@ class FormClient {
      * @throws {@link Pulse.InternalServerError}
      *
      * @example
-     *     await client.form.detect()
+     *     import { createReadStream } from "fs";
+     *     await client.form.detect({})
      */
-    detect(request = {}, requestOptions) {
+    detect(request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__detect(request, requestOptions));
     }
-    __detect() {
-        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+    __detect(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h;
+            const _request = yield core.newFormData();
+            if (request.file != null) {
+                yield _request.appendFile("file", request.file);
+            }
+            if (request.file_url != null) {
+                _request.append("file_url", request.file_url);
+            }
+            if (request.form_id != null) {
+                _request.append("form_id", request.form_id);
+            }
+            if (request.page_range != null) {
+                _request.append("page_range", request.page_range);
+            }
+            if (request.async != null) {
+                _request.append("async", request.async);
+            }
+            const _maybeEncodedRequest = yield _request.getRequest();
             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 _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, _maybeEncodedRequest.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, "form/detect"),
                 method: "POST",
                 headers: _headers,
-                contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                requestType: "json",
-                body: request,
+                requestType: "file",
+                duplex: _maybeEncodedRequest.duplex,
+                body: _maybeEncodedRequest.body,
                 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
@@ -158,13 +182,20 @@ class FormClient {
      * are rendered as an overlay using detected cells from OCR).
      *
      * **Input modes** — provide exactly one of:
-     * - `form_id` (JSON) — reuse a previously processed form from a
-     *   prior `/form/detect`, `/form/fill`, or `/form/clear` call.
-     *   Skips re-detection (fast path); the cached `form_fields` are
+     * - `form_id` — reuse a previously processed form from a prior
+     *   `/form/detect`, `/form/fill`, or `/form/clear` call. Skips
+     *   re-detection (fast path); the cached `form_fields` are
      *   reused.
-     * - `file` (multipart) or `file_url` (JSON or multipart) — start
-     *   from a raw PDF. Pulse runs cell detection internally before
-     *   filling.
+     * - `file_url` — public or pre-signed URL of a PDF Pulse will
+     *   download.
+     * - `file` — direct binary upload of the PDF. Pulse runs cell
+     *   detection internally before filling.
+     *
+     * All three input modes ride on the same `multipart/form-data`
+     * request body. (Callers sending `Content-Type: application/json`
+     * with `form_id` / `file_url` are still accepted server-side for
+     * backward compatibility, but the SDKs only model the multipart
+     * form.)
      *
      * Optional `form_fields` lets callers supply or edit the detected
      * cells before filling. Optional `page_range` (alias `pages`,
@@ -178,7 +209,7 @@ class FormClient {
      * Billed at **3 credits per page**. Requires the `form_filler`
      * feature flag to be enabled for your organization.
      *
-     * @param {Pulse.FormFillJsonInput} request
+     * @param {Pulse.FormFillMultipartInput} request
      * @param {FormClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pulse.BadRequestError}
@@ -189,6 +220,7 @@ class FormClient {
      * @throws {@link Pulse.InternalServerError}
      *
      * @example
+     *     import { createReadStream } from "fs";
      *     await client.form.fill({
      *         instructions: "instructions"
      *     })
@@ -199,16 +231,37 @@ class FormClient {
     __fill(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h;
+            const _request = yield core.newFormData();
+            if (request.file != null) {
+                yield _request.appendFile("file", request.file);
+            }
+            if (request.file_url != null) {
+                _request.append("file_url", request.file_url);
+            }
+            if (request.form_id != null) {
+                _request.append("form_id", request.form_id);
+            }
+            _request.append("instructions", request.instructions);
+            if (request.form_fields != null) {
+                _request.append("form_fields", request.form_fields);
+            }
+            if (request.page_range != null) {
+                _request.append("page_range", request.page_range);
+            }
+            if (request.async != null) {
+                _request.append("async", request.async);
+            }
+            const _maybeEncodedRequest = yield _request.getRequest();
             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 _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, _maybeEncodedRequest.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, "form/fill"),
                 method: "POST",
                 headers: _headers,
-                contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                requestType: "json",
-                body: request,
+                requestType: "file",
+                duplex: _maybeEncodedRequest.duplex,
+                body: _maybeEncodedRequest.body,
                 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
@@ -255,11 +308,18 @@ class FormClient {
      * preserved.
      *
      * **Input modes** — provide exactly one of:
-     * - `form_id` (JSON) — reuse a previously processed form from a
-     *   prior `/form/detect`, `/form/fill`, or `/form/clear` call
-     *   (fast path; cached layout reused).
-     * - `file` (multipart) or `file_url` (JSON or multipart) — start
-     *   from a raw PDF.
+     * - `form_id` — reuse a previously processed form from a prior
+     *   `/form/detect`, `/form/fill`, or `/form/clear` call (fast
+     *   path; cached layout reused).
+     * - `file_url` — public or pre-signed URL of a PDF Pulse will
+     *   download.
+     * - `file` — direct binary upload of the PDF.
+     *
+     * All three input modes ride on the same `multipart/form-data`
+     * request body. (Callers sending `Content-Type: application/json`
+     * with `form_id` / `file_url` are still accepted server-side for
+     * backward compatibility, but the SDKs only model the multipart
+     * form.)
      *
      * `instructions` is optional. When omitted, Pulse clears every
      * user-filled field deterministically (no LLM call) on AcroForm
@@ -279,7 +339,7 @@ class FormClient {
      * Billed at **3 credits per page**. Requires the `form_filler`
      * feature flag to be enabled for your organization.
      *
-     * @param {Pulse.FormClearJsonInput} request
+     * @param {Pulse.FormClearMultipartInput} request
      * @param {FormClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pulse.BadRequestError}
@@ -290,24 +350,48 @@ class FormClient {
      * @throws {@link Pulse.InternalServerError}
      *
      * @example
-     *     await client.form.clear()
+     *     import { createReadStream } from "fs";
+     *     await client.form.clear({})
      */
-    clear(request = {}, requestOptions) {
+    clear(request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__clear(request, requestOptions));
     }
-    __clear() {
-        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+    __clear(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h;
+            const _request = yield core.newFormData();
+            if (request.file != null) {
+                yield _request.appendFile("file", request.file);
+            }
+            if (request.file_url != null) {
+                _request.append("file_url", request.file_url);
+            }
+            if (request.form_id != null) {
+                _request.append("form_id", request.form_id);
+            }
+            if (request.instructions != null) {
+                _request.append("instructions", request.instructions);
+            }
+            if (request.form_fields != null) {
+                _request.append("form_fields", request.form_fields);
+            }
+            if (request.page_range != null) {
+                _request.append("page_range", request.page_range);
+            }
+            if (request.async != null) {
+                _request.append("async", request.async);
+            }
+            const _maybeEncodedRequest = yield _request.getRequest();
             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 _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, _maybeEncodedRequest.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, "form/clear"),
                 method: "POST",
                 headers: _headers,
-                contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                requestType: "json",
-                body: request,
+                requestType: "file",
+                duplex: _maybeEncodedRequest.duplex,
+                body: _maybeEncodedRequest.body,
                 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

package/dist/cjs/api/{types → resources/form/client/requests}/FormClearMultipartInput.d.ts

@@ -1,12 +1,12 @@
+import type * as core from "../../../../../core/index.js";
 /**
- * Multipart `/form/clear` request. Use this variant to upload a
- * PDF directly via `file`. Provide exactly one of `file`,
- * `file_url`, or `form_id`.
+ * @example
+ *     {}
  */
 export interface FormClearMultipartInput {
-    /** PDF file to upload directly. */
-    file?: string;
-    /** Alternative to `file`: a public or pre-signed URL Pulse will download. */
+    /** Direct binary upload of the PDF. Mutually exclusive with `file_url` and `form_id`. */
+    file?: core.file.Uploadable | undefined;
+    /** Public or pre-signed URL of a PDF Pulse will download. Mutually exclusive with `file` and `form_id`. */
     file_url?: string;
     /** Reference to a previously processed form. Mutually exclusive with `file` / `file_url`. */
     form_id?: string;

package/dist/cjs/api/{types → resources/form/client/requests}/FormDetectMultipartInput.d.ts

@@ -1,11 +1,12 @@
+import type * as core from "../../../../../core/index.js";
 /**
- * Multipart `/form/detect` request. Use this variant to upload a
- * PDF directly via `file`.
+ * @example
+ *     {}
  */
 export interface FormDetectMultipartInput {
-    /** PDF file to upload directly. */
-    file?: string;
-    /** Alternative to `file`: a public or pre-signed URL Pulse will download. */
+    /** Direct binary upload of the PDF. Mutually exclusive with `file_url` and `form_id`. */
+    file?: core.file.Uploadable | undefined;
+    /** Public or pre-signed URL of a PDF Pulse will download. Mutually exclusive with `file` and `form_id`. */
     file_url?: string;
     /** Reference to a previously processed form. Mutually exclusive with `file` / `file_url`. */
     form_id?: string;

package/dist/cjs/api/{types → resources/form/client/requests}/FormFillMultipartInput.d.ts

@@ -1,17 +1,19 @@
+import type * as core from "../../../../../core/index.js";
 /**
- * Multipart `/form/fill` request. Use this variant to upload a
- * PDF directly via `file`. Provide exactly one of `file`,
- * `file_url`, or `form_id`.
+ * @example
+ *     {
+ *         instructions: "instructions"
+ *     }
  */
 export interface FormFillMultipartInput {
-    /** PDF file to upload directly. */
-    file?: string;
-    /** Alternative to `file`: a public or pre-signed URL Pulse will download. */
+    /** Direct binary upload of the PDF. Mutually exclusive with `file_url` and `form_id`. */
+    file?: core.file.Uploadable | undefined;
+    /** Public or pre-signed URL of a PDF Pulse will download. Mutually exclusive with `file` and `form_id`. */
     file_url?: string;
     /** Reference to a previously processed form. Mutually exclusive with `file` / `file_url`. */
     form_id?: string;
     /** Required natural-language fill prompt. */
-    instructions?: string;
+    instructions: string;
     /** Optional JSON-encoded array of `FormCell` objects to override detected cells. Multipart bodies must serialise this field as a string. */
     form_fields?: string;
     /** Restrict the operation to a subset of pages, e.g. `"1-3,5"`. */

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

@@ -1,3 +1,3 @@
-export type { FormClearJsonInput } from "./FormClearJsonInput.js";
-export type { FormDetectJsonInput } from "./FormDetectJsonInput.js";
-export type { FormFillJsonInput } from "./FormFillJsonInput.js";
+export type { FormClearMultipartInput } from "./FormClearMultipartInput.js";
+export type { FormDetectMultipartInput } from "./FormDetectMultipartInput.js";
+export type { FormFillMultipartInput } from "./FormFillMultipartInput.js";

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

@@ -8,6 +8,8 @@ export interface ExtractInput {
     fileUrl?: string;
     /** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
     model?: ExtractInput.Model;
+    /** UUID of a saved extraction configuration (a "preset"). When provided, the server loads the saved configuration and applies its options on top of any inline parameters supplied in this request. Inline parameters always take precedence over preset values for the same field. Saved configs are managed via the platform UI or the `input_extractions` admin endpoints. */
+    extractionConfigId?: string;
     /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
     pages?: string;
     /** Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response. */

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

@@ -4,6 +4,8 @@
 export interface ExtractOptions {
     /** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
     model?: ExtractOptions.Model;
+    /** UUID of a saved extraction configuration (a "preset"). When provided, the server loads the saved configuration and applies its options on top of any inline parameters supplied in this request. Inline parameters always take precedence over preset values for the same field. Saved configs are managed via the platform UI or the `input_extractions` admin endpoints. */
+    extractionConfigId?: string;
     /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
     pages?: string;
     /** Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response. */

package/dist/cjs/api/{resources/form/client/requests → types}/FormClearJsonInput.d.ts

@@ -1,7 +1,7 @@
-import type * as Pulse from "../../../../index.js";
+import type * as Pulse from "../index.js";
 /**
- * @example
- *     {}
+ * JSON request body for `/form/clear`. Provide exactly one of
+ * `form_id`, `file_url`, or `file` (multipart only).
  */
 export interface FormClearJsonInput {
     /** ID returned by a previous `/form/detect`, `/form/fill`, or `/form/clear` call (fast path; skips re-detection). */

package/dist/cjs/api/{resources/form/client/requests → types}/FormDetectJsonInput.d.ts

@@ -1,6 +1,6 @@
 /**
- * @example
- *     {}
+ * JSON request body for `/form/detect`. Provide exactly one of
+ * `form_id`, `file_url`, or `file` (multipart only).
  */
 export interface FormDetectJsonInput {
     /** Re-detect cells on a previously stored PDF (returned by an earlier `/form/detect`, `/form/fill`, or `/form/clear` call). Useful when chaining detect calls or refreshing layout after edits. */

package/dist/cjs/api/{resources/form/client/requests → types}/FormFillJsonInput.d.ts

@@ -1,9 +1,7 @@
-import type * as Pulse from "../../../../index.js";
+import type * as Pulse from "../index.js";
 /**
- * @example
- *     {
- *         instructions: "instructions"
- *     }
+ * JSON request body for `/form/fill`. Provide exactly one of
+ * `form_id`, `file_url`, or `file` (multipart only).
  */
 export interface FormFillJsonInput {
     /** ID returned by a previous `/form/detect`, `/form/fill`, or `/form/clear` call. Reuses the stored PDF and cached `form_fields` (fast path; skips re-detection). */

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

@@ -5,6 +5,8 @@ import type * as Pulse from "../index.js";
 export interface PipelineStepBatchExtractConfig {
     /** Extraction model to use. When set to `pulse-ultra-2`, routes the request through Pulse Ultra 2 (self-hosted VPC model) instead of the default cloud-based service. If omitted or set to `default`, the default model is used. */
     model?: PipelineStepBatchExtractConfig.Model;
+    /** UUID of a saved extraction configuration (a "preset"). When provided, the server loads the saved configuration and applies its options on top of any inline parameters supplied in this request. Inline parameters always take precedence over preset values for the same field. Saved configs are managed via the platform UI or the `input_extractions` admin endpoints. */
+    extractionConfigId?: string;
     /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
     pages?: string;
     /** Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response. */

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

@@ -16,9 +16,9 @@ export * from "./ExtractResultCore.js";
 export * from "./ExtractSource.js";
 export * from "./FormCell.js";
 export * from "./FormCheckboxDetail.js";
-export * from "./FormClearMultipartInput.js";
-export * from "./FormDetectMultipartInput.js";
-export * from "./FormFillMultipartInput.js";
+export * from "./FormClearJsonInput.js";
+export * from "./FormDetectJsonInput.js";
+export * from "./FormFillJsonInput.js";
 export * from "./FormFillSharedOptions.js";
 export * from "./FormPlanInfo.js";
 export * from "./FormResult.js";