Class: Samsara::DefectsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::DefectsClient

Parameters:



22
23
24
 
# File 'lib/samsara_api/defects/client.rb', line 22

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



17
18
19
 
# File 'lib/samsara_api/defects/client.rb', line 17

def request_client
  @request_client
end

Instance Method Details

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

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/samsara_api/defects/client.rb', line 103

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)}/defects/#{id}"
end
  Samsara::Types::DvirDefectGetDefectResponseBody.from_json(json_object: response.body)
end

#history(limit: nil, after: nil, start_time:, end_time:, is_resolved: nil, request_options: nil) ⇒ Object

api.defects.history(start_time: “startTime”, end_time: “endTime”)



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/samsara_api/defects/client.rb', line 159

def history(limit: nil, after: nil, start_time:, end_time:, is_resolved: 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 || {}), "limit": limit, "after": after, "startTime": start_time, "endTime": end_time, "isResolved": is_resolved }.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/defects/history"
end
  Samsara::Types::DefectsResponse.from_json(json_object: response.body)
end

#stream(after: nil, limit: nil, start_time:, end_time: nil, include_external_ids: nil, is_resolved: nil, request_options: nil) ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/samsara_api/defects/client.rb', line 60

def stream(after: nil, limit: nil, start_time:, end_time: nil, include_external_ids: nil, is_resolved: 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, "startTime": start_time, "endTime": end_time, "includeExternalIds": include_external_ids, "isResolved": is_resolved }.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)}/defects/stream"
end
  Samsara::Types::DvirDefectStreamDefectsResponseBody.from_json(json_object: response.body)
end

#update(id:, is_resolved: nil, mechanic_notes: nil, resolved_at_time: nil, resolved_by: nil, request_options: nil) ⇒ Object

api.defects.update(id: “id”)



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/samsara_api/defects/client.rb', line 206

def update(id:, is_resolved: nil, mechanic_notes: nil, resolved_at_time: nil, resolved_by: 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 || {}), isResolved: is_resolved, mechanicNotes: mechanic_notes, resolvedAtTime: resolved_at_time, resolvedBy: resolved_by }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/defects/#{id}"
end
  Samsara::Types::DefectResponse.from_json(json_object: response.body)
end