@chrt-inc/typescript-sdk 1.710.0 → 1.718.0

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>;
+}

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

@@ -0,0 +1,164 @@
+/**
+ * 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 * as environments from "../../../../../../../../environments.mjs";
+import * as core from "../../../../../../../../core/index.mjs";
+import * as Chrt from "../../../../../../../index.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../../../core/headers.mjs";
+import * as errors from "../../../../../../../../errors/index.mjs";
+export class Scan {
+    constructor(_options = {}) {
+        this._options = _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, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__addV1(taskArtifactId, request, requestOptions));
+    }
+    __addV1(taskArtifactId, 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/task_artifacts/scan/add/v1/${encodeURIComponent(taskArtifactId)}`),
+                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/task_artifacts/scan/add/v1/{task_artifact_id}.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * 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, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__deleteV1(taskArtifactId, request, requestOptions));
+    }
+    __deleteV1(taskArtifactId, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            const { kind, payload } = request;
+            const _queryParams = {};
+            _queryParams["kind"] = kind;
+            _queryParams["payload"] = payload;
+            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/task_artifacts/scan/delete/v1/${encodeURIComponent(taskArtifactId)}`),
+                method: "DELETE",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                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 DELETE /shipping/task_artifacts/scan/delete/v1/{task_artifact_id}.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    _getAuthorizationHeader() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const bearer = yield core.Supplier.get(this._options.token);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
+        });
+    }
+}

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

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

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

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

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         kind: "expected",
+ *         payload: "payload"
+ *     }
+ */
+export interface AddScanPayloadReq {
+    kind: Chrt.ScanPayloadKindEnum;
+    payload: string;
+}

package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/client/requests/AddScanPayloadReq.mjs

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

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         kind: "expected",
+ *         payload: "payload"
+ *     }
+ */
+export interface ScanDeleteV1Request {
+    kind: Chrt.ScanPayloadKindEnum;
+    payload: string;
+}

package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/client/requests/ScanDeleteV1Request.mjs

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

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

@@ -0,0 +1,2 @@
+export { type AddScanPayloadReq } from "./AddScanPayloadReq.mjs";
+export { type ScanDeleteV1Request } from "./ScanDeleteV1Request.mjs";

package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

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

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

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

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

package/dist/esm/api/types/DeviceLimitedForList1.d.mts

@@ -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/esm/api/types/Driver1.d.mts

@@ -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/esm/api/types/ScanPayloadKindEnum.d.mts

@@ -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/esm/api/types/ScanPayloadKindEnum.mjs

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

package/dist/esm/api/types/TaskArtifact1.d.mts

@@ -5,6 +5,7 @@ import * as Chrt from "../index.mjs";
 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/esm/api/types/TaskArtifactClientCreate1.d.mts

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

package/dist/esm/api/types/TaskArtifactTypeEnum1.d.mts

@@ -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/esm/api/types/TaskArtifactTypeEnum1.mjs

@@ -4,5 +4,6 @@
 export const TaskArtifactTypeEnum1 = {
     Image: "image",
     Signature: "signature",
+    Scan: "scan",
     Other: "other",
 };

package/dist/esm/api/types/index.d.mts

@@ -274,6 +274,7 @@ export * from "./ProviderOrgProfile1.mjs";
 export * from "./ProviderProviderConnection1.mjs";
 export * from "./RateSheetMapping1.mjs";
 export * from "./RateSheetMappingListRes.mjs";
+export * from "./ScanPayloadKindEnum.mjs";
 export * from "./ScheduleCalendarSpec.mjs";
 export * from "./ScheduleIntervalSpec.mjs";
 export * from "./ScheduleRange.mjs";

package/dist/esm/api/types/index.mjs

@@ -274,6 +274,7 @@ export * from "./ProviderOrgProfile1.mjs";
 export * from "./ProviderProviderConnection1.mjs";
 export * from "./RateSheetMapping1.mjs";
 export * from "./RateSheetMappingListRes.mjs";
+export * from "./ScanPayloadKindEnum.mjs";
 export * from "./ScheduleCalendarSpec.mjs";
 export * from "./ScheduleIntervalSpec.mjs";
 export * from "./ScheduleRange.mjs";

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.710.0";
+export const SDK_VERSION = "1.718.0";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chrt-inc/typescript-sdk",
-    "version": "1.710.0",
+    "version": "1.718.0",
     "private": false,
     "repository": "github:chrt-inc/typescript-sdk",
     "type": "commonjs",

package/reference.md

@@ -24017,6 +24017,156 @@ await client.shipping.taskArtifacts.s3Object.writeAiImageDescriptionV1("task_art
 </dl>
 </details>
 
+## Shipping TaskArtifacts Scan
+
+<details><summary><code>client.shipping.taskArtifacts.scan.<a href="/src/api/resources/shipping/resources/taskArtifacts/resources/scan/client/Client.ts">addV1</a>(taskArtifactId, { ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.taskArtifacts.scan.addV1("task_artifact_id", {
+    kind: "expected",
+    payload: "payload",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskArtifactId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shipping.taskArtifacts.AddScanPayloadReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Scan.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shipping.taskArtifacts.scan.<a href="/src/api/resources/shipping/resources/taskArtifacts/resources/scan/client/Client.ts">deleteV1</a>(taskArtifactId, { ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.taskArtifacts.scan.deleteV1("task_artifact_id", {
+    kind: "expected",
+    payload: "payload",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskArtifactId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shipping.taskArtifacts.ScanDeleteV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Scan.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Shipping TaskGroups TaskGroupId
 
 <details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">forExecutorOperatorsV1</a>(orderRef) -> string[]</code></summary>