@chrt-inc/typescript-sdk 1.944.0 → 1.949.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/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 +0 -16
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.js +0 -71
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/index.d.ts +0 -1
- 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/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 +0 -16
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.js +0 -71
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/index.d.ts +0 -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/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 +0 -16
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.mjs +0 -71
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/index.d.mts +0 -1
- 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/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 +0 -16
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.mjs +0 -71
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/index.d.mts +0 -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 +142 -134
- 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
|
@@ -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";
|
|
@@ -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
|
}
|
|
@@ -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);
|
|
@@ -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
|
+
};
|
|
@@ -461,6 +461,9 @@ export * from "./ShipperCoordinatorConnectionsForCoordinatorListRes.mjs";
|
|
|
461
461
|
export * from "./ShipperCoordinatorConnectionsForShipperListRes.mjs";
|
|
462
462
|
export * from "./ShippingIntegrationConnection.mjs";
|
|
463
463
|
export * from "./ShippingIntegrationConnectionListRes.mjs";
|
|
464
|
+
export * from "./ShippingIntegrationIntegrationExecutor.mjs";
|
|
465
|
+
export * from "./ShippingIntegrationIntegrationExecutorListRes.mjs";
|
|
466
|
+
export * from "./ShippingIntegrationOrderCompletedAtProvenanceEnum1.mjs";
|
|
464
467
|
export * from "./ShippingIntegrationOrderExpanded1.mjs";
|
|
465
468
|
export * from "./ShippingIntegrationOrderListRes.mjs";
|
|
466
469
|
export * from "./ShippingIntegrationOrderPlace1.mjs";
|
|
@@ -461,6 +461,9 @@ export * from "./ShipperCoordinatorConnectionsForCoordinatorListRes.mjs";
|
|
|
461
461
|
export * from "./ShipperCoordinatorConnectionsForShipperListRes.mjs";
|
|
462
462
|
export * from "./ShippingIntegrationConnection.mjs";
|
|
463
463
|
export * from "./ShippingIntegrationConnectionListRes.mjs";
|
|
464
|
+
export * from "./ShippingIntegrationIntegrationExecutor.mjs";
|
|
465
|
+
export * from "./ShippingIntegrationIntegrationExecutorListRes.mjs";
|
|
466
|
+
export * from "./ShippingIntegrationOrderCompletedAtProvenanceEnum1.mjs";
|
|
464
467
|
export * from "./ShippingIntegrationOrderExpanded1.mjs";
|
|
465
468
|
export * from "./ShippingIntegrationOrderListRes.mjs";
|
|
466
469
|
export * from "./ShippingIntegrationOrderPlace1.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.949.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.
|
|
1
|
+
export const SDK_VERSION = "1.949.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -24208,6 +24208,63 @@ await client.shippingIntegrations.connections.listV1();
|
|
|
24208
24208
|
</dl>
|
|
24209
24209
|
</details>
|
|
24210
24210
|
|
|
24211
|
+
## ShippingIntegrations IntegrationExecutors
|
|
24212
|
+
|
|
24213
|
+
<details><summary><code>client.shippingIntegrations.integrationExecutors.<a href="/src/api/resources/shippingIntegrations/resources/integrationExecutors/client/Client.ts">listV1</a>() -> Chrt.ShippingIntegrationIntegrationExecutorListRes</code></summary>
|
|
24214
|
+
<dl>
|
|
24215
|
+
<dd>
|
|
24216
|
+
|
|
24217
|
+
#### 📝 Description
|
|
24218
|
+
|
|
24219
|
+
<dl>
|
|
24220
|
+
<dd>
|
|
24221
|
+
|
|
24222
|
+
<dl>
|
|
24223
|
+
<dd>
|
|
24224
|
+
|
|
24225
|
+
Lists all distinct integration executor organizations that have credentials configured across any shipping integration, with public organization data expanded. | authz: min_org_role=operator | () -> (ShippingIntegrationIntegrationExecutorListRes)
|
|
24226
|
+
|
|
24227
|
+
</dd>
|
|
24228
|
+
</dl>
|
|
24229
|
+
</dd>
|
|
24230
|
+
</dl>
|
|
24231
|
+
|
|
24232
|
+
#### 🔌 Usage
|
|
24233
|
+
|
|
24234
|
+
<dl>
|
|
24235
|
+
<dd>
|
|
24236
|
+
|
|
24237
|
+
<dl>
|
|
24238
|
+
<dd>
|
|
24239
|
+
|
|
24240
|
+
```typescript
|
|
24241
|
+
await client.shippingIntegrations.integrationExecutors.listV1();
|
|
24242
|
+
```
|
|
24243
|
+
|
|
24244
|
+
</dd>
|
|
24245
|
+
</dl>
|
|
24246
|
+
</dd>
|
|
24247
|
+
</dl>
|
|
24248
|
+
|
|
24249
|
+
#### ⚙️ Parameters
|
|
24250
|
+
|
|
24251
|
+
<dl>
|
|
24252
|
+
<dd>
|
|
24253
|
+
|
|
24254
|
+
<dl>
|
|
24255
|
+
<dd>
|
|
24256
|
+
|
|
24257
|
+
**requestOptions:** `IntegrationExecutors.RequestOptions`
|
|
24258
|
+
|
|
24259
|
+
</dd>
|
|
24260
|
+
</dl>
|
|
24261
|
+
</dd>
|
|
24262
|
+
</dl>
|
|
24263
|
+
|
|
24264
|
+
</dd>
|
|
24265
|
+
</dl>
|
|
24266
|
+
</details>
|
|
24267
|
+
|
|
24211
24268
|
## ShippingIntegrations Orders
|
|
24212
24269
|
|
|
24213
24270
|
<details><summary><code>client.shippingIntegrations.orders.<a href="/src/api/resources/shippingIntegrations/resources/orders/client/Client.ts">detailV1</a>(id) -> Chrt.ShippingIntegrationOrderExpanded1</code></summary>
|
|
@@ -24222,7 +24279,7 @@ await client.shippingIntegrations.connections.listV1();
|
|
|
24222
24279
|
<dl>
|
|
24223
24280
|
<dd>
|
|
24224
24281
|
|
|
24225
|
-
Returns one unified shipping integration order by its Mongo ObjectId with
|
|
24282
|
+
Returns one unified shipping integration order by its Mongo ObjectId with related organizations expanded. | () -> (ShippingIntegrationOrderExpanded1)
|
|
24226
24283
|
|
|
24227
24284
|
</dd>
|
|
24228
24285
|
</dl>
|
|
@@ -24273,6 +24330,85 @@ await client.shippingIntegrations.orders.detailV1("id");
|
|
|
24273
24330
|
</dl>
|
|
24274
24331
|
</details>
|
|
24275
24332
|
|
|
24333
|
+
<details><summary><code>client.shippingIntegrations.orders.<a href="/src/api/resources/shippingIntegrations/resources/orders/client/Client.ts">listForIntegrationExecutorOperatorsV1</a>({ ...params }) -> Chrt.ShippingIntegrationOrderListRes</code></summary>
|
|
24334
|
+
<dl>
|
|
24335
|
+
<dd>
|
|
24336
|
+
|
|
24337
|
+
#### 📝 Description
|
|
24338
|
+
|
|
24339
|
+
<dl>
|
|
24340
|
+
<dd>
|
|
24341
|
+
|
|
24342
|
+
<dl>
|
|
24343
|
+
<dd>
|
|
24344
|
+
|
|
24345
|
+
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)
|
|
24346
|
+
|
|
24347
|
+
</dd>
|
|
24348
|
+
</dl>
|
|
24349
|
+
</dd>
|
|
24350
|
+
</dl>
|
|
24351
|
+
|
|
24352
|
+
#### 🔌 Usage
|
|
24353
|
+
|
|
24354
|
+
<dl>
|
|
24355
|
+
<dd>
|
|
24356
|
+
|
|
24357
|
+
<dl>
|
|
24358
|
+
<dd>
|
|
24359
|
+
|
|
24360
|
+
```typescript
|
|
24361
|
+
await client.shippingIntegrations.orders.listForIntegrationExecutorOperatorsV1({
|
|
24362
|
+
sort_by: "ordered_at_timestamp",
|
|
24363
|
+
sort_order: "asc",
|
|
24364
|
+
page: 1,
|
|
24365
|
+
page_size: 1,
|
|
24366
|
+
search: "search",
|
|
24367
|
+
filter_shipping_integration: ["xcelerator"],
|
|
24368
|
+
filter_status: ["staged"],
|
|
24369
|
+
filter_integration_order_id: "filter_integration_order_id",
|
|
24370
|
+
filter_reference_number: "filter_reference_number",
|
|
24371
|
+
filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24372
|
+
filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24373
|
+
filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24374
|
+
filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24375
|
+
filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24376
|
+
filter_first_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24377
|
+
});
|
|
24378
|
+
```
|
|
24379
|
+
|
|
24380
|
+
</dd>
|
|
24381
|
+
</dl>
|
|
24382
|
+
</dd>
|
|
24383
|
+
</dl>
|
|
24384
|
+
|
|
24385
|
+
#### ⚙️ Parameters
|
|
24386
|
+
|
|
24387
|
+
<dl>
|
|
24388
|
+
<dd>
|
|
24389
|
+
|
|
24390
|
+
<dl>
|
|
24391
|
+
<dd>
|
|
24392
|
+
|
|
24393
|
+
**request:** `Chrt.shippingIntegrations.OrdersListForIntegrationExecutorOperatorsV1Request`
|
|
24394
|
+
|
|
24395
|
+
</dd>
|
|
24396
|
+
</dl>
|
|
24397
|
+
|
|
24398
|
+
<dl>
|
|
24399
|
+
<dd>
|
|
24400
|
+
|
|
24401
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
24402
|
+
|
|
24403
|
+
</dd>
|
|
24404
|
+
</dl>
|
|
24405
|
+
</dd>
|
|
24406
|
+
</dl>
|
|
24407
|
+
|
|
24408
|
+
</dd>
|
|
24409
|
+
</dl>
|
|
24410
|
+
</details>
|
|
24411
|
+
|
|
24276
24412
|
<details><summary><code>client.shippingIntegrations.orders.<a href="/src/api/resources/shippingIntegrations/resources/orders/client/Client.ts">listV1</a>({ ...params }) -> Chrt.ShippingIntegrationOrderListRes</code></summary>
|
|
24277
24413
|
<dl>
|
|
24278
24414
|
<dd>
|
|
@@ -24314,6 +24450,8 @@ await client.shippingIntegrations.orders.listV1({
|
|
|
24314
24450
|
filter_reference_number: "filter_reference_number",
|
|
24315
24451
|
filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24316
24452
|
filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24453
|
+
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24454
|
+
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24317
24455
|
filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24318
24456
|
filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24319
24457
|
filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -24389,6 +24527,8 @@ await client.shippingIntegrations.orders.statusSummaryV1({
|
|
|
24389
24527
|
filter_reference_number: "filter_reference_number",
|
|
24390
24528
|
filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24391
24529
|
filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24530
|
+
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24531
|
+
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24392
24532
|
filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24393
24533
|
filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24394
24534
|
filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -24440,7 +24580,7 @@ await client.shippingIntegrations.orders.statusSummaryV1({
|
|
|
24440
24580
|
<dl>
|
|
24441
24581
|
<dd>
|
|
24442
24582
|
|
|
24443
|
-
Returns distinct integration order IDs matching the query via case-insensitive regex within the caller's organization. |
|
|
24583
|
+
Returns distinct integration order IDs and reference numbers matching the query via case-insensitive regex within the caller's organization. | () -> (list[ShippingIntegrationOrderTypeaheadResult])
|
|
24444
24584
|
|
|
24445
24585
|
</dd>
|
|
24446
24586
|
</dl>
|
|
@@ -25164,72 +25304,6 @@ await client.shippingIntegrations.atlas.orders.syncOneV1({
|
|
|
25164
25304
|
</dl>
|
|
25165
25305
|
</details>
|
|
25166
25306
|
|
|
25167
|
-
<details><summary><code>client.shippingIntegrations.atlas.orders.<a href="/src/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.ShippingIntegrationOrderTypeaheadResult[]</code></summary>
|
|
25168
|
-
<dl>
|
|
25169
|
-
<dd>
|
|
25170
|
-
|
|
25171
|
-
#### 📝 Description
|
|
25172
|
-
|
|
25173
|
-
<dl>
|
|
25174
|
-
<dd>
|
|
25175
|
-
|
|
25176
|
-
<dl>
|
|
25177
|
-
<dd>
|
|
25178
|
-
|
|
25179
|
-
Returns distinct Atlas integration order IDs matching the query via case-insensitive regex within the caller's organization. | authz: caller's organization scope | () -> (list[ShippingIntegrationOrderTypeaheadResult])
|
|
25180
|
-
|
|
25181
|
-
</dd>
|
|
25182
|
-
</dl>
|
|
25183
|
-
</dd>
|
|
25184
|
-
</dl>
|
|
25185
|
-
|
|
25186
|
-
#### 🔌 Usage
|
|
25187
|
-
|
|
25188
|
-
<dl>
|
|
25189
|
-
<dd>
|
|
25190
|
-
|
|
25191
|
-
<dl>
|
|
25192
|
-
<dd>
|
|
25193
|
-
|
|
25194
|
-
```typescript
|
|
25195
|
-
await client.shippingIntegrations.atlas.orders.typeaheadV1({
|
|
25196
|
-
query: "query",
|
|
25197
|
-
limit: 1,
|
|
25198
|
-
});
|
|
25199
|
-
```
|
|
25200
|
-
|
|
25201
|
-
</dd>
|
|
25202
|
-
</dl>
|
|
25203
|
-
</dd>
|
|
25204
|
-
</dl>
|
|
25205
|
-
|
|
25206
|
-
#### ⚙️ Parameters
|
|
25207
|
-
|
|
25208
|
-
<dl>
|
|
25209
|
-
<dd>
|
|
25210
|
-
|
|
25211
|
-
<dl>
|
|
25212
|
-
<dd>
|
|
25213
|
-
|
|
25214
|
-
**request:** `Chrt.shippingIntegrations.atlas.OrdersTypeaheadV1Request`
|
|
25215
|
-
|
|
25216
|
-
</dd>
|
|
25217
|
-
</dl>
|
|
25218
|
-
|
|
25219
|
-
<dl>
|
|
25220
|
-
<dd>
|
|
25221
|
-
|
|
25222
|
-
**requestOptions:** `Orders.RequestOptions`
|
|
25223
|
-
|
|
25224
|
-
</dd>
|
|
25225
|
-
</dl>
|
|
25226
|
-
</dd>
|
|
25227
|
-
</dl>
|
|
25228
|
-
|
|
25229
|
-
</dd>
|
|
25230
|
-
</dl>
|
|
25231
|
-
</details>
|
|
25232
|
-
|
|
25233
25307
|
## ShippingIntegrations Cxt Creds
|
|
25234
25308
|
|
|
25235
25309
|
<details><summary><code>client.shippingIntegrations.cxt.creds.<a href="/src/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/Client.ts">detailV1</a>(providerOrgId) -> Chrt.CxtCredsLimited1</code></summary>
|
|
@@ -28609,72 +28683,6 @@ await client.shippingIntegrations.xcelerator.orders.syncOneV1({
|
|
|
28609
28683
|
</dl>
|
|
28610
28684
|
</details>
|
|
28611
28685
|
|
|
28612
|
-
<details><summary><code>client.shippingIntegrations.xcelerator.orders.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.ShippingIntegrationOrderTypeaheadResult[]</code></summary>
|
|
28613
|
-
<dl>
|
|
28614
|
-
<dd>
|
|
28615
|
-
|
|
28616
|
-
#### 📝 Description
|
|
28617
|
-
|
|
28618
|
-
<dl>
|
|
28619
|
-
<dd>
|
|
28620
|
-
|
|
28621
|
-
<dl>
|
|
28622
|
-
<dd>
|
|
28623
|
-
|
|
28624
|
-
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])
|
|
28625
|
-
|
|
28626
|
-
</dd>
|
|
28627
|
-
</dl>
|
|
28628
|
-
</dd>
|
|
28629
|
-
</dl>
|
|
28630
|
-
|
|
28631
|
-
#### 🔌 Usage
|
|
28632
|
-
|
|
28633
|
-
<dl>
|
|
28634
|
-
<dd>
|
|
28635
|
-
|
|
28636
|
-
<dl>
|
|
28637
|
-
<dd>
|
|
28638
|
-
|
|
28639
|
-
```typescript
|
|
28640
|
-
await client.shippingIntegrations.xcelerator.orders.typeaheadV1({
|
|
28641
|
-
query: "query",
|
|
28642
|
-
limit: 1,
|
|
28643
|
-
});
|
|
28644
|
-
```
|
|
28645
|
-
|
|
28646
|
-
</dd>
|
|
28647
|
-
</dl>
|
|
28648
|
-
</dd>
|
|
28649
|
-
</dl>
|
|
28650
|
-
|
|
28651
|
-
#### ⚙️ Parameters
|
|
28652
|
-
|
|
28653
|
-
<dl>
|
|
28654
|
-
<dd>
|
|
28655
|
-
|
|
28656
|
-
<dl>
|
|
28657
|
-
<dd>
|
|
28658
|
-
|
|
28659
|
-
**request:** `Chrt.shippingIntegrations.xcelerator.OrdersTypeaheadV1Request`
|
|
28660
|
-
|
|
28661
|
-
</dd>
|
|
28662
|
-
</dl>
|
|
28663
|
-
|
|
28664
|
-
<dl>
|
|
28665
|
-
<dd>
|
|
28666
|
-
|
|
28667
|
-
**requestOptions:** `Orders.RequestOptions`
|
|
28668
|
-
|
|
28669
|
-
</dd>
|
|
28670
|
-
</dl>
|
|
28671
|
-
</dd>
|
|
28672
|
-
</dl>
|
|
28673
|
-
|
|
28674
|
-
</dd>
|
|
28675
|
-
</dl>
|
|
28676
|
-
</details>
|
|
28677
|
-
|
|
28678
28686
|
## Tracking Devices
|
|
28679
28687
|
|
|
28680
28688
|
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">archiveV1</a>({ ...params }) -> boolean</code></summary>
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* @example
|
|
6
|
-
* {
|
|
7
|
-
* query: "query",
|
|
8
|
-
* limit: 1
|
|
9
|
-
* }
|
|
10
|
-
*/
|
|
11
|
-
export interface OrdersTypeaheadV1Request {
|
|
12
|
-
/** Typeahead search query */
|
|
13
|
-
query: string;
|
|
14
|
-
/** Max results */
|
|
15
|
-
limit?: number | null;
|
|
16
|
-
}
|