Class: Samsara::AsyncTagsClient

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

Parameters:



334
335
336
 
# File 'lib/samsara_api/tags/client.rb', line 334

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::AsyncRequestClient (readonly)

Returns:



329
330
331
 
# File 'lib/samsara_api/tags/client.rb', line 329

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”)



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

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)
  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 || {}), 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
end

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

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



565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/samsara_api/tags/client.rb', line 565

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

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

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



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

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

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

api.tags.list



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/samsara_api/tags/client.rb', line 363

def list(limit: nil, after: 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 }.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
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”)



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/samsara_api/tags/client.rb', line 631

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)
  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 || {}), 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
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”)



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/samsara_api/tags/client.rb', line 519

def replace(id:, addresses: nil, assets: nil, drivers: nil, machines: nil, name: nil, parent_tag_id: nil, sensors: nil, vehicles: nil, request_options: nil)
  Async do
    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
end