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.



10845
10846
10847
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10845

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



10843
10844
10845
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10843

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



10865
10866
10867
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10865

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



10850
10851
10852
10853
10854
10855
10856
10857
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10850

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



10870
10871
10872
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10870

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.



10895
10896
10897
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10895

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



10881
10882
10883
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10881

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



10860
10861
10862
10863
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10860

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.



10889
10890
10891
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10889

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

.online ⇒ Object

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



10875
10876
10877
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10875

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

Instance Method Details

#to_hash ⇒ Object 



10899
10900
10901
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10899

def to_hash
  value
end