@chrt-inc/typescript-sdk 1.953.0 → 1.959.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/shipping/resources/orders/client/Client.d.ts +4 -1
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.js +14 -9
- package/dist/cjs/api/resources/shipping/resources/orders/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/index.js +3 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/orderEvents/client/Client.d.ts +71 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/orderEvents/client/Client.js +231 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/orderEvents/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/orderEvents/client/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/orderEvents/client/requests/OrderEventsListV1Request.d.ts +36 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/orderEvents/client/requests/OrderEventsListV1Request.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/orderEvents/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/orderEvents/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/orderEvents/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/orderEvents/index.js +17 -0
- package/dist/cjs/api/types/Order1.d.ts +42 -0
- package/dist/cjs/api/types/Order1.js +5 -0
- package/dist/cjs/api/types/OrderEventActionEnum1.d.ts +67 -0
- package/dist/cjs/api/types/OrderEventActionEnum1.js +66 -0
- package/dist/cjs/api/types/OrderEventActor1.d.ts +11 -0
- package/dist/cjs/api/types/OrderEventActor1.js +5 -0
- package/dist/cjs/api/types/OrderEventEntity1.d.ts +16 -0
- package/dist/cjs/api/types/OrderEventEntity1.js +5 -0
- package/dist/cjs/api/types/OrderEventExpanded1.d.ts +16 -0
- package/dist/cjs/api/types/OrderEventExpanded1.js +5 -0
- package/dist/cjs/api/types/OrderEventListRes.d.ts +8 -0
- package/dist/cjs/api/types/OrderEventListRes.js +5 -0
- package/dist/cjs/api/types/OrderEventSortByEnum.d.ts +4 -0
- package/dist/cjs/api/types/OrderEventSortByEnum.js +5 -0
- package/dist/cjs/api/types/OrderEventSystemActorEnum1.d.ts +13 -0
- package/dist/cjs/api/types/OrderEventSystemActorEnum1.js +15 -0
- package/dist/cjs/api/types/index.d.ts +8 -0
- package/dist/cjs/api/types/index.js +8 -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/shipping/resources/orders/client/Client.d.mts +4 -1
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.mjs +6 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/index.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/orderEvents/client/Client.d.mts +71 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/orderEvents/client/Client.mjs +194 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/orderEvents/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/orderEvents/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/orderEvents/client/requests/OrderEventsListV1Request.d.mts +36 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/orderEvents/client/requests/OrderEventsListV1Request.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/orderEvents/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/orderEvents/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/orderEvents/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/orderEvents/index.mjs +1 -0
- package/dist/esm/api/types/Order1.d.mts +42 -0
- package/dist/esm/api/types/Order1.mjs +4 -0
- package/dist/esm/api/types/OrderEventActionEnum1.d.mts +67 -0
- package/dist/esm/api/types/OrderEventActionEnum1.mjs +63 -0
- package/dist/esm/api/types/OrderEventActor1.d.mts +11 -0
- package/dist/esm/api/types/OrderEventActor1.mjs +4 -0
- package/dist/esm/api/types/OrderEventEntity1.d.mts +16 -0
- package/dist/esm/api/types/OrderEventEntity1.mjs +4 -0
- package/dist/esm/api/types/OrderEventExpanded1.d.mts +16 -0
- package/dist/esm/api/types/OrderEventExpanded1.mjs +4 -0
- package/dist/esm/api/types/OrderEventListRes.d.mts +8 -0
- package/dist/esm/api/types/OrderEventListRes.mjs +4 -0
- package/dist/esm/api/types/OrderEventSortByEnum.d.mts +4 -0
- package/dist/esm/api/types/OrderEventSortByEnum.mjs +4 -0
- package/dist/esm/api/types/OrderEventSystemActorEnum1.d.mts +13 -0
- package/dist/esm/api/types/OrderEventSystemActorEnum1.mjs +12 -0
- package/dist/esm/api/types/index.d.mts +8 -0
- package/dist/esm/api/types/index.mjs +8 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +147 -1
package/dist/esm/api/resources/shipping/resources/orders/resources/orderEvents/client/Client.mjs
ADDED
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
5
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
6
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
7
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
8
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
9
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
10
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
11
|
+
});
|
|
12
|
+
};
|
|
13
|
+
import * as environments from "../../../../../../../../environments.mjs";
|
|
14
|
+
import * as core from "../../../../../../../../core/index.mjs";
|
|
15
|
+
import * as Chrt from "../../../../../../../index.mjs";
|
|
16
|
+
import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../../../core/headers.mjs";
|
|
17
|
+
import * as errors from "../../../../../../../../errors/index.mjs";
|
|
18
|
+
export class OrderEvents {
|
|
19
|
+
constructor(_options = {}) {
|
|
20
|
+
this._options = _options;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Lists event log entries for an order with organization and user public data hydrated, filtering, sorting, and pagination. | authz: min_org_role=administrator | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (OrderEventListRes)
|
|
24
|
+
*
|
|
25
|
+
* @param {string} orderId
|
|
26
|
+
* @param {Chrt.shipping.orders.OrderEventsListV1Request} request
|
|
27
|
+
* @param {OrderEvents.RequestOptions} requestOptions - Request-specific configuration.
|
|
28
|
+
*
|
|
29
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* await client.shipping.orders.orderEvents.listV1("order_id", {
|
|
33
|
+
* sort_by: "timestamp",
|
|
34
|
+
* sort_order: "asc",
|
|
35
|
+
* page: 1,
|
|
36
|
+
* page_size: 1,
|
|
37
|
+
* filter_action: ["shipping.order.draft_started"],
|
|
38
|
+
* filter_user_id: "filter_user_id",
|
|
39
|
+
* filter_org_id: "filter_org_id",
|
|
40
|
+
* filter_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
41
|
+
* filter_timestamp_lte: "2024-01-15T09:30:00Z"
|
|
42
|
+
* })
|
|
43
|
+
*/
|
|
44
|
+
listV1(orderId, request = {}, requestOptions) {
|
|
45
|
+
return core.HttpResponsePromise.fromPromise(this.__listV1(orderId, request, requestOptions));
|
|
46
|
+
}
|
|
47
|
+
__listV1(orderId_1) {
|
|
48
|
+
return __awaiter(this, arguments, void 0, function* (orderId, request = {}, requestOptions) {
|
|
49
|
+
var _a, _b, _c, _d, _e, _f;
|
|
50
|
+
const { sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, filter_action: filterAction, filter_user_id: filterUserId, filter_org_id: filterOrgId, filter_timestamp_gte: filterTimestampGte, filter_timestamp_lte: filterTimestampLte, } = request;
|
|
51
|
+
const _queryParams = {};
|
|
52
|
+
if (sortBy !== undefined) {
|
|
53
|
+
_queryParams["sort_by"] = sortBy;
|
|
54
|
+
}
|
|
55
|
+
if (sortOrder !== undefined) {
|
|
56
|
+
_queryParams["sort_order"] = sortOrder;
|
|
57
|
+
}
|
|
58
|
+
if (page !== undefined) {
|
|
59
|
+
_queryParams["page"] = (_a = page === null || page === void 0 ? void 0 : page.toString()) !== null && _a !== void 0 ? _a : null;
|
|
60
|
+
}
|
|
61
|
+
if (pageSize !== undefined) {
|
|
62
|
+
_queryParams["page_size"] = (_b = pageSize === null || pageSize === void 0 ? void 0 : pageSize.toString()) !== null && _b !== void 0 ? _b : null;
|
|
63
|
+
}
|
|
64
|
+
if (filterAction !== undefined) {
|
|
65
|
+
if (Array.isArray(filterAction)) {
|
|
66
|
+
_queryParams["filter_action"] = filterAction.map((item) => item);
|
|
67
|
+
}
|
|
68
|
+
else {
|
|
69
|
+
_queryParams["filter_action"] = filterAction;
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
if (filterUserId !== undefined) {
|
|
73
|
+
_queryParams["filter_user_id"] = filterUserId;
|
|
74
|
+
}
|
|
75
|
+
if (filterOrgId !== undefined) {
|
|
76
|
+
_queryParams["filter_org_id"] = filterOrgId;
|
|
77
|
+
}
|
|
78
|
+
if (filterTimestampGte !== undefined) {
|
|
79
|
+
_queryParams["filter_timestamp_gte"] = filterTimestampGte;
|
|
80
|
+
}
|
|
81
|
+
if (filterTimestampLte !== undefined) {
|
|
82
|
+
_queryParams["filter_timestamp_lte"] = filterTimestampLte;
|
|
83
|
+
}
|
|
84
|
+
let _headers = mergeHeaders((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
85
|
+
const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
|
|
86
|
+
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, `shipping/orders/order_events/list/v1/${encodeURIComponent(orderId)}`),
|
|
87
|
+
method: "GET",
|
|
88
|
+
headers: _headers,
|
|
89
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
90
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
91
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
92
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
93
|
+
});
|
|
94
|
+
if (_response.ok) {
|
|
95
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
96
|
+
}
|
|
97
|
+
if (_response.error.reason === "status-code") {
|
|
98
|
+
switch (_response.error.statusCode) {
|
|
99
|
+
case 422:
|
|
100
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
101
|
+
default:
|
|
102
|
+
throw new errors.ChrtError({
|
|
103
|
+
statusCode: _response.error.statusCode,
|
|
104
|
+
body: _response.error.body,
|
|
105
|
+
rawResponse: _response.rawResponse,
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
switch (_response.error.reason) {
|
|
110
|
+
case "non-json":
|
|
111
|
+
throw new errors.ChrtError({
|
|
112
|
+
statusCode: _response.error.statusCode,
|
|
113
|
+
body: _response.error.rawBody,
|
|
114
|
+
rawResponse: _response.rawResponse,
|
|
115
|
+
});
|
|
116
|
+
case "timeout":
|
|
117
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/orders/order_events/list/v1/{order_id}.");
|
|
118
|
+
case "unknown":
|
|
119
|
+
throw new errors.ChrtError({
|
|
120
|
+
message: _response.error.errorMessage,
|
|
121
|
+
rawResponse: _response.rawResponse,
|
|
122
|
+
});
|
|
123
|
+
}
|
|
124
|
+
});
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Retrieves a single order event log entry by its ID with organization and user public data hydrated. | authz: min_org_role=administrator | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (OrderEventExpanded1)
|
|
128
|
+
*
|
|
129
|
+
* @param {string} orderEventId
|
|
130
|
+
* @param {OrderEvents.RequestOptions} requestOptions - Request-specific configuration.
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
133
|
+
*
|
|
134
|
+
* @example
|
|
135
|
+
* await client.shipping.orders.orderEvents.getV1("order_event_id")
|
|
136
|
+
*/
|
|
137
|
+
getV1(orderEventId, requestOptions) {
|
|
138
|
+
return core.HttpResponsePromise.fromPromise(this.__getV1(orderEventId, requestOptions));
|
|
139
|
+
}
|
|
140
|
+
__getV1(orderEventId, requestOptions) {
|
|
141
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
142
|
+
var _a, _b, _c, _d;
|
|
143
|
+
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);
|
|
144
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
145
|
+
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, `shipping/orders/order_events/v1/${encodeURIComponent(orderEventId)}`),
|
|
146
|
+
method: "GET",
|
|
147
|
+
headers: _headers,
|
|
148
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
149
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
150
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
151
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
152
|
+
});
|
|
153
|
+
if (_response.ok) {
|
|
154
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
155
|
+
}
|
|
156
|
+
if (_response.error.reason === "status-code") {
|
|
157
|
+
switch (_response.error.statusCode) {
|
|
158
|
+
case 422:
|
|
159
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
160
|
+
default:
|
|
161
|
+
throw new errors.ChrtError({
|
|
162
|
+
statusCode: _response.error.statusCode,
|
|
163
|
+
body: _response.error.body,
|
|
164
|
+
rawResponse: _response.rawResponse,
|
|
165
|
+
});
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
switch (_response.error.reason) {
|
|
169
|
+
case "non-json":
|
|
170
|
+
throw new errors.ChrtError({
|
|
171
|
+
statusCode: _response.error.statusCode,
|
|
172
|
+
body: _response.error.rawBody,
|
|
173
|
+
rawResponse: _response.rawResponse,
|
|
174
|
+
});
|
|
175
|
+
case "timeout":
|
|
176
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/orders/order_events/v1/{order_event_id}.");
|
|
177
|
+
case "unknown":
|
|
178
|
+
throw new errors.ChrtError({
|
|
179
|
+
message: _response.error.errorMessage,
|
|
180
|
+
rawResponse: _response.rawResponse,
|
|
181
|
+
});
|
|
182
|
+
}
|
|
183
|
+
});
|
|
184
|
+
}
|
|
185
|
+
_getAuthorizationHeader() {
|
|
186
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
187
|
+
const bearer = yield core.Supplier.get(this._options.token);
|
|
188
|
+
if (bearer != null) {
|
|
189
|
+
return `Bearer ${bearer}`;
|
|
190
|
+
}
|
|
191
|
+
return undefined;
|
|
192
|
+
});
|
|
193
|
+
}
|
|
194
|
+
}
|
package/dist/esm/api/resources/shipping/resources/orders/resources/orderEvents/client/index.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./requests/index.mjs";
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../../../../../../../../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* {
|
|
8
|
+
* sort_by: "timestamp",
|
|
9
|
+
* sort_order: "asc",
|
|
10
|
+
* page: 1,
|
|
11
|
+
* page_size: 1,
|
|
12
|
+
* filter_action: ["shipping.order.draft_started"],
|
|
13
|
+
* filter_user_id: "filter_user_id",
|
|
14
|
+
* filter_org_id: "filter_org_id",
|
|
15
|
+
* filter_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16
|
+
* filter_timestamp_lte: "2024-01-15T09:30:00Z"
|
|
17
|
+
* }
|
|
18
|
+
*/
|
|
19
|
+
export interface OrderEventsListV1Request {
|
|
20
|
+
/** Field to sort by */
|
|
21
|
+
sort_by?: Chrt.OrderEventSortByEnum | null;
|
|
22
|
+
/** Sort order (asc or desc) */
|
|
23
|
+
sort_order?: Chrt.SortOrderEnum | null;
|
|
24
|
+
page?: number | null;
|
|
25
|
+
page_size?: number | null;
|
|
26
|
+
/** Filter by order event action(s) */
|
|
27
|
+
filter_action?: (Chrt.OrderEventActionEnum1 | null) | (Chrt.OrderEventActionEnum1 | null)[];
|
|
28
|
+
/** Filter by actor user ID */
|
|
29
|
+
filter_user_id?: string | null;
|
|
30
|
+
/** Filter by actor org ID */
|
|
31
|
+
filter_org_id?: string | null;
|
|
32
|
+
/** Filter timestamp >= value */
|
|
33
|
+
filter_timestamp_gte?: string | null;
|
|
34
|
+
/** Filter timestamp <= value */
|
|
35
|
+
filter_timestamp_lte?: string | null;
|
|
36
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { type OrderEventsListV1Request } from "./OrderEventsListV1Request.mjs";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./client/index.mjs";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./client/index.mjs";
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../index.mjs";
|
|
5
|
+
export interface Order1 {
|
|
6
|
+
_id: string;
|
|
7
|
+
awb_numbers?: string[];
|
|
8
|
+
cancelled_at_timestamp?: string | null;
|
|
9
|
+
completed_at_timestamp?: string | null;
|
|
10
|
+
coordinator_assigned_user_ids?: string[];
|
|
11
|
+
coordinator_department_id?: string | null;
|
|
12
|
+
coordinator_label?: string | null;
|
|
13
|
+
/** Must be a string starting with `org_` */
|
|
14
|
+
coordinator_org_id?: string | null;
|
|
15
|
+
coordinator_shipper_account_ids?: string[];
|
|
16
|
+
coordinator_task_lists_to_apply_at_order_staging?: Chrt.TaskListToApplyToOrder1[];
|
|
17
|
+
/** Must be a string starting with `org_` */
|
|
18
|
+
created_by_org_id: string;
|
|
19
|
+
/** Must be a string starting with `user_` */
|
|
20
|
+
created_by_user_id: string;
|
|
21
|
+
/** Client-supplied key for idempotent draft creation */
|
|
22
|
+
creation_idempotency_key?: string | null;
|
|
23
|
+
draft_started_at_timestamp: string;
|
|
24
|
+
exception_at_timestamp?: string | null;
|
|
25
|
+
in_progress_at_timestamp?: string | null;
|
|
26
|
+
invoice_ids?: string[];
|
|
27
|
+
/** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
|
|
28
|
+
off_chrt_reference_id?: string | null;
|
|
29
|
+
off_chrt_shipper_org_data_id?: string | null;
|
|
30
|
+
order_classification_by_task_group_type?: Chrt.TaskGroupTypeEnum1 | null;
|
|
31
|
+
order_schedule_id?: string | null;
|
|
32
|
+
order_schedule_run_idempotency_key?: string | null;
|
|
33
|
+
order_template_new_id?: string | null;
|
|
34
|
+
schema_version: number;
|
|
35
|
+
service_line?: Chrt.ServiceLineEnum;
|
|
36
|
+
/** Must be a string starting with `org_` */
|
|
37
|
+
shipper_org_id?: string | null;
|
|
38
|
+
short_id: string;
|
|
39
|
+
staged_at_timestamp?: string | null;
|
|
40
|
+
status?: Chrt.OrderStatusEnum1;
|
|
41
|
+
task_group_details?: Chrt.OrderTaskGroupExecutorDetails1[];
|
|
42
|
+
}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Canonical vocabulary for shipping order-event and notification actions.
|
|
6
|
+
*/
|
|
7
|
+
export type OrderEventActionEnum1 = "shipping.order.draft_started" | "shipping.order.staged" | "shipping.order.in_progress" | "shipping.order.completed" | "shipping.order.cancelled" | "shipping.order.exception" | "shipping.order.updated" | "shipping.order.deleted" | "shipping.task_group.added" | "shipping.task_group.staged" | "shipping.task_group.provider_assigned" | "shipping.task_group.driver_assigned" | "shipping.task_group.driver_unassigned" | "shipping.task_group.in_progress" | "shipping.task_group.completed" | "shipping.task_group.skipped" | "shipping.task_group.cancelled" | "shipping.task_group.exception" | "shipping.task_group.message" | "shipping.task_group.file_added" | "shipping.task_group.tasks_ordering_updated" | "shipping.task_group.flight_info_updated" | "shipping.task_group.vehicle_type_updated" | "shipping.task_group.ordering_updated" | "shipping.task_group.deleted" | "shipping.task.added" | "shipping.task.staged" | "shipping.task.attempted" | "shipping.task.completed" | "shipping.task.skipped" | "shipping.task.cancelled" | "shipping.task.exception" | "shipping.task.wait_time_started" | "shipping.task.wait_time_ended" | "shipping.task.wait_time_validated" | "shipping.task.task_artifact_completed" | "shipping.task.executor_org_note_added" | "shipping.task.updated" | "shipping.task.deleted" | "shipping.cargo.added" | "shipping.cargo.staged" | "shipping.cargo.in_transit" | "shipping.cargo.delivered" | "shipping.cargo.skipped" | "shipping.cargo.cancelled" | "shipping.cargo.exception" | "shipping.cargo.device_linked" | "shipping.cargo.device_unlinked" | "shipping.cargo.updated" | "shipping.cargo.deleted" | "shipping.task_artifact.added" | "shipping.task_artifact.completed" | "shipping.task_artifact.file_added" | "shipping.task_artifact.deleted" | "shipping.account.associated" | "shipping.account.removed" | "shipping.contact.associated" | "shipping.contact.removed";
|
|
8
|
+
export declare const OrderEventActionEnum1: {
|
|
9
|
+
readonly ShippingOrderDraftStarted: "shipping.order.draft_started";
|
|
10
|
+
readonly ShippingOrderStaged: "shipping.order.staged";
|
|
11
|
+
readonly ShippingOrderInProgress: "shipping.order.in_progress";
|
|
12
|
+
readonly ShippingOrderCompleted: "shipping.order.completed";
|
|
13
|
+
readonly ShippingOrderCancelled: "shipping.order.cancelled";
|
|
14
|
+
readonly ShippingOrderException: "shipping.order.exception";
|
|
15
|
+
readonly ShippingOrderUpdated: "shipping.order.updated";
|
|
16
|
+
readonly ShippingOrderDeleted: "shipping.order.deleted";
|
|
17
|
+
readonly ShippingTaskGroupAdded: "shipping.task_group.added";
|
|
18
|
+
readonly ShippingTaskGroupStaged: "shipping.task_group.staged";
|
|
19
|
+
readonly ShippingTaskGroupProviderAssigned: "shipping.task_group.provider_assigned";
|
|
20
|
+
readonly ShippingTaskGroupDriverAssigned: "shipping.task_group.driver_assigned";
|
|
21
|
+
readonly ShippingTaskGroupDriverUnassigned: "shipping.task_group.driver_unassigned";
|
|
22
|
+
readonly ShippingTaskGroupInProgress: "shipping.task_group.in_progress";
|
|
23
|
+
readonly ShippingTaskGroupCompleted: "shipping.task_group.completed";
|
|
24
|
+
readonly ShippingTaskGroupSkipped: "shipping.task_group.skipped";
|
|
25
|
+
readonly ShippingTaskGroupCancelled: "shipping.task_group.cancelled";
|
|
26
|
+
readonly ShippingTaskGroupException: "shipping.task_group.exception";
|
|
27
|
+
readonly ShippingTaskGroupMessage: "shipping.task_group.message";
|
|
28
|
+
readonly ShippingTaskGroupFileAdded: "shipping.task_group.file_added";
|
|
29
|
+
readonly ShippingTaskGroupTasksOrderingUpdated: "shipping.task_group.tasks_ordering_updated";
|
|
30
|
+
readonly ShippingTaskGroupFlightInfoUpdated: "shipping.task_group.flight_info_updated";
|
|
31
|
+
readonly ShippingTaskGroupVehicleTypeUpdated: "shipping.task_group.vehicle_type_updated";
|
|
32
|
+
readonly ShippingTaskGroupOrderingUpdated: "shipping.task_group.ordering_updated";
|
|
33
|
+
readonly ShippingTaskGroupDeleted: "shipping.task_group.deleted";
|
|
34
|
+
readonly ShippingTaskAdded: "shipping.task.added";
|
|
35
|
+
readonly ShippingTaskStaged: "shipping.task.staged";
|
|
36
|
+
readonly ShippingTaskAttempted: "shipping.task.attempted";
|
|
37
|
+
readonly ShippingTaskCompleted: "shipping.task.completed";
|
|
38
|
+
readonly ShippingTaskSkipped: "shipping.task.skipped";
|
|
39
|
+
readonly ShippingTaskCancelled: "shipping.task.cancelled";
|
|
40
|
+
readonly ShippingTaskException: "shipping.task.exception";
|
|
41
|
+
readonly ShippingTaskWaitTimeStarted: "shipping.task.wait_time_started";
|
|
42
|
+
readonly ShippingTaskWaitTimeEnded: "shipping.task.wait_time_ended";
|
|
43
|
+
readonly ShippingTaskWaitTimeValidated: "shipping.task.wait_time_validated";
|
|
44
|
+
readonly ShippingTaskTaskArtifactCompleted: "shipping.task.task_artifact_completed";
|
|
45
|
+
readonly ShippingTaskExecutorOrgNoteAdded: "shipping.task.executor_org_note_added";
|
|
46
|
+
readonly ShippingTaskUpdated: "shipping.task.updated";
|
|
47
|
+
readonly ShippingTaskDeleted: "shipping.task.deleted";
|
|
48
|
+
readonly ShippingCargoAdded: "shipping.cargo.added";
|
|
49
|
+
readonly ShippingCargoStaged: "shipping.cargo.staged";
|
|
50
|
+
readonly ShippingCargoInTransit: "shipping.cargo.in_transit";
|
|
51
|
+
readonly ShippingCargoDelivered: "shipping.cargo.delivered";
|
|
52
|
+
readonly ShippingCargoSkipped: "shipping.cargo.skipped";
|
|
53
|
+
readonly ShippingCargoCancelled: "shipping.cargo.cancelled";
|
|
54
|
+
readonly ShippingCargoException: "shipping.cargo.exception";
|
|
55
|
+
readonly ShippingCargoDeviceLinked: "shipping.cargo.device_linked";
|
|
56
|
+
readonly ShippingCargoDeviceUnlinked: "shipping.cargo.device_unlinked";
|
|
57
|
+
readonly ShippingCargoUpdated: "shipping.cargo.updated";
|
|
58
|
+
readonly ShippingCargoDeleted: "shipping.cargo.deleted";
|
|
59
|
+
readonly ShippingTaskArtifactAdded: "shipping.task_artifact.added";
|
|
60
|
+
readonly ShippingTaskArtifactCompleted: "shipping.task_artifact.completed";
|
|
61
|
+
readonly ShippingTaskArtifactFileAdded: "shipping.task_artifact.file_added";
|
|
62
|
+
readonly ShippingTaskArtifactDeleted: "shipping.task_artifact.deleted";
|
|
63
|
+
readonly ShippingAccountAssociated: "shipping.account.associated";
|
|
64
|
+
readonly ShippingAccountRemoved: "shipping.account.removed";
|
|
65
|
+
readonly ShippingContactAssociated: "shipping.contact.associated";
|
|
66
|
+
readonly ShippingContactRemoved: "shipping.contact.removed";
|
|
67
|
+
};
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export const OrderEventActionEnum1 = {
|
|
5
|
+
ShippingOrderDraftStarted: "shipping.order.draft_started",
|
|
6
|
+
ShippingOrderStaged: "shipping.order.staged",
|
|
7
|
+
ShippingOrderInProgress: "shipping.order.in_progress",
|
|
8
|
+
ShippingOrderCompleted: "shipping.order.completed",
|
|
9
|
+
ShippingOrderCancelled: "shipping.order.cancelled",
|
|
10
|
+
ShippingOrderException: "shipping.order.exception",
|
|
11
|
+
ShippingOrderUpdated: "shipping.order.updated",
|
|
12
|
+
ShippingOrderDeleted: "shipping.order.deleted",
|
|
13
|
+
ShippingTaskGroupAdded: "shipping.task_group.added",
|
|
14
|
+
ShippingTaskGroupStaged: "shipping.task_group.staged",
|
|
15
|
+
ShippingTaskGroupProviderAssigned: "shipping.task_group.provider_assigned",
|
|
16
|
+
ShippingTaskGroupDriverAssigned: "shipping.task_group.driver_assigned",
|
|
17
|
+
ShippingTaskGroupDriverUnassigned: "shipping.task_group.driver_unassigned",
|
|
18
|
+
ShippingTaskGroupInProgress: "shipping.task_group.in_progress",
|
|
19
|
+
ShippingTaskGroupCompleted: "shipping.task_group.completed",
|
|
20
|
+
ShippingTaskGroupSkipped: "shipping.task_group.skipped",
|
|
21
|
+
ShippingTaskGroupCancelled: "shipping.task_group.cancelled",
|
|
22
|
+
ShippingTaskGroupException: "shipping.task_group.exception",
|
|
23
|
+
ShippingTaskGroupMessage: "shipping.task_group.message",
|
|
24
|
+
ShippingTaskGroupFileAdded: "shipping.task_group.file_added",
|
|
25
|
+
ShippingTaskGroupTasksOrderingUpdated: "shipping.task_group.tasks_ordering_updated",
|
|
26
|
+
ShippingTaskGroupFlightInfoUpdated: "shipping.task_group.flight_info_updated",
|
|
27
|
+
ShippingTaskGroupVehicleTypeUpdated: "shipping.task_group.vehicle_type_updated",
|
|
28
|
+
ShippingTaskGroupOrderingUpdated: "shipping.task_group.ordering_updated",
|
|
29
|
+
ShippingTaskGroupDeleted: "shipping.task_group.deleted",
|
|
30
|
+
ShippingTaskAdded: "shipping.task.added",
|
|
31
|
+
ShippingTaskStaged: "shipping.task.staged",
|
|
32
|
+
ShippingTaskAttempted: "shipping.task.attempted",
|
|
33
|
+
ShippingTaskCompleted: "shipping.task.completed",
|
|
34
|
+
ShippingTaskSkipped: "shipping.task.skipped",
|
|
35
|
+
ShippingTaskCancelled: "shipping.task.cancelled",
|
|
36
|
+
ShippingTaskException: "shipping.task.exception",
|
|
37
|
+
ShippingTaskWaitTimeStarted: "shipping.task.wait_time_started",
|
|
38
|
+
ShippingTaskWaitTimeEnded: "shipping.task.wait_time_ended",
|
|
39
|
+
ShippingTaskWaitTimeValidated: "shipping.task.wait_time_validated",
|
|
40
|
+
ShippingTaskTaskArtifactCompleted: "shipping.task.task_artifact_completed",
|
|
41
|
+
ShippingTaskExecutorOrgNoteAdded: "shipping.task.executor_org_note_added",
|
|
42
|
+
ShippingTaskUpdated: "shipping.task.updated",
|
|
43
|
+
ShippingTaskDeleted: "shipping.task.deleted",
|
|
44
|
+
ShippingCargoAdded: "shipping.cargo.added",
|
|
45
|
+
ShippingCargoStaged: "shipping.cargo.staged",
|
|
46
|
+
ShippingCargoInTransit: "shipping.cargo.in_transit",
|
|
47
|
+
ShippingCargoDelivered: "shipping.cargo.delivered",
|
|
48
|
+
ShippingCargoSkipped: "shipping.cargo.skipped",
|
|
49
|
+
ShippingCargoCancelled: "shipping.cargo.cancelled",
|
|
50
|
+
ShippingCargoException: "shipping.cargo.exception",
|
|
51
|
+
ShippingCargoDeviceLinked: "shipping.cargo.device_linked",
|
|
52
|
+
ShippingCargoDeviceUnlinked: "shipping.cargo.device_unlinked",
|
|
53
|
+
ShippingCargoUpdated: "shipping.cargo.updated",
|
|
54
|
+
ShippingCargoDeleted: "shipping.cargo.deleted",
|
|
55
|
+
ShippingTaskArtifactAdded: "shipping.task_artifact.added",
|
|
56
|
+
ShippingTaskArtifactCompleted: "shipping.task_artifact.completed",
|
|
57
|
+
ShippingTaskArtifactFileAdded: "shipping.task_artifact.file_added",
|
|
58
|
+
ShippingTaskArtifactDeleted: "shipping.task_artifact.deleted",
|
|
59
|
+
ShippingAccountAssociated: "shipping.account.associated",
|
|
60
|
+
ShippingAccountRemoved: "shipping.account.removed",
|
|
61
|
+
ShippingContactAssociated: "shipping.contact.associated",
|
|
62
|
+
ShippingContactRemoved: "shipping.contact.removed",
|
|
63
|
+
};
|
|
@@ -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
|
+
export interface OrderEventActor1 {
|
|
6
|
+
/** Must be a string starting with `org_` */
|
|
7
|
+
org_id?: string | null;
|
|
8
|
+
system?: Chrt.OrderEventSystemActorEnum1 | null;
|
|
9
|
+
/** Must be a string starting with `user_` */
|
|
10
|
+
user_id?: string | null;
|
|
11
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../index.mjs";
|
|
5
|
+
export interface OrderEventEntity1 {
|
|
6
|
+
account?: Chrt.Account1 | null;
|
|
7
|
+
cargo?: Chrt.Cargo1 | null;
|
|
8
|
+
contact?: Chrt.Contact1 | null;
|
|
9
|
+
modification?: Record<string, unknown> | null;
|
|
10
|
+
order?: Chrt.Order1 | null;
|
|
11
|
+
task?: Chrt.Task1 | null;
|
|
12
|
+
task_artifact?: Chrt.TaskArtifact1 | null;
|
|
13
|
+
task_artifact_s3_object_metadata?: Chrt.TaskArtifactS3ObjectMetadata1 | null;
|
|
14
|
+
task_group?: Chrt.TaskGroup1 | null;
|
|
15
|
+
task_group_s3_object_metadata?: Chrt.TaskGroupS3ObjectMetadata1 | null;
|
|
16
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../index.mjs";
|
|
5
|
+
export interface OrderEventExpanded1 {
|
|
6
|
+
_id: string;
|
|
7
|
+
action: Chrt.OrderEventActionEnum1;
|
|
8
|
+
actor: Chrt.OrderEventActor1;
|
|
9
|
+
entities?: Chrt.OrderEventEntity1[];
|
|
10
|
+
order_id: string;
|
|
11
|
+
order_short_id?: string | null;
|
|
12
|
+
org_public_data?: Chrt.OrgPublicData1 | null;
|
|
13
|
+
schema_version: number;
|
|
14
|
+
timestamp: string;
|
|
15
|
+
user_public_data?: Chrt.UserPublicData1 | null;
|
|
16
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export type OrderEventSystemActorEnum1 = "shipping_state_sync" | "temporal_workflow" | "shipping_integration_sync" | "flight_tracker" | "geofence_tracker" | "order_schedule" | "system_automation";
|
|
5
|
+
export declare const OrderEventSystemActorEnum1: {
|
|
6
|
+
readonly ShippingStateSync: "shipping_state_sync";
|
|
7
|
+
readonly TemporalWorkflow: "temporal_workflow";
|
|
8
|
+
readonly ShippingIntegrationSync: "shipping_integration_sync";
|
|
9
|
+
readonly FlightTracker: "flight_tracker";
|
|
10
|
+
readonly GeofenceTracker: "geofence_tracker";
|
|
11
|
+
readonly OrderSchedule: "order_schedule";
|
|
12
|
+
readonly SystemAutomation: "system_automation";
|
|
13
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export const OrderEventSystemActorEnum1 = {
|
|
5
|
+
ShippingStateSync: "shipping_state_sync",
|
|
6
|
+
TemporalWorkflow: "temporal_workflow",
|
|
7
|
+
ShippingIntegrationSync: "shipping_integration_sync",
|
|
8
|
+
FlightTracker: "flight_tracker",
|
|
9
|
+
GeofenceTracker: "geofence_tracker",
|
|
10
|
+
OrderSchedule: "order_schedule",
|
|
11
|
+
SystemAutomation: "system_automation",
|
|
12
|
+
};
|
|
@@ -350,6 +350,7 @@ export * from "./OperationsTaskStatusEnum.mjs";
|
|
|
350
350
|
export * from "./OperationsTaskTypeEnum.mjs";
|
|
351
351
|
export * from "./OperationsTasksDeadlineTimestampsUpdateRes1.mjs";
|
|
352
352
|
export * from "./OperationsTasksStatusUpdateRes1.mjs";
|
|
353
|
+
export * from "./Order1.mjs";
|
|
353
354
|
export * from "./OrderAndTaskGroupExpandedReq.mjs";
|
|
354
355
|
export * from "./OrderAwbBillingAccount1.mjs";
|
|
355
356
|
export * from "./OrderAwbBillingListItem1.mjs";
|
|
@@ -364,6 +365,13 @@ export * from "./OrderBillingShipper1.mjs";
|
|
|
364
365
|
export * from "./OrderBillingSortByEnum.mjs";
|
|
365
366
|
export * from "./OrderDraftValidationRequirements.mjs";
|
|
366
367
|
export * from "./OrderDraftValidationResult.mjs";
|
|
368
|
+
export * from "./OrderEventActionEnum1.mjs";
|
|
369
|
+
export * from "./OrderEventActor1.mjs";
|
|
370
|
+
export * from "./OrderEventEntity1.mjs";
|
|
371
|
+
export * from "./OrderEventExpanded1.mjs";
|
|
372
|
+
export * from "./OrderEventListRes.mjs";
|
|
373
|
+
export * from "./OrderEventSortByEnum.mjs";
|
|
374
|
+
export * from "./OrderEventSystemActorEnum1.mjs";
|
|
367
375
|
export * from "./OrderExpandedForProvider.mjs";
|
|
368
376
|
export * from "./OrderExpandedForShipper.mjs";
|
|
369
377
|
export * from "./OrderInformationConversationRes.mjs";
|
|
@@ -350,6 +350,7 @@ export * from "./OperationsTaskStatusEnum.mjs";
|
|
|
350
350
|
export * from "./OperationsTaskTypeEnum.mjs";
|
|
351
351
|
export * from "./OperationsTasksDeadlineTimestampsUpdateRes1.mjs";
|
|
352
352
|
export * from "./OperationsTasksStatusUpdateRes1.mjs";
|
|
353
|
+
export * from "./Order1.mjs";
|
|
353
354
|
export * from "./OrderAndTaskGroupExpandedReq.mjs";
|
|
354
355
|
export * from "./OrderAwbBillingAccount1.mjs";
|
|
355
356
|
export * from "./OrderAwbBillingListItem1.mjs";
|
|
@@ -364,6 +365,13 @@ export * from "./OrderBillingShipper1.mjs";
|
|
|
364
365
|
export * from "./OrderBillingSortByEnum.mjs";
|
|
365
366
|
export * from "./OrderDraftValidationRequirements.mjs";
|
|
366
367
|
export * from "./OrderDraftValidationResult.mjs";
|
|
368
|
+
export * from "./OrderEventActionEnum1.mjs";
|
|
369
|
+
export * from "./OrderEventActor1.mjs";
|
|
370
|
+
export * from "./OrderEventEntity1.mjs";
|
|
371
|
+
export * from "./OrderEventExpanded1.mjs";
|
|
372
|
+
export * from "./OrderEventListRes.mjs";
|
|
373
|
+
export * from "./OrderEventSortByEnum.mjs";
|
|
374
|
+
export * from "./OrderEventSystemActorEnum1.mjs";
|
|
367
375
|
export * from "./OrderExpandedForProvider.mjs";
|
|
368
376
|
export * from "./OrderExpandedForShipper.mjs";
|
|
369
377
|
export * from "./OrderInformationConversationRes.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.959.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.
|
|
1
|
+
export const SDK_VERSION = "1.959.0";
|