Class: Samsara::Vehicles::StatsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::Vehicles::StatsClient 



24
25
26
 
# File 'lib/samsara_api/vehicles/stats/client.rb', line 24

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::RequestClient (readonly) 



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

def request_client
  @request_client
end

Instance Method Details

#feed(after: nil, parent_tag_ids: nil, tag_ids: nil, vehicle_ids: nil, types: nil, decorations: nil, request_options: nil) ⇒ Object

api.vehicles.stats.feed



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/samsara_api/vehicles/stats/client.rb', line 455

def feed(after: nil, parent_tag_ids: nil, tag_ids: nil, vehicle_ids: nil, types: nil, decorations: 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, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "vehicleIds": vehicle_ids, "types": types, "decorations": decorations }.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)}/fleet/vehicles/stats/feed"
end
  Samsara::Types::VehicleStatsListResponse.from_json(json_object: response.body)
end

#history(after: nil, start_time:, end_time:, parent_tag_ids: nil, tag_ids: nil, vehicle_ids: nil, types: nil, decorations: nil, request_options: nil) ⇒ Object

api.vehicles.stats.history(start_time: “startTime”, end_time: “endTime”)



732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'lib/samsara_api/vehicles/stats/client.rb', line 732

def history(after: nil, start_time:, end_time:, parent_tag_ids: nil, tag_ids: nil, vehicle_ids: nil, types: nil, decorations: 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, "startTime": start_time, "endTime": end_time, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "vehicleIds": vehicle_ids, "types": types, "decorations": decorations }.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)}/fleet/vehicles/stats/history"
end
  Samsara::Types::VehicleStatsListResponse.from_json(json_object: response.body)
end

#list(after: nil, time: nil, parent_tag_ids: nil, tag_ids: nil, vehicle_ids: nil, types: nil, request_options: nil) ⇒ Object

api.vehicles.stats.list



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/samsara_api/vehicles/stats/client.rb', line 179

def list(after: nil, time: nil, parent_tag_ids: nil, tag_ids: nil, vehicle_ids: nil, 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, "time": time, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "vehicleIds": vehicle_ids, "types": 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)}/fleet/vehicles/stats"
end
  Samsara::Types::VehicleStatsResponse.from_json(json_object: response.body)
end