Class: Samsara::AsyncDocumentsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::AsyncDocumentsClient

Parameters:



255
256
257
258
 
# File 'lib/samsara_api/documents/client.rb', line 255

def initialize(request_client:)
  @request_client = request_client
  @pdfs = Samsara::Documents::AsyncPdfsClient.new(request_client: request_client)
end

Instance Attribute Details

#pdfs ⇒ Samsara::Documents::PdfsClient (readonly)

Returns:



250
251
252
 
# File 'lib/samsara_api/documents/client.rb', line 250

def pdfs
  @pdfs
end

#request_client ⇒ Samsara::AsyncRequestClient (readonly)

Returns:



248
249
250
 
# File 'lib/samsara_api/documents/client.rb', line 248

def request_client
  @request_client
end

Instance Method Details

#create(document_type_id:, driver_id:, fields: nil, name: nil, notes: nil, route_stop_id: nil, state: nil, vehicle_id: nil, request_options: nil) ⇒ Object

api.documents.create(document_type_id: “9814a1fa-f0c6-408b-bf85-51dc3bc71ac7”, driver_id: “45646”)



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/samsara_api/documents/client.rb', line 371

def create(document_type_id:, driver_id:, fields: nil, name: nil, notes: nil, route_stop_id: nil, state: nil, vehicle_id: 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 || {}), documentTypeId: document_type_id, driverId: driver_id, fields: fields, name: name, notes: notes, routeStopId: route_stop_id, state: state, vehicleId: vehicle_id }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/documents"
end
    Samsara::Types::DocumentsPostDocumentResponseBody.from_json(json_object: response.body)
  end
end

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

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



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

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/documents/#{id}"
end
  end
end

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

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



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

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

#list(start_time:, end_time:, after: nil, document_type_id: nil, query_by: nil, request_options: nil) ⇒ Object

api.documents.list(start_time: “startTime”, end_time: “endTime”)



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/samsara_api/documents/client.rb', line 297

def list(start_time:, end_time:, after: nil, document_type_id: nil, query_by: 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 || {}), "startTime": start_time, "endTime": end_time, "after": after, "documentTypeId": document_type_id, "queryBy": query_by }.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/documents"
end
    Samsara::Types::DocumentsGetDocumentsResponseBody.from_json(json_object: response.body)
  end
end