Class: Samsara::AddressesClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::AddressesClient

Parameters:



25
26
27
 
# File 'lib/samsara_api/addresses/client.rb', line 25

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



20
21
22
 
# File 'lib/samsara_api/addresses/client.rb', line 20

def request_client
  @request_client
end

Instance Method Details

#create(address_types: nil, contact_ids: nil, external_ids: nil, formatted_address:, geofence:, latitude: nil, longitude: nil, name:, notes: nil, tag_ids: nil, request_options: nil) ⇒ Object

)



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/samsara_api/addresses/client.rb', line 129

def create(address_types: nil, contact_ids: nil, external_ids: nil, formatted_address:, geofence:, latitude: nil, longitude: nil, name:, notes: nil, tag_ids: 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 || {}), addressTypes: address_types, contactIds: contact_ids, externalIds: external_ids, formattedAddress: formatted_address, geofence: geofence, latitude: latitude, longitude: longitude, name: name, notes: notes, tagIds: tag_ids }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/addresses"
end
  Samsara::Types::AddressResponse.from_json(json_object: response.body)
end

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

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/samsara_api/addresses/client.rb', line 215

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)}/addresses/#{id}"
end
  parsed_json = JSON.parse(response.body)
  parsed_json
end

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

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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/samsara_api/addresses/client.rb', line 171

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

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

api.addresses.list



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/samsara_api/addresses/client.rb', line 63

def list(limit: nil, after: nil, parent_tag_ids: nil, tag_ids: nil, created_after_time: 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, "createdAfterTime": created_after_time }.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)}/addresses"
end
  Samsara::Types::ListAddressesResponse.from_json(json_object: response.body)
end

#update(id:, address_types: nil, contact_ids: nil, external_ids: nil, formatted_address: nil, geofence: nil, latitude: nil, longitude: nil, name: nil, notes: nil, tag_ids: nil, request_options: nil) ⇒ Object

api.addresses.update(id: “id”)



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/samsara_api/addresses/client.rb', line 284

def update(id:, address_types: nil, contact_ids: nil, external_ids: nil, formatted_address: nil, geofence: nil, latitude: nil, longitude: nil, name: nil, notes: nil, tag_ids: 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 || {}), addressTypes: address_types, contactIds: contact_ids, externalIds: external_ids, formattedAddress: formatted_address, geofence: geofence, latitude: latitude, longitude: longitude, name: name, notes: notes, tagIds: tag_ids }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/addresses/#{id}"
end
  Samsara::Types::AddressResponse.from_json(json_object: response.body)
end