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.



16843
16844
16845
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16843

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



16841
16842
16843
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16841

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



16863
16864
16865
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16863

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



16898
16899
16900
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16898

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



16892
16893
16894
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16892

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



16848
16849
16850
16851
16852
16853
16854
16855
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16848

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



16887
16888
16889
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16887

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



16858
16859
16860
16861
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16858

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

.generic_error ⇒ Object 



16867
16868
16869
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16867

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



16904
16905
16906
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16904

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

.invalid_currency ⇒ Object

Indicates that the specified currency code is not valid



16877
16878
16879
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16877

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

.invalid_description ⇒ Object

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



16882
16883
16884
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16882

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

.invalid_order_number ⇒ Object

Indicates the specified order does not exist



16872
16873
16874
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16872

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

Instance Method Details

#to_hash ⇒ Object 



16908
16909
16910
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16908

def to_hash
  value
end