Class: PureCloud::DivsPermittedEntityListing

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DivsPermittedEntityListing

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 103

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?(:'allDivsPermitted')
    
    
    self.all_divs_permitted = attributes[:'allDivsPermitted']
    
  
  end

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

  
  if attributes.has_key?(:'selfUri')
    
    
    self.self_uri = attributes[:'selfUri']
    
  
  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

#all_divs_permitted ⇒ Object

Returns the value of attribute all_divs_permitted.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 29

def all_divs_permitted
  @all_divs_permitted
end

#entities ⇒ Object

Returns the value of attribute entities.



21
22
23
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 21

def entities
  @entities
end

#first_uri ⇒ Object

Returns the value of attribute first_uri.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 31

def first_uri
  @first_uri
end

#last_uri ⇒ Object

Returns the value of attribute last_uri.



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

def last_uri
  @last_uri
end

#next_uri ⇒ Object

Returns the value of attribute next_uri.



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 35

def next_uri
  @next_uri
end

#page_count ⇒ Object

Returns the value of attribute page_count.



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 41

def page_count
  @page_count
end

#page_number ⇒ Object

Returns the value of attribute page_number.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 25

def page_number
  @page_number
end

#page_size ⇒ Object

Returns the value of attribute page_size.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 23

def page_size
  @page_size
end

#previous_uri ⇒ Object

Returns the value of attribute previous_uri.



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

def previous_uri
  @previous_uri
end

#self_uri ⇒ Object

Returns the value of attribute self_uri.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 33

def self_uri
  @self_uri
end

#total ⇒ Object

Returns the value of attribute total.



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 27

def total
  @total
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
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/divs_permitted_entity_listing.rb', line 44

def self.attribute_map
  {
    
    :'entities' => :'entities',
    
    :'page_size' => :'pageSize',
    
    :'page_number' => :'pageNumber',
    
    :'total' => :'total',
    
    :'all_divs_permitted' => :'allDivsPermitted',
    
    :'first_uri' => :'firstUri',
    
    :'self_uri' => :'selfUri',
    
    :'next_uri' => :'nextUri',
    
    :'last_uri' => :'lastUri',
    
    :'previous_uri' => :'previousUri',
    
    :'page_count' => :'pageCount'
    
  }
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
96
97
98
99
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 73

def self.swagger_types
  {
    
    :'entities' => :'Array<AuthzDivision>',
    
    :'page_size' => :'Integer',
    
    :'page_number' => :'Integer',
    
    :'total' => :'Integer',
    
    :'all_divs_permitted' => :'BOOLEAN',
    
    :'first_uri' => :'String',
    
    :'self_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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 330

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 &&
      all_divs_permitted == o.all_divs_permitted &&
      first_uri == o.first_uri &&
      self_uri == o.self_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 



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
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 378

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



438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 438

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



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 359

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


348
349
350
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 348

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



354
355
356
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 354

def hash
  [entities, page_size, page_number, total, all_divs_permitted, first_uri, self_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



215
216
217
218
219
220
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 215

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



421
422
423
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 421

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



426
427
428
429
430
431
432
433
434
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 426

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 



416
417
418
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 416

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



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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb', line 224

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end