Class: Io::Flow::V0::Models::CreditPaymentErrorCode
- Inherits:
-
Object
- Object
- Io::Flow::V0::Models::CreditPaymentErrorCode
- 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
-
.amount_exceeds_balance ⇒ Object
Indicates the provided credit amount exceeds the remaining balance on the order.
-
.amount_must_be_positive ⇒ Object
Indicates the provided credit amount was <= 0.
-
.apply(value) ⇒ Object
Returns the instance of CreditPaymentErrorCode for this value, creating a new instance for an unknown value.
-
.duplicate ⇒ Object
Indicates that a credit payment with the specified key already exists.
-
.from_string(value) ⇒ Object
Returns the instance of CreditPaymentErrorCode for this value, or nil if not found.
- .generic_error ⇒ Object
-
.insufficient_amount ⇒ Object
Indicates the provided credit amount exceeds the maximum amount of applicable credit.
-
.invalid_currency ⇒ Object
Indicates that the specified currency code is not valid.
-
.invalid_description ⇒ Object
Indicates that the description is invalid (must be non-empty).
-
.invalid_order_number ⇒ Object
Indicates the specified order does not exist.
Instance Method Summary collapse
-
#initialize(value) ⇒ CreditPaymentErrorCode
constructor
A new instance of CreditPaymentErrorCode.
- #to_hash ⇒ Object
Constructor Details
#initialize(value) ⇒ CreditPaymentErrorCode
Returns a new instance of CreditPaymentErrorCode.
12668 12669 12670 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12668 def initialize(value) @value = HttpClient::Preconditions.assert_class('value', value, String) end |
Instance Attribute Details
#value ⇒ Object (readonly)
Returns the value of attribute value.
12666 12667 12668 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12666 def value @value end |
Class Method Details
.ALL ⇒ Object
12688 12689 12690 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12688 def CreditPaymentErrorCode.ALL @@all ||= [CreditPaymentErrorCode.generic_error, CreditPaymentErrorCode.invalid_order_number, CreditPaymentErrorCode.invalid_currency, CreditPaymentErrorCode.invalid_description, CreditPaymentErrorCode.duplicate, CreditPaymentErrorCode.amount_must_be_positive, CreditPaymentErrorCode.amount_exceeds_balance, CreditPaymentErrorCode.insufficient_amount] end |
.amount_exceeds_balance ⇒ Object
Indicates the provided credit amount exceeds the remaining balance on the order
12723 12724 12725 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12723 def CreditPaymentErrorCode.amount_exceeds_balance @@_amount_exceeds_balance ||= CreditPaymentErrorCode.new('amount_exceeds_balance') end |
.amount_must_be_positive ⇒ Object
Indicates the provided credit amount was <= 0
12717 12718 12719 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12717 def CreditPaymentErrorCode.amount_must_be_positive @@_amount_must_be_positive ||= CreditPaymentErrorCode.new('amount_must_be_positive') end |
.apply(value) ⇒ Object
Returns the instance of CreditPaymentErrorCode for this value, creating a new instance for an unknown value
12673 12674 12675 12676 12677 12678 12679 12680 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12673 def CreditPaymentErrorCode.apply(value) if value.instance_of?(CreditPaymentErrorCode) value else HttpClient::Preconditions.assert_class_or_nil('value', value, String) value.nil? ? nil : (from_string(value) || CreditPaymentErrorCode.new(value)) end end |
.duplicate ⇒ Object
Indicates that a credit payment with the specified key already exists
12712 12713 12714 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12712 def CreditPaymentErrorCode.duplicate @@_duplicate ||= CreditPaymentErrorCode.new('duplicate') end |
.from_string(value) ⇒ Object
Returns the instance of CreditPaymentErrorCode for this value, or nil if not found
12683 12684 12685 12686 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12683 def CreditPaymentErrorCode.from_string(value) HttpClient::Preconditions.assert_class('value', value, String) CreditPaymentErrorCode.ALL.find { |v| v.value == value } end |
.generic_error ⇒ Object
12692 12693 12694 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12692 def CreditPaymentErrorCode.generic_error @@_generic_error ||= CreditPaymentErrorCode.new('generic_error') end |
.insufficient_amount ⇒ Object
Indicates the provided credit amount exceeds the maximum amount of applicable credit
12729 12730 12731 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12729 def CreditPaymentErrorCode.insufficient_amount @@_insufficient_amount ||= CreditPaymentErrorCode.new('insufficient_amount') end |
.invalid_currency ⇒ Object
Indicates that the specified currency code is not valid
12702 12703 12704 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12702 def CreditPaymentErrorCode.invalid_currency @@_invalid_currency ||= CreditPaymentErrorCode.new('invalid_currency') end |
.invalid_description ⇒ Object
Indicates that the description is invalid (must be non-empty)
12707 12708 12709 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12707 def CreditPaymentErrorCode.invalid_description @@_invalid_description ||= CreditPaymentErrorCode.new('invalid_description') end |
.invalid_order_number ⇒ Object
Indicates the specified order does not exist
12697 12698 12699 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12697 def CreditPaymentErrorCode.invalid_order_number @@_invalid_order_number ||= CreditPaymentErrorCode.new('invalid_order_number') end |
Instance Method Details
#to_hash ⇒ Object
12733 12734 12735 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12733 def to_hash value end |