Class: Io::Flow::V0::Models::CheckoutAttribute

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

Overview

A Checkout Attribute defines an attribute that will be made available via the checkout item content. This is useful if you would like to surface a specific attribute (like ‘size’ or ‘color’) in checkout.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ CheckoutAttribute

Returns a new instance of CheckoutAttribute.



16564
16565
16566
16567
16568
16569
16570
16571
16572
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16564

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :experience, :key, :attribute_keys, :position], 'CheckoutAttribute')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @experience = (x = opts.delete(:experience); x.is_a?(::Io::Flow::V0::Models::ExperienceReference) ? x : ::Io::Flow::V0::Models::ExperienceReference.new(x))
  @key = HttpClient::Preconditions.assert_class('key', opts.delete(:key), String)
  @attribute_keys = HttpClient::Preconditions.assert_class('attribute_keys', opts.delete(:attribute_keys), Array).map { |v| HttpClient::Preconditions.assert_class('attribute_keys', v, String) }
  @position = HttpClient::Preconditions.assert_class('position', opts.delete(:position), Integer)
end

Instance Attribute Details

#attribute_keysObject (readonly)

Returns the value of attribute attribute_keys.



16562
16563
16564
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16562

def attribute_keys
  @attribute_keys
end

#experienceObject (readonly)

Returns the value of attribute experience.



16562
16563
16564
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16562

def experience
  @experience
end

#idObject (readonly)

Returns the value of attribute id.



16562
16563
16564
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16562

def id
  @id
end

#keyObject (readonly)

Returns the value of attribute key.



16562
16563
16564
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16562

def key
  @key
end

#positionObject (readonly)

Returns the value of attribute position.



16562
16563
16564
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16562

def position
  @position
end

Instance Method Details

#copy(incoming = {}) ⇒ Object



16578
16579
16580
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16578

def copy(incoming={})
  CheckoutAttribute.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
end

#to_hashObject



16582
16583
16584
16585
16586
16587
16588
16589
16590
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16582

def to_hash
  {
    :id => id,
    :experience => experience.to_hash,
    :key => key,
    :attribute_keys => attribute_keys,
    :position => position
  }
end

#to_jsonObject



16574
16575
16576
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16574

def to_json
  JSON.dump(to_hash)
end