@chrt-inc/typescript-sdk 0.231.0 → 1.254.0

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

@@ -0,0 +1,134 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Driver = void 0;
+const environments = __importStar(require("../../../../../../environments.js"));
+const core = __importStar(require("../../../../../../core/index.js"));
+const Chrt = __importStar(require("../../../../../index.js"));
+const headers_js_1 = require("../../../../../../core/headers.js");
+const errors = __importStar(require("../../../../../../errors/index.js"));
+class Driver {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    /**
+     * Unified endpoint for driver location updates. Automatically determines whether to update task group tracking (if IN_PROGRESS) and/or cargo tracking (if IN_TRANSIT) based on current states.
+     *
+     * @param {Chrt.tracking.DriverUpdateReq} request
+     * @param {Driver.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.driver.update({
+     *         task_group_id: "task_group_id",
+     *         timestamp: "2024-01-15T09:30:00Z",
+     *         location: {
+     *             type: "Feature"
+     *         }
+     *     })
+     */
+    update(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__update(request, requestOptions));
+    }
+    __update(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "tracking/driver/update"),
+                method: "POST",
+                headers: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                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 /tracking/driver/update.");
+                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;
+        });
+    }
+}
+exports.Driver = Driver;

package/dist/cjs/api/resources/tracking/resources/driver/client/index.d.ts

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

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

package/dist/cjs/api/resources/tracking/resources/{cargoByDriver/client/requests/CargoByDriverUpdateReq.d.ts → driver/client/requests/DriverUpdateReq.d.ts}

@@ -12,7 +12,7 @@ import * as Chrt from "../../../../../../index.js";
  *         }
  *     }
  */
-export interface CargoByDriverUpdateReq {
+export interface DriverUpdateReq {
     task_group_id: string;
     timestamp: string;
     location: Chrt.LocationFeature;

package/dist/cjs/api/resources/tracking/resources/driver/client/requests/DriverUpdateReq.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/resources/tracking/resources/driver/client/requests/index.d.ts

@@ -0,0 +1 @@
+export { type DriverUpdateReq } from "./DriverUpdateReq.js";

package/dist/cjs/api/resources/tracking/resources/driver/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/tracking/resources/driver/index.d.ts

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

package/dist/cjs/api/resources/tracking/resources/driver/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/resources/tracking/resources/index.d.ts

@@ -1,4 +1,12 @@
+export * as cargoByDevice from "./cargoByDevice/index.js";
 export * as cargoByDriver from "./cargoByDriver/index.js";
+export * as devices from "./devices/index.js";
+export * as driver from "./driver/index.js";
 export * as taskGroupByDriver from "./taskGroupByDriver/index.js";
+export * as sessionByDevice from "./sessionByDevice/index.js";
+export * from "./cargoByDevice/client/requests/index.js";
 export * from "./cargoByDriver/client/requests/index.js";
+export * from "./devices/client/requests/index.js";
+export * from "./driver/client/requests/index.js";
 export * from "./taskGroupByDriver/client/requests/index.js";
+export * from "./sessionByDevice/client/requests/index.js";

package/dist/cjs/api/resources/tracking/resources/index.js

@@ -36,8 +36,16 @@ 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 });
-exports.taskGroupByDriver = exports.cargoByDriver = void 0;
+exports.sessionByDevice = exports.taskGroupByDriver = exports.driver = exports.devices = exports.cargoByDriver = exports.cargoByDevice = void 0;
+exports.cargoByDevice = __importStar(require("./cargoByDevice/index.js"));
 exports.cargoByDriver = __importStar(require("./cargoByDriver/index.js"));
+exports.devices = __importStar(require("./devices/index.js"));
+exports.driver = __importStar(require("./driver/index.js"));
 exports.taskGroupByDriver = __importStar(require("./taskGroupByDriver/index.js"));
+exports.sessionByDevice = __importStar(require("./sessionByDevice/index.js"));
+__exportStar(require("./cargoByDevice/client/requests/index.js"), exports);
 __exportStar(require("./cargoByDriver/client/requests/index.js"), exports);
