Class: Io::Flow::V0::Models::ReversalErrorCode

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

Returns a new instance of ReversalErrorCode.



15162
15163
15164
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15162

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



15160
15161
15162
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15160

def value
  @value
end

Class Method Details

.ALLObject



15182
15183
15184
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15182

def ReversalErrorCode.ALL
  @@all ||= [ReversalErrorCode.amount_exceeds_balance, ReversalErrorCode.authorization_declined, ReversalErrorCode.authorization_expired, ReversalErrorCode.invalid_authorization, ReversalErrorCode.invalid_key, ReversalErrorCode.invalid_amount, ReversalErrorCode.invalid_currency, ReversalErrorCode.no_remaining_balance, ReversalErrorCode.partial_reversal_not_supported, ReversalErrorCode.unknown]
end

.amount_exceeds_balanceObject

Amount specified exceeds the remaining authorization balance.



15187
15188
15189
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15187

def ReversalErrorCode.amount_exceeds_balance
  @@_amount_exceeds_balance ||= ReversalErrorCode.new('amount_exceeds_balance')
end

.apply(value) ⇒ Object

Returns the instance of ReversalErrorCode for this value, creating a new instance for an unknown value



15167
15168
15169
15170
15171
15172
15173
15174
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15167

def ReversalErrorCode.apply(value)
  if value.instance_of?(ReversalErrorCode)
    value
  else
    HttpClient::Preconditions.assert_class_or_nil('value', value, String)
    value.nil? ? nil : (from_string(value) || ReversalErrorCode.new(value))
  end
end

.authorization_declinedObject

The authorization was initially declined; there is nothing to reverse.



15192
15193
15194
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15192

def ReversalErrorCode.authorization_declined
  @@_authorization_declined ||= ReversalErrorCode.new('authorization_declined')
end

.authorization_expiredObject

The authorization has expired and can no longer be reversed.



15197
15198
15199
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15197

def ReversalErrorCode.authorization_expired
  @@_authorization_expired ||= ReversalErrorCode.new('authorization_expired')
end

.from_string(value) ⇒ Object

Returns the instance of ReversalErrorCode for this value, or nil if not found



15177
15178
15179
15180
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15177

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

.invalid_amountObject

Amount is not valid - usually because amount was <= 0



15212
15213
15214
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15212

def ReversalErrorCode.invalid_amount
  @@_invalid_amount ||= ReversalErrorCode.new('invalid_amount')
end

.invalid_authorizationObject

The authorization was not found.



15202
15203
15204
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15202

def ReversalErrorCode.invalid_authorization
  @@_invalid_authorization ||= ReversalErrorCode.new('invalid_authorization')
end

.invalid_currencyObject

Currency is either not known or invalid



15217
15218
15219
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15217

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

.invalid_keyObject

Invalid key



15207
15208
15209
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15207

def ReversalErrorCode.invalid_key
  @@_invalid_key ||= ReversalErrorCode.new('invalid_key')
end

.no_remaining_balanceObject

The authorization has already been fully captured and/or reversed - there are no additional funds to reverse.



15223
15224
15225
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15223

def ReversalErrorCode.no_remaining_balance
  @@_no_remaining_balance ||= ReversalErrorCode.new('no_remaining_balance')
end

.partial_reversal_not_supportedObject

Indicates a request for a partial reversal when the underlying processor does not support it



15229
15230
15231
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15229

def ReversalErrorCode.partial_reversal_not_supported
  @@_partial_reversal_not_supported ||= ReversalErrorCode.new('partial_reversal_not_supported')
end

.unknownObject

Unknown or other



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def ReversalErrorCode.unknown
  @@_unknown ||= ReversalErrorCode.new('unknown')
end

Instance Method Details

#to_hashObject



15238
15239
15240
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15238

def to_hash
  value
end