Class: Io::Flow::V0::Models::Attribute

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

Overview

An attribute can be configured to be used in different ways throughout Flow. A common example is to identify a meaningful attribute (e.g. brand) that can then be displayed throughout the Flow console.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ Attribute

Returns a new instance of Attribute.



23322
23323
23324
23325
23326
23327
23328
23329
23330
23331
23332
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23322

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :key, :options], 'Attribute')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @key = HttpClient::Preconditions.assert_class('key', opts.delete(:key), String)
  @options = (x = opts.delete(:options); x.is_a?(::Io::Flow::V0::Models::Options) ? x : ::Io::Flow::V0::Models::Options.new(x))
  @label = (x = opts.delete(:label); x.nil? ? nil : HttpClient::Preconditions.assert_class('label', x, String))
  @intent = (x = opts.delete(:intent); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::AttributeIntent) ? x : ::Io::Flow::V0::Models::AttributeIntent.apply(x)))
  @type = (x = opts.delete(:type); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::AttributeDataType) ? x : ::Io::Flow::V0::Models::AttributeDataType.apply(x)))
  @position = (x = opts.delete(:position); x.nil? ? nil : HttpClient::Preconditions.assert_class('position', x, Integer))
end

Instance Attribute Details

#id ⇒ Object (readonly)

Returns the value of attribute id.



23320
23321
23322
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23320

def id
  @id
end

#intent ⇒ Object (readonly)

Returns the value of attribute intent.



23320
23321
23322
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23320

def intent
  @intent
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



23320
23321
23322
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23320

def key
  @key
end

#label ⇒ Object (readonly)

Returns the value of attribute label.



23320
23321
23322
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23320

def label
  @label
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



23320
23321
23322
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23320

def options
  @options
end

#position ⇒ Object (readonly)

Returns the value of attribute position.



23320
23321
23322
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23320

def position
  @position
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



23320
23321
23322
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23320

def type
  @type
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



23338
23339
23340
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23338

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

#to_hash ⇒ Object 



23342
23343
23344
23345
23346
23347
23348
23349
23350
23351
23352
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23342

def to_hash
  {
    :id => id,
    :key => key,
    :options => options.to_hash,
    :label => label,
    :intent => intent.nil? ? nil : intent.value,
    :type => type.nil? ? nil : type.value,
    :position => position
  }
end

#to_json ⇒ Object 



23334
23335
23336
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23334

def to_json
  JSON.dump(to_hash)
end