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).
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.
13237 13238 13239 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13237 def initialize(value) @value = HttpClient::Preconditions.assert_class('value', value, String) end |
Instance Attribute Details
#value ⇒ Object (readonly)
Returns the value of attribute value.
13235 13236 13237 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13235 def value @value end |
Class Method Details
.ALL ⇒ Object
13257 13258 13259 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13257 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
13242 13243 13244 13245 13246 13247 13248 13249 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13242 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
13262 13263 13264 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13262 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.
13287 13288 13289 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13287 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
13273 13274 13275 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13273 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
13252 13253 13254 13255 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13252 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.
13281 13282 13283 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13281 def OrderPaymentType.installment_plan @@_installment_plan ||= OrderPaymentType.new('installment_plan') end |
.online ⇒ Object
Represents an online payment (e.g. paypal, alipay, etc)
13267 13268 13269 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13267 def OrderPaymentType.online @@_online ||= OrderPaymentType.new('online') end |
Instance Method Details
#to_hash ⇒ Object
13291 13292 13293 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 13291 def to_hash value end |