Class: Samsara::Maintenance::WorkOrdersClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::Maintenance::WorkOrdersClient

Parameters:



36
37
38
 
# File 'lib/samsara_api/maintenance/work_orders/client.rb', line 36

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



31
32
33
 
# File 'lib/samsara_api/maintenance/work_orders/client.rb', line 31

def request_client
  @request_client
end

Instance Method Details

#create(asset_id:, assigned_user_id: nil, category: nil, created_by_user_id: nil, description: nil, discount: nil, due_at_time: nil, engine_hours: nil, items: nil, odometer_meters: nil, priority: nil, service_task_instances: nil, tax: nil, request_options: nil) ⇒ Object

api.maintenance.work_orders.create(asset_id: "12443")



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

def create(asset_id:, assigned_user_id: nil, category: nil, created_by_user_id: nil, description: nil, discount: nil, due_at_time: nil, engine_hours: nil, items: nil, odometer_meters: nil, priority: nil, service_task_instances: nil, tax: 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 || {}), assetId: asset_id, assignedUserId: assigned_user_id, category: category, createdByUserId: created_by_user_id, description: description, discount: discount, dueAtTime: due_at_time, engineHours: engine_hours, items: items, odometerMeters: odometer_meters, priority: priority, serviceTaskInstances: service_task_instances, tax: tax }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/maintenance/work-orders"
end
  Samsara::Types::PostWorkOrdersResponseBody.from_json(json_object: response.body)
end

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

api.maintenance.work_orders.delete(id: "id")



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/samsara_api/maintenance/work_orders/client.rb', line 186

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
  req.params = { **(request_options&.additional_query_parameters || {}), "id": id }.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)}/maintenance/work-orders"
end
end

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

api.maintenance.work_orders.list



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

def list(ids: nil, after: 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, "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)}/maintenance/work-orders"
end
  Samsara::Types::GetWorkOrdersResponseBody.from_json(json_object: response.body)
end

#stream(after: nil, start_time:, end_time: nil, work_order_statuses: nil, asset_ids: nil, assigned_user_ids: nil, request_options: nil) ⇒ Object

api.maintenance.work_orders.stream(start_time: "startTime")



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/samsara_api/maintenance/work_orders/client.rb', line 320

def stream(after: nil, start_time:, end_time: nil, work_order_statuses: nil, asset_ids: nil, assigned_user_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 || {}), "after": after, "startTime": start_time, "endTime": end_time, "workOrderStatuses": work_order_statuses, "assetIds": asset_ids, "assignedUserIds": assigned_user_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)}/maintenance/work-orders/stream"
end
  Samsara::Types::StreamWorkOrdersResponseBody.from_json(json_object: response.body)
end

#update(assigned_user_id: nil, category: nil, closing_notes: nil, completed_at_time: nil, description: nil, discount: nil, due_at_time: nil, engine_hours: nil, id:, items: nil, odometer_meters: nil, priority: nil, service_task_instances: nil, status: nil, tax: nil, request_options: nil) ⇒ Object

api.maintenance.work_orders.update(id: "5")



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/samsara_api/maintenance/work_orders/client.rb', line 267

def update(assigned_user_id: nil, category: nil, closing_notes: nil, completed_at_time: nil, description: nil, discount: nil, due_at_time: nil, engine_hours: nil, id:, items: nil, odometer_meters: nil, priority: nil, service_task_instances: nil, status: nil, tax: 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 || {}), assignedUserId: assigned_user_id, category: category, closingNotes: closing_notes, completedAtTime: completed_at_time, description: description, discount: discount, dueAtTime: due_at_time, engineHours: engine_hours, id: id, items: items, odometerMeters: odometer_meters, priority: priority, serviceTaskInstances: service_task_instances, status: status, tax: tax }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/maintenance/work-orders"
end
  Samsara::Types::PatchWorkOrdersResponseBody.from_json(json_object: response.body)
end