Class: Io::Flow::V0::Models::OrderPriceDetailKey

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

Returns a new instance of OrderPriceDetailKey.



17343
17344
17345
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17343

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



17341
17342
17343
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17341

def value
  @value
end

Class Method Details

.adjustmentObject

The details of any adjustments made to the order.



17368
17369
17370
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17368

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

.ALLObject



17363
17364
17365
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17363

def OrderPriceDetailKey.ALL
  @@all ||= [OrderPriceDetailKey.adjustment, OrderPriceDetailKey.subtotal, OrderPriceDetailKey.vat, OrderPriceDetailKey.duty, OrderPriceDetailKey.shipping, OrderPriceDetailKey.insurance, OrderPriceDetailKey.discount, OrderPriceDetailKey.surcharges]
end

.apply(value) ⇒ Object

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



17348
17349
17350
17351
17352
17353
17354
17355
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17348

def OrderPriceDetailKey.apply(value)
  if value.instance_of?(OrderPriceDetailKey)
    value
  else
    HttpClient::Preconditions.assert_class_or_nil('value', value, String)
    value.nil? ? nil : (from_string(value) || OrderPriceDetailKey.new(value))
  end
end

.discountObject

The details of any discount applied to the order.



17399
17400
17401
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17399

def OrderPriceDetailKey.discount
  @@_discount ||= OrderPriceDetailKey.new('discount')
end

.dutyObject

The details of any duties owed on the order.



17384
17385
17386
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17384

def OrderPriceDetailKey.duty
  @@_duty ||= OrderPriceDetailKey.new('duty')
end

.from_string(value) ⇒ Object

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



17358
17359
17360
17361
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17358

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

.insuranceObject

The details of insurance costs for the order.



17394
17395
17396
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17394

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

.shippingObject

The details of shipping costs for the order.



17389
17390
17391
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17389

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

.subtotalObject

The details of the subtotal for the order, including item prices, margins, and rounding.



17374
17375
17376
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17374

def OrderPriceDetailKey.subtotal
  @@_subtotal ||= OrderPriceDetailKey.new('subtotal')
end

.surchargesObject

Additional fees and levies applied to the order



17404
17405
17406
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17404

def OrderPriceDetailKey.surcharges
  @@_surcharges ||= OrderPriceDetailKey.new('surcharges')
end

.vatObject

The details of any VAT owed on the order.



17379
17380
17381
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17379

def OrderPriceDetailKey.vat
  @@_vat ||= OrderPriceDetailKey.new('vat')
end

Instance Method Details

#to_hashObject



17408
17409
17410
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17408

def to_hash
  value
end