Class: PureCloud::UserSearchRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserSearchRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 99

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?(:'sort')
    
    if (value = attributes[:'sort']).is_a?(Array)
      self.sort = value
    end
    
    
  
  end

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

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

  
  if attributes.has_key?(:'integrationPresenceSource')
    
    
    self.integration_presence_source = attributes[:'integrationPresenceSource']
    
  
  end

  
  if attributes.has_key?(:'enforcePermissions')
    
    
    self.enforce_permissions = attributes[:'enforcePermissions']
    
  
  end

  
end

Instance Attribute Details

#enforce_permissions ⇒ Object

Enforce view permission on request



45
46
47
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 45

def enforce_permissions
  @enforce_permissions
end

#expand ⇒ Object

Provides more details about a specified resource



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

def expand
  @expand
end

#integration_presence_source ⇒ Object

Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an "expand". When using this parameter the maximum number of users that can be returned is 10.



42
43
44
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 42

def integration_presence_source
  @integration_presence_source
end

#page_number ⇒ Object

The page of resources you want to retrieve



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/user_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/user_search_request.rb', line 28

def page_size
  @page_size
end

#query ⇒ Object

Returns the value of attribute query.



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 39

def query
  @query
end

#sort ⇒ Object

Multi-value sort order, list of multiple sort values



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

def sort
  @sort
end

#sort_by ⇒ Object

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



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/user_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/user_search_request.rb', line 22

def sort_order
  @sort_order
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 48

def self.attribute_map
  {
    
    :'sort_order' => :'sortOrder',
    
    :'sort_by' => :'sortBy',
    
    :'page_size' => :'pageSize',
    
    :'page_number' => :'pageNumber',
    
    :'sort' => :'sort',
    
    :'expand' => :'expand',
    
    :'query' => :'query',
    
    :'integration_presence_source' => :'integrationPresenceSource',
    
    :'enforce_permissions' => :'enforcePermissions'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 73

def self.swagger_types
  {
    
    :'sort_order' => :'String',
    
    :'sort_by' => :'String',
    
    :'page_size' => :'Integer',
    
    :'page_number' => :'Integer',
    
    :'sort' => :'Array<SearchSort>',
    
    :'expand' => :'Array<String>',
    
    :'query' => :'Array<UserSearchCriteria>',
    
    :'integration_presence_source' => :'String',
    
    :'enforce_permissions' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 322

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 &&
      sort == o.sort &&
      expand == o.expand &&
      query == o.query &&
      integration_presence_source == o.integration_presence_source &&
      enforce_permissions == o.enforce_permissions
end

#_deserialize(type, value) ⇒ Object 



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 368

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



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 428

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



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 349

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


338
339
340
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 338

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



344
345
346
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 344

def hash
  [sort_order, sort_by, page_size, page_number, sort, expand, query, integration_presence_source, enforce_permissions].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



197
198
199
200
201
202
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 197

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))



411
412
413
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 411

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



416
417
418
419
420
421
422
423
424
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 416

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 



406
407
408
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 406

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



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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/purecloudplatformclientv2/models/user_search_request.rb', line 206

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