Class: Io::Flow::V0::Models::MarginType

Inherits:

Object

• Object
• Io::Flow::V0::Models::MarginType

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Instance Attribute Summary

• #value ⇒ Object readonly

  Returns the value of attribute value.

Class Method Summary

• .ALL ⇒ Object
• .apply(value) ⇒ Object

  Returns the instance of MarginType for this value, creating a new instance for an unknown value.

• .fixed ⇒ Object

  A fixed amount to add, e.g 2.5 would add an absolute margin of 2.5 in the base currency of your item.

• .from_string(value) ⇒ Object

  Returns the instance of MarginType for this value, or nil if not found.

• .percent ⇒ Object

  A percent of the base cost to add, e.g.

Instance Method Summary

• #initialize(value) ⇒ MarginType constructor

  A new instance of MarginType.

• #to_hash ⇒ Object

Constructor Details

#initialize(value) ⇒ MarginType

Returns a new instance of MarginType.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9469

def initialize(value)
  @value = HttpClient::Preconditions.assert_class('value', value, String)
end

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9467

def value
  @value
end

Class Method Details

.ALL ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9489

def MarginType.ALL
  @@all ||= [MarginType.fixed, MarginType.percent]
end

.apply(value) ⇒ Object

Returns the instance of MarginType for this value, creating a new instance for an unknown value

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9474

def MarginType.apply(value)
  if value.instance_of?(MarginType)
    value
  else
    HttpClient::Preconditions.assert_class_or_nil('value', value, String)
    value.nil? ? nil : (from_string(value) || MarginType.new(value))
  end
end

.fixed ⇒ Object

A fixed amount to add, e.g 2.5 would add an absolute margin of 2.5 in the base currency of your item.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9495

def MarginType.fixed
  @@_fixed ||= MarginType.new('fixed')
end

.from_string(value) ⇒ Object

Returns the instance of MarginType for this value, or nil if not found

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9484

def MarginType.from_string(value)
  HttpClient::Preconditions.assert_class('value', value, String)
  MarginType.ALL.find { |v| v.value == value }
end

.percent ⇒ Object

A percent of the base cost to add, e.g. 1.2 would represent a 1.2% increase.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9500

def MarginType.percent
  @@_percent ||= MarginType.new('percent')
end

Instance Method Details

#to_hash ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9504

def to_hash
  value
end