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.



12055
12056
12057
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12055

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



12053
12054
12055
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12053

def value
  @value
end

Class Method Details

.ALLObject



12075
12076
12077
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12075

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.



12080
12081
12082
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12080

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



12060
12061
12062
12063
12064
12065
12066
12067
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12060

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.



12085
12086
12087
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12085

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

.authorization_expiredObject

The authorization has expired and can no longer be reversed.



12090
12091
12092
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12090

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



12070
12071
12072
12073
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12070

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



12105
12106
12107
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12105

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

.invalid_authorizationObject

The authorization was not found.



12095
12096
12097
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12095

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

.invalid_currencyObject

Currency is either not known or invalid



12110
12111
12112
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12110

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

.invalid_keyObject

Invalid key



12100
12101
12102
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12100

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.



12116
12117
12118
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12116

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

.partial_reversal_not_supportedObject

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



12122
12123
12124
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12122

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

.unknownObject

Unknown or other



12127
12128
12129
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12127

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

Instance Method Details

#to_hashObject



12131
12132
12133
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12131

def to_hash
  value
end