Class: Io::Flow::V0::Models::PaymentErrorCode

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) ⇒ PaymentErrorCode

Returns a new instance of PaymentErrorCode.



22307
22308
22309
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22307

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



22305
22306
22307
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22305

def value
  @value
end

Class Method Details

.ALLObject



22327
22328
22329
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22327

def PaymentErrorCode.ALL
  @@all ||= [PaymentErrorCode.duplicate, PaymentErrorCode.invalid_amount, PaymentErrorCode.invalid_currency, PaymentErrorCode.invalid_method, PaymentErrorCode.invalid_order, PaymentErrorCode.invalid_customer, PaymentErrorCode.invalid_destination, PaymentErrorCode.unknown]
end

.apply(value) ⇒ Object

Returns the instance of PaymentErrorCode for this value, creating a new instance for an unknown value



22312
22313
22314
22315
22316
22317
22318
22319
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22312

def PaymentErrorCode.apply(value)
  if value.instance_of?(PaymentErrorCode)
    value
  else
    HttpClient::Preconditions.assert_class_or_nil('value', value, String)
    value.nil? ? nil : (from_string(value) || PaymentErrorCode.new(value))
  end
end

.duplicateObject



22331
22332
22333
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22331

def PaymentErrorCode.duplicate
  @@_duplicate ||= PaymentErrorCode.new('duplicate')
end

.from_string(value) ⇒ Object

Returns the instance of PaymentErrorCode for this value, or nil if not found



22322
22323
22324
22325
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22322

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

.invalid_amountObject

Amount is not valid (e.g. for merchant of record payments, the amount specified must match the order). This typically is handled by refreshing the order amount and reconfirming with the user as something has changed.



22338
22339
22340
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22338

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

.invalid_currencyObject

Currency is either not known or invalid (e.g. for merchant of record payments, the currency specified must match the order).



22344
22345
22346
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22344

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

.invalid_customerObject

Customer information is invalid (e.g. email specified but not a valid email)



22359
22360
22361
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22359

def PaymentErrorCode.invalid_customer
  @@_invalid_customer ||= PaymentErrorCode.new('invalid_customer')
end

.invalid_destinationObject

Destination/shipping address is not valid



22364
22365
22366
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22364

def PaymentErrorCode.invalid_destination
  @@_invalid_destination ||= PaymentErrorCode.new('invalid_destination')
end

.invalid_methodObject

Invalid payment method



22349
22350
22351
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22349

def PaymentErrorCode.invalid_method
  @@_invalid_method ||= PaymentErrorCode.new('invalid_method')
end

.invalid_orderObject

The specified order number was not found



22354
22355
22356
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22354

def PaymentErrorCode.invalid_order
  @@_invalid_order ||= PaymentErrorCode.new('invalid_order')
end

.unknownObject

Failed due to another reason (details not known)



22369
22370
22371
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22369

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

Instance Method Details

#to_hashObject



22373
22374
22375
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22373

def to_hash
  value
end