@chrt-inc/typescript-sdk 1.930.0 → 1.935.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.d.ts +3 -0
- package/dist/cjs/Client.js +13 -8
- package/dist/cjs/api/resources/billingNew/resources/billingPeriods/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/billingNew/resources/billingPeriods/client/Client.js +3 -0
- package/dist/cjs/api/resources/billingNew/resources/billingPeriods/client/requests/BillingPeriodsListV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/billingNew/resources/chrtGroundProviderRates/client/Client.d.ts +5 -0
- package/dist/cjs/api/resources/billingNew/resources/chrtGroundProviderRates/client/Client.js +5 -0
- package/dist/cjs/api/resources/billingNew/resources/chrtGroundProviderRates/client/requests/ChrtGroundProviderRatesListV1Request.d.ts +5 -0
- package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/Client.d.ts +4 -0
- package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/Client.js +4 -0
- package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/InvoiceLineItemsListV1Request.d.ts +4 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/client/Client.js +3 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/client/requests/InvoicesListV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/client/Client.js +2 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/client/requests/OrderBillingExpandedListReq.d.ts +2 -0
- package/dist/cjs/api/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/index.js +2 -1
- package/dist/cjs/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.js +2 -2
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/Client.js +2 -0
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForBidderV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForListingV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/listing/resources/listings/client/Client.d.ts +6 -0
- package/dist/cjs/api/resources/listing/resources/listings/client/Client.js +6 -0
- package/dist/cjs/api/resources/listing/resources/listings/client/requests/ListingsListByOrgV1Request.d.ts +2 -0
- package/dist/cjs/api/resources/listing/resources/listings/client/requests/ListingsListForDriverBidderV1Request.d.ts +2 -0
- package/dist/cjs/api/resources/listing/resources/listings/client/requests/ListingsListForProviderBidderV1Request.d.ts +2 -0
- package/dist/cjs/api/resources/listing/resources/orgBiddingGroups/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/listing/resources/orgBiddingGroups/client/Client.js +2 -2
- package/dist/cjs/api/resources/notifications/resources/groups/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/notifications/resources/groups/client/Client.js +2 -2
- package/dist/cjs/api/resources/operations/resources/departments/client/Client.d.ts +4 -3
- package/dist/cjs/api/resources/operations/resources/departments/client/Client.js +4 -3
- package/dist/cjs/api/resources/operations/resources/departments/client/requests/DepartmentsListV1Request.d.ts +2 -1
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.d.ts +6 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.js +6 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksExpandedListV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksListV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/orgs/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/client/Client.js +1 -0
- package/dist/cjs/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/orgs/resources/connections/client/Client.js +1 -1
- package/dist/cjs/api/resources/orgs/resources/publicData/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/orgs/resources/publicData/client/Client.js +4 -4
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.d.ts +3 -1
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.js +3 -1
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversListV1Request.d.ts +2 -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 +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/client/requests/OrderTemplatesNewListV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.ts +8 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js +8 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForProviderOperatorsV1Request.d.ts +5 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForProviderOperatorsV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/client/Client.d.ts +41 -0
- package/dist/cjs/api/resources/shippingIntegrations/client/Client.js +47 -0
- package/dist/cjs/api/resources/shippingIntegrations/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/client/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/index.js +18 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/client/Client.d.ts +26 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/client/Client.js +22 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/client/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/index.js +18 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/Client.d.ts +114 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/Client.js +425 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/requests/AtlasCredsClientCreate1.d.ts +15 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/requests/AtlasCredsClientUpdate1.d.ts +13 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/creds/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/creds/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/index.js +43 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.d.ts +120 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.js +442 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/AtlasOrderSyncOneReq.d.ts +15 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/AtlasOrderSyncOneReq.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersListV1Request.d.ts +50 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersListV1Request.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersTypeaheadV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersTypeaheadV1Request.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/connections/client/Client.d.ts +44 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/connections/client/Client.js +121 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/connections/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/connections/client/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/connections/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/connections/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/client/Client.d.ts +26 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/client/Client.js +22 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/client/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/index.js +18 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/Client.d.ts +117 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/Client.js +428 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/requests/CxtCredsClientCreate1.d.ts +23 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/requests/CxtCredsClientCreate1.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/requests/CxtCredsClientUpdate1.d.ts +19 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/requests/CxtCredsClientUpdate1.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/creds/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/creds/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/index.js +43 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/Client.d.ts +104 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/Client.js +371 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/requests/CxtOrderSyncOneReq.d.ts +15 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/requests/CxtOrderSyncOneReq.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/requests/OrdersListV1Request.d.ts +50 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/requests/OrdersListV1Request.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/orders/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/orders/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/client/Client.d.ts +26 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/client/Client.js +22 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/client/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/index.js +18 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/Client.d.ts +116 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/Client.js +427 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/requests/DispatchScienceCredsClientCreate1.d.ts +20 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/requests/DispatchScienceCredsClientCreate1.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/requests/DispatchScienceCredsClientUpdate1.d.ts +15 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/requests/DispatchScienceCredsClientUpdate1.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/index.js +43 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/Client.d.ts +105 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/Client.js +375 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/requests/DispatchScienceOrderSyncOneReq.d.ts +15 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/requests/DispatchScienceOrderSyncOneReq.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/requests/OrdersListV1Request.d.ts +51 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/requests/OrdersListV1Request.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/index.d.ts +8 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/index.js +47 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/client/Client.d.ts +26 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/client/Client.js +22 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/client/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/index.js +18 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.d.ts +116 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.js +427 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/requests/OnTime360CredsClientCreate1.d.ts +20 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/requests/OnTime360CredsClientCreate1.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/requests/OnTime360CredsClientUpdate1.d.ts +15 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/requests/OnTime360CredsClientUpdate1.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/creds/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/creds/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/index.js +43 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.d.ts +105 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.js +375 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/requests/OnTime360OrderSyncOneReq.d.ts +15 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/requests/OnTime360OrderSyncOneReq.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/requests/OrdersListV1Request.d.ts +51 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/requests/OrdersListV1Request.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/orders/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ontime360/resources/orders/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/Client.d.ts +118 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/Client.js +466 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersListV1Request.d.ts +57 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersListV1Request.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersStatusSummaryV1Request.d.ts +44 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersStatusSummaryV1Request.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersTypeaheadV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersTypeaheadV1Request.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/client/Client.d.ts +26 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/client/Client.js +22 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/client/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/index.js +18 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.d.ts +116 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.js +427 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/requests/XceleratorCredsClientCreate1.d.ts +20 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/requests/XceleratorCredsClientCreate1.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/requests/XceleratorCredsClientUpdate1.d.ts +15 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/requests/XceleratorCredsClientUpdate1.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/index.js +43 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.d.ts +121 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.js +446 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/OrdersListV1Request.d.ts +51 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/OrdersListV1Request.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/OrdersTypeaheadV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/OrdersTypeaheadV1Request.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/XceleratorOrderSyncOneReq.d.ts +15 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/XceleratorOrderSyncOneReq.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/index.js +17 -0
- package/dist/cjs/api/types/AtlasCredsLimited1.d.ts +23 -0
- package/dist/cjs/api/types/AtlasCredsLimited1.js +5 -0
- package/dist/cjs/api/types/AtlasCredsListRes.d.ts +8 -0
- package/dist/cjs/api/types/AtlasCredsListRes.js +5 -0
- package/dist/cjs/api/types/AtlasCredsTestRes.d.ts +10 -0
- package/dist/cjs/api/types/AtlasCredsTestRes.js +5 -0
- package/dist/cjs/api/types/AtlasEventResponse1.d.ts +12 -0
- package/dist/cjs/api/types/AtlasEventResponse1.js +5 -0
- package/dist/cjs/api/types/AtlasOrder1.d.ts +19 -0
- package/dist/cjs/api/types/AtlasOrder1.js +5 -0
- package/dist/cjs/api/types/AtlasOrderExpanded1.d.ts +20 -0
- package/dist/cjs/api/types/AtlasOrderExpanded1.js +5 -0
- package/dist/cjs/api/types/AtlasOrderListRes.d.ts +8 -0
- package/dist/cjs/api/types/AtlasOrderListRes.js +5 -0
- package/dist/cjs/api/types/AtlasOrderResponse1.d.ts +21 -0
- package/dist/cjs/api/types/AtlasOrderResponse1.js +5 -0
- package/dist/cjs/api/types/AtlasOrderSortByEnum.d.ts +10 -0
- package/dist/cjs/api/types/AtlasOrderSortByEnum.js +12 -0
- package/dist/cjs/api/types/AtlasStopResponse1.d.ts +13 -0
- package/dist/cjs/api/types/AtlasStopResponse1.js +5 -0
- package/dist/cjs/api/types/CxtAuthTypeEnum1.d.ts +8 -0
- package/dist/cjs/api/types/CxtAuthTypeEnum1.js +10 -0
- package/dist/cjs/api/types/CxtCredsLimited1.d.ts +29 -0
- package/dist/cjs/api/types/CxtCredsLimited1.js +5 -0
- package/dist/cjs/api/types/CxtCredsListRes.d.ts +8 -0
- package/dist/cjs/api/types/CxtCredsListRes.js +5 -0
- package/dist/cjs/api/types/CxtCredsTestRes.d.ts +10 -0
- package/dist/cjs/api/types/CxtCredsTestRes.js +5 -0
- package/dist/cjs/api/types/CxtInetUserOrderResponse1.d.ts +11 -0
- package/dist/cjs/api/types/CxtInetUserOrderResponse1.js +5 -0
- package/dist/cjs/api/types/CxtOrder1.d.ts +22 -0
- package/dist/cjs/api/types/CxtOrder1.js +5 -0
- package/dist/cjs/api/types/CxtOrderDetailResponse1.d.ts +53 -0
- package/dist/cjs/api/types/CxtOrderDetailResponse1.js +5 -0
- package/dist/cjs/api/types/CxtOrderExpanded1.d.ts +23 -0
- package/dist/cjs/api/types/CxtOrderExpanded1.js +5 -0
- package/dist/cjs/api/types/CxtOrderListRes.d.ts +8 -0
- package/dist/cjs/api/types/CxtOrderListRes.js +5 -0
- package/dist/cjs/api/types/CxtOrderSortByEnum.d.ts +10 -0
- package/dist/cjs/api/types/CxtOrderSortByEnum.js +12 -0
- package/dist/cjs/api/types/CxtXdUserOrderResponse1.d.ts +58 -0
- package/dist/cjs/api/types/CxtXdUserOrderResponse1.js +5 -0
- package/dist/cjs/api/types/DispatchScienceAddressResponse1.d.ts +13 -0
- package/dist/cjs/api/types/DispatchScienceAddressResponse1.js +5 -0
- package/dist/cjs/api/types/DispatchScienceAttachmentResponse1.d.ts +16 -0
- package/dist/cjs/api/types/DispatchScienceAttachmentResponse1.js +5 -0
- package/dist/cjs/api/types/DispatchScienceChargeResponse1.d.ts +17 -0
- package/dist/cjs/api/types/DispatchScienceChargeResponse1.js +5 -0
- package/dist/cjs/api/types/DispatchScienceContactInfoResponse1.d.ts +12 -0
- package/dist/cjs/api/types/DispatchScienceContactInfoResponse1.js +5 -0
- package/dist/cjs/api/types/DispatchScienceCredsLimited1.d.ts +25 -0
- package/dist/cjs/api/types/DispatchScienceCredsLimited1.js +5 -0
- package/dist/cjs/api/types/DispatchScienceCredsListRes.d.ts +8 -0
- package/dist/cjs/api/types/DispatchScienceCredsListRes.js +5 -0
- package/dist/cjs/api/types/DispatchScienceCredsTestRes.d.ts +11 -0
- package/dist/cjs/api/types/DispatchScienceCredsTestRes.js +5 -0
- package/dist/cjs/api/types/DispatchScienceLocationResponse1.d.ts +13 -0
- package/dist/cjs/api/types/DispatchScienceLocationResponse1.js +5 -0
- package/dist/cjs/api/types/DispatchScienceOrder1.d.ts +19 -0
- package/dist/cjs/api/types/DispatchScienceOrder1.js +5 -0
- package/dist/cjs/api/types/DispatchScienceOrderListRes.d.ts +8 -0
- package/dist/cjs/api/types/DispatchScienceOrderListRes.js +5 -0
- package/dist/cjs/api/types/DispatchScienceOrderResponse1.d.ts +44 -0
- package/dist/cjs/api/types/DispatchScienceOrderResponse1.js +5 -0
- package/dist/cjs/api/types/DispatchScienceOrderSortByEnum.d.ts +10 -0
- package/dist/cjs/api/types/DispatchScienceOrderSortByEnum.js +12 -0
- package/dist/cjs/api/types/DispatchScienceTimeWindowResponse1.d.ts +9 -0
- package/dist/cjs/api/types/DispatchScienceTimeWindowResponse1.js +5 -0
- package/dist/cjs/api/types/DispatchScienceTimeZoneResponse1.d.ts +13 -0
- package/dist/cjs/api/types/DispatchScienceTimeZoneResponse1.js +5 -0
- package/dist/cjs/api/types/{GeometryCollectionGeometriesItem.d.ts → GeometriesItem.d.ts} +2 -2
- package/dist/cjs/api/types/GeometriesItem.js +5 -0
- package/dist/cjs/api/types/GeometryCollection.d.ts +1 -1
- package/dist/cjs/api/types/InternalDelegationJwtReq.d.ts +1 -1
- package/dist/cjs/api/types/OnTime360CredsLimited1.d.ts +26 -0
- package/dist/cjs/api/types/OnTime360CredsLimited1.js +5 -0
- package/dist/cjs/api/types/OnTime360CredsListRes.d.ts +8 -0
- package/dist/cjs/api/types/OnTime360CredsListRes.js +5 -0
- package/dist/cjs/api/types/OnTime360CredsTestRes.d.ts +13 -0
- package/dist/cjs/api/types/OnTime360CredsTestRes.js +5 -0
- package/dist/cjs/api/types/OnTime360ItemResponse1.d.ts +12 -0
- package/dist/cjs/api/types/OnTime360ItemResponse1.js +5 -0
- package/dist/cjs/api/types/OnTime360LocationResponse1.d.ts +19 -0
- package/dist/cjs/api/types/OnTime360LocationResponse1.js +5 -0
- package/dist/cjs/api/types/OnTime360Order1.d.ts +19 -0
- package/dist/cjs/api/types/OnTime360Order1.js +5 -0
- package/dist/cjs/api/types/OnTime360OrderListRes.d.ts +8 -0
- package/dist/cjs/api/types/OnTime360OrderListRes.js +5 -0
- package/dist/cjs/api/types/OnTime360OrderResponse1.d.ts +58 -0
- package/dist/cjs/api/types/OnTime360OrderResponse1.js +5 -0
- package/dist/cjs/api/types/OnTime360OrderSortByEnum.d.ts +10 -0
- package/dist/cjs/api/types/OnTime360OrderSortByEnum.js +12 -0
- package/dist/cjs/api/types/OnTime360PriceModifierResponse1.d.ts +11 -0
- package/dist/cjs/api/types/OnTime360PriceModifierResponse1.js +5 -0
- package/dist/cjs/api/types/OnTime360StatusLevelEnum1.d.ts +11 -0
- package/dist/cjs/api/types/OnTime360StatusLevelEnum1.js +5 -0
- package/dist/cjs/api/types/OnTime360StatusResponse1.d.ts +13 -0
- package/dist/cjs/api/types/OnTime360StatusResponse1.js +5 -0
- package/dist/cjs/api/types/OnTime360TimeWindowResponse1.d.ts +10 -0
- package/dist/cjs/api/types/OnTime360TimeWindowResponse1.js +5 -0
- package/dist/cjs/api/types/OnTime360ZoneResponse1.d.ts +9 -0
- package/dist/cjs/api/types/OnTime360ZoneResponse1.js +5 -0
- package/dist/cjs/api/types/OrgShippingIntegrationEnum1.d.ts +11 -0
- package/dist/cjs/api/types/OrgShippingIntegrationEnum1.js +13 -0
- package/dist/cjs/api/types/ShippingIntegrationConnection.d.ts +25 -0
- package/dist/cjs/api/types/ShippingIntegrationConnection.js +5 -0
- package/dist/cjs/api/types/ShippingIntegrationConnectionListRes.d.ts +8 -0
- package/dist/cjs/api/types/ShippingIntegrationConnectionListRes.js +5 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderExpanded1.d.ts +25 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderExpanded1.js +5 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderListRes.d.ts +8 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderListRes.js +5 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderPlace1.d.ts +21 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderPlace1.js +5 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderSortByEnum.d.ts +10 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderSortByEnum.js +12 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderStatusEnum1.d.ts +11 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderStatusEnum1.js +13 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderStatusSummaryRes.d.ts +14 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderStatusSummaryRes.js +5 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderTypeaheadFieldEnum.d.ts +4 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderTypeaheadFieldEnum.js +5 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderTypeaheadResult.d.ts +8 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderTypeaheadResult.js +5 -0
- package/dist/cjs/api/types/{WorkflowActor.d.ts → WorkflowCaller.d.ts} +1 -1
- package/dist/cjs/api/types/WorkflowCaller.js +5 -0
- package/dist/cjs/api/types/XceleratorCredsLimited1.d.ts +27 -0
- package/dist/cjs/api/types/XceleratorCredsLimited1.js +5 -0
- package/dist/cjs/api/types/XceleratorCredsListRes.d.ts +8 -0
- package/dist/cjs/api/types/XceleratorCredsListRes.js +5 -0
- package/dist/cjs/api/types/XceleratorCredsTestRes.d.ts +11 -0
- package/dist/cjs/api/types/XceleratorCredsTestRes.js +5 -0
- package/dist/cjs/api/types/XceleratorOrder1.d.ts +19 -0
- package/dist/cjs/api/types/XceleratorOrder1.js +5 -0
- package/dist/cjs/api/types/XceleratorOrderExpanded1.d.ts +20 -0
- package/dist/cjs/api/types/XceleratorOrderExpanded1.js +5 -0
- package/dist/cjs/api/types/XceleratorOrderExtraResponse1.d.ts +11 -0
- package/dist/cjs/api/types/XceleratorOrderExtraResponse1.js +5 -0
- package/dist/cjs/api/types/XceleratorOrderListRes.d.ts +8 -0
- package/dist/cjs/api/types/XceleratorOrderListRes.js +5 -0
- package/dist/cjs/api/types/XceleratorOrderPackageResponse1.d.ts +9 -0
- package/dist/cjs/api/types/XceleratorOrderPackageResponse1.js +5 -0
- package/dist/cjs/api/types/XceleratorOrderResponse1.d.ts +82 -0
- package/dist/cjs/api/types/XceleratorOrderResponse1.js +5 -0
- package/dist/cjs/api/types/XceleratorOrderSortByEnum.d.ts +10 -0
- package/dist/cjs/api/types/XceleratorOrderSortByEnum.js +12 -0
- package/dist/cjs/api/types/index.d.ts +72 -2
- package/dist/cjs/api/types/index.js +72 -2
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +3 -0
- package/dist/esm/Client.mjs +7 -2
- package/dist/esm/api/resources/billingNew/resources/billingPeriods/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/billingNew/resources/billingPeriods/client/Client.mjs +3 -0
- package/dist/esm/api/resources/billingNew/resources/billingPeriods/client/requests/BillingPeriodsListV1Request.d.mts +3 -0
- package/dist/esm/api/resources/billingNew/resources/chrtGroundProviderRates/client/Client.d.mts +5 -0
- package/dist/esm/api/resources/billingNew/resources/chrtGroundProviderRates/client/Client.mjs +5 -0
- package/dist/esm/api/resources/billingNew/resources/chrtGroundProviderRates/client/requests/ChrtGroundProviderRatesListV1Request.d.mts +5 -0
- package/dist/esm/api/resources/billingNew/resources/invoiceLineItems/client/Client.d.mts +4 -0
- package/dist/esm/api/resources/billingNew/resources/invoiceLineItems/client/Client.mjs +4 -0
- package/dist/esm/api/resources/billingNew/resources/invoiceLineItems/client/requests/InvoiceLineItemsListV1Request.d.mts +4 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/client/Client.mjs +3 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/client/requests/InvoicesListV1Request.d.mts +3 -0
- package/dist/esm/api/resources/billingNew/resources/orders/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/billingNew/resources/orders/client/Client.mjs +2 -0
- package/dist/esm/api/resources/billingNew/resources/orders/client/requests/OrderBillingExpandedListReq.d.mts +2 -0
- package/dist/esm/api/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/index.mjs +1 -0
- package/dist/esm/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.mjs +2 -2
- package/dist/esm/api/resources/listing/resources/bidThreads/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/listing/resources/bidThreads/client/Client.mjs +2 -0
- package/dist/esm/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForBidderV1Request.d.mts +1 -0
- package/dist/esm/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForListingV1Request.d.mts +1 -0
- package/dist/esm/api/resources/listing/resources/listings/client/Client.d.mts +6 -0
- package/dist/esm/api/resources/listing/resources/listings/client/Client.mjs +6 -0
- package/dist/esm/api/resources/listing/resources/listings/client/requests/ListingsListByOrgV1Request.d.mts +2 -0
- package/dist/esm/api/resources/listing/resources/listings/client/requests/ListingsListForDriverBidderV1Request.d.mts +2 -0
- package/dist/esm/api/resources/listing/resources/listings/client/requests/ListingsListForProviderBidderV1Request.d.mts +2 -0
- package/dist/esm/api/resources/listing/resources/orgBiddingGroups/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/listing/resources/orgBiddingGroups/client/Client.mjs +2 -2
- package/dist/esm/api/resources/notifications/resources/groups/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/notifications/resources/groups/client/Client.mjs +2 -2
- package/dist/esm/api/resources/operations/resources/departments/client/Client.d.mts +4 -3
- package/dist/esm/api/resources/operations/resources/departments/client/Client.mjs +4 -3
- package/dist/esm/api/resources/operations/resources/departments/client/requests/DepartmentsListV1Request.d.mts +2 -1
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.d.mts +6 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.mjs +6 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksExpandedListV1Request.d.mts +3 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksListV1Request.d.mts +3 -0
- package/dist/esm/api/resources/orgs/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/orgs/client/Client.mjs +1 -0
- package/dist/esm/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/orgs/resources/connections/client/Client.mjs +1 -1
- package/dist/esm/api/resources/orgs/resources/publicData/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/orgs/resources/publicData/client/Client.mjs +4 -4
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts +3 -1
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs +3 -1
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversListV1Request.d.mts +2 -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 +1 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/client/requests/OrderTemplatesNewListV1Request.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts +8 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs +8 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForProviderOperatorsV1Request.d.mts +5 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.mts +3 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverV1Request.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForProviderOperatorsV1Request.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/client/Client.d.mts +41 -0
- package/dist/esm/api/resources/shippingIntegrations/client/Client.mjs +43 -0
- package/dist/esm/api/resources/shippingIntegrations/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/index.mjs +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/client/Client.d.mts +26 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/client/Client.mjs +18 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/index.mjs +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/Client.d.mts +114 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/Client.mjs +388 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/requests/AtlasCredsClientCreate1.d.mts +15 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/requests/AtlasCredsClientUpdate1.d.mts +13 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/creds/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/creds/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/index.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.d.mts +120 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.mjs +405 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/AtlasOrderSyncOneReq.d.mts +15 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/AtlasOrderSyncOneReq.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersListV1Request.d.mts +50 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersListV1Request.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersTypeaheadV1Request.d.mts +16 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersTypeaheadV1Request.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/connections/client/Client.d.mts +44 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/connections/client/Client.mjs +84 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/connections/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/connections/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/connections/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/connections/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/client/Client.d.mts +26 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/client/Client.mjs +18 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/index.mjs +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/Client.d.mts +117 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/Client.mjs +391 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/requests/CxtCredsClientCreate1.d.mts +23 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/requests/CxtCredsClientCreate1.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/requests/CxtCredsClientUpdate1.d.mts +19 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/requests/CxtCredsClientUpdate1.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/creds/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/creds/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/index.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/Client.d.mts +104 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/Client.mjs +334 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/requests/CxtOrderSyncOneReq.d.mts +15 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/requests/CxtOrderSyncOneReq.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/requests/OrdersListV1Request.d.mts +50 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/requests/OrdersListV1Request.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/orders/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/cxt/resources/orders/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/client/Client.d.mts +26 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/client/Client.mjs +18 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/index.mjs +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/Client.d.mts +116 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/Client.mjs +390 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/requests/DispatchScienceCredsClientCreate1.d.mts +20 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/requests/DispatchScienceCredsClientCreate1.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/requests/DispatchScienceCredsClientUpdate1.d.mts +15 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/requests/DispatchScienceCredsClientUpdate1.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/index.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/Client.d.mts +105 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/Client.mjs +338 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/requests/DispatchScienceOrderSyncOneReq.d.mts +15 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/requests/DispatchScienceOrderSyncOneReq.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/requests/OrdersListV1Request.d.mts +51 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/requests/OrdersListV1Request.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/index.d.mts +8 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/index.mjs +8 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/client/Client.d.mts +26 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/client/Client.mjs +18 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/index.mjs +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.d.mts +116 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.mjs +390 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/requests/OnTime360CredsClientCreate1.d.mts +20 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/requests/OnTime360CredsClientCreate1.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/requests/OnTime360CredsClientUpdate1.d.mts +15 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/requests/OnTime360CredsClientUpdate1.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/creds/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/creds/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/index.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.d.mts +105 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.mjs +338 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/requests/OnTime360OrderSyncOneReq.d.mts +15 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/requests/OnTime360OrderSyncOneReq.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/requests/OrdersListV1Request.d.mts +51 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/requests/OrdersListV1Request.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/orders/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ontime360/resources/orders/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/Client.d.mts +118 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/Client.mjs +429 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersListV1Request.d.mts +57 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersListV1Request.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersStatusSummaryV1Request.d.mts +44 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersStatusSummaryV1Request.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersTypeaheadV1Request.d.mts +16 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersTypeaheadV1Request.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/client/Client.d.mts +26 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/client/Client.mjs +18 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/index.mjs +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.d.mts +116 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.mjs +390 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/requests/XceleratorCredsClientCreate1.d.mts +20 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/requests/XceleratorCredsClientCreate1.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/requests/XceleratorCredsClientUpdate1.d.mts +15 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/requests/XceleratorCredsClientUpdate1.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/index.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.d.mts +121 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.mjs +409 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/OrdersListV1Request.d.mts +51 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/OrdersListV1Request.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/OrdersTypeaheadV1Request.d.mts +16 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/OrdersTypeaheadV1Request.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/XceleratorOrderSyncOneReq.d.mts +15 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/XceleratorOrderSyncOneReq.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/index.mjs +1 -0
- package/dist/esm/api/types/AtlasCredsLimited1.d.mts +23 -0
- package/dist/esm/api/types/AtlasCredsLimited1.mjs +4 -0
- package/dist/esm/api/types/AtlasCredsListRes.d.mts +8 -0
- package/dist/esm/api/types/AtlasCredsListRes.mjs +4 -0
- package/dist/esm/api/types/AtlasCredsTestRes.d.mts +10 -0
- package/dist/esm/api/types/AtlasCredsTestRes.mjs +4 -0
- package/dist/esm/api/types/AtlasEventResponse1.d.mts +12 -0
- package/dist/esm/api/types/AtlasEventResponse1.mjs +4 -0
- package/dist/esm/api/types/AtlasOrder1.d.mts +19 -0
- package/dist/esm/api/types/AtlasOrder1.mjs +4 -0
- package/dist/esm/api/types/AtlasOrderExpanded1.d.mts +20 -0
- package/dist/esm/api/types/AtlasOrderExpanded1.mjs +4 -0
- package/dist/esm/api/types/AtlasOrderListRes.d.mts +8 -0
- package/dist/esm/api/types/AtlasOrderListRes.mjs +4 -0
- package/dist/esm/api/types/AtlasOrderResponse1.d.mts +21 -0
- package/dist/esm/api/types/AtlasOrderResponse1.mjs +4 -0
- package/dist/esm/api/types/AtlasOrderSortByEnum.d.mts +10 -0
- package/dist/esm/api/types/AtlasOrderSortByEnum.mjs +9 -0
- package/dist/esm/api/types/AtlasStopResponse1.d.mts +13 -0
- package/dist/esm/api/types/AtlasStopResponse1.mjs +4 -0
- package/dist/esm/api/types/CxtAuthTypeEnum1.d.mts +8 -0
- package/dist/esm/api/types/CxtAuthTypeEnum1.mjs +7 -0
- package/dist/esm/api/types/CxtCredsLimited1.d.mts +29 -0
- package/dist/esm/api/types/CxtCredsLimited1.mjs +4 -0
- package/dist/esm/api/types/CxtCredsListRes.d.mts +8 -0
- package/dist/esm/api/types/CxtCredsListRes.mjs +4 -0
- package/dist/esm/api/types/CxtCredsTestRes.d.mts +10 -0
- package/dist/esm/api/types/CxtCredsTestRes.mjs +4 -0
- package/dist/esm/api/types/CxtInetUserOrderResponse1.d.mts +11 -0
- package/dist/esm/api/types/CxtInetUserOrderResponse1.mjs +4 -0
- package/dist/esm/api/types/CxtOrder1.d.mts +22 -0
- package/dist/esm/api/types/CxtOrder1.mjs +4 -0
- package/dist/esm/api/types/CxtOrderDetailResponse1.d.mts +53 -0
- package/dist/esm/api/types/CxtOrderDetailResponse1.mjs +4 -0
- package/dist/esm/api/types/CxtOrderExpanded1.d.mts +23 -0
- package/dist/esm/api/types/CxtOrderExpanded1.mjs +4 -0
- package/dist/esm/api/types/CxtOrderListRes.d.mts +8 -0
- package/dist/esm/api/types/CxtOrderListRes.mjs +4 -0
- package/dist/esm/api/types/CxtOrderSortByEnum.d.mts +10 -0
- package/dist/esm/api/types/CxtOrderSortByEnum.mjs +9 -0
- package/dist/esm/api/types/CxtXdUserOrderResponse1.d.mts +58 -0
- package/dist/esm/api/types/CxtXdUserOrderResponse1.mjs +4 -0
- package/dist/esm/api/types/DispatchScienceAddressResponse1.d.mts +13 -0
- package/dist/esm/api/types/DispatchScienceAddressResponse1.mjs +4 -0
- package/dist/esm/api/types/DispatchScienceAttachmentResponse1.d.mts +16 -0
- package/dist/esm/api/types/DispatchScienceAttachmentResponse1.mjs +4 -0
- package/dist/esm/api/types/DispatchScienceChargeResponse1.d.mts +17 -0
- package/dist/esm/api/types/DispatchScienceChargeResponse1.mjs +4 -0
- package/dist/esm/api/types/DispatchScienceContactInfoResponse1.d.mts +12 -0
- package/dist/esm/api/types/DispatchScienceContactInfoResponse1.mjs +4 -0
- package/dist/esm/api/types/DispatchScienceCredsLimited1.d.mts +25 -0
- package/dist/esm/api/types/DispatchScienceCredsLimited1.mjs +4 -0
- package/dist/esm/api/types/DispatchScienceCredsListRes.d.mts +8 -0
- package/dist/esm/api/types/DispatchScienceCredsListRes.mjs +4 -0
- package/dist/esm/api/types/DispatchScienceCredsTestRes.d.mts +11 -0
- package/dist/esm/api/types/DispatchScienceCredsTestRes.mjs +4 -0
- package/dist/esm/api/types/DispatchScienceLocationResponse1.d.mts +13 -0
- package/dist/esm/api/types/DispatchScienceLocationResponse1.mjs +4 -0
- package/dist/esm/api/types/DispatchScienceOrder1.d.mts +19 -0
- package/dist/esm/api/types/DispatchScienceOrder1.mjs +4 -0
- package/dist/esm/api/types/DispatchScienceOrderListRes.d.mts +8 -0
- package/dist/esm/api/types/DispatchScienceOrderListRes.mjs +4 -0
- package/dist/esm/api/types/DispatchScienceOrderResponse1.d.mts +44 -0
- package/dist/esm/api/types/DispatchScienceOrderResponse1.mjs +4 -0
- package/dist/esm/api/types/DispatchScienceOrderSortByEnum.d.mts +10 -0
- package/dist/esm/api/types/DispatchScienceOrderSortByEnum.mjs +9 -0
- package/dist/esm/api/types/DispatchScienceTimeWindowResponse1.d.mts +9 -0
- package/dist/esm/api/types/DispatchScienceTimeWindowResponse1.mjs +4 -0
- package/dist/esm/api/types/DispatchScienceTimeZoneResponse1.d.mts +13 -0
- package/dist/esm/api/types/DispatchScienceTimeZoneResponse1.mjs +4 -0
- package/dist/esm/api/types/{GeometryCollectionGeometriesItem.d.mts → GeometriesItem.d.mts} +2 -2
- package/dist/esm/api/types/GeometriesItem.mjs +4 -0
- package/dist/esm/api/types/GeometryCollection.d.mts +1 -1
- package/dist/esm/api/types/InternalDelegationJwtReq.d.mts +1 -1
- package/dist/esm/api/types/OnTime360CredsLimited1.d.mts +26 -0
- package/dist/esm/api/types/OnTime360CredsLimited1.mjs +4 -0
- package/dist/esm/api/types/OnTime360CredsListRes.d.mts +8 -0
- package/dist/esm/api/types/OnTime360CredsListRes.mjs +4 -0
- package/dist/esm/api/types/OnTime360CredsTestRes.d.mts +13 -0
- package/dist/esm/api/types/OnTime360CredsTestRes.mjs +4 -0
- package/dist/esm/api/types/OnTime360ItemResponse1.d.mts +12 -0
- package/dist/esm/api/types/OnTime360ItemResponse1.mjs +4 -0
- package/dist/esm/api/types/OnTime360LocationResponse1.d.mts +19 -0
- package/dist/esm/api/types/OnTime360LocationResponse1.mjs +4 -0
- package/dist/esm/api/types/OnTime360Order1.d.mts +19 -0
- package/dist/esm/api/types/OnTime360Order1.mjs +4 -0
- package/dist/esm/api/types/OnTime360OrderListRes.d.mts +8 -0
- package/dist/esm/api/types/OnTime360OrderListRes.mjs +4 -0
- package/dist/esm/api/types/OnTime360OrderResponse1.d.mts +58 -0
- package/dist/esm/api/types/OnTime360OrderResponse1.mjs +4 -0
- package/dist/esm/api/types/OnTime360OrderSortByEnum.d.mts +10 -0
- package/dist/esm/api/types/OnTime360OrderSortByEnum.mjs +9 -0
- package/dist/esm/api/types/OnTime360PriceModifierResponse1.d.mts +11 -0
- package/dist/esm/api/types/OnTime360PriceModifierResponse1.mjs +4 -0
- package/dist/esm/api/types/OnTime360StatusLevelEnum1.d.mts +11 -0
- package/dist/esm/api/types/OnTime360StatusLevelEnum1.mjs +4 -0
- package/dist/esm/api/types/OnTime360StatusResponse1.d.mts +13 -0
- package/dist/esm/api/types/OnTime360StatusResponse1.mjs +4 -0
- package/dist/esm/api/types/OnTime360TimeWindowResponse1.d.mts +10 -0
- package/dist/esm/api/types/OnTime360TimeWindowResponse1.mjs +4 -0
- package/dist/esm/api/types/OnTime360ZoneResponse1.d.mts +9 -0
- package/dist/esm/api/types/OnTime360ZoneResponse1.mjs +4 -0
- package/dist/esm/api/types/OrgShippingIntegrationEnum1.d.mts +11 -0
- package/dist/esm/api/types/OrgShippingIntegrationEnum1.mjs +10 -0
- package/dist/esm/api/types/ShippingIntegrationConnection.d.mts +25 -0
- package/dist/esm/api/types/ShippingIntegrationConnection.mjs +4 -0
- package/dist/esm/api/types/ShippingIntegrationConnectionListRes.d.mts +8 -0
- package/dist/esm/api/types/ShippingIntegrationConnectionListRes.mjs +4 -0
- package/dist/esm/api/types/ShippingIntegrationOrderExpanded1.d.mts +25 -0
- package/dist/esm/api/types/ShippingIntegrationOrderExpanded1.mjs +4 -0
- package/dist/esm/api/types/ShippingIntegrationOrderListRes.d.mts +8 -0
- package/dist/esm/api/types/ShippingIntegrationOrderListRes.mjs +4 -0
- package/dist/esm/api/types/ShippingIntegrationOrderPlace1.d.mts +21 -0
- package/dist/esm/api/types/ShippingIntegrationOrderPlace1.mjs +4 -0
- package/dist/esm/api/types/ShippingIntegrationOrderSortByEnum.d.mts +10 -0
- package/dist/esm/api/types/ShippingIntegrationOrderSortByEnum.mjs +9 -0
- package/dist/esm/api/types/ShippingIntegrationOrderStatusEnum1.d.mts +11 -0
- package/dist/esm/api/types/ShippingIntegrationOrderStatusEnum1.mjs +10 -0
- package/dist/esm/api/types/ShippingIntegrationOrderStatusSummaryRes.d.mts +14 -0
- package/dist/esm/api/types/ShippingIntegrationOrderStatusSummaryRes.mjs +4 -0
- package/dist/esm/api/types/ShippingIntegrationOrderTypeaheadFieldEnum.d.mts +4 -0
- package/dist/esm/api/types/ShippingIntegrationOrderTypeaheadFieldEnum.mjs +4 -0
- package/dist/esm/api/types/ShippingIntegrationOrderTypeaheadResult.d.mts +8 -0
- package/dist/esm/api/types/ShippingIntegrationOrderTypeaheadResult.mjs +4 -0
- package/dist/esm/api/types/{WorkflowActor.d.mts → WorkflowCaller.d.mts} +1 -1
- package/dist/esm/api/types/WorkflowCaller.mjs +4 -0
- package/dist/esm/api/types/XceleratorCredsLimited1.d.mts +27 -0
- package/dist/esm/api/types/XceleratorCredsLimited1.mjs +4 -0
- package/dist/esm/api/types/XceleratorCredsListRes.d.mts +8 -0
- package/dist/esm/api/types/XceleratorCredsListRes.mjs +4 -0
- package/dist/esm/api/types/XceleratorCredsTestRes.d.mts +11 -0
- package/dist/esm/api/types/XceleratorCredsTestRes.mjs +4 -0
- package/dist/esm/api/types/XceleratorOrder1.d.mts +19 -0
- package/dist/esm/api/types/XceleratorOrder1.mjs +4 -0
- package/dist/esm/api/types/XceleratorOrderExpanded1.d.mts +20 -0
- package/dist/esm/api/types/XceleratorOrderExpanded1.mjs +4 -0
- package/dist/esm/api/types/XceleratorOrderExtraResponse1.d.mts +11 -0
- package/dist/esm/api/types/XceleratorOrderExtraResponse1.mjs +4 -0
- package/dist/esm/api/types/XceleratorOrderListRes.d.mts +8 -0
- package/dist/esm/api/types/XceleratorOrderListRes.mjs +4 -0
- package/dist/esm/api/types/XceleratorOrderPackageResponse1.d.mts +9 -0
- package/dist/esm/api/types/XceleratorOrderPackageResponse1.mjs +4 -0
- package/dist/esm/api/types/XceleratorOrderResponse1.d.mts +82 -0
- package/dist/esm/api/types/XceleratorOrderResponse1.mjs +4 -0
- package/dist/esm/api/types/XceleratorOrderSortByEnum.d.mts +10 -0
- package/dist/esm/api/types/XceleratorOrderSortByEnum.mjs +9 -0
- package/dist/esm/api/types/index.d.mts +72 -2
- package/dist/esm/api/types/index.mjs +72 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +3905 -13
- /package/dist/cjs/api/{types/GeometryCollectionGeometriesItem.js → resources/shippingIntegrations/resources/atlas/resources/creds/client/requests/AtlasCredsClientCreate1.js} +0 -0
- /package/dist/cjs/api/{types/WorkflowActor.js → resources/shippingIntegrations/resources/atlas/resources/creds/client/requests/AtlasCredsClientUpdate1.js} +0 -0
- /package/dist/esm/api/{types/GeometryCollectionGeometriesItem.mjs → resources/shippingIntegrations/resources/atlas/resources/creds/client/requests/AtlasCredsClientCreate1.mjs} +0 -0
- /package/dist/esm/api/{types/WorkflowActor.mjs → resources/shippingIntegrations/resources/atlas/resources/creds/client/requests/AtlasCredsClientUpdate1.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -156,6 +156,7 @@ Lists all members of the caller's organization with their roles and details. Sup
|
|
|
156
156
|
|
|
157
157
|
```typescript
|
|
158
158
|
await client.orgs.listMembersV1({
|
|
159
|
+
filter_role: ["owner"],
|
|
159
160
|
sort_by: "first_name",
|
|
160
161
|
sort_order: "asc",
|
|
161
162
|
page: 1,
|
|
@@ -1195,6 +1196,9 @@ await client.billingNew.billingPeriods.listV1({
|
|
|
1195
1196
|
sort_order: "asc",
|
|
1196
1197
|
page: 1,
|
|
1197
1198
|
page_size: 1,
|
|
1199
|
+
filter_statuses: ["open"],
|
|
1200
|
+
filter_invoice_types: ["accounts_receivable"],
|
|
1201
|
+
filter_currency_codes: ["USD"],
|
|
1198
1202
|
filter_counterparty_org_id: "filter_counterparty_org_id",
|
|
1199
1203
|
filter_counterparty_off_chrt_org_data_id: "filter_counterparty_off_chrt_org_data_id",
|
|
1200
1204
|
filter_counterparty_driver_id: "filter_counterparty_driver_id",
|
|
@@ -1685,10 +1689,15 @@ await client.billingNew.chrtGroundProviderRates.listV1({
|
|
|
1685
1689
|
sort_order: "asc",
|
|
1686
1690
|
page: 1,
|
|
1687
1691
|
page_size: 1,
|
|
1692
|
+
filter_service_line: ["on_demand"],
|
|
1693
|
+
filter_invoice_types: ["accounts_receivable"],
|
|
1694
|
+
filter_currency_codes: ["USD"],
|
|
1688
1695
|
filter_counterparty_org_id: "filter_counterparty_org_id",
|
|
1689
1696
|
filter_counterparty_off_chrt_org_data_id: "filter_counterparty_off_chrt_org_data_id",
|
|
1690
1697
|
filter_shipper_account_id: "filter_shipper_account_id",
|
|
1691
1698
|
filter_counterparty_driver_id: "filter_counterparty_driver_id",
|
|
1699
|
+
filter_cargo_types: ["spare_parts"],
|
|
1700
|
+
filter_vehicle_types: ["sedan"],
|
|
1692
1701
|
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
1693
1702
|
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
1694
1703
|
filter_updated_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -2616,6 +2625,10 @@ await client.billingNew.invoiceLineItems.listV1({
|
|
|
2616
2625
|
sort_order: "asc",
|
|
2617
2626
|
page: 1,
|
|
2618
2627
|
page_size: 1,
|
|
2628
|
+
filter_invoice_types: ["accounts_receivable"],
|
|
2629
|
+
filter_currency_codes: ["USD"],
|
|
2630
|
+
filter_line_item_types: ["base_rate"],
|
|
2631
|
+
filter_units: ["each"],
|
|
2619
2632
|
filter_counterparty_org_id: "filter_counterparty_org_id",
|
|
2620
2633
|
filter_counterparty_off_chrt_org_data_id: "filter_counterparty_off_chrt_org_data_id",
|
|
2621
2634
|
filter_counterparty_driver_id: "filter_counterparty_driver_id",
|
|
@@ -3379,6 +3392,9 @@ await client.billingNew.invoices.listV1({
|
|
|
3379
3392
|
sort_order: "asc",
|
|
3380
3393
|
page: 1,
|
|
3381
3394
|
page_size: 1,
|
|
3395
|
+
filter_statuses: ["draft"],
|
|
3396
|
+
filter_invoice_types: ["accounts_receivable"],
|
|
3397
|
+
filter_currency_codes: ["USD"],
|
|
3382
3398
|
filter_counterparty_org_id: "filter_counterparty_org_id",
|
|
3383
3399
|
filter_counterparty_off_chrt_org_data_id: "filter_counterparty_off_chrt_org_data_id",
|
|
3384
3400
|
filter_counterparty_driver_id: "filter_counterparty_driver_id",
|
|
@@ -3803,9 +3819,11 @@ await client.billingNew.orders.listExpandedForCoordinatorOperatorsV1({
|
|
|
3803
3819
|
page: 1,
|
|
3804
3820
|
page_size: 1,
|
|
3805
3821
|
search: "search",
|
|
3822
|
+
filter_status: ["draft"],
|
|
3806
3823
|
filter_awb_number: "filter_awb_number",
|
|
3807
3824
|
filter_shipper_org_id: "filter_shipper_org_id",
|
|
3808
3825
|
filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
|
|
3826
|
+
filter_coordinator_shipper_account_ids: ["filter_coordinator_shipper_account_ids"],
|
|
3809
3827
|
filter_executor_org_id: "filter_executor_org_id",
|
|
3810
3828
|
filter_coordinator_label: "filter_coordinator_label",
|
|
3811
3829
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -4486,7 +4504,7 @@ await client.integrations.cargoaiTrackAndTrace.subscriptionV1("awb");
|
|
|
4486
4504
|
<dl>
|
|
4487
4505
|
<dd>
|
|
4488
4506
|
|
|
4489
|
-
**awb:** `string`
|
|
4507
|
+
**awb:** `string` — IATA Air Waybill number: 3-digit airline prefix + 8-digit serial, e.g. '020-12345678'.
|
|
4490
4508
|
|
|
4491
4509
|
</dd>
|
|
4492
4510
|
</dl>
|
|
@@ -4612,7 +4630,7 @@ await client.integrations.cargoaiTrackAndTrace.updatesV1("awb");
|
|
|
4612
4630
|
<dl>
|
|
4613
4631
|
<dd>
|
|
4614
4632
|
|
|
4615
|
-
**awb:** `string`
|
|
4633
|
+
**awb:** `string` — IATA Air Waybill number: 3-digit airline prefix + 8-digit serial, e.g. '020-12345678'.
|
|
4616
4634
|
|
|
4617
4635
|
</dd>
|
|
4618
4636
|
</dl>
|
|
@@ -5277,6 +5295,7 @@ await client.listing.bidThreads.listForBidderV1({
|
|
|
5277
5295
|
sort_order: "asc",
|
|
5278
5296
|
page: 1,
|
|
5279
5297
|
page_size: 1,
|
|
5298
|
+
filter_status: ["open"],
|
|
5280
5299
|
filter_listing_id: "filter_listing_id",
|
|
5281
5300
|
filter_bidder_provider_org_id: "filter_bidder_provider_org_id",
|
|
5282
5301
|
filter_bidder_driver_id: "filter_bidder_driver_id",
|
|
@@ -5352,6 +5371,7 @@ await client.listing.bidThreads.listForListingV1("listing_id", {
|
|
|
5352
5371
|
sort_order: "asc",
|
|
5353
5372
|
page: 1,
|
|
5354
5373
|
page_size: 1,
|
|
5374
|
+
filter_status: ["open"],
|
|
5355
5375
|
filter_listing_id: "filter_listing_id",
|
|
5356
5376
|
filter_bidder_provider_org_id: "filter_bidder_provider_org_id",
|
|
5357
5377
|
filter_bidder_driver_id: "filter_bidder_driver_id",
|
|
@@ -6454,6 +6474,8 @@ await client.listing.listings.listByOrgV1({
|
|
|
6454
6474
|
sort_order: "asc",
|
|
6455
6475
|
page: 1,
|
|
6456
6476
|
page_size: 1,
|
|
6477
|
+
filter_status: ["open"],
|
|
6478
|
+
filter_type: ["dispatch"],
|
|
6457
6479
|
filter_task_group_id: "filter_task_group_id",
|
|
6458
6480
|
filter_order_id: "filter_order_id",
|
|
6459
6481
|
filter_created_by_org_id: "filter_created_by_org_id",
|
|
@@ -6530,6 +6552,8 @@ await client.listing.listings.listForDriverBidderV1({
|
|
|
6530
6552
|
sort_order: "asc",
|
|
6531
6553
|
page: 1,
|
|
6532
6554
|
page_size: 1,
|
|
6555
|
+
filter_status: ["open"],
|
|
6556
|
+
filter_type: ["dispatch"],
|
|
6533
6557
|
filter_task_group_id: "filter_task_group_id",
|
|
6534
6558
|
filter_order_id: "filter_order_id",
|
|
6535
6559
|
filter_created_by_org_id: "filter_created_by_org_id",
|
|
@@ -6606,6 +6630,8 @@ await client.listing.listings.listForProviderBidderV1({
|
|
|
6606
6630
|
sort_order: "asc",
|
|
6607
6631
|
page: 1,
|
|
6608
6632
|
page_size: 1,
|
|
6633
|
+
filter_status: ["open"],
|
|
6634
|
+
filter_type: ["dispatch"],
|
|
6609
6635
|
filter_task_group_id: "filter_task_group_id",
|
|
6610
6636
|
filter_order_id: "filter_order_id",
|
|
6611
6637
|
filter_created_by_org_id: "filter_created_by_org_id",
|
|
@@ -6916,7 +6942,7 @@ await client.listing.orgBiddingGroups.addProviderMemberV1("group_id", "provider_
|
|
|
6916
6942
|
<dl>
|
|
6917
6943
|
<dd>
|
|
6918
6944
|
|
|
6919
|
-
**providerOrgId:** `string`
|
|
6945
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
6920
6946
|
|
|
6921
6947
|
</dd>
|
|
6922
6948
|
</dl>
|
|
@@ -7253,7 +7279,7 @@ await client.listing.orgBiddingGroups.removeProviderMemberV1("group_id", "provid
|
|
|
7253
7279
|
<dl>
|
|
7254
7280
|
<dd>
|
|
7255
7281
|
|
|
7256
|
-
**providerOrgId:** `string`
|
|
7282
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
7257
7283
|
|
|
7258
7284
|
</dd>
|
|
7259
7285
|
</dl>
|
|
@@ -7839,7 +7865,7 @@ await client.notifications.groups.addUserV1("group_id", "user_id");
|
|
|
7839
7865
|
<dl>
|
|
7840
7866
|
<dd>
|
|
7841
7867
|
|
|
7842
|
-
**userId:** `string`
|
|
7868
|
+
**userId:** `string` — Must be a string starting with `user_`
|
|
7843
7869
|
|
|
7844
7870
|
</dd>
|
|
7845
7871
|
</dl>
|
|
@@ -8376,7 +8402,7 @@ await client.notifications.groups.removeUserV1("group_id", "user_id");
|
|
|
8376
8402
|
<dl>
|
|
8377
8403
|
<dd>
|
|
8378
8404
|
|
|
8379
|
-
**userId:** `string`
|
|
8405
|
+
**userId:** `string` — Must be a string starting with `user_`
|
|
8380
8406
|
|
|
8381
8407
|
</dd>
|
|
8382
8408
|
</dl>
|
|
@@ -9045,7 +9071,7 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
9045
9071
|
<dl>
|
|
9046
9072
|
<dd>
|
|
9047
9073
|
|
|
9048
|
-
**userId:** `string`
|
|
9074
|
+
**userId:** `string` — Must be a string starting with `user_`
|
|
9049
9075
|
|
|
9050
9076
|
</dd>
|
|
9051
9077
|
</dl>
|
|
@@ -9097,6 +9123,7 @@ await client.operations.departments.listV1({
|
|
|
9097
9123
|
sort_order: "asc",
|
|
9098
9124
|
page: 1,
|
|
9099
9125
|
page_size: 1,
|
|
9126
|
+
filter_department_type: ["aerospace"],
|
|
9100
9127
|
});
|
|
9101
9128
|
```
|
|
9102
9129
|
|
|
@@ -9184,7 +9211,7 @@ await client.operations.departments.removeOperatorV1("department_id", "user_id")
|
|
|
9184
9211
|
<dl>
|
|
9185
9212
|
<dd>
|
|
9186
9213
|
|
|
9187
|
-
**userId:** `string`
|
|
9214
|
+
**userId:** `string` — Must be a string starting with `user_`
|
|
9188
9215
|
|
|
9189
9216
|
</dd>
|
|
9190
9217
|
</dl>
|
|
@@ -10563,9 +10590,12 @@ await client.operations.operationsTasks.expandedListV1({
|
|
|
10563
10590
|
page: 1,
|
|
10564
10591
|
page_size: 1,
|
|
10565
10592
|
search: "search",
|
|
10593
|
+
filter_order_ids: ["filter_order_ids"],
|
|
10566
10594
|
filter_order_short_id: "filter_order_short_id",
|
|
10567
10595
|
filter_order_off_chrt_reference_id: "filter_order_off_chrt_reference_id",
|
|
10568
10596
|
filter_department_id: "filter_department_id",
|
|
10597
|
+
filter_task_type: ["review_order_details"],
|
|
10598
|
+
filter_status: ["not_started"],
|
|
10569
10599
|
filter_assigned_user_id: "filter_assigned_user_id",
|
|
10570
10600
|
filter_source_task_list_id: "filter_source_task_list_id",
|
|
10571
10601
|
filter_deadline_gte: "2024-01-15T09:30:00Z",
|
|
@@ -10639,9 +10669,12 @@ await client.operations.operationsTasks.listV1({
|
|
|
10639
10669
|
page: 1,
|
|
10640
10670
|
page_size: 1,
|
|
10641
10671
|
search: "search",
|
|
10672
|
+
filter_order_ids: ["filter_order_ids"],
|
|
10642
10673
|
filter_order_short_id: "filter_order_short_id",
|
|
10643
10674
|
filter_order_off_chrt_reference_id: "filter_order_off_chrt_reference_id",
|
|
10644
10675
|
filter_department_id: "filter_department_id",
|
|
10676
|
+
filter_task_type: ["review_order_details"],
|
|
10677
|
+
filter_status: ["not_started"],
|
|
10645
10678
|
filter_assigned_user_id: "filter_assigned_user_id",
|
|
10646
10679
|
filter_source_task_list_id: "filter_source_task_list_id",
|
|
10647
10680
|
filter_deadline_gte: "2024-01-15T09:30:00Z",
|
|
@@ -12201,7 +12234,7 @@ await client.orgs.connections.getByHandleV1("handle");
|
|
|
12201
12234
|
<dl>
|
|
12202
12235
|
<dd>
|
|
12203
12236
|
|
|
12204
|
-
**handle:** `string`
|
|
12237
|
+
**handle:** `string` — Must be a string starting with `@`. May only contain a-z, A-Z, 0-9, \_, -. May not be longer than 30 characters.
|
|
12205
12238
|
|
|
12206
12239
|
</dd>
|
|
12207
12240
|
</dl>
|
|
@@ -13697,7 +13730,7 @@ await client.orgs.publicData.getAvatarV1("handle");
|
|
|
13697
13730
|
<dl>
|
|
13698
13731
|
<dd>
|
|
13699
13732
|
|
|
13700
|
-
**handle:** `string`
|
|
13733
|
+
**handle:** `string` — Must be a string starting with `@`. May only contain a-z, A-Z, 0-9, \_, -. May not be longer than 30 characters.
|
|
13701
13734
|
|
|
13702
13735
|
</dd>
|
|
13703
13736
|
</dl>
|
|
@@ -13760,7 +13793,7 @@ await client.orgs.publicData.getByHandleV1("handle");
|
|
|
13760
13793
|
<dl>
|
|
13761
13794
|
<dd>
|
|
13762
13795
|
|
|
13763
|
-
**handle:** `string`
|
|
13796
|
+
**handle:** `string` — Must be a string starting with `@`. May only contain a-z, A-Z, 0-9, \_, -. May not be longer than 30 characters.
|
|
13764
13797
|
|
|
13765
13798
|
</dd>
|
|
13766
13799
|
</dl>
|
|
@@ -13823,7 +13856,7 @@ await client.orgs.publicData.getHandleAvailabilityV1("handle");
|
|
|
13823
13856
|
<dl>
|
|
13824
13857
|
<dd>
|
|
13825
13858
|
|
|
13826
|
-
**handle:** `string`
|
|
13859
|
+
**handle:** `string` — Must be a string starting with `@`. May only contain a-z, A-Z, 0-9, \_, -. May not be longer than 30 characters.
|
|
13827
13860
|
|
|
13828
13861
|
</dd>
|
|
13829
13862
|
</dl>
|
|
@@ -14004,7 +14037,7 @@ await client.orgs.publicData.getByOrgIdV1("org_id");
|
|
|
14004
14037
|
<dl>
|
|
14005
14038
|
<dd>
|
|
14006
14039
|
|
|
14007
|
-
**orgId:** `string`
|
|
14040
|
+
**orgId:** `string` — Must be a string starting with `org_`
|
|
14008
14041
|
|
|
14009
14042
|
</dd>
|
|
14010
14043
|
</dl>
|
|
@@ -14704,6 +14737,7 @@ await client.shipping.drivers.listV1({
|
|
|
14704
14737
|
search: "search",
|
|
14705
14738
|
filter_available_according_to_driver: true,
|
|
14706
14739
|
filter_available_according_to_operators: true,
|
|
14740
|
+
filter_status: ["unassigned"],
|
|
14707
14741
|
});
|
|
14708
14742
|
```
|
|
14709
14743
|
|
|
@@ -14769,6 +14803,7 @@ Lists all organization members paired with their driver information if they are
|
|
|
14769
14803
|
```typescript
|
|
14770
14804
|
await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
14771
14805
|
search: "search",
|
|
14806
|
+
filter_role: ["owner"],
|
|
14772
14807
|
filter_available_according_to_driver: true,
|
|
14773
14808
|
filter_available_according_to_operators: true,
|
|
14774
14809
|
sort_by: "first_name",
|
|
@@ -16173,6 +16208,7 @@ await client.shipping.orderTemplatesNew.listV1({
|
|
|
16173
16208
|
filter_off_chrt_executor_org_data_id: "filter_off_chrt_executor_org_data_id",
|
|
16174
16209
|
filter_shipper_org_id: "filter_shipper_org_id",
|
|
16175
16210
|
filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
|
|
16211
|
+
filter_coordinator_shipper_account_ids: ["filter_coordinator_shipper_account_ids"],
|
|
16176
16212
|
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16177
16213
|
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16178
16214
|
filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -21555,6 +21591,9 @@ await client.shipping.orders.expanded.listForProviderOperatorsV1({
|
|
|
21555
21591
|
page: 1,
|
|
21556
21592
|
page_size: 1,
|
|
21557
21593
|
search: "search",
|
|
21594
|
+
filter_status: ["draft"],
|
|
21595
|
+
filter_service_line: ["on_demand"],
|
|
21596
|
+
filter_order_classification_by_task_group_type: ["chrt_ground_provider"],
|
|
21558
21597
|
filter_awb_number: "filter_awb_number",
|
|
21559
21598
|
filter_has_invoice: true,
|
|
21560
21599
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -21574,7 +21613,9 @@ await client.shipping.orders.expanded.listForProviderOperatorsV1({
|
|
|
21574
21613
|
filter_coordinator_org_id: "filter_coordinator_org_id",
|
|
21575
21614
|
filter_shipper_org_id: "filter_shipper_org_id",
|
|
21576
21615
|
filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
|
|
21616
|
+
filter_coordinator_shipper_account_ids: ["filter_coordinator_shipper_account_ids"],
|
|
21577
21617
|
filter_coordinator_department_id: "filter_coordinator_department_id",
|
|
21618
|
+
filter_coordinator_assigned_user_ids: ["filter_coordinator_assigned_user_ids"],
|
|
21578
21619
|
filter_coordinator_label: "filter_coordinator_label",
|
|
21579
21620
|
body: {},
|
|
21580
21621
|
});
|
|
@@ -21646,6 +21687,9 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
21646
21687
|
page: 1,
|
|
21647
21688
|
page_size: 1,
|
|
21648
21689
|
search: "search",
|
|
21690
|
+
filter_status: ["draft"],
|
|
21691
|
+
filter_service_line: ["on_demand"],
|
|
21692
|
+
filter_order_classification_by_task_group_type: ["chrt_ground_provider"],
|
|
21649
21693
|
filter_awb_number: "filter_awb_number",
|
|
21650
21694
|
filter_has_invoice: true,
|
|
21651
21695
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -23486,6 +23530,7 @@ await client.shipping.taskGroups.expanded.listForDriverV1({
|
|
|
23486
23530
|
page: 1,
|
|
23487
23531
|
page_size: 1,
|
|
23488
23532
|
search: "search",
|
|
23533
|
+
filter_status: ["draft"],
|
|
23489
23534
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23490
23535
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23491
23536
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -23574,6 +23619,7 @@ await client.shipping.taskGroups.expanded.listForProviderOperatorsV1({
|
|
|
23574
23619
|
page: 1,
|
|
23575
23620
|
page_size: 1,
|
|
23576
23621
|
search: "search",
|
|
23622
|
+
filter_status: ["draft"],
|
|
23577
23623
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23578
23624
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23579
23625
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -24105,6 +24151,3852 @@ await client.shipping.tasks.executorOrgNotes.addV1("task_id", {
|
|
|
24105
24151
|
</dl>
|
|
24106
24152
|
</details>
|
|
24107
24153
|
|
|
24154
|
+
## ShippingIntegrations Connections
|
|
24155
|
+
|
|
24156
|
+
<details><summary><code>client.shippingIntegrations.connections.<a href="/src/api/resources/shippingIntegrations/resources/connections/client/Client.ts">listV1</a>() -> Chrt.ShippingIntegrationConnectionListRes</code></summary>
|
|
24157
|
+
<dl>
|
|
24158
|
+
<dd>
|
|
24159
|
+
|
|
24160
|
+
#### 📝 Description
|
|
24161
|
+
|
|
24162
|
+
<dl>
|
|
24163
|
+
<dd>
|
|
24164
|
+
|
|
24165
|
+
<dl>
|
|
24166
|
+
<dd>
|
|
24167
|
+
|
|
24168
|
+
Lists every provider the caller's organization has credentials for, across all shipping integrations, with public organization data expanded. | () -> (ShippingIntegrationConnectionListRes)
|
|
24169
|
+
|
|
24170
|
+
</dd>
|
|
24171
|
+
</dl>
|
|
24172
|
+
</dd>
|
|
24173
|
+
</dl>
|
|
24174
|
+
|
|
24175
|
+
#### 🔌 Usage
|
|
24176
|
+
|
|
24177
|
+
<dl>
|
|
24178
|
+
<dd>
|
|
24179
|
+
|
|
24180
|
+
<dl>
|
|
24181
|
+
<dd>
|
|
24182
|
+
|
|
24183
|
+
```typescript
|
|
24184
|
+
await client.shippingIntegrations.connections.listV1();
|
|
24185
|
+
```
|
|
24186
|
+
|
|
24187
|
+
</dd>
|
|
24188
|
+
</dl>
|
|
24189
|
+
</dd>
|
|
24190
|
+
</dl>
|
|
24191
|
+
|
|
24192
|
+
#### ⚙️ Parameters
|
|
24193
|
+
|
|
24194
|
+
<dl>
|
|
24195
|
+
<dd>
|
|
24196
|
+
|
|
24197
|
+
<dl>
|
|
24198
|
+
<dd>
|
|
24199
|
+
|
|
24200
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
24201
|
+
|
|
24202
|
+
</dd>
|
|
24203
|
+
</dl>
|
|
24204
|
+
</dd>
|
|
24205
|
+
</dl>
|
|
24206
|
+
|
|
24207
|
+
</dd>
|
|
24208
|
+
</dl>
|
|
24209
|
+
</details>
|
|
24210
|
+
|
|
24211
|
+
## ShippingIntegrations Orders
|
|
24212
|
+
|
|
24213
|
+
<details><summary><code>client.shippingIntegrations.orders.<a href="/src/api/resources/shippingIntegrations/resources/orders/client/Client.ts">detailV1</a>(id) -> Chrt.ShippingIntegrationOrderExpanded1</code></summary>
|
|
24214
|
+
<dl>
|
|
24215
|
+
<dd>
|
|
24216
|
+
|
|
24217
|
+
#### 📝 Description
|
|
24218
|
+
|
|
24219
|
+
<dl>
|
|
24220
|
+
<dd>
|
|
24221
|
+
|
|
24222
|
+
<dl>
|
|
24223
|
+
<dd>
|
|
24224
|
+
|
|
24225
|
+
Returns one unified shipping integration order by its Mongo ObjectId with the provider organization expanded. | () -> (ShippingIntegrationOrderExpanded1)
|
|
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.orders.detailV1("id");
|
|
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
|
+
**id:** `string` — Mongo ObjectId of the unified order document. The provider's own order ID is the integration_order_id field on the returned order.
|
|
24258
|
+
|
|
24259
|
+
</dd>
|
|
24260
|
+
</dl>
|
|
24261
|
+
|
|
24262
|
+
<dl>
|
|
24263
|
+
<dd>
|
|
24264
|
+
|
|
24265
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
24266
|
+
|
|
24267
|
+
</dd>
|
|
24268
|
+
</dl>
|
|
24269
|
+
</dd>
|
|
24270
|
+
</dl>
|
|
24271
|
+
|
|
24272
|
+
</dd>
|
|
24273
|
+
</dl>
|
|
24274
|
+
</details>
|
|
24275
|
+
|
|
24276
|
+
<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
|
+
<dl>
|
|
24278
|
+
<dd>
|
|
24279
|
+
|
|
24280
|
+
#### 📝 Description
|
|
24281
|
+
|
|
24282
|
+
<dl>
|
|
24283
|
+
<dd>
|
|
24284
|
+
|
|
24285
|
+
<dl>
|
|
24286
|
+
<dd>
|
|
24287
|
+
|
|
24288
|
+
Lists the caller's orders from every shipping integration with provider organizations expanded, filtering, sorting, pagination, and optional search. | () -> (ShippingIntegrationOrderListRes)
|
|
24289
|
+
|
|
24290
|
+
</dd>
|
|
24291
|
+
</dl>
|
|
24292
|
+
</dd>
|
|
24293
|
+
</dl>
|
|
24294
|
+
|
|
24295
|
+
#### 🔌 Usage
|
|
24296
|
+
|
|
24297
|
+
<dl>
|
|
24298
|
+
<dd>
|
|
24299
|
+
|
|
24300
|
+
<dl>
|
|
24301
|
+
<dd>
|
|
24302
|
+
|
|
24303
|
+
```typescript
|
|
24304
|
+
await client.shippingIntegrations.orders.listV1({
|
|
24305
|
+
sort_by: "ordered_at_timestamp",
|
|
24306
|
+
sort_order: "asc",
|
|
24307
|
+
page: 1,
|
|
24308
|
+
page_size: 1,
|
|
24309
|
+
search: "search",
|
|
24310
|
+
filter_shipping_integration: ["xcelerator"],
|
|
24311
|
+
filter_provider_org_id: ["filter_provider_org_id"],
|
|
24312
|
+
filter_status: ["staged"],
|
|
24313
|
+
filter_integration_order_id: "filter_integration_order_id",
|
|
24314
|
+
filter_reference_number: "filter_reference_number",
|
|
24315
|
+
filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24316
|
+
filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24317
|
+
filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24318
|
+
filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24319
|
+
filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24320
|
+
filter_first_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24321
|
+
});
|
|
24322
|
+
```
|
|
24323
|
+
|
|
24324
|
+
</dd>
|
|
24325
|
+
</dl>
|
|
24326
|
+
</dd>
|
|
24327
|
+
</dl>
|
|
24328
|
+
|
|
24329
|
+
#### ⚙️ Parameters
|
|
24330
|
+
|
|
24331
|
+
<dl>
|
|
24332
|
+
<dd>
|
|
24333
|
+
|
|
24334
|
+
<dl>
|
|
24335
|
+
<dd>
|
|
24336
|
+
|
|
24337
|
+
**request:** `Chrt.shippingIntegrations.OrdersListV1Request`
|
|
24338
|
+
|
|
24339
|
+
</dd>
|
|
24340
|
+
</dl>
|
|
24341
|
+
|
|
24342
|
+
<dl>
|
|
24343
|
+
<dd>
|
|
24344
|
+
|
|
24345
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
24346
|
+
|
|
24347
|
+
</dd>
|
|
24348
|
+
</dl>
|
|
24349
|
+
</dd>
|
|
24350
|
+
</dl>
|
|
24351
|
+
|
|
24352
|
+
</dd>
|
|
24353
|
+
</dl>
|
|
24354
|
+
</details>
|
|
24355
|
+
|
|
24356
|
+
<details><summary><code>client.shippingIntegrations.orders.<a href="/src/api/resources/shippingIntegrations/resources/orders/client/Client.ts">statusSummaryV1</a>({ ...params }) -> Chrt.ShippingIntegrationOrderStatusSummaryRes</code></summary>
|
|
24357
|
+
<dl>
|
|
24358
|
+
<dd>
|
|
24359
|
+
|
|
24360
|
+
#### 📝 Description
|
|
24361
|
+
|
|
24362
|
+
<dl>
|
|
24363
|
+
<dd>
|
|
24364
|
+
|
|
24365
|
+
<dl>
|
|
24366
|
+
<dd>
|
|
24367
|
+
|
|
24368
|
+
Counts the caller's shipping integration orders by unified status. | () -> (ShippingIntegrationOrderStatusSummaryRes)
|
|
24369
|
+
|
|
24370
|
+
</dd>
|
|
24371
|
+
</dl>
|
|
24372
|
+
</dd>
|
|
24373
|
+
</dl>
|
|
24374
|
+
|
|
24375
|
+
#### 🔌 Usage
|
|
24376
|
+
|
|
24377
|
+
<dl>
|
|
24378
|
+
<dd>
|
|
24379
|
+
|
|
24380
|
+
<dl>
|
|
24381
|
+
<dd>
|
|
24382
|
+
|
|
24383
|
+
```typescript
|
|
24384
|
+
await client.shippingIntegrations.orders.statusSummaryV1({
|
|
24385
|
+
filter_shipping_integration: ["xcelerator"],
|
|
24386
|
+
filter_provider_org_id: ["filter_provider_org_id"],
|
|
24387
|
+
filter_status: ["staged"],
|
|
24388
|
+
filter_integration_order_id: "filter_integration_order_id",
|
|
24389
|
+
filter_reference_number: "filter_reference_number",
|
|
24390
|
+
filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24391
|
+
filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24392
|
+
filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24393
|
+
filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24394
|
+
filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24395
|
+
filter_first_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24396
|
+
});
|
|
24397
|
+
```
|
|
24398
|
+
|
|
24399
|
+
</dd>
|
|
24400
|
+
</dl>
|
|
24401
|
+
</dd>
|
|
24402
|
+
</dl>
|
|
24403
|
+
|
|
24404
|
+
#### ⚙️ Parameters
|
|
24405
|
+
|
|
24406
|
+
<dl>
|
|
24407
|
+
<dd>
|
|
24408
|
+
|
|
24409
|
+
<dl>
|
|
24410
|
+
<dd>
|
|
24411
|
+
|
|
24412
|
+
**request:** `Chrt.shippingIntegrations.OrdersStatusSummaryV1Request`
|
|
24413
|
+
|
|
24414
|
+
</dd>
|
|
24415
|
+
</dl>
|
|
24416
|
+
|
|
24417
|
+
<dl>
|
|
24418
|
+
<dd>
|
|
24419
|
+
|
|
24420
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
24421
|
+
|
|
24422
|
+
</dd>
|
|
24423
|
+
</dl>
|
|
24424
|
+
</dd>
|
|
24425
|
+
</dl>
|
|
24426
|
+
|
|
24427
|
+
</dd>
|
|
24428
|
+
</dl>
|
|
24429
|
+
</details>
|
|
24430
|
+
|
|
24431
|
+
<details><summary><code>client.shippingIntegrations.orders.<a href="/src/api/resources/shippingIntegrations/resources/orders/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.ShippingIntegrationOrderTypeaheadResult[]</code></summary>
|
|
24432
|
+
<dl>
|
|
24433
|
+
<dd>
|
|
24434
|
+
|
|
24435
|
+
#### 📝 Description
|
|
24436
|
+
|
|
24437
|
+
<dl>
|
|
24438
|
+
<dd>
|
|
24439
|
+
|
|
24440
|
+
<dl>
|
|
24441
|
+
<dd>
|
|
24442
|
+
|
|
24443
|
+
Returns distinct integration order IDs matching the query via case-insensitive regex within the caller's organization. | authz: caller's organization scope | () -> (list[ShippingIntegrationOrderTypeaheadResult])
|
|
24444
|
+
|
|
24445
|
+
</dd>
|
|
24446
|
+
</dl>
|
|
24447
|
+
</dd>
|
|
24448
|
+
</dl>
|
|
24449
|
+
|
|
24450
|
+
#### 🔌 Usage
|
|
24451
|
+
|
|
24452
|
+
<dl>
|
|
24453
|
+
<dd>
|
|
24454
|
+
|
|
24455
|
+
<dl>
|
|
24456
|
+
<dd>
|
|
24457
|
+
|
|
24458
|
+
```typescript
|
|
24459
|
+
await client.shippingIntegrations.orders.typeaheadV1({
|
|
24460
|
+
query: "query",
|
|
24461
|
+
limit: 1,
|
|
24462
|
+
});
|
|
24463
|
+
```
|
|
24464
|
+
|
|
24465
|
+
</dd>
|
|
24466
|
+
</dl>
|
|
24467
|
+
</dd>
|
|
24468
|
+
</dl>
|
|
24469
|
+
|
|
24470
|
+
#### ⚙️ Parameters
|
|
24471
|
+
|
|
24472
|
+
<dl>
|
|
24473
|
+
<dd>
|
|
24474
|
+
|
|
24475
|
+
<dl>
|
|
24476
|
+
<dd>
|
|
24477
|
+
|
|
24478
|
+
**request:** `Chrt.shippingIntegrations.OrdersTypeaheadV1Request`
|
|
24479
|
+
|
|
24480
|
+
</dd>
|
|
24481
|
+
</dl>
|
|
24482
|
+
|
|
24483
|
+
<dl>
|
|
24484
|
+
<dd>
|
|
24485
|
+
|
|
24486
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
24487
|
+
|
|
24488
|
+
</dd>
|
|
24489
|
+
</dl>
|
|
24490
|
+
</dd>
|
|
24491
|
+
</dl>
|
|
24492
|
+
|
|
24493
|
+
</dd>
|
|
24494
|
+
</dl>
|
|
24495
|
+
</details>
|
|
24496
|
+
|
|
24497
|
+
## ShippingIntegrations Atlas Creds
|
|
24498
|
+
|
|
24499
|
+
<details><summary><code>client.shippingIntegrations.atlas.creds.<a href="/src/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/Client.ts">detailV1</a>(providerOrgId) -> Chrt.AtlasCredsLimited1</code></summary>
|
|
24500
|
+
<dl>
|
|
24501
|
+
<dd>
|
|
24502
|
+
|
|
24503
|
+
#### 📝 Description
|
|
24504
|
+
|
|
24505
|
+
<dl>
|
|
24506
|
+
<dd>
|
|
24507
|
+
|
|
24508
|
+
<dl>
|
|
24509
|
+
<dd>
|
|
24510
|
+
|
|
24511
|
+
Returns the caller's Atlas credential for one provider, without API key. | () -> (AtlasCredsLimited1)
|
|
24512
|
+
|
|
24513
|
+
</dd>
|
|
24514
|
+
</dl>
|
|
24515
|
+
</dd>
|
|
24516
|
+
</dl>
|
|
24517
|
+
|
|
24518
|
+
#### 🔌 Usage
|
|
24519
|
+
|
|
24520
|
+
<dl>
|
|
24521
|
+
<dd>
|
|
24522
|
+
|
|
24523
|
+
<dl>
|
|
24524
|
+
<dd>
|
|
24525
|
+
|
|
24526
|
+
```typescript
|
|
24527
|
+
await client.shippingIntegrations.atlas.creds.detailV1("provider_org_id");
|
|
24528
|
+
```
|
|
24529
|
+
|
|
24530
|
+
</dd>
|
|
24531
|
+
</dl>
|
|
24532
|
+
</dd>
|
|
24533
|
+
</dl>
|
|
24534
|
+
|
|
24535
|
+
#### ⚙️ Parameters
|
|
24536
|
+
|
|
24537
|
+
<dl>
|
|
24538
|
+
<dd>
|
|
24539
|
+
|
|
24540
|
+
<dl>
|
|
24541
|
+
<dd>
|
|
24542
|
+
|
|
24543
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
24544
|
+
|
|
24545
|
+
</dd>
|
|
24546
|
+
</dl>
|
|
24547
|
+
|
|
24548
|
+
<dl>
|
|
24549
|
+
<dd>
|
|
24550
|
+
|
|
24551
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
24552
|
+
|
|
24553
|
+
</dd>
|
|
24554
|
+
</dl>
|
|
24555
|
+
</dd>
|
|
24556
|
+
</dl>
|
|
24557
|
+
|
|
24558
|
+
</dd>
|
|
24559
|
+
</dl>
|
|
24560
|
+
</details>
|
|
24561
|
+
|
|
24562
|
+
<details><summary><code>client.shippingIntegrations.atlas.creds.<a href="/src/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/Client.ts">listV1</a>() -> Chrt.AtlasCredsListRes</code></summary>
|
|
24563
|
+
<dl>
|
|
24564
|
+
<dd>
|
|
24565
|
+
|
|
24566
|
+
#### 📝 Description
|
|
24567
|
+
|
|
24568
|
+
<dl>
|
|
24569
|
+
<dd>
|
|
24570
|
+
|
|
24571
|
+
<dl>
|
|
24572
|
+
<dd>
|
|
24573
|
+
|
|
24574
|
+
Lists the caller's Atlas credentials, one per connected provider, without API key. | () -> (AtlasCredsListRes)
|
|
24575
|
+
|
|
24576
|
+
</dd>
|
|
24577
|
+
</dl>
|
|
24578
|
+
</dd>
|
|
24579
|
+
</dl>
|
|
24580
|
+
|
|
24581
|
+
#### 🔌 Usage
|
|
24582
|
+
|
|
24583
|
+
<dl>
|
|
24584
|
+
<dd>
|
|
24585
|
+
|
|
24586
|
+
<dl>
|
|
24587
|
+
<dd>
|
|
24588
|
+
|
|
24589
|
+
```typescript
|
|
24590
|
+
await client.shippingIntegrations.atlas.creds.listV1();
|
|
24591
|
+
```
|
|
24592
|
+
|
|
24593
|
+
</dd>
|
|
24594
|
+
</dl>
|
|
24595
|
+
</dd>
|
|
24596
|
+
</dl>
|
|
24597
|
+
|
|
24598
|
+
#### ⚙️ Parameters
|
|
24599
|
+
|
|
24600
|
+
<dl>
|
|
24601
|
+
<dd>
|
|
24602
|
+
|
|
24603
|
+
<dl>
|
|
24604
|
+
<dd>
|
|
24605
|
+
|
|
24606
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
24607
|
+
|
|
24608
|
+
</dd>
|
|
24609
|
+
</dl>
|
|
24610
|
+
</dd>
|
|
24611
|
+
</dl>
|
|
24612
|
+
|
|
24613
|
+
</dd>
|
|
24614
|
+
</dl>
|
|
24615
|
+
</details>
|
|
24616
|
+
|
|
24617
|
+
<details><summary><code>client.shippingIntegrations.atlas.creds.<a href="/src/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/Client.ts">testV1</a>(providerOrgId) -> Chrt.AtlasCredsTestRes</code></summary>
|
|
24618
|
+
<dl>
|
|
24619
|
+
<dd>
|
|
24620
|
+
|
|
24621
|
+
#### 📝 Description
|
|
24622
|
+
|
|
24623
|
+
<dl>
|
|
24624
|
+
<dd>
|
|
24625
|
+
|
|
24626
|
+
<dl>
|
|
24627
|
+
<dd>
|
|
24628
|
+
|
|
24629
|
+
Tests whether stored Atlas credentials can authenticate against the provider. | authz: min_org_role=operator | () -> (AtlasCredsTestRes)
|
|
24630
|
+
|
|
24631
|
+
</dd>
|
|
24632
|
+
</dl>
|
|
24633
|
+
</dd>
|
|
24634
|
+
</dl>
|
|
24635
|
+
|
|
24636
|
+
#### 🔌 Usage
|
|
24637
|
+
|
|
24638
|
+
<dl>
|
|
24639
|
+
<dd>
|
|
24640
|
+
|
|
24641
|
+
<dl>
|
|
24642
|
+
<dd>
|
|
24643
|
+
|
|
24644
|
+
```typescript
|
|
24645
|
+
await client.shippingIntegrations.atlas.creds.testV1("provider_org_id");
|
|
24646
|
+
```
|
|
24647
|
+
|
|
24648
|
+
</dd>
|
|
24649
|
+
</dl>
|
|
24650
|
+
</dd>
|
|
24651
|
+
</dl>
|
|
24652
|
+
|
|
24653
|
+
#### ⚙️ Parameters
|
|
24654
|
+
|
|
24655
|
+
<dl>
|
|
24656
|
+
<dd>
|
|
24657
|
+
|
|
24658
|
+
<dl>
|
|
24659
|
+
<dd>
|
|
24660
|
+
|
|
24661
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
24662
|
+
|
|
24663
|
+
</dd>
|
|
24664
|
+
</dl>
|
|
24665
|
+
|
|
24666
|
+
<dl>
|
|
24667
|
+
<dd>
|
|
24668
|
+
|
|
24669
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
24670
|
+
|
|
24671
|
+
</dd>
|
|
24672
|
+
</dl>
|
|
24673
|
+
</dd>
|
|
24674
|
+
</dl>
|
|
24675
|
+
|
|
24676
|
+
</dd>
|
|
24677
|
+
</dl>
|
|
24678
|
+
</details>
|
|
24679
|
+
|
|
24680
|
+
<details><summary><code>client.shippingIntegrations.atlas.creds.<a href="/src/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/Client.ts">createV1</a>(providerOrgId, { ...params }) -> string</code></summary>
|
|
24681
|
+
<dl>
|
|
24682
|
+
<dd>
|
|
24683
|
+
|
|
24684
|
+
#### 📝 Description
|
|
24685
|
+
|
|
24686
|
+
<dl>
|
|
24687
|
+
<dd>
|
|
24688
|
+
|
|
24689
|
+
<dl>
|
|
24690
|
+
<dd>
|
|
24691
|
+
|
|
24692
|
+
Stores Atlas credentials for one provider on behalf of the caller's organization. | authz: min_org_role=administrator | (AtlasCredsClientCreate1) -> (PydanticObjectId)
|
|
24693
|
+
|
|
24694
|
+
</dd>
|
|
24695
|
+
</dl>
|
|
24696
|
+
</dd>
|
|
24697
|
+
</dl>
|
|
24698
|
+
|
|
24699
|
+
#### 🔌 Usage
|
|
24700
|
+
|
|
24701
|
+
<dl>
|
|
24702
|
+
<dd>
|
|
24703
|
+
|
|
24704
|
+
<dl>
|
|
24705
|
+
<dd>
|
|
24706
|
+
|
|
24707
|
+
```typescript
|
|
24708
|
+
await client.shippingIntegrations.atlas.creds.createV1("provider_org_id", {
|
|
24709
|
+
api_key: "api_key",
|
|
24710
|
+
schema_version: 1,
|
|
24711
|
+
});
|
|
24712
|
+
```
|
|
24713
|
+
|
|
24714
|
+
</dd>
|
|
24715
|
+
</dl>
|
|
24716
|
+
</dd>
|
|
24717
|
+
</dl>
|
|
24718
|
+
|
|
24719
|
+
#### ⚙️ Parameters
|
|
24720
|
+
|
|
24721
|
+
<dl>
|
|
24722
|
+
<dd>
|
|
24723
|
+
|
|
24724
|
+
<dl>
|
|
24725
|
+
<dd>
|
|
24726
|
+
|
|
24727
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
24728
|
+
|
|
24729
|
+
</dd>
|
|
24730
|
+
</dl>
|
|
24731
|
+
|
|
24732
|
+
<dl>
|
|
24733
|
+
<dd>
|
|
24734
|
+
|
|
24735
|
+
**request:** `Chrt.shippingIntegrations.atlas.AtlasCredsClientCreate1`
|
|
24736
|
+
|
|
24737
|
+
</dd>
|
|
24738
|
+
</dl>
|
|
24739
|
+
|
|
24740
|
+
<dl>
|
|
24741
|
+
<dd>
|
|
24742
|
+
|
|
24743
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
24744
|
+
|
|
24745
|
+
</dd>
|
|
24746
|
+
</dl>
|
|
24747
|
+
</dd>
|
|
24748
|
+
</dl>
|
|
24749
|
+
|
|
24750
|
+
</dd>
|
|
24751
|
+
</dl>
|
|
24752
|
+
</details>
|
|
24753
|
+
|
|
24754
|
+
<details><summary><code>client.shippingIntegrations.atlas.creds.<a href="/src/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/Client.ts">deleteV1</a>(providerOrgId) -> boolean</code></summary>
|
|
24755
|
+
<dl>
|
|
24756
|
+
<dd>
|
|
24757
|
+
|
|
24758
|
+
#### 📝 Description
|
|
24759
|
+
|
|
24760
|
+
<dl>
|
|
24761
|
+
<dd>
|
|
24762
|
+
|
|
24763
|
+
<dl>
|
|
24764
|
+
<dd>
|
|
24765
|
+
|
|
24766
|
+
Deletes stored Atlas credentials for one provider. | authz: min_org_role=administrator | () -> (bool)
|
|
24767
|
+
|
|
24768
|
+
</dd>
|
|
24769
|
+
</dl>
|
|
24770
|
+
</dd>
|
|
24771
|
+
</dl>
|
|
24772
|
+
|
|
24773
|
+
#### 🔌 Usage
|
|
24774
|
+
|
|
24775
|
+
<dl>
|
|
24776
|
+
<dd>
|
|
24777
|
+
|
|
24778
|
+
<dl>
|
|
24779
|
+
<dd>
|
|
24780
|
+
|
|
24781
|
+
```typescript
|
|
24782
|
+
await client.shippingIntegrations.atlas.creds.deleteV1("provider_org_id");
|
|
24783
|
+
```
|
|
24784
|
+
|
|
24785
|
+
</dd>
|
|
24786
|
+
</dl>
|
|
24787
|
+
</dd>
|
|
24788
|
+
</dl>
|
|
24789
|
+
|
|
24790
|
+
#### ⚙️ Parameters
|
|
24791
|
+
|
|
24792
|
+
<dl>
|
|
24793
|
+
<dd>
|
|
24794
|
+
|
|
24795
|
+
<dl>
|
|
24796
|
+
<dd>
|
|
24797
|
+
|
|
24798
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
24799
|
+
|
|
24800
|
+
</dd>
|
|
24801
|
+
</dl>
|
|
24802
|
+
|
|
24803
|
+
<dl>
|
|
24804
|
+
<dd>
|
|
24805
|
+
|
|
24806
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
24807
|
+
|
|
24808
|
+
</dd>
|
|
24809
|
+
</dl>
|
|
24810
|
+
</dd>
|
|
24811
|
+
</dl>
|
|
24812
|
+
|
|
24813
|
+
</dd>
|
|
24814
|
+
</dl>
|
|
24815
|
+
</details>
|
|
24816
|
+
|
|
24817
|
+
<details><summary><code>client.shippingIntegrations.atlas.creds.<a href="/src/api/resources/shippingIntegrations/resources/atlas/resources/creds/client/Client.ts">updateV1</a>(providerOrgId, { ...params }) -> boolean</code></summary>
|
|
24818
|
+
<dl>
|
|
24819
|
+
<dd>
|
|
24820
|
+
|
|
24821
|
+
#### 📝 Description
|
|
24822
|
+
|
|
24823
|
+
<dl>
|
|
24824
|
+
<dd>
|
|
24825
|
+
|
|
24826
|
+
<dl>
|
|
24827
|
+
<dd>
|
|
24828
|
+
|
|
24829
|
+
Updates stored Atlas credentials for one provider. | authz: min_org_role=administrator | (AtlasCredsClientUpdate1) -> (bool)
|
|
24830
|
+
|
|
24831
|
+
</dd>
|
|
24832
|
+
</dl>
|
|
24833
|
+
</dd>
|
|
24834
|
+
</dl>
|
|
24835
|
+
|
|
24836
|
+
#### 🔌 Usage
|
|
24837
|
+
|
|
24838
|
+
<dl>
|
|
24839
|
+
<dd>
|
|
24840
|
+
|
|
24841
|
+
<dl>
|
|
24842
|
+
<dd>
|
|
24843
|
+
|
|
24844
|
+
```typescript
|
|
24845
|
+
await client.shippingIntegrations.atlas.creds.updateV1("provider_org_id");
|
|
24846
|
+
```
|
|
24847
|
+
|
|
24848
|
+
</dd>
|
|
24849
|
+
</dl>
|
|
24850
|
+
</dd>
|
|
24851
|
+
</dl>
|
|
24852
|
+
|
|
24853
|
+
#### ⚙️ Parameters
|
|
24854
|
+
|
|
24855
|
+
<dl>
|
|
24856
|
+
<dd>
|
|
24857
|
+
|
|
24858
|
+
<dl>
|
|
24859
|
+
<dd>
|
|
24860
|
+
|
|
24861
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
24862
|
+
|
|
24863
|
+
</dd>
|
|
24864
|
+
</dl>
|
|
24865
|
+
|
|
24866
|
+
<dl>
|
|
24867
|
+
<dd>
|
|
24868
|
+
|
|
24869
|
+
**request:** `Chrt.shippingIntegrations.atlas.AtlasCredsClientUpdate1`
|
|
24870
|
+
|
|
24871
|
+
</dd>
|
|
24872
|
+
</dl>
|
|
24873
|
+
|
|
24874
|
+
<dl>
|
|
24875
|
+
<dd>
|
|
24876
|
+
|
|
24877
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
24878
|
+
|
|
24879
|
+
</dd>
|
|
24880
|
+
</dl>
|
|
24881
|
+
</dd>
|
|
24882
|
+
</dl>
|
|
24883
|
+
|
|
24884
|
+
</dd>
|
|
24885
|
+
</dl>
|
|
24886
|
+
</details>
|
|
24887
|
+
|
|
24888
|
+
## ShippingIntegrations Atlas Orders
|
|
24889
|
+
|
|
24890
|
+
<details><summary><code>client.shippingIntegrations.atlas.orders.<a href="/src/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(providerOrgId, integrationOrderId) -> Chrt.AtlasOrderExpanded1</code></summary>
|
|
24891
|
+
<dl>
|
|
24892
|
+
<dd>
|
|
24893
|
+
|
|
24894
|
+
#### 📝 Description
|
|
24895
|
+
|
|
24896
|
+
<dl>
|
|
24897
|
+
<dd>
|
|
24898
|
+
|
|
24899
|
+
<dl>
|
|
24900
|
+
<dd>
|
|
24901
|
+
|
|
24902
|
+
Returns one mirrored Atlas order by the provider's own order ID with the provider organization expanded. | () -> (AtlasOrderExpanded1)
|
|
24903
|
+
|
|
24904
|
+
</dd>
|
|
24905
|
+
</dl>
|
|
24906
|
+
</dd>
|
|
24907
|
+
</dl>
|
|
24908
|
+
|
|
24909
|
+
#### 🔌 Usage
|
|
24910
|
+
|
|
24911
|
+
<dl>
|
|
24912
|
+
<dd>
|
|
24913
|
+
|
|
24914
|
+
<dl>
|
|
24915
|
+
<dd>
|
|
24916
|
+
|
|
24917
|
+
```typescript
|
|
24918
|
+
await client.shippingIntegrations.atlas.orders.detailByIntegrationOrderIdV1("provider_org_id", "integration_order_id");
|
|
24919
|
+
```
|
|
24920
|
+
|
|
24921
|
+
</dd>
|
|
24922
|
+
</dl>
|
|
24923
|
+
</dd>
|
|
24924
|
+
</dl>
|
|
24925
|
+
|
|
24926
|
+
#### ⚙️ Parameters
|
|
24927
|
+
|
|
24928
|
+
<dl>
|
|
24929
|
+
<dd>
|
|
24930
|
+
|
|
24931
|
+
<dl>
|
|
24932
|
+
<dd>
|
|
24933
|
+
|
|
24934
|
+
**providerOrgId:** `string` — CHRT org ID of the courier whose Atlas instance holds the order
|
|
24935
|
+
|
|
24936
|
+
</dd>
|
|
24937
|
+
</dl>
|
|
24938
|
+
|
|
24939
|
+
<dl>
|
|
24940
|
+
<dd>
|
|
24941
|
+
|
|
24942
|
+
**integrationOrderId:** `string` — Atlas's own ID for the order, as carried on a unified order row
|
|
24943
|
+
|
|
24944
|
+
</dd>
|
|
24945
|
+
</dl>
|
|
24946
|
+
|
|
24947
|
+
<dl>
|
|
24948
|
+
<dd>
|
|
24949
|
+
|
|
24950
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
24951
|
+
|
|
24952
|
+
</dd>
|
|
24953
|
+
</dl>
|
|
24954
|
+
</dd>
|
|
24955
|
+
</dl>
|
|
24956
|
+
|
|
24957
|
+
</dd>
|
|
24958
|
+
</dl>
|
|
24959
|
+
</details>
|
|
24960
|
+
|
|
24961
|
+
<details><summary><code>client.shippingIntegrations.atlas.orders.<a href="/src/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.ts">detailV1</a>(id) -> Chrt.AtlasOrderExpanded1</code></summary>
|
|
24962
|
+
<dl>
|
|
24963
|
+
<dd>
|
|
24964
|
+
|
|
24965
|
+
#### 📝 Description
|
|
24966
|
+
|
|
24967
|
+
<dl>
|
|
24968
|
+
<dd>
|
|
24969
|
+
|
|
24970
|
+
<dl>
|
|
24971
|
+
<dd>
|
|
24972
|
+
|
|
24973
|
+
Returns one mirrored Atlas order by its Mongo ObjectId with the provider organization expanded. | () -> (AtlasOrderExpanded1)
|
|
24974
|
+
|
|
24975
|
+
</dd>
|
|
24976
|
+
</dl>
|
|
24977
|
+
</dd>
|
|
24978
|
+
</dl>
|
|
24979
|
+
|
|
24980
|
+
#### 🔌 Usage
|
|
24981
|
+
|
|
24982
|
+
<dl>
|
|
24983
|
+
<dd>
|
|
24984
|
+
|
|
24985
|
+
<dl>
|
|
24986
|
+
<dd>
|
|
24987
|
+
|
|
24988
|
+
```typescript
|
|
24989
|
+
await client.shippingIntegrations.atlas.orders.detailV1("id");
|
|
24990
|
+
```
|
|
24991
|
+
|
|
24992
|
+
</dd>
|
|
24993
|
+
</dl>
|
|
24994
|
+
</dd>
|
|
24995
|
+
</dl>
|
|
24996
|
+
|
|
24997
|
+
#### ⚙️ Parameters
|
|
24998
|
+
|
|
24999
|
+
<dl>
|
|
25000
|
+
<dd>
|
|
25001
|
+
|
|
25002
|
+
<dl>
|
|
25003
|
+
<dd>
|
|
25004
|
+
|
|
25005
|
+
**id:** `string` — Mongo ObjectId of the mirror document. Atlas's own order ID is the integration_order_id, accepted by the by_integration_order_id route.
|
|
25006
|
+
|
|
25007
|
+
</dd>
|
|
25008
|
+
</dl>
|
|
25009
|
+
|
|
25010
|
+
<dl>
|
|
25011
|
+
<dd>
|
|
25012
|
+
|
|
25013
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
25014
|
+
|
|
25015
|
+
</dd>
|
|
25016
|
+
</dl>
|
|
25017
|
+
</dd>
|
|
25018
|
+
</dl>
|
|
25019
|
+
|
|
25020
|
+
</dd>
|
|
25021
|
+
</dl>
|
|
25022
|
+
</details>
|
|
25023
|
+
|
|
25024
|
+
<details><summary><code>client.shippingIntegrations.atlas.orders.<a href="/src/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.ts">listV1</a>({ ...params }) -> Chrt.AtlasOrderListRes</code></summary>
|
|
25025
|
+
<dl>
|
|
25026
|
+
<dd>
|
|
25027
|
+
|
|
25028
|
+
#### 📝 Description
|
|
25029
|
+
|
|
25030
|
+
<dl>
|
|
25031
|
+
<dd>
|
|
25032
|
+
|
|
25033
|
+
<dl>
|
|
25034
|
+
<dd>
|
|
25035
|
+
|
|
25036
|
+
Returns a paginated list of mirrored Atlas orders with provider organizations expanded, filtering, sorting, pagination, and optional search. | (AtlasOrderListFilters) -> (AtlasOrderListRes)
|
|
25037
|
+
|
|
25038
|
+
</dd>
|
|
25039
|
+
</dl>
|
|
25040
|
+
</dd>
|
|
25041
|
+
</dl>
|
|
25042
|
+
|
|
25043
|
+
#### 🔌 Usage
|
|
25044
|
+
|
|
25045
|
+
<dl>
|
|
25046
|
+
<dd>
|
|
25047
|
+
|
|
25048
|
+
<dl>
|
|
25049
|
+
<dd>
|
|
25050
|
+
|
|
25051
|
+
```typescript
|
|
25052
|
+
await client.shippingIntegrations.atlas.orders.listV1({
|
|
25053
|
+
sort_by: "mirrored_at_timestamp",
|
|
25054
|
+
sort_order: "asc",
|
|
25055
|
+
limit: 1,
|
|
25056
|
+
page: 1,
|
|
25057
|
+
search: "search",
|
|
25058
|
+
filter_provider_org_id: ["filter_provider_org_id"],
|
|
25059
|
+
filter_integration_order_id: "filter_integration_order_id",
|
|
25060
|
+
filter_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25061
|
+
filter_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25062
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25063
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25064
|
+
filter_updated_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25065
|
+
filter_updated_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25066
|
+
});
|
|
25067
|
+
```
|
|
25068
|
+
|
|
25069
|
+
</dd>
|
|
25070
|
+
</dl>
|
|
25071
|
+
</dd>
|
|
25072
|
+
</dl>
|
|
25073
|
+
|
|
25074
|
+
#### ⚙️ Parameters
|
|
25075
|
+
|
|
25076
|
+
<dl>
|
|
25077
|
+
<dd>
|
|
25078
|
+
|
|
25079
|
+
<dl>
|
|
25080
|
+
<dd>
|
|
25081
|
+
|
|
25082
|
+
**request:** `Chrt.shippingIntegrations.atlas.OrdersListV1Request`
|
|
25083
|
+
|
|
25084
|
+
</dd>
|
|
25085
|
+
</dl>
|
|
25086
|
+
|
|
25087
|
+
<dl>
|
|
25088
|
+
<dd>
|
|
25089
|
+
|
|
25090
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
25091
|
+
|
|
25092
|
+
</dd>
|
|
25093
|
+
</dl>
|
|
25094
|
+
</dd>
|
|
25095
|
+
</dl>
|
|
25096
|
+
|
|
25097
|
+
</dd>
|
|
25098
|
+
</dl>
|
|
25099
|
+
</details>
|
|
25100
|
+
|
|
25101
|
+
<details><summary><code>client.shippingIntegrations.atlas.orders.<a href="/src/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.ts">syncOneV1</a>({ ...params }) -> Chrt.AtlasOrder1</code></summary>
|
|
25102
|
+
<dl>
|
|
25103
|
+
<dd>
|
|
25104
|
+
|
|
25105
|
+
#### 📝 Description
|
|
25106
|
+
|
|
25107
|
+
<dl>
|
|
25108
|
+
<dd>
|
|
25109
|
+
|
|
25110
|
+
<dl>
|
|
25111
|
+
<dd>
|
|
25112
|
+
|
|
25113
|
+
Fetches and mirrors one Atlas order by the provider's own order ID. | authz: min_org_role=operator | (AtlasOrderSyncOneReq) -> (AtlasOrder1)
|
|
25114
|
+
|
|
25115
|
+
</dd>
|
|
25116
|
+
</dl>
|
|
25117
|
+
</dd>
|
|
25118
|
+
</dl>
|
|
25119
|
+
|
|
25120
|
+
#### 🔌 Usage
|
|
25121
|
+
|
|
25122
|
+
<dl>
|
|
25123
|
+
<dd>
|
|
25124
|
+
|
|
25125
|
+
<dl>
|
|
25126
|
+
<dd>
|
|
25127
|
+
|
|
25128
|
+
```typescript
|
|
25129
|
+
await client.shippingIntegrations.atlas.orders.syncOneV1({
|
|
25130
|
+
integration_order_id: "integration_order_id",
|
|
25131
|
+
provider_org_id: "provider_org_id",
|
|
25132
|
+
});
|
|
25133
|
+
```
|
|
25134
|
+
|
|
25135
|
+
</dd>
|
|
25136
|
+
</dl>
|
|
25137
|
+
</dd>
|
|
25138
|
+
</dl>
|
|
25139
|
+
|
|
25140
|
+
#### ⚙️ Parameters
|
|
25141
|
+
|
|
25142
|
+
<dl>
|
|
25143
|
+
<dd>
|
|
25144
|
+
|
|
25145
|
+
<dl>
|
|
25146
|
+
<dd>
|
|
25147
|
+
|
|
25148
|
+
**request:** `Chrt.shippingIntegrations.atlas.AtlasOrderSyncOneReq`
|
|
25149
|
+
|
|
25150
|
+
</dd>
|
|
25151
|
+
</dl>
|
|
25152
|
+
|
|
25153
|
+
<dl>
|
|
25154
|
+
<dd>
|
|
25155
|
+
|
|
25156
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
25157
|
+
|
|
25158
|
+
</dd>
|
|
25159
|
+
</dl>
|
|
25160
|
+
</dd>
|
|
25161
|
+
</dl>
|
|
25162
|
+
|
|
25163
|
+
</dd>
|
|
25164
|
+
</dl>
|
|
25165
|
+
</details>
|
|
25166
|
+
|
|
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
|
+
## ShippingIntegrations Cxt Creds
|
|
25234
|
+
|
|
25235
|
+
<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>
|
|
25236
|
+
<dl>
|
|
25237
|
+
<dd>
|
|
25238
|
+
|
|
25239
|
+
#### 📝 Description
|
|
25240
|
+
|
|
25241
|
+
<dl>
|
|
25242
|
+
<dd>
|
|
25243
|
+
|
|
25244
|
+
<dl>
|
|
25245
|
+
<dd>
|
|
25246
|
+
|
|
25247
|
+
Returns the caller's CXT credential for one provider, without passwords or access tokens. | () -> (CxtCredsLimited1)
|
|
25248
|
+
|
|
25249
|
+
</dd>
|
|
25250
|
+
</dl>
|
|
25251
|
+
</dd>
|
|
25252
|
+
</dl>
|
|
25253
|
+
|
|
25254
|
+
#### 🔌 Usage
|
|
25255
|
+
|
|
25256
|
+
<dl>
|
|
25257
|
+
<dd>
|
|
25258
|
+
|
|
25259
|
+
<dl>
|
|
25260
|
+
<dd>
|
|
25261
|
+
|
|
25262
|
+
```typescript
|
|
25263
|
+
await client.shippingIntegrations.cxt.creds.detailV1("provider_org_id");
|
|
25264
|
+
```
|
|
25265
|
+
|
|
25266
|
+
</dd>
|
|
25267
|
+
</dl>
|
|
25268
|
+
</dd>
|
|
25269
|
+
</dl>
|
|
25270
|
+
|
|
25271
|
+
#### ⚙️ Parameters
|
|
25272
|
+
|
|
25273
|
+
<dl>
|
|
25274
|
+
<dd>
|
|
25275
|
+
|
|
25276
|
+
<dl>
|
|
25277
|
+
<dd>
|
|
25278
|
+
|
|
25279
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
25280
|
+
|
|
25281
|
+
</dd>
|
|
25282
|
+
</dl>
|
|
25283
|
+
|
|
25284
|
+
<dl>
|
|
25285
|
+
<dd>
|
|
25286
|
+
|
|
25287
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
25288
|
+
|
|
25289
|
+
</dd>
|
|
25290
|
+
</dl>
|
|
25291
|
+
</dd>
|
|
25292
|
+
</dl>
|
|
25293
|
+
|
|
25294
|
+
</dd>
|
|
25295
|
+
</dl>
|
|
25296
|
+
</details>
|
|
25297
|
+
|
|
25298
|
+
<details><summary><code>client.shippingIntegrations.cxt.creds.<a href="/src/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/Client.ts">listV1</a>() -> Chrt.CxtCredsListRes</code></summary>
|
|
25299
|
+
<dl>
|
|
25300
|
+
<dd>
|
|
25301
|
+
|
|
25302
|
+
#### 📝 Description
|
|
25303
|
+
|
|
25304
|
+
<dl>
|
|
25305
|
+
<dd>
|
|
25306
|
+
|
|
25307
|
+
<dl>
|
|
25308
|
+
<dd>
|
|
25309
|
+
|
|
25310
|
+
Lists the caller's CXT credentials, one per connected provider, without passwords or access tokens. | () -> (CxtCredsListRes)
|
|
25311
|
+
|
|
25312
|
+
</dd>
|
|
25313
|
+
</dl>
|
|
25314
|
+
</dd>
|
|
25315
|
+
</dl>
|
|
25316
|
+
|
|
25317
|
+
#### 🔌 Usage
|
|
25318
|
+
|
|
25319
|
+
<dl>
|
|
25320
|
+
<dd>
|
|
25321
|
+
|
|
25322
|
+
<dl>
|
|
25323
|
+
<dd>
|
|
25324
|
+
|
|
25325
|
+
```typescript
|
|
25326
|
+
await client.shippingIntegrations.cxt.creds.listV1();
|
|
25327
|
+
```
|
|
25328
|
+
|
|
25329
|
+
</dd>
|
|
25330
|
+
</dl>
|
|
25331
|
+
</dd>
|
|
25332
|
+
</dl>
|
|
25333
|
+
|
|
25334
|
+
#### ⚙️ Parameters
|
|
25335
|
+
|
|
25336
|
+
<dl>
|
|
25337
|
+
<dd>
|
|
25338
|
+
|
|
25339
|
+
<dl>
|
|
25340
|
+
<dd>
|
|
25341
|
+
|
|
25342
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
25343
|
+
|
|
25344
|
+
</dd>
|
|
25345
|
+
</dl>
|
|
25346
|
+
</dd>
|
|
25347
|
+
</dl>
|
|
25348
|
+
|
|
25349
|
+
</dd>
|
|
25350
|
+
</dl>
|
|
25351
|
+
</details>
|
|
25352
|
+
|
|
25353
|
+
<details><summary><code>client.shippingIntegrations.cxt.creds.<a href="/src/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/Client.ts">testV1</a>(providerOrgId) -> Chrt.CxtCredsTestRes</code></summary>
|
|
25354
|
+
<dl>
|
|
25355
|
+
<dd>
|
|
25356
|
+
|
|
25357
|
+
#### 📝 Description
|
|
25358
|
+
|
|
25359
|
+
<dl>
|
|
25360
|
+
<dd>
|
|
25361
|
+
|
|
25362
|
+
<dl>
|
|
25363
|
+
<dd>
|
|
25364
|
+
|
|
25365
|
+
Tests whether stored CXT credentials can authenticate against the provider. | authz: min_org_role=operator | () -> (CxtCredsTestRes)
|
|
25366
|
+
|
|
25367
|
+
</dd>
|
|
25368
|
+
</dl>
|
|
25369
|
+
</dd>
|
|
25370
|
+
</dl>
|
|
25371
|
+
|
|
25372
|
+
#### 🔌 Usage
|
|
25373
|
+
|
|
25374
|
+
<dl>
|
|
25375
|
+
<dd>
|
|
25376
|
+
|
|
25377
|
+
<dl>
|
|
25378
|
+
<dd>
|
|
25379
|
+
|
|
25380
|
+
```typescript
|
|
25381
|
+
await client.shippingIntegrations.cxt.creds.testV1("provider_org_id");
|
|
25382
|
+
```
|
|
25383
|
+
|
|
25384
|
+
</dd>
|
|
25385
|
+
</dl>
|
|
25386
|
+
</dd>
|
|
25387
|
+
</dl>
|
|
25388
|
+
|
|
25389
|
+
#### ⚙️ Parameters
|
|
25390
|
+
|
|
25391
|
+
<dl>
|
|
25392
|
+
<dd>
|
|
25393
|
+
|
|
25394
|
+
<dl>
|
|
25395
|
+
<dd>
|
|
25396
|
+
|
|
25397
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
25398
|
+
|
|
25399
|
+
</dd>
|
|
25400
|
+
</dl>
|
|
25401
|
+
|
|
25402
|
+
<dl>
|
|
25403
|
+
<dd>
|
|
25404
|
+
|
|
25405
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
25406
|
+
|
|
25407
|
+
</dd>
|
|
25408
|
+
</dl>
|
|
25409
|
+
</dd>
|
|
25410
|
+
</dl>
|
|
25411
|
+
|
|
25412
|
+
</dd>
|
|
25413
|
+
</dl>
|
|
25414
|
+
</details>
|
|
25415
|
+
|
|
25416
|
+
<details><summary><code>client.shippingIntegrations.cxt.creds.<a href="/src/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/Client.ts">createV1</a>(providerOrgId, { ...params }) -> string</code></summary>
|
|
25417
|
+
<dl>
|
|
25418
|
+
<dd>
|
|
25419
|
+
|
|
25420
|
+
#### 📝 Description
|
|
25421
|
+
|
|
25422
|
+
<dl>
|
|
25423
|
+
<dd>
|
|
25424
|
+
|
|
25425
|
+
<dl>
|
|
25426
|
+
<dd>
|
|
25427
|
+
|
|
25428
|
+
Stores CXT credentials for one provider on behalf of the caller's organization. | authz: min_org_role=administrator | (CxtCredsClientCreate1) -> (PydanticObjectId)
|
|
25429
|
+
|
|
25430
|
+
</dd>
|
|
25431
|
+
</dl>
|
|
25432
|
+
</dd>
|
|
25433
|
+
</dl>
|
|
25434
|
+
|
|
25435
|
+
#### 🔌 Usage
|
|
25436
|
+
|
|
25437
|
+
<dl>
|
|
25438
|
+
<dd>
|
|
25439
|
+
|
|
25440
|
+
<dl>
|
|
25441
|
+
<dd>
|
|
25442
|
+
|
|
25443
|
+
```typescript
|
|
25444
|
+
await client.shippingIntegrations.cxt.creds.createV1("provider_org_id", {
|
|
25445
|
+
base_url: "base_url",
|
|
25446
|
+
cxt_auth_type: "xd_user",
|
|
25447
|
+
password: "password",
|
|
25448
|
+
schema_version: 1,
|
|
25449
|
+
username: "username",
|
|
25450
|
+
});
|
|
25451
|
+
```
|
|
25452
|
+
|
|
25453
|
+
</dd>
|
|
25454
|
+
</dl>
|
|
25455
|
+
</dd>
|
|
25456
|
+
</dl>
|
|
25457
|
+
|
|
25458
|
+
#### ⚙️ Parameters
|
|
25459
|
+
|
|
25460
|
+
<dl>
|
|
25461
|
+
<dd>
|
|
25462
|
+
|
|
25463
|
+
<dl>
|
|
25464
|
+
<dd>
|
|
25465
|
+
|
|
25466
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
25467
|
+
|
|
25468
|
+
</dd>
|
|
25469
|
+
</dl>
|
|
25470
|
+
|
|
25471
|
+
<dl>
|
|
25472
|
+
<dd>
|
|
25473
|
+
|
|
25474
|
+
**request:** `Chrt.shippingIntegrations.cxt.CxtCredsClientCreate1`
|
|
25475
|
+
|
|
25476
|
+
</dd>
|
|
25477
|
+
</dl>
|
|
25478
|
+
|
|
25479
|
+
<dl>
|
|
25480
|
+
<dd>
|
|
25481
|
+
|
|
25482
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
25483
|
+
|
|
25484
|
+
</dd>
|
|
25485
|
+
</dl>
|
|
25486
|
+
</dd>
|
|
25487
|
+
</dl>
|
|
25488
|
+
|
|
25489
|
+
</dd>
|
|
25490
|
+
</dl>
|
|
25491
|
+
</details>
|
|
25492
|
+
|
|
25493
|
+
<details><summary><code>client.shippingIntegrations.cxt.creds.<a href="/src/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/Client.ts">deleteV1</a>(providerOrgId) -> boolean</code></summary>
|
|
25494
|
+
<dl>
|
|
25495
|
+
<dd>
|
|
25496
|
+
|
|
25497
|
+
#### 📝 Description
|
|
25498
|
+
|
|
25499
|
+
<dl>
|
|
25500
|
+
<dd>
|
|
25501
|
+
|
|
25502
|
+
<dl>
|
|
25503
|
+
<dd>
|
|
25504
|
+
|
|
25505
|
+
Deletes stored CXT credentials for one provider. | authz: min_org_role=administrator | () -> (bool)
|
|
25506
|
+
|
|
25507
|
+
</dd>
|
|
25508
|
+
</dl>
|
|
25509
|
+
</dd>
|
|
25510
|
+
</dl>
|
|
25511
|
+
|
|
25512
|
+
#### 🔌 Usage
|
|
25513
|
+
|
|
25514
|
+
<dl>
|
|
25515
|
+
<dd>
|
|
25516
|
+
|
|
25517
|
+
<dl>
|
|
25518
|
+
<dd>
|
|
25519
|
+
|
|
25520
|
+
```typescript
|
|
25521
|
+
await client.shippingIntegrations.cxt.creds.deleteV1("provider_org_id");
|
|
25522
|
+
```
|
|
25523
|
+
|
|
25524
|
+
</dd>
|
|
25525
|
+
</dl>
|
|
25526
|
+
</dd>
|
|
25527
|
+
</dl>
|
|
25528
|
+
|
|
25529
|
+
#### ⚙️ Parameters
|
|
25530
|
+
|
|
25531
|
+
<dl>
|
|
25532
|
+
<dd>
|
|
25533
|
+
|
|
25534
|
+
<dl>
|
|
25535
|
+
<dd>
|
|
25536
|
+
|
|
25537
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
25538
|
+
|
|
25539
|
+
</dd>
|
|
25540
|
+
</dl>
|
|
25541
|
+
|
|
25542
|
+
<dl>
|
|
25543
|
+
<dd>
|
|
25544
|
+
|
|
25545
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
25546
|
+
|
|
25547
|
+
</dd>
|
|
25548
|
+
</dl>
|
|
25549
|
+
</dd>
|
|
25550
|
+
</dl>
|
|
25551
|
+
|
|
25552
|
+
</dd>
|
|
25553
|
+
</dl>
|
|
25554
|
+
</details>
|
|
25555
|
+
|
|
25556
|
+
<details><summary><code>client.shippingIntegrations.cxt.creds.<a href="/src/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/Client.ts">updateV1</a>(providerOrgId, { ...params }) -> boolean</code></summary>
|
|
25557
|
+
<dl>
|
|
25558
|
+
<dd>
|
|
25559
|
+
|
|
25560
|
+
#### 📝 Description
|
|
25561
|
+
|
|
25562
|
+
<dl>
|
|
25563
|
+
<dd>
|
|
25564
|
+
|
|
25565
|
+
<dl>
|
|
25566
|
+
<dd>
|
|
25567
|
+
|
|
25568
|
+
Updates stored CXT credentials for one provider. | authz: min_org_role=administrator | (CxtCredsClientUpdate1) -> (bool)
|
|
25569
|
+
|
|
25570
|
+
</dd>
|
|
25571
|
+
</dl>
|
|
25572
|
+
</dd>
|
|
25573
|
+
</dl>
|
|
25574
|
+
|
|
25575
|
+
#### 🔌 Usage
|
|
25576
|
+
|
|
25577
|
+
<dl>
|
|
25578
|
+
<dd>
|
|
25579
|
+
|
|
25580
|
+
<dl>
|
|
25581
|
+
<dd>
|
|
25582
|
+
|
|
25583
|
+
```typescript
|
|
25584
|
+
await client.shippingIntegrations.cxt.creds.updateV1("provider_org_id");
|
|
25585
|
+
```
|
|
25586
|
+
|
|
25587
|
+
</dd>
|
|
25588
|
+
</dl>
|
|
25589
|
+
</dd>
|
|
25590
|
+
</dl>
|
|
25591
|
+
|
|
25592
|
+
#### ⚙️ Parameters
|
|
25593
|
+
|
|
25594
|
+
<dl>
|
|
25595
|
+
<dd>
|
|
25596
|
+
|
|
25597
|
+
<dl>
|
|
25598
|
+
<dd>
|
|
25599
|
+
|
|
25600
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
25601
|
+
|
|
25602
|
+
</dd>
|
|
25603
|
+
</dl>
|
|
25604
|
+
|
|
25605
|
+
<dl>
|
|
25606
|
+
<dd>
|
|
25607
|
+
|
|
25608
|
+
**request:** `Chrt.shippingIntegrations.cxt.CxtCredsClientUpdate1`
|
|
25609
|
+
|
|
25610
|
+
</dd>
|
|
25611
|
+
</dl>
|
|
25612
|
+
|
|
25613
|
+
<dl>
|
|
25614
|
+
<dd>
|
|
25615
|
+
|
|
25616
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
25617
|
+
|
|
25618
|
+
</dd>
|
|
25619
|
+
</dl>
|
|
25620
|
+
</dd>
|
|
25621
|
+
</dl>
|
|
25622
|
+
|
|
25623
|
+
</dd>
|
|
25624
|
+
</dl>
|
|
25625
|
+
</details>
|
|
25626
|
+
|
|
25627
|
+
## ShippingIntegrations Cxt Orders
|
|
25628
|
+
|
|
25629
|
+
<details><summary><code>client.shippingIntegrations.cxt.orders.<a href="/src/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(providerOrgId, integrationOrderId) -> Chrt.CxtOrderExpanded1</code></summary>
|
|
25630
|
+
<dl>
|
|
25631
|
+
<dd>
|
|
25632
|
+
|
|
25633
|
+
#### 📝 Description
|
|
25634
|
+
|
|
25635
|
+
<dl>
|
|
25636
|
+
<dd>
|
|
25637
|
+
|
|
25638
|
+
<dl>
|
|
25639
|
+
<dd>
|
|
25640
|
+
|
|
25641
|
+
Returns one mirrored CXT order by the provider's own order ID with the provider organization expanded. | () -> (CxtOrderExpanded1)
|
|
25642
|
+
|
|
25643
|
+
</dd>
|
|
25644
|
+
</dl>
|
|
25645
|
+
</dd>
|
|
25646
|
+
</dl>
|
|
25647
|
+
|
|
25648
|
+
#### 🔌 Usage
|
|
25649
|
+
|
|
25650
|
+
<dl>
|
|
25651
|
+
<dd>
|
|
25652
|
+
|
|
25653
|
+
<dl>
|
|
25654
|
+
<dd>
|
|
25655
|
+
|
|
25656
|
+
```typescript
|
|
25657
|
+
await client.shippingIntegrations.cxt.orders.detailByIntegrationOrderIdV1("provider_org_id", "integration_order_id");
|
|
25658
|
+
```
|
|
25659
|
+
|
|
25660
|
+
</dd>
|
|
25661
|
+
</dl>
|
|
25662
|
+
</dd>
|
|
25663
|
+
</dl>
|
|
25664
|
+
|
|
25665
|
+
#### ⚙️ Parameters
|
|
25666
|
+
|
|
25667
|
+
<dl>
|
|
25668
|
+
<dd>
|
|
25669
|
+
|
|
25670
|
+
<dl>
|
|
25671
|
+
<dd>
|
|
25672
|
+
|
|
25673
|
+
**providerOrgId:** `string` — CHRT org ID of the courier whose CXT instance holds the order
|
|
25674
|
+
|
|
25675
|
+
</dd>
|
|
25676
|
+
</dl>
|
|
25677
|
+
|
|
25678
|
+
<dl>
|
|
25679
|
+
<dd>
|
|
25680
|
+
|
|
25681
|
+
**integrationOrderId:** `string` — CXT's own decimal ID for the order, as carried on a unified order row
|
|
25682
|
+
|
|
25683
|
+
</dd>
|
|
25684
|
+
</dl>
|
|
25685
|
+
|
|
25686
|
+
<dl>
|
|
25687
|
+
<dd>
|
|
25688
|
+
|
|
25689
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
25690
|
+
|
|
25691
|
+
</dd>
|
|
25692
|
+
</dl>
|
|
25693
|
+
</dd>
|
|
25694
|
+
</dl>
|
|
25695
|
+
|
|
25696
|
+
</dd>
|
|
25697
|
+
</dl>
|
|
25698
|
+
</details>
|
|
25699
|
+
|
|
25700
|
+
<details><summary><code>client.shippingIntegrations.cxt.orders.<a href="/src/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/Client.ts">detailV1</a>(id) -> Chrt.CxtOrderExpanded1</code></summary>
|
|
25701
|
+
<dl>
|
|
25702
|
+
<dd>
|
|
25703
|
+
|
|
25704
|
+
#### 📝 Description
|
|
25705
|
+
|
|
25706
|
+
<dl>
|
|
25707
|
+
<dd>
|
|
25708
|
+
|
|
25709
|
+
<dl>
|
|
25710
|
+
<dd>
|
|
25711
|
+
|
|
25712
|
+
Returns one mirrored CXT order by its Mongo ObjectId with the provider organization expanded. | () -> (CxtOrderExpanded1)
|
|
25713
|
+
|
|
25714
|
+
</dd>
|
|
25715
|
+
</dl>
|
|
25716
|
+
</dd>
|
|
25717
|
+
</dl>
|
|
25718
|
+
|
|
25719
|
+
#### 🔌 Usage
|
|
25720
|
+
|
|
25721
|
+
<dl>
|
|
25722
|
+
<dd>
|
|
25723
|
+
|
|
25724
|
+
<dl>
|
|
25725
|
+
<dd>
|
|
25726
|
+
|
|
25727
|
+
```typescript
|
|
25728
|
+
await client.shippingIntegrations.cxt.orders.detailV1("id");
|
|
25729
|
+
```
|
|
25730
|
+
|
|
25731
|
+
</dd>
|
|
25732
|
+
</dl>
|
|
25733
|
+
</dd>
|
|
25734
|
+
</dl>
|
|
25735
|
+
|
|
25736
|
+
#### ⚙️ Parameters
|
|
25737
|
+
|
|
25738
|
+
<dl>
|
|
25739
|
+
<dd>
|
|
25740
|
+
|
|
25741
|
+
<dl>
|
|
25742
|
+
<dd>
|
|
25743
|
+
|
|
25744
|
+
**id:** `string` — Mongo ObjectId of the mirror document. CXT's own order ID is the integration_order_id, accepted by the by_integration_order_id route.
|
|
25745
|
+
|
|
25746
|
+
</dd>
|
|
25747
|
+
</dl>
|
|
25748
|
+
|
|
25749
|
+
<dl>
|
|
25750
|
+
<dd>
|
|
25751
|
+
|
|
25752
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
25753
|
+
|
|
25754
|
+
</dd>
|
|
25755
|
+
</dl>
|
|
25756
|
+
</dd>
|
|
25757
|
+
</dl>
|
|
25758
|
+
|
|
25759
|
+
</dd>
|
|
25760
|
+
</dl>
|
|
25761
|
+
</details>
|
|
25762
|
+
|
|
25763
|
+
<details><summary><code>client.shippingIntegrations.cxt.orders.<a href="/src/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/Client.ts">listV1</a>({ ...params }) -> Chrt.CxtOrderListRes</code></summary>
|
|
25764
|
+
<dl>
|
|
25765
|
+
<dd>
|
|
25766
|
+
|
|
25767
|
+
#### 📝 Description
|
|
25768
|
+
|
|
25769
|
+
<dl>
|
|
25770
|
+
<dd>
|
|
25771
|
+
|
|
25772
|
+
<dl>
|
|
25773
|
+
<dd>
|
|
25774
|
+
|
|
25775
|
+
Returns a paginated list of mirrored CXT orders with provider organizations expanded, filtering, sorting, pagination, and optional search. | (CxtOrderListFilters) -> (CxtOrderListRes)
|
|
25776
|
+
|
|
25777
|
+
</dd>
|
|
25778
|
+
</dl>
|
|
25779
|
+
</dd>
|
|
25780
|
+
</dl>
|
|
25781
|
+
|
|
25782
|
+
#### 🔌 Usage
|
|
25783
|
+
|
|
25784
|
+
<dl>
|
|
25785
|
+
<dd>
|
|
25786
|
+
|
|
25787
|
+
<dl>
|
|
25788
|
+
<dd>
|
|
25789
|
+
|
|
25790
|
+
```typescript
|
|
25791
|
+
await client.shippingIntegrations.cxt.orders.listV1({
|
|
25792
|
+
sort_by: "mirrored_at_timestamp",
|
|
25793
|
+
sort_order: "asc",
|
|
25794
|
+
limit: 1,
|
|
25795
|
+
page: 1,
|
|
25796
|
+
search: "search",
|
|
25797
|
+
filter_provider_org_id: ["filter_provider_org_id"],
|
|
25798
|
+
filter_integration_order_id: "filter_integration_order_id",
|
|
25799
|
+
filter_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25800
|
+
filter_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25801
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25802
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25803
|
+
filter_updated_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25804
|
+
filter_updated_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25805
|
+
});
|
|
25806
|
+
```
|
|
25807
|
+
|
|
25808
|
+
</dd>
|
|
25809
|
+
</dl>
|
|
25810
|
+
</dd>
|
|
25811
|
+
</dl>
|
|
25812
|
+
|
|
25813
|
+
#### ⚙️ Parameters
|
|
25814
|
+
|
|
25815
|
+
<dl>
|
|
25816
|
+
<dd>
|
|
25817
|
+
|
|
25818
|
+
<dl>
|
|
25819
|
+
<dd>
|
|
25820
|
+
|
|
25821
|
+
**request:** `Chrt.shippingIntegrations.cxt.OrdersListV1Request`
|
|
25822
|
+
|
|
25823
|
+
</dd>
|
|
25824
|
+
</dl>
|
|
25825
|
+
|
|
25826
|
+
<dl>
|
|
25827
|
+
<dd>
|
|
25828
|
+
|
|
25829
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
25830
|
+
|
|
25831
|
+
</dd>
|
|
25832
|
+
</dl>
|
|
25833
|
+
</dd>
|
|
25834
|
+
</dl>
|
|
25835
|
+
|
|
25836
|
+
</dd>
|
|
25837
|
+
</dl>
|
|
25838
|
+
</details>
|
|
25839
|
+
|
|
25840
|
+
<details><summary><code>client.shippingIntegrations.cxt.orders.<a href="/src/api/resources/shippingIntegrations/resources/cxt/resources/orders/client/Client.ts">syncOneV1</a>({ ...params }) -> Chrt.CxtOrder1</code></summary>
|
|
25841
|
+
<dl>
|
|
25842
|
+
<dd>
|
|
25843
|
+
|
|
25844
|
+
#### 📝 Description
|
|
25845
|
+
|
|
25846
|
+
<dl>
|
|
25847
|
+
<dd>
|
|
25848
|
+
|
|
25849
|
+
<dl>
|
|
25850
|
+
<dd>
|
|
25851
|
+
|
|
25852
|
+
Fetches and mirrors one CXT order by the provider's own decimal order ID. | authz: min_org_role=operator | (CxtOrderSyncOneReq) -> (CxtOrder1)
|
|
25853
|
+
|
|
25854
|
+
</dd>
|
|
25855
|
+
</dl>
|
|
25856
|
+
</dd>
|
|
25857
|
+
</dl>
|
|
25858
|
+
|
|
25859
|
+
#### 🔌 Usage
|
|
25860
|
+
|
|
25861
|
+
<dl>
|
|
25862
|
+
<dd>
|
|
25863
|
+
|
|
25864
|
+
<dl>
|
|
25865
|
+
<dd>
|
|
25866
|
+
|
|
25867
|
+
```typescript
|
|
25868
|
+
await client.shippingIntegrations.cxt.orders.syncOneV1({
|
|
25869
|
+
integration_order_id: "integration_order_id",
|
|
25870
|
+
provider_org_id: "provider_org_id",
|
|
25871
|
+
});
|
|
25872
|
+
```
|
|
25873
|
+
|
|
25874
|
+
</dd>
|
|
25875
|
+
</dl>
|
|
25876
|
+
</dd>
|
|
25877
|
+
</dl>
|
|
25878
|
+
|
|
25879
|
+
#### ⚙️ Parameters
|
|
25880
|
+
|
|
25881
|
+
<dl>
|
|
25882
|
+
<dd>
|
|
25883
|
+
|
|
25884
|
+
<dl>
|
|
25885
|
+
<dd>
|
|
25886
|
+
|
|
25887
|
+
**request:** `Chrt.shippingIntegrations.cxt.CxtOrderSyncOneReq`
|
|
25888
|
+
|
|
25889
|
+
</dd>
|
|
25890
|
+
</dl>
|
|
25891
|
+
|
|
25892
|
+
<dl>
|
|
25893
|
+
<dd>
|
|
25894
|
+
|
|
25895
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
25896
|
+
|
|
25897
|
+
</dd>
|
|
25898
|
+
</dl>
|
|
25899
|
+
</dd>
|
|
25900
|
+
</dl>
|
|
25901
|
+
|
|
25902
|
+
</dd>
|
|
25903
|
+
</dl>
|
|
25904
|
+
</details>
|
|
25905
|
+
|
|
25906
|
+
## ShippingIntegrations DispatchScience Creds
|
|
25907
|
+
|
|
25908
|
+
<details><summary><code>client.shippingIntegrations.dispatchScience.creds.<a href="/src/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/Client.ts">detailV1</a>(providerOrgId) -> Chrt.DispatchScienceCredsLimited1</code></summary>
|
|
25909
|
+
<dl>
|
|
25910
|
+
<dd>
|
|
25911
|
+
|
|
25912
|
+
#### 📝 Description
|
|
25913
|
+
|
|
25914
|
+
<dl>
|
|
25915
|
+
<dd>
|
|
25916
|
+
|
|
25917
|
+
<dl>
|
|
25918
|
+
<dd>
|
|
25919
|
+
|
|
25920
|
+
Returns the caller's DispatchScience credential for one provider, without password or access token. | () -> (DispatchScienceCredsLimited1)
|
|
25921
|
+
|
|
25922
|
+
</dd>
|
|
25923
|
+
</dl>
|
|
25924
|
+
</dd>
|
|
25925
|
+
</dl>
|
|
25926
|
+
|
|
25927
|
+
#### 🔌 Usage
|
|
25928
|
+
|
|
25929
|
+
<dl>
|
|
25930
|
+
<dd>
|
|
25931
|
+
|
|
25932
|
+
<dl>
|
|
25933
|
+
<dd>
|
|
25934
|
+
|
|
25935
|
+
```typescript
|
|
25936
|
+
await client.shippingIntegrations.dispatchScience.creds.detailV1("provider_org_id");
|
|
25937
|
+
```
|
|
25938
|
+
|
|
25939
|
+
</dd>
|
|
25940
|
+
</dl>
|
|
25941
|
+
</dd>
|
|
25942
|
+
</dl>
|
|
25943
|
+
|
|
25944
|
+
#### ⚙️ Parameters
|
|
25945
|
+
|
|
25946
|
+
<dl>
|
|
25947
|
+
<dd>
|
|
25948
|
+
|
|
25949
|
+
<dl>
|
|
25950
|
+
<dd>
|
|
25951
|
+
|
|
25952
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
25953
|
+
|
|
25954
|
+
</dd>
|
|
25955
|
+
</dl>
|
|
25956
|
+
|
|
25957
|
+
<dl>
|
|
25958
|
+
<dd>
|
|
25959
|
+
|
|
25960
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
25961
|
+
|
|
25962
|
+
</dd>
|
|
25963
|
+
</dl>
|
|
25964
|
+
</dd>
|
|
25965
|
+
</dl>
|
|
25966
|
+
|
|
25967
|
+
</dd>
|
|
25968
|
+
</dl>
|
|
25969
|
+
</details>
|
|
25970
|
+
|
|
25971
|
+
<details><summary><code>client.shippingIntegrations.dispatchScience.creds.<a href="/src/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/Client.ts">listV1</a>() -> Chrt.DispatchScienceCredsListRes</code></summary>
|
|
25972
|
+
<dl>
|
|
25973
|
+
<dd>
|
|
25974
|
+
|
|
25975
|
+
#### 📝 Description
|
|
25976
|
+
|
|
25977
|
+
<dl>
|
|
25978
|
+
<dd>
|
|
25979
|
+
|
|
25980
|
+
<dl>
|
|
25981
|
+
<dd>
|
|
25982
|
+
|
|
25983
|
+
Lists the caller's DispatchScience credentials, one per connected provider, without password or access token. | () -> (DispatchScienceCredsListRes)
|
|
25984
|
+
|
|
25985
|
+
</dd>
|
|
25986
|
+
</dl>
|
|
25987
|
+
</dd>
|
|
25988
|
+
</dl>
|
|
25989
|
+
|
|
25990
|
+
#### 🔌 Usage
|
|
25991
|
+
|
|
25992
|
+
<dl>
|
|
25993
|
+
<dd>
|
|
25994
|
+
|
|
25995
|
+
<dl>
|
|
25996
|
+
<dd>
|
|
25997
|
+
|
|
25998
|
+
```typescript
|
|
25999
|
+
await client.shippingIntegrations.dispatchScience.creds.listV1();
|
|
26000
|
+
```
|
|
26001
|
+
|
|
26002
|
+
</dd>
|
|
26003
|
+
</dl>
|
|
26004
|
+
</dd>
|
|
26005
|
+
</dl>
|
|
26006
|
+
|
|
26007
|
+
#### ⚙️ Parameters
|
|
26008
|
+
|
|
26009
|
+
<dl>
|
|
26010
|
+
<dd>
|
|
26011
|
+
|
|
26012
|
+
<dl>
|
|
26013
|
+
<dd>
|
|
26014
|
+
|
|
26015
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
26016
|
+
|
|
26017
|
+
</dd>
|
|
26018
|
+
</dl>
|
|
26019
|
+
</dd>
|
|
26020
|
+
</dl>
|
|
26021
|
+
|
|
26022
|
+
</dd>
|
|
26023
|
+
</dl>
|
|
26024
|
+
</details>
|
|
26025
|
+
|
|
26026
|
+
<details><summary><code>client.shippingIntegrations.dispatchScience.creds.<a href="/src/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/Client.ts">testV1</a>(providerOrgId) -> Chrt.DispatchScienceCredsTestRes</code></summary>
|
|
26027
|
+
<dl>
|
|
26028
|
+
<dd>
|
|
26029
|
+
|
|
26030
|
+
#### 📝 Description
|
|
26031
|
+
|
|
26032
|
+
<dl>
|
|
26033
|
+
<dd>
|
|
26034
|
+
|
|
26035
|
+
<dl>
|
|
26036
|
+
<dd>
|
|
26037
|
+
|
|
26038
|
+
Confirms the caller's stored DispatchScience credentials for one provider still authenticate, reporting the tenant's configured workflow count. | authz: min_org_role=operator | () -> (DispatchScienceCredsTestRes)
|
|
26039
|
+
|
|
26040
|
+
</dd>
|
|
26041
|
+
</dl>
|
|
26042
|
+
</dd>
|
|
26043
|
+
</dl>
|
|
26044
|
+
|
|
26045
|
+
#### 🔌 Usage
|
|
26046
|
+
|
|
26047
|
+
<dl>
|
|
26048
|
+
<dd>
|
|
26049
|
+
|
|
26050
|
+
<dl>
|
|
26051
|
+
<dd>
|
|
26052
|
+
|
|
26053
|
+
```typescript
|
|
26054
|
+
await client.shippingIntegrations.dispatchScience.creds.testV1("provider_org_id");
|
|
26055
|
+
```
|
|
26056
|
+
|
|
26057
|
+
</dd>
|
|
26058
|
+
</dl>
|
|
26059
|
+
</dd>
|
|
26060
|
+
</dl>
|
|
26061
|
+
|
|
26062
|
+
#### ⚙️ Parameters
|
|
26063
|
+
|
|
26064
|
+
<dl>
|
|
26065
|
+
<dd>
|
|
26066
|
+
|
|
26067
|
+
<dl>
|
|
26068
|
+
<dd>
|
|
26069
|
+
|
|
26070
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
26071
|
+
|
|
26072
|
+
</dd>
|
|
26073
|
+
</dl>
|
|
26074
|
+
|
|
26075
|
+
<dl>
|
|
26076
|
+
<dd>
|
|
26077
|
+
|
|
26078
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
26079
|
+
|
|
26080
|
+
</dd>
|
|
26081
|
+
</dl>
|
|
26082
|
+
</dd>
|
|
26083
|
+
</dl>
|
|
26084
|
+
|
|
26085
|
+
</dd>
|
|
26086
|
+
</dl>
|
|
26087
|
+
</details>
|
|
26088
|
+
|
|
26089
|
+
<details><summary><code>client.shippingIntegrations.dispatchScience.creds.<a href="/src/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/Client.ts">createV1</a>(providerOrgId, { ...params }) -> string</code></summary>
|
|
26090
|
+
<dl>
|
|
26091
|
+
<dd>
|
|
26092
|
+
|
|
26093
|
+
#### 📝 Description
|
|
26094
|
+
|
|
26095
|
+
<dl>
|
|
26096
|
+
<dd>
|
|
26097
|
+
|
|
26098
|
+
<dl>
|
|
26099
|
+
<dd>
|
|
26100
|
+
|
|
26101
|
+
Stores DispatchScience credentials for one provider on behalf of the caller's organization. | authz: min_org_role=administrator | (DispatchScienceCredsClientCreate1) -> (PydanticObjectId)
|
|
26102
|
+
|
|
26103
|
+
</dd>
|
|
26104
|
+
</dl>
|
|
26105
|
+
</dd>
|
|
26106
|
+
</dl>
|
|
26107
|
+
|
|
26108
|
+
#### 🔌 Usage
|
|
26109
|
+
|
|
26110
|
+
<dl>
|
|
26111
|
+
<dd>
|
|
26112
|
+
|
|
26113
|
+
<dl>
|
|
26114
|
+
<dd>
|
|
26115
|
+
|
|
26116
|
+
```typescript
|
|
26117
|
+
await client.shippingIntegrations.dispatchScience.creds.createV1("provider_org_id", {
|
|
26118
|
+
base_url: "https://tenant.dispatchscience.com",
|
|
26119
|
+
password: "password",
|
|
26120
|
+
schema_version: 1,
|
|
26121
|
+
username: "username",
|
|
26122
|
+
});
|
|
26123
|
+
```
|
|
26124
|
+
|
|
26125
|
+
</dd>
|
|
26126
|
+
</dl>
|
|
26127
|
+
</dd>
|
|
26128
|
+
</dl>
|
|
26129
|
+
|
|
26130
|
+
#### ⚙️ Parameters
|
|
26131
|
+
|
|
26132
|
+
<dl>
|
|
26133
|
+
<dd>
|
|
26134
|
+
|
|
26135
|
+
<dl>
|
|
26136
|
+
<dd>
|
|
26137
|
+
|
|
26138
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
26139
|
+
|
|
26140
|
+
</dd>
|
|
26141
|
+
</dl>
|
|
26142
|
+
|
|
26143
|
+
<dl>
|
|
26144
|
+
<dd>
|
|
26145
|
+
|
|
26146
|
+
**request:** `Chrt.shippingIntegrations.dispatchScience.DispatchScienceCredsClientCreate1`
|
|
26147
|
+
|
|
26148
|
+
</dd>
|
|
26149
|
+
</dl>
|
|
26150
|
+
|
|
26151
|
+
<dl>
|
|
26152
|
+
<dd>
|
|
26153
|
+
|
|
26154
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
26155
|
+
|
|
26156
|
+
</dd>
|
|
26157
|
+
</dl>
|
|
26158
|
+
</dd>
|
|
26159
|
+
</dl>
|
|
26160
|
+
|
|
26161
|
+
</dd>
|
|
26162
|
+
</dl>
|
|
26163
|
+
</details>
|
|
26164
|
+
|
|
26165
|
+
<details><summary><code>client.shippingIntegrations.dispatchScience.creds.<a href="/src/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/Client.ts">deleteV1</a>(providerOrgId) -> boolean</code></summary>
|
|
26166
|
+
<dl>
|
|
26167
|
+
<dd>
|
|
26168
|
+
|
|
26169
|
+
#### 📝 Description
|
|
26170
|
+
|
|
26171
|
+
<dl>
|
|
26172
|
+
<dd>
|
|
26173
|
+
|
|
26174
|
+
<dl>
|
|
26175
|
+
<dd>
|
|
26176
|
+
|
|
26177
|
+
Deletes the caller's DispatchScience credentials for one provider, stopping future syncs. | authz: min_org_role=administrator | () -> (bool)
|
|
26178
|
+
|
|
26179
|
+
</dd>
|
|
26180
|
+
</dl>
|
|
26181
|
+
</dd>
|
|
26182
|
+
</dl>
|
|
26183
|
+
|
|
26184
|
+
#### 🔌 Usage
|
|
26185
|
+
|
|
26186
|
+
<dl>
|
|
26187
|
+
<dd>
|
|
26188
|
+
|
|
26189
|
+
<dl>
|
|
26190
|
+
<dd>
|
|
26191
|
+
|
|
26192
|
+
```typescript
|
|
26193
|
+
await client.shippingIntegrations.dispatchScience.creds.deleteV1("provider_org_id");
|
|
26194
|
+
```
|
|
26195
|
+
|
|
26196
|
+
</dd>
|
|
26197
|
+
</dl>
|
|
26198
|
+
</dd>
|
|
26199
|
+
</dl>
|
|
26200
|
+
|
|
26201
|
+
#### ⚙️ Parameters
|
|
26202
|
+
|
|
26203
|
+
<dl>
|
|
26204
|
+
<dd>
|
|
26205
|
+
|
|
26206
|
+
<dl>
|
|
26207
|
+
<dd>
|
|
26208
|
+
|
|
26209
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
26210
|
+
|
|
26211
|
+
</dd>
|
|
26212
|
+
</dl>
|
|
26213
|
+
|
|
26214
|
+
<dl>
|
|
26215
|
+
<dd>
|
|
26216
|
+
|
|
26217
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
26218
|
+
|
|
26219
|
+
</dd>
|
|
26220
|
+
</dl>
|
|
26221
|
+
</dd>
|
|
26222
|
+
</dl>
|
|
26223
|
+
|
|
26224
|
+
</dd>
|
|
26225
|
+
</dl>
|
|
26226
|
+
</details>
|
|
26227
|
+
|
|
26228
|
+
<details><summary><code>client.shippingIntegrations.dispatchScience.creds.<a href="/src/api/resources/shippingIntegrations/resources/dispatchScience/resources/creds/client/Client.ts">updateV1</a>(providerOrgId, { ...params }) -> boolean</code></summary>
|
|
26229
|
+
<dl>
|
|
26230
|
+
<dd>
|
|
26231
|
+
|
|
26232
|
+
#### 📝 Description
|
|
26233
|
+
|
|
26234
|
+
<dl>
|
|
26235
|
+
<dd>
|
|
26236
|
+
|
|
26237
|
+
<dl>
|
|
26238
|
+
<dd>
|
|
26239
|
+
|
|
26240
|
+
Updates the caller's DispatchScience credentials for one provider. | authz: min_org_role=administrator | (DispatchScienceCredsClientUpdate1) -> (bool)
|
|
26241
|
+
|
|
26242
|
+
</dd>
|
|
26243
|
+
</dl>
|
|
26244
|
+
</dd>
|
|
26245
|
+
</dl>
|
|
26246
|
+
|
|
26247
|
+
#### 🔌 Usage
|
|
26248
|
+
|
|
26249
|
+
<dl>
|
|
26250
|
+
<dd>
|
|
26251
|
+
|
|
26252
|
+
<dl>
|
|
26253
|
+
<dd>
|
|
26254
|
+
|
|
26255
|
+
```typescript
|
|
26256
|
+
await client.shippingIntegrations.dispatchScience.creds.updateV1("provider_org_id");
|
|
26257
|
+
```
|
|
26258
|
+
|
|
26259
|
+
</dd>
|
|
26260
|
+
</dl>
|
|
26261
|
+
</dd>
|
|
26262
|
+
</dl>
|
|
26263
|
+
|
|
26264
|
+
#### ⚙️ Parameters
|
|
26265
|
+
|
|
26266
|
+
<dl>
|
|
26267
|
+
<dd>
|
|
26268
|
+
|
|
26269
|
+
<dl>
|
|
26270
|
+
<dd>
|
|
26271
|
+
|
|
26272
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
26273
|
+
|
|
26274
|
+
</dd>
|
|
26275
|
+
</dl>
|
|
26276
|
+
|
|
26277
|
+
<dl>
|
|
26278
|
+
<dd>
|
|
26279
|
+
|
|
26280
|
+
**request:** `Chrt.shippingIntegrations.dispatchScience.DispatchScienceCredsClientUpdate1`
|
|
26281
|
+
|
|
26282
|
+
</dd>
|
|
26283
|
+
</dl>
|
|
26284
|
+
|
|
26285
|
+
<dl>
|
|
26286
|
+
<dd>
|
|
26287
|
+
|
|
26288
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
26289
|
+
|
|
26290
|
+
</dd>
|
|
26291
|
+
</dl>
|
|
26292
|
+
</dd>
|
|
26293
|
+
</dl>
|
|
26294
|
+
|
|
26295
|
+
</dd>
|
|
26296
|
+
</dl>
|
|
26297
|
+
</details>
|
|
26298
|
+
|
|
26299
|
+
## ShippingIntegrations DispatchScience Orders
|
|
26300
|
+
|
|
26301
|
+
<details><summary><code>client.shippingIntegrations.dispatchScience.orders.<a href="/src/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(providerOrgId, integrationOrderId) -> Chrt.DispatchScienceOrder1</code></summary>
|
|
26302
|
+
<dl>
|
|
26303
|
+
<dd>
|
|
26304
|
+
|
|
26305
|
+
#### 📝 Description
|
|
26306
|
+
|
|
26307
|
+
<dl>
|
|
26308
|
+
<dd>
|
|
26309
|
+
|
|
26310
|
+
<dl>
|
|
26311
|
+
<dd>
|
|
26312
|
+
|
|
26313
|
+
Returns one mirrored DispatchScience order by the provider's own order ID. | () -> (DispatchScienceOrder1)
|
|
26314
|
+
|
|
26315
|
+
</dd>
|
|
26316
|
+
</dl>
|
|
26317
|
+
</dd>
|
|
26318
|
+
</dl>
|
|
26319
|
+
|
|
26320
|
+
#### 🔌 Usage
|
|
26321
|
+
|
|
26322
|
+
<dl>
|
|
26323
|
+
<dd>
|
|
26324
|
+
|
|
26325
|
+
<dl>
|
|
26326
|
+
<dd>
|
|
26327
|
+
|
|
26328
|
+
```typescript
|
|
26329
|
+
await client.shippingIntegrations.dispatchScience.orders.detailByIntegrationOrderIdV1(
|
|
26330
|
+
"provider_org_id",
|
|
26331
|
+
"integration_order_id",
|
|
26332
|
+
);
|
|
26333
|
+
```
|
|
26334
|
+
|
|
26335
|
+
</dd>
|
|
26336
|
+
</dl>
|
|
26337
|
+
</dd>
|
|
26338
|
+
</dl>
|
|
26339
|
+
|
|
26340
|
+
#### ⚙️ Parameters
|
|
26341
|
+
|
|
26342
|
+
<dl>
|
|
26343
|
+
<dd>
|
|
26344
|
+
|
|
26345
|
+
<dl>
|
|
26346
|
+
<dd>
|
|
26347
|
+
|
|
26348
|
+
**providerOrgId:** `string` — CHRT org ID of the courier whose DispatchScience instance holds the order
|
|
26349
|
+
|
|
26350
|
+
</dd>
|
|
26351
|
+
</dl>
|
|
26352
|
+
|
|
26353
|
+
<dl>
|
|
26354
|
+
<dd>
|
|
26355
|
+
|
|
26356
|
+
**integrationOrderId:** `string` — DispatchScience's own ID for the order (its orderId), as carried on a unified order row
|
|
26357
|
+
|
|
26358
|
+
</dd>
|
|
26359
|
+
</dl>
|
|
26360
|
+
|
|
26361
|
+
<dl>
|
|
26362
|
+
<dd>
|
|
26363
|
+
|
|
26364
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
26365
|
+
|
|
26366
|
+
</dd>
|
|
26367
|
+
</dl>
|
|
26368
|
+
</dd>
|
|
26369
|
+
</dl>
|
|
26370
|
+
|
|
26371
|
+
</dd>
|
|
26372
|
+
</dl>
|
|
26373
|
+
</details>
|
|
26374
|
+
|
|
26375
|
+
<details><summary><code>client.shippingIntegrations.dispatchScience.orders.<a href="/src/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/Client.ts">detailV1</a>(id) -> Chrt.DispatchScienceOrder1</code></summary>
|
|
26376
|
+
<dl>
|
|
26377
|
+
<dd>
|
|
26378
|
+
|
|
26379
|
+
#### 📝 Description
|
|
26380
|
+
|
|
26381
|
+
<dl>
|
|
26382
|
+
<dd>
|
|
26383
|
+
|
|
26384
|
+
<dl>
|
|
26385
|
+
<dd>
|
|
26386
|
+
|
|
26387
|
+
Returns one mirrored DispatchScience order by its Mongo ObjectId. | () -> (DispatchScienceOrder1)
|
|
26388
|
+
|
|
26389
|
+
</dd>
|
|
26390
|
+
</dl>
|
|
26391
|
+
</dd>
|
|
26392
|
+
</dl>
|
|
26393
|
+
|
|
26394
|
+
#### 🔌 Usage
|
|
26395
|
+
|
|
26396
|
+
<dl>
|
|
26397
|
+
<dd>
|
|
26398
|
+
|
|
26399
|
+
<dl>
|
|
26400
|
+
<dd>
|
|
26401
|
+
|
|
26402
|
+
```typescript
|
|
26403
|
+
await client.shippingIntegrations.dispatchScience.orders.detailV1("id");
|
|
26404
|
+
```
|
|
26405
|
+
|
|
26406
|
+
</dd>
|
|
26407
|
+
</dl>
|
|
26408
|
+
</dd>
|
|
26409
|
+
</dl>
|
|
26410
|
+
|
|
26411
|
+
#### ⚙️ Parameters
|
|
26412
|
+
|
|
26413
|
+
<dl>
|
|
26414
|
+
<dd>
|
|
26415
|
+
|
|
26416
|
+
<dl>
|
|
26417
|
+
<dd>
|
|
26418
|
+
|
|
26419
|
+
**id:** `string` — Mongo ObjectId of the mirror document. DispatchScience's own order ID is the integration_order_id, accepted by the by_integration_order_id route.
|
|
26420
|
+
|
|
26421
|
+
</dd>
|
|
26422
|
+
</dl>
|
|
26423
|
+
|
|
26424
|
+
<dl>
|
|
26425
|
+
<dd>
|
|
26426
|
+
|
|
26427
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
26428
|
+
|
|
26429
|
+
</dd>
|
|
26430
|
+
</dl>
|
|
26431
|
+
</dd>
|
|
26432
|
+
</dl>
|
|
26433
|
+
|
|
26434
|
+
</dd>
|
|
26435
|
+
</dl>
|
|
26436
|
+
</details>
|
|
26437
|
+
|
|
26438
|
+
<details><summary><code>client.shippingIntegrations.dispatchScience.orders.<a href="/src/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DispatchScienceOrderListRes</code></summary>
|
|
26439
|
+
<dl>
|
|
26440
|
+
<dd>
|
|
26441
|
+
|
|
26442
|
+
#### 📝 Description
|
|
26443
|
+
|
|
26444
|
+
<dl>
|
|
26445
|
+
<dd>
|
|
26446
|
+
|
|
26447
|
+
<dl>
|
|
26448
|
+
<dd>
|
|
26449
|
+
|
|
26450
|
+
Lists mirrored DispatchScience orders for the caller's organization with filtering, sorting, pagination, and optional search. | () -> (DispatchScienceOrderListRes)
|
|
26451
|
+
|
|
26452
|
+
</dd>
|
|
26453
|
+
</dl>
|
|
26454
|
+
</dd>
|
|
26455
|
+
</dl>
|
|
26456
|
+
|
|
26457
|
+
#### 🔌 Usage
|
|
26458
|
+
|
|
26459
|
+
<dl>
|
|
26460
|
+
<dd>
|
|
26461
|
+
|
|
26462
|
+
<dl>
|
|
26463
|
+
<dd>
|
|
26464
|
+
|
|
26465
|
+
```typescript
|
|
26466
|
+
await client.shippingIntegrations.dispatchScience.orders.listV1({
|
|
26467
|
+
sort_by: "mirrored_at_timestamp",
|
|
26468
|
+
sort_order: "asc",
|
|
26469
|
+
page: 1,
|
|
26470
|
+
page_size: 1,
|
|
26471
|
+
search: "search",
|
|
26472
|
+
filter_provider_org_id: ["filter_provider_org_id"],
|
|
26473
|
+
filter_integration_order_id: "filter_integration_order_id",
|
|
26474
|
+
filter_provider_status: 1,
|
|
26475
|
+
filter_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
26476
|
+
filter_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
26477
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
26478
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
26479
|
+
filter_updated_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
26480
|
+
filter_updated_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
26481
|
+
});
|
|
26482
|
+
```
|
|
26483
|
+
|
|
26484
|
+
</dd>
|
|
26485
|
+
</dl>
|
|
26486
|
+
</dd>
|
|
26487
|
+
</dl>
|
|
26488
|
+
|
|
26489
|
+
#### ⚙️ Parameters
|
|
26490
|
+
|
|
26491
|
+
<dl>
|
|
26492
|
+
<dd>
|
|
26493
|
+
|
|
26494
|
+
<dl>
|
|
26495
|
+
<dd>
|
|
26496
|
+
|
|
26497
|
+
**request:** `Chrt.shippingIntegrations.dispatchScience.OrdersListV1Request`
|
|
26498
|
+
|
|
26499
|
+
</dd>
|
|
26500
|
+
</dl>
|
|
26501
|
+
|
|
26502
|
+
<dl>
|
|
26503
|
+
<dd>
|
|
26504
|
+
|
|
26505
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
26506
|
+
|
|
26507
|
+
</dd>
|
|
26508
|
+
</dl>
|
|
26509
|
+
</dd>
|
|
26510
|
+
</dl>
|
|
26511
|
+
|
|
26512
|
+
</dd>
|
|
26513
|
+
</dl>
|
|
26514
|
+
</details>
|
|
26515
|
+
|
|
26516
|
+
<details><summary><code>client.shippingIntegrations.dispatchScience.orders.<a href="/src/api/resources/shippingIntegrations/resources/dispatchScience/resources/orders/client/Client.ts">syncOneV1</a>({ ...params }) -> Chrt.DispatchScienceOrder1</code></summary>
|
|
26517
|
+
<dl>
|
|
26518
|
+
<dd>
|
|
26519
|
+
|
|
26520
|
+
#### 📝 Description
|
|
26521
|
+
|
|
26522
|
+
<dl>
|
|
26523
|
+
<dd>
|
|
26524
|
+
|
|
26525
|
+
<dl>
|
|
26526
|
+
<dd>
|
|
26527
|
+
|
|
26528
|
+
Fetches and mirrors one DispatchScience order by the provider's own order ID. | authz: min_org_role=operator | (DispatchScienceOrderSyncOneReq) -> (DispatchScienceOrder1)
|
|
26529
|
+
|
|
26530
|
+
</dd>
|
|
26531
|
+
</dl>
|
|
26532
|
+
</dd>
|
|
26533
|
+
</dl>
|
|
26534
|
+
|
|
26535
|
+
#### 🔌 Usage
|
|
26536
|
+
|
|
26537
|
+
<dl>
|
|
26538
|
+
<dd>
|
|
26539
|
+
|
|
26540
|
+
<dl>
|
|
26541
|
+
<dd>
|
|
26542
|
+
|
|
26543
|
+
```typescript
|
|
26544
|
+
await client.shippingIntegrations.dispatchScience.orders.syncOneV1({
|
|
26545
|
+
integration_order_id: "integration_order_id",
|
|
26546
|
+
provider_org_id: "provider_org_id",
|
|
26547
|
+
});
|
|
26548
|
+
```
|
|
26549
|
+
|
|
26550
|
+
</dd>
|
|
26551
|
+
</dl>
|
|
26552
|
+
</dd>
|
|
26553
|
+
</dl>
|
|
26554
|
+
|
|
26555
|
+
#### ⚙️ Parameters
|
|
26556
|
+
|
|
26557
|
+
<dl>
|
|
26558
|
+
<dd>
|
|
26559
|
+
|
|
26560
|
+
<dl>
|
|
26561
|
+
<dd>
|
|
26562
|
+
|
|
26563
|
+
**request:** `Chrt.shippingIntegrations.dispatchScience.DispatchScienceOrderSyncOneReq`
|
|
26564
|
+
|
|
26565
|
+
</dd>
|
|
26566
|
+
</dl>
|
|
26567
|
+
|
|
26568
|
+
<dl>
|
|
26569
|
+
<dd>
|
|
26570
|
+
|
|
26571
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
26572
|
+
|
|
26573
|
+
</dd>
|
|
26574
|
+
</dl>
|
|
26575
|
+
</dd>
|
|
26576
|
+
</dl>
|
|
26577
|
+
|
|
26578
|
+
</dd>
|
|
26579
|
+
</dl>
|
|
26580
|
+
</details>
|
|
26581
|
+
|
|
26582
|
+
## ShippingIntegrations Ontime360 Creds
|
|
26583
|
+
|
|
26584
|
+
<details><summary><code>client.shippingIntegrations.ontime360.creds.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.ts">detailV1</a>(providerOrgId) -> Chrt.OnTime360CredsLimited1</code></summary>
|
|
26585
|
+
<dl>
|
|
26586
|
+
<dd>
|
|
26587
|
+
|
|
26588
|
+
#### 📝 Description
|
|
26589
|
+
|
|
26590
|
+
<dl>
|
|
26591
|
+
<dd>
|
|
26592
|
+
|
|
26593
|
+
<dl>
|
|
26594
|
+
<dd>
|
|
26595
|
+
|
|
26596
|
+
Returns the caller's OnTime360 credential for one provider, without the API key. | () -> (OnTime360CredsLimited1)
|
|
26597
|
+
|
|
26598
|
+
</dd>
|
|
26599
|
+
</dl>
|
|
26600
|
+
</dd>
|
|
26601
|
+
</dl>
|
|
26602
|
+
|
|
26603
|
+
#### 🔌 Usage
|
|
26604
|
+
|
|
26605
|
+
<dl>
|
|
26606
|
+
<dd>
|
|
26607
|
+
|
|
26608
|
+
<dl>
|
|
26609
|
+
<dd>
|
|
26610
|
+
|
|
26611
|
+
```typescript
|
|
26612
|
+
await client.shippingIntegrations.ontime360.creds.detailV1("provider_org_id");
|
|
26613
|
+
```
|
|
26614
|
+
|
|
26615
|
+
</dd>
|
|
26616
|
+
</dl>
|
|
26617
|
+
</dd>
|
|
26618
|
+
</dl>
|
|
26619
|
+
|
|
26620
|
+
#### ⚙️ Parameters
|
|
26621
|
+
|
|
26622
|
+
<dl>
|
|
26623
|
+
<dd>
|
|
26624
|
+
|
|
26625
|
+
<dl>
|
|
26626
|
+
<dd>
|
|
26627
|
+
|
|
26628
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
26629
|
+
|
|
26630
|
+
</dd>
|
|
26631
|
+
</dl>
|
|
26632
|
+
|
|
26633
|
+
<dl>
|
|
26634
|
+
<dd>
|
|
26635
|
+
|
|
26636
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
26637
|
+
|
|
26638
|
+
</dd>
|
|
26639
|
+
</dl>
|
|
26640
|
+
</dd>
|
|
26641
|
+
</dl>
|
|
26642
|
+
|
|
26643
|
+
</dd>
|
|
26644
|
+
</dl>
|
|
26645
|
+
</details>
|
|
26646
|
+
|
|
26647
|
+
<details><summary><code>client.shippingIntegrations.ontime360.creds.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.ts">listV1</a>() -> Chrt.OnTime360CredsListRes</code></summary>
|
|
26648
|
+
<dl>
|
|
26649
|
+
<dd>
|
|
26650
|
+
|
|
26651
|
+
#### 📝 Description
|
|
26652
|
+
|
|
26653
|
+
<dl>
|
|
26654
|
+
<dd>
|
|
26655
|
+
|
|
26656
|
+
<dl>
|
|
26657
|
+
<dd>
|
|
26658
|
+
|
|
26659
|
+
Lists the caller's OnTime360 credentials, one per connected provider, without the API key. | () -> (OnTime360CredsListRes)
|
|
26660
|
+
|
|
26661
|
+
</dd>
|
|
26662
|
+
</dl>
|
|
26663
|
+
</dd>
|
|
26664
|
+
</dl>
|
|
26665
|
+
|
|
26666
|
+
#### 🔌 Usage
|
|
26667
|
+
|
|
26668
|
+
<dl>
|
|
26669
|
+
<dd>
|
|
26670
|
+
|
|
26671
|
+
<dl>
|
|
26672
|
+
<dd>
|
|
26673
|
+
|
|
26674
|
+
```typescript
|
|
26675
|
+
await client.shippingIntegrations.ontime360.creds.listV1();
|
|
26676
|
+
```
|
|
26677
|
+
|
|
26678
|
+
</dd>
|
|
26679
|
+
</dl>
|
|
26680
|
+
</dd>
|
|
26681
|
+
</dl>
|
|
26682
|
+
|
|
26683
|
+
#### ⚙️ Parameters
|
|
26684
|
+
|
|
26685
|
+
<dl>
|
|
26686
|
+
<dd>
|
|
26687
|
+
|
|
26688
|
+
<dl>
|
|
26689
|
+
<dd>
|
|
26690
|
+
|
|
26691
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
26692
|
+
|
|
26693
|
+
</dd>
|
|
26694
|
+
</dl>
|
|
26695
|
+
</dd>
|
|
26696
|
+
</dl>
|
|
26697
|
+
|
|
26698
|
+
</dd>
|
|
26699
|
+
</dl>
|
|
26700
|
+
</details>
|
|
26701
|
+
|
|
26702
|
+
<details><summary><code>client.shippingIntegrations.ontime360.creds.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.ts">testV1</a>(providerOrgId) -> Chrt.OnTime360CredsTestRes</code></summary>
|
|
26703
|
+
<dl>
|
|
26704
|
+
<dd>
|
|
26705
|
+
|
|
26706
|
+
#### 📝 Description
|
|
26707
|
+
|
|
26708
|
+
<dl>
|
|
26709
|
+
<dd>
|
|
26710
|
+
|
|
26711
|
+
<dl>
|
|
26712
|
+
<dd>
|
|
26713
|
+
|
|
26714
|
+
Confirms the caller's stored OnTime360 credentials for one provider can still perform a scoped read, best-effort refreshes the provider's own account label for the caller to eyeball, and reports the provider's own reported time zones beside the stored one. | authz: min_org_role=operator | () -> (OnTime360CredsTestRes)
|
|
26715
|
+
|
|
26716
|
+
</dd>
|
|
26717
|
+
</dl>
|
|
26718
|
+
</dd>
|
|
26719
|
+
</dl>
|
|
26720
|
+
|
|
26721
|
+
#### 🔌 Usage
|
|
26722
|
+
|
|
26723
|
+
<dl>
|
|
26724
|
+
<dd>
|
|
26725
|
+
|
|
26726
|
+
<dl>
|
|
26727
|
+
<dd>
|
|
26728
|
+
|
|
26729
|
+
```typescript
|
|
26730
|
+
await client.shippingIntegrations.ontime360.creds.testV1("provider_org_id");
|
|
26731
|
+
```
|
|
26732
|
+
|
|
26733
|
+
</dd>
|
|
26734
|
+
</dl>
|
|
26735
|
+
</dd>
|
|
26736
|
+
</dl>
|
|
26737
|
+
|
|
26738
|
+
#### ⚙️ Parameters
|
|
26739
|
+
|
|
26740
|
+
<dl>
|
|
26741
|
+
<dd>
|
|
26742
|
+
|
|
26743
|
+
<dl>
|
|
26744
|
+
<dd>
|
|
26745
|
+
|
|
26746
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
26747
|
+
|
|
26748
|
+
</dd>
|
|
26749
|
+
</dl>
|
|
26750
|
+
|
|
26751
|
+
<dl>
|
|
26752
|
+
<dd>
|
|
26753
|
+
|
|
26754
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
26755
|
+
|
|
26756
|
+
</dd>
|
|
26757
|
+
</dl>
|
|
26758
|
+
</dd>
|
|
26759
|
+
</dl>
|
|
26760
|
+
|
|
26761
|
+
</dd>
|
|
26762
|
+
</dl>
|
|
26763
|
+
</details>
|
|
26764
|
+
|
|
26765
|
+
<details><summary><code>client.shippingIntegrations.ontime360.creds.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.ts">createV1</a>(providerOrgId, { ...params }) -> string</code></summary>
|
|
26766
|
+
<dl>
|
|
26767
|
+
<dd>
|
|
26768
|
+
|
|
26769
|
+
#### 📝 Description
|
|
26770
|
+
|
|
26771
|
+
<dl>
|
|
26772
|
+
<dd>
|
|
26773
|
+
|
|
26774
|
+
<dl>
|
|
26775
|
+
<dd>
|
|
26776
|
+
|
|
26777
|
+
Stores OnTime360 credentials for one provider on behalf of the caller's organization. | authz: min_org_role=administrator | (OnTime360CredsClientCreate1) -> (PydanticObjectId)
|
|
26778
|
+
|
|
26779
|
+
</dd>
|
|
26780
|
+
</dl>
|
|
26781
|
+
</dd>
|
|
26782
|
+
</dl>
|
|
26783
|
+
|
|
26784
|
+
#### 🔌 Usage
|
|
26785
|
+
|
|
26786
|
+
<dl>
|
|
26787
|
+
<dd>
|
|
26788
|
+
|
|
26789
|
+
<dl>
|
|
26790
|
+
<dd>
|
|
26791
|
+
|
|
26792
|
+
```typescript
|
|
26793
|
+
await client.shippingIntegrations.ontime360.creds.createV1("provider_org_id", {
|
|
26794
|
+
api_key: "api_key",
|
|
26795
|
+
base_url: "base_url",
|
|
26796
|
+
schema_version: 1,
|
|
26797
|
+
site_time_zone: "America/New_York",
|
|
26798
|
+
});
|
|
26799
|
+
```
|
|
26800
|
+
|
|
26801
|
+
</dd>
|
|
26802
|
+
</dl>
|
|
26803
|
+
</dd>
|
|
26804
|
+
</dl>
|
|
26805
|
+
|
|
26806
|
+
#### ⚙️ Parameters
|
|
26807
|
+
|
|
26808
|
+
<dl>
|
|
26809
|
+
<dd>
|
|
26810
|
+
|
|
26811
|
+
<dl>
|
|
26812
|
+
<dd>
|
|
26813
|
+
|
|
26814
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
26815
|
+
|
|
26816
|
+
</dd>
|
|
26817
|
+
</dl>
|
|
26818
|
+
|
|
26819
|
+
<dl>
|
|
26820
|
+
<dd>
|
|
26821
|
+
|
|
26822
|
+
**request:** `Chrt.shippingIntegrations.ontime360.OnTime360CredsClientCreate1`
|
|
26823
|
+
|
|
26824
|
+
</dd>
|
|
26825
|
+
</dl>
|
|
26826
|
+
|
|
26827
|
+
<dl>
|
|
26828
|
+
<dd>
|
|
26829
|
+
|
|
26830
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
26831
|
+
|
|
26832
|
+
</dd>
|
|
26833
|
+
</dl>
|
|
26834
|
+
</dd>
|
|
26835
|
+
</dl>
|
|
26836
|
+
|
|
26837
|
+
</dd>
|
|
26838
|
+
</dl>
|
|
26839
|
+
</details>
|
|
26840
|
+
|
|
26841
|
+
<details><summary><code>client.shippingIntegrations.ontime360.creds.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.ts">deleteV1</a>(providerOrgId) -> boolean</code></summary>
|
|
26842
|
+
<dl>
|
|
26843
|
+
<dd>
|
|
26844
|
+
|
|
26845
|
+
#### 📝 Description
|
|
26846
|
+
|
|
26847
|
+
<dl>
|
|
26848
|
+
<dd>
|
|
26849
|
+
|
|
26850
|
+
<dl>
|
|
26851
|
+
<dd>
|
|
26852
|
+
|
|
26853
|
+
Deletes the caller's OnTime360 credentials for one provider, stopping future syncs. | authz: min_org_role=administrator | () -> (bool)
|
|
26854
|
+
|
|
26855
|
+
</dd>
|
|
26856
|
+
</dl>
|
|
26857
|
+
</dd>
|
|
26858
|
+
</dl>
|
|
26859
|
+
|
|
26860
|
+
#### 🔌 Usage
|
|
26861
|
+
|
|
26862
|
+
<dl>
|
|
26863
|
+
<dd>
|
|
26864
|
+
|
|
26865
|
+
<dl>
|
|
26866
|
+
<dd>
|
|
26867
|
+
|
|
26868
|
+
```typescript
|
|
26869
|
+
await client.shippingIntegrations.ontime360.creds.deleteV1("provider_org_id");
|
|
26870
|
+
```
|
|
26871
|
+
|
|
26872
|
+
</dd>
|
|
26873
|
+
</dl>
|
|
26874
|
+
</dd>
|
|
26875
|
+
</dl>
|
|
26876
|
+
|
|
26877
|
+
#### ⚙️ Parameters
|
|
26878
|
+
|
|
26879
|
+
<dl>
|
|
26880
|
+
<dd>
|
|
26881
|
+
|
|
26882
|
+
<dl>
|
|
26883
|
+
<dd>
|
|
26884
|
+
|
|
26885
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
26886
|
+
|
|
26887
|
+
</dd>
|
|
26888
|
+
</dl>
|
|
26889
|
+
|
|
26890
|
+
<dl>
|
|
26891
|
+
<dd>
|
|
26892
|
+
|
|
26893
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
26894
|
+
|
|
26895
|
+
</dd>
|
|
26896
|
+
</dl>
|
|
26897
|
+
</dd>
|
|
26898
|
+
</dl>
|
|
26899
|
+
|
|
26900
|
+
</dd>
|
|
26901
|
+
</dl>
|
|
26902
|
+
</details>
|
|
26903
|
+
|
|
26904
|
+
<details><summary><code>client.shippingIntegrations.ontime360.creds.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.ts">updateV1</a>(providerOrgId, { ...params }) -> boolean</code></summary>
|
|
26905
|
+
<dl>
|
|
26906
|
+
<dd>
|
|
26907
|
+
|
|
26908
|
+
#### 📝 Description
|
|
26909
|
+
|
|
26910
|
+
<dl>
|
|
26911
|
+
<dd>
|
|
26912
|
+
|
|
26913
|
+
<dl>
|
|
26914
|
+
<dd>
|
|
26915
|
+
|
|
26916
|
+
Updates the caller's OnTime360 credentials for one provider. | authz: min_org_role=administrator | (OnTime360CredsClientUpdate1) -> (bool)
|
|
26917
|
+
|
|
26918
|
+
</dd>
|
|
26919
|
+
</dl>
|
|
26920
|
+
</dd>
|
|
26921
|
+
</dl>
|
|
26922
|
+
|
|
26923
|
+
#### 🔌 Usage
|
|
26924
|
+
|
|
26925
|
+
<dl>
|
|
26926
|
+
<dd>
|
|
26927
|
+
|
|
26928
|
+
<dl>
|
|
26929
|
+
<dd>
|
|
26930
|
+
|
|
26931
|
+
```typescript
|
|
26932
|
+
await client.shippingIntegrations.ontime360.creds.updateV1("provider_org_id");
|
|
26933
|
+
```
|
|
26934
|
+
|
|
26935
|
+
</dd>
|
|
26936
|
+
</dl>
|
|
26937
|
+
</dd>
|
|
26938
|
+
</dl>
|
|
26939
|
+
|
|
26940
|
+
#### ⚙️ Parameters
|
|
26941
|
+
|
|
26942
|
+
<dl>
|
|
26943
|
+
<dd>
|
|
26944
|
+
|
|
26945
|
+
<dl>
|
|
26946
|
+
<dd>
|
|
26947
|
+
|
|
26948
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
26949
|
+
|
|
26950
|
+
</dd>
|
|
26951
|
+
</dl>
|
|
26952
|
+
|
|
26953
|
+
<dl>
|
|
26954
|
+
<dd>
|
|
26955
|
+
|
|
26956
|
+
**request:** `Chrt.shippingIntegrations.ontime360.OnTime360CredsClientUpdate1`
|
|
26957
|
+
|
|
26958
|
+
</dd>
|
|
26959
|
+
</dl>
|
|
26960
|
+
|
|
26961
|
+
<dl>
|
|
26962
|
+
<dd>
|
|
26963
|
+
|
|
26964
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
26965
|
+
|
|
26966
|
+
</dd>
|
|
26967
|
+
</dl>
|
|
26968
|
+
</dd>
|
|
26969
|
+
</dl>
|
|
26970
|
+
|
|
26971
|
+
</dd>
|
|
26972
|
+
</dl>
|
|
26973
|
+
</details>
|
|
26974
|
+
|
|
26975
|
+
## ShippingIntegrations Ontime360 Orders
|
|
26976
|
+
|
|
26977
|
+
<details><summary><code>client.shippingIntegrations.ontime360.orders.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(providerOrgId, integrationOrderId) -> Chrt.OnTime360Order1</code></summary>
|
|
26978
|
+
<dl>
|
|
26979
|
+
<dd>
|
|
26980
|
+
|
|
26981
|
+
#### 📝 Description
|
|
26982
|
+
|
|
26983
|
+
<dl>
|
|
26984
|
+
<dd>
|
|
26985
|
+
|
|
26986
|
+
<dl>
|
|
26987
|
+
<dd>
|
|
26988
|
+
|
|
26989
|
+
Returns one mirrored OnTime360 order by the provider's own order GUID. | () -> (OnTime360Order1)
|
|
26990
|
+
|
|
26991
|
+
</dd>
|
|
26992
|
+
</dl>
|
|
26993
|
+
</dd>
|
|
26994
|
+
</dl>
|
|
26995
|
+
|
|
26996
|
+
#### 🔌 Usage
|
|
26997
|
+
|
|
26998
|
+
<dl>
|
|
26999
|
+
<dd>
|
|
27000
|
+
|
|
27001
|
+
<dl>
|
|
27002
|
+
<dd>
|
|
27003
|
+
|
|
27004
|
+
```typescript
|
|
27005
|
+
await client.shippingIntegrations.ontime360.orders.detailByIntegrationOrderIdV1(
|
|
27006
|
+
"provider_org_id",
|
|
27007
|
+
"integration_order_id",
|
|
27008
|
+
);
|
|
27009
|
+
```
|
|
27010
|
+
|
|
27011
|
+
</dd>
|
|
27012
|
+
</dl>
|
|
27013
|
+
</dd>
|
|
27014
|
+
</dl>
|
|
27015
|
+
|
|
27016
|
+
#### ⚙️ Parameters
|
|
27017
|
+
|
|
27018
|
+
<dl>
|
|
27019
|
+
<dd>
|
|
27020
|
+
|
|
27021
|
+
<dl>
|
|
27022
|
+
<dd>
|
|
27023
|
+
|
|
27024
|
+
**providerOrgId:** `string` — CHRT org ID of the courier whose OnTime360 site holds the order
|
|
27025
|
+
|
|
27026
|
+
</dd>
|
|
27027
|
+
</dl>
|
|
27028
|
+
|
|
27029
|
+
<dl>
|
|
27030
|
+
<dd>
|
|
27031
|
+
|
|
27032
|
+
**integrationOrderId:** `string` — OnTime360's own GUID for the order (its ID), as carried on a unified order row
|
|
27033
|
+
|
|
27034
|
+
</dd>
|
|
27035
|
+
</dl>
|
|
27036
|
+
|
|
27037
|
+
<dl>
|
|
27038
|
+
<dd>
|
|
27039
|
+
|
|
27040
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
27041
|
+
|
|
27042
|
+
</dd>
|
|
27043
|
+
</dl>
|
|
27044
|
+
</dd>
|
|
27045
|
+
</dl>
|
|
27046
|
+
|
|
27047
|
+
</dd>
|
|
27048
|
+
</dl>
|
|
27049
|
+
</details>
|
|
27050
|
+
|
|
27051
|
+
<details><summary><code>client.shippingIntegrations.ontime360.orders.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.ts">detailV1</a>(id) -> Chrt.OnTime360Order1</code></summary>
|
|
27052
|
+
<dl>
|
|
27053
|
+
<dd>
|
|
27054
|
+
|
|
27055
|
+
#### 📝 Description
|
|
27056
|
+
|
|
27057
|
+
<dl>
|
|
27058
|
+
<dd>
|
|
27059
|
+
|
|
27060
|
+
<dl>
|
|
27061
|
+
<dd>
|
|
27062
|
+
|
|
27063
|
+
Returns one mirrored OnTime360 order by its Mongo ObjectId. | () -> (OnTime360Order1)
|
|
27064
|
+
|
|
27065
|
+
</dd>
|
|
27066
|
+
</dl>
|
|
27067
|
+
</dd>
|
|
27068
|
+
</dl>
|
|
27069
|
+
|
|
27070
|
+
#### 🔌 Usage
|
|
27071
|
+
|
|
27072
|
+
<dl>
|
|
27073
|
+
<dd>
|
|
27074
|
+
|
|
27075
|
+
<dl>
|
|
27076
|
+
<dd>
|
|
27077
|
+
|
|
27078
|
+
```typescript
|
|
27079
|
+
await client.shippingIntegrations.ontime360.orders.detailV1("id");
|
|
27080
|
+
```
|
|
27081
|
+
|
|
27082
|
+
</dd>
|
|
27083
|
+
</dl>
|
|
27084
|
+
</dd>
|
|
27085
|
+
</dl>
|
|
27086
|
+
|
|
27087
|
+
#### ⚙️ Parameters
|
|
27088
|
+
|
|
27089
|
+
<dl>
|
|
27090
|
+
<dd>
|
|
27091
|
+
|
|
27092
|
+
<dl>
|
|
27093
|
+
<dd>
|
|
27094
|
+
|
|
27095
|
+
**id:** `string` — Mongo ObjectId of the mirror document. OnTime360's own order GUID is the integration_order_id, accepted by the by_integration_order_id route.
|
|
27096
|
+
|
|
27097
|
+
</dd>
|
|
27098
|
+
</dl>
|
|
27099
|
+
|
|
27100
|
+
<dl>
|
|
27101
|
+
<dd>
|
|
27102
|
+
|
|
27103
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
27104
|
+
|
|
27105
|
+
</dd>
|
|
27106
|
+
</dl>
|
|
27107
|
+
</dd>
|
|
27108
|
+
</dl>
|
|
27109
|
+
|
|
27110
|
+
</dd>
|
|
27111
|
+
</dl>
|
|
27112
|
+
</details>
|
|
27113
|
+
|
|
27114
|
+
<details><summary><code>client.shippingIntegrations.ontime360.orders.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OnTime360OrderListRes</code></summary>
|
|
27115
|
+
<dl>
|
|
27116
|
+
<dd>
|
|
27117
|
+
|
|
27118
|
+
#### 📝 Description
|
|
27119
|
+
|
|
27120
|
+
<dl>
|
|
27121
|
+
<dd>
|
|
27122
|
+
|
|
27123
|
+
<dl>
|
|
27124
|
+
<dd>
|
|
27125
|
+
|
|
27126
|
+
Lists mirrored OnTime360 orders for the caller's organization with filtering, sorting, pagination, and optional search. | () -> (OnTime360OrderListRes)
|
|
27127
|
+
|
|
27128
|
+
</dd>
|
|
27129
|
+
</dl>
|
|
27130
|
+
</dd>
|
|
27131
|
+
</dl>
|
|
27132
|
+
|
|
27133
|
+
#### 🔌 Usage
|
|
27134
|
+
|
|
27135
|
+
<dl>
|
|
27136
|
+
<dd>
|
|
27137
|
+
|
|
27138
|
+
<dl>
|
|
27139
|
+
<dd>
|
|
27140
|
+
|
|
27141
|
+
```typescript
|
|
27142
|
+
await client.shippingIntegrations.ontime360.orders.listV1({
|
|
27143
|
+
sort_by: "mirrored_at_timestamp",
|
|
27144
|
+
sort_order: "asc",
|
|
27145
|
+
page: 1,
|
|
27146
|
+
page_size: 1,
|
|
27147
|
+
search: "search",
|
|
27148
|
+
filter_provider_org_id: ["filter_provider_org_id"],
|
|
27149
|
+
filter_integration_order_id: "filter_integration_order_id",
|
|
27150
|
+
filter_provider_status_level: 1,
|
|
27151
|
+
filter_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
27152
|
+
filter_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
27153
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
27154
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
27155
|
+
filter_updated_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
27156
|
+
filter_updated_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
27157
|
+
});
|
|
27158
|
+
```
|
|
27159
|
+
|
|
27160
|
+
</dd>
|
|
27161
|
+
</dl>
|
|
27162
|
+
</dd>
|
|
27163
|
+
</dl>
|
|
27164
|
+
|
|
27165
|
+
#### ⚙️ Parameters
|
|
27166
|
+
|
|
27167
|
+
<dl>
|
|
27168
|
+
<dd>
|
|
27169
|
+
|
|
27170
|
+
<dl>
|
|
27171
|
+
<dd>
|
|
27172
|
+
|
|
27173
|
+
**request:** `Chrt.shippingIntegrations.ontime360.OrdersListV1Request`
|
|
27174
|
+
|
|
27175
|
+
</dd>
|
|
27176
|
+
</dl>
|
|
27177
|
+
|
|
27178
|
+
<dl>
|
|
27179
|
+
<dd>
|
|
27180
|
+
|
|
27181
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
27182
|
+
|
|
27183
|
+
</dd>
|
|
27184
|
+
</dl>
|
|
27185
|
+
</dd>
|
|
27186
|
+
</dl>
|
|
27187
|
+
|
|
27188
|
+
</dd>
|
|
27189
|
+
</dl>
|
|
27190
|
+
</details>
|
|
27191
|
+
|
|
27192
|
+
<details><summary><code>client.shippingIntegrations.ontime360.orders.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.ts">syncOneV1</a>({ ...params }) -> Chrt.OnTime360Order1</code></summary>
|
|
27193
|
+
<dl>
|
|
27194
|
+
<dd>
|
|
27195
|
+
|
|
27196
|
+
#### 📝 Description
|
|
27197
|
+
|
|
27198
|
+
<dl>
|
|
27199
|
+
<dd>
|
|
27200
|
+
|
|
27201
|
+
<dl>
|
|
27202
|
+
<dd>
|
|
27203
|
+
|
|
27204
|
+
Fetches and mirrors one OnTime360 order by the provider's own order GUID, updating the unified order list alongside it. | authz: min_org_role=operator | (OnTime360OrderSyncOneReq) -> (OnTime360Order1)
|
|
27205
|
+
|
|
27206
|
+
</dd>
|
|
27207
|
+
</dl>
|
|
27208
|
+
</dd>
|
|
27209
|
+
</dl>
|
|
27210
|
+
|
|
27211
|
+
#### 🔌 Usage
|
|
27212
|
+
|
|
27213
|
+
<dl>
|
|
27214
|
+
<dd>
|
|
27215
|
+
|
|
27216
|
+
<dl>
|
|
27217
|
+
<dd>
|
|
27218
|
+
|
|
27219
|
+
```typescript
|
|
27220
|
+
await client.shippingIntegrations.ontime360.orders.syncOneV1({
|
|
27221
|
+
integration_order_id: "integration_order_id",
|
|
27222
|
+
provider_org_id: "provider_org_id",
|
|
27223
|
+
});
|
|
27224
|
+
```
|
|
27225
|
+
|
|
27226
|
+
</dd>
|
|
27227
|
+
</dl>
|
|
27228
|
+
</dd>
|
|
27229
|
+
</dl>
|
|
27230
|
+
|
|
27231
|
+
#### ⚙️ Parameters
|
|
27232
|
+
|
|
27233
|
+
<dl>
|
|
27234
|
+
<dd>
|
|
27235
|
+
|
|
27236
|
+
<dl>
|
|
27237
|
+
<dd>
|
|
27238
|
+
|
|
27239
|
+
**request:** `Chrt.shippingIntegrations.ontime360.OnTime360OrderSyncOneReq`
|
|
27240
|
+
|
|
27241
|
+
</dd>
|
|
27242
|
+
</dl>
|
|
27243
|
+
|
|
27244
|
+
<dl>
|
|
27245
|
+
<dd>
|
|
27246
|
+
|
|
27247
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
27248
|
+
|
|
27249
|
+
</dd>
|
|
27250
|
+
</dl>
|
|
27251
|
+
</dd>
|
|
27252
|
+
</dl>
|
|
27253
|
+
|
|
27254
|
+
</dd>
|
|
27255
|
+
</dl>
|
|
27256
|
+
</details>
|
|
27257
|
+
|
|
27258
|
+
## ShippingIntegrations Xcelerator Creds
|
|
27259
|
+
|
|
27260
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.creds.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.ts">detailV1</a>(providerOrgId) -> Chrt.XceleratorCredsLimited1</code></summary>
|
|
27261
|
+
<dl>
|
|
27262
|
+
<dd>
|
|
27263
|
+
|
|
27264
|
+
#### 📝 Description
|
|
27265
|
+
|
|
27266
|
+
<dl>
|
|
27267
|
+
<dd>
|
|
27268
|
+
|
|
27269
|
+
<dl>
|
|
27270
|
+
<dd>
|
|
27271
|
+
|
|
27272
|
+
Returns the caller's Xcelerator credential for one provider, without password or access token. | () -> (XceleratorCredsLimited1)
|
|
27273
|
+
|
|
27274
|
+
</dd>
|
|
27275
|
+
</dl>
|
|
27276
|
+
</dd>
|
|
27277
|
+
</dl>
|
|
27278
|
+
|
|
27279
|
+
#### 🔌 Usage
|
|
27280
|
+
|
|
27281
|
+
<dl>
|
|
27282
|
+
<dd>
|
|
27283
|
+
|
|
27284
|
+
<dl>
|
|
27285
|
+
<dd>
|
|
27286
|
+
|
|
27287
|
+
```typescript
|
|
27288
|
+
await client.shippingIntegrations.xcelerator.creds.detailV1("provider_org_id");
|
|
27289
|
+
```
|
|
27290
|
+
|
|
27291
|
+
</dd>
|
|
27292
|
+
</dl>
|
|
27293
|
+
</dd>
|
|
27294
|
+
</dl>
|
|
27295
|
+
|
|
27296
|
+
#### ⚙️ Parameters
|
|
27297
|
+
|
|
27298
|
+
<dl>
|
|
27299
|
+
<dd>
|
|
27300
|
+
|
|
27301
|
+
<dl>
|
|
27302
|
+
<dd>
|
|
27303
|
+
|
|
27304
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
27305
|
+
|
|
27306
|
+
</dd>
|
|
27307
|
+
</dl>
|
|
27308
|
+
|
|
27309
|
+
<dl>
|
|
27310
|
+
<dd>
|
|
27311
|
+
|
|
27312
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
27313
|
+
|
|
27314
|
+
</dd>
|
|
27315
|
+
</dl>
|
|
27316
|
+
</dd>
|
|
27317
|
+
</dl>
|
|
27318
|
+
|
|
27319
|
+
</dd>
|
|
27320
|
+
</dl>
|
|
27321
|
+
</details>
|
|
27322
|
+
|
|
27323
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.creds.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.ts">listV1</a>() -> Chrt.XceleratorCredsListRes</code></summary>
|
|
27324
|
+
<dl>
|
|
27325
|
+
<dd>
|
|
27326
|
+
|
|
27327
|
+
#### 📝 Description
|
|
27328
|
+
|
|
27329
|
+
<dl>
|
|
27330
|
+
<dd>
|
|
27331
|
+
|
|
27332
|
+
<dl>
|
|
27333
|
+
<dd>
|
|
27334
|
+
|
|
27335
|
+
Lists the caller's Xcelerator credentials, one per connected provider, without password or access token. | () -> (XceleratorCredsListRes)
|
|
27336
|
+
|
|
27337
|
+
</dd>
|
|
27338
|
+
</dl>
|
|
27339
|
+
</dd>
|
|
27340
|
+
</dl>
|
|
27341
|
+
|
|
27342
|
+
#### 🔌 Usage
|
|
27343
|
+
|
|
27344
|
+
<dl>
|
|
27345
|
+
<dd>
|
|
27346
|
+
|
|
27347
|
+
<dl>
|
|
27348
|
+
<dd>
|
|
27349
|
+
|
|
27350
|
+
```typescript
|
|
27351
|
+
await client.shippingIntegrations.xcelerator.creds.listV1();
|
|
27352
|
+
```
|
|
27353
|
+
|
|
27354
|
+
</dd>
|
|
27355
|
+
</dl>
|
|
27356
|
+
</dd>
|
|
27357
|
+
</dl>
|
|
27358
|
+
|
|
27359
|
+
#### ⚙️ Parameters
|
|
27360
|
+
|
|
27361
|
+
<dl>
|
|
27362
|
+
<dd>
|
|
27363
|
+
|
|
27364
|
+
<dl>
|
|
27365
|
+
<dd>
|
|
27366
|
+
|
|
27367
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
27368
|
+
|
|
27369
|
+
</dd>
|
|
27370
|
+
</dl>
|
|
27371
|
+
</dd>
|
|
27372
|
+
</dl>
|
|
27373
|
+
|
|
27374
|
+
</dd>
|
|
27375
|
+
</dl>
|
|
27376
|
+
</details>
|
|
27377
|
+
|
|
27378
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.creds.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.ts">testV1</a>(providerOrgId) -> Chrt.XceleratorCredsTestRes</code></summary>
|
|
27379
|
+
<dl>
|
|
27380
|
+
<dd>
|
|
27381
|
+
|
|
27382
|
+
#### 📝 Description
|
|
27383
|
+
|
|
27384
|
+
<dl>
|
|
27385
|
+
<dd>
|
|
27386
|
+
|
|
27387
|
+
<dl>
|
|
27388
|
+
<dd>
|
|
27389
|
+
|
|
27390
|
+
Confirms the caller's stored Xcelerator credentials for one provider can still obtain an access token, and best-effort refreshes the provider's own account label for the caller to eyeball. | authz: min_org_role=operator | () -> (XceleratorCredsTestRes)
|
|
27391
|
+
|
|
27392
|
+
</dd>
|
|
27393
|
+
</dl>
|
|
27394
|
+
</dd>
|
|
27395
|
+
</dl>
|
|
27396
|
+
|
|
27397
|
+
#### 🔌 Usage
|
|
27398
|
+
|
|
27399
|
+
<dl>
|
|
27400
|
+
<dd>
|
|
27401
|
+
|
|
27402
|
+
<dl>
|
|
27403
|
+
<dd>
|
|
27404
|
+
|
|
27405
|
+
```typescript
|
|
27406
|
+
await client.shippingIntegrations.xcelerator.creds.testV1("provider_org_id");
|
|
27407
|
+
```
|
|
27408
|
+
|
|
27409
|
+
</dd>
|
|
27410
|
+
</dl>
|
|
27411
|
+
</dd>
|
|
27412
|
+
</dl>
|
|
27413
|
+
|
|
27414
|
+
#### ⚙️ Parameters
|
|
27415
|
+
|
|
27416
|
+
<dl>
|
|
27417
|
+
<dd>
|
|
27418
|
+
|
|
27419
|
+
<dl>
|
|
27420
|
+
<dd>
|
|
27421
|
+
|
|
27422
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
27423
|
+
|
|
27424
|
+
</dd>
|
|
27425
|
+
</dl>
|
|
27426
|
+
|
|
27427
|
+
<dl>
|
|
27428
|
+
<dd>
|
|
27429
|
+
|
|
27430
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
27431
|
+
|
|
27432
|
+
</dd>
|
|
27433
|
+
</dl>
|
|
27434
|
+
</dd>
|
|
27435
|
+
</dl>
|
|
27436
|
+
|
|
27437
|
+
</dd>
|
|
27438
|
+
</dl>
|
|
27439
|
+
</details>
|
|
27440
|
+
|
|
27441
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.creds.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.ts">createV1</a>(providerOrgId, { ...params }) -> string</code></summary>
|
|
27442
|
+
<dl>
|
|
27443
|
+
<dd>
|
|
27444
|
+
|
|
27445
|
+
#### 📝 Description
|
|
27446
|
+
|
|
27447
|
+
<dl>
|
|
27448
|
+
<dd>
|
|
27449
|
+
|
|
27450
|
+
<dl>
|
|
27451
|
+
<dd>
|
|
27452
|
+
|
|
27453
|
+
Stores Xcelerator credentials for one provider on behalf of the caller's organization. | authz: min_org_role=administrator | (XceleratorCredsClientCreate1) -> (PydanticObjectId)
|
|
27454
|
+
|
|
27455
|
+
</dd>
|
|
27456
|
+
</dl>
|
|
27457
|
+
</dd>
|
|
27458
|
+
</dl>
|
|
27459
|
+
|
|
27460
|
+
#### 🔌 Usage
|
|
27461
|
+
|
|
27462
|
+
<dl>
|
|
27463
|
+
<dd>
|
|
27464
|
+
|
|
27465
|
+
<dl>
|
|
27466
|
+
<dd>
|
|
27467
|
+
|
|
27468
|
+
```typescript
|
|
27469
|
+
await client.shippingIntegrations.xcelerator.creds.createV1("provider_org_id", {
|
|
27470
|
+
base_url: "https://tenant.dispatchscience.com",
|
|
27471
|
+
password: "password",
|
|
27472
|
+
schema_version: 1,
|
|
27473
|
+
username: "username",
|
|
27474
|
+
});
|
|
27475
|
+
```
|
|
27476
|
+
|
|
27477
|
+
</dd>
|
|
27478
|
+
</dl>
|
|
27479
|
+
</dd>
|
|
27480
|
+
</dl>
|
|
27481
|
+
|
|
27482
|
+
#### ⚙️ Parameters
|
|
27483
|
+
|
|
27484
|
+
<dl>
|
|
27485
|
+
<dd>
|
|
27486
|
+
|
|
27487
|
+
<dl>
|
|
27488
|
+
<dd>
|
|
27489
|
+
|
|
27490
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
27491
|
+
|
|
27492
|
+
</dd>
|
|
27493
|
+
</dl>
|
|
27494
|
+
|
|
27495
|
+
<dl>
|
|
27496
|
+
<dd>
|
|
27497
|
+
|
|
27498
|
+
**request:** `Chrt.shippingIntegrations.xcelerator.XceleratorCredsClientCreate1`
|
|
27499
|
+
|
|
27500
|
+
</dd>
|
|
27501
|
+
</dl>
|
|
27502
|
+
|
|
27503
|
+
<dl>
|
|
27504
|
+
<dd>
|
|
27505
|
+
|
|
27506
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
27507
|
+
|
|
27508
|
+
</dd>
|
|
27509
|
+
</dl>
|
|
27510
|
+
</dd>
|
|
27511
|
+
</dl>
|
|
27512
|
+
|
|
27513
|
+
</dd>
|
|
27514
|
+
</dl>
|
|
27515
|
+
</details>
|
|
27516
|
+
|
|
27517
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.creds.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.ts">deleteV1</a>(providerOrgId) -> boolean</code></summary>
|
|
27518
|
+
<dl>
|
|
27519
|
+
<dd>
|
|
27520
|
+
|
|
27521
|
+
#### 📝 Description
|
|
27522
|
+
|
|
27523
|
+
<dl>
|
|
27524
|
+
<dd>
|
|
27525
|
+
|
|
27526
|
+
<dl>
|
|
27527
|
+
<dd>
|
|
27528
|
+
|
|
27529
|
+
Deletes the caller's Xcelerator credentials for one provider, stopping future syncs. | authz: min_org_role=administrator | () -> (bool)
|
|
27530
|
+
|
|
27531
|
+
</dd>
|
|
27532
|
+
</dl>
|
|
27533
|
+
</dd>
|
|
27534
|
+
</dl>
|
|
27535
|
+
|
|
27536
|
+
#### 🔌 Usage
|
|
27537
|
+
|
|
27538
|
+
<dl>
|
|
27539
|
+
<dd>
|
|
27540
|
+
|
|
27541
|
+
<dl>
|
|
27542
|
+
<dd>
|
|
27543
|
+
|
|
27544
|
+
```typescript
|
|
27545
|
+
await client.shippingIntegrations.xcelerator.creds.deleteV1("provider_org_id");
|
|
27546
|
+
```
|
|
27547
|
+
|
|
27548
|
+
</dd>
|
|
27549
|
+
</dl>
|
|
27550
|
+
</dd>
|
|
27551
|
+
</dl>
|
|
27552
|
+
|
|
27553
|
+
#### ⚙️ Parameters
|
|
27554
|
+
|
|
27555
|
+
<dl>
|
|
27556
|
+
<dd>
|
|
27557
|
+
|
|
27558
|
+
<dl>
|
|
27559
|
+
<dd>
|
|
27560
|
+
|
|
27561
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
27562
|
+
|
|
27563
|
+
</dd>
|
|
27564
|
+
</dl>
|
|
27565
|
+
|
|
27566
|
+
<dl>
|
|
27567
|
+
<dd>
|
|
27568
|
+
|
|
27569
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
27570
|
+
|
|
27571
|
+
</dd>
|
|
27572
|
+
</dl>
|
|
27573
|
+
</dd>
|
|
27574
|
+
</dl>
|
|
27575
|
+
|
|
27576
|
+
</dd>
|
|
27577
|
+
</dl>
|
|
27578
|
+
</details>
|
|
27579
|
+
|
|
27580
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.creds.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.ts">updateV1</a>(providerOrgId, { ...params }) -> boolean</code></summary>
|
|
27581
|
+
<dl>
|
|
27582
|
+
<dd>
|
|
27583
|
+
|
|
27584
|
+
#### 📝 Description
|
|
27585
|
+
|
|
27586
|
+
<dl>
|
|
27587
|
+
<dd>
|
|
27588
|
+
|
|
27589
|
+
<dl>
|
|
27590
|
+
<dd>
|
|
27591
|
+
|
|
27592
|
+
Updates the caller's Xcelerator credentials for one provider. | authz: min_org_role=administrator | (XceleratorCredsClientUpdate1) -> (bool)
|
|
27593
|
+
|
|
27594
|
+
</dd>
|
|
27595
|
+
</dl>
|
|
27596
|
+
</dd>
|
|
27597
|
+
</dl>
|
|
27598
|
+
|
|
27599
|
+
#### 🔌 Usage
|
|
27600
|
+
|
|
27601
|
+
<dl>
|
|
27602
|
+
<dd>
|
|
27603
|
+
|
|
27604
|
+
<dl>
|
|
27605
|
+
<dd>
|
|
27606
|
+
|
|
27607
|
+
```typescript
|
|
27608
|
+
await client.shippingIntegrations.xcelerator.creds.updateV1("provider_org_id");
|
|
27609
|
+
```
|
|
27610
|
+
|
|
27611
|
+
</dd>
|
|
27612
|
+
</dl>
|
|
27613
|
+
</dd>
|
|
27614
|
+
</dl>
|
|
27615
|
+
|
|
27616
|
+
#### ⚙️ Parameters
|
|
27617
|
+
|
|
27618
|
+
<dl>
|
|
27619
|
+
<dd>
|
|
27620
|
+
|
|
27621
|
+
<dl>
|
|
27622
|
+
<dd>
|
|
27623
|
+
|
|
27624
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
27625
|
+
|
|
27626
|
+
</dd>
|
|
27627
|
+
</dl>
|
|
27628
|
+
|
|
27629
|
+
<dl>
|
|
27630
|
+
<dd>
|
|
27631
|
+
|
|
27632
|
+
**request:** `Chrt.shippingIntegrations.xcelerator.XceleratorCredsClientUpdate1`
|
|
27633
|
+
|
|
27634
|
+
</dd>
|
|
27635
|
+
</dl>
|
|
27636
|
+
|
|
27637
|
+
<dl>
|
|
27638
|
+
<dd>
|
|
27639
|
+
|
|
27640
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
27641
|
+
|
|
27642
|
+
</dd>
|
|
27643
|
+
</dl>
|
|
27644
|
+
</dd>
|
|
27645
|
+
</dl>
|
|
27646
|
+
|
|
27647
|
+
</dd>
|
|
27648
|
+
</dl>
|
|
27649
|
+
</details>
|
|
27650
|
+
|
|
27651
|
+
## ShippingIntegrations Xcelerator Orders
|
|
27652
|
+
|
|
27653
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.orders.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(providerOrgId, integrationOrderId) -> Chrt.XceleratorOrderExpanded1</code></summary>
|
|
27654
|
+
<dl>
|
|
27655
|
+
<dd>
|
|
27656
|
+
|
|
27657
|
+
#### 📝 Description
|
|
27658
|
+
|
|
27659
|
+
<dl>
|
|
27660
|
+
<dd>
|
|
27661
|
+
|
|
27662
|
+
<dl>
|
|
27663
|
+
<dd>
|
|
27664
|
+
|
|
27665
|
+
Returns one mirrored Xcelerator order by the provider's own order ID with the provider organization expanded. | () -> (XceleratorOrderExpanded1)
|
|
27666
|
+
|
|
27667
|
+
</dd>
|
|
27668
|
+
</dl>
|
|
27669
|
+
</dd>
|
|
27670
|
+
</dl>
|
|
27671
|
+
|
|
27672
|
+
#### 🔌 Usage
|
|
27673
|
+
|
|
27674
|
+
<dl>
|
|
27675
|
+
<dd>
|
|
27676
|
+
|
|
27677
|
+
<dl>
|
|
27678
|
+
<dd>
|
|
27679
|
+
|
|
27680
|
+
```typescript
|
|
27681
|
+
await client.shippingIntegrations.xcelerator.orders.detailByIntegrationOrderIdV1(
|
|
27682
|
+
"provider_org_id",
|
|
27683
|
+
"integration_order_id",
|
|
27684
|
+
);
|
|
27685
|
+
```
|
|
27686
|
+
|
|
27687
|
+
</dd>
|
|
27688
|
+
</dl>
|
|
27689
|
+
</dd>
|
|
27690
|
+
</dl>
|
|
27691
|
+
|
|
27692
|
+
#### ⚙️ Parameters
|
|
27693
|
+
|
|
27694
|
+
<dl>
|
|
27695
|
+
<dd>
|
|
27696
|
+
|
|
27697
|
+
<dl>
|
|
27698
|
+
<dd>
|
|
27699
|
+
|
|
27700
|
+
**providerOrgId:** `string` — CHRT org ID of the courier whose Xcelerator instance holds the order
|
|
27701
|
+
|
|
27702
|
+
</dd>
|
|
27703
|
+
</dl>
|
|
27704
|
+
|
|
27705
|
+
<dl>
|
|
27706
|
+
<dd>
|
|
27707
|
+
|
|
27708
|
+
**integrationOrderId:** `string` — Xcelerator's own ID for the order (its OrderTrackingId), as carried on a unified order row
|
|
27709
|
+
|
|
27710
|
+
</dd>
|
|
27711
|
+
</dl>
|
|
27712
|
+
|
|
27713
|
+
<dl>
|
|
27714
|
+
<dd>
|
|
27715
|
+
|
|
27716
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
27717
|
+
|
|
27718
|
+
</dd>
|
|
27719
|
+
</dl>
|
|
27720
|
+
</dd>
|
|
27721
|
+
</dl>
|
|
27722
|
+
|
|
27723
|
+
</dd>
|
|
27724
|
+
</dl>
|
|
27725
|
+
</details>
|
|
27726
|
+
|
|
27727
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.orders.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.ts">detailV1</a>(id) -> Chrt.XceleratorOrderExpanded1</code></summary>
|
|
27728
|
+
<dl>
|
|
27729
|
+
<dd>
|
|
27730
|
+
|
|
27731
|
+
#### 📝 Description
|
|
27732
|
+
|
|
27733
|
+
<dl>
|
|
27734
|
+
<dd>
|
|
27735
|
+
|
|
27736
|
+
<dl>
|
|
27737
|
+
<dd>
|
|
27738
|
+
|
|
27739
|
+
Returns one mirrored Xcelerator order by its Mongo ObjectId with the provider organization expanded. | () -> (XceleratorOrderExpanded1)
|
|
27740
|
+
|
|
27741
|
+
</dd>
|
|
27742
|
+
</dl>
|
|
27743
|
+
</dd>
|
|
27744
|
+
</dl>
|
|
27745
|
+
|
|
27746
|
+
#### 🔌 Usage
|
|
27747
|
+
|
|
27748
|
+
<dl>
|
|
27749
|
+
<dd>
|
|
27750
|
+
|
|
27751
|
+
<dl>
|
|
27752
|
+
<dd>
|
|
27753
|
+
|
|
27754
|
+
```typescript
|
|
27755
|
+
await client.shippingIntegrations.xcelerator.orders.detailV1("id");
|
|
27756
|
+
```
|
|
27757
|
+
|
|
27758
|
+
</dd>
|
|
27759
|
+
</dl>
|
|
27760
|
+
</dd>
|
|
27761
|
+
</dl>
|
|
27762
|
+
|
|
27763
|
+
#### ⚙️ Parameters
|
|
27764
|
+
|
|
27765
|
+
<dl>
|
|
27766
|
+
<dd>
|
|
27767
|
+
|
|
27768
|
+
<dl>
|
|
27769
|
+
<dd>
|
|
27770
|
+
|
|
27771
|
+
**id:** `string` — Mongo ObjectId of the mirror document. Xcelerator's own order ID is the integration_order_id, accepted by the by_integration_order_id route.
|
|
27772
|
+
|
|
27773
|
+
</dd>
|
|
27774
|
+
</dl>
|
|
27775
|
+
|
|
27776
|
+
<dl>
|
|
27777
|
+
<dd>
|
|
27778
|
+
|
|
27779
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
27780
|
+
|
|
27781
|
+
</dd>
|
|
27782
|
+
</dl>
|
|
27783
|
+
</dd>
|
|
27784
|
+
</dl>
|
|
27785
|
+
|
|
27786
|
+
</dd>
|
|
27787
|
+
</dl>
|
|
27788
|
+
</details>
|
|
27789
|
+
|
|
27790
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.orders.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.ts">listV1</a>({ ...params }) -> Chrt.XceleratorOrderListRes</code></summary>
|
|
27791
|
+
<dl>
|
|
27792
|
+
<dd>
|
|
27793
|
+
|
|
27794
|
+
#### 📝 Description
|
|
27795
|
+
|
|
27796
|
+
<dl>
|
|
27797
|
+
<dd>
|
|
27798
|
+
|
|
27799
|
+
<dl>
|
|
27800
|
+
<dd>
|
|
27801
|
+
|
|
27802
|
+
Lists mirrored Xcelerator orders with provider organizations expanded, filtering, sorting, pagination, and optional search. | () -> (XceleratorOrderListRes)
|
|
27803
|
+
|
|
27804
|
+
</dd>
|
|
27805
|
+
</dl>
|
|
27806
|
+
</dd>
|
|
27807
|
+
</dl>
|
|
27808
|
+
|
|
27809
|
+
#### 🔌 Usage
|
|
27810
|
+
|
|
27811
|
+
<dl>
|
|
27812
|
+
<dd>
|
|
27813
|
+
|
|
27814
|
+
<dl>
|
|
27815
|
+
<dd>
|
|
27816
|
+
|
|
27817
|
+
```typescript
|
|
27818
|
+
await client.shippingIntegrations.xcelerator.orders.listV1({
|
|
27819
|
+
sort_by: "mirrored_at_timestamp",
|
|
27820
|
+
sort_order: "asc",
|
|
27821
|
+
page: 1,
|
|
27822
|
+
page_size: 1,
|
|
27823
|
+
search: "search",
|
|
27824
|
+
filter_provider_org_id: ["filter_provider_org_id"],
|
|
27825
|
+
filter_integration_order_id: "filter_integration_order_id",
|
|
27826
|
+
filter_provider_status_raw: "filter_provider_status_raw",
|
|
27827
|
+
filter_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
27828
|
+
filter_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
27829
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
27830
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
27831
|
+
filter_updated_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
27832
|
+
filter_updated_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
27833
|
+
});
|
|
27834
|
+
```
|
|
27835
|
+
|
|
27836
|
+
</dd>
|
|
27837
|
+
</dl>
|
|
27838
|
+
</dd>
|
|
27839
|
+
</dl>
|
|
27840
|
+
|
|
27841
|
+
#### ⚙️ Parameters
|
|
27842
|
+
|
|
27843
|
+
<dl>
|
|
27844
|
+
<dd>
|
|
27845
|
+
|
|
27846
|
+
<dl>
|
|
27847
|
+
<dd>
|
|
27848
|
+
|
|
27849
|
+
**request:** `Chrt.shippingIntegrations.xcelerator.OrdersListV1Request`
|
|
27850
|
+
|
|
27851
|
+
</dd>
|
|
27852
|
+
</dl>
|
|
27853
|
+
|
|
27854
|
+
<dl>
|
|
27855
|
+
<dd>
|
|
27856
|
+
|
|
27857
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
27858
|
+
|
|
27859
|
+
</dd>
|
|
27860
|
+
</dl>
|
|
27861
|
+
</dd>
|
|
27862
|
+
</dl>
|
|
27863
|
+
|
|
27864
|
+
</dd>
|
|
27865
|
+
</dl>
|
|
27866
|
+
</details>
|
|
27867
|
+
|
|
27868
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.orders.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.ts">syncOneV1</a>({ ...params }) -> Chrt.XceleratorOrder1</code></summary>
|
|
27869
|
+
<dl>
|
|
27870
|
+
<dd>
|
|
27871
|
+
|
|
27872
|
+
#### 📝 Description
|
|
27873
|
+
|
|
27874
|
+
<dl>
|
|
27875
|
+
<dd>
|
|
27876
|
+
|
|
27877
|
+
<dl>
|
|
27878
|
+
<dd>
|
|
27879
|
+
|
|
27880
|
+
Fetches and mirrors one Xcelerator order by the provider's own order ID. | authz: min_org_role=operator | (XceleratorOrderSyncOneReq) -> (XceleratorOrder1)
|
|
27881
|
+
|
|
27882
|
+
</dd>
|
|
27883
|
+
</dl>
|
|
27884
|
+
</dd>
|
|
27885
|
+
</dl>
|
|
27886
|
+
|
|
27887
|
+
#### 🔌 Usage
|
|
27888
|
+
|
|
27889
|
+
<dl>
|
|
27890
|
+
<dd>
|
|
27891
|
+
|
|
27892
|
+
<dl>
|
|
27893
|
+
<dd>
|
|
27894
|
+
|
|
27895
|
+
```typescript
|
|
27896
|
+
await client.shippingIntegrations.xcelerator.orders.syncOneV1({
|
|
27897
|
+
integration_order_id: "integration_order_id",
|
|
27898
|
+
provider_org_id: "provider_org_id",
|
|
27899
|
+
});
|
|
27900
|
+
```
|
|
27901
|
+
|
|
27902
|
+
</dd>
|
|
27903
|
+
</dl>
|
|
27904
|
+
</dd>
|
|
27905
|
+
</dl>
|
|
27906
|
+
|
|
27907
|
+
#### ⚙️ Parameters
|
|
27908
|
+
|
|
27909
|
+
<dl>
|
|
27910
|
+
<dd>
|
|
27911
|
+
|
|
27912
|
+
<dl>
|
|
27913
|
+
<dd>
|
|
27914
|
+
|
|
27915
|
+
**request:** `Chrt.shippingIntegrations.xcelerator.XceleratorOrderSyncOneReq`
|
|
27916
|
+
|
|
27917
|
+
</dd>
|
|
27918
|
+
</dl>
|
|
27919
|
+
|
|
27920
|
+
<dl>
|
|
27921
|
+
<dd>
|
|
27922
|
+
|
|
27923
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
27924
|
+
|
|
27925
|
+
</dd>
|
|
27926
|
+
</dl>
|
|
27927
|
+
</dd>
|
|
27928
|
+
</dl>
|
|
27929
|
+
|
|
27930
|
+
</dd>
|
|
27931
|
+
</dl>
|
|
27932
|
+
</details>
|
|
27933
|
+
|
|
27934
|
+
<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>
|
|
27935
|
+
<dl>
|
|
27936
|
+
<dd>
|
|
27937
|
+
|
|
27938
|
+
#### 📝 Description
|
|
27939
|
+
|
|
27940
|
+
<dl>
|
|
27941
|
+
<dd>
|
|
27942
|
+
|
|
27943
|
+
<dl>
|
|
27944
|
+
<dd>
|
|
27945
|
+
|
|
27946
|
+
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])
|
|
27947
|
+
|
|
27948
|
+
</dd>
|
|
27949
|
+
</dl>
|
|
27950
|
+
</dd>
|
|
27951
|
+
</dl>
|
|
27952
|
+
|
|
27953
|
+
#### 🔌 Usage
|
|
27954
|
+
|
|
27955
|
+
<dl>
|
|
27956
|
+
<dd>
|
|
27957
|
+
|
|
27958
|
+
<dl>
|
|
27959
|
+
<dd>
|
|
27960
|
+
|
|
27961
|
+
```typescript
|
|
27962
|
+
await client.shippingIntegrations.xcelerator.orders.typeaheadV1({
|
|
27963
|
+
query: "query",
|
|
27964
|
+
limit: 1,
|
|
27965
|
+
});
|
|
27966
|
+
```
|
|
27967
|
+
|
|
27968
|
+
</dd>
|
|
27969
|
+
</dl>
|
|
27970
|
+
</dd>
|
|
27971
|
+
</dl>
|
|
27972
|
+
|
|
27973
|
+
#### ⚙️ Parameters
|
|
27974
|
+
|
|
27975
|
+
<dl>
|
|
27976
|
+
<dd>
|
|
27977
|
+
|
|
27978
|
+
<dl>
|
|
27979
|
+
<dd>
|
|
27980
|
+
|
|
27981
|
+
**request:** `Chrt.shippingIntegrations.xcelerator.OrdersTypeaheadV1Request`
|
|
27982
|
+
|
|
27983
|
+
</dd>
|
|
27984
|
+
</dl>
|
|
27985
|
+
|
|
27986
|
+
<dl>
|
|
27987
|
+
<dd>
|
|
27988
|
+
|
|
27989
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
27990
|
+
|
|
27991
|
+
</dd>
|
|
27992
|
+
</dl>
|
|
27993
|
+
</dd>
|
|
27994
|
+
</dl>
|
|
27995
|
+
|
|
27996
|
+
</dd>
|
|
27997
|
+
</dl>
|
|
27998
|
+
</details>
|
|
27999
|
+
|
|
24108
28000
|
## Tracking Devices
|
|
24109
28001
|
|
|
24110
28002
|
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">archiveV1</a>({ ...params }) -> boolean</code></summary>
|