Class: Samsara::AssetsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::AssetsClient

Parameters:



28
29
30
31
 
# File 'lib/samsara_api/assets/client.rb', line 28

def initialize(request_client:)
  @request_client = request_client
  @location_and_speed = Samsara::Assets::LocationAndSpeedClient.new(request_client: request_client)
end

Instance Attribute Details

#location_and_speed ⇒ Samsara::Assets::LocationAndSpeedClient (readonly)

Returns:



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

def location_and_speed
  @location_and_speed
end

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



21
22
23
 
# File 'lib/samsara_api/assets/client.rb', line 21

def request_client
  @request_client
end

Instance Method Details

#create(external_ids: nil, license_plate: nil, make: nil, model: nil, name: nil, notes: nil, regulation_mode: nil, serial_number: nil, type: nil, vin: nil, year: nil, request_options: nil) ⇒ Object

api.assets.create



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

def create(external_ids: nil, license_plate: nil, make: nil, model: nil, name: nil, notes: nil, regulation_mode: nil, serial_number: nil, type: nil, vin: nil, year: 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 || {}), externalIds: external_ids, licensePlate: license_plate, make: make, model: model, name: name, notes: notes, regulationMode: regulation_mode, serialNumber: serial_number, type: type, vin: vin, year: year }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/assets"
end
  Samsara::Types::AssetsCreateAssetResponseBody.from_json(json_object: response.body)
end

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

api.assets.delete(id: “id”)



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/samsara_api/assets/client.rb', line 188

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)}/assets"
end
end

#list(type: nil, after: nil, updated_after_time: nil, include_external_ids: nil, include_tags: nil, tag_ids: nil, parent_tag_ids: nil, ids: nil, attribute_value_ids: nil, request_options: nil) ⇒ Object

api.assets.list



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/samsara_api/assets/client.rb', line 81

def list(type: nil, after: nil, updated_after_time: nil, include_external_ids: nil, include_tags: nil, tag_ids: nil, parent_tag_ids: nil, ids: nil, attribute_value_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 || {}), "type": type, "after": after, "updatedAfterTime": updated_after_time, "includeExternalIds": include_external_ids, "includeTags": include_tags, "tagIds": tag_ids, "parentTagIds": parent_tag_ids, "ids": ids, "attributeValueIds": attribute_value_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)}/assets"
end
  Samsara::Types::AssetsListAssetsResponseBody.from_json(json_object: response.body)
end

#update(id:, external_ids: nil, license_plate: nil, make: nil, model: nil, name: nil, notes: nil, regulation_mode: nil, serial_number: nil, type: nil, vin: nil, year: nil, request_options: nil) ⇒ Object

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/samsara_api/assets/client.rb', line 253

def update(id:, external_ids: nil, license_plate: nil, make: nil, model: nil, name: nil, notes: nil, regulation_mode: nil, serial_number: nil, type: nil, vin: nil, year: 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
  req.params = { **(request_options&.additional_query_parameters || {}), "id": id }.compact
  req.body = { **(request_options&.additional_body_parameters || {}), externalIds: external_ids, licensePlate: license_plate, make: make, model: model, name: name, notes: notes, regulationMode: regulation_mode, serialNumber: serial_number, type: type, vin: vin, year: year }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/assets"
end
  Samsara::Types::AssetsUpdateAssetResponseBody.from_json(json_object: response.body)
end