@samsarahq/samsara 13.29.0 → 13.31.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.
Files changed (46) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/assets/client/requests/AssetsCreateAssetRequestBody.d.ts +2 -2
  3. package/dist/cjs/api/resources/assets/client/requests/AssetsUpdateAssetRequestBody.d.ts +5 -0
  4. package/dist/cjs/api/resources/betaApIs/client/Client.d.ts +1 -1
  5. package/dist/cjs/api/resources/betaApIs/client/Client.js +1 -1
  6. package/dist/cjs/api/resources/betaApIs/client/requests/SafetyEventsV2PatchSafetyEventsV2BatchRequestBody.d.ts +1 -1
  7. package/dist/cjs/api/resources/media/client/Client.d.ts +1 -1
  8. package/dist/cjs/api/resources/media/client/Client.js +1 -1
  9. package/dist/cjs/api/resources/media/client/requests/MediaRetrievalPostMediaRetrievalRequestBody.d.ts +1 -1
  10. package/dist/cjs/api/resources/readings/client/requests/GetReadingsHistoryRequest.d.ts +3 -3
  11. package/dist/cjs/api/resources/readings/client/requests/GetReadingsSnapshotRequest.d.ts +3 -3
  12. package/dist/cjs/api/types/BleAssetTagDetailsResponseResponseBody.d.ts +19 -0
  13. package/dist/cjs/api/types/BleAssetTagDetailsResponseResponseBody.js +14 -0
  14. package/dist/cjs/api/types/CameraConnectorDetailsResponseResponseBody.d.ts +11 -0
  15. package/dist/cjs/api/types/CameraConnectorDetailsResponseResponseBody.js +3 -0
  16. package/dist/cjs/api/types/HealthDetailsResponseResponseBody.d.ts +2 -0
  17. package/dist/cjs/api/types/TrailerStatsObjectResponseBody.d.ts +2 -0
  18. package/dist/cjs/api/types/TrailerStatsSnapshotObjectResponseBody.d.ts +2 -0
  19. package/dist/cjs/api/types/index.d.ts +2 -0
  20. package/dist/cjs/api/types/index.js +2 -0
  21. package/dist/cjs/version.d.ts +1 -1
  22. package/dist/cjs/version.js +1 -1
  23. package/dist/esm/BaseClient.mjs +2 -2
  24. package/dist/esm/api/resources/assets/client/requests/AssetsCreateAssetRequestBody.d.mts +2 -2
  25. package/dist/esm/api/resources/assets/client/requests/AssetsUpdateAssetRequestBody.d.mts +5 -0
  26. package/dist/esm/api/resources/betaApIs/client/Client.d.mts +1 -1
  27. package/dist/esm/api/resources/betaApIs/client/Client.mjs +1 -1
  28. package/dist/esm/api/resources/betaApIs/client/requests/SafetyEventsV2PatchSafetyEventsV2BatchRequestBody.d.mts +1 -1
  29. package/dist/esm/api/resources/media/client/Client.d.mts +1 -1
  30. package/dist/esm/api/resources/media/client/Client.mjs +1 -1
  31. package/dist/esm/api/resources/media/client/requests/MediaRetrievalPostMediaRetrievalRequestBody.d.mts +1 -1
  32. package/dist/esm/api/resources/readings/client/requests/GetReadingsHistoryRequest.d.mts +3 -3
  33. package/dist/esm/api/resources/readings/client/requests/GetReadingsSnapshotRequest.d.mts +3 -3
  34. package/dist/esm/api/types/BleAssetTagDetailsResponseResponseBody.d.mts +19 -0
  35. package/dist/esm/api/types/BleAssetTagDetailsResponseResponseBody.mjs +11 -0
  36. package/dist/esm/api/types/CameraConnectorDetailsResponseResponseBody.d.mts +11 -0
  37. package/dist/esm/api/types/CameraConnectorDetailsResponseResponseBody.mjs +2 -0
  38. package/dist/esm/api/types/HealthDetailsResponseResponseBody.d.mts +2 -0
  39. package/dist/esm/api/types/TrailerStatsObjectResponseBody.d.mts +2 -0
  40. package/dist/esm/api/types/TrailerStatsSnapshotObjectResponseBody.d.mts +2 -0
  41. package/dist/esm/api/types/index.d.mts +2 -0
  42. package/dist/esm/api/types/index.mjs +2 -0
  43. package/dist/esm/version.d.mts +1 -1
  44. package/dist/esm/version.mjs +1 -1
  45. package/package.json +1 -1
  46. package/reference.md +2 -2
@@ -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": "13.29.0",
48
- "User-Agent": "@samsarahq/samsara/13.29.0",
47
+ "X-Fern-SDK-Version": "13.31.0",
48
+ "User-Agent": "@samsarahq/samsara/13.31.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",
@@ -4,7 +4,7 @@ import type * as Samsara from "../../../../index.js";
4
4
  * {}
5
5
  */
