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.



25206
25207
25208
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25206

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



25204
25205
25206
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25204

def value
  @value
end

Class Method Details

.apply(value) ⇒ Object

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



25211
25212
25213
25214
25215
25216
25217
25218
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25211

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_priceObject

The base price of the item.



25231
25232
25233
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25231

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

.currency_marginObject

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



25242
25243
25244
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25242

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

.discountObject

A discount applied to the base price of the item.



25236
25237
25238
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25236

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

.duties_added_marginObject

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



25265
25266
25267
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25265

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

.duties_deminimisObject

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



25275
25276
25277
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25275

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

.duties_item_priceObject

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



25259
25260
25261
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25259

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

.duties_roundingObject

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



25270
25271
25272
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25270

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

.duty_percent_sales_marginObject

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



25343
25344
25345
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25343

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

.fixed_item_marginObject

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



25254
25255
25256
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25254

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



25221
25222
25223
25224
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25221

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

.item_price_percent_sales_marginObject

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



25317
25318
25319
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25317

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

.margins_percent_sales_marginObject

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



25322
25323
25324
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25322

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

.percent_item_marginObject

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



25248
25249
25250
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25248

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

.rounding_percent_sales_marginObject

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



25327
25328
25329
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25327

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

.vat_added_marginObject

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



25286
25287
25288
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25286

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

.vat_deminimisObject

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



25312
25313
25314
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25312

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

.vat_duties_added_marginObject

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



25302
25303
25304
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25302

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

.vat_duties_item_priceObject

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



25296
25297
25298
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25296

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

.vat_duties_roundingObject

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



25307
25308
25309
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25307

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

.vat_duty_percent_sales_marginObject

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



25338
25339
25340
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25338

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

.vat_item_priceObject

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



25280
25281
25282
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25280

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

.vat_percent_sales_marginObject

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



25332
25333
25334
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25332

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

.vat_roundingObject

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



25291
25292
25293
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25291

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

Instance Method Details

#to_hashObject



25347
25348
25349
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25347

def to_hash
  value
end