@samsarahq/samsara 9.0.0 → 9.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/betaApIs/client/Client.d.ts +60 -1
- package/dist/cjs/api/resources/betaApIs/client/Client.js +177 -1
- package/dist/cjs/api/resources/betaApIs/client/requests/EngineImmobilizerUpdateEngineImmobilizerStateRequestBody.d.ts +1 -1
- package/dist/cjs/api/resources/betaApIs/client/requests/GetFunctionRunRequest.d.ts +13 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/GetFunctionRunRequest.js +3 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/GetReadingsHistoryRequest.d.ts +30 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/GetReadingsSnapshotRequest.d.ts +30 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/ListTachographLiveDataRequest.d.ts +16 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/ListTachographLiveDataRequest.js +3 -0
- package/dist/cjs/api/resources/betaApIs/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/media/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/media/client/Client.js +1 -1
- package/dist/cjs/api/resources/media/client/requests/MediaRetrievalPostMediaRetrievalRequestBody.d.ts +1 -1
- package/dist/cjs/api/resources/previewApIs/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/previewApIs/client/Client.js +1 -1
- package/dist/cjs/api/resources/previewApIs/client/requests/SafetyEventsV2PatchSafetyEventsV2BatchRequestBody.d.ts +1 -1
- package/dist/cjs/api/types/EntityListTachographLiveDataTypeResponseBody.d.ts +67 -0
- package/dist/cjs/api/types/EntityListTachographLiveDataTypeResponseBody.js +3 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataBadGatewayErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataBadGatewayErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataGatewayTimeoutErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataGatewayTimeoutErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataInternalServerErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataInternalServerErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataMethodNotAllowedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataMethodNotAllowedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataNotFoundErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataNotFoundErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataNotImplementedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataNotImplementedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataResponseBody.d.ts +6 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataResponseBody.js +3 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataServiceUnavailableErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataServiceUnavailableErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataTooManyRequestsErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataTooManyRequestsErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataUnauthorizedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataUnauthorizedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/FunctionRunContextResponseBody.d.ts +11 -0
- package/dist/cjs/api/types/FunctionRunContextResponseBody.js +3 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunBadGatewayErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunBadGatewayErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunGatewayTimeoutErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunGatewayTimeoutErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunInternalServerErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunInternalServerErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunMethodNotAllowedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunMethodNotAllowedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunNotFoundErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunNotFoundErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunNotImplementedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunNotImplementedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunResponseBody.d.ts +4 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunResponseBody.js +3 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunServiceUnavailableErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunServiceUnavailableErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunTooManyRequestsErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunTooManyRequestsErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunUnauthorizedErrorResponseBody.d.ts +9 -0
- package/dist/cjs/api/types/FunctionsGetFunctionRunUnauthorizedErrorResponseBody.js +3 -0
- package/dist/cjs/api/types/GetFunctionRunDetailResponseBody.d.ts +28 -0
- package/dist/cjs/api/types/GetFunctionRunDetailResponseBody.js +15 -0
- package/dist/cjs/api/types/index.d.ts +23 -0
- package/dist/cjs/api/types/index.js +23 -0
- 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 +60 -1
- package/dist/esm/api/resources/betaApIs/client/Client.mjs +177 -1
- package/dist/esm/api/resources/betaApIs/client/requests/EngineImmobilizerUpdateEngineImmobilizerStateRequestBody.d.mts +1 -1
- package/dist/esm/api/resources/betaApIs/client/requests/GetFunctionRunRequest.d.mts +13 -0
- package/dist/esm/api/resources/betaApIs/client/requests/GetFunctionRunRequest.mjs +2 -0
- package/dist/esm/api/resources/betaApIs/client/requests/GetReadingsHistoryRequest.d.mts +30 -0
- package/dist/esm/api/resources/betaApIs/client/requests/GetReadingsSnapshotRequest.d.mts +30 -0
- package/dist/esm/api/resources/betaApIs/client/requests/ListTachographLiveDataRequest.d.mts +16 -0
- package/dist/esm/api/resources/betaApIs/client/requests/ListTachographLiveDataRequest.mjs +2 -0
- package/dist/esm/api/resources/betaApIs/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/media/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/media/client/Client.mjs +1 -1
- package/dist/esm/api/resources/media/client/requests/MediaRetrievalPostMediaRetrievalRequestBody.d.mts +1 -1
- package/dist/esm/api/resources/previewApIs/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/previewApIs/client/Client.mjs +1 -1
- package/dist/esm/api/resources/previewApIs/client/requests/SafetyEventsV2PatchSafetyEventsV2BatchRequestBody.d.mts +1 -1
- package/dist/esm/api/types/EntityListTachographLiveDataTypeResponseBody.d.mts +67 -0
- package/dist/esm/api/types/EntityListTachographLiveDataTypeResponseBody.mjs +2 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataBadGatewayErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataBadGatewayErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataGatewayTimeoutErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataGatewayTimeoutErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataInternalServerErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataInternalServerErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataMethodNotAllowedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataMethodNotAllowedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataNotFoundErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataNotFoundErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataNotImplementedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataNotImplementedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataResponseBody.d.mts +6 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataResponseBody.mjs +2 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataServiceUnavailableErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataServiceUnavailableErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataTooManyRequestsErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataTooManyRequestsErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataUnauthorizedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/EntityTachographLiveDataRecordsServiceListTachographLiveDataUnauthorizedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/FunctionRunContextResponseBody.d.mts +11 -0
- package/dist/esm/api/types/FunctionRunContextResponseBody.mjs +2 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunBadGatewayErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunBadGatewayErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunGatewayTimeoutErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunGatewayTimeoutErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunInternalServerErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunInternalServerErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunMethodNotAllowedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunMethodNotAllowedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunNotFoundErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunNotFoundErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunNotImplementedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunNotImplementedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunResponseBody.d.mts +4 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunResponseBody.mjs +2 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunServiceUnavailableErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunServiceUnavailableErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunTooManyRequestsErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunTooManyRequestsErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunUnauthorizedErrorResponseBody.d.mts +9 -0
- package/dist/esm/api/types/FunctionsGetFunctionRunUnauthorizedErrorResponseBody.mjs +2 -0
- package/dist/esm/api/types/GetFunctionRunDetailResponseBody.d.mts +28 -0
- package/dist/esm/api/types/GetFunctionRunDetailResponseBody.mjs +12 -0
- package/dist/esm/api/types/index.d.mts +23 -0
- package/dist/esm/api/types/index.mjs +23 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +146 -3
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": "9.
|
|
48
|
-
"User-Agent": "@samsarahq/samsara/9.
|
|
47
|
+
"X-Fern-SDK-Version": "9.2.0",
|
|
48
|
+
"User-Agent": "@samsarahq/samsara/9.2.0",
|
|
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",
|
|
@@ -307,7 +307,7 @@ export declare class BetaApIsClient {
|
|
|
307
307
|
* id: 1000000,
|
|
308
308
|
* relayStates: [{
|
|
309
309
|
* id: "relay1",
|
|
310
|
-
* isOpen:
|
|
310
|
+
* isOpen: true
|
|
311
311
|
* }]
|
|
312
312
|
* })
|
|
313
313
|
*/
|
|
@@ -699,6 +699,34 @@ export declare class BetaApIsClient {
|
|
|
699
699
|
*/
|
|
700
700
|
listMaintenanceVendors(request?: Samsara.ListMaintenanceVendorsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.MaintenanceVendorsListMaintenanceVendorsResponseBody>;
|
|
701
701
|
private __listMaintenanceVendors;
|
|
702
|
+
/**
|
|
703
|
+
* Returns the latest live tachograph data for drivers, including working state and driving rest times, sourced from real-time telemetry.
|
|
704
|
+
*
|
|
705
|
+
* <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>).
|
|
706
|
+
*
|
|
707
|
+
* To use this endpoint, select **Read Tachograph (EU)** under the Compliance 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>
|
|
708
|
+
*
|
|
709
|
+
*
|
|
710
|
+
* **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.
|
|
711
|
+
*
|
|
712
|
+
* @param {Samsara.ListTachographLiveDataRequest} request
|
|
713
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
714
|
+
*
|
|
715
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
716
|
+
* @throws {@link Samsara.NotFoundError}
|
|
717
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
718
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
719
|
+
* @throws {@link Samsara.InternalServerError}
|
|
720
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
721
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
722
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
723
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
724
|
+
*
|
|
725
|
+
* @example
|
|
726
|
+
* await client.betaApIs.listTachographLiveData()
|
|
727
|
+
*/
|
|
728
|
+
listTachographLiveData(request?: Samsara.ListTachographLiveDataRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.EntityTachographLiveDataRecordsServiceListTachographLiveDataResponseBody>;
|
|
729
|
+
private __listTachographLiveData;
|
|
702
730
|
/**
|
|
703
731
|
* Get the engine immobilizer states of the queried vehicles. If a vehicle has never had an engine immobilizer connected, there won't be any state returned for that vehicle.
|
|
704
732
|
*
|
|
@@ -885,6 +913,37 @@ export declare class BetaApIsClient {
|
|
|
885
913
|
*/
|
|
886
914
|
startFunctionRun(request: Samsara.FunctionsStartFunctionRunRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.FunctionsStartFunctionRunResponseBody>;
|
|
887
915
|
private __startFunctionRun;
|
|
916
|
+
/**
|
|
917
|
+
* Retrieve the execution summary for a specific Function run, identified by the correlationId returned from the start run endpoint.
|
|
918
|
+
*
|
|
919
|
+
* <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>).
|
|
920
|
+
*
|
|
921
|
+
* To use this endpoint, select **Read Functions** under the Closed Beta 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>
|
|
922
|
+
*
|
|
923
|
+
*
|
|
924
|
+
* **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.
|
|
925
|
+
*
|
|
926
|
+
* @param {Samsara.GetFunctionRunRequest} request
|
|
927
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
928
|
+
*
|
|
929
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
930
|
+
* @throws {@link Samsara.NotFoundError}
|
|
931
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
932
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
933
|
+
* @throws {@link Samsara.InternalServerError}
|
|
934
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
935
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
936
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
937
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
938
|
+
*
|
|
939
|
+
* @example
|
|
940
|
+
* await client.betaApIs.getFunctionRun({
|
|
941
|
+
* name: "name",
|
|
942
|
+
* correlationId: "correlationId"
|
|
943
|
+
* })
|
|
944
|
+
*/
|
|
945
|
+
getFunctionRun(request: Samsara.GetFunctionRunRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.FunctionsGetFunctionRunResponseBody>;
|
|
946
|
+
private __getFunctionRun;
|
|
888
947
|
/**
|
|
889
948
|
* Update the shippingDocs field of an existing assignment.
|
|
890
949
|
*
|
|
@@ -898,7 +898,7 @@ class BetaApIsClient {
|
|
|
898
898
|
* id: 1000000,
|
|
899
899
|
* relayStates: [{
|
|
900
900
|
* id: "relay1",
|
|
901
|
-
* isOpen:
|
|
901
|
+
* isOpen: true
|
|
902
902
|
* }]
|
|
903
903
|
* })
|
|
904
904
|
*/
|
|
@@ -2118,6 +2118,96 @@ class BetaApIsClient {
|
|
|
2118
2118
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/fleet/maintenance/vendors");
|
|
2119
2119
|
});
|
|
2120
2120
|
}
|
|
2121
|
+
/**
|
|
2122
|
+
* Returns the latest live tachograph data for drivers, including working state and driving rest times, sourced from real-time telemetry.
|
|
2123
|
+
*
|
|
2124
|
+
* <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>).
|
|
2125
|
+
*
|
|
2126
|
+
* To use this endpoint, select **Read Tachograph (EU)** under the Compliance 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>
|
|
2127
|
+
*
|
|
2128
|
+
*
|
|
2129
|
+
* **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.
|
|
2130
|
+
*
|
|
2131
|
+
* @param {Samsara.ListTachographLiveDataRequest} request
|
|
2132
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
2133
|
+
*
|
|
2134
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
2135
|
+
* @throws {@link Samsara.NotFoundError}
|
|
2136
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
2137
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
2138
|
+
* @throws {@link Samsara.InternalServerError}
|
|
2139
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
2140
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
2141
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
2142
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
2143
|
+
*
|
|
2144
|
+
* @example
|
|
2145
|
+
* await client.betaApIs.listTachographLiveData()
|
|
2146
|
+
*/
|
|
2147
|
+
listTachographLiveData(request = {}, requestOptions) {
|
|
2148
|
+
return core.HttpResponsePromise.fromPromise(this.__listTachographLiveData(request, requestOptions));
|
|
2149
|
+
}
|
|
2150
|
+
__listTachographLiveData() {
|
|
2151
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
2152
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
2153
|
+
const { driverIds, vehicleIds, startTime, after, limit } = request;
|
|
2154
|
+
const _queryParams = {
|
|
2155
|
+
driverIds,
|
|
2156
|
+
vehicleIds,
|
|
2157
|
+
startTime,
|
|
2158
|
+
after,
|
|
2159
|
+
limit,
|
|
2160
|
+
};
|
|
2161
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
2162
|
+
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);
|
|
2163
|
+
const _response = yield core.fetcher({
|
|
2164
|
+
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, "fleet/tachograph-live-data/latest"),
|
|
2165
|
+
method: "GET",
|
|
2166
|
+
headers: _headers,
|
|
2167
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
2168
|
+
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,
|
|
2169
|
+
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,
|
|
2170
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
2171
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
2172
|
+
logging: this._options.logging,
|
|
2173
|
+
});
|
|
2174
|
+
if (_response.ok) {
|
|
2175
|
+
return {
|
|
2176
|
+
data: _response.body,
|
|
2177
|
+
rawResponse: _response.rawResponse,
|
|
2178
|
+
};
|
|
2179
|
+
}
|
|
2180
|
+
if (_response.error.reason === "status-code") {
|
|
2181
|
+
switch (_response.error.statusCode) {
|
|
2182
|
+
case 401:
|
|
2183
|
+
throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
2184
|
+
case 404:
|
|
2185
|
+
throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
|
|
2186
|
+
case 405:
|
|
2187
|
+
throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
|
|
2188
|
+
case 429:
|
|
2189
|
+
throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
2190
|
+
case 500:
|
|
2191
|
+
throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
|
|
2192
|
+
case 501:
|
|
2193
|
+
throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
2194
|
+
case 502:
|
|
2195
|
+
throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
|
|
2196
|
+
case 503:
|
|
2197
|
+
throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
2198
|
+
case 504:
|
|
2199
|
+
throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
|
|
2200
|
+
default:
|
|
2201
|
+
throw new errors.SamsaraError({
|
|
2202
|
+
statusCode: _response.error.statusCode,
|
|
2203
|
+
body: _response.error.body,
|
|
2204
|
+
rawResponse: _response.rawResponse,
|
|
2205
|
+
});
|
|
2206
|
+
}
|
|
2207
|
+
}
|
|
2208
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/fleet/tachograph-live-data/latest");
|
|
2209
|
+
});
|
|
2210
|
+
}
|
|
2121
2211
|
/**
|
|
2122
2212
|
* Get the engine immobilizer states of the queried vehicles. If a vehicle has never had an engine immobilizer connected, there won't be any state returned for that vehicle.
|
|
2123
2213
|
*
|
|
@@ -2648,6 +2738,92 @@ class BetaApIsClient {
|
|
|
2648
2738
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/functions/{name}/runs");
|
|
2649
2739
|
});
|
|
2650
2740
|
}
|
|
2741
|
+
/**
|
|
2742
|
+
* Retrieve the execution summary for a specific Function run, identified by the correlationId returned from the start run endpoint.
|
|
2743
|
+
*
|
|
2744
|
+
* <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>).
|
|
2745
|
+
*
|
|
2746
|
+
* To use this endpoint, select **Read Functions** under the Closed Beta 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>
|
|
2747
|
+
*
|
|
2748
|
+
*
|
|
2749
|
+
* **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.
|
|
2750
|
+
*
|
|
2751
|
+
* @param {Samsara.GetFunctionRunRequest} request
|
|
2752
|
+
* @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
2753
|
+
*
|
|
2754
|
+
* @throws {@link Samsara.UnauthorizedError}
|
|
2755
|
+
* @throws {@link Samsara.NotFoundError}
|
|
2756
|
+
* @throws {@link Samsara.MethodNotAllowedError}
|
|
2757
|
+
* @throws {@link Samsara.TooManyRequestsError}
|
|
2758
|
+
* @throws {@link Samsara.InternalServerError}
|
|
2759
|
+
* @throws {@link Samsara.NotImplementedError}
|
|
2760
|
+
* @throws {@link Samsara.BadGatewayError}
|
|
2761
|
+
* @throws {@link Samsara.ServiceUnavailableError}
|
|
2762
|
+
* @throws {@link Samsara.GatewayTimeoutError}
|
|
2763
|
+
*
|
|
2764
|
+
* @example
|
|
2765
|
+
* await client.betaApIs.getFunctionRun({
|
|
2766
|
+
* name: "name",
|
|
2767
|
+
* correlationId: "correlationId"
|
|
2768
|
+
* })
|
|
2769
|
+
*/
|
|
2770
|
+
getFunctionRun(request, requestOptions) {
|
|
2771
|
+
return core.HttpResponsePromise.fromPromise(this.__getFunctionRun(request, requestOptions));
|
|
2772
|
+
}
|
|
2773
|
+
__getFunctionRun(request, requestOptions) {
|
|
2774
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2775
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
2776
|
+
const { name, correlationId } = request;
|
|
2777
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
2778
|
+
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);
|
|
2779
|
+
const _response = yield core.fetcher({
|
|
2780
|
+
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, `functions/${core.url.encodePathParam(name)}/runs/${core.url.encodePathParam(correlationId)}`),
|
|
2781
|
+
method: "GET",
|
|
2782
|
+
headers: _headers,
|
|
2783
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
2784
|
+
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,
|
|
2785
|
+
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,
|
|
2786
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
2787
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
2788
|
+
logging: this._options.logging,
|
|
2789
|
+
});
|
|
2790
|
+
if (_response.ok) {
|
|
2791
|
+
return {
|
|
2792
|
+
data: _response.body,
|
|
2793
|
+
rawResponse: _response.rawResponse,
|
|
2794
|
+
};
|
|
2795
|
+
}
|
|
2796
|
+
if (_response.error.reason === "status-code") {
|
|
2797
|
+
switch (_response.error.statusCode) {
|
|
2798
|
+
case 401:
|
|
2799
|
+
throw new Samsara.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
2800
|
+
case 404:
|
|
2801
|
+
throw new Samsara.NotFoundError(_response.error.body, _response.rawResponse);
|
|
2802
|
+
case 405:
|
|
2803
|
+
throw new Samsara.MethodNotAllowedError(_response.error.body, _response.rawResponse);
|
|
2804
|
+
case 429:
|
|
2805
|
+
throw new Samsara.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
2806
|
+
case 500:
|
|
2807
|
+
throw new Samsara.InternalServerError(_response.error.body, _response.rawResponse);
|
|
2808
|
+
case 501:
|
|
2809
|
+
throw new Samsara.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
2810
|
+
case 502:
|
|
2811
|
+
throw new Samsara.BadGatewayError(_response.error.body, _response.rawResponse);
|
|
2812
|
+
case 503:
|
|
2813
|
+
throw new Samsara.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
2814
|
+
case 504:
|
|
2815
|
+
throw new Samsara.GatewayTimeoutError(_response.error.body, _response.rawResponse);
|
|
2816
|
+
default:
|
|
2817
|
+
throw new errors.SamsaraError({
|
|
2818
|
+
statusCode: _response.error.statusCode,
|
|
2819
|
+
body: _response.error.body,
|
|
2820
|
+
rawResponse: _response.rawResponse,
|
|
2821
|
+
});
|
|
2822
|
+
}
|
|
2823
|
+
}
|
|
2824
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/functions/{name}/runs/{correlationId}");
|
|
2825
|
+
});
|
|
2826
|
+
}
|
|
2651
2827
|
/**
|
|
2652
2828
|
* Update the shippingDocs field of an existing assignment.
|
|
2653
2829
|
*
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* name: "name",
|
|
5
|
+
* correlationId: "correlationId"
|
|
6
|
+
* }
|
|
7
|
+
*/
|
|
8
|
+
export interface GetFunctionRunRequest {
|
|
9
|
+
/** The name of the Function. */
|
|
10
|
+
name: string;
|
|
11
|
+
/** The unique correlationId of the Function run, returned by the start run endpoint. */
|
|
12
|
+
correlationId: string;
|
|
13
|
+
}
|
|
@@ -232,6 +232,36 @@ export interface GetReadingsHistoryRequest {
|
|
|
232
232
|
*
|
|
233
233
|
* </details>
|
|
234
234
|
*
|
|
235
|
+
* <details>
|
|
236
|
+
* <summary><strong>tireCondition</strong></summary>
|
|
237
|
+
*
|
|
238
|
+
* * `axle1tirefromleft1pressure` (Axle 1 Left Outer Tire Pressure): Pressure of the left outer tire on axle 1. (kilopascal)
|
|
239
|
+
* * `axle1tirefromleft1temperature` (Axle 1 Left Outer Tire Temperature): Temperature of the left outer tire on axle 1. (celsius)
|
|
240
|
+
* * `axle1tirefromleft2pressure` (Axle 1 Left Inner Tire Pressure): Pressure of the left inner tire on axle 1. (kilopascal)
|
|
241
|
+
* * `axle1tirefromleft2temperature` (Axle 1 Left Inner Tire Temperature): Temperature of the left inner tire on axle 1. (celsius)
|
|
242
|
+
* * `axle1tirefromleft3pressure` (Axle 1 Right Inner Tire Pressure): Pressure of the right inner tire on axle 1. (kilopascal)
|
|
243
|
+
* * `axle1tirefromleft3temperature` (Axle 1 Right Inner Tire Temperature): Temperature of the right inner tire on axle 1. (celsius)
|
|
244
|
+
* * `axle1tirefromleft4pressure` (Axle 1 Right Outer Tire Pressure): Pressure of the right outer tire on axle 1. (kilopascal)
|
|
245
|
+
* * `axle1tirefromleft4temperature` (Axle 1 Right Outer Tire Temperature): Temperature of the right outer tire on axle 1. (celsius)
|
|
246
|
+
* * `axle2tirefromleft1pressure` (Axle 2 Left Outer Tire Pressure): Pressure of the left outer tire on axle 2. (kilopascal)
|
|
247
|
+
* * `axle2tirefromleft1temperature` (Axle 2 Left Outer Tire Temperature): Temperature of the left outer tire on axle 2. (celsius)
|
|
248
|
+
* * `axle2tirefromleft2pressure` (Axle 2 Left Inner Tire Pressure): Pressure of the left inner tire on axle 2. (kilopascal)
|
|
249
|
+
* * `axle2tirefromleft2temperature` (Axle 2 Left Inner Tire Temperature): Temperature of the left inner tire on axle 2. (celsius)
|
|
250
|
+
* * `axle2tirefromleft3pressure` (Axle 2 Right Inner Tire Pressure): Pressure of the right inner tire on axle 2. (kilopascal)
|
|
251
|
+
* * `axle2tirefromleft3temperature` (Axle 2 Right Inner Tire Temperature): Temperature of the right inner tire on axle 2. (celsius)
|
|
252
|
+
* * `axle2tirefromleft4pressure` (Axle 2 Right Outer Tire Pressure): Pressure of the right outer tire on axle 2. (kilopascal)
|
|
253
|
+
* * `axle2tirefromleft4temperature` (Axle 2 Right Outer Tire Temperature): Temperature of the right outer tire on axle 2. (celsius)
|
|
254
|
+
* * `axle3tirefromleft1pressure` (Axle 3 Left Outer Tire Pressure): Pressure of the left outer tire on axle 3. (kilopascal)
|
|
255
|
+
* * `axle3tirefromleft1temperature` (Axle 3 Left Outer Tire Temperature): Temperature of the left outer tire on axle 3. (celsius)
|
|
256
|
+
* * `axle3tirefromleft2pressure` (Axle 3 Left Inner Tire Pressure): Pressure of the left inner tire on axle 3. (kilopascal)
|
|
257
|
+
* * `axle3tirefromleft2temperature` (Axle 3 Left Inner Tire Temperature): Temperature of the left inner tire on axle 3. (celsius)
|
|
258
|
+
* * `axle3tirefromleft3pressure` (Axle 3 Right Inner Tire Pressure): Pressure of the right inner tire on axle 3. (kilopascal)
|
|
259
|
+
* * `axle3tirefromleft3temperature` (Axle 3 Right Inner Tire Temperature): Temperature of the right inner tire on axle 3. (celsius)
|
|
260
|
+
* * `axle3tirefromleft4pressure` (Axle 3 Right Outer Tire Pressure): Pressure of the right outer tire on axle 3. (kilopascal)
|
|
261
|
+
* * `axle3tirefromleft4temperature` (Axle 3 Right Outer Tire Temperature): Temperature of the right outer tire on axle 3. (celsius)
|
|
262
|
+
*
|
|
263
|
+
* </details>
|
|
264
|
+
*
|
|
235
265
|
* **Note:** This is not an exhaustive list. Your organization may have access to additional readings based on enabled features or custom configurations. Use the `/readings/definitions` endpoint to retrieve all available reading IDs for your organization.
|
|
236
266
|
*/
|
|
237
267
|
readingId: string;
|
|
@@ -232,6 +232,36 @@ export interface GetReadingsSnapshotRequest {
|
|
|
232
232
|
*
|
|
233
233
|
* </details>
|
|
234
234
|
*
|
|
235
|
+
* <details>
|
|
236
|
+
* <summary><strong>tireCondition</strong></summary>
|
|
237
|
+
*
|
|
238
|
+
* * `axle1tirefromleft1pressure` (Axle 1 Left Outer Tire Pressure): Pressure of the left outer tire on axle 1. (kilopascal)
|
|
239
|
+
* * `axle1tirefromleft1temperature` (Axle 1 Left Outer Tire Temperature): Temperature of the left outer tire on axle 1. (celsius)
|
|
240
|
+
* * `axle1tirefromleft2pressure` (Axle 1 Left Inner Tire Pressure): Pressure of the left inner tire on axle 1. (kilopascal)
|
|
241
|
+
* * `axle1tirefromleft2temperature` (Axle 1 Left Inner Tire Temperature): Temperature of the left inner tire on axle 1. (celsius)
|
|
242
|
+
* * `axle1tirefromleft3pressure` (Axle 1 Right Inner Tire Pressure): Pressure of the right inner tire on axle 1. (kilopascal)
|
|
243
|
+
* * `axle1tirefromleft3temperature` (Axle 1 Right Inner Tire Temperature): Temperature of the right inner tire on axle 1. (celsius)
|
|
244
|
+
* * `axle1tirefromleft4pressure` (Axle 1 Right Outer Tire Pressure): Pressure of the right outer tire on axle 1. (kilopascal)
|
|
245
|
+
* * `axle1tirefromleft4temperature` (Axle 1 Right Outer Tire Temperature): Temperature of the right outer tire on axle 1. (celsius)
|
|
246
|
+
* * `axle2tirefromleft1pressure` (Axle 2 Left Outer Tire Pressure): Pressure of the left outer tire on axle 2. (kilopascal)
|
|
247
|
+
* * `axle2tirefromleft1temperature` (Axle 2 Left Outer Tire Temperature): Temperature of the left outer tire on axle 2. (celsius)
|
|
248
|
+
* * `axle2tirefromleft2pressure` (Axle 2 Left Inner Tire Pressure): Pressure of the left inner tire on axle 2. (kilopascal)
|
|
249
|
+
* * `axle2tirefromleft2temperature` (Axle 2 Left Inner Tire Temperature): Temperature of the left inner tire on axle 2. (celsius)
|
|
250
|
+
* * `axle2tirefromleft3pressure` (Axle 2 Right Inner Tire Pressure): Pressure of the right inner tire on axle 2. (kilopascal)
|
|
251
|
+
* * `axle2tirefromleft3temperature` (Axle 2 Right Inner Tire Temperature): Temperature of the right inner tire on axle 2. (celsius)
|
|
252
|
+
* * `axle2tirefromleft4pressure` (Axle 2 Right Outer Tire Pressure): Pressure of the right outer tire on axle 2. (kilopascal)
|
|
253
|
+
* * `axle2tirefromleft4temperature` (Axle 2 Right Outer Tire Temperature): Temperature of the right outer tire on axle 2. (celsius)
|
|
254
|
+
* * `axle3tirefromleft1pressure` (Axle 3 Left Outer Tire Pressure): Pressure of the left outer tire on axle 3. (kilopascal)
|
|
255
|
+
* * `axle3tirefromleft1temperature` (Axle 3 Left Outer Tire Temperature): Temperature of the left outer tire on axle 3. (celsius)
|
|
256
|
+
* * `axle3tirefromleft2pressure` (Axle 3 Left Inner Tire Pressure): Pressure of the left inner tire on axle 3. (kilopascal)
|
|
257
|
+
* * `axle3tirefromleft2temperature` (Axle 3 Left Inner Tire Temperature): Temperature of the left inner tire on axle 3. (celsius)
|
|
258
|
+
* * `axle3tirefromleft3pressure` (Axle 3 Right Inner Tire Pressure): Pressure of the right inner tire on axle 3. (kilopascal)
|
|
259
|
+
* * `axle3tirefromleft3temperature` (Axle 3 Right Inner Tire Temperature): Temperature of the right inner tire on axle 3. (celsius)
|
|
260
|
+
* * `axle3tirefromleft4pressure` (Axle 3 Right Outer Tire Pressure): Pressure of the right outer tire on axle 3. (kilopascal)
|
|
261
|
+
* * `axle3tirefromleft4temperature` (Axle 3 Right Outer Tire Temperature): Temperature of the right outer tire on axle 3. (celsius)
|
|
262
|
+
*
|
|
263
|
+
* </details>
|
|
264
|
+
*
|
|
235
265
|
* **Note:** This is not an exhaustive list. Your organization may have access to additional readings based on enabled features or custom configurations. Use the `/readings/definitions` endpoint to retrieve all available reading IDs for your organization.
|
|
236
266
|
*/
|
|
237
267
|
readingIds: string;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {}
|
|
4
|
+
*/
|
|
5
|
+
export interface ListTachographLiveDataRequest {
|
|
6
|
+
/** A filter on the data based on this comma-separated list of Driver ID values. */
|
|
7
|
+
driverIds?: string;
|
|
8
|
+
/** A filter on the data based on this comma-separated list of Vehicle ID values. */
|
|
9
|
+
vehicleIds?: string;
|
|
10
|
+
/** A start time in RFC 3339 format. Millisecond precision and timezones are supported. Defaults to 1 hour before now if not provided. */
|
|
11
|
+
startTime?: string;
|
|
12
|
+
/** 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. */
|
|
13
|
+
after?: string;
|
|
14
|
+
/** The limit for how many objects will be in the response. Default and max for this value is 200 objects. */
|
|
15
|
+
limit?: number;
|
|
16
|
+
}
|
|
@@ -19,6 +19,7 @@ export type { GetDevicesRequest } from "./GetDevicesRequest.js";
|
|
|
19
19
|
export type { GetDriverEfficiencyRequest } from "./GetDriverEfficiencyRequest.js";
|
|
20
20
|
export type { GetEngineImmobilizerStatesRequest } from "./GetEngineImmobilizerStatesRequest.js";
|
|
21
21
|
export type { GetFunctionRequest } from "./GetFunctionRequest.js";
|
|
22
|
+
export type { GetFunctionRunRequest } from "./GetFunctionRunRequest.js";
|
|
22
23
|
export type { GetHosEldEventsRequest } from "./GetHosEldEventsRequest.js";
|
|
23
24
|
export type { GetJobsRequest } from "./GetJobsRequest.js";
|
|
24
25
|
export type { GetQualificationRecordsRequest } from "./GetQualificationRecordsRequest.js";
|
|
@@ -46,6 +47,7 @@ export type { ListReadingsDefinitionsRequest } from "./ListReadingsDefinitionsRe
|
|
|
46
47
|
export type { ListRidershipAccountsRequest } from "./ListRidershipAccountsRequest.js";
|
|
47
48
|
export type { ListRidershipPassengersRequest } from "./ListRidershipPassengersRequest.js";
|
|
48
49
|
export type { ListRidershipRouteSetupsRequest } from "./ListRidershipRouteSetupsRequest.js";
|
|
50
|
+
export type { ListTachographLiveDataRequest } from "./ListTachographLiveDataRequest.js";
|
|
49
51
|
export type { ListVendorCategoriesRequest } from "./ListVendorCategoriesRequest.js";
|
|
50
52
|
export type { PlanOrdersCreatePlanOrdersRequestBody } from "./PlanOrdersCreatePlanOrdersRequestBody.js";
|
|
51
53
|
export type { QualificationsArchiveQualificationRecordRequestBody } from "./QualificationsArchiveQualificationRecordRequestBody.js";
|
|
@@ -98,7 +98,7 @@ export declare class MediaClient {
|
|
|
98
98
|
* @example
|
|
99
99
|
* await client.media.postMediaRetrieval({
|
|
100
100
|
* endTime: "2019-06-13T19:08:55Z",
|
|
101
|
-
* inputs: ["dashcamRoadFacing", "dashcamRoadFacing"
|
|
101
|
+
* inputs: ["dashcamRoadFacing", "dashcamRoadFacing"],
|
|
102
102
|
* mediaType: "image",
|
|
103
103
|
* startTime: "2019-06-13T19:08:25Z",
|
|
104
104
|
* vehicleId: "1234"
|
|
@@ -274,7 +274,7 @@ class MediaClient {
|
|
|
274
274
|
* @example
|
|
275
275
|
* await client.media.postMediaRetrieval({
|
|
276
276
|
* endTime: "2019-06-13T19:08:55Z",
|
|
277
|
-
* inputs: ["dashcamRoadFacing", "dashcamRoadFacing"
|
|
277
|
+
* inputs: ["dashcamRoadFacing", "dashcamRoadFacing"],
|
|
278
278
|
* mediaType: "image",
|
|
279
279
|
* startTime: "2019-06-13T19:08:25Z",
|
|
280
280
|
* vehicleId: "1234"
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* @example
|
|
3
3
|
* {
|
|
4
4
|
* endTime: "2019-06-13T19:08:55Z",
|
|
5
|
-
* inputs: ["dashcamRoadFacing", "dashcamRoadFacing"
|
|
5
|
+
* inputs: ["dashcamRoadFacing", "dashcamRoadFacing"],
|
|
6
6
|
* mediaType: "image",
|
|
7
7
|
* startTime: "2019-06-13T19:08:25Z",
|
|
8
8
|
* vehicleId: "1234"
|
|
@@ -149,7 +149,7 @@ export declare class PreviewApIsClient {
|
|
|
149
149
|
*
|
|
150
150
|
* @example
|
|
151
151
|
* await client.previewApIs.patchSafetyEventsV2Batch({
|
|
152
|
-
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
152
|
+
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
153
153
|
* })
|
|
154
154
|
*/
|
|
155
155
|
patchSafetyEventsV2Batch(request: Samsara.SafetyEventsV2PatchSafetyEventsV2BatchRequestBody, requestOptions?: PreviewApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.SafetyEventsV2PatchSafetyEventsV2BatchResponseBody>;
|
|
@@ -355,7 +355,7 @@ class PreviewApIsClient {
|
|
|
355
355
|
*
|
|
356
356
|
* @example
|
|
357
357
|
* await client.previewApIs.patchSafetyEventsV2Batch({
|
|
358
|
-
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
358
|
+
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
359
359
|
* })
|
|
360
360
|
*/
|
|
361
361
|
patchSafetyEventsV2Batch(request, requestOptions) {
|
|
@@ -2,7 +2,7 @@ import type * as Samsara from "../../../../index.js";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
-
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
5
|
+
* safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
|
|
6
6
|
* }
|
|
7
7
|
*/
|
|
8
8
|
export interface SafetyEventsV2PatchSafetyEventsV2BatchRequestBody {
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TachographLiveData object
|
|
3
|
+
*/
|
|
4
|
+
export interface EntityListTachographLiveDataTypeResponseBody {
|
|
5
|
+
/** The driver's cumulated driving time across the previous and current week, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
6
|
+
cumulatedDrivingTimePreviousAndCurrentWeekMinute?: number | undefined;
|
|
7
|
+
/** The driver's cumulative break time, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
8
|
+
cumulativeBreakTimeMinute?: number | undefined;
|
|
9
|
+
/** The driver's current daily driving time, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
10
|
+
currentDailyDrivingTimeMinute?: number | undefined;
|
|
11
|
+
/** The duration of the driver's currently selected activity, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
12
|
+
currentDurationOfSelectedActivityMinute?: number | undefined;
|
|
13
|
+
/** The driver's current weekly driving time, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
14
|
+
currentWeeklyDrivingTimeMinute?: number | undefined;
|
|
15
|
+
/** Samsara ID for the driver. */
|
|
16
|
+
driverId?: string | undefined;
|
|
17
|
+
/** The expected duration of the driver's next break or rest period, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
18
|
+
durationOfNextBreakRestMinute?: number | undefined;
|
|
19
|
+
/** The expected duration of the driver's next driving period, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
20
|
+
durationOfNextDrivingPeriodMinute?: number | undefined;
|
|
21
|
+
/** The timestamp marking the end of the driver's last daily rest period, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
22
|
+
endOfLastDailyRestPeriod?: string | undefined;
|
|
23
|
+
/** The timestamp marking the end of the driver's last weekly rest period, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
24
|
+
endOfLastWeeklyRestPeriod?: string | undefined;
|
|
25
|
+
/** The timestamp when the tachograph reading was measured. */
|
|
26
|
+
happenedAtTime?: string | undefined;
|
|
27
|
+
/** The maximum allowed daily driving time for the driver, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
28
|
+
maximumDailyDrivingTimeMinute?: number | undefined;
|
|
29
|
+
/** The minimum required daily rest duration for the driver, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
30
|
+
minimumDailyRestMinute?: number | undefined;
|
|
31
|
+
/** The minimum required weekly rest duration for the driver, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
32
|
+
minimumWeeklyRestMinute?: number | undefined;
|
|
33
|
+
/** The number of times the driver has exceeded the 9-hour daily driving time limit, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
34
|
+
numberOfTimes9hDailyDrivingTimesExceeded?: number | undefined;
|
|
35
|
+
/** The number of reduced daily rest periods the driver has used, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
36
|
+
numberOfUsedReducedDailyRestPeriods?: number | undefined;
|
|
37
|
+
/** Open rest compensation owed from the second week before last, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
38
|
+
openCompensationInSecondWeekBeforeLastMinute?: number | undefined;
|
|
39
|
+
/** Open rest compensation owed from the last week, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
40
|
+
openCompensationInTheLastWeekMinute?: number | undefined;
|
|
41
|
+
/** Open rest compensation owed from the week before last, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
42
|
+
openCompensationInWeekBeforeLastMinute?: number | undefined;
|
|
43
|
+
/** The driver's remaining driving time across the current two-week period, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
44
|
+
remaining2WeeksDrivingTimeMinute?: number | undefined;
|
|
45
|
+
/** The driver's remaining current continuous driving time before a break is required, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
46
|
+
remainingCurrentDrivingTimeMinute?: number | undefined;
|
|
47
|
+
/** The driver's remaining driving time for the current week, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
48
|
+
remainingDrivingTimeOfCurrentWeekMinute?: number | undefined;
|
|
49
|
+
/** The driver's remaining driving time on the current shift, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
50
|
+
remainingDrivingTimeOnCurrentShiftMinute?: number | undefined;
|
|
51
|
+
/** Time remaining in the driver's current break or rest period, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
52
|
+
remainingTimeOfCurrentBreakRestMinute?: number | undefined;
|
|
53
|
+
/** Time remaining until the driver's next required break or rest period, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
54
|
+
remainingTimeUntilNextBreakOrRestMinute?: number | undefined;
|
|
55
|
+
/** The tachograph card number for the driver. */
|
|
56
|
+
tachographCardNumber?: string | undefined;
|
|
57
|
+
/** Time remaining until the driver must begin a new daily rest period, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
58
|
+
timeLeftUntilNewDailyRestPeriodMinute?: number | undefined;
|
|
59
|
+
/** Time remaining until the driver must begin a new weekly rest period, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
60
|
+
timeLeftUntilNewWeeklyRestPeriodMinute?: number | undefined;
|
|
61
|
+
/** Time remaining until the driver's next driving period can begin, as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
62
|
+
timeLeftUntilNextDrivingPeriodMinute?: number | undefined;
|
|
63
|
+
/** Samsara ID for the vehicle associated with the live tachograph data. */
|
|
64
|
+
vehicleId?: string | undefined;
|
|
65
|
+
/** The current working state of the driver (e.g. Rest, Availability, Work, Driving), as defined by ISO 16844-7 (Tachograph - Digital data interface). */
|
|
66
|
+
workingState?: string | undefined;
|
|
67
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bad Gateway
|
|
3
|
+
*/
|
|
4
|
+
export interface EntityTachographLiveDataRecordsServiceListTachographLiveDataBadGatewayErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Gateway timeout
|
|
3
|
+
*/
|
|
4
|
+
export interface EntityTachographLiveDataRecordsServiceListTachographLiveDataGatewayTimeoutErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An internal server error occurred
|
|
3
|
+
*/
|
|
4
|
+
export interface EntityTachographLiveDataRecordsServiceListTachographLiveDataInternalServerErrorResponseBody {
|
|
5
|
+
/** Message of error */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The request ID; used when reaching out to support for issues with requests. */
|
|
8
|
+
requestId: string;
|
|
9
|
+
}
|