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.



8787
8788
8789
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8787

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



8785
8786
8787
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8785

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



8807
8808
8809
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8807

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



8842
8843
8844
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8842

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



8836
8837
8838
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8836

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



8792
8793
8794
8795
8796
8797
8798
8799
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8792

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



8831
8832
8833
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8831

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



8802
8803
8804
8805
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8802

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

.generic_error ⇒ Object 



8811
8812
8813
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8811

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



8848
8849
8850
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8848

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

.invalid_currency ⇒ Object

Indicates that the specified currency code is not valid



8821
8822
8823
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8821

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

.invalid_description ⇒ Object

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



8826
8827
8828
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8826

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

.invalid_order_number ⇒ Object

Indicates the specified order does not exist



8816
8817
8818
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8816

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

Instance Method Details

#to_hash ⇒ Object 



8852
8853
8854
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8852

def to_hash
  value
end