Class: Samsara::AttributesClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::AttributesClient

Parameters:



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

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



26
27
28
 
# File 'lib/samsara_api/attributes/client.rb', line 26

def request_client
  @request_client
end

Instance Method Details

#create(attribute_type:, attribute_value_quantity:, entities: nil, entity_type:, name:, number_values: nil, string_values: nil, request_options: nil) ⇒ Object

)



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

def create(attribute_type:, attribute_value_quantity:, entities: nil, entity_type:, name:, number_values: nil, string_values: 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 || {}), attributeType: attribute_type, attributeValueQuantity: attribute_value_quantity, entities: entities, entityType: entity_type, name: name, numberValues: number_values, stringValues: string_values }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/attributes"
end
  Samsara::Types::AttributeExpandedResponse.from_json(json_object: response.body)
end

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

api.attributes.delete(id: “id”, entity_type: DRIVER)



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

def delete(id:, entity_type:, 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 || {}), "entityType": entity_type }.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)}/attributes/#{id}"
end
  parsed_json = JSON.parse(response.body)
  parsed_json
end

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

api.attributes.get(id: “id”, entity_type: DRIVER)



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

def get(id:, entity_type:, 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 || {}), "entityType": entity_type }.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)}/attributes/#{id}"
end
  Samsara::Types::AttributeExpandedResponse.from_json(json_object: response.body)
end

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

api.attributes.list(entity_type: DRIVER)



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

def list(entity_type:, 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 || {}), "entityType": entity_type, "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)}/attributes"
end
  Samsara::Types::GetAttributesByEntityTypeResponse.from_json(json_object: response.body)
end

#update(id:, attribute_type: nil, attribute_value_quantity: nil, entities: nil, entity_type:, name: nil, number_values: nil, string_values: nil, request_options: nil) ⇒ Object

api.attributes.update(id: “id”, entity_type: DRIVER)



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

def update(id:, attribute_type: nil, attribute_value_quantity: nil, entities: nil, entity_type:, name: nil, number_values: nil, string_values: 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 || {}), attributeType: attribute_type, attributeValueQuantity: attribute_value_quantity, entities: entities, entityType: entity_type, name: name, numberValues: number_values, stringValues: string_values }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/attributes/#{id}"
end
  Samsara::Types::AttributeExpandedResponse.from_json(json_object: response.body)
end