Class: Hubspot::Crm::Schemas::ObjectTypeDefinition

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ObjectTypeDefinition

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
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
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 106

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#archived ⇒ Object

Returns the value of attribute archived.



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

def archived
  @archived
end

#created_at ⇒ Object

When the object type was created.



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

def created_at
  @created_at
end

#fully_qualified_name ⇒ Object

Returns the value of attribute fully_qualified_name.



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

def fully_qualified_name
  @fully_qualified_name
end

#id ⇒ Object

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



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

def id
  @id
end

#labels ⇒ Object

Returns the value of attribute labels.



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

def labels
  @labels
end

#name ⇒ Object

A unique name for this object. For internal use only.



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

def name
  @name
end

#object_type_id ⇒ Object

Returns the value of attribute object_type_id.



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

def object_type_id
  @object_type_id
end

#portal_id ⇒ Object

The ID of the account that this object type is specific to.



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

def portal_id
  @portal_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.



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

def primary_display_property
  @primary_display_property
end

#required_properties ⇒ Object

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



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

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.



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

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.



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

def secondary_display_properties
  @secondary_display_properties
end

#updated_at ⇒ Object

When the object type was last updated.



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 56

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



271
272
273
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 271

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 99

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 80

def self.openapi_types
  {
    :'labels' => :'ObjectTypeDefinitionLabels',
    :'required_properties' => :'Array<String>',
    :'searchable_properties' => :'Array<String>',
    :'primary_display_property' => :'String',
    :'secondary_display_properties' => :'Array<String>',
    :'archived' => :'Boolean',
    :'id' => :'String',
    :'fully_qualified_name' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'object_type_id' => :'String',
    :'name' => :'String',
    :'portal_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 238

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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 302

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



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 373

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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 278

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


258
259
260
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 258

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



264
265
266
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 264

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



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
215
216
217
218
219
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 180

def list_invalid_properties
  invalid_properties = Array.new
  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 @searchable_properties.nil?
    invalid_properties.push('invalid value for "searchable_properties", searchable_properties cannot be nil.')
  end

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

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

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

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

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

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



349
350
351
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 349

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



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 355

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



343
344
345
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition.rb', line 343

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



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

def valid?
  return false if @labels.nil?
  return false if @required_properties.nil?
  return false if @searchable_properties.nil?
  return false if @secondary_display_properties.nil?
  return false if @archived.nil?
  return false if @id.nil?
  return false if @fully_qualified_name.nil?
  return false if @object_type_id.nil?
  return false if @name.nil?
  true
end