Class: Hubspot::Crm::Lists::PublicObjectListSearchResult

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PublicObjectListSearchResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/lists/models/public_object_list_search_result.rb', line 110

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_properties ⇒ Object

The name and value of any additional properties that exist for this list and that were included in the search request.



51
52
53
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 51

def additional_properties
  @additional_properties
end

#created_at ⇒ Object

The time when the list was created.



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

def created_at
  @created_at
end

#created_by_id ⇒ Object

The ID of the user that created the list.



54
55
56
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 54

def created_by_id
  @created_by_id
end

#deleted_at ⇒ Object

The time when the list was deleted.



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

def deleted_at
  @deleted_at
end

#filters_updated_at ⇒ Object

The time when the filters for this list were last updated.



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

def filters_updated_at
  @filters_updated_at
end

#list_id ⇒ Object

The **ILS ID** of the list.



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

def list_id
  @list_id
end

#list_version ⇒ Object

The version of the list.



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

def list_version
  @list_version
end

#name ⇒ Object

The name of the list.



48
49
50
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 48

def name
  @name
end

#object_type_id ⇒ Object

The object type of the list.



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

def object_type_id
  @object_type_id
end

#processing_status ⇒ Object

The processing status of the list.



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

def processing_status
  @processing_status
end

#processing_type ⇒ Object

The processing type of the list.



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

def processing_type
  @processing_type
end

#updated_at ⇒ Object

The time the list was last updated.



57
58
59
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 57

def updated_at
  @updated_at
end

#updated_by_id ⇒ Object

The ID of the user that last updated the list.



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

def updated_by_id
  @updated_by_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 60

def self.attribute_map
  {
    :'processing_type' => :'processingType',
    :'object_type_id' => :'objectTypeId',
    :'updated_by_id' => :'updatedById',
    :'filters_updated_at' => :'filtersUpdatedAt',
    :'list_id' => :'listId',
    :'created_at' => :'createdAt',
    :'processing_status' => :'processingStatus',
    :'deleted_at' => :'deletedAt',
    :'list_version' => :'listVersion',
    :'name' => :'name',
    :'additional_properties' => :'additionalProperties',
    :'created_by_id' => :'createdById',
    :'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



261
262
263
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 261

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 84

def self.openapi_types
  {
    :'processing_type' => :'String',
    :'object_type_id' => :'String',
    :'updated_by_id' => :'String',
    :'filters_updated_at' => :'Time',
    :'list_id' => :'String',
    :'created_at' => :'Time',
    :'processing_status' => :'String',
    :'deleted_at' => :'Time',
    :'list_version' => :'Integer',
    :'name' => :'String',
    :'additional_properties' => :'Hash<String, String>',
    :'created_by_id' => :'String',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      processing_type == o.processing_type &&
      object_type_id == o.object_type_id &&
      updated_by_id == o.updated_by_id &&
      filters_updated_at == o.filters_updated_at &&
      list_id == o.list_id &&
      created_at == o.created_at &&
      processing_status == o.processing_status &&
      deleted_at == o.deleted_at &&
      list_version == o.list_version &&
      name == o.name &&
      additional_properties == o.additional_properties &&
      created_by_id == o.created_by_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



292
293
294
295
296
297
298
299
300
301
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
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 292

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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 363

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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 268

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [processing_type, object_type_id, updated_by_id, filters_updated_at, list_id, created_at, processing_status, deleted_at, list_version, name, additional_properties, created_by_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



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
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 180

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

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

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

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

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



339
340
341
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 339

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 345

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



333
334
335
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 333

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



215
216
217
218
219
220
221
222
223
224
 
# File 'lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb', line 215

def valid?
  return false if @processing_type.nil?
  return false if @object_type_id.nil?
  return false if @list_id.nil?
  return false if @processing_status.nil?
  return false if @list_version.nil?
  return false if @name.nil?
  return false if @additional_properties.nil?
  true
end