Class: Io::Flow::V0::Models::PriceDetailComponentKey

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value) ⇒ PriceDetailComponentKey

Returns a new instance of PriceDetailComponentKey.



15070
15071
15072
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15070

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



15068
15069
15070
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15068

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



15090
15091
15092
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15090

def PriceDetailComponentKey.ALL
  @@all ||= [PriceDetailComponentKey.base_price, PriceDetailComponentKey.discount, PriceDetailComponentKey.currency_margin, PriceDetailComponentKey.percent_item_margin, PriceDetailComponentKey.fixed_item_margin, PriceDetailComponentKey.duties_item_price, PriceDetailComponentKey.duties_added_margin, PriceDetailComponentKey.duties_rounding, PriceDetailComponentKey.duties_deminimis, PriceDetailComponentKey.vat_item_price, PriceDetailComponentKey.vat_added_margin, PriceDetailComponentKey.vat_rounding, PriceDetailComponentKey.vat_duties_item_price, PriceDetailComponentKey.vat_duties_added_margin, PriceDetailComponentKey.vat_duties_rounding, PriceDetailComponentKey.vat_deminimis, PriceDetailComponentKey.item_price_percent_sales_margin, PriceDetailComponentKey.margins_percent_sales_margin, PriceDetailComponentKey.rounding_percent_sales_margin, PriceDetailComponentKey.vat_percent_sales_margin, PriceDetailComponentKey.vat_duty_percent_sales_margin, PriceDetailComponentKey.duty_percent_sales_margin]
end

.apply(value) ⇒ Object

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



15075
15076
15077
15078
15079
15080
15081
15082
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15075

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

.base_price ⇒ Object

The base price of the item.



15095
15096
15097
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15095

def PriceDetailComponentKey.base_price
  @@_base_price ||= PriceDetailComponentKey.new('base_price')
end

.currency_margin ⇒ Object

The amount added to the post-discount item price due to FX markup, as configured in the organization’s currency settings.



15106
15107
15108
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15106

def PriceDetailComponentKey.currency_margin
  @@_currency_margin ||= PriceDetailComponentKey.new('currency_margin')
end

.discount ⇒ Object

A discount applied to the base price of the item.



15100
15101
15102
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15100

def PriceDetailComponentKey.discount
  @@_discount ||= PriceDetailComponentKey.new('discount')
end

.duties_added_margin ⇒ Object

The duty owed on the sum of the currency margin, percent item margin, and fixed item margin.



15129
15130
15131
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15129

def PriceDetailComponentKey.duties_added_margin
  @@_duties_added_margin ||= PriceDetailComponentKey.new('duties_added_margin')
end

.duties_deminimis ⇒ Object

An adjustment made if the item does not meet the duty de minimis rule.



15139
15140
15141
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15139

def PriceDetailComponentKey.duties_deminimis
  @@_duties_deminimis ||= PriceDetailComponentKey.new('duties_deminimis')
end

.duties_item_price ⇒ Object

The duty owed on the post-discount base item price.



15123
15124
15125
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15123

def PriceDetailComponentKey.duties_item_price
  @@_duties_item_price ||= PriceDetailComponentKey.new('duties_item_price')
end

.duties_rounding ⇒ Object

The duty owed on any rounding applied to the total item price.



15134
15135
15136
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15134

def PriceDetailComponentKey.duties_rounding
  @@_duties_rounding ||= PriceDetailComponentKey.new('duties_rounding')
end

.duty_percent_sales_margin ⇒ Object

An adjustment made to duty owed as a result of a percent sales margin.



15207
15208
15209
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15207

def PriceDetailComponentKey.duty_percent_sales_margin
  @@_duty_percent_sales_margin ||= PriceDetailComponentKey.new('duty_percent_sales_margin')
end

.fixed_item_margin ⇒ Object

The amount added to the post-discount item price from a fixed item margin. Negative amounts represent discounts.



15118
15119
15120
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15118

def PriceDetailComponentKey.fixed_item_margin
  @@_fixed_item_margin ||= PriceDetailComponentKey.new('fixed_item_margin')
end

.from_string(value) ⇒ Object

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



15085
15086
15087
15088
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15085

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

