Class: Io::Flow::V0::Clients::Attributes

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Attributes

Returns a new instance of Attributes.



469
470
471
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 469

def initialize(client)
  @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client)
end

Instance Method Details

#delete_by_key(organization, key) ⇒ Object

Delete an attribute with the specified key.



529
530
531
532
533
534
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 529

def delete_by_key(organization, key)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('key', key, String)
  r = @client.request("/#{CGI.escape(organization)}/attributes/#{CGI.escape(key)}").delete
  nil
end

#get(organization, incoming = {}) ⇒ Object

Search attributes. Always paginated.



474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 474

def get(organization, incoming={})
  HttpClient::Preconditions.assert_class('organization', organization, String)
  opts = HttpClient::Helper.symbolize_keys(incoming)
  query = {
    :id => (x = opts.delete(:id); x.nil? ? nil : HttpClient::Preconditions.assert_class('id', x, Array).map { |v| HttpClient::Preconditions.assert_class('id', v, String) }),
    :key => (x = opts.delete(:key); x.nil? ? nil : HttpClient::Preconditions.assert_class('key', x, Array).map { |v| HttpClient::Preconditions.assert_class('key', v, String) }),
    :limit => HttpClient::Preconditions.assert_class('limit', (x = opts.delete(:limit); x.nil? ? 25 : x), Integer),
    :offset => HttpClient::Preconditions.assert_class('offset', (x = opts.delete(:offset); x.nil? ? 0 : x), Integer),
    :sort => HttpClient::Preconditions.assert_class('sort', (x = opts.delete(:sort); x.nil? ? "position" : x), String)
  }.delete_if { |k, v| v.nil? }
  r = @client.request("/#{CGI.escape(organization)}/attributes").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::Attribute.new(x) }
end

#get_by_key(organization, key) ⇒ Object

Returns information about a specific attribute.



512
513
514
515
516
517
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 512

def get_by_key(organization, key)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('key', key, String)
  r = @client.request("/#{CGI.escape(organization)}/attributes/#{CGI.escape(key)}").get
  ::Io::Flow::V0::Models::Attribute.new(r)
end

#get_versions(organization, incoming = {}) ⇒ Object

Provides visibility into recent changes of each object, including deletion



497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 497

def get_versions(organization, incoming={})
  HttpClient::Preconditions.assert_class('organization', organization, String)
  opts = HttpClient::Helper.symbolize_keys(incoming)
  query = {
    :id => (x = opts.delete(:id); x.nil? ? nil : HttpClient::Preconditions.assert_class('id', x, Array).map { |v| HttpClient::Preconditions.assert_class('id', v, String) }),
    :key => (x = opts.delete(:key); x.nil? ? nil : HttpClient::Preconditions.assert_class('key', x, Array).map { |v| HttpClient::Preconditions.assert_class('key', v, String) }),
    :limit => HttpClient::Preconditions.assert_class('limit', (x = opts.delete(:limit); x.nil? ? 25 : x), Integer),
    :offset => HttpClient::Preconditions.assert_class('offset', (x = opts.delete(:offset); x.nil? ? 0 : x), Integer),
    :sort => HttpClient::Preconditions.assert_class('sort', (x = opts.delete(:sort); x.nil? ? "journal_timestamp" : x), String)
  }.delete_if { |k, v| v.nil? }
  r = @client.request("/#{CGI.escape(organization)}/attributes/versions").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::AttributeVersion.new(x) }
end

#post(organization, attribute_form) ⇒ Object

Add attribute



489
490
491
492
493
494
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 489

def post(organization, attribute_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  (x = attribute_form; x.is_a?(::Io::Flow::V0::Models::AttributeForm) ? x : ::Io::Flow::V0::Models::AttributeForm.new(x))
  r = @client.request("/#{CGI.escape(organization)}/attributes").with_json(attribute_form.to_json).post
  ::Io::Flow::V0::Models::Attribute.new(r)
end

#put_by_key(organization, key, attribute_form) ⇒ Object

Create or update an attribute with the specified key.



520
521
522
523
524
525
526
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 520

def put_by_key(organization, key, attribute_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('key', key, String)
  (x = attribute_form; x.is_a?(::Io::Flow::V0::Models::AttributeForm) ? x : ::Io::Flow::V0::Models::AttributeForm.new(x))
  r = @client.request("/#{CGI.escape(organization)}/attributes/#{CGI.escape(key)}").with_json(attribute_form.to_json).put
  ::Io::Flow::V0::Models::Attribute.new(r)
end