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

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) ⇒ OrderPriceDetailComponentKey

Returns a new instance of OrderPriceDetailComponentKey.



8450
8451
8452
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8450

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



8448
8449
8450
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8448

def value
  @value
end

Class Method Details

.adjustment ⇒ Object

A general purpose adjustment applied to the order.



8475
8476
8477
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8475

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

.ALL ⇒ Object 



8470
8471
8472
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8470

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



8455
8456
8457
8458
8459
8460
8461
8462
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8455

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.



8496
8497
8498
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8496

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

.duties_insurance ⇒ Object

The duty owed on the insurance cost of the order.



8501
8502
8503
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8501

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.



8491
8492
8493
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8491

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.



8485
8486
8487
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8485

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.



8591
8592
8593
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8591

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



8465
8466
8467
8468
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8465

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.



8549
8550
8551
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8549

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

.item_price ⇒ Object

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



8539
8540
8541
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8539

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

.order_discount ⇒ Object

A discount applied to the entire order.



8559
8560
8561
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8559

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

.rounding ⇒ Object

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



8544
8545
8546
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8544

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

.shipping ⇒ Object

The shipping cost for the order.



8554
8555
8556
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8554

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.



8575
8576
8577
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8575

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.



8565
8566
8567
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8565

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.



8570
8571
8572
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8570

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.



8480
8481
8482
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8480

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.



8528
8529
8530
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8528

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.



8533
8534
8535
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8533

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.



8523
8524
8525
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8523

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.



8512
8513
8514
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8512

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

.vat_insurance ⇒ Object

The VAT owed on the insurance cost of the order.



8517
8518
8519
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8517

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.



8507
8508
8509
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8507

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.



8583
8584
8585
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8583

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

Instance Method Details

#to_hash ⇒ Object 



8595
8596
8597
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8595

def to_hash
  value
end