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.



693
694
695
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 693

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.



761
762
763
764
765
766
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 761

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.



698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 698

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.



744
745
746
747
748
749
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 744

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



729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 729

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



713
714
715
716
717
718
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 713

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(organization, attribute_forms) ⇒ Object

Create or update a batch of attributes



721
722
723
724
725
726
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 721

def put(organization, attribute_forms)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('attribute_forms', attribute_forms, Array).map { |v| (x = v; 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_forms.map { |o| o.to_hash }.to_json).put
  r.map { |x| ::Io::Flow::V0::Models::Attribute.new(x) }
end

#put_by_key(organization, key, attribute_form) ⇒ Object

Create or update an attribute with the specified key.



752
753
754
755
756
757
758
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 752

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