Class: Hubspot::Crm::Schemas::ObjectTypeDefinitionPatch

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ObjectTypeDefinitionPatch

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

Instance Attribute Details

#clear_description ⇒ Object

Returns the value of attribute clear_description.



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

def clear_description
  @clear_description
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#labels ⇒ Object

Returns the value of attribute labels.



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

def labels
  @labels
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.



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

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.



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

def required_properties
  @required_properties
end

#restorable ⇒ Object

Returns the value of attribute restorable.



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

def restorable
  @restorable
end

#searchable_properties ⇒ Object

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



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

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.



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

def secondary_display_properties
  @secondary_display_properties
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'secondary_display_properties' => :'secondaryDisplayProperties',
    :'required_properties' => :'requiredProperties',
    :'searchable_properties' => :'searchableProperties',
    :'clear_description' => :'clearDescription',
    :'primary_display_property' => :'primaryDisplayProperty',
    :'description' => :'description',
    :'restorable' => :'restorable',
    :'labels' => :'labels'
  }
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



176
177
178
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition_patch.rb', line 176

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition_patch.rb', line 60

def self.openapi_types
  {
    :'secondary_display_properties' => :'Array<String>',
    :'required_properties' => :'Array<String>',
    :'searchable_properties' => :'Array<String>',
    :'clear_description' => :'Boolean',
    :'primary_display_property' => :'String',
    :'description' => :'String',
    :'restorable' => :'Boolean',
    :'labels' => :'ObjectTypeDefinitionLabels'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition_patch.rb', line 148

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      secondary_display_properties == o.secondary_display_properties &&
      required_properties == o.required_properties &&
      searchable_properties == o.searchable_properties &&
      clear_description == o.clear_description &&
      primary_display_property == o.primary_display_property &&
      description == o.description &&
      restorable == o.restorable &&
      labels == o.labels
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



207
208
209
210
211
212
213
214
215
216
217
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
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition_patch.rb', line 207

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



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition_patch.rb', line 278

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition_patch.rb', line 183

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


163
164
165
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition_patch.rb', line 163

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



169
170
171
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition_patch.rb', line 169

def hash
  [secondary_display_properties, required_properties, searchable_properties, clear_description, primary_display_property, description, restorable, labels].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



135
136
137
138
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition_patch.rb', line 135

def list_invalid_properties
  invalid_properties = Array.new
  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



254
255
256
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition_patch.rb', line 254

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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition_patch.rb', line 260

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



248
249
250
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition_patch.rb', line 248

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



142
143
144
 
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_definition_patch.rb', line 142

def valid?
  true
end