Class: Samsara::AsyncRoutesClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::AsyncRoutesClient

Parameters:



359
360
361
362
 
# File 'lib/samsara_api/routes/client.rb', line 359

def initialize(request_client:)
  @request_client = request_client
  @audit_logs = Samsara::Routes::AsyncAuditLogsClient.new(request_client: request_client)
end

Instance Attribute Details

#audit_logs ⇒ Samsara::Routes::AuditLogsClient (readonly)

Returns:



354
355
356
 
# File 'lib/samsara_api/routes/client.rb', line 354

def audit_logs
  @audit_logs
end

#request_client ⇒ Samsara::AsyncRequestClient (readonly)

Returns:



352
353
354
 
# File 'lib/samsara_api/routes/client.rb', line 352

def request_client
  @request_client
end

Instance Method Details

#create(driver_id: nil, external_ids: nil, name:, notes: nil, recompute_scheduled_times: nil, settings: nil, stops:, vehicle_id: nil, request_options: nil) ⇒ Object

api.routes.create(name: "Bid 123", stops: [{ }])



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

def create(driver_id: nil, external_ids: nil, name:, notes: nil, recompute_scheduled_times: nil, settings: nil, stops:, 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 || {}), driverId: driver_id, externalIds: external_ids, name: name, notes: notes, recomputeScheduledTimes: recompute_scheduled_times, settings: settings, stops: stops, vehicleId: vehicle_id }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/routes"
end
    Samsara::Types::RoutesCreateRouteResponseBody.from_json(json_object: response.body)
  end
end

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

api.routes.delete(id: "id")



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

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

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

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



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

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

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

api.routes.list(start_time: "startTime", end_time: "endTime")



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/samsara_api/routes/client.rb', line 399

def list(start_time:, end_time:, 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 || {}), "startTime": start_time, "endTime": end_time, "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/routes"
end
    Samsara::Types::RoutesFetchRoutesResponseBody.from_json(json_object: response.body)
  end
end

#update(id:, driver_id: nil, external_ids: nil, name: nil, notes: nil, recompute_scheduled_times: nil, settings: nil, stops: nil, vehicle_id: nil, request_options: nil) ⇒ Object

api.routes.update(id: "id")



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'lib/samsara_api/routes/client.rb', line 671

def update(id:, driver_id: nil, external_ids: nil, name: nil, notes: nil, recompute_scheduled_times: nil, settings: nil, stops: nil, vehicle_id: 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 || {}), driverId: driver_id, externalIds: external_ids, name: name, notes: notes, recomputeScheduledTimes: recompute_scheduled_times, settings: settings, stops: stops, vehicleId: vehicle_id }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/routes/#{id}"
end
    Samsara::Types::RoutesPatchRouteResponseBody.from_json(json_object: response.body)
  end
end