@chrt-inc/typescript-sdk 1.762.0 → 1.787.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/README.md +13 -10
- package/dist/cjs/Client.d.ts +3 -0
- package/dist/cjs/Client.js +31 -26
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.d.ts +35 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.js +133 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/requests/SharedTaskGroupMileageCreateForProviderPayDriverClientReq.d.ts +23 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/requests/SharedTaskGroupMileageCreateForProviderPayProviderClientReq.d.ts +24 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/flights/client/Client.d.ts +52 -0
- package/dist/cjs/api/resources/flights/client/Client.js +135 -0
- package/dist/cjs/api/resources/flights/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/flights/client/index.js +17 -0
- package/dist/cjs/api/resources/flights/client/requests/FlightConnectionsSearchReq.d.ts +45 -0
- package/dist/cjs/api/resources/flights/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/flights/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/flights/index.d.ts +1 -0
- package/dist/cjs/api/resources/flights/index.js +17 -0
- package/dist/cjs/api/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.js +3 -1
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/Client.d.ts +36 -2
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/Client.js +138 -1
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/requests/AdHocListBySessionIdV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/Client.d.ts +47 -10
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/Client.js +149 -17
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListClientCreate1.d.ts +1 -1
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListReorderEntries1.d.ts +1 -1
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.d.ts +19 -1
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.js +71 -1
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksBulkUpdateDeadlinesReq1.d.ts +16 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.js +11 -3
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversListV1Request.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.ts +4 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddTaskGroupReq.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientCreate1.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientUpdate1.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.d.ts +30 -25
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.js +55 -52
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientCreate1.d.ts +3 -2
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientUpdate1.d.ts +4 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionSetFlightInfoReq1.d.ts +24 -0
- package/dist/{esm/api/resources/tracking/resources/sessions/client/requests/SessionsSyncFlightStatusV1Request.d.mts → cjs/api/resources/tracking/resources/sessions/client/requests/SessionsFlightLegsV1Request.d.ts} +1 -1
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsFlightTrackV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.d.ts +0 -3
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/index.d.ts +3 -3
- package/dist/cjs/api/types/AlertCallback.d.ts +7 -0
- package/dist/cjs/api/types/AlertCallback.js +5 -0
- package/dist/cjs/api/types/AlertEvent.d.ts +6 -0
- package/dist/cjs/api/types/AlertEvent.js +5 -0
- package/dist/cjs/api/types/AlertMessage.d.ts +10 -0
- package/dist/cjs/api/types/AlertMessage.js +5 -0
- package/dist/cjs/api/types/AlertNameValue.d.ts +7 -0
- package/dist/cjs/api/types/AlertNameValue.js +5 -0
- package/dist/cjs/api/types/AlertNameValues.d.ts +7 -0
- package/dist/cjs/api/types/AlertNameValues.js +5 -0
- package/dist/cjs/api/types/AlertRuleEnvelope.d.ts +7 -0
- package/dist/cjs/api/types/AlertRuleEnvelope.js +5 -0
- package/dist/cjs/api/types/CiriumAirportResources.d.ts +9 -0
- package/dist/cjs/api/types/CiriumAirportResources.js +5 -0
- package/dist/cjs/api/types/CiriumDate.d.ts +6 -0
- package/dist/cjs/api/types/CiriumDate.js +5 -0
- package/dist/cjs/api/types/{FlightAwareWebhookResponse.d.ts → CiriumFlightAlertsWebhookResponse.d.ts} +1 -1
- package/dist/cjs/api/types/CiriumFlightAlertsWebhookResponse.js +5 -0
- package/dist/cjs/api/types/CiriumFlightStatus.d.ts +15 -0
- package/dist/cjs/api/types/CiriumFlightStatus.js +5 -0
- package/dist/cjs/api/types/CiriumOperationalTimes.d.ts +17 -0
- package/dist/cjs/api/types/CiriumOperationalTimes.js +5 -0
- package/dist/cjs/api/types/ConnectionSearchByEnum.d.ts +8 -0
- package/dist/cjs/api/types/ConnectionSearchByEnum.js +10 -0
- package/dist/cjs/api/types/ConnectionSearchPreferenceEnum.d.ts +8 -0
- package/dist/cjs/api/types/ConnectionSearchPreferenceEnum.js +10 -0
- package/dist/cjs/api/types/Driver1.d.ts +0 -1
- package/dist/cjs/api/types/DriverListRes.d.ts +1 -1
- package/dist/cjs/api/types/DriverWithActiveTaskGroupIds1.d.ts +35 -0
- package/dist/cjs/api/types/DriverWithActiveTaskGroupIds1.js +5 -0
- package/dist/cjs/api/types/FlightConnection.d.ts +10 -0
- package/dist/cjs/api/types/FlightConnection.js +5 -0
- package/dist/cjs/api/types/FlightConnectionLeg.d.ts +22 -0
- package/dist/cjs/api/types/FlightConnectionLeg.js +5 -0
- package/dist/cjs/api/types/FlightConnectionsSearchRes.d.ts +7 -0
- package/dist/cjs/api/types/FlightConnectionsSearchRes.js +5 -0
- package/dist/cjs/api/types/FlightLeg1.d.ts +3 -2
- package/dist/cjs/api/types/LineItem1.d.ts +1 -0
- package/dist/cjs/api/types/NotificationEventsForAdHocEnum.d.ts +4 -3
- package/dist/cjs/api/types/NotificationEventsForAdHocEnum.js +1 -0
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.d.ts +2 -1
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.js +1 -0
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.d.ts +2 -1
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.js +1 -0
- package/dist/cjs/api/types/NotificationIntentAdHoc1.d.ts +2 -1
- package/dist/cjs/api/{resources/notifications/resources/adHoc/client/requests → types}/NotificationIntentAdHocClientCreate1.d.ts +1 -8
- package/dist/cjs/api/types/NotificationIntentAdHocClientCreate1.js +5 -0
- package/dist/cjs/api/types/OnboardCourierTaskActionEnum1.d.ts +1 -11
- package/dist/cjs/api/types/OnboardCourierTaskActionEnum1.js +0 -10
- package/dist/cjs/api/types/OperationsTaskDeadlineUpdate1.d.ts +7 -0
- package/dist/cjs/api/types/OperationsTaskDeadlineUpdate1.js +5 -0
- package/dist/cjs/api/types/OperationsTaskListEntry1.d.ts +4 -12
- package/dist/cjs/api/types/OperationsTaskListEntryClientCreate1.d.ts +15 -0
- package/dist/cjs/api/types/OperationsTaskListEntryClientCreate1.js +5 -0
- package/dist/cjs/api/types/OperationsTaskListRemoveFromCaseRes1.d.ts +1 -1
- package/dist/cjs/api/types/OperationsTaskStatusEnum.d.ts +2 -1
- package/dist/cjs/api/types/OperationsTaskStatusEnum.js +1 -0
- package/dist/cjs/api/types/OperationsTasksBulkUpdateDeadlinesRes1.d.ts +7 -0
- package/dist/cjs/api/types/OperationsTasksBulkUpdateDeadlinesRes1.js +5 -0
- package/dist/cjs/api/types/OrderBuilderReq.d.ts +2 -0
- package/dist/cjs/api/types/OrderDraftValidationRequirements.d.ts +1 -0
- package/dist/cjs/api/types/OrderManifestValidationRequirements.d.ts +1 -0
- package/dist/cjs/api/types/OrderTemplate1.d.ts +1 -0
- package/dist/cjs/api/types/OrderTemplateCore1.d.ts +1 -0
- package/dist/cjs/api/types/OrgMembersAndDrivers.d.ts +1 -1
- package/dist/cjs/api/types/Session1.d.ts +6 -6
- package/dist/cjs/api/types/TaskGroup1.d.ts +1 -0
- package/dist/cjs/api/types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.d.ts +10 -0
- package/dist/cjs/api/types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.js +5 -0
- package/dist/cjs/api/types/index.d.ts +22 -4
- package/dist/cjs/api/types/index.js +22 -4
- 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/billing/resources/lineItemGroups/client/Client.d.mts +35 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.mjs +133 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/requests/SharedTaskGroupMileageCreateForProviderPayDriverClientReq.d.mts +23 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/requests/SharedTaskGroupMileageCreateForProviderPayProviderClientReq.d.mts +24 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/flights/client/Client.d.mts +52 -0
- package/dist/esm/api/resources/flights/client/Client.mjs +98 -0
- package/dist/esm/api/resources/flights/client/index.d.mts +2 -0
- package/dist/esm/api/resources/flights/client/index.mjs +1 -0
- package/dist/esm/api/resources/flights/client/requests/FlightConnectionsSearchReq.d.mts +45 -0
- package/dist/esm/api/resources/flights/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/flights/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/flights/index.d.mts +1 -0
- package/dist/esm/api/resources/flights/index.mjs +1 -0
- package/dist/esm/api/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/index.mjs +2 -0
- package/dist/esm/api/resources/notifications/resources/adHoc/client/Client.d.mts +36 -2
- package/dist/esm/api/resources/notifications/resources/adHoc/client/Client.mjs +138 -1
- package/dist/esm/api/resources/notifications/resources/adHoc/client/requests/AdHocListBySessionIdV1Request.d.mts +14 -0
- package/dist/esm/api/resources/notifications/resources/adHoc/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/Client.d.mts +47 -10
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/Client.mjs +149 -17
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListClientCreate1.d.mts +1 -1
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListReorderEntries1.d.mts +1 -1
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.d.mts +19 -1
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.mjs +71 -1
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksBulkUpdateDeadlinesReq1.d.mts +16 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs +11 -3
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversListV1Request.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.mts +4 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddTaskGroupReq.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientCreate1.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientUpdate1.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.d.mts +30 -25
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.mjs +55 -52
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionClientCreate1.d.mts +3 -2
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionClientUpdate1.d.mts +4 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionSetFlightInfoReq1.d.mts +24 -0
- package/dist/{cjs/api/resources/tracking/resources/sessions/client/requests/SessionsSyncFlightStatusV1Request.d.ts → esm/api/resources/tracking/resources/sessions/client/requests/SessionsFlightLegsV1Request.d.mts} +1 -1
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsFlightTrackV1Request.d.mts +14 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.d.mts +0 -3
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/index.d.mts +3 -3
- package/dist/esm/api/types/AlertCallback.d.mts +7 -0
- package/dist/esm/api/types/AlertCallback.mjs +4 -0
- package/dist/esm/api/types/AlertEvent.d.mts +6 -0
- package/dist/esm/api/types/AlertEvent.mjs +4 -0
- package/dist/esm/api/types/AlertMessage.d.mts +10 -0
- package/dist/esm/api/types/AlertMessage.mjs +4 -0
- package/dist/esm/api/types/AlertNameValue.d.mts +7 -0
- package/dist/esm/api/types/AlertNameValue.mjs +4 -0
- package/dist/esm/api/types/AlertNameValues.d.mts +7 -0
- package/dist/esm/api/types/AlertNameValues.mjs +4 -0
- package/dist/esm/api/types/AlertRuleEnvelope.d.mts +7 -0
- package/dist/esm/api/types/AlertRuleEnvelope.mjs +4 -0
- package/dist/esm/api/types/CiriumAirportResources.d.mts +9 -0
- package/dist/esm/api/types/CiriumAirportResources.mjs +4 -0
- package/dist/esm/api/types/CiriumDate.d.mts +6 -0
- package/dist/esm/api/types/CiriumDate.mjs +4 -0
- package/dist/esm/api/types/{FlightAwareWebhookResponse.d.mts → CiriumFlightAlertsWebhookResponse.d.mts} +1 -1
- package/dist/esm/api/types/CiriumFlightAlertsWebhookResponse.mjs +4 -0
- package/dist/esm/api/types/CiriumFlightStatus.d.mts +15 -0
- package/dist/esm/api/types/CiriumFlightStatus.mjs +4 -0
- package/dist/esm/api/types/CiriumOperationalTimes.d.mts +17 -0
- package/dist/esm/api/types/CiriumOperationalTimes.mjs +4 -0
- package/dist/esm/api/types/ConnectionSearchByEnum.d.mts +8 -0
- package/dist/esm/api/types/ConnectionSearchByEnum.mjs +7 -0
- package/dist/esm/api/types/ConnectionSearchPreferenceEnum.d.mts +8 -0
- package/dist/esm/api/types/ConnectionSearchPreferenceEnum.mjs +7 -0
- package/dist/esm/api/types/Driver1.d.mts +0 -1
- package/dist/esm/api/types/DriverListRes.d.mts +1 -1
- package/dist/esm/api/types/DriverWithActiveTaskGroupIds1.d.mts +35 -0
- package/dist/esm/api/types/DriverWithActiveTaskGroupIds1.mjs +4 -0
- package/dist/esm/api/types/FlightConnection.d.mts +10 -0
- package/dist/esm/api/types/FlightConnection.mjs +4 -0
- package/dist/esm/api/types/FlightConnectionLeg.d.mts +22 -0
- package/dist/esm/api/types/FlightConnectionLeg.mjs +4 -0
- package/dist/esm/api/types/FlightConnectionsSearchRes.d.mts +7 -0
- package/dist/esm/api/types/FlightConnectionsSearchRes.mjs +4 -0
- package/dist/esm/api/types/FlightLeg1.d.mts +3 -2
- package/dist/esm/api/types/LineItem1.d.mts +1 -0
- package/dist/esm/api/types/NotificationEventsForAdHocEnum.d.mts +4 -3
- package/dist/esm/api/types/NotificationEventsForAdHocEnum.mjs +1 -0
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.d.mts +2 -1
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.mjs +1 -0
- package/dist/esm/api/types/NotificationEventsForUsersEnum.d.mts +2 -1
- package/dist/esm/api/types/NotificationEventsForUsersEnum.mjs +1 -0
- package/dist/esm/api/types/NotificationIntentAdHoc1.d.mts +2 -1
- package/dist/esm/api/{resources/notifications/resources/adHoc/client/requests → types}/NotificationIntentAdHocClientCreate1.d.mts +1 -8
- package/dist/esm/api/types/NotificationIntentAdHocClientCreate1.mjs +4 -0
- package/dist/esm/api/types/OnboardCourierTaskActionEnum1.d.mts +1 -11
- package/dist/esm/api/types/OnboardCourierTaskActionEnum1.mjs +0 -10
- package/dist/esm/api/types/OperationsTaskDeadlineUpdate1.d.mts +7 -0
- package/dist/esm/api/types/OperationsTaskDeadlineUpdate1.mjs +4 -0
- package/dist/esm/api/types/OperationsTaskListEntry1.d.mts +4 -12
- package/dist/esm/api/types/OperationsTaskListEntryClientCreate1.d.mts +15 -0
- package/dist/esm/api/types/OperationsTaskListEntryClientCreate1.mjs +4 -0
- package/dist/esm/api/types/OperationsTaskListRemoveFromCaseRes1.d.mts +1 -1
- package/dist/esm/api/types/OperationsTaskStatusEnum.d.mts +2 -1
- package/dist/esm/api/types/OperationsTaskStatusEnum.mjs +1 -0
- package/dist/esm/api/types/OperationsTasksBulkUpdateDeadlinesRes1.d.mts +7 -0
- package/dist/esm/api/types/OperationsTasksBulkUpdateDeadlinesRes1.mjs +4 -0
- package/dist/esm/api/types/OrderBuilderReq.d.mts +2 -0
- package/dist/esm/api/types/OrderDraftValidationRequirements.d.mts +1 -0
- package/dist/esm/api/types/OrderManifestValidationRequirements.d.mts +1 -0
- package/dist/esm/api/types/OrderTemplate1.d.mts +1 -0
- package/dist/esm/api/types/OrderTemplateCore1.d.mts +1 -0
- package/dist/esm/api/types/OrgMembersAndDrivers.d.mts +1 -1
- package/dist/esm/api/types/Session1.d.mts +6 -6
- package/dist/esm/api/types/TaskGroup1.d.mts +1 -0
- package/dist/esm/api/types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.d.mts +10 -0
- package/dist/esm/api/types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +22 -4
- package/dist/esm/api/types/index.mjs +22 -4
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +639 -51
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListSetEntries1.d.ts +0 -11
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionAddFlightReq1.d.ts +0 -16
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionRemoveFlightReq1.d.ts +0 -16
- package/dist/cjs/api/types/FlightAwareAlertFlight.d.ts +0 -16
- package/dist/cjs/api/types/FlightAwareAlertPayload.d.ts +0 -17
- package/dist/cjs/api/types/FlightStatusEnum.d.ts +0 -14
- package/dist/cjs/api/types/FlightStatusEnum.js +0 -16
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListSetEntries1.d.mts +0 -11
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionAddFlightReq1.d.mts +0 -16
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionRemoveFlightReq1.d.mts +0 -16
- package/dist/esm/api/types/FlightAwareAlertFlight.d.mts +0 -16
- package/dist/esm/api/types/FlightAwareAlertPayload.d.mts +0 -17
- package/dist/esm/api/types/FlightStatusEnum.d.mts +0 -14
- package/dist/esm/api/types/FlightStatusEnum.mjs +0 -13
- /package/dist/cjs/api/resources/{notifications/resources/adHoc/client/requests/NotificationIntentAdHocClientCreate1.js → billing/resources/lineItemGroups/client/requests/SharedTaskGroupMileageCreateForProviderPayDriverClientReq.js} +0 -0
- /package/dist/cjs/api/resources/{operations/resources/operationsTaskLists/client/requests/OperationsTaskListSetEntries1.js → billing/resources/lineItemGroups/client/requests/SharedTaskGroupMileageCreateForProviderPayProviderClientReq.js} +0 -0
- /package/dist/cjs/api/resources/{tracking/resources/sessions/client/requests/SessionAddFlightReq1.js → flights/client/requests/FlightConnectionsSearchReq.js} +0 -0
- /package/dist/cjs/api/resources/{tracking/resources/sessions/client/requests/SessionRemoveFlightReq1.js → notifications/resources/adHoc/client/requests/AdHocListBySessionIdV1Request.js} +0 -0
- /package/dist/cjs/api/resources/{tracking/resources/sessions/client/requests/SessionsSyncFlightStatusV1Request.js → operations/resources/operationsTasks/client/requests/OperationsTasksBulkUpdateDeadlinesReq1.js} +0 -0
- /package/dist/cjs/api/{types/FlightAwareAlertFlight.js → resources/tracking/resources/sessions/client/requests/SessionSetFlightInfoReq1.js} +0 -0
- /package/dist/cjs/api/{types/FlightAwareAlertPayload.js → resources/tracking/resources/sessions/client/requests/SessionsFlightLegsV1Request.js} +0 -0
- /package/dist/cjs/api/{types/FlightAwareWebhookResponse.js → resources/tracking/resources/sessions/client/requests/SessionsFlightTrackV1Request.js} +0 -0
- /package/dist/esm/api/resources/{notifications/resources/adHoc/client/requests/NotificationIntentAdHocClientCreate1.mjs → billing/resources/lineItemGroups/client/requests/SharedTaskGroupMileageCreateForProviderPayDriverClientReq.mjs} +0 -0
- /package/dist/esm/api/resources/{operations/resources/operationsTaskLists/client/requests/OperationsTaskListSetEntries1.mjs → billing/resources/lineItemGroups/client/requests/SharedTaskGroupMileageCreateForProviderPayProviderClientReq.mjs} +0 -0
- /package/dist/esm/api/resources/{tracking/resources/sessions/client/requests/SessionAddFlightReq1.mjs → flights/client/requests/FlightConnectionsSearchReq.mjs} +0 -0
- /package/dist/esm/api/resources/{tracking/resources/sessions/client/requests/SessionRemoveFlightReq1.mjs → notifications/resources/adHoc/client/requests/AdHocListBySessionIdV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/{tracking/resources/sessions/client/requests/SessionsSyncFlightStatusV1Request.mjs → operations/resources/operationsTasks/client/requests/OperationsTasksBulkUpdateDeadlinesReq1.mjs} +0 -0
- /package/dist/esm/api/{types/FlightAwareAlertFlight.mjs → resources/tracking/resources/sessions/client/requests/SessionSetFlightInfoReq1.mjs} +0 -0
- /package/dist/esm/api/{types/FlightAwareAlertPayload.mjs → resources/tracking/resources/sessions/client/requests/SessionsFlightLegsV1Request.mjs} +0 -0
- /package/dist/esm/api/{types/FlightAwareWebhookResponse.mjs → resources/tracking/resources/sessions/client/requests/SessionsFlightTrackV1Request.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -1,5 +1,75 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
+
## Flights
|
|
4
|
+
|
|
5
|
+
<details><summary><code>client.flights.<a href="/src/api/resources/flights/client/Client.ts">searchConnectionsV1</a>({ ...params }) -> Chrt.FlightConnectionsSearchRes</code></summary>
|
|
6
|
+
<dl>
|
|
7
|
+
<dd>
|
|
8
|
+
|
|
9
|
+
#### 📝 Description
|
|
10
|
+
|
|
11
|
+
<dl>
|
|
12
|
+
<dd>
|
|
13
|
+
|
|
14
|
+
<dl>
|
|
15
|
+
<dd>
|
|
16
|
+
|
|
17
|
+
Searches Cirium for cargo flight connections between two airports, anchored on a departure or arrival time. | (FlightConnectionsSearchReq) -> (FlightConnectionsSearchRes)
|
|
18
|
+
|
|
19
|
+
</dd>
|
|
20
|
+
</dl>
|
|
21
|
+
</dd>
|
|
22
|
+
</dl>
|
|
23
|
+
|
|
24
|
+
#### 🔌 Usage
|
|
25
|
+
|
|
26
|
+
<dl>
|
|
27
|
+
<dd>
|
|
28
|
+
|
|
29
|
+
<dl>
|
|
30
|
+
<dd>
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
await client.flights.searchConnectionsV1({
|
|
34
|
+
origin: "origin",
|
|
35
|
+
destination: "destination",
|
|
36
|
+
search_by: "departure_time",
|
|
37
|
+
local_date_time: "2024-01-15T09:30:00Z",
|
|
38
|
+
});
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
</dd>
|
|
42
|
+
</dl>
|
|
43
|
+
</dd>
|
|
44
|
+
</dl>
|
|
45
|
+
|
|
46
|
+
#### ⚙️ Parameters
|
|
47
|
+
|
|
48
|
+
<dl>
|
|
49
|
+
<dd>
|
|
50
|
+
|
|
51
|
+
<dl>
|
|
52
|
+
<dd>
|
|
53
|
+
|
|
54
|
+
**request:** `Chrt.FlightConnectionsSearchReq`
|
|
55
|
+
|
|
56
|
+
</dd>
|
|
57
|
+
</dl>
|
|
58
|
+
|
|
59
|
+
<dl>
|
|
60
|
+
<dd>
|
|
61
|
+
|
|
62
|
+
**requestOptions:** `Flights.RequestOptions`
|
|
63
|
+
|
|
64
|
+
</dd>
|
|
65
|
+
</dl>
|
|
66
|
+
</dd>
|
|
67
|
+
</dl>
|
|
68
|
+
|
|
69
|
+
</dd>
|
|
70
|
+
</dl>
|
|
71
|
+
</details>
|
|
72
|
+
|
|
3
73
|
## Orgs
|
|
4
74
|
|
|
5
75
|
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getInfoV1</a>() -> Chrt.OrgInfoResponse</code></summary>
|
|
@@ -2090,6 +2160,141 @@ await client.billing.lineItemGroups.fromRateSheetCreateForProviderPayDriverV1({
|
|
|
2090
2160
|
</dl>
|
|
2091
2161
|
</details>
|
|
2092
2162
|
|
|
2163
|
+
<details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">sharedTaskGroupMileageCreateV1</a>({ ...params }) -> Chrt.LineItemGroup1</code></summary>
|
|
2164
|
+
<dl>
|
|
2165
|
+
<dd>
|
|
2166
|
+
|
|
2167
|
+
#### 📝 Description
|
|
2168
|
+
|
|
2169
|
+
<dl>
|
|
2170
|
+
<dd>
|
|
2171
|
+
|
|
2172
|
+
<dl>
|
|
2173
|
+
<dd>
|
|
2174
|
+
|
|
2175
|
+
Prices a single driver's combined trip across several task groups once. Recomputes route mileage from the ordered task locations (plus optional start/end legs), applies the CHRT-ground rate sheet, and atomically creates an OrderGroup-anchored LineItemGroup, its mileage LineItems, and the LineItemCalculation that records how the charges were derived. The LIG is detached on create (task_group_id is None) — attach to a Statement afterwards. | authz: allowed_org_types=[provider], min_org_role=operator | (SharedTaskGroupMileageCreateForProviderPayDriverClientReq) -> (LineItemGroup1)
|
|
2176
|
+
|
|
2177
|
+
</dd>
|
|
2178
|
+
</dl>
|
|
2179
|
+
</dd>
|
|
2180
|
+
</dl>
|
|
2181
|
+
|
|
2182
|
+
#### 🔌 Usage
|
|
2183
|
+
|
|
2184
|
+
<dl>
|
|
2185
|
+
<dd>
|
|
2186
|
+
|
|
2187
|
+
<dl>
|
|
2188
|
+
<dd>
|
|
2189
|
+
|
|
2190
|
+
```typescript
|
|
2191
|
+
await client.billing.lineItemGroups.sharedTaskGroupMileageCreateV1({
|
|
2192
|
+
order_group_id: "order_group_id",
|
|
2193
|
+
rate_sheet_id: "rate_sheet_id",
|
|
2194
|
+
payment_destination_driver_id: "payment_destination_driver_id",
|
|
2195
|
+
task_ids: ["task_ids"],
|
|
2196
|
+
});
|
|
2197
|
+
```
|
|
2198
|
+
|
|
2199
|
+
</dd>
|
|
2200
|
+
</dl>
|
|
2201
|
+
</dd>
|
|
2202
|
+
</dl>
|
|
2203
|
+
|
|
2204
|
+
#### ⚙️ Parameters
|
|
2205
|
+
|
|
2206
|
+
<dl>
|
|
2207
|
+
<dd>
|
|
2208
|
+
|
|
2209
|
+
<dl>
|
|
2210
|
+
<dd>
|
|
2211
|
+
|
|
2212
|
+
**request:** `Chrt.billing.SharedTaskGroupMileageCreateForProviderPayDriverClientReq`
|
|
2213
|
+
|
|
2214
|
+
</dd>
|
|
2215
|
+
</dl>
|
|
2216
|
+
|
|
2217
|
+
<dl>
|
|
2218
|
+
<dd>
|
|
2219
|
+
|
|
2220
|
+
**requestOptions:** `LineItemGroups.RequestOptions`
|
|
2221
|
+
|
|
2222
|
+
</dd>
|
|
2223
|
+
</dl>
|
|
2224
|
+
</dd>
|
|
2225
|
+
</dl>
|
|
2226
|
+
|
|
2227
|
+
</dd>
|
|
2228
|
+
</dl>
|
|
2229
|
+
</details>
|
|
2230
|
+
|
|
2231
|
+
<details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">sharedTaskGroupMileageCreateForProviderPayProviderV1</a>({ ...params }) -> Chrt.LineItemGroup1</code></summary>
|
|
2232
|
+
<dl>
|
|
2233
|
+
<dd>
|
|
2234
|
+
|
|
2235
|
+
#### 📝 Description
|
|
2236
|
+
|
|
2237
|
+
<dl>
|
|
2238
|
+
<dd>
|
|
2239
|
+
|
|
2240
|
+
<dl>
|
|
2241
|
+
<dd>
|
|
2242
|
+
|
|
2243
|
+
Prices a single agent's combined trip across several task groups once, on the provider_pay_provider vector — a coordinator paying the executor (commonly an off-chrt agent) that ran the route. Recomputes route mileage from the ordered task locations (plus optional start/end legs), applies the CHRT-ground rate sheet, and atomically creates an OrderGroup-anchored LineItemGroup, its mileage LineItems, and the LineItemCalculation that records how the charges were derived. The LIG is detached on create (task_group_id is None) — attach to a Statement afterwards. | authz: allowed_org_types=[provider], min_org_role=operator | (SharedTaskGroupMileageCreateForProviderPayProviderClientReq) -> (LineItemGroup1)
|
|
2244
|
+
|
|
2245
|
+
</dd>
|
|
2246
|
+
</dl>
|
|
2247
|
+
</dd>
|
|
2248
|
+
</dl>
|
|
2249
|
+
|
|
2250
|
+
#### 🔌 Usage
|
|
2251
|
+
|
|
2252
|
+
<dl>
|
|
2253
|
+
<dd>
|
|
2254
|
+
|
|
2255
|
+
<dl>
|
|
2256
|
+
<dd>
|
|
2257
|
+
|
|
2258
|
+
```typescript
|
|
2259
|
+
await client.billing.lineItemGroups.sharedTaskGroupMileageCreateForProviderPayProviderV1({
|
|
2260
|
+
order_group_id: "order_group_id",
|
|
2261
|
+
rate_sheet_id: "rate_sheet_id",
|
|
2262
|
+
task_ids: ["task_ids"],
|
|
2263
|
+
});
|
|
2264
|
+
```
|
|
2265
|
+
|
|
2266
|
+
</dd>
|
|
2267
|
+
</dl>
|
|
2268
|
+
</dd>
|
|
2269
|
+
</dl>
|
|
2270
|
+
|
|
2271
|
+
#### ⚙️ Parameters
|
|
2272
|
+
|
|
2273
|
+
<dl>
|
|
2274
|
+
<dd>
|
|
2275
|
+
|
|
2276
|
+
<dl>
|
|
2277
|
+
<dd>
|
|
2278
|
+
|
|
2279
|
+
**request:** `Chrt.billing.SharedTaskGroupMileageCreateForProviderPayProviderClientReq`
|
|
2280
|
+
|
|
2281
|
+
</dd>
|
|
2282
|
+
</dl>
|
|
2283
|
+
|
|
2284
|
+
<dl>
|
|
2285
|
+
<dd>
|
|
2286
|
+
|
|
2287
|
+
**requestOptions:** `LineItemGroups.RequestOptions`
|
|
2288
|
+
|
|
2289
|
+
</dd>
|
|
2290
|
+
</dl>
|
|
2291
|
+
</dd>
|
|
2292
|
+
</dl>
|
|
2293
|
+
|
|
2294
|
+
</dd>
|
|
2295
|
+
</dl>
|
|
2296
|
+
</details>
|
|
2297
|
+
|
|
2093
2298
|
## Billing ChrtGroundProviderRateSheets
|
|
2094
2299
|
|
|
2095
2300
|
<details><summary><code>client.billing.chrtGroundProviderRateSheets.<a href="/src/api/resources/billing/resources/chrtGroundProviderRateSheets/client/Client.ts">getByIdV1</a>(id) -> Chrt.ChrtGroundProviderRateSheet1</code></summary>
|
|
@@ -9455,7 +9660,146 @@ await client.listing.bidThreads.withdrawV1("bid_thread_id", {});
|
|
|
9455
9660
|
</dl>
|
|
9456
9661
|
</details>
|
|
9457
9662
|
|
|
9458
|
-
<details><summary><code>client.listing.bidThreads.<a href="/src/api/resources/listing/resources/bidThreads/client/Client.ts">confirmAcceptV1</a>(bidThreadId) -> boolean</code></summary>
|
|
9663
|
+
<details><summary><code>client.listing.bidThreads.<a href="/src/api/resources/listing/resources/bidThreads/client/Client.ts">confirmAcceptV1</a>(bidThreadId) -> boolean</code></summary>
|
|
9664
|
+
<dl>
|
|
9665
|
+
<dd>
|
|
9666
|
+
|
|
9667
|
+
#### 📝 Description
|
|
9668
|
+
|
|
9669
|
+
<dl>
|
|
9670
|
+
<dd>
|
|
9671
|
+
|
|
9672
|
+
<dl>
|
|
9673
|
+
<dd>
|
|
9674
|
+
|
|
9675
|
+
Lister confirmation of a bidder's ACCEPT on this thread, used when `listing.auto_award_first_accept == False`. Runs the full award cascade: thread ACCEPTED, listing AWARDED, sibling threads / listings cancelled, shipping + billing side-effects. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (bool)
|
|
9676
|
+
|
|
9677
|
+
</dd>
|
|
9678
|
+
</dl>
|
|
9679
|
+
</dd>
|
|
9680
|
+
</dl>
|
|
9681
|
+
|
|
9682
|
+
#### 🔌 Usage
|
|
9683
|
+
|
|
9684
|
+
<dl>
|
|
9685
|
+
<dd>
|
|
9686
|
+
|
|
9687
|
+
<dl>
|
|
9688
|
+
<dd>
|
|
9689
|
+
|
|
9690
|
+
```typescript
|
|
9691
|
+
await client.listing.bidThreads.confirmAcceptV1("bid_thread_id");
|
|
9692
|
+
```
|
|
9693
|
+
|
|
9694
|
+
</dd>
|
|
9695
|
+
</dl>
|
|
9696
|
+
</dd>
|
|
9697
|
+
</dl>
|
|
9698
|
+
|
|
9699
|
+
#### ⚙️ Parameters
|
|
9700
|
+
|
|
9701
|
+
<dl>
|
|
9702
|
+
<dd>
|
|
9703
|
+
|
|
9704
|
+
<dl>
|
|
9705
|
+
<dd>
|
|
9706
|
+
|
|
9707
|
+
**bidThreadId:** `string`
|
|
9708
|
+
|
|
9709
|
+
</dd>
|
|
9710
|
+
</dl>
|
|
9711
|
+
|
|
9712
|
+
<dl>
|
|
9713
|
+
<dd>
|
|
9714
|
+
|
|
9715
|
+
**requestOptions:** `BidThreads.RequestOptions`
|
|
9716
|
+
|
|
9717
|
+
</dd>
|
|
9718
|
+
</dl>
|
|
9719
|
+
</dd>
|
|
9720
|
+
</dl>
|
|
9721
|
+
|
|
9722
|
+
</dd>
|
|
9723
|
+
</dl>
|
|
9724
|
+
</details>
|
|
9725
|
+
|
|
9726
|
+
## Notifications AdHoc
|
|
9727
|
+
|
|
9728
|
+
<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>
|
|
9729
|
+
<dl>
|
|
9730
|
+
<dd>
|
|
9731
|
+
|
|
9732
|
+
#### 📝 Description
|
|
9733
|
+
|
|
9734
|
+
<dl>
|
|
9735
|
+
<dd>
|
|
9736
|
+
|
|
9737
|
+
<dl>
|
|
9738
|
+
<dd>
|
|
9739
|
+
|
|
9740
|
+
Lists all ad-hoc notification intents for an order. | authz: min_org_role=operator | () -> (NotificationAdHocListRes)
|
|
9741
|
+
|
|
9742
|
+
</dd>
|
|
9743
|
+
</dl>
|
|
9744
|
+
</dd>
|
|
9745
|
+
</dl>
|
|
9746
|
+
|
|
9747
|
+
#### 🔌 Usage
|
|
9748
|
+
|
|
9749
|
+
<dl>
|
|
9750
|
+
<dd>
|
|
9751
|
+
|
|
9752
|
+
<dl>
|
|
9753
|
+
<dd>
|
|
9754
|
+
|
|
9755
|
+
```typescript
|
|
9756
|
+
await client.notifications.adHoc.listByOrderIdV1("order_id", {
|
|
9757
|
+
page: 1,
|
|
9758
|
+
page_size: 1,
|
|
9759
|
+
});
|
|
9760
|
+
```
|
|
9761
|
+
|
|
9762
|
+
</dd>
|
|
9763
|
+
</dl>
|
|
9764
|
+
</dd>
|
|
9765
|
+
</dl>
|
|
9766
|
+
|
|
9767
|
+
#### ⚙️ Parameters
|
|
9768
|
+
|
|
9769
|
+
<dl>
|
|
9770
|
+
<dd>
|
|
9771
|
+
|
|
9772
|
+
<dl>
|
|
9773
|
+
<dd>
|
|
9774
|
+
|
|
9775
|
+
**orderId:** `string`
|
|
9776
|
+
|
|
9777
|
+
</dd>
|
|
9778
|
+
</dl>
|
|
9779
|
+
|
|
9780
|
+
<dl>
|
|
9781
|
+
<dd>
|
|
9782
|
+
|
|
9783
|
+
**request:** `Chrt.notifications.AdHocListByOrderIdV1Request`
|
|
9784
|
+
|
|
9785
|
+
</dd>
|
|
9786
|
+
</dl>
|
|
9787
|
+
|
|
9788
|
+
<dl>
|
|
9789
|
+
<dd>
|
|
9790
|
+
|
|
9791
|
+
**requestOptions:** `AdHoc.RequestOptions`
|
|
9792
|
+
|
|
9793
|
+
</dd>
|
|
9794
|
+
</dl>
|
|
9795
|
+
</dd>
|
|
9796
|
+
</dl>
|
|
9797
|
+
|
|
9798
|
+
</dd>
|
|
9799
|
+
</dl>
|
|
9800
|
+
</details>
|
|
9801
|
+
|
|
9802
|
+
<details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">listBySessionIdV1</a>(sessionId, { ...params }) -> Chrt.NotificationAdHocListRes</code></summary>
|
|
9459
9803
|
<dl>
|
|
9460
9804
|
<dd>
|
|
9461
9805
|
|
|
@@ -9467,7 +9811,7 @@ await client.listing.bidThreads.withdrawV1("bid_thread_id", {});
|
|
|
9467
9811
|
<dl>
|
|
9468
9812
|
<dd>
|
|
9469
9813
|
|
|
9470
|
-
|
|
9814
|
+
Lists all ad-hoc notification intents for a tracking session. | authz: min_org_role=operator | () -> (NotificationAdHocListRes)
|
|
9471
9815
|
|
|
9472
9816
|
</dd>
|
|
9473
9817
|
</dl>
|
|
@@ -9483,7 +9827,10 @@ Lister confirmation of a bidder's ACCEPT on this thread, used when `listing.auto
|
|
|
9483
9827
|
<dd>
|
|
9484
9828
|
|
|
9485
9829
|
```typescript
|
|
9486
|
-
await client.
|
|
9830
|
+
await client.notifications.adHoc.listBySessionIdV1("session_id", {
|
|
9831
|
+
page: 1,
|
|
9832
|
+
page_size: 1,
|
|
9833
|
+
});
|
|
9487
9834
|
```
|
|
9488
9835
|
|
|
9489
9836
|
</dd>
|
|
@@ -9499,7 +9846,7 @@ await client.listing.bidThreads.confirmAcceptV1("bid_thread_id");
|
|
|
9499
9846
|
<dl>
|
|
9500
9847
|
<dd>
|
|
9501
9848
|
|
|
9502
|
-
**
|
|
9849
|
+
**sessionId:** `string`
|
|
9503
9850
|
|
|
9504
9851
|
</dd>
|
|
9505
9852
|
</dl>
|
|
@@ -9507,7 +9854,15 @@ await client.listing.bidThreads.confirmAcceptV1("bid_thread_id");
|
|
|
9507
9854
|
<dl>
|
|
9508
9855
|
<dd>
|
|
9509
9856
|
|
|
9510
|
-
**
|
|
9857
|
+
**request:** `Chrt.notifications.AdHocListBySessionIdV1Request`
|
|
9858
|
+
|
|
9859
|
+
</dd>
|
|
9860
|
+
</dl>
|
|
9861
|
+
|
|
9862
|
+
<dl>
|
|
9863
|
+
<dd>
|
|
9864
|
+
|
|
9865
|
+
**requestOptions:** `AdHoc.RequestOptions`
|
|
9511
9866
|
|
|
9512
9867
|
</dd>
|
|
9513
9868
|
</dl>
|
|
@@ -9518,9 +9873,7 @@ await client.listing.bidThreads.confirmAcceptV1("bid_thread_id");
|
|
|
9518
9873
|
</dl>
|
|
9519
9874
|
</details>
|
|
9520
9875
|
|
|
9521
|
-
|
|
9522
|
-
|
|
9523
|
-
<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>
|
|
9876
|
+
<details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">createV1</a>(orderId, { ...params }) -> string</code></summary>
|
|
9524
9877
|
<dl>
|
|
9525
9878
|
<dd>
|
|
9526
9879
|
|
|
@@ -9532,7 +9885,7 @@ await client.listing.bidThreads.confirmAcceptV1("bid_thread_id");
|
|
|
9532
9885
|
<dl>
|
|
9533
9886
|
<dd>
|
|
9534
9887
|
|
|
9535
|
-
|
|
9888
|
+
Creates a new ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
|
|
9536
9889
|
|
|
9537
9890
|
</dd>
|
|
9538
9891
|
</dl>
|
|
@@ -9548,9 +9901,9 @@ Lists all ad-hoc notification intents for an order. | authz: min_org_role=operat
|
|
|
9548
9901
|
<dd>
|
|
9549
9902
|
|
|
9550
9903
|
```typescript
|
|
9551
|
-
await client.notifications.adHoc.
|
|
9552
|
-
|
|
9553
|
-
|
|
9904
|
+
await client.notifications.adHoc.createV1("order_id", {
|
|
9905
|
+
schema_version: 1,
|
|
9906
|
+
directory_entry_id: "directory_entry_id",
|
|
9554
9907
|
});
|
|
9555
9908
|
```
|
|
9556
9909
|
|
|
@@ -9575,7 +9928,7 @@ await client.notifications.adHoc.listByOrderIdV1("order_id", {
|
|
|
9575
9928
|
<dl>
|
|
9576
9929
|
<dd>
|
|
9577
9930
|
|
|
9578
|
-
**request:** `Chrt.
|
|
9931
|
+
**request:** `Chrt.NotificationIntentAdHocClientCreate1`
|
|
9579
9932
|
|
|
9580
9933
|
</dd>
|
|
9581
9934
|
</dl>
|
|
@@ -9594,7 +9947,7 @@ await client.notifications.adHoc.listByOrderIdV1("order_id", {
|
|
|
9594
9947
|
</dl>
|
|
9595
9948
|
</details>
|
|
9596
9949
|
|
|
9597
|
-
<details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">
|
|
9950
|
+
<details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">createForSessionV1</a>(sessionId, { ...params }) -> string</code></summary>
|
|
9598
9951
|
<dl>
|
|
9599
9952
|
<dd>
|
|
9600
9953
|
|
|
@@ -9606,7 +9959,7 @@ await client.notifications.adHoc.listByOrderIdV1("order_id", {
|
|
|
9606
9959
|
<dl>
|
|
9607
9960
|
<dd>
|
|
9608
9961
|
|
|
9609
|
-
Creates a new ad-hoc notification intent for
|
|
9962
|
+
Creates a new ad-hoc notification intent for a tracking session. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
|
|
9610
9963
|
|
|
9611
9964
|
</dd>
|
|
9612
9965
|
</dl>
|
|
@@ -9622,7 +9975,7 @@ Creates a new ad-hoc notification intent for an order. | authz: min_org_role=ope
|
|
|
9622
9975
|
<dd>
|
|
9623
9976
|
|
|
9624
9977
|
```typescript
|
|
9625
|
-
await client.notifications.adHoc.
|
|
9978
|
+
await client.notifications.adHoc.createForSessionV1("session_id", {
|
|
9626
9979
|
schema_version: 1,
|
|
9627
9980
|
directory_entry_id: "directory_entry_id",
|
|
9628
9981
|
});
|
|
@@ -9641,7 +9994,7 @@ await client.notifications.adHoc.createV1("order_id", {
|
|
|
9641
9994
|
<dl>
|
|
9642
9995
|
<dd>
|
|
9643
9996
|
|
|
9644
|
-
**
|
|
9997
|
+
**sessionId:** `string`
|
|
9645
9998
|
|
|
9646
9999
|
</dd>
|
|
9647
10000
|
</dl>
|
|
@@ -9649,7 +10002,7 @@ await client.notifications.adHoc.createV1("order_id", {
|
|
|
9649
10002
|
<dl>
|
|
9650
10003
|
<dd>
|
|
9651
10004
|
|
|
9652
|
-
**request:** `Chrt.
|
|
10005
|
+
**request:** `Chrt.NotificationIntentAdHocClientCreate1`
|
|
9653
10006
|
|
|
9654
10007
|
</dd>
|
|
9655
10008
|
</dl>
|
|
@@ -12773,7 +13126,165 @@ await client.operations.operationsTaskLists.createV1({
|
|
|
12773
13126
|
</dl>
|
|
12774
13127
|
</details>
|
|
12775
13128
|
|
|
12776
|
-
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">
|
|
13129
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">addEntryV1</a>(taskListId, { ...params }) -> string</code></summary>
|
|
13130
|
+
<dl>
|
|
13131
|
+
<dd>
|
|
13132
|
+
|
|
13133
|
+
#### 📝 Description
|
|
13134
|
+
|
|
13135
|
+
<dl>
|
|
13136
|
+
<dd>
|
|
13137
|
+
|
|
13138
|
+
<dl>
|
|
13139
|
+
<dd>
|
|
13140
|
+
|
|
13141
|
+
Appends a new entry to an OperationsTaskList's `entries` array. The server assigns a fresh UUID and returns it. Order is load-bearing for from_previous_task-anchored deadlines. | authz: min_org_role=operator | (OperationsTaskListEntryClientCreate1) -> (str)
|
|
13142
|
+
|
|
13143
|
+
</dd>
|
|
13144
|
+
</dl>
|
|
13145
|
+
</dd>
|
|
13146
|
+
</dl>
|
|
13147
|
+
|
|
13148
|
+
#### 🔌 Usage
|
|
13149
|
+
|
|
13150
|
+
<dl>
|
|
13151
|
+
<dd>
|
|
13152
|
+
|
|
13153
|
+
<dl>
|
|
13154
|
+
<dd>
|
|
13155
|
+
|
|
13156
|
+
```typescript
|
|
13157
|
+
await client.operations.operationsTaskLists.addEntryV1("task_list_id", {
|
|
13158
|
+
task_type: "review_order_details",
|
|
13159
|
+
title: "title",
|
|
13160
|
+
description: "description",
|
|
13161
|
+
});
|
|
13162
|
+
```
|
|
13163
|
+
|
|
13164
|
+
</dd>
|
|
13165
|
+
</dl>
|
|
13166
|
+
</dd>
|
|
13167
|
+
</dl>
|
|
13168
|
+
|
|
13169
|
+
#### ⚙️ Parameters
|
|
13170
|
+
|
|
13171
|
+
<dl>
|
|
13172
|
+
<dd>
|
|
13173
|
+
|
|
13174
|
+
<dl>
|
|
13175
|
+
<dd>
|
|
13176
|
+
|
|
13177
|
+
**taskListId:** `string`
|
|
13178
|
+
|
|
13179
|
+
</dd>
|
|
13180
|
+
</dl>
|
|
13181
|
+
|
|
13182
|
+
<dl>
|
|
13183
|
+
<dd>
|
|
13184
|
+
|
|
13185
|
+
**request:** `Chrt.OperationsTaskListEntryClientCreate1`
|
|
13186
|
+
|
|
13187
|
+
</dd>
|
|
13188
|
+
</dl>
|
|
13189
|
+
|
|
13190
|
+
<dl>
|
|
13191
|
+
<dd>
|
|
13192
|
+
|
|
13193
|
+
**requestOptions:** `OperationsTaskLists.RequestOptions`
|
|
13194
|
+
|
|
13195
|
+
</dd>
|
|
13196
|
+
</dl>
|
|
13197
|
+
</dd>
|
|
13198
|
+
</dl>
|
|
13199
|
+
|
|
13200
|
+
</dd>
|
|
13201
|
+
</dl>
|
|
13202
|
+
</details>
|
|
13203
|
+
|
|
13204
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">editEntryV1</a>(taskListId, entryUuid, { ...params }) -> boolean</code></summary>
|
|
13205
|
+
<dl>
|
|
13206
|
+
<dd>
|
|
13207
|
+
|
|
13208
|
+
#### 📝 Description
|
|
13209
|
+
|
|
13210
|
+
<dl>
|
|
13211
|
+
<dd>
|
|
13212
|
+
|
|
13213
|
+
<dl>
|
|
13214
|
+
<dd>
|
|
13215
|
+
|
|
13216
|
+
Replaces the entry with the given uuid in an OperationsTaskList's `entries` array. The stored uuid is preserved regardless of the request body. 404 if no entry matches. | authz: min_org_role=operator | (OperationsTaskListEntryClientCreate1) -> (bool)
|
|
13217
|
+
|
|
13218
|
+
</dd>
|
|
13219
|
+
</dl>
|
|
13220
|
+
</dd>
|
|
13221
|
+
</dl>
|
|
13222
|
+
|
|
13223
|
+
#### 🔌 Usage
|
|
13224
|
+
|
|
13225
|
+
<dl>
|
|
13226
|
+
<dd>
|
|
13227
|
+
|
|
13228
|
+
<dl>
|
|
13229
|
+
<dd>
|
|
13230
|
+
|
|
13231
|
+
```typescript
|
|
13232
|
+
await client.operations.operationsTaskLists.editEntryV1("task_list_id", "entry_uuid", {
|
|
13233
|
+
task_type: "review_order_details",
|
|
13234
|
+
title: "title",
|
|
13235
|
+
description: "description",
|
|
13236
|
+
});
|
|
13237
|
+
```
|
|
13238
|
+
|
|
13239
|
+
</dd>
|
|
13240
|
+
</dl>
|
|
13241
|
+
</dd>
|
|
13242
|
+
</dl>
|
|
13243
|
+
|
|
13244
|
+
#### ⚙️ Parameters
|
|
13245
|
+
|
|
13246
|
+
<dl>
|
|
13247
|
+
<dd>
|
|
13248
|
+
|
|
13249
|
+
<dl>
|
|
13250
|
+
<dd>
|
|
13251
|
+
|
|
13252
|
+
**taskListId:** `string`
|
|
13253
|
+
|
|
13254
|
+
</dd>
|
|
13255
|
+
</dl>
|
|
13256
|
+
|
|
13257
|
+
<dl>
|
|
13258
|
+
<dd>
|
|
13259
|
+
|
|
13260
|
+
**entryUuid:** `string`
|
|
13261
|
+
|
|
13262
|
+
</dd>
|
|
13263
|
+
</dl>
|
|
13264
|
+
|
|
13265
|
+
<dl>
|
|
13266
|
+
<dd>
|
|
13267
|
+
|
|
13268
|
+
**request:** `Chrt.OperationsTaskListEntryClientCreate1`
|
|
13269
|
+
|
|
13270
|
+
</dd>
|
|
13271
|
+
</dl>
|
|
13272
|
+
|
|
13273
|
+
<dl>
|
|
13274
|
+
<dd>
|
|
13275
|
+
|
|
13276
|
+
**requestOptions:** `OperationsTaskLists.RequestOptions`
|
|
13277
|
+
|
|
13278
|
+
</dd>
|
|
13279
|
+
</dl>
|
|
13280
|
+
</dd>
|
|
13281
|
+
</dl>
|
|
13282
|
+
|
|
13283
|
+
</dd>
|
|
13284
|
+
</dl>
|
|
13285
|
+
</details>
|
|
13286
|
+
|
|
13287
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">removeEntryV1</a>(taskListId, entryUuid) -> boolean</code></summary>
|
|
12777
13288
|
<dl>
|
|
12778
13289
|
<dd>
|
|
12779
13290
|
|
|
@@ -12785,7 +13296,7 @@ await client.operations.operationsTaskLists.createV1({
|
|
|
12785
13296
|
<dl>
|
|
12786
13297
|
<dd>
|
|
12787
13298
|
|
|
12788
|
-
|
|
13299
|
+
Removes the entry with the given uuid from an OperationsTaskList's `entries` array, closing the gap in order. 404 if no entry matches. | authz: min_org_role=operator | () -> (bool)
|
|
12789
13300
|
|
|
12790
13301
|
</dd>
|
|
12791
13302
|
</dl>
|
|
@@ -12801,7 +13312,7 @@ Replaces an OperationsTaskList's `entries` array wholesale — covering add, rem
|
|
|
12801
13312
|
<dd>
|
|
12802
13313
|
|
|
12803
13314
|
```typescript
|
|
12804
|
-
await client.operations.operationsTaskLists.
|
|
13315
|
+
await client.operations.operationsTaskLists.removeEntryV1("task_list_id", "entry_uuid");
|
|
12805
13316
|
```
|
|
12806
13317
|
|
|
12807
13318
|
</dd>
|
|
@@ -12825,7 +13336,7 @@ await client.operations.operationsTaskLists.setEntriesV1("task_list_id");
|
|
|
12825
13336
|
<dl>
|
|
12826
13337
|
<dd>
|
|
12827
13338
|
|
|
12828
|
-
**
|
|
13339
|
+
**entryUuid:** `string`
|
|
12829
13340
|
|
|
12830
13341
|
</dd>
|
|
12831
13342
|
</dl>
|
|
@@ -12856,7 +13367,7 @@ await client.operations.operationsTaskLists.setEntriesV1("task_list_id");
|
|
|
12856
13367
|
<dl>
|
|
12857
13368
|
<dd>
|
|
12858
13369
|
|
|
12859
|
-
Reorders an OperationsTaskList's existing entries. `
|
|
13370
|
+
Reorders an OperationsTaskList's existing entries. `entry_uuids` must be an exact permutation of the list's current entry uuids (every uuid present, no extras, no duplicates), so a reorder can never drop, add, or mutate an entry. | authz: min_org_role=operator | (OperationsTaskListReorderEntries1) -> (bool)
|
|
12860
13371
|
|
|
12861
13372
|
</dd>
|
|
12862
13373
|
</dl>
|
|
@@ -13122,7 +13633,7 @@ await client.operations.operationsTaskLists.applyToCaseV1("task_list_id", "case_
|
|
|
13122
13633
|
</dl>
|
|
13123
13634
|
</details>
|
|
13124
13635
|
|
|
13125
|
-
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">
|
|
13636
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">removeNotStartedTasksFromCaseV1</a>(taskListId, caseId) -> Chrt.OperationsTaskListRemoveFromCaseRes1</code></summary>
|
|
13126
13637
|
<dl>
|
|
13127
13638
|
<dd>
|
|
13128
13639
|
|
|
@@ -13134,7 +13645,7 @@ await client.operations.operationsTaskLists.applyToCaseV1("task_list_id", "case_
|
|
|
13134
13645
|
<dl>
|
|
13135
13646
|
<dd>
|
|
13136
13647
|
|
|
13137
|
-
Removes the OperationsTasks this OperationsTaskList added to the Case (matched by source_task_list_id). Only untouched (not_started) tasks are deleted; started/completed/skipped tasks are kept. Returns deleted and kept counts. | authz: min_org_role=operator | () -> (OperationsTaskListRemoveFromCaseRes1)
|
|
13648
|
+
Removes the OperationsTasks this OperationsTaskList added to the Case (matched by source_task_list_id). Only untouched (not_started) tasks are deleted; started/completed/skipped/cancelled tasks are kept. Returns deleted and kept counts. | authz: min_org_role=operator | () -> (OperationsTaskListRemoveFromCaseRes1)
|
|
13138
13649
|
|
|
13139
13650
|
</dd>
|
|
13140
13651
|
</dl>
|
|
@@ -13150,7 +13661,7 @@ Removes the OperationsTasks this OperationsTaskList added to the Case (matched b
|
|
|
13150
13661
|
<dd>
|
|
13151
13662
|
|
|
13152
13663
|
```typescript
|
|
13153
|
-
await client.operations.operationsTaskLists.
|
|
13664
|
+
await client.operations.operationsTaskLists.removeNotStartedTasksFromCaseV1("task_list_id", "case_id");
|
|
13154
13665
|
```
|
|
13155
13666
|
|
|
13156
13667
|
</dd>
|
|
@@ -13533,6 +14044,76 @@ await client.operations.operationsTasks.createV1({
|
|
|
13533
14044
|
</dl>
|
|
13534
14045
|
</details>
|
|
13535
14046
|
|
|
14047
|
+
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">bulkUpdateDeadlinesV1</a>({ ...params }) -> Chrt.OperationsTasksBulkUpdateDeadlinesRes1</code></summary>
|
|
14048
|
+
<dl>
|
|
14049
|
+
<dd>
|
|
14050
|
+
|
|
14051
|
+
#### 📝 Description
|
|
14052
|
+
|
|
14053
|
+
<dl>
|
|
14054
|
+
<dd>
|
|
14055
|
+
|
|
14056
|
+
<dl>
|
|
14057
|
+
<dd>
|
|
14058
|
+
|
|
14059
|
+
Sets deadline_timestamp on multiple OperationsTasks in one call, each scoped to the caller's organization. Task ids that don't exist or belong to another org are silently skipped; the response reports how many were updated. | authz: min_org_role=operator | (OperationsTasksBulkUpdateDeadlinesReq1) -> (OperationsTasksBulkUpdateDeadlinesRes1)
|
|
14060
|
+
|
|
14061
|
+
</dd>
|
|
14062
|
+
</dl>
|
|
14063
|
+
</dd>
|
|
14064
|
+
</dl>
|
|
14065
|
+
|
|
14066
|
+
#### 🔌 Usage
|
|
14067
|
+
|
|
14068
|
+
<dl>
|
|
14069
|
+
<dd>
|
|
14070
|
+
|
|
14071
|
+
<dl>
|
|
14072
|
+
<dd>
|
|
14073
|
+
|
|
14074
|
+
```typescript
|
|
14075
|
+
await client.operations.operationsTasks.bulkUpdateDeadlinesV1({
|
|
14076
|
+
operations_task_deadline_updates: [
|
|
14077
|
+
{
|
|
14078
|
+
task_id: "task_id",
|
|
14079
|
+
deadline_timestamp: "2024-01-15T09:30:00Z",
|
|
14080
|
+
},
|
|
14081
|
+
],
|
|
14082
|
+
});
|
|
14083
|
+
```
|
|
14084
|
+
|
|
14085
|
+
</dd>
|
|
14086
|
+
</dl>
|
|
14087
|
+
</dd>
|
|
14088
|
+
</dl>
|
|
14089
|
+
|
|
14090
|
+
#### ⚙️ Parameters
|
|
14091
|
+
|
|
14092
|
+
<dl>
|
|
14093
|
+
<dd>
|
|
14094
|
+
|
|
14095
|
+
<dl>
|
|
14096
|
+
<dd>
|
|
14097
|
+
|
|
14098
|
+
**request:** `Chrt.operations.OperationsTasksBulkUpdateDeadlinesReq1`
|
|
14099
|
+
|
|
14100
|
+
</dd>
|
|
14101
|
+
</dl>
|
|
14102
|
+
|
|
14103
|
+
<dl>
|
|
14104
|
+
<dd>
|
|
14105
|
+
|
|
14106
|
+
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
14107
|
+
|
|
14108
|
+
</dd>
|
|
14109
|
+
</dl>
|
|
14110
|
+
</dd>
|
|
14111
|
+
</dl>
|
|
14112
|
+
|
|
14113
|
+
</dd>
|
|
14114
|
+
</dl>
|
|
14115
|
+
</details>
|
|
14116
|
+
|
|
13536
14117
|
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">updateStatusV1</a>(taskId, { ...params }) -> boolean</code></summary>
|
|
13537
14118
|
<dl>
|
|
13538
14119
|
<dd>
|
|
@@ -13545,7 +14126,7 @@ await client.operations.operationsTasks.createV1({
|
|
|
13545
14126
|
<dl>
|
|
13546
14127
|
<dd>
|
|
13547
14128
|
|
|
13548
|
-
Sets an OperationsTask's status (not_started / in_progress / completed / skipped). Setting COMPLETED stamps completed_at/by; any other status clears them. | authz: min_org_role=operator | (OperationsTaskStatusReq) -> (bool)
|
|
14129
|
+
Sets an OperationsTask's status (not_started / in_progress / completed / skipped / cancelled). Setting COMPLETED stamps completed_at/by; any other status clears them. | authz: min_org_role=operator | (OperationsTaskStatusReq) -> (bool)
|
|
13549
14130
|
|
|
13550
14131
|
</dd>
|
|
13551
14132
|
</dl>
|
|
@@ -17487,7 +18068,7 @@ await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17487
18068
|
</dl>
|
|
17488
18069
|
</details>
|
|
17489
18070
|
|
|
17490
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.
|
|
18071
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.DriverWithActiveTaskGroupIds1</code></summary>
|
|
17491
18072
|
<dl>
|
|
17492
18073
|
<dd>
|
|
17493
18074
|
|
|
@@ -17499,7 +18080,7 @@ await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17499
18080
|
<dl>
|
|
17500
18081
|
<dd>
|
|
17501
18082
|
|
|
17502
|
-
Retrieves driver information for the caller within their organization. | () -> (
|
|
18083
|
+
Retrieves driver information for the caller within their organization. | () -> (DriverWithActiveTaskGroupIds1)
|
|
17503
18084
|
|
|
17504
18085
|
</dd>
|
|
17505
18086
|
</dl>
|
|
@@ -17542,7 +18123,7 @@ await client.shipping.drivers.getForCallerV1();
|
|
|
17542
18123
|
</dl>
|
|
17543
18124
|
</details>
|
|
17544
18125
|
|
|
17545
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getByDriverIdV1</a>(driverId) -> Chrt.
|
|
18126
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getByDriverIdV1</a>(driverId) -> Chrt.DriverWithActiveTaskGroupIds1</code></summary>
|
|
17546
18127
|
<dl>
|
|
17547
18128
|
<dd>
|
|
17548
18129
|
|
|
@@ -17554,7 +18135,7 @@ await client.shipping.drivers.getForCallerV1();
|
|
|
17554
18135
|
<dl>
|
|
17555
18136
|
<dd>
|
|
17556
18137
|
|
|
17557
|
-
Retrieves detailed driver information by driver ID within the organization. | () -> (
|
|
18138
|
+
Retrieves detailed driver information by driver ID within the organization. | () -> (DriverWithActiveTaskGroupIds1)
|
|
17558
18139
|
|
|
17559
18140
|
</dd>
|
|
17560
18141
|
</dl>
|
|
@@ -28863,7 +29444,6 @@ await client.tracking.sessions.listV1({
|
|
|
28863
29444
|
filter_device_id: "filter_device_id",
|
|
28864
29445
|
filter_off_chrt_reference_id: "filter_off_chrt_reference_id",
|
|
28865
29446
|
filter_flight_number: "filter_flight_number",
|
|
28866
|
-
filter_fa_flight_id: "filter_fa_flight_id",
|
|
28867
29447
|
filter_flight_loaded_status: "filter_flight_loaded_status",
|
|
28868
29448
|
filter_has_last_seen: true,
|
|
28869
29449
|
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -29053,7 +29633,7 @@ await client.tracking.sessions.typeaheadV1({
|
|
|
29053
29633
|
<dl>
|
|
29054
29634
|
<dd>
|
|
29055
29635
|
|
|
29056
|
-
Creates a new tracking session for a device and automatically starts recording data points. The caller must be the device owner or belong to an org the device is shared with. The device owner remains the session owner (org_id). The device's shared_with_org_ids are copied to the session. The device must not have an active session. Auto-termination is scheduled for ~1 week out at 8 PM PT. Prevent auto termination with `no_auto_termination=True` | auth: api_key | (SessionClientCreate1) -> (PydanticObjectId)
|
|
29636
|
+
Creates a new tracking session for a device and automatically starts recording data points. The caller must be the device owner or belong to an org the device is shared with. The device owner remains the session owner (org_id). The device's shared_with_org_ids are copied to the session. The device must not have an active session. Optionally seed a destination geofence (location + radius) to fire a destination geofence entered notification; attach flights afterwards via set_flight_info. Auto-termination is scheduled for ~1 week out at 8 PM PT. Prevent auto termination with `no_auto_termination=True` | auth: api_key | (SessionClientCreate1) -> (PydanticObjectId)
|
|
29057
29637
|
|
|
29058
29638
|
</dd>
|
|
29059
29639
|
</dl>
|
|
@@ -29120,7 +29700,7 @@ await client.tracking.sessions.createSessionV1({
|
|
|
29120
29700
|
<dl>
|
|
29121
29701
|
<dd>
|
|
29122
29702
|
|
|
29123
|
-
Updates a session's metadata. | auth: api_key | (SessionClientUpdate1) -> (bool)
|
|
29703
|
+
Updates a session's mutable metadata (off_chrt_reference_id, comments, public, termination_scheduled_for_timestamp, destination_geofence_location, destination_geofence_radius_miles). Setting or replacing the destination geofence location resets the entered latch so it can fire again; clearing it (destination_geofence_location\_\_set_to_None) also resets the latch. | auth: api_key | (SessionClientUpdate1) -> (bool)
|
|
29124
29704
|
|
|
29125
29705
|
</dd>
|
|
29126
29706
|
</dl>
|
|
@@ -29250,7 +29830,7 @@ await client.tracking.sessions.updateSharedOrgsV1({
|
|
|
29250
29830
|
<dl>
|
|
29251
29831
|
<dd>
|
|
29252
29832
|
|
|
29253
|
-
Terminates a session. Moves device.active_session_id to device.past_session_ids. | auth: api_key | () -> (bool)
|
|
29833
|
+
Terminates a session. Moves device.active_session_id to device.past_session_ids and deactivates the device. | auth: api_key | () -> (bool)
|
|
29254
29834
|
|
|
29255
29835
|
</dd>
|
|
29256
29836
|
</dl>
|
|
@@ -29303,7 +29883,7 @@ await client.tracking.sessions.terminateV1({
|
|
|
29303
29883
|
</dl>
|
|
29304
29884
|
</details>
|
|
29305
29885
|
|
|
29306
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">
|
|
29886
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">flightLegsV1</a>({ ...params }) -> Chrt.FlightLeg1[]</code></summary>
|
|
29307
29887
|
<dl>
|
|
29308
29888
|
<dd>
|
|
29309
29889
|
|
|
@@ -29315,7 +29895,7 @@ await client.tracking.sessions.terminateV1({
|
|
|
29315
29895
|
<dl>
|
|
29316
29896
|
<dd>
|
|
29317
29897
|
|
|
29318
|
-
|
|
29898
|
+
Returns the session's flight legs in order, with Cirium-sourced status lazily resolved and refreshed on read. Access restricted to the caller's organization or shared organizations. | auth: api_key | authz: min_org_role=operator | () -> (list[FlightLeg1])
|
|
29319
29899
|
|
|
29320
29900
|
</dd>
|
|
29321
29901
|
</dl>
|
|
@@ -29331,10 +29911,8 @@ Adds a flight number and FA flight IDs to an existing session. Creates or reuses
|
|
|
29331
29911
|
<dd>
|
|
29332
29912
|
|
|
29333
29913
|
```typescript
|
|
29334
|
-
await client.tracking.sessions.
|
|
29914
|
+
await client.tracking.sessions.flightLegsV1({
|
|
29335
29915
|
session_id: "session_id",
|
|
29336
|
-
flight_number: "flight_number",
|
|
29337
|
-
fa_flight_ids: ["fa_flight_ids"],
|
|
29338
29916
|
});
|
|
29339
29917
|
```
|
|
29340
29918
|
|
|
@@ -29351,7 +29929,7 @@ await client.tracking.sessions.addFlightV1({
|
|
|
29351
29929
|
<dl>
|
|
29352
29930
|
<dd>
|
|
29353
29931
|
|
|
29354
|
-
**request:** `Chrt.tracking.
|
|
29932
|
+
**request:** `Chrt.tracking.SessionsFlightLegsV1Request`
|
|
29355
29933
|
|
|
29356
29934
|
</dd>
|
|
29357
29935
|
</dl>
|
|
@@ -29370,7 +29948,7 @@ await client.tracking.sessions.addFlightV1({
|
|
|
29370
29948
|
</dl>
|
|
29371
29949
|
</details>
|
|
29372
29950
|
|
|
29373
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">
|
|
29951
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">flightTrackV1</a>({ ...params }) -> Chrt.FlightTrackRes</code></summary>
|
|
29374
29952
|
<dl>
|
|
29375
29953
|
<dd>
|
|
29376
29954
|
|
|
@@ -29382,7 +29960,7 @@ await client.tracking.sessions.addFlightV1({
|
|
|
29382
29960
|
<dl>
|
|
29383
29961
|
<dd>
|
|
29384
29962
|
|
|
29385
|
-
|
|
29963
|
+
Returns the Cirium-sourced positional track for one of the session's flight legs — the live breadcrumb trail plus the planned path (waypoints + legacy route) — cached on read. Access restricted to the caller's organization or shared organizations. | auth: api_key | authz: min_org_role=operator | () -> (FlightTrackRes)
|
|
29386
29964
|
|
|
29387
29965
|
</dd>
|
|
29388
29966
|
</dl>
|
|
@@ -29398,10 +29976,9 @@ Removes a flight number and FA flight IDs from a session. Runs the shared-aware
|
|
|
29398
29976
|
<dd>
|
|
29399
29977
|
|
|
29400
29978
|
```typescript
|
|
29401
|
-
await client.tracking.sessions.
|
|
29979
|
+
await client.tracking.sessions.flightTrackV1({
|
|
29402
29980
|
session_id: "session_id",
|
|
29403
|
-
|
|
29404
|
-
fa_flight_ids: ["fa_flight_ids"],
|
|
29981
|
+
flight_leg_id: "flight_leg_id",
|
|
29405
29982
|
});
|
|
29406
29983
|
```
|
|
29407
29984
|
|
|
@@ -29418,7 +29995,7 @@ await client.tracking.sessions.removeFlightV1({
|
|
|
29418
29995
|
<dl>
|
|
29419
29996
|
<dd>
|
|
29420
29997
|
|
|
29421
|
-
**request:** `Chrt.tracking.
|
|
29998
|
+
**request:** `Chrt.tracking.SessionsFlightTrackV1Request`
|
|
29422
29999
|
|
|
29423
30000
|
</dd>
|
|
29424
30001
|
</dl>
|
|
@@ -29437,7 +30014,7 @@ await client.tracking.sessions.removeFlightV1({
|
|
|
29437
30014
|
</dl>
|
|
29438
30015
|
</details>
|
|
29439
30016
|
|
|
29440
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">
|
|
30017
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">setFlightInfoV1</a>({ ...params }) -> boolean</code></summary>
|
|
29441
30018
|
<dl>
|
|
29442
30019
|
<dd>
|
|
29443
30020
|
|
|
@@ -29449,7 +30026,7 @@ await client.tracking.sessions.removeFlightV1({
|
|
|
29449
30026
|
<dl>
|
|
29450
30027
|
<dd>
|
|
29451
30028
|
|
|
29452
|
-
|
|
30029
|
+
Replaces the session's followed flights: deletes the existing session-owned FlightLeg documents and creates new ones from the supplied flight details. Each leg's Cirium flightId and status resolve lazily on read. Pass an empty list to clear all flights. | auth: api_key | authz: min_org_role=operator | (SessionSetFlightInfoReq1) -> (bool)
|
|
29453
30030
|
|
|
29454
30031
|
</dd>
|
|
29455
30032
|
</dl>
|
|
@@ -29465,8 +30042,19 @@ Fetches current OOOI timestamps from FlightAware for each fa_flight_id on the se
|
|
|
29465
30042
|
<dd>
|
|
29466
30043
|
|
|
29467
30044
|
```typescript
|
|
29468
|
-
await client.tracking.sessions.
|
|
30045
|
+
await client.tracking.sessions.setFlightInfoV1({
|
|
29469
30046
|
session_id: "session_id",
|
|
30047
|
+
flight_legs: [
|
|
30048
|
+
{
|
|
30049
|
+
schema_version: 1,
|
|
30050
|
+
flight_number: "flight_number",
|
|
30051
|
+
provenance: "manual",
|
|
30052
|
+
origin_iata: "origin_iata",
|
|
30053
|
+
destination_iata: "destination_iata",
|
|
30054
|
+
scheduled_departure_utc: "2024-01-15T09:30:00Z",
|
|
30055
|
+
carrier_iata: "carrier_iata",
|
|
30056
|
+
},
|
|
30057
|
+
],
|
|
29470
30058
|
});
|
|
29471
30059
|
```
|
|
29472
30060
|
|
|
@@ -29483,7 +30071,7 @@ await client.tracking.sessions.syncFlightStatusV1({
|
|
|
29483
30071
|
<dl>
|
|
29484
30072
|
<dd>
|
|
29485
30073
|
|
|
29486
|
-
**request:** `Chrt.tracking.
|
|
30074
|
+
**request:** `Chrt.tracking.SessionSetFlightInfoReq1`
|
|
29487
30075
|
|
|
29488
30076
|
</dd>
|
|
29489
30077
|
</dl>
|