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.



18282
18283
18284
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18282

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



18280
18281
18282
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18280

def value
  @value
end

Class Method Details

.adjustment ⇒ Object

A general purpose adjustment applied to the order.



18307
18308
18309
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18307

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

.ALL ⇒ Object 



18302
18303
18304
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18302

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, OrderPriceDetailComponentKey.remote_area_surcharge, OrderPriceDetailComponentKey.fuel_surcharge, OrderPriceDetailComponentKey.emergency_situation_surcharge]
end

.apply(value) ⇒ Object

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



18287
18288
18289
18290
18291
18292
18293
18294
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18287

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.



18328
18329
18330
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18328

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

.duties_insurance ⇒ Object

The duty owed on the insurance cost of the order.



18333
18334
18335
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18333

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.



18323
18324
18325
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18323

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.



18317
18318
18319
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18317

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.



18428
18429
18430
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18428

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.



18445
18446
18447
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18445

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



18297
18298
18299
18300
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18297

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.



18439
18440
18441
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18439

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

.insurance ⇒ Object

The insurance cost for the order.



18386
18387
18388
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18386

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

.item_discount ⇒ Object

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



18376
18377
18378
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18376

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.



18371
18372
18373
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18371

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

.order_discount ⇒ Object

A discount applied to the entire order.



18396
18397
18398
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18396

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

.remote_area_surcharge ⇒ Object

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



18434
18435
18436
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18434

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.



18381
18382
18383
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18381

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

.shipping ⇒ Object

The shipping cost for the order.



18391
18392
18393
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18391

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.



18412
18413
18414
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18412

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.



18402
18403
18404
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18402

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.



18407
18408
18409
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18407

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.



18312
18313
18314
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18312

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.



18360
18361
18362
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18360

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.



18365
18366
18367
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18365

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.



18355
18356
18357
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18355

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.



18344
18345
18346
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18344

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

.vat_insurance ⇒ Object

The VAT owed on the insurance cost of the order.



18349
18350
18351
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18349

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.



18339
18340
18341
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18339

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.



18420
18421
18422
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18420

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

Instance Method Details

#to_hash ⇒ Object 



18449
18450
18451
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18449

def to_hash
  value
end