Class: PureCloud::SearchRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/search_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
128
129
130
131
132
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 80

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'sortOrder')
    self.sort_order = attributes[:'sortOrder']
  end

  if attributes.has_key?(:'sortBy')
    self.sort_by = attributes[:'sortBy']
  end

  if attributes.has_key?(:'pageSize')
    self.page_size = attributes[:'pageSize']
  end

  if attributes.has_key?(:'pageNumber')
    self.page_number = attributes[:'pageNumber']
  end

  if attributes.has_key?(:'returnFields')
    if (value = attributes[:'returnFields']).is_a?(Array)
      self.return_fields = value
    end
  end

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

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

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

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

end

Instance Attribute Details

#aggregations ⇒ Object

Aggregation criteria



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 46

def aggregations
  @aggregations
end

#expand ⇒ Object

Provides more details about a specified resource



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 37

def expand
  @expand
end

#page_number ⇒ Object

The page of resources you want to retrieve



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 31

def page_number
  @page_number
end

#page_size ⇒ Object

The number of results per page



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 28

def page_size
  @page_size
end

#query ⇒ Object

The search criteria



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 43

def query
  @query
end

#return_fields ⇒ Object

A List of strings. Possible values are any field in the resource you are searching on. The other option is to use ALL_FIELDS, when this is provided all fields in the resource will be returned in the search results.



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 34

def return_fields
  @return_fields
end

#sort_by ⇒ Object

The field in the resource that you want to sort the results by



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 25

def sort_by
  @sort_by
end

#sort_order ⇒ Object

The sort order for results



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 22

def sort_order
  @sort_order
end

#types ⇒ Object

Resource domain type to search



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 40

def types
  @types
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 49

def self.attribute_map
  {
    :'sort_order' => :'sortOrder',
    :'sort_by' => :'sortBy',
    :'page_size' => :'pageSize',
    :'page_number' => :'pageNumber',
    :'return_fields' => :'returnFields',
    :'expand' => :'expand',
    :'types' => :'types',
    :'query' => :'query',
    :'aggregations' => :'aggregations'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 64

def self.swagger_types
  {
    :'sort_order' => :'String',
    :'sort_by' => :'String',
    :'page_size' => :'Integer',
    :'page_number' => :'Integer',
    :'return_fields' => :'Array<String>',
    :'expand' => :'Array<String>',
    :'types' => :'Array<String>',
    :'query' => :'Array<SearchCriteria>',
    :'aggregations' => :'Array<SearchAggregation>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      sort_order == o.sort_order &&
      sort_by == o.sort_by &&
      page_size == o.page_size &&
      page_number == o.page_number &&
      return_fields == o.return_fields &&
      expand == o.expand &&
      types == o.types &&
      query == o.query &&
      aggregations == o.aggregations
end

#_deserialize(type, value) ⇒ Object 



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
245
246
247
248
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 212

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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 272

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

build the object from hash



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 193

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


182
183
184
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 182

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



188
189
190
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 188

def hash
  [sort_order, sort_by, page_size, page_number, return_fields, expand, types, query, aggregations].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



136
137
138
139
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 136

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



255
256
257
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 255

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



260
261
262
263
264
265
266
267
268
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 260

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



250
251
252
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 250

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



143
144
145
146
147
148
149
150
151
152
 
# File 'lib/purecloudplatformclientv2/models/search_request.rb', line 143

def valid?
  allowed_values = ["ASC", "DESC", "SCORE"]
  if @sort_order && !allowed_values.include?(@sort_order)
    return false
  end
  if @types.nil?
    return false
  end

end