Class: Samsara::HosClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::HosClient

Parameters:



22
23
24
 
# File 'lib/samsara_api/hos/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/hos/client.rb', line 17

def request_client
  @request_client
end

Instance Method Details

#clocks(tag_ids: nil, parent_tag_ids: nil, driver_ids: nil, after: nil, limit: nil, request_options: nil) ⇒ Object

api.hos.clocks



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

def clocks(tag_ids: nil, parent_tag_ids: nil, driver_ids: nil, after: nil, limit: 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 || {}), "tagIds": tag_ids, "parentTagIds": parent_tag_ids, "driverIds": driver_ids, "after": after, "limit": limit }.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/hos/clocks"
end
  Samsara::Types::HosClocksResponse.from_json(json_object: response.body)
end

#daily_logs(driver_ids: nil, start_date: nil, end_date: nil, tag_ids: nil, parent_tag_ids: nil, driver_activation_status: nil, after: nil, expand: nil, request_options: nil) ⇒ Object

api.hos.daily_logs



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/samsara_api/hos/client.rb', line 136

def daily_logs(driver_ids: nil, start_date: nil, end_date: nil, tag_ids: nil, parent_tag_ids: nil, driver_activation_status: nil, after: nil, expand: 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 || {}), "driverIds": driver_ids, "startDate": start_date, "endDate": end_date, "tagIds": tag_ids, "parentTagIds": parent_tag_ids, "driverActivationStatus": driver_activation_status, "after": after, "expand": expand }.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/hos/daily-logs"
end
  Samsara::Types::HosDailyLogsGetHosDailyLogsResponseBody.from_json(json_object: response.body)
end

#logs(tag_ids: nil, parent_tag_ids: nil, driver_ids: nil, start_time: nil, end_time: nil, after: nil, request_options: nil) ⇒ Object

api.hos.logs



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

def logs(tag_ids: nil, parent_tag_ids: nil, driver_ids: nil, start_time: nil, end_time: 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 || {}), "tagIds": tag_ids, "parentTagIds": parent_tag_ids, "driverIds": driver_ids, "startTime": start_time, "endTime": end_time, "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)}/fleet/hos/logs"
end
  Samsara::Types::HosLogsResponse.from_json(json_object: response.body)
end

#violations(driver_ids: nil, start_time: nil, end_time: nil, tag_ids: nil, parent_tag_ids: nil, types: nil, after: nil, request_options: nil) ⇒ Object

api.hos.violations



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/samsara_api/hos/client.rb', line 285

def violations(driver_ids: nil, start_time: nil, end_time: nil, tag_ids: nil, parent_tag_ids: nil, types: 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 || {}), "driverIds": driver_ids, "startTime": start_time, "endTime": end_time, "tagIds": tag_ids, "parentTagIds": parent_tag_ids, "types": types, "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)}/fleet/hos/violations"
end
  Samsara::Types::HosViolationsGetHosViolationsResponseBody.from_json(json_object: response.body)
end