@chrt-inc/typescript-sdk 1.944.0 → 1.953.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/flights/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/flights/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/client/Client.js +5 -1
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/client/requests/OrderTemplatesNewListV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/shippingIntegrations/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/shippingIntegrations/client/Client.js +19 -14
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.d.ts +3 -19
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.js +7 -78
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/Client.js +7 -7
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/Client.js +7 -7
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.js +7 -7
- package/dist/cjs/api/resources/shippingIntegrations/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/index.js +2 -1
- package/dist/cjs/api/resources/shippingIntegrations/resources/integrationExecutors/client/Client.d.ts +44 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/integrationExecutors/client/Client.js +121 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/integrationExecutors/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/integrationExecutors/client/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/integrationExecutors/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/integrationExecutors/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.js +7 -7
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/Client.d.ts +35 -2
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/Client.js +152 -4
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersListForIntegrationExecutorOperatorsV1Request.d.ts +54 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersListV1Request.d.ts +6 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersStatusSummaryV1Request.d.ts +6 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.d.ts +3 -19
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.js +7 -78
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.js +1 -1
- package/dist/cjs/api/types/ShippingIntegrationIntegrationExecutor.d.ts +17 -0
- package/dist/cjs/api/types/ShippingIntegrationIntegrationExecutorListRes.d.ts +8 -0
- package/dist/cjs/api/types/ShippingIntegrationIntegrationExecutorListRes.js +5 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderCompletedAtProvenanceEnum1.d.ts +8 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderCompletedAtProvenanceEnum1.js +10 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderExpanded1.d.ts +3 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderSortByEnum.d.ts +2 -1
- package/dist/cjs/api/types/ShippingIntegrationOrderSortByEnum.js +1 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderTypeaheadFieldEnum.d.ts +5 -1
- package/dist/cjs/api/types/ShippingIntegrationOrderTypeaheadFieldEnum.js +5 -0
- package/dist/cjs/api/types/index.d.ts +3 -0
- package/dist/cjs/api/types/index.js +3 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/shipping/resources/flights/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/flights/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/client/Client.mjs +5 -1
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/client/requests/OrderTemplatesNewListV1Request.d.mts +3 -0
- package/dist/esm/api/resources/shippingIntegrations/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/shippingIntegrations/client/Client.mjs +5 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.d.mts +3 -19
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.mjs +7 -78
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/Client.mjs +7 -7
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/Client.mjs +7 -7
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.mjs +7 -7
- package/dist/esm/api/resources/shippingIntegrations/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/integrationExecutors/client/Client.d.mts +44 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/integrationExecutors/client/Client.mjs +84 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/integrationExecutors/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/integrationExecutors/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/integrationExecutors/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/integrationExecutors/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.mjs +7 -7
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/Client.d.mts +35 -2
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/Client.mjs +152 -4
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersListForIntegrationExecutorOperatorsV1Request.d.mts +54 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersListV1Request.d.mts +6 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersStatusSummaryV1Request.d.mts +6 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.d.mts +3 -19
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.mjs +7 -78
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.mjs +1 -1
- package/dist/esm/api/types/ShippingIntegrationIntegrationExecutor.d.mts +17 -0
- package/dist/esm/api/types/ShippingIntegrationIntegrationExecutorListRes.d.mts +8 -0
- package/dist/esm/api/types/ShippingIntegrationIntegrationExecutorListRes.mjs +4 -0
- package/dist/esm/api/types/ShippingIntegrationOrderCompletedAtProvenanceEnum1.d.mts +8 -0
- package/dist/esm/api/types/ShippingIntegrationOrderCompletedAtProvenanceEnum1.mjs +7 -0
- package/dist/esm/api/types/ShippingIntegrationOrderExpanded1.d.mts +3 -0
- package/dist/esm/api/types/ShippingIntegrationOrderSortByEnum.d.mts +2 -1
- package/dist/esm/api/types/ShippingIntegrationOrderSortByEnum.mjs +1 -0
- package/dist/esm/api/types/ShippingIntegrationOrderTypeaheadFieldEnum.d.mts +5 -1
- package/dist/esm/api/types/ShippingIntegrationOrderTypeaheadFieldEnum.mjs +4 -1
- package/dist/esm/api/types/index.d.mts +3 -0
- package/dist/esm/api/types/index.mjs +3 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +163 -166
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersTypeaheadV1Request.d.ts +0 -16
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/OrdersTypeaheadV1Request.d.ts +0 -16
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersTypeaheadV1Request.d.mts +0 -16
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/OrdersTypeaheadV1Request.d.mts +0 -16
- /package/dist/cjs/api/resources/shippingIntegrations/resources/{atlas/resources/orders/client/requests/OrdersTypeaheadV1Request.js → orders/client/requests/OrdersListForIntegrationExecutorOperatorsV1Request.js} +0 -0
- /package/dist/cjs/api/{resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/OrdersTypeaheadV1Request.js → types/ShippingIntegrationIntegrationExecutor.js} +0 -0
- /package/dist/esm/api/resources/shippingIntegrations/resources/{atlas/resources/orders/client/requests/OrdersTypeaheadV1Request.mjs → orders/client/requests/OrdersListForIntegrationExecutorOperatorsV1Request.mjs} +0 -0
- /package/dist/esm/api/{resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/OrdersTypeaheadV1Request.mjs → types/ShippingIntegrationIntegrationExecutor.mjs} +0 -0
|
@@ -20,7 +20,7 @@ export class Orders {
|
|
|
20
20
|
this._options = _options;
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* Returns one unified shipping integration order by its Mongo ObjectId with
|
|
23
|
+
* Returns one unified shipping integration order by its Mongo ObjectId with related organizations expanded. | () -> (ShippingIntegrationOrderExpanded1)
|
|
24
24
|
*
|
|
25
25
|
* @param {string} id - Mongo ObjectId of the unified order document. The provider's own order ID is the integration_order_id field on the returned order.
|
|
26
26
|
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -81,6 +81,138 @@ export class Orders {
|
|
|
81
81
|
}
|
|
82
82
|
});
|
|
83
83
|
}
|
|
84
|
+
/**
|
|
85
|
+
* Lists orders assigned to the caller's integration executor organization across all shipping integrations with integration coordinator organizations expanded, filtering, sorting, pagination, and optional search. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (ShippingIntegrationOrderListRes)
|
|
86
|
+
*
|
|
87
|
+
* @param {Chrt.shippingIntegrations.OrdersListForIntegrationExecutorOperatorsV1Request} request
|
|
88
|
+
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
91
|
+
*
|
|
92
|
+
* @example
|
|
93
|
+
* await client.shippingIntegrations.orders.listForIntegrationExecutorOperatorsV1({
|
|
94
|
+
* sort_by: "ordered_at_timestamp",
|
|
95
|
+
* sort_order: "asc",
|
|
96
|
+
* page: 1,
|
|
97
|
+
* page_size: 1,
|
|
98
|
+
* search: "search",
|
|
99
|
+
* filter_shipping_integration: ["xcelerator"],
|
|
100
|
+
* filter_status: ["staged"],
|
|
101
|
+
* filter_integration_order_id: "filter_integration_order_id",
|
|
102
|
+
* filter_reference_number: "filter_reference_number",
|
|
103
|
+
* filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
104
|
+
* filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
105
|
+
* filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
106
|
+
* filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
107
|
+
* filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
108
|
+
* filter_first_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z"
|
|
109
|
+
* })
|
|
110
|
+
*/
|
|
111
|
+
listForIntegrationExecutorOperatorsV1(request = {}, requestOptions) {
|
|
112
|
+
return core.HttpResponsePromise.fromPromise(this.__listForIntegrationExecutorOperatorsV1(request, requestOptions));
|
|
113
|
+
}
|
|
114
|
+
__listForIntegrationExecutorOperatorsV1() {
|
|
115
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
116
|
+
var _a, _b, _c, _d, _e, _f;
|
|
117
|
+
const { sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, search, filter_shipping_integration: filterShippingIntegration, filter_status: filterStatus, filter_integration_order_id: filterIntegrationOrderId, filter_reference_number: filterReferenceNumber, filter_ordered_at_timestamp_gte: filterOrderedAtTimestampGte, filter_ordered_at_timestamp_lte: filterOrderedAtTimestampLte, filter_last_mirrored_at_timestamp_gte: filterLastMirroredAtTimestampGte, filter_last_mirrored_at_timestamp_lte: filterLastMirroredAtTimestampLte, filter_first_mirrored_at_timestamp_gte: filterFirstMirroredAtTimestampGte, filter_first_mirrored_at_timestamp_lte: filterFirstMirroredAtTimestampLte, } = request;
|
|
118
|
+
const _queryParams = {};
|
|
119
|
+
if (sortBy !== undefined) {
|
|
120
|
+
_queryParams["sort_by"] = sortBy;
|
|
121
|
+
}
|
|
122
|
+
if (sortOrder !== undefined) {
|
|
123
|
+
_queryParams["sort_order"] = sortOrder;
|
|
124
|
+
}
|
|
125
|
+
if (page !== undefined) {
|
|
126
|
+
_queryParams["page"] = (_a = page === null || page === void 0 ? void 0 : page.toString()) !== null && _a !== void 0 ? _a : null;
|
|
127
|
+
}
|
|
128
|
+
if (pageSize !== undefined) {
|
|
129
|
+
_queryParams["page_size"] = (_b = pageSize === null || pageSize === void 0 ? void 0 : pageSize.toString()) !== null && _b !== void 0 ? _b : null;
|
|
130
|
+
}
|
|
131
|
+
if (search !== undefined) {
|
|
132
|
+
_queryParams["search"] = search;
|
|
133
|
+
}
|
|
134
|
+
if (filterShippingIntegration !== undefined) {
|
|
135
|
+
if (Array.isArray(filterShippingIntegration)) {
|
|
136
|
+
_queryParams["filter_shipping_integration"] = filterShippingIntegration.map((item) => item);
|
|
137
|
+
}
|
|
138
|
+
else {
|
|
139
|
+
_queryParams["filter_shipping_integration"] = filterShippingIntegration;
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
if (filterStatus !== undefined) {
|
|
143
|
+
if (Array.isArray(filterStatus)) {
|
|
144
|
+
_queryParams["filter_status"] = filterStatus.map((item) => item);
|
|
145
|
+
}
|
|
146
|
+
else {
|
|
147
|
+
_queryParams["filter_status"] = filterStatus;
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
if (filterIntegrationOrderId !== undefined) {
|
|
151
|
+
_queryParams["filter_integration_order_id"] = filterIntegrationOrderId;
|
|
152
|
+
}
|
|
153
|
+
if (filterReferenceNumber !== undefined) {
|
|
154
|
+
_queryParams["filter_reference_number"] = filterReferenceNumber;
|
|
155
|
+
}
|
|
156
|
+
if (filterOrderedAtTimestampGte !== undefined) {
|
|
157
|
+
_queryParams["filter_ordered_at_timestamp_gte"] = filterOrderedAtTimestampGte;
|
|
158
|
+
}
|
|
159
|
+
if (filterOrderedAtTimestampLte !== undefined) {
|
|
160
|
+
_queryParams["filter_ordered_at_timestamp_lte"] = filterOrderedAtTimestampLte;
|
|
161
|
+
}
|
|
162
|
+
if (filterLastMirroredAtTimestampGte !== undefined) {
|
|
163
|
+
_queryParams["filter_last_mirrored_at_timestamp_gte"] = filterLastMirroredAtTimestampGte;
|
|
164
|
+
}
|
|
165
|
+
if (filterLastMirroredAtTimestampLte !== undefined) {
|
|
166
|
+
_queryParams["filter_last_mirrored_at_timestamp_lte"] = filterLastMirroredAtTimestampLte;
|
|
167
|
+
}
|
|
168
|
+
if (filterFirstMirroredAtTimestampGte !== undefined) {
|
|
169
|
+
_queryParams["filter_first_mirrored_at_timestamp_gte"] = filterFirstMirroredAtTimestampGte;
|
|
170
|
+
}
|
|
171
|
+
if (filterFirstMirroredAtTimestampLte !== undefined) {
|
|
172
|
+
_queryParams["filter_first_mirrored_at_timestamp_lte"] = filterFirstMirroredAtTimestampLte;
|
|
173
|
+
}
|
|
174
|
+
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);
|
|
175
|
+
const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
|
|
176
|
+
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_integrations/orders/list/for_integration_executor_operators/v1"),
|
|
177
|
+
method: "GET",
|
|
178
|
+
headers: _headers,
|
|
179
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
180
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
181
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
182
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
183
|
+
});
|
|
184
|
+
if (_response.ok) {
|
|
185
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
186
|
+
}
|
|
187
|
+
if (_response.error.reason === "status-code") {
|
|
188
|
+
switch (_response.error.statusCode) {
|
|
189
|
+
case 422:
|
|
190
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
191
|
+
default:
|
|
192
|
+
throw new errors.ChrtError({
|
|
193
|
+
statusCode: _response.error.statusCode,
|
|
194
|
+
body: _response.error.body,
|
|
195
|
+
rawResponse: _response.rawResponse,
|
|
196
|
+
});
|
|
197
|
+
}
|
|
198
|
+
}
|
|
199
|
+
switch (_response.error.reason) {
|
|
200
|
+
case "non-json":
|
|
201
|
+
throw new errors.ChrtError({
|
|
202
|
+
statusCode: _response.error.statusCode,
|
|
203
|
+
body: _response.error.rawBody,
|
|
204
|
+
rawResponse: _response.rawResponse,
|
|
205
|
+
});
|
|
206
|
+
case "timeout":
|
|
207
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping_integrations/orders/list/for_integration_executor_operators/v1.");
|
|
208
|
+
case "unknown":
|
|
209
|
+
throw new errors.ChrtError({
|
|
210
|
+
message: _response.error.errorMessage,
|
|
211
|
+
rawResponse: _response.rawResponse,
|
|
212
|
+
});
|
|
213
|
+
}
|
|
214
|
+
});
|
|
215
|
+
}
|
|
84
216
|
/**
|
|
85
217
|
* Lists the caller's orders from every shipping integration with provider organizations expanded, filtering, sorting, pagination, and optional search. | () -> (ShippingIntegrationOrderListRes)
|
|
86
218
|
*
|
|
@@ -103,6 +235,8 @@ export class Orders {
|
|
|
103
235
|
* filter_reference_number: "filter_reference_number",
|
|
104
236
|
* filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
105
237
|
* filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
238
|
+
* filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
239
|
+
* filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
106
240
|
* filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
107
241
|
* filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
108
242
|
* filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -115,7 +249,7 @@ export class Orders {
|
|
|
115
249
|
__listV1() {
|
|
116
250
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
117
251
|
var _a, _b, _c, _d, _e, _f;
|
|
118
|
-
const { sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, search, filter_shipping_integration: filterShippingIntegration, filter_provider_org_id: filterProviderOrgId, filter_status: filterStatus, filter_integration_order_id: filterIntegrationOrderId, filter_reference_number: filterReferenceNumber, filter_ordered_at_timestamp_gte: filterOrderedAtTimestampGte, filter_ordered_at_timestamp_lte: filterOrderedAtTimestampLte, filter_last_mirrored_at_timestamp_gte: filterLastMirroredAtTimestampGte, filter_last_mirrored_at_timestamp_lte: filterLastMirroredAtTimestampLte, filter_first_mirrored_at_timestamp_gte: filterFirstMirroredAtTimestampGte, filter_first_mirrored_at_timestamp_lte: filterFirstMirroredAtTimestampLte, } = request;
|
|
252
|
+
const { sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, search, filter_shipping_integration: filterShippingIntegration, filter_provider_org_id: filterProviderOrgId, filter_status: filterStatus, filter_integration_order_id: filterIntegrationOrderId, filter_reference_number: filterReferenceNumber, filter_ordered_at_timestamp_gte: filterOrderedAtTimestampGte, filter_ordered_at_timestamp_lte: filterOrderedAtTimestampLte, filter_completed_at_timestamp_gte: filterCompletedAtTimestampGte, filter_completed_at_timestamp_lte: filterCompletedAtTimestampLte, filter_last_mirrored_at_timestamp_gte: filterLastMirroredAtTimestampGte, filter_last_mirrored_at_timestamp_lte: filterLastMirroredAtTimestampLte, filter_first_mirrored_at_timestamp_gte: filterFirstMirroredAtTimestampGte, filter_first_mirrored_at_timestamp_lte: filterFirstMirroredAtTimestampLte, } = request;
|
|
119
253
|
const _queryParams = {};
|
|
120
254
|
if (sortBy !== undefined) {
|
|
121
255
|
_queryParams["sort_by"] = sortBy;
|
|
@@ -168,6 +302,12 @@ export class Orders {
|
|
|
168
302
|
if (filterOrderedAtTimestampLte !== undefined) {
|
|
169
303
|
_queryParams["filter_ordered_at_timestamp_lte"] = filterOrderedAtTimestampLte;
|
|
170
304
|
}
|
|
305
|
+
if (filterCompletedAtTimestampGte !== undefined) {
|
|
306
|
+
_queryParams["filter_completed_at_timestamp_gte"] = filterCompletedAtTimestampGte;
|
|
307
|
+
}
|
|
308
|
+
if (filterCompletedAtTimestampLte !== undefined) {
|
|
309
|
+
_queryParams["filter_completed_at_timestamp_lte"] = filterCompletedAtTimestampLte;
|
|
310
|
+
}
|
|
171
311
|
if (filterLastMirroredAtTimestampGte !== undefined) {
|
|
172
312
|
_queryParams["filter_last_mirrored_at_timestamp_gte"] = filterLastMirroredAtTimestampGte;
|
|
173
313
|
}
|
|
@@ -239,6 +379,8 @@ export class Orders {
|
|
|
239
379
|
* filter_reference_number: "filter_reference_number",
|
|
240
380
|
* filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
241
381
|
* filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
382
|
+
* filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
383
|
+
* filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
242
384
|
* filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
243
385
|
* filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
244
386
|
* filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -251,7 +393,7 @@ export class Orders {
|
|
|
251
393
|
__statusSummaryV1() {
|
|
252
394
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
253
395
|
var _a, _b, _c, _d;
|
|
254
|
-
const { filter_shipping_integration: filterShippingIntegration, filter_provider_org_id: filterProviderOrgId, filter_status: filterStatus, filter_integration_order_id: filterIntegrationOrderId, filter_reference_number: filterReferenceNumber, filter_ordered_at_timestamp_gte: filterOrderedAtTimestampGte, filter_ordered_at_timestamp_lte: filterOrderedAtTimestampLte, filter_last_mirrored_at_timestamp_gte: filterLastMirroredAtTimestampGte, filter_last_mirrored_at_timestamp_lte: filterLastMirroredAtTimestampLte, filter_first_mirrored_at_timestamp_gte: filterFirstMirroredAtTimestampGte, filter_first_mirrored_at_timestamp_lte: filterFirstMirroredAtTimestampLte, } = request;
|
|
396
|
+
const { filter_shipping_integration: filterShippingIntegration, filter_provider_org_id: filterProviderOrgId, filter_status: filterStatus, filter_integration_order_id: filterIntegrationOrderId, filter_reference_number: filterReferenceNumber, filter_ordered_at_timestamp_gte: filterOrderedAtTimestampGte, filter_ordered_at_timestamp_lte: filterOrderedAtTimestampLte, filter_completed_at_timestamp_gte: filterCompletedAtTimestampGte, filter_completed_at_timestamp_lte: filterCompletedAtTimestampLte, filter_last_mirrored_at_timestamp_gte: filterLastMirroredAtTimestampGte, filter_last_mirrored_at_timestamp_lte: filterLastMirroredAtTimestampLte, filter_first_mirrored_at_timestamp_gte: filterFirstMirroredAtTimestampGte, filter_first_mirrored_at_timestamp_lte: filterFirstMirroredAtTimestampLte, } = request;
|
|
255
397
|
const _queryParams = {};
|
|
256
398
|
if (filterShippingIntegration !== undefined) {
|
|
257
399
|
if (Array.isArray(filterShippingIntegration)) {
|
|
@@ -289,6 +431,12 @@ export class Orders {
|
|
|
289
431
|
if (filterOrderedAtTimestampLte !== undefined) {
|
|
290
432
|
_queryParams["filter_ordered_at_timestamp_lte"] = filterOrderedAtTimestampLte;
|
|
291
433
|
}
|
|
434
|
+
if (filterCompletedAtTimestampGte !== undefined) {
|
|
435
|
+
_queryParams["filter_completed_at_timestamp_gte"] = filterCompletedAtTimestampGte;
|
|
436
|
+
}
|
|
437
|
+
if (filterCompletedAtTimestampLte !== undefined) {
|
|
438
|
+
_queryParams["filter_completed_at_timestamp_lte"] = filterCompletedAtTimestampLte;
|
|
439
|
+
}
|
|
292
440
|
if (filterLastMirroredAtTimestampGte !== undefined) {
|
|
293
441
|
_queryParams["filter_last_mirrored_at_timestamp_gte"] = filterLastMirroredAtTimestampGte;
|
|
294
442
|
}
|
|
@@ -347,7 +495,7 @@ export class Orders {
|
|
|
347
495
|
});
|
|
348
496
|
}
|
|
349
497
|
/**
|
|
350
|
-
* Returns distinct integration order IDs matching the query via case-insensitive regex within the caller's organization. |
|
|
498
|
+
* Returns distinct integration order IDs and reference numbers matching the query via case-insensitive regex within the caller's organization. | () -> (list[ShippingIntegrationOrderTypeaheadResult])
|
|
351
499
|
*
|
|
352
500
|
* @param {Chrt.shippingIntegrations.OrdersTypeaheadV1Request} request
|
|
353
501
|
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -0,0 +1,54 @@
|
|
|
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: "ordered_at_timestamp",
|
|
9
|
+
* sort_order: "asc",
|
|
10
|
+
* page: 1,
|
|
11
|
+
* page_size: 1,
|
|
12
|
+
* search: "search",
|
|
13
|
+
* filter_shipping_integration: ["xcelerator"],
|
|
14
|
+
* filter_status: ["staged"],
|
|
15
|
+
* filter_integration_order_id: "filter_integration_order_id",
|
|
16
|
+
* filter_reference_number: "filter_reference_number",
|
|
17
|
+
* filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
18
|
+
* filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
19
|
+
* filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
20
|
+
* filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21
|
+
* filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
22
|
+
* filter_first_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z"
|
|
23
|
+
* }
|
|
24
|
+
*/
|
|
25
|
+
export interface OrdersListForIntegrationExecutorOperatorsV1Request {
|
|
26
|
+
/** Field to sort by. */
|
|
27
|
+
sort_by?: Chrt.ShippingIntegrationOrderSortByEnum | null;
|
|
28
|
+
/** Sort order (asc or desc). */
|
|
29
|
+
sort_order?: Chrt.SortOrderEnum | null;
|
|
30
|
+
page?: number | null;
|
|
31
|
+
page_size?: number | null;
|
|
32
|
+
/** Search provider order IDs and reference numbers. */
|
|
33
|
+
search?: string | null;
|
|
34
|
+
/** Filter by shipping integration(s) */
|
|
35
|
+
filter_shipping_integration?: (Chrt.OrgShippingIntegrationEnum1 | null) | (Chrt.OrgShippingIntegrationEnum1 | null)[];
|
|
36
|
+
/** Filter by unified status(es) */
|
|
37
|
+
filter_status?: (Chrt.ShippingIntegrationOrderStatusEnum1 | null) | (Chrt.ShippingIntegrationOrderStatusEnum1 | null)[];
|
|
38
|
+
/** Filter by the provider's exact order ID */
|
|
39
|
+
filter_integration_order_id?: string | null;
|
|
40
|
+
/** Filter by an exact reference number carried on the order */
|
|
41
|
+
filter_reference_number?: string | null;
|
|
42
|
+
/** Filter ordered_at_timestamp >= value */
|
|
43
|
+
filter_ordered_at_timestamp_gte?: string | null;
|
|
44
|
+
/** Filter ordered_at_timestamp <= value */
|
|
45
|
+
filter_ordered_at_timestamp_lte?: string | null;
|
|
46
|
+
/** Filter last_mirrored_at_timestamp >= value */
|
|
47
|
+
filter_last_mirrored_at_timestamp_gte?: string | null;
|
|
48
|
+
/** Filter last_mirrored_at_timestamp <= value */
|
|
49
|
+
filter_last_mirrored_at_timestamp_lte?: string | null;
|
|
50
|
+
/** Filter first_mirrored_at_timestamp >= value */
|
|
51
|
+
filter_first_mirrored_at_timestamp_gte?: string | null;
|
|
52
|
+
/** Filter first_mirrored_at_timestamp <= value */
|
|
53
|
+
filter_first_mirrored_at_timestamp_lte?: string | null;
|
|
54
|
+
}
|
|
@@ -17,6 +17,8 @@ import * as Chrt from "../../../../../../index.mjs";
|
|
|
17
17
|
* filter_reference_number: "filter_reference_number",
|
|
18
18
|
* filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
19
19
|
* filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
20
|
+
* filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21
|
+
* filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
20
22
|
* filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21
23
|
* filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
22
24
|
* filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -46,6 +48,10 @@ export interface OrdersListV1Request {
|
|
|
46
48
|
filter_ordered_at_timestamp_gte?: string | null;
|
|
47
49
|
/** Filter ordered_at_timestamp <= value */
|
|
48
50
|
filter_ordered_at_timestamp_lte?: string | null;
|
|
51
|
+
/** Filter completed_at_timestamp >= value */
|
|
52
|
+
filter_completed_at_timestamp_gte?: string | null;
|
|
53
|
+
/** Filter completed_at_timestamp <= value */
|
|
54
|
+
filter_completed_at_timestamp_lte?: string | null;
|
|
49
55
|
/** Filter last_mirrored_at_timestamp >= value */
|
|
50
56
|
filter_last_mirrored_at_timestamp_gte?: string | null;
|
|
51
57
|
/** Filter last_mirrored_at_timestamp <= value */
|
|
@@ -12,6 +12,8 @@ import * as Chrt from "../../../../../../index.mjs";
|
|
|
12
12
|
* filter_reference_number: "filter_reference_number",
|
|
13
13
|
* filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
14
14
|
* filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
15
|
+
* filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16
|
+
* filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
15
17
|
* filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16
18
|
* filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
17
19
|
* filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -33,6 +35,10 @@ export interface OrdersStatusSummaryV1Request {
|
|
|
33
35
|
filter_ordered_at_timestamp_gte?: string | null;
|
|
34
36
|
/** Filter ordered_at_timestamp <= value */
|
|
35
37
|
filter_ordered_at_timestamp_lte?: string | null;
|
|
38
|
+
/** Filter completed_at_timestamp >= value */
|
|
39
|
+
filter_completed_at_timestamp_gte?: string | null;
|
|
40
|
+
/** Filter completed_at_timestamp <= value */
|
|
41
|
+
filter_completed_at_timestamp_lte?: string | null;
|
|
36
42
|
/** Filter last_mirrored_at_timestamp >= value */
|
|
37
43
|
filter_last_mirrored_at_timestamp_gte?: string | null;
|
|
38
44
|
/** Filter last_mirrored_at_timestamp <= value */
|
package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/index.d.mts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
export { type OrdersListForIntegrationExecutorOperatorsV1Request } from "./OrdersListForIntegrationExecutorOperatorsV1Request.mjs";
|
|
1
2
|
export { type OrdersListV1Request } from "./OrdersListV1Request.mjs";
|
|
2
3
|
export { type OrdersStatusSummaryV1Request } from "./OrdersStatusSummaryV1Request.mjs";
|
|
3
4
|
export { type OrdersTypeaheadV1Request } from "./OrdersTypeaheadV1Request.mjs";
|
|
@@ -33,16 +33,16 @@ export declare class Orders {
|
|
|
33
33
|
/**
|
|
34
34
|
* Returns one mirrored Xcelerator order by the provider's own order ID with the provider organization expanded. | () -> (XceleratorOrderExpanded1)
|
|
35
35
|
*
|
|
36
|
-
* @param {string}
|
|
36
|
+
* @param {string} orgId - CHRT org ID of the other party (executor if caller is coordinator, coordinator if caller is executor)
|
|
37
37
|
* @param {string} integrationOrderId - Xcelerator's own ID for the order (its OrderTrackingId), as carried on a unified order row
|
|
38
38
|
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
39
39
|
*
|
|
40
40
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
|
-
* await client.shippingIntegrations.xcelerator.orders.detailByIntegrationOrderIdV1("
|
|
43
|
+
* await client.shippingIntegrations.xcelerator.orders.detailByIntegrationOrderIdV1("org_id", "integration_order_id")
|
|
44
44
|
*/
|
|
45
|
-
detailByIntegrationOrderIdV1(
|
|
45
|
+
detailByIntegrationOrderIdV1(orgId: string, integrationOrderId: string, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Chrt.XceleratorOrderExpanded1>;
|
|
46
46
|
private __detailByIntegrationOrderIdV1;
|
|
47
47
|
/**
|
|
48
48
|
* Returns one mirrored Xcelerator order by its Mongo ObjectId with the provider organization expanded. | () -> (XceleratorOrderExpanded1)
|
|
@@ -101,21 +101,5 @@ export declare class Orders {
|
|
|
101
101
|
*/
|
|
102
102
|
syncOneV1(request: Chrt.shippingIntegrations.xcelerator.XceleratorOrderSyncOneReq, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Chrt.XceleratorOrder1>;
|
|
103
103
|
private __syncOneV1;
|
|
104
|
-
/**
|
|
105
|
-
* Returns distinct Xcelerator integration order IDs matching the query via case-insensitive regex within the caller's organization. | authz: caller's organization scope | () -> (list[ShippingIntegrationOrderTypeaheadResult])
|
|
106
|
-
*
|
|
107
|
-
* @param {Chrt.shippingIntegrations.xcelerator.OrdersTypeaheadV1Request} request
|
|
108
|
-
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
109
|
-
*
|
|
110
|
-
* @throws {@link Chrt.UnprocessableEntityError}
|
|
111
|
-
*
|
|
112
|
-
* @example
|
|
113
|
-
* await client.shippingIntegrations.xcelerator.orders.typeaheadV1({
|
|
114
|
-
* query: "query",
|
|
115
|
-
* limit: 1
|
|
116
|
-
* })
|
|
117
|
-
*/
|
|
118
|
-
typeaheadV1(request: Chrt.shippingIntegrations.xcelerator.OrdersTypeaheadV1Request, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Chrt.ShippingIntegrationOrderTypeaheadResult[]>;
|
|
119
|
-
private __typeaheadV1;
|
|
120
104
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
121
105
|
}
|
|
@@ -22,24 +22,24 @@ export class Orders {
|
|
|
22
22
|
/**
|
|
23
23
|
* Returns one mirrored Xcelerator order by the provider's own order ID with the provider organization expanded. | () -> (XceleratorOrderExpanded1)
|
|
24
24
|
*
|
|
25
|
-
* @param {string}
|
|
25
|
+
* @param {string} orgId - CHRT org ID of the other party (executor if caller is coordinator, coordinator if caller is executor)
|
|
26
26
|
* @param {string} integrationOrderId - Xcelerator's own ID for the order (its OrderTrackingId), as carried on a unified order row
|
|
27
27
|
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
28
28
|
*
|
|
29
29
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
30
30
|
*
|
|
31
31
|
* @example
|
|
32
|
-
* await client.shippingIntegrations.xcelerator.orders.detailByIntegrationOrderIdV1("
|
|
32
|
+
* await client.shippingIntegrations.xcelerator.orders.detailByIntegrationOrderIdV1("org_id", "integration_order_id")
|
|
33
33
|
*/
|
|
34
|
-
detailByIntegrationOrderIdV1(
|
|
35
|
-
return core.HttpResponsePromise.fromPromise(this.__detailByIntegrationOrderIdV1(
|
|
34
|
+
detailByIntegrationOrderIdV1(orgId, integrationOrderId, requestOptions) {
|
|
35
|
+
return core.HttpResponsePromise.fromPromise(this.__detailByIntegrationOrderIdV1(orgId, integrationOrderId, requestOptions));
|
|
36
36
|
}
|
|
37
|
-
__detailByIntegrationOrderIdV1(
|
|
37
|
+
__detailByIntegrationOrderIdV1(orgId, integrationOrderId, requestOptions) {
|
|
38
38
|
return __awaiter(this, void 0, void 0, function* () {
|
|
39
39
|
var _a, _b, _c, _d;
|
|
40
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
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, `shipping_integrations/xcelerator/orders/by_integration_order_id/detail/v1/${encodeURIComponent(
|
|
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, `shipping_integrations/xcelerator/orders/by_integration_order_id/detail/v1/${encodeURIComponent(orgId)}/${encodeURIComponent(integrationOrderId)}`),
|
|
43
43
|
method: "GET",
|
|
44
44
|
headers: _headers,
|
|
45
45
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
@@ -70,7 +70,7 @@ export class Orders {
|
|
|
70
70
|
rawResponse: _response.rawResponse,
|
|
71
71
|
});
|
|
72
72
|
case "timeout":
|
|
73
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping_integrations/xcelerator/orders/by_integration_order_id/detail/v1/{
|
|
73
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping_integrations/xcelerator/orders/by_integration_order_id/detail/v1/{org_id}/{integration_order_id}.");
|
|
74
74
|
case "unknown":
|
|
75
75
|
throw new errors.ChrtError({
|
|
76
76
|
message: _response.error.errorMessage,
|
|
@@ -326,77 +326,6 @@ export class Orders {
|
|
|
326
326
|
}
|
|
327
327
|
});
|
|
328
328
|
}
|
|
329
|
-
/**
|
|
330
|
-
* Returns distinct Xcelerator integration order IDs matching the query via case-insensitive regex within the caller's organization. | authz: caller's organization scope | () -> (list[ShippingIntegrationOrderTypeaheadResult])
|
|
331
|
-
*
|
|
332
|
-
* @param {Chrt.shippingIntegrations.xcelerator.OrdersTypeaheadV1Request} request
|
|
333
|
-
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
334
|
-
*
|
|
335
|
-
* @throws {@link Chrt.UnprocessableEntityError}
|
|
336
|
-
*
|
|
337
|
-
* @example
|
|
338
|
-
* await client.shippingIntegrations.xcelerator.orders.typeaheadV1({
|
|
339
|
-
* query: "query",
|
|
340
|
-
* limit: 1
|
|
341
|
-
* })
|
|
342
|
-
*/
|
|
343
|
-
typeaheadV1(request, requestOptions) {
|
|
344
|
-
return core.HttpResponsePromise.fromPromise(this.__typeaheadV1(request, requestOptions));
|
|
345
|
-
}
|
|
346
|
-
__typeaheadV1(request, requestOptions) {
|
|
347
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
348
|
-
var _a, _b, _c, _d, _e;
|
|
349
|
-
const { query, limit } = request;
|
|
350
|
-
const _queryParams = {};
|
|
351
|
-
_queryParams["query"] = query;
|
|
352
|
-
if (limit !== undefined) {
|
|
353
|
-
_queryParams["limit"] = (_a = limit === null || limit === void 0 ? void 0 : limit.toString()) !== null && _a !== void 0 ? _a : null;
|
|
354
|
-
}
|
|
355
|
-
let _headers = mergeHeaders((_b = this._options) === null || _b === void 0 ? void 0 : _b.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
356
|
-
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
357
|
-
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ChrtEnvironment.Local, "shipping_integrations/xcelerator/orders/typeahead/v1"),
|
|
358
|
-
method: "GET",
|
|
359
|
-
headers: _headers,
|
|
360
|
-
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
361
|
-
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
362
|
-
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
363
|
-
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
364
|
-
});
|
|
365
|
-
if (_response.ok) {
|
|
366
|
-
return {
|
|
367
|
-
data: _response.body,
|
|
368
|
-
rawResponse: _response.rawResponse,
|
|
369
|
-
};
|
|
370
|
-
}
|
|
371
|
-
if (_response.error.reason === "status-code") {
|
|
372
|
-
switch (_response.error.statusCode) {
|
|
373
|
-
case 422:
|
|
374
|
-
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
375
|
-
default:
|
|
376
|
-
throw new errors.ChrtError({
|
|
377
|
-
statusCode: _response.error.statusCode,
|
|
378
|
-
body: _response.error.body,
|
|
379
|
-
rawResponse: _response.rawResponse,
|
|
380
|
-
});
|
|
381
|
-
}
|
|
382
|
-
}
|
|
383
|
-
switch (_response.error.reason) {
|
|
384
|
-
case "non-json":
|
|
385
|
-
throw new errors.ChrtError({
|
|
386
|
-
statusCode: _response.error.statusCode,
|
|
387
|
-
body: _response.error.rawBody,
|
|
388
|
-
rawResponse: _response.rawResponse,
|
|
389
|
-
});
|
|
390
|
-
case "timeout":
|
|
391
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping_integrations/xcelerator/orders/typeahead/v1.");
|
|
392
|
-
case "unknown":
|
|
393
|
-
throw new errors.ChrtError({
|
|
394
|
-
message: _response.error.errorMessage,
|
|
395
|
-
rawResponse: _response.rawResponse,
|
|
396
|
-
});
|
|
397
|
-
}
|
|
398
|
-
});
|
|
399
|
-
}
|
|
400
329
|
_getAuthorizationHeader() {
|
|
401
330
|
return __awaiter(this, void 0, void 0, function* () {
|
|
402
331
|
const bearer = yield core.Supplier.get(this._options.token);
|
|
@@ -63,7 +63,7 @@ export declare class Sessions {
|
|
|
63
63
|
flightLegsV1(request: Chrt.tracking.SessionsFlightLegsV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.FlightLeg1[]>;
|
|
64
64
|
private __flightLegsV1;
|
|
65
65
|
/**
|
|
66
|
-
* Returns the
|
|
66
|
+
* Returns the Cirium positional track for one of the session's flight legs; pass force_refresh=true to bypass the cache. Access restricted to the caller's organization or shared organizations. | auth: api_key | authz: min_org_role=operator | () -> (FlightTrackRes)
|
|
67
67
|
*
|
|
68
68
|
* @param {Chrt.tracking.SessionsFlightTrackV1Request} request
|
|
69
69
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -167,7 +167,7 @@ export class Sessions {
|
|
|
167
167
|
});
|
|
168
168
|
}
|
|
169
169
|
/**
|
|
170
|
-
* Returns the
|
|
170
|
+
* Returns the Cirium positional track for one of the session's flight legs; pass force_refresh=true to bypass the cache. Access restricted to the caller's organization or shared organizations. | auth: api_key | authz: min_org_role=operator | () -> (FlightTrackRes)
|
|
171
171
|
*
|
|
172
172
|
* @param {Chrt.tracking.SessionsFlightTrackV1Request} request
|
|
173
173
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* A distinct integration executor organization configured across shipping integrations.
|
|
7
|
+
*
|
|
8
|
+
* Deliberately carries no credentials or secrets: provides the public identity
|
|
9
|
+
* and the list of shipping integrations the executor org is connected with.
|
|
10
|
+
*/
|
|
11
|
+
export interface ShippingIntegrationIntegrationExecutor {
|
|
12
|
+
integration_executor_org?: Chrt.OrgPublicData1 | null;
|
|
13
|
+
/** Must be a string starting with `org_` */
|
|
14
|
+
integration_executor_org_id: string;
|
|
15
|
+
integration_executor_org_name?: string | null;
|
|
16
|
+
integrations?: Chrt.OrgShippingIntegrationEnum1[];
|
|
17
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export type ShippingIntegrationOrderCompletedAtProvenanceEnum1 = "reported" | "derived";
|
|
5
|
+
export declare const ShippingIntegrationOrderCompletedAtProvenanceEnum1: {
|
|
6
|
+
readonly Reported: "reported";
|
|
7
|
+
readonly Derived: "derived";
|
|
8
|
+
};
|
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
import * as Chrt from "../index.mjs";
|
|
5
5
|
export interface ShippingIntegrationOrderExpanded1 {
|
|
6
6
|
_id: string;
|
|
7
|
+
completed_at_provenance?: Chrt.ShippingIntegrationOrderCompletedAtProvenanceEnum1 | null;
|
|
8
|
+
completed_at_timestamp?: string | null;
|
|
7
9
|
destination?: Chrt.ShippingIntegrationOrderPlace1 | null;
|
|
8
10
|
first_mirrored_at_timestamp: string;
|
|
9
11
|
integration_order_id: string;
|
|
@@ -18,6 +20,7 @@ export interface ShippingIntegrationOrderExpanded1 {
|
|
|
18
20
|
provider_status_raw?: string | null;
|
|
19
21
|
reference_numbers?: string[];
|
|
20
22
|
schema_version: number;
|
|
23
|
+
shipper_org?: Chrt.OrgPublicData1 | null;
|
|
21
24
|
shipping_integration: Chrt.OrgShippingIntegrationEnum1;
|
|
22
25
|
source_provider_payload_hash: string;
|
|
23
26
|
status: Chrt.ShippingIntegrationOrderStatusEnum1;
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
export type ShippingIntegrationOrderSortByEnum = "ordered_at_timestamp" | "last_mirrored_at_timestamp" | "first_mirrored_at_timestamp" | "status";
|
|
4
|
+
export type ShippingIntegrationOrderSortByEnum = "ordered_at_timestamp" | "completed_at_timestamp" | "last_mirrored_at_timestamp" | "first_mirrored_at_timestamp" | "status";
|
|
5
5
|
export declare const ShippingIntegrationOrderSortByEnum: {
|
|
6
6
|
readonly OrderedAtTimestamp: "ordered_at_timestamp";
|
|
7
|
+
readonly CompletedAtTimestamp: "completed_at_timestamp";
|
|
7
8
|
readonly LastMirroredAtTimestamp: "last_mirrored_at_timestamp";
|
|
8
9
|
readonly FirstMirroredAtTimestamp: "first_mirrored_at_timestamp";
|
|
9
10
|
readonly Status: "status";
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const ShippingIntegrationOrderSortByEnum = {
|
|
5
5
|
OrderedAtTimestamp: "ordered_at_timestamp",
|
|
6
|
+
CompletedAtTimestamp: "completed_at_timestamp",
|
|
6
7
|
LastMirroredAtTimestamp: "last_mirrored_at_timestamp",
|
|
7
8
|
FirstMirroredAtTimestamp: "first_mirrored_at_timestamp",
|
|
8
9
|
Status: "status",
|
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
export type ShippingIntegrationOrderTypeaheadFieldEnum = "integration_order_id";
|
|
4
|
+
export type ShippingIntegrationOrderTypeaheadFieldEnum = "integration_order_id" | "reference_numbers";
|
|
5
|
+
export declare const ShippingIntegrationOrderTypeaheadFieldEnum: {
|
|
6
|
+
readonly IntegrationOrderId: "integration_order_id";
|
|
7
|
+
readonly ReferenceNumbers: "reference_numbers";
|
|
8
|
+
};
|