Class: Zernio::ErrorResponse

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/error_response.rb

Overview

Canonical error envelope. error is the human-readable message; type, code, param, platform, and platformError are top-level siblings for programmatic handling. For upstream platform failures (type: platform_error), platformError carries the provider's raw payload verbatim (for Meta: error_subcode, error_user_title, error_user_msg).

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 = {}) ⇒ ErrorResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
146
147
148
149
150
151
 
# File 'lib/zernio-sdk/models/error_response.rb', line 106

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::ErrorResponse` 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 `Zernio::ErrorResponse`. 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?(:'error')
    self.error = attributes[:'error']
  end

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

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

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

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

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

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

Instance Attribute Details

#code ⇒ Object

Stable machine-readable error code.



26
27
28
 
# File 'lib/zernio-sdk/models/error_response.rb', line 26

def code
  @code
end

#details ⇒ Object

Additional structured context (e.g. field-level validation errors).



38
39
40
 
# File 'lib/zernio-sdk/models/error_response.rb', line 38

def details
  @details
end

#error ⇒ Object

Human-readable error message.



20
21
22
 
# File 'lib/zernio-sdk/models/error_response.rb', line 20

def error
  @error
end

#param ⇒ Object

The request field that caused the error, when applicable.



29
30
31
 
# File 'lib/zernio-sdk/models/error_response.rb', line 29

def param
  @param
end

#platform ⇒ Object

Upstream platform (e.g. meta, google, tiktok) — present when type is platform_error.



32
33
34
 
# File 'lib/zernio-sdk/models/error_response.rb', line 32

def platform
  @platform
end

#platform_error ⇒ Object

Raw error payload from the upstream platform, passed through verbatim so integrators can read provider-specific codes. For Meta this includes error_subcode, error_user_title, and error_user_msg.



35
36
37
 
# File 'lib/zernio-sdk/models/error_response.rb', line 35

def platform_error
  @platform_error
end

#type ⇒ Object

Error class for programmatic handling.



23
24
25
 
# File 'lib/zernio-sdk/models/error_response.rb', line 23

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



76
77
78
 
# File 'lib/zernio-sdk/models/error_response.rb', line 76

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/zernio-sdk/models/error_response.rb', line 81

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/zernio-sdk/models/error_response.rb', line 63

def self.attribute_map
  {
    :'error' => :'error',
    :'type' => :'type',
    :'code' => :'code',
    :'param' => :'param',
    :'platform' => :'platform',
    :'platform_error' => :'platformError',
    :'details' => :'details'
  }
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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/zernio-sdk/models/error_response.rb', line 209

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



99
100
101
102
 
# File 'lib/zernio-sdk/models/error_response.rb', line 99

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/zernio-sdk/models/error_response.rb', line 86

def self.openapi_types
  {
    :'error' => :'String',
    :'type' => :'String',
    :'code' => :'String',
    :'param' => :'String',
    :'platform' => :'String',
    :'platform_error' => :'Hash<String, Object>',
    :'details' => :'Hash<String, Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/zernio-sdk/models/error_response.rb', line 182

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      error == o.error &&
      type == o.type &&
      code == o.code &&
      param == o.param &&
      platform == o.platform &&
      platform_error == o.platform_error &&
      details == o.details
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


196
197
198
 
# File 'lib/zernio-sdk/models/error_response.rb', line 196

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



202
203
204
 
# File 'lib/zernio-sdk/models/error_response.rb', line 202

def hash
  [error, type, code, param, platform, platform_error, details].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



155
156
157
158
159
 
# File 'lib/zernio-sdk/models/error_response.rb', line 155

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/zernio-sdk/models/error_response.rb', line 231

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



163
164
165
166
167
168
 
# File 'lib/zernio-sdk/models/error_response.rb', line 163

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["invalid_request_error", "authentication_error", "permission_error", "not_found", "rate_limit_error", "platform_error", "api_error"])
  return false unless type_validator.valid?(@type)
  true
end