Class: Samsara::Equipment::AsyncLocationsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::Equipment::AsyncLocationsClient

Parameters:



189
190
191
 
# File 'lib/samsara_api/equipment/locations/client.rb', line 189

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::AsyncRequestClient (readonly)

Returns:



184
185
186
 
# File 'lib/samsara_api/equipment/locations/client.rb', line 184

def request_client
  @request_client
end

Instance Method Details

#feed(after: nil, parent_tag_ids: nil, tag_ids: nil, equipment_ids: nil, request_options: nil) ⇒ Object

api.equipment.locations.feed



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/samsara_api/equipment/locations/client.rb', line 281

def feed(after: nil, parent_tag_ids: nil, tag_ids: nil, equipment_ids: nil, request_options: nil)
  Async do
    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, "equipmentIds": equipment_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)}/fleet/equipment/locations/feed"
end
    Samsara::Types::EquipmentLocationsListResponse.from_json(json_object: response.body)
  end
end

#history(after: nil, start_time:, end_time:, parent_tag_ids: nil, tag_ids: nil, equipment_ids: nil, request_options: nil) ⇒ Object

api.equipment.locations.history(start_time: "startTime", end_time: "endTime")



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/samsara_api/equipment/locations/client.rb', line 338

def history(after: nil, start_time:, end_time:, parent_tag_ids: nil, tag_ids: nil, equipment_ids: nil, request_options: nil)
  Async do
    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, "equipmentIds": equipment_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)}/fleet/equipment/locations/history"
end
    Samsara::Types::EquipmentLocationsListResponse.from_json(json_object: response.body)
  end
end

#list(after: nil, parent_tag_ids: nil, tag_ids: nil, equipment_ids: nil, request_options: nil) ⇒ Object

api.equipment.locations.list



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/samsara_api/equipment/locations/client.rb', line 224

def list(after: nil, parent_tag_ids: nil, tag_ids: nil, equipment_ids: nil, request_options: nil)
  Async do
    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, "equipmentIds": equipment_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)}/fleet/equipment/locations"
end
    Samsara::Types::EquipmentLocationsResponse.from_json(json_object: response.body)
  end
end