Class: Samsara::EquipmentClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::EquipmentClient

Parameters:



23
24
25
26
27
 
# File 'lib/samsara_api/equipment/client.rb', line 23

def initialize(request_client:)
  @request_client = request_client
  @locations = Samsara::Equipment::LocationsClient.new(request_client: request_client)
  @stats = Samsara::Equipment::StatsClient.new(request_client: request_client)
end

Instance Attribute Details

#locations ⇒ Samsara::Equipment::LocationsClient (readonly)

Returns:



16
17
18
 
# File 'lib/samsara_api/equipment/client.rb', line 16

def locations
  @locations
end

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



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

def request_client
  @request_client
end

#stats ⇒ Samsara::Equipment::StatsClient (readonly)

Returns:



18
19
20
 
# File 'lib/samsara_api/equipment/client.rb', line 18

def stats
  @stats
end

Instance Method Details

#get(id:, request_options: nil) ⇒ Object

api.equipment.get(id: “id”)



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/samsara_api/equipment/client.rb', line 88

def get(id:, 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
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  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/#{id}"
end
  Samsara::Types::EquipmentResponse.from_json(json_object: response.body)
end

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

api.equipment.list



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/samsara_api/equipment/client.rb', line 49

def list(limit: nil, after: nil, parent_tag_ids: nil, tag_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 || {}), "limit": limit, "after": after, "parentTagIds": parent_tag_ids, "tagIds": tag_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"
end
  Samsara::Types::EquipmentListResponse.from_json(json_object: response.body)
end