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.



14825
14826
14827
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14825

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



14823
14824
14825
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14823

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



14845
14846
14847
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14845

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



14830
14831
14832
14833
14834
14835
14836
14837
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14830

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



14850
14851
14852
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14850

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.



14875
14876
14877
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14875

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



14861
14862
14863
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14861

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



14840
14841
14842
14843
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14840

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.



14869
14870
14871
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14869

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

.online ⇒ Object

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



14855
14856
14857
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14855

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

Instance Method Details

#to_hash ⇒ Object 



14879
14880
14881
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 14879

def to_hash
  value
end