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.



10992
10993
10994
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10992

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



10990
10991
10992
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10990

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



11012
11013
11014
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11012

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



10997
10998
10999
11000
11001
11002
11003
11004
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10997

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



11017
11018
11019
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11017

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.



11042
11043
11044
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11042

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



11028
11029
11030
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11028

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



11007
11008
11009
11010
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11007

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.



11036
11037
11038
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11036

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

.online ⇒ Object

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



11022
11023
11024
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11022

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

Instance Method Details

#to_hash ⇒ Object 



11046
11047
11048
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11046

def to_hash
  value
end