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



11253
11254
11255
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11253

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



11251
11252
11253
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11251

def value
  @value
end

Class Method Details

.ALLObject



11273
11274
11275
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11273

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_balanceObject

Indicates the provided credit amount exceeds the remaining balance on the order



11308
11309
11310
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11308

def CreditPaymentErrorCode.amount_exceeds_balance
  @@_amount_exceeds_balance ||= CreditPaymentErrorCode.new('amount_exceeds_balance')
end

.amount_must_be_positiveObject

Indicates the provided credit amount was <= 0



11302
11303
11304
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11302

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



11258
11259
11260
11261
11262
11263
11264
11265
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11258

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

.duplicateObject

Indicates that a credit payment with the specified key already exists



11297
11298
11299
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11297

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



11268
11269
11270
11271
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11268

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

.generic_errorObject



11277
11278
11279
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11277

def CreditPaymentErrorCode.generic_error
  @@_generic_error ||= CreditPaymentErrorCode.new('generic_error')
end

.insufficient_amountObject

Indicates the provided credit amount exceeds the maximum amount of applicable credit



11314
11315
11316
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11314

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

.invalid_currencyObject

Indicates that the specified currency code is not valid



11287
11288
11289
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11287

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

.invalid_descriptionObject

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



11292
11293
11294
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11292

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

.invalid_order_numberObject

Indicates the specified order does not exist



11282
11283
11284
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11282

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

Instance Method Details

#to_hashObject



11318
11319
11320
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11318

def to_hash
  value
end