Class: Samsara::AsyncDvirsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::AsyncDvirsClient

Parameters:



283
284
285
 
# File 'lib/samsara_api/dvirs/client.rb', line 283

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::AsyncRequestClient (readonly)

Returns:



278
279
280
 
# File 'lib/samsara_api/dvirs/client.rb', line 278

def request_client
  @request_client
end

Instance Method Details

#create(author_id:, license_plate: nil, location: nil, mechanic_notes: nil, odometer_meters: nil, resolved_defect_ids: nil, safety_status:, trailer_id: nil, vehicle_id: nil, request_options: nil) ⇒ Object

api.dvirs.create(author_id: "11", safety_status: SAFE)



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

def create(author_id:, license_plate: nil, location: nil, mechanic_notes: nil, odometer_meters: nil, resolved_defect_ids: nil, safety_status:, trailer_id: 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 || {}), "type": "mechanic", authorId: author_id, licensePlate: license_plate, location: location, mechanicNotes: mechanic_notes, odometerMeters: odometer_meters, resolvedDefectIds: resolved_defect_ids, safetyStatus: safety_status, trailerId: trailer_id, vehicleId: vehicle_id }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/dvirs"
end
    Samsara::Types::DvirResponse.from_json(json_object: response.body)
  end
end

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

api.dvirs.get(id: "id")



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/samsara_api/dvirs/client.rb', line 368

def get(id:, include_external_ids: 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 || {}), "includeExternalIds": include_external_ids }.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)}/dvirs/#{id}"
end
    Samsara::Types::DvirGetDvirResponseBody.from_json(json_object: response.body)
  end
end

#history(limit: nil, after: nil, parent_tag_ids: nil, tag_ids: nil, start_time:, end_time:, request_options: nil) ⇒ Object

api.dvirs.history(start_time: "startTime", end_time: "endTime")



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/samsara_api/dvirs/client.rb', line 476

def history(limit: nil, after: nil, parent_tag_ids: nil, tag_ids: nil, start_time:, end_time:, 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, "startTime": start_time, "endTime": end_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)}/fleet/dvirs/history"
end
    Samsara::Types::DvirsListResponse.from_json(json_object: response.body)
  end
end

#stream(after: nil, limit: nil, include_external_ids: nil, start_time:, end_time: nil, safety_status: nil, request_options: nil) ⇒ Object

api.dvirs.stream(start_time: "startTime")



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/samsara_api/dvirs/client.rb', line 323

def stream(after: nil, limit: nil, include_external_ids: nil, start_time:, end_time: nil, safety_status: 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 || {}), "after": after, "limit": limit, "includeExternalIds": include_external_ids, "startTime": start_time, "endTime": end_time, "safetyStatus": safety_status }.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)}/dvirs/stream"
end
    Samsara::Types::DvirGetDvirsResponseBody.from_json(json_object: response.body)
  end
end

#update(id:, author_id:, is_resolved:, mechanic_notes: nil, signed_at_time: nil, request_options: nil) ⇒ Object

)



526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/samsara_api/dvirs/client.rb', line 526

def update(id:, author_id:, is_resolved:, mechanic_notes: nil, signed_at_time: 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 || {}), authorId: author_id, isResolved: is_resolved, mechanicNotes: mechanic_notes, signedAtTime: signed_at_time }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/dvirs/#{id}"
end
    Samsara::Types::DvirResponse.from_json(json_object: response.body)
  end
end