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.



19004
19005
19006
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19004

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



19002
19003
19004
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19002

def value
  @value
end

Class Method Details

.ALLObject



19024
19025
19026
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19024

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.



19029
19030
19031
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19029

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



19009
19010
19011
19012
19013
19014
19015
19016
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19009

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.



19034
19035
19036
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19034

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

.authorization_expiredObject

The authorization has expired and can no longer be reversed.



19039
19040
19041
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19039

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



19019
19020
19021
19022
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19019

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



19054
19055
19056
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19054

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

.invalid_authorizationObject

The authorization was not found.



19044
19045
19046
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19044

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

.invalid_currencyObject

Currency is either not known or invalid



19059
19060
19061
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19059

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

.invalid_keyObject

Invalid key



19049
19050
19051
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19049

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.



19065
19066
19067
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19065

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



19071
19072
19073
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19071

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

.unknownObject

Unknown or other



19076
19077
19078
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19076

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

Instance Method Details

#to_hashObject



19080
19081
19082
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19080

def to_hash
  value
end