class Io::Flow::V0::Models::OrderPriceDetailComponentKey

Attributes

value[R]

Public Class Methods

ALL() click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 23211
def OrderPriceDetailComponentKey.ALL
  @@all ||= [OrderPriceDetailComponentKey.adjustment, OrderPriceDetailComponentKey.vat_deminimis, OrderPriceDetailComponentKey.duty_deminimis, OrderPriceDetailComponentKey.duties_item_price, OrderPriceDetailComponentKey.duties_freight, OrderPriceDetailComponentKey.duties_insurance, OrderPriceDetailComponentKey.vat_item_price, OrderPriceDetailComponentKey.vat_freight, OrderPriceDetailComponentKey.vat_insurance, OrderPriceDetailComponentKey.vat_duties_item_price, OrderPriceDetailComponentKey.vat_duties_freight, OrderPriceDetailComponentKey.vat_duties_insurance, OrderPriceDetailComponentKey.item_price, OrderPriceDetailComponentKey.item_discount, OrderPriceDetailComponentKey.rounding, OrderPriceDetailComponentKey.insurance, OrderPriceDetailComponentKey.shipping, OrderPriceDetailComponentKey.shipping_discount, OrderPriceDetailComponentKey.order_discount, OrderPriceDetailComponentKey.subtotal_percent_sales_margin, OrderPriceDetailComponentKey.subtotal_vat_percent_sales_margin, OrderPriceDetailComponentKey.subtotal_duty_percent_sales_margin, OrderPriceDetailComponentKey.vat_subsidy, OrderPriceDetailComponentKey.duty_subsidy, OrderPriceDetailComponentKey.remote_area_surcharge, OrderPriceDetailComponentKey.fuel_surcharge, OrderPriceDetailComponentKey.emergency_situation_surcharge, OrderPriceDetailComponentKey.peak_surcharge, OrderPriceDetailComponentKey.duties_taxes_paid_surcharge]
end
adjustment() click to toggle source

A general purpose adjustment applied to the order.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23216
def OrderPriceDetailComponentKey.adjustment
  @@_adjustment ||= OrderPriceDetailComponentKey.new('adjustment')
end
apply(value) click to toggle source

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

# File lib/flow_commerce/flow_api_v0_client.rb, line 23196
def OrderPriceDetailComponentKey.apply(value)
  if value.instance_of?(OrderPriceDetailComponentKey)
    value
  else
    HttpClient::Preconditions.assert_class_or_nil('value', value, String)
    value.nil? ? nil : (from_string(value) || OrderPriceDetailComponentKey.new(value))
  end
end
duties_freight() click to toggle source

The duty owed on the freight cost of the order.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23237
def OrderPriceDetailComponentKey.duties_freight
  @@_duties_freight ||= OrderPriceDetailComponentKey.new('duties_freight')
end
duties_insurance() click to toggle source

The duty owed on the insurance cost of the order.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23242
def OrderPriceDetailComponentKey.duties_insurance
  @@_duties_insurance ||= OrderPriceDetailComponentKey.new('duties_insurance')
end
duties_item_price() click to toggle source

The duty owed on the price of the order’s items, including any added margins and rounding.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23232
def OrderPriceDetailComponentKey.duties_item_price
  @@_duties_item_price ||= OrderPriceDetailComponentKey.new('duties_item_price')
end
duties_taxes_paid_surcharge() click to toggle source

Surcharge applied per shipment for all shipment that are sent DDP

# File lib/flow_commerce/flow_api_v0_client.rb, line 23369
def OrderPriceDetailComponentKey.duties_taxes_paid_surcharge
  @@_duties_taxes_paid_surcharge ||= OrderPriceDetailComponentKey.new('duties_taxes_paid_surcharge')
end
duty_deminimis() click to toggle source

An adjustment based on whether the duty de minimis applies to the order.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23226
def OrderPriceDetailComponentKey.duty_deminimis
  @@_duty_deminimis ||= OrderPriceDetailComponentKey.new('duty_deminimis')
end
duty_subsidy() click to toggle source

An offset to account for any duty subsidized by the organization. For example, if duty is included in an item price and changes at the order level (due to passing de minimis threshold, or the destination having a more specific duty rate), the difference will be represented here.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23342
def OrderPriceDetailComponentKey.duty_subsidy
  @@_duty_subsidy ||= OrderPriceDetailComponentKey.new('duty_subsidy')
end
emergency_situation_surcharge() click to toggle source

Surcharge applied to a shipment during emergency circumstances, such as covid19.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23359
def OrderPriceDetailComponentKey.emergency_situation_surcharge
  @@_emergency_situation_surcharge ||= OrderPriceDetailComponentKey.new('emergency_situation_surcharge')
end
from_string(value) click to toggle source

Returns the instance of OrderPriceDetailComponentKey for this value, or nil if not found

# File lib/flow_commerce/flow_api_v0_client.rb, line 23206
def OrderPriceDetailComponentKey.from_string(value)
  HttpClient::Preconditions.assert_class('value', value, String)
  OrderPriceDetailComponentKey.ALL.find { |v| v.value == value }
end
fuel_surcharge() click to toggle source

Surcharge applied to a shipment for fuel consumption by the carrier.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23353
def OrderPriceDetailComponentKey.fuel_surcharge
  @@_fuel_surcharge ||= OrderPriceDetailComponentKey.new('fuel_surcharge')
end
insurance() click to toggle source

The insurance cost for the order.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23295
def OrderPriceDetailComponentKey.insurance
  @@_insurance ||= OrderPriceDetailComponentKey.new('insurance')
