@chrt-inc/typescript-sdk 1.594.0 → 1.601.0

package/dist/cjs/api/resources/trackingIntegrations/resources/tive/resources/devices/client/Client.js

@@ -0,0 +1,226 @@
+"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.Devices = 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 Devices {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    /**
+     * Lists Tive devices with filtering, sorting, and pagination. Scoped to the caller's organization. | authz: min_org_role=operator | () -> (TiveDeviceListRes)
+     *
+     * @param {Chrt.trackingIntegrations.tive.DevicesListV1Request} request
+     * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.trackingIntegrations.tive.devices.listV1({
+     *         sort_by: "chrt_created_at_timestamp",
+     *         sort_order: "asc",
+     *         page: 1,
+     *         page_size: 1,
+     *         filter_tive_account_id: 1,
+     *         filter_tive_device_id: "filter_tive_device_id",
+     *         filter_chrt_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_chrt_created_at_timestamp_lte: "2024-01-15T09:30:00Z"
+     *     })
+     */
+    listV1(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listV1(request, requestOptions));
+    }
+    __listV1() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g;
+            const { sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, filter_tive_account_id: filterTiveAccountId, filter_tive_device_id: filterTiveDeviceId, filter_chrt_created_at_timestamp_gte: filterChrtCreatedAtTimestampGte, filter_chrt_created_at_timestamp_lte: filterChrtCreatedAtTimestampLte, } = request;
+            const _queryParams = {};
+            if (sortBy !== undefined) {
+                _queryParams["sort_by"] = sortBy;
+            }
+            if (sortOrder !== undefined) {
+                _queryParams["sort_order"] = sortOrder;
+            }
+            if (page !== undefined) {
+                _queryParams["page"] = (_a = page === null || page === void 0 ? void 0 : page.toString()) !== null && _a !== void 0 ? _a : null;
+            }
+            if (pageSize !== undefined) {
+                _queryParams["page_size"] = (_b = pageSize === null || pageSize === void 0 ? void 0 : pageSize.toString()) !== null && _b !== void 0 ? _b : null;
+            }
+            if (filterTiveAccountId !== undefined) {
+                _queryParams["filter_tive_account_id"] = (_c = filterTiveAccountId === null || filterTiveAccountId === void 0 ? void 0 : filterTiveAccountId.toString()) !== null && _c !== void 0 ? _c : null;
+            }
+            if (filterTiveDeviceId !== undefined) {
+                _queryParams["filter_tive_device_id"] = filterTiveDeviceId;
+            }
+            if (filterChrtCreatedAtTimestampGte !== undefined) {
+                _queryParams["filter_chrt_created_at_timestamp_gte"] = filterChrtCreatedAtTimestampGte;
+            }
+            if (filterChrtCreatedAtTimestampLte !== undefined) {
+                _queryParams["filter_chrt_created_at_timestamp_lte"] = filterChrtCreatedAtTimestampLte;
+            }
+            let _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);
+            const _response = yield ((_e = this._options.fetcher) !== null && _e !== void 0 ? _e : core.fetcher)({
+                url: core.url.join((_g = (_f = (yield core.Supplier.get(this._options.baseUrl))) !== null && _f !== void 0 ? _f : (yield core.Supplier.get(this._options.environment))) !== null && _g !== void 0 ? _g : environments.ChrtEnvironment.Local, "tracking_integrations/tive/devices/list/v1"),
+                method: "GET",
+                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 GET /tracking_integrations/tive/devices/list/v1.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Retrieves a single Tive device by its ID. Scoped to the caller's organization. | authz: min_org_role=operator | () -> (TiveDevice1)
+     *
+     * @param {Chrt.trackingIntegrations.tive.DevicesGetV1Request} request
+     * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.trackingIntegrations.tive.devices.getV1({
+     *         tive_device_id: "tive_device_id"
+     *     })
+     */
+    getV1(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getV1(request, requestOptions));
+    }
+    __getV1(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            const { tive_device_id: tiveDeviceId } = request;
+            const _queryParams = {};
+            _queryParams["tive_device_id"] = tiveDeviceId;
+            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, "tracking_integrations/tive/devices/get/v1"),
+                method: "GET",
+                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 GET /tracking_integrations/tive/devices/get/v1.");
+                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.Devices = Devices;

package/dist/cjs/api/resources/trackingIntegrations/resources/tive/resources/devices/client/index.d.ts

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

package/dist/cjs/api/resources/trackingIntegrations/resources/tive/resources/devices/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/trackingIntegrations/resources/tive/resources/devices/client/requests/DevicesGetV1Request.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         tive_device_id: "tive_device_id"
+ *     }
+ */
+export interface DevicesGetV1Request {
+    tive_device_id: string;
+}

package/dist/cjs/api/resources/trackingIntegrations/resources/tive/resources/devices/client/requests/DevicesGetV1Request.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/trackingIntegrations/resources/tive/resources/devices/client/requests/DevicesListV1Request.d.ts

