@chrt-inc/typescript-sdk 1.925.0 → 1.930.0

package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.js

@@ -124,9 +124,10 @@ class Tasks {
         });
     }
     /**
-     * Marks a task as COMPLETED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
+     * Marks a task as COMPLETED, optionally recording a client-supplied completion timestamp no more than five minutes in the future. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | (TaskCompleteReq) -> (bool)
      *
      * @param {string} taskId
+     * @param {Chrt.shipping.TaskCompleteReq} request
      * @param {Tasks.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
@@ -134,18 +135,21 @@ class Tasks {
      * @example
      *     await client.shipping.tasks.completeV1("task_id")
      */
-    completeV1(taskId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__completeV1(taskId, requestOptions));
+    completeV1(taskId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__completeV1(taskId, request, requestOptions));
     }
-    __completeV1(taskId, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
+    __completeV1(taskId_1) {
+        return __awaiter(this, arguments, void 0, function* (taskId, request = {}, requestOptions) {
             var _a, _b, _c, _d;
             let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.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/tasks/complete/v1/${encodeURIComponent(taskId)}`),
                 method: "PUT",
                 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,
@@ -182,6 +186,71 @@ class Tasks {
             }
         });
     }
+    /**
+     * Corrects a completed task's completion timestamp. The driver may correct only their own completion; authorized operators may override it. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | (TaskCompletionTimestampUpdateReq) -> (bool)
+     *
+     * @param {string} taskId
+     * @param {Chrt.shipping.TaskCompletionTimestampUpdateReq} request
+     * @param {Tasks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.tasks.updateCompletionTimestampV1("task_id", {
+     *         completed_at_timestamp: "2024-01-15T09:30:00Z"
+     *     })
+     */
+    updateCompletionTimestampV1(taskId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__updateCompletionTimestampV1(taskId, request, requestOptions));
+    }
+    __updateCompletionTimestampV1(taskId, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.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/tasks/completion_timestamp/update/v1/${encodeURIComponent(taskId)}`),
+                method: "PATCH",
+                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 PATCH /shipping/tasks/completion_timestamp/update/v1/{task_id}.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Overrides a draft or staged task location from a contact or coordinator shipper account and associates the reference. | authz_personas=[draft_creator_org_operator, order_creator_org_operators, task_group_operating_org_operators, coordinator_org_operators] | (TaskLocationFromReferenceReq) -> (PydanticObjectId)
      *

package/dist/cjs/api/resources/shipping/resources/tasks/client/requests/TaskCompleteReq.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface TaskCompleteReq {
+    completed_at_timestamp?: string | null;
+}

package/dist/cjs/api/resources/shipping/resources/tasks/client/requests/TaskCompletionTimestampUpdateReq.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         completed_at_timestamp: "2024-01-15T09:30:00Z"
+ *     }
+ */
+export interface TaskCompletionTimestampUpdateReq {
+    completed_at_timestamp: string;
+}

package/dist/cjs/api/resources/shipping/resources/tasks/client/requests/index.d.ts

@@ -1,3 +1,5 @@
 export { type AttemptTaskReq } from "./AttemptTaskReq.js";
+export { type TaskCompleteReq } from "./TaskCompleteReq.js";
+export { type TaskCompletionTimestampUpdateReq } from "./TaskCompletionTimestampUpdateReq.js";
 export { type TaskLocationFromReferenceReq } from "./TaskLocationFromReferenceReq.js";
 export { type WaitTimeOverrideReq } from "./WaitTimeOverrideReq.js";

package/dist/cjs/api/resources/tracking/client/Client.d.ts

@@ -5,7 +5,9 @@ import * as environments from "../../../../environments.js";
 import * as core from "../../../../core/index.js";
 import { Devices } from "../resources/devices/client/Client.js";
 import { Driver } from "../resources/driver/client/Client.js";
+import { GeofenceTemplates } from "../resources/geofenceTemplates/client/Client.js";
 import { Sessions } from "../resources/sessions/client/Client.js";
+import { SessionGeofences } from "../resources/sessionGeofences/client/Client.js";
 import { SharingSettings } from "../resources/sharingSettings/client/Client.js";
 import { Timeseries } from "../resources/timeseries/client/Client.js";
 export declare namespace Tracking {
@@ -23,13 +25,17 @@ export declare class Tracking {
     protected readonly _options: Tracking.Options;
     protected _devices: Devices | undefined;
     protected _driver: Driver | undefined;
+    protected _geofenceTemplates: GeofenceTemplates | undefined;
     protected _sessions: Sessions | undefined;
+    protected _sessionGeofences: SessionGeofences | undefined;
     protected _sharingSettings: SharingSettings | undefined;
     protected _timeseries: Timeseries | undefined;
     constructor(_options?: Tracking.Options);
     get devices(): Devices;
     get driver(): Driver;
+    get geofenceTemplates(): GeofenceTemplates;
     get sessions(): Sessions;
+    get sessionGeofences(): SessionGeofences;
     get sharingSettings(): SharingSettings;
     get timeseries(): Timeseries;
 }

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

@@ -6,9 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Tracking = void 0;
 const Client_js_1 = require("../resources/devices/client/Client.js");
 const Client_js_2 = require("../resources/driver/client/Client.js");
-const Client_js_3 = require("../resources/sessions/client/Client.js");
-const Client_js_4 = require("../resources/sharingSettings/client/Client.js");
-const Client_js_5 = require("../resources/timeseries/client/Client.js");
+const Client_js_3 = require("../resources/geofenceTemplates/client/Client.js");
+const Client_js_4 = require("../resources/sessions/client/Client.js");
+const Client_js_5 = require("../resources/sessionGeofences/client/Client.js");
+const Client_js_6 = require("../resources/sharingSettings/client/Client.js");
+const Client_js_7 = require("../resources/timeseries/client/Client.js");
 class Tracking {
     constructor(_options = {}) {
         this._options = _options;
@@ -21,17 +23,25 @@ class Tracking {
         var _a;
         return ((_a = this._driver) !== null && _a !== void 0 ? _a : (this._driver = new Client_js_2.Driver(this._options)));
     }
+    get geofenceTemplates() {
+        var _a;
+        return ((_a = this._geofenceTemplates) !== null && _a !== void 0 ? _a : (this._geofenceTemplates = new Client_js_3.GeofenceTemplates(this._options)));
+    }
     get sessions() {
         var _a;
-        return ((_a = this._sessions) !== null && _a !== void 0 ? _a : (this._sessions = new Client_js_3.Sessions(this._options)));
+        return ((_a = this._sessions) !== null && _a !== void 0 ? _a : (this._sessions = new Client_js_4.Sessions(this._options)));
+    }
+    get sessionGeofences() {
+        var _a;
+        return ((_a = this._sessionGeofences) !== null && _a !== void 0 ? _a : (this._sessionGeofences = new Client_js_5.SessionGeofences(this._options)));
     }
     get sharingSettings() {
         var _a;
-        return ((_a = this._sharingSettings) !== null && _a !== void 0 ? _a : (this._sharingSettings = new Client_js_4.SharingSettings(this._options)));
+        return ((_a = this._sharingSettings) !== null && _a !== void 0 ? _a : (this._sharingSettings = new Client_js_6.SharingSettings(this._options)));
     }
     get timeseries() {
         var _a;
-        return ((_a = this._timeseries) !== null && _a !== void 0 ? _a : (this._timeseries = new Client_js_5.Timeseries(this._options)));
+        return ((_a = this._timeseries) !== null && _a !== void 0 ? _a : (this._timeseries = new Client_js_7.Timeseries(this._options)));
     }
 }
 exports.Tracking = Tracking;

package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/Client.d.ts

@@ -0,0 +1,140 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments.js";
+import * as core from "../../../../../../core/index.js";
+import * as Chrt from "../../../../../index.js";
+export declare namespace GeofenceTemplates {
+    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 GeofenceTemplates {
+    protected readonly _options: GeofenceTemplates.Options;
+    constructor(_options?: GeofenceTemplates.Options);
+    /**
+     * Archives a geofence template owned by the caller's organization. | authz: min_org_role=operator | () -> (bool)
+     *
+     * @param {string} geofenceTemplateId
+     * @param {GeofenceTemplates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.geofenceTemplates.archiveV1("geofence_template_id")
+     */
+    archiveV1(geofenceTemplateId: string, requestOptions?: GeofenceTemplates.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __archiveV1;
+    /**
+     * Lists geofence templates for the caller's organization. | authz: min_org_role=operator | () -> (GeofenceTemplateListRes)
+     *
+     * @param {Chrt.tracking.GeofenceTemplatesListV1Request} request
+     * @param {GeofenceTemplates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.geofenceTemplates.listV1({
+     *         sort_by: "created_at_timestamp",
+     *         sort_order: "asc",
+     *         page: 1,
+     *         page_size: 1,
+     *         filter_archived: true,
+     *         filter_owned_by_user_id: "filter_owned_by_user_id",
+     *         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_last_used_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_last_used_at_timestamp_lte: "2024-01-15T09:30:00Z"
+     *     })
+     */
+    listV1(request?: Chrt.tracking.GeofenceTemplatesListV1Request, requestOptions?: GeofenceTemplates.RequestOptions): core.HttpResponsePromise<Chrt.GeofenceTemplateListRes>;
+    private __listV1;
+    /**
+     * Restores an archived geofence template owned by the caller's organization. | authz: min_org_role=operator | () -> (bool)
+     *
+     * @param {string} geofenceTemplateId
+     * @param {GeofenceTemplates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.geofenceTemplates.unarchiveV1("geofence_template_id")
+     */
+    unarchiveV1(geofenceTemplateId: string, requestOptions?: GeofenceTemplates.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __unarchiveV1;
+    /**
+     * Updates an active geofence template owned by the caller's organization. | authz: min_org_role=operator | (SessionGeofenceTemplateClientUpdate1) -> (SessionGeofenceTemplate1)
+     *
+     * @param {string} geofenceTemplateId
+     * @param {Chrt.tracking.SessionGeofenceTemplateClientUpdate1} request
+     * @param {GeofenceTemplates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.geofenceTemplates.updateV1("geofence_template_id")
+     */
+    updateV1(geofenceTemplateId: string, request?: Chrt.tracking.SessionGeofenceTemplateClientUpdate1, requestOptions?: GeofenceTemplates.RequestOptions): core.HttpResponsePromise<Chrt.SessionGeofenceTemplate1>;
+    private __updateV1;
+    /**
+     * Creates a geofence template owned by the caller's organization. | authz: min_org_role=operator | (SessionGeofenceTemplateClientCreate1) -> (SessionGeofenceTemplate1)
+     *
+     * @param {Chrt.tracking.SessionGeofenceTemplateClientCreate1} request
+     * @param {GeofenceTemplates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.geofenceTemplates.createV1({
+     *         geofences: [{
+     *                 display_name: "display_name",
+     *                 location: {
+     *                     geometry: {
+     *                         coordinates: [],
+     *                         type: "Point"
+     *                     },
+     *                     type: "Feature"
+     *                 },
+     *                 radius_miles: 1.1
+     *             }],
+     *         name: "name",
+     *         schema_version: 1
+     *     })
+     */
+    createV1(request: Chrt.tracking.SessionGeofenceTemplateClientCreate1, requestOptions?: GeofenceTemplates.RequestOptions): core.HttpResponsePromise<Chrt.SessionGeofenceTemplate1>;
+    private __createV1;
+    /**
+     * Retrieves a geofence template owned by the caller's organization. | authz: min_org_role=operator | () -> (SessionGeofenceTemplate1)
+     *
+     * @param {string} geofenceTemplateId
+     * @param {GeofenceTemplates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.geofenceTemplates.getByIdV1("geofence_template_id")
+     */
+    getByIdV1(geofenceTemplateId: string, requestOptions?: GeofenceTemplates.RequestOptions): core.HttpResponsePromise<Chrt.SessionGeofenceTemplate1>;
+    private __getByIdV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}