Class: Hubspot::OAuth::ErrorDetail

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ErrorDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash


63
64
65
66
67
68
69
70
71
72
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
# File 'lib/hubspot/codegen/oauth/models/error_detail.rb', line 63

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

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

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

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

Instance Attribute Details

#_inObject

The name of the field or parameter in which the error was found.


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

def _in
  @_in
end

#codeObject

The status code associated with the error detail


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

def code
  @code
end

#contextObject

Context about the error condition


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

def context
  @context
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_detail.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_detail.rb', line 28

def sub_category
  @sub_category
end

Class Method Details

.attribute_mapObject

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


34
35
36
37
38
39
40
41
42
# File 'lib/hubspot/codegen/oauth/models/error_detail.rb', line 34

def self.attribute_map
  {
    :'message' => :'message',
    :'_in' => :'in',
    :'code' => :'code',
    :'sub_category' => :'subCategory',
    :'context' => :'context'
  }
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


144
145
146
# File 'lib/hubspot/codegen/oauth/models/error_detail.rb', line 144

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

.openapi_nullableObject

List of attributes with nullable: true


56
57
58
59
# File 'lib/hubspot/codegen/oauth/models/error_detail.rb', line 56

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

.openapi_typesObject

Attribute type mapping.


45
46
47
48
49
50
51
52
53
# File 'lib/hubspot/codegen/oauth/models/error_detail.rb', line 45

def self.openapi_types
  {
    :'message' => :'String',
    :'_in' => :'String',
    :'code' => :'String',
    :'sub_category' => :'String',
    :'context' => :'Hash<String, Array<String>>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


119
120
121
122
123
124
125
126
127
# File 'lib/hubspot/codegen/oauth/models/error_detail.rb', line 119

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      message == o.message &&
      _in == o._in &&
      code == o.code &&
      sub_category == o.sub_category &&
      context == o.context
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


172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'lib/hubspot/codegen/oauth/models/error_detail.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
    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


241
242
243
244
245
246
247
248
249
250
251
252
253
# File 'lib/hubspot/codegen/oauth/models/error_detail.rb', line 241

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


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/hubspot/codegen/oauth/models/error_detail.rb', line 151

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

131
132
133
# File 'lib/hubspot/codegen/oauth/models/error_detail.rb', line 131

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


137
138
139
# File 'lib/hubspot/codegen/oauth/models/error_detail.rb', line 137

def hash
  [message, _in, code, sub_category, context].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


101
102
103
104
105
106
107
108
# File 'lib/hubspot/codegen/oauth/models/error_detail.rb', line 101

def list_invalid_properties
  invalid_properties = Array.new
  if @message.nil?
    invalid_properties.push('invalid value for "message", message 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


217
218
219
# File 'lib/hubspot/codegen/oauth/models/error_detail.rb', line 217

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


223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'lib/hubspot/codegen/oauth/models/error_detail.rb', line 223

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


211
212
213
# File 'lib/hubspot/codegen/oauth/models/error_detail.rb', line 211

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


112
113
114
115
# File 'lib/hubspot/codegen/oauth/models/error_detail.rb', line 112

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