@samsarahq/samsara 8.1.0 → 8.1.1

package/dist/cjs/BaseClient.js

@@ -44,8 +44,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@samsarahq/samsara",
-        "X-Fern-SDK-Version": "8.1.0",
-        "User-Agent": "@samsarahq/samsara/8.1.0",
+        "X-Fern-SDK-Version": "8.1.1",
+        "User-Agent": "@samsarahq/samsara/8.1.1",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
         "X-Samsara-Version": (_a = options === null || options === void 0 ? void 0 : options.version) !== null && _a !== void 0 ? _a : "2025-06-11",

package/dist/cjs/api/resources/betaApIs/client/Client.d.ts

@@ -1367,7 +1367,7 @@ export declare class BetaApIsClient {
     listReadingsDefinitions(request?: Samsara.ListReadingsDefinitionsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.ReadingsListReadingsDefinitionsResponseBody>;
     private __listReadingsDefinitions;
     /**
-     * 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. End time of null implies endTime is infinite and all known readings are returned.
+     * 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.
      *
      *  <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>).
      *

package/dist/cjs/api/resources/betaApIs/client/Client.js

@@ -4013,7 +4013,7 @@ class BetaApIsClient {
         });
     }
     /**
-     * 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. End time of null implies endTime is infinite and all known readings are returned.
+     * 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.
      *
      *  <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>).
      *

package/dist/cjs/api/resources/betaApIs/client/requests/GetReadingsHistoryRequest.d.ts

@@ -234,13 +234,13 @@ export interface GetReadingsHistoryRequest {
      * **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.
      */
     readingId: string;
-    /** A filter on the data based on this comma-separated list of entity IDs or external IDs. If not set, all entities are returned. */
+    /** A filter on the data based on this comma-separated list of entity IDs. If not set, all entities are returned. */
     entityIds?: string;
-    /** A entity type of the entityIds or externalIds to fetch readings for. Use /readings/definitions endpoint to get a list of valid entity types. (Examples: asset, sensor) */
+    /** The entity type of the entityIds or externalIds to fetch readings for. Use /readings/definitions endpoint to get a list of valid entity types. (Examples: asset, sensor) */
     entityType: string;
     /** A filter on the data based on this comma-separated list of external IDs. (Examples: samsara.serial:ZPXKLMN7VJ, samsara.serial:ABXKIMN4NM) */
     externalIds?: string;
-    /** A filter on the data that returns the last known data points with timestamps greater than or equal to this value. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2020-01-27T07:06:25Z) */
+    /** A filter on the data that returns data points with timestamps greater than or equal to this value. Required when feed mode is not enabled. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2020-01-27T07:06:25Z) */
     startTime?: string;
     /** A filter on the data that returns the last known data points with timestamps less than or equal to this value. If not set, the time of the request is considered the endTime. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2020-01-27T07:06:25Z) */
     endTime?: string;

package/dist/cjs/api/resources/betaApIs/client/requests/GetReadingsSnapshotRequest.d.ts

@@ -9,7 +9,7 @@ export interface GetReadingsSnapshotRequest {
     /**  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. */
     after?: string;
     /**
-     * A collection of comma separated reading IDs. Include up to 3 readings IDs. Use /readings/definitions endpoint to get a list of valid reading IDs. (Examples: engineRpm,fuelLevel)
+     * A collection of comma separated reading IDs. Include up to 5 readings IDs. Use /readings/definitions endpoint to get a list of valid reading IDs. (Examples: engineRpm,fuelLevel)
      *
      * Available reading IDs (by category):
      *
@@ -234,13 +234,13 @@ export interface GetReadingsSnapshotRequest {
      * **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.
      */
     readingIds: string;
-    /** A filter on the data based on this comma-separated list of entity IDs or external IDs. If not set, all entities are returned. */
+    /** A filter on the data based on this comma-separated list of entity IDs. If not set, all entities are returned. */
     entityIds?: string;
     /** A filter on the data based on this comma-separated list of external IDs. (Examples: samsara.serial:ZPXKLMN7VJ, samsara.serial:ABXKIMN4NM) */
     externalIds?: string;
     /** A filter on the data that returns the last known data points with timestamps less than or equal to this value. Defaults to now if not provided. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2020-01-27T07:06:25Z) */
     asOfTime?: string;
-    /** A entity type of the entityIds or externalIds to fetch readings for. Use /readings/definitions endpoint to get a list of valid entity types. (Examples: asset, sensor) */
+    /** The entity type of the entityIds or externalIds to fetch readings for. Use /readings/definitions endpoint to get a list of valid entity types. (Examples: asset, sensor) */
     entityType: string;
     /** Optional boolean indicating whether to return external IDs on supported entities */
     includeExternalIds?: boolean;

package/dist/cjs/api/resources/betaApIs/client/requests/ListReadingsDefinitionsRequest.d.ts

@@ -7,6 +7,6 @@ export interface ListReadingsDefinitionsRequest {
     after?: string;
     /** A String of comma separated reading IDs. Include up to 50 readings IDs. If not set, all readings are returned. */
     ids?: string;
-    /** A list of entity type to return readings for. (Examples: asset, sensor) */
+    /** A list of entity types to return readings for. (Examples: asset, sensor) */
     entityTypes?: string;
 }

package/dist/cjs/api/types/ReadingHistoryResponseBody.d.ts

@@ -2,7 +2,7 @@
  * A history of reading values for an entity.
  */
 export interface ReadingHistoryResponseBody {
-    /** The ID of the entity this readings is for. */
+    /** The ID of the entity this reading is for. */
     entityId: string;
     /** A map of external ids */
     externalIds?: Record<string, string> | undefined;

package/dist/cjs/api/types/ReadingSnapshotResponseBody.d.ts

@@ -2,7 +2,7 @@
  * A snapshot of a reading value at a point in time.
  */
 export interface ReadingSnapshotResponseBody {
-    /** The ID of the entity this readings is for. */
+    /** The ID of the entity this reading is for. */
     entityId: string;
     /** A map of external ids */
     externalIds?: Record<string, string> | undefined;

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "8.1.0";
+export declare const SDK_VERSION = "8.1.1";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "8.1.0";
+exports.SDK_VERSION = "8.1.1";

package/dist/esm/BaseClient.mjs

@@ -7,8 +7,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@samsarahq/samsara",
-        "X-Fern-SDK-Version": "8.1.0",
-        "User-Agent": "@samsarahq/samsara/8.1.0",
+        "X-Fern-SDK-Version": "8.1.1",
+        "User-Agent": "@samsarahq/samsara/8.1.1",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
         "X-Samsara-Version": (_a = options === null || options === void 0 ? void 0 : options.version) !== null && _a !== void 0 ? _a : "2025-06-11",

package/dist/esm/api/resources/betaApIs/client/Client.d.mts

@@ -1367,7 +1367,7 @@ export declare class BetaApIsClient {
     listReadingsDefinitions(request?: Samsara.ListReadingsDefinitionsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.ReadingsListReadingsDefinitionsResponseBody>;
     private __listReadingsDefinitions;
     /**
-     * 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. End time of null implies endTime is infinite and all known readings are returned.
+     * 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.
      *
      *  <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>).
      *

package/dist/esm/api/resources/betaApIs/client/Client.mjs

@@ -3977,7 +3977,7 @@ export class BetaApIsClient {
         });
     }
     /**
-     * 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. End time of null implies endTime is infinite and all known readings are returned.
+     * 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.
      *
      *  <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>).
      *

package/dist/esm/api/resources/betaApIs/client/requests/GetReadingsHistoryRequest.d.mts

@@ -234,13 +234,13 @@ export interface GetReadingsHistoryRequest {
      * **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.
      */
     readingId: string;
-    /** A filter on the data based on this comma-separated list of entity IDs or external IDs. If not set, all entities are returned. */
+    /** A filter on the data based on this comma-separated list of entity IDs. If not set, all entities are returned. */
     entityIds?: string;
-    /** A entity type of the entityIds or externalIds to fetch readings for. Use /readings/definitions endpoint to get a list of valid entity types. (Examples: asset, sensor) */
+    /** The entity type of the entityIds or externalIds to fetch readings for. Use /readings/definitions endpoint to get a list of valid entity types. (Examples: asset, sensor) */
     entityType: string;
     /** A filter on the data based on this comma-separated list of external IDs. (Examples: samsara.serial:ZPXKLMN7VJ, samsara.serial:ABXKIMN4NM) */
     externalIds?: string;
-    /** A filter on the data that returns the last known data points with timestamps greater than or equal to this value. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2020-01-27T07:06:25Z) */
+    /** A filter on the data that returns data points with timestamps greater than or equal to this value. Required when feed mode is not enabled. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2020-01-27T07:06:25Z) */
     startTime?: string;
     /** A filter on the data that returns the last known data points with timestamps less than or equal to this value. If not set, the time of the request is considered the endTime. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2020-01-27T07:06:25Z) */
     endTime?: string;

package/dist/esm/api/resources/betaApIs/client/requests/GetReadingsSnapshotRequest.d.mts

@@ -9,7 +9,7 @@ export interface GetReadingsSnapshotRequest {
     /**  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. */
     after?: string;
     /**
-     * A collection of comma separated reading IDs. Include up to 3 readings IDs. Use /readings/definitions endpoint to get a list of valid reading IDs. (Examples: engineRpm,fuelLevel)
+     * A collection of comma separated reading IDs. Include up to 5 readings IDs. Use /readings/definitions endpoint to get a list of valid reading IDs. (Examples: engineRpm,fuelLevel)
      *
      * Available reading IDs (by category):
      *
@@ -234,13 +234,13 @@ export interface GetReadingsSnapshotRequest {
      * **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.
      */
     readingIds: string;
-    /** A filter on the data based on this comma-separated list of entity IDs or external IDs. If not set, all entities are returned. */
+    /** A filter on the data based on this comma-separated list of entity IDs. If not set, all entities are returned. */
     entityIds?: string;
     /** A filter on the data based on this comma-separated list of external IDs. (Examples: samsara.serial:ZPXKLMN7VJ, samsara.serial:ABXKIMN4NM) */
     externalIds?: string;
     /** A filter on the data that returns the last known data points with timestamps less than or equal to this value. Defaults to now if not provided. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2020-01-27T07:06:25Z) */
     asOfTime?: string;
-    /** A entity type of the entityIds or externalIds to fetch readings for. Use /readings/definitions endpoint to get a list of valid entity types. (Examples: asset, sensor) */
+    /** The entity type of the entityIds or externalIds to fetch readings for. Use /readings/definitions endpoint to get a list of valid entity types. (Examples: asset, sensor) */
     entityType: string;
     /** Optional boolean indicating whether to return external IDs on supported entities */
     includeExternalIds?: boolean;

package/dist/esm/api/resources/betaApIs/client/requests/ListReadingsDefinitionsRequest.d.mts

@@ -7,6 +7,6 @@ export interface ListReadingsDefinitionsRequest {
     after?: string;
     /** A String of comma separated reading IDs. Include up to 50 readings IDs. If not set, all readings are returned. */
     ids?: string;
-    /** A list of entity type to return readings for. (Examples: asset, sensor) */
+    /** A list of entity types to return readings for. (Examples: asset, sensor) */
     entityTypes?: string;
 }

package/dist/esm/api/types/ReadingHistoryResponseBody.d.mts

@@ -2,7 +2,7 @@
  * A history of reading values for an entity.
  */
 export interface ReadingHistoryResponseBody {
-    /** The ID of the entity this readings is for. */
+    /** The ID of the entity this reading is for. */
     entityId: string;
     /** A map of external ids */
     externalIds?: Record<string, string> | undefined;

package/dist/esm/api/types/ReadingSnapshotResponseBody.d.mts

@@ -2,7 +2,7 @@
  * A snapshot of a reading value at a point in time.
  */
 export interface ReadingSnapshotResponseBody {
-    /** The ID of the entity this readings is for. */
+    /** The ID of the entity this reading is for. */
     entityId: string;
     /** A map of external ids */
     externalIds?: Record<string, string> | undefined;

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "8.1.0";
+export declare const SDK_VERSION = "8.1.1";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "8.1.0";
+export const SDK_VERSION = "8.1.1";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@samsarahq/samsara",
-    "version": "8.1.0",
+    "version": "8.1.1",
     "private": false,
     "repository": {
         "type": "git",

package/reference.md

@@ -4706,7 +4706,7 @@ await client.betaApIs.listReadingsDefinitions();
 <dl>
 <dd>
 
-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. End time of null implies endTime is infinite and all known readings are returned.
+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.
 
  <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>).