Class: Samsara::DvirsClient

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::DvirsClient

Parameters:



23
24
25
 
# File 'lib/samsara_api/dvirs/client.rb', line 23

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



18
19
20
 
# File 'lib/samsara_api/dvirs/client.rb', line 18

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)



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/samsara_api/dvirs/client.rb', line 153

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)
  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

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

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/samsara_api/dvirs/client.rb', line 106

def get(id:, include_external_ids: 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 || {}), "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

#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”)



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/samsara_api/dvirs/client.rb', line 210

def history(limit: nil, after: nil, parent_tag_ids: nil, tag_ids: nil, start_time:, end_time:, 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 || {}), "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

#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”)



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/samsara_api/dvirs/client.rb', line 63

def stream(after: nil, limit: nil, include_external_ids: nil, start_time:, end_time: nil, safety_status: 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 || {}), "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

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

)



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

def update(id:, author_id:, is_resolved:, mechanic_notes: nil, signed_at_time: nil, 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 || {}), 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