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.



13945
13946
13947
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13945

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



13943
13944
13945
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13943

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



13965
13966
13967
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13965

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



13950
13951
13952
13953
13954
13955
13956
13957
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13950

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.



13970
13971
13972
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13970

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.



13981
13982
13983
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13981

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

.discount ⇒ Object

A discount applied to the base price of the item.



13975
13976
13977
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13975

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.



14004
14005
14006
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14004

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.



14014
14015
14016
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14014

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.



13998
13999
14000
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13998

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.



14009
14010
14011
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14009

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.



14082
14083
14084
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14082

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.



13993
13994
13995
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13993

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



13960
13961
13962
13963
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13960

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.



14056
14057
14058
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14056

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.



14061
14062
14063
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14061

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.



13987
13988
13989
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13987

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.



14066
14067
14068
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14066

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.



14025
14026
14027
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14025

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.



14051
14052
14053
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14051

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.



14041
14042
14043
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14041

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.



14035
14036
14037
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14035

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.



14046
14047
14048
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14046

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.



14077
14078
14079
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14077

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.



14019
14020
14021
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14019

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.



14071
14072
14073
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14071

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.



14030
14031
14032
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14030

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

Instance Method Details

#to_hash ⇒ Object 



14086
14087
14088
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14086

def to_hash
  value
end