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.



18704
18705
18706
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18704

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



18702
18703
18704
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18702

def value
  @value
end

Class Method Details

.ALLObject



18724
18725
18726
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18724

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.



18729
18730
18731
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18729

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



18709
18710
18711
18712
18713
18714
18715
18716
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18709

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.



18734
18735
18736
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18734

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

.authorization_expiredObject

The authorization has expired and can no longer be reversed.



18739
18740
18741
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18739

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



18719
18720
18721
18722
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18719

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



18754
18755
18756
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18754

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

.invalid_authorizationObject

The authorization was not found.



18744
18745
18746
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18744

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

.invalid_currencyObject

Currency is either not known or invalid



18759
18760
18761
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18759

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

.invalid_keyObject

Invalid key



18749
18750
18751
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18749

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.



18765
18766
18767
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18765

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



18771
18772
18773
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18771

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

.unknownObject

Unknown or other



18776
18777
18778
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18776

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

Instance Method Details

#to_hashObject



18780
18781
18782
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18780

def to_hash
  value
end