@chrt-inc/typescript-sdk 0.231.0 → 0.252.0
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/client/Client.d.ts +6 -0
- package/dist/cjs/api/resources/tracking/client/Client.js +12 -2
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.d.ts +103 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js +371 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/index.js +17 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesGetRequest.d.ts +12 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesGetRequest.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesLinkToCargoRequest.d.ts +14 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesLinkToCargoRequest.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesRegisterToOrgRequest.d.ts +12 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesRegisterToOrgRequest.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesUnlinkFromCargoRequest.d.ts +12 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesUnlinkFromCargoRequest.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/tracking/resources/devices/index.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/devices/index.js +17 -0
- package/dist/cjs/api/resources/tracking/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/tracking/resources/index.js +5 -1
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/Client.d.ts +137 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/Client.js +510 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/index.js +17 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceCreateSessionRequest1.d.ts +13 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceCreateSessionRequest1.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceEndSessionRequest.d.ts +12 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceEndSessionRequest.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceLastSeenRequest.d.ts +12 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceLastSeenRequest.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDevicePauseSessionRequest.d.ts +12 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDevicePauseSessionRequest.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceResumeSessionRequest.d.ts +12 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceResumeSessionRequest.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceStartSessionRequest.d.ts +12 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceStartSessionRequest.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceUpdateCommentsRequest1.d.ts +14 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceUpdateCommentsRequest1.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/index.d.ts +7 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/index.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/index.js +17 -0
- package/dist/cjs/api/types/Cargo1.d.ts +1 -1
- package/dist/cjs/api/types/DecodedJwtWithOrgAndUserId.d.ts +1 -1
- package/dist/cjs/api/types/Device1.d.ts +19 -0
- package/dist/cjs/api/types/Device1.js +5 -0
- package/dist/cjs/api/types/TrackingDeviceTypeEnum1.d.ts +9 -0
- package/dist/cjs/api/types/TrackingDeviceTypeEnum1.js +11 -0
- package/dist/cjs/api/types/TrackingSessionByDeviceDataPoint1.d.ts +12 -0
- package/dist/cjs/api/types/TrackingSessionByDeviceDataPoint1.js +5 -0
- package/dist/cjs/api/types/TrackingSessionByDeviceDataPointMetadata1.d.ts +6 -0
- package/dist/cjs/api/types/TrackingSessionByDeviceDataPointMetadata1.js +5 -0
- package/dist/cjs/api/types/index.d.ts +4 -0
- package/dist/cjs/api/types/index.js +4 -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/client/Client.d.mts +6 -0
- package/dist/esm/api/resources/tracking/client/Client.mjs +10 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.d.mts +103 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs +334 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/index.d.mts +2 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesGetRequest.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesGetRequest.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesLinkToCargoRequest.d.mts +14 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesLinkToCargoRequest.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesRegisterToOrgRequest.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesRegisterToOrgRequest.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesUnlinkFromCargoRequest.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesUnlinkFromCargoRequest.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/devices/index.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/devices/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/tracking/resources/index.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/Client.d.mts +137 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/Client.mjs +473 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/index.d.mts +2 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceCreateSessionRequest1.d.mts +13 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceCreateSessionRequest1.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceEndSessionRequest.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceEndSessionRequest.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceLastSeenRequest.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceLastSeenRequest.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDevicePauseSessionRequest.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDevicePauseSessionRequest.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceResumeSessionRequest.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceResumeSessionRequest.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceStartSessionRequest.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceStartSessionRequest.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceUpdateCommentsRequest1.d.mts +14 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceUpdateCommentsRequest1.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/index.d.mts +7 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/index.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/index.mjs +1 -0
- package/dist/esm/api/types/Cargo1.d.mts +1 -1
- package/dist/esm/api/types/DecodedJwtWithOrgAndUserId.d.mts +1 -1
- package/dist/esm/api/types/Device1.d.mts +19 -0
- package/dist/esm/api/types/Device1.mjs +4 -0
- package/dist/esm/api/types/TrackingDeviceTypeEnum1.d.mts +9 -0
- package/dist/esm/api/types/TrackingDeviceTypeEnum1.mjs +8 -0
- package/dist/esm/api/types/TrackingSessionByDeviceDataPoint1.d.mts +12 -0
- package/dist/esm/api/types/TrackingSessionByDeviceDataPoint1.mjs +4 -0
- package/dist/esm/api/types/TrackingSessionByDeviceDataPointMetadata1.d.mts +6 -0
- package/dist/esm/api/types/TrackingSessionByDeviceDataPointMetadata1.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +4 -0
- package/dist/esm/api/types/index.mjs +4 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +790 -15
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./client/index.js"), exports);
|
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
export * as cargoByDriver from "./cargoByDriver/index.js";
|
|
2
|
+
export * as devices from "./devices/index.js";
|
|
2
3
|
export * as taskGroupByDriver from "./taskGroupByDriver/index.js";
|
|
4
|
+
export * as sessionByDevice from "./sessionByDevice/index.js";
|
|
3
5
|
export * from "./cargoByDriver/client/requests/index.js";
|
|
6
|
+
export * from "./devices/client/requests/index.js";
|
|
4
7
|
export * from "./taskGroupByDriver/client/requests/index.js";
|
|
8
|
+
export * from "./sessionByDevice/client/requests/index.js";
|
|
@@ -36,8 +36,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
36
36
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
37
37
|
};
|
|
38
38
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.taskGroupByDriver = exports.cargoByDriver = void 0;
|
|
39
|
+
exports.sessionByDevice = exports.taskGroupByDriver = exports.devices = exports.cargoByDriver = void 0;
|
|
40
40
|
exports.cargoByDriver = __importStar(require("./cargoByDriver/index.js"));
|
|
41
|
+
exports.devices = __importStar(require("./devices/index.js"));
|
|
41
42
|
exports.taskGroupByDriver = __importStar(require("./taskGroupByDriver/index.js"));
|
|
43
|
+
exports.sessionByDevice = __importStar(require("./sessionByDevice/index.js"));
|
|
42
44
|
__exportStar(require("./cargoByDriver/client/requests/index.js"), exports);
|
|
45
|
+
__exportStar(require("./devices/client/requests/index.js"), exports);
|
|
43
46
|
__exportStar(require("./taskGroupByDriver/client/requests/index.js"), exports);
|
|
47
|
+
__exportStar(require("./sessionByDevice/client/requests/index.js"), exports);
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as environments from "../../../../../../environments.js";
|
|
5
|
+
import * as core from "../../../../../../core/index.js";
|
|
6
|
+
import * as Chrt from "../../../../../index.js";
|
|
7
|
+
export declare namespace SessionByDevice {
|
|
8
|
+
interface Options {
|
|
9
|
+
environment?: core.Supplier<environments.ChrtEnvironment | string>;
|
|
10
|
+
/** Specify a custom URL to connect the client to. */
|
|
11
|
+
baseUrl?: core.Supplier<string>;
|
|
12
|
+
token?: core.Supplier<core.BearerToken | undefined>;
|
|
13
|
+
/** Additional headers to include in requests. */
|
|
14
|
+
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
|
|
15
|
+
fetcher?: core.FetchFunction;
|
|
16
|
+
}
|
|
17
|
+
interface RequestOptions {
|
|
18
|
+
/** The maximum time to wait for a response in seconds. */
|
|
19
|
+
timeoutInSeconds?: number;
|
|
20
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
21
|
+
maxRetries?: number;
|
|
22
|
+
/** A hook to abort the request. */
|
|
23
|
+
abortSignal?: AbortSignal;
|
|
24
|
+
/** Additional headers to include in the request. */
|
|
25
|
+
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
export declare class SessionByDevice {
|
|
29
|
+
protected readonly _options: SessionByDevice.Options;
|
|
30
|
+
constructor(_options?: SessionByDevice.Options);
|
|
31
|
+
/**
|
|
32
|
+
* Return the most recent datapoint for a session.
|
|
33
|
+
*
|
|
34
|
+
* @param {Chrt.tracking.SessionByDeviceLastSeenRequest} request
|
|
35
|
+
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* await client.tracking.sessionByDevice.lastSeen({
|
|
41
|
+
* session_id: "session_id"
|
|
42
|
+
* })
|
|
43
|
+
*/
|
|
44
|
+
lastSeen(request: Chrt.tracking.SessionByDeviceLastSeenRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<(Chrt.TrackingSessionByDeviceDataPoint1 | null) | undefined>;
|
|
45
|
+
private __lastSeen;
|
|
46
|
+
/**
|
|
47
|
+
* Create a session for a device and link the device to it.
|
|
48
|
+
*
|
|
49
|
+
* @param {Chrt.tracking.SessionByDeviceCreateSessionRequest1} request
|
|
50
|
+
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* await client.tracking.sessionByDevice.createSession({
|
|
56
|
+
* device_mac_address: "device_mac_address"
|
|
57
|
+
* })
|
|
58
|
+
*/
|
|
59
|
+
createSession(request: Chrt.tracking.SessionByDeviceCreateSessionRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<string>;
|
|
60
|
+
private __createSession;
|
|
61
|
+
/**
|
|
62
|
+
* Overwrite or delete the comments for a session.
|
|
63
|
+
*
|
|
64
|
+
* @param {Chrt.tracking.SessionByDeviceUpdateCommentsRequest1} request
|
|
65
|
+
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* await client.tracking.sessionByDevice.updateComments({
|
|
71
|
+
* session_id: "session_id"
|
|
72
|
+
* })
|
|
73
|
+
*/
|
|
74
|
+
updateComments(request: Chrt.tracking.SessionByDeviceUpdateCommentsRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
75
|
+
private __updateComments;
|
|
76
|
+
/**
|
|
77
|
+
* Start a session (set recording=true).
|
|
78
|
+
*
|
|
79
|
+
* @param {Chrt.tracking.SessionByDeviceStartSessionRequest} request
|
|
80
|
+
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* await client.tracking.sessionByDevice.startSession({
|
|
86
|
+
* session_id: "session_id"
|
|
87
|
+
* })
|
|
88
|
+
*/
|
|
89
|
+
startSession(request: Chrt.tracking.SessionByDeviceStartSessionRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
90
|
+
private __startSession;
|
|
91
|
+
/**
|
|
92
|
+
* Pause a session (set recording=false).
|
|
93
|
+
*
|
|
94
|
+
* @param {Chrt.tracking.SessionByDevicePauseSessionRequest} request
|
|
95
|
+
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
98
|
+
*
|
|
99
|
+
* @example
|
|
100
|
+
* await client.tracking.sessionByDevice.pauseSession({
|
|
101
|
+
* session_id: "session_id"
|
|
102
|
+
* })
|
|
103
|
+
*/
|
|
104
|
+
pauseSession(request: Chrt.tracking.SessionByDevicePauseSessionRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
105
|
+
private __pauseSession;
|
|
106
|
+
/**
|
|
107
|
+
* Resume a session (set recording=true).
|
|
108
|
+
*
|
|
109
|
+
* @param {Chrt.tracking.SessionByDeviceResumeSessionRequest} request
|
|
110
|
+
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
113
|
+
*
|
|
114
|
+
* @example
|
|
115
|
+
* await client.tracking.sessionByDevice.resumeSession({
|
|
116
|
+
* session_id: "session_id"
|
|
117
|
+
* })
|
|
118
|
+
*/
|
|
119
|
+
resumeSession(request: Chrt.tracking.SessionByDeviceResumeSessionRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
120
|
+
private __resumeSession;
|
|
121
|
+
/**
|
|
122
|
+
* End a session (set recording=false).
|
|
123
|
+
*
|
|
124
|
+
* @param {Chrt.tracking.SessionByDeviceEndSessionRequest} request
|
|
125
|
+
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
128
|
+
*
|
|
129
|
+
* @example
|
|
130
|
+
* await client.tracking.sessionByDevice.endSession({
|
|
131
|
+
* session_id: "session_id"
|
|
132
|
+
* })
|
|
133
|
+
*/
|
|
134
|
+
endSession(request: Chrt.tracking.SessionByDeviceEndSessionRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
135
|
+
private __endSession;
|
|
136
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
137
|
+
}
|