.item_price_percent_sales_margin ⇒ Object

An adjustment made to the item price as a result of a percent sales margin.



15181
15182
15183
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15181

def PriceDetailComponentKey.item_price_percent_sales_margin
  @@_item_price_percent_sales_margin ||= PriceDetailComponentKey.new('item_price_percent_sales_margin')
end

.margins_percent_sales_margin ⇒ Object

An adjustment made to the item margins as a result of a percent sales margin.



15186
15187
15188
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15186

def PriceDetailComponentKey.margins_percent_sales_margin
  @@_margins_percent_sales_margin ||= PriceDetailComponentKey.new('margins_percent_sales_margin')
end

.percent_item_margin ⇒ Object

The amount added to the post-discount item price from a percent item margin. Negative amounts represent discounts.



15112
15113
15114
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15112

def PriceDetailComponentKey.percent_item_margin
  @@_percent_item_margin ||= PriceDetailComponentKey.new('percent_item_margin')
end

.rounding_percent_sales_margin ⇒ Object

An adjustment made to rounding as a result of a percent sales margin.



15191
15192
15193
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15191

def PriceDetailComponentKey.rounding_percent_sales_margin
  @@_rounding_percent_sales_margin ||= PriceDetailComponentKey.new('rounding_percent_sales_margin')
end

.vat_added_margin ⇒ Object

The VAT owed on the sum of the currency margin, percent item margin, and fixed item margin.



15150
15151
15152
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15150

def PriceDetailComponentKey.vat_added_margin
  @@_vat_added_margin ||= PriceDetailComponentKey.new('vat_added_margin')
end

.vat_deminimis ⇒ Object

An adjustment made if the item does not meet the VAT de minimis rule.



15176
15177
15178
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15176

def PriceDetailComponentKey.vat_deminimis
  @@_vat_deminimis ||= PriceDetailComponentKey.new('vat_deminimis')
end

.vat_duties_added_margin ⇒ Object

The VAT owed on the duty owed on the sum of the currency margin, percent item margin, and fixed item margin.



15166
15167
15168
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15166

def PriceDetailComponentKey.vat_duties_added_margin
  @@_vat_duties_added_margin ||= PriceDetailComponentKey.new('vat_duties_added_margin')
end

.vat_duties_item_price ⇒ Object

The VAT owed on the duty owed on the post-discount base item price.



15160
15161
15162
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15160

def PriceDetailComponentKey.vat_duties_item_price
  @@_vat_duties_item_price ||= PriceDetailComponentKey.new('vat_duties_item_price')
end

.vat_duties_rounding ⇒ Object

The VAT owed on the duty owed on any rounding applied to the total item price.



15171
15172
15173
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15171

def PriceDetailComponentKey.vat_duties_rounding
  @@_vat_duties_rounding ||= PriceDetailComponentKey.new('vat_duties_rounding')
end

.vat_duty_percent_sales_margin ⇒ Object

An adjustment made to VAT on duties (e.g. VAT on duties on item price) owed as a result of a percent sales margin.



15202
15203
15204
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15202

def PriceDetailComponentKey.vat_duty_percent_sales_margin
  @@_vat_duty_percent_sales_margin ||= PriceDetailComponentKey.new('vat_duty_percent_sales_margin')
end

.vat_item_price ⇒ Object

The VAT owed on the post-discount base item price.



15144
15145
15146
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15144

def PriceDetailComponentKey.vat_item_price
  @@_vat_item_price ||= PriceDetailComponentKey.new('vat_item_price')
end

.vat_percent_sales_margin ⇒ Object

An adjustment made to VAT owed as a result of a percent sales margin.



15196
15197
15198
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15196

def PriceDetailComponentKey.vat_percent_sales_margin
  @@_vat_percent_sales_margin ||= PriceDetailComponentKey.new('vat_percent_sales_margin')
end

.vat_rounding ⇒ Object

The VAT owed on any rounding applied to the total item price.



15155
15156
15157
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15155

def PriceDetailComponentKey.vat_rounding
  @@_vat_rounding ||= PriceDetailComponentKey.new('vat_rounding')
end

Instance Method Details

#to_hash ⇒ Object 



15211
15212
15213
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15211

def to_hash
  value
end