pulse-ts-sdk 1.0.8 → 1.0.10

package/dist/esm/api/resources/batch/client/Client.mjs

@@ -51,7 +51,7 @@ export class BatchClient {
     }
     __extract(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            var _a, _b, _c, _d, _e, _f, _g, _h;
             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({
@@ -62,10 +62,14 @@ export class BatchClient {
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 requestType: "json",
                 body: request,
-                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,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
+                    ? requestOptions.timeoutInSeconds * 1000
+                    : ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
+                        ? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
+                        : undefined,
+                maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -127,7 +131,7 @@ export class BatchClient {
     }
     __schema(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            var _a, _b, _c, _d, _e, _f, _g, _h;
             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({
@@ -138,10 +142,14 @@ export class BatchClient {
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 requestType: "json",
                 body: request,
-                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,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
+                    ? requestOptions.timeoutInSeconds * 1000
+                    : ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
+                        ? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
+                        : undefined,
+                maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -201,7 +209,7 @@ export class BatchClient {
     }
     __tables(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            var _a, _b, _c, _d, _e, _f, _g, _h;
             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({
@@ -212,10 +220,14 @@ export class BatchClient {
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 requestType: "json",
                 body: request,
-                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,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
+                    ? requestOptions.timeoutInSeconds * 1000
+                    : ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
+                        ? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
+                        : undefined,
+                maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -280,7 +292,7 @@ export class BatchClient {
     }
     __split(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            var _a, _b, _c, _d, _e, _f, _g, _h;
             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({
@@ -291,10 +303,14 @@ export class BatchClient {
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 requestType: "json",
                 body: request,
-                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,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
+                    ? requestOptions.timeoutInSeconds * 1000
+                    : ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
+                        ? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
+                        : undefined,
+                maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {

package/dist/esm/api/resources/form/client/Client.d.mts

@@ -0,0 +1,148 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Pulse from "../../../index.mjs";
+export declare namespace FormClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class FormClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<FormClient.Options>;
+    constructor(options?: FormClient.Options);
+    /**
+     * Run cell detection on a PDF and return the detected `form_fields`
+     * along with a reusable `form_id`. No LLM matching, no fill, no
+     * clear — this is the OCR / layout step that `/form/fill` and
+     * `/form/clear` would otherwise run internally.
+     *
+     * The returned `form_id` references the uploaded PDF and its
+     * detected layout, and can be passed back to a subsequent
+     * `/form/fill`, `/form/clear`, or `/form/detect` call as the
+     * single input source — Pulse will skip detection on the fast
+     * 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.
+     *
+     * Optional `page_range` (alias `pages`, e.g. `"1-3,5"`) restricts
+     * the operation to a subset of pages.
+     *
+     * Synchronous by default — returns the detected layout inline.
+     * Set `async: true` to receive `{job_id, status: "pending"}`
+     * immediately and poll [GET /job/{jobId}](api:GET/job/{jobId}).
+     *
+     * Billed at **1 credit per page**. Requires the `form_filler`
+     * feature flag to be enabled for your organization.
+     *
+     * @param {Pulse.FormDetectJsonInput} request
+     * @param {FormClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pulse.BadRequestError}
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.ForbiddenError}
+     * @throws {@link Pulse.NotFoundError}
+     * @throws {@link Pulse.TooManyRequestsError}
+     * @throws {@link Pulse.InternalServerError}
+     *
+     * @example
+     *     await client.form.detect()
+     */
+    detect(request?: Pulse.FormDetectJsonInput, requestOptions?: FormClient.RequestOptions): core.HttpResponsePromise<Pulse.FormResult>;
+    private __detect;
+    /**
+     * Fill the fields of a PDF form with values inferred from a natural
+     * language `instructions` prompt. Works on both AcroForm PDFs
+     * (true form fields are written) and flat/scanned PDFs (values
+     * 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
+     *   reused.
+     * - `file` (multipart) or `file_url` (JSON or multipart) — start
+     *   from a raw PDF. Pulse runs cell detection internally before
+     *   filling.
+     *
+     * Optional `form_fields` lets callers supply or edit the detected
+     * cells before filling. Optional `page_range` (alias `pages`,
+     * e.g. `"1-3,5"`) restricts the operation to a subset of pages.
+     *
+     * Synchronous by default — returns the filled `FormResult` inline
+     * (including a `pdf_url` you can `GET` to download the PDF
+     * binary). Set `async: true` to receive `{job_id, status:
+     * "pending"}` and poll [GET /job/{jobId}](api:GET/job/{jobId}).
+     *
+     * Billed at **3 credits per page**. Requires the `form_filler`
+     * feature flag to be enabled for your organization.
+     *
+     * @param {Pulse.FormFillJsonInput} request
+     * @param {FormClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pulse.BadRequestError}
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.ForbiddenError}
+     * @throws {@link Pulse.NotFoundError}
+     * @throws {@link Pulse.TooManyRequestsError}
+     * @throws {@link Pulse.InternalServerError}
+     *
+     * @example
+     *     await client.form.fill({
+     *         instructions: "instructions"
+     *     })
+     */
+    fill(request: Pulse.FormFillJsonInput, requestOptions?: FormClient.RequestOptions): core.HttpResponsePromise<Pulse.FormResult>;
+    private __fill;
+    /**
+     * Remove user-entered data from a PDF form, leaving the blank
+     * form template intact. Erases handwritten entries, typed values,
+     * and unchecks selected checkboxes — printed labels, field
+     * titles, section headers, and other static template content are
+     * 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.
+     *
+     * `instructions` is optional. When omitted, Pulse clears every
+     * user-filled field deterministically (no LLM call) on AcroForm
+     * PDFs, eliminating any chance of hallucinated content. Provide
+     * a natural language prompt to clear only specific fields
+     * (e.g. `"clear only the address fields"`); targeted clears go
+     * through the LLM matcher with a delete-only filter.
+     *
+     * Optional `form_fields` and `page_range` (alias `pages`) behave
+     * the same as on [Form Fill](api:POST/form/fill).
+     *
+     * Synchronous by default — returns the cleared `FormResult`
+     * inline (including a `pdf_url` you can `GET` to download the
+     * PDF binary). Set `async: true` to receive `{job_id, status:
+     * "pending"}` and poll [GET /job/{jobId}](api:GET/job/{jobId}).
+     *
+     * Billed at **3 credits per page**. Requires the `form_filler`
+     * feature flag to be enabled for your organization.
+     *
+     * @param {Pulse.FormClearJsonInput} request
+     * @param {FormClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pulse.BadRequestError}
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.ForbiddenError}
+     * @throws {@link Pulse.NotFoundError}
+     * @throws {@link Pulse.TooManyRequestsError}
+     * @throws {@link Pulse.InternalServerError}
+     *
+     * @example
+     *     await client.form.clear()
+     */
+    clear(request?: Pulse.FormClearJsonInput, requestOptions?: FormClient.RequestOptions): core.HttpResponsePromise<Pulse.FormResult>;
+    private __clear;
+}

package/dist/esm/api/resources/form/client/Client.mjs

@@ -0,0 +1,313 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import { mergeHeaders } from "../../../../core/headers.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as environments from "../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
+import * as errors from "../../../../errors/index.mjs";
+import * as Pulse from "../../../index.mjs";
+export class FormClient {
+    constructor(options = {}) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    /**
+     * Run cell detection on a PDF and return the detected `form_fields`
+     * along with a reusable `form_id`. No LLM matching, no fill, no
+     * clear — this is the OCR / layout step that `/form/fill` and
+     * `/form/clear` would otherwise run internally.
+     *
+     * The returned `form_id` references the uploaded PDF and its
+     * detected layout, and can be passed back to a subsequent
+     * `/form/fill`, `/form/clear`, or `/form/detect` call as the
+     * single input source — Pulse will skip detection on the fast
+     * 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.
+     *
+     * Optional `page_range` (alias `pages`, e.g. `"1-3,5"`) restricts
+     * the operation to a subset of pages.
+     *
+     * Synchronous by default — returns the detected layout inline.
+     * Set `async: true` to receive `{job_id, status: "pending"}`
+     * immediately and poll [GET /job/{jobId}](api:GET/job/{jobId}).
+     *
+     * Billed at **1 credit per page**. Requires the `form_filler`
+     * feature flag to be enabled for your organization.
+     *
+     * @param {Pulse.FormDetectJsonInput} request
+     * @param {FormClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pulse.BadRequestError}
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.ForbiddenError}
+     * @throws {@link Pulse.NotFoundError}
+     * @throws {@link Pulse.TooManyRequestsError}
+     * @throws {@link Pulse.InternalServerError}
+     *
+     * @example
+     *     await client.form.detect()
+     */
+    detect(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__detect(request, requestOptions));
+    }
+    __detect() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            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, "form/detect"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
+                    ? requestOptions.timeoutInSeconds * 1000
+                    : ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
+                        ? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
+                        : undefined,
+                maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pulse.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pulse.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pulse.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Pulse.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Pulse.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pulse.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PulseError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/form/detect");
+        });
+    }
+    /**
+     * Fill the fields of a PDF form with values inferred from a natural
+     * language `instructions` prompt. Works on both AcroForm PDFs
+     * (true form fields are written) and flat/scanned PDFs (values
+     * 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
+     *   reused.
+     * - `file` (multipart) or `file_url` (JSON or multipart) — start
+     *   from a raw PDF. Pulse runs cell detection internally before
+     *   filling.
+     *
+     * Optional `form_fields` lets callers supply or edit the detected
+     * cells before filling. Optional `page_range` (alias `pages`,
+     * e.g. `"1-3,5"`) restricts the operation to a subset of pages.
+     *
+     * Synchronous by default — returns the filled `FormResult` inline
+     * (including a `pdf_url` you can `GET` to download the PDF
+     * binary). Set `async: true` to receive `{job_id, status:
+     * "pending"}` and poll [GET /job/{jobId}](api:GET/job/{jobId}).
+     *
+     * Billed at **3 credits per page**. Requires the `form_filler`
+     * feature flag to be enabled for your organization.
+     *
+     * @param {Pulse.FormFillJsonInput} request
+     * @param {FormClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pulse.BadRequestError}
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.ForbiddenError}
+     * @throws {@link Pulse.NotFoundError}
+     * @throws {@link Pulse.TooManyRequestsError}
+     * @throws {@link Pulse.InternalServerError}
+     *
+     * @example
+     *     await client.form.fill({
+     *         instructions: "instructions"
+     *     })
+     */
+    fill(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__fill(request, requestOptions));
+    }
+    __fill(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = 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, "form/fill"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
+                    ? requestOptions.timeoutInSeconds * 1000
+                    : ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
+                        ? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
+                        : undefined,
+                maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pulse.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pulse.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pulse.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Pulse.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Pulse.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pulse.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PulseError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/form/fill");
+        });
+    }
+    /**
+     * Remove user-entered data from a PDF form, leaving the blank
+     * form template intact. Erases handwritten entries, typed values,
+     * and unchecks selected checkboxes — printed labels, field
+     * titles, section headers, and other static template content are
+     * 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.
+     *
+     * `instructions` is optional. When omitted, Pulse clears every
+     * user-filled field deterministically (no LLM call) on AcroForm
+     * PDFs, eliminating any chance of hallucinated content. Provide
+     * a natural language prompt to clear only specific fields
+     * (e.g. `"clear only the address fields"`); targeted clears go
+     * through the LLM matcher with a delete-only filter.
+     *
+     * Optional `form_fields` and `page_range` (alias `pages`) behave
+     * the same as on [Form Fill](api:POST/form/fill).
+     *
+     * Synchronous by default — returns the cleared `FormResult`
+     * inline (including a `pdf_url` you can `GET` to download the
+     * PDF binary). Set `async: true` to receive `{job_id, status:
+     * "pending"}` and poll [GET /job/{jobId}](api:GET/job/{jobId}).
+     *
+     * Billed at **3 credits per page**. Requires the `form_filler`
+     * feature flag to be enabled for your organization.
+     *
+     * @param {Pulse.FormClearJsonInput} request
+     * @param {FormClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pulse.BadRequestError}
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.ForbiddenError}
+     * @throws {@link Pulse.NotFoundError}
+     * @throws {@link Pulse.TooManyRequestsError}
+     * @throws {@link Pulse.InternalServerError}
+     *
+     * @example
+     *     await client.form.clear()
+     */
+    clear(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__clear(request, requestOptions));
+    }
+    __clear() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            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, "form/clear"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
+                    ? requestOptions.timeoutInSeconds * 1000
+                    : ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
+                        ? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
+                        : undefined,
+                maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pulse.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pulse.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pulse.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Pulse.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Pulse.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pulse.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PulseError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/form/clear");
+        });
+    }
+}

package/dist/esm/api/resources/form/client/index.d.mts

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

package/dist/esm/api/resources/form/client/index.mjs

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

package/dist/esm/api/resources/form/client/requests/FormClearJsonInput.d.mts

@@ -0,0 +1,19 @@
+import type * as Pulse from "../../../../index.mjs";
+/**
+ * @example
+ *     {}
+ */
+export interface FormClearJsonInput {
+    /** ID returned by a previous `/form/detect`, `/form/fill`, or `/form/clear` call (fast path; skips re-detection). */
+    form_id?: string;
+    /** Public or pre-signed URL of a PDF to download and clear. */
+    file_url?: string;
+    /** Optional natural-language description of what to clear. When omitted, Pulse clears every user-filled value deterministically (no LLM call) on AcroForm PDFs while preserving the blank form template. */
+    instructions?: string;
+    /** Optional override for the cells used when filling / clearing. When omitted, Pulse uses the cells stored on the referenced `form_id` (fast path) or runs detection on the uploaded PDF. Useful for editing detected cells before filling. */
+    form_fields?: Pulse.FormCell[];
+    /** Restrict the operation to a subset of pages. Accepts comma-separated page numbers and ranges, e.g. `"1-3,5"`. Alias: `pages`. */
+    page_range?: string;
+    /** When `true`, the endpoint returns immediately with `{job_id, status: "pending"}` (HTTP 202) and processes the job in the background. Poll [GET /job/{jobId}](api:GET/job/{jobId}) for the result. Default `false` — return the full result inline. */
+    async?: boolean;
+}

package/dist/esm/api/resources/form/client/requests/FormClearJsonInput.mjs

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

package/dist/esm/api/resources/form/client/requests/FormDetectJsonInput.d.mts

@@ -0,0 +1,14 @@
+/**
+ * @example
+ *     {}
+ */
+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. */
+    form_id?: string;
+    /** Public or pre-signed URL of a PDF to detect cells on. */
+    file_url?: string;
+    /** Restrict the operation to a subset of pages. Accepts comma-separated page numbers and ranges, e.g. `"1-3,5"`. Alias: `pages`. */
+    page_range?: string;
+    /** When `true`, the endpoint returns immediately with `{job_id, status: "pending"}` (HTTP 202) and processes the job in the background. Poll [GET /job/{jobId}](api:GET/job/{jobId}) for the result. Default `false` — return the full result inline. */
+    async?: boolean;
+}

package/dist/esm/api/resources/form/client/requests/FormDetectJsonInput.mjs

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

package/dist/esm/api/resources/form/client/requests/FormFillJsonInput.d.mts

@@ -0,0 +1,21 @@
+import type * as Pulse from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         instructions: "instructions"
+ *     }
+ */
+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). */
+    form_id?: string;
+    /** Public or pre-signed URL of a PDF to download and fill. */
+    file_url?: string;
+    /** Required natural-language description of what to fill into the form (e.g. `"Use John Doe, 123 Main St, born 1990-01-01"`). */
+    instructions: string;
+    /** Optional override for the cells used when filling / clearing. When omitted, Pulse uses the cells stored on the referenced `form_id` (fast path) or runs detection on the uploaded PDF. Useful for editing detected cells before filling. */
+    form_fields?: Pulse.FormCell[];
+    /** Restrict the operation to a subset of pages. Accepts comma-separated page numbers and ranges, e.g. `"1-3,5"`. Alias: `pages`. */
+    page_range?: string;
+    /** When `true`, the endpoint returns immediately with `{job_id, status: "pending"}` (HTTP 202) and processes the job in the background. Poll [GET /job/{jobId}](api:GET/job/{jobId}) for the result. Default `false` — return the full result inline. */
+    async?: boolean;
+}

package/dist/esm/api/resources/form/client/requests/FormFillJsonInput.mjs

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