Class: Hubspot::OAuth::Error

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/oauth/models/error.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Error

Initializes the object

Parameters:

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

    Model attributes in the form of hash


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 73

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#categoryObject

The error category


25
26
27
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 25

def category
  @category
end

#contextObject

Context about the error condition


34
35
36
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 34

def context
  @context
end

#correlation_idObject

A unique identifier for the request. Include this value with any error reports or support tickets


22
23
24
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 22

def correlation_id
  @correlation_id
end

#errorsObject

further information about the error


31
32
33
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 31

def errors
  @errors
end

A map of link names to associated URIs containing documentation about the error or recommended remediation steps


37
38
39
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 37

def links
  @links
end

#messageObject

A human readable message describing the error along with remediation steps where appropriate


19
20
21
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 19

def message
  @message
end

#sub_categoryObject

A specific category that contains more specific detail about the error


28
29
30
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 28

def sub_category
  @sub_category
end

Class Method Details

.attribute_mapObject

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


40
41
42
43
44
45
46
47
48
49
50
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 40

def self.attribute_map
  {
    :'message' => :'message',
    :'correlation_id' => :'correlationId',
    :'category' => :'category',
    :'sub_category' => :'subCategory',
    :'errors' => :'errors',
    :'context' => :'context',
    :'links' => :'links'
  }
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


178
179
180
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 178

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullableObject

List of attributes with nullable: true


66
67
68
69
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 66

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

.openapi_typesObject

Attribute type mapping.


53
54
55
56
57
58
59
60
61
62
63
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 53

def self.openapi_types
  {
    :'message' => :'String',
    :'correlation_id' => :'String',
    :'category' => :'String',
    :'sub_category' => :'String',
    :'errors' => :'Array<ErrorDetail>',
    :'context' => :'Hash<String, Array<String>>',
    :'links' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


151
152
153
154
155
156
157
158
159
160
161
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      message == o.message &&
      correlation_id == o.correlation_id &&
      category == o.category &&
      sub_category == o.sub_category &&
      errors == o.errors &&
      context == o.context &&
      links == o.links
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 206

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
    Hubspot::OAuth.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 275

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

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 185

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[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) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

165
166
167
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 165

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


171
172
173
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 171

def hash
  [message, correlation_id, category, sub_category, errors, context, links].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 123

def list_invalid_properties
  invalid_properties = Array.new
  if @message.nil?
    invalid_properties.push('invalid value for "message", message cannot be nil.')
  end

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


251
252
253
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 251

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 257

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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


245
246
247
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 245

def to_s
  to_hash.to_s
end

#valid?Boolean

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

Returns:

  • (Boolean)

    true if the model is valid


142
143
144
145
146
147
# File 'lib/hubspot/codegen/oauth/models/error.rb', line 142

def valid?
  return false if @message.nil?
  return false if @correlation_id.nil?
  return false if @category.nil?
  true
end