@samsarahq/samsara 10.3.4 → 11.1.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 +20 -12
- package/dist/cjs/api/resources/betaApIs/client/Client.js +20 -12
- package/dist/cjs/api/resources/previewApIs/client/requests/SafetyEventsV2PatchSafetyEventsV2BatchRequestBody.d.ts +4 -2
- package/dist/cjs/api/resources/previewApIs/client/requests/SafetyEventsV2PatchSafetyEventsV2BatchRequestBody.js +4 -2
- 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 +20 -12
- package/dist/esm/api/resources/betaApIs/client/Client.mjs +20 -12
- package/dist/esm/api/resources/previewApIs/client/requests/SafetyEventsV2PatchSafetyEventsV2BatchRequestBody.d.mts +4 -2
- package/dist/esm/api/resources/previewApIs/client/requests/SafetyEventsV2PatchSafetyEventsV2BatchRequestBody.mjs +4 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +20 -12
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": "11.1.0",
|
|
48
|
+
"User-Agent": "@samsarahq/samsara/11.1.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",
|
|
@@ -695,7 +695,7 @@ export declare class BetaApIsClient {
|
|
|
695
695
|
*
|
|
696
696
|
* <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>).
|
|
697
697
|
*
|
|
698
|
-
* To use this endpoint, select **Write Functions** under the
|
|
698
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
699
699
|
*
|
|
700
700
|
*
|
|
701
701
|
* **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.
|
|
@@ -728,7 +728,7 @@ export declare class BetaApIsClient {
|
|
|
728
728
|
*
|
|
729
729
|
* <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>).
|
|
730
730
|
*
|
|
731
|
-
* To use this endpoint, select **Read Functions** under the
|
|
731
|
+
* To use this endpoint, select **Read Functions** under the Functions 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>
|
|
732
732
|
*
|
|
733
733
|
*
|
|
734
734
|
* **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.
|
|
@@ -758,7 +758,7 @@ export declare class BetaApIsClient {
|
|
|
758
758
|
*
|
|
759
759
|
* <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>).
|
|
760
760
|
*
|
|
761
|
-
* To use this endpoint, select **Write Functions** under the
|
|
761
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
762
762
|
*
|
|
763
763
|
*
|
|
764
764
|
* **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.
|
|
@@ -788,7 +788,7 @@ export declare class BetaApIsClient {
|
|
|
788
788
|
*
|
|
789
789
|
* <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>).
|
|
790
790
|
*
|
|
791
|
-
* To use this endpoint, select **Write Functions** under the
|
|
791
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
792
792
|
*
|
|
793
793
|
*
|
|
794
794
|
* **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.
|
|
@@ -819,7 +819,7 @@ export declare class BetaApIsClient {
|
|
|
819
819
|
*
|
|
820
820
|
* <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>).
|
|
821
821
|
*
|
|
822
|
-
* To use this endpoint, select **Write Functions** under the
|
|
822
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
823
823
|
*
|
|
824
824
|
*
|
|
825
825
|
* **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.
|
|
@@ -849,7 +849,7 @@ export declare class BetaApIsClient {
|
|
|
849
849
|
*
|
|
850
850
|
* <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>).
|
|
851
851
|
*
|
|
852
|
-
* To use this endpoint, select **Read Functions** under the
|
|
852
|
+
* To use this endpoint, select **Read Functions** under the Functions 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>
|
|
853
853
|
*
|
|
854
854
|
*
|
|
855
855
|
* **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.
|
|
@@ -881,7 +881,7 @@ export declare class BetaApIsClient {
|
|
|
881
881
|
*
|
|
882
882
|
* <b>Rate limit:</b> 2 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
883
883
|
*
|
|
884
|
-
* To use this endpoint, select **Write Functions** under the
|
|
884
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
885
885
|
*
|
|
886
886
|
*
|
|
887
887
|
* **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.
|
|
@@ -912,7 +912,7 @@ export declare class BetaApIsClient {
|
|
|
912
912
|
*
|
|
913
913
|
* <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>).
|
|
914
914
|
*
|
|
915
|
-
* To use this endpoint, select **Read Functions** under the
|
|
915
|
+
* To use this endpoint, select **Read Functions** under the Functions 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>
|
|
916
916
|
*
|
|
917
917
|
*
|
|
918
918
|
* **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.
|
|
@@ -1296,7 +1296,9 @@ export declare class BetaApIsClient {
|
|
|
1296
1296
|
/**
|
|
1297
1297
|
* Ingest new readings. This endpoint allows the ingestion of batches of readings.
|
|
1298
1298
|
*
|
|
1299
|
-
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API. When ingesting location data, the readingID 'location' must be used and the value object must contain at least the following fields: 'speed', 'latitude', 'longitude'.
|
|
1299
|
+
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API. When ingesting location data, the readingID 'location' must be used and the value object must contain at least the following fields: 'speed', 'latitude', 'longitude'.
|
|
1300
|
+
*
|
|
1301
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
1300
1302
|
*
|
|
1301
1303
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
1302
1304
|
*
|
|
@@ -1334,7 +1336,9 @@ export declare class BetaApIsClient {
|
|
|
1334
1336
|
postReadings(request: Samsara.ReadingsPostReadingsRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
1335
1337
|
private __postReadings;
|
|
1336
1338
|
/**
|
|
1337
|
-
* An introspection endpoint for discovering the set of readings including their name, description, data type, unit, and other metadata.
|
|
1339
|
+
* An introspection endpoint for discovering the set of readings including their name, description, data type, unit, and other metadata.
|
|
1340
|
+
*
|
|
1341
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
1338
1342
|
*
|
|
1339
1343
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
1340
1344
|
*
|
|
@@ -1362,7 +1366,9 @@ export declare class BetaApIsClient {
|
|
|
1362
1366
|
listReadingsDefinitions(request?: Samsara.ListReadingsDefinitionsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.ReadingsListReadingsDefinitionsResponseBody>;
|
|
1363
1367
|
private __listReadingsDefinitions;
|
|
1364
1368
|
/**
|
|
1365
|
-
* Get the values of a reading for a set of entities within the specified time range. Returns a paginated response with data for the specified resource IDs where startTime <= happenedAtTime < endTime. If endTime is not set, the time of the request is used as the endTime.
|
|
1369
|
+
* Get the values of a reading for a set of entities within the specified time range. Returns a paginated response with data for the specified resource IDs where startTime <= happenedAtTime < endTime. If endTime is not set, the time of the request is used as the endTime.
|
|
1370
|
+
*
|
|
1371
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
1366
1372
|
*
|
|
1367
1373
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
1368
1374
|
*
|
|
@@ -1393,7 +1399,9 @@ export declare class BetaApIsClient {
|
|
|
1393
1399
|
getReadingsHistory(request: Samsara.GetReadingsHistoryRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.ReadingsGetReadingsHistoryResponseBody>;
|
|
1394
1400
|
private __getReadingsHistory;
|
|
1395
1401
|
/**
|
|
1396
|
-
* An endpoint to get the last value of a reading for a set of entities at the specified time.
|
|
1402
|
+
* An endpoint to get the last value of a reading for a set of entities at the specified time.
|
|
1403
|
+
*
|
|
1404
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
1397
1405
|
*
|
|
1398
1406
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
1399
1407
|
*
|
|
@@ -2103,7 +2103,7 @@ class BetaApIsClient {
|
|
|
2103
2103
|
*
|
|
2104
2104
|
* <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>).
|
|
2105
2105
|
*
|
|
2106
|
-
* To use this endpoint, select **Write Functions** under the
|
|
2106
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
2107
2107
|
*
|
|
2108
2108
|
*
|
|
2109
2109
|
* **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.
|
|
@@ -2193,7 +2193,7 @@ class BetaApIsClient {
|
|
|
2193
2193
|
*
|
|
2194
2194
|
* <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>).
|
|
2195
2195
|
*
|
|
2196
|
-
* To use this endpoint, select **Read Functions** under the
|
|
2196
|
+
* To use this endpoint, select **Read Functions** under the Functions 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>
|
|
2197
2197
|
*
|
|
2198
2198
|
*
|
|
2199
2199
|
* **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.
|
|
@@ -2278,7 +2278,7 @@ class BetaApIsClient {
|
|
|
2278
2278
|
*
|
|
2279
2279
|
* <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>).
|
|
2280
2280
|
*
|
|
2281
|
-
* To use this endpoint, select **Write Functions** under the
|
|
2281
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
2282
2282
|
*
|
|
2283
2283
|
*
|
|
2284
2284
|
* **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.
|
|
@@ -2360,7 +2360,7 @@ class BetaApIsClient {
|
|
|
2360
2360
|
*
|
|
2361
2361
|
* <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>).
|
|
2362
2362
|
*
|
|
2363
|
-
* To use this endpoint, select **Write Functions** under the
|
|
2363
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
2364
2364
|
*
|
|
2365
2365
|
*
|
|
2366
2366
|
* **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.
|
|
@@ -2449,7 +2449,7 @@ class BetaApIsClient {
|
|
|
2449
2449
|
*
|
|
2450
2450
|
* <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>).
|
|
2451
2451
|
*
|
|
2452
|
-
* To use this endpoint, select **Write Functions** under the
|
|
2452
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
2453
2453
|
*
|
|
2454
2454
|
*
|
|
2455
2455
|
* **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.
|
|
@@ -2534,7 +2534,7 @@ class BetaApIsClient {
|
|
|
2534
2534
|
*
|
|
2535
2535
|
* <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>).
|
|
2536
2536
|
*
|
|
2537
|
-
* To use this endpoint, select **Read Functions** under the
|
|
2537
|
+
* To use this endpoint, select **Read Functions** under the Functions 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>
|
|
2538
2538
|
*
|
|
2539
2539
|
*
|
|
2540
2540
|
* **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.
|
|
@@ -2628,7 +2628,7 @@ class BetaApIsClient {
|
|
|
2628
2628
|
*
|
|
2629
2629
|
* <b>Rate limit:</b> 2 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
2630
2630
|
*
|
|
2631
|
-
* To use this endpoint, select **Write Functions** under the
|
|
2631
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
2632
2632
|
*
|
|
2633
2633
|
*
|
|
2634
2634
|
* **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.
|
|
@@ -2717,7 +2717,7 @@ class BetaApIsClient {
|
|
|
2717
2717
|
*
|
|
2718
2718
|
* <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>).
|
|
2719
2719
|
*
|
|
2720
|
-
* To use this endpoint, select **Read Functions** under the
|
|
2720
|
+
* To use this endpoint, select **Read Functions** under the Functions 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>
|
|
2721
2721
|
*
|
|
2722
2722
|
*
|
|
2723
2723
|
* **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.
|
|
@@ -3799,7 +3799,9 @@ class BetaApIsClient {
|
|
|
3799
3799
|
/**
|
|
3800
3800
|
* Ingest new readings. This endpoint allows the ingestion of batches of readings.
|
|
3801
3801
|
*
|
|
3802
|
-
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API. When ingesting location data, the readingID 'location' must be used and the value object must contain at least the following fields: 'speed', 'latitude', 'longitude'.
|
|
3802
|
+
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API. When ingesting location data, the readingID 'location' must be used and the value object must contain at least the following fields: 'speed', 'latitude', 'longitude'.
|
|
3803
|
+
*
|
|
3804
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
3803
3805
|
*
|
|
3804
3806
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
3805
3807
|
*
|
|
@@ -3891,7 +3893,9 @@ class BetaApIsClient {
|
|
|
3891
3893
|
});
|
|
3892
3894
|
}
|
|
3893
3895
|
/**
|
|
3894
|
-
* An introspection endpoint for discovering the set of readings including their name, description, data type, unit, and other metadata.
|
|
3896
|
+
* An introspection endpoint for discovering the set of readings including their name, description, data type, unit, and other metadata.
|
|
3897
|
+
*
|
|
3898
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
3895
3899
|
*
|
|
3896
3900
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
3897
3901
|
*
|
|
@@ -3979,7 +3983,9 @@ class BetaApIsClient {
|
|
|
3979
3983
|
});
|
|
3980
3984
|
}
|
|
3981
3985
|
/**
|
|
3982
|
-
* Get the values of a reading for a set of entities within the specified time range. Returns a paginated response with data for the specified resource IDs where startTime <= happenedAtTime < endTime. If endTime is not set, the time of the request is used as the endTime.
|
|
3986
|
+
* Get the values of a reading for a set of entities within the specified time range. Returns a paginated response with data for the specified resource IDs where startTime <= happenedAtTime < endTime. If endTime is not set, the time of the request is used as the endTime.
|
|
3987
|
+
*
|
|
3988
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
3983
3989
|
*
|
|
3984
3990
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
3985
3991
|
*
|
|
@@ -4076,7 +4082,9 @@ class BetaApIsClient {
|
|
|
4076
4082
|
});
|
|
4077
4083
|
}
|
|
4078
4084
|
/**
|
|
4079
|
-
* An endpoint to get the last value of a reading for a set of entities at the specified time.
|
|
4085
|
+
* An endpoint to get the last value of a reading for a set of entities at the specified time.
|
|
4086
|
+
*
|
|
4087
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
4080
4088
|
*
|
|
4081
4089
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
4082
4090
|
*
|
|
@@ -19,8 +19,9 @@ export interface SafetyEventsV2PatchSafetyEventsV2BatchRequestBody {
|
|
|
19
19
|
export declare namespace SafetyEventsV2PatchSafetyEventsV2BatchRequestBody {
|
|
20
20
|
type ContextLabelsToAdd = ContextLabelsToAdd.Item[];
|
|
21
21
|
namespace ContextLabelsToAdd {
|
|
22
|
-
/** A context label to add. Valid values: `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
22
|
+
/** A context label to add. Valid values: `Animal Collision`, `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
23
23
|
const Item: {
|
|
24
|
+
readonly AnimalCollision: "Animal Collision";
|
|
24
25
|
readonly Congested: "Congested";
|
|
25
26
|
readonly Construction: "Construction";
|
|
26
27
|
readonly CouplingUncoupling: "Coupling/Uncoupling";
|
|
@@ -51,8 +52,9 @@ export declare namespace SafetyEventsV2PatchSafetyEventsV2BatchRequestBody {
|
|
|
51
52
|
}
|
|
52
53
|
type ContextLabelsToRemove = ContextLabelsToRemove.Item[];
|
|
53
54
|
namespace ContextLabelsToRemove {
|
|
54
|
-
/** A context label to remove. Valid values: `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
55
|
+
/** A context label to remove. Valid values: `Animal Collision`, `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
55
56
|
const Item: {
|
|
57
|
+
readonly AnimalCollision: "Animal Collision";
|
|
56
58
|
readonly Congested: "Congested";
|
|
57
59
|
readonly Construction: "Construction";
|
|
58
60
|
readonly CouplingUncoupling: "Coupling/Uncoupling";
|
|
@@ -6,8 +6,9 @@ var SafetyEventsV2PatchSafetyEventsV2BatchRequestBody;
|
|
|
6
6
|
(function (SafetyEventsV2PatchSafetyEventsV2BatchRequestBody) {
|
|
7
7
|
let ContextLabelsToAdd;
|
|
8
8
|
(function (ContextLabelsToAdd) {
|
|
9
|
-
/** A context label to add. Valid values: `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
9
|
+
/** A context label to add. Valid values: `Animal Collision`, `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
10
10
|
ContextLabelsToAdd.Item = {
|
|
11
|
+
AnimalCollision: "Animal Collision",
|
|
11
12
|
Congested: "Congested",
|
|
12
13
|
Construction: "Construction",
|
|
13
14
|
CouplingUncoupling: "Coupling/Uncoupling",
|
|
@@ -37,8 +38,9 @@ var SafetyEventsV2PatchSafetyEventsV2BatchRequestBody;
|
|
|
37
38
|
})(ContextLabelsToAdd = SafetyEventsV2PatchSafetyEventsV2BatchRequestBody.ContextLabelsToAdd || (SafetyEventsV2PatchSafetyEventsV2BatchRequestBody.ContextLabelsToAdd = {}));
|
|
38
39
|
let ContextLabelsToRemove;
|
|
39
40
|
(function (ContextLabelsToRemove) {
|
|
40
|
-
/** A context label to remove. Valid values: `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
41
|
+
/** A context label to remove. Valid values: `Animal Collision`, `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
41
42
|
ContextLabelsToRemove.Item = {
|
|
43
|
+
AnimalCollision: "Animal Collision",
|
|
42
44
|
Congested: "Congested",
|
|
43
45
|
Construction: "Construction",
|
|
44
46
|
CouplingUncoupling: "Coupling/Uncoupling",
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "
|
|
1
|
+
export declare const SDK_VERSION = "11.1.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -7,8 +7,8 @@ export function normalizeClientOptions(options) {
|
|
|
7
7
|
const headers = mergeHeaders({
|
|
8
8
|
"X-Fern-Language": "JavaScript",
|
|
9
9
|
"X-Fern-SDK-Name": "@samsarahq/samsara",
|
|
10
|
-
"X-Fern-SDK-Version": "
|
|
11
|
-
"User-Agent": "@samsarahq/samsara/
|
|
10
|
+
"X-Fern-SDK-Version": "11.1.0",
|
|
11
|
+
"User-Agent": "@samsarahq/samsara/11.1.0",
|
|
12
12
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
13
13
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
14
14
|
"X-Samsara-Version": (_a = options === null || options === void 0 ? void 0 : options.version) !== null && _a !== void 0 ? _a : "2025-06-11",
|
|
@@ -695,7 +695,7 @@ export declare class BetaApIsClient {
|
|
|
695
695
|
*
|
|
696
696
|
* <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>).
|
|
697
697
|
*
|
|
698
|
-
* To use this endpoint, select **Write Functions** under the
|
|
698
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
699
699
|
*
|
|
700
700
|
*
|
|
701
701
|
* **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.
|
|
@@ -728,7 +728,7 @@ export declare class BetaApIsClient {
|
|
|
728
728
|
*
|
|
729
729
|
* <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>).
|
|
730
730
|
*
|
|
731
|
-
* To use this endpoint, select **Read Functions** under the
|
|
731
|
+
* To use this endpoint, select **Read Functions** under the Functions 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>
|
|
732
732
|
*
|
|
733
733
|
*
|
|
734
734
|
* **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.
|
|
@@ -758,7 +758,7 @@ export declare class BetaApIsClient {
|
|
|
758
758
|
*
|
|
759
759
|
* <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>).
|
|
760
760
|
*
|
|
761
|
-
* To use this endpoint, select **Write Functions** under the
|
|
761
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
762
762
|
*
|
|
763
763
|
*
|
|
764
764
|
* **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.
|
|
@@ -788,7 +788,7 @@ export declare class BetaApIsClient {
|
|
|
788
788
|
*
|
|
789
789
|
* <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>).
|
|
790
790
|
*
|
|
791
|
-
* To use this endpoint, select **Write Functions** under the
|
|
791
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
792
792
|
*
|
|
793
793
|
*
|
|
794
794
|
* **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.
|
|
@@ -819,7 +819,7 @@ export declare class BetaApIsClient {
|
|
|
819
819
|
*
|
|
820
820
|
* <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>).
|
|
821
821
|
*
|
|
822
|
-
* To use this endpoint, select **Write Functions** under the
|
|
822
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
823
823
|
*
|
|
824
824
|
*
|
|
825
825
|
* **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.
|
|
@@ -849,7 +849,7 @@ export declare class BetaApIsClient {
|
|
|
849
849
|
*
|
|
850
850
|
* <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>).
|
|
851
851
|
*
|
|
852
|
-
* To use this endpoint, select **Read Functions** under the
|
|
852
|
+
* To use this endpoint, select **Read Functions** under the Functions 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>
|
|
853
853
|
*
|
|
854
854
|
*
|
|
855
855
|
* **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.
|
|
@@ -881,7 +881,7 @@ export declare class BetaApIsClient {
|
|
|
881
881
|
*
|
|
882
882
|
* <b>Rate limit:</b> 2 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
883
883
|
*
|
|
884
|
-
* To use this endpoint, select **Write Functions** under the
|
|
884
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
885
885
|
*
|
|
886
886
|
*
|
|
887
887
|
* **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.
|
|
@@ -912,7 +912,7 @@ export declare class BetaApIsClient {
|
|
|
912
912
|
*
|
|
913
913
|
* <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>).
|
|
914
914
|
*
|
|
915
|
-
* To use this endpoint, select **Read Functions** under the
|
|
915
|
+
* To use this endpoint, select **Read Functions** under the Functions 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>
|
|
916
916
|
*
|
|
917
917
|
*
|
|
918
918
|
* **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.
|
|
@@ -1296,7 +1296,9 @@ export declare class BetaApIsClient {
|
|
|
1296
1296
|
/**
|
|
1297
1297
|
* Ingest new readings. This endpoint allows the ingestion of batches of readings.
|
|
1298
1298
|
*
|
|
1299
|
-
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API. When ingesting location data, the readingID 'location' must be used and the value object must contain at least the following fields: 'speed', 'latitude', 'longitude'.
|
|
1299
|
+
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API. When ingesting location data, the readingID 'location' must be used and the value object must contain at least the following fields: 'speed', 'latitude', 'longitude'.
|
|
1300
|
+
*
|
|
1301
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
1300
1302
|
*
|
|
1301
1303
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
1302
1304
|
*
|
|
@@ -1334,7 +1336,9 @@ export declare class BetaApIsClient {
|
|
|
1334
1336
|
postReadings(request: Samsara.ReadingsPostReadingsRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
1335
1337
|
private __postReadings;
|
|
1336
1338
|
/**
|
|
1337
|
-
* An introspection endpoint for discovering the set of readings including their name, description, data type, unit, and other metadata.
|
|
1339
|
+
* An introspection endpoint for discovering the set of readings including their name, description, data type, unit, and other metadata.
|
|
1340
|
+
*
|
|
1341
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
1338
1342
|
*
|
|
1339
1343
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
1340
1344
|
*
|
|
@@ -1362,7 +1366,9 @@ export declare class BetaApIsClient {
|
|
|
1362
1366
|
listReadingsDefinitions(request?: Samsara.ListReadingsDefinitionsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.ReadingsListReadingsDefinitionsResponseBody>;
|
|
1363
1367
|
private __listReadingsDefinitions;
|
|
1364
1368
|
/**
|
|
1365
|
-
* Get the values of a reading for a set of entities within the specified time range. Returns a paginated response with data for the specified resource IDs where startTime <= happenedAtTime < endTime. If endTime is not set, the time of the request is used as the endTime.
|
|
1369
|
+
* Get the values of a reading for a set of entities within the specified time range. Returns a paginated response with data for the specified resource IDs where startTime <= happenedAtTime < endTime. If endTime is not set, the time of the request is used as the endTime.
|
|
1370
|
+
*
|
|
1371
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
1366
1372
|
*
|
|
1367
1373
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
1368
1374
|
*
|
|
@@ -1393,7 +1399,9 @@ export declare class BetaApIsClient {
|
|
|
1393
1399
|
getReadingsHistory(request: Samsara.GetReadingsHistoryRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.ReadingsGetReadingsHistoryResponseBody>;
|
|
1394
1400
|
private __getReadingsHistory;
|
|
1395
1401
|
/**
|
|
1396
|
-
* An endpoint to get the last value of a reading for a set of entities at the specified time.
|
|
1402
|
+
* An endpoint to get the last value of a reading for a set of entities at the specified time.
|
|
1403
|
+
*
|
|
1404
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
1397
1405
|
*
|
|
1398
1406
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
1399
1407
|
*
|
|
@@ -2067,7 +2067,7 @@ export class BetaApIsClient {
|
|
|
2067
2067
|
*
|
|
2068
2068
|
* <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>).
|
|
2069
2069
|
*
|
|
2070
|
-
* To use this endpoint, select **Write Functions** under the
|
|
2070
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
2071
2071
|
*
|
|
2072
2072
|
*
|
|
2073
2073
|
* **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.
|
|
@@ -2157,7 +2157,7 @@ export class BetaApIsClient {
|
|
|
2157
2157
|
*
|
|
2158
2158
|
* <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>).
|
|
2159
2159
|
*
|
|
2160
|
-
* To use this endpoint, select **Read Functions** under the
|
|
2160
|
+
* To use this endpoint, select **Read Functions** under the Functions 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>
|
|
2161
2161
|
*
|
|
2162
2162
|
*
|
|
2163
2163
|
* **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.
|
|
@@ -2242,7 +2242,7 @@ export class BetaApIsClient {
|
|
|
2242
2242
|
*
|
|
2243
2243
|
* <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>).
|
|
2244
2244
|
*
|
|
2245
|
-
* To use this endpoint, select **Write Functions** under the
|
|
2245
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
2246
2246
|
*
|
|
2247
2247
|
*
|
|
2248
2248
|
* **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.
|
|
@@ -2324,7 +2324,7 @@ export class BetaApIsClient {
|
|
|
2324
2324
|
*
|
|
2325
2325
|
* <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>).
|
|
2326
2326
|
*
|
|
2327
|
-
* To use this endpoint, select **Write Functions** under the
|
|
2327
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
2328
2328
|
*
|
|
2329
2329
|
*
|
|
2330
2330
|
* **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.
|
|
@@ -2413,7 +2413,7 @@ export class BetaApIsClient {
|
|
|
2413
2413
|
*
|
|
2414
2414
|
* <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>).
|
|
2415
2415
|
*
|
|
2416
|
-
* To use this endpoint, select **Write Functions** under the
|
|
2416
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
2417
2417
|
*
|
|
2418
2418
|
*
|
|
2419
2419
|
* **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.
|
|
@@ -2498,7 +2498,7 @@ export class BetaApIsClient {
|
|
|
2498
2498
|
*
|
|
2499
2499
|
* <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>).
|
|
2500
2500
|
*
|
|
2501
|
-
* To use this endpoint, select **Read Functions** under the
|
|
2501
|
+
* To use this endpoint, select **Read Functions** under the Functions 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>
|
|
2502
2502
|
*
|
|
2503
2503
|
*
|
|
2504
2504
|
* **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.
|
|
@@ -2592,7 +2592,7 @@ export class BetaApIsClient {
|
|
|
2592
2592
|
*
|
|
2593
2593
|
* <b>Rate limit:</b> 2 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
2594
2594
|
*
|
|
2595
|
-
* To use this endpoint, select **Write Functions** under the
|
|
2595
|
+
* To use this endpoint, select **Write Functions** under the Functions 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>
|
|
2596
2596
|
*
|
|
2597
2597
|
*
|
|
2598
2598
|
* **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.
|
|
@@ -2681,7 +2681,7 @@ export class BetaApIsClient {
|
|
|
2681
2681
|
*
|
|
2682
2682
|
* <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>).
|
|
2683
2683
|
*
|
|
2684
|
-
* To use this endpoint, select **Read Functions** under the
|
|
2684
|
+
* To use this endpoint, select **Read Functions** under the Functions 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>
|
|
2685
2685
|
*
|
|
2686
2686
|
*
|
|
2687
2687
|
* **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.
|
|
@@ -3763,7 +3763,9 @@ export class BetaApIsClient {
|
|
|
3763
3763
|
/**
|
|
3764
3764
|
* Ingest new readings. This endpoint allows the ingestion of batches of readings.
|
|
3765
3765
|
*
|
|
3766
|
-
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API. When ingesting location data, the readingID 'location' must be used and the value object must contain at least the following fields: 'speed', 'latitude', 'longitude'.
|
|
3766
|
+
* Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API. When ingesting location data, the readingID 'location' must be used and the value object must contain at least the following fields: 'speed', 'latitude', 'longitude'.
|
|
3767
|
+
*
|
|
3768
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
3767
3769
|
*
|
|
3768
3770
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
3769
3771
|
*
|
|
@@ -3855,7 +3857,9 @@ export class BetaApIsClient {
|
|
|
3855
3857
|
});
|
|
3856
3858
|
}
|
|
3857
3859
|
/**
|
|
3858
|
-
* An introspection endpoint for discovering the set of readings including their name, description, data type, unit, and other metadata.
|
|
3860
|
+
* An introspection endpoint for discovering the set of readings including their name, description, data type, unit, and other metadata.
|
|
3861
|
+
*
|
|
3862
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
3859
3863
|
*
|
|
3860
3864
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
3861
3865
|
*
|
|
@@ -3943,7 +3947,9 @@ export class BetaApIsClient {
|
|
|
3943
3947
|
});
|
|
3944
3948
|
}
|
|
3945
3949
|
/**
|
|
3946
|
-
* Get the values of a reading for a set of entities within the specified time range. Returns a paginated response with data for the specified resource IDs where startTime <= happenedAtTime < endTime. If endTime is not set, the time of the request is used as the endTime.
|
|
3950
|
+
* Get the values of a reading for a set of entities within the specified time range. Returns a paginated response with data for the specified resource IDs where startTime <= happenedAtTime < endTime. If endTime is not set, the time of the request is used as the endTime.
|
|
3951
|
+
*
|
|
3952
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
3947
3953
|
*
|
|
3948
3954
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
3949
3955
|
*
|
|
@@ -4040,7 +4046,9 @@ export class BetaApIsClient {
|
|
|
4040
4046
|
});
|
|
4041
4047
|
}
|
|
4042
4048
|
/**
|
|
4043
|
-
* An endpoint to get the last value of a reading for a set of entities at the specified time.
|
|
4049
|
+
* An endpoint to get the last value of a reading for a set of entities at the specified time.
|
|
4050
|
+
*
|
|
4051
|
+
* Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
4044
4052
|
*
|
|
4045
4053
|
* <b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
4046
4054
|
*
|
|
@@ -19,8 +19,9 @@ export interface SafetyEventsV2PatchSafetyEventsV2BatchRequestBody {
|
|
|
19
19
|
export declare namespace SafetyEventsV2PatchSafetyEventsV2BatchRequestBody {
|
|
20
20
|
type ContextLabelsToAdd = ContextLabelsToAdd.Item[];
|
|
21
21
|
namespace ContextLabelsToAdd {
|
|
22
|
-
/** A context label to add. Valid values: `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
22
|
+
/** A context label to add. Valid values: `Animal Collision`, `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
23
23
|
const Item: {
|
|
24
|
+
readonly AnimalCollision: "Animal Collision";
|
|
24
25
|
readonly Congested: "Congested";
|
|
25
26
|
readonly Construction: "Construction";
|
|
26
27
|
readonly CouplingUncoupling: "Coupling/Uncoupling";
|
|
@@ -51,8 +52,9 @@ export declare namespace SafetyEventsV2PatchSafetyEventsV2BatchRequestBody {
|
|
|
51
52
|
}
|
|
52
53
|
type ContextLabelsToRemove = ContextLabelsToRemove.Item[];
|
|
53
54
|
namespace ContextLabelsToRemove {
|
|
54
|
-
/** A context label to remove. Valid values: `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
55
|
+
/** A context label to remove. Valid values: `Animal Collision`, `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
55
56
|
const Item: {
|
|
57
|
+
readonly AnimalCollision: "Animal Collision";
|
|
56
58
|
readonly Congested: "Congested";
|
|
57
59
|
readonly Construction: "Construction";
|
|
58
60
|
readonly CouplingUncoupling: "Coupling/Uncoupling";
|
|
@@ -3,8 +3,9 @@ export var SafetyEventsV2PatchSafetyEventsV2BatchRequestBody;
|
|
|
3
3
|
(function (SafetyEventsV2PatchSafetyEventsV2BatchRequestBody) {
|
|
4
4
|
let ContextLabelsToAdd;
|
|
5
5
|
(function (ContextLabelsToAdd) {
|
|
6
|
-
/** A context label to add. Valid values: `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
6
|
+
/** A context label to add. Valid values: `Animal Collision`, `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
7
7
|
ContextLabelsToAdd.Item = {
|
|
8
|
+
AnimalCollision: "Animal Collision",
|
|
8
9
|
Congested: "Congested",
|
|
9
10
|
Construction: "Construction",
|
|
10
11
|
CouplingUncoupling: "Coupling/Uncoupling",
|
|
@@ -34,8 +35,9 @@ export var SafetyEventsV2PatchSafetyEventsV2BatchRequestBody;
|
|
|
34
35
|
})(ContextLabelsToAdd = SafetyEventsV2PatchSafetyEventsV2BatchRequestBody.ContextLabelsToAdd || (SafetyEventsV2PatchSafetyEventsV2BatchRequestBody.ContextLabelsToAdd = {}));
|
|
35
36
|
let ContextLabelsToRemove;
|
|
36
37
|
(function (ContextLabelsToRemove) {
|
|
37
|
-
/** A context label to remove. Valid values: `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
38
|
+
/** A context label to remove. Valid values: `Animal Collision`, `Congested`, `Construction`, `Coupling/Uncoupling`, `Cyclist/Motorcyclist`, `Defensive`, `Fog`, `Improper Seat Belt`, `Light Traffic`, `Moderate Traffic`, `Moderately Drowsy`, `Mounted Phone`, `Night`, `Parking Lot`, `Passenger Mobile Usage`, `Passenger Sleeping`, `Passengers`, `Pedestrians`, `Raining`, `Sensitive Media`, `Slightly Drowsy`, `Snowing`, `Snowy Road`, `Speed Sign Verified`, `Very Drowsy`, `Wet Road` */
|
|
38
39
|
ContextLabelsToRemove.Item = {
|
|
40
|
+
AnimalCollision: "Animal Collision",
|
|
39
41
|
Congested: "Congested",
|
|
40
42
|
Construction: "Construction",
|
|
41
43
|
CouplingUncoupling: "Coupling/Uncoupling",
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "
|
|
1
|
+
export declare const SDK_VERSION = "11.1.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "
|
|
1
|
+
export const SDK_VERSION = "11.1.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -3152,7 +3152,7 @@ Create a new Function with the given name, description, and configuration. The r
|
|
|
3152
3152
|
|
|
3153
3153
|
<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>).
|
|
3154
3154
|
|
|
3155
|
-
To use this endpoint, select **Write Functions** under the
|
|
3155
|
+
To use this endpoint, select **Write Functions** under the Functions 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>
|
|
3156
3156
|
|
|
3157
3157
|
|
|
3158
3158
|
**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.
|
|
@@ -3227,7 +3227,7 @@ Retrieve the current state of an existing Function, including its configuration,
|
|
|
3227
3227
|
|
|
3228
3228
|
<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>).
|
|
3229
3229
|
|
|
3230
|
-
To use this endpoint, select **Read Functions** under the
|
|
3230
|
+
To use this endpoint, select **Read Functions** under the Functions 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>
|
|
3231
3231
|
|
|
3232
3232
|
|
|
3233
3233
|
**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.
|
|
@@ -3299,7 +3299,7 @@ Delete a Function by name. A Function that is currently configured as an action
|
|
|
3299
3299
|
|
|
3300
3300
|
<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>).
|
|
3301
3301
|
|
|
3302
|
-
To use this endpoint, select **Write Functions** under the
|
|
3302
|
+
To use this endpoint, select **Write Functions** under the Functions 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>
|
|
3303
3303
|
|
|
3304
3304
|
|
|
3305
3305
|
**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.
|
|
@@ -3371,7 +3371,7 @@ Update an existing Function's description and configuration. The request must in
|
|
|
3371
3371
|
|
|
3372
3372
|
<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>).
|
|
3373
3373
|
|
|
3374
|
-
To use this endpoint, select **Write Functions** under the
|
|
3374
|
+
To use this endpoint, select **Write Functions** under the Functions 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>
|
|
3375
3375
|
|
|
3376
3376
|
|
|
3377
3377
|
**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.
|
|
@@ -3444,7 +3444,7 @@ Deploy the uploaded code package for the specified Function, making it runnable.
|
|
|
3444
3444
|
|
|
3445
3445
|
<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>).
|
|
3446
3446
|
|
|
3447
|
-
To use this endpoint, select **Write Functions** under the
|
|
3447
|
+
To use this endpoint, select **Write Functions** under the Functions 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>
|
|
3448
3448
|
|
|
3449
3449
|
|
|
3450
3450
|
**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.
|
|
@@ -3516,7 +3516,7 @@ Retrieve paginated log entries for a specific Function within a given time range
|
|
|
3516
3516
|
|
|
3517
3517
|
<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>).
|
|
3518
3518
|
|
|
3519
|
-
To use this endpoint, select **Read Functions** under the
|
|
3519
|
+
To use this endpoint, select **Read Functions** under the Functions 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>
|
|
3520
3520
|
|
|
3521
3521
|
|
|
3522
3522
|
**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.
|
|
@@ -3590,7 +3590,7 @@ Start an asynchronous run for the specified Function. This endpoint allows you t
|
|
|
3590
3590
|
|
|
3591
3591
|
<b>Rate limit:</b> 2 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
3592
3592
|
|
|
3593
|
-
To use this endpoint, select **Write Functions** under the
|
|
3593
|
+
To use this endpoint, select **Write Functions** under the Functions 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>
|
|
3594
3594
|
|
|
3595
3595
|
|
|
3596
3596
|
**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.
|
|
@@ -3663,7 +3663,7 @@ Retrieve the execution summary for a specific Function run, identified by the co
|
|
|
3663
3663
|
|
|
3664
3664
|
<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>).
|
|
3665
3665
|
|
|
3666
|
-
To use this endpoint, select **Read Functions** under the
|
|
3666
|
+
To use this endpoint, select **Read Functions** under the Functions 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>
|
|
3667
3667
|
|
|
3668
3668
|
|
|
3669
3669
|
**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.
|
|
@@ -4551,7 +4551,9 @@ await client.betaApIs.getQualificationTypes({
|
|
|
4551
4551
|
|
|
4552
4552
|
Ingest new readings. This endpoint allows the ingestion of batches of readings.
|
|
4553
4553
|
|
|
4554
|
-
Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API. When ingesting location data, the readingID 'location' must be used and the value object must contain at least the following fields: 'speed', 'latitude', 'longitude'.
|
|
4554
|
+
Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API. When ingesting location data, the readingID 'location' must be used and the value object must contain at least the following fields: 'speed', 'latitude', 'longitude'.
|
|
4555
|
+
|
|
4556
|
+
Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
4555
4557
|
|
|
4556
4558
|
<b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
4557
4559
|
|
|
@@ -4631,7 +4633,9 @@ await client.betaApIs.postReadings({
|
|
|
4631
4633
|
<dl>
|
|
4632
4634
|
<dd>
|
|
4633
4635
|
|
|
4634
|
-
An introspection endpoint for discovering the set of readings including their name, description, data type, unit, and other metadata.
|
|
4636
|
+
An introspection endpoint for discovering the set of readings including their name, description, data type, unit, and other metadata.
|
|
4637
|
+
|
|
4638
|
+
Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
4635
4639
|
|
|
4636
4640
|
<b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
4637
4641
|
|
|
@@ -4701,7 +4705,9 @@ await client.betaApIs.listReadingsDefinitions();
|
|
|
4701
4705
|
<dl>
|
|
4702
4706
|
<dd>
|
|
4703
4707
|
|
|
4704
|
-
Get the values of a reading for a set of entities within the specified time range. Returns a paginated response with data for the specified resource IDs where startTime <= happenedAtTime < endTime. If endTime is not set, the time of the request is used as the endTime.
|
|
4708
|
+
Get the values of a reading for a set of entities within the specified time range. Returns a paginated response with data for the specified resource IDs where startTime <= happenedAtTime < endTime. If endTime is not set, the time of the request is used as the endTime.
|
|
4709
|
+
|
|
4710
|
+
Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
4705
4711
|
|
|
4706
4712
|
<b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
4707
4713
|
|
|
@@ -4774,7 +4780,9 @@ await client.betaApIs.getReadingsHistory({
|
|
|
4774
4780
|
<dl>
|
|
4775
4781
|
<dd>
|
|
4776
4782
|
|
|
4777
|
-
An endpoint to get the last value of a reading for a set of entities at the specified time.
|
|
4783
|
+
An endpoint to get the last value of a reading for a set of entities at the specified time.
|
|
4784
|
+
|
|
4785
|
+
Related guide: [Readings](https://developers.samsara.com/docs/readings).
|
|
4778
4786
|
|
|
4779
4787
|
<b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
4780
4788
|
|