Class: Hubspot::Crm::Schemas::AssociationDefinition

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssociationDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 99

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

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

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

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

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

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

Instance Attribute Details

#cardinalityObject

Returns the value of attribute cardinality


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

def cardinality
  @cardinality
end

#created_atObject

When the association was defined.


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

def created_at
  @created_at
end

#from_object_type_idObject

ID of the primary object type to link from.


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

def from_object_type_id
  @from_object_type_id
end

#idObject

A unique ID for this association.


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

def id
  @id
end

#inverse_cardinalityObject

Returns the value of attribute inverse_cardinality


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

def inverse_cardinality
  @inverse_cardinality
end

#nameObject

A unique name for this association.


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

def name
  @name
end

#to_object_type_idObject

ID of the target object type ID to link to.


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

def to_object_type_id
  @to_object_type_id
end

#updated_atObject

When the association was last updated.


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

def updated_at
  @updated_at
end

Class Method Details

.attribute_mapObject

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


64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 64

def self.attribute_map
  {
    :'from_object_type_id' => :'fromObjectTypeId',
    :'to_object_type_id' => :'toObjectTypeId',
    :'name' => :'name',
    :'cardinality' => :'cardinality',
    :'inverse_cardinality' => :'inverseCardinality',
    :'id' => :'id',
    :'created_at' => :'createdAt',
    :'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


237
238
239
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 237

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

.openapi_nullableObject

List of attributes with nullable: true


92
93
94
95
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 92

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

.openapi_typesObject

Attribute type mapping.


78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 78

def self.openapi_types
  {
    :'from_object_type_id' => :'String',
    :'to_object_type_id' => :'String',
    :'name' => :'String',
    :'cardinality' => :'String',
    :'inverse_cardinality' => :'String',
    :'id' => :'String',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      from_object_type_id == o.from_object_type_id &&
      to_object_type_id == o.to_object_type_id &&
      name == o.name &&
      cardinality == o.cardinality &&
      inverse_cardinality == o.inverse_cardinality &&
      id == o.id &&
      created_at == o.created_at &&
      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


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 265

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


334
335
336
337
338
339
340
341
342
343
344
345
346
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 334

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


244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 244

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

224
225
226
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 224

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


230
231
232
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 230

def hash
  [from_object_type_id, to_object_type_id, name, cardinality, inverse_cardinality, id, created_at, updated_at].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 147

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

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

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

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

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


310
311
312
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 310

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


316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 316

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


304
305
306
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 304

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


174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/hubspot/codegen/crm/schemas/models/association_definition.rb', line 174

def valid?
  return false if @from_object_type_id.nil?
  return false if @to_object_type_id.nil?
  return false if @cardinality.nil?
  cardinality_validator = EnumAttributeValidator.new('String', ["ONE_TO_ONE", "ONE_TO_MANY"])
  return false unless cardinality_validator.valid?(@cardinality)
  return false if @inverse_cardinality.nil?
  inverse_cardinality_validator = EnumAttributeValidator.new('String', ["ONE_TO_ONE", "ONE_TO_MANY"])
  return false unless inverse_cardinality_validator.valid?(@inverse_cardinality)
  return false if @id.nil?
  true
end