pulse-ts-sdk 1.0.9 → 1.0.11

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

@@ -87,7 +87,7 @@ 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 = (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({
@@ -98,10 +98,14 @@ 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) {
@@ -163,7 +167,7 @@ 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 = (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({
@@ -174,10 +178,14 @@ 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) {
@@ -237,7 +245,7 @@ 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 = (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({
@@ -248,10 +256,14 @@ 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) {
@@ -316,7 +328,7 @@ 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 = (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({
@@ -327,10 +339,14 @@ 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/cjs/api/resources/form/client/Client.d.ts

@@ -0,0 +1,171 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Pulse from "../../../index.js";
+export declare namespace 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` — 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.
+     *
+     * 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.FormDetectMultipartInput} 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
+     *     import { createReadStream } from "fs";
+     *     await client.form.detect({})
+     */
+    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
+     * 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` — 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_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`,
+     * 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.FormFillMultipartInput} 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
+     *     import { createReadStream } from "fs";
+     *     await client.form.fill({
+     *         instructions: "instructions"
+     *     })
+     */
+    fill(request: Pulse.FormFillMultipartInput, 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` — 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
+     * 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.FormClearMultipartInput} 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
+     *     import { createReadStream } from "fs";
+     *     await client.form.clear({})
+     */
+    clear(request: Pulse.FormClearMultipartInput, requestOptions?: FormClient.RequestOptions): core.HttpResponsePromise<Pulse.FormResult>;
+    private __clear;
+}