class Bfwd::BFError

Standard BillForward error format.

Attributes

error_code[RW]

{"description":"Code describing the nature of the error. Currently unused; prefer `errorType`.","verbs":}

error_message[RW]

{"description":"Human-readable description of the reason for the error.","verbs":}

error_parameters[RW]

{"description":"List of erroneous parameters found in your input (if applicable).","verbs":}

error_type[RW]

{"description":"Enum categorizing the nature of the error.","verbs":}

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/bf_ruby2/models/bf_error.rb, line 53
def self.attribute_map
  {
    :'error_type' => :'errorType',
    :'error_message' => :'errorMessage',
    :'error_code' => :'errorCode',
    :'error_parameters' => :'errorParameters'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/bf_ruby2/models/bf_error.rb, line 74
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'errorType')
    self.error_type = attributes[:'errorType']
  end

  if attributes.has_key?(:'errorMessage')
    self.error_message = attributes[:'errorMessage']
  end

  if attributes.has_key?(:'errorCode')
    self.error_code = attributes[:'errorCode']
  end

  if attributes.has_key?(:'errorParameters')
    if (value = attributes[:'errorParameters']).is_a?(Array)
      self.error_parameters = value
    end
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/bf_ruby2/models/bf_error.rb, line 63
def self.swagger_types
  {
    :'error_type' => :'String',
    :'error_message' => :'String',
    :'error_code' => :'Integer',
    :'error_parameters' => :'Array<String>'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/bf_ruby2/models/bf_error.rb, line 127
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      error_type == o.error_type &&
      error_message == o.error_message &&
      error_code == o.error_code &&
      error_parameters == o.error_parameters
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/bf_ruby2/models/bf_error.rb, line 172
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Bfwd.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/bf_ruby2/models/bf_error.rb, line 238
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/bf_ruby2/models/bf_error.rb, line 151
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/bf_ruby2/models/bf_error.rb, line 138
def eql?(o)
  self == o
end
error_type=(error_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] error_type Object to be assigned

# File lib/bf_ruby2/models/bf_error.rb, line 117
def error_type=(error_type)
  validator = EnumAttributeValidator.new('String', ["BFError", "ServerError", "ValidationError", "UnserializationException", "Oauth", "PermissionsError", "PreconditionFailed", "NotImplemented", "InvocationError", "NoSuchEntity", "InconsistentState", "StripeOperationFailure", "BraintreeOperationFailure", "BraintreeValidationError", "SagePayOperationFailure", "TokenizationAuthCaptureFailure", "TokenizationPreAuthFailure", "CouponException", "CouponUniqueCodesRequestException", "CouponUniqueCodesResponseException", "RemoveCouponException", "AddCouponCodeToSubscriptionRequestException", "GatewayAuthenticationError", "GatewayAuthorizationError", "GatewayResourceNotFoundError", "GatewayProtocolVersionError", "GatewayInternalError", "GatewayDownTemporarilyError", "GatewayUnexpectedError", "GatewayUnhandledError", "GatewaySDKUnhandledError"])
  unless validator.valid?(error_type)
    fail ArgumentError, "invalid value for 'error_type', must be one of #{validator.allowable_values}."
  end
  @error_type = error_type
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/bf_ruby2/models/bf_error.rb, line 144
def hash
  [error_type, error_message, error_code, error_parameters].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/bf_ruby2/models/bf_error.rb, line 102
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/bf_ruby2/models/bf_error.rb, line 218
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/bf_ruby2/models/bf_error.rb, line 224
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/bf_ruby2/models/bf_error.rb, line 212
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/bf_ruby2/models/bf_error.rb, line 109
def valid?
  error_type_validator = EnumAttributeValidator.new('String', ["BFError", "ServerError", "ValidationError", "UnserializationException", "Oauth", "PermissionsError", "PreconditionFailed", "NotImplemented", "InvocationError", "NoSuchEntity", "InconsistentState", "StripeOperationFailure", "BraintreeOperationFailure", "BraintreeValidationError", "SagePayOperationFailure", "TokenizationAuthCaptureFailure", "TokenizationPreAuthFailure", "CouponException", "CouponUniqueCodesRequestException", "CouponUniqueCodesResponseException", "RemoveCouponException", "AddCouponCodeToSubscriptionRequestException", "GatewayAuthenticationError", "GatewayAuthorizationError", "GatewayResourceNotFoundError", "GatewayProtocolVersionError", "GatewayInternalError", "GatewayDownTemporarilyError", "GatewayUnexpectedError", "GatewayUnhandledError", "GatewaySDKUnhandledError"])
  return false unless error_type_validator.valid?(@error_type)
  return true
end