Class: Hubspot::Crm::Lists::PublicListFolder

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PublicListFolder

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
133
134
135
136
137
138
139
140
141
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.rb', line 89

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#child_lists ⇒ Object

An array of list Id’s contained in this folder.



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

def child_lists
  @child_lists
end

#child_nodes ⇒ Object

Returns the value of attribute child_nodes.



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

def child_nodes
  @child_nodes
end

#created_at ⇒ Object

The time the folder was created at.



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

def created_at
  @created_at
end

#id ⇒ Object

The Id of the folder.



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

def id
  @id
end

#name ⇒ Object

The name of the folder.



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

def name
  @name
end

#parent_folder_id ⇒ Object

The Id of the folder this folder is in, the root folder is represented as 0.



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

def parent_folder_id
  @parent_folder_id
end

#updated_at ⇒ Object

The time the folder was last updated at.



44
45
46
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.rb', line 44

def updated_at
  @updated_at
end

#updated_contents_at ⇒ Object

The time that the contents of the folder was last updated at.



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

def updated_contents_at
  @updated_contents_at
end

#user_id ⇒ Object

The user Id of the owner of the folder.



41
42
43
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.rb', line 41

def user_id
  @user_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



62
63
64
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.rb', line 62

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.rb', line 47

def self.attribute_map
  {
    :'created_at' => :'createdAt',
    :'parent_folder_id' => :'parentFolderId',
    :'child_nodes' => :'childNodes',
    :'name' => :'name',
    :'id' => :'id',
    :'child_lists' => :'childLists',
    :'updated_contents_at' => :'updatedContentsAt',
    :'user_id' => :'userId',
    :'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



207
208
209
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.rb', line 207

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.rb', line 82

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

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.rb', line 67

def self.openapi_types
  {
    :'created_at' => :'Time',
    :'parent_folder_id' => :'Integer',
    :'child_nodes' => :'Array<PublicListFolder>',
    :'name' => :'String',
    :'id' => :'Integer',
    :'child_lists' => :'Array<Integer>',
    :'updated_contents_at' => :'Time',
    :'user_id' => :'Integer',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.rb', line 178

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      parent_folder_id == o.parent_folder_id &&
      child_nodes == o.child_nodes &&
      name == o.name &&
      id == o.id &&
      child_lists == o.child_lists &&
      updated_contents_at == o.updated_contents_at &&
      user_id == o.user_id &&
      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



238
239
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/lists/models/public_list_folder.rb', line 238

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



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.rb', line 214

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


194
195
196
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



200
201
202
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.rb', line 200

def hash
  [created_at, parent_folder_id, child_nodes, name, id, child_lists, updated_contents_at, user_id, 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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.rb', line 145

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

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

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

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



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

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



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



279
280
281
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.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



168
169
170
171
172
173
174
 
# File 'lib/hubspot/codegen/crm/lists/models/public_list_folder.rb', line 168

def valid?
  return false if @parent_folder_id.nil?
  return false if @child_nodes.nil?
  return false if @id.nil?
  return false if @child_lists.nil?
  true
end