Class: PureCloud::SearchRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchRequest

Returns a new instance of SearchRequest.



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
133
134
 
# File 'lib/purecloud/models/search_request.rb', line 81

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

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

  
  if attributes[:'sortOrder']
    self.sort_order = attributes[:'sortOrder']
  end
  
  if attributes[:'sortBy']
    self.sort_by = attributes[:'sortBy']
  end
  
  if attributes[:'pageSize']
    self.page_size = attributes[:'pageSize']
  end
  
  if attributes[:'pageNumber']
    self.page_number = attributes[:'pageNumber']
  end
  
  if attributes[:'returnFields']
    if (value = attributes[:'returnFields']).is_a?(Array)
      self.return_fields = value
    end
  end
  
  if attributes[:'expand']
    if (value = attributes[:'expand']).is_a?(Array)
      self.expand = value
    end
  end
  
  if attributes[:'types']
    if (value = attributes[:'types']).is_a?(Array)
      self.types = value
    end
  end
  
  if attributes[:'query']
    if (value = attributes[:'query']).is_a?(Array)
      self.query = value
    end
  end
  
  if attributes[:'aggregations']
    if (value = attributes[:'aggregations']).is_a?(Array)
      self.aggregations = value
    end
  end
  
end

Instance Attribute Details

#aggregations ⇒ Object

Returns the value of attribute aggregations.



38
39
40
 
# File 'lib/purecloud/models/search_request.rb', line 38

def aggregations
  @aggregations
end

#expand ⇒ Object

Returns the value of attribute expand.



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

def expand
  @expand
end

#page_number ⇒ Object

Returns the value of attribute page_number.



27
28
29
 
# File 'lib/purecloud/models/search_request.rb', line 27

def page_number
  @page_number
end

#page_size ⇒ Object

Returns the value of attribute page_size.



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

def page_size
  @page_size
end

#query ⇒ Object

Returns the value of attribute query.



36
37
38
 
# File 'lib/purecloud/models/search_request.rb', line 36

def query
  @query
end

#return_fields ⇒ Object

Returns the value of attribute return_fields.



29
30
31
 
# File 'lib/purecloud/models/search_request.rb', line 29

def return_fields
  @return_fields
end

#sort_by ⇒ Object

Returns the value of attribute sort_by.



23
24
25
 
# File 'lib/purecloud/models/search_request.rb', line 23

def sort_by
  @sort_by
end

#sort_order ⇒ Object

Returns the value of attribute sort_order.



21
22
23
 
# File 'lib/purecloud/models/search_request.rb', line 21

def sort_order
  @sort_order
end

#types ⇒ Object

Resource Domain type



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

def types
  @types
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/purecloud/models/search_request.rb', line 41

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.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/purecloud/models/search_request.rb', line 66

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

Check equality by comparing each attribute.



146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/purecloud/models/search_request.rb', line 146

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 



190
191
192
193
194
195
196
197
198
199
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
 
# File 'lib/purecloud/models/search_request.rb', line 190

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



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/purecloud/models/search_request.rb', line 250

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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/purecloud/models/search_request.rb', line 171

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

Returns:

  • (Boolean)

See Also:

  • `==` method


161
162
163
 
# File 'lib/purecloud/models/search_request.rb', line 161

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



166
167
168
 
# File 'lib/purecloud/models/search_request.rb', line 166

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

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



233
234
235
 
# File 'lib/purecloud/models/search_request.rb', line 233

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



238
239
240
241
242
243
244
245
246
 
# File 'lib/purecloud/models/search_request.rb', line 238

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 



228
229
230
 
# File 'lib/purecloud/models/search_request.rb', line 228

def to_s
  to_hash.to_s
end