Class: PureCloud::UsersSearchResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UsersSearchResponse

Returns a new instance of UsersSearchResponse.



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
106
107
108
109
110
111
 
# File 'lib/purecloud/models/users_search_response.rb', line 64

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[:'total']
    self.total = attributes[:'total']
  end
  
  if attributes[:'pageCount']
    self.page_count = attributes[:'pageCount']
  end
  
  if attributes[:'pageSize']
    self.page_size = attributes[:'pageSize']
  end
  
  if attributes[:'pageNumber']
    self.page_number = attributes[:'pageNumber']
  end
  
  if attributes[:'previousPage']
    self.previous_page = attributes[:'previousPage']
  end
  
  if attributes[:'currentPage']
    self.current_page = attributes[:'currentPage']
  end
  
  if attributes[:'nextPage']
    self.next_page = attributes[:'nextPage']
  end
  
  if attributes[:'types']
    if (value = attributes[:'types']).is_a?(Array)
      self.types = value
    end
  end
  
  if attributes[:'results']
    if (value = attributes[:'results']).is_a?(Array)
      self.results = value
    end
  end
  
end

Instance Attribute Details

#current_page ⇒ Object

Returns the value of attribute current_page.



15
16
17
 
# File 'lib/purecloud/models/users_search_response.rb', line 15

def current_page
  @current_page
end

#next_page ⇒ Object

Returns the value of attribute next_page.



17
18
19
 
# File 'lib/purecloud/models/users_search_response.rb', line 17

def next_page
  @next_page
end

#page_count ⇒ Object

Returns the value of attribute page_count.



7
8
9
 
# File 'lib/purecloud/models/users_search_response.rb', line 7

def page_count
  @page_count
end

#page_number ⇒ Object

Returns the value of attribute page_number.



11
12
13
 
# File 'lib/purecloud/models/users_search_response.rb', line 11

def page_number
  @page_number
end

#page_size ⇒ Object

Returns the value of attribute page_size.



9
10
11
 
# File 'lib/purecloud/models/users_search_response.rb', line 9

def page_size
  @page_size
end

#previous_page ⇒ Object

Returns the value of attribute previous_page.



13
14
15
 
# File 'lib/purecloud/models/users_search_response.rb', line 13

def previous_page
  @previous_page
end

#results ⇒ Object

Returns the value of attribute results.



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

def results
  @results
end

#total ⇒ Object

Returns the value of attribute total.



5
6
7
 
# File 'lib/purecloud/models/users_search_response.rb', line 5

def total
  @total
end

#types ⇒ Object

Returns the value of attribute types.



19
20
21
 
# File 'lib/purecloud/models/users_search_response.rb', line 19

def types
  @types
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/purecloud/models/users_search_response.rb', line 24

def self.attribute_map
  {
    
    :'total' => :'total',
    
    :'page_count' => :'pageCount',
    
    :'page_size' => :'pageSize',
    
    :'page_number' => :'pageNumber',
    
    :'previous_page' => :'previousPage',
    
    :'current_page' => :'currentPage',
    
    :'next_page' => :'nextPage',
    
    :'types' => :'types',
    
    :'results' => :'results'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'total' => :'Integer',
    :'page_count' => :'Integer',
    :'page_size' => :'Integer',
    :'page_number' => :'Integer',
    :'previous_page' => :'String',
    :'current_page' => :'String',
    :'next_page' => :'String',
    :'types' => :'Array<String>',
    :'results' => :'Array<User>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/purecloud/models/users_search_response.rb', line 114

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total == o.total &&
      page_count == o.page_count &&
      page_size == o.page_size &&
      page_number == o.page_number &&
      previous_page == o.previous_page &&
      current_page == o.current_page &&
      next_page == o.next_page &&
      types == o.types &&
      results == o.results
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/users_search_response.rb', line 158

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/purecloud/models/users_search_response.rb', line 215

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/purecloud/models/users_search_response.rb', line 139

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


129
130
131
 
# File 'lib/purecloud/models/users_search_response.rb', line 129

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



134
135
136
 
# File 'lib/purecloud/models/users_search_response.rb', line 134

def hash
  [total, page_count, page_size, page_number, previous_page, current_page, next_page, types, results].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



198
199
200
 
# File 'lib/purecloud/models/users_search_response.rb', line 198

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



203
204
205
206
207
208
209
210
211
 
# File 'lib/purecloud/models/users_search_response.rb', line 203

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 



193
194
195
 
# File 'lib/purecloud/models/users_search_response.rb', line 193

def to_s
  to_hash.to_s
end