extend-ai 1.6.0 → 1.8.0

package/api/resources/workflows/client/Client.js

@@ -56,9 +56,89 @@ class WorkflowsClient {
         this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
-     * Create a new workflow in Extend. Workflows are sequences of steps that process files and data in a specific order to achieve a desired outcome.
+     * List all workflows. Returns a paginated list of workflow summaries.
      *
-     * This endpoint will create a new workflow in Extend, which can then be configured and deployed. Typically, workflows are created from our UI, however this endpoint can be used to create workflows programmatically. Configuration of the flow still needs to be done in the dashboard.
+     * @param {Extend.WorkflowsListRequest} request
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Extend.BadRequestError}
+     * @throws {@link Extend.UnauthorizedError}
+     * @throws {@link Extend.PaymentRequiredError}
+     * @throws {@link Extend.ForbiddenError}
+     * @throws {@link Extend.NotFoundError}
+     * @throws {@link Extend.UnprocessableEntityError}
+     * @throws {@link Extend.TooManyRequestsError}
+     * @throws {@link Extend.InternalServerError}
+     *
+     * @example
+     *     await client.workflows.list({
+     *         nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
+     *     })
+     */
+    list(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
+    }
+    __list() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const { nextPageToken, maxPageSize, sortBy, sortDir } = request;
+            const _queryParams = {
+                nextPageToken,
+                maxPageSize,
+                sortBy: sortBy != null ? sortBy : undefined,
+                sortDir: sortDir != null ? sortDir : undefined,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({ "x-extend-api-version": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.extendApiVersion) !== null && _b !== void 0 ? _b : "2026-02-09" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
+                url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ExtendEnvironment.Production, "workflows"),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 300) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.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 Extend.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Extend.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 402:
+                        throw new Extend.PaymentRequiredError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Extend.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Extend.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Extend.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Extend.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Extend.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.ExtendError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/workflows");
+        });
+    }
+    /**
+     * Create a new workflow. Optionally provide `steps` to define the workflow's step graph.
+     *
+     * When `steps` is omitted, the workflow is created with default steps (`TRIGGER` → `PARSE`). When `steps` is provided, the step graph is validated and the draft version is populated with the given steps.
+     *
+     * **Note:** The default steps may change in the future. If your integration depends on a specific step graph, provide `steps` explicitly.
      *
      * @param {Extend.WorkflowsCreateRequest} request
      * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -76,6 +156,48 @@ class WorkflowsClient {
      *     await client.workflows.create({
      *         name: "Invoice Processing"
      *     })
+     *
+     * @example
+     *     await client.workflows.create({
+     *         name: "Invoice Processing",
+     *         steps: [{
+     *                 type: "TRIGGER",
+     *                 name: "name"
+     *             }, {
+     *                 type: "PARSE",
+     *                 name: "name"
+     *             }, {
+     *                 type: "EXTRACT",
+     *                 name: "name"
+     *             }, {
+     *                 type: "HUMAN_REVIEW",
+     *                 name: "name"
+     *             }]
+     *     })
+     *
+     * @example
+     *     await client.workflows.create({
+     *         name: "Document Routing",
+     *         steps: [{
+     *                 type: "TRIGGER",
+     *                 name: "name"
+     *             }, {
+     *                 type: "PARSE",
+     *                 name: "name"
+     *             }, {
+     *                 type: "CLASSIFY",
+     *                 name: "name"
+     *             }, {
+     *                 type: "EXTRACT",
+     *                 name: "name"
+     *             }, {
+     *                 type: "EXTRACT",
+     *                 name: "name"
+     *             }, {
+     *                 type: "HUMAN_REVIEW",
+     *                 name: "name"
+     *             }]
+     *     })
      */
     create(request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
@@ -131,5 +253,162 @@ class WorkflowsClient {
             return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/workflows");
         });
     }
