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.



17857
17858
17859
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17857

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



17855
17856
17857
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17855

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



17877
17878
17879
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17877

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



17862
17863
17864
17865
17866
17867
17868
17869
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17862

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



17882
17883
17884
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17882

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.



17908
17909
17910
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17908

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



17893
17894
17895
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17893

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



17872
17873
17874
17875
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17872

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. Note this feature was deprecated in early 2020.



17902
17903
17904
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17902

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

.online ⇒ Object

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



17887
17888
17889
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17887

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

Instance Method Details

#to_hash ⇒ Object 



17912
17913
17914
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17912

def to_hash
  value
end