end
item_discount() click to toggle source

The sum of all discounts applied to the order’s items.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23285
def OrderPriceDetailComponentKey.item_discount
  @@_item_discount ||= OrderPriceDetailComponentKey.new('item_discount')
end
item_price() click to toggle source

The sum of the price of the order’s items with their currency margins, percent margins, and fixed margins included.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23280
def OrderPriceDetailComponentKey.item_price
  @@_item_price ||= OrderPriceDetailComponentKey.new('item_price')
end
new(value) click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 23191
def initialize(value)
  @value = HttpClient::Preconditions.assert_class('value', value, String)
end
order_discount() click to toggle source

A discount applied to the entire order.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23310
def OrderPriceDetailComponentKey.order_discount
  @@_order_discount ||= OrderPriceDetailComponentKey.new('order_discount')
end
peak_surcharge() click to toggle source

Surcharge applied per package during peak times.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23364
def OrderPriceDetailComponentKey.peak_surcharge
  @@_peak_surcharge ||= OrderPriceDetailComponentKey.new('peak_surcharge')
end
remote_area_surcharge() click to toggle source

Surcharge applied to a shipment for delivery to a remote area determined by the carrier.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23348
def OrderPriceDetailComponentKey.remote_area_surcharge
  @@_remote_area_surcharge ||= OrderPriceDetailComponentKey.new('remote_area_surcharge')
end
rounding() click to toggle source

The sum of any rounding applied to the order’s items.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23290
def OrderPriceDetailComponentKey.rounding
  @@_rounding ||= OrderPriceDetailComponentKey.new('rounding')
end
shipping() click to toggle source

The shipping cost for the order.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23300
def OrderPriceDetailComponentKey.shipping
  @@_shipping ||= OrderPriceDetailComponentKey.new('shipping')
end
shipping_discount() click to toggle source

A shipping discount applied to the entire order.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23305
def OrderPriceDetailComponentKey.shipping_discount
  @@_shipping_discount ||= OrderPriceDetailComponentKey.new('shipping_discount')
end
subtotal_duty_percent_sales_margin() click to toggle source

The sum of adjustments to duty owed made due to percentage sales margins.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23326
def OrderPriceDetailComponentKey.subtotal_duty_percent_sales_margin
  @@_subtotal_duty_percent_sales_margin ||= OrderPriceDetailComponentKey.new('subtotal_duty_percent_sales_margin')
end
subtotal_percent_sales_margin() click to toggle source

The sum of adjustments to item price, margin and rounding made due to percentage sales margins.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23316
def OrderPriceDetailComponentKey.subtotal_percent_sales_margin
  @@_subtotal_percent_sales_margin ||= OrderPriceDetailComponentKey.new('subtotal_percent_sales_margin')
end
subtotal_vat_percent_sales_margin() click to toggle source

The sum of adjustments to VAT owed made due to percentage sales margins.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23321
def OrderPriceDetailComponentKey.subtotal_vat_percent_sales_margin
  @@_subtotal_vat_percent_sales_margin ||= OrderPriceDetailComponentKey.new('subtotal_vat_percent_sales_margin')
end
vat_deminimis() click to toggle source

An adjustment based on whether the VAT de minimis applies to the order.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23221
def OrderPriceDetailComponentKey.vat_deminimis
  @@_vat_deminimis ||= OrderPriceDetailComponentKey.new('vat_deminimis')
end
vat_duties_freight() click to toggle source

The VAT owed on the duties on the freight cost of the order.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23269
def OrderPriceDetailComponentKey.vat_duties_freight
  @@_vat_duties_freight ||= OrderPriceDetailComponentKey.new('vat_duties_freight')
end
vat_duties_insurance() click to toggle source

The VAT owed on the duties on the insurance cost of the order.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23274
def OrderPriceDetailComponentKey.vat_duties_insurance
  @@_vat_duties_insurance ||= OrderPriceDetailComponentKey.new('vat_duties_insurance')
end
vat_duties_item_price() click to toggle source

The VAT owed on the duties on the price of the order’s items, including any added margins and rounding.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23264
def OrderPriceDetailComponentKey.vat_duties_item_price
  @@_vat_duties_item_price ||= OrderPriceDetailComponentKey.new('vat_duties_item_price')
end
vat_freight() click to toggle source

The VAT owed on the freight cost of the order.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23253
def OrderPriceDetailComponentKey.vat_freight
  @@_vat_freight ||= OrderPriceDetailComponentKey.new('vat_freight')
end
vat_insurance() click to toggle source

The VAT owed on the insurance cost of the order.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23258
def OrderPriceDetailComponentKey.vat_insurance
  @@_vat_insurance ||= OrderPriceDetailComponentKey.new('vat_insurance')
end
vat_item_price() click to toggle source

The VAT owed on the price of the order’s items, including any added margins and rounding.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23248
def OrderPriceDetailComponentKey.vat_item_price
  @@_vat_item_price ||= OrderPriceDetailComponentKey.new('vat_item_price')
end
vat_subsidy() click to toggle source

An offset to account for any VAT subsidized by the organization. For example, if VAT is included in an item price and changes at the order level (due to passing de minimis threshold, or the destination having a more specific VAT rate), the difference will be represented here.

# File lib/flow_commerce/flow_api_v0_client.rb, line 23334
def OrderPriceDetailComponentKey.vat_subsidy
  @@_vat_subsidy ||= OrderPriceDetailComponentKey.new('vat_subsidy')
end

Public Instance Methods

to_hash() click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 23373
def to_hash
  value
end