@chrt-inc/typescript-sdk 1.262.0 → 1.268.1

package/dist/cjs/Client.js

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

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

@@ -33,7 +33,7 @@ export declare class Devices {
     /**
      * Register a device to the caller's org.
      *
-     * @param {Chrt.tracking.DevicesRegisterToOrgRequest} request
+     * @param {Chrt.tracking.DevicesRegisterToOrgReq1} request
      * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
@@ -43,8 +43,34 @@ export declare class Devices {
      *         device_mac_address: "device_mac_address"
      *     })
      */
-    registerToOrg(request: Chrt.tracking.DevicesRegisterToOrgRequest, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<string>;
+    registerToOrg(request: Chrt.tracking.DevicesRegisterToOrgReq1, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<string>;
     private __registerToOrg;
+    /**
+     * Update the type and/or comments for a device.
+     *
+     * @param {Chrt.tracking.DevicesUpdateRequest1} request
+     * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.devices.update()
+     */
+    update(request?: Chrt.tracking.DevicesUpdateRequest1, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __update;
+    /**
+     * Delete a device by device_id or device_mac_address. Cannot delete if linked to a session or cargo.
+     *
+     * @param {Chrt.tracking.DevicesDeleteRequest} request
+     * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.devices.delete()
+     */
+    delete(request?: Chrt.tracking.DevicesDeleteRequest, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __delete;
     /**
      * Get a device by device_mac_address or device_id.
      *

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

@@ -58,7 +58,7 @@ class Devices {
     /**
      * Register a device to the caller's org.
      *
-     * @param {Chrt.tracking.DevicesRegisterToOrgRequest} request
+     * @param {Chrt.tracking.DevicesRegisterToOrgReq1} request
      * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
@@ -74,15 +74,15 @@ class Devices {
     __registerToOrg(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
-            const { device_mac_address: deviceMacAddress } = request;
-            const _queryParams = {};
-            _queryParams["device_mac_address"] = deviceMacAddress;
             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/devices/register_to_org"),
                 method: "POST",
                 headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                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,
@@ -119,6 +119,135 @@ class Devices {
             }
         });
     }
+    /**
+     * Update the type and/or comments for a device.
+     *
+     * @param {Chrt.tracking.DevicesUpdateRequest1} request
+     * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.devices.update()
+     */
+    update(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__update(request, requestOptions));
+    }
+    __update() {
+        return __awaiter(this, arguments, void 0, function* (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, "tracking/devices/update"),
+                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 /tracking/devices/update.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Delete a device by device_id or device_mac_address. Cannot delete if linked to a session or cargo.
+     *
+     * @param {Chrt.tracking.DevicesDeleteRequest} request
+     * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.devices.delete()
+     */
+    delete(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__delete(request, requestOptions));
+    }
+    __delete() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d;
+            const { device_id: deviceId, device_mac_address: deviceMacAddress } = request;
+            const _queryParams = {};
+            if (deviceId !== undefined) {
+                _queryParams["device_id"] = deviceId;
+            }
+            if (deviceMacAddress !== undefined) {
+                _queryParams["device_mac_address"] = deviceMacAddress;
+            }
+            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/devices/delete"),
+                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 /tracking/devices/delete.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Get a device by device_mac_address or device_id.
      *

package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesDeleteRequest.d.ts

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

package/dist/cjs/api/resources/tracking/resources/devices/client/requests/{DevicesRegisterToOrgRequest.d.ts → DevicesRegisterToOrgReq1.d.ts}

@@ -1,12 +1,15 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Chrt from "../../../../../../index.js";
 /**
  * @example
  *     {
  *         device_mac_address: "device_mac_address"
  *     }
  */
-export interface DevicesRegisterToOrgRequest {
+export interface DevicesRegisterToOrgReq1 {
     device_mac_address: string;
+    type?: Chrt.TrackingDeviceTypeEnum1 | null;
+    comments?: string | null;
 }

package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesUpdateRequest1.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../index.js";
+/**
+ * @example
+ *     {}
+ */
+export interface DevicesUpdateRequest1 {
+    device_id?: string | null;
+    device_mac_address?: string | null;
+    type?: Chrt.TrackingDeviceTypeEnum1 | null;
+    comments?: string | null;
+    delete_type?: boolean;
+    delete_comments?: boolean;
+}

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

@@ -1,4 +1,6 @@
-export { type DevicesRegisterToOrgRequest } from "./DevicesRegisterToOrgRequest.js";
+export { type DevicesRegisterToOrgReq1 } from "./DevicesRegisterToOrgReq1.js";
+export { type DevicesUpdateRequest1 } from "./DevicesUpdateRequest1.js";
+export { type DevicesDeleteRequest } from "./DevicesDeleteRequest.js";
 export { type DevicesGetRequest } from "./DevicesGetRequest.js";
 export { type DevicesLinkToCargoRequest } from "./DevicesLinkToCargoRequest.js";
 export { type DevicesUnlinkFromCargoRequest } from "./DevicesUnlinkFromCargoRequest.js";

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

@@ -40,6 +40,21 @@ export declare class SessionByDevice {
      */
     list(requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.Session1[]>;
     private __list;
+    /**
+     * Get a single session document by session_id.
+     *
+     * @param {Chrt.tracking.SessionByDeviceGetRequest} request
+     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionByDevice.get({
+     *         session_id: "session_id"
+     *     })
+     */
+    get(request: Chrt.tracking.SessionByDeviceGetRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.Session1>;
+    private __get;
     /**
      * Return the most recent datapoint for a session.
      *
@@ -86,79 +101,124 @@ export declare class SessionByDevice {
     createSession(request: Chrt.tracking.SessionByDeviceCreateSessionRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<string>;
     private __createSession;
     /**
-     * Overwrite or delete the comments for a session.
+     * Update a session's comments and/or public visibility status.
      *
-     * @param {Chrt.tracking.SessionByDeviceUpdateCommentsRequest1} request
+     * @param {Chrt.tracking.SessionByDeviceUpdateRequest1} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.updateComments({
+     *     await client.tracking.sessionByDevice.update({
      *         session_id: "session_id"
      *     })
      */
-    updateComments(request: Chrt.tracking.SessionByDeviceUpdateCommentsRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __updateComments;
+    update(request: Chrt.tracking.SessionByDeviceUpdateRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __update;
     /**
      * Start a session (set recording=true).
      *
-     * @param {Chrt.tracking.SessionByDeviceStartSessionRequest} request
+     * @param {Chrt.tracking.SessionByDeviceStartRequest} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.startSession({
+     *     await client.tracking.sessionByDevice.start({
      *         session_id: "session_id"
      *     })
      */
-    startSession(request: Chrt.tracking.SessionByDeviceStartSessionRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __startSession;
+    start(request: Chrt.tracking.SessionByDeviceStartRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __start;
     /**
      * Pause a session (set recording=false).
      *
-     * @param {Chrt.tracking.SessionByDevicePauseSessionRequest} request
+     * @param {Chrt.tracking.SessionByDevicePauseRecordingRequest} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.pauseSession({
+     *     await client.tracking.sessionByDevice.pauseRecording({
      *         session_id: "session_id"
      *     })
      */
-    pauseSession(request: Chrt.tracking.SessionByDevicePauseSessionRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __pauseSession;
+    pauseRecording(request: Chrt.tracking.SessionByDevicePauseRecordingRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __pauseRecording;
     /**
      * Resume a session (set recording=true).
      *
-     * @param {Chrt.tracking.SessionByDeviceResumeSessionRequest} request
+     * @param {Chrt.tracking.SessionByDeviceResumeRecordingRequest} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.resumeSession({
+     *     await client.tracking.sessionByDevice.resumeRecording({
      *         session_id: "session_id"
      *     })
      */
-    resumeSession(request: Chrt.tracking.SessionByDeviceResumeSessionRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __resumeSession;
+    resumeRecording(request: Chrt.tracking.SessionByDeviceResumeRecordingRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __resumeRecording;
     /**
      * End a session (set recording=false).
      *
-     * @param {Chrt.tracking.SessionByDeviceEndSessionRequest} request
+     * @param {Chrt.tracking.SessionByDeviceTerminateRequest} request
+     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionByDevice.terminate({
+     *         session_id: "session_id"
+     *     })
+     */
+    terminate(request: Chrt.tracking.SessionByDeviceTerminateRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __terminate;
+    /**
+     * Delete a terminated session and all associated timeseries data.
+     *
+     * @param {Chrt.tracking.SessionByDeviceDeleteRequest} request
+     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionByDevice.delete({
+     *         session_id: "session_id"
+     *     })
+     */
+    delete(request: Chrt.tracking.SessionByDeviceDeleteRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.SessionByDeviceDeleteResponse1>;
+    private __delete;
+    /**
+     * Return the most recent datapoint for a session. Session must be have public=True.
+     *
+     * @param {Chrt.tracking.SessionByDeviceLastSeenPublicRequest} request
+     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionByDevice.lastSeenPublic({
+     *         session_id: "session_id"
+     *     })
+     */
+    lastSeenPublic(request: Chrt.tracking.SessionByDeviceLastSeenPublicRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<(Chrt.TrackingSessionByDeviceDataPoint1 | null) | undefined>;
+    private __lastSeenPublic;
+    /**
+     * Return a specified number of data points for a public session, intelligently sampled across the time range. Session must have public=True.
+     *
+     * @param {Chrt.tracking.SessionByDeviceDataPointsPublicRequest} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.endSession({
+     *     await client.tracking.sessionByDevice.dataPointsPublic({
      *         session_id: "session_id"
      *     })
      */
-    endSession(request: Chrt.tracking.SessionByDeviceEndSessionRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __endSession;
+    dataPointsPublic(request: Chrt.tracking.SessionByDeviceDataPointsPublicRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSessionByDeviceDataPoint1[]>;
+    private __dataPointsPublic;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }