Class: Samsara::ReadingsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/samsara_api/readings/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::ReadingsClient

Parameters:



19
20
21
 
# File 'lib/samsara_api/readings/client.rb', line 19

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



14
15
16
 
# File 'lib/samsara_api/readings/client.rb', line 14

def request_client
  @request_client
end

Instance Method Details

#definitions(after: nil, ids: nil, entity_types: nil, request_options: nil) ⇒ Object

api.readings.definitions



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/samsara_api/readings/client.rb', line 53

def definitions(after: nil, ids: nil, entity_types: nil, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "after": after, "ids": ids, "entityTypes": entity_types }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/readings/definitions"
end
  Samsara::Types::ReadingsListReadingsDefinitionsResponseBody.from_json(json_object: response.body)
end

#history(after: nil, reading_id:, entity_ids: nil, entity_type:, external_ids: nil, start_time: nil, end_time: nil, feed: nil, include_external_ids: nil, request_options: nil) ⇒ Object

api.readings.history(reading_id: “readingId”, entity_type: “entityType”)



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/samsara_api/readings/client.rb', line 119

def history(after: nil, reading_id:, entity_ids: nil, entity_type:, external_ids: nil, start_time: nil, end_time: nil, feed: nil, include_external_ids: nil, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "after": after, "readingId": reading_id, "entityIds": entity_ids, "entityType": entity_type, "externalIds": external_ids, "startTime": start_time, "endTime": end_time, "feed": feed, "includeExternalIds": include_external_ids }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/readings/history"
end
  Samsara::Types::ReadingsGetReadingsHistoryResponseBody.from_json(json_object: response.body)
end

#latest(after: nil, reading_ids:, entity_ids: nil, external_ids: nil, as_of_time: nil, entity_type:, include_external_ids: nil, request_options: nil) ⇒ Object

api.readings.latest(reading_ids: “readingIds”, entity_type: “entityType”)



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/samsara_api/readings/client.rb', line 175

def latest(after: nil, reading_ids:, entity_ids: nil, external_ids: nil, as_of_time: nil, entity_type:, include_external_ids: nil, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "after": after, "readingIds": reading_ids, "entityIds": entity_ids, "externalIds": external_ids, "asOfTime": as_of_time, "entityType": entity_type, "includeExternalIds": include_external_ids }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/readings/latest"
end
  Samsara::Types::ReadingsGetReadingsSnapshotResponseBody.from_json(json_object: response.body)
end