@samsarahq/samsara 5.7.2 → 5.9.0

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

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface DeleteRidershipAccountRequest {
+    /** The Samsara UUID of the ridership account. */
+    id: string;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface DeleteRidershipPassengerRequest {
+    /** The Samsara UUID of the ridership passenger. */
+    id: string;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         routeId: "routeId"
+ *     }
+ */
+export interface DeleteRidershipRouteSetupRequest {
+    /** The route ID. This is the Samsara route ID returned by the Routing API. */
+    routeId: string;
+}

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

@@ -0,0 +1,17 @@
+import type * as Samsara from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         id: 1000000,
+ *         relayStates: [{
+ *                 id: "relay1",
+ *                 isOpen: true
+ *             }]
+ *     }
+ */
+export interface EngineImmobilizerUpdateEngineImmobilizerStateRequestBody {
+    /** Vehicle ID */
+    id: number;
+    /** A list of relay states. If a relay is omitted, its state won't be updated. If the list is empty, a 400 bad request status code will be returned. If there are multiple states for the same relay, a 400 bad request status code will be returned. */
+    relayStates: Samsara.UpdateEngineImmobilizerRelayStateRequestBodyRequestBody[];
+}

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

@@ -0,0 +1,27 @@
+import type * as Samsara from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface EquipmentPatchEquipmentRequestBody {
+    /** The unique Samsara ID of the Equipment. This is automatically generated when the Equipment object is created. It cannot be changed. */
+    id: string;
+    /** List of attributes associated with the entity */
+    attributes?: Samsara.GoaAttributeTiny[];
+    /** When you provide a manual engine hours override, Samsara will begin updating a equipment's engine hours used since this override was set. */
+    engineHours?: number;
+    /** The serial number of the equipment. */
+    equipmentSerialNumber?: string;
+    /** A map of external ids */
+    externalIds?: Record<string, string>;
+    /** The human-readable name of the Equipment. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time. */
+    name?: string;
+    /** These are generic notes about the Equipment. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time. */
+    notes?: string;
+    /** When you provide a manual odometer override, Samsara will begin updating a equipment's odometer using GPS distance traveled since this override was set. */
+    odometerMeters?: number;
+    /** An array of IDs of tags to associate with this equipment. If your access to the API is scoped by one or more tags, this field is required to pass in. */
+    tagIds?: string[];
+}

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

@@ -0,0 +1,19 @@
+/**
+ * @example
+ *     {
+ *         name: "name",
+ *         paramsOverride: {}
+ *     }
+ */
+export interface FunctionsStartFunctionRunRequestBody {
+    /** The name of the Function to run. */
+    name: string;
+    /** Parameter overrides for the Function execution. Can be an empty object but must be provided. */
+    paramsOverride: FunctionsStartFunctionRunRequestBody.ParamsOverride;
+}
+export declare namespace FunctionsStartFunctionRunRequestBody {
+    /**
+     * Parameter overrides for the Function execution. Can be an empty object but must be provided.
+     */
+    type ParamsOverride = {};
+}

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

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         pageNumber: "pageNumber"
+ *     }
+ */
+export interface GetAempEquipmentListRequest {
+    /** The number corresponding to a specific page of paginated results, defaulting to the first page if not provided. The default page size is 100 records. */
+    pageNumber: string;
+}

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

