Class: Hubspot::Crm::Schemas::ObjectSchema

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ObjectSchema

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
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
208
209
210
211
212
213
214
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 124

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#archived ⇒ Object

Returns the value of attribute archived.



39
40
41
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 39

def archived
  @archived
end

#associations ⇒ Object

Associations defined for a given object type.



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

def associations
  @associations
end

#created_at ⇒ Object

When the object schema was created.



42
43
44
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 42

def created_at
  @created_at
end

#created_by_user_id ⇒ Object

Returns the value of attribute created_by_user_id.



26
27
28
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 26

def created_by_user_id
  @created_by_user_id
end

#description ⇒ Object

Returns the value of attribute description.



30
31
32
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 30

def description
  @description
end

#fully_qualified_name ⇒ Object

An assigned unique ID for the object, including portal ID and object name.



35
36
37
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 35

def fully_qualified_name
  @fully_qualified_name
end

#id ⇒ Object

A unique ID for this schema’s object type. Will be defined as meta-type-ID.



57
58
59
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 57

def id
  @id
end

#labels ⇒ Object

Returns the value of attribute labels.



37
38
39
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 37

def labels
  @labels
end

#name ⇒ Object

A unique name for the schema’s object type.



54
55
56
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 54

def name
  @name
end

#object_type_id ⇒ Object

Returns the value of attribute object_type_id.



28
29
30
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 28

def object_type_id
  @object_type_id
end

#primary_display_property ⇒ Object

The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.



51
52
53
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 51

def primary_display_property
  @primary_display_property
end

#properties ⇒ Object

Properties defined for this object type.



60
61
62
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 60

def properties
  @properties
end

#required_properties ⇒ Object

The names of properties that should be required when creating an object of this type.



45
46
47
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 45

def required_properties
  @required_properties
end

#searchable_properties ⇒ Object

Names of properties that will be indexed for this object type in by HubSpot’s product search.



48
49
50
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 48

def searchable_properties
  @searchable_properties
end

#secondary_display_properties ⇒ Object

The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.



24
25
26
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 24

def secondary_display_properties
  @secondary_display_properties
end

#updated_at ⇒ Object

When the object schema was last updated.



63
64
65
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 63

def updated_at
  @updated_at
end

#updated_by_user_id ⇒ Object

Returns the value of attribute updated_by_user_id.



32
33
34
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 32

def updated_by_user_id
  @updated_by_user_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 66

def self.attribute_map
  {
    :'associations' => :'associations',
    :'secondary_display_properties' => :'secondaryDisplayProperties',
    :'created_by_user_id' => :'createdByUserId',
    :'object_type_id' => :'objectTypeId',
    :'description' => :'description',
    :'updated_by_user_id' => :'updatedByUserId',
    :'fully_qualified_name' => :'fullyQualifiedName',
    :'labels' => :'labels',
    :'archived' => :'archived',
    :'created_at' => :'createdAt',
    :'required_properties' => :'requiredProperties',
    :'searchable_properties' => :'searchableProperties',
    :'primary_display_property' => :'primaryDisplayProperty',
    :'name' => :'name',
    :'id' => :'id',
    :'properties' => :'properties',
    :'updated_at' => :'updatedAt'
  }
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



298
299
300
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 298

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 117

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 94

def self.openapi_types
  {
    :'associations' => :'Array<AssociationDefinition>',
    :'secondary_display_properties' => :'Array<String>',
    :'created_by_user_id' => :'Integer',
    :'object_type_id' => :'String',
    :'description' => :'String',
    :'updated_by_user_id' => :'Integer',
    :'fully_qualified_name' => :'String',
    :'labels' => :'ObjectTypeDefinitionLabels',
    :'archived' => :'Boolean',
    :'created_at' => :'Time',
    :'required_properties' => :'Array<String>',
    :'searchable_properties' => :'Array<String>',
    :'primary_display_property' => :'String',
    :'name' => :'String',
    :'id' => :'String',
    :'properties' => :'Array<Property>',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 261

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      associations == o.associations &&
      secondary_display_properties == o.secondary_display_properties &&
      created_by_user_id == o.created_by_user_id &&
      object_type_id == o.object_type_id &&
      description == o.description &&
      updated_by_user_id == o.updated_by_user_id &&
      fully_qualified_name == o.fully_qualified_name &&
      labels == o.labels &&
      archived == o.archived &&
      created_at == o.created_at &&
      required_properties == o.required_properties &&
      searchable_properties == o.searchable_properties &&
      primary_display_property == o.primary_display_property &&
      name == o.name &&
      id == o.id &&
      properties == o.properties &&
      updated_at == o.updated_at
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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 329

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Hubspot::Crm::Schemas.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 400

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 305

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


285
286
287
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 285

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



291
292
293
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 291

def hash
  [associations, secondary_display_properties, created_by_user_id, object_type_id, description, updated_by_user_id, fully_qualified_name, labels, archived, created_at, required_properties, searchable_properties, primary_display_property, name, id, properties, updated_at].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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 218

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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



376
377
378
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 376

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 382

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



370
371
372
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 370

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



249
250
251
252
253
254
255
256
257
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema.rb', line 249

def valid?
  return false if @associations.nil?
  return false if @labels.nil?
  return false if @required_properties.nil?
  return false if @name.nil?
  return false if @id.nil?
  return false if @properties.nil?
  true
end