Class: Sendmux::Mailbox::Generated::ApiErrorError

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/sendmux_mailbox_generated/models/api_error_error.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ApiErrorError

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 100

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Sendmux::Mailbox::Generated::ApiErrorError` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Sendmux::Mailbox::Generated::ApiErrorError`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'code')
    self.code = attributes[:'code']
  else
    self.code = nil
  end

  if attributes.key?(:'doc_url')
    self.doc_url = attributes[:'doc_url']
  end

  if attributes.key?(:'errors')
    if (value = attributes[:'errors']).is_a?(Array)
      self.errors = value
    end
  end

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  else
    self.message = nil
  end

  if attributes.key?(:'param')
    self.param = attributes[:'param']
  end

  if attributes.key?(:'retryable')
    self.retryable = attributes[:'retryable']
  else
    self.retryable = nil
  end
end

Instance Attribute Details

#code ⇒ Object

Machine-readable error code



19
20
21
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 19

def code
  @code
end

#doc_url ⇒ Object

Link to relevant documentation



22
23
24
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 22

def doc_url
  @doc_url
end

#errors ⇒ Object

Accumulated per-field issues for validation errors. Only present on 400/422 responses.



25
26
27
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 25

def errors
  @errors
end

#message ⇒ Object

Human-readable error description



28
29
30
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 28

def message
  @message
end

#param ⇒ Object

The parameter that caused the error



31
32
33
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 31

def param
  @param
end

#retryable ⇒ Object

Whether the caller may safely retry this request. 4xx are typically false (except 429); 5xx are typically true.



34
35
36
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 34

def retryable
  @retryable
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



71
72
73
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 71

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 76

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 59

def self.attribute_map
  {
    :'code' => :'code',
    :'doc_url' => :'doc_url',
    :'errors' => :'errors',
    :'message' => :'message',
    :'param' => :'param',
    :'retryable' => :'retryable'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 237

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



93
94
95
96
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 93

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 81

def self.openapi_types
  {
    :'code' => :'String',
    :'doc_url' => :'String',
    :'errors' => :'Array<ApiErrorDetail>',
    :'message' => :'String',
    :'param' => :'String',
    :'retryable' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 211

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code == o.code &&
      doc_url == o.doc_url &&
      errors == o.errors &&
      message == o.message &&
      param == o.param &&
      retryable == o.retryable
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


224
225
226
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



230
231
232
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 230

def hash
  [code, doc_url, errors, message, param, retryable].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 149

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @code.nil?
    invalid_properties.push('invalid value for "code", code cannot be nil.')
  end

  if @message.nil?
    invalid_properties.push('invalid value for "message", message cannot be nil.')
  end

  if @retryable.nil?
    invalid_properties.push('invalid value for "retryable", retryable cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 259

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



169
170
171
172
173
174
175
176
177
 
# File 'lib/sendmux_mailbox_generated/models/api_error_error.rb', line 169

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @code.nil?
  code_validator = EnumAttributeValidator.new('String', ["invalid_parameter", "missing_parameter", "authentication_required", "insufficient_permissions", "not_found", "conflict", "limit_exceeded", "idempotency_conflict", "payload_too_large", "validation_error", "rate_limit_exceeded", "service_unavailable", "internal_error", "unknown_default_open_api"])
  return false unless code_validator.valid?(@code)
  return false if @message.nil?
  return false if @retryable.nil?
  true
end