@@ -0,0 +1,230 @@
+/**
+ * @example
+ *     {
+ *         readingId: "readingId",
+ *         entityType: "entityType"
+ *     }
+ */
+export interface GetReadingsHistoryRequest {
+    /**  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;
+    /**
+     * The reading ID to retrieve data for. Use /readings/definitions endpoint to get a list of valid reading IDs. (Examples: engineRpm,fuelLevel)
+     *
+     * Available reading IDs (by category):
+     *
+     *
+     * **diagnostic**
+     *
+     * * `airInletPressure` (Air Inlet Pressure): Air inlet pressure. (kilopascal)
+     * * `airTemp` (Air Inlet (Ambient Air) Temp): Air inlet (ambient air) temperature. (celsius)
+     * * `altitude` (Altitude): The altitude of the asset (meter)
+     * * `altitudeAccuracy` (Altitude Uncertainty): The uncertainty of the asset's GPS-based altitude. (meter)
+     * * `assetStatus` (Status): Combined movement and equipment status derived from location & Digio events. (values: movementStart | movementEnd | stopped | none | equipmentOn | equipmentOff)
+     * * `averageACCurrent` (Average AC Current): Average AC current in amperes. (ampere)
+     * * `averageACFrequency` (Average AC Frequency): Average AC frequency in Hertz. (hertz)
+     * * `averageLineToLineACRMSVoltage` (Average Line-to-Line Voltage): Average RMS voltage between AC lines in volts. (volt)
+     * * `averageLineToNeutralACRMSVoltage` (Average Line-to-Neutral Voltage): Average RMS voltage from AC line to neutral in volts. (volt)
+     * * `barometerPressure` (Barometric Pressure): Atmospheric pressure as measured by the barometer. (kilopascal)
+     * * `batteryPotentialSwitched` (Battery Potential (Switched)): Switched battery potential in volts. (volt)
+     * * `batteryVoltage` (Battery Voltage): Voltage of the asset's battery. (volt)
+     * * `boostPressureEngineTurbocharger1` (Engine Turbocharger 1 Boost Pressure): Represents the boost pressure for engine turbocharger 1. (kilopascal)
+     * * `boostPressurePa` (Boost Pressure): Represents the boost pressure. (kilopascal)
+     * * `boostPressureTurbocharger2` (Boost Pressure (Turbocharger 2)): Boost pressure from the second turbocharger in kPa. (kilopascal)
+     * * `canBusType` (CAN Bus Status): Indicates whether the CAN Bus system is active or provides an invalid reading. (values: invalid | active)
+     * * `checkEngineLightJ1939Emissions` (Check Engine Light (J1939) - Emissions): Indicates whether the J1939 check engine light emissions indicator is active or inactive. (values: off | on)
+     * * `checkEngineLightJ1939Protect` (Check Engine Light (J1939) - Protect): Indicates whether the J1939 check engine light protect indicator is active or inactive. (values: off | on)
+     * * `checkEngineLightJ1939Stop` (Check Engine Light (J1939) - Stop): Indicates whether the J1939 check engine light stop indicator is active or inactive. (values: off | on)
+     * * `checkEngineLightJ1939Warning` (Check Engine Light (J1939) - Warning): Indicates whether the J1939 check engine light warning indicator is active or inactive. (values: off | on)
+     * * `checkEngineLightPassenger` (Check Engine Light (Passenger)): Indicates whether the passenger check engine light indicator is active or inactive. (values: off | on)
+     * * `coolantTemp` (Engine Coolant Temp): Represents the engine coolant temperature. (celsius)
+     * * `defLevel` (DEF Level): Represents the DEF (Diesel Exhaust Fluid) level percentage. (percent)
+     * * `derivedFuelConsumed` (Lifetime Fuel Consumed (Samsara)): Samsara-maintained fuel consumption since the device was firstinstalled. (liter)
+     * * `deviceOrientation` (Device Orientation): Indicates orientation of the device. (values: invalid | unknown | topDown | bottomDown | leftDown | rightDown | backDown | frontDown)
+     * * `digioInput1` (Digital IO #1): Represents the state of digital IO #1. (values: off | on)
+     * * `dpfLampStatus` (DPF Lamp Status): Status of the Diesel Particulate Filter warning lamp. (values: off | on | blinking)
+     * * `dpfSootLoadPercent` (DPF Soot Load): Diesel Particulate Filter soot load percentage. (percent)
+     * * `ecuHistoryTotalRunTime` (ECU Total Run Time): Total engine run time from ECU in seconds. (second)
+     * * `engineHours` (Engine Hours (ECU)): Represents the total engine runtime in hours as reported by the ECU. (second)
+     * * `engineHoursDigioBased` (Engine Hours (Synthetic - Aux input)): Represents the synthetic total engine runtime in hours based on auxiliary input. (millisecond)
+     * * `engineHoursEngineStateBased` (Engine Hours (Synthetic)): Represents the synthetic total engine runtime in hours based on engine state. (millisecond)
+     * * `engineIntakeAirTemp` (Engine Intake Air Temperature): Represents the engine intake air temperature. (celsius)
+     * * `engineLoadPercent` (Engine Load): Engine load percentage. (percent)
+     * * `engineState` (Engine State): Indicates the current state of the engine, such as running, stopped. (values: off | running | idling)
+     * * `ev24VoltDcDcInverterCurrent` (EV 24V DC/DC Inverter Current): Current from the 24V DC-DC inverter in amperes. (ampere)
+     * * `evAverageCellTemperature` (EV Average Cell Temperature): Average temperature of EV battery cells in degrees Celsius. (celsius)
+     * * `evChargingErrorStatus` (EV Charging Error Status): Indicates if the EV charging system has an error. (values: noError | batteryTooHotOrCold | vehicleNotInPark | connectorLockFault | chargingSystemFault | chargingCurrentDifferential | chargingVoltageOutOfRange | chargingSystemNotCompatible | noDataUndeterminedStatus | notAvailable | unknownError)
+     * * `evHighCapacityBatteryCurrent` (EV High Capacity Battery Current): Current from the high capacity EV battery in amperes. (ampere)
+     * * `evHighCapacityBatteryVoltage` (High Capacity EV Battery Voltage): Represents the voltage of the high capacity EV battery. (volt)
+     * * `evMaxAllowedStateOfChargePercent` (EV Max Allowed State of Charge): Maximum allowed state of charge percentage. (percent)
+     * * `evMaxCellTemperature` (EV Max Cell Temperature): Maximum temperature of EV battery cells in degrees Celsius. (celsius)
+     * * `evMinAllowedStateOfChargePercent` (EV Min Allowed State of Charge): Minimum allowed state of charge percentage. (percent)
+     * * `evMinCellTemperature` (EV Min Cell Temperature): Minimum temperature of EV battery cells in degrees Celsius. (celsius)
+     * * `exhaustGasPressure` (Exhaust Gas Pressure): Represents the exhaust gas pressure. (kilopascal)
+     * * `fuelConsumptionRate` (Fuel Consumption Rate): The rate at which an asset uses fuel (litersperhour)
+     * * `fuelLevelPerc` (Fuel Level): Percentage of fuel remaining in the tank. (percent)
+     * * `fuelSource` (Fuel Source): Type of fuel used by the asset. (values: gasoline | diesel)
+     * * `geoCoordinates` (Geo Coordinates): GPS coordinates (latitude and longitude) of the asset's location.
+     * * `gpsSpeed` (GPS Speed): Asset speed measured by the gateway's GPS receiver. (meterspersec)
+     * * `ignitionStatus` (Ignitions Status): Indicates the current ignition status as a voltage (values: off | on)
+     * * `latitude` (Latitude): Latitude coordinate of the asset's location. (decimaldegrees)
+     * * `lifetimeFuelConsumed` (Lifetime Fuel Consumed): Represents the vehicle maintained lifetime fuel consumption as reported by the vehicle. (liter)
+     * * `location` (Location): Represents the current address of the asset.
+     * * `longitude` (Longitude): Longitude coordinate of the asset's location. (decimaldegrees)
+     * * `mnfldTemp` (Intake Manifold Temp): Represents the intake manifold temperature. (celsius)
+     * * `ngFuelPressure` (NG Fuel Pressure): Represents the natural gas fuel pressure. (kilopascal)
+     * * `odometerEcu` (Odometer (ECU)): Represents the total distance traveled as recorded by the ECU. (meter)
+     * * `odometerGps` (Odometer (GPS)): Represents the total distance traveled as determined by GPS. (meter)
+     * * `oilPressure` (Engine Oil Pressure): Represents the oil pressure in the engine. (kilopascal)
+     * * `phaseAACFrequency` (Phase A AC Frequency): AC frequency for Phase A in Hertz. (hertz)
+     * * `phaseAAmpsRms` (Phase A Current (RMS)): RMS current for Phase A in amperes. (ampere)
+     * * `phaseALLVolts` (Phase A Line-to-Line Voltage): Line-to-line voltage for Phase A in volts. (volt)
+     * * `phaseALNVolts` (Phase A Line-to-Neutral Voltage): Line-to-neutral voltage for Phase A in volts. (volt)
+     * * `phaseBAmpsRms` (Phase B Current (RMS)): RMS current for Phase B in amperes. (ampere)
+     * * `phaseBLLVolts` (Phase B Line-to-Line Voltage): Line-to-line voltage for Phase B in volts. (volt)
+     * * `phaseBLNVolts` (Phase B Line-to-Neutral Voltage): Line-to-neutral voltage for Phase B in volts. (volt)
+     * * `phaseCAmpsRms` (Phase C Current (RMS)): RMS current for Phase C in amperes. (ampere)
+     * * `phaseCLLVolts` (Phase C Line-to-Line Voltage): Line-to-line voltage for Phase C in volts. (volt)
+     * * `phaseCLNVolts` (Phase C Line-to-Neutral Voltage): Line-to-neutral voltage for Phase C in volts. (volt)
+     * * `powerFactorRatio` (Power Factor Ratio): Represents the power factor ratio. (percent)
+     * * `samsaraEngineHours` (Samsara Engine Hours): Samsara's intelligent engine hours calculation that combines ECU data, synthetic calculations, and manual overrides with automatic fallbacks for optimal accuracy across all asset types. (millisecond)
+     * * `samsaraEngineHoursWithSource` (Samsara Engine Hours with Source): Samsara's intelligent engine hours calculation including detailed source metadata to indicate the origin of the data (ECU, synthetic, or manual override). Useful for debugging and understanding data provenance.
+     * * `samsaraOdometer` (Samsara Odometer): Samsara automatically pulls odometer readings from a vehicle's engine control unit (ECU). If the reading isn't available and the vehicle is unregulated, you can manually enter the odometer value for maintenance tracking—this value will then update based on GPS trip data. (kilometer)
+     * * `samsaraSpeed` (Samsara Speed): Samsara's best estimate of the asset speed, combining multiple data sources such as ECU and GPS. (meterspersec)
+     * * `samsaraSpeedLimit` (Samsara Speed Limit): Speed limit at the location of the asset. (meterspersec)
+     * * `seatbeltDriver` (Seatbelt (Driver)): Indicates whether the driver's seatbelt is buckled or unbuckled. (values: unbuckled | buckled)
+     * * `seatbeltPassenger` (Seatbelt (Passenger)): Indicates whether the passenger's seatbelt is buckled or unbuckled. (values: unbuckled | buckled)
+     * * `supportFindNearby` (Support Find Nearby): Indicates if the asset can support find nearby. (values: noData | notCompatible | pendingUpgrade | Ready)
+     * * `tirePressuresBackLeft` (Tire pressure, back left): Represents the tire pressure for the back-left tire. (kilopascal)
+     * * `tirePressuresBackRight` (Tire pressure, back right): Represents the tire pressure for the back-right tire. (kilopascal)
+     * * `tirePressuresFrontLeft` (Tire pressure, front left): Represents the tire pressure for the front-left tire. (kilopascal)
+     * * `tirePressuresFrontRight` (Tire pressure, front right): Represents the tire pressure for the front-right tire. (kilopascal)
+     * * `torquePercent` (Torque): Engine torque as a percentage. (percent)
+     * * `totalApparentPower` (Total Apparent Power): Total apparent power in volt-amperes. (voltAmpere)
+     * * `totalEnergyExported` (Total Energy Exported): Represents the total energy exported in kilowatt-hours (kWh). (kilowatthour)
+     * * `totalReactivePower` (Total Reactive Power): Total reactive power in volt-amperes reactive. (voltAmpereReactive)
+     * * `totalRealPower` (Total Real Power): Total real power in watts. (watt)
+     *
+     * **levelMonitoring**
+     *
+     * * `fillCriticality` (Fill Level Criticality): Indicates if the state of the fill level is critical. (values: normal | criticallyHigh | criticallyLow)
+     * * `fillMass` (Fill Mass): Mass of material in the vessel. (kilogram)
+     * * `fillMassAvailableCapacity` (Fill Mass Available Capacity): Available mass to be filled in the vessel. (kilogram)
+     * * `fillPercent` (Fill Level Percent): Fill level of the vessel as a percentage full. (percent)
+     * * `fillVolume` (Fill Volume): Volume of material in the vessel. (liter)
+     * * `fillVolumeAvailableCapacity` (Fill Volume Available Capacity): Available volume to be filled in the vessel. (liter)
+     * * `fluidLevelStatus` (Battery Water Level): The status of the battery's water level. Will be OK or LOW. (values: noData | ok | low)
+     *
+     * **obd**
+     *
+     * * `accDistanceAlertSignal` (ACC Distance Alert): Distance Alert Signal from the Adaptive Cruise Control system. (values: notActive | active)
+     * * `adaptiveCruiseControlMode` (ACC Mode): Current mode of the Adaptive Cruise Control System. (values: off | speedControlActive | distanceControlActive | overtakeMode | holdMode | finishMode | disabledOrError)
+     * * `aebsDriverActivationDemand` (AEBS Activation): Whether Advanced Emergency Braking is enabled or disabled by the driver. (values: deactivated | activated)
+     * * `cruiseControlFinalSetSpeed` (Cruise Control Final Set Speed): Includes driver set point and overrides from the ACC system. (kmperhr)
+     * * `cruiseControlSetSpeed` (Cruise Control Set Speed): Driver's set speed for the cruise control system. (kmperhr)
+     * * `cruiseControlSwitch` (Cruise Control Switch): The state of the cruise control switch. (values: off | on | error)
+     * * `driverAlertnessWarning` (Driver Alertness Warning): Driver Alertness Warning. (values: noConditionDetected | level1MildDistraction | level2Degradation | level3Warning)
+     * * `driverAlertnessWarningSystemState` (Driver Alertness Warning State): State of the Driver Alertness Warning system. (values: installedButDisabled | initializing | temporarilyNotAvailable | available | monitoringDriverBehavior)
+     * * `ecuSpeed` (ECU Speed): Speed read from the asset's OBD port. (kmperhr)
+     * * `emergencyBrakingActive` (Emergency Braking State): State of the Emergency Braking System. (values: inactive | active)
+     * * `emergencyBrakingAebsState` (AEBS State (Collision)): State of the Emergency Braking System for Forward Collision. (values: notReady | temporarilyNotAvailable | deactivatedByDriver | readyAndActivated | driverOverrides | forwardCollisionWarningActive | forwardCollisionWarningWithBraking | forwardCollisionEmergencyBrakingActive | performanceLimited | error)
+     * * `externalBrakeRequestReason` (Self-Braking Reason/Mode): Brake reason/mode for the emergency self-braking system. (values: collisionAvoidance | stabilityControl | cruiseControlRoadSpeed | adaptiveCruiseControlDistanceControl | driverWarningHapticIndicator)
+     * * `forwardCollisionWarningLevel` (AEBS FCW Level): Severity level of the AEBS Forward Collision Warning. (values: noWarning | level1 | level2 | level3 | level4 | level5 | level6 | level7)
+     * * `forwardCollisionWarningStatus` (ACC FCW Status): Status of the Adaptive Cruise Control Forward Collision Warning system. (values: noWarning | collisionImminent | error)
+     * * `forwardLaneImagerStatus` (Forward Lane Imager State): State of the Forward Lane Imager. (values: fullyOperational | warmingUp | partiallyBlocked | fullyBlocked | misaligned | viewDegraded | error)
+     * * `imminentLeftLaneDeparture` (Imminent Left Lane Departure): State of the Imminent Left Lane Departure detection. (values: notImminent | imminent)
+     * * `imminentRightLaneDeparture` (Imminent Right Lane Departure): State of the Imminent Right Lane Departure detection. (values: notImminent | imminent)
+     * * `laneCenteringSystemState` (Lane Centering State): State of the Lane Centering System. (values: notReady | temporarilyNotAvailable | deactivatedByDriver | ready | suppressedByOperator | actuating | error)
+     * * `laneDepartureIndicationStatus` (LDW Indication): State of the Lane Departure Indication system. (values: disabled | enabled)
+     * * `laneDepartureWarningSystemState` (LDW System State): State of the Lane Departure Warning system. (values: notReady | temporarilyNotAvailable | deactivatedByDriver | ready | warningSuppressed | warningLaneDeparture | error)
+     * * `laneKeepingAssistSystemState` (LKAS State): State of the Lane Keep Assist System. (values: notReady | temporarilyNotAvailable | deactivatedByDriver | ready | suppressedByOperator | actuating | error)
+     * * `leftLaneDeparture` (Left Lane Departure): State of the Left Lane Departure detection. (values: notDeparting | departing)
+     * * `rightLaneDeparture` (Right Lane Departure): State of the Right Lane Departure detection. (values: notDeparting | departing)
+     * * `roadDepartureAebsState` (AEBS State (Lane Departure)): State of the AEBS system for Lane Departure. (values: notReady | temporarilyNotAvailable | deactivatedByDriver | readyAndActivated | driverOverrides | roadDepartureWarningActive | roadDepartureWarningWithBraking | roadDepartureEmergencyBrakingActive | performanceLimited | error)
+     * * `ropBrakeControlActive` (ROP Brake Control Active): Indicates whether Roll Over Prevention (ROP) has activated brake control. (values: passive | active)
+     * * `ropEngineControlActive` (ROP Engine Control Active): Indicates whether Roll Over Prevention (ROP) has commanded engine control to be active. (values: passive | active)
+     * * `tractionControlOverrideSwitch` (Traction Control Override Switch): When the switch is on, the automatic traction control function is disabled by the driver. (values: off | on | error)
+     * * `turnSignal` (Turn Signal): State of the turn signal switch (blinker). (values: off | left | right)
+     * * `vdcFullyOperational` (VDC Fully Operational): Indicates whether the Vehicle Dynamic Stability Control (VDC) system is fully operational. (values: notFullyOperational | fullyOperational)
+     * * `vehicleGear` (Vehicle Gear): The gear of the vehicle that is currently selected. (values: unknown | park | neutral | reverse | drive)
+     * * `xbrActiveControlMode` (Emergency Self-Braking System Mode): Current mode of the emergency self-braking system. (values: noBrakeDemand | driverBrakeDemand | additionMode | maximumMode | brakeHold)
+     * * `xbrSystemState` (Emergency Self-Braking System Operational State): State of the emergency self-braking system. (values: fullyOperational | highestPriorityOnly | noRequestsAccepted)
+     * * `ycBrakeControlActive` (YC Brake Control Active): Indicates whether Yaw Control (YC) has activated brake control. (values: passive | active)
+     * * `ycEngineControlActive` (YC Engine Control Active): Indicates whether Yaw Control (YC) has commanded engine control to be active. (values: passive | active)
+     *
+     * **pressureVesselHealth**
+     *
+     * * `pressureVesselBatteryLevelPercentage` (Pressure Vessel Battery Level Percentage): Battery level percentage of the pressure vessel. (percent)
+     * * `pressureVesselPressure` (Pressure Vessel Pressure): Pressure of the pressure vessel. (kilopascal)
+     * * `pressureVesselTemperature` (Pressure Vessel Temperature): Temperature of the pressure vessel. (celsius)
+     *
+     * **reefer**
+     *
+     * * `reeferAlarm` (Reefer Alarms): Array of active alarm codes for the refrigeration unit with metadata
+     * * `reeferAlarmSeverity` (Reefer Alarm Severity): Highest severity level across active reefer alarms (green, yellow, red, orange) (values: none | green | yellow | red | orange)
+     * * `reeferAmbientAir` (Reefer Ambient Air Temperature): External environment temperature for the reefer (celsius)
+     * * `reeferBatteryVoltage` (Reefer Battery Voltage): The voltage of the Refrigeration Unit's battery. (volt)
+     * * `reeferDoorOpenZone1` (Reefer Door Open (Zone 1)): Status indicating whether the reefer's door (zone 1) is closed or open (values: closed | open)
+     * * `reeferDoorOpenZone2` (Reefer Door Open (Zone 2)): Status indicating whether the reefer's door (zone 2) is closed or open (values: closed | open)
+     * * `reeferDoorOpenZone3` (Reefer Door Open (Zone 3)): Status indicating whether the reefer's door (zone 3) is closed or open (values: closed | open)
+     * * `reeferEngineHours` (Reefer Engine Hours): The total accumulated hours that the Refrigeration Unit has been running on its engine. (hour)
+     * * `reeferFuelLevel` (Reefer Fuel Level): Refrigeration Unit Fuel Level (%) (percent)
+     * * `reeferPowerSource` (Reefer Power Source): The power source of the refrigeration unit (Diesel, Electric or Cryo) (values: engine | electric | cryo)
+     * * `reeferReturnAirZone1` (Reefer Return Air Temperature (Zone 1)): Return air temperature for the reefer's zone 1 (celsius)
+     * * `reeferReturnAirZone2` (Reefer Return Air Temperature (Zone 2)): Return air temperature for the reefer's zone 2 (celsius)
+     * * `reeferReturnAirZone3` (Reefer Return Air Temperature (Zone 3)): Return air temperature for the reefer's zone 3 (celsius)
+     * * `reeferRunMode` (Reefer Run Mode): The run mode of the refrigeration unit (Continuous or Start/Stop) (values: continuous | startStop)
+     * * `reeferSetPointZone1` (Reefer Set Point (Zone 1)): Current set point for the reefer's zone 1 (celsius)
+     * * `reeferSetPointZone2` (Reefer Set Point (Zone 2)): Current set point for the reefer's zone 2 (celsius)
+     * * `reeferSetPointZone3` (Reefer Set Point (Zone 3)): Current set point for the reefer's zone 3 (celsius)
+     * * `reeferState` (Reefer State): The on/off state of the refrigeration unit (values: off | active | error | inactive)
+     * * `reeferStateZone1` (Reefer State (Zone 1)): The on/off state of the refrigeration unit (Zone 1) (values: off | active | error | inactive)
+     * * `reeferStateZone2` (Reefer State (Zone 2)): The on/off state of the refrigeration unit (Zone 2) (values: off | active | error | inactive)
+     * * `reeferStateZone3` (Reefer State (Zone 3)): The on/off state of the refrigeration unit (Zone 3) (values: off | active | error | inactive)
+     * * `reeferSupplyAirZone1` (Reefer Supply Air Temperature (Zone 1)): Supply air temperature for the reefer's zone 1 (celsius)
+     * * `reeferSupplyAirZone2` (Reefer Supply Air Temperature (Zone 2)): Supply air temperature for the reefer's zone 2 (celsius)
+     * * `reeferSupplyAirZone3` (Reefer Supply Air Temperature (Zone 3)): Supply air temperature for the reefer's zone 3 (celsius)
+     * * `reeferTemperatureRecorder1` (Reefer Temperature Recorder (Zone 1)): Temperature recorder reading for reefer zone 1 (celsius)
+     * * `reeferTemperatureRecorder2` (Reefer Temperature Recorder (Zone 2)): Temperature recorder reading for reefer zone 2 (celsius)
+     * * `reeferTemperatureRecorder3` (Reefer Temperature Recorder (Zone 3)): Temperature recorder reading for reefer zone 3 (celsius)
+     * * `reeferTemperatureRecorder4` (Reefer Temperature Recorder (Zone 4)): Temperature recorder reading for reefer zone 4 (celsius)
+     * * `reeferTemperatureRecorder5` (Reefer Temperature Recorder (Zone 5)): Temperature recorder reading for reefer zone 5 (celsius)
+     * * `reeferTemperatureRecorder6` (Reefer Temperature Recorder (Zone 6)): Temperature recorder reading for reefer zone 6 (celsius)
+     *
+     * **smartTrailer**
+     *
+     * * `addressEntry` (Address Entry): Address data from the address entry event
+     * * `addressExit` (Address Exit): Address data from the address exit event
+     * * `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)
+     * * `ag51BatteryTemperature` (AG51 Battery Temperature): Internal temperature of the AG51 gateway battery in degrees Celsius (celsius)
+     * * `ag51BatteryVoltage` (AG51 Battery Voltage): Total battery voltage of the AG51 gateway (sum of all 3 cells) in volts (volt)
+     * * `atisLamp` (Atis Lamp status): Atis lamp on/off status (values: off | on)
+     * * `derivedCargoState` (Cargo Status): Indicates if the overall cargo status of the asset is Empty, Partially Empty, Full, or Unknown. (values: unknown | empty | partiallyEmpty | full)
+     * * `doorClosedStatus` (Door Closed Status): Status indicating whether a door is closed or open (values: open | closed)
+     * * `doorClosedStatusAdvanced` (Door Closed Status (Advanced)): Status indicating whether a door is closed or open (values: open | closed)
+     * * `environmentMonitorAmbientTemperature` (Ambient Temperature): Air temperature at the environmental monitor device (built-in sensor). (celsius)
+     * * `environmentMonitorThermistorTemperature` (Thermistor Temperature): Temperature from an external thermistor probe (e.g. cable probe in cargo or reefer). (celsius)
+     * * `trailerMovingWithoutPower` (Trailer Moving Without Power): Trailer moving without power status (values: off | on)
+     * * `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)
+     * * `widgetBatteryVoltage` (Widget Battery Voltage): Battery voltage level of the widget sensor in millivolts (volt)
+     * * `widgetBatteryVoltageLow` (Widget Battery Voltage Low): Indicates if widget battery voltage is below 1500mV threshold (values: normal | low)
+     * * `widgetDisconnect` (Widget Disconnection Status): Connection status between widget and device (values: connected | disconnected)
+     *
+     * **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. */
+    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) */
+    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) */
+    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;
+    /** Set to true to enable feed mode for continuous reading updates. When enabled, the API always includes an endCursor in the response. If hasNextPage is false, it indicates that no new data is currently available — wait at least 5 seconds before making the next request to avoid unnecessary polling. */
+    feed?: boolean;
+    /** Optional boolean indicating whether to return external IDs on supported entities */
+    includeExternalIds?: boolean;
+}

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

