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.



12814
12815
12816
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12814

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



12812
12813
12814
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12812

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



12834
12835
12836
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12834

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



12819
12820
12821
12822
12823
12824
12825
12826
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12819

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



12839
12840
12841
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12839

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.



12864
12865
12866
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12864

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



12850
12851
12852
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12850

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



12829
12830
12831
12832
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12829

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.



12858
12859
12860
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12858

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

.online ⇒ Object

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



12844
12845
12846
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12844

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

Instance Method Details

#to_hash ⇒ Object 



12868
12869
12870
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12868

def to_hash
  value
end