Class: Samsara::TagsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::TagsClient

Parameters:



22
23
24
 
# File 'lib/samsara_api/tags/client.rb', line 22

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



17
18
19
 
# File 'lib/samsara_api/tags/client.rb', line 17

def request_client
  @request_client
end

Instance Method Details

#create(addresses: nil, assets: nil, drivers: nil, external_ids: nil, machines: nil, name:, parent_tag_id: nil, sensors: nil, vehicles: nil, request_options: nil) ⇒ Object

api.tags.create(name: “California”)



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/samsara_api/tags/client.rb', line 101

def create(addresses: nil, assets: nil, drivers: nil, external_ids: nil, machines: nil, name:, parent_tag_id: nil, sensors: nil, vehicles: nil, request_options: nil)
  response = @request_client.conn.post 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
  req.body = { **(request_options&.additional_body_parameters || {}), addresses: addresses, assets: assets, drivers: drivers, externalIds: external_ids, machines: machines, name: name, parentTagId: parent_tag_id, sensors: sensors, vehicles: vehicles }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/tags"
end
  Samsara::Types::TagResponse.from_json(json_object: response.body)
end

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

api.tags.delete(id: “id”)



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/samsara_api/tags/client.rb', line 245

def delete(id:, request_options: nil)
  response = @request_client.conn.delete 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)}/tags/#{id}"
end
  parsed_json = JSON.parse(response.body)
  parsed_json
end

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

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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/samsara_api/tags/client.rb', line 145

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)}/tags/#{id}"
end
  Samsara::Types::TagResponse.from_json(json_object: response.body)
end

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

api.tags.list



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

def list(limit: nil, after: 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 }.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)}/tags"
end
  Samsara::Types::ListTagsResponse.from_json(json_object: response.body)
end

#patch(id:, addresses: nil, assets: nil, drivers: nil, external_ids: nil, machines: nil, name: nil, parent_tag_id: nil, sensors: nil, vehicles: nil, request_options: nil) ⇒ Object

api.tags.patch(id: “id”)



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/samsara_api/tags/client.rb', line 309

def patch(id:, addresses: nil, assets: nil, drivers: nil, external_ids: nil, machines: nil, name: nil, parent_tag_id: nil, sensors: nil, vehicles: nil, request_options: nil)
  response = @request_client.conn.patch 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
  req.body = { **(request_options&.additional_body_parameters || {}), addresses: addresses, assets: assets, drivers: drivers, externalIds: external_ids, machines: machines, name: name, parentTagId: parent_tag_id, sensors: sensors, vehicles: vehicles }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/tags/#{id}"
end
  Samsara::Types::TagResponse.from_json(json_object: response.body)
end

#replace(id:, addresses: nil, assets: nil, drivers: nil, machines: nil, name: nil, parent_tag_id: nil, sensors: nil, vehicles: nil, request_options: nil) ⇒ Object

api.tags.replace(id: “id”)



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/samsara_api/tags/client.rb', line 201

def replace(id:, addresses: nil, assets: nil, drivers: nil, machines: nil, name: nil, parent_tag_id: nil, sensors: nil, vehicles: nil, request_options: nil)
  response = @request_client.conn.put 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
  req.body = { **(request_options&.additional_body_parameters || {}), addresses: addresses, assets: assets, drivers: drivers, machines: machines, name: name, parentTagId: parent_tag_id, sensors: sensors, vehicles: vehicles }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/tags/#{id}"
end
  Samsara::Types::TagResponse.from_json(json_object: response.body)
end