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.



17956
17957
17958
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17956

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



17954
17955
17956
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17954

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



17976
17977
17978
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17976

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



17961
17962
17963
17964
17965
17966
17967
17968
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17961

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



17981
17982
17983
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17981

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.



18007
18008
18009
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18007

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



17992
17993
17994
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17992

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



17971
17972
17973
17974
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17971

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.



18001
18002
18003
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18001

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

.online ⇒ Object

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



17986
17987
17988
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17986

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

Instance Method Details

#to_hash ⇒ Object 



18011
18012
18013
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18011

def to_hash
  value
end