Class: Hubspot::Crm::Schemas::ObjectSchemaEgg

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ObjectSchemaEgg

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
122
123
124
125
126
127
128
129
130
131
132
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema_egg.rb', line 78

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

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

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

Instance Attribute Details

#associated_objectsObject

Associations defined for this object type.


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

def associated_objects
  @associated_objects
end

#labelsObject

Returns the value of attribute labels


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

def labels
  @labels
end

#nameObject

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


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

def name
  @name
end

#primary_display_propertyObject

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


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

def primary_display_property
  @primary_display_property
end

#propertiesObject

Properties defined for this object type.


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

def properties
  @properties
end

#required_propertiesObject

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


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

def required_properties
  @required_properties
end

#searchable_propertiesObject

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


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

def searchable_properties
  @searchable_properties
end

#secondary_display_propertiesObject

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


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

def secondary_display_properties
  @secondary_display_properties
end

Class Method Details

.attribute_mapObject

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


43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema_egg.rb', line 43

def self.attribute_map
  {
    :'labels' => :'labels',
    :'required_properties' => :'requiredProperties',
    :'searchable_properties' => :'searchableProperties',
    :'primary_display_property' => :'primaryDisplayProperty',
    :'secondary_display_properties' => :'secondaryDisplayProperties',
    :'properties' => :'properties',
    :'associated_objects' => :'associatedObjects',
    :'name' => :'name'
  }
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


212
213
214
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema_egg.rb', line 212

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

.openapi_nullableObject

List of attributes with nullable: true


71
72
73
74
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema_egg.rb', line 71

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

.openapi_typesObject

Attribute type mapping.


57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema_egg.rb', line 57

def self.openapi_types
  {
    :'labels' => :'ObjectTypeDefinitionLabels',
    :'required_properties' => :'Array<String>',
    :'searchable_properties' => :'Array<String>',
    :'primary_display_property' => :'String',
    :'secondary_display_properties' => :'Array<String>',
    :'properties' => :'Array<ObjectTypePropertyCreate>',
    :'associated_objects' => :'Array<String>',
    :'name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


184
185
186
187
188
189
190
191
192
193
194
195
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema_egg.rb', line 184

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 &&
      properties == o.properties &&
      associated_objects == o.associated_objects &&
      name == o.name
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


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema_egg.rb', line 240

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::Schemas.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


309
310
311
312
313
314
315
316
317
318
319
320
321
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema_egg.rb', line 309

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


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

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

199
200
201
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema_egg.rb', line 199

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


205
206
207
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema_egg.rb', line 205

def hash
  [labels, required_properties, searchable_properties, primary_display_property, secondary_display_properties, properties, associated_objects, name].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


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

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 @properties.nil?
    invalid_properties.push('invalid value for "properties", properties cannot be nil.')
  end

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

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


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

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


291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema_egg.rb', line 291

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


279
280
281
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema_egg.rb', line 279

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


171
172
173
174
175
176
177
178
179
180
# File 'lib/hubspot/codegen/crm/schemas/models/object_schema_egg.rb', line 171

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 @properties.nil?
  return false if @associated_objects.nil?
  return false if @name.nil?
  true
end