@chrt-inc/typescript-sdk 1.288.0 → 1.293.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/milestones/resources/images/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/milestones/resources/images/client/Client.js +2 -1
- package/dist/cjs/api/resources/milestones/resources/images/client/requests/BodyPostMilestonesUploadImageV1OortMilestonesImagesUploadV1MilestoneIdPost.d.ts +2 -1
- package/dist/cjs/api/resources/orders/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/orders/client/Client.js +64 -0
- package/dist/cjs/api/resources/orders/client/requests/OrdersExpandedReq.d.ts +17 -0
- package/dist/cjs/api/resources/orders/client/requests/OrdersExpandedReq.js +5 -0
- package/dist/cjs/api/resources/orders/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/orders/resources/full/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/orders/resources/full/client/Client.js +1 -1
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.d.ts +8 -2
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js +8 -2
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesDeleteV1Request.d.ts +4 -1
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesGetV1Request.d.ts +4 -1
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/Client.d.ts +4 -2
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/Client.js +4 -2
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceDataPointsPublicV1Request.d.ts +2 -1
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceDataPointsV1Request.d.ts +2 -1
- package/dist/cjs/api/types/GeometryCollection.d.ts +1 -1
- package/dist/cjs/api/types/LineString.d.ts +1 -1
- package/dist/cjs/api/types/LocationFeature.d.ts +1 -1
- package/dist/cjs/api/types/MultiLineString.d.ts +1 -1
- package/dist/cjs/api/types/MultiPoint.d.ts +1 -1
- package/dist/cjs/api/types/MultiPolygon.d.ts +1 -1
- package/dist/cjs/api/types/OrderExpanded.d.ts +11 -0
- package/dist/cjs/api/types/OrderExpanded.js +5 -0
- package/dist/cjs/api/types/OrdersExpandedRes.d.ts +10 -0
- package/dist/cjs/api/types/OrdersExpandedRes.js +5 -0
- package/dist/cjs/api/types/Point.d.ts +1 -1
- package/dist/cjs/api/types/Polygon.d.ts +1 -1
- package/dist/cjs/api/types/index.d.ts +4 -2
- package/dist/cjs/api/types/index.js +4 -2
- 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/milestones/resources/images/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/milestones/resources/images/client/Client.mjs +2 -1
- package/dist/esm/api/resources/milestones/resources/images/client/requests/BodyPostMilestonesUploadImageV1OortMilestonesImagesUploadV1MilestoneIdPost.d.mts +2 -1
- package/dist/esm/api/resources/orders/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/orders/client/Client.mjs +64 -0
- package/dist/esm/api/resources/orders/client/requests/OrdersExpandedReq.d.mts +17 -0
- package/dist/esm/api/resources/orders/client/requests/OrdersExpandedReq.mjs +4 -0
- package/dist/esm/api/resources/orders/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/orders/resources/full/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/orders/resources/full/client/Client.mjs +1 -1
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.d.mts +8 -2
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs +8 -2
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesDeleteV1Request.d.mts +4 -1
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesGetV1Request.d.mts +4 -1
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/Client.d.mts +4 -2
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/Client.mjs +4 -2
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceDataPointsPublicV1Request.d.mts +2 -1
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceDataPointsV1Request.d.mts +2 -1
- package/dist/esm/api/types/GeometryCollection.d.mts +1 -1
- package/dist/esm/api/types/LineString.d.mts +1 -1
- package/dist/esm/api/types/LocationFeature.d.mts +1 -1
- package/dist/esm/api/types/MultiLineString.d.mts +1 -1
- package/dist/esm/api/types/MultiPoint.d.mts +1 -1
- package/dist/esm/api/types/MultiPolygon.d.mts +1 -1
- package/dist/esm/api/types/OrderExpanded.d.mts +11 -0
- package/dist/esm/api/types/OrderExpanded.mjs +4 -0
- package/dist/esm/api/types/OrdersExpandedRes.d.mts +10 -0
- package/dist/esm/api/types/OrdersExpandedRes.mjs +4 -0
- package/dist/esm/api/types/Point.d.mts +1 -1
- package/dist/esm/api/types/Polygon.d.mts +1 -1
- package/dist/esm/api/types/index.d.mts +4 -2
- package/dist/esm/api/types/index.mjs +4 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +77 -3
package/dist/cjs/Client.js
CHANGED
|
@@ -68,8 +68,8 @@ class ChrtClient {
|
|
|
68
68
|
this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
|
|
69
69
|
"X-Fern-Language": "JavaScript",
|
|
70
70
|
"X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
|
|
71
|
-
"X-Fern-SDK-Version": "1.
|
|
72
|
-
"User-Agent": "@chrt-inc/typescript-sdk/1.
|
|
71
|
+
"X-Fern-SDK-Version": "1.293.0",
|
|
72
|
+
"User-Agent": "@chrt-inc/typescript-sdk/1.293.0",
|
|
73
73
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
74
74
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
75
75
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -42,7 +42,8 @@ export declare class Images {
|
|
|
42
42
|
* @example
|
|
43
43
|
* import { createReadStream } from "fs";
|
|
44
44
|
* await client.milestones.images.uploadByMilestoneIdV1("milestone_id", {
|
|
45
|
-
* image: fs.createReadStream("/path/to/your/file")
|
|
45
|
+
* image: fs.createReadStream("/path/to/your/file"),
|
|
46
|
+
* comments: "comments"
|
|
46
47
|
* })
|
|
47
48
|
*/
|
|
48
49
|
uploadByMilestoneIdV1(milestoneId: string, request: Chrt.milestones.BodyPostMilestonesUploadImageV1OortMilestonesImagesUploadV1MilestoneIdPost, requestOptions?: Images.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
@@ -67,7 +67,8 @@ class Images {
|
|
|
67
67
|
* @example
|
|
68
68
|
* import { createReadStream } from "fs";
|
|
69
69
|
* await client.milestones.images.uploadByMilestoneIdV1("milestone_id", {
|
|
70
|
-
* image: fs.createReadStream("/path/to/your/file")
|
|
70
|
+
* image: fs.createReadStream("/path/to/your/file"),
|
|
71
|
+
* comments: "comments"
|
|
71
72
|
* })
|
|
72
73
|
*/
|
|
73
74
|
uploadByMilestoneIdV1(milestoneId, request, requestOptions) {
|
|
@@ -5,7 +5,8 @@ import * as core from "../../../../../../../core/index.js";
|
|
|
5
5
|
/**
|
|
6
6
|
* @example
|
|
7
7
|
* {
|
|
8
|
-
* image: fs.createReadStream("/path/to/your/file")
|
|
8
|
+
* image: fs.createReadStream("/path/to/your/file"),
|
|
9
|
+
* comments: "comments"
|
|
9
10
|
* }
|
|
10
11
|
*/
|
|
11
12
|
export interface BodyPostMilestonesUploadImageV1OortMilestonesImagesUploadV1MilestoneIdPost {
|
|
@@ -90,6 +90,21 @@ export declare class Orders {
|
|
|
90
90
|
*/
|
|
91
91
|
createV1(request: Chrt.CreateOrderReq, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Chrt.CreateOrderRes>;
|
|
92
92
|
private __createV1;
|
|
93
|
+
/**
|
|
94
|
+
* Fetches an order with optional expanded data for task groups, tasks, milestones, and cargos.
|
|
95
|
+
*
|
|
96
|
+
* @param {Chrt.OrdersExpandedReq} request
|
|
97
|
+
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
100
|
+
*
|
|
101
|
+
* @example
|
|
102
|
+
* await client.orders.postExpandedV1({
|
|
103
|
+
* order_id_or_short_id: "order_id_or_short_id"
|
|
104
|
+
* })
|
|
105
|
+
*/
|
|
106
|
+
postExpandedV1(request: Chrt.OrdersExpandedReq, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Chrt.OrdersExpandedRes>;
|
|
107
|
+
private __postExpandedV1;
|
|
93
108
|
/**
|
|
94
109
|
* Lists all orders for the authenticated shipper organization.
|
|
95
110
|
*
|
|
@@ -258,6 +258,70 @@ class Orders {
|
|
|
258
258
|
}
|
|
259
259
|
});
|
|
260
260
|
}
|
|
261
|
+
/**
|
|
262
|
+
* Fetches an order with optional expanded data for task groups, tasks, milestones, and cargos.
|
|
263
|
+
*
|
|
264
|
+
* @param {Chrt.OrdersExpandedReq} request
|
|
265
|
+
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
266
|
+
*
|
|
267
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
268
|
+
*
|
|
269
|
+
* @example
|
|
270
|
+
* await client.orders.postExpandedV1({
|
|
271
|
+
* order_id_or_short_id: "order_id_or_short_id"
|
|
272
|
+
* })
|
|
273
|
+
*/
|
|
274
|
+
postExpandedV1(request, requestOptions) {
|
|
275
|
+
return core.HttpResponsePromise.fromPromise(this.__postExpandedV1(request, requestOptions));
|
|
276
|
+
}
|
|
277
|
+
__postExpandedV1(request, requestOptions) {
|
|
278
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
279
|
+
var _a, _b, _c, _d;
|
|
280
|
+
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);
|
|
281
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
282
|
+
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, "oort/orders/expanded/v1"),
|
|
283
|
+
method: "POST",
|
|
284
|
+
headers: _headers,
|
|
285
|
+
contentType: "application/json",
|
|
286
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
287
|
+
requestType: "json",
|
|
288
|
+
body: request,
|
|
289
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
290
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
291
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
292
|
+
});
|
|
293
|
+
if (_response.ok) {
|
|
294
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
295
|
+
}
|
|
296
|
+
if (_response.error.reason === "status-code") {
|
|
297
|
+
switch (_response.error.statusCode) {
|
|
298
|
+
case 422:
|
|
299
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
300
|
+
default:
|
|
301
|
+
throw new errors.ChrtError({
|
|
302
|
+
statusCode: _response.error.statusCode,
|
|
303
|
+
body: _response.error.body,
|
|
304
|
+
rawResponse: _response.rawResponse,
|
|
305
|
+
});
|
|
306
|
+
}
|
|
307
|
+
}
|
|
308
|
+
switch (_response.error.reason) {
|
|
309
|
+
case "non-json":
|
|
310
|
+
throw new errors.ChrtError({
|
|
311
|
+
statusCode: _response.error.statusCode,
|
|
312
|
+
body: _response.error.rawBody,
|
|
313
|
+
rawResponse: _response.rawResponse,
|
|
314
|
+
});
|
|
315
|
+
case "timeout":
|
|
316
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /oort/orders/expanded/v1.");
|
|
317
|
+
case "unknown":
|
|
318
|
+
throw new errors.ChrtError({
|
|
319
|
+
message: _response.error.errorMessage,
|
|
320
|
+
rawResponse: _response.rawResponse,
|
|
321
|
+
});
|
|
322
|
+
}
|
|
323
|
+
});
|
|
324
|
+
}
|
|
261
325
|
/**
|
|
262
326
|
* Lists all orders for the authenticated shipper organization.
|
|
263
327
|
*
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* order_id_or_short_id: "order_id_or_short_id"
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface OrdersExpandedReq {
|
|
11
|
+
order_id_or_short_id: string;
|
|
12
|
+
expand_task_groups?: boolean;
|
|
13
|
+
expand_tasks?: boolean;
|
|
14
|
+
expand_milestones?: boolean;
|
|
15
|
+
expand_cargos?: boolean;
|
|
16
|
+
expand_shipper_contact_infos?: boolean;
|
|
17
|
+
}
|
|
@@ -31,7 +31,7 @@ export declare class Full {
|
|
|
31
31
|
protected readonly _options: Full.Options;
|
|
32
32
|
constructor(_options?: Full.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Retrieves an order with all related task groups, tasks, milestones, and cargo information.
|
|
34
|
+
* (DEPRECATED) Retrieves an order with all related task groups, tasks, milestones, and cargo information.
|
|
35
35
|
*
|
|
36
36
|
* @param {string} orderIdOrShortId
|
|
37
37
|
* @param {Full.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class Full {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Retrieves an order with all related task groups, tasks, milestones, and cargo information.
|
|
59
|
+
* (DEPRECATED) Retrieves an order with all related task groups, tasks, milestones, and cargo information.
|
|
60
60
|
*
|
|
61
61
|
* @param {string} orderIdOrShortId
|
|
62
62
|
* @param {Full.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -67,7 +67,10 @@ export declare class Devices {
|
|
|
67
67
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
68
68
|
*
|
|
69
69
|
* @example
|
|
70
|
-
* await client.tracking.devices.deleteV1(
|
|
70
|
+
* await client.tracking.devices.deleteV1({
|
|
71
|
+
* device_id: "device_id",
|
|
72
|
+
* device_mac_address: "device_mac_address"
|
|
73
|
+
* })
|
|
71
74
|
*/
|
|
72
75
|
deleteV1(request?: Chrt.tracking.DevicesDeleteV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
73
76
|
private __deleteV1;
|
|
@@ -80,7 +83,10 @@ export declare class Devices {
|
|
|
80
83
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
81
84
|
*
|
|
82
85
|
* @example
|
|
83
|
-
* await client.tracking.devices.getV1(
|
|
86
|
+
* await client.tracking.devices.getV1({
|
|
87
|
+
* device_mac_address: "device_mac_address",
|
|
88
|
+
* device_id: "device_id"
|
|
89
|
+
* })
|
|
84
90
|
*/
|
|
85
91
|
getV1(request?: Chrt.tracking.DevicesGetV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<Chrt.Device1>;
|
|
86
92
|
private __getV1;
|
|
@@ -190,7 +190,10 @@ class Devices {
|
|
|
190
190
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
191
191
|
*
|
|
192
192
|
* @example
|
|
193
|
-
* await client.tracking.devices.deleteV1(
|
|
193
|
+
* await client.tracking.devices.deleteV1({
|
|
194
|
+
* device_id: "device_id",
|
|
195
|
+
* device_mac_address: "device_mac_address"
|
|
196
|
+
* })
|
|
194
197
|
*/
|
|
195
198
|
deleteV1(request = {}, requestOptions) {
|
|
196
199
|
return core.HttpResponsePromise.fromPromise(this.__deleteV1(request, requestOptions));
|
|
@@ -257,7 +260,10 @@ class Devices {
|
|
|
257
260
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
258
261
|
*
|
|
259
262
|
* @example
|
|
260
|
-
* await client.tracking.devices.getV1(
|
|
263
|
+
* await client.tracking.devices.getV1({
|
|
264
|
+
* device_mac_address: "device_mac_address",
|
|
265
|
+
* device_id: "device_id"
|
|
266
|
+
* })
|
|
261
267
|
*/
|
|
262
268
|
getV1(request = {}, requestOptions) {
|
|
263
269
|
return core.HttpResponsePromise.fromPromise(this.__getV1(request, requestOptions));
|
|
@@ -80,7 +80,8 @@ export declare class SessionByDevice {
|
|
|
80
80
|
*
|
|
81
81
|
* @example
|
|
82
82
|
* await client.tracking.sessionByDevice.dataPointsV1({
|
|
83
|
-
* session_id: "session_id"
|
|
83
|
+
* session_id: "session_id",
|
|
84
|
+
* limit: 1
|
|
84
85
|
* })
|
|
85
86
|
*/
|
|
86
87
|
dataPointsV1(request: Chrt.tracking.SessionByDeviceDataPointsV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSessionByDeviceDataPoint1[]>;
|
|
@@ -231,7 +232,8 @@ export declare class SessionByDevice {
|
|
|
231
232
|
*
|
|
232
233
|
* @example
|
|
233
234
|
* await client.tracking.sessionByDevice.dataPointsPublicV1({
|
|
234
|
-
* session_id: "session_id"
|
|
235
|
+
* session_id: "session_id",
|
|
236
|
+
* limit: 1
|
|
235
237
|
* })
|
|
236
238
|
*/
|
|
237
239
|
dataPointsPublicV1(request: Chrt.tracking.SessionByDeviceDataPointsPublicV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSessionByDeviceDataPoint1[]>;
|
|
@@ -247,7 +247,8 @@ class SessionByDevice {
|
|
|
247
247
|
*
|
|
248
248
|
* @example
|
|
249
249
|
* await client.tracking.sessionByDevice.dataPointsV1({
|
|
250
|
-
* session_id: "session_id"
|
|
250
|
+
* session_id: "session_id",
|
|
251
|
+
* limit: 1
|
|
251
252
|
* })
|
|
252
253
|
*/
|
|
253
254
|
dataPointsV1(request, requestOptions) {
|
|
@@ -900,7 +901,8 @@ class SessionByDevice {
|
|
|
900
901
|
*
|
|
901
902
|
* @example
|
|
902
903
|
* await client.tracking.sessionByDevice.dataPointsPublicV1({
|
|
903
|
-
* session_id: "session_id"
|
|
904
|
+
* session_id: "session_id",
|
|
905
|
+
* limit: 1
|
|
904
906
|
* })
|
|
905
907
|
*/
|
|
906
908
|
dataPointsPublicV1(request, requestOptions) {
|
|
@@ -10,7 +10,7 @@ import * as Chrt from "../index.js";
|
|
|
10
10
|
* To ensure geometry is always present, validate it at runtime or make it required.
|
|
11
11
|
*/
|
|
12
12
|
export interface LocationFeature {
|
|
13
|
-
bbox?: unknown[];
|
|
13
|
+
bbox?: unknown[] | null;
|
|
14
14
|
type: "Feature";
|
|
15
15
|
geometry: Chrt.Geometry;
|
|
16
16
|
properties?: Chrt.LocationProperties | null;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* Single order with optional expanded data
|
|
7
|
+
*/
|
|
8
|
+
export interface OrderExpanded {
|
|
9
|
+
order: Chrt.Order1;
|
|
10
|
+
task_groups_expanded?: Chrt.TaskGroupExpanded[] | null;
|
|
11
|
+
}
|
|
@@ -54,7 +54,9 @@ export * from "./Order1.js";
|
|
|
54
54
|
export * from "./OrderClientCreate1.js";
|
|
55
55
|
export * from "./OrderCreatedByTypeEnum.js";
|
|
56
56
|
export * from "./OrderDispatchTypeEnum.js";
|
|
57
|
+
export * from "./OrderExpanded.js";
|
|
57
58
|
export * from "./OrderStatusEnum1.js";
|
|
59
|
+
export * from "./OrdersExpandedRes.js";
|
|
58
60
|
export * from "./OrgMemberDetails.js";
|
|
59
61
|
export * from "./OrgMembersAndDrivers.js";
|
|
60
62
|
export * from "./OrgPublicData2.js";
|
|
@@ -87,10 +89,8 @@ export * from "./Task1.js";
|
|
|
87
89
|
export * from "./TaskActionEnum1.js";
|
|
88
90
|
export * from "./TaskClientCreate1.js";
|
|
89
91
|
export * from "./TaskCreateBundle.js";
|
|
90
|
-
export * from "./TaskExpanded.js";
|
|
91
92
|
export * from "./TaskGroup1.js";
|
|
92
93
|
export * from "./TaskGroupDetailsResponse.js";
|
|
93
|
-
export * from "./TaskGroupExpanded.js";
|
|
94
94
|
export * from "./TaskGroupStatusEnum1.js";
|
|
95
95
|
export * from "./TaskGroupWithDetails.js";
|
|
96
96
|
export * from "./TaskGroupWithTasks.js";
|
|
@@ -114,3 +114,5 @@ export * from "./UserPublicData1.js";
|
|
|
114
114
|
export * from "./ValidationError.js";
|
|
115
115
|
export * from "./Vehicle1.js";
|
|
116
116
|
export * from "./VehicleTypeEnum.js";
|
|
117
|
+
export * from "./TaskExpanded.js";
|
|
118
|
+
export * from "./TaskGroupExpanded.js";
|
|
@@ -70,7 +70,9 @@ __exportStar(require("./Order1.js"), exports);
|
|
|
70
70
|
__exportStar(require("./OrderClientCreate1.js"), exports);
|
|
71
71
|
__exportStar(require("./OrderCreatedByTypeEnum.js"), exports);
|
|
72
72
|
__exportStar(require("./OrderDispatchTypeEnum.js"), exports);
|
|
73
|
+
__exportStar(require("./OrderExpanded.js"), exports);
|
|
73
74
|
__exportStar(require("./OrderStatusEnum1.js"), exports);
|
|
75
|
+
__exportStar(require("./OrdersExpandedRes.js"), exports);
|
|
74
76
|
__exportStar(require("./OrgMemberDetails.js"), exports);
|
|
75
77
|
__exportStar(require("./OrgMembersAndDrivers.js"), exports);
|
|
76
78
|
__exportStar(require("./OrgPublicData2.js"), exports);
|
|
@@ -103,10 +105,8 @@ __exportStar(require("./Task1.js"), exports);
|
|
|
103
105
|
__exportStar(require("./TaskActionEnum1.js"), exports);
|
|
104
106
|
__exportStar(require("./TaskClientCreate1.js"), exports);
|
|
105
107
|
__exportStar(require("./TaskCreateBundle.js"), exports);
|
|
106
|
-
__exportStar(require("./TaskExpanded.js"), exports);
|
|
107
108
|
__exportStar(require("./TaskGroup1.js"), exports);
|
|
108
109
|
__exportStar(require("./TaskGroupDetailsResponse.js"), exports);
|
|
109
|
-
__exportStar(require("./TaskGroupExpanded.js"), exports);
|
|
110
110
|
__exportStar(require("./TaskGroupStatusEnum1.js"), exports);
|
|
111
111
|
__exportStar(require("./TaskGroupWithDetails.js"), exports);
|
|
112
112
|
__exportStar(require("./TaskGroupWithTasks.js"), exports);
|
|
@@ -130,3 +130,5 @@ __exportStar(require("./UserPublicData1.js"), exports);
|
|
|
130
130
|
__exportStar(require("./ValidationError.js"), exports);
|
|
131
131
|
__exportStar(require("./Vehicle1.js"), exports);
|
|
132
132
|
__exportStar(require("./VehicleTypeEnum.js"), exports);
|
|
133
|
+
__exportStar(require("./TaskExpanded.js"), exports);
|
|
134
|
+
__exportStar(require("./TaskGroupExpanded.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.293.0";
|
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.293.0",
|
|
36
|
+
"User-Agent": "@chrt-inc/typescript-sdk/1.293.0",
|
|
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) });
|
|
@@ -42,7 +42,8 @@ export declare class Images {
|
|
|
42
42
|
* @example
|
|
43
43
|
* import { createReadStream } from "fs";
|
|
44
44
|
* await client.milestones.images.uploadByMilestoneIdV1("milestone_id", {
|
|
45
|
-
* image: fs.createReadStream("/path/to/your/file")
|
|
45
|
+
* image: fs.createReadStream("/path/to/your/file"),
|
|
46
|
+
* comments: "comments"
|
|
46
47
|
* })
|
|
47
48
|
*/
|
|
48
49
|
uploadByMilestoneIdV1(milestoneId: string, request: Chrt.milestones.BodyPostMilestonesUploadImageV1OortMilestonesImagesUploadV1MilestoneIdPost, requestOptions?: Images.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
@@ -31,7 +31,8 @@ export class Images {
|
|
|
31
31
|
* @example
|
|
32
32
|
* import { createReadStream } from "fs";
|
|
33
33
|
* await client.milestones.images.uploadByMilestoneIdV1("milestone_id", {
|
|
34
|
-
* image: fs.createReadStream("/path/to/your/file")
|
|
34
|
+
* image: fs.createReadStream("/path/to/your/file"),
|
|
35
|
+
* comments: "comments"
|
|
35
36
|
* })
|
|
36
37
|
*/
|
|
37
38
|
uploadByMilestoneIdV1(milestoneId, request, requestOptions) {
|
|
@@ -5,7 +5,8 @@ import * as core from "../../../../../../../core/index.mjs";
|
|
|
5
5
|
/**
|
|
6
6
|
* @example
|
|
7
7
|
* {
|
|
8
|
-
* image: fs.createReadStream("/path/to/your/file")
|
|
8
|
+
* image: fs.createReadStream("/path/to/your/file"),
|
|
9
|
+
* comments: "comments"
|
|
9
10
|
* }
|
|
10
11
|
*/
|
|
11
12
|
export interface BodyPostMilestonesUploadImageV1OortMilestonesImagesUploadV1MilestoneIdPost {
|
|
@@ -90,6 +90,21 @@ export declare class Orders {
|
|
|
90
90
|
*/
|
|
91
91
|
createV1(request: Chrt.CreateOrderReq, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Chrt.CreateOrderRes>;
|
|
92
92
|
private __createV1;
|
|
93
|
+
/**
|
|
94
|
+
* Fetches an order with optional expanded data for task groups, tasks, milestones, and cargos.
|
|
95
|
+
*
|
|
96
|
+
* @param {Chrt.OrdersExpandedReq} request
|
|
97
|
+
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
100
|
+
*
|
|
101
|
+
* @example
|
|
102
|
+
* await client.orders.postExpandedV1({
|
|
103
|
+
* order_id_or_short_id: "order_id_or_short_id"
|
|
104
|
+
* })
|
|
105
|
+
*/
|
|
106
|
+
postExpandedV1(request: Chrt.OrdersExpandedReq, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Chrt.OrdersExpandedRes>;
|
|
107
|
+
private __postExpandedV1;
|
|
93
108
|
/**
|
|
94
109
|
* Lists all orders for the authenticated shipper organization.
|
|
95
110
|
*
|
|
@@ -222,6 +222,70 @@ export class Orders {
|
|
|
222
222
|
}
|
|
223
223
|
});
|
|
224
224
|
}
|
|
225
|
+
/**
|
|
226
|
+
* Fetches an order with optional expanded data for task groups, tasks, milestones, and cargos.
|
|
227
|
+
*
|
|
228
|
+
* @param {Chrt.OrdersExpandedReq} request
|
|
229
|
+
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
230
|
+
*
|
|
231
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
232
|
+
*
|
|
233
|
+
* @example
|
|
234
|
+
* await client.orders.postExpandedV1({
|
|
235
|
+
* order_id_or_short_id: "order_id_or_short_id"
|
|
236
|
+
* })
|
|
237
|
+
*/
|
|
238
|
+
postExpandedV1(request, requestOptions) {
|
|
239
|
+
return core.HttpResponsePromise.fromPromise(this.__postExpandedV1(request, requestOptions));
|
|
240
|
+
}
|
|
241
|
+
__postExpandedV1(request, requestOptions) {
|
|
242
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
243
|
+
var _a, _b, _c, _d;
|
|
244
|
+
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);
|
|
245
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
246
|
+
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, "oort/orders/expanded/v1"),
|
|
247
|
+
method: "POST",
|
|
248
|
+
headers: _headers,
|
|
249
|
+
contentType: "application/json",
|
|
250
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
251
|
+
requestType: "json",
|
|
252
|
+
body: request,
|
|
253
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
254
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
255
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
256
|
+
});
|
|
257
|
+
if (_response.ok) {
|
|
258
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
259
|
+
}
|
|
260
|
+
if (_response.error.reason === "status-code") {
|
|
261
|
+
switch (_response.error.statusCode) {
|
|
262
|
+
case 422:
|
|
263
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
264
|
+
default:
|
|
265
|
+
throw new errors.ChrtError({
|
|
266
|
+
statusCode: _response.error.statusCode,
|
|
267
|
+
body: _response.error.body,
|
|
268
|
+
rawResponse: _response.rawResponse,
|
|
269
|
+
});
|
|
270
|
+
}
|
|
271
|
+
}
|
|
272
|
+
switch (_response.error.reason) {
|
|
273
|
+
case "non-json":
|
|
274
|
+
throw new errors.ChrtError({
|
|
275
|
+
statusCode: _response.error.statusCode,
|
|
276
|
+
body: _response.error.rawBody,
|
|
277
|
+
rawResponse: _response.rawResponse,
|
|
278
|
+
});
|
|
279
|
+
case "timeout":
|
|
280
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /oort/orders/expanded/v1.");
|
|
281
|
+
case "unknown":
|
|
282
|
+
throw new errors.ChrtError({
|
|
283
|
+
message: _response.error.errorMessage,
|
|
284
|
+
rawResponse: _response.rawResponse,
|
|
285
|
+
});
|
|
286
|
+
}
|
|
287
|
+
});
|
|
288
|
+
}
|
|
225
289
|
/**
|
|
226
290
|
* Lists all orders for the authenticated shipper organization.
|
|
227
291
|
*
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* order_id_or_short_id: "order_id_or_short_id"
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface OrdersExpandedReq {
|
|
11
|
+
order_id_or_short_id: string;
|
|
12
|
+
expand_task_groups?: boolean;
|
|
13
|
+
expand_tasks?: boolean;
|
|
14
|
+
expand_milestones?: boolean;
|
|
15
|
+
expand_cargos?: boolean;
|
|
16
|
+
expand_shipper_contact_infos?: boolean;
|
|
17
|
+
}
|
|
@@ -31,7 +31,7 @@ export declare class Full {
|
|
|
31
31
|
protected readonly _options: Full.Options;
|
|
32
32
|
constructor(_options?: Full.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Retrieves an order with all related task groups, tasks, milestones, and cargo information.
|
|
34
|
+
* (DEPRECATED) Retrieves an order with all related task groups, tasks, milestones, and cargo information.
|
|
35
35
|
*
|
|
36
36
|
* @param {string} orderIdOrShortId
|
|
37
37
|
* @param {Full.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -20,7 +20,7 @@ export class Full {
|
|
|
20
20
|
this._options = _options;
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* Retrieves an order with all related task groups, tasks, milestones, and cargo information.
|
|
23
|
+
* (DEPRECATED) Retrieves an order with all related task groups, tasks, milestones, and cargo information.
|
|
24
24
|
*
|
|
25
25
|
* @param {string} orderIdOrShortId
|
|
26
26
|
* @param {Full.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -67,7 +67,10 @@ export declare class Devices {
|
|
|
67
67
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
68
68
|
*
|
|
69
69
|
* @example
|
|
70
|
-
* await client.tracking.devices.deleteV1(
|
|
70
|
+
* await client.tracking.devices.deleteV1({
|
|
71
|
+
* device_id: "device_id",
|
|
72
|
+
* device_mac_address: "device_mac_address"
|
|
73
|
+
* })
|
|
71
74
|
*/
|
|
72
75
|
deleteV1(request?: Chrt.tracking.DevicesDeleteV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
73
76
|
private __deleteV1;
|
|
@@ -80,7 +83,10 @@ export declare class Devices {
|
|
|
80
83
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
81
84
|
*
|
|
82
85
|
* @example
|
|
83
|
-
* await client.tracking.devices.getV1(
|
|
86
|
+
* await client.tracking.devices.getV1({
|
|
87
|
+
* device_mac_address: "device_mac_address",
|
|
88
|
+
* device_id: "device_id"
|
|
89
|
+
* })
|
|
84
90
|
*/
|
|
85
91
|
getV1(request?: Chrt.tracking.DevicesGetV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<Chrt.Device1>;
|
|
86
92
|
private __getV1;
|
|
@@ -154,7 +154,10 @@ export class Devices {
|
|
|
154
154
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
155
155
|
*
|
|
156
156
|
* @example
|
|
157
|
-
* await client.tracking.devices.deleteV1(
|
|
157
|
+
* await client.tracking.devices.deleteV1({
|
|
158
|
+
* device_id: "device_id",
|
|
159
|
+
* device_mac_address: "device_mac_address"
|
|
160
|
+
* })
|
|
158
161
|
*/
|
|
159
162
|
deleteV1(request = {}, requestOptions) {
|
|
160
163
|
return core.HttpResponsePromise.fromPromise(this.__deleteV1(request, requestOptions));
|
|
@@ -221,7 +224,10 @@ export class Devices {
|
|
|
221
224
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
222
225
|
*
|
|
223
226
|
* @example
|
|
224
|
-
* await client.tracking.devices.getV1(
|
|
227
|
+
* await client.tracking.devices.getV1({
|
|
228
|
+
* device_mac_address: "device_mac_address",
|
|
229
|
+
* device_id: "device_id"
|
|
230
|
+
* })
|
|
225
231
|
*/
|
|
226
232
|
getV1(request = {}, requestOptions) {
|
|
227
233
|
return core.HttpResponsePromise.fromPromise(this.__getV1(request, requestOptions));
|
|
@@ -80,7 +80,8 @@ export declare class SessionByDevice {
|
|
|
80
80
|
*
|
|
81
81
|
* @example
|
|
82
82
|
* await client.tracking.sessionByDevice.dataPointsV1({
|
|
83
|
-
* session_id: "session_id"
|
|
83
|
+
* session_id: "session_id",
|
|
84
|
+
* limit: 1
|
|
84
85
|
* })
|
|
85
86
|
*/
|
|
86
87
|
dataPointsV1(request: Chrt.tracking.SessionByDeviceDataPointsV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSessionByDeviceDataPoint1[]>;
|
|
@@ -231,7 +232,8 @@ export declare class SessionByDevice {
|
|
|
231
232
|
*
|
|
232
233
|
* @example
|
|
233
234
|
* await client.tracking.sessionByDevice.dataPointsPublicV1({
|
|
234
|
-
* session_id: "session_id"
|
|
235
|
+
* session_id: "session_id",
|
|
236
|
+
* limit: 1
|
|
235
237
|
* })
|
|
236
238
|
*/
|
|
237
239
|
dataPointsPublicV1(request: Chrt.tracking.SessionByDeviceDataPointsPublicV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSessionByDeviceDataPoint1[]>;
|
|
@@ -211,7 +211,8 @@ export class SessionByDevice {
|
|
|
211
211
|
*
|
|
212
212
|
* @example
|
|
213
213
|
* await client.tracking.sessionByDevice.dataPointsV1({
|
|
214
|
-
* session_id: "session_id"
|
|
214
|
+
* session_id: "session_id",
|
|
215
|
+
* limit: 1
|
|
215
216
|
* })
|
|
216
217
|
*/
|
|
217
218
|
dataPointsV1(request, requestOptions) {
|
|
@@ -864,7 +865,8 @@ export class SessionByDevice {
|
|
|
864
865
|
*
|
|
865
866
|
* @example
|
|
866
867
|
* await client.tracking.sessionByDevice.dataPointsPublicV1({
|
|
867
|
-
* session_id: "session_id"
|
|
868
|
+
* session_id: "session_id",
|
|
869
|
+
* limit: 1
|
|
868
870
|
* })
|
|
869
871
|
*/
|
|
870
872
|
dataPointsPublicV1(request, requestOptions) {
|
|
@@ -10,7 +10,7 @@ import * as Chrt from "../index.mjs";
|
|
|
10
10
|
* To ensure geometry is always present, validate it at runtime or make it required.
|
|
11
11
|
*/
|
|
12
12
|
export interface LocationFeature {
|
|
13
|
-
bbox?: unknown[];
|
|
13
|
+
bbox?: unknown[] | null;
|
|
14
14
|
type: "Feature";
|
|
15
15
|
geometry: Chrt.Geometry;
|
|
16
16
|
properties?: Chrt.LocationProperties | null;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Single order with optional expanded data
|
|
7
|
+
*/
|
|
8
|
+
export interface OrderExpanded {
|
|
9
|
+
order: Chrt.Order1;
|
|
10
|
+
task_groups_expanded?: Chrt.TaskGroupExpanded[] | null;
|
|
11
|
+
}
|
|
@@ -54,7 +54,9 @@ export * from "./Order1.mjs";
|
|
|
54
54
|
export * from "./OrderClientCreate1.mjs";
|
|
55
55
|
export * from "./OrderCreatedByTypeEnum.mjs";
|
|
56
56
|
export * from "./OrderDispatchTypeEnum.mjs";
|
|
57
|
+
export * from "./OrderExpanded.mjs";
|
|
57
58
|
export * from "./OrderStatusEnum1.mjs";
|
|
59
|
+
export * from "./OrdersExpandedRes.mjs";
|
|
58
60
|
export * from "./OrgMemberDetails.mjs";
|
|
59
61
|
export * from "./OrgMembersAndDrivers.mjs";
|
|
60
62
|
export * from "./OrgPublicData2.mjs";
|
|
@@ -87,10 +89,8 @@ export * from "./Task1.mjs";
|
|
|
87
89
|
export * from "./TaskActionEnum1.mjs";
|
|
88
90
|
export * from "./TaskClientCreate1.mjs";
|
|
89
91
|
export * from "./TaskCreateBundle.mjs";
|
|
90
|
-
export * from "./TaskExpanded.mjs";
|
|
91
92
|
export * from "./TaskGroup1.mjs";
|
|
92
93
|
export * from "./TaskGroupDetailsResponse.mjs";
|
|
93
|
-
export * from "./TaskGroupExpanded.mjs";
|
|
94
94
|
export * from "./TaskGroupStatusEnum1.mjs";
|
|
95
95
|
export * from "./TaskGroupWithDetails.mjs";
|
|
96
96
|
export * from "./TaskGroupWithTasks.mjs";
|
|
@@ -114,3 +114,5 @@ export * from "./UserPublicData1.mjs";
|
|
|
114
114
|
export * from "./ValidationError.mjs";
|
|
115
115
|
export * from "./Vehicle1.mjs";
|
|
116
116
|
export * from "./VehicleTypeEnum.mjs";
|
|
117
|
+
export * from "./TaskExpanded.mjs";
|
|
118
|
+
export * from "./TaskGroupExpanded.mjs";
|
|
@@ -54,7 +54,9 @@ export * from "./Order1.mjs";
|
|
|
54
54
|
export * from "./OrderClientCreate1.mjs";
|
|
55
55
|
export * from "./OrderCreatedByTypeEnum.mjs";
|
|
56
56
|
export * from "./OrderDispatchTypeEnum.mjs";
|
|
57
|
+
export * from "./OrderExpanded.mjs";
|
|
57
58
|
export * from "./OrderStatusEnum1.mjs";
|
|
59
|
+
export * from "./OrdersExpandedRes.mjs";
|
|
58
60
|
export * from "./OrgMemberDetails.mjs";
|
|
59
61
|
export * from "./OrgMembersAndDrivers.mjs";
|
|
60
62
|
export * from "./OrgPublicData2.mjs";
|
|
@@ -87,10 +89,8 @@ export * from "./Task1.mjs";
|
|
|
87
89
|
export * from "./TaskActionEnum1.mjs";
|
|
88
90
|
export * from "./TaskClientCreate1.mjs";
|
|
89
91
|
export * from "./TaskCreateBundle.mjs";
|
|
90
|
-
export * from "./TaskExpanded.mjs";
|
|
91
92
|
export * from "./TaskGroup1.mjs";
|
|
92
93
|
export * from "./TaskGroupDetailsResponse.mjs";
|
|
93
|
-
export * from "./TaskGroupExpanded.mjs";
|
|
94
94
|
export * from "./TaskGroupStatusEnum1.mjs";
|
|
95
95
|
export * from "./TaskGroupWithDetails.mjs";
|
|
96
96
|
export * from "./TaskGroupWithTasks.mjs";
|
|
@@ -114,3 +114,5 @@ export * from "./UserPublicData1.mjs";
|
|
|
114
114
|
export * from "./ValidationError.mjs";
|
|
115
115
|
export * from "./Vehicle1.mjs";
|
|
116
116
|
export * from "./VehicleTypeEnum.mjs";
|
|
117
|
+
export * from "./TaskExpanded.mjs";
|
|
118
|
+
export * from "./TaskGroupExpanded.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.293.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.
|
|
1
|
+
export const SDK_VERSION = "1.293.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -2112,6 +2112,71 @@ await client.orders.createV1({
|
|
|
2112
2112
|
</dl>
|
|
2113
2113
|
</details>
|
|
2114
2114
|
|
|
2115
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">postExpandedV1</a>({ ...params }) -> Chrt.OrdersExpandedRes</code></summary>
|
|
2116
|
+
<dl>
|
|
2117
|
+
<dd>
|
|
2118
|
+
|
|
2119
|
+
#### 📝 Description
|
|
2120
|
+
|
|
2121
|
+
<dl>
|
|
2122
|
+
<dd>
|
|
2123
|
+
|
|
2124
|
+
<dl>
|
|
2125
|
+
<dd>
|
|
2126
|
+
|
|
2127
|
+
Fetches an order with optional expanded data for task groups, tasks, milestones, and cargos.
|
|
2128
|
+
|
|
2129
|
+
</dd>
|
|
2130
|
+
</dl>
|
|
2131
|
+
</dd>
|
|
2132
|
+
</dl>
|
|
2133
|
+
|
|
2134
|
+
#### 🔌 Usage
|
|
2135
|
+
|
|
2136
|
+
<dl>
|
|
2137
|
+
<dd>
|
|
2138
|
+
|
|
2139
|
+
<dl>
|
|
2140
|
+
<dd>
|
|
2141
|
+
|
|
2142
|
+
```typescript
|
|
2143
|
+
await client.orders.postExpandedV1({
|
|
2144
|
+
order_id_or_short_id: "order_id_or_short_id",
|
|
2145
|
+
});
|
|
2146
|
+
```
|
|
2147
|
+
|
|
2148
|
+
</dd>
|
|
2149
|
+
</dl>
|
|
2150
|
+
</dd>
|
|
2151
|
+
</dl>
|
|
2152
|
+
|
|
2153
|
+
#### ⚙️ Parameters
|
|
2154
|
+
|
|
2155
|
+
<dl>
|
|
2156
|
+
<dd>
|
|
2157
|
+
|
|
2158
|
+
<dl>
|
|
2159
|
+
<dd>
|
|
2160
|
+
|
|
2161
|
+
**request:** `Chrt.OrdersExpandedReq`
|
|
2162
|
+
|
|
2163
|
+
</dd>
|
|
2164
|
+
</dl>
|
|
2165
|
+
|
|
2166
|
+
<dl>
|
|
2167
|
+
<dd>
|
|
2168
|
+
|
|
2169
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
2170
|
+
|
|
2171
|
+
</dd>
|
|
2172
|
+
</dl>
|
|
2173
|
+
</dd>
|
|
2174
|
+
</dl>
|
|
2175
|
+
|
|
2176
|
+
</dd>
|
|
2177
|
+
</dl>
|
|
2178
|
+
</details>
|
|
2179
|
+
|
|
2115
2180
|
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">listByShipperOrgIdV1</a>() -> Chrt.Order1[]</code></summary>
|
|
2116
2181
|
<dl>
|
|
2117
2182
|
<dd>
|
|
@@ -6864,6 +6929,7 @@ Uploads an image file to a milestone with automatic blurhash generation.
|
|
|
6864
6929
|
```typescript
|
|
6865
6930
|
await client.milestones.images.uploadByMilestoneIdV1("milestone_id", {
|
|
6866
6931
|
image: fs.createReadStream("/path/to/your/file"),
|
|
6932
|
+
comments: "comments",
|
|
6867
6933
|
});
|
|
6868
6934
|
```
|
|
6869
6935
|
|
|
@@ -7356,7 +7422,7 @@ await client.notifications.courier.upsertPreferencesV1({
|
|
|
7356
7422
|
<dl>
|
|
7357
7423
|
<dd>
|
|
7358
7424
|
|
|
7359
|
-
Retrieves an order with all related task groups, tasks, milestones, and cargo information.
|
|
7425
|
+
(DEPRECATED) Retrieves an order with all related task groups, tasks, milestones, and cargo information.
|
|
7360
7426
|
|
|
7361
7427
|
</dd>
|
|
7362
7428
|
</dl>
|
|
@@ -8776,7 +8842,10 @@ Deletes a device by ID or MAC address. Device must be unlinked from any session
|
|
|
8776
8842
|
<dd>
|
|
8777
8843
|
|
|
8778
8844
|
```typescript
|
|
8779
|
-
await client.tracking.devices.deleteV1(
|
|
8845
|
+
await client.tracking.devices.deleteV1({
|
|
8846
|
+
device_id: "device_id",
|
|
8847
|
+
device_mac_address: "device_mac_address",
|
|
8848
|
+
});
|
|
8780
8849
|
```
|
|
8781
8850
|
|
|
8782
8851
|
</dd>
|
|
@@ -8839,7 +8908,10 @@ Retrieves a single device by its MAC address or ID. Access restricted to the dev
|
|
|
8839
8908
|
<dd>
|
|
8840
8909
|
|
|
8841
8910
|
```typescript
|
|
8842
|
-
await client.tracking.devices.getV1(
|
|
8911
|
+
await client.tracking.devices.getV1({
|
|
8912
|
+
device_mac_address: "device_mac_address",
|
|
8913
|
+
device_id: "device_id",
|
|
8914
|
+
});
|
|
8843
8915
|
```
|
|
8844
8916
|
|
|
8845
8917
|
</dd>
|
|
@@ -9357,6 +9429,7 @@ Returns up to the specified number of data points for a session, intelligently s
|
|
|
9357
9429
|
```typescript
|
|
9358
9430
|
await client.tracking.sessionByDevice.dataPointsV1({
|
|
9359
9431
|
session_id: "session_id",
|
|
9432
|
+
limit: 1,
|
|
9360
9433
|
});
|
|
9361
9434
|
```
|
|
9362
9435
|
|
|
@@ -10008,6 +10081,7 @@ Returns up to the specified number of data points for a public session, intellig
|
|
|
10008
10081
|
```typescript
|
|
10009
10082
|
await client.tracking.sessionByDevice.dataPointsPublicV1({
|
|
10010
10083
|
session_id: "session_id",
|
|
10084
|
+
limit: 1,
|
|
10011
10085
|
});
|
|
10012
10086
|
```
|
|
10013
10087
|
|