+    /**
+     * Get details of a workflow, including its draft version and steps.
+     *
+     * @param {string} id - The ID of the workflow.
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Extend.BadRequestError}
+     * @throws {@link Extend.UnauthorizedError}
+     * @throws {@link Extend.PaymentRequiredError}
+     * @throws {@link Extend.ForbiddenError}
+     * @throws {@link Extend.NotFoundError}
+     * @throws {@link Extend.UnprocessableEntityError}
+     * @throws {@link Extend.TooManyRequestsError}
+     * @throws {@link Extend.InternalServerError}
+     *
+     * @example
+     *     await client.workflows.retrieve("workflow_abc123")
+     */
+    retrieve(id, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__retrieve(id, requestOptions));
+    }
+    __retrieve(id, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({ "x-extend-api-version": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.extendApiVersion) !== null && _b !== void 0 ? _b : "2026-02-09" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
+                url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ExtendEnvironment.Production, `workflows/${core.url.encodePathParam(id)}`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 300) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.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 Extend.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Extend.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 402:
+                        throw new Extend.PaymentRequiredError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Extend.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Extend.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Extend.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Extend.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Extend.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.ExtendError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/workflows/{id}");
+        });
+    }
+    /**
+     * Update a workflow's draft. You can update the name, the steps, or both.
+     *
+     * When `steps` is provided, the draft version's steps are replaced with the new set. Steps with matching names from the previous draft preserve their internal identity.
+     *
+     * @param {string} id - The ID of the workflow to update.
+     * @param {Extend.WorkflowsUpdateRequest} request
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Extend.BadRequestError}
+     * @throws {@link Extend.UnauthorizedError}
+     * @throws {@link Extend.PaymentRequiredError}
+     * @throws {@link Extend.ForbiddenError}
+     * @throws {@link Extend.NotFoundError}
+     * @throws {@link Extend.UnprocessableEntityError}
+     * @throws {@link Extend.TooManyRequestsError}
+     * @throws {@link Extend.InternalServerError}
+     *
+     * @example
+     *     await client.workflows.update("workflow_abc123", {
+     *         name: "Updated Invoice Processing"
+     *     })
+     *
+     * @example
+     *     await client.workflows.update("workflow_abc123", {
+     *         steps: [{
+     *                 type: "TRIGGER",
+     *                 name: "name"
+     *             }, {
+     *                 type: "PARSE",
+     *                 name: "name"
+     *             }]
+     *     })
+     */
+    update(id, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__update(id, request, requestOptions));
+    }
+    __update(id_1) {
+        return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({ "x-extend-api-version": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.extendApiVersion) !== null && _b !== void 0 ? _b : "2026-02-09" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
+                url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ExtendEnvironment.Production, `workflows/${core.url.encodePathParam(id)}`),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 300) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.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 Extend.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Extend.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 402:
+                        throw new Extend.PaymentRequiredError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Extend.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Extend.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Extend.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Extend.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Extend.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.ExtendError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/workflows/{id}");
+        });
+    }
 }
 exports.WorkflowsClient = WorkflowsClient;

package/api/resources/workflows/client/requests/WorkflowsCreateRequest.d.ts

@@ -1,10 +1,61 @@
+import type * as Extend from "../../../../index";
 /**
  * @example
  *     {
  *         name: "Invoice Processing"
  *     }
+ *
+ * @example
+ *     {
+ *         name: "Invoice Processing",
+ *         steps: [{
+ *                 type: "TRIGGER",
+ *                 name: "name"
+ *             }, {
+ *                 type: "PARSE",
+ *                 name: "name"
+ *             }, {
+ *                 type: "EXTRACT",
+ *                 name: "name"
+ *             }, {
+ *                 type: "HUMAN_REVIEW",
+ *                 name: "name"
+ *             }]
+ *     }
+ *
+ * @example
+ *     {
+ *         name: "Document Routing",
+ *         steps: [{
+ *                 type: "TRIGGER",
+ *                 name: "name"
+ *             }, {
+ *                 type: "PARSE",
+ *                 name: "name"
+ *             }, {
+ *                 type: "CLASSIFY",
+ *                 name: "name"
+ *             }, {
+ *                 type: "EXTRACT",
+ *                 name: "name"
+ *             }, {
+ *                 type: "EXTRACT",
+ *                 name: "name"
+ *             }, {
+ *                 type: "HUMAN_REVIEW",
+ *                 name: "name"
+ *             }]
+ *     }
  */
 export interface WorkflowsCreateRequest {
-    /** The name of the workflow */
+    /** The name of the workflow. */
     name: string;
+    /**
+     * The steps that define the workflow's processing graph. Each step has a `type`, a unique `name`, and optional `next` entries that define routing to downstream steps.
+     *
+     * When omitted, the workflow is created with default steps (`TRIGGER` → `PARSE`). The default steps may change in the future.
+     *
+     * See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api) for step definitions, branching patterns, and examples.
+     */
+    steps?: Extend.WorkflowStepDefinition[];
 }

package/api/resources/workflows/client/requests/WorkflowsListRequest.d.ts

@@ -0,0 +1,13 @@
+import type * as Extend from "../../../../index";
+/**
+ * @example
+ *     {
+ *         nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
+ *     }
+ */
+export interface WorkflowsListRequest {
+    nextPageToken?: Extend.NextPageToken;
+    maxPageSize?: Extend.MaxPageSize;
+    sortBy?: Extend.SortBy;
+    sortDir?: Extend.SortDir;
+}

package/api/resources/workflows/client/requests/WorkflowsListRequest.js

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

