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.



7724
7725
7726
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7724

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

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.



7722
7723
7724
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7722

def value
  @value
end

Class Method Details

.ALL ⇒ Object 



7744
7745
7746
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7744

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



7779
7780
7781
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7779

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



7773
7774
7775
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7773

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



7729
7730
7731
7732
7733
7734
7735
7736
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7729

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



7768
7769
7770
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7768

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



7739
7740
7741
7742
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7739

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

.generic_error ⇒ Object 



7748
7749
7750
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7748

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



7785
7786
7787
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7785

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

.invalid_currency ⇒ Object

Indicates that the specified currency code is not valid



7758
7759
7760
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7758

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

.invalid_description ⇒ Object

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



7763
7764
7765
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7763

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

.invalid_order_number ⇒ Object

Indicates the specified order does not exist



7753
7754
7755
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7753

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

Instance Method Details

#to_hash ⇒ Object 



7789
7790
7791
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7789

def to_hash
  value
end