@chrt-inc/typescript-sdk 1.336.0 → 1.337.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/orderDrafts/client/Client.d.ts +0 -14
- package/dist/cjs/api/resources/orderDrafts/client/Client.js +0 -63
- package/dist/cjs/api/resources/orderDrafts/resources/expanded/client/Client.d.ts +14 -0
- package/dist/cjs/api/resources/orderDrafts/resources/expanded/client/Client.js +63 -0
- package/dist/cjs/api/resources/tracking/resources/driver/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tracking/resources/driver/client/Client.js +1 -1
- 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/orderDrafts/client/Client.d.mts +0 -14
- package/dist/esm/api/resources/orderDrafts/client/Client.mjs +0 -63
- package/dist/esm/api/resources/orderDrafts/resources/expanded/client/Client.d.mts +14 -0
- package/dist/esm/api/resources/orderDrafts/resources/expanded/client/Client.mjs +63 -0
- package/dist/esm/api/resources/tracking/resources/driver/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/tracking/resources/driver/client/Client.mjs +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +72 -72
package/dist/cjs/Client.js
CHANGED
|
@@ -74,8 +74,8 @@ class ChrtClient {
|
|
|
74
74
|
this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
|
|
75
75
|
"X-Fern-Language": "JavaScript",
|
|
76
76
|
"X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
|
|
77
|
-
"X-Fern-SDK-Version": "1.
|
|
78
|
-
"User-Agent": "@chrt-inc/typescript-sdk/1.
|
|
77
|
+
"X-Fern-SDK-Version": "1.337.0",
|
|
78
|
+
"User-Agent": "@chrt-inc/typescript-sdk/1.337.0",
|
|
79
79
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
80
80
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
81
81
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -86,20 +86,6 @@ export declare class OrderDrafts {
|
|
|
86
86
|
*/
|
|
87
87
|
deleteV1(orderId: string, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
88
88
|
private __deleteV1;
|
|
89
|
-
/**
|
|
90
|
-
* Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
|
|
91
|
-
*
|
|
92
|
-
* @param {string} orderIdOrShortId
|
|
93
|
-
* @param {Chrt.OrderAndTaskGroupExpandedReq} request
|
|
94
|
-
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
95
|
-
*
|
|
96
|
-
* @throws {@link Chrt.UnprocessableEntityError}
|
|
97
|
-
*
|
|
98
|
-
* @example
|
|
99
|
-
* await client.orderDrafts.expandedV1("order_id_or_short_id", {})
|
|
100
|
-
*/
|
|
101
|
-
expandedV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpanded>;
|
|
102
|
-
private __expandedV1;
|
|
103
89
|
/**
|
|
104
90
|
* Checks whether the draft order satisfies all requirements to move into staging. | () -> (bool)
|
|
105
91
|
*
|
|
@@ -265,69 +265,6 @@ class OrderDrafts {
|
|
|
265
265
|
}
|
|
266
266
|
});
|
|
267
267
|
}
|
|
268
|
-
/**
|
|
269
|
-
* Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
|
|
270
|
-
*
|
|
271
|
-
* @param {string} orderIdOrShortId
|
|
272
|
-
* @param {Chrt.OrderAndTaskGroupExpandedReq} request
|
|
273
|
-
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
274
|
-
*
|
|
275
|
-
* @throws {@link Chrt.UnprocessableEntityError}
|
|
276
|
-
*
|
|
277
|
-
* @example
|
|
278
|
-
* await client.orderDrafts.expandedV1("order_id_or_short_id", {})
|
|
279
|
-
*/
|
|
280
|
-
expandedV1(orderIdOrShortId, request, requestOptions) {
|
|
281
|
-
return core.HttpResponsePromise.fromPromise(this.__expandedV1(orderIdOrShortId, request, requestOptions));
|
|
282
|
-
}
|
|
283
|
-
__expandedV1(orderIdOrShortId, request, requestOptions) {
|
|
284
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
285
|
-
var _a, _b, _c, _d;
|
|
286
|
-
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);
|
|
287
|
-
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
288
|
-
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/order_drafts/expanded/v1/${encodeURIComponent(orderIdOrShortId)}`),
|
|
289
|
-
method: "POST",
|
|
290
|
-
headers: _headers,
|
|
291
|
-
contentType: "application/json",
|
|
292
|
-
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
293
|
-
requestType: "json",
|
|
294
|
-
body: request,
|
|
295
|
-
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
296
|
-
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
297
|
-
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
298
|
-
});
|
|
299
|
-
if (_response.ok) {
|
|
300
|
-
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
301
|
-
}
|
|
302
|
-
if (_response.error.reason === "status-code") {
|
|
303
|
-
switch (_response.error.statusCode) {
|
|
304
|
-
case 422:
|
|
305
|
-
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
306
|
-
default:
|
|
307
|
-
throw new errors.ChrtError({
|
|
308
|
-
statusCode: _response.error.statusCode,
|
|
309
|
-
body: _response.error.body,
|
|
310
|
-
rawResponse: _response.rawResponse,
|
|
311
|
-
});
|
|
312
|
-
}
|
|
313
|
-
}
|
|
314
|
-
switch (_response.error.reason) {
|
|
315
|
-
case "non-json":
|
|
316
|
-
throw new errors.ChrtError({
|
|
317
|
-
statusCode: _response.error.statusCode,
|
|
318
|
-
body: _response.error.rawBody,
|
|
319
|
-
rawResponse: _response.rawResponse,
|
|
320
|
-
});
|
|
321
|
-
case "timeout":
|
|
322
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /oort/order_drafts/expanded/v1/{order_id_or_short_id}.");
|
|
323
|
-
case "unknown":
|
|
324
|
-
throw new errors.ChrtError({
|
|
325
|
-
message: _response.error.errorMessage,
|
|
326
|
-
rawResponse: _response.rawResponse,
|
|
327
|
-
});
|
|
328
|
-
}
|
|
329
|
-
});
|
|
330
|
-
}
|
|
331
268
|
/**
|
|
332
269
|
* Checks whether the draft order satisfies all requirements to move into staging. | () -> (bool)
|
|
333
270
|
*
|
|
@@ -30,6 +30,20 @@ export declare namespace Expanded {
|
|
|
30
30
|
export declare class Expanded {
|
|
31
31
|
protected readonly _options: Expanded.Options;
|
|
32
32
|
constructor(_options?: Expanded.Options);
|
|
33
|
+
/**
|
|
34
|
+
* Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
|
|
35
|
+
*
|
|
36
|
+
* @param {string} orderIdOrShortId
|
|
37
|
+
* @param {Chrt.OrderAndTaskGroupExpandedReq} request
|
|
38
|
+
* @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* await client.orderDrafts.expanded.retrieveV1("order_id_or_short_id", {})
|
|
44
|
+
*/
|
|
45
|
+
retrieveV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpanded>;
|
|
46
|
+
private __retrieveV1;
|
|
33
47
|
/**
|
|
34
48
|
* Lists expanded draft orders for the creator with filtering, sorting, and pagination. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpandedListRes)
|
|
35
49
|
*
|
|
@@ -55,6 +55,69 @@ class Expanded {
|
|
|
55
55
|
constructor(_options = {}) {
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
|
+
/**
|
|
59
|
+
* Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
|
|
60
|
+
*
|
|
61
|
+
* @param {string} orderIdOrShortId
|
|
62
|
+
* @param {Chrt.OrderAndTaskGroupExpandedReq} request
|
|
63
|
+
* @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* await client.orderDrafts.expanded.retrieveV1("order_id_or_short_id", {})
|
|
69
|
+
*/
|
|
70
|
+
retrieveV1(orderIdOrShortId, request, requestOptions) {
|
|
71
|
+
return core.HttpResponsePromise.fromPromise(this.__retrieveV1(orderIdOrShortId, request, requestOptions));
|
|
72
|
+
}
|
|
73
|
+
__retrieveV1(orderIdOrShortId, request, requestOptions) {
|
|
74
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
75
|
+
var _a, _b, _c, _d;
|
|
76
|
+
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);
|
|
77
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
78
|
+
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/order_drafts/expanded/retrieve/v1/${encodeURIComponent(orderIdOrShortId)}`),
|
|
79
|
+
method: "POST",
|
|
80
|
+
headers: _headers,
|
|
81
|
+
contentType: "application/json",
|
|
82
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
83
|
+
requestType: "json",
|
|
84
|
+
body: request,
|
|
85
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
86
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
87
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
88
|
+
});
|
|
89
|
+
if (_response.ok) {
|
|
90
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
91
|
+
}
|
|
92
|
+
if (_response.error.reason === "status-code") {
|
|
93
|
+
switch (_response.error.statusCode) {
|
|
94
|
+
case 422:
|
|
95
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
96
|
+
default:
|
|
97
|
+
throw new errors.ChrtError({
|
|
98
|
+
statusCode: _response.error.statusCode,
|
|
99
|
+
body: _response.error.body,
|
|
100
|
+
rawResponse: _response.rawResponse,
|
|
101
|
+
});
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
switch (_response.error.reason) {
|
|
105
|
+
case "non-json":
|
|
106
|
+
throw new errors.ChrtError({
|
|
107
|
+
statusCode: _response.error.statusCode,
|
|
108
|
+
body: _response.error.rawBody,
|
|
109
|
+
rawResponse: _response.rawResponse,
|
|
110
|
+
});
|
|
111
|
+
case "timeout":
|
|
112
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /oort/order_drafts/expanded/retrieve/v1/{order_id_or_short_id}.");
|
|
113
|
+
case "unknown":
|
|
114
|
+
throw new errors.ChrtError({
|
|
115
|
+
message: _response.error.errorMessage,
|
|
116
|
+
rawResponse: _response.rawResponse,
|
|
117
|
+
});
|
|
118
|
+
}
|
|
119
|
+
});
|
|
120
|
+
}
|
|
58
121
|
/**
|
|
59
122
|
* Lists expanded draft orders for the creator with filtering, sorting, and pagination. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpandedListRes)
|
|
60
123
|
*
|
|
@@ -31,7 +31,7 @@ export declare class Driver {
|
|
|
31
31
|
protected readonly _options: Driver.Options;
|
|
32
32
|
constructor(_options?: Driver.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos. | (LocationFeature) -> (DriverUpdateRes)
|
|
34
|
+
* Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos (cargo_by_driver). | (LocationFeature) -> (DriverUpdateRes)
|
|
35
35
|
*
|
|
36
36
|
* @param {Chrt.LocationFeature} request
|
|
37
37
|
* @param {Driver.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class Driver {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos. | (LocationFeature) -> (DriverUpdateRes)
|
|
59
|
+
* Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos (cargo_by_driver). | (LocationFeature) -> (DriverUpdateRes)
|
|
60
60
|
*
|
|
61
61
|
* @param {Chrt.LocationFeature} request
|
|
62
62
|
* @param {Driver.RequestOptions} requestOptions - Request-specific configuration.
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.337.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/Client.mjs
CHANGED
|
@@ -38,8 +38,8 @@ export class ChrtClient {
|
|
|
38
38
|
this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
|
|
39
39
|
"X-Fern-Language": "JavaScript",
|
|
40
40
|
"X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
|
|
41
|
-
"X-Fern-SDK-Version": "1.
|
|
42
|
-
"User-Agent": "@chrt-inc/typescript-sdk/1.
|
|
41
|
+
"X-Fern-SDK-Version": "1.337.0",
|
|
42
|
+
"User-Agent": "@chrt-inc/typescript-sdk/1.337.0",
|
|
43
43
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
44
44
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
45
45
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -86,20 +86,6 @@ export declare class OrderDrafts {
|
|
|
86
86
|
*/
|
|
87
87
|
deleteV1(orderId: string, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
88
88
|
private __deleteV1;
|
|
89
|
-
/**
|
|
90
|
-
* Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
|
|
91
|
-
*
|
|
92
|
-
* @param {string} orderIdOrShortId
|
|
93
|
-
* @param {Chrt.OrderAndTaskGroupExpandedReq} request
|
|
94
|
-
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
95
|
-
*
|
|
96
|
-
* @throws {@link Chrt.UnprocessableEntityError}
|
|
97
|
-
*
|
|
98
|
-
* @example
|
|
99
|
-
* await client.orderDrafts.expandedV1("order_id_or_short_id", {})
|
|
100
|
-
*/
|
|
101
|
-
expandedV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpanded>;
|
|
102
|
-
private __expandedV1;
|
|
103
89
|
/**
|
|
104
90
|
* Checks whether the draft order satisfies all requirements to move into staging. | () -> (bool)
|
|
105
91
|
*
|
|
@@ -229,69 +229,6 @@ export class OrderDrafts {
|
|
|
229
229
|
}
|
|
230
230
|
});
|
|
231
231
|
}
|
|
232
|
-
/**
|
|
233
|
-
* Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
|
|
234
|
-
*
|
|
235
|
-
* @param {string} orderIdOrShortId
|
|
236
|
-
* @param {Chrt.OrderAndTaskGroupExpandedReq} request
|
|
237
|
-
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
238
|
-
*
|
|
239
|
-
* @throws {@link Chrt.UnprocessableEntityError}
|
|
240
|
-
*
|
|
241
|
-
* @example
|
|
242
|
-
* await client.orderDrafts.expandedV1("order_id_or_short_id", {})
|
|
243
|
-
*/
|
|
244
|
-
expandedV1(orderIdOrShortId, request, requestOptions) {
|
|
245
|
-
return core.HttpResponsePromise.fromPromise(this.__expandedV1(orderIdOrShortId, request, requestOptions));
|
|
246
|
-
}
|
|
247
|
-
__expandedV1(orderIdOrShortId, request, requestOptions) {
|
|
248
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
249
|
-
var _a, _b, _c, _d;
|
|
250
|
-
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);
|
|
251
|
-
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
252
|
-
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/order_drafts/expanded/v1/${encodeURIComponent(orderIdOrShortId)}`),
|
|
253
|
-
method: "POST",
|
|
254
|
-
headers: _headers,
|
|
255
|
-
contentType: "application/json",
|
|
256
|
-
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
257
|
-
requestType: "json",
|
|
258
|
-
body: request,
|
|
259
|
-
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
260
|
-
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
261
|
-
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
262
|
-
});
|
|
263
|
-
if (_response.ok) {
|
|
264
|
-
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
265
|
-
}
|
|
266
|
-
if (_response.error.reason === "status-code") {
|
|
267
|
-
switch (_response.error.statusCode) {
|
|
268
|
-
case 422:
|
|
269
|
-
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
270
|
-
default:
|
|
271
|
-
throw new errors.ChrtError({
|
|
272
|
-
statusCode: _response.error.statusCode,
|
|
273
|
-
body: _response.error.body,
|
|
274
|
-
rawResponse: _response.rawResponse,
|
|
275
|
-
});
|
|
276
|
-
}
|
|
277
|
-
}
|
|
278
|
-
switch (_response.error.reason) {
|
|
279
|
-
case "non-json":
|
|
280
|
-
throw new errors.ChrtError({
|
|
281
|
-
statusCode: _response.error.statusCode,
|
|
282
|
-
body: _response.error.rawBody,
|
|
283
|
-
rawResponse: _response.rawResponse,
|
|
284
|
-
});
|
|
285
|
-
case "timeout":
|
|
286
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /oort/order_drafts/expanded/v1/{order_id_or_short_id}.");
|
|
287
|
-
case "unknown":
|
|
288
|
-
throw new errors.ChrtError({
|
|
289
|
-
message: _response.error.errorMessage,
|
|
290
|
-
rawResponse: _response.rawResponse,
|
|
291
|
-
});
|
|
292
|
-
}
|
|
293
|
-
});
|
|
294
|
-
}
|
|
295
232
|
/**
|
|
296
233
|
* Checks whether the draft order satisfies all requirements to move into staging. | () -> (bool)
|
|
297
234
|
*
|
|
@@ -30,6 +30,20 @@ export declare namespace Expanded {
|
|
|
30
30
|
export declare class Expanded {
|
|
31
31
|
protected readonly _options: Expanded.Options;
|
|
32
32
|
constructor(_options?: Expanded.Options);
|
|
33
|
+
/**
|
|
34
|
+
* Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
|
|
35
|
+
*
|
|
36
|
+
* @param {string} orderIdOrShortId
|
|
37
|
+
* @param {Chrt.OrderAndTaskGroupExpandedReq} request
|
|
38
|
+
* @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* await client.orderDrafts.expanded.retrieveV1("order_id_or_short_id", {})
|
|
44
|
+
*/
|
|
45
|
+
retrieveV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpanded>;
|
|
46
|
+
private __retrieveV1;
|
|
33
47
|
/**
|
|
34
48
|
* Lists expanded draft orders for the creator with filtering, sorting, and pagination. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpandedListRes)
|
|
35
49
|
*
|
|
@@ -19,6 +19,69 @@ export class Expanded {
|
|
|
19
19
|
constructor(_options = {}) {
|
|
20
20
|
this._options = _options;
|
|
21
21
|
}
|
|
22
|
+
/**
|
|
23
|
+
* Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
|
|
24
|
+
*
|
|
25
|
+
* @param {string} orderIdOrShortId
|
|
26
|
+
* @param {Chrt.OrderAndTaskGroupExpandedReq} request
|
|
27
|
+
* @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
|
|
28
|
+
*
|
|
29
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* await client.orderDrafts.expanded.retrieveV1("order_id_or_short_id", {})
|
|
33
|
+
*/
|
|
34
|
+
retrieveV1(orderIdOrShortId, request, requestOptions) {
|
|
35
|
+
return core.HttpResponsePromise.fromPromise(this.__retrieveV1(orderIdOrShortId, request, requestOptions));
|
|
36
|
+
}
|
|
37
|
+
__retrieveV1(orderIdOrShortId, request, requestOptions) {
|
|
38
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
39
|
+
var _a, _b, _c, _d;
|
|
40
|
+
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);
|
|
41
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
42
|
+
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/order_drafts/expanded/retrieve/v1/${encodeURIComponent(orderIdOrShortId)}`),
|
|
43
|
+
method: "POST",
|
|
44
|
+
headers: _headers,
|
|
45
|
+
contentType: "application/json",
|
|
46
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
47
|
+
requestType: "json",
|
|
48
|
+
body: request,
|
|
49
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
50
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
51
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
52
|
+
});
|
|
53
|
+
if (_response.ok) {
|
|
54
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
55
|
+
}
|
|
56
|
+
if (_response.error.reason === "status-code") {
|
|
57
|
+
switch (_response.error.statusCode) {
|
|
58
|
+
case 422:
|
|
59
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
60
|
+
default:
|
|
61
|
+
throw new errors.ChrtError({
|
|
62
|
+
statusCode: _response.error.statusCode,
|
|
63
|
+
body: _response.error.body,
|
|
64
|
+
rawResponse: _response.rawResponse,
|
|
65
|
+
});
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
switch (_response.error.reason) {
|
|
69
|
+
case "non-json":
|
|
70
|
+
throw new errors.ChrtError({
|
|
71
|
+
statusCode: _response.error.statusCode,
|
|
72
|
+
body: _response.error.rawBody,
|
|
73
|
+
rawResponse: _response.rawResponse,
|
|
74
|
+
});
|
|
75
|
+
case "timeout":
|
|
76
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /oort/order_drafts/expanded/retrieve/v1/{order_id_or_short_id}.");
|
|
77
|
+
case "unknown":
|
|
78
|
+
throw new errors.ChrtError({
|
|
79
|
+
message: _response.error.errorMessage,
|
|
80
|
+
rawResponse: _response.rawResponse,
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
});
|
|
84
|
+
}
|
|
22
85
|
/**
|
|
23
86
|
* Lists expanded draft orders for the creator with filtering, sorting, and pagination. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpandedListRes)
|
|
24
87
|
*
|
|
@@ -31,7 +31,7 @@ export declare class Driver {
|
|
|
31
31
|
protected readonly _options: Driver.Options;
|
|
32
32
|
constructor(_options?: Driver.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos. | (LocationFeature) -> (DriverUpdateRes)
|
|
34
|
+
* Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos (cargo_by_driver). | (LocationFeature) -> (DriverUpdateRes)
|
|
35
35
|
*
|
|
36
36
|
* @param {Chrt.LocationFeature} request
|
|
37
37
|
* @param {Driver.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -20,7 +20,7 @@ export class Driver {
|
|
|
20
20
|
this._options = _options;
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos. | (LocationFeature) -> (DriverUpdateRes)
|
|
23
|
+
* Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos (cargo_by_driver). | (LocationFeature) -> (DriverUpdateRes)
|
|
24
24
|
*
|
|
25
25
|
* @param {Chrt.LocationFeature} request
|
|
26
26
|
* @param {Driver.RequestOptions} requestOptions - Request-specific configuration.
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.337.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.
|
|
1
|
+
export const SDK_VERSION = "1.337.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -5983,77 +5983,6 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
5983
5983
|
</dl>
|
|
5984
5984
|
</details>
|
|
5985
5985
|
|
|
5986
|
-
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">expandedV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderDraftExpanded</code></summary>
|
|
5987
|
-
<dl>
|
|
5988
|
-
<dd>
|
|
5989
|
-
|
|
5990
|
-
#### 📝 Description
|
|
5991
|
-
|
|
5992
|
-
<dl>
|
|
5993
|
-
<dd>
|
|
5994
|
-
|
|
5995
|
-
<dl>
|
|
5996
|
-
<dd>
|
|
5997
|
-
|
|
5998
|
-
Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
|
|
5999
|
-
|
|
6000
|
-
</dd>
|
|
6001
|
-
</dl>
|
|
6002
|
-
</dd>
|
|
6003
|
-
</dl>
|
|
6004
|
-
|
|
6005
|
-
#### 🔌 Usage
|
|
6006
|
-
|
|
6007
|
-
<dl>
|
|
6008
|
-
<dd>
|
|
6009
|
-
|
|
6010
|
-
<dl>
|
|
6011
|
-
<dd>
|
|
6012
|
-
|
|
6013
|
-
```typescript
|
|
6014
|
-
await client.orderDrafts.expandedV1("order_id_or_short_id", {});
|
|
6015
|
-
```
|
|
6016
|
-
|
|
6017
|
-
</dd>
|
|
6018
|
-
</dl>
|
|
6019
|
-
</dd>
|
|
6020
|
-
</dl>
|
|
6021
|
-
|
|
6022
|
-
#### ⚙️ Parameters
|
|
6023
|
-
|
|
6024
|
-
<dl>
|
|
6025
|
-
<dd>
|
|
6026
|
-
|
|
6027
|
-
<dl>
|
|
6028
|
-
<dd>
|
|
6029
|
-
|
|
6030
|
-
**orderIdOrShortId:** `string`
|
|
6031
|
-
|
|
6032
|
-
</dd>
|
|
6033
|
-
</dl>
|
|
6034
|
-
|
|
6035
|
-
<dl>
|
|
6036
|
-
<dd>
|
|
6037
|
-
|
|
6038
|
-
**request:** `Chrt.OrderAndTaskGroupExpandedReq`
|
|
6039
|
-
|
|
6040
|
-
</dd>
|
|
6041
|
-
</dl>
|
|
6042
|
-
|
|
6043
|
-
<dl>
|
|
6044
|
-
<dd>
|
|
6045
|
-
|
|
6046
|
-
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
6047
|
-
|
|
6048
|
-
</dd>
|
|
6049
|
-
</dl>
|
|
6050
|
-
</dd>
|
|
6051
|
-
</dl>
|
|
6052
|
-
|
|
6053
|
-
</dd>
|
|
6054
|
-
</dl>
|
|
6055
|
-
</details>
|
|
6056
|
-
|
|
6057
5986
|
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">validateV1</a>(orderId) -> boolean</code></summary>
|
|
6058
5987
|
<dl>
|
|
6059
5988
|
<dd>
|
|
@@ -10128,6 +10057,77 @@ await client.orderDrafts.cargo.deleteV1("cargo_id");
|
|
|
10128
10057
|
|
|
10129
10058
|
## OrderDrafts Expanded
|
|
10130
10059
|
|
|
10060
|
+
<details><summary><code>client.orderDrafts.expanded.<a href="/src/api/resources/orderDrafts/resources/expanded/client/Client.ts">retrieveV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderDraftExpanded</code></summary>
|
|
10061
|
+
<dl>
|
|
10062
|
+
<dd>
|
|
10063
|
+
|
|
10064
|
+
#### 📝 Description
|
|
10065
|
+
|
|
10066
|
+
<dl>
|
|
10067
|
+
<dd>
|
|
10068
|
+
|
|
10069
|
+
<dl>
|
|
10070
|
+
<dd>
|
|
10071
|
+
|
|
10072
|
+
Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
|
|
10073
|
+
|
|
10074
|
+
</dd>
|
|
10075
|
+
</dl>
|
|
10076
|
+
</dd>
|
|
10077
|
+
</dl>
|
|
10078
|
+
|
|
10079
|
+
#### 🔌 Usage
|
|
10080
|
+
|
|
10081
|
+
<dl>
|
|
10082
|
+
<dd>
|
|
10083
|
+
|
|
10084
|
+
<dl>
|
|
10085
|
+
<dd>
|
|
10086
|
+
|
|
10087
|
+
```typescript
|
|
10088
|
+
await client.orderDrafts.expanded.retrieveV1("order_id_or_short_id", {});
|
|
10089
|
+
```
|
|
10090
|
+
|
|
10091
|
+
</dd>
|
|
10092
|
+
</dl>
|
|
10093
|
+
</dd>
|
|
10094
|
+
</dl>
|
|
10095
|
+
|
|
10096
|
+
#### ⚙️ Parameters
|
|
10097
|
+
|
|
10098
|
+
<dl>
|
|
10099
|
+
<dd>
|
|
10100
|
+
|
|
10101
|
+
<dl>
|
|
10102
|
+
<dd>
|
|
10103
|
+
|
|
10104
|
+
**orderIdOrShortId:** `string`
|
|
10105
|
+
|
|
10106
|
+
</dd>
|
|
10107
|
+
</dl>
|
|
10108
|
+
|
|
10109
|
+
<dl>
|
|
10110
|
+
<dd>
|
|
10111
|
+
|
|
10112
|
+
**request:** `Chrt.OrderAndTaskGroupExpandedReq`
|
|
10113
|
+
|
|
10114
|
+
</dd>
|
|
10115
|
+
</dl>
|
|
10116
|
+
|
|
10117
|
+
<dl>
|
|
10118
|
+
<dd>
|
|
10119
|
+
|
|
10120
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
10121
|
+
|
|
10122
|
+
</dd>
|
|
10123
|
+
</dl>
|
|
10124
|
+
</dd>
|
|
10125
|
+
</dl>
|
|
10126
|
+
|
|
10127
|
+
</dd>
|
|
10128
|
+
</dl>
|
|
10129
|
+
</details>
|
|
10130
|
+
|
|
10131
10131
|
<details><summary><code>client.orderDrafts.expanded.<a href="/src/api/resources/orderDrafts/resources/expanded/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OrderDraftExpandedListRes</code></summary>
|
|
10132
10132
|
<dl>
|
|
10133
10133
|
<dd>
|
|
@@ -13081,7 +13081,7 @@ await client.tracking.devices.listV1();
|
|
|
13081
13081
|
<dl>
|
|
13082
13082
|
<dd>
|
|
13083
13083
|
|
|
13084
|
-
Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos. | (LocationFeature) -> (DriverUpdateRes)
|
|
13084
|
+
Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos (cargo_by_driver). | (LocationFeature) -> (DriverUpdateRes)
|
|
13085
13085
|
|
|
13086
13086
|
</dd>
|
|
13087
13087
|
</dl>
|