@chrt-inc/typescript-sdk 1.262.0 → 1.268.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.d.ts +28 -2
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js +134 -5
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesDeleteRequest.d.ts +11 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/{DevicesRegisterToOrgRequest.d.ts → DevicesRegisterToOrgReq1.d.ts} +4 -1
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesUpdateRequest1.d.ts +16 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/index.d.ts +3 -1
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/Client.d.ts +81 -21
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/Client.js +301 -36
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceDataPointsPublicRequest.d.ts +13 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/{SessionByDeviceEndSessionRequest.d.ts → SessionByDeviceDeleteRequest.d.ts} +1 -1
- package/dist/{esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceEndSessionRequest.d.mts → cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceGetRequest.d.ts} +1 -1
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/{SessionByDeviceResumeSessionRequest.d.ts → SessionByDeviceLastSeenPublicRequest.d.ts} +1 -1
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceLastSeenPublicRequest.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDevicePauseRecordingRequest.d.ts +12 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDevicePauseRecordingRequest.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceResumeRecordingRequest.d.ts +12 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceResumeRecordingRequest.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/{SessionByDeviceStartSessionRequest.d.ts → SessionByDeviceStartRequest.d.ts} +1 -1
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceStartRequest.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/{SessionByDevicePauseSessionRequest.d.ts → SessionByDeviceTerminateRequest.d.ts} +1 -1
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceTerminateRequest.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/{SessionByDeviceUpdateCommentsRequest1.d.ts → SessionByDeviceUpdateRequest1.d.ts} +2 -1
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceUpdateRequest1.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/index.d.ts +9 -5
- package/dist/cjs/api/types/Device1.d.ts +2 -0
- package/dist/cjs/api/types/Session1.d.ts +3 -0
- package/dist/cjs/api/types/SessionByDeviceDeleteResponse1.d.ts +7 -0
- package/dist/cjs/api/types/SessionByDeviceDeleteResponse1.js +5 -0
- package/dist/cjs/api/types/TrackingDeviceTypeEnum1.d.ts +4 -4
- package/dist/cjs/api/types/TrackingDeviceTypeEnum1.js +3 -3
- package/dist/cjs/api/types/index.d.ts +1 -0
- package/dist/cjs/api/types/index.js +1 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.d.mts +28 -2
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs +134 -5
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesDeleteRequest.d.mts +11 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/{DevicesRegisterToOrgRequest.d.mts → DevicesRegisterToOrgReq1.d.mts} +4 -1
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesUpdateRequest1.d.mts +16 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/index.d.mts +3 -1
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/Client.d.mts +81 -21
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/Client.mjs +301 -36
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceDataPointsPublicRequest.d.mts +13 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceDeleteRequest.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceGetRequest.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceLastSeenPublicRequest.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceLastSeenPublicRequest.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDevicePauseRecordingRequest.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDevicePauseRecordingRequest.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceResumeRecordingRequest.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceResumeRecordingRequest.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceStartRequest.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceStartRequest.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceTerminateRequest.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceTerminateRequest.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/{SessionByDeviceUpdateCommentsRequest1.d.mts → SessionByDeviceUpdateRequest1.d.mts} +2 -1
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceUpdateRequest1.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/index.d.mts +9 -5
- package/dist/esm/api/types/Device1.d.mts +2 -0
- package/dist/esm/api/types/Session1.d.mts +3 -0
- package/dist/esm/api/types/SessionByDeviceDeleteResponse1.d.mts +7 -0
- package/dist/esm/api/types/SessionByDeviceDeleteResponse1.mjs +4 -0
- package/dist/esm/api/types/TrackingDeviceTypeEnum1.d.mts +4 -4
- package/dist/esm/api/types/TrackingDeviceTypeEnum1.mjs +3 -3
- package/dist/esm/api/types/index.d.mts +1 -0
- package/dist/esm/api/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +403 -17
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDevicePauseSessionRequest.d.mts +0 -12
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceResumeSessionRequest.d.mts +0 -12
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceStartSessionRequest.d.mts +0 -12
- /package/dist/cjs/api/resources/tracking/resources/devices/client/requests/{DevicesRegisterToOrgRequest.js → DevicesDeleteRequest.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceEndSessionRequest.js → devices/client/requests/DevicesRegisterToOrgReq1.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDevicePauseSessionRequest.js → devices/client/requests/DevicesUpdateRequest1.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/{SessionByDeviceResumeSessionRequest.js → SessionByDeviceDataPointsPublicRequest.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/{SessionByDeviceStartSessionRequest.js → SessionByDeviceDeleteRequest.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/{SessionByDeviceUpdateCommentsRequest1.js → SessionByDeviceGetRequest.js} +0 -0
- /package/dist/esm/api/resources/tracking/resources/devices/client/requests/{DevicesRegisterToOrgRequest.mjs → DevicesDeleteRequest.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceEndSessionRequest.mjs → devices/client/requests/DevicesRegisterToOrgReq1.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDevicePauseSessionRequest.mjs → devices/client/requests/DevicesUpdateRequest1.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/{SessionByDeviceResumeSessionRequest.mjs → SessionByDeviceDataPointsPublicRequest.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/{SessionByDeviceStartSessionRequest.mjs → SessionByDeviceDeleteRequest.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/{SessionByDeviceUpdateCommentsRequest1.mjs → SessionByDeviceGetRequest.mjs} +0 -0
package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/index.d.ts
CHANGED
|
@@ -1,8 +1,12 @@
|
|
|
1
|
+
export { type SessionByDeviceGetRequest } from "./SessionByDeviceGetRequest.js";
|
|
1
2
|
export { type SessionByDeviceLastSeenRequest } from "./SessionByDeviceLastSeenRequest.js";
|
|
2
3
|
export { type SessionByDeviceDataPointsRequest } from "./SessionByDeviceDataPointsRequest.js";
|
|
3
4
|
export { type SessionByDeviceCreateSessionRequest1 } from "./SessionByDeviceCreateSessionRequest1.js";
|
|
4
|
-
export { type
|
|
5
|
-
export { type
|
|
6
|
-
export { type
|
|
7
|
-
export { type
|
|
8
|
-
export { type
|
|
5
|
+
export { type SessionByDeviceUpdateRequest1 } from "./SessionByDeviceUpdateRequest1.js";
|
|
6
|
+
export { type SessionByDeviceStartRequest } from "./SessionByDeviceStartRequest.js";
|
|
7
|
+
export { type SessionByDevicePauseRecordingRequest } from "./SessionByDevicePauseRecordingRequest.js";
|
|
8
|
+
export { type SessionByDeviceResumeRecordingRequest } from "./SessionByDeviceResumeRecordingRequest.js";
|
|
9
|
+
export { type SessionByDeviceTerminateRequest } from "./SessionByDeviceTerminateRequest.js";
|
|
10
|
+
export { type SessionByDeviceDeleteRequest } from "./SessionByDeviceDeleteRequest.js";
|
|
11
|
+
export { type SessionByDeviceLastSeenPublicRequest } from "./SessionByDeviceLastSeenPublicRequest.js";
|
|
12
|
+
export { type SessionByDeviceDataPointsPublicRequest } from "./SessionByDeviceDataPointsPublicRequest.js";
|
|
@@ -10,10 +10,12 @@ export interface Device1 {
|
|
|
10
10
|
device_token?: string | null;
|
|
11
11
|
type?: Chrt.TrackingDeviceTypeEnum1 | null;
|
|
12
12
|
registered_at_timestamp?: string | null;
|
|
13
|
+
first_seen_at_timestamp?: string | null;
|
|
13
14
|
last_seen_at_location?: Chrt.LocationFeature | null;
|
|
14
15
|
last_seen_at_timestamp?: string | null;
|
|
15
16
|
last_seen_battery_level?: string | null;
|
|
16
17
|
session_id?: string | null;
|
|
17
18
|
cargo_id?: string | null;
|
|
19
|
+
comments?: string | null;
|
|
18
20
|
_id: string;
|
|
19
21
|
}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
export type TrackingDeviceTypeEnum1 = "D15N" | "MTB06" | "T3-D";
|
|
4
|
+
export type TrackingDeviceTypeEnum1 = "D15N-tag" | "MTB06-label" | "T3-D-tag";
|
|
5
5
|
export declare const TrackingDeviceTypeEnum1: {
|
|
6
|
-
readonly
|
|
7
|
-
readonly
|
|
8
|
-
readonly
|
|
6
|
+
readonly D15NTag: "D15N-tag";
|
|
7
|
+
readonly Mtb06Label: "MTB06-label";
|
|
8
|
+
readonly T3DTag: "T3-D-tag";
|
|
9
9
|
};
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
exports.TrackingDeviceTypeEnum1 = void 0;
|
|
7
7
|
exports.TrackingDeviceTypeEnum1 = {
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
8
|
+
D15NTag: "D15N-tag",
|
|
9
|
+
Mtb06Label: "MTB06-label",
|
|
10
|
+
T3DTag: "T3-D-tag",
|
|
11
11
|
};
|
|
@@ -67,6 +67,7 @@ export * from "./Position3D.js";
|
|
|
67
67
|
export * from "./PriceNameEnum.js";
|
|
68
68
|
export * from "./RouteTypeEnum1.js";
|
|
69
69
|
export * from "./Session1.js";
|
|
70
|
+
export * from "./SessionByDeviceDeleteResponse1.js";
|
|
70
71
|
export * from "./ShipperContactInfo1.js";
|
|
71
72
|
export * from "./ShipperContactInfoClientCreate1.js";
|
|
72
73
|
export * from "./ShipperNotificationEventEnum.js";
|
|
@@ -83,6 +83,7 @@ __exportStar(require("./Position3D.js"), exports);
|
|
|
83
83
|
__exportStar(require("./PriceNameEnum.js"), exports);
|
|
84
84
|
__exportStar(require("./RouteTypeEnum1.js"), exports);
|
|
85
85
|
__exportStar(require("./Session1.js"), exports);
|
|
86
|
+
__exportStar(require("./SessionByDeviceDeleteResponse1.js"), exports);
|
|
86
87
|
__exportStar(require("./ShipperContactInfo1.js"), exports);
|
|
87
88
|
__exportStar(require("./ShipperContactInfoClientCreate1.js"), exports);
|
|
88
89
|
__exportStar(require("./ShipperNotificationEventEnum.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.268.1";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/Client.mjs
CHANGED
|
@@ -32,8 +32,8 @@ export class ChrtClient {
|
|
|
32
32
|
this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
|
|
33
33
|
"X-Fern-Language": "JavaScript",
|
|
34
34
|
"X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
|
|
35
|
-
"X-Fern-SDK-Version": "1.
|
|
36
|
-
"User-Agent": "@chrt-inc/typescript-sdk/1.
|
|
35
|
+
"X-Fern-SDK-Version": "1.268.1",
|
|
36
|
+
"User-Agent": "@chrt-inc/typescript-sdk/1.268.1",
|
|
37
37
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
38
38
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
39
39
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -33,7 +33,7 @@ export declare class Devices {
|
|
|
33
33
|
/**
|
|
34
34
|
* Register a device to the caller's org.
|
|
35
35
|
*
|
|
36
|
-
* @param {Chrt.tracking.
|
|
36
|
+
* @param {Chrt.tracking.DevicesRegisterToOrgReq1} request
|
|
37
37
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
38
38
|
*
|
|
39
39
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
@@ -43,8 +43,34 @@ export declare class Devices {
|
|
|
43
43
|
* device_mac_address: "device_mac_address"
|
|
44
44
|
* })
|
|
45
45
|
*/
|
|
46
|
-
registerToOrg(request: Chrt.tracking.
|
|
46
|
+
registerToOrg(request: Chrt.tracking.DevicesRegisterToOrgReq1, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<string>;
|
|
47
47
|
private __registerToOrg;
|
|
48
|
+
/**
|
|
49
|
+
* Update the type and/or comments for a device.
|
|
50
|
+
*
|
|
51
|
+
* @param {Chrt.tracking.DevicesUpdateRequest1} request
|
|
52
|
+
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
55
|
+
*
|
|
56
|
+
* @example
|
|
57
|
+
* await client.tracking.devices.update()
|
|
58
|
+
*/
|
|
59
|
+
update(request?: Chrt.tracking.DevicesUpdateRequest1, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
60
|
+
private __update;
|
|
61
|
+
/**
|
|
62
|
+
* Delete a device by device_id or device_mac_address. Cannot delete if linked to a session or cargo.
|
|
63
|
+
*
|
|
64
|
+
* @param {Chrt.tracking.DevicesDeleteRequest} request
|
|
65
|
+
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* await client.tracking.devices.delete()
|
|
71
|
+
*/
|
|
72
|
+
delete(request?: Chrt.tracking.DevicesDeleteRequest, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
73
|
+
private __delete;
|
|
48
74
|
/**
|
|
49
75
|
* Get a device by device_mac_address or device_id.
|
|
50
76
|
*
|
|
@@ -22,7 +22,7 @@ export class Devices {
|
|
|
22
22
|
/**
|
|
23
23
|
* Register a device to the caller's org.
|
|
24
24
|
*
|
|
25
|
-
* @param {Chrt.tracking.
|
|
25
|
+
* @param {Chrt.tracking.DevicesRegisterToOrgReq1} request
|
|
26
26
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
27
27
|
*
|
|
28
28
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
@@ -38,15 +38,15 @@ export class Devices {
|
|
|
38
38
|
__registerToOrg(request, requestOptions) {
|
|
39
39
|
return __awaiter(this, void 0, void 0, function* () {
|
|
40
40
|
var _a, _b, _c, _d;
|
|
41
|
-
const { device_mac_address: deviceMacAddress } = request;
|
|
42
|
-
const _queryParams = {};
|
|
43
|
-
_queryParams["device_mac_address"] = deviceMacAddress;
|
|
44
41
|
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);
|
|
45
42
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
46
43
|
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"),
|
|
47
44
|
method: "POST",
|
|
48
45
|
headers: _headers,
|
|
49
|
-
|
|
46
|
+
contentType: "application/json",
|
|
47
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
48
|
+
requestType: "json",
|
|
49
|
+
body: request,
|
|
50
50
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
51
51
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
52
52
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -83,6 +83,135 @@ export class Devices {
|
|
|
83
83
|
}
|
|
84
84
|
});
|
|
85
85
|
}
|
|
86
|
+
/**
|
|
87
|
+
* Update the type and/or comments for a device.
|
|
88
|
+
*
|
|
89
|
+
* @param {Chrt.tracking.DevicesUpdateRequest1} request
|
|
90
|
+
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
93
|
+
*
|
|
94
|
+
* @example
|
|
95
|
+
* await client.tracking.devices.update()
|
|
96
|
+
*/
|
|
97
|
+
update(request = {}, requestOptions) {
|
|
98
|
+
return core.HttpResponsePromise.fromPromise(this.__update(request, requestOptions));
|
|
99
|
+
}
|
|
100
|
+
__update() {
|
|
101
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
102
|
+
var _a, _b, _c, _d;
|
|
103
|
+
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);
|
|
104
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
105
|
+
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"),
|
|
106
|
+
method: "POST",
|
|
107
|
+
headers: _headers,
|
|
108
|
+
contentType: "application/json",
|
|
109
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
110
|
+
requestType: "json",
|
|
111
|
+
body: request,
|
|
112
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
113
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
114
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
115
|
+
});
|
|
116
|
+
if (_response.ok) {
|
|
117
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
118
|
+
}
|
|
119
|
+
if (_response.error.reason === "status-code") {
|
|
120
|
+
switch (_response.error.statusCode) {
|
|
121
|
+
case 422:
|
|
122
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
123
|
+
default:
|
|
124
|
+
throw new errors.ChrtError({
|
|
125
|
+
statusCode: _response.error.statusCode,
|
|
126
|
+
body: _response.error.body,
|
|
127
|
+
rawResponse: _response.rawResponse,
|
|
128
|
+
});
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
switch (_response.error.reason) {
|
|
132
|
+
case "non-json":
|
|
133
|
+
throw new errors.ChrtError({
|
|
134
|
+
statusCode: _response.error.statusCode,
|
|
135
|
+
body: _response.error.rawBody,
|
|
136
|
+
rawResponse: _response.rawResponse,
|
|
137
|
+
});
|
|
138
|
+
case "timeout":
|
|
139
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /tracking/devices/update.");
|
|
140
|
+
case "unknown":
|
|
141
|
+
throw new errors.ChrtError({
|
|
142
|
+
message: _response.error.errorMessage,
|
|
143
|
+
rawResponse: _response.rawResponse,
|
|
144
|
+
});
|
|
145
|
+
}
|
|
146
|
+
});
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Delete a device by device_id or device_mac_address. Cannot delete if linked to a session or cargo.
|
|
150
|
+
*
|
|
151
|
+
* @param {Chrt.tracking.DevicesDeleteRequest} request
|
|
152
|
+
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
153
|
+
*
|
|
154
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
155
|
+
*
|
|
156
|
+
* @example
|
|
157
|
+
* await client.tracking.devices.delete()
|
|
158
|
+
*/
|
|
159
|
+
delete(request = {}, requestOptions) {
|
|
160
|
+
return core.HttpResponsePromise.fromPromise(this.__delete(request, requestOptions));
|
|
161
|
+
}
|
|
162
|
+
__delete() {
|
|
163
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
164
|
+
var _a, _b, _c, _d;
|
|
165
|
+
const { device_id: deviceId, device_mac_address: deviceMacAddress } = request;
|
|
166
|
+
const _queryParams = {};
|
|
167
|
+
if (deviceId !== undefined) {
|
|
168
|
+
_queryParams["device_id"] = deviceId;
|
|
169
|
+
}
|
|
170
|
+
if (deviceMacAddress !== undefined) {
|
|
171
|
+
_queryParams["device_mac_address"] = deviceMacAddress;
|
|
172
|
+
}
|
|
173
|
+
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);
|
|
174
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
175
|
+
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"),
|
|
176
|
+
method: "DELETE",
|
|
177
|
+
headers: _headers,
|
|
178
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
179
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
180
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
181
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
182
|
+
});
|
|
183
|
+
if (_response.ok) {
|
|
184
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
185
|
+
}
|
|
186
|
+
if (_response.error.reason === "status-code") {
|
|
187
|
+
switch (_response.error.statusCode) {
|
|
188
|
+
case 422:
|
|
189
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
190
|
+
default:
|
|
191
|
+
throw new errors.ChrtError({
|
|
192
|
+
statusCode: _response.error.statusCode,
|
|
193
|
+
body: _response.error.body,
|
|
194
|
+
rawResponse: _response.rawResponse,
|
|
195
|
+
});
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
switch (_response.error.reason) {
|
|
199
|
+
case "non-json":
|
|
200
|
+
throw new errors.ChrtError({
|
|
201
|
+
statusCode: _response.error.statusCode,
|
|
202
|
+
body: _response.error.rawBody,
|
|
203
|
+
rawResponse: _response.rawResponse,
|
|
204
|
+
});
|
|
205
|
+
case "timeout":
|
|
206
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling DELETE /tracking/devices/delete.");
|
|
207
|
+
case "unknown":
|
|
208
|
+
throw new errors.ChrtError({
|
|
209
|
+
message: _response.error.errorMessage,
|
|
210
|
+
rawResponse: _response.rawResponse,
|
|
211
|
+
});
|
|
212
|
+
}
|
|
213
|
+
});
|
|
214
|
+
}
|
|
86
215
|
/**
|
|
87
216
|
* Get a device by device_mac_address or device_id.
|
|
88
217
|
*
|
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
+
import * as Chrt from "../../../../../../index.mjs";
|
|
4
5
|
/**
|
|
5
6
|
* @example
|
|
6
7
|
* {
|
|
7
8
|
* device_mac_address: "device_mac_address"
|
|
8
9
|
* }
|
|
9
10
|
*/
|
|
10
|
-
export interface
|
|
11
|
+
export interface DevicesRegisterToOrgReq1 {
|
|
11
12
|
device_mac_address: string;
|
|
13
|
+
type?: Chrt.TrackingDeviceTypeEnum1 | null;
|
|
14
|
+
comments?: string | null;
|
|
12
15
|
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../../../../../../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* {}
|
|
8
|
+
*/
|
|
9
|
+
export interface DevicesUpdateRequest1 {
|
|
10
|
+
device_id?: string | null;
|
|
11
|
+
device_mac_address?: string | null;
|
|
12
|
+
type?: Chrt.TrackingDeviceTypeEnum1 | null;
|
|
13
|
+
comments?: string | null;
|
|
14
|
+
delete_type?: boolean;
|
|
15
|
+
delete_comments?: boolean;
|
|
16
|
+
}
|
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
export { type
|
|
1
|
+
export { type DevicesRegisterToOrgReq1 } from "./DevicesRegisterToOrgReq1.mjs";
|
|
2
|
+
export { type DevicesUpdateRequest1 } from "./DevicesUpdateRequest1.mjs";
|
|
3
|
+
export { type DevicesDeleteRequest } from "./DevicesDeleteRequest.mjs";
|
|
2
4
|
export { type DevicesGetRequest } from "./DevicesGetRequest.mjs";
|
|
3
5
|
export { type DevicesLinkToCargoRequest } from "./DevicesLinkToCargoRequest.mjs";
|
|
4
6
|
export { type DevicesUnlinkFromCargoRequest } from "./DevicesUnlinkFromCargoRequest.mjs";
|
|
@@ -40,6 +40,21 @@ export declare class SessionByDevice {
|
|
|
40
40
|
*/
|
|
41
41
|
list(requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.Session1[]>;
|
|
42
42
|
private __list;
|
|
43
|
+
/**
|
|
44
|
+
* Get a single session document by session_id.
|
|
45
|
+
*
|
|
46
|
+
* @param {Chrt.tracking.SessionByDeviceGetRequest} request
|
|
47
|
+
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* await client.tracking.sessionByDevice.get({
|
|
53
|
+
* session_id: "session_id"
|
|
54
|
+
* })
|
|
55
|
+
*/
|
|
56
|
+
get(request: Chrt.tracking.SessionByDeviceGetRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.Session1>;
|
|
57
|
+
private __get;
|
|
43
58
|
/**
|
|
44
59
|
* Return the most recent datapoint for a session.
|
|
45
60
|
*
|
|
@@ -86,79 +101,124 @@ export declare class SessionByDevice {
|
|
|
86
101
|
createSession(request: Chrt.tracking.SessionByDeviceCreateSessionRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<string>;
|
|
87
102
|
private __createSession;
|
|
88
103
|
/**
|
|
89
|
-
*
|
|
104
|
+
* Update a session's comments and/or public visibility status.
|
|
90
105
|
*
|
|
91
|
-
* @param {Chrt.tracking.
|
|
106
|
+
* @param {Chrt.tracking.SessionByDeviceUpdateRequest1} request
|
|
92
107
|
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
93
108
|
*
|
|
94
109
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
95
110
|
*
|
|
96
111
|
* @example
|
|
97
|
-
* await client.tracking.sessionByDevice.
|
|
112
|
+
* await client.tracking.sessionByDevice.update({
|
|
98
113
|
* session_id: "session_id"
|
|
99
114
|
* })
|
|
100
115
|
*/
|
|
101
|
-
|
|
102
|
-
private
|
|
116
|
+
update(request: Chrt.tracking.SessionByDeviceUpdateRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
117
|
+
private __update;
|
|
103
118
|
/**
|
|
104
119
|
* Start a session (set recording=true).
|
|
105
120
|
*
|
|
106
|
-
* @param {Chrt.tracking.
|
|
121
|
+
* @param {Chrt.tracking.SessionByDeviceStartRequest} request
|
|
107
122
|
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
108
123
|
*
|
|
109
124
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
110
125
|
*
|
|
111
126
|
* @example
|
|
112
|
-
* await client.tracking.sessionByDevice.
|
|
127
|
+
* await client.tracking.sessionByDevice.start({
|
|
113
128
|
* session_id: "session_id"
|
|
114
129
|
* })
|
|
115
130
|
*/
|
|
116
|
-
|
|
117
|
-
private
|
|
131
|
+
start(request: Chrt.tracking.SessionByDeviceStartRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
132
|
+
private __start;
|
|
118
133
|
/**
|
|
119
134
|
* Pause a session (set recording=false).
|
|
120
135
|
*
|
|
121
|
-
* @param {Chrt.tracking.
|
|
136
|
+
* @param {Chrt.tracking.SessionByDevicePauseRecordingRequest} request
|
|
122
137
|
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
123
138
|
*
|
|
124
139
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
125
140
|
*
|
|
126
141
|
* @example
|
|
127
|
-
* await client.tracking.sessionByDevice.
|
|
142
|
+
* await client.tracking.sessionByDevice.pauseRecording({
|
|
128
143
|
* session_id: "session_id"
|
|
129
144
|
* })
|
|
130
145
|
*/
|
|
131
|
-
|
|
132
|
-
private
|
|
146
|
+
pauseRecording(request: Chrt.tracking.SessionByDevicePauseRecordingRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
147
|
+
private __pauseRecording;
|
|
133
148
|
/**
|
|
134
149
|
* Resume a session (set recording=true).
|
|
135
150
|
*
|
|
136
|
-
* @param {Chrt.tracking.
|
|
151
|
+
* @param {Chrt.tracking.SessionByDeviceResumeRecordingRequest} request
|
|
137
152
|
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
138
153
|
*
|
|
139
154
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
140
155
|
*
|
|
141
156
|
* @example
|
|
142
|
-
* await client.tracking.sessionByDevice.
|
|
157
|
+
* await client.tracking.sessionByDevice.resumeRecording({
|
|
143
158
|
* session_id: "session_id"
|
|
144
159
|
* })
|
|
145
160
|
*/
|
|
146
|
-
|
|
147
|
-
private
|
|
161
|
+
resumeRecording(request: Chrt.tracking.SessionByDeviceResumeRecordingRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
162
|
+
private __resumeRecording;
|
|
148
163
|
/**
|
|
149
164
|
* End a session (set recording=false).
|
|
150
165
|
*
|
|
151
|
-
* @param {Chrt.tracking.
|
|
166
|
+
* @param {Chrt.tracking.SessionByDeviceTerminateRequest} request
|
|
167
|
+
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
168
|
+
*
|
|
169
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
170
|
+
*
|
|
171
|
+
* @example
|
|
172
|
+
* await client.tracking.sessionByDevice.terminate({
|
|
173
|
+
* session_id: "session_id"
|
|
174
|
+
* })
|
|
175
|
+
*/
|
|
176
|
+
terminate(request: Chrt.tracking.SessionByDeviceTerminateRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
177
|
+
private __terminate;
|
|
178
|
+
/**
|
|
179
|
+
* Delete a terminated session and all associated timeseries data.
|
|
180
|
+
*
|
|
181
|
+
* @param {Chrt.tracking.SessionByDeviceDeleteRequest} request
|
|
182
|
+
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
183
|
+
*
|
|
184
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
185
|
+
*
|
|
186
|
+
* @example
|
|
187
|
+
* await client.tracking.sessionByDevice.delete({
|
|
188
|
+
* session_id: "session_id"
|
|
189
|
+
* })
|
|
190
|
+
*/
|
|
191
|
+
delete(request: Chrt.tracking.SessionByDeviceDeleteRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.SessionByDeviceDeleteResponse1>;
|
|
192
|
+
private __delete;
|
|
193
|
+
/**
|
|
194
|
+
* Return the most recent datapoint for a session. Session must be have public=True.
|
|
195
|
+
*
|
|
196
|
+
* @param {Chrt.tracking.SessionByDeviceLastSeenPublicRequest} request
|
|
197
|
+
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
198
|
+
*
|
|
199
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
200
|
+
*
|
|
201
|
+
* @example
|
|
202
|
+
* await client.tracking.sessionByDevice.lastSeenPublic({
|
|
203
|
+
* session_id: "session_id"
|
|
204
|
+
* })
|
|
205
|
+
*/
|
|
206
|
+
lastSeenPublic(request: Chrt.tracking.SessionByDeviceLastSeenPublicRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<(Chrt.TrackingSessionByDeviceDataPoint1 | null) | undefined>;
|
|
207
|
+
private __lastSeenPublic;
|
|
208
|
+
/**
|
|
209
|
+
* Return a specified number of data points for a public session, intelligently sampled across the time range. Session must have public=True.
|
|
210
|
+
*
|
|
211
|
+
* @param {Chrt.tracking.SessionByDeviceDataPointsPublicRequest} request
|
|
152
212
|
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
153
213
|
*
|
|
154
214
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
155
215
|
*
|
|
156
216
|
* @example
|
|
157
|
-
* await client.tracking.sessionByDevice.
|
|
217
|
+
* await client.tracking.sessionByDevice.dataPointsPublic({
|
|
158
218
|
* session_id: "session_id"
|
|
159
219
|
* })
|
|
160
220
|
*/
|
|
161
|
-
|
|
162
|
-
private
|
|
221
|
+
dataPointsPublic(request: Chrt.tracking.SessionByDeviceDataPointsPublicRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSessionByDeviceDataPoint1[]>;
|
|
222
|
+
private __dataPointsPublic;
|
|
163
223
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
164
224
|
}
|