@chrt-inc/typescript-sdk 1.404.0 → 1.405.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/resources/devices/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js +1 -1
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesRegisterToOrgReq1.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesUpdateRequest1.d.ts +2 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.d.ts +56 -5
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.js +225 -18
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionCreateSessionRequest1.d.ts +3 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionUpdateRequest1.d.ts +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.d.ts +51 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsSearchV1Request.d.ts +17 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsSearchV1Request.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsTypeaheadOffChrtOrderIdV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsTypeaheadOffChrtOrderIdV1Request.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/types/Device1.d.ts +1 -0
- package/dist/cjs/api/types/Session1.d.ts +3 -0
- package/dist/cjs/api/types/SessionListRes.d.ts +8 -0
- package/dist/cjs/api/types/SessionListRes.js +5 -0
- package/dist/cjs/api/types/SessionSearchRes.d.ts +8 -0
- package/dist/cjs/api/types/SessionSearchRes.js +5 -0
- package/dist/cjs/api/types/SessionSortByEnum.d.ts +8 -0
- package/dist/cjs/api/types/SessionSortByEnum.js +10 -0
- package/dist/cjs/api/types/index.d.ts +3 -0
- package/dist/cjs/api/types/index.js +3 -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 +1 -1
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs +1 -1
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesRegisterToOrgReq1.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesUpdateRequest1.d.mts +2 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.d.mts +56 -5
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.mjs +225 -18
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionCreateSessionRequest1.d.mts +3 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionUpdateRequest1.d.mts +5 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.d.mts +51 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsSearchV1Request.d.mts +17 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsSearchV1Request.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsTypeaheadOffChrtOrderIdV1Request.d.mts +16 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsTypeaheadOffChrtOrderIdV1Request.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/index.d.mts +3 -0
- package/dist/esm/api/types/Device1.d.mts +1 -0
- package/dist/esm/api/types/Session1.d.mts +3 -0
- package/dist/esm/api/types/SessionListRes.d.mts +8 -0
- package/dist/esm/api/types/SessionListRes.mjs +4 -0
- package/dist/esm/api/types/SessionSearchRes.d.mts +8 -0
- package/dist/esm/api/types/SessionSearchRes.mjs +4 -0
- package/dist/esm/api/types/SessionSortByEnum.d.mts +8 -0
- package/dist/esm/api/types/SessionSortByEnum.mjs +7 -0
- package/dist/esm/api/types/index.d.mts +3 -0
- package/dist/esm/api/types/index.mjs +3 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +162 -6
package/dist/cjs/Client.js
CHANGED
|
@@ -67,8 +67,8 @@ class ChrtClient {
|
|
|
67
67
|
this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
|
|
68
68
|
"X-Fern-Language": "JavaScript",
|
|
69
69
|
"X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
|
|
70
|
-
"X-Fern-SDK-Version": "1.
|
|
71
|
-
"User-Agent": "@chrt-inc/typescript-sdk/1.
|
|
70
|
+
"X-Fern-SDK-Version": "1.405.0",
|
|
71
|
+
"User-Agent": "@chrt-inc/typescript-sdk/1.405.0",
|
|
72
72
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
73
73
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
74
74
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -46,7 +46,7 @@ export declare class Devices {
|
|
|
46
46
|
registerToOrgV1(request: Chrt.tracking.DevicesRegisterToOrgReq1, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<string>;
|
|
47
47
|
private __registerToOrgV1;
|
|
48
48
|
/**
|
|
49
|
-
* Updates a device's type and/or
|
|
49
|
+
* Updates a device's type, comments, and/or off_chrt_order_id. Can update one or more fields, or delete them by setting delete flags. | (DevicesUpdateRequest1) -> (bool)
|
|
50
50
|
*
|
|
51
51
|
* @param {Chrt.tracking.DevicesUpdateRequest1} request
|
|
52
52
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -120,7 +120,7 @@ class Devices {
|
|
|
120
120
|
});
|
|
121
121
|
}
|
|
122
122
|
/**
|
|
123
|
-
* Updates a device's type and/or
|
|
123
|
+
* Updates a device's type, comments, and/or off_chrt_order_id. Can update one or more fields, or delete them by setting delete flags. | (DevicesUpdateRequest1) -> (bool)
|
|
124
124
|
*
|
|
125
125
|
* @param {Chrt.tracking.DevicesUpdateRequest1} request
|
|
126
126
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,17 +31,35 @@ export declare class Sessions {
|
|
|
31
31
|
protected readonly _options: Sessions.Options;
|
|
32
32
|
constructor(_options?: Sessions.Options);
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
34
|
+
* Lists sessions with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (SessionListRes)
|
|
35
35
|
*
|
|
36
|
+
* @param {Chrt.tracking.SessionsListV1Request} request
|
|
36
37
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
37
38
|
*
|
|
39
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
40
|
+
*
|
|
38
41
|
* @example
|
|
39
|
-
* await client.tracking.sessions.listV1(
|
|
42
|
+
* await client.tracking.sessions.listV1({
|
|
43
|
+
* sort_by: "session_created_at_timestamp",
|
|
44
|
+
* sort_order: "asc",
|
|
45
|
+
* page: 1,
|
|
46
|
+
* page_size: 1,
|
|
47
|
+
* filter_recording: true,
|
|
48
|
+
* filter_terminated: true,
|
|
49
|
+
* filter_public: true,
|
|
50
|
+
* filter_device_id: "filter_device_id",
|
|
51
|
+
* filter_off_chrt_order_id: "filter_off_chrt_order_id",
|
|
52
|
+
* filter_flight_number: "filter_flight_number",
|
|
53
|
+
* filter_session_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
54
|
+
* filter_session_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
55
|
+
* filter_recording_initiated_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
56
|
+
* filter_recording_initiated_at_timestamp_lte: "2024-01-15T09:30:00Z"
|
|
57
|
+
* })
|
|
40
58
|
*/
|
|
41
|
-
listV1(requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.
|
|
59
|
+
listV1(request?: Chrt.tracking.SessionsListV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.SessionListRes>;
|
|
42
60
|
private __listV1;
|
|
43
61
|
/**
|
|
44
|
-
* Retrieves a single session by its ID. Access restricted to the caller's organization. | () -> (Session1)
|
|
62
|
+
* Retrieves a single session by its ID. Access restricted to the caller's organization. | authz: min_org_role=operator | () -> (Session1)
|
|
45
63
|
*
|
|
46
64
|
* @param {Chrt.tracking.SessionsGetV1Request} request
|
|
47
65
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -55,6 +73,39 @@ export declare class Sessions {
|
|
|
55
73
|
*/
|
|
56
74
|
getV1(request: Chrt.tracking.SessionsGetV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.Session1>;
|
|
57
75
|
private __getV1;
|
|
76
|
+
/**
|
|
77
|
+
* Returns distinct off_chrt_order_id values matching the query via case-insensitive regex, searching across both sessions and devices. | authz: min_org_role=operator | () -> (list[str])
|
|
78
|
+
*
|
|
79
|
+
* @param {Chrt.tracking.SessionsTypeaheadOffChrtOrderIdV1Request} request
|
|
80
|
+
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* await client.tracking.sessions.typeaheadOffChrtOrderIdV1({
|
|
86
|
+
* query: "query",
|
|
87
|
+
* limit: 1
|
|
88
|
+
* })
|
|
89
|
+
*/
|
|
90
|
+
typeaheadOffChrtOrderIdV1(request: Chrt.tracking.SessionsTypeaheadOffChrtOrderIdV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<string[]>;
|
|
91
|
+
private __typeaheadOffChrtOrderIdV1;
|
|
92
|
+
/**
|
|
93
|
+
* Full-text search across session comments, device_mac_address, flight_number, and off_chrt_order_id using Atlas Search. | authz: min_org_role=operator | () -> (SessionSearchRes)
|
|
94
|
+
*
|
|
95
|
+
* @param {Chrt.tracking.SessionsSearchV1Request} request
|
|
96
|
+
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
99
|
+
*
|
|
100
|
+
* @example
|
|
101
|
+
* await client.tracking.sessions.searchV1({
|
|
102
|
+
* query: "query",
|
|
103
|
+
* page: 1,
|
|
104
|
+
* page_size: 1
|
|
105
|
+
* })
|
|
106
|
+
*/
|
|
107
|
+
searchV1(request: Chrt.tracking.SessionsSearchV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.SessionSearchRes>;
|
|
108
|
+
private __searchV1;
|
|
58
109
|
/**
|
|
59
110
|
* Creates a new tracking session for a device and links the device to it. The device must be registered to the caller's organization. | (SessionCreateSessionRequest1) -> (PydanticObjectId)
|
|
60
111
|
*
|
|
@@ -71,7 +122,7 @@ export declare class Sessions {
|
|
|
71
122
|
createSessionV1(request: Chrt.tracking.SessionCreateSessionRequest1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<string>;
|
|
72
123
|
private __createSessionV1;
|
|
73
124
|
/**
|
|
74
|
-
* Updates a session's comments
|
|
125
|
+
* Updates a session's mutable fields (comments, public, off_chrt_order_id, flight_number, fa_flight_ids). | (SessionUpdateRequest1) -> (bool)
|
|
75
126
|
*
|
|
76
127
|
* @param {Chrt.tracking.SessionUpdateRequest1} request
|
|
77
128
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,25 +56,87 @@ class Sessions {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
*
|
|
59
|
+
* Lists sessions with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (SessionListRes)
|
|
60
60
|
*
|
|
61
|
+
* @param {Chrt.tracking.SessionsListV1Request} request
|
|
61
62
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
62
63
|
*
|
|
64
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
65
|
+
*
|
|
63
66
|
* @example
|
|
64
|
-
* await client.tracking.sessions.listV1(
|
|
67
|
+
* await client.tracking.sessions.listV1({
|
|
68
|
+
* sort_by: "session_created_at_timestamp",
|
|
69
|
+
* sort_order: "asc",
|
|
70
|
+
* page: 1,
|
|
71
|
+
* page_size: 1,
|
|
72
|
+
* filter_recording: true,
|
|
73
|
+
* filter_terminated: true,
|
|
74
|
+
* filter_public: true,
|
|
75
|
+
* filter_device_id: "filter_device_id",
|
|
76
|
+
* filter_off_chrt_order_id: "filter_off_chrt_order_id",
|
|
77
|
+
* filter_flight_number: "filter_flight_number",
|
|
78
|
+
* filter_session_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
79
|
+
* filter_session_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
80
|
+
* filter_recording_initiated_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
81
|
+
* filter_recording_initiated_at_timestamp_lte: "2024-01-15T09:30:00Z"
|
|
82
|
+
* })
|
|
65
83
|
*/
|
|
66
|
-
listV1(requestOptions) {
|
|
67
|
-
return core.HttpResponsePromise.fromPromise(this.__listV1(requestOptions));
|
|
84
|
+
listV1(request = {}, requestOptions) {
|
|
85
|
+
return core.HttpResponsePromise.fromPromise(this.__listV1(request, requestOptions));
|
|
68
86
|
}
|
|
69
|
-
__listV1(
|
|
70
|
-
return __awaiter(this,
|
|
71
|
-
var _a, _b, _c, _d;
|
|
72
|
-
|
|
73
|
-
const
|
|
74
|
-
|
|
87
|
+
__listV1() {
|
|
88
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
89
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
90
|
+
const { sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, filter_recording: filterRecording, filter_terminated: filterTerminated, filter_public: filterPublic, filter_device_id: filterDeviceId, filter_off_chrt_order_id: filterOffChrtOrderId, filter_flight_number: filterFlightNumber, filter_session_created_at_timestamp_gte: filterSessionCreatedAtTimestampGte, filter_session_created_at_timestamp_lte: filterSessionCreatedAtTimestampLte, filter_recording_initiated_at_timestamp_gte: filterRecordingInitiatedAtTimestampGte, filter_recording_initiated_at_timestamp_lte: filterRecordingInitiatedAtTimestampLte, } = request;
|
|
91
|
+
const _queryParams = {};
|
|
92
|
+
if (sortBy !== undefined) {
|
|
93
|
+
_queryParams["sort_by"] = sortBy;
|
|
94
|
+
}
|
|
95
|
+
if (sortOrder !== undefined) {
|
|
96
|
+
_queryParams["sort_order"] = sortOrder;
|
|
97
|
+
}
|
|
98
|
+
if (page !== undefined) {
|
|
99
|
+
_queryParams["page"] = (_a = page === null || page === void 0 ? void 0 : page.toString()) !== null && _a !== void 0 ? _a : null;
|
|
100
|
+
}
|
|
101
|
+
if (pageSize !== undefined) {
|
|
102
|
+
_queryParams["page_size"] = (_b = pageSize === null || pageSize === void 0 ? void 0 : pageSize.toString()) !== null && _b !== void 0 ? _b : null;
|
|
103
|
+
}
|
|
104
|
+
if (filterRecording !== undefined) {
|
|
105
|
+
_queryParams["filter_recording"] = (_c = filterRecording === null || filterRecording === void 0 ? void 0 : filterRecording.toString()) !== null && _c !== void 0 ? _c : null;
|
|
106
|
+
}
|
|
107
|
+
if (filterTerminated !== undefined) {
|
|
108
|
+
_queryParams["filter_terminated"] = (_d = filterTerminated === null || filterTerminated === void 0 ? void 0 : filterTerminated.toString()) !== null && _d !== void 0 ? _d : null;
|
|
109
|
+
}
|
|
110
|
+
if (filterPublic !== undefined) {
|
|
111
|
+
_queryParams["filter_public"] = (_e = filterPublic === null || filterPublic === void 0 ? void 0 : filterPublic.toString()) !== null && _e !== void 0 ? _e : null;
|
|
112
|
+
}
|
|
113
|
+
if (filterDeviceId !== undefined) {
|
|
114
|
+
_queryParams["filter_device_id"] = filterDeviceId;
|
|
115
|
+
}
|
|
116
|
+
if (filterOffChrtOrderId !== undefined) {
|
|
117
|
+
_queryParams["filter_off_chrt_order_id"] = filterOffChrtOrderId;
|
|
118
|
+
}
|
|
119
|
+
if (filterFlightNumber !== undefined) {
|
|
120
|
+
_queryParams["filter_flight_number"] = filterFlightNumber;
|
|
121
|
+
}
|
|
122
|
+
if (filterSessionCreatedAtTimestampGte !== undefined) {
|
|
123
|
+
_queryParams["filter_session_created_at_timestamp_gte"] = filterSessionCreatedAtTimestampGte;
|
|
124
|
+
}
|
|
125
|
+
if (filterSessionCreatedAtTimestampLte !== undefined) {
|
|
126
|
+
_queryParams["filter_session_created_at_timestamp_lte"] = filterSessionCreatedAtTimestampLte;
|
|
127
|
+
}
|
|
128
|
+
if (filterRecordingInitiatedAtTimestampGte !== undefined) {
|
|
129
|
+
_queryParams["filter_recording_initiated_at_timestamp_gte"] = filterRecordingInitiatedAtTimestampGte;
|
|
130
|
+
}
|
|
131
|
+
if (filterRecordingInitiatedAtTimestampLte !== undefined) {
|
|
132
|
+
_queryParams["filter_recording_initiated_at_timestamp_lte"] = filterRecordingInitiatedAtTimestampLte;
|
|
133
|
+
}
|
|
134
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_f = this._options) === null || _f === void 0 ? void 0 : _f.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
135
|
+
const _response = yield ((_g = this._options.fetcher) !== null && _g !== void 0 ? _g : core.fetcher)({
|
|
136
|
+
url: core.url.join((_j = (_h = (yield core.Supplier.get(this._options.baseUrl))) !== null && _h !== void 0 ? _h : (yield core.Supplier.get(this._options.environment))) !== null && _j !== void 0 ? _j : environments.ChrtEnvironment.Local, "tracking/sessions/list/v1"),
|
|
75
137
|
method: "GET",
|
|
76
138
|
headers: _headers,
|
|
77
|
-
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
139
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
78
140
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
79
141
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
80
142
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -83,11 +145,16 @@ class Sessions {
|
|
|
83
145
|
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
84
146
|
}
|
|
85
147
|
if (_response.error.reason === "status-code") {
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
148
|
+
switch (_response.error.statusCode) {
|
|
149
|
+
case 422:
|
|
150
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
151
|
+
default:
|
|
152
|
+
throw new errors.ChrtError({
|
|
153
|
+
statusCode: _response.error.statusCode,
|
|
154
|
+
body: _response.error.body,
|
|
155
|
+
rawResponse: _response.rawResponse,
|
|
156
|
+
});
|
|
157
|
+
}
|
|
91
158
|
}
|
|
92
159
|
switch (_response.error.reason) {
|
|
93
160
|
case "non-json":
|
|
@@ -107,7 +174,7 @@ class Sessions {
|
|
|
107
174
|
});
|
|
108
175
|
}
|
|
109
176
|
/**
|
|
110
|
-
* Retrieves a single session by its ID. Access restricted to the caller's organization. | () -> (Session1)
|
|
177
|
+
* Retrieves a single session by its ID. Access restricted to the caller's organization. | authz: min_org_role=operator | () -> (Session1)
|
|
111
178
|
*
|
|
112
179
|
* @param {Chrt.tracking.SessionsGetV1Request} request
|
|
113
180
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -170,6 +237,146 @@ class Sessions {
|
|
|
170
237
|
}
|
|
171
238
|
});
|
|
172
239
|
}
|
|
240
|
+
/**
|
|
241
|
+
* Returns distinct off_chrt_order_id values matching the query via case-insensitive regex, searching across both sessions and devices. | authz: min_org_role=operator | () -> (list[str])
|
|
242
|
+
*
|
|
243
|
+
* @param {Chrt.tracking.SessionsTypeaheadOffChrtOrderIdV1Request} request
|
|
244
|
+
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
245
|
+
*
|
|
246
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
247
|
+
*
|
|
248
|
+
* @example
|
|
249
|
+
* await client.tracking.sessions.typeaheadOffChrtOrderIdV1({
|
|
250
|
+
* query: "query",
|
|
251
|
+
* limit: 1
|
|
252
|
+
* })
|
|
253
|
+
*/
|
|
254
|
+
typeaheadOffChrtOrderIdV1(request, requestOptions) {
|
|
255
|
+
return core.HttpResponsePromise.fromPromise(this.__typeaheadOffChrtOrderIdV1(request, requestOptions));
|
|
256
|
+
}
|
|
257
|
+
__typeaheadOffChrtOrderIdV1(request, requestOptions) {
|
|
258
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
259
|
+
var _a, _b, _c, _d, _e;
|
|
260
|
+
const { query, limit } = request;
|
|
261
|
+
const _queryParams = {};
|
|
262
|
+
_queryParams["query"] = query;
|
|
263
|
+
if (limit !== undefined) {
|
|
264
|
+
_queryParams["limit"] = (_a = limit === null || limit === void 0 ? void 0 : limit.toString()) !== null && _a !== void 0 ? _a : null;
|
|
265
|
+
}
|
|
266
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_b = this._options) === null || _b === void 0 ? void 0 : _b.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
267
|
+
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
268
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ChrtEnvironment.Local, "tracking/sessions/typeahead/off_chrt_order_id/v1"),
|
|
269
|
+
method: "GET",
|
|
270
|
+
headers: _headers,
|
|
271
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
272
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
273
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
274
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
275
|
+
});
|
|
276
|
+
if (_response.ok) {
|
|
277
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
278
|
+
}
|
|
279
|
+
if (_response.error.reason === "status-code") {
|
|
280
|
+
switch (_response.error.statusCode) {
|
|
281
|
+
case 422:
|
|
282
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
283
|
+
default:
|
|
284
|
+
throw new errors.ChrtError({
|
|
285
|
+
statusCode: _response.error.statusCode,
|
|
286
|
+
body: _response.error.body,
|
|
287
|
+
rawResponse: _response.rawResponse,
|
|
288
|
+
});
|
|
289
|
+
}
|
|
290
|
+
}
|
|
291
|
+
switch (_response.error.reason) {
|
|
292
|
+
case "non-json":
|
|
293
|
+
throw new errors.ChrtError({
|
|
294
|
+
statusCode: _response.error.statusCode,
|
|
295
|
+
body: _response.error.rawBody,
|
|
296
|
+
rawResponse: _response.rawResponse,
|
|
297
|
+
});
|
|
298
|
+
case "timeout":
|
|
299
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /tracking/sessions/typeahead/off_chrt_order_id/v1.");
|
|
300
|
+
case "unknown":
|
|
301
|
+
throw new errors.ChrtError({
|
|
302
|
+
message: _response.error.errorMessage,
|
|
303
|
+
rawResponse: _response.rawResponse,
|
|
304
|
+
});
|
|
305
|
+
}
|
|
306
|
+
});
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* Full-text search across session comments, device_mac_address, flight_number, and off_chrt_order_id using Atlas Search. | authz: min_org_role=operator | () -> (SessionSearchRes)
|
|
310
|
+
*
|
|
311
|
+
* @param {Chrt.tracking.SessionsSearchV1Request} request
|
|
312
|
+
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
313
|
+
*
|
|
314
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
315
|
+
*
|
|
316
|
+
* @example
|
|
317
|
+
* await client.tracking.sessions.searchV1({
|
|
318
|
+
* query: "query",
|
|
319
|
+
* page: 1,
|
|
320
|
+
* page_size: 1
|
|
321
|
+
* })
|
|
322
|
+
*/
|
|
323
|
+
searchV1(request, requestOptions) {
|
|
324
|
+
return core.HttpResponsePromise.fromPromise(this.__searchV1(request, requestOptions));
|
|
325
|
+
}
|
|
326
|
+
__searchV1(request, requestOptions) {
|
|
327
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
328
|
+
var _a, _b, _c, _d, _e, _f;
|
|
329
|
+
const { query, page, page_size: pageSize } = request;
|
|
330
|
+
const _queryParams = {};
|
|
331
|
+
_queryParams["query"] = query;
|
|
332
|
+
if (page !== undefined) {
|
|
333
|
+
_queryParams["page"] = (_a = page === null || page === void 0 ? void 0 : page.toString()) !== null && _a !== void 0 ? _a : null;
|
|
334
|
+
}
|
|
335
|
+
if (pageSize !== undefined) {
|
|
336
|
+
_queryParams["page_size"] = (_b = pageSize === null || pageSize === void 0 ? void 0 : pageSize.toString()) !== null && _b !== void 0 ? _b : null;
|
|
337
|
+
}
|
|
338
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
339
|
+
const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
|
|
340
|
+
url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.ChrtEnvironment.Local, "tracking/sessions/search/v1"),
|
|
341
|
+
method: "GET",
|
|
342
|
+
headers: _headers,
|
|
343
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
344
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
345
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
346
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
347
|
+
});
|
|
348
|
+
if (_response.ok) {
|
|
349
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
350
|
+
}
|
|
351
|
+
if (_response.error.reason === "status-code") {
|
|
352
|
+
switch (_response.error.statusCode) {
|
|
353
|
+
case 422:
|
|
354
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
355
|
+
default:
|
|
356
|
+
throw new errors.ChrtError({
|
|
357
|
+
statusCode: _response.error.statusCode,
|
|
358
|
+
body: _response.error.body,
|
|
359
|
+
rawResponse: _response.rawResponse,
|
|
360
|
+
});
|
|
361
|
+
}
|
|
362
|
+
}
|
|
363
|
+
switch (_response.error.reason) {
|
|
364
|
+
case "non-json":
|
|
365
|
+
throw new errors.ChrtError({
|
|
366
|
+
statusCode: _response.error.statusCode,
|
|
367
|
+
body: _response.error.rawBody,
|
|
368
|
+
rawResponse: _response.rawResponse,
|
|
369
|
+
});
|
|
370
|
+
case "timeout":
|
|
371
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /tracking/sessions/search/v1.");
|
|
372
|
+
case "unknown":
|
|
373
|
+
throw new errors.ChrtError({
|
|
374
|
+
message: _response.error.errorMessage,
|
|
375
|
+
rawResponse: _response.rawResponse,
|
|
376
|
+
});
|
|
377
|
+
}
|
|
378
|
+
});
|
|
379
|
+
}
|
|
173
380
|
/**
|
|
174
381
|
* Creates a new tracking session for a device and links the device to it. The device must be registered to the caller's organization. | (SessionCreateSessionRequest1) -> (PydanticObjectId)
|
|
175
382
|
*
|
|
@@ -235,7 +442,7 @@ class Sessions {
|
|
|
235
442
|
});
|
|
236
443
|
}
|
|
237
444
|
/**
|
|
238
|
-
* Updates a session's comments
|
|
445
|
+
* Updates a session's mutable fields (comments, public, off_chrt_order_id, flight_number, fa_flight_ids). | (SessionUpdateRequest1) -> (bool)
|
|
239
446
|
*
|
|
240
447
|
* @param {Chrt.tracking.SessionUpdateRequest1} request
|
|
241
448
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -12,4 +12,9 @@ export interface SessionUpdateRequest1 {
|
|
|
12
12
|
comments?: string | null;
|
|
13
13
|
delete_comments?: boolean;
|
|
14
14
|
public?: boolean | null;
|
|
15
|
+
off_chrt_order_id?: string | null;
|
|
16
|
+
delete_off_chrt_order_id?: boolean;
|
|
17
|
+
flight_number?: string | null;
|
|
18
|
+
delete_flight_number?: boolean;
|
|
19
|
+
fa_flight_ids?: string[] | null;
|
|
15
20
|
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../../../../../../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* {
|
|
8
|
+
* sort_by: "session_created_at_timestamp",
|
|
9
|
+
* sort_order: "asc",
|
|
10
|
+
* page: 1,
|
|
11
|
+
* page_size: 1,
|
|
12
|
+
* filter_recording: true,
|
|
13
|
+
* filter_terminated: true,
|
|
14
|
+
* filter_public: true,
|
|
15
|
+
* filter_device_id: "filter_device_id",
|
|
16
|
+
* filter_off_chrt_order_id: "filter_off_chrt_order_id",
|
|
17
|
+
* filter_flight_number: "filter_flight_number",
|
|
18
|
+
* filter_session_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
19
|
+
* filter_session_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
20
|
+
* filter_recording_initiated_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21
|
+
* filter_recording_initiated_at_timestamp_lte: "2024-01-15T09:30:00Z"
|
|
22
|
+
* }
|
|
23
|
+
*/
|
|
24
|
+
export interface SessionsListV1Request {
|
|
25
|
+
/** Field to sort by */
|
|
26
|
+
sort_by?: Chrt.SessionSortByEnum | null;
|
|
27
|
+
/** Sort order (ascending or descending) */
|
|
28
|
+
sort_order?: Chrt.SortOrderEnum | null;
|
|
29
|
+
page?: number | null;
|
|
30
|
+
page_size?: number | null;
|
|
31
|
+
/** Filter by recording status */
|
|
32
|
+
filter_recording?: boolean | null;
|
|
33
|
+
/** Filter by terminated status */
|
|
34
|
+
filter_terminated?: boolean | null;
|
|
35
|
+
/** Filter by public visibility */
|
|
36
|
+
filter_public?: boolean | null;
|
|
37
|
+
/** Filter by device ID */
|
|
38
|
+
filter_device_id?: string | null;
|
|
39
|
+
/** Filter by off-CHRT order ID (exact match) */
|
|
40
|
+
filter_off_chrt_order_id?: string | null;
|
|
41
|
+
/** Filter by flight number (exact match) */
|
|
42
|
+
filter_flight_number?: string | null;
|
|
43
|
+
/** Filter by session_created_at_timestamp >= value */
|
|
44
|
+
filter_session_created_at_timestamp_gte?: string | null;
|
|
45
|
+
/** Filter by session_created_at_timestamp <= value */
|
|
46
|
+
filter_session_created_at_timestamp_lte?: string | null;
|
|
47
|
+
/** Filter by recording_initiated_at_timestamp >= value */
|
|
48
|
+
filter_recording_initiated_at_timestamp_gte?: string | null;
|
|
49
|
+
/** Filter by recording_initiated_at_timestamp <= value */
|
|
50
|
+
filter_recording_initiated_at_timestamp_lte?: string | null;
|
|
51
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* query: "query",
|
|
8
|
+
* page: 1,
|
|
9
|
+
* page_size: 1
|
|
10
|
+
* }
|
|
11
|
+
*/
|
|
12
|
+
export interface SessionsSearchV1Request {
|
|
13
|
+
/** Full-text search query */
|
|
14
|
+
query: string;
|
|
15
|
+
page?: number | null;
|
|
16
|
+
page_size?: number | null;
|
|
17
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* query: "query",
|
|
8
|
+
* limit: 1
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface SessionsTypeaheadOffChrtOrderIdV1Request {
|
|
12
|
+
/** Typeahead search query */
|
|
13
|
+
query: string;
|
|
14
|
+
/** Max results */
|
|
15
|
+
limit?: number | null;
|
|
16
|
+
}
|
|
@@ -1,4 +1,7 @@
|
|
|
1
|
+
export { type SessionsListV1Request } from "./SessionsListV1Request.js";
|
|
1
2
|
export { type SessionsGetV1Request } from "./SessionsGetV1Request.js";
|
|
3
|
+
export { type SessionsTypeaheadOffChrtOrderIdV1Request } from "./SessionsTypeaheadOffChrtOrderIdV1Request.js";
|
|
4
|
+
export { type SessionsSearchV1Request } from "./SessionsSearchV1Request.js";
|
|
2
5
|
export { type SessionCreateSessionRequest1 } from "./SessionCreateSessionRequest1.js";
|
|
3
6
|
export { type SessionUpdateRequest1 } from "./SessionUpdateRequest1.js";
|
|
4
7
|
export { type SessionsStartV1Request } from "./SessionsStartV1Request.js";
|
|
@@ -13,5 +13,8 @@ export interface Session1 {
|
|
|
13
13
|
session_created_at_timestamp: string;
|
|
14
14
|
recording_initiated_at_timestamp?: string | null;
|
|
15
15
|
public?: boolean;
|
|
16
|
+
flight_number?: string | null;
|
|
17
|
+
fa_flight_ids?: string[];
|
|
18
|
+
off_chrt_order_id?: string | null;
|
|
16
19
|
_id: string;
|
|
17
20
|
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export type SessionSortByEnum = "session_created_at_timestamp" | "recording_initiated_at_timestamp";
|
|
5
|
+
export declare const SessionSortByEnum: {
|
|
6
|
+
readonly SessionCreatedAtTimestamp: "session_created_at_timestamp";
|
|
7
|
+
readonly RecordingInitiatedAtTimestamp: "recording_initiated_at_timestamp";
|
|
8
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.SessionSortByEnum = void 0;
|
|
7
|
+
exports.SessionSortByEnum = {
|
|
8
|
+
SessionCreatedAtTimestamp: "session_created_at_timestamp",
|
|
9
|
+
RecordingInitiatedAtTimestamp: "recording_initiated_at_timestamp",
|
|
10
|
+
};
|