Class: PureCloud::ResponseEntityList

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

Overview

Query result list

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResponseEntityList

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 76

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

  if attributes.has_key?(:'selfUri')
    self.self_uri = attributes[:'selfUri']
  end

  if attributes.has_key?(:'firstUri')
    self.first_uri = attributes[:'firstUri']
  end

  if attributes.has_key?(:'nextUri')
    self.next_uri = attributes[:'nextUri']
  end

  if attributes.has_key?(:'lastUri')
    self.last_uri = attributes[:'lastUri']
  end

  if attributes.has_key?(:'previousUri')
    self.previous_uri = attributes[:'previousUri']
  end

  if attributes.has_key?(:'pageCount')
    self.page_count = attributes[:'pageCount']
  end

end

Instance Attribute Details

#entities ⇒ Object

Returns the value of attribute entities.



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

def entities
  @entities
end

#first_uri ⇒ Object

Returns the value of attribute first_uri.



32
33
34
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 32

def first_uri
  @first_uri
end

#last_uri ⇒ Object

Returns the value of attribute last_uri.



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 36

def last_uri
  @last_uri
end

#next_uri ⇒ Object

Returns the value of attribute next_uri.



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

def next_uri
  @next_uri
end

#page_count ⇒ Object

Returns the value of attribute page_count.



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

def page_count
  @page_count
end

#page_number ⇒ Object

Returns the value of attribute page_number.



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 26

def page_number
  @page_number
end

#page_size ⇒ Object

Returns the value of attribute page_size.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 24

def page_size
  @page_size
end

#previous_uri ⇒ Object

Returns the value of attribute previous_uri.



38
39
40
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 38

def previous_uri
  @previous_uri
end

#self_uri ⇒ Object

Returns the value of attribute self_uri.



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 30

def self_uri
  @self_uri
end

#total ⇒ Object

Returns the value of attribute total.



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

def total
  @total
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 43

def self.attribute_map
  {
    :'entities' => :'entities',
    :'page_size' => :'pageSize',
    :'page_number' => :'pageNumber',
    :'total' => :'total',
    :'self_uri' => :'selfUri',
    :'first_uri' => :'firstUri',
    :'next_uri' => :'nextUri',
    :'last_uri' => :'lastUri',
    :'previous_uri' => :'previousUri',
    :'page_count' => :'pageCount'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 59

def self.swagger_types
  {
    :'entities' => :'Array<Response>',
    :'page_size' => :'Integer',
    :'page_number' => :'Integer',
    :'total' => :'Integer',
    :'self_uri' => :'String',
    :'first_uri' => :'String',
    :'next_uri' => :'String',
    :'last_uri' => :'String',
    :'previous_uri' => :'String',
    :'page_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      entities == o.entities &&
      page_size == o.page_size &&
      page_number == o.page_number &&
      total == o.total &&
      self_uri == o.self_uri &&
      first_uri == o.first_uri &&
      next_uri == o.next_uri &&
      last_uri == o.last_uri &&
      previous_uri == o.previous_uri &&
      page_count == o.page_count
end

#_deserialize(type, value) ⇒ Object 



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
223
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 187

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



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 247

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



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

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


157
158
159
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 163

def hash
  [entities, page_size, page_number, total, self_uri, first_uri, next_uri, last_uri, previous_uri, page_count].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



128
129
130
131
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 128

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



230
231
232
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 230

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



235
236
237
238
239
240
241
242
243
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 235

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 



225
226
227
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 225

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



135
136
 
# File 'lib/purecloudplatformclientv2/models/response_entity_list.rb', line 135

def valid?
end