@@ -0,0 +1,226 @@
+/**
+ * @example
+ *     {
+ *         readingIds: "readingIds",
+ *         entityType: "entityType"
+ *     }
+ */
+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)
+     *
+     * Available reading IDs (by category):
+     *
+     *
+     * **diagnostic**
+     *
+     * * `airInletPressure` (Air Inlet Pressure): Air inlet pressure. (kilopascal)
+     * * `airTemp` (Air Inlet (Ambient Air) Temp): Air inlet (ambient air) temperature. (celsius)
+     * * `altitude` (Altitude): The altitude of the asset (meter)
+     * * `altitudeAccuracy` (Altitude Uncertainty): The uncertainty of the asset's GPS-based altitude. (meter)
+     * * `assetStatus` (Status): Combined movement and equipment status derived from location & Digio events. (values: movementStart | movementEnd | stopped | none | equipmentOn | equipmentOff)
+     * * `averageACCurrent` (Average AC Current): Average AC current in amperes. (ampere)
+     * * `averageACFrequency` (Average AC Frequency): Average AC frequency in Hertz. (hertz)
+     * * `averageLineToLineACRMSVoltage` (Average Line-to-Line Voltage): Average RMS voltage between AC lines in volts. (volt)
+     * * `averageLineToNeutralACRMSVoltage` (Average Line-to-Neutral Voltage): Average RMS voltage from AC line to neutral in volts. (volt)
+     * * `barometerPressure` (Barometric Pressure): Atmospheric pressure as measured by the barometer. (kilopascal)
+     * * `batteryPotentialSwitched` (Battery Potential (Switched)): Switched battery potential in volts. (volt)
+     * * `batteryVoltage` (Battery Voltage): Voltage of the asset's battery. (volt)
+     * * `boostPressureEngineTurbocharger1` (Engine Turbocharger 1 Boost Pressure): Represents the boost pressure for engine turbocharger 1. (kilopascal)
+     * * `boostPressurePa` (Boost Pressure): Represents the boost pressure. (kilopascal)
+     * * `boostPressureTurbocharger2` (Boost Pressure (Turbocharger 2)): Boost pressure from the second turbocharger in kPa. (kilopascal)
+     * * `canBusType` (CAN Bus Status): Indicates whether the CAN Bus system is active or provides an invalid reading. (values: invalid | active)
+     * * `checkEngineLightJ1939Emissions` (Check Engine Light (J1939) - Emissions): Indicates whether the J1939 check engine light emissions indicator is active or inactive. (values: off | on)
+     * * `checkEngineLightJ1939Protect` (Check Engine Light (J1939) - Protect): Indicates whether the J1939 check engine light protect indicator is active or inactive. (values: off | on)
+     * * `checkEngineLightJ1939Stop` (Check Engine Light (J1939) - Stop): Indicates whether the J1939 check engine light stop indicator is active or inactive. (values: off | on)
+     * * `checkEngineLightJ1939Warning` (Check Engine Light (J1939) - Warning): Indicates whether the J1939 check engine light warning indicator is active or inactive. (values: off | on)
+     * * `checkEngineLightPassenger` (Check Engine Light (Passenger)): Indicates whether the passenger check engine light indicator is active or inactive. (values: off | on)
+     * * `coolantTemp` (Engine Coolant Temp): Represents the engine coolant temperature. (celsius)
+     * * `defLevel` (DEF Level): Represents the DEF (Diesel Exhaust Fluid) level percentage. (percent)
+     * * `derivedFuelConsumed` (Lifetime Fuel Consumed (Samsara)): Samsara-maintained fuel consumption since the device was firstinstalled. (liter)
+     * * `deviceOrientation` (Device Orientation): Indicates orientation of the device. (values: invalid | unknown | topDown | bottomDown | leftDown | rightDown | backDown | frontDown)
+     * * `digioInput1` (Digital IO #1): Represents the state of digital IO #1. (values: off | on)
+     * * `dpfLampStatus` (DPF Lamp Status): Status of the Diesel Particulate Filter warning lamp. (values: off | on | blinking)
+     * * `dpfSootLoadPercent` (DPF Soot Load): Diesel Particulate Filter soot load percentage. (percent)
+     * * `ecuHistoryTotalRunTime` (ECU Total Run Time): Total engine run time from ECU in seconds. (second)
+     * * `engineHours` (Engine Hours (ECU)): Represents the total engine runtime in hours as reported by the ECU. (second)
+     * * `engineHoursDigioBased` (Engine Hours (Synthetic - Aux input)): Represents the synthetic total engine runtime in hours based on auxiliary input. (millisecond)
+     * * `engineHoursEngineStateBased` (Engine Hours (Synthetic)): Represents the synthetic total engine runtime in hours based on engine state. (millisecond)
+     * * `engineIntakeAirTemp` (Engine Intake Air Temperature): Represents the engine intake air temperature. (celsius)
+     * * `engineLoadPercent` (Engine Load): Engine load percentage. (percent)
+     * * `engineState` (Engine State): Indicates the current state of the engine, such as running, stopped. (values: off | running | idling)
+     * * `ev24VoltDcDcInverterCurrent` (EV 24V DC/DC Inverter Current): Current from the 24V DC-DC inverter in amperes. (ampere)
+     * * `evAverageCellTemperature` (EV Average Cell Temperature): Average temperature of EV battery cells in degrees Celsius. (celsius)
+     * * `evChargingErrorStatus` (EV Charging Error Status): Indicates if the EV charging system has an error. (values: noError | batteryTooHotOrCold | vehicleNotInPark | connectorLockFault | chargingSystemFault | chargingCurrentDifferential | chargingVoltageOutOfRange | chargingSystemNotCompatible | noDataUndeterminedStatus | notAvailable | unknownError)
+     * * `evHighCapacityBatteryCurrent` (EV High Capacity Battery Current): Current from the high capacity EV battery in amperes. (ampere)
+     * * `evHighCapacityBatteryVoltage` (High Capacity EV Battery Voltage): Represents the voltage of the high capacity EV battery. (volt)
+     * * `evMaxAllowedStateOfChargePercent` (EV Max Allowed State of Charge): Maximum allowed state of charge percentage. (percent)
+     * * `evMaxCellTemperature` (EV Max Cell Temperature): Maximum temperature of EV battery cells in degrees Celsius. (celsius)
+     * * `evMinAllowedStateOfChargePercent` (EV Min Allowed State of Charge): Minimum allowed state of charge percentage. (percent)
+     * * `evMinCellTemperature` (EV Min Cell Temperature): Minimum temperature of EV battery cells in degrees Celsius. (celsius)
+     * * `exhaustGasPressure` (Exhaust Gas Pressure): Represents the exhaust gas pressure. (kilopascal)
+     * * `fuelConsumptionRate` (Fuel Consumption Rate): The rate at which an asset uses fuel (litersperhour)
+     * * `fuelLevelPerc` (Fuel Level): Percentage of fuel remaining in the tank. (percent)
+     * * `fuelSource` (Fuel Source): Type of fuel used by the asset. (values: gasoline | diesel)
+     * * `geoCoordinates` (Geo Coordinates): GPS coordinates (latitude and longitude) of the asset's location.
+     * * `gpsSpeed` (GPS Speed): Asset speed measured by the gateway's GPS receiver. (meterspersec)
+     * * `ignitionStatus` (Ignitions Status): Indicates the current ignition status as a voltage (values: off | on)
+     * * `latitude` (Latitude): Latitude coordinate of the asset's location. (decimaldegrees)
+     * * `lifetimeFuelConsumed` (Lifetime Fuel Consumed): Represents the vehicle maintained lifetime fuel consumption as reported by the vehicle. (liter)
+     * * `location` (Location): Represents the current address of the asset.
+     * * `longitude` (Longitude): Longitude coordinate of the asset's location. (decimaldegrees)
+     * * `mnfldTemp` (Intake Manifold Temp): Represents the intake manifold temperature. (celsius)
+     * * `ngFuelPressure` (NG Fuel Pressure): Represents the natural gas fuel pressure. (kilopascal)
+     * * `odometerEcu` (Odometer (ECU)): Represents the total distance traveled as recorded by the ECU. (meter)
+     * * `odometerGps` (Odometer (GPS)): Represents the total distance traveled as determined by GPS. (meter)
+     * * `oilPressure` (Engine Oil Pressure): Represents the oil pressure in the engine. (kilopascal)
+     * * `phaseAACFrequency` (Phase A AC Frequency): AC frequency for Phase A in Hertz. (hertz)
+     * * `phaseAAmpsRms` (Phase A Current (RMS)): RMS current for Phase A in amperes. (ampere)
+     * * `phaseALLVolts` (Phase A Line-to-Line Voltage): Line-to-line voltage for Phase A in volts. (volt)
+     * * `phaseALNVolts` (Phase A Line-to-Neutral Voltage): Line-to-neutral voltage for Phase A in volts. (volt)
+     * * `phaseBAmpsRms` (Phase B Current (RMS)): RMS current for Phase B in amperes. (ampere)
+     * * `phaseBLLVolts` (Phase B Line-to-Line Voltage): Line-to-line voltage for Phase B in volts. (volt)
+     * * `phaseBLNVolts` (Phase B Line-to-Neutral Voltage): Line-to-neutral voltage for Phase B in volts. (volt)
+     * * `phaseCAmpsRms` (Phase C Current (RMS)): RMS current for Phase C in amperes. (ampere)
+     * * `phaseCLLVolts` (Phase C Line-to-Line Voltage): Line-to-line voltage for Phase C in volts. (volt)
+     * * `phaseCLNVolts` (Phase C Line-to-Neutral Voltage): Line-to-neutral voltage for Phase C in volts. (volt)
+     * * `powerFactorRatio` (Power Factor Ratio): Represents the power factor ratio. (percent)
+     * * `samsaraEngineHours` (Samsara Engine Hours): Samsara's intelligent engine hours calculation that combines ECU data, synthetic calculations, and manual overrides with automatic fallbacks for optimal accuracy across all asset types. (millisecond)
+     * * `samsaraEngineHoursWithSource` (Samsara Engine Hours with Source): Samsara's intelligent engine hours calculation including detailed source metadata to indicate the origin of the data (ECU, synthetic, or manual override). Useful for debugging and understanding data provenance.
+     * * `samsaraOdometer` (Samsara Odometer): Samsara automatically pulls odometer readings from a vehicle's engine control unit (ECU). If the reading isn't available and the vehicle is unregulated, you can manually enter the odometer value for maintenance tracking—this value will then update based on GPS trip data. (kilometer)
+     * * `samsaraSpeed` (Samsara Speed): Samsara's best estimate of the asset speed, combining multiple data sources such as ECU and GPS. (meterspersec)
+     * * `samsaraSpeedLimit` (Samsara Speed Limit): Speed limit at the location of the asset. (meterspersec)
+     * * `seatbeltDriver` (Seatbelt (Driver)): Indicates whether the driver's seatbelt is buckled or unbuckled. (values: unbuckled | buckled)
+     * * `seatbeltPassenger` (Seatbelt (Passenger)): Indicates whether the passenger's seatbelt is buckled or unbuckled. (values: unbuckled | buckled)
+     * * `supportFindNearby` (Support Find Nearby): Indicates if the asset can support find nearby. (values: noData | notCompatible | pendingUpgrade | Ready)
+     * * `tirePressuresBackLeft` (Tire pressure, back left): Represents the tire pressure for the back-left tire. (kilopascal)
+     * * `tirePressuresBackRight` (Tire pressure, back right): Represents the tire pressure for the back-right tire. (kilopascal)
+     * * `tirePressuresFrontLeft` (Tire pressure, front left): Represents the tire pressure for the front-left tire. (kilopascal)
+     * * `tirePressuresFrontRight` (Tire pressure, front right): Represents the tire pressure for the front-right tire. (kilopascal)
+     * * `torquePercent` (Torque): Engine torque as a percentage. (percent)
+     * * `totalApparentPower` (Total Apparent Power): Total apparent power in volt-amperes. (voltAmpere)
+     * * `totalEnergyExported` (Total Energy Exported): Represents the total energy exported in kilowatt-hours (kWh). (kilowatthour)
+     * * `totalReactivePower` (Total Reactive Power): Total reactive power in volt-amperes reactive. (voltAmpereReactive)
+     * * `totalRealPower` (Total Real Power): Total real power in watts. (watt)
+     *
+     * **levelMonitoring**
+     *
+     * * `fillCriticality` (Fill Level Criticality): Indicates if the state of the fill level is critical. (values: normal | criticallyHigh | criticallyLow)
+     * * `fillMass` (Fill Mass): Mass of material in the vessel. (kilogram)
+     * * `fillMassAvailableCapacity` (Fill Mass Available Capacity): Available mass to be filled in the vessel. (kilogram)
+     * * `fillPercent` (Fill Level Percent): Fill level of the vessel as a percentage full. (percent)
+     * * `fillVolume` (Fill Volume): Volume of material in the vessel. (liter)
+     * * `fillVolumeAvailableCapacity` (Fill Volume Available Capacity): Available volume to be filled in the vessel. (liter)
+     * * `fluidLevelStatus` (Battery Water Level): The status of the battery's water level. Will be OK or LOW. (values: noData | ok | low)
+     *
+     * **obd**
+     *
+     * * `accDistanceAlertSignal` (ACC Distance Alert): Distance Alert Signal from the Adaptive Cruise Control system. (values: notActive | active)
+     * * `adaptiveCruiseControlMode` (ACC Mode): Current mode of the Adaptive Cruise Control System. (values: off | speedControlActive | distanceControlActive | overtakeMode | holdMode | finishMode | disabledOrError)
+     * * `aebsDriverActivationDemand` (AEBS Activation): Whether Advanced Emergency Braking is enabled or disabled by the driver. (values: deactivated | activated)
+     * * `cruiseControlFinalSetSpeed` (Cruise Control Final Set Speed): Includes driver set point and overrides from the ACC system. (kmperhr)
+     * * `cruiseControlSetSpeed` (Cruise Control Set Speed): Driver's set speed for the cruise control system. (kmperhr)
+     * * `cruiseControlSwitch` (Cruise Control Switch): The state of the cruise control switch. (values: off | on | error)
+     * * `driverAlertnessWarning` (Driver Alertness Warning): Driver Alertness Warning. (values: noConditionDetected | level1MildDistraction | level2Degradation | level3Warning)
+     * * `driverAlertnessWarningSystemState` (Driver Alertness Warning State): State of the Driver Alertness Warning system. (values: installedButDisabled | initializing | temporarilyNotAvailable | available | monitoringDriverBehavior)
+     * * `ecuSpeed` (ECU Speed): Speed read from the asset's OBD port. (kmperhr)
+     * * `emergencyBrakingActive` (Emergency Braking State): State of the Emergency Braking System. (values: inactive | active)
+     * * `emergencyBrakingAebsState` (AEBS State (Collision)): State of the Emergency Braking System for Forward Collision. (values: notReady | temporarilyNotAvailable | deactivatedByDriver | readyAndActivated | driverOverrides | forwardCollisionWarningActive | forwardCollisionWarningWithBraking | forwardCollisionEmergencyBrakingActive | performanceLimited | error)
+     * * `externalBrakeRequestReason` (Self-Braking Reason/Mode): Brake reason/mode for the emergency self-braking system. (values: collisionAvoidance | stabilityControl | cruiseControlRoadSpeed | adaptiveCruiseControlDistanceControl | driverWarningHapticIndicator)
+     * * `forwardCollisionWarningLevel` (AEBS FCW Level): Severity level of the AEBS Forward Collision Warning. (values: noWarning | level1 | level2 | level3 | level4 | level5 | level6 | level7)
+     * * `forwardCollisionWarningStatus` (ACC FCW Status): Status of the Adaptive Cruise Control Forward Collision Warning system. (values: noWarning | collisionImminent | error)
+     * * `forwardLaneImagerStatus` (Forward Lane Imager State): State of the Forward Lane Imager. (values: fullyOperational | warmingUp | partiallyBlocked | fullyBlocked | misaligned | viewDegraded | error)
+     * * `imminentLeftLaneDeparture` (Imminent Left Lane Departure): State of the Imminent Left Lane Departure detection. (values: notImminent | imminent)
+     * * `imminentRightLaneDeparture` (Imminent Right Lane Departure): State of the Imminent Right Lane Departure detection. (values: notImminent | imminent)
+     * * `laneCenteringSystemState` (Lane Centering State): State of the Lane Centering System. (values: notReady | temporarilyNotAvailable | deactivatedByDriver | ready | suppressedByOperator | actuating | error)
+     * * `laneDepartureIndicationStatus` (LDW Indication): State of the Lane Departure Indication system. (values: disabled | enabled)
+     * * `laneDepartureWarningSystemState` (LDW System State): State of the Lane Departure Warning system. (values: notReady | temporarilyNotAvailable | deactivatedByDriver | ready | warningSuppressed | warningLaneDeparture | error)
+     * * `laneKeepingAssistSystemState` (LKAS State): State of the Lane Keep Assist System. (values: notReady | temporarilyNotAvailable | deactivatedByDriver | ready | suppressedByOperator | actuating | error)
+     * * `leftLaneDeparture` (Left Lane Departure): State of the Left Lane Departure detection. (values: notDeparting | departing)
+     * * `rightLaneDeparture` (Right Lane Departure): State of the Right Lane Departure detection. (values: notDeparting | departing)
+     * * `roadDepartureAebsState` (AEBS State (Lane Departure)): State of the AEBS system for Lane Departure. (values: notReady | temporarilyNotAvailable | deactivatedByDriver | readyAndActivated | driverOverrides | roadDepartureWarningActive | roadDepartureWarningWithBraking | roadDepartureEmergencyBrakingActive | performanceLimited | error)
+     * * `ropBrakeControlActive` (ROP Brake Control Active): Indicates whether Roll Over Prevention (ROP) has activated brake control. (values: passive | active)
+     * * `ropEngineControlActive` (ROP Engine Control Active): Indicates whether Roll Over Prevention (ROP) has commanded engine control to be active. (values: passive | active)
+     * * `tractionControlOverrideSwitch` (Traction Control Override Switch): When the switch is on, the automatic traction control function is disabled by the driver. (values: off | on | error)
+     * * `turnSignal` (Turn Signal): State of the turn signal switch (blinker). (values: off | left | right)
+     * * `vdcFullyOperational` (VDC Fully Operational): Indicates whether the Vehicle Dynamic Stability Control (VDC) system is fully operational. (values: notFullyOperational | fullyOperational)
+     * * `vehicleGear` (Vehicle Gear): The gear of the vehicle that is currently selected. (values: unknown | park | neutral | reverse | drive)
+     * * `xbrActiveControlMode` (Emergency Self-Braking System Mode): Current mode of the emergency self-braking system. (values: noBrakeDemand | driverBrakeDemand | additionMode | maximumMode | brakeHold)
+     * * `xbrSystemState` (Emergency Self-Braking System Operational State): State of the emergency self-braking system. (values: fullyOperational | highestPriorityOnly | noRequestsAccepted)
+     * * `ycBrakeControlActive` (YC Brake Control Active): Indicates whether Yaw Control (YC) has activated brake control. (values: passive | active)
+     * * `ycEngineControlActive` (YC Engine Control Active): Indicates whether Yaw Control (YC) has commanded engine control to be active. (values: passive | active)
+     *
+     * **pressureVesselHealth**
+     *
+     * * `pressureVesselBatteryLevelPercentage` (Pressure Vessel Battery Level Percentage): Battery level percentage of the pressure vessel. (percent)
+     * * `pressureVesselPressure` (Pressure Vessel Pressure): Pressure of the pressure vessel. (kilopascal)
+     * * `pressureVesselTemperature` (Pressure Vessel Temperature): Temperature of the pressure vessel. (celsius)
+     *
+     * **reefer**
+     *
+     * * `reeferAlarm` (Reefer Alarms): Array of active alarm codes for the refrigeration unit with metadata
+     * * `reeferAlarmSeverity` (Reefer Alarm Severity): Highest severity level across active reefer alarms (green, yellow, red, orange) (values: none | green | yellow | red | orange)
+     * * `reeferAmbientAir` (Reefer Ambient Air Temperature): External environment temperature for the reefer (celsius)
+     * * `reeferBatteryVoltage` (Reefer Battery Voltage): The voltage of the Refrigeration Unit's battery. (volt)
+     * * `reeferDoorOpenZone1` (Reefer Door Open (Zone 1)): Status indicating whether the reefer's door (zone 1) is closed or open (values: closed | open)
+     * * `reeferDoorOpenZone2` (Reefer Door Open (Zone 2)): Status indicating whether the reefer's door (zone 2) is closed or open (values: closed | open)
+     * * `reeferDoorOpenZone3` (Reefer Door Open (Zone 3)): Status indicating whether the reefer's door (zone 3) is closed or open (values: closed | open)
+     * * `reeferEngineHours` (Reefer Engine Hours): The total accumulated hours that the Refrigeration Unit has been running on its engine. (hour)
+     * * `reeferFuelLevel` (Reefer Fuel Level): Refrigeration Unit Fuel Level (%) (percent)
+     * * `reeferPowerSource` (Reefer Power Source): The power source of the refrigeration unit (Diesel, Electric or Cryo) (values: engine | electric | cryo)
+     * * `reeferReturnAirZone1` (Reefer Return Air Temperature (Zone 1)): Return air temperature for the reefer's zone 1 (celsius)
+     * * `reeferReturnAirZone2` (Reefer Return Air Temperature (Zone 2)): Return air temperature for the reefer's zone 2 (celsius)
+     * * `reeferReturnAirZone3` (Reefer Return Air Temperature (Zone 3)): Return air temperature for the reefer's zone 3 (celsius)
+     * * `reeferRunMode` (Reefer Run Mode): The run mode of the refrigeration unit (Continuous or Start/Stop) (values: continuous | startStop)
+     * * `reeferSetPointZone1` (Reefer Set Point (Zone 1)): Current set point for the reefer's zone 1 (celsius)
+     * * `reeferSetPointZone2` (Reefer Set Point (Zone 2)): Current set point for the reefer's zone 2 (celsius)
+     * * `reeferSetPointZone3` (Reefer Set Point (Zone 3)): Current set point for the reefer's zone 3 (celsius)
+     * * `reeferState` (Reefer State): The on/off state of the refrigeration unit (values: off | active | error | inactive)
+     * * `reeferStateZone1` (Reefer State (Zone 1)): The on/off state of the refrigeration unit (Zone 1) (values: off | active | error | inactive)
+     * * `reeferStateZone2` (Reefer State (Zone 2)): The on/off state of the refrigeration unit (Zone 2) (values: off | active | error | inactive)
+     * * `reeferStateZone3` (Reefer State (Zone 3)): The on/off state of the refrigeration unit (Zone 3) (values: off | active | error | inactive)
+     * * `reeferSupplyAirZone1` (Reefer Supply Air Temperature (Zone 1)): Supply air temperature for the reefer's zone 1 (celsius)
+     * * `reeferSupplyAirZone2` (Reefer Supply Air Temperature (Zone 2)): Supply air temperature for the reefer's zone 2 (celsius)
+     * * `reeferSupplyAirZone3` (Reefer Supply Air Temperature (Zone 3)): Supply air temperature for the reefer's zone 3 (celsius)
+     * * `reeferTemperatureRecorder1` (Reefer Temperature Recorder (Zone 1)): Temperature recorder reading for reefer zone 1 (celsius)
+     * * `reeferTemperatureRecorder2` (Reefer Temperature Recorder (Zone 2)): Temperature recorder reading for reefer zone 2 (celsius)
+     * * `reeferTemperatureRecorder3` (Reefer Temperature Recorder (Zone 3)): Temperature recorder reading for reefer zone 3 (celsius)
+     * * `reeferTemperatureRecorder4` (Reefer Temperature Recorder (Zone 4)): Temperature recorder reading for reefer zone 4 (celsius)
+     * * `reeferTemperatureRecorder5` (Reefer Temperature Recorder (Zone 5)): Temperature recorder reading for reefer zone 5 (celsius)
+     * * `reeferTemperatureRecorder6` (Reefer Temperature Recorder (Zone 6)): Temperature recorder reading for reefer zone 6 (celsius)
+     *
+     * **smartTrailer**
+     *
+     * * `addressEntry` (Address Entry): Address data from the address entry event
+     * * `addressExit` (Address Exit): Address data from the address exit event
+     * * `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)
+     * * `ag51BatteryTemperature` (AG51 Battery Temperature): Internal temperature of the AG51 gateway battery in degrees Celsius (celsius)
+     * * `ag51BatteryVoltage` (AG51 Battery Voltage): Total battery voltage of the AG51 gateway (sum of all 3 cells) in volts (volt)
+     * * `atisLamp` (Atis Lamp status): Atis lamp on/off status (values: off | on)
+     * * `derivedCargoState` (Cargo Status): Indicates if the overall cargo status of the asset is Empty, Partially Empty, Full, or Unknown. (values: unknown | empty | partiallyEmpty | full)
+     * * `doorClosedStatus` (Door Closed Status): Status indicating whether a door is closed or open (values: open | closed)
+     * * `doorClosedStatusAdvanced` (Door Closed Status (Advanced)): Status indicating whether a door is closed or open (values: open | closed)
+     * * `environmentMonitorAmbientTemperature` (Ambient Temperature): Air temperature at the environmental monitor device (built-in sensor). (celsius)
+     * * `environmentMonitorThermistorTemperature` (Thermistor Temperature): Temperature from an external thermistor probe (e.g. cable probe in cargo or reefer). (celsius)
+     * * `trailerMovingWithoutPower` (Trailer Moving Without Power): Trailer moving without power status (values: off | on)
+     * * `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)
+     * * `widgetBatteryVoltage` (Widget Battery Voltage): Battery voltage level of the widget sensor in millivolts (volt)
+     * * `widgetBatteryVoltageLow` (Widget Battery Voltage Low): Indicates if widget battery voltage is below 1500mV threshold (values: normal | low)
+     * * `widgetDisconnect` (Widget Disconnection Status): Connection status between widget and device (values: connected | disconnected)
+     *
+     * **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. */
+    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) */
+    entityType: string;
+    /** Optional boolean indicating whether to return external IDs on supported entities */
+    includeExternalIds?: boolean;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface GetRidershipAccountRequest {
+    /** ID of the ridership account. This can either be the Samsara-specified UUID, or an external ID. External IDs are customer-specified key-value pairs. To specify an external ID, use the following format: `key:value`. For example, `district:SPR-001`. */
+    id: string;
+    /** Optional boolean indicating whether to return external IDs on supported entities */
+    includeExternalIds?: boolean;
+}