@@ -0,0 +1,33 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         sort_by: "chrt_created_at_timestamp",
+ *         sort_order: "asc",
+ *         page: 1,
+ *         page_size: 1,
+ *         filter_tive_account_id: 1,
+ *         filter_tive_device_id: "filter_tive_device_id",
+ *         filter_chrt_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
+ *         filter_chrt_created_at_timestamp_lte: "2024-01-15T09:30:00Z"
+ *     }
+ */
+export interface DevicesListV1Request {
+    /** Field to sort by */
+    sort_by?: Chrt.TiveDeviceSortByEnum | null;
+    /** Sort order (asc or desc) */
+    sort_order?: Chrt.SortOrderEnum | null;
+    page?: number | null;
+    page_size?: number | null;
+    /** Filter by Tive account ID */
+    filter_tive_account_id?: number | null;
+    /** Filter by Tive device ID (exact match) */
+    filter_tive_device_id?: string | null;
+    /** Filter by chrt_created_at_timestamp >= value */
+    filter_chrt_created_at_timestamp_gte?: string | null;
+    /** Filter by chrt_created_at_timestamp <= value */
+    filter_chrt_created_at_timestamp_lte?: string | null;
+}

package/dist/cjs/api/resources/trackingIntegrations/resources/tive/resources/devices/client/requests/DevicesListV1Request.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/trackingIntegrations/resources/tive/resources/devices/client/requests/index.d.ts

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

package/dist/cjs/api/resources/trackingIntegrations/resources/tive/resources/devices/client/requests/index.js

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

package/dist/cjs/api/resources/trackingIntegrations/resources/tive/resources/devices/index.d.ts

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

package/dist/cjs/api/resources/trackingIntegrations/resources/tive/resources/devices/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/trackingIntegrations/resources/tive/resources/index.d.ts

@@ -0,0 +1,6 @@
+export * as devices from "./devices/index.js";
+export * as shipments from "./shipments/index.js";
+export * as timeseries from "./timeseries/index.js";
+export * from "./devices/client/requests/index.js";
+export * from "./shipments/client/requests/index.js";
+export * from "./timeseries/client/requests/index.js";

package/dist/cjs/api/resources/trackingIntegrations/resources/tive/resources/index.js

@@ -0,0 +1,45 @@
+"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 __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 __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.timeseries = exports.shipments = exports.devices = void 0;
+exports.devices = __importStar(require("./devices/index.js"));
+exports.shipments = __importStar(require("./shipments/index.js"));
+exports.timeseries = __importStar(require("./timeseries/index.js"));
+__exportStar(require("./devices/client/requests/index.js"), exports);
+__exportStar(require("./shipments/client/requests/index.js"), exports);
+__exportStar(require("./timeseries/client/requests/index.js"), exports);

package/dist/cjs/api/resources/trackingIntegrations/resources/tive/resources/shipments/client/Client.d.ts

@@ -0,0 +1,71 @@
+/**
+ * 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 Shipments {
+    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 Shipments {
+    protected readonly _options: Shipments.Options;
+    constructor(_options?: Shipments.Options);
+    /**
+     * Lists Tive shipments with filtering, sorting, and pagination. Scoped to the caller's organization. | authz: min_org_role=operator | () -> (TiveShipmentListRes)
+     *
+     * @param {Chrt.trackingIntegrations.tive.ShipmentsListV1Request} request
+     * @param {Shipments.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.trackingIntegrations.tive.shipments.listV1({
+     *         sort_by: "chrt_created_at_timestamp",
+     *         sort_order: "asc",
+     *         page: 1,
+     *         page_size: 1,
+     *         filter_tive_device_object_id: "filter_tive_device_object_id",
+     *         filter_tive_shipment_id: "filter_tive_shipment_id",
+     *         filter_chrt_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_chrt_created_at_timestamp_lte: "2024-01-15T09:30:00Z"
+     *     })
+     */
+    listV1(request?: Chrt.trackingIntegrations.tive.ShipmentsListV1Request, requestOptions?: Shipments.RequestOptions): core.HttpResponsePromise<Chrt.TiveShipmentListRes>;
+    private __listV1;
+    /**
+     * Retrieves a single Tive shipment by its ID. Scoped to the caller's organization. | authz: min_org_role=operator | () -> (TiveShipment1)
+     *
+     * @param {Chrt.trackingIntegrations.tive.ShipmentsGetV1Request} request
+     * @param {Shipments.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.trackingIntegrations.tive.shipments.getV1({
+     *         tive_shipment_id: "tive_shipment_id"
+     *     })
+     */
+    getV1(request: Chrt.trackingIntegrations.tive.ShipmentsGetV1Request, requestOptions?: Shipments.RequestOptions): core.HttpResponsePromise<Chrt.TiveShipment1>;
+    private __getV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}