Class: Hubspot::Crm::Lists::ListSearchRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListSearchRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_properties ⇒ Object

The property names of any additional list properties to include in the response. Properties that do not exist or that are empty for a particular list are not included in the response. By default, all requests will fetch the following properties for each list: ‘hs_list_size`, `hs_last_record_added_at`, `hs_last_record_removed_at`, `hs_folder_name`, and `hs_list_reference_count`.



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

def additional_properties
  @additional_properties
end

#count ⇒ Object

The number of lists to include in the response. Defaults to ‘20` if no value is provided. The max `count` is `500`.



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

def count
  @count
end

#list_ids ⇒ Object

The ‘listIds` that will be used to filter results by `listId`. If values are provided, then the response will only include results that have a `listId` in this array. If no value is provided, or if an empty list is provided, then the results will not be filtered by `listId`.



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

def list_ids
  @list_ids
end

#offset ⇒ Object

Value used to paginate through lists. The ‘offset` provided in the response can be used in the next request to fetch the next page of results. Defaults to `0` if no offset is provided.



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

def offset
  @offset
end

#processing_types ⇒ Object

The ‘processingTypes` that will be used to filter results by `processingType`. If values are provided, then the response will only include results that have a `processingType` in this array. If no value is provided, or if an empty list is provided, then results will not be filtered by `processingType`. Valid `processingTypes` are: `MANUAL`, `SNAPSHOT`, or `DYNAMIC`.



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

def processing_types
  @processing_types
end

#query ⇒ Object

The ‘query` that will be used to search for lists by list name. If no `query` is provided, then the results will include all lists.



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

def query
  @query
end

#sort ⇒ Object

Returns the value of attribute sort.



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

def sort
  @sort
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

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

def self.attribute_map
  {
    :'list_ids' => :'listIds',
    :'offset' => :'offset',
    :'query' => :'query',
    :'count' => :'count',
    :'processing_types' => :'processingTypes',
    :'additional_properties' => :'additionalProperties',
    :'sort' => :'sort'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
75
 
# File 'lib/hubspot/codegen/crm/lists/models/list_search_request.rb', line 72

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

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/hubspot/codegen/crm/lists/models/list_search_request.rb', line 59

def self.openapi_types
  {
    :'list_ids' => :'Array<String>',
    :'offset' => :'Integer',
    :'query' => :'String',
    :'count' => :'Integer',
    :'processing_types' => :'Array<String>',
    :'additional_properties' => :'Array<String>',
    :'sort' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/hubspot/codegen/crm/lists/models/list_search_request.rb', line 142

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      list_ids == o.list_ids &&
      offset == o.offset &&
      query == o.query &&
      count == o.count &&
      processing_types == o.processing_types &&
      additional_properties == o.additional_properties &&
      sort == o.sort
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



200
201
202
203
204
205
206
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
 
# File 'lib/hubspot/codegen/crm/lists/models/list_search_request.rb', line 200

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



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/hubspot/codegen/crm/lists/models/list_search_request.rb', line 271

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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/hubspot/codegen/crm/lists/models/list_search_request.rb', line 176

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


156
157
158
 
# File 'lib/hubspot/codegen/crm/lists/models/list_search_request.rb', line 156

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



162
163
164
 
# File 'lib/hubspot/codegen/crm/lists/models/list_search_request.rb', line 162

def hash
  [list_ids, offset, query, count, processing_types, additional_properties, sort].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



129
130
131
132
 
# File 'lib/hubspot/codegen/crm/lists/models/list_search_request.rb', line 129

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



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

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



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/hubspot/codegen/crm/lists/models/list_search_request.rb', line 253

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



241
242
243
 
# File 'lib/hubspot/codegen/crm/lists/models/list_search_request.rb', line 241

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



136
137
138
 
# File 'lib/hubspot/codegen/crm/lists/models/list_search_request.rb', line 136

def valid?
  true
end