6
6
  export interface AssetsCreateAssetRequestBody {
7
- /** A list of attributes to assign to the asset. */
7
+ /** A list of attributes to assign to the asset. If provided, this replaces the asset's entire set of attribute associations with exactly this list; omit this field to leave existing attribute associations unchanged, or pass an empty array to clear them. */
8
8
  attributes?: Samsara.GoaAttributeTinyRequestBody[];
9
9
  /** A map of external ids */
10
10
  externalIds?: Record<string, string>;
@@ -24,7 +24,7 @@ export interface AssetsCreateAssetRequestBody {
24
24
  regulationMode?: AssetsCreateAssetRequestBody.RegulationMode;
25
25
  /** The serial number of the asset. This can be an internal serial number or used to hold legacy VIN/PIN numbers such as ones of shorter lengths. */
26
26
  serialNumber?: string;
27
- /** An array of IDs of tags to associate with this asset. If your access to the API is scoped by one or more tags, this field is required to pass in. */
27
+ /** An array of IDs of tags to associate with this asset. If provided, this replaces the asset's entire set of tag associations with exactly this list; omit this field to leave existing tag associations unchanged, or pass an empty array to clear them. If your access to the API is scoped by one or more tags, this field is required to pass in. */
28
28
  tagIds?: string[];
29
29
  /** The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle` */
30
30
  type?: AssetsCreateAssetRequestBody.Type;
@@ -1,3 +1,4 @@
1
+ import type * as Samsara from "../../../../index.js";
1
2
  /**
2
3
  * @example
3
4
  * {
@@ -7,6 +8,8 @@
7
8
  export interface AssetsUpdateAssetRequestBody {
8
9
  /** A filter selecting a single asset by id. */
9
10
  id: string;
11
+ /** A list of attributes to assign to the asset. If provided, this replaces the asset's entire set of attribute associations with exactly this list; omit this field to leave existing attribute associations unchanged, or pass an empty array to clear them. */
12
+ attributes?: Samsara.GoaAttributeTinyRequestBody[];
10
13
  /** A map of external ids */
11
14
  externalIds?: Record<string, string>;
12
15
  /** The license plate of the asset. */
@@ -25,6 +28,8 @@ export interface AssetsUpdateAssetRequestBody {
25
28
  regulationMode?: AssetsUpdateAssetRequestBody.RegulationMode;
26
29
  /** The serial number of the asset. This can be an internal serial number or used to hold legacy VIN/PIN numbers such as ones of shorter lengths. */
27
30
  serialNumber?: string;
31
+ /** An array of IDs of tags to associate with this asset. If provided, this replaces the asset's entire set of tag associations with exactly this list; omit this field to leave existing tag associations unchanged, or pass an empty array to clear them. If your access to the API is scoped by one or more tags, this field is required to pass in. */
32
+ tagIds?: string[];
28
33
  /** The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle` */
29
34
  type?: AssetsUpdateAssetRequestBody.Type;
30
35
  /** The unique 17-digit VIN (Vehicle Identification Number) or PIN (Product Identification Number) of the asset. */
@@ -2632,7 +2632,7 @@ export declare class BetaApIsClient {
2632
2632
  *
2633
2633
  * @example
2634
2634
  * await client.betaApIs.patchSafetyEventsV2Batch({
2635
- * safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
2635
+ * safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
2636
2636
  * })
2637
2637
  */
2638
2638
  patchSafetyEventsV2Batch(request: Samsara.SafetyEventsV2PatchSafetyEventsV2BatchRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.SafetyEventsV2PatchSafetyEventsV2BatchResponseBody>;
@@ -7585,7 +7585,7 @@ class BetaApIsClient {
7585
7585
  *
7586
7586
  * @example
7587
7587
  * await client.betaApIs.patchSafetyEventsV2Batch({
7588
- * safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
7588
+ * safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
7589
7589
  * })
7590
7590
  */
7591
7591
  patchSafetyEventsV2Batch(request, requestOptions) {
@@ -2,7 +2,7 @@ import type * as Samsara from "../../../../index.js";
2
2
  /**
3
3
  * @example
4
4
  * {
5
- * safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
5
+ * safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
6
6
  * }
7
7
  */
8
8
  export interface SafetyEventsV2PatchSafetyEventsV2BatchRequestBody {
@@ -98,7 +98,7 @@ export declare class MediaClient {
98
98
  * @example
99
99
  * await client.media.postMediaRetrieval({
100
100
  * endTime: "2019-06-13T19:08:55Z",
101
- * inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
101
+ * inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
102
102
  * mediaType: "image",
103
103
  * startTime: "2019-06-13T19:08:25Z",
104
104
  * vehicleId: "1234"
@@ -274,7 +274,7 @@ class MediaClient {
274
274
  * @example
275
275
  * await client.media.postMediaRetrieval({
276
276
  * endTime: "2019-06-13T19:08:55Z",
277
- * inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
277
+ * inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
278
278
  * mediaType: "image",
279
279
  * startTime: "2019-06-13T19:08:25Z",
280
280
  * vehicleId: "1234"
@@ -2,7 +2,7 @@
2
2
  * @example
3
3
  * {
4
4
  * endTime: "2019-06-13T19:08:55Z",
5
- * inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
5
+ * inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
6
6
  * mediaType: "image",
7
7
  * startTime: "2019-06-13T19:08:25Z",
8
8
  * vehicleId: "1234"
@@ -221,9 +221,6 @@ export interface GetReadingsHistoryRequest {
221
221
  *
222
222
  * * `addressEntry` (Address Entry): Address data from the address entry event
223
223
  * * `addressExit` (Address Exit): Address data from the address exit event
224
- * * `ag51BatteryStatus` (AG51 Battery Status): Battery status of the AG51 gateway based on temperature-compensated voltage threshold. The threshold varies from 3672mV at -40°C to 4579mV at 60°C. (values: ok | low)
225
- * * `ag51BatteryTemperature` (AG51 Battery Temperature): Internal temperature of the AG51 gateway battery in degrees Celsius (celsius)
226
- * * `ag51BatteryVoltage` (AG51 Battery Voltage): Total battery voltage of the AG51 gateway (sum of all 3 cells) in volts (volt)
227
224
  * * `atisLamp` (Atis Lamp status): Atis lamp on/off status (values: off | on)
228
225
  * * `derivedCargoState` (Cargo Status): Indicates if the overall cargo status of the asset is Empty, Partially Empty, Full, or Unknown. (values: unknown | empty | partiallyEmpty | full)
229
226
  * * `doorClosedStatus` (Door Closed Status): Status indicating whether a door is closed or open (values: open | closed)
@@ -232,6 +229,9 @@ export interface GetReadingsHistoryRequest {
232
229
  * * `environmentMonitorAmbientTemperatureBLEConnection` (Ambient Temperature (BLE Connection)): Air temperature at the environmental monitor device (built-in sensor) via BLE Connection. (celsius)
233
230
  * * `environmentMonitorThermistorTemperature` (Thermistor Temperature): Temperature from an external thermistor probe (e.g. cable probe in cargo or reefer). (celsius)
234
231
  * * `environmentMonitorThermistorTemperatureBLEConnection` (Thermistor Temperature (BLE Connection)): Temperature from an external thermistor probe (e.g. cable probe in cargo or reefer) via BLE Connection. (celsius)
232
+ * * `gatewayBatteryStatus` (Gateway Battery Status): Battery status of the gateway based on temperature-compensated voltage threshold. The threshold varies from 3672mV at -40°C to 4579mV at 60°C. (values: ok | low)
233
+ * * `gatewayBatteryTemperature` (Gateway Battery Temperature): Internal temperature of the gateway battery in degrees Celsius (celsius)
234
+ * * `gatewayBatteryVoltage` (Gateway Battery Voltage): Total battery voltage of the gateway (sum of all 3 cells) in volts (volt)
235
235
  * * `trailerMovingWithoutPower` (Trailer Moving Without Power): Trailer moving without power status (values: off | on)
236
236
  * * `validBrakeScore` (Braking Performance Value): Percent score representing trailer braking effectiveness using regression analysis over the past 90 days, guaranteed to have under 3% margin of error. (percent)
237
237
  * * `widgetBatteryVoltage` (Widget Battery Voltage): Battery voltage level of the widget sensor in millivolts (volt)
@@ -221,9 +221,6 @@ export interface GetReadingsSnapshotRequest {
221
221
  *
222
222
  * * `addressEntry` (Address Entry): Address data from the address entry event
223
223
  * * `addressExit` (Address Exit): Address data from the address exit event
224
- * * `ag51BatteryStatus` (AG51 Battery Status): Battery status of the AG51 gateway based on temperature-compensated voltage threshold. The threshold varies from 3672mV at -40°C to 4579mV at 60°C. (values: ok | low)
225
- * * `ag51BatteryTemperature` (AG51 Battery Temperature): Internal temperature of the AG51 gateway battery in degrees Celsius (celsius)
226
- * * `ag51BatteryVoltage` (AG51 Battery Voltage): Total battery voltage of the AG51 gateway (sum of all 3 cells) in volts (volt)
227
224
  * * `atisLamp` (Atis Lamp status): Atis lamp on/off status (values: off | on)
228
225
  * * `derivedCargoState` (Cargo Status): Indicates if the overall cargo status of the asset is Empty, Partially Empty, Full, or Unknown. (values: unknown | empty | partiallyEmpty | full)
229
226
  * * `doorClosedStatus` (Door Closed Status): Status indicating whether a door is closed or open (values: open | closed)
@@ -232,6 +229,9 @@ export interface GetReadingsSnapshotRequest {
232
229
  * * `environmentMonitorAmbientTemperatureBLEConnection` (Ambient Temperature (BLE Connection)): Air temperature at the environmental monitor device (built-in sensor) via BLE Connection. (celsius)
233
230
  * * `environmentMonitorThermistorTemperature` (Thermistor Temperature): Temperature from an external thermistor probe (e.g. cable probe in cargo or reefer). (celsius)
234
231
  * * `environmentMonitorThermistorTemperatureBLEConnection` (Thermistor Temperature (BLE Connection)): Temperature from an external thermistor probe (e.g. cable probe in cargo or reefer) via BLE Connection. (celsius)
232
+ * * `gatewayBatteryStatus` (Gateway Battery Status): Battery status of the gateway based on temperature-compensated voltage threshold. The threshold varies from 3672mV at -40°C to 4579mV at 60°C. (values: ok | low)
233
+ * * `gatewayBatteryTemperature` (Gateway Battery Temperature): Internal temperature of the gateway battery in degrees Celsius (celsius)
234
+ * * `gatewayBatteryVoltage` (Gateway Battery Voltage): Total battery voltage of the gateway (sum of all 3 cells) in volts (volt)
235
235
  * * `trailerMovingWithoutPower` (Trailer Moving Without Power): Trailer moving without power status (values: off | on)
236
236
  * * `validBrakeScore` (Braking Performance Value): Percent score representing trailer braking effectiveness using regression analysis over the past 90 days, guaranteed to have under 3% margin of error. (percent)
237
237
  * * `widgetBatteryVoltage` (Widget Battery Voltage): Battery voltage level of the widget sensor in millivolts (volt)
@@ -0,0 +1,19 @@
1
+ /**
2
+ * BLE asset tag-specific health metadata details.
3
+ */
4
+ export interface BleAssetTagDetailsResponseResponseBody {
5
+ /** The BLE asset tag's battery state. Valid values: `critical`, `low`, `ok`, `unknown` */
6
+ batteryState?: BleAssetTagDetailsResponseResponseBody.BatteryState | undefined;
7
+ /** The timestamp when the BLE asset tag was last detected by a gateway in the Samsara network, in RFC 3339 format. */
8
+ lastCheckInTime?: string | undefined;
9
+ }
10
+ export declare namespace BleAssetTagDetailsResponseResponseBody {
11
+ /** The BLE asset tag's battery state. Valid values: `critical`, `low`, `ok`, `unknown` */
12
+ const BatteryState: {
13
+ readonly Critical: "critical";
14
+ readonly Low: "low";
15
+ readonly Ok: "ok";
16
+ readonly Unknown: "unknown";
17
+ };
18
+ type BatteryState = (typeof BatteryState)[keyof typeof BatteryState];
19
+ }
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.BleAssetTagDetailsResponseResponseBody = void 0;
5
+ var BleAssetTagDetailsResponseResponseBody;
6
+ (function (BleAssetTagDetailsResponseResponseBody) {
7
+ /** The BLE asset tag's battery state. Valid values: `critical`, `low`, `ok`, `unknown` */
8
+ BleAssetTagDetailsResponseResponseBody.BatteryState = {
9
+ Critical: "critical",
10
+ Low: "low",
11
+ Ok: "ok",
12
+ Unknown: "unknown",
13
+ };
14
+ })(BleAssetTagDetailsResponseResponseBody || (exports.BleAssetTagDetailsResponseResponseBody = BleAssetTagDetailsResponseResponseBody = {}));
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Camera connector-specific health metadata details.
3
+ */
4
+ export interface CameraConnectorDetailsResponseResponseBody {
5
+ /** The timestamp when the gateway was last connected to the vehicle, in RFC 3339 format. */
6
+ gatewayLastConnectedTime?: string | undefined;
7
+ /** The percentage of successful recording time during the time when the vehicle is on an active trip over the past 50 hours, in percentage points. */
8
+ lastFiftyHoursUptimePercentage?: number | undefined;
9
+ /** The serial number of the vehicle gateway that the camera connector is connected to. */
10
+ vehicleGatewaySerial?: string | undefined;
11
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -3,6 +3,8 @@ import type * as Samsara from "../index.js";
3
3
  * Detailed health related metadata for the device.
4
4
  */
5
5
  export interface HealthDetailsResponseResponseBody {
6
+ bleAssetTagDetails?: Samsara.BleAssetTagDetailsResponseResponseBody | undefined;
7
+ cameraConnectorDetails?: Samsara.CameraConnectorDetailsResponseResponseBody | undefined;
6
8
  cameraDetails?: Samsara.CameraDetailsResponseResponseBody | undefined;
7
9
  gatewayDetails?: Samsara.GatewayDetailsResponseResponseBody | undefined;
8
10
  }
@@ -5,6 +5,8 @@ import type * as Samsara from "../index.js";
5
5
  export interface TrailerStatsObjectResponseBody {
6
6
  /** A list of engine state points. */
7
7
  carrierReeferState?: Samsara.TrailerStatReeferStateWithDecorationsTypeResponseBody[] | undefined;
8
+ /** A map of external ids */
9
+ externalIds?: Record<string, string> | undefined;
8
10
  /** A list of GPS points. */
9
11
  gps?: Samsara.TrailerStatGpsWithDecorationsTypeResponseBody[] | undefined;
10
12
  /** A list of odometer points. */
@@ -4,6 +4,8 @@ import type * as Samsara from "../index.js";
4
4
  */
5
5
  export interface TrailerStatsSnapshotObjectResponseBody {
6
6
  carrierReeferState?: Samsara.TrailerStatReeferStateTypeResponseBody | undefined;
7
+ /** A map of external ids */
8
+ externalIds?: Record<string, string> | undefined;
7
9
  gps?: Samsara.TrailerStatGpsTypeResponseBody | undefined;
8
10
  gpsOdometerMeters?: Samsara.TrailerStatGpsOdometerMetersTypeResponseBody | undefined;
9
11
  /** ID of the trailer. */
@@ -233,6 +233,8 @@ export * from "./BaseRouteResponseObjectResponseBody.js";
233
233
  export * from "./BehaviorCountDetailsRequestBody.js";
234
234
  export * from "./BehaviorCountDetailsResponseBody.js";
235
235
  export * from "./BehaviorResponseBody.js";
236
+ export * from "./BleAssetTagDetailsResponseResponseBody.js";
237
+ export * from "./CameraConnectorDetailsResponseResponseBody.js";
236
238
  export * from "./CameraConnectorDisconectedResponseBody.js";
237
239
  export * from "./CameraDetailsResponseResponseBody.js";
238
240
  export * from "./CameraSerial.js";
@@ -249,6 +249,8 @@ __exportStar(require("./BaseRouteResponseObjectResponseBody.js"), exports);
249
249
  __exportStar(require("./BehaviorCountDetailsRequestBody.js"), exports);
250
250
  __exportStar(require("./BehaviorCountDetailsResponseBody.js"), exports);
251
251
  __exportStar(require("./BehaviorResponseBody.js"), exports);
252
+ __exportStar(require("./BleAssetTagDetailsResponseResponseBody.js"), exports);
253
+ __exportStar(require("./CameraConnectorDetailsResponseResponseBody.js"), exports);
252
254
  __exportStar(require("./CameraConnectorDisconectedResponseBody.js"), exports);
253
255
  __exportStar(require("./CameraDetailsResponseResponseBody.js"), exports);
254
256
  __exportStar(require("./CameraSerial.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "13.29.0";
1
+ export declare const SDK_VERSION = "13.31.0";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "13.29.0";
4
+ exports.SDK_VERSION = "13.31.0";
@@ -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": "13.29.0",
11
- "User-Agent": "@samsarahq/samsara/13.29.0",
10
+ "X-Fern-SDK-Version": "13.31.0",
11
+ "User-Agent": "@samsarahq/samsara/13.31.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",
@@ -4,7 +4,7 @@ import type * as Samsara from "../../../../index.mjs";
4
4
  * {}
5
5
  */
6
6
  export interface AssetsCreateAssetRequestBody {
7
- /** A list of attributes to assign to the asset. */
7
+ /** A list of attributes to assign to the asset. If provided, this replaces the asset's entire set of attribute associations with exactly this list; omit this field to leave existing attribute associations unchanged, or pass an empty array to clear them. */
8
8
  attributes?: Samsara.GoaAttributeTinyRequestBody[];
9
9
  /** A map of external ids */
10
10
  externalIds?: Record<string, string>;
@@ -24,7 +24,7 @@ export interface AssetsCreateAssetRequestBody {
24
24
  regulationMode?: AssetsCreateAssetRequestBody.RegulationMode;
25
25
  /** The serial number of the asset. This can be an internal serial number or used to hold legacy VIN/PIN numbers such as ones of shorter lengths. */
26
26
  serialNumber?: string;
27
- /** An array of IDs of tags to associate with this asset. If your access to the API is scoped by one or more tags, this field is required to pass in. */
27
+ /** An array of IDs of tags to associate with this asset. If provided, this replaces the asset's entire set of tag associations with exactly this list; omit this field to leave existing tag associations unchanged, or pass an empty array to clear them. If your access to the API is scoped by one or more tags, this field is required to pass in. */
28
28
  tagIds?: string[];
29
29
  /** The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle` */
30
30
  type?: AssetsCreateAssetRequestBody.Type;
@@ -1,3 +1,4 @@
1
+ import type * as Samsara from "../../../../index.mjs";
1
2
  /**
2
3
  * @example
3
4
  * {
@@ -7,6 +8,8 @@
7
8
  export interface AssetsUpdateAssetRequestBody {
8
9
  /** A filter selecting a single asset by id. */
9
10
  id: string;
11
+ /** A list of attributes to assign to the asset. If provided, this replaces the asset's entire set of attribute associations with exactly this list; omit this field to leave existing attribute associations unchanged, or pass an empty array to clear them. */
12
+ attributes?: Samsara.GoaAttributeTinyRequestBody[];
10
13
  /** A map of external ids */
11
14
  externalIds?: Record<string, string>;
12
15
  /** The license plate of the asset. */
@@ -25,6 +28,8 @@ export interface AssetsUpdateAssetRequestBody {
25
28
  regulationMode?: AssetsUpdateAssetRequestBody.RegulationMode;
26
29
  /** The serial number of the asset. This can be an internal serial number or used to hold legacy VIN/PIN numbers such as ones of shorter lengths. */
27
30
  serialNumber?: string;
31
+ /** An array of IDs of tags to associate with this asset. If provided, this replaces the asset's entire set of tag associations with exactly this list; omit this field to leave existing tag associations unchanged, or pass an empty array to clear them. If your access to the API is scoped by one or more tags, this field is required to pass in. */
32
+ tagIds?: string[];
28
33
  /** The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle` */
29
34
  type?: AssetsUpdateAssetRequestBody.Type;
30
35
  /** The unique 17-digit VIN (Vehicle Identification Number) or PIN (Product Identification Number) of the asset. */
@@ -2632,7 +2632,7 @@ export declare class BetaApIsClient {
2632
2632
  *
2633
2633
  * @example
2634
2634
  * await client.betaApIs.patchSafetyEventsV2Batch({
2635
- * safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
2635
+ * safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
2636
2636
  * })
2637
2637
  */
2638
2638
  patchSafetyEventsV2Batch(request: Samsara.SafetyEventsV2PatchSafetyEventsV2BatchRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise<Samsara.SafetyEventsV2PatchSafetyEventsV2BatchResponseBody>;
@@ -7549,7 +7549,7 @@ export class BetaApIsClient {
7549
7549
  *
7550
7550
  * @example
7551
7551
  * await client.betaApIs.patchSafetyEventsV2Batch({
7552
- * safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
7552
+ * safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
7553
7553
  * })
7554
7554
  */
7555
7555
  patchSafetyEventsV2Batch(request, requestOptions) {
@@ -2,7 +2,7 @@ import type * as Samsara from "../../../../index.mjs";
2
2
  /**
3
3
  * @example
4
4
  * {
5
- * safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
5
+ * safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
6
6
  * }
7
7
  */
8
8
  export interface SafetyEventsV2PatchSafetyEventsV2BatchRequestBody {
@@ -98,7 +98,7 @@ export declare class MediaClient {
98
98
  * @example
99
99
  * await client.media.postMediaRetrieval({
100
100
  * endTime: "2019-06-13T19:08:55Z",
101
- * inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
101
+ * inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
102
102
  * mediaType: "image",
103
103
  * startTime: "2019-06-13T19:08:25Z",
104
104
  * vehicleId: "1234"
@@ -238,7 +238,7 @@ export class MediaClient {
238
238
  * @example
239
239
  * await client.media.postMediaRetrieval({
240
240
  * endTime: "2019-06-13T19:08:55Z",
241
- * inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
241
+ * inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
242
242
  * mediaType: "image",
243
243
  * startTime: "2019-06-13T19:08:25Z",
244
244
  * vehicleId: "1234"
@@ -2,7 +2,7 @@
2
2
  * @example
3
3
  * {
4
4
  * endTime: "2019-06-13T19:08:55Z",
5
- * inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
5
+ * inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
6
6
  * mediaType: "image",
7
7
  * startTime: "2019-06-13T19:08:25Z",
8
8
  * vehicleId: "1234"
@@ -221,9 +221,6 @@ export interface GetReadingsHistoryRequest {
221
221
  *
222
222
  * * `addressEntry` (Address Entry): Address data from the address entry event
223
223
  * * `addressExit` (Address Exit): Address data from the address exit event
224
- * * `ag51BatteryStatus` (AG51 Battery Status): Battery status of the AG51 gateway based on temperature-compensated voltage threshold. The threshold varies from 3672mV at -40°C to 4579mV at 60°C. (values: ok | low)
225
- * * `ag51BatteryTemperature` (AG51 Battery Temperature): Internal temperature of the AG51 gateway battery in degrees Celsius (celsius)
226
- * * `ag51BatteryVoltage` (AG51 Battery Voltage): Total battery voltage of the AG51 gateway (sum of all 3 cells) in volts (volt)
227
224
  * * `atisLamp` (Atis Lamp status): Atis lamp on/off status (values: off | on)
228
225
  * * `derivedCargoState` (Cargo Status): Indicates if the overall cargo status of the asset is Empty, Partially Empty, Full, or Unknown. (values: unknown | empty | partiallyEmpty | full)
229
226
  * * `doorClosedStatus` (Door Closed Status): Status indicating whether a door is closed or open (values: open | closed)
@@ -232,6 +229,9 @@ export interface GetReadingsHistoryRequest {
232
229
  * * `environmentMonitorAmbientTemperatureBLEConnection` (Ambient Temperature (BLE Connection)): Air temperature at the environmental monitor device (built-in sensor) via BLE Connection. (celsius)
233
230
  * * `environmentMonitorThermistorTemperature` (Thermistor Temperature): Temperature from an external thermistor probe (e.g. cable probe in cargo or reefer). (celsius)
234
231
  * * `environmentMonitorThermistorTemperatureBLEConnection` (Thermistor Temperature (BLE Connection)): Temperature from an external thermistor probe (e.g. cable probe in cargo or reefer) via BLE Connection. (celsius)
232
+ * * `gatewayBatteryStatus` (Gateway Battery Status): Battery status of the gateway based on temperature-compensated voltage threshold. The threshold varies from 3672mV at -40°C to 4579mV at 60°C. (values: ok | low)
233
+ * * `gatewayBatteryTemperature` (Gateway Battery Temperature): Internal temperature of the gateway battery in degrees Celsius (celsius)
234
+ * * `gatewayBatteryVoltage` (Gateway Battery Voltage): Total battery voltage of the gateway (sum of all 3 cells) in volts (volt)
235
235
  * * `trailerMovingWithoutPower` (Trailer Moving Without Power): Trailer moving without power status (values: off | on)
236
236
  * * `validBrakeScore` (Braking Performance Value): Percent score representing trailer braking effectiveness using regression analysis over the past 90 days, guaranteed to have under 3% margin of error. (percent)
237
237
  * * `widgetBatteryVoltage` (Widget Battery Voltage): Battery voltage level of the widget sensor in millivolts (volt)
@@ -221,9 +221,6 @@ export interface GetReadingsSnapshotRequest {
221
221
  *
222
222
  * * `addressEntry` (Address Entry): Address data from the address entry event
223
223
  * * `addressExit` (Address Exit): Address data from the address exit event
224
- * * `ag51BatteryStatus` (AG51 Battery Status): Battery status of the AG51 gateway based on temperature-compensated voltage threshold. The threshold varies from 3672mV at -40°C to 4579mV at 60°C. (values: ok | low)
225
- * * `ag51BatteryTemperature` (AG51 Battery Temperature): Internal temperature of the AG51 gateway battery in degrees Celsius (celsius)
226
- * * `ag51BatteryVoltage` (AG51 Battery Voltage): Total battery voltage of the AG51 gateway (sum of all 3 cells) in volts (volt)
227
224
  * * `atisLamp` (Atis Lamp status): Atis lamp on/off status (values: off | on)
228
225
  * * `derivedCargoState` (Cargo Status): Indicates if the overall cargo status of the asset is Empty, Partially Empty, Full, or Unknown. (values: unknown | empty | partiallyEmpty | full)
229
226
  * * `doorClosedStatus` (Door Closed Status): Status indicating whether a door is closed or open (values: open | closed)
@@ -232,6 +229,9 @@ export interface GetReadingsSnapshotRequest {
232
229
  * * `environmentMonitorAmbientTemperatureBLEConnection` (Ambient Temperature (BLE Connection)): Air temperature at the environmental monitor device (built-in sensor) via BLE Connection. (celsius)
233
230
  * * `environmentMonitorThermistorTemperature` (Thermistor Temperature): Temperature from an external thermistor probe (e.g. cable probe in cargo or reefer). (celsius)
234
231
  * * `environmentMonitorThermistorTemperatureBLEConnection` (Thermistor Temperature (BLE Connection)): Temperature from an external thermistor probe (e.g. cable probe in cargo or reefer) via BLE Connection. (celsius)
232
+ * * `gatewayBatteryStatus` (Gateway Battery Status): Battery status of the gateway based on temperature-compensated voltage threshold. The threshold varies from 3672mV at -40°C to 4579mV at 60°C. (values: ok | low)
233
+ * * `gatewayBatteryTemperature` (Gateway Battery Temperature): Internal temperature of the gateway battery in degrees Celsius (celsius)
234
+ * * `gatewayBatteryVoltage` (Gateway Battery Voltage): Total battery voltage of the gateway (sum of all 3 cells) in volts (volt)
235
235
  * * `trailerMovingWithoutPower` (Trailer Moving Without Power): Trailer moving without power status (values: off | on)
236
236
  * * `validBrakeScore` (Braking Performance Value): Percent score representing trailer braking effectiveness using regression analysis over the past 90 days, guaranteed to have under 3% margin of error. (percent)
237
237
  * * `widgetBatteryVoltage` (Widget Battery Voltage): Battery voltage level of the widget sensor in millivolts (volt)
@@ -0,0 +1,19 @@
1
+ /**
2
+ * BLE asset tag-specific health metadata details.
3
+ */
4
+ export interface BleAssetTagDetailsResponseResponseBody {
5
+ /** The BLE asset tag's battery state. Valid values: `critical`, `low`, `ok`, `unknown` */
6
+ batteryState?: BleAssetTagDetailsResponseResponseBody.BatteryState | undefined;
7
+ /** The timestamp when the BLE asset tag was last detected by a gateway in the Samsara network, in RFC 3339 format. */
8
+ lastCheckInTime?: string | undefined;
9
+ }
10
+ export declare namespace BleAssetTagDetailsResponseResponseBody {
11
+ /** The BLE asset tag's battery state. Valid values: `critical`, `low`, `ok`, `unknown` */
12
+ const BatteryState: {
13
+ readonly Critical: "critical";
14
+ readonly Low: "low";
15
+ readonly Ok: "ok";
16
+ readonly Unknown: "unknown";
17
+ };
18
+ type BatteryState = (typeof BatteryState)[keyof typeof BatteryState];
19
+ }
@@ -0,0 +1,11 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var BleAssetTagDetailsResponseResponseBody;
3
+ (function (BleAssetTagDetailsResponseResponseBody) {
4
+ /** The BLE asset tag's battery state. Valid values: `critical`, `low`, `ok`, `unknown` */
5
+ BleAssetTagDetailsResponseResponseBody.BatteryState = {
6
+ Critical: "critical",
7
+ Low: "low",
8
+ Ok: "ok",
9
+ Unknown: "unknown",
10
+ };
11
+ })(BleAssetTagDetailsResponseResponseBody || (BleAssetTagDetailsResponseResponseBody = {}));
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Camera connector-specific health metadata details.
3
+ */
4
+ export interface CameraConnectorDetailsResponseResponseBody {
5
+ /** The timestamp when the gateway was last connected to the vehicle, in RFC 3339 format. */
6
+ gatewayLastConnectedTime?: string | undefined;
7
+ /** The percentage of successful recording time during the time when the vehicle is on an active trip over the past 50 hours, in percentage points. */
8
+ lastFiftyHoursUptimePercentage?: number | undefined;
9
+ /** The serial number of the vehicle gateway that the camera connector is connected to. */
10
+ vehicleGatewaySerial?: string | undefined;
11
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -3,6 +3,8 @@ import type * as Samsara from "../index.mjs";
3
3
  * Detailed health related metadata for the device.
4
4
  */
5
5
  export interface HealthDetailsResponseResponseBody {
6
+ bleAssetTagDetails?: Samsara.BleAssetTagDetailsResponseResponseBody | undefined;
7
+ cameraConnectorDetails?: Samsara.CameraConnectorDetailsResponseResponseBody | undefined;
6
8
  cameraDetails?: Samsara.CameraDetailsResponseResponseBody | undefined;
7
9
  gatewayDetails?: Samsara.GatewayDetailsResponseResponseBody | undefined;
8
10
  }
@@ -5,6 +5,8 @@ import type * as Samsara from "../index.mjs";
5
5
  export interface TrailerStatsObjectResponseBody {
6
6
  /** A list of engine state points. */
7
7
  carrierReeferState?: Samsara.TrailerStatReeferStateWithDecorationsTypeResponseBody[] | undefined;
8
+ /** A map of external ids */
9
+ externalIds?: Record<string, string> | undefined;
8
10
  /** A list of GPS points. */
9
11
  gps?: Samsara.TrailerStatGpsWithDecorationsTypeResponseBody[] | undefined;
10
12
  /** A list of odometer points. */
@@ -4,6 +4,8 @@ import type * as Samsara from "../index.mjs";
4
4
  */
5
5
  export interface TrailerStatsSnapshotObjectResponseBody {
6
6
  carrierReeferState?: Samsara.TrailerStatReeferStateTypeResponseBody | undefined;
7
+ /** A map of external ids */
8
+ externalIds?: Record<string, string> | undefined;
7
9
  gps?: Samsara.TrailerStatGpsTypeResponseBody | undefined;
8
10
  gpsOdometerMeters?: Samsara.TrailerStatGpsOdometerMetersTypeResponseBody | undefined;
9
11
  /** ID of the trailer. */
@@ -233,6 +233,8 @@ export * from "./BaseRouteResponseObjectResponseBody.mjs";
233
233
  export * from "./BehaviorCountDetailsRequestBody.mjs";
234
234
  export * from "./BehaviorCountDetailsResponseBody.mjs";
235
235
  export * from "./BehaviorResponseBody.mjs";
236
+ export * from "./BleAssetTagDetailsResponseResponseBody.mjs";
237
+ export * from "./CameraConnectorDetailsResponseResponseBody.mjs";
236
238
  export * from "./CameraConnectorDisconectedResponseBody.mjs";
237
239
  export * from "./CameraDetailsResponseResponseBody.mjs";
238
240
  export * from "./CameraSerial.mjs";
@@ -233,6 +233,8 @@ export * from "./BaseRouteResponseObjectResponseBody.mjs";
233
233
  export * from "./BehaviorCountDetailsRequestBody.mjs";
234
234
  export * from "./BehaviorCountDetailsResponseBody.mjs";
235
235
  export * from "./BehaviorResponseBody.mjs";
236
+ export * from "./BleAssetTagDetailsResponseResponseBody.mjs";
237
+ export * from "./CameraConnectorDetailsResponseResponseBody.mjs";
236
238
  export * from "./CameraConnectorDisconectedResponseBody.mjs";
237
239
  export * from "./CameraDetailsResponseResponseBody.mjs";
238
240
  export * from "./CameraSerial.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "13.29.0";
1
+ export declare const SDK_VERSION = "13.31.0";
@@ -1 +1 @@
1
- export const SDK_VERSION = "13.29.0";
1
+ export const SDK_VERSION = "13.31.0";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@samsarahq/samsara",
3
- "version": "13.29.0",
3
+ "version": "13.31.0",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -6528,7 +6528,7 @@ To use this endpoint, select **Write Safety Events & Scores** under the Safety &
6528
6528
 
6529
6529
  ```typescript
6530
6530
  await client.betaApIs.patchSafetyEventsV2Batch({
6531
- safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
6531
+ safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"]
6532
6532
  });
6533
6533
 
6534
6534
  ```
@@ -8273,7 +8273,7 @@ To use this endpoint, select **Write Media Retrieval** under the Safety & Camera
8273
8273
  ```typescript
8274
8274
  await client.media.postMediaRetrieval({
8275
8275
  endTime: "2019-06-13T19:08:55Z",
8276
- inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
8276
+ inputs: ["dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing"],
8277
8277
  mediaType: "image",
8278
8278
  startTime: "2019-06-13T19:08:25Z",
8279
8279
  vehicleId: "1234"