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.



8891
8892
8893
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8891

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



8889
8890
8891
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8889

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



8911
8912
8913
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8911

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



8896
8897
8898
8899
8900
8901
8902
8903
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8896

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.



8916
8917
8918
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8916

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.



8927
8928
8929
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8927

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

.discount ⇒ Object

A discount applied to the base price of the item.



8921
8922
8923
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8921

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.



8950
8951
8952
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8950

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.



8960
8961
8962
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8960

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.



8944
8945
8946
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8944

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.



8955
8956
8957
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8955

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.



9028
9029
9030
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9028

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.



8939
8940
8941
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8939

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



8906
8907
8908
8909
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8906

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.



9002
9003
9004
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9002

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.



9007
9008
9009
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9007

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.



8933
8934
8935
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8933

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.



9012
9013
9014
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9012

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.



8971
8972
8973
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8971

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.



8997
8998
8999
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8997

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.



8987
8988
8989
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8987

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.



8981
8982
8983
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8981

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.



8992
8993
8994
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8992

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.



9023
9024
9025
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9023

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.



8965
8966
8967
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8965

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.



9017
9018
9019
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9017

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.



8976
8977
8978
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8976

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

Instance Method Details

#to_hash ⇒ Object 



9032
9033
9034
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9032

def to_hash
  value
end