Class: Io::Flow::V0::Models::CreditPaymentErrorCode

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) ⇒ CreditPaymentErrorCode

Returns a new instance of CreditPaymentErrorCode.



8124
8125
8126
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8124

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



8122
8123
8124
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8122

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



8144
8145
8146
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8144

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



8179
8180
8181
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8179

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



8173
8174
8175
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8173

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



8129
8130
8131
8132
8133
8134
8135
8136
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8129

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



8168
8169
8170
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8168

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



8139
8140
8141
8142
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8139

def CreditPaymentErrorCode.from_string(value)
  HttpClient::Preconditions.assert_class('value', value, String)
  CreditPaymentErrorCode.ALL.find { |v| v.value == value }
end

.generic_error ⇒ Object 



8148
8149
8150
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8148

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



8185
8186
8187
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8185

def CreditPaymentErrorCode.insufficient_amount
  @@_insufficient_amount ||= CreditPaymentErrorCode.new('insufficient_amount')
end

.invalid_currency ⇒ Object

Indicates that the specified currency code is not valid



8158
8159
8160
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8158

def CreditPaymentErrorCode.invalid_currency
  @@_invalid_currency ||= CreditPaymentErrorCode.new('invalid_currency')
end

.invalid_description ⇒ Object

Indicates that the description is invalid (must be non-empty)



8163
8164
8165
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8163

def CreditPaymentErrorCode.invalid_description
  @@_invalid_description ||= CreditPaymentErrorCode.new('invalid_description')
end

.invalid_order_number ⇒ Object

Indicates the specified order does not exist



8153
8154
8155
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8153

def CreditPaymentErrorCode.invalid_order_number
  @@_invalid_order_number ||= CreditPaymentErrorCode.new('invalid_order_number')
end

Instance Method Details

#to_hash ⇒ Object 



8189
8190
8191
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8189

def to_hash
  value
end