Class: Hubspot::Crm::Contacts::PublicObjectSearchRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PublicObjectSearchRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
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
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 63

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

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

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

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

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

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

Instance Attribute Details

#afterObject

Returns the value of attribute after


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

def after
  @after
end

#filter_groupsObject

Returns the value of attribute filter_groups


19
20
21
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 19

def filter_groups
  @filter_groups
end

#limitObject

Returns the value of attribute limit


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

def limit
  @limit
end

#propertiesObject

Returns the value of attribute properties


25
26
27
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 25

def properties
  @properties
end

#queryObject

Returns the value of attribute query


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

def query
  @query
end

#sortsObject

Returns the value of attribute sorts


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

def sorts
  @sorts
end

Class Method Details

.attribute_mapObject

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


32
33
34
35
36
37
38
39
40
41
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 32

def self.attribute_map
  {
    :'filter_groups' => :'filterGroups',
    :'sorts' => :'sorts',
    :'query' => :'query',
    :'properties' => :'properties',
    :'limit' => :'limit',
    :'after' => :'after'
  }
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


173
174
175
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 173

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

.openapi_nullableObject

List of attributes with nullable: true


56
57
58
59
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 56

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

.openapi_typesObject

Attribute type mapping.


44
45
46
47
48
49
50
51
52
53
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 44

def self.openapi_types
  {
    :'filter_groups' => :'Array<FilterGroup>',
    :'sorts' => :'Array<String>',
    :'query' => :'String',
    :'properties' => :'Array<String>',
    :'limit' => :'Integer',
    :'after' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


147
148
149
150
151
152
153
154
155
156
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 147

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      filter_groups == o.filter_groups &&
      sorts == o.sorts &&
      query == o.query &&
      properties == o.properties &&
      limit == o.limit &&
      after == o.after
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


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
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 201

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


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

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


180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 180

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

160
161
162
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 160

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


166
167
168
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 166

def hash
  [filter_groups, sorts, query, properties, limit, after].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 109

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

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

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

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

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


246
247
248
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 246

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


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

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


240
241
242
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 240

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
139
140
141
142
143
# File 'lib/hubspot/codegen/crm/contacts/models/public_object_search_request.rb', line 136

def valid?
  return false if @filter_groups.nil?
  return false if @sorts.nil?
  return false if @properties.nil?
  return false if @limit.nil?
  return false if @after.nil?
  true
end