@chrt-inc/typescript-sdk 1.530.1 → 1.539.1
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/README.md +1 -1
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/billing/index.d.ts +1 -1
- package/dist/cjs/api/resources/billing/index.js +1 -1
- package/dist/cjs/api/resources/billing/resources/index.d.ts +1 -2
- package/dist/cjs/api/resources/billing/resources/index.js +2 -3
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.js +5 -1
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/requests/LineItemGroupsListForCourierOrgV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/billing/resources/rateSheets/client/Client.d.ts +3 -2
- package/dist/cjs/api/resources/billing/resources/rateSheets/client/Client.js +7 -3
- package/dist/cjs/api/resources/billing/resources/rateSheets/client/requests/RateSheetsListByOrgV1Request.d.ts +6 -2
- package/dist/cjs/api/resources/billing/resources/rateSheets/index.d.ts +0 -1
- package/dist/cjs/api/resources/billing/resources/rateSheets/index.js +0 -1
- package/dist/cjs/api/resources/billing/resources/statements/client/Client.d.ts +8 -2
- package/dist/cjs/api/resources/billing/resources/statements/client/Client.js +28 -4
- package/dist/cjs/api/resources/billing/resources/statements/client/requests/StatementsExpandedListV1Request.d.ts +10 -1
- package/dist/cjs/api/resources/billing/resources/statements/client/requests/StatementsListV1Request.d.ts +10 -1
- package/dist/cjs/api/resources/index.d.ts +2 -2
- package/dist/cjs/api/resources/index.js +3 -3
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/Client.d.ts +7 -3
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/Client.js +23 -11
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/requests/AdHocListByOrderIdV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/notifications/resources/groups/client/Client.d.ts +18 -6
- package/dist/cjs/api/resources/notifications/resources/groups/client/Client.js +71 -36
- package/dist/cjs/api/resources/notifications/resources/groups/client/requests/GroupsListByOrgV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/notifications/resources/groups/client/requests/GroupsListByUserV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/notifications/resources/groups/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/orgs/client/Client.d.ts +11 -3
- package/dist/cjs/api/resources/orgs/client/Client.js +51 -16
- package/dist/cjs/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.ts +23 -0
- package/dist/cjs/api/resources/orgs/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/Client.d.ts +27 -9
- package/dist/cjs/api/resources/orgs/resources/connections/client/Client.js +105 -48
- package/dist/cjs/api/resources/orgs/resources/connections/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/index.js +15 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ConnectionsListCouriersV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ConnectionsListCouriersV1Request.js +5 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ConnectionsListForwardersV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ConnectionsListForwardersV1Request.js +5 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ConnectionsListShippersV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ConnectionsListShippersV1Request.js +5 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/orgs/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/index.js +1 -0
- package/dist/cjs/api/resources/orgs/resources/offChrtShipperOrg/client/Client.d.ts +9 -3
- package/dist/cjs/api/resources/orgs/resources/offChrtShipperOrg/client/Client.js +35 -16
- package/dist/cjs/api/resources/orgs/resources/offChrtShipperOrg/client/requests/OffChrtShipperOrgListV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/orgs/resources/offChrtShipperOrg/client/requests/OffChrtShipperOrgListV1Request.js +5 -0
- package/dist/cjs/api/resources/orgs/resources/offChrtShipperOrg/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/index.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/index.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.d.ts +14 -8
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.js +58 -24
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.ts +11 -4
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversListV1Request.d.ts +17 -6
- package/dist/cjs/api/resources/shipping/resources/index.d.ts +3 -3
- package/dist/cjs/api/resources/shipping/resources/index.js +4 -4
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrdersDraftUpdateReq.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/index.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/index.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/requests/ExpandedListV1Request.d.ts +3 -2
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/index.js +0 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/index.d.ts +1 -2
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/index.js +2 -3
- package/dist/cjs/api/resources/shipping/resources/orders/index.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orders/index.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.ts +22 -4
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js +82 -6
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForForwarderOperatorsV1Request.d.ts +6 -2
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.ts +6 -2
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedTypeaheadV1Request.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/index.js +0 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/index.js +0 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/index.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/index.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.ts +22 -4
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.js +82 -6
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierDriverV1Request.d.ts +6 -2
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierOperatorsV1Request.d.ts +6 -2
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedTypeaheadV1Request.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/index.js +0 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/index.d.ts +1 -2
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/index.js +2 -3
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.d.ts +5 -20
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js +15 -79
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesListV1Request.d.ts +10 -1
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.d.ts +4 -21
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.js +8 -80
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.d.ts +4 -1
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.js +2 -2
- package/dist/cjs/api/resources/users/resources/directoryEntries/client/Client.d.ts +12 -3
- package/dist/cjs/api/resources/users/resources/directoryEntries/client/Client.js +47 -16
- package/dist/cjs/api/resources/users/resources/directoryEntries/client/requests/DirectoryEntriesListV1Request.d.ts +24 -0
- package/dist/cjs/api/resources/users/resources/directoryEntries/client/requests/DirectoryEntriesListV1Request.js +5 -0
- package/dist/cjs/api/resources/users/resources/directoryEntries/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/types/CourierConnectionListRes.d.ts +8 -0
- package/dist/cjs/api/types/CourierConnectionListRes.js +5 -0
- package/dist/cjs/api/types/DeviceLimitedForList1.d.ts +1 -0
- package/dist/cjs/api/types/DeviceListRes.d.ts +1 -1
- package/dist/cjs/api/types/DevicePausedTimeWindow1.d.ts +7 -0
- package/dist/cjs/api/types/DevicePausedTimeWindow1.js +5 -0
- package/dist/cjs/api/types/{DeviceSearchRes.d.ts → DirectoryEntryListRes.d.ts} +2 -2
- package/dist/cjs/api/types/DirectoryEntryListRes.js +5 -0
- package/dist/cjs/api/types/DirectoryEntrySortByEnum.d.ts +9 -0
- package/dist/cjs/api/types/DirectoryEntrySortByEnum.js +11 -0
- package/dist/cjs/api/types/{SessionSearchRes.d.ts → DriverListRes.d.ts} +2 -2
- package/dist/cjs/api/types/DriverListRes.js +5 -0
- package/dist/cjs/api/types/ForwarderConnectionListRes.d.ts +8 -0
- package/dist/cjs/api/types/ForwarderConnectionListRes.js +5 -0
- package/dist/cjs/api/types/LineItemGroupListRes.d.ts +1 -1
- package/dist/cjs/api/types/NotificationAdHocListRes.d.ts +8 -0
- package/dist/cjs/api/types/NotificationAdHocListRes.js +5 -0
- package/dist/cjs/api/types/NotificationGroupListRes.d.ts +8 -0
- package/dist/cjs/api/types/NotificationGroupListRes.js +5 -0
- package/dist/cjs/api/types/NotificationGroupUserListRes.d.ts +8 -0
- package/dist/cjs/api/types/NotificationGroupUserListRes.js +5 -0
- package/dist/cjs/api/types/OffChrtShipperOrgListRes.d.ts +8 -0
- package/dist/cjs/api/types/OffChrtShipperOrgListRes.js +5 -0
- package/dist/cjs/api/types/OrderDraftExpandedListRes.d.ts +1 -1
- package/dist/cjs/api/types/OrdersExpandedListRes.d.ts +1 -1
- package/dist/cjs/api/types/OrgMemberListRes.d.ts +8 -0
- package/dist/cjs/api/types/OrgMemberListRes.js +5 -0
- package/dist/cjs/api/types/OrgMemberSortByEnum.d.ts +8 -0
- package/dist/cjs/api/types/OrgMemberSortByEnum.js +10 -0
- package/dist/cjs/api/types/OrgMembersAndDriversListRes.d.ts +8 -0
- package/dist/cjs/api/types/OrgMembersAndDriversListRes.js +5 -0
- package/dist/cjs/api/types/RateSheetListResponse.d.ts +1 -1
- package/dist/cjs/api/types/SessionListRes.d.ts +1 -1
- package/dist/cjs/api/types/ShipperConnectionListRes.d.ts +8 -0
- package/dist/cjs/api/types/ShipperConnectionListRes.js +5 -0
- package/dist/cjs/api/types/StatementsExpandedListRes.d.ts +1 -1
- package/dist/cjs/api/types/StatementsListRes.d.ts +1 -1
- package/dist/cjs/api/types/TaskGroupExpandedListRes.d.ts +1 -1
- package/dist/cjs/api/types/index.d.ts +14 -2
- package/dist/cjs/api/types/index.js +14 -2
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/billing/index.d.mts +1 -1
- package/dist/esm/api/resources/billing/index.mjs +1 -1
- package/dist/esm/api/resources/billing/resources/index.d.mts +1 -2
- package/dist/esm/api/resources/billing/resources/index.mjs +1 -2
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.mjs +5 -1
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/requests/LineItemGroupsListForCourierOrgV1Request.d.mts +3 -0
- package/dist/esm/api/resources/billing/resources/rateSheets/client/Client.d.mts +3 -2
- package/dist/esm/api/resources/billing/resources/rateSheets/client/Client.mjs +7 -3
- package/dist/esm/api/resources/billing/resources/rateSheets/client/requests/RateSheetsListByOrgV1Request.d.mts +6 -2
- package/dist/esm/api/resources/billing/resources/rateSheets/index.d.mts +0 -1
- package/dist/esm/api/resources/billing/resources/rateSheets/index.mjs +0 -1
- package/dist/esm/api/resources/billing/resources/statements/client/Client.d.mts +8 -2
- package/dist/esm/api/resources/billing/resources/statements/client/Client.mjs +28 -4
- package/dist/esm/api/resources/billing/resources/statements/client/requests/StatementsExpandedListV1Request.d.mts +10 -1
- package/dist/esm/api/resources/billing/resources/statements/client/requests/StatementsListV1Request.d.mts +10 -1
- package/dist/esm/api/resources/index.d.mts +2 -2
- package/dist/esm/api/resources/index.mjs +2 -2
- package/dist/esm/api/resources/notifications/resources/adHoc/client/Client.d.mts +7 -3
- package/dist/esm/api/resources/notifications/resources/adHoc/client/Client.mjs +23 -11
- package/dist/esm/api/resources/notifications/resources/adHoc/client/requests/AdHocListByOrderIdV1Request.d.mts +14 -0
- package/dist/esm/api/resources/notifications/resources/adHoc/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/notifications/resources/groups/client/Client.d.mts +18 -6
- package/dist/esm/api/resources/notifications/resources/groups/client/Client.mjs +71 -36
- package/dist/esm/api/resources/notifications/resources/groups/client/requests/GroupsListByOrgV1Request.d.mts +14 -0
- package/dist/esm/api/resources/notifications/resources/groups/client/requests/GroupsListByUserV1Request.d.mts +14 -0
- package/dist/esm/api/resources/notifications/resources/groups/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/orgs/client/Client.d.mts +11 -3
- package/dist/esm/api/resources/orgs/client/Client.mjs +51 -16
- package/dist/esm/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.mts +23 -0
- package/dist/esm/api/resources/orgs/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/Client.d.mts +27 -9
- package/dist/esm/api/resources/orgs/resources/connections/client/Client.mjs +105 -48
- package/dist/esm/api/resources/orgs/resources/connections/client/index.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/index.mjs +1 -1
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListCouriersV1Request.d.mts +14 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListCouriersV1Request.mjs +4 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListForwardersV1Request.d.mts +14 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListForwardersV1Request.mjs +4 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListShippersV1Request.d.mts +14 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListShippersV1Request.mjs +4 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/orgs/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/index.mjs +1 -0
- package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/Client.d.mts +9 -3
- package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/Client.mjs +35 -16
- package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/requests/OffChrtShipperOrgListV1Request.d.mts +14 -0
- package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/requests/OffChrtShipperOrgListV1Request.mjs +4 -0
- package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/index.d.mts +1 -1
- package/dist/esm/api/resources/shipping/index.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts +14 -8
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs +58 -24
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.mts +11 -4
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversListV1Request.d.mts +17 -6
- package/dist/esm/api/resources/shipping/resources/index.d.mts +3 -3
- package/dist/esm/api/resources/shipping/resources/index.mjs +3 -3
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersDraftUpdateReq.d.mts +3 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/index.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/index.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/requests/ExpandedListV1Request.d.mts +3 -2
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/index.mjs +0 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/index.d.mts +1 -2
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/index.mjs +1 -2
- package/dist/esm/api/resources/shipping/resources/orders/index.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orders/index.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts +22 -4
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs +82 -6
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForForwarderOperatorsV1Request.d.mts +6 -2
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.mts +6 -2
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedTypeaheadV1Request.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/index.mjs +0 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/index.mjs +0 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/index.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/index.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.mts +22 -4
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.mjs +82 -6
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierDriverV1Request.d.mts +6 -2
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierOperatorsV1Request.d.mts +6 -2
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedTypeaheadV1Request.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/index.mjs +0 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/index.d.mts +1 -2
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/index.mjs +1 -2
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.d.mts +5 -20
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs +15 -79
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesListV1Request.d.mts +10 -1
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.d.mts +4 -21
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.mjs +8 -80
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.d.mts +4 -1
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.mjs +2 -2
- package/dist/esm/api/resources/users/resources/directoryEntries/client/Client.d.mts +12 -3
- package/dist/esm/api/resources/users/resources/directoryEntries/client/Client.mjs +47 -16
- package/dist/esm/api/resources/users/resources/directoryEntries/client/requests/DirectoryEntriesListV1Request.d.mts +24 -0
- package/dist/esm/api/resources/users/resources/directoryEntries/client/requests/DirectoryEntriesListV1Request.mjs +4 -0
- package/dist/esm/api/resources/users/resources/directoryEntries/client/requests/index.d.mts +1 -0
- package/dist/esm/api/types/CourierConnectionListRes.d.mts +8 -0
- package/dist/esm/api/types/CourierConnectionListRes.mjs +4 -0
- package/dist/esm/api/types/DeviceLimitedForList1.d.mts +1 -0
- package/dist/esm/api/types/DeviceListRes.d.mts +1 -1
- package/dist/esm/api/types/DevicePausedTimeWindow1.d.mts +7 -0
- package/dist/esm/api/types/DevicePausedTimeWindow1.mjs +4 -0
- package/dist/esm/api/types/{DeviceSearchRes.d.mts → DirectoryEntryListRes.d.mts} +2 -2
- package/dist/esm/api/types/DirectoryEntryListRes.mjs +4 -0
- package/dist/esm/api/types/DirectoryEntrySortByEnum.d.mts +9 -0
- package/dist/esm/api/types/DirectoryEntrySortByEnum.mjs +8 -0
- package/dist/esm/api/types/{SessionSearchRes.d.mts → DriverListRes.d.mts} +2 -2
- package/dist/esm/api/types/DriverListRes.mjs +4 -0
- package/dist/esm/api/types/ForwarderConnectionListRes.d.mts +8 -0
- package/dist/esm/api/types/ForwarderConnectionListRes.mjs +4 -0
- package/dist/esm/api/types/LineItemGroupListRes.d.mts +1 -1
- package/dist/esm/api/types/NotificationAdHocListRes.d.mts +8 -0
- package/dist/esm/api/types/NotificationAdHocListRes.mjs +4 -0
- package/dist/esm/api/types/NotificationGroupListRes.d.mts +8 -0
- package/dist/esm/api/types/NotificationGroupListRes.mjs +4 -0
- package/dist/esm/api/types/NotificationGroupUserListRes.d.mts +8 -0
- package/dist/esm/api/types/NotificationGroupUserListRes.mjs +4 -0
- package/dist/esm/api/types/OffChrtShipperOrgListRes.d.mts +8 -0
- package/dist/esm/api/types/OffChrtShipperOrgListRes.mjs +4 -0
- package/dist/esm/api/types/OrderDraftExpandedListRes.d.mts +1 -1
- package/dist/esm/api/types/OrdersExpandedListRes.d.mts +1 -1
- package/dist/esm/api/types/OrgMemberListRes.d.mts +8 -0
- package/dist/esm/api/types/OrgMemberListRes.mjs +4 -0
- package/dist/esm/api/types/OrgMemberSortByEnum.d.mts +8 -0
- package/dist/esm/api/types/OrgMemberSortByEnum.mjs +7 -0
- package/dist/esm/api/types/OrgMembersAndDriversListRes.d.mts +8 -0
- package/dist/esm/api/types/OrgMembersAndDriversListRes.mjs +4 -0
- package/dist/esm/api/types/RateSheetListResponse.d.mts +1 -1
- package/dist/esm/api/types/SessionListRes.d.mts +1 -1
- package/dist/esm/api/types/ShipperConnectionListRes.d.mts +8 -0
- package/dist/esm/api/types/ShipperConnectionListRes.mjs +4 -0
- package/dist/esm/api/types/StatementsExpandedListRes.d.mts +1 -1
- package/dist/esm/api/types/StatementsListRes.d.mts +1 -1
- package/dist/esm/api/types/TaskGroupExpandedListRes.d.mts +1 -1
- package/dist/esm/api/types/index.d.mts +14 -2
- package/dist/esm/api/types/index.mjs +14 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +307 -185
- package/dist/cjs/api/resources/billing/resources/rateSheets/types/RateSheetsListByOrgV1RequestSortOrder.d.ts +0 -8
- package/dist/cjs/api/resources/billing/resources/rateSheets/types/RateSheetsListByOrgV1RequestSortOrder.js +0 -10
- package/dist/cjs/api/resources/billing/resources/rateSheets/types/index.d.ts +0 -1
- package/dist/cjs/api/resources/billing/resources/rateSheets/types/index.js +0 -17
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/types/ExpandedListV1RequestSortOrder.d.ts +0 -8
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/types/ExpandedListV1RequestSortOrder.js +0 -10
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/types/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/types/index.js +0 -17
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/types/ExpandedListForForwarderOperatorsV1RequestSortOrder.d.ts +0 -8
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/types/ExpandedListForForwarderOperatorsV1RequestSortOrder.js +0 -10
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/types/ExpandedListForShipperOperatorsV1RequestSortOrder.d.ts +0 -8
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/types/ExpandedListForShipperOperatorsV1RequestSortOrder.js +0 -10
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/types/index.d.ts +0 -2
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/types/index.js +0 -18
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/types/ExpandedListForCourierDriverV1RequestSortOrder.d.ts +0 -8
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/types/ExpandedListForCourierDriverV1RequestSortOrder.js +0 -10
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/types/ExpandedListForCourierOperatorsV1RequestSortOrder.d.ts +0 -8
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/types/ExpandedListForCourierOperatorsV1RequestSortOrder.js +0 -10
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/types/index.d.ts +0 -2
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/types/index.js +0 -18
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesSearchV1Request.d.ts +0 -21
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsSearchV1Request.d.ts +0 -21
- package/dist/esm/api/resources/billing/resources/rateSheets/types/RateSheetsListByOrgV1RequestSortOrder.d.mts +0 -8
- package/dist/esm/api/resources/billing/resources/rateSheets/types/RateSheetsListByOrgV1RequestSortOrder.mjs +0 -7
- package/dist/esm/api/resources/billing/resources/rateSheets/types/index.d.mts +0 -1
- package/dist/esm/api/resources/billing/resources/rateSheets/types/index.mjs +0 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/types/ExpandedListV1RequestSortOrder.d.mts +0 -8
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/types/ExpandedListV1RequestSortOrder.mjs +0 -7
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/types/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/types/index.mjs +0 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/types/ExpandedListForForwarderOperatorsV1RequestSortOrder.d.mts +0 -8
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/types/ExpandedListForForwarderOperatorsV1RequestSortOrder.mjs +0 -7
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/types/ExpandedListForShipperOperatorsV1RequestSortOrder.d.mts +0 -8
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/types/ExpandedListForShipperOperatorsV1RequestSortOrder.mjs +0 -7
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/types/index.d.mts +0 -2
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/types/index.mjs +0 -2
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/types/ExpandedListForCourierDriverV1RequestSortOrder.d.mts +0 -8
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/types/ExpandedListForCourierDriverV1RequestSortOrder.mjs +0 -7
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/types/ExpandedListForCourierOperatorsV1RequestSortOrder.d.mts +0 -8
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/types/ExpandedListForCourierOperatorsV1RequestSortOrder.mjs +0 -7
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/types/index.d.mts +0 -2
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/types/index.mjs +0 -2
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesSearchV1Request.d.mts +0 -21
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsSearchV1Request.d.mts +0 -21
- /package/dist/cjs/api/resources/{tracking/resources/devices/client/requests/DevicesSearchV1Request.js → notifications/resources/adHoc/client/requests/AdHocListByOrderIdV1Request.js} +0 -0
- /package/dist/cjs/api/resources/{tracking/resources/sessions/client/requests/SessionsSearchV1Request.js → notifications/resources/groups/client/requests/GroupsListByOrgV1Request.js} +0 -0
- /package/dist/cjs/api/{types/DeviceSearchRes.js → resources/notifications/resources/groups/client/requests/GroupsListByUserV1Request.js} +0 -0
- /package/dist/cjs/api/{types/SessionSearchRes.js → resources/orgs/client/requests/OrgsListMembersV1Request.js} +0 -0
- /package/dist/esm/api/resources/{tracking/resources/devices/client/requests/DevicesSearchV1Request.mjs → notifications/resources/adHoc/client/requests/AdHocListByOrderIdV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/{tracking/resources/sessions/client/requests/SessionsSearchV1Request.mjs → notifications/resources/groups/client/requests/GroupsListByOrgV1Request.mjs} +0 -0
- /package/dist/esm/api/{types/DeviceSearchRes.mjs → resources/notifications/resources/groups/client/requests/GroupsListByUserV1Request.mjs} +0 -0
- /package/dist/esm/api/{types/SessionSearchRes.mjs → resources/orgs/client/requests/OrgsListMembersV1Request.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -57,7 +57,7 @@ await client.orgs.getInfoV1();
|
|
|
57
57
|
</dl>
|
|
58
58
|
</details>
|
|
59
59
|
|
|
60
|
-
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">listMembersV1</a>() -> Chrt.
|
|
60
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">listMembersV1</a>({ ...params }) -> Chrt.OrgMemberListRes</code></summary>
|
|
61
61
|
<dl>
|
|
62
62
|
<dd>
|
|
63
63
|
|
|
@@ -69,7 +69,7 @@ await client.orgs.getInfoV1();
|
|
|
69
69
|
<dl>
|
|
70
70
|
<dd>
|
|
71
71
|
|
|
72
|
-
Lists all members of the caller's organization with their roles and details. | () -> (
|
|
72
|
+
Lists all members of the caller's organization with their roles and details. | () -> (OrgMemberListRes)
|
|
73
73
|
|
|
74
74
|
</dd>
|
|
75
75
|
</dl>
|
|
@@ -85,7 +85,12 @@ Lists all members of the caller's organization with their roles and details. | (
|
|
|
85
85
|
<dd>
|
|
86
86
|
|
|
87
87
|
```typescript
|
|
88
|
-
await client.orgs.listMembersV1(
|
|
88
|
+
await client.orgs.listMembersV1({
|
|
89
|
+
sort_by: "first_name",
|
|
90
|
+
sort_order: "asc",
|
|
91
|
+
page: 1,
|
|
92
|
+
page_size: 1,
|
|
93
|
+
});
|
|
89
94
|
```
|
|
90
95
|
|
|
91
96
|
</dd>
|
|
@@ -101,6 +106,14 @@ await client.orgs.listMembersV1();
|
|
|
101
106
|
<dl>
|
|
102
107
|
<dd>
|
|
103
108
|
|
|
109
|
+
**request:** `Chrt.OrgsListMembersV1Request`
|
|
110
|
+
|
|
111
|
+
</dd>
|
|
112
|
+
</dl>
|
|
113
|
+
|
|
114
|
+
<dl>
|
|
115
|
+
<dd>
|
|
116
|
+
|
|
104
117
|
**requestOptions:** `Orgs.RequestOptions`
|
|
105
118
|
|
|
106
119
|
</dd>
|
|
@@ -466,6 +479,7 @@ await client.billing.lineItemGroups.listForCourierOrgV1({
|
|
|
466
479
|
filter_attached_to_statement: true,
|
|
467
480
|
filter_order_id: "filter_order_id",
|
|
468
481
|
filter_payment_role: "origin",
|
|
482
|
+
sort_order: "asc",
|
|
469
483
|
page: 1,
|
|
470
484
|
page_size: 1,
|
|
471
485
|
});
|
|
@@ -998,7 +1012,7 @@ await client.billing.rateSheets.updateV1("rate_sheet_id");
|
|
|
998
1012
|
<dl>
|
|
999
1013
|
<dd>
|
|
1000
1014
|
|
|
1001
|
-
Lists rate sheets for the caller's organization with filtering, sorting, and
|
|
1015
|
+
Lists rate sheets for the caller's organization with filtering, sorting, pagination, and optional full-text search. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (RateSheetListResponse)
|
|
1002
1016
|
|
|
1003
1017
|
</dd>
|
|
1004
1018
|
</dl>
|
|
@@ -1016,9 +1030,10 @@ Lists rate sheets for the caller's organization with filtering, sorting, and pag
|
|
|
1016
1030
|
```typescript
|
|
1017
1031
|
await client.billing.rateSheets.listByOrgV1({
|
|
1018
1032
|
sort_by: "id",
|
|
1019
|
-
sort_order: "
|
|
1033
|
+
sort_order: "asc",
|
|
1020
1034
|
page: 1,
|
|
1021
1035
|
page_size: 1,
|
|
1036
|
+
search: "search",
|
|
1022
1037
|
filter_archived: true,
|
|
1023
1038
|
filter_payment_vector_type: "shipper_pay_forwarder",
|
|
1024
1039
|
filter_service_type: "on_demand",
|
|
@@ -1696,6 +1711,7 @@ await client.billing.statements.listV1({
|
|
|
1696
1711
|
filter_settlement_type: "stripe_connect",
|
|
1697
1712
|
filter_order_id: "filter_order_id",
|
|
1698
1713
|
filter_payment_origin_org_id: "filter_payment_origin_org_id",
|
|
1714
|
+
filter_payment_origin_off_chrt_shipper_org_id: "filter_payment_origin_off_chrt_shipper_org_id",
|
|
1699
1715
|
filter_payment_destination_org_id: "filter_payment_destination_org_id",
|
|
1700
1716
|
filter_owned_by_org_id: "filter_owned_by_org_id",
|
|
1701
1717
|
filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -1704,6 +1720,8 @@ await client.billing.statements.listV1({
|
|
|
1704
1720
|
filter_opened_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
1705
1721
|
filter_paid_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
1706
1722
|
filter_paid_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
1723
|
+
filter_uncollectible_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
1724
|
+
filter_uncollectible_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
1707
1725
|
});
|
|
1708
1726
|
```
|
|
1709
1727
|
|
|
@@ -1775,6 +1793,7 @@ await client.billing.statements.expandedListV1({
|
|
|
1775
1793
|
filter_settlement_type: "stripe_connect",
|
|
1776
1794
|
filter_order_id: "filter_order_id",
|
|
1777
1795
|
filter_payment_origin_org_id: "filter_payment_origin_org_id",
|
|
1796
|
+
filter_payment_origin_off_chrt_shipper_org_id: "filter_payment_origin_off_chrt_shipper_org_id",
|
|
1778
1797
|
filter_payment_destination_org_id: "filter_payment_destination_org_id",
|
|
1779
1798
|
filter_owned_by_org_id: "filter_owned_by_org_id",
|
|
1780
1799
|
filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -1783,6 +1802,8 @@ await client.billing.statements.expandedListV1({
|
|
|
1783
1802
|
filter_opened_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
1784
1803
|
filter_paid_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
1785
1804
|
filter_paid_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
1805
|
+
filter_uncollectible_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
1806
|
+
filter_uncollectible_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
1786
1807
|
});
|
|
1787
1808
|
```
|
|
1788
1809
|
|
|
@@ -3876,7 +3897,7 @@ await client.integrations.webcargoEmbed.getEmbedV1("task_group_id", {
|
|
|
3876
3897
|
|
|
3877
3898
|
## Notifications AdHoc
|
|
3878
3899
|
|
|
3879
|
-
<details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">listByOrderIdV1</a>(orderId) -> Chrt.
|
|
3900
|
+
<details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">listByOrderIdV1</a>(orderId, { ...params }) -> Chrt.NotificationAdHocListRes</code></summary>
|
|
3880
3901
|
<dl>
|
|
3881
3902
|
<dd>
|
|
3882
3903
|
|
|
@@ -3888,7 +3909,7 @@ await client.integrations.webcargoEmbed.getEmbedV1("task_group_id", {
|
|
|
3888
3909
|
<dl>
|
|
3889
3910
|
<dd>
|
|
3890
3911
|
|
|
3891
|
-
Lists all ad-hoc notification intents for an order. | authz: min_org_role=operator | () -> (
|
|
3912
|
+
Lists all ad-hoc notification intents for an order. | authz: min_org_role=operator | () -> (NotificationAdHocListRes)
|
|
3892
3913
|
|
|
3893
3914
|
</dd>
|
|
3894
3915
|
</dl>
|
|
@@ -3904,7 +3925,10 @@ Lists all ad-hoc notification intents for an order. | authz: min_org_role=operat
|
|
|
3904
3925
|
<dd>
|
|
3905
3926
|
|
|
3906
3927
|
```typescript
|
|
3907
|
-
await client.notifications.adHoc.listByOrderIdV1("order_id"
|
|
3928
|
+
await client.notifications.adHoc.listByOrderIdV1("order_id", {
|
|
3929
|
+
page: 1,
|
|
3930
|
+
page_size: 1,
|
|
3931
|
+
});
|
|
3908
3932
|
```
|
|
3909
3933
|
|
|
3910
3934
|
</dd>
|
|
@@ -3928,6 +3952,14 @@ await client.notifications.adHoc.listByOrderIdV1("order_id");
|
|
|
3928
3952
|
<dl>
|
|
3929
3953
|
<dd>
|
|
3930
3954
|
|
|
3955
|
+
**request:** `Chrt.notifications.AdHocListByOrderIdV1Request`
|
|
3956
|
+
|
|
3957
|
+
</dd>
|
|
3958
|
+
</dl>
|
|
3959
|
+
|
|
3960
|
+
<dl>
|
|
3961
|
+
<dd>
|
|
3962
|
+
|
|
3931
3963
|
**requestOptions:** `AdHoc.RequestOptions`
|
|
3932
3964
|
|
|
3933
3965
|
</dd>
|
|
@@ -4078,7 +4110,7 @@ await client.notifications.adHoc.deleteV1("ad_hoc_id");
|
|
|
4078
4110
|
|
|
4079
4111
|
## Notifications Groups
|
|
4080
4112
|
|
|
4081
|
-
<details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">listByOrgV1</a>() -> Chrt.
|
|
4113
|
+
<details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">listByOrgV1</a>({ ...params }) -> Chrt.NotificationGroupListRes</code></summary>
|
|
4082
4114
|
<dl>
|
|
4083
4115
|
<dd>
|
|
4084
4116
|
|
|
@@ -4090,7 +4122,7 @@ await client.notifications.adHoc.deleteV1("ad_hoc_id");
|
|
|
4090
4122
|
<dl>
|
|
4091
4123
|
<dd>
|
|
4092
4124
|
|
|
4093
|
-
Lists all notification groups for the caller's organization. | authz: min_org_role=operator | () -> (
|
|
4125
|
+
Lists all notification groups for the caller's organization. | authz: min_org_role=operator | () -> (NotificationGroupListRes)
|
|
4094
4126
|
|
|
4095
4127
|
</dd>
|
|
4096
4128
|
</dl>
|
|
@@ -4106,7 +4138,10 @@ Lists all notification groups for the caller's organization. | authz: min_org_ro
|
|
|
4106
4138
|
<dd>
|
|
4107
4139
|
|
|
4108
4140
|
```typescript
|
|
4109
|
-
await client.notifications.groups.listByOrgV1(
|
|
4141
|
+
await client.notifications.groups.listByOrgV1({
|
|
4142
|
+
page: 1,
|
|
4143
|
+
page_size: 1,
|
|
4144
|
+
});
|
|
4110
4145
|
```
|
|
4111
4146
|
|
|
4112
4147
|
</dd>
|
|
@@ -4122,6 +4157,14 @@ await client.notifications.groups.listByOrgV1();
|
|
|
4122
4157
|
<dl>
|
|
4123
4158
|
<dd>
|
|
4124
4159
|
|
|
4160
|
+
**request:** `Chrt.notifications.GroupsListByOrgV1Request`
|
|
4161
|
+
|
|
4162
|
+
</dd>
|
|
4163
|
+
</dl>
|
|
4164
|
+
|
|
4165
|
+
<dl>
|
|
4166
|
+
<dd>
|
|
4167
|
+
|
|
4125
4168
|
**requestOptions:** `Groups.RequestOptions`
|
|
4126
4169
|
|
|
4127
4170
|
</dd>
|
|
@@ -4196,7 +4239,7 @@ await client.notifications.groups.getForAdministratorV1("group_id");
|
|
|
4196
4239
|
</dl>
|
|
4197
4240
|
</details>
|
|
4198
4241
|
|
|
4199
|
-
<details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">listByUserV1</a>() -> Chrt.
|
|
4242
|
+
<details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">listByUserV1</a>({ ...params }) -> Chrt.NotificationGroupUserListRes</code></summary>
|
|
4200
4243
|
<dl>
|
|
4201
4244
|
<dd>
|
|
4202
4245
|
|
|
@@ -4208,7 +4251,7 @@ await client.notifications.groups.getForAdministratorV1("group_id");
|
|
|
4208
4251
|
<dl>
|
|
4209
4252
|
<dd>
|
|
4210
4253
|
|
|
4211
|
-
Lists notification groups the caller is a member of. | () -> (
|
|
4254
|
+
Lists notification groups the caller is a member of. | () -> (NotificationGroupUserListRes)
|
|
4212
4255
|
|
|
4213
4256
|
</dd>
|
|
4214
4257
|
</dl>
|
|
@@ -4224,7 +4267,10 @@ Lists notification groups the caller is a member of. | () -> (list[NotificationG
|
|
|
4224
4267
|
<dd>
|
|
4225
4268
|
|
|
4226
4269
|
```typescript
|
|
4227
|
-
await client.notifications.groups.listByUserV1(
|
|
4270
|
+
await client.notifications.groups.listByUserV1({
|
|
4271
|
+
page: 1,
|
|
4272
|
+
page_size: 1,
|
|
4273
|
+
});
|
|
4228
4274
|
```
|
|
4229
4275
|
|
|
4230
4276
|
</dd>
|
|
@@ -4240,6 +4286,14 @@ await client.notifications.groups.listByUserV1();
|
|
|
4240
4286
|
<dl>
|
|
4241
4287
|
<dd>
|
|
4242
4288
|
|
|
4289
|
+
**request:** `Chrt.notifications.GroupsListByUserV1Request`
|
|
4290
|
+
|
|
4291
|
+
</dd>
|
|
4292
|
+
</dl>
|
|
4293
|
+
|
|
4294
|
+
<dl>
|
|
4295
|
+
<dd>
|
|
4296
|
+
|
|
4243
4297
|
**requestOptions:** `Groups.RequestOptions`
|
|
4244
4298
|
|
|
4245
4299
|
</dd>
|
|
@@ -5341,7 +5395,7 @@ await client.notifications.webhookSetup.turnOffV1();
|
|
|
5341
5395
|
|
|
5342
5396
|
## Orgs Connections
|
|
5343
5397
|
|
|
5344
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listShippersV1</a>() -> Chrt.
|
|
5398
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listShippersV1</a>({ ...params }) -> Chrt.ShipperConnectionListRes</code></summary>
|
|
5345
5399
|
<dl>
|
|
5346
5400
|
<dd>
|
|
5347
5401
|
|
|
@@ -5353,7 +5407,7 @@ await client.notifications.webhookSetup.turnOffV1();
|
|
|
5353
5407
|
<dl>
|
|
5354
5408
|
<dd>
|
|
5355
5409
|
|
|
5356
|
-
Lists shipper organizations based on the caller's organization type. Couriers see connected shippers, forwarders see connected shippers. | () -> (
|
|
5410
|
+
Lists shipper organizations based on the caller's organization type. Couriers see connected shippers, forwarders see connected shippers. | () -> (ShipperConnectionListRes)
|
|
5357
5411
|
|
|
5358
5412
|
</dd>
|
|
5359
5413
|
</dl>
|
|
@@ -5369,7 +5423,10 @@ Lists shipper organizations based on the caller's organization type. Couriers se
|
|
|
5369
5423
|
<dd>
|
|
5370
5424
|
|
|
5371
5425
|
```typescript
|
|
5372
|
-
await client.orgs.connections.listShippersV1(
|
|
5426
|
+
await client.orgs.connections.listShippersV1({
|
|
5427
|
+
page: 1,
|
|
5428
|
+
page_size: 1,
|
|
5429
|
+
});
|
|
5373
5430
|
```
|
|
5374
5431
|
|
|
5375
5432
|
</dd>
|
|
@@ -5385,6 +5442,14 @@ await client.orgs.connections.listShippersV1();
|
|
|
5385
5442
|
<dl>
|
|
5386
5443
|
<dd>
|
|
5387
5444
|
|
|
5445
|
+
**request:** `Chrt.orgs.ConnectionsListShippersV1Request`
|
|
5446
|
+
|
|
5447
|
+
</dd>
|
|
5448
|
+
</dl>
|
|
5449
|
+
|
|
5450
|
+
<dl>
|
|
5451
|
+
<dd>
|
|
5452
|
+
|
|
5388
5453
|
**requestOptions:** `Connections.RequestOptions`
|
|
5389
5454
|
|
|
5390
5455
|
</dd>
|
|
@@ -5396,7 +5461,7 @@ await client.orgs.connections.listShippersV1();
|
|
|
5396
5461
|
</dl>
|
|
5397
5462
|
</details>
|
|
5398
5463
|
|
|
5399
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listCouriersV1</a>() -> Chrt.
|
|
5464
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listCouriersV1</a>({ ...params }) -> Chrt.CourierConnectionListRes</code></summary>
|
|
5400
5465
|
<dl>
|
|
5401
5466
|
<dd>
|
|
5402
5467
|
|
|
@@ -5408,7 +5473,7 @@ await client.orgs.connections.listShippersV1();
|
|
|
5408
5473
|
<dl>
|
|
5409
5474
|
<dd>
|
|
5410
5475
|
|
|
5411
|
-
Lists courier organizations based on the caller's organization type. Shippers see connected couriers, forwarders see connected couriers. | () -> (
|
|
5476
|
+
Lists courier organizations based on the caller's organization type. Shippers see connected couriers, forwarders see connected couriers. | () -> (CourierConnectionListRes)
|
|
5412
5477
|
|
|
5413
5478
|
</dd>
|
|
5414
5479
|
</dl>
|
|
@@ -5424,7 +5489,10 @@ Lists courier organizations based on the caller's organization type. Shippers se
|
|
|
5424
5489
|
<dd>
|
|
5425
5490
|
|
|
5426
5491
|
```typescript
|
|
5427
|
-
await client.orgs.connections.listCouriersV1(
|
|
5492
|
+
await client.orgs.connections.listCouriersV1({
|
|
5493
|
+
page: 1,
|
|
5494
|
+
page_size: 1,
|
|
5495
|
+
});
|
|
5428
5496
|
```
|
|
5429
5497
|
|
|
5430
5498
|
</dd>
|
|
@@ -5440,6 +5508,14 @@ await client.orgs.connections.listCouriersV1();
|
|
|
5440
5508
|
<dl>
|
|
5441
5509
|
<dd>
|
|
5442
5510
|
|
|
5511
|
+
**request:** `Chrt.orgs.ConnectionsListCouriersV1Request`
|
|
5512
|
+
|
|
5513
|
+
</dd>
|
|
5514
|
+
</dl>
|
|
5515
|
+
|
|
5516
|
+
<dl>
|
|
5517
|
+
<dd>
|
|
5518
|
+
|
|
5443
5519
|
**requestOptions:** `Connections.RequestOptions`
|
|
5444
5520
|
|
|
5445
5521
|
</dd>
|
|
@@ -5451,7 +5527,7 @@ await client.orgs.connections.listCouriersV1();
|
|
|
5451
5527
|
</dl>
|
|
5452
5528
|
</details>
|
|
5453
5529
|
|
|
5454
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listForwardersV1</a>() -> Chrt.
|
|
5530
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listForwardersV1</a>({ ...params }) -> Chrt.ForwarderConnectionListRes</code></summary>
|
|
5455
5531
|
<dl>
|
|
5456
5532
|
<dd>
|
|
5457
5533
|
|
|
@@ -5463,7 +5539,7 @@ await client.orgs.connections.listCouriersV1();
|
|
|
5463
5539
|
<dl>
|
|
5464
5540
|
<dd>
|
|
5465
5541
|
|
|
5466
|
-
Lists forwarder organizations based on the caller's organization type. Shippers see connected forwarders, couriers see connected forwarders. | () -> (
|
|
5542
|
+
Lists forwarder organizations based on the caller's organization type. Shippers see connected forwarders, couriers see connected forwarders. | () -> (ForwarderConnectionListRes)
|
|
5467
5543
|
|
|
5468
5544
|
</dd>
|
|
5469
5545
|
</dl>
|
|
@@ -5479,7 +5555,10 @@ Lists forwarder organizations based on the caller's organization type. Shippers
|
|
|
5479
5555
|
<dd>
|
|
5480
5556
|
|
|
5481
5557
|
```typescript
|
|
5482
|
-
await client.orgs.connections.listForwardersV1(
|
|
5558
|
+
await client.orgs.connections.listForwardersV1({
|
|
5559
|
+
page: 1,
|
|
5560
|
+
page_size: 1,
|
|
5561
|
+
});
|
|
5483
5562
|
```
|
|
5484
5563
|
|
|
5485
5564
|
</dd>
|
|
@@ -5495,6 +5574,14 @@ await client.orgs.connections.listForwardersV1();
|
|
|
5495
5574
|
<dl>
|
|
5496
5575
|
<dd>
|
|
5497
5576
|
|
|
5577
|
+
**request:** `Chrt.orgs.ConnectionsListForwardersV1Request`
|
|
5578
|
+
|
|
5579
|
+
</dd>
|
|
5580
|
+
</dl>
|
|
5581
|
+
|
|
5582
|
+
<dl>
|
|
5583
|
+
<dd>
|
|
5584
|
+
|
|
5498
5585
|
**requestOptions:** `Connections.RequestOptions`
|
|
5499
5586
|
|
|
5500
5587
|
</dd>
|
|
@@ -5832,7 +5919,7 @@ await client.orgs.offChrtShipperOrg.createV1({
|
|
|
5832
5919
|
</dl>
|
|
5833
5920
|
</details>
|
|
5834
5921
|
|
|
5835
|
-
<details><summary><code>client.orgs.offChrtShipperOrg.<a href="/src/api/resources/orgs/resources/offChrtShipperOrg/client/Client.ts">listV1</a>() -> Chrt.
|
|
5922
|
+
<details><summary><code>client.orgs.offChrtShipperOrg.<a href="/src/api/resources/orgs/resources/offChrtShipperOrg/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OffChrtShipperOrgListRes</code></summary>
|
|
5836
5923
|
<dl>
|
|
5837
5924
|
<dd>
|
|
5838
5925
|
|
|
@@ -5844,7 +5931,7 @@ await client.orgs.offChrtShipperOrg.createV1({
|
|
|
5844
5931
|
<dl>
|
|
5845
5932
|
<dd>
|
|
5846
5933
|
|
|
5847
|
-
Lists all off-platform shipper organizations created by the caller's organization. | () -> (
|
|
5934
|
+
Lists all off-platform shipper organizations created by the caller's organization. | () -> (OffChrtShipperOrgListRes)
|
|
5848
5935
|
|
|
5849
5936
|
</dd>
|
|
5850
5937
|
</dl>
|
|
@@ -5860,7 +5947,10 @@ Lists all off-platform shipper organizations created by the caller's organizatio
|
|
|
5860
5947
|
<dd>
|
|
5861
5948
|
|
|
5862
5949
|
```typescript
|
|
5863
|
-
await client.orgs.offChrtShipperOrg.listV1(
|
|
5950
|
+
await client.orgs.offChrtShipperOrg.listV1({
|
|
5951
|
+
page: 1,
|
|
5952
|
+
page_size: 1,
|
|
5953
|
+
});
|
|
5864
5954
|
```
|
|
5865
5955
|
|
|
5866
5956
|
</dd>
|
|
@@ -5876,6 +5966,14 @@ await client.orgs.offChrtShipperOrg.listV1();
|
|
|
5876
5966
|
<dl>
|
|
5877
5967
|
<dd>
|
|
5878
5968
|
|
|
5969
|
+
**request:** `Chrt.orgs.OffChrtShipperOrgListV1Request`
|
|
5970
|
+
|
|
5971
|
+
</dd>
|
|
5972
|
+
</dl>
|
|
5973
|
+
|
|
5974
|
+
<dl>
|
|
5975
|
+
<dd>
|
|
5976
|
+
|
|
5879
5977
|
**requestOptions:** `OffChrtShipperOrg.RequestOptions`
|
|
5880
5978
|
|
|
5881
5979
|
</dd>
|
|
@@ -7628,7 +7726,7 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
|
7628
7726
|
</dl>
|
|
7629
7727
|
</details>
|
|
7630
7728
|
|
|
7631
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listOrgMembersAndDriversV1</a>({ ...params }) -> Chrt.
|
|
7729
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listOrgMembersAndDriversV1</a>({ ...params }) -> Chrt.OrgMembersAndDriversListRes</code></summary>
|
|
7632
7730
|
<dl>
|
|
7633
7731
|
<dd>
|
|
7634
7732
|
|
|
@@ -7640,7 +7738,7 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
|
7640
7738
|
<dl>
|
|
7641
7739
|
<dd>
|
|
7642
7740
|
|
|
7643
|
-
Lists all organization members paired with their driver information if they are drivers. Filter by availability. | () -> (
|
|
7741
|
+
Lists all organization members paired with their driver information if they are drivers. Filter by availability. | () -> (OrgMembersAndDriversListRes)
|
|
7644
7742
|
|
|
7645
7743
|
</dd>
|
|
7646
7744
|
</dl>
|
|
@@ -7657,8 +7755,10 @@ Lists all organization members paired with their driver information if they are
|
|
|
7657
7755
|
|
|
7658
7756
|
```typescript
|
|
7659
7757
|
await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
7660
|
-
|
|
7661
|
-
|
|
7758
|
+
filter_available_according_to_driver: true,
|
|
7759
|
+
filter_available_according_to_operators: true,
|
|
7760
|
+
page: 1,
|
|
7761
|
+
page_size: 1,
|
|
7662
7762
|
});
|
|
7663
7763
|
```
|
|
7664
7764
|
|
|
@@ -7694,7 +7794,7 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
7694
7794
|
</dl>
|
|
7695
7795
|
</details>
|
|
7696
7796
|
|
|
7697
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listV1</a>({ ...params }) -> Chrt.
|
|
7797
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DriverListRes</code></summary>
|
|
7698
7798
|
<dl>
|
|
7699
7799
|
<dd>
|
|
7700
7800
|
|
|
@@ -7706,7 +7806,7 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
7706
7806
|
<dl>
|
|
7707
7807
|
<dd>
|
|
7708
7808
|
|
|
7709
|
-
Lists all drivers belonging to the caller's organization
|
|
7809
|
+
Lists all drivers belonging to the caller's organization with filtering, sorting, pagination, and optional full-text search. | () -> (DriverListRes)
|
|
7710
7810
|
|
|
7711
7811
|
</dd>
|
|
7712
7812
|
</dl>
|
|
@@ -7723,8 +7823,12 @@ Lists all drivers belonging to the caller's organization. Filter by availability
|
|
|
7723
7823
|
|
|
7724
7824
|
```typescript
|
|
7725
7825
|
await client.shipping.drivers.listV1({
|
|
7726
|
-
|
|
7727
|
-
|
|
7826
|
+
sort_order: "asc",
|
|
7827
|
+
page: 1,
|
|
7828
|
+
page_size: 1,
|
|
7829
|
+
search: "search",
|
|
7830
|
+
filter_available_according_to_driver: true,
|
|
7831
|
+
filter_available_according_to_operators: true,
|
|
7728
7832
|
});
|
|
7729
7833
|
```
|
|
7730
7834
|
|
|
@@ -11036,7 +11140,7 @@ Lists expanded draft orders for the organization with filtering, sorting, and pa
|
|
|
11036
11140
|
```typescript
|
|
11037
11141
|
await client.shipping.orderDrafts.expanded.listV1({
|
|
11038
11142
|
sort_by: "draft_started_at_timestamp",
|
|
11039
|
-
sort_order: "
|
|
11143
|
+
sort_order: "asc",
|
|
11040
11144
|
page: 1,
|
|
11041
11145
|
page_size: 1,
|
|
11042
11146
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -11233,7 +11337,7 @@ await client.shipping.orders.expanded.forForwarderOperatorsV1("order_id_or_short
|
|
|
11233
11337
|
<dl>
|
|
11234
11338
|
<dd>
|
|
11235
11339
|
|
|
11236
|
-
Lists expanded orders for forwarder operators with filtering, sorting, and
|
|
11340
|
+
Lists expanded orders for forwarder operators with filtering, sorting, pagination, and optional search. | authz: allowed_org_types=[forwarder], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
|
|
11237
11341
|
|
|
11238
11342
|
</dd>
|
|
11239
11343
|
</dl>
|
|
@@ -11251,9 +11355,10 @@ Lists expanded orders for forwarder operators with filtering, sorting, and pagin
|
|
|
11251
11355
|
```typescript
|
|
11252
11356
|
await client.shipping.orders.expanded.listForForwarderOperatorsV1({
|
|
11253
11357
|
sort_by: "draft_started_at_timestamp",
|
|
11254
|
-
sort_order: "
|
|
11358
|
+
sort_order: "asc",
|
|
11255
11359
|
page: 1,
|
|
11256
11360
|
page_size: 1,
|
|
11361
|
+
search: "search",
|
|
11257
11362
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
11258
11363
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11259
11364
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -11314,7 +11419,7 @@ await client.shipping.orders.expanded.listForForwarderOperatorsV1({
|
|
|
11314
11419
|
<dl>
|
|
11315
11420
|
<dd>
|
|
11316
11421
|
|
|
11317
|
-
Lists expanded orders for shipper operators with filtering, sorting, and
|
|
11422
|
+
Lists expanded orders for shipper operators with filtering, sorting, pagination, and optional search. | authz: allowed_org_types=[shipper], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
|
|
11318
11423
|
|
|
11319
11424
|
</dd>
|
|
11320
11425
|
</dl>
|
|
@@ -11332,9 +11437,10 @@ Lists expanded orders for shipper operators with filtering, sorting, and paginat
|
|
|
11332
11437
|
```typescript
|
|
11333
11438
|
await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
11334
11439
|
sort_by: "draft_started_at_timestamp",
|
|
11335
|
-
sort_order: "
|
|
11440
|
+
sort_order: "asc",
|
|
11336
11441
|
page: 1,
|
|
11337
11442
|
page_size: 1,
|
|
11443
|
+
search: "search",
|
|
11338
11444
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
11339
11445
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11340
11446
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -11383,6 +11489,72 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
11383
11489
|
</dl>
|
|
11384
11490
|
</details>
|
|
11385
11491
|
|
|
11492
|
+
<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">typeaheadV1</a>({ ...params }) -> string[]</code></summary>
|
|
11493
|
+
<dl>
|
|
11494
|
+
<dd>
|
|
11495
|
+
|
|
11496
|
+
#### 📝 Description
|
|
11497
|
+
|
|
11498
|
+
<dl>
|
|
11499
|
+
<dd>
|
|
11500
|
+
|
|
11501
|
+
<dl>
|
|
11502
|
+
<dd>
|
|
11503
|
+
|
|
11504
|
+
Returns distinct order short_id values matching the query via case-insensitive regex. Searches non-draft orders visible to the caller's org. | authz: allowed_org_types=[forwarder, shipper], min_org_role=operator | () -> (list[str])
|
|
11505
|
+
|
|
11506
|
+
</dd>
|
|
11507
|
+
</dl>
|
|
11508
|
+
</dd>
|
|
11509
|
+
</dl>
|
|
11510
|
+
|
|
11511
|
+
#### 🔌 Usage
|
|
11512
|
+
|
|
11513
|
+
<dl>
|
|
11514
|
+
<dd>
|
|
11515
|
+
|
|
11516
|
+
<dl>
|
|
11517
|
+
<dd>
|
|
11518
|
+
|
|
11519
|
+
```typescript
|
|
11520
|
+
await client.shipping.orders.expanded.typeaheadV1({
|
|
11521
|
+
query: "query",
|
|
11522
|
+
limit: 1,
|
|
11523
|
+
});
|
|
11524
|
+
```
|
|
11525
|
+
|
|
11526
|
+
</dd>
|
|
11527
|
+
</dl>
|
|
11528
|
+
</dd>
|
|
11529
|
+
</dl>
|
|
11530
|
+
|
|
11531
|
+
#### ⚙️ Parameters
|
|
11532
|
+
|
|
11533
|
+
<dl>
|
|
11534
|
+
<dd>
|
|
11535
|
+
|
|
11536
|
+
<dl>
|
|
11537
|
+
<dd>
|
|
11538
|
+
|
|
11539
|
+
**request:** `Chrt.shipping.orders.ExpandedTypeaheadV1Request`
|
|
11540
|
+
|
|
11541
|
+
</dd>
|
|
11542
|
+
</dl>
|
|
11543
|
+
|
|
11544
|
+
<dl>
|
|
11545
|
+
<dd>
|
|
11546
|
+
|
|
11547
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
11548
|
+
|
|
11549
|
+
</dd>
|
|
11550
|
+
</dl>
|
|
11551
|
+
</dd>
|
|
11552
|
+
</dl>
|
|
11553
|
+
|
|
11554
|
+
</dd>
|
|
11555
|
+
</dl>
|
|
11556
|
+
</details>
|
|
11557
|
+
|
|
11386
11558
|
## Shipping TaskArtifacts S3Object
|
|
11387
11559
|
|
|
11388
11560
|
<details><summary><code>client.shipping.taskArtifacts.s3Object.<a href="/src/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.ts">getS3ObjectMetadataV1</a>(taskArtifactS3ObjectMetadataId) -> Chrt.TaskArtifactS3ObjectMetadata1</code></summary>
|
|
@@ -12337,7 +12509,7 @@ await client.shipping.taskGroups.expanded.forForwarderOperatorsV1("task_group_id
|
|
|
12337
12509
|
<dl>
|
|
12338
12510
|
<dd>
|
|
12339
12511
|
|
|
12340
|
-
Lists expanded task groups for courier operators with filtering, sorting, and
|
|
12512
|
+
Lists expanded task groups for courier operators with filtering, sorting, pagination, and optional full-text search. | authz_personas=[courier_org_operators] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpandedListRes)
|
|
12341
12513
|
|
|
12342
12514
|
</dd>
|
|
12343
12515
|
</dl>
|
|
@@ -12355,9 +12527,10 @@ Lists expanded task groups for courier operators with filtering, sorting, and pa
|
|
|
12355
12527
|
```typescript
|
|
12356
12528
|
await client.shipping.taskGroups.expanded.listForCourierOperatorsV1({
|
|
12357
12529
|
sort_by: "draft_started_at_timestamp",
|
|
12358
|
-
sort_order: "
|
|
12530
|
+
sort_order: "asc",
|
|
12359
12531
|
page: 1,
|
|
12360
12532
|
page_size: 1,
|
|
12533
|
+
search: "search",
|
|
12361
12534
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
12362
12535
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
12363
12536
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -12418,7 +12591,7 @@ await client.shipping.taskGroups.expanded.listForCourierOperatorsV1({
|
|
|
12418
12591
|
<dl>
|
|
12419
12592
|
<dd>
|
|
12420
12593
|
|
|
12421
|
-
Lists expanded task groups for courier driver with filtering, sorting, and
|
|
12594
|
+
Lists expanded task groups for courier driver with filtering, sorting, pagination, and optional full-text search. | authz_personas=[courier_driver] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpandedListRes)
|
|
12422
12595
|
|
|
12423
12596
|
</dd>
|
|
12424
12597
|
</dl>
|
|
@@ -12436,9 +12609,10 @@ Lists expanded task groups for courier driver with filtering, sorting, and pagin
|
|
|
12436
12609
|
```typescript
|
|
12437
12610
|
await client.shipping.taskGroups.expanded.listForCourierDriverV1({
|
|
12438
12611
|
sort_by: "draft_started_at_timestamp",
|
|
12439
|
-
sort_order: "
|
|
12612
|
+
sort_order: "asc",
|
|
12440
12613
|
page: 1,
|
|
12441
12614
|
page_size: 1,
|
|
12615
|
+
search: "search",
|
|
12442
12616
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
12443
12617
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
12444
12618
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -12487,9 +12661,7 @@ await client.shipping.taskGroups.expanded.listForCourierDriverV1({
|
|
|
12487
12661
|
</dl>
|
|
12488
12662
|
</details>
|
|
12489
12663
|
|
|
12490
|
-
|
|
12491
|
-
|
|
12492
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">registerToOrgV1</a>({ ...params }) -> string</code></summary>
|
|
12664
|
+
<details><summary><code>client.shipping.taskGroups.expanded.<a href="/src/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.ts">typeaheadV1</a>({ ...params }) -> string[]</code></summary>
|
|
12493
12665
|
<dl>
|
|
12494
12666
|
<dd>
|
|
12495
12667
|
|
|
@@ -12501,7 +12673,7 @@ await client.shipping.taskGroups.expanded.listForCourierDriverV1({
|
|
|
12501
12673
|
<dl>
|
|
12502
12674
|
<dd>
|
|
12503
12675
|
|
|
12504
|
-
|
|
12676
|
+
Returns distinct order_short_id values matching the query via case-insensitive regex. Searches non-draft task groups belonging to the caller's courier org. | authz: allowed_org_types=[courier], min_org_role=driver | () -> (list[str])
|
|
12505
12677
|
|
|
12506
12678
|
</dd>
|
|
12507
12679
|
</dl>
|
|
@@ -12517,9 +12689,9 @@ Registers a tracking device to the caller's organization. If the device is alrea
|
|
|
12517
12689
|
<dd>
|
|
12518
12690
|
|
|
12519
12691
|
```typescript
|
|
12520
|
-
await client.
|
|
12521
|
-
|
|
12522
|
-
|
|
12692
|
+
await client.shipping.taskGroups.expanded.typeaheadV1({
|
|
12693
|
+
query: "query",
|
|
12694
|
+
limit: 1,
|
|
12523
12695
|
});
|
|
12524
12696
|
```
|
|
12525
12697
|
|
|
@@ -12536,7 +12708,7 @@ await client.tracking.devices.registerToOrgV1({
|
|
|
12536
12708
|
<dl>
|
|
12537
12709
|
<dd>
|
|
12538
12710
|
|
|
12539
|
-
**request:** `Chrt.
|
|
12711
|
+
**request:** `Chrt.shipping.taskGroups.ExpandedTypeaheadV1Request`
|
|
12540
12712
|
|
|
12541
12713
|
</dd>
|
|
12542
12714
|
</dl>
|
|
@@ -12544,7 +12716,7 @@ await client.tracking.devices.registerToOrgV1({
|
|
|
12544
12716
|
<dl>
|
|
12545
12717
|
<dd>
|
|
12546
12718
|
|
|
12547
|
-
**requestOptions:** `
|
|
12719
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
12548
12720
|
|
|
12549
12721
|
</dd>
|
|
12550
12722
|
</dl>
|
|
@@ -12555,7 +12727,9 @@ await client.tracking.devices.registerToOrgV1({
|
|
|
12555
12727
|
</dl>
|
|
12556
12728
|
</details>
|
|
12557
12729
|
|
|
12558
|
-
|
|
12730
|
+
## Tracking Devices
|
|
12731
|
+
|
|
12732
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">registerToOrgV1</a>({ ...params }) -> string</code></summary>
|
|
12559
12733
|
<dl>
|
|
12560
12734
|
<dd>
|
|
12561
12735
|
|
|
@@ -12567,7 +12741,7 @@ await client.tracking.devices.registerToOrgV1({
|
|
|
12567
12741
|
<dl>
|
|
12568
12742
|
<dd>
|
|
12569
12743
|
|
|
12570
|
-
|
|
12744
|
+
Registers a tracking device to the caller's organization. If the device is already registered to a different organization, returns 409 Conflict. | (DeviceClientCreate1) -> (PydanticObjectId)
|
|
12571
12745
|
|
|
12572
12746
|
</dd>
|
|
12573
12747
|
</dl>
|
|
@@ -12583,8 +12757,9 @@ Updates a device's type, comments, and/or off_chrt_reference_id. Use \_\_set_to_
|
|
|
12583
12757
|
<dd>
|
|
12584
12758
|
|
|
12585
12759
|
```typescript
|
|
12586
|
-
await client.tracking.devices.
|
|
12587
|
-
|
|
12760
|
+
await client.tracking.devices.registerToOrgV1({
|
|
12761
|
+
schema_version: 1,
|
|
12762
|
+
device_mac_address: "device_mac_address",
|
|
12588
12763
|
});
|
|
12589
12764
|
```
|
|
12590
12765
|
|
|
@@ -12601,7 +12776,7 @@ await client.tracking.devices.updateV1({
|
|
|
12601
12776
|
<dl>
|
|
12602
12777
|
<dd>
|
|
12603
12778
|
|
|
12604
|
-
**request:** `Chrt.tracking.
|
|
12779
|
+
**request:** `Chrt.tracking.DeviceClientCreate1`
|
|
12605
12780
|
|
|
12606
12781
|
</dd>
|
|
12607
12782
|
</dl>
|
|
@@ -12620,7 +12795,7 @@ await client.tracking.devices.updateV1({
|
|
|
12620
12795
|
</dl>
|
|
12621
12796
|
</details>
|
|
12622
12797
|
|
|
12623
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">
|
|
12798
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
12624
12799
|
<dl>
|
|
12625
12800
|
<dd>
|
|
12626
12801
|
|
|
@@ -12632,7 +12807,7 @@ await client.tracking.devices.updateV1({
|
|
|
12632
12807
|
<dl>
|
|
12633
12808
|
<dd>
|
|
12634
12809
|
|
|
12635
|
-
|
|
12810
|
+
Updates a device's type, comments, and/or off_chrt_reference_id. Use \_\_set_to_None flags to explicitly clear Optional fields. | (DeviceClientUpdate1) -> (bool)
|
|
12636
12811
|
|
|
12637
12812
|
</dd>
|
|
12638
12813
|
</dl>
|
|
@@ -12648,7 +12823,7 @@ Archives a device by setting archived=True. Device must not have an active sessi
|
|
|
12648
12823
|
<dd>
|
|
12649
12824
|
|
|
12650
12825
|
```typescript
|
|
12651
|
-
await client.tracking.devices.
|
|
12826
|
+
await client.tracking.devices.updateV1({
|
|
12652
12827
|
device_id: "device_id",
|
|
12653
12828
|
});
|
|
12654
12829
|
```
|
|
@@ -12666,7 +12841,7 @@ await client.tracking.devices.archiveV1({
|
|
|
12666
12841
|
<dl>
|
|
12667
12842
|
<dd>
|
|
12668
12843
|
|
|
12669
|
-
**request:** `Chrt.tracking.
|
|
12844
|
+
**request:** `Chrt.tracking.DeviceClientUpdate1`
|
|
12670
12845
|
|
|
12671
12846
|
</dd>
|
|
12672
12847
|
</dl>
|
|
@@ -12685,7 +12860,7 @@ await client.tracking.devices.archiveV1({
|
|
|
12685
12860
|
</dl>
|
|
12686
12861
|
</details>
|
|
12687
12862
|
|
|
12688
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">
|
|
12863
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">archiveV1</a>({ ...params }) -> boolean</code></summary>
|
|
12689
12864
|
<dl>
|
|
12690
12865
|
<dd>
|
|
12691
12866
|
|
|
@@ -12697,7 +12872,7 @@ await client.tracking.devices.archiveV1({
|
|
|
12697
12872
|
<dl>
|
|
12698
12873
|
<dd>
|
|
12699
12874
|
|
|
12700
|
-
|
|
12875
|
+
Archives a device by setting archived=True. Device must not have an active session — terminate it first. | () -> (bool)
|
|
12701
12876
|
|
|
12702
12877
|
</dd>
|
|
12703
12878
|
</dl>
|
|
@@ -12713,7 +12888,7 @@ Pauses a device. Cargo-by-device and session-by-device data points are marked as
|
|
|
12713
12888
|
<dd>
|
|
12714
12889
|
|
|
12715
12890
|
```typescript
|
|
12716
|
-
await client.tracking.devices.
|
|
12891
|
+
await client.tracking.devices.archiveV1({
|
|
12717
12892
|
device_id: "device_id",
|
|
12718
12893
|
});
|
|
12719
12894
|
```
|
|
@@ -12731,7 +12906,7 @@ await client.tracking.devices.pauseV1({
|
|
|
12731
12906
|
<dl>
|
|
12732
12907
|
<dd>
|
|
12733
12908
|
|
|
12734
|
-
**request:** `Chrt.tracking.
|
|
12909
|
+
**request:** `Chrt.tracking.DevicesArchiveV1Request`
|
|
12735
12910
|
|
|
12736
12911
|
</dd>
|
|
12737
12912
|
</dl>
|
|
@@ -12750,7 +12925,7 @@ await client.tracking.devices.pauseV1({
|
|
|
12750
12925
|
</dl>
|
|
12751
12926
|
</details>
|
|
12752
12927
|
|
|
12753
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">
|
|
12928
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">pauseV1</a>({ ...params }) -> boolean</code></summary>
|
|
12754
12929
|
<dl>
|
|
12755
12930
|
<dd>
|
|
12756
12931
|
|
|
@@ -12762,7 +12937,7 @@ await client.tracking.devices.pauseV1({
|
|
|
12762
12937
|
<dl>
|
|
12763
12938
|
<dd>
|
|
12764
12939
|
|
|
12765
|
-
|
|
12940
|
+
Pauses a device and opens a new pause time window. | () -> (bool)
|
|
12766
12941
|
|
|
12767
12942
|
</dd>
|
|
12768
12943
|
</dl>
|
|
@@ -12778,7 +12953,7 @@ Unpauses a device. | () -> (bool)
|
|
|
12778
12953
|
<dd>
|
|
12779
12954
|
|
|
12780
12955
|
```typescript
|
|
12781
|
-
await client.tracking.devices.
|
|
12956
|
+
await client.tracking.devices.pauseV1({
|
|
12782
12957
|
device_id: "device_id",
|
|
12783
12958
|
});
|
|
12784
12959
|
```
|
|
@@ -12796,7 +12971,7 @@ await client.tracking.devices.unpauseV1({
|
|
|
12796
12971
|
<dl>
|
|
12797
12972
|
<dd>
|
|
12798
12973
|
|
|
12799
|
-
**request:** `Chrt.tracking.
|
|
12974
|
+
**request:** `Chrt.tracking.DevicesPauseV1Request`
|
|
12800
12975
|
|
|
12801
12976
|
</dd>
|
|
12802
12977
|
</dl>
|
|
@@ -12815,7 +12990,7 @@ await client.tracking.devices.unpauseV1({
|
|
|
12815
12990
|
</dl>
|
|
12816
12991
|
</details>
|
|
12817
12992
|
|
|
12818
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">
|
|
12993
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">unpauseV1</a>({ ...params }) -> boolean</code></summary>
|
|
12819
12994
|
<dl>
|
|
12820
12995
|
<dd>
|
|
12821
12996
|
|
|
@@ -12827,7 +13002,7 @@ await client.tracking.devices.unpauseV1({
|
|
|
12827
13002
|
<dl>
|
|
12828
13003
|
<dd>
|
|
12829
13004
|
|
|
12830
|
-
|
|
13005
|
+
Unpauses a device. Closes the open pause time window. | () -> (bool)
|
|
12831
13006
|
|
|
12832
13007
|
</dd>
|
|
12833
13008
|
</dl>
|
|
@@ -12843,7 +13018,7 @@ Adds and/or removes org_ids from a device's shared_with_org_ids list. Removal ov
|
|
|
12843
13018
|
<dd>
|
|
12844
13019
|
|
|
12845
13020
|
```typescript
|
|
12846
|
-
await client.tracking.devices.
|
|
13021
|
+
await client.tracking.devices.unpauseV1({
|
|
12847
13022
|
device_id: "device_id",
|
|
12848
13023
|
});
|
|
12849
13024
|
```
|
|
@@ -12861,7 +13036,7 @@ await client.tracking.devices.updateSharedOrgsV1({
|
|
|
12861
13036
|
<dl>
|
|
12862
13037
|
<dd>
|
|
12863
13038
|
|
|
12864
|
-
**request:** `Chrt.tracking.
|
|
13039
|
+
**request:** `Chrt.tracking.DevicesUnpauseV1Request`
|
|
12865
13040
|
|
|
12866
13041
|
</dd>
|
|
12867
13042
|
</dl>
|
|
@@ -12880,7 +13055,7 @@ await client.tracking.devices.updateSharedOrgsV1({
|
|
|
12880
13055
|
</dl>
|
|
12881
13056
|
</details>
|
|
12882
13057
|
|
|
12883
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">
|
|
13058
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">updateSharedOrgsV1</a>({ ...params }) -> boolean</code></summary>
|
|
12884
13059
|
<dl>
|
|
12885
13060
|
<dd>
|
|
12886
13061
|
|
|
@@ -12892,7 +13067,7 @@ await client.tracking.devices.updateSharedOrgsV1({
|
|
|
12892
13067
|
<dl>
|
|
12893
13068
|
<dd>
|
|
12894
13069
|
|
|
12895
|
-
|
|
13070
|
+
Adds and/or removes org_ids from a device's shared_with_org_ids list. Removal overrides addition. | (DevicesUpdateSharedOrgsReq1) -> (bool)
|
|
12896
13071
|
|
|
12897
13072
|
</dd>
|
|
12898
13073
|
</dl>
|
|
@@ -12908,7 +13083,7 @@ Retrieves a single device by its ID with expanded sessions and cargos. Access re
|
|
|
12908
13083
|
<dd>
|
|
12909
13084
|
|
|
12910
13085
|
```typescript
|
|
12911
|
-
await client.tracking.devices.
|
|
13086
|
+
await client.tracking.devices.updateSharedOrgsV1({
|
|
12912
13087
|
device_id: "device_id",
|
|
12913
13088
|
});
|
|
12914
13089
|
```
|
|
@@ -12926,7 +13101,7 @@ await client.tracking.devices.getV1({
|
|
|
12926
13101
|
<dl>
|
|
12927
13102
|
<dd>
|
|
12928
13103
|
|
|
12929
|
-
**request:** `Chrt.tracking.
|
|
13104
|
+
**request:** `Chrt.tracking.DevicesUpdateSharedOrgsReq1`
|
|
12930
13105
|
|
|
12931
13106
|
</dd>
|
|
12932
13107
|
</dl>
|
|
@@ -12945,7 +13120,7 @@ await client.tracking.devices.getV1({
|
|
|
12945
13120
|
</dl>
|
|
12946
13121
|
</details>
|
|
12947
13122
|
|
|
12948
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">
|
|
13123
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">getV1</a>({ ...params }) -> Chrt.DeviceExpandedRes</code></summary>
|
|
12949
13124
|
<dl>
|
|
12950
13125
|
<dd>
|
|
12951
13126
|
|
|
@@ -12957,7 +13132,7 @@ await client.tracking.devices.getV1({
|
|
|
12957
13132
|
<dl>
|
|
12958
13133
|
<dd>
|
|
12959
13134
|
|
|
12960
|
-
|
|
13135
|
+
Retrieves a single device by its ID with expanded sessions and cargos. Access restricted to the caller's organization or shared organizations. | authz: min_org_role=operator | () -> (DeviceExpandedRes)
|
|
12961
13136
|
|
|
12962
13137
|
</dd>
|
|
12963
13138
|
</dl>
|
|
@@ -12973,23 +13148,8 @@ Lists devices with filtering, sorting, and pagination. Use org_scope to restrict
|
|
|
12973
13148
|
<dd>
|
|
12974
13149
|
|
|
12975
13150
|
```typescript
|
|
12976
|
-
await client.tracking.devices.
|
|
12977
|
-
|
|
12978
|
-
sort_order: "asc",
|
|
12979
|
-
page: 1,
|
|
12980
|
-
page_size: 1,
|
|
12981
|
-
org_scope: "owned",
|
|
12982
|
-
filter_off_chrt_reference_id: "filter_off_chrt_reference_id",
|
|
12983
|
-
filter_type: "D15N-tag",
|
|
12984
|
-
filter_active_cargo_id: "filter_active_cargo_id",
|
|
12985
|
-
filter_active_session_id: "filter_active_session_id",
|
|
12986
|
-
filter_has_active_session: true,
|
|
12987
|
-
filter_has_active_cargo: true,
|
|
12988
|
-
filter_registered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
12989
|
-
filter_registered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
12990
|
-
filter_last_seen_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
12991
|
-
filter_last_seen_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
12992
|
-
filter_archived: true,
|
|
13151
|
+
await client.tracking.devices.getV1({
|
|
13152
|
+
device_id: "device_id",
|
|
12993
13153
|
});
|
|
12994
13154
|
```
|
|
12995
13155
|
|
|
@@ -13006,7 +13166,7 @@ await client.tracking.devices.listV1({
|
|
|
13006
13166
|
<dl>
|
|
13007
13167
|
<dd>
|
|
13008
13168
|
|
|
13009
|
-
**request:** `Chrt.tracking.
|
|
13169
|
+
**request:** `Chrt.tracking.DevicesGetV1Request`
|
|
13010
13170
|
|
|
13011
13171
|
</dd>
|
|
13012
13172
|
</dl>
|
|
@@ -13025,7 +13185,7 @@ await client.tracking.devices.listV1({
|
|
|
13025
13185
|
</dl>
|
|
13026
13186
|
</details>
|
|
13027
13187
|
|
|
13028
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">
|
|
13188
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DeviceListRes</code></summary>
|
|
13029
13189
|
<dl>
|
|
13030
13190
|
<dd>
|
|
13031
13191
|
|
|
@@ -13037,7 +13197,7 @@ await client.tracking.devices.listV1({
|
|
|
13037
13197
|
<dl>
|
|
13038
13198
|
<dd>
|
|
13039
13199
|
|
|
13040
|
-
|
|
13200
|
+
Lists devices with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (DeviceListRes)
|
|
13041
13201
|
|
|
13042
13202
|
</dd>
|
|
13043
13203
|
</dl>
|
|
@@ -13053,10 +13213,26 @@ Returns distinct device_mac_address and off_chrt_reference_id values matching th
|
|
|
13053
13213
|
<dd>
|
|
13054
13214
|
|
|
13055
13215
|
```typescript
|
|
13056
|
-
await client.tracking.devices.
|
|
13057
|
-
|
|
13058
|
-
|
|
13216
|
+
await client.tracking.devices.listV1({
|
|
13217
|
+
sort_by: "registered_at_timestamp",
|
|
13218
|
+
sort_order: "asc",
|
|
13219
|
+
page: 1,
|
|
13220
|
+
page_size: 1,
|
|
13221
|
+
search: "search",
|
|
13059
13222
|
org_scope: "owned",
|
|
13223
|
+
filter_off_chrt_reference_id: "filter_off_chrt_reference_id",
|
|
13224
|
+
filter_type: "D15N-tag",
|
|
13225
|
+
filter_active_cargo_id: "filter_active_cargo_id",
|
|
13226
|
+
filter_active_session_id: "filter_active_session_id",
|
|
13227
|
+
filter_has_active_session: true,
|
|
13228
|
+
filter_has_active_cargo: true,
|
|
13229
|
+
filter_registered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
13230
|
+
filter_registered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
13231
|
+
filter_last_seen_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
13232
|
+
filter_last_seen_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
13233
|
+
filter_first_seen_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
13234
|
+
filter_first_seen_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
13235
|
+
filter_archived: true,
|
|
13060
13236
|
});
|
|
13061
13237
|
```
|
|
13062
13238
|
|
|
@@ -13073,7 +13249,7 @@ await client.tracking.devices.typeaheadV1({
|
|
|
13073
13249
|
<dl>
|
|
13074
13250
|
<dd>
|
|
13075
13251
|
|
|
13076
|
-
**request:** `Chrt.tracking.
|
|
13252
|
+
**request:** `Chrt.tracking.DevicesListV1Request`
|
|
13077
13253
|
|
|
13078
13254
|
</dd>
|
|
13079
13255
|
</dl>
|
|
@@ -13092,7 +13268,7 @@ await client.tracking.devices.typeaheadV1({
|
|
|
13092
13268
|
</dl>
|
|
13093
13269
|
</details>
|
|
13094
13270
|
|
|
13095
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">
|
|
13271
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.TrackingTypeaheadResult[]</code></summary>
|
|
13096
13272
|
<dl>
|
|
13097
13273
|
<dd>
|
|
13098
13274
|
|
|
@@ -13104,7 +13280,7 @@ await client.tracking.devices.typeaheadV1({
|
|
|
13104
13280
|
<dl>
|
|
13105
13281
|
<dd>
|
|
13106
13282
|
|
|
13107
|
-
|
|
13283
|
+
Returns distinct device_mac_address and off_chrt_reference_id values matching the query via case-insensitive regex, searching devices. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])
|
|
13108
13284
|
|
|
13109
13285
|
</dd>
|
|
13110
13286
|
</dl>
|
|
@@ -13120,10 +13296,9 @@ Search across device device_mac_address, comments, and off_chrt_reference_id. Ha
|
|
|
13120
13296
|
<dd>
|
|
13121
13297
|
|
|
13122
13298
|
```typescript
|
|
13123
|
-
await client.tracking.devices.
|
|
13299
|
+
await client.tracking.devices.typeaheadV1({
|
|
13124
13300
|
query: "query",
|
|
13125
|
-
|
|
13126
|
-
page_size: 1,
|
|
13301
|
+
limit: 1,
|
|
13127
13302
|
org_scope: "owned",
|
|
13128
13303
|
});
|
|
13129
13304
|
```
|
|
@@ -13141,7 +13316,7 @@ await client.tracking.devices.searchV1({
|
|
|
13141
13316
|
<dl>
|
|
13142
13317
|
<dd>
|
|
13143
13318
|
|
|
13144
|
-
**request:** `Chrt.tracking.
|
|
13319
|
+
**request:** `Chrt.tracking.DevicesTypeaheadV1Request`
|
|
13145
13320
|
|
|
13146
13321
|
</dd>
|
|
13147
13322
|
</dl>
|
|
@@ -13250,7 +13425,7 @@ await client.tracking.driver.updateV1({
|
|
|
13250
13425
|
<dl>
|
|
13251
13426
|
<dd>
|
|
13252
13427
|
|
|
13253
|
-
Lists sessions with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (SessionListRes)
|
|
13428
|
+
Lists sessions with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | auth: api_key | authz: min_org_role=operator | () -> (SessionListRes)
|
|
13254
13429
|
|
|
13255
13430
|
</dd>
|
|
13256
13431
|
</dl>
|
|
@@ -13271,6 +13446,7 @@ await client.tracking.sessions.listV1({
|
|
|
13271
13446
|
sort_order: "asc",
|
|
13272
13447
|
page: 1,
|
|
13273
13448
|
page_size: 1,
|
|
13449
|
+
search: "search",
|
|
13274
13450
|
org_scope: "owned",
|
|
13275
13451
|
filter_terminated: true,
|
|
13276
13452
|
filter_public: true,
|
|
@@ -13332,7 +13508,7 @@ await client.tracking.sessions.listV1({
|
|
|
13332
13508
|
<dl>
|
|
13333
13509
|
<dd>
|
|
13334
13510
|
|
|
13335
|
-
Retrieves a single session by its ID. Access restricted to the caller's organization or shared organizations. | authz: min_org_role=operator | () -> (Session1)
|
|
13511
|
+
Retrieves a single session by its ID. Access restricted to the caller's organization or shared organizations. | auth: api_key | authz: min_org_role=operator | () -> (Session1)
|
|
13336
13512
|
|
|
13337
13513
|
</dd>
|
|
13338
13514
|
</dl>
|
|
@@ -13397,7 +13573,7 @@ await client.tracking.sessions.getV1({
|
|
|
13397
13573
|
<dl>
|
|
13398
13574
|
<dd>
|
|
13399
13575
|
|
|
13400
|
-
Returns distinct device_mac_address and off_chrt_reference_id values matching the query via case-insensitive regex, searching sessions. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])
|
|
13576
|
+
Returns distinct device_mac_address and off_chrt_reference_id values matching the query via case-insensitive regex, searching sessions. Use org_scope to restrict to owned, shared, or both (default). | auth: api_key | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])
|
|
13401
13577
|
|
|
13402
13578
|
</dd>
|
|
13403
13579
|
</dl>
|
|
@@ -13452,74 +13628,6 @@ await client.tracking.sessions.typeaheadV1({
|
|
|
13452
13628
|
</dl>
|
|
13453
13629
|
</details>
|
|
13454
13630
|
|
|
13455
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">searchV1</a>({ ...params }) -> Chrt.SessionSearchRes</code></summary>
|
|
13456
|
-
<dl>
|
|
13457
|
-
<dd>
|
|
13458
|
-
|
|
13459
|
-
#### 📝 Description
|
|
13460
|
-
|
|
13461
|
-
<dl>
|
|
13462
|
-
<dd>
|
|
13463
|
-
|
|
13464
|
-
<dl>
|
|
13465
|
-
<dd>
|
|
13466
|
-
|
|
13467
|
-
Search across session comments, device_mac_address, flight_numbers, and off_chrt_reference_id. Handles both partial and full matches. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (SessionSearchRes)
|
|
13468
|
-
|
|
13469
|
-
</dd>
|
|
13470
|
-
</dl>
|
|
13471
|
-
</dd>
|
|
13472
|
-
</dl>
|
|
13473
|
-
|
|
13474
|
-
#### 🔌 Usage
|
|
13475
|
-
|
|
13476
|
-
<dl>
|
|
13477
|
-
<dd>
|
|
13478
|
-
|
|
13479
|
-
<dl>
|
|
13480
|
-
<dd>
|
|
13481
|
-
|
|
13482
|
-
```typescript
|
|
13483
|
-
await client.tracking.sessions.searchV1({
|
|
13484
|
-
query: "query",
|
|
13485
|
-
page: 1,
|
|
13486
|
-
page_size: 1,
|
|
13487
|
-
org_scope: "owned",
|
|
13488
|
-
});
|
|
13489
|
-
```
|
|
13490
|
-
|
|
13491
|
-
</dd>
|
|
13492
|
-
</dl>
|
|
13493
|
-
</dd>
|
|
13494
|
-
</dl>
|
|
13495
|
-
|
|
13496
|
-
#### ⚙️ Parameters
|
|
13497
|
-
|
|
13498
|
-
<dl>
|
|
13499
|
-
<dd>
|
|
13500
|
-
|
|
13501
|
-
<dl>
|
|
13502
|
-
<dd>
|
|
13503
|
-
|
|
13504
|
-
**request:** `Chrt.tracking.SessionsSearchV1Request`
|
|
13505
|
-
|
|
13506
|
-
</dd>
|
|
13507
|
-
</dl>
|
|
13508
|
-
|
|
13509
|
-
<dl>
|
|
13510
|
-
<dd>
|
|
13511
|
-
|
|
13512
|
-
**requestOptions:** `Sessions.RequestOptions`
|
|
13513
|
-
|
|
13514
|
-
</dd>
|
|
13515
|
-
</dl>
|
|
13516
|
-
</dd>
|
|
13517
|
-
</dl>
|
|
13518
|
-
|
|
13519
|
-
</dd>
|
|
13520
|
-
</dl>
|
|
13521
|
-
</details>
|
|
13522
|
-
|
|
13523
13631
|
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">createSessionV1</a>({ ...params }) -> string</code></summary>
|
|
13524
13632
|
<dl>
|
|
13525
13633
|
<dd>
|
|
@@ -14865,7 +14973,7 @@ await client.tracking.timeseries.cargoByDriver.dataPointsPublicV1({
|
|
|
14865
14973
|
<dl>
|
|
14866
14974
|
<dd>
|
|
14867
14975
|
|
|
14868
|
-
Returns the most recent data point for a session, excluding outliers. Access restricted to the caller's organization. | authz: min_org_role=operator | () -> (SessionByDeviceDataPoint1 | None)
|
|
14976
|
+
Returns the most recent data point for a session, excluding outliers. Access restricted to the caller's organization. | auth: api_key | authz: min_org_role=operator | () -> (SessionByDeviceDataPoint1 | None)
|
|
14869
14977
|
|
|
14870
14978
|
</dd>
|
|
14871
14979
|
</dl>
|
|
@@ -14930,7 +15038,7 @@ await client.tracking.timeseries.sessionByDevice.lastSeenV1({
|
|
|
14930
15038
|
<dl>
|
|
14931
15039
|
<dd>
|
|
14932
15040
|
|
|
14933
|
-
Returns time-bucketed data points and stationary clusters for a session within the given time range. start_timestamp and end_timestamp are required. | authz: min_org_role=operator | () -> SessionByDeviceHistoryRes1
|
|
15041
|
+
Returns time-bucketed data points and stationary clusters for a session within the given time range. start_timestamp and end_timestamp are required. | auth: api_key | authz: min_org_role=operator | () -> SessionByDeviceHistoryRes1
|
|
14934
15042
|
|
|
14935
15043
|
</dd>
|
|
14936
15044
|
</dl>
|
|
@@ -15821,7 +15929,7 @@ await client.users.directoryEntries.getV1("directory_entry_id");
|
|
|
15821
15929
|
</dl>
|
|
15822
15930
|
</details>
|
|
15823
15931
|
|
|
15824
|
-
<details><summary><code>client.users.directoryEntries.<a href="/src/api/resources/users/resources/directoryEntries/client/Client.ts">listV1</a>() -> Chrt.
|
|
15932
|
+
<details><summary><code>client.users.directoryEntries.<a href="/src/api/resources/users/resources/directoryEntries/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DirectoryEntryListRes</code></summary>
|
|
15825
15933
|
<dl>
|
|
15826
15934
|
<dd>
|
|
15827
15935
|
|
|
@@ -15833,7 +15941,7 @@ await client.users.directoryEntries.getV1("directory_entry_id");
|
|
|
15833
15941
|
<dl>
|
|
15834
15942
|
<dd>
|
|
15835
15943
|
|
|
15836
|
-
Lists
|
|
15944
|
+
Lists directory entries with pagination and optional full-text search. | authz: min_org_role=operator | () -> (DirectoryEntryListRes)
|
|
15837
15945
|
|
|
15838
15946
|
</dd>
|
|
15839
15947
|
</dl>
|
|
@@ -15849,7 +15957,13 @@ Lists all directory entries created by the caller's organization. | authz: min_o
|
|
|
15849
15957
|
<dd>
|
|
15850
15958
|
|
|
15851
15959
|
```typescript
|
|
15852
|
-
await client.users.directoryEntries.listV1(
|
|
15960
|
+
await client.users.directoryEntries.listV1({
|
|
15961
|
+
search: "search",
|
|
15962
|
+
sort_by: "company_name",
|
|
15963
|
+
sort_order: "asc",
|
|
15964
|
+
page: 1,
|
|
15965
|
+
page_size: 1,
|
|
15966
|
+
});
|
|
15853
15967
|
```
|
|
15854
15968
|
|
|
15855
15969
|
</dd>
|
|
@@ -15865,6 +15979,14 @@ await client.users.directoryEntries.listV1();
|
|
|
15865
15979
|
<dl>
|
|
15866
15980
|
<dd>
|
|
15867
15981
|
|
|
15982
|
+
**request:** `Chrt.users.DirectoryEntriesListV1Request`
|
|
15983
|
+
|
|
15984
|
+
</dd>
|
|
15985
|
+
</dl>
|
|
15986
|
+
|
|
15987
|
+
<dl>
|
|
15988
|
+
<dd>
|
|
15989
|
+
|
|
15868
15990
|
**requestOptions:** `DirectoryEntries.RequestOptions`
|
|
15869
15991
|
|
|
15870
15992
|
</dd>
|