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.



21390
21391
21392
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21390

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



21388
21389
21390
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21388

def value
  @value
end

Class Method Details

.adjustment ⇒ Object

A general purpose adjustment applied to the order.



21415
21416
21417
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21415

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

.ALL ⇒ Object 



21410
21411
21412
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21410

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

.apply(value) ⇒ Object

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



21395
21396
21397
21398
21399
21400
21401
21402
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21395

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.



21436
21437
21438
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21436

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

.duties_insurance ⇒ Object

The duty owed on the insurance cost of the order.



21441
21442
21443
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21441

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

.duties_item_price ⇒ Object

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



21431
21432
21433
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21431

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

.duties_taxes_paid_surcharge ⇒ Object

Surcharge applied per shipment for all shipment that are sent DDP



21568
21569
21570
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21568

def OrderPriceDetailComponentKey.duties_taxes_paid_surcharge
  @@_duties_taxes_paid_surcharge ||= OrderPriceDetailComponentKey.new('duties_taxes_paid_surcharge')
end

.duty_deminimis ⇒ Object

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



21425
21426
21427
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21425

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.



21541
21542
21543
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21541

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

.emergency_situation_surcharge ⇒ Object

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



21558
21559
21560
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21558

def OrderPriceDetailComponentKey.emergency_situation_surcharge
  @@_emergency_situation_surcharge ||= OrderPriceDetailComponentKey.new('emergency_situation_surcharge')
end

.from_string(value) ⇒ Object

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



21405
21406
21407
21408
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21405

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

.fuel_surcharge ⇒ Object

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



21552
21553
21554
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21552

def OrderPriceDetailComponentKey.fuel_surcharge
  @@_fuel_surcharge ||= OrderPriceDetailComponentKey.new('fuel_surcharge')
end

.insurance ⇒ Object

The insurance cost for the order.



21494
21495
21496
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21494

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

.item_discount ⇒ Object

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



21484
21485
21486
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21484

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.



21479
21480
21481
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21479

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

.order_discount ⇒ Object

A discount applied to the entire order.



21509
21510
21511
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21509

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

.peak_surcharge ⇒ Object

Surcharge applied per package during peak times.



21563
21564
21565
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21563

def OrderPriceDetailComponentKey.peak_surcharge
  @@_peak_surcharge ||= OrderPriceDetailComponentKey.new('peak_surcharge')
end

.remote_area_surcharge ⇒ Object

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



21547
21548
21549
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21547

def OrderPriceDetailComponentKey.remote_area_surcharge
  @@_remote_area_surcharge ||= OrderPriceDetailComponentKey.new('remote_area_surcharge')
end

.rounding ⇒ Object

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



21489
21490
21491
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21489

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

.shipping ⇒ Object

The shipping cost for the order.



21499
21500
21501
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21499

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

.shipping_discount ⇒ Object

A shipping discount applied to the entire order.



21504
21505
21506
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21504

def OrderPriceDetailComponentKey.shipping_discount
  @@_shipping_discount ||= OrderPriceDetailComponentKey.new('shipping_discount')
end

.subtotal_duty_percent_sales_margin ⇒ Object

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



21525
21526
21527
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21525

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.



21515
21516
21517
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21515

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.



21520
21521
21522
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21520

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.



21420
21421
21422
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21420

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.



21468
21469
21470
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21468

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.



21473
21474
21475
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21473

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.



21463
21464
21465
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21463

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.



21452
21453
21454
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21452

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

.vat_insurance ⇒ Object

The VAT owed on the insurance cost of the order.



21457
21458
21459
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21457

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.



21447
21448
21449
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21447

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.



21533
21534
21535
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21533

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

Instance Method Details

#to_hash ⇒ Object 



21572
21573
21574
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21572

def to_hash
  value
end