Class: Samsara::TrailersClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::TrailersClient

Parameters:



23
24
25
 
# File 'lib/samsara_api/trailers/client.rb', line 23

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



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

def request_client
  @request_client
end

Instance Method Details

#create(attributes: nil, enabled_for_mobile: nil, external_ids: nil, license_plate: nil, name:, notes: nil, tag_ids: nil, trailer_serial_number: nil, request_options: nil) ⇒ Object

api.trailers.create(name: "Trailer-123")



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/samsara_api/trailers/client.rb', line 120

def create(attributes: nil, enabled_for_mobile: nil, external_ids: nil, license_plate: nil, name:, notes: nil, tag_ids: nil, trailer_serial_number: 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 || {}), attributes: attributes, enabledForMobile: enabled_for_mobile, externalIds: external_ids, licensePlate: license_plate, name: name, notes: notes, tagIds: tag_ids, trailerSerialNumber: trailer_serial_number }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/trailers"
end
  Samsara::Types::TrailersCreateTrailerResponseBody.from_json(json_object: response.body)
end

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

api.trailers.delete(id: "id")



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/samsara_api/trailers/client.rb', line 210

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/trailers/#{id}"
end
end

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

api.trailers.get(id: "id")



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/samsara_api/trailers/client.rb', line 166

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

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

api.trailers.list



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

def list(tag_ids: nil, parent_tag_ids: nil, limit: 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, "limit": limit, "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/trailers"
end
  Samsara::Types::TrailersListTrailersResponseBody.from_json(json_object: response.body)
end

#update(id:, attributes: nil, enabled_for_mobile: nil, external_ids: nil, license_plate: nil, name: nil, notes: nil, odometer_meters: nil, tag_ids: nil, trailer_serial_number: nil, request_options: nil) ⇒ Object

api.trailers.update(id: "id")



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/samsara_api/trailers/client.rb', line 281

def update(id:, attributes: nil, enabled_for_mobile: nil, external_ids: nil, license_plate: nil, name: nil, notes: nil, odometer_meters: nil, tag_ids: nil, trailer_serial_number: 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 || {}), attributes: attributes, enabledForMobile: enabled_for_mobile, externalIds: external_ids, licensePlate: license_plate, name: name, notes: notes, odometerMeters: odometer_meters, tagIds: tag_ids, trailerSerialNumber: trailer_serial_number }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/trailers/#{id}"
end
  Samsara::Types::TrailersUpdateTrailerResponseBody.from_json(json_object: response.body)
end