package/api/resources/workflows/client/requests/WorkflowsUpdateRequest.d.ts

@@ -0,0 +1,28 @@
+import type * as Extend from "../../../../index";
+/**
+ * @example
+ *     {
+ *         name: "Updated Invoice Processing"
+ *     }
+ *
+ * @example
+ *     {
+ *         steps: [{
+ *                 type: "TRIGGER",
+ *                 name: "name"
+ *             }, {
+ *                 type: "PARSE",
+ *                 name: "name"
+ *             }]
+ *     }
+ */
+export interface WorkflowsUpdateRequest {
+    /** The new name for the workflow. */
+    name?: string;
+    /**
+     * The new step definitions for the draft version. Replaces all existing draft steps.
+     *
+     * See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api) for step definitions, branching patterns, and examples.
+     */
+    steps?: Extend.WorkflowStepDefinition[];
+}

package/api/resources/workflows/client/requests/WorkflowsUpdateRequest.js

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

package/api/resources/workflows/client/requests/index.d.ts

@@ -1 +1,3 @@
 export type { WorkflowsCreateRequest } from "./WorkflowsCreateRequest";
+export type { WorkflowsListRequest } from "./WorkflowsListRequest";
+export type { WorkflowsUpdateRequest } from "./WorkflowsUpdateRequest";

package/api/resources/workflows/index.d.ts

@@ -1 +1,2 @@
 export * from "./client";
+export * from "./types";

package/api/resources/workflows/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./client"), exports);
+__exportStar(require("./types"), exports);

package/api/resources/workflows/types/WorkflowsListResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Extend from "../../../index";
+export interface WorkflowsListResponse {
+    object: "list";
+    data: Extend.WorkflowSummary[];
+    nextPageToken?: Extend.NextPageToken;
+}

package/api/resources/workflows/types/WorkflowsListResponse.js

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

package/api/resources/workflows/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./WorkflowsListResponse";

package/api/resources/workflows/types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./WorkflowsListResponse"), exports);

package/api/types/BarcodeDetails.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Details for barcode blocks
+ */
+export interface BarcodeDetails {
+    /** Indicates this is a barcode details object */
+    type: "barcode_details";
+    /** URL to the clipped/segmented barcode image. Only set if the option `imageClippingEnabled` in blockOptions.barcodes is `true`. */
+    imageUrl?: string;
+    /** The decoded value of the barcode or QR code. Only set if the option `readingEnabled` in blockOptions.barcodes is `true`. */
+    decodedValue?: string;
+    /** The format of the barcode (e.g., "QRCode", "Code128", "DataMatrix", "EAN13"). */
+    format?: string;
+}

package/api/types/BarcodeDetails.js

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

package/api/types/BatchProcessorRunCompletedWebhookEvent.d.ts

@@ -0,0 +1,6 @@
+import type * as Extend from "../index";
+export interface BatchProcessorRunCompletedWebhookEvent {
+    /** Unique identifier for the event */
+    eventId: string;
+    payload: Extend.BatchRun;
+}

package/api/types/BatchProcessorRunCompletedWebhookEvent.js

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

package/api/types/BatchProcessorRunFailedWebhookEvent.d.ts

@@ -0,0 +1,6 @@
+import type * as Extend from "../index";
+export interface BatchProcessorRunFailedWebhookEvent {
+    /** Unique identifier for the event */
+    eventId: string;
+    payload: Extend.BatchRun;
+}

package/api/types/BatchProcessorRunFailedWebhookEvent.js

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

package/api/types/BatchRun.d.ts

@@ -1,27 +1,20 @@
 import type * as Extend from "../index";
+/**
+ * A batch run represents a batch of files submitted for processing via one of the batch endpoints (`POST /extract_runs/batch`, `POST /classify_runs/batch`, or `POST /split_runs/batch`). Use `GET /batch_runs/{id}` to poll the status.
+ *
+ * **Note:** This object is not used for workflow batch runs. See `POST /workflow_runs/batch` for workflow batching.
+ */
 export interface BatchRun {
-    /** The type of object. In this case, it will always be `"batch_run"`. */
+    /** The type of object. Always `"batch_run"`. */
     object: "batch_run";
     /**
      * The unique identifier for this batch run.
      *
-     * Example: `"batch_run_Xj8mK2pL9nR4vT7qY5wZ"`
+     * Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
      */
     id: string;
-    /**
-     * The extractor, classifier, or splitter that was run.
-     *
-     * **Availability:** Present when an entity was provided when creating the batch run.
-     */
-    entity: Extend.BatchRunEntity | null;
-    /**
-     * The version of the extractor, classifier, or splitter that was run.
-     *
-     * **Availability:** Present when an entity was provided when creating the batch run.
-     */
-    entityVersion: Extend.BatchRunEntityVersion | null;
     status: Extend.BatchRunStatus;
-    metrics: Extend.BatchRunMetrics;
+    /** The number of individual runs in this batch. */
+    runCount: number;
     createdAt: Extend.CreatedAt;
-    updatedAt: Extend.UpdatedAt;
 }

