Class: Samsara::AsyncAttributesClient

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::AsyncAttributesClient

Parameters:



277
278
279
 
# File 'lib/samsara_api/attributes/client.rb', line 277

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::AsyncRequestClient (readonly)

Returns:



272
273
274
 
# File 'lib/samsara_api/attributes/client.rb', line 272

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

)



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/samsara_api/attributes/client.rb', line 366

def create(attribute_type:, attribute_value_quantity:, entities: nil, entity_type:, name:, number_values: nil, string_values: nil, request_options: nil)
  Async do
    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
end

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

api.attributes.delete(id: "id", entity_type: DRIVER)



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/samsara_api/attributes/client.rb', line 450

def delete(id:, entity_type:, request_options: nil)
  Async do
    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
end

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

api.attributes.get(id: "id", entity_type: DRIVER)



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/samsara_api/attributes/client.rb', line 408

def get(id:, entity_type:, request_options: nil)
  Async do
    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
end

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

api.attributes.list(entity_type: DRIVER)



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/samsara_api/attributes/client.rb', line 308

def list(entity_type:, limit: nil, after: nil, request_options: nil)
  Async do
    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
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)



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/samsara_api/attributes/client.rb', line 506

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)
  Async do
    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
end