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 



17947
17948
17949
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17947

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



17945
17946
17947
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17945

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



17967
17968
17969
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17967

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



17952
17953
17954
17955
17956
17957
17958
17959
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17952

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.



17972
17973
17974
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17972

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.



17983
17984
17985
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17983

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

.discount ⇒ Object

A discount applied to the base price of the item.



17977
17978
17979
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17977

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.



18006
18007
18008
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18006

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.



18016
18017
18018
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18016

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.



18000
18001
18002
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18000

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.



18011
18012
18013
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18011

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.



18084
18085
18086
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18084

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.



17995
17996
17997
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17995

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



17962
17963
17964
17965
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17962

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.



18058
18059
18060
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18058

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.



18063
18064
18065
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18063

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.



17989
17990
17991
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17989

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.



18068
18069
18070
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18068

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.



18027
18028
18029
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18027

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.



18053
18054
18055
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18053

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.



18043
18044
18045
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18043

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.



18037
18038
18039
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18037

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.



18048
18049
18050
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18048

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.



18079
18080
18081
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18079

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.



18021
18022
18023
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18021

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.



18073
18074
18075
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18073

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.



18032
18033
18034
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18032

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

Instance Method Details

#to_hash ⇒ Object 



18088
18089
18090
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18088

def to_hash
  value
end