@samsarahq/samsara 5.11.0 → 6.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/betaApIs/client/Client.d.ts +31 -1
- package/dist/cjs/api/resources/betaApIs/client/Client.js +91 -1
- package/dist/cjs/api/resources/betaApIs/client/requests/GetDetectionsRequest.d.ts +1 -1
- package/dist/cjs/api/resources/betaApIs/client/requests/GetReadingsHistoryRequest.d.ts +16 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/GetReadingsSnapshotRequest.d.ts +16 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/ListRidershipRouteSetupsRequest.d.ts +14 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/driverVehicleAssignments/client/requests/GetDriverVehicleAssignmentsRequest.d.ts +1 -1
- package/dist/cjs/api/resources/driverVehicleAssignments/types/GetDriverVehicleAssignmentsRequestAssignmentType.d.ts +1 -0
- package/dist/cjs/api/resources/driverVehicleAssignments/types/GetDriverVehicleAssignmentsRequestAssignmentType.js +1 -0
- package/dist/cjs/api/resources/index.d.ts +0 -1
- package/dist/cjs/api/resources/index.js +0 -1
- package/dist/cjs/api/resources/previewApIs/client/Client.d.ts +5 -41
- package/dist/cjs/api/resources/previewApIs/client/Client.js +9 -101
- package/dist/cjs/api/resources/previewApIs/client/requests/ListDeviceRecoveryMissingAssetsRequest.d.ts +8 -0
- package/dist/cjs/api/resources/previewApIs/client/requests/index.d.ts +1 -2
- package/dist/cjs/api/resources/previewApIs/index.d.ts +0 -1
- package/dist/cjs/api/resources/previewApIs/index.js +0 -1
- package/dist/cjs/api/types/DetectionLogDetectionObjectResponseBody.d.ts +3 -2
- package/dist/cjs/api/types/DetectionLogDetectionObjectResponseBody.js +2 -1
- package/dist/{esm/api/types/DeviceRecoveryGetAssetRecoveryStateBadGatewayErrorResponseBody.d.mts → cjs/api/types/DeviceRecoveryListDeviceRecoveryMissingAssetsBadGatewayErrorResponseBody.d.ts} +1 -1
- package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateGatewayTimeoutErrorResponseBody.d.ts → DeviceRecoveryListDeviceRecoveryMissingAssetsGatewayTimeoutErrorResponseBody.d.ts} +1 -1
- package/dist/{esm/api/types/DeviceRecoveryListDeviceRecoveryAssetsInternalServerErrorResponseBody.d.mts → cjs/api/types/DeviceRecoveryListDeviceRecoveryMissingAssetsInternalServerErrorResponseBody.d.ts} +1 -1
- package/dist/{esm/api/types/DeviceRecoveryGetAssetRecoveryStateMethodNotAllowedErrorResponseBody.d.mts → cjs/api/types/DeviceRecoveryListDeviceRecoveryMissingAssetsMethodNotAllowedErrorResponseBody.d.ts} +1 -1
- package/dist/{esm/api/types/DeviceRecoveryListDeviceRecoveryAssetsNotFoundErrorResponseBody.d.mts → cjs/api/types/DeviceRecoveryListDeviceRecoveryMissingAssetsNotFoundErrorResponseBody.d.ts} +1 -1
- package/dist/{esm/api/types/DeviceRecoveryGetAssetRecoveryStateNotImplementedErrorResponseBody.d.mts → cjs/api/types/DeviceRecoveryListDeviceRecoveryMissingAssetsNotImplementedErrorResponseBody.d.ts} +1 -1
- package/dist/cjs/api/types/DeviceRecoveryListDeviceRecoveryMissingAssetsResponseBody.d.ts +6 -0
- package/dist/{esm/api/types/DeviceRecoveryGetAssetRecoveryStateServiceUnavailableErrorResponseBody.d.mts → cjs/api/types/DeviceRecoveryListDeviceRecoveryMissingAssetsServiceUnavailableErrorResponseBody.d.ts} +1 -1
- package/dist/{esm/api/types/DeviceRecoveryGetAssetRecoveryStateTooManyRequestsErrorResponseBody.d.mts → cjs/api/types/DeviceRecoveryListDeviceRecoveryMissingAssetsTooManyRequestsErrorResponseBody.d.ts} +1 -1
- package/dist/{esm/api/types/DeviceRecoveryGetAssetRecoveryStateUnauthorizedErrorResponseBody.d.mts → cjs/api/types/DeviceRecoveryListDeviceRecoveryMissingAssetsUnauthorizedErrorResponseBody.d.ts} +1 -1
- package/dist/cjs/api/types/DeviceRecoveryMarkAssetMissingResponseBody.d.ts +1 -1
- package/dist/cjs/api/types/DeviceRecoveryRecoverAssetResponseBody.d.ts +1 -1
- package/dist/cjs/api/types/DriverVehicleAssignmentV2ObjectResponseBody.d.ts +3 -2
- package/dist/cjs/api/types/DriverVehicleAssignmentV2ObjectResponseBody.js +2 -1
- package/dist/cjs/api/types/MissingStateResponseBody.d.ts +20 -0
- package/dist/cjs/api/types/RecoveryStateResponseBody.d.ts +22 -0
- package/dist/cjs/api/types/RidershipRouteSetupObjectResponseBody.d.ts +4 -0
- package/dist/cjs/api/types/{DeviceRecoveryListDeviceRecoveryAssetsBadGatewayErrorResponseBody.d.ts → RidershipRouteSetupsListRidershipRouteSetupsBadGatewayErrorResponseBody.d.ts} +1 -1
- package/dist/cjs/api/types/{DeviceRecoveryListDeviceRecoveryAssetsGatewayTimeoutErrorResponseBody.d.ts → RidershipRouteSetupsListRidershipRouteSetupsGatewayTimeoutErrorResponseBody.d.ts} +1 -1
- package/dist/cjs/api/types/{DeviceRecoveryListDeviceRecoveryAssetsInternalServerErrorResponseBody.d.ts → RidershipRouteSetupsListRidershipRouteSetupsInternalServerErrorResponseBody.d.ts} +1 -1
- package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateMethodNotAllowedErrorResponseBody.d.ts → RidershipRouteSetupsListRidershipRouteSetupsMethodNotAllowedErrorResponseBody.d.ts} +1 -1
- package/dist/cjs/api/types/{DeviceRecoveryListDeviceRecoveryAssetsNotFoundErrorResponseBody.d.ts → RidershipRouteSetupsListRidershipRouteSetupsNotFoundErrorResponseBody.d.ts} +1 -1
- package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateNotImplementedErrorResponseBody.d.ts → RidershipRouteSetupsListRidershipRouteSetupsNotImplementedErrorResponseBody.d.ts} +1 -1
- package/dist/cjs/api/types/RidershipRouteSetupsListRidershipRouteSetupsResponseBody.d.ts +6 -0
- package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateServiceUnavailableErrorResponseBody.d.ts → RidershipRouteSetupsListRidershipRouteSetupsServiceUnavailableErrorResponseBody.d.ts} +1 -1
- package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateTooManyRequestsErrorResponseBody.d.ts → RidershipRouteSetupsListRidershipRouteSetupsTooManyRequestsErrorResponseBody.d.ts} +1 -1
- package/dist/cjs/api/types/RidershipRouteSetupsListRidershipRouteSetupsTooManyRequestsErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateUnauthorizedErrorResponseBody.d.ts → RidershipRouteSetupsListRidershipRouteSetupsUnauthorizedErrorResponseBody.d.ts} +1 -1
- package/dist/cjs/api/types/RidershipRouteSetupsListRidershipRouteSetupsUnauthorizedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/index.d.ts +22 -21
- package/dist/cjs/api/types/index.js +22 -21
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/betaApIs/client/Client.d.mts +31 -1
- package/dist/esm/api/resources/betaApIs/client/Client.mjs +91 -1
- package/dist/esm/api/resources/betaApIs/client/requests/GetDetectionsRequest.d.mts +1 -1
- package/dist/esm/api/resources/betaApIs/client/requests/GetReadingsHistoryRequest.d.mts +16 -0
- package/dist/esm/api/resources/betaApIs/client/requests/GetReadingsSnapshotRequest.d.mts +16 -0
- package/dist/esm/api/resources/betaApIs/client/requests/ListRidershipRouteSetupsRequest.d.mts +14 -0
- package/dist/esm/api/resources/betaApIs/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/driverVehicleAssignments/client/requests/GetDriverVehicleAssignmentsRequest.d.mts +1 -1
- package/dist/esm/api/resources/driverVehicleAssignments/types/GetDriverVehicleAssignmentsRequestAssignmentType.d.mts +1 -0
- package/dist/esm/api/resources/driverVehicleAssignments/types/GetDriverVehicleAssignmentsRequestAssignmentType.mjs +1 -0
- package/dist/esm/api/resources/index.d.mts +0 -1
- package/dist/esm/api/resources/index.mjs +0 -1
- package/dist/esm/api/resources/previewApIs/client/Client.d.mts +5 -41
- package/dist/esm/api/resources/previewApIs/client/Client.mjs +9 -101
- package/dist/esm/api/resources/previewApIs/client/requests/ListDeviceRecoveryMissingAssetsRequest.d.mts +8 -0
- package/dist/esm/api/resources/previewApIs/client/requests/index.d.mts +1 -2
- package/dist/esm/api/resources/previewApIs/index.d.mts +0 -1
- package/dist/esm/api/resources/previewApIs/index.mjs +0 -1
- package/dist/esm/api/types/DetectionLogDetectionObjectResponseBody.d.mts +3 -2
- package/dist/esm/api/types/DetectionLogDetectionObjectResponseBody.mjs +2 -1
- package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsBadGatewayErrorResponseBody.d.mts → DeviceRecoveryListDeviceRecoveryMissingAssetsBadGatewayErrorResponseBody.d.mts} +1 -1
- package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsGatewayTimeoutErrorResponseBody.d.mts → DeviceRecoveryListDeviceRecoveryMissingAssetsGatewayTimeoutErrorResponseBody.d.mts} +1 -1
- package/dist/{cjs/api/types/DeviceRecoveryGetAssetRecoveryStateInternalServerErrorResponseBody.d.ts → esm/api/types/DeviceRecoveryListDeviceRecoveryMissingAssetsInternalServerErrorResponseBody.d.mts} +1 -1
- package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsMethodNotAllowedErrorResponseBody.d.mts → DeviceRecoveryListDeviceRecoveryMissingAssetsMethodNotAllowedErrorResponseBody.d.mts} +1 -1
- package/dist/{cjs/api/types/DeviceRecoveryGetAssetRecoveryStateNotFoundErrorResponseBody.d.ts → esm/api/types/DeviceRecoveryListDeviceRecoveryMissingAssetsNotFoundErrorResponseBody.d.mts} +1 -1
- package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsNotImplementedErrorResponseBody.d.mts → DeviceRecoveryListDeviceRecoveryMissingAssetsNotImplementedErrorResponseBody.d.mts} +1 -1
- package/dist/esm/api/types/DeviceRecoveryListDeviceRecoveryMissingAssetsResponseBody.d.mts +6 -0
- package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsServiceUnavailableErrorResponseBody.d.mts → DeviceRecoveryListDeviceRecoveryMissingAssetsServiceUnavailableErrorResponseBody.d.mts} +1 -1
- package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsTooManyRequestsErrorResponseBody.d.mts → DeviceRecoveryListDeviceRecoveryMissingAssetsTooManyRequestsErrorResponseBody.d.mts} +1 -1
- package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsUnauthorizedErrorResponseBody.d.mts → DeviceRecoveryListDeviceRecoveryMissingAssetsUnauthorizedErrorResponseBody.d.mts} +1 -1
- package/dist/esm/api/types/DeviceRecoveryMarkAssetMissingResponseBody.d.mts +1 -1
- package/dist/esm/api/types/DeviceRecoveryRecoverAssetResponseBody.d.mts +1 -1
- package/dist/esm/api/types/DriverVehicleAssignmentV2ObjectResponseBody.d.mts +3 -2
- package/dist/esm/api/types/DriverVehicleAssignmentV2ObjectResponseBody.mjs +2 -1
- package/dist/esm/api/types/MissingStateResponseBody.d.mts +20 -0
- package/dist/esm/api/types/RecoveryStateResponseBody.d.mts +22 -0
- package/dist/esm/api/types/RidershipRouteSetupObjectResponseBody.d.mts +4 -0
- package/dist/{cjs/api/types/DeviceRecoveryGetAssetRecoveryStateBadGatewayErrorResponseBody.d.ts → esm/api/types/RidershipRouteSetupsListRidershipRouteSetupsBadGatewayErrorResponseBody.d.mts} +1 -1
- package/dist/esm/api/types/{DeviceRecoveryGetAssetRecoveryStateGatewayTimeoutErrorResponseBody.d.mts → RidershipRouteSetupsListRidershipRouteSetupsGatewayTimeoutErrorResponseBody.d.mts} +1 -1
- package/dist/esm/api/types/{DeviceRecoveryGetAssetRecoveryStateInternalServerErrorResponseBody.d.mts → RidershipRouteSetupsListRidershipRouteSetupsInternalServerErrorResponseBody.d.mts} +1 -1
- package/dist/{cjs/api/types/DeviceRecoveryListDeviceRecoveryAssetsMethodNotAllowedErrorResponseBody.d.ts → esm/api/types/RidershipRouteSetupsListRidershipRouteSetupsMethodNotAllowedErrorResponseBody.d.mts} +1 -1
- package/dist/esm/api/types/{DeviceRecoveryGetAssetRecoveryStateNotFoundErrorResponseBody.d.mts → RidershipRouteSetupsListRidershipRouteSetupsNotFoundErrorResponseBody.d.mts} +1 -1
- package/dist/{cjs/api/types/DeviceRecoveryListDeviceRecoveryAssetsNotImplementedErrorResponseBody.d.ts → esm/api/types/RidershipRouteSetupsListRidershipRouteSetupsNotImplementedErrorResponseBody.d.mts} +1 -1
- package/dist/esm/api/types/RidershipRouteSetupsListRidershipRouteSetupsResponseBody.d.mts +6 -0
- package/dist/{cjs/api/types/DeviceRecoveryListDeviceRecoveryAssetsServiceUnavailableErrorResponseBody.d.ts → esm/api/types/RidershipRouteSetupsListRidershipRouteSetupsServiceUnavailableErrorResponseBody.d.mts} +1 -1
- package/dist/{cjs/api/types/DeviceRecoveryListDeviceRecoveryAssetsTooManyRequestsErrorResponseBody.d.ts → esm/api/types/RidershipRouteSetupsListRidershipRouteSetupsTooManyRequestsErrorResponseBody.d.mts} +1 -1
- package/dist/esm/api/types/RidershipRouteSetupsListRidershipRouteSetupsTooManyRequestsErrorResponseBody.mjs +2 -0
- package/dist/{cjs/api/types/DeviceRecoveryListDeviceRecoveryAssetsUnauthorizedErrorResponseBody.d.ts → esm/api/types/RidershipRouteSetupsListRidershipRouteSetupsUnauthorizedErrorResponseBody.d.mts} +1 -1
- package/dist/esm/api/types/RidershipRouteSetupsListRidershipRouteSetupsUnauthorizedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +22 -21
- package/dist/esm/api/types/index.mjs +22 -21
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +77 -83
- package/dist/cjs/api/resources/previewApIs/client/requests/GetAssetRecoveryStateRequest.d.ts +0 -10
- package/dist/cjs/api/resources/previewApIs/client/requests/ListDeviceRecoveryAssetsRequest.d.ts +0 -11
- package/dist/cjs/api/resources/previewApIs/types/ListDeviceRecoveryAssetsRequestStatusesItem.d.ts +0 -7
- package/dist/cjs/api/resources/previewApIs/types/ListDeviceRecoveryAssetsRequestStatusesItem.js +0 -10
- package/dist/cjs/api/resources/previewApIs/types/index.d.ts +0 -1
- package/dist/cjs/api/resources/previewApIs/types/index.js +0 -17
- package/dist/cjs/api/types/DeviceRecoveryGetAssetRecoveryStateResponseBody.d.ts +0 -4
- package/dist/cjs/api/types/DeviceRecoveryListDeviceRecoveryAssetsResponseBody.d.ts +0 -6
- package/dist/cjs/api/types/DeviceRecoveryStateResponseBody.d.ts +0 -40
- package/dist/cjs/api/types/DeviceRecoveryStateResponseBody.js +0 -14
- package/dist/esm/api/resources/previewApIs/client/requests/GetAssetRecoveryStateRequest.d.mts +0 -10
- package/dist/esm/api/resources/previewApIs/client/requests/ListDeviceRecoveryAssetsRequest.d.mts +0 -11
- package/dist/esm/api/resources/previewApIs/types/ListDeviceRecoveryAssetsRequestStatusesItem.d.mts +0 -7
- package/dist/esm/api/resources/previewApIs/types/ListDeviceRecoveryAssetsRequestStatusesItem.mjs +0 -7
- package/dist/esm/api/resources/previewApIs/types/index.d.mts +0 -1
- package/dist/esm/api/resources/previewApIs/types/index.mjs +0 -1
- package/dist/esm/api/types/DeviceRecoveryGetAssetRecoveryStateResponseBody.d.mts +0 -4
- package/dist/esm/api/types/DeviceRecoveryListDeviceRecoveryAssetsResponseBody.d.mts +0 -6
- package/dist/esm/api/types/DeviceRecoveryStateResponseBody.d.mts +0 -40
- package/dist/esm/api/types/DeviceRecoveryStateResponseBody.mjs +0 -11
- /package/dist/cjs/api/resources/{previewApIs/client/requests/GetAssetRecoveryStateRequest.js → betaApIs/client/requests/ListRidershipRouteSetupsRequest.js} +0 -0
- /package/dist/cjs/api/resources/previewApIs/client/requests/{ListDeviceRecoveryAssetsRequest.js → ListDeviceRecoveryMissingAssetsRequest.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateBadGatewayErrorResponseBody.js → DeviceRecoveryListDeviceRecoveryMissingAssetsBadGatewayErrorResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateGatewayTimeoutErrorResponseBody.js → DeviceRecoveryListDeviceRecoveryMissingAssetsGatewayTimeoutErrorResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateInternalServerErrorResponseBody.js → DeviceRecoveryListDeviceRecoveryMissingAssetsInternalServerErrorResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateMethodNotAllowedErrorResponseBody.js → DeviceRecoveryListDeviceRecoveryMissingAssetsMethodNotAllowedErrorResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateNotFoundErrorResponseBody.js → DeviceRecoveryListDeviceRecoveryMissingAssetsNotFoundErrorResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateNotImplementedErrorResponseBody.js → DeviceRecoveryListDeviceRecoveryMissingAssetsNotImplementedErrorResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateResponseBody.js → DeviceRecoveryListDeviceRecoveryMissingAssetsResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateServiceUnavailableErrorResponseBody.js → DeviceRecoveryListDeviceRecoveryMissingAssetsServiceUnavailableErrorResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateTooManyRequestsErrorResponseBody.js → DeviceRecoveryListDeviceRecoveryMissingAssetsTooManyRequestsErrorResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryGetAssetRecoveryStateUnauthorizedErrorResponseBody.js → DeviceRecoveryListDeviceRecoveryMissingAssetsUnauthorizedErrorResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryListDeviceRecoveryAssetsBadGatewayErrorResponseBody.js → MissingStateResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryListDeviceRecoveryAssetsGatewayTimeoutErrorResponseBody.js → RecoveryStateResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryListDeviceRecoveryAssetsInternalServerErrorResponseBody.js → RidershipRouteSetupsListRidershipRouteSetupsBadGatewayErrorResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryListDeviceRecoveryAssetsMethodNotAllowedErrorResponseBody.js → RidershipRouteSetupsListRidershipRouteSetupsGatewayTimeoutErrorResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryListDeviceRecoveryAssetsNotFoundErrorResponseBody.js → RidershipRouteSetupsListRidershipRouteSetupsInternalServerErrorResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryListDeviceRecoveryAssetsNotImplementedErrorResponseBody.js → RidershipRouteSetupsListRidershipRouteSetupsMethodNotAllowedErrorResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryListDeviceRecoveryAssetsResponseBody.js → RidershipRouteSetupsListRidershipRouteSetupsNotFoundErrorResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryListDeviceRecoveryAssetsServiceUnavailableErrorResponseBody.js → RidershipRouteSetupsListRidershipRouteSetupsNotImplementedErrorResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryListDeviceRecoveryAssetsTooManyRequestsErrorResponseBody.js → RidershipRouteSetupsListRidershipRouteSetupsResponseBody.js} +0 -0
- /package/dist/cjs/api/types/{DeviceRecoveryListDeviceRecoveryAssetsUnauthorizedErrorResponseBody.js → RidershipRouteSetupsListRidershipRouteSetupsServiceUnavailableErrorResponseBody.js} +0 -0
- /package/dist/esm/api/resources/{previewApIs/client/requests/GetAssetRecoveryStateRequest.mjs → betaApIs/client/requests/ListRidershipRouteSetupsRequest.mjs} +0 -0
- /package/dist/esm/api/resources/previewApIs/client/requests/{ListDeviceRecoveryAssetsRequest.mjs → ListDeviceRecoveryMissingAssetsRequest.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryGetAssetRecoveryStateBadGatewayErrorResponseBody.mjs → DeviceRecoveryListDeviceRecoveryMissingAssetsBadGatewayErrorResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryGetAssetRecoveryStateGatewayTimeoutErrorResponseBody.mjs → DeviceRecoveryListDeviceRecoveryMissingAssetsGatewayTimeoutErrorResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryGetAssetRecoveryStateInternalServerErrorResponseBody.mjs → DeviceRecoveryListDeviceRecoveryMissingAssetsInternalServerErrorResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryGetAssetRecoveryStateMethodNotAllowedErrorResponseBody.mjs → DeviceRecoveryListDeviceRecoveryMissingAssetsMethodNotAllowedErrorResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryGetAssetRecoveryStateNotFoundErrorResponseBody.mjs → DeviceRecoveryListDeviceRecoveryMissingAssetsNotFoundErrorResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryGetAssetRecoveryStateNotImplementedErrorResponseBody.mjs → DeviceRecoveryListDeviceRecoveryMissingAssetsNotImplementedErrorResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryGetAssetRecoveryStateResponseBody.mjs → DeviceRecoveryListDeviceRecoveryMissingAssetsResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryGetAssetRecoveryStateServiceUnavailableErrorResponseBody.mjs → DeviceRecoveryListDeviceRecoveryMissingAssetsServiceUnavailableErrorResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryGetAssetRecoveryStateTooManyRequestsErrorResponseBody.mjs → DeviceRecoveryListDeviceRecoveryMissingAssetsTooManyRequestsErrorResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryGetAssetRecoveryStateUnauthorizedErrorResponseBody.mjs → DeviceRecoveryListDeviceRecoveryMissingAssetsUnauthorizedErrorResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsBadGatewayErrorResponseBody.mjs → MissingStateResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsGatewayTimeoutErrorResponseBody.mjs → RecoveryStateResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsInternalServerErrorResponseBody.mjs → RidershipRouteSetupsListRidershipRouteSetupsBadGatewayErrorResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsMethodNotAllowedErrorResponseBody.mjs → RidershipRouteSetupsListRidershipRouteSetupsGatewayTimeoutErrorResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsNotFoundErrorResponseBody.mjs → RidershipRouteSetupsListRidershipRouteSetupsInternalServerErrorResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsNotImplementedErrorResponseBody.mjs → RidershipRouteSetupsListRidershipRouteSetupsMethodNotAllowedErrorResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsResponseBody.mjs → RidershipRouteSetupsListRidershipRouteSetupsNotFoundErrorResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsServiceUnavailableErrorResponseBody.mjs → RidershipRouteSetupsListRidershipRouteSetupsNotImplementedErrorResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsTooManyRequestsErrorResponseBody.mjs → RidershipRouteSetupsListRidershipRouteSetupsResponseBody.mjs} +0 -0
- /package/dist/esm/api/types/{DeviceRecoveryListDeviceRecoveryAssetsUnauthorizedErrorResponseBody.mjs → RidershipRouteSetupsListRidershipRouteSetupsServiceUnavailableErrorResponseBody.mjs} +0 -0
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -44,8 +44,8 @@ function normalizeClientOptions(options) {
|
|
|
44
44
|
const headers = (0, headers_js_1.mergeHeaders)({
|
|
45
45
|
"X-Fern-Language": "JavaScript",
|
|
46
46
|
"X-Fern-SDK-Name": "@samsarahq/samsara",
|
|
47
|
-
"X-Fern-SDK-Version": "
|
|
48
|
-
"User-Agent": "@samsarahq/samsara/
|
|
47
|
+
"X-Fern-SDK-Version": "6.0.1",
|
|
48
|
+
"User-Agent": "@samsarahq/samsara/6.0.1",
|
|
49
49
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
50
50
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
51
51
|
"X-Samsara-Version": (_a = options === null || options === void 0 ? void 0 : options.version) !== null && _a !== void 0 ? _a : "2025-06-11",
|
|
@@ -1545,7 +1545,37 @@ export declare class BetaApIsClient {
|
|
|
1545
1545
|
getRidershipPassenger(request: Samsara.GetRidershipPassengerRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.RidershipPassengersGetRidershipPassengerResponseBody>;
|
|
1546
1546
|
private __getRidershipPassenger;
|
|
1547
1547
|
/**
|
|
1548
|
-
*
|
|
1548
|
+
* List all route setups for a ridership account.
|
|
1549
|
+
*
|
|
1550
|
+
* <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
1551
|
+
*
|
|
1552
|
+
* To use this endpoint, select **Read Ridership** under the Ridership category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1553
|
+
*
|
|
1554
|
+
*
|
|
1555
|
+
* **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1556
|
+
*
|
|
1557
|
+
* @param {Samsara.ListRidershipRouteSetupsRequest} request
|
|
1558
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1559
|
+
*
|
|
1560
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
1561
|
+
* @throws {@link Samsara.NotFoundError}
|
|
1562
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
1563
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
1564
|
+
* @throws {@link Samsara.InternalServerError}
|
|
1565
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
1566
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
1567
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
1568
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
1569
|
+
*
|
|
1570
|
+
* @example
|
|
1571
|
+
* await client.betaApIs.listRidershipRouteSetups({
|
|
1572
|
+
* accountId: "accountId"
|
|
1573
|
+
* })
|
|
1574
|
+
*/
|
|
1575
|
+
listRidershipRouteSetups(request: Samsara.ListRidershipRouteSetupsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.RidershipRouteSetupsListRidershipRouteSetupsResponseBody>;
|
|
1576
|
+
private __listRidershipRouteSetups;
|
|
1577
|
+
/**
|
|
1578
|
+
* Create the passenger assignment setup for a route.
|
|
1549
1579
|
*
|
|
1550
1580
|
* <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
1551
1581
|
*
|
|
@@ -4567,7 +4567,97 @@ class BetaApIsClient {
|
|
|
4567
4567
|
});
|
|
4568
4568
|
}
|
|
4569
4569
|
/**
|
|
4570
|
-
*
|
|
4570
|
+
* List all route setups for a ridership account.
|
|
4571
|
+
*
|
|
4572
|
+
* <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
4573
|
+
*
|
|
4574
|
+
* To use this endpoint, select **Read Ridership** under the Ridership category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
4575
|
+
*
|
|
4576
|
+
*
|
|
4577
|
+
* **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
4578
|
+
*
|
|
4579
|
+
* @param {Samsara.ListRidershipRouteSetupsRequest} request
|
|
4580
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4581
|
+
*
|
|
4582
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
4583
|
+
* @throws {@link Samsara.NotFoundError}
|
|
4584
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
4585
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
4586
|
+
* @throws {@link Samsara.InternalServerError}
|
|
4587
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
4588
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
4589
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
4590
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
4591
|
+
*
|
|
4592
|
+
* @example
|
|
4593
|
+
* await client.betaApIs.listRidershipRouteSetups({
|
|
4594
|
+
* accountId: "accountId"
|
|
4595
|
+
* })
|
|
4596
|
+
*/
|
|
4597
|
+
listRidershipRouteSetups(request, requestOptions) {
|
|
4598
|
+
return core.HttpResponsePromise.fromPromise(this.__listRidershipRouteSetups(request, requestOptions));
|
|
4599
|
+
}
|
|
4600
|
+
__listRidershipRouteSetups(request, requestOptions) {
|
|
4601
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4602
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
4603
|
+
const { accountId, after, limit } = request;
|
|
4604
|
+
const _queryParams = {
|
|
4605
|
+
accountId,
|
|
4606
|
+
after,
|
|
4607
|
+
limit,
|
|
4608
|
+
};
|
|
4609
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
4610
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Samsara-Version": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
4611
|
+
const _response = yield core.fetcher({
|
|
4612
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.SamsaraEnvironment.ProductionApi, "ridership/route-setups"),
|
|
4613
|
+
method: "GET",
|
|
4614
|
+
headers: _headers,
|
|
4615
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
4616
|
+
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
4617
|
+
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
4618
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
4619
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
4620
|
+
logging: this._options.logging,
|
|
4621
|
+
});
|
|
4622
|
+
if (_response.ok) {
|
|
4623
|
+
return {
|
|
4624
|
+
data: _response.body,
|
|
4625
|
+
rawResponse: _response.rawResponse,
|
|
4626
|
+
};
|
|
4627
|
+
}
|
|
4628
|
+
if (_response.error.reason === "status-code") {
|
|
4629
|
+
switch (_response.error.statusCode) {
|
|
4630
|
+
case 401:
|
|
4631
|
+
throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
4632
|
+
case 404:
|
|
4633
|
+
throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
|
|
4634
|
+
case 405:
|
|
4635
|
+
throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
|
|
4636
|
+
case 429:
|
|
4637
|
+
throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
4638
|
+
case 500:
|
|
4639
|
+
throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
|
|
4640
|
+
case 501:
|
|
4641
|
+
throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
4642
|
+
case 502:
|
|
4643
|
+
throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
|
|
4644
|
+
case 503:
|
|
4645
|
+
throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
4646
|
+
case 504:
|
|
4647
|
+
throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
|
|
4648
|
+
default:
|
|
4649
|
+
throw new errors.SamsaraError({
|
|
4650
|
+
statusCode: _response.error.statusCode,
|
|
4651
|
+
body: _response.error.body,
|
|
4652
|
+
rawResponse: _response.rawResponse,
|
|
4653
|
+
});
|
|
4654
|
+
}
|
|
4655
|
+
}
|
|
4656
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/ridership/route-setups");
|
|
4657
|
+
});
|
|
4658
|
+
}
|
|
4659
|
+
/**
|
|
4660
|
+
* Create the passenger assignment setup for a route.
|
|
4571
4661
|
*
|
|
4572
4662
|
* <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
4573
4663
|
*
|
|
@@ -9,7 +9,7 @@ export interface GetDetectionsRequest {
|
|
|
9
9
|
driverIds?: string | string[];
|
|
10
10
|
/** Optional string of comma separated asset IDs. If asset ID is present, events for the specified asset(s) will be returned. Max for this value is 2000 objects. (Example: 281474982859091,281471982957527) */
|
|
11
11
|
assetIds?: string | string[];
|
|
12
|
-
/** Optional string of comma separated labels to filter behavior labels. Uses OR semantics for filtering. An empty list allows all values. Valid values: `acceleration`, `braking`, `crash`, `drowsy`, `eatingDrinking`, `edgeRailroadCrossingViolation`, `followingDistance`, `forwardCollisionWarning`, `genericDistraction`, `harshTurn`, `heavySpeeding`, `laneDeparture`, `lightSpeeding`, `maxSpeed`, `mobileUsage`, `moderateSpeeding`, `noSeatbelt`, `obstructedCamera`, `passenger`, `policyViolationMask`, `ranRedLight`, `rearCollisionWarning`, `rollingStop`, `rolloverProtection`, `severeSpeeding`, `smoking`, `speeding`, `unsafeParking`, `vehicleInBlindSpotWarning`, `vulnerableRoadUserCollisionWarning`, `yawControl`. (Example: rollingStop,obstructedCamera,noSeatbelt) */
|
|
12
|
+
/** Optional string of comma separated labels to filter behavior labels. Uses OR semantics for filtering. An empty list allows all values. Valid values: `acceleration`, `braking`, `crash`, `drowsy`, `eatingDrinking`, `edgeRailroadCrossingViolation`, `followingDistance`, `forwardCollisionWarning`, `genericDistraction`, `harshTurn`, `heavySpeeding`, `laneDeparture`, `lightSpeeding`, `maxSpeed`, `mobileUsage`, `moderateSpeeding`, `noSeatbelt`, `obstructedCamera`, `passenger`, `policyViolationMask`, `ranRedLight`, `rearCollisionWarning`, `reversing`, `rollingStop`, `rolloverProtection`, `severeSpeeding`, `smoking`, `speeding`, `unsafeParking`, `vehicleInBlindSpotWarning`, `vulnerableRoadUserCollisionWarning`, `yawControl`. (Example: rollingStop,obstructedCamera,noSeatbelt) */
|
|
13
13
|
detectionBehaviorLabels?: string | string[];
|
|
14
14
|
/** Optional string of comma separated reasons to filter detections. Uses OR semantics for filtering. An empty list allows all values. Valid values: `overDailyLimit`, `overHourlyLimit`, `overTripLimit`, `belowConfidenceThreshold`, `belowSeverityThreshold`, `overEventRateLimit`, `geofenceFilter`, `belowNudgeThreshold`, `belowSpeedThreshold`, `nighttimeFilter`, `speedingFilter`, `inCabAlertOnly`, `unknown`. (Example: overDailyLimit,overHourlyLimit,belowConfidenceThreshold) */
|
|
15
15
|
inboxFilterReason?: string | string[];
|
|
@@ -39,6 +39,7 @@ export interface GetReadingsHistoryRequest {
|
|
|
39
39
|
* * `checkEngineLightJ1939Warning` (Check Engine Light (J1939) - Warning): Indicates whether the J1939 check engine light warning indicator is active or inactive. (values: off | on)
|
|
40
40
|
* * `checkEngineLightPassenger` (Check Engine Light (Passenger)): Indicates whether the passenger check engine light indicator is active or inactive. (values: off | on)
|
|
41
41
|
* * `coolantTemp` (Engine Coolant Temp): Represents the engine coolant temperature. (celsius)
|
|
42
|
+
* * `crankcasePressure` (Crankcase Pressure): The pressure inside the engine's crankcase (kilopascal)
|
|
42
43
|
* * `defLevel` (DEF Level): Represents the DEF (Diesel Exhaust Fluid) level percentage. (percent)
|
|
43
44
|
* * `derivedFuelConsumed` (Lifetime Fuel Consumed (Samsara)): Samsara-maintained fuel consumption since the device was firstinstalled. (liter)
|
|
44
45
|
* * `deviceOrientation` (Device Orientation): Indicates orientation of the device. (values: invalid | unknown | topDown | bottomDown | leftDown | rightDown | backDown | frontDown)
|
|
@@ -46,27 +47,41 @@ export interface GetReadingsHistoryRequest {
|
|
|
46
47
|
* * `dpfLampStatus` (DPF Lamp Status): Status of the Diesel Particulate Filter warning lamp. (values: off | on | blinking)
|
|
47
48
|
* * `dpfSootLoadPercent` (DPF Soot Load): Diesel Particulate Filter soot load percentage. (percent)
|
|
48
49
|
* * `ecuHistoryTotalRunTime` (ECU Total Run Time): Total engine run time from ECU in seconds. (second)
|
|
50
|
+
* * `engineExhaustTemperature` (Engine Exhaust Temperature): Temperature of the engine exhaust (celsius)
|
|
49
51
|
* * `engineHours` (Engine Hours (ECU)): Represents the total engine runtime in hours as reported by the ECU. (second)
|
|
50
52
|
* * `engineHoursDigioBased` (Engine Hours (Synthetic - Aux input)): Represents the synthetic total engine runtime in hours based on auxiliary input. (millisecond)
|
|
51
53
|
* * `engineHoursEngineStateBased` (Engine Hours (Synthetic)): Represents the synthetic total engine runtime in hours based on engine state. (millisecond)
|
|
54
|
+
* * `engineImmobilizer` (Engine Immobilizer): The state of the engine immobilizer. Valid values: ignition_disabled, ignition_enabled.
|
|
52
55
|
* * `engineIntakeAirTemp` (Engine Intake Air Temperature): Represents the engine intake air temperature. (celsius)
|
|
53
56
|
* * `engineLoadPercent` (Engine Load): Engine load percentage. (percent)
|
|
57
|
+
* * `engineOilTemperature` (Engine Oil Temperature): Temperature of the engine oil (celsius)
|
|
54
58
|
* * `engineState` (Engine State): Indicates the current state of the engine, such as running, stopped. (values: off | running | idling)
|
|
59
|
+
* * `engineTotalIdleTime` (Engine Total Idle Time): Total idle time for the vehicle. (minute)
|
|
55
60
|
* * `ev24VoltDcDcInverterCurrent` (EV 24V DC/DC Inverter Current): Current from the 24V DC-DC inverter in amperes. (ampere)
|
|
56
61
|
* * `evAverageCellTemperature` (EV Average Cell Temperature): Average temperature of EV battery cells in degrees Celsius. (celsius)
|
|
62
|
+
* * `evChargingCurrent` (EV Charging Current): Charging current for electric and hybrid vehicles. (ampere)
|
|
63
|
+
* * `evChargingEnergy` (EV Charging Energy): Charging energy for electric and hybrid vehicles. (watthour)
|
|
57
64
|
* * `evChargingErrorStatus` (EV Charging Error Status): Indicates if the EV charging system has an error. (values: noError | batteryTooHotOrCold | vehicleNotInPark | connectorLockFault | chargingSystemFault | chargingCurrentDifferential | chargingVoltageOutOfRange | chargingSystemNotCompatible | noDataUndeterminedStatus | notAvailable | unknownError)
|
|
65
|
+
* * `evChargingStatus` (EV Charging Status): Charging status for electric and hybrid vehicles. (values: unknown | notCharging | charging)
|
|
66
|
+
* * `evChargingVoltage` (EV Charging Voltage): Charging voltage for electric and hybrid vehicles. (volt)
|
|
67
|
+
* * `evConsumedEnergy` (EV Consumed Energy): Consumed energy (including regenerated) for electric and hybrid vehicles. (watthour)
|
|
68
|
+
* * `evDistanceDriven` (EV Distance Driven): Electric distance driven for electric and hybrid vehicles. (meter)
|
|
58
69
|
* * `evHighCapacityBatteryCurrent` (EV High Capacity Battery Current): Current from the high capacity EV battery in amperes. (ampere)
|
|
59
70
|
* * `evHighCapacityBatteryVoltage` (High Capacity EV Battery Voltage): Represents the voltage of the high capacity EV battery. (volt)
|
|
60
71
|
* * `evMaxAllowedStateOfChargePercent` (EV Max Allowed State of Charge): Maximum allowed state of charge percentage. (percent)
|
|
61
72
|
* * `evMaxCellTemperature` (EV Max Cell Temperature): Maximum temperature of EV battery cells in degrees Celsius. (celsius)
|
|
62
73
|
* * `evMinAllowedStateOfChargePercent` (EV Min Allowed State of Charge): Minimum allowed state of charge percentage. (percent)
|
|
63
74
|
* * `evMinCellTemperature` (EV Min Cell Temperature): Minimum temperature of EV battery cells in degrees Celsius. (celsius)
|
|
75
|
+
* * `evRegeneratedEnergy` (EV Regenerated Energy): Regenerated energy for electric and hybrid vehicles. (watthour)
|
|
64
76
|
* * `exhaustGasPressure` (Exhaust Gas Pressure): Represents the exhaust gas pressure. (kilopascal)
|
|
77
|
+
* * `faultCodes` (Fault Codes): Engine fault codes for the asset
|
|
65
78
|
* * `fuelConsumptionRate` (Fuel Consumption Rate): The rate at which an asset uses fuel (litersperhour)
|
|
66
79
|
* * `fuelLevelPerc` (Fuel Level): Percentage of fuel remaining in the tank. (percent)
|
|
67
80
|
* * `fuelSource` (Fuel Source): Type of fuel used by the asset. (values: gasoline | diesel)
|
|
68
81
|
* * `geoCoordinates` (Geo Coordinates): GPS coordinates (latitude and longitude) of the asset's location.
|
|
82
|
+
* * `gpsDistance` (GPS Distance): The distance the vehicle has traveled since the gateway was installed based on GPS calculations. (meter)
|
|
69
83
|
* * `gpsSpeed` (GPS Speed): Asset speed measured by the gateway's GPS receiver. (meterspersec)
|
|
84
|
+
* * `idlingDuration` (Cumulative Idling Duration): The cumulative idling duration. Cumulative values always increase. (millisecond)
|
|
70
85
|
* * `ignitionStatus` (Ignitions Status): Indicates the current ignition status as a voltage (values: off | on)
|
|
71
86
|
* * `latitude` (Latitude): Latitude coordinate of the asset's location. (decimaldegrees)
|
|
72
87
|
* * `lifetimeFuelConsumed` (Lifetime Fuel Consumed): Represents the vehicle maintained lifetime fuel consumption as reported by the vehicle. (liter)
|
|
@@ -97,6 +112,7 @@ export interface GetReadingsHistoryRequest {
|
|
|
97
112
|
* * `seatbeltDriver` (Seatbelt (Driver)): Indicates whether the driver's seatbelt is buckled or unbuckled. (values: unbuckled | buckled)
|
|
98
113
|
* * `seatbeltPassenger` (Seatbelt (Passenger)): Indicates whether the passenger's seatbelt is buckled or unbuckled. (values: unbuckled | buckled)
|
|
99
114
|
* * `supportFindNearby` (Support Find Nearby): Indicates if the asset can support find nearby. (values: noData | notCompatible | pendingUpgrade | Ready)
|
|
115
|
+
* * `tellTales` (Tell Tale Status): Tell tales status as read from the vehicle.
|
|
100
116
|
* * `tirePressuresBackLeft` (Tire pressure, back left): Represents the tire pressure for the back-left tire. (kilopascal)
|
|
101
117
|
* * `tirePressuresBackRight` (Tire pressure, back right): Represents the tire pressure for the back-right tire. (kilopascal)
|
|
102
118
|
* * `tirePressuresFrontLeft` (Tire pressure, front left): Represents the tire pressure for the front-left tire. (kilopascal)
|
|
@@ -39,6 +39,7 @@ export interface GetReadingsSnapshotRequest {
|
|
|
39
39
|
* * `checkEngineLightJ1939Warning` (Check Engine Light (J1939) - Warning): Indicates whether the J1939 check engine light warning indicator is active or inactive. (values: off | on)
|
|
40
40
|
* * `checkEngineLightPassenger` (Check Engine Light (Passenger)): Indicates whether the passenger check engine light indicator is active or inactive. (values: off | on)
|
|
41
41
|
* * `coolantTemp` (Engine Coolant Temp): Represents the engine coolant temperature. (celsius)
|
|
42
|
+
* * `crankcasePressure` (Crankcase Pressure): The pressure inside the engine's crankcase (kilopascal)
|
|
42
43
|
* * `defLevel` (DEF Level): Represents the DEF (Diesel Exhaust Fluid) level percentage. (percent)
|
|
43
44
|
* * `derivedFuelConsumed` (Lifetime Fuel Consumed (Samsara)): Samsara-maintained fuel consumption since the device was firstinstalled. (liter)
|
|
44
45
|
* * `deviceOrientation` (Device Orientation): Indicates orientation of the device. (values: invalid | unknown | topDown | bottomDown | leftDown | rightDown | backDown | frontDown)
|
|
@@ -46,27 +47,41 @@ export interface GetReadingsSnapshotRequest {
|
|
|
46
47
|
* * `dpfLampStatus` (DPF Lamp Status): Status of the Diesel Particulate Filter warning lamp. (values: off | on | blinking)
|
|
47
48
|
* * `dpfSootLoadPercent` (DPF Soot Load): Diesel Particulate Filter soot load percentage. (percent)
|
|
48
49
|
* * `ecuHistoryTotalRunTime` (ECU Total Run Time): Total engine run time from ECU in seconds. (second)
|
|
50
|
+
* * `engineExhaustTemperature` (Engine Exhaust Temperature): Temperature of the engine exhaust (celsius)
|
|
49
51
|
* * `engineHours` (Engine Hours (ECU)): Represents the total engine runtime in hours as reported by the ECU. (second)
|
|
50
52
|
* * `engineHoursDigioBased` (Engine Hours (Synthetic - Aux input)): Represents the synthetic total engine runtime in hours based on auxiliary input. (millisecond)
|
|
51
53
|
* * `engineHoursEngineStateBased` (Engine Hours (Synthetic)): Represents the synthetic total engine runtime in hours based on engine state. (millisecond)
|
|
54
|
+
* * `engineImmobilizer` (Engine Immobilizer): The state of the engine immobilizer. Valid values: ignition_disabled, ignition_enabled.
|
|
52
55
|
* * `engineIntakeAirTemp` (Engine Intake Air Temperature): Represents the engine intake air temperature. (celsius)
|
|
53
56
|
* * `engineLoadPercent` (Engine Load): Engine load percentage. (percent)
|
|
57
|
+
* * `engineOilTemperature` (Engine Oil Temperature): Temperature of the engine oil (celsius)
|
|
54
58
|
* * `engineState` (Engine State): Indicates the current state of the engine, such as running, stopped. (values: off | running | idling)
|
|
59
|
+
* * `engineTotalIdleTime` (Engine Total Idle Time): Total idle time for the vehicle. (minute)
|
|
55
60
|
* * `ev24VoltDcDcInverterCurrent` (EV 24V DC/DC Inverter Current): Current from the 24V DC-DC inverter in amperes. (ampere)
|
|
56
61
|
* * `evAverageCellTemperature` (EV Average Cell Temperature): Average temperature of EV battery cells in degrees Celsius. (celsius)
|
|
62
|
+
* * `evChargingCurrent` (EV Charging Current): Charging current for electric and hybrid vehicles. (ampere)
|
|
63
|
+
* * `evChargingEnergy` (EV Charging Energy): Charging energy for electric and hybrid vehicles. (watthour)
|
|
57
64
|
* * `evChargingErrorStatus` (EV Charging Error Status): Indicates if the EV charging system has an error. (values: noError | batteryTooHotOrCold | vehicleNotInPark | connectorLockFault | chargingSystemFault | chargingCurrentDifferential | chargingVoltageOutOfRange | chargingSystemNotCompatible | noDataUndeterminedStatus | notAvailable | unknownError)
|
|
65
|
+
* * `evChargingStatus` (EV Charging Status): Charging status for electric and hybrid vehicles. (values: unknown | notCharging | charging)
|
|
66
|
+
* * `evChargingVoltage` (EV Charging Voltage): Charging voltage for electric and hybrid vehicles. (volt)
|
|
67
|
+
* * `evConsumedEnergy` (EV Consumed Energy): Consumed energy (including regenerated) for electric and hybrid vehicles. (watthour)
|
|
68
|
+
* * `evDistanceDriven` (EV Distance Driven): Electric distance driven for electric and hybrid vehicles. (meter)
|
|
58
69
|
* * `evHighCapacityBatteryCurrent` (EV High Capacity Battery Current): Current from the high capacity EV battery in amperes. (ampere)
|
|
59
70
|
* * `evHighCapacityBatteryVoltage` (High Capacity EV Battery Voltage): Represents the voltage of the high capacity EV battery. (volt)
|
|
60
71
|
* * `evMaxAllowedStateOfChargePercent` (EV Max Allowed State of Charge): Maximum allowed state of charge percentage. (percent)
|
|
61
72
|
* * `evMaxCellTemperature` (EV Max Cell Temperature): Maximum temperature of EV battery cells in degrees Celsius. (celsius)
|
|
62
73
|
* * `evMinAllowedStateOfChargePercent` (EV Min Allowed State of Charge): Minimum allowed state of charge percentage. (percent)
|
|
63
74
|
* * `evMinCellTemperature` (EV Min Cell Temperature): Minimum temperature of EV battery cells in degrees Celsius. (celsius)
|
|
75
|
+
* * `evRegeneratedEnergy` (EV Regenerated Energy): Regenerated energy for electric and hybrid vehicles. (watthour)
|
|
64
76
|
* * `exhaustGasPressure` (Exhaust Gas Pressure): Represents the exhaust gas pressure. (kilopascal)
|
|
77
|
+
* * `faultCodes` (Fault Codes): Engine fault codes for the asset
|
|
65
78
|
* * `fuelConsumptionRate` (Fuel Consumption Rate): The rate at which an asset uses fuel (litersperhour)
|
|
66
79
|
* * `fuelLevelPerc` (Fuel Level): Percentage of fuel remaining in the tank. (percent)
|
|
67
80
|
* * `fuelSource` (Fuel Source): Type of fuel used by the asset. (values: gasoline | diesel)
|
|
68
81
|
* * `geoCoordinates` (Geo Coordinates): GPS coordinates (latitude and longitude) of the asset's location.
|
|
82
|
+
* * `gpsDistance` (GPS Distance): The distance the vehicle has traveled since the gateway was installed based on GPS calculations. (meter)
|
|
69
83
|
* * `gpsSpeed` (GPS Speed): Asset speed measured by the gateway's GPS receiver. (meterspersec)
|
|
84
|
+
* * `idlingDuration` (Cumulative Idling Duration): The cumulative idling duration. Cumulative values always increase. (millisecond)
|
|
70
85
|
* * `ignitionStatus` (Ignitions Status): Indicates the current ignition status as a voltage (values: off | on)
|
|
71
86
|
* * `latitude` (Latitude): Latitude coordinate of the asset's location. (decimaldegrees)
|
|
72
87
|
* * `lifetimeFuelConsumed` (Lifetime Fuel Consumed): Represents the vehicle maintained lifetime fuel consumption as reported by the vehicle. (liter)
|
|
@@ -97,6 +112,7 @@ export interface GetReadingsSnapshotRequest {
|
|
|
97
112
|
* * `seatbeltDriver` (Seatbelt (Driver)): Indicates whether the driver's seatbelt is buckled or unbuckled. (values: unbuckled | buckled)
|
|
98
113
|
* * `seatbeltPassenger` (Seatbelt (Passenger)): Indicates whether the passenger's seatbelt is buckled or unbuckled. (values: unbuckled | buckled)
|
|
99
114
|
* * `supportFindNearby` (Support Find Nearby): Indicates if the asset can support find nearby. (values: noData | notCompatible | pendingUpgrade | Ready)
|
|
115
|
+
* * `tellTales` (Tell Tale Status): Tell tales status as read from the vehicle.
|
|
100
116
|
* * `tirePressuresBackLeft` (Tire pressure, back left): Represents the tire pressure for the back-left tire. (kilopascal)
|
|
101
117
|
* * `tirePressuresBackRight` (Tire pressure, back right): Represents the tire pressure for the back-right tire. (kilopascal)
|
|
102
118
|
* * `tirePressuresFrontLeft` (Tire pressure, front left): Represents the tire pressure for the front-left tire. (kilopascal)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* accountId: "accountId"
|
|
5
|
+
* }
|
|
6
|
+
*/
|
|
7
|
+
export interface ListRidershipRouteSetupsRequest {
|
|
8
|
+
/** The Samsara UUID of the ridership account to list route setups for. */
|
|
9
|
+
accountId: string;
|
|
10
|
+
/** If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results. */
|
|
11
|
+
after?: string;
|
|
12
|
+
/** The limit for how many objects will be in the response. Default and max for this value is 512 objects. */
|
|
13
|
+
limit?: number;
|
|
14
|
+
}
|
|
@@ -44,6 +44,7 @@ export type { ListHubCustomPropertiesRequest } from "./ListHubCustomPropertiesRe
|
|
|
44
44
|
export type { ListReadingsDefinitionsRequest } from "./ListReadingsDefinitionsRequest.js";
|
|
45
45
|
export type { ListRidershipAccountsRequest } from "./ListRidershipAccountsRequest.js";
|
|
46
46
|
export type { ListRidershipPassengersRequest } from "./ListRidershipPassengersRequest.js";
|
|
47
|
+
export type { ListRidershipRouteSetupsRequest } from "./ListRidershipRouteSetupsRequest.js";
|
|
47
48
|
export type { PlanOrdersCreatePlanOrdersRequestBody } from "./PlanOrdersCreatePlanOrdersRequestBody.js";
|
|
48
49
|
export type { QualificationsArchiveQualificationRecordRequestBody } from "./QualificationsArchiveQualificationRecordRequestBody.js";
|
|
49
50
|
export type { QualificationsDeleteQualificationRecordRequestBody } from "./QualificationsDeleteQualificationRecordRequestBody.js";
|
|
@@ -22,6 +22,6 @@ export interface GetDriverVehicleAssignmentsRequest {
|
|
|
22
22
|
vehicleTagIds?: string;
|
|
23
23
|
/** If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results. */
|
|
24
24
|
after?: string;
|
|
25
|
-
/** Specifies which assignment type to filter by. Valid values: `HOS`, `idCard`, `static`, `faceId`, `tachograph`, `safetyManual`, `RFID`, `trailer`, `external`, `qrCode`, `driverApp` */
|
|
25
|
+
/** Specifies which assignment type to filter by. Valid values: `HOS`, `idCard`, `static`, `faceId`, `tachograph`, `safetyManual`, `RFID`, `trailer`, `external`, `qrCode`, `driverApp`, `voiceSignIn` */
|
|
26
26
|
assignmentType?: Samsara.GetDriverVehicleAssignmentsRequestAssignmentType;
|
|
27
27
|
}
|
|
@@ -10,5 +10,6 @@ export declare const GetDriverVehicleAssignmentsRequestAssignmentType: {
|
|
|
10
10
|
readonly External: "external";
|
|
11
11
|
readonly QrCode: "qrCode";
|
|
12
12
|
readonly DriverApp: "driverApp";
|
|
13
|
+
readonly VoiceSignIn: "voiceSignIn";
|
|
13
14
|
};
|
|
14
15
|
export type GetDriverVehicleAssignmentsRequestAssignmentType = (typeof GetDriverVehicleAssignmentsRequestAssignmentType)[keyof typeof GetDriverVehicleAssignmentsRequestAssignmentType];
|
|
@@ -79,7 +79,6 @@ export * from "./plans/client/requests/index.js";
|
|
|
79
79
|
export * as plans from "./plans/index.js";
|
|
80
80
|
export * from "./previewApIs/client/requests/index.js";
|
|
81
81
|
export * as previewApIs from "./previewApIs/index.js";
|
|
82
|
-
export * from "./previewApIs/types/index.js";
|
|
83
82
|
export * from "./routeEvents/client/requests/index.js";
|
|
84
83
|
export * as routeEvents from "./routeEvents/index.js";
|
|
85
84
|
export * from "./routes/client/requests/index.js";
|
|
@@ -119,7 +119,6 @@ __exportStar(require("./plans/client/requests/index.js"), exports);
|
|
|
119
119
|
exports.plans = __importStar(require("./plans/index.js"));
|
|
120
120
|
__exportStar(require("./previewApIs/client/requests/index.js"), exports);
|
|
121
121
|
exports.previewApIs = __importStar(require("./previewApIs/index.js"));
|
|
122
|
-
__exportStar(require("./previewApIs/types/index.js"), exports);
|
|
123
122
|
__exportStar(require("./routeEvents/client/requests/index.js"), exports);
|
|
124
123
|
exports.routeEvents = __importStar(require("./routeEvents/index.js"));
|
|
125
124
|
__exportStar(require("./routes/client/requests/index.js"), exports);
|
|
@@ -11,7 +11,7 @@ export declare class PreviewApIsClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<PreviewApIsClient.Options>;
|
|
12
12
|
constructor(options?: PreviewApIsClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* List all assets that
|
|
14
|
+
* List all assets that are currently marked as missing for the organization.
|
|
15
15
|
*
|
|
16
16
|
* <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
17
17
|
*
|
|
@@ -26,7 +26,7 @@ export declare class PreviewApIsClient {
|
|
|
26
26
|
*
|
|
27
27
|
* **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
28
28
|
*
|
|
29
|
-
* @param {Samsara.
|
|
29
|
+
* @param {Samsara.ListDeviceRecoveryMissingAssetsRequest} request
|
|
30
30
|
* @param {PreviewApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
31
31
|
*
|
|
32
32
|
* @throws {@link Samsara.UnauthorizedError}
|
|
@@ -40,10 +40,10 @@ export declare class PreviewApIsClient {
|
|
|
40
40
|
* @throws {@link Samsara.GatewayTimeoutError}
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
|
-
* await client.previewApIs.
|
|
43
|
+
* await client.previewApIs.listDeviceRecoveryMissingAssets()
|
|
44
44
|
*/
|
|
45
|
-
|
|
46
|
-
private
|
|
45
|
+
listDeviceRecoveryMissingAssets(request?: Samsara.ListDeviceRecoveryMissingAssetsRequest, requestOptions?: PreviewApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.DeviceRecoveryListDeviceRecoveryMissingAssetsResponseBody>;
|
|
46
|
+
private __listDeviceRecoveryMissingAssets;
|
|
47
47
|
/**
|
|
48
48
|
* Mark an asset as missing. Optionally specify a note and notification recipients who will receive email updates.
|
|
49
49
|
*
|
|
@@ -119,42 +119,6 @@ export declare class PreviewApIsClient {
|
|
|
119
119
|
*/
|
|
120
120
|
recoverAsset(request: Samsara.DeviceRecoveryRecoverAssetRequestBody, requestOptions?: PreviewApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.DeviceRecoveryRecoverAssetResponseBody>;
|
|
121
121
|
private __recoverAsset;
|
|
122
|
-
/**
|
|
123
|
-
* Get the current recovery state for a specific asset, including recovery photos and notification recipients.
|
|
124
|
-
*
|
|
125
|
-
* <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
126
|
-
*
|
|
127
|
-
* To use this endpoint, select **Read Assets** under the Assets category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
128
|
-
*
|
|
129
|
-
* Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications
|
|
130
|
-
*
|
|
131
|
-
* - Samsara may change the structure of a preview API's interface without versioning or any notice to API users.
|
|
132
|
-
*
|
|
133
|
-
* - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
* **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
137
|
-
*
|
|
138
|
-
* @param {Samsara.GetAssetRecoveryStateRequest} request
|
|
139
|
-
* @param {PreviewApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
140
|
-
*
|
|
141
|
-
* @throws {@link Samsara.UnauthorizedError}
|
|
142
|
-
* @throws {@link Samsara.NotFoundError}
|
|
143
|
-
* @throws {@link Samsara.MethodNotAllowedError}
|
|
144
|
-
* @throws {@link Samsara.TooManyRequestsError}
|
|
145
|
-
* @throws {@link Samsara.InternalServerError}
|
|
146
|
-
* @throws {@link Samsara.NotImplementedError}
|
|
147
|
-
* @throws {@link Samsara.BadGatewayError}
|
|
148
|
-
* @throws {@link Samsara.ServiceUnavailableError}
|
|
149
|
-
* @throws {@link Samsara.GatewayTimeoutError}
|
|
150
|
-
*
|
|
151
|
-
* @example
|
|
152
|
-
* await client.previewApIs.getAssetRecoveryState({
|
|
153
|
-
* id: "id"
|
|
154
|
-
* })
|
|
155
|
-
*/
|
|
156
|
-
getAssetRecoveryState(request: Samsara.GetAssetRecoveryStateRequest, requestOptions?: PreviewApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.DeviceRecoveryGetAssetRecoveryStateResponseBody>;
|
|
157
|
-
private __getAssetRecoveryState;
|
|
158
122
|
/**
|
|
159
123
|
* Creates a short-lived auth token for a driver.
|
|
160
124
|
*
|
|
@@ -67,7 +67,7 @@ class PreviewApIsClient {
|
|
|
67
67
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
70
|
-
* List all assets that
|
|
70
|
+
* List all assets that are currently marked as missing for the organization.
|
|
71
71
|
*
|
|
72
72
|
* <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
73
73
|
*
|
|
@@ -82,7 +82,7 @@ class PreviewApIsClient {
|
|
|
82
82
|
*
|
|
83
83
|
* **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
84
84
|
*
|
|
85
|
-
* @param {Samsara.
|
|
85
|
+
* @param {Samsara.ListDeviceRecoveryMissingAssetsRequest} request
|
|
86
86
|
* @param {PreviewApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
87
87
|
*
|
|
88
88
|
* @throws {@link Samsara.UnauthorizedError}
|
|
@@ -96,23 +96,22 @@ class PreviewApIsClient {
|
|
|
96
96
|
* @throws {@link Samsara.GatewayTimeoutError}
|
|
97
97
|
*
|
|
98
98
|
* @example
|
|
99
|
-
* await client.previewApIs.
|
|
99
|
+
* await client.previewApIs.listDeviceRecoveryMissingAssets()
|
|
100
100
|
*/
|
|
101
|
-
|
|
102
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
101
|
+
listDeviceRecoveryMissingAssets(request = {}, requestOptions) {
|
|
102
|
+
return core.HttpResponsePromise.fromPromise(this.__listDeviceRecoveryMissingAssets(request, requestOptions));
|
|
103
103
|
}
|
|
104
|
-
|
|
104
|
+
__listDeviceRecoveryMissingAssets() {
|
|
105
105
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
106
106
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
107
|
-
const {
|
|
107
|
+
const { after } = request;
|
|
108
108
|
const _queryParams = {
|
|
109
|
-
statuses: Array.isArray(statuses) ? statuses.map((item) => item) : statuses != null ? statuses : undefined,
|
|
110
109
|
after,
|
|
111
110
|
};
|
|
112
111
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
113
112
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Samsara-Version": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
114
113
|
const _response = yield core.fetcher({
|
|
115
|
-
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.SamsaraEnvironment.ProductionApi, "preview/fleet/assets/device-recovery"),
|
|
114
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.SamsaraEnvironment.ProductionApi, "preview/fleet/assets/device-recovery-missing"),
|
|
116
115
|
method: "GET",
|
|
117
116
|
headers: _headers,
|
|
118
117
|
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
@@ -156,7 +155,7 @@ class PreviewApIsClient {
|
|
|
156
155
|
});
|
|
157
156
|
}
|
|
158
157
|
}
|
|
159
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/preview/fleet/assets/device-recovery");
|
|
158
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/preview/fleet/assets/device-recovery-missing");
|
|
160
159
|
});
|
|
161
160
|
}
|
|
162
161
|
/**
|
|
@@ -350,97 +349,6 @@ class PreviewApIsClient {
|
|
|
350
349
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/preview/fleet/assets/device-recovery/{id}/recovered");
|
|
351
350
|
});
|
|
352
351
|
}
|
|
353
|
-
/**
|
|
354
|
-
* Get the current recovery state for a specific asset, including recovery photos and notification recipients.
|
|
355
|
-
*
|
|
356
|
-
* <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
357
|
-
*
|
|
358
|
-
* To use this endpoint, select **Read Assets** under the Assets category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
359
|
-
*
|
|
360
|
-
* Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications
|
|
361
|
-
*
|
|
362
|
-
* - Samsara may change the structure of a preview API's interface without versioning or any notice to API users.
|
|
363
|
-
*
|
|
364
|
-
* - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).
|
|
365
|
-
*
|
|
366
|
-
*
|
|
367
|
-
* **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
368
|
-
*
|
|
369
|
-
* @param {Samsara.GetAssetRecoveryStateRequest} request
|
|
370
|
-
* @param {PreviewApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
371
|
-
*
|
|
372
|
-
* @throws {@link Samsara.UnauthorizedError}
|
|
373
|
-
* @throws {@link Samsara.NotFoundError}
|
|
374
|
-
* @throws {@link Samsara.MethodNotAllowedError}
|
|
375
|
-
* @throws {@link Samsara.TooManyRequestsError}
|
|
376
|
-
* @throws {@link Samsara.InternalServerError}
|
|
377
|
-
* @throws {@link Samsara.NotImplementedError}
|
|
378
|
-
* @throws {@link Samsara.BadGatewayError}
|
|
379
|
-
* @throws {@link Samsara.ServiceUnavailableError}
|
|
380
|
-
* @throws {@link Samsara.GatewayTimeoutError}
|
|
381
|
-
*
|
|
382
|
-
* @example
|
|
383
|
-
* await client.previewApIs.getAssetRecoveryState({
|
|
384
|
-
* id: "id"
|
|
385
|
-
* })
|
|
386
|
-
*/
|
|
387
|
-
getAssetRecoveryState(request, requestOptions) {
|
|
388
|
-
return core.HttpResponsePromise.fromPromise(this.__getAssetRecoveryState(request, requestOptions));
|
|
389
|
-
}
|
|
390
|
-
__getAssetRecoveryState(request, requestOptions) {
|
|
391
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
392
|
-
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
393
|
-
const { id } = request;
|
|
394
|
-
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
395
|
-
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Samsara-Version": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
396
|
-
const _response = yield core.fetcher({
|
|
397
|
-
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.SamsaraEnvironment.ProductionApi, `preview/fleet/assets/device-recovery/${core.url.encodePathParam(id)}/recovery-state`),
|
|
398
|
-
method: "GET",
|
|
399
|
-
headers: _headers,
|
|
400
|
-
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
401
|
-
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
402
|
-
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
403
|
-
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
404
|
-
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
405
|
-
logging: this._options.logging,
|
|
406
|
-
});
|
|
407
|
-
if (_response.ok) {
|
|
408
|
-
return {
|
|
409
|
-
data: _response.body,
|
|
410
|
-
rawResponse: _response.rawResponse,
|
|
411
|
-
};
|
|
412
|
-
}
|
|
413
|
-
if (_response.error.reason === "status-code") {
|
|
414
|
-
switch (_response.error.statusCode) {
|
|
415
|
-
case 401:
|
|
416
|
-
throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
417
|
-
case 404:
|
|
418
|
-
throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
|
|
419
|
-
case 405:
|
|
420
|
-
throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
|
|
421
|
-
case 429:
|
|
422
|
-
throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
423
|
-
case 500:
|
|
424
|
-
throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
|
|
425
|
-
case 501:
|
|
426
|
-
throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
427
|
-
case 502:
|
|
428
|
-
throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
|
|
429
|
-
case 503:
|
|
430
|
-
throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
431
|
-
case 504:
|
|
432
|
-
throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
|
|
433
|
-
default:
|
|
434
|
-
throw new errors.SamsaraError({
|
|
435
|
-
statusCode: _response.error.statusCode,
|
|
436
|
-
body: _response.error.body,
|
|
437
|
-
rawResponse: _response.rawResponse,
|
|
438
|
-
});
|
|
439
|
-
}
|
|
440
|
-
}
|
|
441
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/preview/fleet/assets/device-recovery/{id}/recovery-state");
|
|
442
|
-
});
|
|
443
|
-
}
|
|
444
352
|
/**
|
|
445
353
|
* Creates a short-lived auth token for a driver.
|
|
446
354
|
*
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {}
|
|
4
|
+
*/
|
|
5
|
+
export interface ListDeviceRecoveryMissingAssetsRequest {
|
|
6
|
+
/** If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results. */
|
|
7
|
+
after?: string;
|
|
8
|
+
}
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
export type { DeviceRecoveryMarkAssetMissingRequestBody } from "./DeviceRecoveryMarkAssetMissingRequestBody.js";
|
|
2
2
|
export { DeviceRecoveryRecoverAssetRequestBody } from "./DeviceRecoveryRecoverAssetRequestBody.js";
|
|
3
3
|
export type { DriversAuthTokenCreateDriverAuthTokenRequestBody } from "./DriversAuthTokenCreateDriverAuthTokenRequestBody.js";
|
|
4
|
-
export type {
|
|
5
|
-
export type { ListDeviceRecoveryAssetsRequest } from "./ListDeviceRecoveryAssetsRequest.js";
|
|
4
|
+
export type { ListDeviceRecoveryMissingAssetsRequest } from "./ListDeviceRecoveryMissingAssetsRequest.js";
|
|
6
5
|
export type { LockVehicleRequest } from "./LockVehicleRequest.js";
|
|
7
6
|
export type { UnlockVehicleRequest } from "./UnlockVehicleRequest.js";
|