@chrt-inc/typescript-sdk 1.325.0 → 1.331.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -21
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/cargos/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/cargos/client/Client.js +1 -1
- 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/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/taskArtifacts/resources/s3Object/client/Client.d.ts +2 -9
- package/dist/cjs/api/resources/taskArtifacts/resources/s3Object/client/Client.js +2 -8
- package/dist/cjs/api/resources/taskGroups/resources/s3Object/client/Client.d.ts +2 -9
- package/dist/cjs/api/resources/taskGroups/resources/s3Object/client/Client.js +2 -8
- 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 +1 -2
- package/dist/cjs/api/resources/tracking/resources/driver/client/Client.js +1 -2
- package/dist/cjs/api/resources/tracking/resources/driver/client/requests/DriverUpdateReq.d.ts +0 -2
- package/dist/cjs/api/resources/tracking/resources/index.d.ts +5 -8
- package/dist/cjs/api/resources/tracking/resources/index.js +6 -9
- 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/{esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceDeleteV1Request.d.mts → cjs/api/resources/tracking/resources/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/sharing/client/Client.d.ts +100 -0
- package/dist/cjs/api/resources/tracking/resources/sharing/client/Client.js +330 -0
- package/dist/cjs/api/resources/tracking/resources/sharing/client/requests/CargoByDeviceSharingSettingsUpdateReq.d.ts +18 -0
- package/dist/cjs/api/resources/tracking/resources/sharing/client/requests/CargoByDriverSharingSettingsUpdateReq.d.ts +18 -0
- package/dist/cjs/api/resources/tracking/resources/sharing/client/requests/TaskGroupByDriverSharingSettingsUpdateReq.d.ts +16 -0
- package/dist/cjs/api/resources/tracking/resources/sharing/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/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/TaskGroupByDriverDataPointsPublicV1Request.js +5 -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/TaskGroupByDriverDataPointsV1Request.js +5 -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/TaskGroupByDriverLastSeenPublicV1Request.js +5 -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/{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/{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 +14 -9
- package/dist/cjs/api/types/index.js +14 -9
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/cargos/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/cargos/client/Client.mjs +1 -1
- 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/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/taskArtifacts/resources/s3Object/client/Client.d.mts +2 -9
- package/dist/esm/api/resources/taskArtifacts/resources/s3Object/client/Client.mjs +2 -8
- package/dist/esm/api/resources/taskGroups/resources/s3Object/client/Client.d.mts +2 -9
- package/dist/esm/api/resources/taskGroups/resources/s3Object/client/Client.mjs +2 -8
- 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 +1 -2
- package/dist/esm/api/resources/tracking/resources/driver/client/Client.mjs +1 -2
- package/dist/esm/api/resources/tracking/resources/driver/client/requests/DriverUpdateReq.d.mts +0 -2
- package/dist/esm/api/resources/tracking/resources/index.d.mts +5 -8
- package/dist/esm/api/resources/tracking/resources/index.mjs +5 -8
- 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/{cjs/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceDeleteV1Request.d.ts → esm/api/resources/tracking/resources/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/sharing/client/Client.d.mts +100 -0
- package/dist/esm/api/resources/tracking/resources/sharing/client/Client.mjs +293 -0
- package/dist/esm/api/resources/tracking/resources/sharing/client/requests/CargoByDeviceSharingSettingsUpdateReq.d.mts +18 -0
- package/dist/esm/api/resources/tracking/resources/sharing/client/requests/CargoByDriverSharingSettingsUpdateReq.d.mts +18 -0
- package/dist/esm/api/resources/tracking/resources/sharing/client/requests/TaskGroupByDriverSharingSettingsUpdateReq.d.mts +16 -0
- package/dist/esm/api/resources/tracking/resources/sharing/client/requests/index.d.mts +3 -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.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/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/TaskGroupByDriverDataPointsPublicV1Request.mjs +4 -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/TaskGroupByDriverDataPointsV1Request.mjs +4 -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/TaskGroupByDriverLastSeenPublicV1Request.mjs +4 -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/{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/{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 +14 -9
- package/dist/esm/api/types/index.mjs +14 -9
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +1155 -222
- package/dist/cjs/api/resources/tracking/resources/cargoByDevice/client/Client.d.ts +0 -50
- 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/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/Client.js +0 -135
- package/dist/cjs/api/resources/tracking/resources/taskGroupByDriver/client/requests/index.d.ts +0 -1
- package/dist/esm/api/resources/tracking/resources/cargoByDevice/client/Client.d.mts +0 -50
- 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/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/Client.mjs +0 -98
- package/dist/esm/api/resources/tracking/resources/taskGroupByDriver/client/requests/index.d.mts +0 -1
- /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/tracking/resources/{cargoByDevice/client/requests/CargoByDeviceLastSeenV1Request.js → sessions/client/requests/SessionCreateSessionRequest1.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDriver/client/requests/CargoByDriverLastSeenV1Request.js → sessions/client/requests/SessionUpdateRequest1.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceCreateSessionRequest1.js → sessions/client/requests/SessionsDeleteV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceDataPointsPublicV1Request.js → sessions/client/requests/SessionsGetV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceDataPointsV1Request.js → sessions/client/requests/SessionsPauseRecordingV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceDeleteV1Request.js → sessions/client/requests/SessionsResumeRecordingV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceGetV1Request.js → sessions/client/requests/SessionsStartV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceLastSeenPublicV1Request.js → sessions/client/requests/SessionsTerminateV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDevice → sessions}/client/requests/index.js +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDevice → sessions}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDevice → sessions}/index.js +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDriver → sharing}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDriver → sharing}/client/index.js +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceLastSeenV1Request.js → sharing/client/requests/CargoByDeviceSharingSettingsUpdateReq.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceMarkOutliersRequest1.js → sharing/client/requests/CargoByDriverSharingSettingsUpdateReq.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDevicePauseRecordingV1Request.js → sharing/client/requests/TaskGroupByDriverSharingSettingsUpdateReq.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDriver → sharing}/client/requests/index.js +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDriver → sharing}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{cargoByDriver → sharing}/index.js +0 -0
- /package/dist/{esm/api/resources/tracking/resources/cargoByDevice/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/SessionByDeviceResumeRecordingV1Request.js → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceDataPointsPublicV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceStartV1Request.js → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceDataPointsV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceTerminateV1Request.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/SessionByDeviceUpdateRequest1.js → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceLastSeenV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{taskGroupByDriver/client/requests/TaskGroupByDriverLastSeenV1Request.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/{sessionByDevice → timeseries/resources/cargoByDevice}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{sessionByDevice → 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/{types/SessionByDeviceDeleteResponse1.js → resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/CargoByDriverDataPointsPublicV1Request.js} +0 -0
- /package/dist/cjs/api/{types/TrackingCargoByDeviceDataPoint1.js → resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/CargoByDriverDataPointsV1Request.js} +0 -0
- /package/dist/cjs/api/{types/TrackingCargoByDeviceDataPointMetadata1.js → resources/tracking/resources/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/TrackingCargoByDriverDataPoint1.js → resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/CargoByDriverLastSeenV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{taskGroupByDriver → timeseries/resources/cargoByDriver}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{taskGroupByDriver → timeseries/resources/cargoByDriver}/index.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/TrackingCargoByDriverDataPointMetadata1.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/TrackingSessionByDeviceDataPoint1.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/TrackingSessionByDeviceDataPointMetadata1.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/TrackingTaskGroupByDriverDataPoint1.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/TrackingTaskGroupByDriverDataPointMetadata1.js → resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/SessionByDeviceMarkOutliersRequest1.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/{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/tracking/resources/{cargoByDevice/client/requests/CargoByDeviceLastSeenV1Request.mjs → sessions/client/requests/SessionCreateSessionRequest1.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDriver/client/requests/CargoByDriverLastSeenV1Request.mjs → sessions/client/requests/SessionUpdateRequest1.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceCreateSessionRequest1.mjs → sessions/client/requests/SessionsDeleteV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceDataPointsPublicV1Request.mjs → sessions/client/requests/SessionsGetV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceDataPointsV1Request.mjs → sessions/client/requests/SessionsPauseRecordingV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceDeleteV1Request.mjs → sessions/client/requests/SessionsResumeRecordingV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceGetV1Request.mjs → sessions/client/requests/SessionsStartV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceLastSeenPublicV1Request.mjs → sessions/client/requests/SessionsTerminateV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDriver → sessions}/client/requests/index.mjs +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDevice → sessions}/index.d.mts +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDevice → sessions}/index.mjs +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDriver → sharing}/client/index.d.mts +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDriver → sharing}/client/index.mjs +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceLastSeenV1Request.mjs → sharing/client/requests/CargoByDeviceSharingSettingsUpdateReq.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceMarkOutliersRequest1.mjs → sharing/client/requests/CargoByDriverSharingSettingsUpdateReq.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDevicePauseRecordingV1Request.mjs → sharing/client/requests/TaskGroupByDriverSharingSettingsUpdateReq.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice → sharing}/client/requests/index.mjs +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDriver → sharing}/index.d.mts +0 -0
- /package/dist/esm/api/resources/tracking/resources/{cargoByDriver → sharing}/index.mjs +0 -0
- /package/dist/esm/api/resources/tracking/resources/{taskGroupByDriver/client/requests/index.mjs → timeseries/client/index.d.mts} +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/SessionByDeviceResumeRecordingV1Request.mjs → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceDataPointsPublicV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceStartV1Request.mjs → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceDataPointsV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice/client/requests/SessionByDeviceTerminateV1Request.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/SessionByDeviceUpdateRequest1.mjs → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceLastSeenV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{taskGroupByDriver/client/requests/TaskGroupByDriverLastSeenV1Request.mjs → timeseries/resources/cargoByDevice/client/requests/CargoByDeviceMarkOutliersRequest1.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice → timeseries/resources/cargoByDevice}/index.d.mts +0 -0
- /package/dist/esm/api/resources/tracking/resources/{sessionByDevice → 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/{types/SessionByDeviceDeleteResponse1.mjs → resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/CargoByDriverDataPointsPublicV1Request.mjs} +0 -0
- /package/dist/esm/api/{types/TrackingCargoByDeviceDataPoint1.mjs → resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/CargoByDriverDataPointsV1Request.mjs} +0 -0
- /package/dist/esm/api/{types/TrackingCargoByDeviceDataPointMetadata1.mjs → resources/tracking/resources/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/TrackingCargoByDriverDataPoint1.mjs → resources/tracking/resources/timeseries/resources/cargoByDriver/client/requests/CargoByDriverLastSeenV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{taskGroupByDriver → timeseries/resources/cargoByDriver}/index.d.mts +0 -0
- /package/dist/esm/api/resources/tracking/resources/{taskGroupByDriver → timeseries/resources/cargoByDriver}/index.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/TrackingCargoByDriverDataPointMetadata1.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/TrackingSessionByDeviceDataPoint1.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/TrackingSessionByDeviceDataPointMetadata1.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/TrackingTaskGroupByDriverDataPoint1.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/TrackingTaskGroupByDriverDataPointMetadata1.mjs → resources/tracking/resources/timeseries/resources/sessionByDevice/client/requests/SessionByDeviceMarkOutliersRequest1.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>
|
|
@@ -4618,7 +4618,7 @@ await client.drivers.listV1({
|
|
|
4618
4618
|
<dl>
|
|
4619
4619
|
<dd>
|
|
4620
4620
|
|
|
4621
|
-
Creates a new driver profile for the caller.
|
|
4621
|
+
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
4622
|
|
|
4623
4623
|
</dd>
|
|
4624
4624
|
</dl>
|
|
@@ -4635,6 +4635,7 @@ Creates a new driver profile for the caller. Returns existing driver ID if one a
|
|
|
4635
4635
|
|
|
4636
4636
|
```typescript
|
|
4637
4637
|
await client.drivers.createV1({
|
|
4638
|
+
target_user_id: "target_user_id",
|
|
4638
4639
|
schema_version: 1,
|
|
4639
4640
|
});
|
|
4640
4641
|
```
|
|
@@ -5025,7 +5026,7 @@ await client.drivers.updateAvailabilityAccordingToOperatorsV1("driver_id", {
|
|
|
5025
5026
|
<dl>
|
|
5026
5027
|
<dd>
|
|
5027
5028
|
|
|
5028
|
-
Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
5029
|
+
Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPPED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
5029
5030
|
|
|
5030
5031
|
</dd>
|
|
5031
5032
|
</dl>
|
|
@@ -8743,7 +8744,7 @@ await client.connections.connectionToForwarder.createV1({
|
|
|
8743
8744
|
<dl>
|
|
8744
8745
|
<dd>
|
|
8745
8746
|
|
|
8746
|
-
Adds additional line items to an existing courier driver line item group.
|
|
8747
|
+
Adds additional line items to an existing courier driver line item group. | (CourierPayDriverLineItemGroupAddLineItemsReq) -> (CourierPayDriverLineItemGroup1)
|
|
8747
8748
|
|
|
8748
8749
|
</dd>
|
|
8749
8750
|
</dl>
|
|
@@ -8825,7 +8826,7 @@ await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
8825
8826
|
<dl>
|
|
8826
8827
|
<dd>
|
|
8827
8828
|
|
|
8828
|
-
Removes specific line items from a courier driver line item group by their UUID identifiers.
|
|
8829
|
+
Removes specific line items from a courier driver line item group by their UUID identifiers. | (CourierPayDriverLineItemGroupRemoveLineItemsReq) -> (CourierPayDriverLineItemGroup1)
|
|
8829
8830
|
|
|
8830
8831
|
</dd>
|
|
8831
8832
|
</dl>
|
|
@@ -10369,7 +10370,7 @@ await client.orders.expanded.forForwarderOperatorsV1("order_id_or_short_id", {})
|
|
|
10369
10370
|
<dl>
|
|
10370
10371
|
<dd>
|
|
10371
10372
|
|
|
10372
|
-
Lists expanded orders for forwarder operators with filtering, sorting, and pagination. |
|
|
10373
|
+
Lists expanded orders for forwarder operators with filtering, sorting, and pagination. | authz: allowed_org_types=[forwarder], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
|
|
10373
10374
|
|
|
10374
10375
|
</dd>
|
|
10375
10376
|
</dl>
|
|
@@ -10450,7 +10451,7 @@ await client.orders.expanded.listForForwarderOperatorsV1({
|
|
|
10450
10451
|
<dl>
|
|
10451
10452
|
<dd>
|
|
10452
10453
|
|
|
10453
|
-
Lists expanded orders for shipper operators with filtering, sorting, and pagination. |
|
|
10454
|
+
Lists expanded orders for shipper operators with filtering, sorting, and pagination. | authz: allowed_org_types=[shipper], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
|
|
10454
10455
|
|
|
10455
10456
|
</dd>
|
|
10456
10457
|
</dl>
|
|
@@ -11146,7 +11147,7 @@ await client.orgInfoForConnections.forwarder.updateV1();
|
|
|
11146
11147
|
<dl>
|
|
11147
11148
|
<dd>
|
|
11148
11149
|
|
|
11149
|
-
Lists all shipper pay courier line item groups for the caller's shipper organization.
|
|
11150
|
+
Lists all shipper pay courier line item groups for the caller's shipper organization. | () -> (list[ShipperPayCourierLineItemGroup1])
|
|
11150
11151
|
|
|
11151
11152
|
</dd>
|
|
11152
11153
|
</dl>
|
|
@@ -11201,7 +11202,7 @@ await client.shipperPayCourierLineItemGroups.shipper.listV1();
|
|
|
11201
11202
|
<dl>
|
|
11202
11203
|
<dd>
|
|
11203
11204
|
|
|
11204
|
-
Retrieves a shipper pay courier line item group by its ID for the caller's shipper organization.
|
|
11205
|
+
Retrieves a shipper pay courier line item group by its ID for the caller's shipper organization. | () -> (ShipperPayCourierLineItemGroup1)
|
|
11205
11206
|
|
|
11206
11207
|
</dd>
|
|
11207
11208
|
</dl>
|
|
@@ -11264,7 +11265,7 @@ await client.shipperPayCourierLineItemGroups.shipper.getByIdV1("id");
|
|
|
11264
11265
|
<dl>
|
|
11265
11266
|
<dd>
|
|
11266
11267
|
|
|
11267
|
-
Retrieves a shipper pay courier line item group by its associated task group ID for the caller's shipper organization.
|
|
11268
|
+
Retrieves a shipper pay courier line item group by its associated task group ID for the caller's shipper organization. | () -> (ShipperPayCourierLineItemGroup1)
|
|
11268
11269
|
|
|
11269
11270
|
</dd>
|
|
11270
11271
|
</dl>
|
|
@@ -11329,7 +11330,7 @@ await client.shipperPayCourierLineItemGroups.shipper.byTaskGroupIdV1("task_group
|
|
|
11329
11330
|
<dl>
|
|
11330
11331
|
<dd>
|
|
11331
11332
|
|
|
11332
|
-
Lists all shipper pay courier line item groups for the caller's courier organization.
|
|
11333
|
+
Lists all shipper pay courier line item groups for the caller's courier organization. | () -> (list[ShipperPayCourierLineItemGroup1])
|
|
11333
11334
|
|
|
11334
11335
|
</dd>
|
|
11335
11336
|
</dl>
|
|
@@ -11386,7 +11387,7 @@ await client.shipperPayCourierLineItemGroups.courier.listV1();
|
|
|
11386
11387
|
<dl>
|
|
11387
11388
|
<dd>
|
|
11388
11389
|
|
|
11389
|
-
Adds additional line items to an existing shipper pay courier line item group.
|
|
11390
|
+
Adds additional line items to an existing shipper pay courier line item group. | (ShipperPayCourierLineItemGroupAddLineItemsReq) -> (ShipperPayCourierLineItemGroup1)
|
|
11390
11391
|
|
|
11391
11392
|
</dd>
|
|
11392
11393
|
</dl>
|
|
@@ -11468,7 +11469,7 @@ await client.shipperPayCourierLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
11468
11469
|
<dl>
|
|
11469
11470
|
<dd>
|
|
11470
11471
|
|
|
11471
|
-
Removes specific line items from a shipper pay courier line item group by their UUID identifiers.
|
|
11472
|
+
Removes specific line items from a shipper pay courier line item group by their UUID identifiers. | (ShipperPayCourierLineItemGroupRemoveLineItemsReq) -> (ShipperPayCourierLineItemGroup1)
|
|
11472
11473
|
|
|
11473
11474
|
</dd>
|
|
11474
11475
|
</dl>
|
|
@@ -11594,7 +11595,7 @@ await client.taskArtifacts.s3Object.getS3ObjectMetadataV1("task_artifact_s3_obje
|
|
|
11594
11595
|
</dl>
|
|
11595
11596
|
</details>
|
|
11596
11597
|
|
|
11597
|
-
<details><summary><code>client.taskArtifacts.s3Object.<a href="/src/api/resources/taskArtifacts/resources/s3Object/client/Client.ts">getV1</a>(taskArtifactS3ObjectMetadataId) ->
|
|
11598
|
+
<details><summary><code>client.taskArtifacts.s3Object.<a href="/src/api/resources/taskArtifacts/resources/s3Object/client/Client.ts">getV1</a>(taskArtifactS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
11598
11599
|
<dl>
|
|
11599
11600
|
<dd>
|
|
11600
11601
|
|
|
@@ -11606,7 +11607,7 @@ await client.taskArtifacts.s3Object.getS3ObjectMetadataV1("task_artifact_s3_obje
|
|
|
11606
11607
|
<dl>
|
|
11607
11608
|
<dd>
|
|
11608
11609
|
|
|
11609
|
-
Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (
|
|
11610
|
+
Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (binary)
|
|
11610
11611
|
|
|
11611
11612
|
</dd>
|
|
11612
11613
|
</dl>
|
|
@@ -11986,7 +11987,7 @@ await client.taskGroups.s3Object.getS3ObjectMetadataV1("task_group_s3_object_met
|
|
|
11986
11987
|
</dl>
|
|
11987
11988
|
</details>
|
|
11988
11989
|
|
|
11989
|
-
<details><summary><code>client.taskGroups.s3Object.<a href="/src/api/resources/taskGroups/resources/s3Object/client/Client.ts">getV1</a>(taskGroupS3ObjectMetadataId) ->
|
|
11990
|
+
<details><summary><code>client.taskGroups.s3Object.<a href="/src/api/resources/taskGroups/resources/s3Object/client/Client.ts">getV1</a>(taskGroupS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
11990
11991
|
<dl>
|
|
11991
11992
|
<dd>
|
|
11992
11993
|
|
|
@@ -11998,7 +11999,7 @@ await client.taskGroups.s3Object.getS3ObjectMetadataV1("task_group_s3_object_met
|
|
|
11998
11999
|
<dl>
|
|
11999
12000
|
<dd>
|
|
12000
12001
|
|
|
12001
|
-
Streams a task group S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (
|
|
12002
|
+
Streams a task group S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (binary)
|
|
12002
12003
|
|
|
12003
12004
|
</dd>
|
|
12004
12005
|
</dl>
|
|
@@ -12633,9 +12634,9 @@ await client.taskGroups.expanded.listForCourierDriverV1({
|
|
|
12633
12634
|
</dl>
|
|
12634
12635
|
</details>
|
|
12635
12636
|
|
|
12636
|
-
## Tracking
|
|
12637
|
+
## Tracking Devices
|
|
12637
12638
|
|
|
12638
|
-
<details><summary><code>client.tracking.
|
|
12639
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">registerToOrgV1</a>({ ...params }) -> string</code></summary>
|
|
12639
12640
|
<dl>
|
|
12640
12641
|
<dd>
|
|
12641
12642
|
|
|
@@ -12647,7 +12648,7 @@ await client.taskGroups.expanded.listForCourierDriverV1({
|
|
|
12647
12648
|
<dl>
|
|
12648
12649
|
<dd>
|
|
12649
12650
|
|
|
12650
|
-
|
|
12651
|
+
Registers a tracking device to the caller's organization. If device is already registered to a different organization, registration is blocked. | (DevicesRegisterToOrgReq1) -> (PydanticObjectId)
|
|
12651
12652
|
|
|
12652
12653
|
</dd>
|
|
12653
12654
|
</dl>
|
|
@@ -12663,9 +12664,8 @@ Returns the most recent device location data point for cargo within a task group
|
|
|
12663
12664
|
<dd>
|
|
12664
12665
|
|
|
12665
12666
|
```typescript
|
|
12666
|
-
await client.tracking.
|
|
12667
|
-
|
|
12668
|
-
task_group_id: "task_group_id",
|
|
12667
|
+
await client.tracking.devices.registerToOrgV1({
|
|
12668
|
+
device_mac_address: "device_mac_address",
|
|
12669
12669
|
});
|
|
12670
12670
|
```
|
|
12671
12671
|
|
|
@@ -12682,7 +12682,7 @@ await client.tracking.cargoByDevice.lastSeenV1({
|
|
|
12682
12682
|
<dl>
|
|
12683
12683
|
<dd>
|
|
12684
12684
|
|
|
12685
|
-
**request:** `Chrt.tracking.
|
|
12685
|
+
**request:** `Chrt.tracking.DevicesRegisterToOrgReq1`
|
|
12686
12686
|
|
|
12687
12687
|
</dd>
|
|
12688
12688
|
</dl>
|
|
@@ -12690,7 +12690,7 @@ await client.tracking.cargoByDevice.lastSeenV1({
|
|
|
12690
12690
|
<dl>
|
|
12691
12691
|
<dd>
|
|
12692
12692
|
|
|
12693
|
-
**requestOptions:** `
|
|
12693
|
+
**requestOptions:** `Devices.RequestOptions`
|
|
12694
12694
|
|
|
12695
12695
|
</dd>
|
|
12696
12696
|
</dl>
|
|
@@ -12701,9 +12701,7 @@ await client.tracking.cargoByDevice.lastSeenV1({
|
|
|
12701
12701
|
</dl>
|
|
12702
12702
|
</details>
|
|
12703
12703
|
|
|
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>
|
|
12704
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
12707
12705
|
<dl>
|
|
12708
12706
|
<dd>
|
|
12709
12707
|
|
|
@@ -12715,7 +12713,7 @@ await client.tracking.cargoByDevice.lastSeenV1({
|
|
|
12715
12713
|
<dl>
|
|
12716
12714
|
<dd>
|
|
12717
12715
|
|
|
12718
|
-
|
|
12716
|
+
Updates a device's type and/or comments. Can update one or both fields, or delete them by setting delete flags. | (DevicesUpdateRequest1) -> (bool)
|
|
12719
12717
|
|
|
12720
12718
|
</dd>
|
|
12721
12719
|
</dl>
|
|
@@ -12731,10 +12729,7 @@ Returns the most recent driver location data point for cargo within a task group
|
|
|
12731
12729
|
<dd>
|
|
12732
12730
|
|
|
12733
12731
|
```typescript
|
|
12734
|
-
await client.tracking.
|
|
12735
|
-
cargo_id: "cargo_id",
|
|
12736
|
-
task_group_id: "task_group_id",
|
|
12737
|
-
});
|
|
12732
|
+
await client.tracking.devices.updateV1();
|
|
12738
12733
|
```
|
|
12739
12734
|
|
|
12740
12735
|
</dd>
|
|
@@ -12750,7 +12745,7 @@ await client.tracking.cargoByDriver.lastSeenV1({
|
|
|
12750
12745
|
<dl>
|
|
12751
12746
|
<dd>
|
|
12752
12747
|
|
|
12753
|
-
**request:** `Chrt.tracking.
|
|
12748
|
+
**request:** `Chrt.tracking.DevicesUpdateRequest1`
|
|
12754
12749
|
|
|
12755
12750
|
</dd>
|
|
12756
12751
|
</dl>
|
|
@@ -12758,7 +12753,7 @@ await client.tracking.cargoByDriver.lastSeenV1({
|
|
|
12758
12753
|
<dl>
|
|
12759
12754
|
<dd>
|
|
12760
12755
|
|
|
12761
|
-
**requestOptions:** `
|
|
12756
|
+
**requestOptions:** `Devices.RequestOptions`
|
|
12762
12757
|
|
|
12763
12758
|
</dd>
|
|
12764
12759
|
</dl>
|
|
@@ -12769,9 +12764,7 @@ await client.tracking.cargoByDriver.lastSeenV1({
|
|
|
12769
12764
|
</dl>
|
|
12770
12765
|
</details>
|
|
12771
12766
|
|
|
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>
|
|
12767
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">deleteV1</a>({ ...params }) -> boolean</code></summary>
|
|
12775
12768
|
<dl>
|
|
12776
12769
|
<dd>
|
|
12777
12770
|
|
|
@@ -12783,7 +12776,7 @@ await client.tracking.cargoByDriver.lastSeenV1({
|
|
|
12783
12776
|
<dl>
|
|
12784
12777
|
<dd>
|
|
12785
12778
|
|
|
12786
|
-
|
|
12779
|
+
Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. | () -> (bool)
|
|
12787
12780
|
|
|
12788
12781
|
</dd>
|
|
12789
12782
|
</dl>
|
|
@@ -12799,7 +12792,8 @@ Registers a tracking device to the caller's organization. If device is already r
|
|
|
12799
12792
|
<dd>
|
|
12800
12793
|
|
|
12801
12794
|
```typescript
|
|
12802
|
-
await client.tracking.devices.
|
|
12795
|
+
await client.tracking.devices.deleteV1({
|
|
12796
|
+
device_id: "device_id",
|
|
12803
12797
|
device_mac_address: "device_mac_address",
|
|
12804
12798
|
});
|
|
12805
12799
|
```
|
|
@@ -12817,7 +12811,7 @@ await client.tracking.devices.registerToOrgV1({
|
|
|
12817
12811
|
<dl>
|
|
12818
12812
|
<dd>
|
|
12819
12813
|
|
|
12820
|
-
**request:** `Chrt.tracking.
|
|
12814
|
+
**request:** `Chrt.tracking.DevicesDeleteV1Request`
|
|
12821
12815
|
|
|
12822
12816
|
</dd>
|
|
12823
12817
|
</dl>
|
|
@@ -12836,7 +12830,7 @@ await client.tracking.devices.registerToOrgV1({
|
|
|
12836
12830
|
</dl>
|
|
12837
12831
|
</details>
|
|
12838
12832
|
|
|
12839
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">
|
|
12833
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">linkToCargoV1</a>({ ...params }) -> boolean</code></summary>
|
|
12840
12834
|
<dl>
|
|
12841
12835
|
<dd>
|
|
12842
12836
|
|
|
@@ -12848,7 +12842,7 @@ await client.tracking.devices.registerToOrgV1({
|
|
|
12848
12842
|
<dl>
|
|
12849
12843
|
<dd>
|
|
12850
12844
|
|
|
12851
|
-
|
|
12845
|
+
Links a device to cargo with bidirectional references. Device must not already be linked to a session or different cargo. | () -> (bool)
|
|
12852
12846
|
|
|
12853
12847
|
</dd>
|
|
12854
12848
|
</dl>
|
|
@@ -12864,7 +12858,10 @@ Updates a device's type and/or comments. Can update one or both fields, or delet
|
|
|
12864
12858
|
<dd>
|
|
12865
12859
|
|
|
12866
12860
|
```typescript
|
|
12867
|
-
await client.tracking.devices.
|
|
12861
|
+
await client.tracking.devices.linkToCargoV1({
|
|
12862
|
+
device_mac_address: "device_mac_address",
|
|
12863
|
+
cargo_id: "cargo_id",
|
|
12864
|
+
});
|
|
12868
12865
|
```
|
|
12869
12866
|
|
|
12870
12867
|
</dd>
|
|
@@ -12880,7 +12877,7 @@ await client.tracking.devices.updateV1();
|
|
|
12880
12877
|
<dl>
|
|
12881
12878
|
<dd>
|
|
12882
12879
|
|
|
12883
|
-
**request:** `Chrt.tracking.
|
|
12880
|
+
**request:** `Chrt.tracking.DevicesLinkToCargoV1Request`
|
|
12884
12881
|
|
|
12885
12882
|
</dd>
|
|
12886
12883
|
</dl>
|
|
@@ -12899,7 +12896,7 @@ await client.tracking.devices.updateV1();
|
|
|
12899
12896
|
</dl>
|
|
12900
12897
|
</details>
|
|
12901
12898
|
|
|
12902
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">
|
|
12899
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">unlinkFromCargoV1</a>({ ...params }) -> boolean</code></summary>
|
|
12903
12900
|
<dl>
|
|
12904
12901
|
<dd>
|
|
12905
12902
|
|
|
@@ -12911,7 +12908,7 @@ await client.tracking.devices.updateV1();
|
|
|
12911
12908
|
<dl>
|
|
12912
12909
|
<dd>
|
|
12913
12910
|
|
|
12914
|
-
|
|
12911
|
+
Unlinks a device from its linked cargo, removing the bidirectional reference. Returns false if device is not linked to any cargo. | () -> (bool)
|
|
12915
12912
|
|
|
12916
12913
|
</dd>
|
|
12917
12914
|
</dl>
|
|
@@ -12927,8 +12924,7 @@ Deletes a device by ID or MAC address. Device must be unlinked from any session
|
|
|
12927
12924
|
<dd>
|
|
12928
12925
|
|
|
12929
12926
|
```typescript
|
|
12930
|
-
await client.tracking.devices.
|
|
12931
|
-
device_id: "device_id",
|
|
12927
|
+
await client.tracking.devices.unlinkFromCargoV1({
|
|
12932
12928
|
device_mac_address: "device_mac_address",
|
|
12933
12929
|
});
|
|
12934
12930
|
```
|
|
@@ -12946,7 +12942,7 @@ await client.tracking.devices.deleteV1({
|
|
|
12946
12942
|
<dl>
|
|
12947
12943
|
<dd>
|
|
12948
12944
|
|
|
12949
|
-
**request:** `Chrt.tracking.
|
|
12945
|
+
**request:** `Chrt.tracking.DevicesUnlinkFromCargoV1Request`
|
|
12950
12946
|
|
|
12951
12947
|
</dd>
|
|
12952
12948
|
</dl>
|
|
@@ -12977,7 +12973,7 @@ await client.tracking.devices.deleteV1({
|
|
|
12977
12973
|
<dl>
|
|
12978
12974
|
<dd>
|
|
12979
12975
|
|
|
12980
|
-
Retrieves a single device by its MAC address or ID. Access restricted to the caller's organization. | () -> (Device1)
|
|
12976
|
+
Retrieves a single device by its MAC address or ID. Access restricted to the caller's organization. | authz: min_org_role=operator | () -> (Device1)
|
|
12981
12977
|
|
|
12982
12978
|
</dd>
|
|
12983
12979
|
</dl>
|
|
@@ -13043,7 +13039,7 @@ await client.tracking.devices.getV1({
|
|
|
13043
13039
|
<dl>
|
|
13044
13040
|
<dd>
|
|
13045
13041
|
|
|
13046
|
-
Returns all tracking devices registered to the caller's organization. | () -> (list[Device1])
|
|
13042
|
+
Returns all tracking devices registered to the caller's organization. | authz: min_org_role=operator | () -> (list[Device1])
|
|
13047
13043
|
|
|
13048
13044
|
</dd>
|
|
13049
13045
|
</dl>
|
|
@@ -13086,7 +13082,9 @@ await client.tracking.devices.listV1();
|
|
|
13086
13082
|
</dl>
|
|
13087
13083
|
</details>
|
|
13088
13084
|
|
|
13089
|
-
|
|
13085
|
+
## Tracking Driver
|
|
13086
|
+
|
|
13087
|
+
<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
13088
|
<dl>
|
|
13091
13089
|
<dd>
|
|
13092
13090
|
|
|
@@ -13098,7 +13096,7 @@ await client.tracking.devices.listV1();
|
|
|
13098
13096
|
<dl>
|
|
13099
13097
|
<dd>
|
|
13100
13098
|
|
|
13101
|
-
|
|
13099
|
+
Records driver location updates. Automatically writes to all IN_PROGRESS task groups and their associated cargos. Updates driver's last seen timestamp and location. | (DriverUpdateReq) -> (DriverUpdateRes)
|
|
13102
13100
|
|
|
13103
13101
|
</dd>
|
|
13104
13102
|
</dl>
|
|
@@ -13114,9 +13112,20 @@ Links a device to cargo with bidirectional references. Device must not already b
|
|
|
13114
13112
|
<dd>
|
|
13115
13113
|
|
|
13116
13114
|
```typescript
|
|
13117
|
-
await client.tracking.
|
|
13118
|
-
|
|
13119
|
-
|
|
13115
|
+
await client.tracking.driver.updateV1({
|
|
13116
|
+
timestamp: "2024-01-15T09:30:00Z",
|
|
13117
|
+
location: {
|
|
13118
|
+
type: "Feature",
|
|
13119
|
+
geometry: {
|
|
13120
|
+
type: "GeometryCollection",
|
|
13121
|
+
geometries: [
|
|
13122
|
+
{
|
|
13123
|
+
type: "LineString",
|
|
13124
|
+
coordinates: [[]],
|
|
13125
|
+
},
|
|
13126
|
+
],
|
|
13127
|
+
},
|
|
13128
|
+
},
|
|
13120
13129
|
});
|
|
13121
13130
|
```
|
|
13122
13131
|
|
|
@@ -13133,7 +13142,7 @@ await client.tracking.devices.linkToCargoV1({
|
|
|
13133
13142
|
<dl>
|
|
13134
13143
|
<dd>
|
|
13135
13144
|
|
|
13136
|
-
**request:** `Chrt.tracking.
|
|
13145
|
+
**request:** `Chrt.tracking.DriverUpdateReq`
|
|
13137
13146
|
|
|
13138
13147
|
</dd>
|
|
13139
13148
|
</dl>
|
|
@@ -13141,7 +13150,7 @@ await client.tracking.devices.linkToCargoV1({
|
|
|
13141
13150
|
<dl>
|
|
13142
13151
|
<dd>
|
|
13143
13152
|
|
|
13144
|
-
**requestOptions:** `
|
|
13153
|
+
**requestOptions:** `Driver.RequestOptions`
|
|
13145
13154
|
|
|
13146
13155
|
</dd>
|
|
13147
13156
|
</dl>
|
|
@@ -13152,7 +13161,9 @@ await client.tracking.devices.linkToCargoV1({
|
|
|
13152
13161
|
</dl>
|
|
13153
13162
|
</details>
|
|
13154
13163
|
|
|
13155
|
-
|
|
13164
|
+
## Tracking Sessions
|
|
13165
|
+
|
|
13166
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">listV1</a>() -> Chrt.Session1[]</code></summary>
|
|
13156
13167
|
<dl>
|
|
13157
13168
|
<dd>
|
|
13158
13169
|
|
|
@@ -13164,7 +13175,7 @@ await client.tracking.devices.linkToCargoV1({
|
|
|
13164
13175
|
<dl>
|
|
13165
13176
|
<dd>
|
|
13166
13177
|
|
|
13167
|
-
|
|
13178
|
+
Returns all tracking sessions for the caller's organization. | () -> (list[Session1])
|
|
13168
13179
|
|
|
13169
13180
|
</dd>
|
|
13170
13181
|
</dl>
|
|
@@ -13180,8 +13191,63 @@ Unlinks a device from its linked cargo, removing the bidirectional reference. Re
|
|
|
13180
13191
|
<dd>
|
|
13181
13192
|
|
|
13182
13193
|
```typescript
|
|
13183
|
-
await client.tracking.
|
|
13184
|
-
|
|
13194
|
+
await client.tracking.sessions.listV1();
|
|
13195
|
+
```
|
|
13196
|
+
|
|
13197
|
+
</dd>
|
|
13198
|
+
</dl>
|
|
13199
|
+
</dd>
|
|
13200
|
+
</dl>
|
|
13201
|
+
|
|
13202
|
+
#### ⚙️ Parameters
|
|
13203
|
+
|
|
13204
|
+
<dl>
|
|
13205
|
+
<dd>
|
|
13206
|
+
|
|
13207
|
+
<dl>
|
|
13208
|
+
<dd>
|
|
13209
|
+
|
|
13210
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13211
|
+
|
|
13212
|
+
</dd>
|
|
13213
|
+
</dl>
|
|
13214
|
+
</dd>
|
|
13215
|
+
</dl>
|
|
13216
|
+
|
|
13217
|
+
</dd>
|
|
13218
|
+
</dl>
|
|
13219
|
+
</details>
|
|
13220
|
+
|
|
13221
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">getV1</a>({ ...params }) -> Chrt.Session1</code></summary>
|
|
13222
|
+
<dl>
|
|
13223
|
+
<dd>
|
|
13224
|
+
|
|
13225
|
+
#### 📝 Description
|
|
13226
|
+
|
|
13227
|
+
<dl>
|
|
13228
|
+
<dd>
|
|
13229
|
+
|
|
13230
|
+
<dl>
|
|
13231
|
+
<dd>
|
|
13232
|
+
|
|
13233
|
+
Retrieves a single session by its ID. Access restricted to the caller's organization. | () -> (Session1)
|
|
13234
|
+
|
|
13235
|
+
</dd>
|
|
13236
|
+
</dl>
|
|
13237
|
+
</dd>
|
|
13238
|
+
</dl>
|
|
13239
|
+
|
|
13240
|
+
#### 🔌 Usage
|
|
13241
|
+
|
|
13242
|
+
<dl>
|
|
13243
|
+
<dd>
|
|
13244
|
+
|
|
13245
|
+
<dl>
|
|
13246
|
+
<dd>
|
|
13247
|
+
|
|
13248
|
+
```typescript
|
|
13249
|
+
await client.tracking.sessions.getV1({
|
|
13250
|
+
session_id: "session_id",
|
|
13185
13251
|
});
|
|
13186
13252
|
```
|
|
13187
13253
|
|
|
@@ -13198,7 +13264,7 @@ await client.tracking.devices.unlinkFromCargoV1({
|
|
|
13198
13264
|
<dl>
|
|
13199
13265
|
<dd>
|
|
13200
13266
|
|
|
13201
|
-
**request:** `Chrt.tracking.
|
|
13267
|
+
**request:** `Chrt.tracking.SessionsGetV1Request`
|
|
13202
13268
|
|
|
13203
13269
|
</dd>
|
|
13204
13270
|
</dl>
|
|
@@ -13206,7 +13272,7 @@ await client.tracking.devices.unlinkFromCargoV1({
|
|
|
13206
13272
|
<dl>
|
|
13207
13273
|
<dd>
|
|
13208
13274
|
|
|
13209
|
-
**requestOptions:** `
|
|
13275
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13210
13276
|
|
|
13211
13277
|
</dd>
|
|
13212
13278
|
</dl>
|
|
@@ -13217,9 +13283,7 @@ await client.tracking.devices.unlinkFromCargoV1({
|
|
|
13217
13283
|
</dl>
|
|
13218
13284
|
</details>
|
|
13219
13285
|
|
|
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>
|
|
13286
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">createSessionV1</a>({ ...params }) -> string</code></summary>
|
|
13223
13287
|
<dl>
|
|
13224
13288
|
<dd>
|
|
13225
13289
|
|
|
@@ -13231,7 +13295,7 @@ await client.tracking.devices.unlinkFromCargoV1({
|
|
|
13231
13295
|
<dl>
|
|
13232
13296
|
<dd>
|
|
13233
13297
|
|
|
13234
|
-
|
|
13298
|
+
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)
|
|
13235
13299
|
|
|
13236
13300
|
</dd>
|
|
13237
13301
|
</dl>
|
|
@@ -13247,21 +13311,8 @@ Records driver location updates for a task group. Automatically writes to task g
|
|
|
13247
13311
|
<dd>
|
|
13248
13312
|
|
|
13249
13313
|
```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
|
-
},
|
|
13314
|
+
await client.tracking.sessions.createSessionV1({
|
|
13315
|
+
device_mac_address: "device_mac_address",
|
|
13265
13316
|
});
|
|
13266
13317
|
```
|
|
13267
13318
|
|
|
@@ -13278,7 +13329,7 @@ await client.tracking.driver.updateV1({
|
|
|
13278
13329
|
<dl>
|
|
13279
13330
|
<dd>
|
|
13280
13331
|
|
|
13281
|
-
**request:** `Chrt.tracking.
|
|
13332
|
+
**request:** `Chrt.tracking.SessionCreateSessionRequest1`
|
|
13282
13333
|
|
|
13283
13334
|
</dd>
|
|
13284
13335
|
</dl>
|
|
@@ -13286,7 +13337,7 @@ await client.tracking.driver.updateV1({
|
|
|
13286
13337
|
<dl>
|
|
13287
13338
|
<dd>
|
|
13288
13339
|
|
|
13289
|
-
**requestOptions:** `
|
|
13340
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13290
13341
|
|
|
13291
13342
|
</dd>
|
|
13292
13343
|
</dl>
|
|
@@ -13297,9 +13348,7 @@ await client.tracking.driver.updateV1({
|
|
|
13297
13348
|
</dl>
|
|
13298
13349
|
</details>
|
|
13299
13350
|
|
|
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>
|
|
13351
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
13303
13352
|
<dl>
|
|
13304
13353
|
<dd>
|
|
13305
13354
|
|
|
@@ -13311,7 +13360,7 @@ await client.tracking.driver.updateV1({
|
|
|
13311
13360
|
<dl>
|
|
13312
13361
|
<dd>
|
|
13313
13362
|
|
|
13314
|
-
|
|
13363
|
+
Updates a session's comments and/or public visibility status. Can update one or both fields. | (SessionUpdateRequest1) -> (bool)
|
|
13315
13364
|
|
|
13316
13365
|
</dd>
|
|
13317
13366
|
</dl>
|
|
@@ -13327,7 +13376,9 @@ Returns all tracking sessions for the caller's organization. | () -> (list[Sessi
|
|
|
13327
13376
|
<dd>
|
|
13328
13377
|
|
|
13329
13378
|
```typescript
|
|
13330
|
-
await client.tracking.
|
|
13379
|
+
await client.tracking.sessions.updateV1({
|
|
13380
|
+
session_id: "session_id",
|
|
13381
|
+
});
|
|
13331
13382
|
```
|
|
13332
13383
|
|
|
13333
13384
|
</dd>
|
|
@@ -13343,7 +13394,15 @@ await client.tracking.sessionByDevice.listV1();
|
|
|
13343
13394
|
<dl>
|
|
13344
13395
|
<dd>
|
|
13345
13396
|
|
|
13346
|
-
**
|
|
13397
|
+
**request:** `Chrt.tracking.SessionUpdateRequest1`
|
|
13398
|
+
|
|
13399
|
+
</dd>
|
|
13400
|
+
</dl>
|
|
13401
|
+
|
|
13402
|
+
<dl>
|
|
13403
|
+
<dd>
|
|
13404
|
+
|
|
13405
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13347
13406
|
|
|
13348
13407
|
</dd>
|
|
13349
13408
|
</dl>
|
|
@@ -13354,7 +13413,7 @@ await client.tracking.sessionByDevice.listV1();
|
|
|
13354
13413
|
</dl>
|
|
13355
13414
|
</details>
|
|
13356
13415
|
|
|
13357
|
-
<details><summary><code>client.tracking.
|
|
13416
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">startV1</a>({ ...params }) -> boolean</code></summary>
|
|
13358
13417
|
<dl>
|
|
13359
13418
|
<dd>
|
|
13360
13419
|
|
|
@@ -13366,7 +13425,7 @@ await client.tracking.sessionByDevice.listV1();
|
|
|
13366
13425
|
<dl>
|
|
13367
13426
|
<dd>
|
|
13368
13427
|
|
|
13369
|
-
|
|
13428
|
+
Starts location recording for a session by setting recording status to true. Sets the recording initiated timestamp on first start. | () -> (bool)
|
|
13370
13429
|
|
|
13371
13430
|
</dd>
|
|
13372
13431
|
</dl>
|
|
@@ -13382,7 +13441,7 @@ Retrieves a single session by its ID. Access restricted to the caller's organiza
|
|
|
13382
13441
|
<dd>
|
|
13383
13442
|
|
|
13384
13443
|
```typescript
|
|
13385
|
-
await client.tracking.
|
|
13444
|
+
await client.tracking.sessions.startV1({
|
|
13386
13445
|
session_id: "session_id",
|
|
13387
13446
|
});
|
|
13388
13447
|
```
|
|
@@ -13400,7 +13459,7 @@ await client.tracking.sessionByDevice.getV1({
|
|
|
13400
13459
|
<dl>
|
|
13401
13460
|
<dd>
|
|
13402
13461
|
|
|
13403
|
-
**request:** `Chrt.tracking.
|
|
13462
|
+
**request:** `Chrt.tracking.SessionsStartV1Request`
|
|
13404
13463
|
|
|
13405
13464
|
</dd>
|
|
13406
13465
|
</dl>
|
|
@@ -13408,7 +13467,7 @@ await client.tracking.sessionByDevice.getV1({
|
|
|
13408
13467
|
<dl>
|
|
13409
13468
|
<dd>
|
|
13410
13469
|
|
|
13411
|
-
**requestOptions:** `
|
|
13470
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13412
13471
|
|
|
13413
13472
|
</dd>
|
|
13414
13473
|
</dl>
|
|
@@ -13419,7 +13478,7 @@ await client.tracking.sessionByDevice.getV1({
|
|
|
13419
13478
|
</dl>
|
|
13420
13479
|
</details>
|
|
13421
13480
|
|
|
13422
|
-
<details><summary><code>client.tracking.
|
|
13481
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">pauseRecordingV1</a>({ ...params }) -> boolean</code></summary>
|
|
13423
13482
|
<dl>
|
|
13424
13483
|
<dd>
|
|
13425
13484
|
|
|
@@ -13431,7 +13490,7 @@ await client.tracking.sessionByDevice.getV1({
|
|
|
13431
13490
|
<dl>
|
|
13432
13491
|
<dd>
|
|
13433
13492
|
|
|
13434
|
-
|
|
13493
|
+
Pauses location recording for a session by setting recording status to false. Device remains linked to the session. | () -> (bool)
|
|
13435
13494
|
|
|
13436
13495
|
</dd>
|
|
13437
13496
|
</dl>
|
|
@@ -13447,7 +13506,7 @@ Returns the most recent data point for a session, excluding outliers. Access res
|
|
|
13447
13506
|
<dd>
|
|
13448
13507
|
|
|
13449
13508
|
```typescript
|
|
13450
|
-
await client.tracking.
|
|
13509
|
+
await client.tracking.sessions.pauseRecordingV1({
|
|
13451
13510
|
session_id: "session_id",
|
|
13452
13511
|
});
|
|
13453
13512
|
```
|
|
@@ -13465,7 +13524,7 @@ await client.tracking.sessionByDevice.lastSeenV1({
|
|
|
13465
13524
|
<dl>
|
|
13466
13525
|
<dd>
|
|
13467
13526
|
|
|
13468
|
-
**request:** `Chrt.tracking.
|
|
13527
|
+
**request:** `Chrt.tracking.SessionsPauseRecordingV1Request`
|
|
13469
13528
|
|
|
13470
13529
|
</dd>
|
|
13471
13530
|
</dl>
|
|
@@ -13473,7 +13532,7 @@ await client.tracking.sessionByDevice.lastSeenV1({
|
|
|
13473
13532
|
<dl>
|
|
13474
13533
|
<dd>
|
|
13475
13534
|
|
|
13476
|
-
**requestOptions:** `
|
|
13535
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13477
13536
|
|
|
13478
13537
|
</dd>
|
|
13479
13538
|
</dl>
|
|
@@ -13484,7 +13543,7 @@ await client.tracking.sessionByDevice.lastSeenV1({
|
|
|
13484
13543
|
</dl>
|
|
13485
13544
|
</details>
|
|
13486
13545
|
|
|
13487
|
-
<details><summary><code>client.tracking.
|
|
13546
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">resumeRecordingV1</a>({ ...params }) -> boolean</code></summary>
|
|
13488
13547
|
<dl>
|
|
13489
13548
|
<dd>
|
|
13490
13549
|
|
|
@@ -13496,7 +13555,7 @@ await client.tracking.sessionByDevice.lastSeenV1({
|
|
|
13496
13555
|
<dl>
|
|
13497
13556
|
<dd>
|
|
13498
13557
|
|
|
13499
|
-
|
|
13558
|
+
Resumes location recording for a session by setting recording status to true. | () -> (bool)
|
|
13500
13559
|
|
|
13501
13560
|
</dd>
|
|
13502
13561
|
</dl>
|
|
@@ -13512,9 +13571,8 @@ Returns up to the specified number of data points for a session, intelligently s
|
|
|
13512
13571
|
<dd>
|
|
13513
13572
|
|
|
13514
13573
|
```typescript
|
|
13515
|
-
await client.tracking.
|
|
13574
|
+
await client.tracking.sessions.resumeRecordingV1({
|
|
13516
13575
|
session_id: "session_id",
|
|
13517
|
-
limit: 1,
|
|
13518
13576
|
});
|
|
13519
13577
|
```
|
|
13520
13578
|
|
|
@@ -13531,7 +13589,7 @@ await client.tracking.sessionByDevice.dataPointsV1({
|
|
|
13531
13589
|
<dl>
|
|
13532
13590
|
<dd>
|
|
13533
13591
|
|
|
13534
|
-
**request:** `Chrt.tracking.
|
|
13592
|
+
**request:** `Chrt.tracking.SessionsResumeRecordingV1Request`
|
|
13535
13593
|
|
|
13536
13594
|
</dd>
|
|
13537
13595
|
</dl>
|
|
@@ -13539,7 +13597,7 @@ await client.tracking.sessionByDevice.dataPointsV1({
|
|
|
13539
13597
|
<dl>
|
|
13540
13598
|
<dd>
|
|
13541
13599
|
|
|
13542
|
-
**requestOptions:** `
|
|
13600
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13543
13601
|
|
|
13544
13602
|
</dd>
|
|
13545
13603
|
</dl>
|
|
@@ -13550,7 +13608,7 @@ await client.tracking.sessionByDevice.dataPointsV1({
|
|
|
13550
13608
|
</dl>
|
|
13551
13609
|
</details>
|
|
13552
13610
|
|
|
13553
|
-
<details><summary><code>client.tracking.
|
|
13611
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">terminateV1</a>({ ...params }) -> boolean</code></summary>
|
|
13554
13612
|
<dl>
|
|
13555
13613
|
<dd>
|
|
13556
13614
|
|
|
@@ -13562,7 +13620,7 @@ await client.tracking.sessionByDevice.dataPointsV1({
|
|
|
13562
13620
|
<dl>
|
|
13563
13621
|
<dd>
|
|
13564
13622
|
|
|
13565
|
-
|
|
13623
|
+
Terminates a session by setting recording to false and marking it as terminated. Unlinks the device from the session. | () -> (bool)
|
|
13566
13624
|
|
|
13567
13625
|
</dd>
|
|
13568
13626
|
</dl>
|
|
@@ -13578,8 +13636,8 @@ Creates a new tracking session for a device and links the device to it. The devi
|
|
|
13578
13636
|
<dd>
|
|
13579
13637
|
|
|
13580
13638
|
```typescript
|
|
13581
|
-
await client.tracking.
|
|
13582
|
-
|
|
13639
|
+
await client.tracking.sessions.terminateV1({
|
|
13640
|
+
session_id: "session_id",
|
|
13583
13641
|
});
|
|
13584
13642
|
```
|
|
13585
13643
|
|
|
@@ -13596,7 +13654,7 @@ await client.tracking.sessionByDevice.createSessionV1({
|
|
|
13596
13654
|
<dl>
|
|
13597
13655
|
<dd>
|
|
13598
13656
|
|
|
13599
|
-
**request:** `Chrt.tracking.
|
|
13657
|
+
**request:** `Chrt.tracking.SessionsTerminateV1Request`
|
|
13600
13658
|
|
|
13601
13659
|
</dd>
|
|
13602
13660
|
</dl>
|
|
@@ -13604,7 +13662,7 @@ await client.tracking.sessionByDevice.createSessionV1({
|
|
|
13604
13662
|
<dl>
|
|
13605
13663
|
<dd>
|
|
13606
13664
|
|
|
13607
|
-
**requestOptions:** `
|
|
13665
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13608
13666
|
|
|
13609
13667
|
</dd>
|
|
13610
13668
|
</dl>
|
|
@@ -13615,7 +13673,7 @@ await client.tracking.sessionByDevice.createSessionV1({
|
|
|
13615
13673
|
</dl>
|
|
13616
13674
|
</details>
|
|
13617
13675
|
|
|
13618
|
-
<details><summary><code>client.tracking.
|
|
13676
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">deleteV1</a>({ ...params }) -> Chrt.SessionDeleteResponse1</code></summary>
|
|
13619
13677
|
<dl>
|
|
13620
13678
|
<dd>
|
|
13621
13679
|
|
|
@@ -13627,7 +13685,7 @@ await client.tracking.sessionByDevice.createSessionV1({
|
|
|
13627
13685
|
<dl>
|
|
13628
13686
|
<dd>
|
|
13629
13687
|
|
|
13630
|
-
|
|
13688
|
+
Deletes a terminated session and all its associated timeseries data points. Only sessions marked as terminated can be deleted. | () -> (SessionDeleteResponse1)
|
|
13631
13689
|
|
|
13632
13690
|
</dd>
|
|
13633
13691
|
</dl>
|
|
@@ -13643,7 +13701,7 @@ Updates a session's comments and/or public visibility status. Can update one or
|
|
|
13643
13701
|
<dd>
|
|
13644
13702
|
|
|
13645
13703
|
```typescript
|
|
13646
|
-
await client.tracking.
|
|
13704
|
+
await client.tracking.sessions.deleteV1({
|
|
13647
13705
|
session_id: "session_id",
|
|
13648
13706
|
});
|
|
13649
13707
|
```
|
|
@@ -13661,7 +13719,7 @@ await client.tracking.sessionByDevice.updateV1({
|
|
|
13661
13719
|
<dl>
|
|
13662
13720
|
<dd>
|
|
13663
13721
|
|
|
13664
|
-
**request:** `Chrt.tracking.
|
|
13722
|
+
**request:** `Chrt.tracking.SessionsDeleteV1Request`
|
|
13665
13723
|
|
|
13666
13724
|
</dd>
|
|
13667
13725
|
</dl>
|
|
@@ -13669,7 +13727,7 @@ await client.tracking.sessionByDevice.updateV1({
|
|
|
13669
13727
|
<dl>
|
|
13670
13728
|
<dd>
|
|
13671
13729
|
|
|
13672
|
-
**requestOptions:** `
|
|
13730
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13673
13731
|
|
|
13674
13732
|
</dd>
|
|
13675
13733
|
</dl>
|
|
@@ -13680,7 +13738,9 @@ await client.tracking.sessionByDevice.updateV1({
|
|
|
13680
13738
|
</dl>
|
|
13681
13739
|
</details>
|
|
13682
13740
|
|
|
13683
|
-
|
|
13741
|
+
## Tracking Sharing
|
|
13742
|
+
|
|
13743
|
+
<details><summary><code>client.tracking.sharing.<a href="/src/api/resources/tracking/resources/sharing/client/Client.ts">getSettingsV1</a>(orderIdOrShortId) -> Chrt.TrackingSharingSettingsRes[]</code></summary>
|
|
13684
13744
|
<dl>
|
|
13685
13745
|
<dd>
|
|
13686
13746
|
|
|
@@ -13692,7 +13752,7 @@ await client.tracking.sessionByDevice.updateV1({
|
|
|
13692
13752
|
<dl>
|
|
13693
13753
|
<dd>
|
|
13694
13754
|
|
|
13695
|
-
|
|
13755
|
+
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])
|
|
13696
13756
|
|
|
13697
13757
|
</dd>
|
|
13698
13758
|
</dl>
|
|
@@ -13708,9 +13768,7 @@ Starts location recording for a session by setting recording status to true. Set
|
|
|
13708
13768
|
<dd>
|
|
13709
13769
|
|
|
13710
13770
|
```typescript
|
|
13711
|
-
await client.tracking.
|
|
13712
|
-
session_id: "session_id",
|
|
13713
|
-
});
|
|
13771
|
+
await client.tracking.sharing.getSettingsV1("order_id_or_short_id");
|
|
13714
13772
|
```
|
|
13715
13773
|
|
|
13716
13774
|
</dd>
|
|
@@ -13726,7 +13784,7 @@ await client.tracking.sessionByDevice.startV1({
|
|
|
13726
13784
|
<dl>
|
|
13727
13785
|
<dd>
|
|
13728
13786
|
|
|
13729
|
-
**
|
|
13787
|
+
**orderIdOrShortId:** `string`
|
|
13730
13788
|
|
|
13731
13789
|
</dd>
|
|
13732
13790
|
</dl>
|
|
@@ -13734,7 +13792,7 @@ await client.tracking.sessionByDevice.startV1({
|
|
|
13734
13792
|
<dl>
|
|
13735
13793
|
<dd>
|
|
13736
13794
|
|
|
13737
|
-
**requestOptions:** `
|
|
13795
|
+
**requestOptions:** `Sharing.RequestOptions`
|
|
13738
13796
|
|
|
13739
13797
|
</dd>
|
|
13740
13798
|
</dl>
|
|
@@ -13745,7 +13803,7 @@ await client.tracking.sessionByDevice.startV1({
|
|
|
13745
13803
|
</dl>
|
|
13746
13804
|
</details>
|
|
13747
13805
|
|
|
13748
|
-
<details><summary><code>client.tracking.
|
|
13806
|
+
<details><summary><code>client.tracking.sharing.<a href="/src/api/resources/tracking/resources/sharing/client/Client.ts">taskGroupByDriverSharingSettingsV1</a>({ ...params }) -> Chrt.TaskGroupByDriverSharingSettings1</code></summary>
|
|
13749
13807
|
<dl>
|
|
13750
13808
|
<dd>
|
|
13751
13809
|
|
|
@@ -13757,7 +13815,7 @@ await client.tracking.sessionByDevice.startV1({
|
|
|
13757
13815
|
<dl>
|
|
13758
13816
|
<dd>
|
|
13759
13817
|
|
|
13760
|
-
|
|
13818
|
+
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)
|
|
13761
13819
|
|
|
13762
13820
|
</dd>
|
|
13763
13821
|
</dl>
|
|
@@ -13773,8 +13831,10 @@ Pauses location recording for a session by setting recording status to false. De
|
|
|
13773
13831
|
<dd>
|
|
13774
13832
|
|
|
13775
13833
|
```typescript
|
|
13776
|
-
await client.tracking.
|
|
13777
|
-
|
|
13834
|
+
await client.tracking.sharing.taskGroupByDriverSharingSettingsV1({
|
|
13835
|
+
task_group_id: "task_group_id",
|
|
13836
|
+
driver_id: "driver_id",
|
|
13837
|
+
public: true,
|
|
13778
13838
|
});
|
|
13779
13839
|
```
|
|
13780
13840
|
|
|
@@ -13791,7 +13851,7 @@ await client.tracking.sessionByDevice.pauseRecordingV1({
|
|
|
13791
13851
|
<dl>
|
|
13792
13852
|
<dd>
|
|
13793
13853
|
|
|
13794
|
-
**request:** `Chrt.tracking.
|
|
13854
|
+
**request:** `Chrt.tracking.TaskGroupByDriverSharingSettingsUpdateReq`
|
|
13795
13855
|
|
|
13796
13856
|
</dd>
|
|
13797
13857
|
</dl>
|
|
@@ -13799,7 +13859,7 @@ await client.tracking.sessionByDevice.pauseRecordingV1({
|
|
|
13799
13859
|
<dl>
|
|
13800
13860
|
<dd>
|
|
13801
13861
|
|
|
13802
|
-
**requestOptions:** `
|
|
13862
|
+
**requestOptions:** `Sharing.RequestOptions`
|
|
13803
13863
|
|
|
13804
13864
|
</dd>
|
|
13805
13865
|
</dl>
|
|
@@ -13810,7 +13870,7 @@ await client.tracking.sessionByDevice.pauseRecordingV1({
|
|
|
13810
13870
|
</dl>
|
|
13811
13871
|
</details>
|
|
13812
13872
|
|
|
13813
|
-
<details><summary><code>client.tracking.
|
|
13873
|
+
<details><summary><code>client.tracking.sharing.<a href="/src/api/resources/tracking/resources/sharing/client/Client.ts">cargoByDriverSettingsV1</a>({ ...params }) -> Chrt.CargoByDriverSharingSettings1</code></summary>
|
|
13814
13874
|
<dl>
|
|
13815
13875
|
<dd>
|
|
13816
13876
|
|
|
@@ -13822,7 +13882,7 @@ await client.tracking.sessionByDevice.pauseRecordingV1({
|
|
|
13822
13882
|
<dl>
|
|
13823
13883
|
<dd>
|
|
13824
13884
|
|
|
13825
|
-
|
|
13885
|
+
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)
|
|
13826
13886
|
|
|
13827
13887
|
</dd>
|
|
13828
13888
|
</dl>
|
|
@@ -13838,8 +13898,11 @@ Resumes location recording for a session by setting recording status to true. |
|
|
|
13838
13898
|
<dd>
|
|
13839
13899
|
|
|
13840
13900
|
```typescript
|
|
13841
|
-
await client.tracking.
|
|
13842
|
-
|
|
13901
|
+
await client.tracking.sharing.cargoByDriverSettingsV1({
|
|
13902
|
+
task_group_id: "task_group_id",
|
|
13903
|
+
cargo_id: "cargo_id",
|
|
13904
|
+
driver_id: "driver_id",
|
|
13905
|
+
public: true,
|
|
13843
13906
|
});
|
|
13844
13907
|
```
|
|
13845
13908
|
|
|
@@ -13856,7 +13919,7 @@ await client.tracking.sessionByDevice.resumeRecordingV1({
|
|
|
13856
13919
|
<dl>
|
|
13857
13920
|
<dd>
|
|
13858
13921
|
|
|
13859
|
-
**request:** `Chrt.tracking.
|
|
13922
|
+
**request:** `Chrt.tracking.CargoByDriverSharingSettingsUpdateReq`
|
|
13860
13923
|
|
|
13861
13924
|
</dd>
|
|
13862
13925
|
</dl>
|
|
@@ -13864,7 +13927,7 @@ await client.tracking.sessionByDevice.resumeRecordingV1({
|
|
|
13864
13927
|
<dl>
|
|
13865
13928
|
<dd>
|
|
13866
13929
|
|
|
13867
|
-
**requestOptions:** `
|
|
13930
|
+
**requestOptions:** `Sharing.RequestOptions`
|
|
13868
13931
|
|
|
13869
13932
|
</dd>
|
|
13870
13933
|
</dl>
|
|
@@ -13875,7 +13938,7 @@ await client.tracking.sessionByDevice.resumeRecordingV1({
|
|
|
13875
13938
|
</dl>
|
|
13876
13939
|
</details>
|
|
13877
13940
|
|
|
13878
|
-
<details><summary><code>client.tracking.
|
|
13941
|
+
<details><summary><code>client.tracking.sharing.<a href="/src/api/resources/tracking/resources/sharing/client/Client.ts">cargoByDeviceSettingsV1</a>({ ...params }) -> Chrt.CargoByDeviceSharingSettings1</code></summary>
|
|
13879
13942
|
<dl>
|
|
13880
13943
|
<dd>
|
|
13881
13944
|
|
|
@@ -13887,7 +13950,7 @@ await client.tracking.sessionByDevice.resumeRecordingV1({
|
|
|
13887
13950
|
<dl>
|
|
13888
13951
|
<dd>
|
|
13889
13952
|
|
|
13890
|
-
|
|
13953
|
+
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)
|
|
13891
13954
|
|
|
13892
13955
|
</dd>
|
|
13893
13956
|
</dl>
|
|
@@ -13903,8 +13966,11 @@ Terminates a session by setting recording to false and marking it as terminated.
|
|
|
13903
13966
|
<dd>
|
|
13904
13967
|
|
|
13905
13968
|
```typescript
|
|
13906
|
-
await client.tracking.
|
|
13907
|
-
|
|
13969
|
+
await client.tracking.sharing.cargoByDeviceSettingsV1({
|
|
13970
|
+
task_group_id: "task_group_id",
|
|
13971
|
+
cargo_id: "cargo_id",
|
|
13972
|
+
device_id: "device_id",
|
|
13973
|
+
public: true,
|
|
13908
13974
|
});
|
|
13909
13975
|
```
|
|
13910
13976
|
|
|
@@ -13921,7 +13987,7 @@ await client.tracking.sessionByDevice.terminateV1({
|
|
|
13921
13987
|
<dl>
|
|
13922
13988
|
<dd>
|
|
13923
13989
|
|
|
13924
|
-
**request:** `Chrt.tracking.
|
|
13990
|
+
**request:** `Chrt.tracking.CargoByDeviceSharingSettingsUpdateReq`
|
|
13925
13991
|
|
|
13926
13992
|
</dd>
|
|
13927
13993
|
</dl>
|
|
@@ -13929,7 +13995,7 @@ await client.tracking.sessionByDevice.terminateV1({
|
|
|
13929
13995
|
<dl>
|
|
13930
13996
|
<dd>
|
|
13931
13997
|
|
|
13932
|
-
**requestOptions:** `
|
|
13998
|
+
**requestOptions:** `Sharing.RequestOptions`
|
|
13933
13999
|
|
|
13934
14000
|
</dd>
|
|
13935
14001
|
</dl>
|
|
@@ -13940,7 +14006,9 @@ await client.tracking.sessionByDevice.terminateV1({
|
|
|
13940
14006
|
</dl>
|
|
13941
14007
|
</details>
|
|
13942
14008
|
|
|
13943
|
-
|
|
14009
|
+
## Tracking Timeseries CargoByDevice
|
|
14010
|
+
|
|
14011
|
+
<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>
|
|
13944
14012
|
<dl>
|
|
13945
14013
|
<dd>
|
|
13946
14014
|
|
|
@@ -13952,7 +14020,7 @@ await client.tracking.sessionByDevice.terminateV1({
|
|
|
13952
14020
|
<dl>
|
|
13953
14021
|
<dd>
|
|
13954
14022
|
|
|
13955
|
-
|
|
14023
|
+
Returns the last seen data point for cargo within a task group. Access granted to courier or shipper organization. | () -> (CargoByDeviceDataPoint1 | None)
|
|
13956
14024
|
|
|
13957
14025
|
</dd>
|
|
13958
14026
|
</dl>
|
|
@@ -13968,9 +14036,9 @@ Marks data points as outliers or non-outliers. Uses atomic delete and reinsert s
|
|
|
13968
14036
|
<dd>
|
|
13969
14037
|
|
|
13970
14038
|
```typescript
|
|
13971
|
-
await client.tracking.
|
|
13972
|
-
|
|
13973
|
-
|
|
14039
|
+
await client.tracking.timeseries.cargoByDevice.lastSeenV1({
|
|
14040
|
+
cargo_id: "cargo_id",
|
|
14041
|
+
task_group_id: "task_group_id",
|
|
13974
14042
|
});
|
|
13975
14043
|
```
|
|
13976
14044
|
|
|
@@ -13987,7 +14055,7 @@ await client.tracking.sessionByDevice.outlierV1({
|
|
|
13987
14055
|
<dl>
|
|
13988
14056
|
<dd>
|
|
13989
14057
|
|
|
13990
|
-
**request:** `Chrt.tracking.
|
|
14058
|
+
**request:** `Chrt.tracking.timeseries.CargoByDeviceLastSeenV1Request`
|
|
13991
14059
|
|
|
13992
14060
|
</dd>
|
|
13993
14061
|
</dl>
|
|
@@ -13995,7 +14063,7 @@ await client.tracking.sessionByDevice.outlierV1({
|
|
|
13995
14063
|
<dl>
|
|
13996
14064
|
<dd>
|
|
13997
14065
|
|
|
13998
|
-
**requestOptions:** `
|
|
14066
|
+
**requestOptions:** `CargoByDevice.RequestOptions`
|
|
13999
14067
|
|
|
14000
14068
|
</dd>
|
|
14001
14069
|
</dl>
|
|
@@ -14006,7 +14074,7 @@ await client.tracking.sessionByDevice.outlierV1({
|
|
|
14006
14074
|
</dl>
|
|
14007
14075
|
</details>
|
|
14008
14076
|
|
|
14009
|
-
<details><summary><code>client.tracking.
|
|
14077
|
+
<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>
|
|
14010
14078
|
<dl>
|
|
14011
14079
|
<dd>
|
|
14012
14080
|
|
|
@@ -14018,7 +14086,7 @@ await client.tracking.sessionByDevice.outlierV1({
|
|
|
14018
14086
|
<dl>
|
|
14019
14087
|
<dd>
|
|
14020
14088
|
|
|
14021
|
-
|
|
14089
|
+
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])
|
|
14022
14090
|
|
|
14023
14091
|
</dd>
|
|
14024
14092
|
</dl>
|
|
@@ -14034,8 +14102,10 @@ Deletes a terminated session and all its associated timeseries data points. Only
|
|
|
14034
14102
|
<dd>
|
|
14035
14103
|
|
|
14036
14104
|
```typescript
|
|
14037
|
-
await client.tracking.
|
|
14038
|
-
|
|
14105
|
+
await client.tracking.timeseries.cargoByDevice.dataPointsV1({
|
|
14106
|
+
cargo_id: "cargo_id",
|
|
14107
|
+
task_group_id: "task_group_id",
|
|
14108
|
+
limit: 1,
|
|
14039
14109
|
});
|
|
14040
14110
|
```
|
|
14041
14111
|
|
|
@@ -14052,7 +14122,7 @@ await client.tracking.sessionByDevice.deleteV1({
|
|
|
14052
14122
|
<dl>
|
|
14053
14123
|
<dd>
|
|
14054
14124
|
|
|
14055
|
-
**request:** `Chrt.tracking.
|
|
14125
|
+
**request:** `Chrt.tracking.timeseries.CargoByDeviceDataPointsV1Request`
|
|
14056
14126
|
|
|
14057
14127
|
</dd>
|
|
14058
14128
|
</dl>
|
|
@@ -14060,7 +14130,7 @@ await client.tracking.sessionByDevice.deleteV1({
|
|
|
14060
14130
|
<dl>
|
|
14061
14131
|
<dd>
|
|
14062
14132
|
|
|
14063
|
-
**requestOptions:** `
|
|
14133
|
+
**requestOptions:** `CargoByDevice.RequestOptions`
|
|
14064
14134
|
|
|
14065
14135
|
</dd>
|
|
14066
14136
|
</dl>
|
|
@@ -14071,7 +14141,7 @@ await client.tracking.sessionByDevice.deleteV1({
|
|
|
14071
14141
|
</dl>
|
|
14072
14142
|
</details>
|
|
14073
14143
|
|
|
14074
|
-
<details><summary><code>client.tracking.
|
|
14144
|
+
<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>
|
|
14075
14145
|
<dl>
|
|
14076
14146
|
<dd>
|
|
14077
14147
|
|
|
@@ -14083,7 +14153,7 @@ await client.tracking.sessionByDevice.deleteV1({
|
|
|
14083
14153
|
<dl>
|
|
14084
14154
|
<dd>
|
|
14085
14155
|
|
|
14086
|
-
|
|
14156
|
+
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)
|
|
14087
14157
|
|
|
14088
14158
|
</dd>
|
|
14089
14159
|
</dl>
|
|
@@ -14099,8 +14169,9 @@ Returns the most recent data point for a public session, excluding outliers. No
|
|
|
14099
14169
|
<dd>
|
|
14100
14170
|
|
|
14101
14171
|
```typescript
|
|
14102
|
-
await client.tracking.
|
|
14103
|
-
|
|
14172
|
+
await client.tracking.timeseries.cargoByDevice.outlierV1({
|
|
14173
|
+
tracking_cargo_by_device_data_point_ids: ["tracking_cargo_by_device_data_point_ids"],
|
|
14174
|
+
outlier: true,
|
|
14104
14175
|
});
|
|
14105
14176
|
```
|
|
14106
14177
|
|
|
@@ -14117,7 +14188,7 @@ await client.tracking.sessionByDevice.lastSeenPublicV1({
|
|
|
14117
14188
|
<dl>
|
|
14118
14189
|
<dd>
|
|
14119
14190
|
|
|
14120
|
-
**request:** `Chrt.tracking.
|
|
14191
|
+
**request:** `Chrt.tracking.timeseries.CargoByDeviceMarkOutliersRequest1`
|
|
14121
14192
|
|
|
14122
14193
|
</dd>
|
|
14123
14194
|
</dl>
|
|
@@ -14125,7 +14196,7 @@ await client.tracking.sessionByDevice.lastSeenPublicV1({
|
|
|
14125
14196
|
<dl>
|
|
14126
14197
|
<dd>
|
|
14127
14198
|
|
|
14128
|
-
**requestOptions:** `
|
|
14199
|
+
**requestOptions:** `CargoByDevice.RequestOptions`
|
|
14129
14200
|
|
|
14130
14201
|
</dd>
|
|
14131
14202
|
</dl>
|
|
@@ -14136,7 +14207,7 @@ await client.tracking.sessionByDevice.lastSeenPublicV1({
|
|
|
14136
14207
|
</dl>
|
|
14137
14208
|
</details>
|
|
14138
14209
|
|
|
14139
|
-
<details><summary><code>client.tracking.
|
|
14210
|
+
<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>
|
|
14140
14211
|
<dl>
|
|
14141
14212
|
<dd>
|
|
14142
14213
|
|
|
@@ -14148,7 +14219,7 @@ await client.tracking.sessionByDevice.lastSeenPublicV1({
|
|
|
14148
14219
|
<dl>
|
|
14149
14220
|
<dd>
|
|
14150
14221
|
|
|
14151
|
-
Returns
|
|
14222
|
+
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)
|
|
14152
14223
|
|
|
14153
14224
|
</dd>
|
|
14154
14225
|
</dl>
|
|
@@ -14164,9 +14235,9 @@ Returns up to the specified number of data points for a public session, intellig
|
|
|
14164
14235
|
<dd>
|
|
14165
14236
|
|
|
14166
14237
|
```typescript
|
|
14167
|
-
await client.tracking.
|
|
14168
|
-
|
|
14169
|
-
|
|
14238
|
+
await client.tracking.timeseries.cargoByDevice.lastSeenPublicV1({
|
|
14239
|
+
cargo_id: "cargo_id",
|
|
14240
|
+
task_group_id: "task_group_id",
|
|
14170
14241
|
});
|
|
14171
14242
|
```
|
|
14172
14243
|
|
|
@@ -14183,7 +14254,7 @@ await client.tracking.sessionByDevice.dataPointsPublicV1({
|
|
|
14183
14254
|
<dl>
|
|
14184
14255
|
<dd>
|
|
14185
14256
|
|
|
14186
|
-
**request:** `Chrt.tracking.
|
|
14257
|
+
**request:** `Chrt.tracking.timeseries.CargoByDeviceLastSeenPublicV1Request`
|
|
14187
14258
|
|
|
14188
14259
|
</dd>
|
|
14189
14260
|
</dl>
|
|
@@ -14191,7 +14262,7 @@ await client.tracking.sessionByDevice.dataPointsPublicV1({
|
|
|
14191
14262
|
<dl>
|
|
14192
14263
|
<dd>
|
|
14193
14264
|
|
|
14194
|
-
**requestOptions:** `
|
|
14265
|
+
**requestOptions:** `CargoByDevice.RequestOptions`
|
|
14195
14266
|
|
|
14196
14267
|
</dd>
|
|
14197
14268
|
</dl>
|
|
@@ -14202,9 +14273,7 @@ await client.tracking.sessionByDevice.dataPointsPublicV1({
|
|
|
14202
14273
|
</dl>
|
|
14203
14274
|
</details>
|
|
14204
14275
|
|
|
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>
|
|
14276
|
+
<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>
|
|
14208
14277
|
<dl>
|
|
14209
14278
|
<dd>
|
|
14210
14279
|
|
|
@@ -14216,7 +14285,7 @@ await client.tracking.sessionByDevice.dataPointsPublicV1({
|
|
|
14216
14285
|
<dl>
|
|
14217
14286
|
<dd>
|
|
14218
14287
|
|
|
14219
|
-
Returns the
|
|
14288
|
+
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])
|
|
14220
14289
|
|
|
14221
14290
|
</dd>
|
|
14222
14291
|
</dl>
|
|
@@ -14232,8 +14301,872 @@ Returns the most recent driver location data point for a task group. Access gran
|
|
|
14232
14301
|
<dd>
|
|
14233
14302
|
|
|
14234
14303
|
```typescript
|
|
14235
|
-
await client.tracking.
|
|
14304
|
+
await client.tracking.timeseries.cargoByDevice.dataPointsPublicV1({
|
|
14305
|
+
cargo_id: "cargo_id",
|
|
14236
14306
|
task_group_id: "task_group_id",
|
|
14307
|
+
limit: 1,
|
|
14308
|
+
});
|
|
14309
|
+
```
|
|
14310
|
+
|
|
14311
|
+
</dd>
|
|
14312
|
+
</dl>
|
|
14313
|
+
</dd>
|
|
14314
|
+
</dl>
|
|
14315
|
+
|
|
14316
|
+
#### ⚙️ Parameters
|
|
14317
|
+
|
|
14318
|
+
<dl>
|
|
14319
|
+
<dd>
|
|
14320
|
+
|
|
14321
|
+
<dl>
|
|
14322
|
+
<dd>
|
|
14323
|
+
|
|
14324
|
+
**request:** `Chrt.tracking.timeseries.CargoByDeviceDataPointsPublicV1Request`
|
|
14325
|
+
|
|
14326
|
+
</dd>
|
|
14327
|
+
</dl>
|
|
14328
|
+
|
|
14329
|
+
<dl>
|
|
14330
|
+
<dd>
|
|
14331
|
+
|
|
14332
|
+
**requestOptions:** `CargoByDevice.RequestOptions`
|
|
14333
|
+
|
|
14334
|
+
</dd>
|
|
14335
|
+
</dl>
|
|
14336
|
+
</dd>
|
|
14337
|
+
</dl>
|
|
14338
|
+
|
|
14339
|
+
</dd>
|
|
14340
|
+
</dl>
|
|
14341
|
+
</details>
|
|
14342
|
+
|
|
14343
|
+
## Tracking Timeseries CargoByDriver
|
|
14344
|
+
|
|
14345
|
+
<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>
|
|
14346
|
+
<dl>
|
|
14347
|
+
<dd>
|
|
14348
|
+
|
|
14349
|
+
#### 📝 Description
|
|
14350
|
+
|
|
14351
|
+
<dl>
|
|
14352
|
+
<dd>
|
|
14353
|
+
|
|
14354
|
+
<dl>
|
|
14355
|
+
<dd>
|
|
14356
|
+
|
|
14357
|
+
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)
|
|
14358
|
+
|
|
14359
|
+
</dd>
|
|
14360
|
+
</dl>
|
|
14361
|
+
</dd>
|
|
14362
|
+
</dl>
|
|
14363
|
+
|
|
14364
|
+
#### 🔌 Usage
|
|
14365
|
+
|
|
14366
|
+
<dl>
|
|
14367
|
+
<dd>
|
|
14368
|
+
|
|
14369
|
+
<dl>
|
|
14370
|
+
<dd>
|
|
14371
|
+
|
|
14372
|
+
```typescript
|
|
14373
|
+
await client.tracking.timeseries.cargoByDriver.lastSeenV1({
|
|
14374
|
+
cargo_id: "cargo_id",
|
|
14375
|
+
task_group_id: "task_group_id",
|
|
14376
|
+
});
|
|
14377
|
+
```
|
|
14378
|
+
|
|
14379
|
+
</dd>
|
|
14380
|
+
</dl>
|
|
14381
|
+
</dd>
|
|
14382
|
+
</dl>
|
|
14383
|
+
|
|
14384
|
+
#### ⚙️ Parameters
|
|
14385
|
+
|
|
14386
|
+
<dl>
|
|
14387
|
+
<dd>
|
|
14388
|
+
|
|
14389
|
+
<dl>
|
|
14390
|
+
<dd>
|
|
14391
|
+
|
|
14392
|
+
**request:** `Chrt.tracking.timeseries.CargoByDriverLastSeenV1Request`
|
|
14393
|
+
|
|
14394
|
+
</dd>
|
|
14395
|
+
</dl>
|
|
14396
|
+
|
|
14397
|
+
<dl>
|
|
14398
|
+
<dd>
|
|
14399
|
+
|
|
14400
|
+
**requestOptions:** `CargoByDriver.RequestOptions`
|
|
14401
|
+
|
|
14402
|
+
</dd>
|
|
14403
|
+
</dl>
|
|
14404
|
+
</dd>
|
|
14405
|
+
</dl>
|
|
14406
|
+
|
|
14407
|
+
</dd>
|
|
14408
|
+
</dl>
|
|
14409
|
+
</details>
|
|
14410
|
+
|
|
14411
|
+
<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>
|
|
14412
|
+
<dl>
|
|
14413
|
+
<dd>
|
|
14414
|
+
|
|
14415
|
+
#### 📝 Description
|
|
14416
|
+
|
|
14417
|
+
<dl>
|
|
14418
|
+
<dd>
|
|
14419
|
+
|
|
14420
|
+
<dl>
|
|
14421
|
+
<dd>
|
|
14422
|
+
|
|
14423
|
+
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])
|
|
14424
|
+
|
|
14425
|
+
</dd>
|
|
14426
|
+
</dl>
|
|
14427
|
+
</dd>
|
|
14428
|
+
</dl>
|
|
14429
|
+
|
|
14430
|
+
#### 🔌 Usage
|
|
14431
|
+
|
|
14432
|
+
<dl>
|
|
14433
|
+
<dd>
|
|
14434
|
+
|
|
14435
|
+
<dl>
|
|
14436
|
+
<dd>
|
|
14437
|
+
|
|
14438
|
+
```typescript
|
|
14439
|
+
await client.tracking.timeseries.cargoByDriver.dataPointsV1({
|
|
14440
|
+
cargo_id: "cargo_id",
|
|
14441
|
+
task_group_id: "task_group_id",
|
|
14442
|
+
limit: 1,
|
|
14443
|
+
});
|
|
14444
|
+
```
|
|
14445
|
+
|
|
14446
|
+
</dd>
|
|
14447
|
+
</dl>
|
|
14448
|
+
</dd>
|
|
14449
|
+
</dl>
|
|
14450
|
+
|
|
14451
|
+
#### ⚙️ Parameters
|
|
14452
|
+
|
|
14453
|
+
<dl>
|
|
14454
|
+
<dd>
|
|
14455
|
+
|
|
14456
|
+
<dl>
|
|
14457
|
+
<dd>
|
|
14458
|
+
|
|
14459
|
+
**request:** `Chrt.tracking.timeseries.CargoByDriverDataPointsV1Request`
|
|
14460
|
+
|
|
14461
|
+
</dd>
|
|
14462
|
+
</dl>
|
|
14463
|
+
|
|
14464
|
+
<dl>
|
|
14465
|
+
<dd>
|
|
14466
|
+
|
|
14467
|
+
**requestOptions:** `CargoByDriver.RequestOptions`
|
|
14468
|
+
|
|
14469
|
+
</dd>
|
|
14470
|
+
</dl>
|
|
14471
|
+
</dd>
|
|
14472
|
+
</dl>
|
|
14473
|
+
|
|
14474
|
+
</dd>
|
|
14475
|
+
</dl>
|
|
14476
|
+
</details>
|
|
14477
|
+
|
|
14478
|
+
<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>
|
|
14479
|
+
<dl>
|
|
14480
|
+
<dd>
|
|
14481
|
+
|
|
14482
|
+
#### 📝 Description
|
|
14483
|
+
|
|
14484
|
+
<dl>
|
|
14485
|
+
<dd>
|
|
14486
|
+
|
|
14487
|
+
<dl>
|
|
14488
|
+
<dd>
|
|
14489
|
+
|
|
14490
|
+
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)
|
|
14491
|
+
|
|
14492
|
+
</dd>
|
|
14493
|
+
</dl>
|
|
14494
|
+
</dd>
|
|
14495
|
+
</dl>
|
|
14496
|
+
|
|
14497
|
+
#### 🔌 Usage
|
|
14498
|
+
|
|
14499
|
+
<dl>
|
|
14500
|
+
<dd>
|
|
14501
|
+
|
|
14502
|
+
<dl>
|
|
14503
|
+
<dd>
|
|
14504
|
+
|
|
14505
|
+
```typescript
|
|
14506
|
+
await client.tracking.timeseries.cargoByDriver.lastSeenPublicV1({
|
|
14507
|
+
cargo_id: "cargo_id",
|
|
14508
|
+
task_group_id: "task_group_id",
|
|
14509
|
+
});
|
|
14510
|
+
```
|
|
14511
|
+
|
|
14512
|
+
</dd>
|
|
14513
|
+
</dl>
|
|
14514
|
+
</dd>
|
|
14515
|
+
</dl>
|
|
14516
|
+
|
|
14517
|
+
#### ⚙️ Parameters
|
|
14518
|
+
|
|
14519
|
+
<dl>
|
|
14520
|
+
<dd>
|
|
14521
|
+
|
|
14522
|
+
<dl>
|
|
14523
|
+
<dd>
|
|
14524
|
+
|
|
14525
|
+
**request:** `Chrt.tracking.timeseries.CargoByDriverLastSeenPublicV1Request`
|
|
14526
|
+
|
|
14527
|
+
</dd>
|
|
14528
|
+
</dl>
|
|
14529
|
+
|
|
14530
|
+
<dl>
|
|
14531
|
+
<dd>
|
|
14532
|
+
|
|
14533
|
+
**requestOptions:** `CargoByDriver.RequestOptions`
|
|
14534
|
+
|
|
14535
|
+
</dd>
|
|
14536
|
+
</dl>
|
|
14537
|
+
</dd>
|
|
14538
|
+
</dl>
|
|
14539
|
+
|
|
14540
|
+
</dd>
|
|
14541
|
+
</dl>
|
|
14542
|
+
</details>
|
|
14543
|
+
|
|
14544
|
+
<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>
|
|
14545
|
+
<dl>
|
|
14546
|
+
<dd>
|
|
14547
|
+
|
|
14548
|
+
#### 📝 Description
|
|
14549
|
+
|
|
14550
|
+
<dl>
|
|
14551
|
+
<dd>
|
|
14552
|
+
|
|
14553
|
+
<dl>
|
|
14554
|
+
<dd>
|
|
14555
|
+
|
|
14556
|
+
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])
|
|
14557
|
+
|
|
14558
|
+
</dd>
|
|
14559
|
+
</dl>
|
|
14560
|
+
</dd>
|
|
14561
|
+
</dl>
|
|
14562
|
+
|
|
14563
|
+
#### 🔌 Usage
|
|
14564
|
+
|
|
14565
|
+
<dl>
|
|
14566
|
+
<dd>
|
|
14567
|
+
|
|
14568
|
+
<dl>
|
|
14569
|
+
<dd>
|
|
14570
|
+
|
|
14571
|
+
```typescript
|
|
14572
|
+
await client.tracking.timeseries.cargoByDriver.dataPointsPublicV1({
|
|
14573
|
+
cargo_id: "cargo_id",
|
|
14574
|
+
task_group_id: "task_group_id",
|
|
14575
|
+
limit: 1,
|
|
14576
|
+
});
|
|
14577
|
+
```
|
|
14578
|
+
|
|
14579
|
+
</dd>
|
|
14580
|
+
</dl>
|
|
14581
|
+
</dd>
|
|
14582
|
+
</dl>
|
|
14583
|
+
|
|
14584
|
+
#### ⚙️ Parameters
|
|
14585
|
+
|
|
14586
|
+
<dl>
|
|
14587
|
+
<dd>
|
|
14588
|
+
|
|
14589
|
+
<dl>
|
|
14590
|
+
<dd>
|
|
14591
|
+
|
|
14592
|
+
**request:** `Chrt.tracking.timeseries.CargoByDriverDataPointsPublicV1Request`
|
|
14593
|
+
|
|
14594
|
+
</dd>
|
|
14595
|
+
</dl>
|
|
14596
|
+
|
|
14597
|
+
<dl>
|
|
14598
|
+
<dd>
|
|
14599
|
+
|
|
14600
|
+
**requestOptions:** `CargoByDriver.RequestOptions`
|
|
14601
|
+
|
|
14602
|
+
</dd>
|
|
14603
|
+
</dl>
|
|
14604
|
+
</dd>
|
|
14605
|
+
</dl>
|
|
14606
|
+
|
|
14607
|
+
</dd>
|
|
14608
|
+
</dl>
|
|
14609
|
+
</details>
|
|
14610
|
+
|
|
14611
|
+
## Tracking Timeseries SessionByDevice
|
|
14612
|
+
|
|
14613
|
+
<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>
|
|
14614
|
+
<dl>
|
|
14615
|
+
<dd>
|
|
14616
|
+
|
|
14617
|
+
#### 📝 Description
|
|
14618
|
+
|
|
14619
|
+
<dl>
|
|
14620
|
+
<dd>
|
|
14621
|
+
|
|
14622
|
+
<dl>
|
|
14623
|
+
<dd>
|
|
14624
|
+
|
|
14625
|
+
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)
|
|
14626
|
+
|
|
14627
|
+
</dd>
|
|
14628
|
+
</dl>
|
|
14629
|
+
</dd>
|
|
14630
|
+
</dl>
|
|
14631
|
+
|
|
14632
|
+
#### 🔌 Usage
|
|
14633
|
+
|
|
14634
|
+
<dl>
|
|
14635
|
+
<dd>
|
|
14636
|
+
|
|
14637
|
+
<dl>
|
|
14638
|
+
<dd>
|
|
14639
|
+
|
|
14640
|
+
```typescript
|
|
14641
|
+
await client.tracking.timeseries.sessionByDevice.lastSeenV1({
|
|
14642
|
+
session_id: "session_id",
|
|
14643
|
+
});
|
|
14644
|
+
```
|
|
14645
|
+
|
|
14646
|
+
</dd>
|
|
14647
|
+
</dl>
|
|
14648
|
+
</dd>
|
|
14649
|
+
</dl>
|
|
14650
|
+
|
|
14651
|
+
#### ⚙️ Parameters
|
|
14652
|
+
|
|
14653
|
+
<dl>
|
|
14654
|
+
<dd>
|
|
14655
|
+
|
|
14656
|
+
<dl>
|
|
14657
|
+
<dd>
|
|
14658
|
+
|
|
14659
|
+
**request:** `Chrt.tracking.timeseries.SessionByDeviceLastSeenV1Request`
|
|
14660
|
+
|
|
14661
|
+
</dd>
|
|
14662
|
+
</dl>
|
|
14663
|
+
|
|
14664
|
+
<dl>
|
|
14665
|
+
<dd>
|
|
14666
|
+
|
|
14667
|
+
**requestOptions:** `SessionByDevice.RequestOptions`
|
|
14668
|
+
|
|
14669
|
+
</dd>
|
|
14670
|
+
</dl>
|
|
14671
|
+
</dd>
|
|
14672
|
+
</dl>
|
|
14673
|
+
|
|
14674
|
+
</dd>
|
|
14675
|
+
</dl>
|
|
14676
|
+
</details>
|
|
14677
|
+
|
|
14678
|
+
<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>
|
|
14679
|
+
<dl>
|
|
14680
|
+
<dd>
|
|
14681
|
+
|
|
14682
|
+
#### 📝 Description
|
|
14683
|
+
|
|
14684
|
+
<dl>
|
|
14685
|
+
<dd>
|
|
14686
|
+
|
|
14687
|
+
<dl>
|
|
14688
|
+
<dd>
|
|
14689
|
+
|
|
14690
|
+
Returns up to the specified number of data points for a session, intelligently sampled across the time range. Excludes outliers. | () -> (list[SessionByDeviceDataPoint1])
|
|
14691
|
+
|
|
14692
|
+
</dd>
|
|
14693
|
+
</dl>
|
|
14694
|
+
</dd>
|
|
14695
|
+
</dl>
|
|
14696
|
+
|
|
14697
|
+
#### 🔌 Usage
|
|
14698
|
+
|
|
14699
|
+
<dl>
|
|
14700
|
+
<dd>
|
|
14701
|
+
|
|
14702
|
+
<dl>
|
|
14703
|
+
<dd>
|
|
14704
|
+
|
|
14705
|
+
```typescript
|
|
14706
|
+
await client.tracking.timeseries.sessionByDevice.dataPointsV1({
|
|
14707
|
+
session_id: "session_id",
|
|
14708
|
+
limit: 1,
|
|
14709
|
+
});
|
|
14710
|
+
```
|
|
14711
|
+
|
|
14712
|
+
</dd>
|
|
14713
|
+
</dl>
|
|
14714
|
+
</dd>
|
|
14715
|
+
</dl>
|
|
14716
|
+
|
|
14717
|
+
#### ⚙️ Parameters
|
|
14718
|
+
|
|
14719
|
+
<dl>
|
|
14720
|
+
<dd>
|
|
14721
|
+
|
|
14722
|
+
<dl>
|
|
14723
|
+
<dd>
|
|
14724
|
+
|
|
14725
|
+
**request:** `Chrt.tracking.timeseries.SessionByDeviceDataPointsV1Request`
|
|
14726
|
+
|
|
14727
|
+
</dd>
|
|
14728
|
+
</dl>
|
|
14729
|
+
|
|
14730
|
+
<dl>
|
|
14731
|
+
<dd>
|
|
14732
|
+
|
|
14733
|
+
**requestOptions:** `SessionByDevice.RequestOptions`
|
|
14734
|
+
|
|
14735
|
+
</dd>
|
|
14736
|
+
</dl>
|
|
14737
|
+
</dd>
|
|
14738
|
+
</dl>
|
|
14739
|
+
|
|
14740
|
+
</dd>
|
|
14741
|
+
</dl>
|
|
14742
|
+
</details>
|
|
14743
|
+
|
|
14744
|
+
<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>
|
|
14745
|
+
<dl>
|
|
14746
|
+
<dd>
|
|
14747
|
+
|
|
14748
|
+
#### 📝 Description
|
|
14749
|
+
|
|
14750
|
+
<dl>
|
|
14751
|
+
<dd>
|
|
14752
|
+
|
|
14753
|
+
<dl>
|
|
14754
|
+
<dd>
|
|
14755
|
+
|
|
14756
|
+
Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | (SessionByDeviceMarkOutliersRequest1) -> (SessionByDeviceMarkOutliersResponse1)
|
|
14757
|
+
|
|
14758
|
+
</dd>
|
|
14759
|
+
</dl>
|
|
14760
|
+
</dd>
|
|
14761
|
+
</dl>
|
|
14762
|
+
|
|
14763
|
+
#### 🔌 Usage
|
|
14764
|
+
|
|
14765
|
+
<dl>
|
|
14766
|
+
<dd>
|
|
14767
|
+
|
|
14768
|
+
<dl>
|
|
14769
|
+
<dd>
|
|
14770
|
+
|
|
14771
|
+
```typescript
|
|
14772
|
+
await client.tracking.timeseries.sessionByDevice.outlierV1({
|
|
14773
|
+
tracking_session_by_device_data_point_ids: ["tracking_session_by_device_data_point_ids"],
|
|
14774
|
+
outlier: true,
|
|
14775
|
+
});
|
|
14776
|
+
```
|
|
14777
|
+
|
|
14778
|
+
</dd>
|
|
14779
|
+
</dl>
|
|
14780
|
+
</dd>
|
|
14781
|
+
</dl>
|
|
14782
|
+
|
|
14783
|
+
#### ⚙️ Parameters
|
|
14784
|
+
|
|
14785
|
+
<dl>
|
|
14786
|
+
<dd>
|
|
14787
|
+
|
|
14788
|
+
<dl>
|
|
14789
|
+
<dd>
|
|
14790
|
+
|
|
14791
|
+
**request:** `Chrt.tracking.timeseries.SessionByDeviceMarkOutliersRequest1`
|
|
14792
|
+
|
|
14793
|
+
</dd>
|
|
14794
|
+
</dl>
|
|
14795
|
+
|
|
14796
|
+
<dl>
|
|
14797
|
+
<dd>
|
|
14798
|
+
|
|
14799
|
+
**requestOptions:** `SessionByDevice.RequestOptions`
|
|
14800
|
+
|
|
14801
|
+
</dd>
|
|
14802
|
+
</dl>
|
|
14803
|
+
</dd>
|
|
14804
|
+
</dl>
|
|
14805
|
+
|
|
14806
|
+
</dd>
|
|
14807
|
+
</dl>
|
|
14808
|
+
</details>
|
|
14809
|
+
|
|
14810
|
+
<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>
|
|
14811
|
+
<dl>
|
|
14812
|
+
<dd>
|
|
14813
|
+
|
|
14814
|
+
#### 📝 Description
|
|
14815
|
+
|
|
14816
|
+
<dl>
|
|
14817
|
+
<dd>
|
|
14818
|
+
|
|
14819
|
+
<dl>
|
|
14820
|
+
<dd>
|
|
14821
|
+
|
|
14822
|
+
Returns the most recent data point for a public session, excluding outliers. No authentication required if session has public visibility enabled. | () -> (SessionByDeviceDataPoint1 | None)
|
|
14823
|
+
|
|
14824
|
+
</dd>
|
|
14825
|
+
</dl>
|
|
14826
|
+
</dd>
|
|
14827
|
+
</dl>
|
|
14828
|
+
|
|
14829
|
+
#### 🔌 Usage
|
|
14830
|
+
|
|
14831
|
+
<dl>
|
|
14832
|
+
<dd>
|
|
14833
|
+
|
|
14834
|
+
<dl>
|
|
14835
|
+
<dd>
|
|
14836
|
+
|
|
14837
|
+
```typescript
|
|
14838
|
+
await client.tracking.timeseries.sessionByDevice.lastSeenPublicV1({
|
|
14839
|
+
session_id: "session_id",
|
|
14840
|
+
});
|
|
14841
|
+
```
|
|
14842
|
+
|
|
14843
|
+
</dd>
|
|
14844
|
+
</dl>
|
|
14845
|
+
</dd>
|
|
14846
|
+
</dl>
|
|
14847
|
+
|
|
14848
|
+
#### ⚙️ Parameters
|
|
14849
|
+
|
|
14850
|
+
<dl>
|
|
14851
|
+
<dd>
|
|
14852
|
+
|
|
14853
|
+
<dl>
|
|
14854
|
+
<dd>
|
|
14855
|
+
|
|
14856
|
+
**request:** `Chrt.tracking.timeseries.SessionByDeviceLastSeenPublicV1Request`
|
|
14857
|
+
|
|
14858
|
+
</dd>
|
|
14859
|
+
</dl>
|
|
14860
|
+
|
|
14861
|
+
<dl>
|
|
14862
|
+
<dd>
|
|
14863
|
+
|
|
14864
|
+
**requestOptions:** `SessionByDevice.RequestOptions`
|
|
14865
|
+
|
|
14866
|
+
</dd>
|
|
14867
|
+
</dl>
|
|
14868
|
+
</dd>
|
|
14869
|
+
</dl>
|
|
14870
|
+
|
|
14871
|
+
</dd>
|
|
14872
|
+
</dl>
|
|
14873
|
+
</details>
|
|
14874
|
+
|
|
14875
|
+
<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>
|
|
14876
|
+
<dl>
|
|
14877
|
+
<dd>
|
|
14878
|
+
|
|
14879
|
+
#### 📝 Description
|
|
14880
|
+
|
|
14881
|
+
<dl>
|
|
14882
|
+
<dd>
|
|
14883
|
+
|
|
14884
|
+
<dl>
|
|
14885
|
+
<dd>
|
|
14886
|
+
|
|
14887
|
+
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])
|
|
14888
|
+
|
|
14889
|
+
</dd>
|
|
14890
|
+
</dl>
|
|
14891
|
+
</dd>
|
|
14892
|
+
</dl>
|
|
14893
|
+
|
|
14894
|
+
#### 🔌 Usage
|
|
14895
|
+
|
|
14896
|
+
<dl>
|
|
14897
|
+
<dd>
|
|
14898
|
+
|
|
14899
|
+
<dl>
|
|
14900
|
+
<dd>
|
|
14901
|
+
|
|
14902
|
+
```typescript
|
|
14903
|
+
await client.tracking.timeseries.sessionByDevice.dataPointsPublicV1({
|
|
14904
|
+
session_id: "session_id",
|
|
14905
|
+
limit: 1,
|
|
14906
|
+
});
|
|
14907
|
+
```
|
|
14908
|
+
|
|
14909
|
+
</dd>
|
|
14910
|
+
</dl>
|
|
14911
|
+
</dd>
|
|
14912
|
+
</dl>
|
|
14913
|
+
|
|
14914
|
+
#### ⚙️ Parameters
|
|
14915
|
+
|
|
14916
|
+
<dl>
|
|
14917
|
+
<dd>
|
|
14918
|
+
|
|
14919
|
+
<dl>
|
|
14920
|
+
<dd>
|
|
14921
|
+
|
|
14922
|
+
**request:** `Chrt.tracking.timeseries.SessionByDeviceDataPointsPublicV1Request`
|
|
14923
|
+
|
|
14924
|
+
</dd>
|
|
14925
|
+
</dl>
|
|
14926
|
+
|
|
14927
|
+
<dl>
|
|
14928
|
+
<dd>
|
|
14929
|
+
|
|
14930
|
+
**requestOptions:** `SessionByDevice.RequestOptions`
|
|
14931
|
+
|
|
14932
|
+
</dd>
|
|
14933
|
+
</dl>
|
|
14934
|
+
</dd>
|
|
14935
|
+
</dl>
|
|
14936
|
+
|
|
14937
|
+
</dd>
|
|
14938
|
+
</dl>
|
|
14939
|
+
</details>
|
|
14940
|
+
|
|
14941
|
+
## Tracking Timeseries TaskGroupByDriver
|
|
14942
|
+
|
|
14943
|
+
<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>
|
|
14944
|
+
<dl>
|
|
14945
|
+
<dd>
|
|
14946
|
+
|
|
14947
|
+
#### 📝 Description
|
|
14948
|
+
|
|
14949
|
+
<dl>
|
|
14950
|
+
<dd>
|
|
14951
|
+
|
|
14952
|
+
<dl>
|
|
14953
|
+
<dd>
|
|
14954
|
+
|
|
14955
|
+
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)
|
|
14956
|
+
|
|
14957
|
+
</dd>
|
|
14958
|
+
</dl>
|
|
14959
|
+
</dd>
|
|
14960
|
+
</dl>
|
|
14961
|
+
|
|
14962
|
+
#### 🔌 Usage
|
|
14963
|
+
|
|
14964
|
+
<dl>
|
|
14965
|
+
<dd>
|
|
14966
|
+
|
|
14967
|
+
<dl>
|
|
14968
|
+
<dd>
|
|
14969
|
+
|
|
14970
|
+
```typescript
|
|
14971
|
+
await client.tracking.timeseries.taskGroupByDriver.lastSeenV1({
|
|
14972
|
+
task_group_id: "task_group_id",
|
|
14973
|
+
});
|
|
14974
|
+
```
|
|
14975
|
+
|
|
14976
|
+
</dd>
|
|
14977
|
+
</dl>
|
|
14978
|
+
</dd>
|
|
14979
|
+
</dl>
|
|
14980
|
+
|
|
14981
|
+
#### ⚙️ Parameters
|
|
14982
|
+
|
|
14983
|
+
<dl>
|
|
14984
|
+
<dd>
|
|
14985
|
+
|
|
14986
|
+
<dl>
|
|
14987
|
+
<dd>
|
|
14988
|
+
|
|
14989
|
+
**request:** `Chrt.tracking.timeseries.TaskGroupByDriverLastSeenV1Request`
|
|
14990
|
+
|
|
14991
|
+
</dd>
|
|
14992
|
+
</dl>
|
|
14993
|
+
|
|
14994
|
+
<dl>
|
|
14995
|
+
<dd>
|
|
14996
|
+
|
|
14997
|
+
**requestOptions:** `TaskGroupByDriver.RequestOptions`
|
|
14998
|
+
|
|
14999
|
+
</dd>
|
|
15000
|
+
</dl>
|
|
15001
|
+
</dd>
|
|
15002
|
+
</dl>
|
|
15003
|
+
|
|
15004
|
+
</dd>
|
|
15005
|
+
</dl>
|
|
15006
|
+
</details>
|
|
15007
|
+
|
|
15008
|
+
<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>
|
|
15009
|
+
<dl>
|
|
15010
|
+
<dd>
|
|
15011
|
+
|
|
15012
|
+
#### 📝 Description
|
|
15013
|
+
|
|
15014
|
+
<dl>
|
|
15015
|
+
<dd>
|
|
15016
|
+
|
|
15017
|
+
<dl>
|
|
15018
|
+
<dd>
|
|
15019
|
+
|
|
15020
|
+
Returns up to the specified number of data points for a task group, intelligently sampled across the time range. Excludes outliers. | () -> (list[TaskGroupByDriverDataPoint1])
|
|
15021
|
+
|
|
15022
|
+
</dd>
|
|
15023
|
+
</dl>
|
|
15024
|
+
</dd>
|
|
15025
|
+
</dl>
|
|
15026
|
+
|
|
15027
|
+
#### 🔌 Usage
|
|
15028
|
+
|
|
15029
|
+
<dl>
|
|
15030
|
+
<dd>
|
|
15031
|
+
|
|
15032
|
+
<dl>
|
|
15033
|
+
<dd>
|
|
15034
|
+
|
|
15035
|
+
```typescript
|
|
15036
|
+
await client.tracking.timeseries.taskGroupByDriver.dataPointsV1({
|
|
15037
|
+
task_group_id: "task_group_id",
|
|
15038
|
+
limit: 1,
|
|
15039
|
+
});
|
|
15040
|
+
```
|
|
15041
|
+
|
|
15042
|
+
</dd>
|
|
15043
|
+
</dl>
|
|
15044
|
+
</dd>
|
|
15045
|
+
</dl>
|
|
15046
|
+
|
|
15047
|
+
#### ⚙️ Parameters
|
|
15048
|
+
|
|
15049
|
+
<dl>
|
|
15050
|
+
<dd>
|
|
15051
|
+
|
|
15052
|
+
<dl>
|
|
15053
|
+
<dd>
|
|
15054
|
+
|
|
15055
|
+
**request:** `Chrt.tracking.timeseries.TaskGroupByDriverDataPointsV1Request`
|
|
15056
|
+
|
|
15057
|
+
</dd>
|
|
15058
|
+
</dl>
|
|
15059
|
+
|
|
15060
|
+
<dl>
|
|
15061
|
+
<dd>
|
|
15062
|
+
|
|
15063
|
+
**requestOptions:** `TaskGroupByDriver.RequestOptions`
|
|
15064
|
+
|
|
15065
|
+
</dd>
|
|
15066
|
+
</dl>
|
|
15067
|
+
</dd>
|
|
15068
|
+
</dl>
|
|
15069
|
+
|
|
15070
|
+
</dd>
|
|
15071
|
+
</dl>
|
|
15072
|
+
</details>
|
|
15073
|
+
|
|
15074
|
+
<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>
|
|
15075
|
+
<dl>
|
|
15076
|
+
<dd>
|
|
15077
|
+
|
|
15078
|
+
#### 📝 Description
|
|
15079
|
+
|
|
15080
|
+
<dl>
|
|
15081
|
+
<dd>
|
|
15082
|
+
|
|
15083
|
+
<dl>
|
|
15084
|
+
<dd>
|
|
15085
|
+
|
|
15086
|
+
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)
|
|
15087
|
+
|
|
15088
|
+
</dd>
|
|
15089
|
+
</dl>
|
|
15090
|
+
</dd>
|
|
15091
|
+
</dl>
|
|
15092
|
+
|
|
15093
|
+
#### 🔌 Usage
|
|
15094
|
+
|
|
15095
|
+
<dl>
|
|
15096
|
+
<dd>
|
|
15097
|
+
|
|
15098
|
+
<dl>
|
|
15099
|
+
<dd>
|
|
15100
|
+
|
|
15101
|
+
```typescript
|
|
15102
|
+
await client.tracking.timeseries.taskGroupByDriver.lastSeenPublicV1({
|
|
15103
|
+
task_group_id: "task_group_id",
|
|
15104
|
+
});
|
|
15105
|
+
```
|
|
15106
|
+
|
|
15107
|
+
</dd>
|
|
15108
|
+
</dl>
|
|
15109
|
+
</dd>
|
|
15110
|
+
</dl>
|
|
15111
|
+
|
|
15112
|
+
#### ⚙️ Parameters
|
|
15113
|
+
|
|
15114
|
+
<dl>
|
|
15115
|
+
<dd>
|
|
15116
|
+
|
|
15117
|
+
<dl>
|
|
15118
|
+
<dd>
|
|
15119
|
+
|
|
15120
|
+
**request:** `Chrt.tracking.timeseries.TaskGroupByDriverLastSeenPublicV1Request`
|
|
15121
|
+
|
|
15122
|
+
</dd>
|
|
15123
|
+
</dl>
|
|
15124
|
+
|
|
15125
|
+
<dl>
|
|
15126
|
+
<dd>
|
|
15127
|
+
|
|
15128
|
+
**requestOptions:** `TaskGroupByDriver.RequestOptions`
|
|
15129
|
+
|
|
15130
|
+
</dd>
|
|
15131
|
+
</dl>
|
|
15132
|
+
</dd>
|
|
15133
|
+
</dl>
|
|
15134
|
+
|
|
15135
|
+
</dd>
|
|
15136
|
+
</dl>
|
|
15137
|
+
</details>
|
|
15138
|
+
|
|
15139
|
+
<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>
|
|
15140
|
+
<dl>
|
|
15141
|
+
<dd>
|
|
15142
|
+
|
|
15143
|
+
#### 📝 Description
|
|
15144
|
+
|
|
15145
|
+
<dl>
|
|
15146
|
+
<dd>
|
|
15147
|
+
|
|
15148
|
+
<dl>
|
|
15149
|
+
<dd>
|
|
15150
|
+
|
|
15151
|
+
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])
|
|
15152
|
+
|
|
15153
|
+
</dd>
|
|
15154
|
+
</dl>
|
|
15155
|
+
</dd>
|
|
15156
|
+
</dl>
|
|
15157
|
+
|
|
15158
|
+
#### 🔌 Usage
|
|
15159
|
+
|
|
15160
|
+
<dl>
|
|
15161
|
+
<dd>
|
|
15162
|
+
|
|
15163
|
+
<dl>
|
|
15164
|
+
<dd>
|
|
15165
|
+
|
|
15166
|
+
```typescript
|
|
15167
|
+
await client.tracking.timeseries.taskGroupByDriver.dataPointsPublicV1({
|
|
15168
|
+
task_group_id: "task_group_id",
|
|
15169
|
+
limit: 1,
|
|
14237
15170
|
});
|
|
14238
15171
|
```
|
|
14239
15172
|
|
|
@@ -14250,7 +15183,7 @@ await client.tracking.taskGroupByDriver.lastSeenV1({
|
|
|
14250
15183
|
<dl>
|
|
14251
15184
|
<dd>
|
|
14252
15185
|
|
|
14253
|
-
**request:** `Chrt.tracking.
|
|
15186
|
+
**request:** `Chrt.tracking.timeseries.TaskGroupByDriverDataPointsPublicV1Request`
|
|
14254
15187
|
|
|
14255
15188
|
</dd>
|
|
14256
15189
|
</dl>
|