Class: Samsara::DocumentsClient

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



25
26
27
28
 
# File 'lib/samsara_api/documents/client.rb', line 25

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

Instance Attribute Details

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



20
21
22
 
# File 'lib/samsara_api/documents/client.rb', line 20

def pdfs
  @pdfs
end

#request_client ⇒ Samsara::RequestClient (readonly) 



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

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



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

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

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

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/samsara_api/documents/client.rb', line 227

def delete(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
  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

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

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/samsara_api/documents/client.rb', line 182

def get(id:, 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
  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

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/samsara_api/documents/client.rb', line 67

def list(start_time:, end_time:, after: nil, document_type_id: nil, query_by: 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 || {}), "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