@chrt-inc/typescript-sdk 1.708.0 → 1.718.0

package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/scan/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/scan/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("./client/index.js"), exports);

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

@@ -24,6 +24,8 @@ export interface DeviceLimitedForList1 {
     first_seen_at_timestamp?: string | null;
     last_seen_at_location?: Chrt.LocationFeature | null;
     last_seen_at_timestamp?: string | null;
+    last_seen_at_location_city?: string | null;
+    last_seen_at_location_large_city?: string | null;
     last_seen_battery_level?: string | null;
     archived?: boolean;
     paused?: boolean;

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

@@ -24,4 +24,6 @@ export interface Driver1 {
     active_task_group_ids?: string[];
     last_seen_at_location?: Chrt.LocationFeature | null;
     last_seen_at_timestamp?: string | null;
+    last_seen_at_location_city?: string | null;
+    last_seen_at_location_large_city?: string | null;
 }

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface OrderBuilderPrecheckRes {
+    valid: boolean;
+    feedback?: string;
+}

package/dist/cjs/api/types/OrderBuilderPrecheckRes.js

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

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ScanPayloadKindEnum = "expected" | "observed";
+export declare const ScanPayloadKindEnum: {
+    readonly Expected: "expected";
+    readonly Observed: "observed";
+};

package/dist/cjs/api/types/ScanPayloadKindEnum.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScanPayloadKindEnum = void 0;
+exports.ScanPayloadKindEnum = {
+    Expected: "expected",
+    Observed: "observed",
+};

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

@@ -5,6 +5,7 @@ import * as Chrt from "../index.js";
 export interface TaskArtifact1 {
     schema_version: number;
     type: Chrt.TaskArtifactTypeEnum1;
+    expected_scan_payloads?: string[];
     _id: string;
     order_id: string;
     order_short_id: string;
@@ -26,6 +27,7 @@ export interface TaskArtifact1 {
     completed_by_org_id?: string | null;
     /** Must be a string starting with `user_` */
     completed_by_user_id?: string | null;
+    observed_scan_payloads?: string[];
     status?: Chrt.TaskArtifactStatusEnum1;
     draft_started_at_timestamp: string;
     staged_at_timestamp?: string | null;

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

@@ -5,4 +5,5 @@ import * as Chrt from "../index.js";
 export interface TaskArtifactClientCreate1 {
     schema_version: number;
     type: Chrt.TaskArtifactTypeEnum1;
+    expected_scan_payloads?: string[];
 }

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

@@ -1,9 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type TaskArtifactTypeEnum1 = "image" | "signature" | "other";
+export type TaskArtifactTypeEnum1 = "image" | "signature" | "scan" | "other";
 export declare const TaskArtifactTypeEnum1: {
     readonly Image: "image";
     readonly Signature: "signature";
+    readonly Scan: "scan";
     readonly Other: "other";
 };

package/dist/cjs/api/types/TaskArtifactTypeEnum1.js

@@ -7,5 +7,6 @@ exports.TaskArtifactTypeEnum1 = void 0;
 exports.TaskArtifactTypeEnum1 = {
     Image: "image",
     Signature: "signature",
+    Scan: "scan",
     Other: "other",
 };

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

@@ -214,6 +214,7 @@ export * from "./OperationsTaskListRes.js";
 export * from "./OperationsTaskSortByEnum.js";
 export * from "./Order1.js";
 export * from "./OrderAndTaskGroupExpandedReq.js";
+export * from "./OrderBuilderPrecheckRes.js";
 export * from "./OrderBuilderReq.js";
 export * from "./OrderBuilderRes.js";
 export * from "./OrderDraftExpanded.js";
@@ -273,6 +274,7 @@ export * from "./ProviderOrgProfile1.js";
 export * from "./ProviderProviderConnection1.js";
 export * from "./RateSheetMapping1.js";
 export * from "./RateSheetMappingListRes.js";
+export * from "./ScanPayloadKindEnum.js";
 export * from "./ScheduleCalendarSpec.js";
 export * from "./ScheduleIntervalSpec.js";
 export * from "./ScheduleRange.js";

package/dist/cjs/api/types/index.js

@@ -230,6 +230,7 @@ __exportStar(require("./OperationsTaskListRes.js"), exports);
 __exportStar(require("./OperationsTaskSortByEnum.js"), exports);
 __exportStar(require("./Order1.js"), exports);
 __exportStar(require("./OrderAndTaskGroupExpandedReq.js"), exports);
+__exportStar(require("./OrderBuilderPrecheckRes.js"), exports);
 __exportStar(require("./OrderBuilderReq.js"), exports);
 __exportStar(require("./OrderBuilderRes.js"), exports);
 __exportStar(require("./OrderDraftExpanded.js"), exports);
@@ -289,6 +290,7 @@ __exportStar(require("./ProviderOrgProfile1.js"), exports);
 __exportStar(require("./ProviderProviderConnection1.js"), exports);
 __exportStar(require("./RateSheetMapping1.js"), exports);
 __exportStar(require("./RateSheetMappingListRes.js"), exports);
+__exportStar(require("./ScanPayloadKindEnum.js"), exports);
 __exportStar(require("./ScheduleCalendarSpec.js"), exports);
 __exportStar(require("./ScheduleIntervalSpec.js"), exports);
 __exportStar(require("./ScheduleRange.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.708.0";
+export declare const SDK_VERSION = "1.718.0";

package/dist/cjs/version.js

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

package/dist/esm/Client.mjs

@@ -20,8 +20,8 @@ export class ChrtClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
-                "X-Fern-SDK-Version": "1.708.0",
-                "User-Agent": "@chrt-inc/typescript-sdk/1.708.0",
+                "X-Fern-SDK-Version": "1.718.0",
+                "User-Agent": "@chrt-inc/typescript-sdk/1.718.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.d.mts

@@ -88,6 +88,22 @@ export declare class OrderDrafts {
      */
     deleteV1(orderId: string, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<boolean>;
     private __deleteV1;
+    /**
+     * Converts an order screenshot into lightly structured text for the AI order builder. | (UploadFile) -> (str)
+     *
+     * @param {Chrt.shipping.BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post} request
+     * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.shipping.orderDrafts.imageToTextV1({
+     *         file: fs.createReadStream("/path/to/your/file")
+     *     })
+     */
+    imageToTextV1(request: Chrt.shipping.BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<string>;
+    private __imageToTextV1;
     /**
      * Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)
      *

package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.mjs

@@ -233,6 +233,74 @@ export class OrderDrafts {
             }
         });
     }
+    /**
+     * Converts an order screenshot into lightly structured text for the AI order builder. | (UploadFile) -> (str)
+     *
+     * @param {Chrt.shipping.BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post} request
+     * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.shipping.orderDrafts.imageToTextV1({
+     *         file: fs.createReadStream("/path/to/your/file")
+     *     })
+     */
+    imageToTextV1(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__imageToTextV1(request, requestOptions));
+    }
+    __imageToTextV1(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            const _request = yield core.newFormData();
+            yield _request.appendFile("file", request.file);
+            const _maybeEncodedRequest = yield _request.getRequest();
+            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({ Authorization: yield this._getAuthorizationHeader() }, _maybeEncodedRequest.headers)), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, "shipping/order_drafts/image_to_text/v1"),
+                method: "POST",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "file",
+                duplex: _maybeEncodedRequest.duplex,
+                body: _maybeEncodedRequest.body,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.ChrtError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.ChrtError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/order_drafts/image_to_text/v1.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)
      *

package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post.d.mts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../../../../core/index.mjs";
+/**
+ * @example
+ *     {
+ *         file: fs.createReadStream("/path/to/your/file")
+ *     }
+ */
+export interface BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post {
+    file: core.file.Uploadable.FileLike;
+}

package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post.mjs

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

package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/index.d.mts

@@ -1,2 +1,3 @@
 export { type OrdersNewDraftReq } from "./OrdersNewDraftReq.mjs";
 export { type OrdersDraftUpdateReq } from "./OrdersDraftUpdateReq.mjs";
+export { type BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post } from "./BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post.mjs";

package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.d.mts

@@ -30,6 +30,22 @@ export declare namespace Agentic {
 export declare class Agentic {
     protected readonly _options: Agentic.Options;
     constructor(_options?: Agentic.Options);
+    /**
+     * Predicts whether input is complete enough for the AI order builder. | (OrderBuilderReq) -> (OrderBuilderPrecheckRes)
+     *
+     * @param {Chrt.OrderBuilderReq} request
+     * @param {Agentic.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderDrafts.agentic.precheckV1({
+     *         order_short_id: "order_short_id",
+     *         text: "text"
+     *     })
+     */
+    precheckV1(request: Chrt.OrderBuilderReq, requestOptions?: Agentic.RequestOptions): core.HttpResponsePromise<Chrt.OrderBuilderPrecheckRes>;
+    private __precheckV1;
     /**
      * Populates an existing draft order with cargo, task groups, and tasks parsed from natural language. | (OrderBuilderReq) -> (OrderBuilderRes)
      *

package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.mjs

@@ -19,6 +19,71 @@ export class Agentic {
     constructor(_options = {}) {
         this._options = _options;
     }
+    /**
+     * Predicts whether input is complete enough for the AI order builder. | (OrderBuilderReq) -> (OrderBuilderPrecheckRes)
+     *
+     * @param {Chrt.OrderBuilderReq} request
+     * @param {Agentic.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderDrafts.agentic.precheckV1({
+     *         order_short_id: "order_short_id",
+     *         text: "text"
+     *     })
+     */
+    precheckV1(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__precheckV1(request, requestOptions));
+    }
+    __precheckV1(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, "shipping/order_drafts/agentic/precheck/v1"),
+                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 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.ChrtError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.ChrtError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/order_drafts/agentic/precheck/v1.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Populates an existing draft order with cargo, task groups, and tasks parsed from natural language. | (OrderBuilderReq) -> (OrderBuilderRes)
      *

package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskArtifact/client/requests/OrderDraftAddTaskArtifactReq.d.mts

@@ -12,5 +12,6 @@ import * as Chrt from "../../../../../../../../index.mjs";
 export interface OrderDraftAddTaskArtifactReq {
     task_id: string;
     task_artifact_type: Chrt.TaskArtifactTypeEnum1;
+    expected_scan_payloads?: string[];
     order_schedule_template_path?: string | null;
 }

package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/Client.d.mts

@@ -5,6 +5,7 @@ import * as environments from "../../../../../../environments.mjs";
 import * as core from "../../../../../../core/index.mjs";
 import * as Chrt from "../../../../../index.mjs";
 import { S3Object } from "../resources/s3Object/client/Client.mjs";
+import { Scan } from "../resources/scan/client/Client.mjs";
 export declare namespace TaskArtifacts {
     interface Options {
         environment?: core.Supplier<environments.ChrtEnvironment | string>;
@@ -31,8 +32,10 @@ export declare namespace TaskArtifacts {
 export declare class TaskArtifacts {
     protected readonly _options: TaskArtifacts.Options;
     protected _s3Object: S3Object | undefined;
+    protected _scan: Scan | undefined;
     constructor(_options?: TaskArtifacts.Options);
     get s3Object(): S3Object;
+    get scan(): Scan;
     /**
      * Adds a new task artifact to a task. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | (AddTaskArtifactReq) -> (PydanticObjectId)
      *

package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/Client.mjs

@@ -16,6 +16,7 @@ import * as Chrt from "../../../../../index.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
 import * as errors from "../../../../../../errors/index.mjs";
 import { S3Object } from "../resources/s3Object/client/Client.mjs";
+import { Scan } from "../resources/scan/client/Client.mjs";
 export class TaskArtifacts {
     constructor(_options = {}) {
         this._options = _options;
@@ -24,6 +25,10 @@ export class TaskArtifacts {
         var _a;
         return ((_a = this._s3Object) !== null && _a !== void 0 ? _a : (this._s3Object = new S3Object(this._options)));
     }
+    get scan() {
+        var _a;
+        return ((_a = this._scan) !== null && _a !== void 0 ? _a : (this._scan = new Scan(this._options)));
+    }
     /**
      * Adds a new task artifact to a task. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | (AddTaskArtifactReq) -> (PydanticObjectId)
      *

package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/index.d.mts

@@ -1,2 +1,4 @@
 export * as s3Object from "./s3Object/index.mjs";
+export * as scan from "./scan/index.mjs";
 export * from "./s3Object/client/requests/index.mjs";
+export * from "./scan/client/requests/index.mjs";

package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/index.mjs

@@ -1,2 +1,4 @@
 export * as s3Object from "./s3Object/index.mjs";
+export * as scan from "./scan/index.mjs";
 export * from "./s3Object/client/requests/index.mjs";
+export * from "./scan/client/requests/index.mjs";

package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/client/Client.d.mts

@@ -0,0 +1,68 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../../../environments.mjs";
+import * as core from "../../../../../../../../core/index.mjs";
+import * as Chrt from "../../../../../../../index.mjs";
+export declare namespace Scan {
+    interface Options {
+        environment?: core.Supplier<environments.ChrtEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class Scan {
+    protected readonly _options: Scan.Options;
+    constructor(_options?: Scan.Options);
+    /**
+     * Appends a barcode/QR scan payload to a SCAN-type task artifact's expected or observed array (deduplicated). | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | (AddScanPayloadReq) -> (bool)
+     *
+     * @param {string} taskArtifactId
+     * @param {Chrt.shipping.taskArtifacts.AddScanPayloadReq} request
+     * @param {Scan.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.taskArtifacts.scan.addV1("task_artifact_id", {
+     *         kind: "expected",
+     *         payload: "payload"
+     *     })
+     */
+    addV1(taskArtifactId: string, request: Chrt.shipping.taskArtifacts.AddScanPayloadReq, requestOptions?: Scan.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __addV1;
+    /**
+     * Removes a barcode/QR scan payload (by value) from a SCAN-type task artifact's expected or observed array. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (bool)
+     *
+     * @param {string} taskArtifactId
+     * @param {Chrt.shipping.taskArtifacts.ScanDeleteV1Request} request
+     * @param {Scan.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.taskArtifacts.scan.deleteV1("task_artifact_id", {
+     *         kind: "expected",
+     *         payload: "payload"
+     *     })
+     */
+    deleteV1(taskArtifactId: string, request: Chrt.shipping.taskArtifacts.ScanDeleteV1Request, requestOptions?: Scan.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}