Class: Samsara::FormSubmissionsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::FormSubmissionsClient

Parameters:



31
32
33
34
 
# File 'lib/samsara_api/form_submissions/client.rb', line 31

def initialize(request_client:)
  @request_client = request_client
  @pdf_exports = Samsara::FormSubmissions::PdfExportsClient.new(request_client: request_client)
end

Instance Attribute Details

#pdf_exports ⇒ Samsara::FormSubmissions::PdfExportsClient (readonly)

Returns:



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

def pdf_exports
  @pdf_exports
end

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



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

def request_client
  @request_client
end

Instance Method Details

#create(assigned_to: nil, due_at_time: nil, fields: nil, form_template:, is_required: nil, route_stop_id: nil, title: nil, request_options: nil) ⇒ Object

api.form_submissions.create(form_template: { id: “9814a1fa-f0c6-408b-bf85-51dc3bc71ac7”, revision_id: “1214a1fa-f0c6-408b-bf85-51dc3bc71ac7” })



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/samsara_api/form_submissions/client.rb', line 145

def create(assigned_to: nil, due_at_time: nil, fields: nil, form_template:, is_required: nil, route_stop_id: nil, title: 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 || {}), "status": "notStarted", assignedTo: assigned_to, dueAtTime: due_at_time, fields: fields, formTemplate: form_template, isRequired: is_required, routeStopId: route_stop_id, title: title }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/form-submissions"
end
  Samsara::Types::FormSubmissionsPostFormSubmissionResponseBody.from_json(json_object: response.body)
end

#list(ids: nil, include: nil, request_options: nil) ⇒ Object

api.form_submissions.list



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

def list(ids: nil, include: 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 || {}), "ids": ids, "include": include }.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)}/form-submissions"
end
  Samsara::Types::FormSubmissionsGetFormSubmissionsResponseBody.from_json(json_object: response.body)
end

#stream(start_time:, end_time: nil, after: nil, form_template_ids: nil, user_ids: nil, driver_ids: nil, include: nil, assigned_to_route_stop_ids: nil, request_options: nil) ⇒ Object

api.form_submissions.stream(start_time: “startTime”)



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/samsara_api/form_submissions/client.rb', line 264

def stream(start_time:, end_time: nil, after: nil, form_template_ids: nil, user_ids: nil, driver_ids: nil, include: nil, assigned_to_route_stop_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 || {}), "startTime": start_time, "endTime": end_time, "after": after, "formTemplateIds": form_template_ids, "userIds": user_ids, "driverIds": driver_ids, "include": include, "assignedToRouteStopIds": assigned_to_route_stop_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)}/form-submissions/stream"
end
  Samsara::Types::FormSubmissionsGetFormSubmissionsStreamResponseBody.from_json(json_object: response.body)
end

#update(approval_details: nil, assigned_to: nil, due_at_time: nil, id:, is_required: nil, route_stop_id: nil, status: nil, title: nil, request_options: nil) ⇒ Object

api.form_submissions.update(id: “9814a1fa-f0c6-408b-bf85-51dc3bc71ac8”, status: NOT_STARTED)



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/samsara_api/form_submissions/client.rb', line 202

def update(approval_details: nil, assigned_to: nil, due_at_time: nil, id:, is_required: nil, route_stop_id: nil, status: nil, title: 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 || {}), approvalDetails: approval_details, assignedTo: assigned_to, dueAtTime: due_at_time, id: id, isRequired: is_required, routeStopId: route_stop_id, status: status, title: title }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/form-submissions"
end
  Samsara::Types::FormSubmissionsPatchFormSubmissionResponseBody.from_json(json_object: response.body)
end