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.



18217
18218
18219
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18217

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



18215
18216
18217
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18215

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



18237
18238
18239
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18237

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



18222
18223
18224
18225
18226
18227
18228
18229
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18222

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



18242
18243
18244
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18242

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.



18268
18269
18270
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18268

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



18253
18254
18255
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18253

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



18232
18233
18234
18235
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18232

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.



18262
18263
18264
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18262

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

.online ⇒ Object

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



18247
18248
18249
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18247

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

Instance Method Details

#to_hash ⇒ Object 



18272
18273
18274
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18272

def to_hash
  value
end