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.



9120
9121
9122
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9120

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



9118
9119
9120
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9118

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



9140
9141
9142
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9140

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



9125
9126
9127
9128
9129
9130
9131
9132
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9125

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.



9145
9146
9147
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9145

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.



9156
9157
9158
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9156

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

.discount ⇒ Object

A discount applied to the base price of the item.



9150
9151
9152
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9150

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.



9179
9180
9181
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9179

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.



9189
9190
9191
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9189

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.



9173
9174
9175
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9173

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.



9184
9185
9186
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9184

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.



9257
9258
9259
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9257

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.



9168
9169
9170
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9168

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



9135
9136
9137
9138
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9135

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.



9231
9232
9233
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9231

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.



9236
9237
9238
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9236

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.



9162
9163
9164
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9162

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.



9241
9242
9243
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9241

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.



9200
9201
9202
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9200

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.



9226
9227
9228
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9226

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.



9216
9217
9218
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9216

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.



9210
9211
9212
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9210

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.



9221
9222
9223
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9221

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.



9252
9253
9254
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9252

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.



9194
9195
9196
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9194

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.



9246
9247
9248
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9246

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.



9205
9206
9207
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9205

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

Instance Method Details

#to_hash ⇒ Object 



9261
9262
9263
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 9261

def to_hash
  value
end