Class: Samsara::AsyncAddressesClient

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::AsyncAddressesClient

Parameters:



309
310
311
 
# File 'lib/samsara_api/addresses/client.rb', line 309

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::AsyncRequestClient (readonly)

Returns:



304
305
306
 
# File 'lib/samsara_api/addresses/client.rb', line 304

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

)



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/samsara_api/addresses/client.rb', line 415

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)
  Async do
    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
end

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

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



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/samsara_api/addresses/client.rb', line 505

def delete(id:, request_options: nil)
  Async do
    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
end

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

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



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/samsara_api/addresses/client.rb', line 459

def get(id:, 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
  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
end

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

api.addresses.list



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/samsara_api/addresses/client.rb', line 347

def list(limit: nil, after: nil, parent_tag_ids: nil, tag_ids: nil, created_after_time: 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 || {}), "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
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”)



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/samsara_api/addresses/client.rb', line 576

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)
  Async do
    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
end