@chrt-inc/typescript-sdk 1.326.0 → 1.333.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.d.ts +3 -0
- package/dist/cjs/Client.js +41 -36
- package/dist/cjs/api/resources/courierPayDriverLineItemGroups/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/courierPayDriverLineItemGroups/client/Client.js +4 -4
- package/dist/cjs/api/resources/courierPayDriverLineItemGroups/resources/addLineItems/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/courierPayDriverLineItemGroups/resources/addLineItems/client/Client.js +1 -1
- package/dist/cjs/api/resources/courierPayDriverLineItemGroups/resources/removeLineItems/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/courierPayDriverLineItemGroups/resources/removeLineItems/client/Client.js +1 -1
- package/dist/cjs/api/resources/courierPayDriverPayouts/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/courierPayDriverPayouts/client/Client.js +4 -4
- package/dist/cjs/api/resources/courierPayDriverRateSheets/client/Client.d.ts +6 -6
- package/dist/cjs/api/resources/courierPayDriverRateSheets/client/Client.js +6 -6
- package/dist/cjs/api/resources/courierPayDriverStatements/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/courierPayDriverStatements/client/Client.js +4 -4
- package/dist/cjs/api/resources/drivers/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/drivers/client/Client.js +20 -3
- package/dist/cjs/api/resources/drivers/client/requests/DriverClientCreate1.d.ts +2 -0
- package/dist/cjs/api/resources/{tracking/resources/cargoByDevice → flights}/client/Client.d.ts +13 -16
- package/dist/cjs/api/resources/{tracking/resources/taskGroupByDriver → flights}/client/Client.js +19 -27
- package/dist/cjs/api/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/index.js +2 -1
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/Client.d.ts +5 -7
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/Client.js +8 -10
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/orders/resources/expanded/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/orders/resources/expanded/client/Client.js +2 -2
- package/dist/cjs/api/resources/payments/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/payments/client/Client.js +5 -5
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/client/Client.js +5 -5
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/addLineItems/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/addLineItems/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/courier/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/courier/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/removeLineItems/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/removeLineItems/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.js +3 -3
- package/dist/cjs/api/resources/shipperPayCourierPayments/client/Client.d.ts +7 -7
- package/dist/cjs/api/resources/shipperPayCourierPayments/client/Client.js +7 -7
- package/dist/cjs/api/resources/shipperPayCourierRateSheets/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/shipperPayCourierRateSheets/client/Client.js +5 -5
- package/dist/cjs/api/resources/shipperPayCourierStatements/client/Client.d.ts +7 -7
- package/dist/cjs/api/resources/shipperPayCourierStatements/client/Client.js +7 -7
- package/dist/cjs/api/resources/taskGroups/client/Client.d.ts +5 -7
- package/dist/cjs/api/resources/taskGroups/client/Client.js +8 -10
- package/dist/cjs/api/resources/taskGroups/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/tracking/client/Client.d.ts +9 -12
- package/dist/cjs/api/resources/tracking/client/Client.js +15 -20
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.d.ts +25 -25
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js +73 -73
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/tracking/resources/driver/client/Client.d.ts +10 -14
- package/dist/cjs/api/resources/tracking/resources/driver/client/Client.js +9 -13
- package/dist/cjs/api/resources/tracking/resources/driver/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/tracking/resources/driver/client/index.js +0 -15
- package/dist/cjs/api/resources/tracking/resources/index.d.ts +5 -9
- package/dist/cjs/api/resources/tracking/resources/index.js +6 -10
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.d.ts +164 -0
- package/dist/cjs/api/resources/tracking/resources/{sessionByDevice → sessions}/client/Client.js +50 -394
- package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceCreateSessionRequest1.d.ts → sessions/client/requests/SessionCreateSessionRequest1.d.ts} +1 -1
- package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceUpdateRequest1.d.ts → sessions/client/requests/SessionUpdateRequest1.d.ts} +1 -1
- package/dist/{esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceGetV1Request.d.mts → cjs/api/resources/tracking/resources/sessions/client/requests/SessionsDeleteV1Request.d.ts} +1 -1
- package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceGetV1Request.d.ts → sessions/client/requests/SessionsGetV1Request.d.ts} +1 -1
- package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceDeleteV1Request.d.ts → sessions/client/requests/SessionsPauseRecordingV1Request.d.ts} +1 -1
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsResumeRecordingV1Request.d.ts +12 -0
- package/dist/{esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceStartV1Request.d.mts → cjs/api/resources/tracking/resources/sessions/client/requests/SessionsStartV1Request.d.ts} +1 -1
- package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceStartV1Request.d.ts → sessions/client/requests/SessionsTerminateV1Request.d.ts} +1 -1
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/index.d.ts +8 -0
- package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/Client.d.ts +100 -0
- package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/Client.js +330 -0
- package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/requests/CargoByDeviceSharingSettingsUpdateReq.d.ts +18 -0
- package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/requests/CargoByDriverSharingSettingsUpdateReq.d.ts +18 -0
- package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/requests/TaskGroupByDriverSharingSettingsUpdateReq.d.ts +16 -0
- package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/client/Client.d.ts +32 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/client/Client.js +32 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/index.d.ts +2 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/index.js +18 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.d.ts +116 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.js +414 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/requests/CargoByDeviceDataPointsPublicV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/requests/CargoByDeviceDataPointsV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/requests/CargoByDeviceLastSeenPublicV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/requests/CargoByDeviceMarkOutliersRequest1.d.ts +14 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/requests/index.d.ts +5 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.d.ts +100 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.js +346 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/CargoByDriverDataPointsPublicV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/CargoByDriverDataPointsV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/CargoByDriverLastSeenPublicV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDriver/index.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDriver/index.js +17 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/index.d.ts +8 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/index.js +47 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.d.ts +112 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.js +406 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/index.js +17 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/index.d.ts +5 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/sessionByDevice/index.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/sessionByDevice/index.js +17 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.d.ts +96 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.js +338 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/index.js +17 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/TaskGroupByDriverDataPointsPublicV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/TaskGroupByDriverDataPointsV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/TaskGroupByDriverLastSeenPublicV1Request.d.ts +12 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/TaskGroupByDriverLastSeenV1Request.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/index.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/index.js +17 -0
- package/dist/cjs/api/types/{TrackingCargoByDeviceDataPoint1.d.ts → CargoByDeviceDataPoint1.d.ts} +2 -2
- package/dist/cjs/api/types/CargoByDeviceDataPoint1.js +5 -0
- package/dist/cjs/api/types/{TrackingCargoByDeviceDataPointMetadata1.d.ts → CargoByDeviceDataPointMetadata1.d.ts} +3 -3
- package/dist/cjs/api/types/CargoByDeviceDataPointMetadata1.js +5 -0
- package/dist/cjs/api/types/CargoByDeviceMarkOutliersResponse1.d.ts +7 -0
- package/dist/cjs/api/types/CargoByDeviceMarkOutliersResponse1.js +5 -0
- package/dist/cjs/api/types/CargoByDeviceSharingSettings1.d.ts +16 -0
- package/dist/cjs/api/types/CargoByDeviceSharingSettings1.js +5 -0
- package/dist/cjs/api/types/{TrackingCargoByDriverDataPoint1.d.ts → CargoByDriverDataPoint1.d.ts} +2 -2
- package/dist/cjs/api/types/CargoByDriverDataPoint1.js +5 -0
- package/dist/cjs/api/types/{TrackingCargoByDriverDataPointMetadata1.d.ts → CargoByDriverDataPointMetadata1.d.ts} +3 -3
- package/dist/cjs/api/types/CargoByDriverDataPointMetadata1.js +5 -0
- package/dist/cjs/api/types/CargoByDriverSharingSettings1.d.ts +16 -0
- package/dist/cjs/api/types/CargoByDriverSharingSettings1.js +5 -0
- package/dist/cjs/api/types/Driver1.d.ts +1 -1
- package/dist/cjs/api/types/DriverUpdateRes.d.ts +1 -1
- package/dist/cjs/api/types/FlightInfoForTaskRes.d.ts +10 -0
- package/dist/cjs/api/types/FlightInfoForTaskRes.js +5 -0
- package/dist/cjs/api/types/{TrackingSessionByDeviceDataPoint1.d.ts → SessionByDeviceDataPoint1.d.ts} +2 -2
- package/dist/cjs/api/types/SessionByDeviceDataPoint1.js +5 -0
- package/dist/cjs/api/types/{TrackingSessionByDeviceDataPointMetadata1.d.ts → SessionByDeviceDataPointMetadata1.d.ts} +1 -1
- package/dist/cjs/api/types/SessionByDeviceDataPointMetadata1.js +5 -0
- package/dist/cjs/api/types/{SessionByDeviceDeleteResponse1.d.ts → SessionDeleteResponse1.d.ts} +1 -1
- package/dist/cjs/api/types/SessionDeleteResponse1.js +5 -0
- package/dist/cjs/api/types/SetFlightInfoReq.d.ts +9 -0
- package/dist/cjs/api/types/SetFlightInfoReq.js +5 -0
- package/dist/cjs/api/types/Task1.d.ts +0 -1
- package/dist/cjs/api/types/TaskClientCreate1.d.ts +0 -1
- package/dist/cjs/api/types/TaskClientUpdate1.d.ts +0 -1
- package/dist/cjs/api/types/TaskGroup1.d.ts +1 -0
- package/dist/cjs/api/types/{TrackingTaskGroupByDriverDataPoint1.d.ts → TaskGroupByDriverDataPoint1.d.ts} +2 -2
- package/dist/cjs/api/types/TaskGroupByDriverDataPoint1.js +5 -0
- package/dist/cjs/api/types/{TrackingTaskGroupByDriverDataPointMetadata1.d.ts → TaskGroupByDriverDataPointMetadata1.d.ts} +2 -2
- package/dist/cjs/api/types/TaskGroupByDriverDataPointMetadata1.js +5 -0
- package/dist/cjs/api/types/TaskGroupByDriverSharingSettings1.d.ts +15 -0
- package/dist/cjs/api/types/TaskGroupByDriverSharingSettings1.js +5 -0
- package/dist/cjs/api/types/TrackingSharingSettingsRes.d.ts +11 -0
- package/dist/cjs/api/types/TrackingSharingSettingsRes.js +5 -0
- package/dist/cjs/api/types/index.d.ts +16 -9
- package/dist/cjs/api/types/index.js +16 -9
- 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/courierPayDriverLineItemGroups/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/courierPayDriverLineItemGroups/client/Client.mjs +4 -4
- package/dist/esm/api/resources/courierPayDriverLineItemGroups/resources/addLineItems/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/courierPayDriverLineItemGroups/resources/addLineItems/client/Client.mjs +1 -1
- package/dist/esm/api/resources/courierPayDriverLineItemGroups/resources/removeLineItems/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/courierPayDriverLineItemGroups/resources/removeLineItems/client/Client.mjs +1 -1
- package/dist/esm/api/resources/courierPayDriverPayouts/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/courierPayDriverPayouts/client/Client.mjs +4 -4
- package/dist/esm/api/resources/courierPayDriverRateSheets/client/Client.d.mts +6 -6
- package/dist/esm/api/resources/courierPayDriverRateSheets/client/Client.mjs +6 -6
- package/dist/esm/api/resources/courierPayDriverStatements/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/courierPayDriverStatements/client/Client.mjs +4 -4
- package/dist/esm/api/resources/drivers/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/drivers/client/Client.mjs +20 -3
- package/dist/esm/api/resources/drivers/client/requests/DriverClientCreate1.d.mts +2 -0
- package/dist/esm/api/resources/{tracking/resources/cargoByDevice → flights}/client/Client.d.mts +13 -16
- package/dist/esm/api/resources/{tracking/resources/taskGroupByDriver → flights}/client/Client.mjs +17 -25
- package/dist/esm/api/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/index.mjs +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/Client.d.mts +5 -7
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/Client.mjs +8 -10
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/orders/resources/expanded/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/orders/resources/expanded/client/Client.mjs +2 -2
- package/dist/esm/api/resources/payments/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/payments/client/Client.mjs +5 -5
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/client/Client.mjs +5 -5
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/resources/addLineItems/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/resources/addLineItems/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/resources/courier/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/resources/courier/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/resources/removeLineItems/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/resources/removeLineItems/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.mjs +3 -3
- package/dist/esm/api/resources/shipperPayCourierPayments/client/Client.d.mts +7 -7
- package/dist/esm/api/resources/shipperPayCourierPayments/client/Client.mjs +7 -7
- package/dist/esm/api/resources/shipperPayCourierRateSheets/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/shipperPayCourierRateSheets/client/Client.mjs +5 -5
- package/dist/esm/api/resources/shipperPayCourierStatements/client/Client.d.mts +7 -7
- package/dist/esm/api/resources/shipperPayCourierStatements/client/Client.mjs +7 -7
- package/dist/esm/api/resources/taskGroups/client/Client.d.mts +5 -7
- package/dist/esm/api/resources/taskGroups/client/Client.mjs +8 -10
- package/dist/esm/api/resources/taskGroups/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/tracking/client/Client.d.mts +9 -12
- package/dist/esm/api/resources/tracking/client/Client.mjs +11 -16
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.d.mts +25 -25
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs +73 -73
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/tracking/resources/driver/client/Client.d.mts +10 -14
- package/dist/esm/api/resources/tracking/resources/driver/client/Client.mjs +9 -13
- package/dist/esm/api/resources/tracking/resources/driver/client/index.d.mts +0 -1
- package/dist/esm/api/resources/tracking/resources/driver/client/index.mjs +1 -1
- package/dist/esm/api/resources/tracking/resources/index.d.mts +5 -9
- package/dist/esm/api/resources/tracking/resources/index.mjs +5 -9
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.d.mts +164 -0
- package/dist/esm/api/resources/tracking/resources/{sessionByDevice → sessions}/client/Client.mjs +48 -392
- package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceCreateSessionRequest1.d.mts → sessions/client/requests/SessionCreateSessionRequest1.d.mts} +1 -1
- package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceUpdateRequest1.d.mts → sessions/client/requests/SessionUpdateRequest1.d.mts} +1 -1
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsDeleteV1Request.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsGetV1Request.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceDeleteV1Request.d.mts → sessions/client/requests/SessionsPauseRecordingV1Request.d.mts} +1 -1
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsResumeRecordingV1Request.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsStartV1Request.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsTerminateV1Request.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/index.d.mts +8 -0
- package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.d.mts +100 -0
- package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.mjs +293 -0
- package/dist/esm/api/resources/tracking/resources/sharingSettings/client/requests/CargoByDeviceSharingSettingsUpdateReq.d.mts +18 -0
- package/dist/esm/api/resources/tracking/resources/sharingSettings/client/requests/CargoByDriverSharingSettingsUpdateReq.d.mts +18 -0
- package/dist/esm/api/resources/tracking/resources/sharingSettings/client/requests/TaskGroupByDriverSharingSettingsUpdateReq.d.mts +16 -0
- package/dist/esm/api/resources/tracking/resources/sharingSettings/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/tracking/resources/sharingSettings/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/client/Client.d.mts +32 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/client/Client.mjs +28 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/client/index.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/client/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/index.d.mts +2 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/index.mjs +2 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.d.mts +116 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.mjs +377 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/requests/CargoByDeviceDataPointsPublicV1Request.d.mts +16 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/requests/CargoByDeviceDataPointsV1Request.d.mts +16 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/requests/CargoByDeviceLastSeenPublicV1Request.d.mts +14 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/requests/CargoByDeviceMarkOutliersRequest1.d.mts +14 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/requests/index.d.mts +5 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.d.mts +100 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.mjs +309 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/CargoByDriverDataPointsPublicV1Request.d.mts +16 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/CargoByDriverDataPointsV1Request.d.mts +16 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/CargoByDriverLastSeenPublicV1Request.d.mts +14 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDriver/index.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDriver/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/index.d.mts +8 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/index.mjs +8 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.d.mts +112 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.mjs +369 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/index.d.mts +2 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/index.d.mts +5 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/sessionByDevice/index.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/sessionByDevice/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.d.mts +96 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.mjs +301 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/index.d.mts +2 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/TaskGroupByDriverDataPointsPublicV1Request.d.mts +14 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/TaskGroupByDriverDataPointsV1Request.d.mts +14 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/TaskGroupByDriverLastSeenPublicV1Request.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/TaskGroupByDriverLastSeenV1Request.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/index.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/index.mjs +1 -0
- package/dist/esm/api/types/{TrackingCargoByDeviceDataPoint1.d.mts → CargoByDeviceDataPoint1.d.mts} +2 -2
- package/dist/esm/api/types/CargoByDeviceDataPoint1.mjs +4 -0
- package/dist/esm/api/types/{TrackingCargoByDeviceDataPointMetadata1.d.mts → CargoByDeviceDataPointMetadata1.d.mts} +3 -3
- package/dist/esm/api/types/CargoByDeviceDataPointMetadata1.mjs +4 -0
- package/dist/esm/api/types/CargoByDeviceMarkOutliersResponse1.d.mts +7 -0
- package/dist/esm/api/types/CargoByDeviceMarkOutliersResponse1.mjs +4 -0
- package/dist/esm/api/types/CargoByDeviceSharingSettings1.d.mts +16 -0
- package/dist/esm/api/types/CargoByDeviceSharingSettings1.mjs +4 -0
- package/dist/esm/api/types/{TrackingCargoByDriverDataPoint1.d.mts → CargoByDriverDataPoint1.d.mts} +2 -2
- package/dist/esm/api/types/CargoByDriverDataPoint1.mjs +4 -0
- package/dist/esm/api/types/{TrackingCargoByDriverDataPointMetadata1.d.mts → CargoByDriverDataPointMetadata1.d.mts} +3 -3
- package/dist/esm/api/types/CargoByDriverDataPointMetadata1.mjs +4 -0
- package/dist/esm/api/types/CargoByDriverSharingSettings1.d.mts +16 -0
- package/dist/esm/api/types/CargoByDriverSharingSettings1.mjs +4 -0
- package/dist/esm/api/types/Driver1.d.mts +1 -1
- package/dist/esm/api/types/DriverUpdateRes.d.mts +1 -1
- package/dist/esm/api/types/FlightInfoForTaskRes.d.mts +10 -0
- package/dist/esm/api/types/FlightInfoForTaskRes.mjs +4 -0
- package/dist/esm/api/types/{TrackingSessionByDeviceDataPoint1.d.mts → SessionByDeviceDataPoint1.d.mts} +2 -2
- package/dist/esm/api/types/SessionByDeviceDataPoint1.mjs +4 -0
- package/dist/esm/api/types/{TrackingSessionByDeviceDataPointMetadata1.d.mts → SessionByDeviceDataPointMetadata1.d.mts} +1 -1
- package/dist/esm/api/types/SessionByDeviceDataPointMetadata1.mjs +4 -0
- package/dist/esm/api/types/{SessionByDeviceDeleteResponse1.d.mts → SessionDeleteResponse1.d.mts} +1 -1
- package/dist/esm/api/types/SessionDeleteResponse1.mjs +4 -0
- package/dist/esm/api/types/SetFlightInfoReq.d.mts +9 -0
- package/dist/esm/api/types/SetFlightInfoReq.mjs +4 -0
- package/dist/esm/api/types/Task1.d.mts +0 -1
- package/dist/esm/api/types/TaskClientCreate1.d.mts +0 -1
- package/dist/esm/api/types/TaskClientUpdate1.d.mts +0 -1
- package/dist/esm/api/types/TaskGroup1.d.mts +1 -0
- package/dist/esm/api/types/{TrackingTaskGroupByDriverDataPoint1.d.mts → TaskGroupByDriverDataPoint1.d.mts} +2 -2
- package/dist/esm/api/types/TaskGroupByDriverDataPoint1.mjs +4 -0
- package/dist/esm/api/types/{TrackingTaskGroupByDriverDataPointMetadata1.d.mts → TaskGroupByDriverDataPointMetadata1.d.mts} +2 -2
- package/dist/esm/api/types/TaskGroupByDriverDataPointMetadata1.mjs +4 -0
- package/dist/esm/api/types/TaskGroupByDriverSharingSettings1.d.mts +15 -0
- package/dist/esm/api/types/TaskGroupByDriverSharingSettings1.mjs +4 -0
- package/dist/esm/api/types/TrackingSharingSettingsRes.d.mts +11 -0
- package/dist/esm/api/types/TrackingSharingSettingsRes.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +16 -9
- package/dist/esm/api/types/index.mjs +16 -9
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +1227 -236
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/requests/SetFlightNumberDraftReq.d.ts +0 -13
- package/dist/cjs/api/resources/taskGroups/client/requests/SetFlightNumberReq.d.ts +0 -13
- package/dist/cjs/api/resources/tracking/resources/cargoByDevice/client/Client.js +0 -137
- package/dist/cjs/api/resources/tracking/resources/cargoByDevice/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/tracking/resources/cargoByDriver/client/Client.d.ts +0 -50
- package/dist/cjs/api/resources/tracking/resources/cargoByDriver/client/Client.js +0 -137
- package/dist/cjs/api/resources/tracking/resources/cargoByDriver/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/tracking/resources/driver/client/requests/DriverUpdateReq.d.ts +0 -26
- package/dist/cjs/api/resources/tracking/resources/driver/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/Client.d.ts +0 -242
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDevicePauseRecordingV1Request.d.ts +0 -12
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceResumeRecordingV1Request.d.ts +0 -12
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceTerminateV1Request.d.ts +0 -12
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/requests/index.d.ts +0 -13
- package/dist/cjs/api/resources/tracking/resources/taskGroupByDriver/client/Client.d.ts +0 -49
- package/dist/cjs/api/resources/tracking/resources/taskGroupByDriver/client/requests/index.d.ts +0 -1
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/requests/SetFlightNumberDraftReq.d.mts +0 -13
- package/dist/esm/api/resources/taskGroups/client/requests/SetFlightNumberReq.d.mts +0 -13
- package/dist/esm/api/resources/tracking/resources/cargoByDevice/client/Client.mjs +0 -100
- package/dist/esm/api/resources/tracking/resources/cargoByDevice/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/tracking/resources/cargoByDriver/client/Client.d.mts +0 -50
- package/dist/esm/api/resources/tracking/resources/cargoByDriver/client/Client.mjs +0 -100
- package/dist/esm/api/resources/tracking/resources/cargoByDriver/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/tracking/resources/driver/client/requests/DriverUpdateReq.d.mts +0 -26
- package/dist/esm/api/resources/tracking/resources/driver/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/Client.d.mts +0 -242
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDevicePauseRecordingV1Request.d.mts +0 -12
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceResumeRecordingV1Request.d.mts +0 -12
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceTerminateV1Request.d.mts +0 -12
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/index.d.mts +0 -13
- package/dist/esm/api/resources/tracking/resources/taskGroupByDriver/client/Client.d.mts +0 -49
- package/dist/esm/api/resources/tracking/resources/taskGroupByDriver/client/requests/index.d.mts +0 -1
- /package/dist/{esm/api/resources/tracking/resources/cargoByDevice/client/requests/index.mjs → cjs/api/resources/flights/client/index.d.ts} +0 -0
- /package/dist/cjs/api/resources/{tracking/resources/cargoByDevice/client/requests → flights/client}/index.js +0 -0
- /package/dist/cjs/api/resources/{tracking/resources/cargoByDevice → flights}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/{tracking/resources/cargoByDevice → flights}/index.js +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDevice → sessions}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDevice → sessions}/client/index.js +0 -0
- /package/dist/cjs/api/resources/{orderDrafts/resources/taskGroup/client/requests/SetFlightNumberDraftReq.js → tracking/resources/sessions/client/requests/SessionCreateSessionRequest1.js} +0 -0
- /package/dist/cjs/api/resources/{taskGroups/client/requests/SetFlightNumberReq.js → tracking/resources/sessions/client/requests/SessionUpdateRequest1.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDevice/client/requests/CargoByDeviceLastSeenV1Request.js → sessions/client/requests/SessionsDeleteV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDriver/client/requests/CargoByDriverLastSeenV1Request.js → sessions/client/requests/SessionsGetV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{driver/client/requests/DriverUpdateReq.js → sessions/client/requests/SessionsPauseRecordingV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceCreateSessionRequest1.js → sessions/client/requests/SessionsResumeRecordingV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceDataPointsPublicV1Request.js → sessions/client/requests/SessionsStartV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceDataPointsV1Request.js → sessions/client/requests/SessionsTerminateV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDriver → sessions}/client/requests/index.js +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDriver → sessions}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDriver → sessions}/index.js +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDriver → sharingSettings}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDriver → sharingSettings}/client/index.js +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceDeleteV1Request.js → sharingSettings/client/requests/CargoByDeviceSharingSettingsUpdateReq.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceGetV1Request.js → sharingSettings/client/requests/CargoByDriverSharingSettingsUpdateReq.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceLastSeenPublicV1Request.js → sharingSettings/client/requests/TaskGroupByDriverSharingSettingsUpdateReq.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{driver → sharingSettings}/client/requests/index.js +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice → sharingSettings}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice → sharingSettings}/index.js +0 -0
- /package/dist/{esm/api/resources/tracking/resources/cargoByDriver/client/requests/index.mjs → cjs/api/resources/tracking/resources/timeseries/client/index.d.ts} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests → timeseries/client}/index.js +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice → timeseries/resources/cargoByDevice}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice → timeseries/resources/cargoByDevice}/client/index.js +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceLastSeenV1Request.js → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceDataPointsPublicV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceMarkOutliersRequest1.js → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceDataPointsV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDevicePauseRecordingV1Request.js → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceLastSeenPublicV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDevice → timeseries/resources/cargoByDevice}/client/requests/CargoByDeviceLastSeenV1Request.d.ts +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceResumeRecordingV1Request.js → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceLastSeenV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceStartV1Request.js → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceMarkOutliersRequest1.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{taskGroupByDriver → timeseries/resources/cargoByDevice}/client/requests/index.js +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{taskGroupByDriver → timeseries/resources/cargoByDevice}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{taskGroupByDriver → timeseries/resources/cargoByDevice}/index.js +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{taskGroupByDriver → timeseries/resources/cargoByDriver}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{taskGroupByDriver → timeseries/resources/cargoByDriver}/client/index.js +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceTerminateV1Request.js → timeseries/resources/cargoByDriver/client/requests/CargoByDriverDataPointsPublicV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceUpdateRequest1.js → timeseries/resources/cargoByDriver/client/requests/CargoByDriverDataPointsV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{taskGroupByDriver/client/requests/TaskGroupByDriverLastSeenV1Request.js → timeseries/resources/cargoByDriver/client/requests/CargoByDriverLastSeenPublicV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDriver → timeseries/resources/cargoByDriver}/client/requests/CargoByDriverLastSeenV1Request.d.ts +0 -0
- /package/dist/cjs/api/{types/SessionByDeviceDeleteResponse1.js → resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/CargoByDriverLastSeenV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice → timeseries/resources/sessionByDevice}/client/requests/SessionByDeviceDataPointsPublicV1Request.d.ts +0 -0
- /package/dist/cjs/api/{types/TrackingCargoByDeviceDataPoint1.js → resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/SessionByDeviceDataPointsPublicV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice → timeseries/resources/sessionByDevice}/client/requests/SessionByDeviceDataPointsV1Request.d.ts +0 -0
- /package/dist/cjs/api/{types/TrackingCargoByDeviceDataPointMetadata1.js → resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/SessionByDeviceDataPointsV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice → timeseries/resources/sessionByDevice}/client/requests/SessionByDeviceLastSeenPublicV1Request.d.ts +0 -0
- /package/dist/cjs/api/{types/TrackingCargoByDriverDataPoint1.js → resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/SessionByDeviceLastSeenPublicV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice → timeseries/resources/sessionByDevice}/client/requests/SessionByDeviceLastSeenV1Request.d.ts +0 -0
- /package/dist/cjs/api/{types/TrackingCargoByDriverDataPointMetadata1.js → resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/SessionByDeviceLastSeenV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice → timeseries/resources/sessionByDevice}/client/requests/SessionByDeviceMarkOutliersRequest1.d.ts +0 -0
- /package/dist/cjs/api/{types/TrackingSessionByDeviceDataPoint1.js → resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/SessionByDeviceMarkOutliersRequest1.js} +0 -0
- /package/dist/cjs/api/{types/TrackingSessionByDeviceDataPointMetadata1.js → resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/TaskGroupByDriverDataPointsPublicV1Request.js} +0 -0
- /package/dist/cjs/api/{types/TrackingTaskGroupByDriverDataPoint1.js → resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/TaskGroupByDriverDataPointsV1Request.js} +0 -0
- /package/dist/cjs/api/{types/TrackingTaskGroupByDriverDataPointMetadata1.js → resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/TaskGroupByDriverLastSeenPublicV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{taskGroupByDriver → timeseries/resources/taskGroupByDriver}/client/requests/TaskGroupByDriverLastSeenV1Request.d.ts +0 -0
- /package/dist/esm/api/resources/{tracking/resources/driver/client/requests/index.mjs → flights/client/index.d.mts} +0 -0
- /package/dist/esm/api/resources/{tracking/resources/sessionByDevice/client/requests → flights/client}/index.mjs +0 -0
- /package/dist/esm/api/resources/{tracking/resources/cargoByDevice → flights}/index.d.mts +0 -0
- /package/dist/esm/api/resources/{tracking/resources/cargoByDevice → flights}/index.mjs +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDevice → sessions}/client/index.d.mts +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDevice → sessions}/client/index.mjs +0 -0
- /package/dist/esm/api/resources/{orderDrafts/resources/taskGroup/client/requests/SetFlightNumberDraftReq.mjs → tracking/resources/sessions/client/requests/SessionCreateSessionRequest1.mjs} +0 -0
- /package/dist/esm/api/resources/{taskGroups/client/requests/SetFlightNumberReq.mjs → tracking/resources/sessions/client/requests/SessionUpdateRequest1.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDevice/client/requests/CargoByDeviceLastSeenV1Request.mjs → sessions/client/requests/SessionsDeleteV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDriver/client/requests/CargoByDriverLastSeenV1Request.mjs → sessions/client/requests/SessionsGetV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{driver/client/requests/DriverUpdateReq.mjs → sessions/client/requests/SessionsPauseRecordingV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceCreateSessionRequest1.mjs → sessions/client/requests/SessionsResumeRecordingV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceDataPointsPublicV1Request.mjs → sessions/client/requests/SessionsStartV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceDataPointsV1Request.mjs → sessions/client/requests/SessionsTerminateV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{taskGroupByDriver → sessions}/client/requests/index.mjs +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDriver → sessions}/index.d.mts +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDriver → sessions}/index.mjs +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDriver → sharingSettings}/client/index.d.mts +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDriver → sharingSettings}/client/index.mjs +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceDeleteV1Request.mjs → sharingSettings/client/requests/CargoByDeviceSharingSettingsUpdateReq.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceGetV1Request.mjs → sharingSettings/client/requests/CargoByDriverSharingSettingsUpdateReq.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceLastSeenPublicV1Request.mjs → sharingSettings/client/requests/TaskGroupByDriverSharingSettingsUpdateReq.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice → sharingSettings}/index.d.mts +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice → sharingSettings}/index.mjs +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice → timeseries/resources/cargoByDevice}/client/index.d.mts +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice → timeseries/resources/cargoByDevice}/client/index.mjs +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceLastSeenV1Request.mjs → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceDataPointsPublicV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceMarkOutliersRequest1.mjs → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceDataPointsV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDevicePauseRecordingV1Request.mjs → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceLastSeenPublicV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDevice → timeseries/resources/cargoByDevice}/client/requests/CargoByDeviceLastSeenV1Request.d.mts +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceResumeRecordingV1Request.mjs → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceLastSeenV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceStartV1Request.mjs → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceMarkOutliersRequest1.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{taskGroupByDriver → timeseries/resources/cargoByDevice}/index.d.mts +0 -0
- /package/dist/esm/api/resources/tracking/resources/{taskGroupByDriver → timeseries/resources/cargoByDevice}/index.mjs +0 -0
- /package/dist/esm/api/resources/tracking/resources/{taskGroupByDriver → timeseries/resources/cargoByDriver}/client/index.d.mts +0 -0
- /package/dist/esm/api/resources/tracking/resources/{taskGroupByDriver → timeseries/resources/cargoByDriver}/client/index.mjs +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceTerminateV1Request.mjs → timeseries/resources/cargoByDriver/client/requests/CargoByDriverDataPointsPublicV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceUpdateRequest1.mjs → timeseries/resources/cargoByDriver/client/requests/CargoByDriverDataPointsV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{taskGroupByDriver/client/requests/TaskGroupByDriverLastSeenV1Request.mjs → timeseries/resources/cargoByDriver/client/requests/CargoByDriverLastSeenPublicV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDriver → timeseries/resources/cargoByDriver}/client/requests/CargoByDriverLastSeenV1Request.d.mts +0 -0
- /package/dist/esm/api/{types/SessionByDeviceDeleteResponse1.mjs → resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/CargoByDriverLastSeenV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice → timeseries/resources/sessionByDevice}/client/requests/SessionByDeviceDataPointsPublicV1Request.d.mts +0 -0
- /package/dist/esm/api/{types/TrackingCargoByDeviceDataPoint1.mjs → resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/SessionByDeviceDataPointsPublicV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice → timeseries/resources/sessionByDevice}/client/requests/SessionByDeviceDataPointsV1Request.d.mts +0 -0
- /package/dist/esm/api/{types/TrackingCargoByDeviceDataPointMetadata1.mjs → resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/SessionByDeviceDataPointsV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice → timeseries/resources/sessionByDevice}/client/requests/SessionByDeviceLastSeenPublicV1Request.d.mts +0 -0
- /package/dist/esm/api/{types/TrackingCargoByDriverDataPoint1.mjs → resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/SessionByDeviceLastSeenPublicV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice → timeseries/resources/sessionByDevice}/client/requests/SessionByDeviceLastSeenV1Request.d.mts +0 -0
- /package/dist/esm/api/{types/TrackingCargoByDriverDataPointMetadata1.mjs → resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/SessionByDeviceLastSeenV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice → timeseries/resources/sessionByDevice}/client/requests/SessionByDeviceMarkOutliersRequest1.d.mts +0 -0
- /package/dist/esm/api/{types/TrackingSessionByDeviceDataPoint1.mjs → resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/SessionByDeviceMarkOutliersRequest1.mjs} +0 -0
- /package/dist/esm/api/{types/TrackingSessionByDeviceDataPointMetadata1.mjs → resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/TaskGroupByDriverDataPointsPublicV1Request.mjs} +0 -0
- /package/dist/esm/api/{types/TrackingTaskGroupByDriverDataPoint1.mjs → resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/TaskGroupByDriverDataPointsV1Request.mjs} +0 -0
- /package/dist/esm/api/{types/TrackingTaskGroupByDriverDataPointMetadata1.mjs → resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/requests/TaskGroupByDriverLastSeenPublicV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{taskGroupByDriver → timeseries/resources/taskGroupByDriver}/client/requests/TaskGroupByDriverLastSeenV1Request.d.mts +0 -0
package/reference.md
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
<dl>
|
|
15
15
|
<dd>
|
|
16
16
|
|
|
17
|
-
Generates and sends a Stripe invoice for a shipper statement to a courier organization's Connect account. Applies a 10% application fee.
|
|
17
|
+
Generates and sends a Stripe invoice for a shipper statement to a courier organization's Connect account. Applies a 10% application fee. | (GenerateInvoiceReq) -> (GenerateInvoiceRes)
|
|
18
18
|
|
|
19
19
|
</dd>
|
|
20
20
|
</dl>
|
|
@@ -79,7 +79,7 @@ await client.payments.generateInvoiceV1({
|
|
|
79
79
|
<dl>
|
|
80
80
|
<dd>
|
|
81
81
|
|
|
82
|
-
Creates a Stripe checkout session for a subscription with pricing based on the selected plan.
|
|
82
|
+
Creates a Stripe checkout session for a subscription with pricing based on the selected plan. | (CreateCheckoutSessionReq) -> (CreateCheckoutSessionRes)
|
|
83
83
|
|
|
84
84
|
</dd>
|
|
85
85
|
</dl>
|
|
@@ -144,7 +144,7 @@ await client.payments.createCheckoutSessionV1({
|
|
|
144
144
|
<dl>
|
|
145
145
|
<dd>
|
|
146
146
|
|
|
147
|
-
Synchronizes subscription data from Stripe to the authentication service for the current user.
|
|
147
|
+
Synchronizes subscription data from Stripe to the authentication service for the current user. | () -> (bool)
|
|
148
148
|
|
|
149
149
|
</dd>
|
|
150
150
|
</dl>
|
|
@@ -199,7 +199,7 @@ await client.payments.syncStripeToClerkV1();
|
|
|
199
199
|
<dl>
|
|
200
200
|
<dd>
|
|
201
201
|
|
|
202
|
-
Creates a Stripe Connect account for the organization to receive payments. Idempotent - returns existing account if already created.
|
|
202
|
+
Creates a Stripe Connect account for the organization to receive payments. Idempotent - returns existing account if already created. | () -> (CreateConnectAccountRes)
|
|
203
203
|
|
|
204
204
|
</dd>
|
|
205
205
|
</dl>
|
|
@@ -254,7 +254,7 @@ await client.payments.createConnectAccountV1();
|
|
|
254
254
|
<dl>
|
|
255
255
|
<dd>
|
|
256
256
|
|
|
257
|
-
Creates an onboarding link for a Stripe Connect account. Used to complete or update account setup.
|
|
257
|
+
Creates an onboarding link for a Stripe Connect account. Used to complete or update account setup. | () -> (CreateConnectAccountLinkRes)
|
|
258
258
|
|
|
259
259
|
</dd>
|
|
260
260
|
</dl>
|
|
@@ -311,7 +311,7 @@ await client.payments.createConnectAccountLinkV1();
|
|
|
311
311
|
<dl>
|
|
312
312
|
<dd>
|
|
313
313
|
|
|
314
|
-
Retrieves a courier driver line item group by its ID.
|
|
314
|
+
Retrieves a courier driver line item group by its ID. | () -> (CourierPayDriverLineItemGroup1)
|
|
315
315
|
|
|
316
316
|
</dd>
|
|
317
317
|
</dl>
|
|
@@ -374,7 +374,7 @@ await client.courierPayDriverLineItemGroups.getByIdV1("id");
|
|
|
374
374
|
<dl>
|
|
375
375
|
<dd>
|
|
376
376
|
|
|
377
|
-
Retrieves a courier driver line item group by its associated task group ID.
|
|
377
|
+
Retrieves a courier driver line item group by its associated task group ID. | () -> (CourierPayDriverLineItemGroup1)
|
|
378
378
|
|
|
379
379
|
</dd>
|
|
380
380
|
</dl>
|
|
@@ -437,7 +437,7 @@ await client.courierPayDriverLineItemGroups.byTaskGroupIdV1("task_group_id");
|
|
|
437
437
|
<dl>
|
|
438
438
|
<dd>
|
|
439
439
|
|
|
440
|
-
Previews calculated line items for a driver based on a rate sheet and task group. Does not write to the database.
|
|
440
|
+
Previews calculated line items for a driver based on a rate sheet and task group. Does not write to the database. | (CourierPayDriverLineItemGroupCreateReq) -> (CourierPayDriverLineItemGroupServerCreate1)
|
|
441
441
|
|
|
442
442
|
</dd>
|
|
443
443
|
</dl>
|
|
@@ -511,7 +511,7 @@ await client.courierPayDriverLineItemGroups.previewV1("driver_id", {
|
|
|
511
511
|
<dl>
|
|
512
512
|
<dd>
|
|
513
513
|
|
|
514
|
-
Creates a courier pay driver line item group by calculating items from a rate sheet and task group.
|
|
514
|
+
Creates a courier pay driver line item group by calculating items from a rate sheet and task group. | (CourierPayDriverLineItemGroupCreateReq) -> (PydanticObjectId)
|
|
515
515
|
|
|
516
516
|
</dd>
|
|
517
517
|
</dl>
|
|
@@ -579,7 +579,7 @@ await client.courierPayDriverLineItemGroups.createV1({
|
|
|
579
579
|
<dl>
|
|
580
580
|
<dd>
|
|
581
581
|
|
|
582
|
-
Retrieves a specific courier driver payout
|
|
582
|
+
Retrieves a specific courier driver payout for the caller's organization. | () -> (CourierPayDriverStatement1)
|
|
583
583
|
|
|
584
584
|
</dd>
|
|
585
585
|
</dl>
|
|
@@ -642,7 +642,7 @@ await client.courierPayDriverPayouts.getByIdV1("id");
|
|
|
642
642
|
<dl>
|
|
643
643
|
<dd>
|
|
644
644
|
|
|
645
|
-
Lists all payouts for a specific driver within the caller's organization.
|
|
645
|
+
Lists all payouts for a specific driver within the caller's organization. | () -> (list[CourierPayDriverStatement1])
|
|
646
646
|
|
|
647
647
|
</dd>
|
|
648
648
|
</dl>
|
|
@@ -705,7 +705,7 @@ await client.courierPayDriverPayouts.listByDriverIdV1("driver_id");
|
|
|
705
705
|
<dl>
|
|
706
706
|
<dd>
|
|
707
707
|
|
|
708
|
-
Creates a new driver payout from selected line item groups and calculates the total amount.
|
|
708
|
+
Creates a new driver payout from selected line item groups and calculates the total amount. | (CourierPayDriverStatementClientCreate1) -> (PydanticObjectId)
|
|
709
709
|
|
|
710
710
|
</dd>
|
|
711
711
|
</dl>
|
|
@@ -771,7 +771,7 @@ await client.courierPayDriverPayouts.createV1({
|
|
|
771
771
|
<dl>
|
|
772
772
|
<dd>
|
|
773
773
|
|
|
774
|
-
Updates the status of a courier driver payout with validation of allowed state transitions.
|
|
774
|
+
Updates the status of a courier driver payout with validation of allowed state transitions. | (CourierPayDriverStatementClientUpdate1) -> (CourierPayDriverStatement1)
|
|
775
775
|
|
|
776
776
|
</dd>
|
|
777
777
|
</dl>
|
|
@@ -844,7 +844,7 @@ await client.courierPayDriverPayouts.updateStatusV1("id", {});
|
|
|
844
844
|
<dl>
|
|
845
845
|
<dd>
|
|
846
846
|
|
|
847
|
-
Lists all driver rate sheets for the caller's courier organization.
|
|
847
|
+
Lists all driver rate sheets for the caller's courier organization. | () -> (list[CourierPayDriverRateSheet1])
|
|
848
848
|
|
|
849
849
|
</dd>
|
|
850
850
|
</dl>
|
|
@@ -899,7 +899,7 @@ await client.courierPayDriverRateSheets.listByCourierOrgIdV1();
|
|
|
899
899
|
<dl>
|
|
900
900
|
<dd>
|
|
901
901
|
|
|
902
|
-
Retrieves all rate sheets assigned to a specific driver.
|
|
902
|
+
Retrieves all rate sheets assigned to a specific driver. | () -> (list[CourierPayDriverRateSheet1])
|
|
903
903
|
|
|
904
904
|
</dd>
|
|
905
905
|
</dl>
|
|
@@ -962,7 +962,7 @@ await client.courierPayDriverRateSheets.listByDriverIdV1("driver_id");
|
|
|
962
962
|
<dl>
|
|
963
963
|
<dd>
|
|
964
964
|
|
|
965
|
-
Creates a new driver rate sheet for calculating courier payments.
|
|
965
|
+
Creates a new driver rate sheet for calculating courier payments. | (CourierPayDriverRateSheetClientCreate1) -> (PydanticObjectId)
|
|
966
966
|
|
|
967
967
|
</dd>
|
|
968
968
|
</dl>
|
|
@@ -1041,7 +1041,7 @@ await client.courierPayDriverRateSheets.createV1({
|
|
|
1041
1041
|
<dl>
|
|
1042
1042
|
<dd>
|
|
1043
1043
|
|
|
1044
|
-
Retrieves a single rate sheet by its ID.
|
|
1044
|
+
Retrieves a single rate sheet by its ID. | () -> (CourierPayDriverRateSheet1)
|
|
1045
1045
|
|
|
1046
1046
|
</dd>
|
|
1047
1047
|
</dl>
|
|
@@ -1104,7 +1104,7 @@ await client.courierPayDriverRateSheets.getV1("id");
|
|
|
1104
1104
|
<dl>
|
|
1105
1105
|
<dd>
|
|
1106
1106
|
|
|
1107
|
-
Deletes a driver rate sheet owned by the caller's organization.
|
|
1107
|
+
Deletes a driver rate sheet owned by the caller's organization. | () -> (bool)
|
|
1108
1108
|
|
|
1109
1109
|
</dd>
|
|
1110
1110
|
</dl>
|
|
@@ -1167,7 +1167,7 @@ await client.courierPayDriverRateSheets.deleteByIdV1("id");
|
|
|
1167
1167
|
<dl>
|
|
1168
1168
|
<dd>
|
|
1169
1169
|
|
|
1170
|
-
Updates an existing driver rate sheet owned by the caller's organization.
|
|
1170
|
+
Updates an existing driver rate sheet owned by the caller's organization. | (CourierPayDriverRateSheetClientUpdate1) -> (CourierPayDriverRateSheet1)
|
|
1171
1171
|
|
|
1172
1172
|
</dd>
|
|
1173
1173
|
</dl>
|
|
@@ -1240,7 +1240,7 @@ await client.courierPayDriverRateSheets.updateByIdV1("id");
|
|
|
1240
1240
|
<dl>
|
|
1241
1241
|
<dd>
|
|
1242
1242
|
|
|
1243
|
-
Retrieves a specific courier driver statement
|
|
1243
|
+
Retrieves a specific courier driver statement for the caller's organization. | () -> (CourierPayDriverStatement1)
|
|
1244
1244
|
|
|
1245
1245
|
</dd>
|
|
1246
1246
|
</dl>
|
|
@@ -1303,7 +1303,7 @@ await client.courierPayDriverStatements.getByIdV1("id");
|
|
|
1303
1303
|
<dl>
|
|
1304
1304
|
<dd>
|
|
1305
1305
|
|
|
1306
|
-
Lists all statements for a specific driver within the caller's organization.
|
|
1306
|
+
Lists all statements for a specific driver within the caller's organization. | () -> (list[CourierPayDriverStatement1])
|
|
1307
1307
|
|
|
1308
1308
|
</dd>
|
|
1309
1309
|
</dl>
|
|
@@ -1366,7 +1366,7 @@ await client.courierPayDriverStatements.listByDriverIdV1("driver_id");
|
|
|
1366
1366
|
<dl>
|
|
1367
1367
|
<dd>
|
|
1368
1368
|
|
|
1369
|
-
Creates a new driver statement from selected line item groups and calculates the total amount.
|
|
1369
|
+
Creates a new driver statement from selected line item groups and calculates the total amount. | (CourierPayDriverStatementClientCreate1) -> (PydanticObjectId)
|
|
1370
1370
|
|
|
1371
1371
|
</dd>
|
|
1372
1372
|
</dl>
|
|
@@ -1432,7 +1432,7 @@ await client.courierPayDriverStatements.createV1({
|
|
|
1432
1432
|
<dl>
|
|
1433
1433
|
<dd>
|
|
1434
1434
|
|
|
1435
|
-
Updates the status of a courier driver statement with validation of allowed state transitions.
|
|
1435
|
+
Updates the status of a courier driver statement with validation of allowed state transitions. | (CourierPayDriverStatementClientUpdate1) -> (CourierPayDriverStatement1)
|
|
1436
1436
|
|
|
1437
1437
|
</dd>
|
|
1438
1438
|
</dl>
|
|
@@ -1505,7 +1505,7 @@ await client.courierPayDriverStatements.updateStatusV1("id", {});
|
|
|
1505
1505
|
<dl>
|
|
1506
1506
|
<dd>
|
|
1507
1507
|
|
|
1508
|
-
Retrieves a shipper pay courier line item group by its ID for the caller's courier organization.
|
|
1508
|
+
Retrieves a shipper pay courier line item group by its ID for the caller's courier organization. | () -> (ShipperPayCourierLineItemGroup1)
|
|
1509
1509
|
|
|
1510
1510
|
</dd>
|
|
1511
1511
|
</dl>
|
|
@@ -1568,7 +1568,7 @@ await client.shipperPayCourierLineItemGroups.getByIdV1("id");
|
|
|
1568
1568
|
<dl>
|
|
1569
1569
|
<dd>
|
|
1570
1570
|
|
|
1571
|
-
Deletes a shipper pay courier line item group by its ID if not referenced by any payment.
|
|
1571
|
+
Deletes a shipper pay courier line item group by its ID if not referenced by any payment. | () -> (bool)
|
|
1572
1572
|
|
|
1573
1573
|
</dd>
|
|
1574
1574
|
</dl>
|
|
@@ -1631,7 +1631,7 @@ await client.shipperPayCourierLineItemGroups.deleteByIdV1("id");
|
|
|
1631
1631
|
<dl>
|
|
1632
1632
|
<dd>
|
|
1633
1633
|
|
|
1634
|
-
Retrieves a shipper pay courier line item group by its associated task group ID for the caller's courier organization.
|
|
1634
|
+
Retrieves a shipper pay courier line item group by its associated task group ID for the caller's courier organization. | () -> (ShipperPayCourierLineItemGroup1)
|
|
1635
1635
|
|
|
1636
1636
|
</dd>
|
|
1637
1637
|
</dl>
|
|
@@ -1694,7 +1694,7 @@ await client.shipperPayCourierLineItemGroups.byTaskGroupIdV1("task_group_id");
|
|
|
1694
1694
|
<dl>
|
|
1695
1695
|
<dd>
|
|
1696
1696
|
|
|
1697
|
-
Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group.
|
|
1697
|
+
Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group. | (ShipperPayCourierLineItemGroupCreateReq) -> (ShipperPayCourierLineItemGroupServerCreate1)
|
|
1698
1698
|
|
|
1699
1699
|
</dd>
|
|
1700
1700
|
</dl>
|
|
@@ -1760,7 +1760,7 @@ await client.shipperPayCourierLineItemGroups.previewV1({
|
|
|
1760
1760
|
<dl>
|
|
1761
1761
|
<dd>
|
|
1762
1762
|
|
|
1763
|
-
Creates a shipper pay courier line item group by calculating items from rate sheet and task group.
|
|
1763
|
+
Creates a shipper pay courier line item group by calculating items from rate sheet and task group. | (ShipperPayCourierLineItemGroupCreateReq) -> (PydanticObjectId)
|
|
1764
1764
|
|
|
1765
1765
|
</dd>
|
|
1766
1766
|
</dl>
|
|
@@ -1828,7 +1828,7 @@ await client.shipperPayCourierLineItemGroups.createV1({
|
|
|
1828
1828
|
<dl>
|
|
1829
1829
|
<dd>
|
|
1830
1830
|
|
|
1831
|
-
Retrieves a shipper pay courier payment by its ID with Stripe invoice sync.
|
|
1831
|
+
Retrieves a shipper pay courier payment by its ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)
|
|
1832
1832
|
|
|
1833
1833
|
</dd>
|
|
1834
1834
|
</dl>
|
|
@@ -1891,7 +1891,7 @@ await client.shipperPayCourierPayments.getByIdV1("shipper_pay_courier_payment_id
|
|
|
1891
1891
|
<dl>
|
|
1892
1892
|
<dd>
|
|
1893
1893
|
|
|
1894
|
-
Deletes a shipper-to-courier payment record if invoice not yet created.
|
|
1894
|
+
Deletes a shipper-to-courier payment record if invoice not yet created. | () -> (bool)
|
|
1895
1895
|
|
|
1896
1896
|
</dd>
|
|
1897
1897
|
</dl>
|
|
@@ -1954,7 +1954,7 @@ await client.shipperPayCourierPayments.deleteV1("shipper_pay_courier_payment_id"
|
|
|
1954
1954
|
<dl>
|
|
1955
1955
|
<dd>
|
|
1956
1956
|
|
|
1957
|
-
Retrieves a shipper pay courier payment by order ID or short ID with Stripe invoice sync.
|
|
1957
|
+
Retrieves a shipper pay courier payment by order ID or short ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)
|
|
1958
1958
|
|
|
1959
1959
|
</dd>
|
|
1960
1960
|
</dl>
|
|
@@ -2017,7 +2017,7 @@ await client.shipperPayCourierPayments.getByOrderIdOrShortIdV1("order_id_or_shor
|
|
|
2017
2017
|
<dl>
|
|
2018
2018
|
<dd>
|
|
2019
2019
|
|
|
2020
|
-
Lists shipper pay courier payments by shipper org ID with status filtering and Stripe sync.
|
|
2020
|
+
Lists shipper pay courier payments by shipper org ID with status filtering and Stripe sync. | (ListPaymentsByShipperReq) -> (GetShipperPayCourierPaymentsForShipperRes)
|
|
2021
2021
|
|
|
2022
2022
|
</dd>
|
|
2023
2023
|
</dl>
|
|
@@ -2082,7 +2082,7 @@ await client.shipperPayCourierPayments.listByShipperOrgIdV1({
|
|
|
2082
2082
|
<dl>
|
|
2083
2083
|
<dd>
|
|
2084
2084
|
|
|
2085
|
-
Lists shipper pay courier payments by courier org ID with status filtering and Stripe sync.
|
|
2085
|
+
Lists shipper pay courier payments by courier org ID with status filtering and Stripe sync. | (ListPaymentsByCourierReq) -> (GetShipperPayCourierPaymentsForShipperRes)
|
|
2086
2086
|
|
|
2087
2087
|
</dd>
|
|
2088
2088
|
</dl>
|
|
@@ -2147,7 +2147,7 @@ await client.shipperPayCourierPayments.listByCourierOrgIdV1({
|
|
|
2147
2147
|
<dl>
|
|
2148
2148
|
<dd>
|
|
2149
2149
|
|
|
2150
|
-
Creates a shipper-to-courier payment record based on all task groups in an order.
|
|
2150
|
+
Creates a shipper-to-courier payment record based on all task groups in an order. | (CreateShipperPayCourierPaymentReq) -> (PydanticObjectId)
|
|
2151
2151
|
|
|
2152
2152
|
</dd>
|
|
2153
2153
|
</dl>
|
|
@@ -2212,7 +2212,7 @@ await client.shipperPayCourierPayments.createV1({
|
|
|
2212
2212
|
<dl>
|
|
2213
2213
|
<dd>
|
|
2214
2214
|
|
|
2215
|
-
Previews a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status.
|
|
2215
|
+
Previews a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status. | (CreateShipperPayCourierPaymentReq) -> (PaymentPreviewResponse)
|
|
2216
2216
|
|
|
2217
2217
|
</dd>
|
|
2218
2218
|
</dl>
|
|
@@ -2279,7 +2279,7 @@ await client.shipperPayCourierPayments.previewV1({
|
|
|
2279
2279
|
<dl>
|
|
2280
2280
|
<dd>
|
|
2281
2281
|
|
|
2282
|
-
Lists all rate sheets created by the authenticated courier organization.
|
|
2282
|
+
Lists all rate sheets created by the authenticated courier organization. | () -> (list[ShipperPayCourierRateSheet1])
|
|
2283
2283
|
|
|
2284
2284
|
</dd>
|
|
2285
2285
|
</dl>
|
|
@@ -2334,7 +2334,7 @@ await client.shipperPayCourierRateSheets.listByCourierOrgIdV1();
|
|
|
2334
2334
|
<dl>
|
|
2335
2335
|
<dd>
|
|
2336
2336
|
|
|
2337
|
-
Creates a new rate sheet for a courier to charge shippers.
|
|
2337
|
+
Creates a new rate sheet for a courier to charge shippers. | (ShipperPayCourierRateSheetClientCreate1) -> (PydanticObjectId)
|
|
2338
2338
|
|
|
2339
2339
|
</dd>
|
|
2340
2340
|
</dl>
|
|
@@ -2412,7 +2412,7 @@ await client.shipperPayCourierRateSheets.createV1({
|
|
|
2412
2412
|
<dl>
|
|
2413
2413
|
<dd>
|
|
2414
2414
|
|
|
2415
|
-
Retrieves a single rate sheet by its ID (courier access only).
|
|
2415
|
+
Retrieves a single rate sheet by its ID (courier access only). | () -> (ShipperPayCourierRateSheet1)
|
|
2416
2416
|
|
|
2417
2417
|
</dd>
|
|
2418
2418
|
</dl>
|
|
@@ -2475,7 +2475,7 @@ await client.shipperPayCourierRateSheets.getV1("id");
|
|
|
2475
2475
|
<dl>
|
|
2476
2476
|
<dd>
|
|
2477
2477
|
|
|
2478
|
-
Deletes a rate sheet owned by the authenticated courier organization.
|
|
2478
|
+
Deletes a rate sheet owned by the authenticated courier organization. | () -> (bool)
|
|
2479
2479
|
|
|
2480
2480
|
</dd>
|
|
2481
2481
|
</dl>
|
|
@@ -2538,7 +2538,7 @@ await client.shipperPayCourierRateSheets.deleteByIdV1("id");
|
|
|
2538
2538
|
<dl>
|
|
2539
2539
|
<dd>
|
|
2540
2540
|
|
|
2541
|
-
Updates an existing rate sheet owned by the authenticated courier organization.
|
|
2541
|
+
Updates an existing rate sheet owned by the authenticated courier organization. | (ShipperPayCourierRateSheetClientUpdate1) -> (ShipperPayCourierRateSheet1)
|
|
2542
2542
|
|
|
2543
2543
|
</dd>
|
|
2544
2544
|
</dl>
|
|
@@ -2611,7 +2611,7 @@ await client.shipperPayCourierRateSheets.updateByIdV1("id");
|
|
|
2611
2611
|
<dl>
|
|
2612
2612
|
<dd>
|
|
2613
2613
|
|
|
2614
|
-
Retrieves a shipper pay courier statement by its ID with Stripe invoice sync.
|
|
2614
|
+
Retrieves a shipper pay courier statement by its ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)
|
|
2615
2615
|
|
|
2616
2616
|
</dd>
|
|
2617
2617
|
</dl>
|
|
@@ -2674,7 +2674,7 @@ await client.shipperPayCourierStatements.getByIdV1("shipper_pay_courier_statemen
|
|
|
2674
2674
|
<dl>
|
|
2675
2675
|
<dd>
|
|
2676
2676
|
|
|
2677
|
-
Deletes a shipper-to-courier statement record if invoice not yet created.
|
|
2677
|
+
Deletes a shipper-to-courier statement record if invoice not yet created. | () -> (bool)
|
|
2678
2678
|
|
|
2679
2679
|
</dd>
|
|
2680
2680
|
</dl>
|
|
@@ -2737,7 +2737,7 @@ await client.shipperPayCourierStatements.deleteV1("shipper_pay_courier_statement
|
|
|
2737
2737
|
<dl>
|
|
2738
2738
|
<dd>
|
|
2739
2739
|
|
|
2740
|
-
Retrieves a shipper pay courier statement by order ID or short ID with Stripe invoice sync.
|
|
2740
|
+
Retrieves a shipper pay courier statement by order ID or short ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)
|
|
2741
2741
|
|
|
2742
2742
|
</dd>
|
|
2743
2743
|
</dl>
|
|
@@ -2800,7 +2800,7 @@ await client.shipperPayCourierStatements.getByOrderIdOrShortIdV1("order_id_or_sh
|
|
|
2800
2800
|
<dl>
|
|
2801
2801
|
<dd>
|
|
2802
2802
|
|
|
2803
|
-
Lists shipper pay courier statements by shipper org ID with status filtering and Stripe sync.
|
|
2803
|
+
Lists shipper pay courier statements by shipper org ID with status filtering and Stripe sync. | (ListStatementsByShipperReq) -> (GetShipperPayCourierStatementsForShipperRes)
|
|
2804
2804
|
|
|
2805
2805
|
</dd>
|
|
2806
2806
|
</dl>
|
|
@@ -2865,7 +2865,7 @@ await client.shipperPayCourierStatements.listByShipperOrgIdV1({
|
|
|
2865
2865
|
<dl>
|
|
2866
2866
|
<dd>
|
|
2867
2867
|
|
|
2868
|
-
Lists shipper pay courier statements by courier org ID with status filtering and Stripe sync.
|
|
2868
|
+
Lists shipper pay courier statements by courier org ID with status filtering and Stripe sync. | (ListStatementsByCourierReq) -> (GetShipperPayCourierStatementsForShipperRes)
|
|
2869
2869
|
|
|
2870
2870
|
</dd>
|
|
2871
2871
|
</dl>
|
|
@@ -2930,7 +2930,7 @@ await client.shipperPayCourierStatements.listByCourierOrgIdV1({
|
|
|
2930
2930
|
<dl>
|
|
2931
2931
|
<dd>
|
|
2932
2932
|
|
|
2933
|
-
Creates a shipper-to-courier statement record based on all task groups in an order.
|
|
2933
|
+
Creates a shipper-to-courier statement record based on all task groups in an order. | (CreateShipperPayCourierStatementReq) -> (PydanticObjectId)
|
|
2934
2934
|
|
|
2935
2935
|
</dd>
|
|
2936
2936
|
</dl>
|
|
@@ -2995,7 +2995,7 @@ await client.shipperPayCourierStatements.createV1({
|
|
|
2995
2995
|
<dl>
|
|
2996
2996
|
<dd>
|
|
2997
2997
|
|
|
2998
|
-
Previews a shipper-to-courier statement showing task groups, line item groups, total amount, and readiness status.
|
|
2998
|
+
Previews a shipper-to-courier statement showing task groups, line item groups, total amount, and readiness status. | (CreateShipperPayCourierStatementReq) -> (StatementPreviewResponse)
|
|
2999
2999
|
|
|
3000
3000
|
</dd>
|
|
3001
3001
|
</dl>
|
|
@@ -4232,6 +4232,71 @@ await client.dev.getGitInfoV1();
|
|
|
4232
4232
|
</dl>
|
|
4233
4233
|
</details>
|
|
4234
4234
|
|
|
4235
|
+
## Flights
|
|
4236
|
+
|
|
4237
|
+
<details><summary><code>client.flights.<a href="/src/api/resources/flights/client/Client.ts">getFlightInfoForTaskV1</a>(taskId) -> Chrt.FlightInfoForTaskRes</code></summary>
|
|
4238
|
+
<dl>
|
|
4239
|
+
<dd>
|
|
4240
|
+
|
|
4241
|
+
#### 📝 Description
|
|
4242
|
+
|
|
4243
|
+
<dl>
|
|
4244
|
+
<dd>
|
|
4245
|
+
|
|
4246
|
+
<dl>
|
|
4247
|
+
<dd>
|
|
4248
|
+
|
|
4249
|
+
Returns flight info from an adjacent FLIGHT task group for TENDER_TO_AIRLINE or RECOVER_FROM_AIRLINE tasks. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators, shipper_org_operators] | () -> (FlightInfoForTaskRes)
|
|
4250
|
+
|
|
4251
|
+
</dd>
|
|
4252
|
+
</dl>
|
|
4253
|
+
</dd>
|
|
4254
|
+
</dl>
|
|
4255
|
+
|
|
4256
|
+
#### 🔌 Usage
|
|
4257
|
+
|
|
4258
|
+
<dl>
|
|
4259
|
+
<dd>
|
|
4260
|
+
|
|
4261
|
+
<dl>
|
|
4262
|
+
<dd>
|
|
4263
|
+
|
|
4264
|
+
```typescript
|
|
4265
|
+
await client.flights.getFlightInfoForTaskV1("task_id");
|
|
4266
|
+
```
|
|
4267
|
+
|
|
4268
|
+
</dd>
|
|
4269
|
+
</dl>
|
|
4270
|
+
</dd>
|
|
4271
|
+
</dl>
|
|
4272
|
+
|
|
4273
|
+
#### ⚙️ Parameters
|
|
4274
|
+
|
|
4275
|
+
<dl>
|
|
4276
|
+
<dd>
|
|
4277
|
+
|
|
4278
|
+
<dl>
|
|
4279
|
+
<dd>
|
|
4280
|
+
|
|
4281
|
+
**taskId:** `string`
|
|
4282
|
+
|
|
4283
|
+
</dd>
|
|
4284
|
+
</dl>
|
|
4285
|
+
|
|
4286
|
+
<dl>
|
|
4287
|
+
<dd>
|
|
4288
|
+
|
|
4289
|
+
**requestOptions:** `Flights.RequestOptions`
|
|
4290
|
+
|
|
4291
|
+
</dd>
|
|
4292
|
+
</dl>
|
|
4293
|
+
</dd>
|
|
4294
|
+
</dl>
|
|
4295
|
+
|
|
4296
|
+
</dd>
|
|
4297
|
+
</dl>
|
|
4298
|
+
</details>
|
|
4299
|
+
|
|
4235
4300
|
## TaskArtifactNotifications
|
|
4236
4301
|
|
|
4237
4302
|
<details><summary><code>client.taskArtifactNotifications.<a href="/src/api/resources/taskArtifactNotifications/client/Client.ts">getPreferencesV1</a>() -> Chrt.TaskArtifactNotificationPreferences1</code></summary>
|
|
@@ -4618,7 +4683,7 @@ await client.drivers.listV1({
|
|
|
4618
4683
|
<dl>
|
|
4619
4684
|
<dd>
|
|
4620
4685
|
|
|
4621
|
-
Creates a new driver profile for the caller.
|
|
4686
|
+
Creates a new driver profile for the target user (defaults to caller). Drivers can create themselves; operators+ can create any org member. Courier orgs only. | (DriverClientCreate1) -> (PydanticObjectId)
|
|
4622
4687
|
|
|
4623
4688
|
</dd>
|
|
4624
4689
|
</dl>
|
|
@@ -4635,6 +4700,7 @@ Creates a new driver profile for the caller. Returns existing driver ID if one a
|
|
|
4635
4700
|
|
|
4636
4701
|
```typescript
|
|
4637
4702
|
await client.drivers.createV1({
|
|
4703
|
+
target_user_id: "target_user_id",
|
|
4638
4704
|
schema_version: 1,
|
|
4639
4705
|
});
|
|
4640
4706
|
```
|
|
@@ -6265,7 +6331,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
6265
6331
|
</dl>
|
|
6266
6332
|
</details>
|
|
6267
6333
|
|
|
6268
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">
|
|
6334
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">setFlightInfoV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6269
6335
|
<dl>
|
|
6270
6336
|
<dd>
|
|
6271
6337
|
|
|
@@ -6277,7 +6343,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
6277
6343
|
<dl>
|
|
6278
6344
|
<dd>
|
|
6279
6345
|
|
|
6280
|
-
Sets the flight number
|
|
6346
|
+
Sets the flight number and/or fa_flight_id on a task group. | authz_personas=[lig_org_operators] | (SetFlightInfoReq) -> (bool)
|
|
6281
6347
|
|
|
6282
6348
|
</dd>
|
|
6283
6349
|
</dl>
|
|
@@ -6293,9 +6359,7 @@ Sets the flight number on a task group, plus any TENDER_TO_AIRLINE tasks in the
|
|
|
6293
6359
|
<dd>
|
|
6294
6360
|
|
|
6295
6361
|
```typescript
|
|
6296
|
-
await client.taskGroups.
|
|
6297
|
-
flight_number: "flight_number",
|
|
6298
|
-
});
|
|
6362
|
+
await client.taskGroups.setFlightInfoV1("task_group_id", {});
|
|
6299
6363
|
```
|
|
6300
6364
|
|
|
6301
6365
|
</dd>
|
|
@@ -6319,7 +6383,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6319
6383
|
<dl>
|
|
6320
6384
|
<dd>
|
|
6321
6385
|
|
|
6322
|
-
**request:** `Chrt.
|
|
6386
|
+
**request:** `Chrt.SetFlightInfoReq`
|
|
6323
6387
|
|
|
6324
6388
|
</dd>
|
|
6325
6389
|
</dl>
|
|
@@ -8743,7 +8807,7 @@ await client.connections.connectionToForwarder.createV1({
|
|
|
8743
8807
|
<dl>
|
|
8744
8808
|
<dd>
|
|
8745
8809
|
|
|
8746
|
-
Adds additional line items to an existing courier driver line item group.
|
|
8810
|
+
Adds additional line items to an existing courier driver line item group. | (CourierPayDriverLineItemGroupAddLineItemsReq) -> (CourierPayDriverLineItemGroup1)
|
|
8747
8811
|
|
|
8748
8812
|
</dd>
|
|
8749
8813
|
</dl>
|
|
@@ -8825,7 +8889,7 @@ await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
8825
8889
|
<dl>
|
|
8826
8890
|
<dd>
|
|
8827
8891
|
|
|
8828
|
-
Removes specific line items from a courier driver line item group by their UUID identifiers.
|
|
8892
|
+
Removes specific line items from a courier driver line item group by their UUID identifiers. | (CourierPayDriverLineItemGroupRemoveLineItemsReq) -> (CourierPayDriverLineItemGroup1)
|
|
8829
8893
|
|
|
8830
8894
|
</dd>
|
|
8831
8895
|
</dl>
|
|
@@ -9198,7 +9262,7 @@ await client.orderDrafts.taskGroup.addV1({
|
|
|
9198
9262
|
</dl>
|
|
9199
9263
|
</details>
|
|
9200
9264
|
|
|
9201
|
-
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">
|
|
9265
|
+
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">setFlightInfoV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
9202
9266
|
<dl>
|
|
9203
9267
|
<dd>
|
|
9204
9268
|
|
|
@@ -9210,7 +9274,7 @@ await client.orderDrafts.taskGroup.addV1({
|
|
|
9210
9274
|
<dl>
|
|
9211
9275
|
<dd>
|
|
9212
9276
|
|
|
9213
|
-
Sets the flight number on a draft task group. | (
|
|
9277
|
+
Sets the flight number and/or fa_flight_id on a draft task group. | (SetFlightInfoReq) -> (bool)
|
|
9214
9278
|
|
|
9215
9279
|
</dd>
|
|
9216
9280
|
</dl>
|
|
@@ -9226,9 +9290,7 @@ Sets the flight number on a draft task group. | (SetFlightNumberDraftReq) -> (bo
|
|
|
9226
9290
|
<dd>
|
|
9227
9291
|
|
|
9228
9292
|
```typescript
|
|
9229
|
-
await client.orderDrafts.taskGroup.
|
|
9230
|
-
flight_number: "flight_number",
|
|
9231
|
-
});
|
|
9293
|
+
await client.orderDrafts.taskGroup.setFlightInfoV1("task_group_id", {});
|
|
9232
9294
|
```
|
|
9233
9295
|
|
|
9234
9296
|
</dd>
|
|
@@ -9252,7 +9314,7 @@ await client.orderDrafts.taskGroup.setFlightNumberV1("task_group_id", {
|
|
|
9252
9314
|
<dl>
|
|
9253
9315
|
<dd>
|
|
9254
9316
|
|
|
9255
|
-
**request:** `Chrt.
|
|
9317
|
+
**request:** `Chrt.SetFlightInfoReq`
|
|
9256
9318
|
|
|
9257
9319
|
</dd>
|
|
9258
9320
|
</dl>
|
|
@@ -10369,7 +10431,7 @@ await client.orders.expanded.forForwarderOperatorsV1("order_id_or_short_id", {})
|
|
|
10369
10431
|
<dl>
|
|
10370
10432
|
<dd>
|
|
10371
10433
|
|
|
10372
|
-
Lists expanded orders for forwarder operators with filtering, sorting, and pagination. |
|
|
10434
|
+
Lists expanded orders for forwarder operators with filtering, sorting, and pagination. | authz: allowed_org_types=[forwarder], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
|
|
10373
10435
|
|
|
10374
10436
|
</dd>
|
|
10375
10437
|
</dl>
|
|
@@ -10450,7 +10512,7 @@ await client.orders.expanded.listForForwarderOperatorsV1({
|
|
|
10450
10512
|
<dl>
|
|
10451
10513
|
<dd>
|
|
10452
10514
|
|
|
10453
|
-
Lists expanded orders for shipper operators with filtering, sorting, and pagination. |
|
|
10515
|
+
Lists expanded orders for shipper operators with filtering, sorting, and pagination. | authz: allowed_org_types=[shipper], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
|
|
10454
10516
|
|
|
10455
10517
|
</dd>
|
|
10456
10518
|
</dl>
|
|
@@ -11146,7 +11208,7 @@ await client.orgInfoForConnections.forwarder.updateV1();
|
|
|
11146
11208
|
<dl>
|
|
11147
11209
|
<dd>
|
|
11148
11210
|
|
|
11149
|
-
Lists all shipper pay courier line item groups for the caller's shipper organization.
|
|
11211
|
+
Lists all shipper pay courier line item groups for the caller's shipper organization. | () -> (list[ShipperPayCourierLineItemGroup1])
|
|
11150
11212
|
|
|
11151
11213
|
</dd>
|
|
11152
11214
|
</dl>
|
|
@@ -11201,7 +11263,7 @@ await client.shipperPayCourierLineItemGroups.shipper.listV1();
|
|
|
11201
11263
|
<dl>
|
|
11202
11264
|
<dd>
|
|
11203
11265
|
|
|
11204
|
-
Retrieves a shipper pay courier line item group by its ID for the caller's shipper organization.
|
|
11266
|
+
Retrieves a shipper pay courier line item group by its ID for the caller's shipper organization. | () -> (ShipperPayCourierLineItemGroup1)
|
|
11205
11267
|
|
|
11206
11268
|
</dd>
|
|
11207
11269
|
</dl>
|
|
@@ -11264,7 +11326,7 @@ await client.shipperPayCourierLineItemGroups.shipper.getByIdV1("id");
|
|
|
11264
11326
|
<dl>
|
|
11265
11327
|
<dd>
|
|
11266
11328
|
|
|
11267
|
-
Retrieves a shipper pay courier line item group by its associated task group ID for the caller's shipper organization.
|
|
11329
|
+
Retrieves a shipper pay courier line item group by its associated task group ID for the caller's shipper organization. | () -> (ShipperPayCourierLineItemGroup1)
|
|
11268
11330
|
|
|
11269
11331
|
</dd>
|
|
11270
11332
|
</dl>
|
|
@@ -11329,7 +11391,7 @@ await client.shipperPayCourierLineItemGroups.shipper.byTaskGroupIdV1("task_group
|
|
|
11329
11391
|
<dl>
|
|
11330
11392
|
<dd>
|
|
11331
11393
|
|
|
11332
|
-
Lists all shipper pay courier line item groups for the caller's courier organization.
|
|
11394
|
+
Lists all shipper pay courier line item groups for the caller's courier organization. | () -> (list[ShipperPayCourierLineItemGroup1])
|
|
11333
11395
|
|
|
11334
11396
|
</dd>
|
|
11335
11397
|
</dl>
|
|
@@ -11386,7 +11448,7 @@ await client.shipperPayCourierLineItemGroups.courier.listV1();
|
|
|
11386
11448
|
<dl>
|
|
11387
11449
|
<dd>
|
|
11388
11450
|
|
|
11389
|
-
Adds additional line items to an existing shipper pay courier line item group.
|
|
11451
|
+
Adds additional line items to an existing shipper pay courier line item group. | (ShipperPayCourierLineItemGroupAddLineItemsReq) -> (ShipperPayCourierLineItemGroup1)
|
|
11390
11452
|
|
|
11391
11453
|
</dd>
|
|
11392
11454
|
</dl>
|
|
@@ -11468,7 +11530,7 @@ await client.shipperPayCourierLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
11468
11530
|
<dl>
|
|
11469
11531
|
<dd>
|
|
11470
11532
|
|
|
11471
|
-
Removes specific line items from a shipper pay courier line item group by their UUID identifiers.
|
|
11533
|
+
Removes specific line items from a shipper pay courier line item group by their UUID identifiers. | (ShipperPayCourierLineItemGroupRemoveLineItemsReq) -> (ShipperPayCourierLineItemGroup1)
|
|
11472
11534
|
|
|
11473
11535
|
</dd>
|
|
11474
11536
|
</dl>
|
|
@@ -12633,9 +12695,9 @@ await client.taskGroups.expanded.listForCourierDriverV1({
|
|
|
12633
12695
|
</dl>
|
|
12634
12696
|
</details>
|
|
12635
12697
|
|
|
12636
|
-
## Tracking
|
|
12698
|
+
## Tracking Devices
|
|
12637
12699
|
|
|
12638
|
-
<details><summary><code>client.tracking.
|
|
12700
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">registerToOrgV1</a>({ ...params }) -> string</code></summary>
|
|
12639
12701
|
<dl>
|
|
12640
12702
|
<dd>
|
|
12641
12703
|
|
|
@@ -12647,7 +12709,7 @@ await client.taskGroups.expanded.listForCourierDriverV1({
|
|
|
12647
12709
|
<dl>
|
|
12648
12710
|
<dd>
|
|
12649
12711
|
|
|
12650
|
-
|
|
12712
|
+
Registers a tracking device to the caller's organization. If device is already registered to a different organization, registration is blocked. | (DevicesRegisterToOrgReq1) -> (PydanticObjectId)
|
|
12651
12713
|
|
|
12652
12714
|
</dd>
|
|
12653
12715
|
</dl>
|
|
@@ -12663,9 +12725,8 @@ Returns the most recent device location data point for cargo within a task group
|
|
|
12663
12725
|
<dd>
|
|
12664
12726
|
|
|
12665
12727
|
```typescript
|
|
12666
|
-
await client.tracking.
|
|
12667
|
-
|
|
12668
|
-
task_group_id: "task_group_id",
|
|
12728
|
+
await client.tracking.devices.registerToOrgV1({
|
|
12729
|
+
device_mac_address: "device_mac_address",
|
|
12669
12730
|
});
|
|
12670
12731
|
```
|
|
12671
12732
|
|
|
@@ -12682,7 +12743,7 @@ await client.tracking.cargoByDevice.lastSeenV1({
|
|
|
12682
12743
|
<dl>
|
|
12683
12744
|
<dd>
|
|
12684
12745
|
|
|
12685
|
-
**request:** `Chrt.tracking.
|
|
12746
|
+
**request:** `Chrt.tracking.DevicesRegisterToOrgReq1`
|
|
12686
12747
|
|
|
12687
12748
|
</dd>
|
|
12688
12749
|
</dl>
|
|
@@ -12690,7 +12751,7 @@ await client.tracking.cargoByDevice.lastSeenV1({
|
|
|
12690
12751
|
<dl>
|
|
12691
12752
|
<dd>
|
|
12692
12753
|
|
|
12693
|
-
**requestOptions:** `
|
|
12754
|
+
**requestOptions:** `Devices.RequestOptions`
|
|
12694
12755
|
|
|
12695
12756
|
</dd>
|
|
12696
12757
|
</dl>
|
|
@@ -12701,9 +12762,7 @@ await client.tracking.cargoByDevice.lastSeenV1({
|
|
|
12701
12762
|
</dl>
|
|
12702
12763
|
</details>
|
|
12703
12764
|
|
|
12704
|
-
|
|
12705
|
-
|
|
12706
|
-
<details><summary><code>client.tracking.cargoByDriver.<a href="/src/api/resources/tracking/resources/cargoByDriver/client/Client.ts">lastSeenV1</a>({ ...params }) -> (Chrt.TrackingCargoByDriverDataPoint1 | null) | undefined</code></summary>
|
|
12765
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
12707
12766
|
<dl>
|
|
12708
12767
|
<dd>
|
|
12709
12768
|
|
|
@@ -12715,7 +12774,7 @@ await client.tracking.cargoByDevice.lastSeenV1({
|
|
|
12715
12774
|
<dl>
|
|
12716
12775
|
<dd>
|
|
12717
12776
|
|
|
12718
|
-
|
|
12777
|
+
Updates a device's type and/or comments. Can update one or both fields, or delete them by setting delete flags. | (DevicesUpdateRequest1) -> (bool)
|
|
12719
12778
|
|
|
12720
12779
|
</dd>
|
|
12721
12780
|
</dl>
|
|
@@ -12731,10 +12790,7 @@ Returns the most recent driver location data point for cargo within a task group
|
|
|
12731
12790
|
<dd>
|
|
12732
12791
|
|
|
12733
12792
|
```typescript
|
|
12734
|
-
await client.tracking.
|
|
12735
|
-
cargo_id: "cargo_id",
|
|
12736
|
-
task_group_id: "task_group_id",
|
|
12737
|
-
});
|
|
12793
|
+
await client.tracking.devices.updateV1();
|
|
12738
12794
|
```
|
|
12739
12795
|
|
|
12740
12796
|
</dd>
|
|
@@ -12750,7 +12806,7 @@ await client.tracking.cargoByDriver.lastSeenV1({
|
|
|
12750
12806
|
<dl>
|
|
12751
12807
|
<dd>
|
|
12752
12808
|
|
|
12753
|
-
**request:** `Chrt.tracking.
|
|
12809
|
+
**request:** `Chrt.tracking.DevicesUpdateRequest1`
|
|
12754
12810
|
|
|
12755
12811
|
</dd>
|
|
12756
12812
|
</dl>
|
|
@@ -12758,7 +12814,7 @@ await client.tracking.cargoByDriver.lastSeenV1({
|
|
|
12758
12814
|
<dl>
|
|
12759
12815
|
<dd>
|
|
12760
12816
|
|
|
12761
|
-
**requestOptions:** `
|
|
12817
|
+
**requestOptions:** `Devices.RequestOptions`
|
|
12762
12818
|
|
|
12763
12819
|
</dd>
|
|
12764
12820
|
</dl>
|
|
@@ -12769,9 +12825,7 @@ await client.tracking.cargoByDriver.lastSeenV1({
|
|
|
12769
12825
|
</dl>
|
|
12770
12826
|
</details>
|
|
12771
12827
|
|
|
12772
|
-
|
|
12773
|
-
|
|
12774
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">registerToOrgV1</a>({ ...params }) -> string</code></summary>
|
|
12828
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">deleteV1</a>({ ...params }) -> boolean</code></summary>
|
|
12775
12829
|
<dl>
|
|
12776
12830
|
<dd>
|
|
12777
12831
|
|
|
@@ -12783,7 +12837,7 @@ await client.tracking.cargoByDriver.lastSeenV1({
|
|
|
12783
12837
|
<dl>
|
|
12784
12838
|
<dd>
|
|
12785
12839
|
|
|
12786
|
-
|
|
12840
|
+
Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. | () -> (bool)
|
|
12787
12841
|
|
|
12788
12842
|
</dd>
|
|
12789
12843
|
</dl>
|
|
@@ -12799,7 +12853,8 @@ Registers a tracking device to the caller's organization. If device is already r
|
|
|
12799
12853
|
<dd>
|
|
12800
12854
|
|
|
12801
12855
|
```typescript
|
|
12802
|
-
await client.tracking.devices.
|
|
12856
|
+
await client.tracking.devices.deleteV1({
|
|
12857
|
+
device_id: "device_id",
|
|
12803
12858
|
device_mac_address: "device_mac_address",
|
|
12804
12859
|
});
|
|
12805
12860
|
```
|
|
@@ -12817,7 +12872,7 @@ await client.tracking.devices.registerToOrgV1({
|
|
|
12817
12872
|
<dl>
|
|
12818
12873
|
<dd>
|
|
12819
12874
|
|
|
12820
|
-
**request:** `Chrt.tracking.
|
|
12875
|
+
**request:** `Chrt.tracking.DevicesDeleteV1Request`
|
|
12821
12876
|
|
|
12822
12877
|
</dd>
|
|
12823
12878
|
</dl>
|
|
@@ -12836,7 +12891,7 @@ await client.tracking.devices.registerToOrgV1({
|
|
|
12836
12891
|
</dl>
|
|
12837
12892
|
</details>
|
|
12838
12893
|
|
|
12839
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">
|
|
12894
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">linkToCargoV1</a>({ ...params }) -> boolean</code></summary>
|
|
12840
12895
|
<dl>
|
|
12841
12896
|
<dd>
|
|
12842
12897
|
|
|
@@ -12848,7 +12903,7 @@ await client.tracking.devices.registerToOrgV1({
|
|
|
12848
12903
|
<dl>
|
|
12849
12904
|
<dd>
|
|
12850
12905
|
|
|
12851
|
-
|
|
12906
|
+
Links a device to cargo with bidirectional references. Device must not already be linked to a session or different cargo. | () -> (bool)
|
|
12852
12907
|
|
|
12853
12908
|
</dd>
|
|
12854
12909
|
</dl>
|
|
@@ -12864,7 +12919,10 @@ Updates a device's type and/or comments. Can update one or both fields, or delet
|
|
|
12864
12919
|
<dd>
|
|
12865
12920
|
|
|
12866
12921
|
```typescript
|
|
12867
|
-
await client.tracking.devices.
|
|
12922
|
+
await client.tracking.devices.linkToCargoV1({
|
|
12923
|
+
device_mac_address: "device_mac_address",
|
|
12924
|
+
cargo_id: "cargo_id",
|
|
12925
|
+
});
|
|
12868
12926
|
```
|
|
12869
12927
|
|
|
12870
12928
|
</dd>
|
|
@@ -12880,7 +12938,7 @@ await client.tracking.devices.updateV1();
|
|
|
12880
12938
|
<dl>
|
|
12881
12939
|
<dd>
|
|
12882
12940
|
|
|
12883
|
-
**request:** `Chrt.tracking.
|
|
12941
|
+
**request:** `Chrt.tracking.DevicesLinkToCargoV1Request`
|
|
12884
12942
|
|
|
12885
12943
|
</dd>
|
|
12886
12944
|
</dl>
|
|
@@ -12899,7 +12957,7 @@ await client.tracking.devices.updateV1();
|
|
|
12899
12957
|
</dl>
|
|
12900
12958
|
</details>
|
|
12901
12959
|
|
|
12902
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">
|
|
12960
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">unlinkFromCargoV1</a>({ ...params }) -> boolean</code></summary>
|
|
12903
12961
|
<dl>
|
|
12904
12962
|
<dd>
|
|
12905
12963
|
|
|
@@ -12911,7 +12969,7 @@ await client.tracking.devices.updateV1();
|
|
|
12911
12969
|
<dl>
|
|
12912
12970
|
<dd>
|
|
12913
12971
|
|
|
12914
|
-
|
|
12972
|
+
Unlinks a device from its linked cargo, removing the bidirectional reference. Returns false if device is not linked to any cargo. | () -> (bool)
|
|
12915
12973
|
|
|
12916
12974
|
</dd>
|
|
12917
12975
|
</dl>
|
|
@@ -12927,8 +12985,7 @@ Deletes a device by ID or MAC address. Device must be unlinked from any session
|
|
|
12927
12985
|
<dd>
|
|
12928
12986
|
|
|
12929
12987
|
```typescript
|
|
12930
|
-
await client.tracking.devices.
|
|
12931
|
-
device_id: "device_id",
|
|
12988
|
+
await client.tracking.devices.unlinkFromCargoV1({
|
|
12932
12989
|
device_mac_address: "device_mac_address",
|
|
12933
12990
|
});
|
|
12934
12991
|
```
|
|
@@ -12946,7 +13003,7 @@ await client.tracking.devices.deleteV1({
|
|
|
12946
13003
|
<dl>
|
|
12947
13004
|
<dd>
|
|
12948
13005
|
|
|
12949
|
-
**request:** `Chrt.tracking.
|
|
13006
|
+
**request:** `Chrt.tracking.DevicesUnlinkFromCargoV1Request`
|
|
12950
13007
|
|
|
12951
13008
|
</dd>
|
|
12952
13009
|
</dl>
|
|
@@ -12977,7 +13034,7 @@ await client.tracking.devices.deleteV1({
|
|
|
12977
13034
|
<dl>
|
|
12978
13035
|
<dd>
|
|
12979
13036
|
|
|
12980
|
-
Retrieves a single device by its MAC address or ID. Access restricted to the caller's organization. | () -> (Device1)
|
|
13037
|
+
Retrieves a single device by its MAC address or ID. Access restricted to the caller's organization. | authz: min_org_role=operator | () -> (Device1)
|
|
12981
13038
|
|
|
12982
13039
|
</dd>
|
|
12983
13040
|
</dl>
|
|
@@ -13043,7 +13100,7 @@ await client.tracking.devices.getV1({
|
|
|
13043
13100
|
<dl>
|
|
13044
13101
|
<dd>
|
|
13045
13102
|
|
|
13046
|
-
Returns all tracking devices registered to the caller's organization. | () -> (list[Device1])
|
|
13103
|
+
Returns all tracking devices registered to the caller's organization. | authz: min_org_role=operator | () -> (list[Device1])
|
|
13047
13104
|
|
|
13048
13105
|
</dd>
|
|
13049
13106
|
</dl>
|
|
@@ -13086,7 +13143,9 @@ await client.tracking.devices.listV1();
|
|
|
13086
13143
|
</dl>
|
|
13087
13144
|
</details>
|
|
13088
13145
|
|
|
13089
|
-
|
|
13146
|
+
## Tracking Driver
|
|
13147
|
+
|
|
13148
|
+
<details><summary><code>client.tracking.driver.<a href="/src/api/resources/tracking/resources/driver/client/Client.ts">updateV1</a>({ ...params }) -> Chrt.DriverUpdateRes</code></summary>
|
|
13090
13149
|
<dl>
|
|
13091
13150
|
<dd>
|
|
13092
13151
|
|
|
@@ -13098,7 +13157,7 @@ await client.tracking.devices.listV1();
|
|
|
13098
13157
|
<dl>
|
|
13099
13158
|
<dd>
|
|
13100
13159
|
|
|
13101
|
-
|
|
13160
|
+
Records driver location updates. Automatically writes to all IN_PROGRESS task groups and their associated IN_TRANSIT cargos. Updates driver's last seen timestamp and location. | (DriverUpdateReq) -> (DriverUpdateRes)
|
|
13102
13161
|
|
|
13103
13162
|
</dd>
|
|
13104
13163
|
</dl>
|
|
@@ -13114,9 +13173,17 @@ Links a device to cargo with bidirectional references. Device must not already b
|
|
|
13114
13173
|
<dd>
|
|
13115
13174
|
|
|
13116
13175
|
```typescript
|
|
13117
|
-
await client.tracking.
|
|
13118
|
-
|
|
13119
|
-
|
|
13176
|
+
await client.tracking.driver.updateV1({
|
|
13177
|
+
type: "Feature",
|
|
13178
|
+
geometry: {
|
|
13179
|
+
type: "GeometryCollection",
|
|
13180
|
+
geometries: [
|
|
13181
|
+
{
|
|
13182
|
+
type: "LineString",
|
|
13183
|
+
coordinates: [[]],
|
|
13184
|
+
},
|
|
13185
|
+
],
|
|
13186
|
+
},
|
|
13120
13187
|
});
|
|
13121
13188
|
```
|
|
13122
13189
|
|
|
@@ -13133,7 +13200,7 @@ await client.tracking.devices.linkToCargoV1({
|
|
|
13133
13200
|
<dl>
|
|
13134
13201
|
<dd>
|
|
13135
13202
|
|
|
13136
|
-
**request:** `Chrt.
|
|
13203
|
+
**request:** `Chrt.LocationFeature`
|
|
13137
13204
|
|
|
13138
13205
|
</dd>
|
|
13139
13206
|
</dl>
|
|
@@ -13141,7 +13208,7 @@ await client.tracking.devices.linkToCargoV1({
|
|
|
13141
13208
|
<dl>
|
|
13142
13209
|
<dd>
|
|
13143
13210
|
|
|
13144
|
-
**requestOptions:** `
|
|
13211
|
+
**requestOptions:** `Driver.RequestOptions`
|
|
13145
13212
|
|
|
13146
13213
|
</dd>
|
|
13147
13214
|
</dl>
|
|
@@ -13152,7 +13219,9 @@ await client.tracking.devices.linkToCargoV1({
|
|
|
13152
13219
|
</dl>
|
|
13153
13220
|
</details>
|
|
13154
13221
|
|
|
13155
|
-
|
|
13222
|
+
## Tracking Sessions
|
|
13223
|
+
|
|
13224
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">listV1</a>() -> Chrt.Session1[]</code></summary>
|
|
13156
13225
|
<dl>
|
|
13157
13226
|
<dd>
|
|
13158
13227
|
|
|
@@ -13164,7 +13233,7 @@ await client.tracking.devices.linkToCargoV1({
|
|
|
13164
13233
|
<dl>
|
|
13165
13234
|
<dd>
|
|
13166
13235
|
|
|
13167
|
-
|
|
13236
|
+
Returns all tracking sessions for the caller's organization. | () -> (list[Session1])
|
|
13168
13237
|
|
|
13169
13238
|
</dd>
|
|
13170
13239
|
</dl>
|
|
@@ -13180,9 +13249,7 @@ Unlinks a device from its linked cargo, removing the bidirectional reference. Re
|
|
|
13180
13249
|
<dd>
|
|
13181
13250
|
|
|
13182
13251
|
```typescript
|
|
13183
|
-
await client.tracking.
|
|
13184
|
-
device_mac_address: "device_mac_address",
|
|
13185
|
-
});
|
|
13252
|
+
await client.tracking.sessions.listV1();
|
|
13186
13253
|
```
|
|
13187
13254
|
|
|
13188
13255
|
</dd>
|
|
@@ -13198,15 +13265,7 @@ await client.tracking.devices.unlinkFromCargoV1({
|
|
|
13198
13265
|
<dl>
|
|
13199
13266
|
<dd>
|
|
13200
13267
|
|
|
13201
|
-
**
|
|
13202
|
-
|
|
13203
|
-
</dd>
|
|
13204
|
-
</dl>
|
|
13205
|
-
|
|
13206
|
-
<dl>
|
|
13207
|
-
<dd>
|
|
13208
|
-
|
|
13209
|
-
**requestOptions:** `Devices.RequestOptions`
|
|
13268
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13210
13269
|
|
|
13211
13270
|
</dd>
|
|
13212
13271
|
</dl>
|
|
@@ -13217,9 +13276,7 @@ await client.tracking.devices.unlinkFromCargoV1({
|
|
|
13217
13276
|
</dl>
|
|
13218
13277
|
</details>
|
|
13219
13278
|
|
|
13220
|
-
|
|
13221
|
-
|
|
13222
|
-
<details><summary><code>client.tracking.driver.<a href="/src/api/resources/tracking/resources/driver/client/Client.ts">updateV1</a>({ ...params }) -> Chrt.DriverUpdateRes</code></summary>
|
|
13279
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">getV1</a>({ ...params }) -> Chrt.Session1</code></summary>
|
|
13223
13280
|
<dl>
|
|
13224
13281
|
<dd>
|
|
13225
13282
|
|
|
@@ -13231,7 +13288,7 @@ await client.tracking.devices.unlinkFromCargoV1({
|
|
|
13231
13288
|
<dl>
|
|
13232
13289
|
<dd>
|
|
13233
13290
|
|
|
13234
|
-
|
|
13291
|
+
Retrieves a single session by its ID. Access restricted to the caller's organization. | () -> (Session1)
|
|
13235
13292
|
|
|
13236
13293
|
</dd>
|
|
13237
13294
|
</dl>
|
|
@@ -13247,21 +13304,8 @@ Records driver location updates for a task group. Automatically writes to task g
|
|
|
13247
13304
|
<dd>
|
|
13248
13305
|
|
|
13249
13306
|
```typescript
|
|
13250
|
-
await client.tracking.
|
|
13251
|
-
|
|
13252
|
-
timestamp: "2024-01-15T09:30:00Z",
|
|
13253
|
-
location: {
|
|
13254
|
-
type: "Feature",
|
|
13255
|
-
geometry: {
|
|
13256
|
-
type: "GeometryCollection",
|
|
13257
|
-
geometries: [
|
|
13258
|
-
{
|
|
13259
|
-
type: "LineString",
|
|
13260
|
-
coordinates: [[]],
|
|
13261
|
-
},
|
|
13262
|
-
],
|
|
13263
|
-
},
|
|
13264
|
-
},
|
|
13307
|
+
await client.tracking.sessions.getV1({
|
|
13308
|
+
session_id: "session_id",
|
|
13265
13309
|
});
|
|
13266
13310
|
```
|
|
13267
13311
|
|
|
@@ -13278,7 +13322,7 @@ await client.tracking.driver.updateV1({
|
|
|
13278
13322
|
<dl>
|
|
13279
13323
|
<dd>
|
|
13280
13324
|
|
|
13281
|
-
**request:** `Chrt.tracking.
|
|
13325
|
+
**request:** `Chrt.tracking.SessionsGetV1Request`
|
|
13282
13326
|
|
|
13283
13327
|
</dd>
|
|
13284
13328
|
</dl>
|
|
@@ -13286,7 +13330,7 @@ await client.tracking.driver.updateV1({
|
|
|
13286
13330
|
<dl>
|
|
13287
13331
|
<dd>
|
|
13288
13332
|
|
|
13289
|
-
**requestOptions:** `
|
|
13333
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13290
13334
|
|
|
13291
13335
|
</dd>
|
|
13292
13336
|
</dl>
|
|
@@ -13297,9 +13341,7 @@ await client.tracking.driver.updateV1({
|
|
|
13297
13341
|
</dl>
|
|
13298
13342
|
</details>
|
|
13299
13343
|
|
|
13300
|
-
|
|
13301
|
-
|
|
13302
|
-
<details><summary><code>client.tracking.sessionByDevice.<a href="/src/api/resources/tracking/resources/sessionByDevice/client/Client.ts">listV1</a>() -> Chrt.Session1[]</code></summary>
|
|
13344
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">createSessionV1</a>({ ...params }) -> string</code></summary>
|
|
13303
13345
|
<dl>
|
|
13304
13346
|
<dd>
|
|
13305
13347
|
|
|
@@ -13311,7 +13353,7 @@ await client.tracking.driver.updateV1({
|
|
|
13311
13353
|
<dl>
|
|
13312
13354
|
<dd>
|
|
13313
13355
|
|
|
13314
|
-
|
|
13356
|
+
Creates a new tracking session for a device and links the device to it. The device must be registered to the caller's organization. | (SessionCreateSessionRequest1) -> (PydanticObjectId)
|
|
13315
13357
|
|
|
13316
13358
|
</dd>
|
|
13317
13359
|
</dl>
|
|
@@ -13327,7 +13369,9 @@ Returns all tracking sessions for the caller's organization. | () -> (list[Sessi
|
|
|
13327
13369
|
<dd>
|
|
13328
13370
|
|
|
13329
13371
|
```typescript
|
|
13330
|
-
await client.tracking.
|
|
13372
|
+
await client.tracking.sessions.createSessionV1({
|
|
13373
|
+
device_mac_address: "device_mac_address",
|
|
13374
|
+
});
|
|
13331
13375
|
```
|
|
13332
13376
|
|
|
13333
13377
|
</dd>
|
|
@@ -13343,7 +13387,15 @@ await client.tracking.sessionByDevice.listV1();
|
|
|
13343
13387
|
<dl>
|
|
13344
13388
|
<dd>
|
|
13345
13389
|
|
|
13346
|
-
**
|
|
13390
|
+
**request:** `Chrt.tracking.SessionCreateSessionRequest1`
|
|
13391
|
+
|
|
13392
|
+
</dd>
|
|
13393
|
+
</dl>
|
|
13394
|
+
|
|
13395
|
+
<dl>
|
|
13396
|
+
<dd>
|
|
13397
|
+
|
|
13398
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13347
13399
|
|
|
13348
13400
|
</dd>
|
|
13349
13401
|
</dl>
|
|
@@ -13354,7 +13406,7 @@ await client.tracking.sessionByDevice.listV1();
|
|
|
13354
13406
|
</dl>
|
|
13355
13407
|
</details>
|
|
13356
13408
|
|
|
13357
|
-
<details><summary><code>client.tracking.
|
|
13409
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
13358
13410
|
<dl>
|
|
13359
13411
|
<dd>
|
|
13360
13412
|
|
|
@@ -13366,7 +13418,7 @@ await client.tracking.sessionByDevice.listV1();
|
|
|
13366
13418
|
<dl>
|
|
13367
13419
|
<dd>
|
|
13368
13420
|
|
|
13369
|
-
|
|
13421
|
+
Updates a session's comments and/or public visibility status. Can update one or both fields. | (SessionUpdateRequest1) -> (bool)
|
|
13370
13422
|
|
|
13371
13423
|
</dd>
|
|
13372
13424
|
</dl>
|
|
@@ -13382,7 +13434,7 @@ Retrieves a single session by its ID. Access restricted to the caller's organiza
|
|
|
13382
13434
|
<dd>
|
|
13383
13435
|
|
|
13384
13436
|
```typescript
|
|
13385
|
-
await client.tracking.
|
|
13437
|
+
await client.tracking.sessions.updateV1({
|
|
13386
13438
|
session_id: "session_id",
|
|
13387
13439
|
});
|
|
13388
13440
|
```
|
|
@@ -13400,7 +13452,7 @@ await client.tracking.sessionByDevice.getV1({
|
|
|
13400
13452
|
<dl>
|
|
13401
13453
|
<dd>
|
|
13402
13454
|
|
|
13403
|
-
**request:** `Chrt.tracking.
|
|
13455
|
+
**request:** `Chrt.tracking.SessionUpdateRequest1`
|
|
13404
13456
|
|
|
13405
13457
|
</dd>
|
|
13406
13458
|
</dl>
|
|
@@ -13408,7 +13460,7 @@ await client.tracking.sessionByDevice.getV1({
|
|
|
13408
13460
|
<dl>
|
|
13409
13461
|
<dd>
|
|
13410
13462
|
|
|
13411
|
-
**requestOptions:** `
|
|
13463
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13412
13464
|
|
|
13413
13465
|
</dd>
|
|
13414
13466
|
</dl>
|
|
@@ -13419,7 +13471,7 @@ await client.tracking.sessionByDevice.getV1({
|
|
|
13419
13471
|
</dl>
|
|
13420
13472
|
</details>
|
|
13421
13473
|
|
|
13422
|
-
<details><summary><code>client.tracking.
|
|
13474
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">startV1</a>({ ...params }) -> boolean</code></summary>
|
|
13423
13475
|
<dl>
|
|
13424
13476
|
<dd>
|
|
13425
13477
|
|
|
@@ -13431,7 +13483,7 @@ await client.tracking.sessionByDevice.getV1({
|
|
|
13431
13483
|
<dl>
|
|
13432
13484
|
<dd>
|
|
13433
13485
|
|
|
13434
|
-
|
|
13486
|
+
Starts location recording for a session by setting recording status to true. Sets the recording initiated timestamp on first start. | () -> (bool)
|
|
13435
13487
|
|
|
13436
13488
|
</dd>
|
|
13437
13489
|
</dl>
|
|
@@ -13447,7 +13499,7 @@ Returns the most recent data point for a session, excluding outliers. Access res
|
|
|
13447
13499
|
<dd>
|
|
13448
13500
|
|
|
13449
13501
|
```typescript
|
|
13450
|
-
await client.tracking.
|
|
13502
|
+
await client.tracking.sessions.startV1({
|
|
13451
13503
|
session_id: "session_id",
|
|
13452
13504
|
});
|
|
13453
13505
|
```
|
|
@@ -13465,7 +13517,7 @@ await client.tracking.sessionByDevice.lastSeenV1({
|
|
|
13465
13517
|
<dl>
|
|
13466
13518
|
<dd>
|
|
13467
13519
|
|
|
13468
|
-
**request:** `Chrt.tracking.
|
|
13520
|
+
**request:** `Chrt.tracking.SessionsStartV1Request`
|
|
13469
13521
|
|
|
13470
13522
|
</dd>
|
|
13471
13523
|
</dl>
|
|
@@ -13473,7 +13525,7 @@ await client.tracking.sessionByDevice.lastSeenV1({
|
|
|
13473
13525
|
<dl>
|
|
13474
13526
|
<dd>
|
|
13475
13527
|
|
|
13476
|
-
**requestOptions:** `
|
|
13528
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13477
13529
|
|
|
13478
13530
|
</dd>
|
|
13479
13531
|
</dl>
|
|
@@ -13484,7 +13536,7 @@ await client.tracking.sessionByDevice.lastSeenV1({
|
|
|
13484
13536
|
</dl>
|
|
13485
13537
|
</details>
|
|
13486
13538
|
|
|
13487
|
-
<details><summary><code>client.tracking.
|
|
13539
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">pauseRecordingV1</a>({ ...params }) -> boolean</code></summary>
|
|
13488
13540
|
<dl>
|
|
13489
13541
|
<dd>
|
|
13490
13542
|
|
|
@@ -13496,7 +13548,7 @@ await client.tracking.sessionByDevice.lastSeenV1({
|
|
|
13496
13548
|
<dl>
|
|
13497
13549
|
<dd>
|
|
13498
13550
|
|
|
13499
|
-
|
|
13551
|
+
Pauses location recording for a session by setting recording status to false. Device remains linked to the session. | () -> (bool)
|
|
13500
13552
|
|
|
13501
13553
|
</dd>
|
|
13502
13554
|
</dl>
|
|
@@ -13512,9 +13564,8 @@ Returns up to the specified number of data points for a session, intelligently s
|
|
|
13512
13564
|
<dd>
|
|
13513
13565
|
|
|
13514
13566
|
```typescript
|
|
13515
|
-
await client.tracking.
|
|
13567
|
+
await client.tracking.sessions.pauseRecordingV1({
|
|
13516
13568
|
session_id: "session_id",
|
|
13517
|
-
limit: 1,
|
|
13518
13569
|
});
|
|
13519
13570
|
```
|
|
13520
13571
|
|
|
@@ -13531,7 +13582,7 @@ await client.tracking.sessionByDevice.dataPointsV1({
|
|
|
13531
13582
|
<dl>
|
|
13532
13583
|
<dd>
|
|
13533
13584
|
|
|
13534
|
-
**request:** `Chrt.tracking.
|
|
13585
|
+
**request:** `Chrt.tracking.SessionsPauseRecordingV1Request`
|
|
13535
13586
|
|
|
13536
13587
|
</dd>
|
|
13537
13588
|
</dl>
|
|
@@ -13539,7 +13590,7 @@ await client.tracking.sessionByDevice.dataPointsV1({
|
|
|
13539
13590
|
<dl>
|
|
13540
13591
|
<dd>
|
|
13541
13592
|
|
|
13542
|
-
**requestOptions:** `
|
|
13593
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13543
13594
|
|
|
13544
13595
|
</dd>
|
|
13545
13596
|
</dl>
|
|
@@ -13550,7 +13601,7 @@ await client.tracking.sessionByDevice.dataPointsV1({
|
|
|
13550
13601
|
</dl>
|
|
13551
13602
|
</details>
|
|
13552
13603
|
|
|
13553
|
-
<details><summary><code>client.tracking.
|
|
13604
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">resumeRecordingV1</a>({ ...params }) -> boolean</code></summary>
|
|
13554
13605
|
<dl>
|
|
13555
13606
|
<dd>
|
|
13556
13607
|
|
|
@@ -13562,7 +13613,7 @@ await client.tracking.sessionByDevice.dataPointsV1({
|
|
|
13562
13613
|
<dl>
|
|
13563
13614
|
<dd>
|
|
13564
13615
|
|
|
13565
|
-
|
|
13616
|
+
Resumes location recording for a session by setting recording status to true. | () -> (bool)
|
|
13566
13617
|
|
|
13567
13618
|
</dd>
|
|
13568
13619
|
</dl>
|
|
@@ -13578,8 +13629,8 @@ Creates a new tracking session for a device and links the device to it. The devi
|
|
|
13578
13629
|
<dd>
|
|
13579
13630
|
|
|
13580
13631
|
```typescript
|
|
13581
|
-
await client.tracking.
|
|
13582
|
-
|
|
13632
|
+
await client.tracking.sessions.resumeRecordingV1({
|
|
13633
|
+
session_id: "session_id",
|
|
13583
13634
|
});
|
|
13584
13635
|
```
|
|
13585
13636
|
|
|
@@ -13596,7 +13647,7 @@ await client.tracking.sessionByDevice.createSessionV1({
|
|
|
13596
13647
|
<dl>
|
|
13597
13648
|
<dd>
|
|
13598
13649
|
|
|
13599
|
-
**request:** `Chrt.tracking.
|
|
13650
|
+
**request:** `Chrt.tracking.SessionsResumeRecordingV1Request`
|
|
13600
13651
|
|
|
13601
13652
|
</dd>
|
|
13602
13653
|
</dl>
|
|
@@ -13604,7 +13655,7 @@ await client.tracking.sessionByDevice.createSessionV1({
|
|
|
13604
13655
|
<dl>
|
|
13605
13656
|
<dd>
|
|
13606
13657
|
|
|
13607
|
-
**requestOptions:** `
|
|
13658
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13608
13659
|
|
|
13609
13660
|
</dd>
|
|
13610
13661
|
</dl>
|
|
@@ -13615,7 +13666,7 @@ await client.tracking.sessionByDevice.createSessionV1({
|
|
|
13615
13666
|
</dl>
|
|
13616
13667
|
</details>
|
|
13617
13668
|
|
|
13618
|
-
<details><summary><code>client.tracking.
|
|
13669
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">terminateV1</a>({ ...params }) -> boolean</code></summary>
|
|
13619
13670
|
<dl>
|
|
13620
13671
|
<dd>
|
|
13621
13672
|
|
|
@@ -13627,7 +13678,7 @@ await client.tracking.sessionByDevice.createSessionV1({
|
|
|
13627
13678
|
<dl>
|
|
13628
13679
|
<dd>
|
|
13629
13680
|
|
|
13630
|
-
|
|
13681
|
+
Terminates a session by setting recording to false and marking it as terminated. Unlinks the device from the session. | () -> (bool)
|
|
13631
13682
|
|
|
13632
13683
|
</dd>
|
|
13633
13684
|
</dl>
|
|
@@ -13643,7 +13694,7 @@ Updates a session's comments and/or public visibility status. Can update one or
|
|
|
13643
13694
|
<dd>
|
|
13644
13695
|
|
|
13645
13696
|
```typescript
|
|
13646
|
-
await client.tracking.
|
|
13697
|
+
await client.tracking.sessions.terminateV1({
|
|
13647
13698
|
session_id: "session_id",
|
|
13648
13699
|
});
|
|
13649
13700
|
```
|
|
@@ -13661,7 +13712,7 @@ await client.tracking.sessionByDevice.updateV1({
|
|
|
13661
13712
|
<dl>
|
|
13662
13713
|
<dd>
|
|
13663
13714
|
|
|
13664
|
-
**request:** `Chrt.tracking.
|
|
13715
|
+
**request:** `Chrt.tracking.SessionsTerminateV1Request`
|
|
13665
13716
|
|
|
13666
13717
|
</dd>
|
|
13667
13718
|
</dl>
|
|
@@ -13669,7 +13720,7 @@ await client.tracking.sessionByDevice.updateV1({
|
|
|
13669
13720
|
<dl>
|
|
13670
13721
|
<dd>
|
|
13671
13722
|
|
|
13672
|
-
**requestOptions:** `
|
|
13723
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13673
13724
|
|
|
13674
13725
|
</dd>
|
|
13675
13726
|
</dl>
|
|
@@ -13680,7 +13731,7 @@ await client.tracking.sessionByDevice.updateV1({
|
|
|
13680
13731
|
</dl>
|
|
13681
13732
|
</details>
|
|
13682
13733
|
|
|
13683
|
-
<details><summary><code>client.tracking.
|
|
13734
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">deleteV1</a>({ ...params }) -> Chrt.SessionDeleteResponse1</code></summary>
|
|
13684
13735
|
<dl>
|
|
13685
13736
|
<dd>
|
|
13686
13737
|
|
|
@@ -13692,7 +13743,7 @@ await client.tracking.sessionByDevice.updateV1({
|
|
|
13692
13743
|
<dl>
|
|
13693
13744
|
<dd>
|
|
13694
13745
|
|
|
13695
|
-
|
|
13746
|
+
Deletes a terminated session and all its associated timeseries data points. Only sessions marked as terminated can be deleted. | () -> (SessionDeleteResponse1)
|
|
13696
13747
|
|
|
13697
13748
|
</dd>
|
|
13698
13749
|
</dl>
|
|
@@ -13708,7 +13759,7 @@ Starts location recording for a session by setting recording status to true. Set
|
|
|
13708
13759
|
<dd>
|
|
13709
13760
|
|
|
13710
13761
|
```typescript
|
|
13711
|
-
await client.tracking.
|
|
13762
|
+
await client.tracking.sessions.deleteV1({
|
|
13712
13763
|
session_id: "session_id",
|
|
13713
13764
|
});
|
|
13714
13765
|
```
|
|
@@ -13726,7 +13777,7 @@ await client.tracking.sessionByDevice.startV1({
|
|
|
13726
13777
|
<dl>
|
|
13727
13778
|
<dd>
|
|
13728
13779
|
|
|
13729
|
-
**request:** `Chrt.tracking.
|
|
13780
|
+
**request:** `Chrt.tracking.SessionsDeleteV1Request`
|
|
13730
13781
|
|
|
13731
13782
|
</dd>
|
|
13732
13783
|
</dl>
|
|
@@ -13734,7 +13785,7 @@ await client.tracking.sessionByDevice.startV1({
|
|
|
13734
13785
|
<dl>
|
|
13735
13786
|
<dd>
|
|
13736
13787
|
|
|
13737
|
-
**requestOptions:** `
|
|
13788
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13738
13789
|
|
|
13739
13790
|
</dd>
|
|
13740
13791
|
</dl>
|
|
@@ -13745,7 +13796,9 @@ await client.tracking.sessionByDevice.startV1({
|
|
|
13745
13796
|
</dl>
|
|
13746
13797
|
</details>
|
|
13747
13798
|
|
|
13748
|
-
|
|
13799
|
+
## Tracking SharingSettings
|
|
13800
|
+
|
|
13801
|
+
<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">getSettingsV1</a>(orderIdOrShortId) -> Chrt.TrackingSharingSettingsRes[]</code></summary>
|
|
13749
13802
|
<dl>
|
|
13750
13803
|
<dd>
|
|
13751
13804
|
|
|
@@ -13757,7 +13810,7 @@ await client.tracking.sessionByDevice.startV1({
|
|
|
13757
13810
|
<dl>
|
|
13758
13811
|
<dd>
|
|
13759
13812
|
|
|
13760
|
-
|
|
13813
|
+
Get all tracking datasets and their sharing settings for a given order. | authz_personas=[shipper_org_operators, forwarder_org_operators, courier_org_operators] | () -> (list[TrackingSharingSettingsRes])
|
|
13761
13814
|
|
|
13762
13815
|
</dd>
|
|
13763
13816
|
</dl>
|
|
@@ -13773,9 +13826,7 @@ Pauses location recording for a session by setting recording status to false. De
|
|
|
13773
13826
|
<dd>
|
|
13774
13827
|
|
|
13775
13828
|
```typescript
|
|
13776
|
-
await client.tracking.
|
|
13777
|
-
session_id: "session_id",
|
|
13778
|
-
});
|
|
13829
|
+
await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
|
|
13779
13830
|
```
|
|
13780
13831
|
|
|
13781
13832
|
</dd>
|
|
@@ -13791,7 +13842,7 @@ await client.tracking.sessionByDevice.pauseRecordingV1({
|
|
|
13791
13842
|
<dl>
|
|
13792
13843
|
<dd>
|
|
13793
13844
|
|
|
13794
|
-
**
|
|
13845
|
+
**orderIdOrShortId:** `string`
|
|
13795
13846
|
|
|
13796
13847
|
</dd>
|
|
13797
13848
|
</dl>
|
|
@@ -13799,7 +13850,7 @@ await client.tracking.sessionByDevice.pauseRecordingV1({
|
|
|
13799
13850
|
<dl>
|
|
13800
13851
|
<dd>
|
|
13801
13852
|
|
|
13802
|
-
**requestOptions:** `
|
|
13853
|
+
**requestOptions:** `SharingSettings.RequestOptions`
|
|
13803
13854
|
|
|
13804
13855
|
</dd>
|
|
13805
13856
|
</dl>
|
|
@@ -13810,7 +13861,7 @@ await client.tracking.sessionByDevice.pauseRecordingV1({
|
|
|
13810
13861
|
</dl>
|
|
13811
13862
|
</details>
|
|
13812
13863
|
|
|
13813
|
-
<details><summary><code>client.tracking.
|
|
13864
|
+
<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">taskGroupByDriverSharingSettingsV1</a>({ ...params }) -> Chrt.TaskGroupByDriverSharingSettings1</code></summary>
|
|
13814
13865
|
<dl>
|
|
13815
13866
|
<dd>
|
|
13816
13867
|
|
|
@@ -13822,7 +13873,7 @@ await client.tracking.sessionByDevice.pauseRecordingV1({
|
|
|
13822
13873
|
<dl>
|
|
13823
13874
|
<dd>
|
|
13824
13875
|
|
|
13825
|
-
|
|
13876
|
+
Updates the sharing settings for a task group by driver tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | (TaskGroupByDriverSharingSettingsUpdateReq) -> (TaskGroupByDriverSharingSettings1)
|
|
13826
13877
|
|
|
13827
13878
|
</dd>
|
|
13828
13879
|
</dl>
|
|
@@ -13838,8 +13889,10 @@ Resumes location recording for a session by setting recording status to true. |
|
|
|
13838
13889
|
<dd>
|
|
13839
13890
|
|
|
13840
13891
|
```typescript
|
|
13841
|
-
await client.tracking.
|
|
13842
|
-
|
|
13892
|
+
await client.tracking.sharingSettings.taskGroupByDriverSharingSettingsV1({
|
|
13893
|
+
task_group_id: "task_group_id",
|
|
13894
|
+
driver_id: "driver_id",
|
|
13895
|
+
public: true,
|
|
13843
13896
|
});
|
|
13844
13897
|
```
|
|
13845
13898
|
|
|
@@ -13856,7 +13909,7 @@ await client.tracking.sessionByDevice.resumeRecordingV1({
|
|
|
13856
13909
|
<dl>
|
|
13857
13910
|
<dd>
|
|
13858
13911
|
|
|
13859
|
-
**request:** `Chrt.tracking.
|
|
13912
|
+
**request:** `Chrt.tracking.TaskGroupByDriverSharingSettingsUpdateReq`
|
|
13860
13913
|
|
|
13861
13914
|
</dd>
|
|
13862
13915
|
</dl>
|
|
@@ -13864,7 +13917,7 @@ await client.tracking.sessionByDevice.resumeRecordingV1({
|
|
|
13864
13917
|
<dl>
|
|
13865
13918
|
<dd>
|
|
13866
13919
|
|
|
13867
|
-
**requestOptions:** `
|
|
13920
|
+
**requestOptions:** `SharingSettings.RequestOptions`
|
|
13868
13921
|
|
|
13869
13922
|
</dd>
|
|
13870
13923
|
</dl>
|
|
@@ -13875,7 +13928,7 @@ await client.tracking.sessionByDevice.resumeRecordingV1({
|
|
|
13875
13928
|
</dl>
|
|
13876
13929
|
</details>
|
|
13877
13930
|
|
|
13878
|
-
<details><summary><code>client.tracking.
|
|
13931
|
+
<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">cargoByDriverSettingsV1</a>({ ...params }) -> Chrt.CargoByDriverSharingSettings1</code></summary>
|
|
13879
13932
|
<dl>
|
|
13880
13933
|
<dd>
|
|
13881
13934
|
|
|
@@ -13887,7 +13940,7 @@ await client.tracking.sessionByDevice.resumeRecordingV1({
|
|
|
13887
13940
|
<dl>
|
|
13888
13941
|
<dd>
|
|
13889
13942
|
|
|
13890
|
-
|
|
13943
|
+
Updates the sharing settings for a cargo by driver tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | (CargoByDriverSharingSettingsUpdateReq) -> (CargoByDriverSharingSettings1)
|
|
13891
13944
|
|
|
13892
13945
|
</dd>
|
|
13893
13946
|
</dl>
|
|
@@ -13903,8 +13956,11 @@ Terminates a session by setting recording to false and marking it as terminated.
|
|
|
13903
13956
|
<dd>
|
|
13904
13957
|
|
|
13905
13958
|
```typescript
|
|
13906
|
-
await client.tracking.
|
|
13907
|
-
|
|
13959
|
+
await client.tracking.sharingSettings.cargoByDriverSettingsV1({
|
|
13960
|
+
task_group_id: "task_group_id",
|
|
13961
|
+
cargo_id: "cargo_id",
|
|
13962
|
+
driver_id: "driver_id",
|
|
13963
|
+
public: true,
|
|
13908
13964
|
});
|
|
13909
13965
|
```
|
|
13910
13966
|
|
|
@@ -13921,7 +13977,7 @@ await client.tracking.sessionByDevice.terminateV1({
|
|
|
13921
13977
|
<dl>
|
|
13922
13978
|
<dd>
|
|
13923
13979
|
|
|
13924
|
-
**request:** `Chrt.tracking.
|
|
13980
|
+
**request:** `Chrt.tracking.CargoByDriverSharingSettingsUpdateReq`
|
|
13925
13981
|
|
|
13926
13982
|
</dd>
|
|
13927
13983
|
</dl>
|
|
@@ -13929,7 +13985,7 @@ await client.tracking.sessionByDevice.terminateV1({
|
|
|
13929
13985
|
<dl>
|
|
13930
13986
|
<dd>
|
|
13931
13987
|
|
|
13932
|
-
**requestOptions:** `
|
|
13988
|
+
**requestOptions:** `SharingSettings.RequestOptions`
|
|
13933
13989
|
|
|
13934
13990
|
</dd>
|
|
13935
13991
|
</dl>
|
|
@@ -13940,7 +13996,7 @@ await client.tracking.sessionByDevice.terminateV1({
|
|
|
13940
13996
|
</dl>
|
|
13941
13997
|
</details>
|
|
13942
13998
|
|
|
13943
|
-
<details><summary><code>client.tracking.
|
|
13999
|
+
<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">cargoByDeviceSettingsV1</a>({ ...params }) -> Chrt.CargoByDeviceSharingSettings1</code></summary>
|
|
13944
14000
|
<dl>
|
|
13945
14001
|
<dd>
|
|
13946
14002
|
|
|
@@ -13952,7 +14008,7 @@ await client.tracking.sessionByDevice.terminateV1({
|
|
|
13952
14008
|
<dl>
|
|
13953
14009
|
<dd>
|
|
13954
14010
|
|
|
13955
|
-
|
|
14011
|
+
Updates the sharing settings for a cargo by device tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, order_creator_org_operators] | (CargoByDeviceSharingSettingsUpdateReq) -> (CargoByDeviceSharingSettings1)
|
|
13956
14012
|
|
|
13957
14013
|
</dd>
|
|
13958
14014
|
</dl>
|
|
@@ -13968,9 +14024,11 @@ Marks data points as outliers or non-outliers. Uses atomic delete and reinsert s
|
|
|
13968
14024
|
<dd>
|
|
13969
14025
|
|
|
13970
14026
|
```typescript
|
|
13971
|
-
await client.tracking.
|
|
13972
|
-
|
|
13973
|
-
|
|
14027
|
+
await client.tracking.sharingSettings.cargoByDeviceSettingsV1({
|
|
14028
|
+
task_group_id: "task_group_id",
|
|
14029
|
+
cargo_id: "cargo_id",
|
|
14030
|
+
device_id: "device_id",
|
|
14031
|
+
public: true,
|
|
13974
14032
|
});
|
|
13975
14033
|
```
|
|
13976
14034
|
|
|
@@ -13987,7 +14045,7 @@ await client.tracking.sessionByDevice.outlierV1({
|
|
|
13987
14045
|
<dl>
|
|
13988
14046
|
<dd>
|
|
13989
14047
|
|
|
13990
|
-
**request:** `Chrt.tracking.
|
|
14048
|
+
**request:** `Chrt.tracking.CargoByDeviceSharingSettingsUpdateReq`
|
|
13991
14049
|
|
|
13992
14050
|
</dd>
|
|
13993
14051
|
</dl>
|
|
@@ -13995,7 +14053,7 @@ await client.tracking.sessionByDevice.outlierV1({
|
|
|
13995
14053
|
<dl>
|
|
13996
14054
|
<dd>
|
|
13997
14055
|
|
|
13998
|
-
**requestOptions:** `
|
|
14056
|
+
**requestOptions:** `SharingSettings.RequestOptions`
|
|
13999
14057
|
|
|
14000
14058
|
</dd>
|
|
14001
14059
|
</dl>
|
|
@@ -14006,7 +14064,9 @@ await client.tracking.sessionByDevice.outlierV1({
|
|
|
14006
14064
|
</dl>
|
|
14007
14065
|
</details>
|
|
14008
14066
|
|
|
14009
|
-
|
|
14067
|
+
## Tracking Timeseries CargoByDevice
|
|
14068
|
+
|
|
14069
|
+
<details><summary><code>client.tracking.timeseries.cargoByDevice.<a href="/src/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.ts">lastSeenV1</a>({ ...params }) -> (Chrt.CargoByDeviceDataPoint1 | null) | undefined</code></summary>
|
|
14010
14070
|
<dl>
|
|
14011
14071
|
<dd>
|
|
14012
14072
|
|
|
@@ -14018,7 +14078,7 @@ await client.tracking.sessionByDevice.outlierV1({
|
|
|
14018
14078
|
<dl>
|
|
14019
14079
|
<dd>
|
|
14020
14080
|
|
|
14021
|
-
|
|
14081
|
+
Returns the last seen data point for cargo within a task group. Access granted to courier or shipper organization. | () -> (CargoByDeviceDataPoint1 | None)
|
|
14022
14082
|
|
|
14023
14083
|
</dd>
|
|
14024
14084
|
</dl>
|
|
@@ -14034,8 +14094,9 @@ Deletes a terminated session and all its associated timeseries data points. Only
|
|
|
14034
14094
|
<dd>
|
|
14035
14095
|
|
|
14036
14096
|
```typescript
|
|
14037
|
-
await client.tracking.
|
|
14038
|
-
|
|
14097
|
+
await client.tracking.timeseries.cargoByDevice.lastSeenV1({
|
|
14098
|
+
cargo_id: "cargo_id",
|
|
14099
|
+
task_group_id: "task_group_id",
|
|
14039
14100
|
});
|
|
14040
14101
|
```
|
|
14041
14102
|
|
|
@@ -14052,7 +14113,7 @@ await client.tracking.sessionByDevice.deleteV1({
|
|
|
14052
14113
|
<dl>
|
|
14053
14114
|
<dd>
|
|
14054
14115
|
|
|
14055
|
-
**request:** `Chrt.tracking.
|
|
14116
|
+
**request:** `Chrt.tracking.timeseries.CargoByDeviceLastSeenV1Request`
|
|
14056
14117
|
|
|
14057
14118
|
</dd>
|
|
14058
14119
|
</dl>
|
|
@@ -14060,7 +14121,7 @@ await client.tracking.sessionByDevice.deleteV1({
|
|
|
14060
14121
|
<dl>
|
|
14061
14122
|
<dd>
|
|
14062
14123
|
|
|
14063
|
-
**requestOptions:** `
|
|
14124
|
+
**requestOptions:** `CargoByDevice.RequestOptions`
|
|
14064
14125
|
|
|
14065
14126
|
</dd>
|
|
14066
14127
|
</dl>
|
|
@@ -14071,7 +14132,7 @@ await client.tracking.sessionByDevice.deleteV1({
|
|
|
14071
14132
|
</dl>
|
|
14072
14133
|
</details>
|
|
14073
14134
|
|
|
14074
|
-
<details><summary><code>client.tracking.
|
|
14135
|
+
<details><summary><code>client.tracking.timeseries.cargoByDevice.<a href="/src/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.ts">dataPointsV1</a>({ ...params }) -> Chrt.CargoByDeviceDataPoint1[]</code></summary>
|
|
14075
14136
|
<dl>
|
|
14076
14137
|
<dd>
|
|
14077
14138
|
|
|
@@ -14083,7 +14144,7 @@ await client.tracking.sessionByDevice.deleteV1({
|
|
|
14083
14144
|
<dl>
|
|
14084
14145
|
<dd>
|
|
14085
14146
|
|
|
14086
|
-
Returns the
|
|
14147
|
+
Returns up to the specified number of data points for a cargo within a task group, intelligently sampled across the time range. Excludes outliers. | () -> (list[CargoByDeviceDataPoint1])
|
|
14087
14148
|
|
|
14088
14149
|
</dd>
|
|
14089
14150
|
</dl>
|
|
@@ -14099,8 +14160,10 @@ Returns the most recent data point for a public session, excluding outliers. No
|
|
|
14099
14160
|
<dd>
|
|
14100
14161
|
|
|
14101
14162
|
```typescript
|
|
14102
|
-
await client.tracking.
|
|
14103
|
-
|
|
14163
|
+
await client.tracking.timeseries.cargoByDevice.dataPointsV1({
|
|
14164
|
+
cargo_id: "cargo_id",
|
|
14165
|
+
task_group_id: "task_group_id",
|
|
14166
|
+
limit: 1,
|
|
14104
14167
|
});
|
|
14105
14168
|
```
|
|
14106
14169
|
|
|
@@ -14117,7 +14180,7 @@ await client.tracking.sessionByDevice.lastSeenPublicV1({
|
|
|
14117
14180
|
<dl>
|
|
14118
14181
|
<dd>
|
|
14119
14182
|
|
|
14120
|
-
**request:** `Chrt.tracking.
|
|
14183
|
+
**request:** `Chrt.tracking.timeseries.CargoByDeviceDataPointsV1Request`
|
|
14121
14184
|
|
|
14122
14185
|
</dd>
|
|
14123
14186
|
</dl>
|
|
@@ -14125,7 +14188,7 @@ await client.tracking.sessionByDevice.lastSeenPublicV1({
|
|
|
14125
14188
|
<dl>
|
|
14126
14189
|
<dd>
|
|
14127
14190
|
|
|
14128
|
-
**requestOptions:** `
|
|
14191
|
+
**requestOptions:** `CargoByDevice.RequestOptions`
|
|
14129
14192
|
|
|
14130
14193
|
</dd>
|
|
14131
14194
|
</dl>
|
|
@@ -14136,7 +14199,7 @@ await client.tracking.sessionByDevice.lastSeenPublicV1({
|
|
|
14136
14199
|
</dl>
|
|
14137
14200
|
</details>
|
|
14138
14201
|
|
|
14139
|
-
<details><summary><code>client.tracking.
|
|
14202
|
+
<details><summary><code>client.tracking.timeseries.cargoByDevice.<a href="/src/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.ts">outlierV1</a>({ ...params }) -> Chrt.CargoByDeviceMarkOutliersResponse1</code></summary>
|
|
14140
14203
|
<dl>
|
|
14141
14204
|
<dd>
|
|
14142
14205
|
|
|
@@ -14148,7 +14211,7 @@ await client.tracking.sessionByDevice.lastSeenPublicV1({
|
|
|
14148
14211
|
<dl>
|
|
14149
14212
|
<dd>
|
|
14150
14213
|
|
|
14151
|
-
|
|
14214
|
+
Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | authz: allowed_org_types=[shipper, forwarder], min_org_role=operator | (CargoByDeviceMarkOutliersRequest1) -> (CargoByDeviceMarkOutliersResponse1)
|
|
14152
14215
|
|
|
14153
14216
|
</dd>
|
|
14154
14217
|
</dl>
|
|
@@ -14164,9 +14227,9 @@ Returns up to the specified number of data points for a public session, intellig
|
|
|
14164
14227
|
<dd>
|
|
14165
14228
|
|
|
14166
14229
|
```typescript
|
|
14167
|
-
await client.tracking.
|
|
14168
|
-
|
|
14169
|
-
|
|
14230
|
+
await client.tracking.timeseries.cargoByDevice.outlierV1({
|
|
14231
|
+
tracking_cargo_by_device_data_point_ids: ["tracking_cargo_by_device_data_point_ids"],
|
|
14232
|
+
outlier: true,
|
|
14170
14233
|
});
|
|
14171
14234
|
```
|
|
14172
14235
|
|
|
@@ -14183,7 +14246,7 @@ await client.tracking.sessionByDevice.dataPointsPublicV1({
|
|
|
14183
14246
|
<dl>
|
|
14184
14247
|
<dd>
|
|
14185
14248
|
|
|
14186
|
-
**request:** `Chrt.tracking.
|
|
14249
|
+
**request:** `Chrt.tracking.timeseries.CargoByDeviceMarkOutliersRequest1`
|
|
14187
14250
|
|
|
14188
14251
|
</dd>
|
|
14189
14252
|
</dl>
|
|
@@ -14191,7 +14254,7 @@ await client.tracking.sessionByDevice.dataPointsPublicV1({
|
|
|
14191
14254
|
<dl>
|
|
14192
14255
|
<dd>
|
|
14193
14256
|
|
|
14194
|
-
**requestOptions:** `
|
|
14257
|
+
**requestOptions:** `CargoByDevice.RequestOptions`
|
|
14195
14258
|
|
|
14196
14259
|
</dd>
|
|
14197
14260
|
</dl>
|
|
@@ -14202,9 +14265,7 @@ await client.tracking.sessionByDevice.dataPointsPublicV1({
|
|
|
14202
14265
|
</dl>
|
|
14203
14266
|
</details>
|
|
14204
14267
|
|
|
14205
|
-
|
|
14206
|
-
|
|
14207
|
-
<details><summary><code>client.tracking.taskGroupByDriver.<a href="/src/api/resources/tracking/resources/taskGroupByDriver/client/Client.ts">lastSeenV1</a>({ ...params }) -> (Chrt.TrackingTaskGroupByDriverDataPoint1 | null) | undefined</code></summary>
|
|
14268
|
+
<details><summary><code>client.tracking.timeseries.cargoByDevice.<a href="/src/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.ts">lastSeenPublicV1</a>({ ...params }) -> (Chrt.CargoByDeviceDataPoint1 | null) | undefined</code></summary>
|
|
14208
14269
|
<dl>
|
|
14209
14270
|
<dd>
|
|
14210
14271
|
|
|
@@ -14216,7 +14277,7 @@ await client.tracking.sessionByDevice.dataPointsPublicV1({
|
|
|
14216
14277
|
<dl>
|
|
14217
14278
|
<dd>
|
|
14218
14279
|
|
|
14219
|
-
Returns the most recent
|
|
14280
|
+
Returns the most recent device location data point for a cargo within a public task group. No authentication required if cargo has public visibility enabled via sharing settings. | () -> (CargoByDeviceDataPoint1 | None)
|
|
14220
14281
|
|
|
14221
14282
|
</dd>
|
|
14222
14283
|
</dl>
|
|
@@ -14232,7 +14293,8 @@ Returns the most recent driver location data point for a task group. Access gran
|
|
|
14232
14293
|
<dd>
|
|
14233
14294
|
|
|
14234
14295
|
```typescript
|
|
14235
|
-
await client.tracking.
|
|
14296
|
+
await client.tracking.timeseries.cargoByDevice.lastSeenPublicV1({
|
|
14297
|
+
cargo_id: "cargo_id",
|
|
14236
14298
|
task_group_id: "task_group_id",
|
|
14237
14299
|
});
|
|
14238
14300
|
```
|
|
@@ -14250,7 +14312,936 @@ await client.tracking.taskGroupByDriver.lastSeenV1({
|
|
|
14250
14312
|
<dl>
|
|
14251
14313
|
<dd>
|
|
14252
14314
|
|
|
14253
|
-
**request:** `Chrt.tracking.
|
|
14315
|
+
**request:** `Chrt.tracking.timeseries.CargoByDeviceLastSeenPublicV1Request`
|
|
14316
|
+
|
|
14317
|
+
</dd>
|
|
14318
|
+
</dl>
|
|
14319
|
+
|
|
14320
|
+
<dl>
|
|
14321
|
+
<dd>
|
|
14322
|
+
|
|
14323
|
+
**requestOptions:** `CargoByDevice.RequestOptions`
|
|
14324
|
+
|
|
14325
|
+
</dd>
|
|
14326
|
+
</dl>
|
|
14327
|
+
</dd>
|
|
14328
|
+
</dl>
|
|
14329
|
+
|
|
14330
|
+
</dd>
|
|
14331
|
+
</dl>
|
|
14332
|
+
</details>
|
|
14333
|
+
|
|
14334
|
+
<details><summary><code>client.tracking.timeseries.cargoByDevice.<a href="/src/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.ts">dataPointsPublicV1</a>({ ...params }) -> Chrt.CargoByDeviceDataPoint1[]</code></summary>
|
|
14335
|
+
<dl>
|
|
14336
|
+
<dd>
|
|
14337
|
+
|
|
14338
|
+
#### 📝 Description
|
|
14339
|
+
|
|
14340
|
+
<dl>
|
|
14341
|
+
<dd>
|
|
14342
|
+
|
|
14343
|
+
<dl>
|
|
14344
|
+
<dd>
|
|
14345
|
+
|
|
14346
|
+
Returns up to the specified number of data points for a cargo within a public task group, intelligently sampled across the time range. Excludes outliers. No authentication required if cargo has public visibility enabled via sharing settings. | () -> (list[CargoByDeviceDataPoint1])
|
|
14347
|
+
|
|
14348
|
+
</dd>
|
|
14349
|
+
</dl>
|
|
14350
|
+
</dd>
|
|
14351
|
+
</dl>
|
|
14352
|
+
|
|
14353
|
+
#### 🔌 Usage
|
|
14354
|
+
|
|
14355
|
+
<dl>
|
|
14356
|
+
<dd>
|
|
14357
|
+
|
|
14358
|
+
<dl>
|
|
14359
|
+
<dd>
|
|
14360
|
+
|
|
14361
|
+
```typescript
|
|
14362
|
+
await client.tracking.timeseries.cargoByDevice.dataPointsPublicV1({
|
|
14363
|
+
cargo_id: "cargo_id",
|
|
14364
|
+
task_group_id: "task_group_id",
|
|
14365
|
+
limit: 1,
|
|
14366
|
+
});
|
|
14367
|
+
```
|
|
14368
|
+
|
|
14369
|
+
</dd>
|
|
14370
|
+
</dl>
|
|
14371
|
+
</dd>
|
|
14372
|
+
</dl>
|
|
14373
|
+
|
|
14374
|
+
#### ⚙️ Parameters
|
|
14375
|
+
|
|
14376
|
+
<dl>
|
|
14377
|
+
<dd>
|
|
14378
|
+
|
|
14379
|
+
<dl>
|
|
14380
|
+
<dd>
|
|
14381
|
+
|
|
14382
|
+
**request:** `Chrt.tracking.timeseries.CargoByDeviceDataPointsPublicV1Request`
|
|
14383
|
+
|
|
14384
|
+
</dd>
|
|
14385
|
+
</dl>
|
|
14386
|
+
|
|
14387
|
+
<dl>
|
|
14388
|
+
<dd>
|
|
14389
|
+
|
|
14390
|
+
**requestOptions:** `CargoByDevice.RequestOptions`
|
|
14391
|
+
|
|
14392
|
+
</dd>
|
|
14393
|
+
</dl>
|
|
14394
|
+
</dd>
|
|
14395
|
+
</dl>
|
|
14396
|
+
|
|
14397
|
+
</dd>
|
|
14398
|
+
</dl>
|
|
14399
|
+
</details>
|
|
14400
|
+
|
|
14401
|
+
## Tracking Timeseries CargoByDriver
|
|
14402
|
+
|
|
14403
|
+
<details><summary><code>client.tracking.timeseries.cargoByDriver.<a href="/src/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.ts">lastSeenV1</a>({ ...params }) -> (Chrt.CargoByDriverDataPoint1 | null) | undefined</code></summary>
|
|
14404
|
+
<dl>
|
|
14405
|
+
<dd>
|
|
14406
|
+
|
|
14407
|
+
#### 📝 Description
|
|
14408
|
+
|
|
14409
|
+
<dl>
|
|
14410
|
+
<dd>
|
|
14411
|
+
|
|
14412
|
+
<dl>
|
|
14413
|
+
<dd>
|
|
14414
|
+
|
|
14415
|
+
Returns the most recent driver location data point for cargo within a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | () -> (CargoByDriverDataPoint1 | None)
|
|
14416
|
+
|
|
14417
|
+
</dd>
|
|
14418
|
+
</dl>
|
|
14419
|
+
</dd>
|
|
14420
|
+
</dl>
|
|
14421
|
+
|
|
14422
|
+
#### 🔌 Usage
|
|
14423
|
+
|
|
14424
|
+
<dl>
|
|
14425
|
+
<dd>
|
|
14426
|
+
|
|
14427
|
+
<dl>
|
|
14428
|
+
<dd>
|
|
14429
|
+
|
|
14430
|
+
```typescript
|
|
14431
|
+
await client.tracking.timeseries.cargoByDriver.lastSeenV1({
|
|
14432
|
+
cargo_id: "cargo_id",
|
|
14433
|
+
task_group_id: "task_group_id",
|
|
14434
|
+
});
|
|
14435
|
+
```
|
|
14436
|
+
|
|
14437
|
+
</dd>
|
|
14438
|
+
</dl>
|
|
14439
|
+
</dd>
|
|
14440
|
+
</dl>
|
|
14441
|
+
|
|
14442
|
+
#### ⚙️ Parameters
|
|
14443
|
+
|
|
14444
|
+
<dl>
|
|
14445
|
+
<dd>
|
|
14446
|
+
|
|
14447
|
+
<dl>
|
|
14448
|
+
<dd>
|
|
14449
|
+
|
|
14450
|
+
**request:** `Chrt.tracking.timeseries.CargoByDriverLastSeenV1Request`
|
|
14451
|
+
|
|
14452
|
+
</dd>
|
|
14453
|
+
</dl>
|
|
14454
|
+
|
|
14455
|
+
<dl>
|
|
14456
|
+
<dd>
|
|
14457
|
+
|
|
14458
|
+
**requestOptions:** `CargoByDriver.RequestOptions`
|
|
14459
|
+
|
|
14460
|
+
</dd>
|
|
14461
|
+
</dl>
|
|
14462
|
+
</dd>
|
|
14463
|
+
</dl>
|
|
14464
|
+
|
|
14465
|
+
</dd>
|
|
14466
|
+
</dl>
|
|
14467
|
+
</details>
|
|
14468
|
+
|
|
14469
|
+
<details><summary><code>client.tracking.timeseries.cargoByDriver.<a href="/src/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.ts">dataPointsV1</a>({ ...params }) -> Chrt.CargoByDriverDataPoint1[]</code></summary>
|
|
14470
|
+
<dl>
|
|
14471
|
+
<dd>
|
|
14472
|
+
|
|
14473
|
+
#### 📝 Description
|
|
14474
|
+
|
|
14475
|
+
<dl>
|
|
14476
|
+
<dd>
|
|
14477
|
+
|
|
14478
|
+
<dl>
|
|
14479
|
+
<dd>
|
|
14480
|
+
|
|
14481
|
+
Returns up to the specified number of data points for a cargo within a task group, intelligently sampled across the time range. Excludes outliers. | () -> (list[CargoByDriverDataPoint1])
|
|
14482
|
+
|
|
14483
|
+
</dd>
|
|
14484
|
+
</dl>
|
|
14485
|
+
</dd>
|
|
14486
|
+
</dl>
|
|
14487
|
+
|
|
14488
|
+
#### 🔌 Usage
|
|
14489
|
+
|
|
14490
|
+
<dl>
|
|
14491
|
+
<dd>
|
|
14492
|
+
|
|
14493
|
+
<dl>
|
|
14494
|
+
<dd>
|
|
14495
|
+
|
|
14496
|
+
```typescript
|
|
14497
|
+
await client.tracking.timeseries.cargoByDriver.dataPointsV1({
|
|
14498
|
+
cargo_id: "cargo_id",
|
|
14499
|
+
task_group_id: "task_group_id",
|
|
14500
|
+
limit: 1,
|
|
14501
|
+
});
|
|
14502
|
+
```
|
|
14503
|
+
|
|
14504
|
+
</dd>
|
|
14505
|
+
</dl>
|
|
14506
|
+
</dd>
|
|
14507
|
+
</dl>
|
|
14508
|
+
|
|
14509
|
+
#### ⚙️ Parameters
|
|
14510
|
+
|
|
14511
|
+
<dl>
|
|
14512
|
+
<dd>
|
|
14513
|
+
|
|
14514
|
+
<dl>
|
|
14515
|
+
<dd>
|
|
14516
|
+
|
|
14517
|
+
**request:** `Chrt.tracking.timeseries.CargoByDriverDataPointsV1Request`
|
|
14518
|
+
|
|
14519
|
+
</dd>
|
|
14520
|
+
</dl>
|
|
14521
|
+
|
|
14522
|
+
<dl>
|
|
14523
|
+
<dd>
|
|
14524
|
+
|
|
14525
|
+
**requestOptions:** `CargoByDriver.RequestOptions`
|
|
14526
|
+
|
|
14527
|
+
</dd>
|
|
14528
|
+
</dl>
|
|
14529
|
+
</dd>
|
|
14530
|
+
</dl>
|
|
14531
|
+
|
|
14532
|
+
</dd>
|
|
14533
|
+
</dl>
|
|
14534
|
+
</details>
|
|
14535
|
+
|
|
14536
|
+
<details><summary><code>client.tracking.timeseries.cargoByDriver.<a href="/src/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.ts">lastSeenPublicV1</a>({ ...params }) -> (Chrt.CargoByDriverDataPoint1 | null) | undefined</code></summary>
|
|
14537
|
+
<dl>
|
|
14538
|
+
<dd>
|
|
14539
|
+
|
|
14540
|
+
#### 📝 Description
|
|
14541
|
+
|
|
14542
|
+
<dl>
|
|
14543
|
+
<dd>
|
|
14544
|
+
|
|
14545
|
+
<dl>
|
|
14546
|
+
<dd>
|
|
14547
|
+
|
|
14548
|
+
Returns the most recent driver location data point for a cargo within a public task group. No authentication required if cargo has public visibility enabled via sharing settings. | () -> (CargoByDriverDataPoint1 | None)
|
|
14549
|
+
|
|
14550
|
+
</dd>
|
|
14551
|
+
</dl>
|
|
14552
|
+
</dd>
|
|
14553
|
+
</dl>
|
|
14554
|
+
|
|
14555
|
+
#### 🔌 Usage
|
|
14556
|
+
|
|
14557
|
+
<dl>
|
|
14558
|
+
<dd>
|
|
14559
|
+
|
|
14560
|
+
<dl>
|
|
14561
|
+
<dd>
|
|
14562
|
+
|
|
14563
|
+
```typescript
|
|
14564
|
+
await client.tracking.timeseries.cargoByDriver.lastSeenPublicV1({
|
|
14565
|
+
cargo_id: "cargo_id",
|
|
14566
|
+
task_group_id: "task_group_id",
|
|
14567
|
+
});
|
|
14568
|
+
```
|
|
14569
|
+
|
|
14570
|
+
</dd>
|
|
14571
|
+
</dl>
|
|
14572
|
+
</dd>
|
|
14573
|
+
</dl>
|
|
14574
|
+
|
|
14575
|
+
#### ⚙️ Parameters
|
|
14576
|
+
|
|
14577
|
+
<dl>
|
|
14578
|
+
<dd>
|
|
14579
|
+
|
|
14580
|
+
<dl>
|
|
14581
|
+
<dd>
|
|
14582
|
+
|
|
14583
|
+
**request:** `Chrt.tracking.timeseries.CargoByDriverLastSeenPublicV1Request`
|
|
14584
|
+
|
|
14585
|
+
</dd>
|
|
14586
|
+
</dl>
|
|
14587
|
+
|
|
14588
|
+
<dl>
|
|
14589
|
+
<dd>
|
|
14590
|
+
|
|
14591
|
+
**requestOptions:** `CargoByDriver.RequestOptions`
|
|
14592
|
+
|
|
14593
|
+
</dd>
|
|
14594
|
+
</dl>
|
|
14595
|
+
</dd>
|
|
14596
|
+
</dl>
|
|
14597
|
+
|
|
14598
|
+
</dd>
|
|
14599
|
+
</dl>
|
|
14600
|
+
</details>
|
|
14601
|
+
|
|
14602
|
+
<details><summary><code>client.tracking.timeseries.cargoByDriver.<a href="/src/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.ts">dataPointsPublicV1</a>({ ...params }) -> Chrt.CargoByDriverDataPoint1[]</code></summary>
|
|
14603
|
+
<dl>
|
|
14604
|
+
<dd>
|
|
14605
|
+
|
|
14606
|
+
#### 📝 Description
|
|
14607
|
+
|
|
14608
|
+
<dl>
|
|
14609
|
+
<dd>
|
|
14610
|
+
|
|
14611
|
+
<dl>
|
|
14612
|
+
<dd>
|
|
14613
|
+
|
|
14614
|
+
Returns up to the specified number of data points for a cargo within a public task group, intelligently sampled across the time range. Excludes outliers. No authentication required if cargo has public visibility enabled via sharing settings. | () -> (list[CargoByDriverDataPoint1])
|
|
14615
|
+
|
|
14616
|
+
</dd>
|
|
14617
|
+
</dl>
|
|
14618
|
+
</dd>
|
|
14619
|
+
</dl>
|
|
14620
|
+
|
|
14621
|
+
#### 🔌 Usage
|
|
14622
|
+
|
|
14623
|
+
<dl>
|
|
14624
|
+
<dd>
|
|
14625
|
+
|
|
14626
|
+
<dl>
|
|
14627
|
+
<dd>
|
|
14628
|
+
|
|
14629
|
+
```typescript
|
|
14630
|
+
await client.tracking.timeseries.cargoByDriver.dataPointsPublicV1({
|
|
14631
|
+
cargo_id: "cargo_id",
|
|
14632
|
+
task_group_id: "task_group_id",
|
|
14633
|
+
limit: 1,
|
|
14634
|
+
});
|
|
14635
|
+
```
|
|
14636
|
+
|
|
14637
|
+
</dd>
|
|
14638
|
+
</dl>
|
|
14639
|
+
</dd>
|
|
14640
|
+
</dl>
|
|
14641
|
+
|
|
14642
|
+
#### ⚙️ Parameters
|
|
14643
|
+
|
|
14644
|
+
<dl>
|
|
14645
|
+
<dd>
|
|
14646
|
+
|
|
14647
|
+
<dl>
|
|
14648
|
+
<dd>
|
|
14649
|
+
|
|
14650
|
+
**request:** `Chrt.tracking.timeseries.CargoByDriverDataPointsPublicV1Request`
|
|
14651
|
+
|
|
14652
|
+
</dd>
|
|
14653
|
+
</dl>
|
|
14654
|
+
|
|
14655
|
+
<dl>
|
|
14656
|
+
<dd>
|
|
14657
|
+
|
|
14658
|
+
**requestOptions:** `CargoByDriver.RequestOptions`
|
|
14659
|
+
|
|
14660
|
+
</dd>
|
|
14661
|
+
</dl>
|
|
14662
|
+
</dd>
|
|
14663
|
+
</dl>
|
|
14664
|
+
|
|
14665
|
+
</dd>
|
|
14666
|
+
</dl>
|
|
14667
|
+
</details>
|
|
14668
|
+
|
|
14669
|
+
## Tracking Timeseries SessionByDevice
|
|
14670
|
+
|
|
14671
|
+
<details><summary><code>client.tracking.timeseries.sessionByDevice.<a href="/src/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.ts">lastSeenV1</a>({ ...params }) -> (Chrt.SessionByDeviceDataPoint1 | null) | undefined</code></summary>
|
|
14672
|
+
<dl>
|
|
14673
|
+
<dd>
|
|
14674
|
+
|
|
14675
|
+
#### 📝 Description
|
|
14676
|
+
|
|
14677
|
+
<dl>
|
|
14678
|
+
<dd>
|
|
14679
|
+
|
|
14680
|
+
<dl>
|
|
14681
|
+
<dd>
|
|
14682
|
+
|
|
14683
|
+
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)
|
|
14684
|
+
|
|
14685
|
+
</dd>
|
|
14686
|
+
</dl>
|
|
14687
|
+
</dd>
|
|
14688
|
+
</dl>
|
|
14689
|
+
|
|
14690
|
+
#### 🔌 Usage
|
|
14691
|
+
|
|
14692
|
+
<dl>
|
|
14693
|
+
<dd>
|
|
14694
|
+
|
|
14695
|
+
<dl>
|
|
14696
|
+
<dd>
|
|
14697
|
+
|
|
14698
|
+
```typescript
|
|
14699
|
+
await client.tracking.timeseries.sessionByDevice.lastSeenV1({
|
|
14700
|
+
session_id: "session_id",
|
|
14701
|
+
});
|
|
14702
|
+
```
|
|
14703
|
+
|
|
14704
|
+
</dd>
|
|
14705
|
+
</dl>
|
|
14706
|
+
</dd>
|
|
14707
|
+
</dl>
|
|
14708
|
+
|
|
14709
|
+
#### ⚙️ Parameters
|
|
14710
|
+
|
|
14711
|
+
<dl>
|
|
14712
|
+
<dd>
|
|
14713
|
+
|
|
14714
|
+
<dl>
|
|
14715
|
+
<dd>
|
|
14716
|
+
|
|
14717
|
+
**request:** `Chrt.tracking.timeseries.SessionByDeviceLastSeenV1Request`
|
|
14718
|
+
|
|
14719
|
+
</dd>
|
|
14720
|
+
</dl>
|
|
14721
|
+
|
|
14722
|
+
<dl>
|
|
14723
|
+
<dd>
|
|
14724
|
+
|
|
14725
|
+
**requestOptions:** `SessionByDevice.RequestOptions`
|
|
14726
|
+
|
|
14727
|
+
</dd>
|
|
14728
|
+
</dl>
|
|
14729
|
+
</dd>
|
|
14730
|
+
</dl>
|
|
14731
|
+
|
|
14732
|
+
</dd>
|
|
14733
|
+
</dl>
|
|
14734
|
+
</details>
|
|
14735
|
+
|
|
14736
|
+
<details><summary><code>client.tracking.timeseries.sessionByDevice.<a href="/src/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.ts">dataPointsV1</a>({ ...params }) -> Chrt.SessionByDeviceDataPoint1[]</code></summary>
|
|
14737
|
+
<dl>
|
|
14738
|
+
<dd>
|
|
14739
|
+
|
|
14740
|
+
#### 📝 Description
|
|
14741
|
+
|
|
14742
|
+
<dl>
|
|
14743
|
+
<dd>
|
|
14744
|
+
|
|
14745
|
+
<dl>
|
|
14746
|
+
<dd>
|
|
14747
|
+
|
|
14748
|
+
Returns up to the specified number of data points for a session, intelligently sampled across the time range. Excludes outliers. | () -> (list[SessionByDeviceDataPoint1])
|
|
14749
|
+
|
|
14750
|
+
</dd>
|
|
14751
|
+
</dl>
|
|
14752
|
+
</dd>
|
|
14753
|
+
</dl>
|
|
14754
|
+
|
|
14755
|
+
#### 🔌 Usage
|
|
14756
|
+
|
|
14757
|
+
<dl>
|
|
14758
|
+
<dd>
|
|
14759
|
+
|
|
14760
|
+
<dl>
|
|
14761
|
+
<dd>
|
|
14762
|
+
|
|
14763
|
+
```typescript
|
|
14764
|
+
await client.tracking.timeseries.sessionByDevice.dataPointsV1({
|
|
14765
|
+
session_id: "session_id",
|
|
14766
|
+
limit: 1,
|
|
14767
|
+
});
|
|
14768
|
+
```
|
|
14769
|
+
|
|
14770
|
+
</dd>
|
|
14771
|
+
</dl>
|
|
14772
|
+
</dd>
|
|
14773
|
+
</dl>
|
|
14774
|
+
|
|
14775
|
+
#### ⚙️ Parameters
|
|
14776
|
+
|
|
14777
|
+
<dl>
|
|
14778
|
+
<dd>
|
|
14779
|
+
|
|
14780
|
+
<dl>
|
|
14781
|
+
<dd>
|
|
14782
|
+
|
|
14783
|
+
**request:** `Chrt.tracking.timeseries.SessionByDeviceDataPointsV1Request`
|
|
14784
|
+
|
|
14785
|
+
</dd>
|
|
14786
|
+
</dl>
|
|
14787
|
+
|
|
14788
|
+
<dl>
|
|
14789
|
+
<dd>
|
|
14790
|
+
|
|
14791
|
+
**requestOptions:** `SessionByDevice.RequestOptions`
|
|
14792
|
+
|
|
14793
|
+
</dd>
|
|
14794
|
+
</dl>
|
|
14795
|
+
</dd>
|
|
14796
|
+
</dl>
|
|
14797
|
+
|
|
14798
|
+
</dd>
|
|
14799
|
+
</dl>
|
|
14800
|
+
</details>
|
|
14801
|
+
|
|
14802
|
+
<details><summary><code>client.tracking.timeseries.sessionByDevice.<a href="/src/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.ts">outlierV1</a>({ ...params }) -> Chrt.SessionByDeviceMarkOutliersResponse1</code></summary>
|
|
14803
|
+
<dl>
|
|
14804
|
+
<dd>
|
|
14805
|
+
|
|
14806
|
+
#### 📝 Description
|
|
14807
|
+
|
|
14808
|
+
<dl>
|
|
14809
|
+
<dd>
|
|
14810
|
+
|
|
14811
|
+
<dl>
|
|
14812
|
+
<dd>
|
|
14813
|
+
|
|
14814
|
+
Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | (SessionByDeviceMarkOutliersRequest1) -> (SessionByDeviceMarkOutliersResponse1)
|
|
14815
|
+
|
|
14816
|
+
</dd>
|
|
14817
|
+
</dl>
|
|
14818
|
+
</dd>
|
|
14819
|
+
</dl>
|
|
14820
|
+
|
|
14821
|
+
#### 🔌 Usage
|
|
14822
|
+
|
|
14823
|
+
<dl>
|
|
14824
|
+
<dd>
|
|
14825
|
+
|
|
14826
|
+
<dl>
|
|
14827
|
+
<dd>
|
|
14828
|
+
|
|
14829
|
+
```typescript
|
|
14830
|
+
await client.tracking.timeseries.sessionByDevice.outlierV1({
|
|
14831
|
+
tracking_session_by_device_data_point_ids: ["tracking_session_by_device_data_point_ids"],
|
|
14832
|
+
outlier: true,
|
|
14833
|
+
});
|
|
14834
|
+
```
|
|
14835
|
+
|
|
14836
|
+
</dd>
|
|
14837
|
+
</dl>
|
|
14838
|
+
</dd>
|
|
14839
|
+
</dl>
|
|
14840
|
+
|
|
14841
|
+
#### ⚙️ Parameters
|
|
14842
|
+
|
|
14843
|
+
<dl>
|
|
14844
|
+
<dd>
|
|
14845
|
+
|
|
14846
|
+
<dl>
|
|
14847
|
+
<dd>
|
|
14848
|
+
|
|
14849
|
+
**request:** `Chrt.tracking.timeseries.SessionByDeviceMarkOutliersRequest1`
|
|
14850
|
+
|
|
14851
|
+
</dd>
|
|
14852
|
+
</dl>
|
|
14853
|
+
|
|
14854
|
+
<dl>
|
|
14855
|
+
<dd>
|
|
14856
|
+
|
|
14857
|
+
**requestOptions:** `SessionByDevice.RequestOptions`
|
|
14858
|
+
|
|
14859
|
+
</dd>
|
|
14860
|
+
</dl>
|
|
14861
|
+
</dd>
|
|
14862
|
+
</dl>
|
|
14863
|
+
|
|
14864
|
+
</dd>
|
|
14865
|
+
</dl>
|
|
14866
|
+
</details>
|
|
14867
|
+
|
|
14868
|
+
<details><summary><code>client.tracking.timeseries.sessionByDevice.<a href="/src/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.ts">lastSeenPublicV1</a>({ ...params }) -> (Chrt.SessionByDeviceDataPoint1 | null) | undefined</code></summary>
|
|
14869
|
+
<dl>
|
|
14870
|
+
<dd>
|
|
14871
|
+
|
|
14872
|
+
#### 📝 Description
|
|
14873
|
+
|
|
14874
|
+
<dl>
|
|
14875
|
+
<dd>
|
|
14876
|
+
|
|
14877
|
+
<dl>
|
|
14878
|
+
<dd>
|
|
14879
|
+
|
|
14880
|
+
Returns the most recent data point for a public session, excluding outliers. No authentication required if session has public visibility enabled. | () -> (SessionByDeviceDataPoint1 | None)
|
|
14881
|
+
|
|
14882
|
+
</dd>
|
|
14883
|
+
</dl>
|
|
14884
|
+
</dd>
|
|
14885
|
+
</dl>
|
|
14886
|
+
|
|
14887
|
+
#### 🔌 Usage
|
|
14888
|
+
|
|
14889
|
+
<dl>
|
|
14890
|
+
<dd>
|
|
14891
|
+
|
|
14892
|
+
<dl>
|
|
14893
|
+
<dd>
|
|
14894
|
+
|
|
14895
|
+
```typescript
|
|
14896
|
+
await client.tracking.timeseries.sessionByDevice.lastSeenPublicV1({
|
|
14897
|
+
session_id: "session_id",
|
|
14898
|
+
});
|
|
14899
|
+
```
|
|
14900
|
+
|
|
14901
|
+
</dd>
|
|
14902
|
+
</dl>
|
|
14903
|
+
</dd>
|
|
14904
|
+
</dl>
|
|
14905
|
+
|
|
14906
|
+
#### ⚙️ Parameters
|
|
14907
|
+
|
|
14908
|
+
<dl>
|
|
14909
|
+
<dd>
|
|
14910
|
+
|
|
14911
|
+
<dl>
|
|
14912
|
+
<dd>
|
|
14913
|
+
|
|
14914
|
+
**request:** `Chrt.tracking.timeseries.SessionByDeviceLastSeenPublicV1Request`
|
|
14915
|
+
|
|
14916
|
+
</dd>
|
|
14917
|
+
</dl>
|
|
14918
|
+
|
|
14919
|
+
<dl>
|
|
14920
|
+
<dd>
|
|
14921
|
+
|
|
14922
|
+
**requestOptions:** `SessionByDevice.RequestOptions`
|
|
14923
|
+
|
|
14924
|
+
</dd>
|
|
14925
|
+
</dl>
|
|
14926
|
+
</dd>
|
|
14927
|
+
</dl>
|
|
14928
|
+
|
|
14929
|
+
</dd>
|
|
14930
|
+
</dl>
|
|
14931
|
+
</details>
|
|
14932
|
+
|
|
14933
|
+
<details><summary><code>client.tracking.timeseries.sessionByDevice.<a href="/src/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.ts">dataPointsPublicV1</a>({ ...params }) -> Chrt.SessionByDeviceDataPoint1[]</code></summary>
|
|
14934
|
+
<dl>
|
|
14935
|
+
<dd>
|
|
14936
|
+
|
|
14937
|
+
#### 📝 Description
|
|
14938
|
+
|
|
14939
|
+
<dl>
|
|
14940
|
+
<dd>
|
|
14941
|
+
|
|
14942
|
+
<dl>
|
|
14943
|
+
<dd>
|
|
14944
|
+
|
|
14945
|
+
Returns up to the specified number of data points for a public session, intelligently sampled across the time range. Excludes outliers. No authentication required if session has public visibility enabled. | () -> (list[SessionByDeviceDataPoint1])
|
|
14946
|
+
|
|
14947
|
+
</dd>
|
|
14948
|
+
</dl>
|
|
14949
|
+
</dd>
|
|
14950
|
+
</dl>
|
|
14951
|
+
|
|
14952
|
+
#### 🔌 Usage
|
|
14953
|
+
|
|
14954
|
+
<dl>
|
|
14955
|
+
<dd>
|
|
14956
|
+
|
|
14957
|
+
<dl>
|
|
14958
|
+
<dd>
|
|
14959
|
+
|
|
14960
|
+
```typescript
|
|
14961
|
+
await client.tracking.timeseries.sessionByDevice.dataPointsPublicV1({
|
|
14962
|
+
session_id: "session_id",
|
|
14963
|
+
limit: 1,
|
|
14964
|
+
});
|
|
14965
|
+
```
|
|
14966
|
+
|
|
14967
|
+
</dd>
|
|
14968
|
+
</dl>
|
|
14969
|
+
</dd>
|
|
14970
|
+
</dl>
|
|
14971
|
+
|
|
14972
|
+
#### ⚙️ Parameters
|
|
14973
|
+
|
|
14974
|
+
<dl>
|
|
14975
|
+
<dd>
|
|
14976
|
+
|
|
14977
|
+
<dl>
|
|
14978
|
+
<dd>
|
|
14979
|
+
|
|
14980
|
+
**request:** `Chrt.tracking.timeseries.SessionByDeviceDataPointsPublicV1Request`
|
|
14981
|
+
|
|
14982
|
+
</dd>
|
|
14983
|
+
</dl>
|
|
14984
|
+
|
|
14985
|
+
<dl>
|
|
14986
|
+
<dd>
|
|
14987
|
+
|
|
14988
|
+
**requestOptions:** `SessionByDevice.RequestOptions`
|
|
14989
|
+
|
|
14990
|
+
</dd>
|
|
14991
|
+
</dl>
|
|
14992
|
+
</dd>
|
|
14993
|
+
</dl>
|
|
14994
|
+
|
|
14995
|
+
</dd>
|
|
14996
|
+
</dl>
|
|
14997
|
+
</details>
|
|
14998
|
+
|
|
14999
|
+
## Tracking Timeseries TaskGroupByDriver
|
|
15000
|
+
|
|
15001
|
+
<details><summary><code>client.tracking.timeseries.taskGroupByDriver.<a href="/src/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.ts">lastSeenV1</a>({ ...params }) -> (Chrt.TaskGroupByDriverDataPoint1 | null) | undefined</code></summary>
|
|
15002
|
+
<dl>
|
|
15003
|
+
<dd>
|
|
15004
|
+
|
|
15005
|
+
#### 📝 Description
|
|
15006
|
+
|
|
15007
|
+
<dl>
|
|
15008
|
+
<dd>
|
|
15009
|
+
|
|
15010
|
+
<dl>
|
|
15011
|
+
<dd>
|
|
15012
|
+
|
|
15013
|
+
Returns the most recent driver location data point for a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | () -> (TaskGroupByDriverDataPoint1 | None)
|
|
15014
|
+
|
|
15015
|
+
</dd>
|
|
15016
|
+
</dl>
|
|
15017
|
+
</dd>
|
|
15018
|
+
</dl>
|
|
15019
|
+
|
|
15020
|
+
#### 🔌 Usage
|
|
15021
|
+
|
|
15022
|
+
<dl>
|
|
15023
|
+
<dd>
|
|
15024
|
+
|
|
15025
|
+
<dl>
|
|
15026
|
+
<dd>
|
|
15027
|
+
|
|
15028
|
+
```typescript
|
|
15029
|
+
await client.tracking.timeseries.taskGroupByDriver.lastSeenV1({
|
|
15030
|
+
task_group_id: "task_group_id",
|
|
15031
|
+
});
|
|
15032
|
+
```
|
|
15033
|
+
|
|
15034
|
+
</dd>
|
|
15035
|
+
</dl>
|
|
15036
|
+
</dd>
|
|
15037
|
+
</dl>
|
|
15038
|
+
|
|
15039
|
+
#### ⚙️ Parameters
|
|
15040
|
+
|
|
15041
|
+
<dl>
|
|
15042
|
+
<dd>
|
|
15043
|
+
|
|
15044
|
+
<dl>
|
|
15045
|
+
<dd>
|
|
15046
|
+
|
|
15047
|
+
**request:** `Chrt.tracking.timeseries.TaskGroupByDriverLastSeenV1Request`
|
|
15048
|
+
|
|
15049
|
+
</dd>
|
|
15050
|
+
</dl>
|
|
15051
|
+
|
|
15052
|
+
<dl>
|
|
15053
|
+
<dd>
|
|
15054
|
+
|
|
15055
|
+
**requestOptions:** `TaskGroupByDriver.RequestOptions`
|
|
15056
|
+
|
|
15057
|
+
</dd>
|
|
15058
|
+
</dl>
|
|
15059
|
+
</dd>
|
|
15060
|
+
</dl>
|
|
15061
|
+
|
|
15062
|
+
</dd>
|
|
15063
|
+
</dl>
|
|
15064
|
+
</details>
|
|
15065
|
+
|
|
15066
|
+
<details><summary><code>client.tracking.timeseries.taskGroupByDriver.<a href="/src/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.ts">dataPointsV1</a>({ ...params }) -> Chrt.TaskGroupByDriverDataPoint1[]</code></summary>
|
|
15067
|
+
<dl>
|
|
15068
|
+
<dd>
|
|
15069
|
+
|
|
15070
|
+
#### 📝 Description
|
|
15071
|
+
|
|
15072
|
+
<dl>
|
|
15073
|
+
<dd>
|
|
15074
|
+
|
|
15075
|
+
<dl>
|
|
15076
|
+
<dd>
|
|
15077
|
+
|
|
15078
|
+
Returns up to the specified number of data points for a task group, intelligently sampled across the time range. Excludes outliers. | () -> (list[TaskGroupByDriverDataPoint1])
|
|
15079
|
+
|
|
15080
|
+
</dd>
|
|
15081
|
+
</dl>
|
|
15082
|
+
</dd>
|
|
15083
|
+
</dl>
|
|
15084
|
+
|
|
15085
|
+
#### 🔌 Usage
|
|
15086
|
+
|
|
15087
|
+
<dl>
|
|
15088
|
+
<dd>
|
|
15089
|
+
|
|
15090
|
+
<dl>
|
|
15091
|
+
<dd>
|
|
15092
|
+
|
|
15093
|
+
```typescript
|
|
15094
|
+
await client.tracking.timeseries.taskGroupByDriver.dataPointsV1({
|
|
15095
|
+
task_group_id: "task_group_id",
|
|
15096
|
+
limit: 1,
|
|
15097
|
+
});
|
|
15098
|
+
```
|
|
15099
|
+
|
|
15100
|
+
</dd>
|
|
15101
|
+
</dl>
|
|
15102
|
+
</dd>
|
|
15103
|
+
</dl>
|
|
15104
|
+
|
|
15105
|
+
#### ⚙️ Parameters
|
|
15106
|
+
|
|
15107
|
+
<dl>
|
|
15108
|
+
<dd>
|
|
15109
|
+
|
|
15110
|
+
<dl>
|
|
15111
|
+
<dd>
|
|
15112
|
+
|
|
15113
|
+
**request:** `Chrt.tracking.timeseries.TaskGroupByDriverDataPointsV1Request`
|
|
15114
|
+
|
|
15115
|
+
</dd>
|
|
15116
|
+
</dl>
|
|
15117
|
+
|
|
15118
|
+
<dl>
|
|
15119
|
+
<dd>
|
|
15120
|
+
|
|
15121
|
+
**requestOptions:** `TaskGroupByDriver.RequestOptions`
|
|
15122
|
+
|
|
15123
|
+
</dd>
|
|
15124
|
+
</dl>
|
|
15125
|
+
</dd>
|
|
15126
|
+
</dl>
|
|
15127
|
+
|
|
15128
|
+
</dd>
|
|
15129
|
+
</dl>
|
|
15130
|
+
</details>
|
|
15131
|
+
|
|
15132
|
+
<details><summary><code>client.tracking.timeseries.taskGroupByDriver.<a href="/src/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.ts">lastSeenPublicV1</a>({ ...params }) -> (Chrt.TaskGroupByDriverDataPoint1 | null) | undefined</code></summary>
|
|
15133
|
+
<dl>
|
|
15134
|
+
<dd>
|
|
15135
|
+
|
|
15136
|
+
#### 📝 Description
|
|
15137
|
+
|
|
15138
|
+
<dl>
|
|
15139
|
+
<dd>
|
|
15140
|
+
|
|
15141
|
+
<dl>
|
|
15142
|
+
<dd>
|
|
15143
|
+
|
|
15144
|
+
Returns the most recent driver location data point for a public task group. No authentication required if task group has public visibility enabled via sharing settings. | () -> (TaskGroupByDriverDataPoint1 | None)
|
|
15145
|
+
|
|
15146
|
+
</dd>
|
|
15147
|
+
</dl>
|
|
15148
|
+
</dd>
|
|
15149
|
+
</dl>
|
|
15150
|
+
|
|
15151
|
+
#### 🔌 Usage
|
|
15152
|
+
|
|
15153
|
+
<dl>
|
|
15154
|
+
<dd>
|
|
15155
|
+
|
|
15156
|
+
<dl>
|
|
15157
|
+
<dd>
|
|
15158
|
+
|
|
15159
|
+
```typescript
|
|
15160
|
+
await client.tracking.timeseries.taskGroupByDriver.lastSeenPublicV1({
|
|
15161
|
+
task_group_id: "task_group_id",
|
|
15162
|
+
});
|
|
15163
|
+
```
|
|
15164
|
+
|
|
15165
|
+
</dd>
|
|
15166
|
+
</dl>
|
|
15167
|
+
</dd>
|
|
15168
|
+
</dl>
|
|
15169
|
+
|
|
15170
|
+
#### ⚙️ Parameters
|
|
15171
|
+
|
|
15172
|
+
<dl>
|
|
15173
|
+
<dd>
|
|
15174
|
+
|
|
15175
|
+
<dl>
|
|
15176
|
+
<dd>
|
|
15177
|
+
|
|
15178
|
+
**request:** `Chrt.tracking.timeseries.TaskGroupByDriverLastSeenPublicV1Request`
|
|
15179
|
+
|
|
15180
|
+
</dd>
|
|
15181
|
+
</dl>
|
|
15182
|
+
|
|
15183
|
+
<dl>
|
|
15184
|
+
<dd>
|
|
15185
|
+
|
|
15186
|
+
**requestOptions:** `TaskGroupByDriver.RequestOptions`
|
|
15187
|
+
|
|
15188
|
+
</dd>
|
|
15189
|
+
</dl>
|
|
15190
|
+
</dd>
|
|
15191
|
+
</dl>
|
|
15192
|
+
|
|
15193
|
+
</dd>
|
|
15194
|
+
</dl>
|
|
15195
|
+
</details>
|
|
15196
|
+
|
|
15197
|
+
<details><summary><code>client.tracking.timeseries.taskGroupByDriver.<a href="/src/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.ts">dataPointsPublicV1</a>({ ...params }) -> Chrt.TaskGroupByDriverDataPoint1[]</code></summary>
|
|
15198
|
+
<dl>
|
|
15199
|
+
<dd>
|
|
15200
|
+
|
|
15201
|
+
#### 📝 Description
|
|
15202
|
+
|
|
15203
|
+
<dl>
|
|
15204
|
+
<dd>
|
|
15205
|
+
|
|
15206
|
+
<dl>
|
|
15207
|
+
<dd>
|
|
15208
|
+
|
|
15209
|
+
Returns up to the specified number of data points for a public task group, intelligently sampled across the time range. Excludes outliers. No authentication required if task group has public visibility enabled via sharing settings. | () -> (list[TaskGroupByDriverDataPoint1])
|
|
15210
|
+
|
|
15211
|
+
</dd>
|
|
15212
|
+
</dl>
|
|
15213
|
+
</dd>
|
|
15214
|
+
</dl>
|
|
15215
|
+
|
|
15216
|
+
#### 🔌 Usage
|
|
15217
|
+
|
|
15218
|
+
<dl>
|
|
15219
|
+
<dd>
|
|
15220
|
+
|
|
15221
|
+
<dl>
|
|
15222
|
+
<dd>
|
|
15223
|
+
|
|
15224
|
+
```typescript
|
|
15225
|
+
await client.tracking.timeseries.taskGroupByDriver.dataPointsPublicV1({
|
|
15226
|
+
task_group_id: "task_group_id",
|
|
15227
|
+
limit: 1,
|
|
15228
|
+
});
|
|
15229
|
+
```
|
|
15230
|
+
|
|
15231
|
+
</dd>
|
|
15232
|
+
</dl>
|
|
15233
|
+
</dd>
|
|
15234
|
+
</dl>
|
|
15235
|
+
|
|
15236
|
+
#### ⚙️ Parameters
|
|
15237
|
+
|
|
15238
|
+
<dl>
|
|
15239
|
+
<dd>
|
|
15240
|
+
|
|
15241
|
+
<dl>
|
|
15242
|
+
<dd>
|
|
15243
|
+
|
|
15244
|
+
**request:** `Chrt.tracking.timeseries.TaskGroupByDriverDataPointsPublicV1Request`
|
|
14254
15245
|
|
|
14255
15246
|
</dd>
|
|
14256
15247
|
</dl>
|