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.



18198
18199
18200
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18198

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



18196
18197
18198
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18196

def value
  @value
end

Class Method Details

.adjustmentObject

The details of any adjustments made to the order.



18223
18224
18225
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18223

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

.ALLObject



18218
18219
18220
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18218

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



18203
18204
18205
18206
18207
18208
18209
18210
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18203

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.



18254
18255
18256
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18254

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

.dutyObject

The details of any duties owed on the order.



18239
18240
18241
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18239

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



18213
18214
18215
18216
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18213

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.



18249
18250
18251
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18249

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

.shippingObject

The details of shipping costs for the order.



18244
18245
18246
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18244

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

.subtotalObject

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



18229
18230
18231
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18229

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

.surchargesObject

Additional fees and levies applied to the order



18259
18260
18261
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18259

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

.vatObject

The details of any VAT owed on the order.



18234
18235
18236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18234

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

Instance Method Details

#to_hashObject



18263
18264
18265
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18263

def to_hash
  value
end