Class: Io::Flow::V0::Models::OrderPaymentType

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

Returns a new instance of OrderPaymentType.



13304
13305
13306
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13304

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



13302
13303
13304
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13302

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



13324
13325
13326
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13324

def OrderPaymentType.ALL
  @@all ||= [OrderPaymentType.card, OrderPaymentType.online, OrderPaymentType.credit, OrderPaymentType.installment_plan, OrderPaymentType.cash_on_delivery]
end

.apply(value) ⇒ Object

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



13309
13310
13311
13312
13313
13314
13315
13316
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13309

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

.card ⇒ Object

Represents a payment in the form of a credit or debit card



13329
13330
13331
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13329

def OrderPaymentType.card
  @@_card ||= OrderPaymentType.new('card')
end

.cash_on_delivery ⇒ Object

Request to pay the balance with cash on delivery. Offered only when the final mile carriers support cash on delivery.



13354
13355
13356
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13354

def OrderPaymentType.cash_on_delivery
  @@_cash_on_delivery ||= OrderPaymentType.new('cash_on_delivery')
end

.credit ⇒ Object

A payment in the form of a credit of some type (e.g. a store credit, gift card) applied to an order



13340
13341
13342
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13340

def OrderPaymentType.credit
  @@_credit ||= OrderPaymentType.new('credit')
end

.from_string(value) ⇒ Object

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



13319
13320
13321
13322
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13319

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

.installment_plan ⇒ Object

An installment plan payment represents that the user has elected an installment plan to pay for this order. For the purposes of the order, the balance will reflect fully paid for the total value of the installment plan, even though individual installments may be created in the future.



13348
13349
13350
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13348

def OrderPaymentType.installment_plan
  @@_installment_plan ||= OrderPaymentType.new('installment_plan')
end

.online ⇒ Object

Represents an online payment (e.g. paypal, alipay, etc)



13334
13335
13336
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13334

def OrderPaymentType.online
  @@_online ||= OrderPaymentType.new('online')
end

Instance Method Details

#to_hash ⇒ Object 



13358
13359
13360
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13358

def to_hash
  value
end