Class: Samsara::DriverVehicleAssignmentsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::DriverVehicleAssignmentsClient

Parameters:



24
25
26
 
# File 'lib/samsara_api/driver_vehicle_assignments/client.rb', line 24

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



19
20
21
 
# File 'lib/samsara_api/driver_vehicle_assignments/client.rb', line 19

def request_client
  @request_client
end

Instance Method Details

#create(assigned_at_time: nil, driver_id:, end_time: nil, is_passenger: nil, metadata: nil, start_time: nil, vehicle_id:, request_options: nil) ⇒ Object

api.driver_vehicle_assignments.create(driver_id: “494123”, vehicle_id: “281474978683353”)



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/samsara_api/driver_vehicle_assignments/client.rb', line 141

def create(assigned_at_time: nil, driver_id:, end_time: nil, is_passenger: nil, metadata: nil, start_time: nil, vehicle_id:, request_options: nil)
  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 || {}), assignedAtTime: assigned_at_time, driverId: driver_id, endTime: end_time, isPassenger: is_passenger, metadata: metadata, startTime: start_time, vehicleId: vehicle_id }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/driver-vehicle-assignments"
end
  Samsara::Types::DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentResponseBody.from_json(json_object: response.body)
end

#delete(assigned_at_time: nil, end_time: nil, is_passenger: nil, start_time: nil, vehicle_id:, request_options: nil) ⇒ Object

api.driver_vehicle_assignments.delete(vehicle_id: “281474978683353”)



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/samsara_api/driver_vehicle_assignments/client.rb', line 196

def delete(assigned_at_time: nil, end_time: nil, is_passenger: nil, start_time: nil, vehicle_id:, request_options: nil)
  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
  req.body = { **(request_options&.additional_body_parameters || {}), assignedAtTime: assigned_at_time, endTime: end_time, isPassenger: is_passenger, startTime: start_time, vehicleId: vehicle_id }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/driver-vehicle-assignments"
end
end

#get(filter_by:, start_time: nil, end_time: nil, driver_ids: nil, vehicle_ids: nil, driver_tag_ids: nil, vehicle_tag_ids: nil, after: nil, assignment_type: nil, request_options: nil) ⇒ Object

api.driver_vehicle_assignments.get(filter_by: DRIVERS)



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/samsara_api/driver_vehicle_assignments/client.rb', line 81

def get(filter_by:, start_time: nil, end_time: nil, driver_ids: nil, vehicle_ids: nil, driver_tag_ids: nil, vehicle_tag_ids: nil, after: nil, assignment_type: nil, request_options: nil)
  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 || {}), "filterBy": filter_by, "startTime": start_time, "endTime": end_time, "driverIds": driver_ids, "vehicleIds": vehicle_ids, "driverTagIds": driver_tag_ids, "vehicleTagIds": vehicle_tag_ids, "after": after, "assignmentType": assignment_type }.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/driver-vehicle-assignments"
end
  Samsara::Types::DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsResponseBody.from_json(json_object: response.body)
end

#update(assigned_at_time: nil, driver_id:, end_time: nil, is_passenger: nil, metadata: nil, start_time:, vehicle_id:, request_options: nil) ⇒ Object

)



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/samsara_api/driver_vehicle_assignments/client.rb', line 259

def update(assigned_at_time: nil, driver_id:, end_time: nil, is_passenger: nil, metadata: nil, start_time:, vehicle_id:, request_options: nil)
  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 || {}), assignedAtTime: assigned_at_time, driverId: driver_id, endTime: end_time, isPassenger: is_passenger, metadata: metadata, startTime: start_time, vehicleId: vehicle_id }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/driver-vehicle-assignments"
end
  Samsara::Types::DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentResponseBody.from_json(json_object: response.body)
end