+__exportStar(require("./devices/client/requests/index.js"), exports);
+__exportStar(require("./driver/client/requests/index.js"), exports);
 __exportStar(require("./taskGroupByDriver/client/requests/index.js"), exports);
+__exportStar(require("./sessionByDevice/client/requests/index.js"), exports);

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

@@ -0,0 +1,167 @@
+/**
+ * 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 SessionByDevice {
+    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 | undefined> | 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 headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+export declare class SessionByDevice {
+    protected readonly _options: SessionByDevice.Options;
+    constructor(_options?: SessionByDevice.Options);
+    /**
+     * Return the most recent datapoint for a session.
+     *
+     * @param {Chrt.tracking.SessionByDeviceLastSeenRequest} request
+     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionByDevice.lastSeen({
+     *         session_id: "session_id"
+     *     })
+     */
+    lastSeen(request: Chrt.tracking.SessionByDeviceLastSeenRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<(Chrt.TrackingSessionByDeviceDataPoint1 | null) | undefined>;
+    private __lastSeen;
+    /**
+     * Return a specified number of data points for a session, intelligently sampled across the time range.
+     *
+     * @param {Chrt.tracking.SessionByDeviceDataPointsRequest} request
+     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionByDevice.dataPoints({
+     *         session_id: "session_id"
+     *     })
+     */
+    dataPoints(request: Chrt.tracking.SessionByDeviceDataPointsRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSessionByDeviceDataPoint1[]>;
+    private __dataPoints;
+    /**
+     * Return data points for a session with intelligent stop/movement detection. Detects stops (location barely changes for >5 minutes) and shows up to 5 markers. For movement, samples data points lightly.
+     *
+     * @param {Chrt.tracking.SessionByDeviceDataPointsFancyRequest} request
+     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionByDevice.dataPointsFancy({
+     *         session_id: "session_id"
+     *     })
+     */
+    dataPointsFancy(request: Chrt.tracking.SessionByDeviceDataPointsFancyRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSessionByDeviceDataPoint1[]>;
+    private __dataPointsFancy;
+    /**
+     * Create a session for a device and link the device to it.
+     *
+     * @param {Chrt.tracking.SessionByDeviceCreateSessionRequest1} request
+     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionByDevice.createSession({
+     *         device_mac_address: "device_mac_address"
+     *     })
+     */
+    createSession(request: Chrt.tracking.SessionByDeviceCreateSessionRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<string>;
+    private __createSession;
+    /**
+     * Overwrite or delete the comments for a session.
+     *
+     * @param {Chrt.tracking.SessionByDeviceUpdateCommentsRequest1} request
+     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionByDevice.updateComments({
+     *         session_id: "session_id"
+     *     })
+     */
+    updateComments(request: Chrt.tracking.SessionByDeviceUpdateCommentsRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateComments;
+    /**
+     * Start a session (set recording=true).
+     *
+     * @param {Chrt.tracking.SessionByDeviceStartSessionRequest} request
+     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionByDevice.startSession({
+     *         session_id: "session_id"
+     *     })
+     */
+    startSession(request: Chrt.tracking.SessionByDeviceStartSessionRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __startSession;
+    /**
+     * Pause a session (set recording=false).
+     *
+     * @param {Chrt.tracking.SessionByDevicePauseSessionRequest} request
+     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionByDevice.pauseSession({
+     *         session_id: "session_id"
+     *     })
+     */
+    pauseSession(request: Chrt.tracking.SessionByDevicePauseSessionRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __pauseSession;
+    /**
+     * Resume a session (set recording=true).
+     *
+     * @param {Chrt.tracking.SessionByDeviceResumeSessionRequest} request
+     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionByDevice.resumeSession({
+     *         session_id: "session_id"
+     *     })
+     */
+    resumeSession(request: Chrt.tracking.SessionByDeviceResumeSessionRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __resumeSession;
+    /**
+     * End a session (set recording=false).
+     *
+     * @param {Chrt.tracking.SessionByDeviceEndSessionRequest} request
+     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionByDevice.endSession({
+     *         session_id: "session_id"
+     *     })
+     */
+    endSession(request: Chrt.tracking.SessionByDeviceEndSessionRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __endSession;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}