Class: Hubspot::Crm::Contacts::StandardError

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/contacts/models/standard_error.rb

Direct Known Subclasses

ApiError

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StandardError

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 71

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

  if attributes.key?(:'id')
    self.id = attributes[:'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?(:'message')
    self.message = attributes[:'message']
  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

Returns the value of attribute category


23
24
25
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 23

def category
  @category
end

#contextObject

Returns the value of attribute context


31
32
33
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 31

def context
  @context
end

#errorsObject

Returns the value of attribute errors


29
30
31
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 29

def errors
  @errors
end

#idObject

Returns the value of attribute id


21
22
23
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 21

def id
  @id
end

Returns the value of attribute links


33
34
35
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 33

def links
  @links
end

#messageObject

Returns the value of attribute message


27
28
29
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 27

def message
  @message
end

#statusObject

Returns the value of attribute status


19
20
21
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 19

def status
  @status
end

#sub_categoryObject

Returns the value of attribute sub_category


25
26
27
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 25

def sub_category
  @sub_category
end

Class Method Details

.attribute_mapObject

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


36
37
38
39
40
41
42
43
44
45
46
47
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 36

def self.attribute_map
  {
    :'status' => :'status',
    :'id' => :'id',
    :'category' => :'category',
    :'sub_category' => :'subCategory',
    :'message' => :'message',
    :'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


196
197
198
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 196

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

.openapi_nullableObject

List of attributes with nullable: true


64
65
66
67
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 64

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

.openapi_typesObject

Attribute type mapping.


50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 50

def self.openapi_types
  {
    :'status' => :'String',
    :'id' => :'String',
    :'category' => :'ErrorCategory',
    :'sub_category' => :'Object',
    :'message' => :'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


168
169
170
171
172
173
174
175
176
177
178
179
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 168

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


224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 224

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::Crm::Contacts.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


293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 293

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


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 203

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

183
184
185
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 183

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


189
190
191
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 189

def hash
  [status, id, category, sub_category, message, 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


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
152
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 125

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

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

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

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

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

  if @links.nil?
    invalid_properties.push('invalid value for "links", links 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


269
270
271
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 269

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


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

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


263
264
265
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 263

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


156
157
158
159
160
161
162
163
164
# File 'lib/hubspot/codegen/crm/contacts/models/standard_error.rb', line 156

def valid?
  return false if @status.nil?
  return false if @category.nil?
  return false if @message.nil?
  return false if @errors.nil?
  return false if @context.nil?
  return false if @links.nil?
  true
end