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.



8303
8304
8305
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8303

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

Instance Attribute Details

#valueObject (readonly)

Returns the value of attribute value.



8301
8302
8303
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8301

def value
  @value
end

Class Method Details

.ALLObject



8323
8324
8325
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8323

def PaymentErrorCode.ALL
  @@all ||= [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



8308
8309
8310
8311
8312
8313
8314
8315
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8308

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

.from_string(value) ⇒ Object

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



8318
8319
8320
8321
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8318

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.



8330
8331
8332
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8330

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).



8336
8337
8338
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8336

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)



8351
8352
8353
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8351

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

.invalid_destinationObject

Destination/shipping address is not valid



8356
8357
8358
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8356

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

.invalid_methodObject

Invalid payment method



8341
8342
8343
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8341

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

.invalid_orderObject

The specified order number was not found



8346
8347
8348
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8346

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

.unknownObject

Failed due to another reason (details not known)



8361
8362
8363
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8361

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

Instance Method Details

#to_hashObject



8365
8366
8367
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 8365

def to_hash
  value
end