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.



11430
11431
11432
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11430

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



11428
11429
11430
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11428

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



11450
11451
11452
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11450

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



11435
11436
11437
11438
11439
11440
11441
11442
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11435

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



11455
11456
11457
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11455

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.



11480
11481
11482
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11480

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



11466
11467
11468
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11466

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



11445
11446
11447
11448
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11445

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.



11474
11475
11476
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11474

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

.online ⇒ Object

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



11460
11461
11462
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11460

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

Instance Method Details

#to_hash ⇒ Object 



11484
11485
11486
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11484

def to_hash
  value
end