@chrt-inc/typescript-sdk 1.949.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/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/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/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.js +7 -7
- 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/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/xcelerator/resources/orders/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.js +7 -7
- 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/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/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/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/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.mjs +7 -7
- 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/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/xcelerator/resources/orders/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.mjs +7 -7
- 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/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 +168 -33
|
@@ -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";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -15903,7 +15903,7 @@ await client.shipping.flights.getFlightStatusForFlightLegV1("flight_leg_id");
|
|
|
15903
15903
|
<dl>
|
|
15904
15904
|
<dd>
|
|
15905
15905
|
|
|
15906
|
-
Returns the
|
|
15906
|
+
Returns the Cirium positional track for a flight leg; pass force_refresh=true to bypass the cache. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, order_executor_org_operators, shipper_org_operators] | () -> (FlightTrackRes)
|
|
15907
15907
|
|
|
15908
15908
|
</dd>
|
|
15909
15909
|
</dl>
|
|
@@ -16204,6 +16204,7 @@ await client.shipping.orderTemplatesNew.listV1({
|
|
|
16204
16204
|
search: "search",
|
|
16205
16205
|
filter_archived: true,
|
|
16206
16206
|
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
16207
|
+
filter_coordinator_label: "filter_coordinator_label",
|
|
16207
16208
|
filter_executor_org_id: "filter_executor_org_id",
|
|
16208
16209
|
filter_off_chrt_executor_org_data_id: "filter_off_chrt_executor_org_data_id",
|
|
16209
16210
|
filter_shipper_org_id: "filter_shipper_org_id",
|
|
@@ -17198,7 +17199,7 @@ await client.shipping.orders.getSuggestedDepartmentV1("order_id");
|
|
|
17198
17199
|
<dl>
|
|
17199
17200
|
<dd>
|
|
17200
17201
|
|
|
17201
|
-
Sets task-group ordering on an
|
|
17202
|
+
Sets task-group ordering on an order ensuring terminal task groups precede non-terminal task groups. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | (OrdersTaskGroupOrderingReq) -> (bool)
|
|
17202
17203
|
|
|
17203
17204
|
</dd>
|
|
17204
17205
|
</dl>
|
|
@@ -21742,6 +21743,152 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
21742
21743
|
</dl>
|
|
21743
21744
|
</details>
|
|
21744
21745
|
|
|
21746
|
+
## Shipping Orders OrderEvents
|
|
21747
|
+
|
|
21748
|
+
<details><summary><code>client.shipping.orders.orderEvents.<a href="/src/api/resources/shipping/resources/orders/resources/orderEvents/client/Client.ts">listV1</a>(orderId, { ...params }) -> Chrt.OrderEventListRes</code></summary>
|
|
21749
|
+
<dl>
|
|
21750
|
+
<dd>
|
|
21751
|
+
|
|
21752
|
+
#### 📝 Description
|
|
21753
|
+
|
|
21754
|
+
<dl>
|
|
21755
|
+
<dd>
|
|
21756
|
+
|
|
21757
|
+
<dl>
|
|
21758
|
+
<dd>
|
|
21759
|
+
|
|
21760
|
+
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)
|
|
21761
|
+
|
|
21762
|
+
</dd>
|
|
21763
|
+
</dl>
|
|
21764
|
+
</dd>
|
|
21765
|
+
</dl>
|
|
21766
|
+
|
|
21767
|
+
#### 🔌 Usage
|
|
21768
|
+
|
|
21769
|
+
<dl>
|
|
21770
|
+
<dd>
|
|
21771
|
+
|
|
21772
|
+
<dl>
|
|
21773
|
+
<dd>
|
|
21774
|
+
|
|
21775
|
+
```typescript
|
|
21776
|
+
await client.shipping.orders.orderEvents.listV1("order_id", {
|
|
21777
|
+
sort_by: "timestamp",
|
|
21778
|
+
sort_order: "asc",
|
|
21779
|
+
page: 1,
|
|
21780
|
+
page_size: 1,
|
|
21781
|
+
filter_action: ["shipping.order.draft_started"],
|
|
21782
|
+
filter_user_id: "filter_user_id",
|
|
21783
|
+
filter_org_id: "filter_org_id",
|
|
21784
|
+
filter_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21785
|
+
filter_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21786
|
+
});
|
|
21787
|
+
```
|
|
21788
|
+
|
|
21789
|
+
</dd>
|
|
21790
|
+
</dl>
|
|
21791
|
+
</dd>
|
|
21792
|
+
</dl>
|
|
21793
|
+
|
|
21794
|
+
#### ⚙️ Parameters
|
|
21795
|
+
|
|
21796
|
+
<dl>
|
|
21797
|
+
<dd>
|
|
21798
|
+
|
|
21799
|
+
<dl>
|
|
21800
|
+
<dd>
|
|
21801
|
+
|
|
21802
|
+
**orderId:** `string`
|
|
21803
|
+
|
|
21804
|
+
</dd>
|
|
21805
|
+
</dl>
|
|
21806
|
+
|
|
21807
|
+
<dl>
|
|
21808
|
+
<dd>
|
|
21809
|
+
|
|
21810
|
+
**request:** `Chrt.shipping.orders.OrderEventsListV1Request`
|
|
21811
|
+
|
|
21812
|
+
</dd>
|
|
21813
|
+
</dl>
|
|
21814
|
+
|
|
21815
|
+
<dl>
|
|
21816
|
+
<dd>
|
|
21817
|
+
|
|
21818
|
+
**requestOptions:** `OrderEvents.RequestOptions`
|
|
21819
|
+
|
|
21820
|
+
</dd>
|
|
21821
|
+
</dl>
|
|
21822
|
+
</dd>
|
|
21823
|
+
</dl>
|
|
21824
|
+
|
|
21825
|
+
</dd>
|
|
21826
|
+
</dl>
|
|
21827
|
+
</details>
|
|
21828
|
+
|
|
21829
|
+
<details><summary><code>client.shipping.orders.orderEvents.<a href="/src/api/resources/shipping/resources/orders/resources/orderEvents/client/Client.ts">getV1</a>(orderEventId) -> Chrt.OrderEventExpanded1</code></summary>
|
|
21830
|
+
<dl>
|
|
21831
|
+
<dd>
|
|
21832
|
+
|
|
21833
|
+
#### 📝 Description
|
|
21834
|
+
|
|
21835
|
+
<dl>
|
|
21836
|
+
<dd>
|
|
21837
|
+
|
|
21838
|
+
<dl>
|
|
21839
|
+
<dd>
|
|
21840
|
+
|
|
21841
|
+
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)
|
|
21842
|
+
|
|
21843
|
+
</dd>
|
|
21844
|
+
</dl>
|
|
21845
|
+
</dd>
|
|
21846
|
+
</dl>
|
|
21847
|
+
|
|
21848
|
+
#### 🔌 Usage
|
|
21849
|
+
|
|
21850
|
+
<dl>
|
|
21851
|
+
<dd>
|
|
21852
|
+
|
|
21853
|
+
<dl>
|
|
21854
|
+
<dd>
|
|
21855
|
+
|
|
21856
|
+
```typescript
|
|
21857
|
+
await client.shipping.orders.orderEvents.getV1("order_event_id");
|
|
21858
|
+
```
|
|
21859
|
+
|
|
21860
|
+
</dd>
|
|
21861
|
+
</dl>
|
|
21862
|
+
</dd>
|
|
21863
|
+
</dl>
|
|
21864
|
+
|
|
21865
|
+
#### ⚙️ Parameters
|
|
21866
|
+
|
|
21867
|
+
<dl>
|
|
21868
|
+
<dd>
|
|
21869
|
+
|
|
21870
|
+
<dl>
|
|
21871
|
+
<dd>
|
|
21872
|
+
|
|
21873
|
+
**orderEventId:** `string`
|
|
21874
|
+
|
|
21875
|
+
</dd>
|
|
21876
|
+
</dl>
|
|
21877
|
+
|
|
21878
|
+
<dl>
|
|
21879
|
+
<dd>
|
|
21880
|
+
|
|
21881
|
+
**requestOptions:** `OrderEvents.RequestOptions`
|
|
21882
|
+
|
|
21883
|
+
</dd>
|
|
21884
|
+
</dl>
|
|
21885
|
+
</dd>
|
|
21886
|
+
</dl>
|
|
21887
|
+
|
|
21888
|
+
</dd>
|
|
21889
|
+
</dl>
|
|
21890
|
+
</details>
|
|
21891
|
+
|
|
21745
21892
|
## Shipping Orders Task
|
|
21746
21893
|
|
|
21747
21894
|
<details><summary><code>client.shipping.orders.task.<a href="/src/api/resources/shipping/resources/orders/resources/task/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
@@ -25027,7 +25174,7 @@ await client.shippingIntegrations.atlas.creds.updateV1("provider_org_id");
|
|
|
25027
25174
|
|
|
25028
25175
|
## ShippingIntegrations Atlas Orders
|
|
25029
25176
|
|
|
25030
|
-
<details><summary><code>client.shippingIntegrations.atlas.orders.<a href="/src/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(
|
|
25177
|
+
<details><summary><code>client.shippingIntegrations.atlas.orders.<a href="/src/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(orgId, integrationOrderId) -> Chrt.AtlasOrderExpanded1</code></summary>
|
|
25031
25178
|
<dl>
|
|
25032
25179
|
<dd>
|
|
25033
25180
|
|
|
@@ -25055,7 +25202,7 @@ Returns one mirrored Atlas order by the provider's own order ID with the provide
|
|
|
25055
25202
|
<dd>
|
|
25056
25203
|
|
|
25057
25204
|
```typescript
|
|
25058
|
-
await client.shippingIntegrations.atlas.orders.detailByIntegrationOrderIdV1("
|
|
25205
|
+
await client.shippingIntegrations.atlas.orders.detailByIntegrationOrderIdV1("org_id", "integration_order_id");
|
|
25059
25206
|
```
|
|
25060
25207
|
|
|
25061
25208
|
</dd>
|
|
@@ -25071,7 +25218,7 @@ await client.shippingIntegrations.atlas.orders.detailByIntegrationOrderIdV1("pro
|
|
|
25071
25218
|
<dl>
|
|
25072
25219
|
<dd>
|
|
25073
25220
|
|
|
25074
|
-
**
|
|
25221
|
+
**orgId:** `string` — CHRT org ID of the other party (executor if caller is coordinator, coordinator if caller is executor)
|
|
25075
25222
|
|
|
25076
25223
|
</dd>
|
|
25077
25224
|
</dl>
|
|
@@ -25700,7 +25847,7 @@ await client.shippingIntegrations.cxt.creds.updateV1("provider_org_id");
|
|
|
25700
25847
|
|
|
25701
25848
|
## ShippingIntegrations Cxt Orders
|
|
25702
25849
|
|
|
25703
|
-
<details><summary><code>client.shippingIntegrations.cxt.orders.<a href="/src/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(
|
|
25850
|
+
<details><summary><code>client.shippingIntegrations.cxt.orders.<a href="/src/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(orgId, integrationOrderId) -> Chrt.CxtOrderExpanded1</code></summary>
|
|
25704
25851
|
<dl>
|
|
25705
25852
|
<dd>
|
|
25706
25853
|
|
|
@@ -25728,7 +25875,7 @@ Returns one mirrored CXT order by the provider's own order ID with the provider
|
|
|
25728
25875
|
<dd>
|
|
25729
25876
|
|
|
25730
25877
|
```typescript
|
|
25731
|
-
await client.shippingIntegrations.cxt.orders.detailByIntegrationOrderIdV1("
|
|
25878
|
+
await client.shippingIntegrations.cxt.orders.detailByIntegrationOrderIdV1("org_id", "integration_order_id");
|
|
25732
25879
|
```
|
|
25733
25880
|
|
|
25734
25881
|
</dd>
|
|
@@ -25744,7 +25891,7 @@ await client.shippingIntegrations.cxt.orders.detailByIntegrationOrderIdV1("provi
|
|
|
25744
25891
|
<dl>
|
|
25745
25892
|
<dd>
|
|
25746
25893
|
|
|
25747
|
-
**
|
|
25894
|
+
**orgId:** `string` — CHRT org ID of the other party (executor if caller is coordinator, coordinator if caller is executor)
|
|
25748
25895
|
|
|
25749
25896
|
</dd>
|
|
25750
25897
|
</dl>
|
|
@@ -26372,7 +26519,7 @@ await client.shippingIntegrations.dispatchScience.creds.updateV1("provider_org_i
|
|
|
26372
26519
|
|
|
26373
26520
|
## ShippingIntegrations DispatchScience Orders
|
|
26374
26521
|
|
|
26375
|
-
<details><summary><code>client.shippingIntegrations.dispatchScience.orders.<a href="/src/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(
|
|
26522
|
+
<details><summary><code>client.shippingIntegrations.dispatchScience.orders.<a href="/src/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(orgId, integrationOrderId) -> Chrt.DispatchScienceOrder1</code></summary>
|
|
26376
26523
|
<dl>
|
|
26377
26524
|
<dd>
|
|
26378
26525
|
|
|
@@ -26400,10 +26547,7 @@ Returns one mirrored DispatchScience order by the provider's own order ID. | ()
|
|
|
26400
26547
|
<dd>
|
|
26401
26548
|
|
|
26402
26549
|
```typescript
|
|
26403
|
-
await client.shippingIntegrations.dispatchScience.orders.detailByIntegrationOrderIdV1(
|
|
26404
|
-
"provider_org_id",
|
|
26405
|
-
"integration_order_id",
|
|
26406
|
-
);
|
|
26550
|
+
await client.shippingIntegrations.dispatchScience.orders.detailByIntegrationOrderIdV1("org_id", "integration_order_id");
|
|
26407
26551
|
```
|
|
26408
26552
|
|
|
26409
26553
|
</dd>
|
|
@@ -26419,7 +26563,7 @@ await client.shippingIntegrations.dispatchScience.orders.detailByIntegrationOrde
|
|
|
26419
26563
|
<dl>
|
|
26420
26564
|
<dd>
|
|
26421
26565
|
|
|
26422
|
-
**
|
|
26566
|
+
**orgId:** `string` — CHRT org ID of the other party (executor if caller is coordinator, coordinator if caller is executor)
|
|
26423
26567
|
|
|
26424
26568
|
</dd>
|
|
26425
26569
|
</dl>
|
|
@@ -27051,7 +27195,7 @@ await client.shippingIntegrations.ecourier.creds.updateV1("provider_org_id");
|
|
|
27051
27195
|
|
|
27052
27196
|
## ShippingIntegrations Ecourier Orders
|
|
27053
27197
|
|
|
27054
|
-
<details><summary><code>client.shippingIntegrations.ecourier.orders.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(
|
|
27198
|
+
<details><summary><code>client.shippingIntegrations.ecourier.orders.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(orgId, integrationOrderId) -> Chrt.EcourierOrder1</code></summary>
|
|
27055
27199
|
<dl>
|
|
27056
27200
|
<dd>
|
|
27057
27201
|
|
|
@@ -27079,10 +27223,7 @@ Returns one mirrored e-Courier order by the provider's own order number. | () ->
|
|
|
27079
27223
|
<dd>
|
|
27080
27224
|
|
|
27081
27225
|
```typescript
|
|
27082
|
-
await client.shippingIntegrations.ecourier.orders.detailByIntegrationOrderIdV1(
|
|
27083
|
-
"provider_org_id",
|
|
27084
|
-
"integration_order_id",
|
|
27085
|
-
);
|
|
27226
|
+
await client.shippingIntegrations.ecourier.orders.detailByIntegrationOrderIdV1("org_id", "integration_order_id");
|
|
27086
27227
|
```
|
|
27087
27228
|
|
|
27088
27229
|
</dd>
|
|
@@ -27098,7 +27239,7 @@ await client.shippingIntegrations.ecourier.orders.detailByIntegrationOrderIdV1(
|
|
|
27098
27239
|
<dl>
|
|
27099
27240
|
<dd>
|
|
27100
27241
|
|
|
27101
|
-
**
|
|
27242
|
+
**orgId:** `string` — CHRT org ID of the other party (executor if caller is coordinator, coordinator if caller is executor)
|
|
27102
27243
|
|
|
27103
27244
|
</dd>
|
|
27104
27245
|
</dl>
|
|
@@ -27726,7 +27867,7 @@ await client.shippingIntegrations.ontime360.creds.updateV1("provider_org_id");
|
|
|
27726
27867
|
|
|
27727
27868
|
## ShippingIntegrations Ontime360 Orders
|
|
27728
27869
|
|
|
27729
|
-
<details><summary><code>client.shippingIntegrations.ontime360.orders.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(
|
|
27870
|
+
<details><summary><code>client.shippingIntegrations.ontime360.orders.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(orgId, integrationOrderId) -> Chrt.OnTime360Order1</code></summary>
|
|
27730
27871
|
<dl>
|
|
27731
27872
|
<dd>
|
|
27732
27873
|
|
|
@@ -27754,10 +27895,7 @@ Returns one mirrored OnTime360 order by the provider's own order GUID. | () -> (
|
|
|
27754
27895
|
<dd>
|
|
27755
27896
|
|
|
27756
27897
|
```typescript
|
|
27757
|
-
await client.shippingIntegrations.ontime360.orders.detailByIntegrationOrderIdV1(
|
|
27758
|
-
"provider_org_id",
|
|
27759
|
-
"integration_order_id",
|
|
27760
|
-
);
|
|
27898
|
+
await client.shippingIntegrations.ontime360.orders.detailByIntegrationOrderIdV1("org_id", "integration_order_id");
|
|
27761
27899
|
```
|
|
27762
27900
|
|
|
27763
27901
|
</dd>
|
|
@@ -27773,7 +27911,7 @@ await client.shippingIntegrations.ontime360.orders.detailByIntegrationOrderIdV1(
|
|
|
27773
27911
|
<dl>
|
|
27774
27912
|
<dd>
|
|
27775
27913
|
|
|
27776
|
-
**
|
|
27914
|
+
**orgId:** `string` — CHRT org ID of the other party (executor if caller is coordinator, coordinator if caller is executor)
|
|
27777
27915
|
|
|
27778
27916
|
</dd>
|
|
27779
27917
|
</dl>
|
|
@@ -28402,7 +28540,7 @@ await client.shippingIntegrations.xcelerator.creds.updateV1("provider_org_id");
|
|
|
28402
28540
|
|
|
28403
28541
|
## ShippingIntegrations Xcelerator Orders
|
|
28404
28542
|
|
|
28405
|
-
<details><summary><code>client.shippingIntegrations.xcelerator.orders.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(
|
|
28543
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.orders.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(orgId, integrationOrderId) -> Chrt.XceleratorOrderExpanded1</code></summary>
|
|
28406
28544
|
<dl>
|
|
28407
28545
|
<dd>
|
|
28408
28546
|
|
|
@@ -28430,10 +28568,7 @@ Returns one mirrored Xcelerator order by the provider's own order ID with the pr
|
|
|
28430
28568
|
<dd>
|
|
28431
28569
|
|
|
28432
28570
|
```typescript
|
|
28433
|
-
await client.shippingIntegrations.xcelerator.orders.detailByIntegrationOrderIdV1(
|
|
28434
|
-
"provider_org_id",
|
|
28435
|
-
"integration_order_id",
|
|
28436
|
-
);
|
|
28571
|
+
await client.shippingIntegrations.xcelerator.orders.detailByIntegrationOrderIdV1("org_id", "integration_order_id");
|
|
28437
28572
|
```
|
|
28438
28573
|
|
|
28439
28574
|
</dd>
|
|
@@ -28449,7 +28584,7 @@ await client.shippingIntegrations.xcelerator.orders.detailByIntegrationOrderIdV1
|
|
|
28449
28584
|
<dl>
|
|
28450
28585
|
<dd>
|
|
28451
28586
|
|
|
28452
|
-
**
|
|
28587
|
+
**orgId:** `string` — CHRT org ID of the other party (executor if caller is coordinator, coordinator if caller is executor)
|
|
28453
28588
|
|
|
28454
28589
|
</dd>
|
|
28455
28590
|
</dl>
|
|
@@ -29934,7 +30069,7 @@ await client.tracking.sessions.flightLegsV1({
|
|
|
29934
30069
|
<dl>
|
|
29935
30070
|
<dd>
|
|
29936
30071
|
|
|
29937
|
-
Returns the
|
|
30072
|
+
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)
|
|
29938
30073
|
|
|
29939
30074
|
</dd>
|
|
29940
30075
|
</dl>
|