Class: Samsara::AsyncTrailersClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::AsyncTrailersClient 



306
307
308
 
# File 'lib/samsara_api/trailers/client.rb', line 306

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::AsyncRequestClient (readonly) 



301
302
303
 
# File 'lib/samsara_api/trailers/client.rb', line 301

def request_client
  @request_client
end

Instance Method Details

#create(attributes: nil, enabled_for_mobile: nil, external_ids: nil, license_plate: nil, name:, notes: nil, tag_ids: nil, trailer_serial_number: nil, request_options: nil) ⇒ Object

api.trailers.create(name: “Trailer-123”)



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/samsara_api/trailers/client.rb', line 405

def create(attributes: nil, enabled_for_mobile: nil, external_ids: nil, license_plate: nil, name:, notes: nil, tag_ids: nil, trailer_serial_number: 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 || {}), attributes: attributes, enabledForMobile: enabled_for_mobile, externalIds: external_ids, licensePlate: license_plate, name: name, notes: notes, tagIds: tag_ids, trailerSerialNumber: trailer_serial_number }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/trailers"
end
    Samsara::Types::TrailersCreateTrailerResponseBody.from_json(json_object: response.body)
  end
end

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

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



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/samsara_api/trailers/client.rb', line 499

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)}/fleet/trailers/#{id}"
end
  end
end

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

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



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/samsara_api/trailers/client.rb', line 453

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

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

api.trailers.list



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/samsara_api/trailers/client.rb', line 343

def list(tag_ids: nil, parent_tag_ids: nil, 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 || {}), "tagIds": tag_ids, "parentTagIds": parent_tag_ids, "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)}/fleet/trailers"
end
    Samsara::Types::TrailersListTrailersResponseBody.from_json(json_object: response.body)
  end
end

#update(id:, attributes: nil, enabled_for_mobile: nil, external_ids: nil, license_plate: nil, name: nil, notes: nil, odometer_meters: nil, tag_ids: nil, trailer_serial_number: nil, request_options: nil) ⇒ Object

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



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/samsara_api/trailers/client.rb', line 572

def update(id:, attributes: nil, enabled_for_mobile: nil, external_ids: nil, license_plate: nil, name: nil, notes: nil, odometer_meters: nil, tag_ids: nil, trailer_serial_number: 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 || {}), attributes: attributes, enabledForMobile: enabled_for_mobile, externalIds: external_ids, licensePlate: license_plate, name: name, notes: notes, odometerMeters: odometer_meters, tagIds: tag_ids, trailerSerialNumber: trailer_serial_number }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/trailers/#{id}"
end
    Samsara::Types::TrailersUpdateTrailerResponseBody.from_json(json_object: response.body)
  end
end