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.



17179
17180
17181
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17179

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



17177
17178
17179
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17177

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



17199
17200
17201
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17199

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



17184
17185
17186
17187
17188
17189
17190
17191
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17184

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



17204
17205
17206
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17204

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.



17230
17231
17232
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17230

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



17215
17216
17217
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17215

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



17194
17195
17196
17197
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17194

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.



17224
17225
17226
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17224

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

.online ⇒ Object

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



17209
17210
17211
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17209

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

Instance Method Details

#to_hash ⇒ Object 



17234
17235
17236
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 17234

def to_hash
  value
end