Class: Io::Flow::V0::Models::OrderPriceDetailComponentKey

Inherits:

Object

• Object
• Io::Flow::V0::Models::OrderPriceDetailComponentKey

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Instance Attribute Summary

• #value ⇒ Object readonly

  Returns the value of attribute value.

Class Method Summary

• .adjustment ⇒ Object

  A general purpose adjustment applied to the order.

• .ALL ⇒ Object
• .apply(value) ⇒ Object

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

• .duties_freight ⇒ Object

  The duty owed on the freight cost of the order.

• .duties_insurance ⇒ Object

  The duty owed on the insurance cost of the order.

• .duties_item_price ⇒ Object

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

• .duty_deminimis ⇒ Object

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

• .duty_subsidy ⇒ Object

  An offset to account for any duty subsidized by the organization.

• .from_string(value) ⇒ Object

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

• .insurance ⇒ Object

  The insurance cost for the order.

• .item_discount ⇒ Object

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

• .item_price ⇒ Object

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

• .order_discount ⇒ Object

  A discount applied to the entire order.

• .rounding ⇒ Object

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

• .shipping ⇒ Object

  The shipping cost for the order.

• .subtotal_duty_percent_sales_margin ⇒ Object

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

• .subtotal_percent_sales_margin ⇒ Object

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

• .subtotal_vat_percent_sales_margin ⇒ Object

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

• .vat_deminimis ⇒ Object

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

• .vat_duties_freight ⇒ Object

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

• .vat_duties_insurance ⇒ Object

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

• .vat_duties_item_price ⇒ Object

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

• .vat_freight ⇒ Object

  The VAT owed on the freight cost of the order.

• .vat_insurance ⇒ Object

  The VAT owed on the insurance cost of the order.

• .vat_item_price ⇒ Object

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

• .vat_subsidy ⇒ Object

  An offset to account for any VAT subsidized by the organization.

Instance Method Summary

• #initialize(value) ⇒ OrderPriceDetailComponentKey constructor

  A new instance of OrderPriceDetailComponentKey.

• #to_hash ⇒ Object

Constructor Details

#initialize(value) ⇒ OrderPriceDetailComponentKey

Returns a new instance of OrderPriceDetailComponentKey.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13368

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13366

def value
  @value
end

Class Method Details

.adjustment ⇒ Object

A general purpose adjustment applied to the order.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13393

def OrderPriceDetailComponentKey.adjustment
  @@_adjustment ||= OrderPriceDetailComponentKey.new('adjustment')
end

.ALL ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13388

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.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]
end

.apply(value) ⇒ Object

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 13373

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 ⇒ Object

The duty owed on the freight cost of the order.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13414

def OrderPriceDetailComponentKey.duties_freight
  @@_duties_freight ||= OrderPriceDetailComponentKey.new('duties_freight')
end

.duties_insurance ⇒ Object

The duty owed on the insurance cost of the order.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13419

def OrderPriceDetailComponentKey.duties_insurance
  @@_duties_insurance ||= OrderPriceDetailComponentKey.new('duties_insurance')
end

.duties_item_price ⇒ Object

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 13409

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

.duty_deminimis ⇒ Object

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

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13403

def OrderPriceDetailComponentKey.duty_deminimis
  @@_duty_deminimis ||= OrderPriceDetailComponentKey.new('duty_deminimis')
end

.duty_subsidy ⇒ Object

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 13514

def OrderPriceDetailComponentKey.duty_subsidy
  @@_duty_subsidy ||= OrderPriceDetailComponentKey.new('duty_subsidy')
end

.from_string(value) ⇒ Object

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

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13383

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

.insurance ⇒ Object

The insurance cost for the order.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13472

def OrderPriceDetailComponentKey.insurance
  @@_insurance ||= OrderPriceDetailComponentKey.new('insurance')
end

.item_discount ⇒ Object

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

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13462

def OrderPriceDetailComponentKey.item_discount
  @@_item_discount ||= OrderPriceDetailComponentKey.new('item_discount')
end

.item_price ⇒ Object

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 13457

def OrderPriceDetailComponentKey.item_price
  @@_item_price ||= OrderPriceDetailComponentKey.new('item_price')
end

.order_discount ⇒ Object

A discount applied to the entire order.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13482

def OrderPriceDetailComponentKey.order_discount
  @@_order_discount ||= OrderPriceDetailComponentKey.new('order_discount')
end

.rounding ⇒ Object

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

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13467

def OrderPriceDetailComponentKey.rounding
  @@_rounding ||= OrderPriceDetailComponentKey.new('rounding')
end

.shipping ⇒ Object

The shipping cost for the order.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13477

def OrderPriceDetailComponentKey.shipping
  @@_shipping ||= OrderPriceDetailComponentKey.new('shipping')
end

.subtotal_duty_percent_sales_margin ⇒ Object

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

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13498

def OrderPriceDetailComponentKey.subtotal_duty_percent_sales_margin
  @@_subtotal_duty_percent_sales_margin ||= OrderPriceDetailComponentKey.new('subtotal_duty_percent_sales_margin')
end

.subtotal_percent_sales_margin ⇒ Object

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 13488

def OrderPriceDetailComponentKey.subtotal_percent_sales_margin
  @@_subtotal_percent_sales_margin ||= OrderPriceDetailComponentKey.new('subtotal_percent_sales_margin')
end

.subtotal_vat_percent_sales_margin ⇒ Object

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

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13493

def OrderPriceDetailComponentKey.subtotal_vat_percent_sales_margin
  @@_subtotal_vat_percent_sales_margin ||= OrderPriceDetailComponentKey.new('subtotal_vat_percent_sales_margin')
end

.vat_deminimis ⇒ Object

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

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13398

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

.vat_duties_freight ⇒ Object

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

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13446

def OrderPriceDetailComponentKey.vat_duties_freight
  @@_vat_duties_freight ||= OrderPriceDetailComponentKey.new('vat_duties_freight')
end

.vat_duties_insurance ⇒ Object

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

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13451

def OrderPriceDetailComponentKey.vat_duties_insurance
  @@_vat_duties_insurance ||= OrderPriceDetailComponentKey.new('vat_duties_insurance')
end

.vat_duties_item_price ⇒ Object

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 13441

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

.vat_freight ⇒ Object

The VAT owed on the freight cost of the order.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13430

def OrderPriceDetailComponentKey.vat_freight
  @@_vat_freight ||= OrderPriceDetailComponentKey.new('vat_freight')
end

.vat_insurance ⇒ Object

The VAT owed on the insurance cost of the order.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13435

def OrderPriceDetailComponentKey.vat_insurance
  @@_vat_insurance ||= OrderPriceDetailComponentKey.new('vat_insurance')
end

.vat_item_price ⇒ Object

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 13425

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

.vat_subsidy ⇒ Object

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 13506

def OrderPriceDetailComponentKey.vat_subsidy
  @@_vat_subsidy ||= OrderPriceDetailComponentKey.new('vat_subsidy')
end

Instance Method Details

#to_hash ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13518

def to_hash
  value
end