package/api/types/BatchRunStatus.d.ts

@@ -1,14 +1,16 @@
 /**
- * The status of a run:
- * * `"PENDING"` - The run has not started yet
- * * `"PROCESSING"` - The run is in progress
- * * `"PROCESSED"` - The run completed successfully
- * * `"FAILED"` - The run failed
+ * The status of a batch run:
+ * * `"PENDING"` - The batch has been created and is waiting to be processed
+ * * `"PROCESSING"` - The batch is currently being processed
+ * * `"PROCESSED"` - All runs in the batch have completed successfully
+ * * `"FAILED"` - The batch failed to process
+ * * `"CANCELLED"` - The batch was cancelled
  */
 export declare const BatchRunStatus: {
     readonly Pending: "PENDING";
     readonly Processing: "PROCESSING";
     readonly Processed: "PROCESSED";
     readonly Failed: "FAILED";
+    readonly Cancelled: "CANCELLED";
 };
 export type BatchRunStatus = (typeof BatchRunStatus)[keyof typeof BatchRunStatus] | string;

package/api/types/BatchRunStatus.js

@@ -3,15 +3,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BatchRunStatus = void 0;
 /**
- * The status of a run:
- * * `"PENDING"` - The run has not started yet
- * * `"PROCESSING"` - The run is in progress
- * * `"PROCESSED"` - The run completed successfully
- * * `"FAILED"` - The run failed
+ * The status of a batch run:
+ * * `"PENDING"` - The batch has been created and is waiting to be processed
+ * * `"PROCESSING"` - The batch is currently being processed
+ * * `"PROCESSED"` - All runs in the batch have completed successfully
+ * * `"FAILED"` - The batch failed to process
+ * * `"CANCELLED"` - The batch was cancelled
  */
 exports.BatchRunStatus = {
     Pending: "PENDING",
     Processing: "PROCESSING",
     Processed: "PROCESSED",
     Failed: "FAILED",
+    Cancelled: "CANCELLED",
 };

package/api/types/Block.d.ts

@@ -12,9 +12,15 @@ export interface Block {
      * * `"heading"` - Section or document headings
      * * `"section_heading"` - Subsection headings
      * * `"table"` - Tabular data with rows and columns
+     * * `"figure"` - Images, charts, diagrams, or logos
      * * `"table_head"` - Table header cells
      * * `"table_cell"` - Table body cells
-     * * `"figure"` - Images, charts, diagrams, or logos
+     * * `"key_value"` - Key-value pairs (e.g., form regions, key-val groups, etc)
+     * * `"page_number"` - Page number indicators
+     * * `"barcode"` - Barcodes and QR codes
+     * * `"formula"` - Mathematical formulas and equations
+     * * `"header"` - Page headers
+     * * `"footer"` - Page footers
      */
     type: Extend.BlockType;
     /** The textual content of the block formatted based on the target format. */

package/api/types/BlockDetails.d.ts

@@ -2,4 +2,4 @@ import type * as Extend from "../index";
 /**
  * Additional details specific to the block type. The schema depends on the block type.
  */
-export type BlockDetails = Extend.TableDetails | Extend.TableCellDetails | Extend.FigureDetails | Extend.EmptyBlockDetails;
+export type BlockDetails = Extend.TableDetails | Extend.TableCellDetails | Extend.FigureDetails | Extend.BarcodeDetails | Extend.FormulaDetails | Extend.KeyValueDetails | Extend.EmptyBlockDetails;

package/api/types/BlockMetadata.d.ts

@@ -5,4 +5,6 @@ import type * as Extend from "../index";
 export interface BlockMetadata {
     /** Information about the page this block appears on. */
     page?: Extend.BlockMetadataPage;
+    /** Text direction for this block's content ("ltr" for left-to-right, "rtl" for right-to-left). */
+    textDirection?: Extend.BlockMetadataTextDirection;
 }

package/api/types/BlockMetadataTextDirection.d.ts

@@ -0,0 +1,6 @@
+/** Text direction for this block's content ("ltr" for left-to-right, "rtl" for right-to-left). */
+export declare const BlockMetadataTextDirection: {
+    readonly Ltr: "ltr";
+    readonly Rtl: "rtl";
+};
+export type BlockMetadataTextDirection = (typeof BlockMetadataTextDirection)[keyof typeof BlockMetadataTextDirection] | string;