Class: PureCloud::LocationsSearchResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LocationsSearchResponse

Returns a new instance of LocationsSearchResponse.



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
135
136
137
138
 
# File 'lib/purecloud/models/locations_search_response.rb', line 85

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



39
40
41
 
# File 'lib/purecloud/models/locations_search_response.rb', line 39

def aggregations
  @aggregations
end

#current_page ⇒ Object

Returns the value of attribute current_page.



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

def current_page
  @current_page
end

#next_page ⇒ Object

Returns the value of attribute next_page.



33
34
35
 
# File 'lib/purecloud/models/locations_search_response.rb', line 33

def next_page
  @next_page
end

#page_count ⇒ Object

Returns the value of attribute page_count.



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

def page_count
  @page_count
end

#page_number ⇒ Object

Returns the value of attribute page_number.



27
28
29
 
# File 'lib/purecloud/models/locations_search_response.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/locations_search_response.rb', line 25

def page_size
  @page_size
end

#previous_page ⇒ Object

Returns the value of attribute previous_page.



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

def previous_page
  @previous_page
end

#results ⇒ Object

Returns the value of attribute results.



37
38
39
 
# File 'lib/purecloud/models/locations_search_response.rb', line 37

def results
  @results
end

#total ⇒ Object

Returns the value of attribute total.



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

def total
  @total
end

#types ⇒ Object

Returns the value of attribute types.



35
36
37
 
# File 'lib/purecloud/models/locations_search_response.rb', line 35

def types
  @types
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    
    :'aggregations' => :'aggregations'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/purecloud/models/locations_search_response.rb', line 69

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<Location>',
    :'aggregations' => :'Array<Location>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



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

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 &&
      aggregations == o.aggregations
end

#_deserialize(type, value) ⇒ Object 



186
187
188
189
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
 
# File 'lib/purecloud/models/locations_search_response.rb', line 186

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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/purecloud/models/locations_search_response.rb', line 246

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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/purecloud/models/locations_search_response.rb', line 167

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


157
158
159
 
# File 'lib/purecloud/models/locations_search_response.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



162
163
164
 
# File 'lib/purecloud/models/locations_search_response.rb', line 162

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

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



229
230
231
 
# File 'lib/purecloud/models/locations_search_response.rb', line 229

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



234
235
236
237
238
239
240
241
242
 
# File 'lib/purecloud/models/locations_search_response.rb', line 234

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 



224
225
226
 
# File 'lib/purecloud/models/locations_search_response.rb', line 224

def to_s
  to_hash.to_s
end