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.



20192
20193
20194
20195
20196
20197
20198
20199
20200
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20192

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.



20190
20191
20192
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20190

def attribute_keys
  @attribute_keys
end

#experienceObject (readonly)

Returns the value of attribute experience.



20190
20191
20192
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20190

def experience
  @experience
end

#idObject (readonly)

Returns the value of attribute id.



20190
20191
20192
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20190

def id
  @id
end

#keyObject (readonly)

Returns the value of attribute key.



20190
20191
20192
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20190

def key
  @key
end

#positionObject (readonly)

Returns the value of attribute position.



20190
20191
20192
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20190

def position
  @position
end

Instance Method Details

#copy(incoming = {}) ⇒ Object



20206
20207
20208
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20206

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

#to_hashObject



20210
20211
20212
20213
20214
20215
20216
20217
20218
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20210

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

#to_jsonObject



20202
20203
20204
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20202

def to_json
  JSON.dump(to_hash)
end