Class: Io::Flow::V0::Models::OrderPaymentType
- Inherits:
-
Object
- Object
- Io::Flow::V0::Models::OrderPaymentType
- Defined in:
- lib/flow_commerce/flow_api_v0_client.rb
Instance Attribute Summary collapse
-
#value ⇒ Object
readonly
Returns the value of attribute value.
Class Method Summary collapse
- .ALL ⇒ Object
-
.apply(value) ⇒ Object
Returns the instance of OrderPaymentType for this value, creating a new instance for an unknown value.
-
.card ⇒ Object
Represents a payment in the form of a credit or debit card.
-
.cash_on_delivery ⇒ Object
Request to pay the balance with cash on delivery.
-
.credit ⇒ Object
A payment in the form of a credit of some type (e.g. a store credit, gift card) applied to an order.
-
.from_string(value) ⇒ Object
Returns the instance of OrderPaymentType for this value, or nil if not found.
-
.installment_plan ⇒ Object
An installment plan payment represents that the user has elected an installment plan to pay for this order.
-
.online ⇒ Object
Represents an online payment (e.g. paypal, alipay, etc).
-
.subsidized ⇒ Object
Subsidized indicates that this payment is being subsidized by the organization - and Flow’s billing system will directly invoice the client for this payment.
Instance Method Summary collapse
-
#initialize(value) ⇒ OrderPaymentType
constructor
A new instance of OrderPaymentType.
- #to_hash ⇒ Object
Constructor Details
#initialize(value) ⇒ OrderPaymentType
Returns a new instance of OrderPaymentType.
21317 21318 21319 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21317 def initialize(value) @value = HttpClient::Preconditions.assert_class('value', value, String) end |
Instance Attribute Details
#value ⇒ Object (readonly)
Returns the value of attribute value.
21315 21316 21317 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21315 def value @value end |
Class Method Details
.ALL ⇒ Object
21337 21338 21339 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21337 def OrderPaymentType.ALL @@all ||= [OrderPaymentType.card, OrderPaymentType.online, OrderPaymentType.credit, OrderPaymentType.subsidized, 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
21322 21323 21324 21325 21326 21327 21328 21329 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21322 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
21342 21343 21344 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21342 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.
21376 21377 21378 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21376 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
21353 21354 21355 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21353 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
21332 21333 21334 21335 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21332 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.
21370 21371 21372 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21370 def OrderPaymentType.installment_plan @@_installment_plan ||= OrderPaymentType.new('installment_plan') end |
.online ⇒ Object
Represents an online payment (e.g. paypal, alipay, etc)
21347 21348 21349 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21347 def OrderPaymentType.online @@_online ||= OrderPaymentType.new('online') end |
.subsidized ⇒ Object
Subsidized indicates that this payment is being subsidized by the organization
-
and Flow’s billing system will directly invoice the client for this payment.
This is intended to identify payment for replacement orders and in the future other types of orders (eg. influencer orders).
21361 21362 21363 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21361 def OrderPaymentType.subsidized @@_subsidized ||= OrderPaymentType.new('subsidized') end |
Instance Method Details
#to_hash ⇒ Object
21380 21381 21382 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 21380 def to_hash value end |