Class SensorsApi

Hierarchy

BaseAPI
- SensorsApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new SensorsApi(configuration?: Configuration): SensorsApi

Inherited from runtime.BaseAPI.constructor
- Defined in runtime.ts:25
Parameters
- configuration: Configuration = ...
Returns SensorsApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

Protected request

request(context: RequestOpts): Promise<Response>

Inherited from runtime.BaseAPI.request
- Defined in runtime.ts:47
Parameters
- context: RequestOpts
Returns Promise<Response>

v1getSensors

v1getSensors(): Promise<InlineResponse2009>

- Defined in apis/SensorsApi.ts:101
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get sensor objects. This method returns a list of the sensor objects in the Samsara Cloud and information about them. Get all sensors

Returns Promise<InlineResponse2009>

v1getSensorsCargo

v1getSensorsCargo(requestParameters: V1getSensorsCargoRequest): Promise<V1CargoResponse>

- Defined in apis/SensorsApi.ts:136
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get cargo monitor status (empty / full) for requested sensors. Get cargo status

Parameters
- requestParameters: V1getSensorsCargoRequest
Returns Promise<V1CargoResponse>

v1getSensorsCargoRaw

v1getSensorsCargoRaw(requestParameters: V1getSensorsCargoRequest): Promise<ApiResponse<V1CargoResponse>>

- Defined in apis/SensorsApi.ts:110
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get cargo monitor status (empty / full) for requested sensors. Get cargo status

Parameters
- requestParameters: V1getSensorsCargoRequest
Returns Promise<ApiResponse<V1CargoResponse>>

v1getSensorsDoor

v1getSensorsDoor(requestParameters: V1getSensorsDoorRequest): Promise<V1DoorResponse>

- Defined in apis/SensorsApi.ts:171
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get door monitor status (closed / open) for requested sensors. Get door status

Parameters
- requestParameters: V1getSensorsDoorRequest
Returns Promise<V1DoorResponse>

v1getSensorsDoorRaw

v1getSensorsDoorRaw(requestParameters: V1getSensorsDoorRequest): Promise<ApiResponse<V1DoorResponse>>

- Defined in apis/SensorsApi.ts:145
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get door monitor status (closed / open) for requested sensors. Get door status

Parameters
- requestParameters: V1getSensorsDoorRequest
Returns Promise<ApiResponse<V1DoorResponse>>

v1getSensorsHistory

v1getSensorsHistory(requestParameters: V1getSensorsHistoryRequest): Promise<V1SensorHistoryResponse>

- Defined in apis/SensorsApi.ts:206
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get historical data for specified sensors. This method returns a set of historical data for the specified sensors in the specified time range and at the specified time resolution. Get sensor history

Parameters
- requestParameters: V1getSensorsHistoryRequest
Returns Promise<V1SensorHistoryResponse>

v1getSensorsHistoryRaw

v1getSensorsHistoryRaw(requestParameters: V1getSensorsHistoryRequest): Promise<ApiResponse<V1SensorHistoryResponse>>

- Defined in apis/SensorsApi.ts:180
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get historical data for specified sensors. This method returns a set of historical data for the specified sensors in the specified time range and at the specified time resolution. Get sensor history

Parameters
- requestParameters: V1getSensorsHistoryRequest
Returns Promise<ApiResponse<V1SensorHistoryResponse>>

v1getSensorsHumidity

v1getSensorsHumidity(requestParameters: V1getSensorsHumidityRequest): Promise<V1HumidityResponse>

- Defined in apis/SensorsApi.ts:241
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get humidity for requested sensors. This method returns the current relative humidity for the requested sensors. Get humidity

Parameters
- requestParameters: V1getSensorsHumidityRequest
Returns Promise<V1HumidityResponse>

v1getSensorsHumidityRaw

v1getSensorsHumidityRaw(requestParameters: V1getSensorsHumidityRequest): Promise<ApiResponse<V1HumidityResponse>>

- Defined in apis/SensorsApi.ts:215
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get humidity for requested sensors. This method returns the current relative humidity for the requested sensors. Get humidity

Parameters
- requestParameters: V1getSensorsHumidityRequest
Returns Promise<ApiResponse<V1HumidityResponse>>

v1getSensorsRaw

v1getSensorsRaw(): Promise<ApiResponse<InlineResponse2009>>

- Defined in apis/SensorsApi.ts:82
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get sensor objects. This method returns a list of the sensor objects in the Samsara Cloud and information about them. Get all sensors

Returns Promise<ApiResponse<InlineResponse2009>>

v1getSensorsTemperature

v1getSensorsTemperature(requestParameters: V1getSensorsTemperatureRequest): Promise<V1TemperatureResponse>

- Defined in apis/SensorsApi.ts:276
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get temperature for requested sensors. This method returns the current ambient temperature (and probe temperature if applicable) for the requested sensors. Get temperature

Parameters
- requestParameters: V1getSensorsTemperatureRequest
Returns Promise<V1TemperatureResponse>

v1getSensorsTemperatureRaw

v1getSensorsTemperatureRaw(requestParameters: V1getSensorsTemperatureRequest): Promise<ApiResponse<V1TemperatureResponse>>

- Defined in apis/SensorsApi.ts:250
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get temperature for requested sensors. This method returns the current ambient temperature (and probe temperature if applicable) for the requested sensors. Get temperature

Parameters
- requestParameters: V1getSensorsTemperatureRequest
Returns Promise<ApiResponse<V1TemperatureResponse>>

withMiddleware

withMiddleware<T>(...middlewares: Middleware[]): T

Inherited from runtime.BaseAPI.withMiddleware
- Defined in runtime.ts:31
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...middlewares: Middleware[]
Returns T

withPostMiddleware

withPostMiddleware<T>(...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T

Inherited from runtime.BaseAPI.withPostMiddleware
- Defined in runtime.ts:42
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

withPreMiddleware

withPreMiddleware<T>(...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T

Inherited from runtime.BaseAPI.withPreMiddleware
- Defined in runtime.ts:37
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Generated using TypeDoc