Class: PureCloud::Site

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Site

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 170

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

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

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

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

  
  if attributes.has_key?(:'dateCreated')
    
    
    self.date_created = attributes[:'dateCreated']
    
  
  end

  
  if attributes.has_key?(:'dateModified')
    
    
    self.date_modified = attributes[:'dateModified']
    
  
  end

  
  if attributes.has_key?(:'modifiedBy')
    
    
    self.modified_by = attributes[:'modifiedBy']
    
  
  end

  
  if attributes.has_key?(:'createdBy')
    
    
    self.created_by = attributes[:'createdBy']
    
  
  end

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

  
  if attributes.has_key?(:'modifiedByApp')
    
    
    self.modified_by_app = attributes[:'modifiedByApp']
    
  
  end

  
  if attributes.has_key?(:'createdByApp')
    
    
    self.created_by_app = attributes[:'createdByApp']
    
  
  end

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

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

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

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

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

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

  
  if attributes.has_key?(:'edgeAutoUpdateConfig')
    
    
    self.edge_auto_update_config = attributes[:'edgeAutoUpdateConfig']
    
  
  end

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

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

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

  
end

Instance Attribute Details

#addresses ⇒ Object

Returns the value of attribute addresses.



55
56
57
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 55

def addresses
  @addresses
end

#created_by ⇒ Object

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#created_by_app ⇒ Object

Returns the value of attribute created_by_app.



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

def created_by_app
  @created_by_app
end

#date_created ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def date_created
  @date_created
end

#date_modified ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def date_modified
  @date_modified
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#edge_auto_update_config ⇒ Object

Recurrance rule, time zone, and start/end settings for automatic edge updates for this site



60
61
62
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 60

def edge_auto_update_config
  @edge_auto_update_config
end

#edges ⇒ Object

Returns the value of attribute edges.



57
58
59
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 57

def edges
  @edges
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#location ⇒ Object

Location



63
64
65
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 63

def location
  @location
end

#managed ⇒ Object

Returns the value of attribute managed.



65
66
67
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 65

def managed
  @managed
end

#modified_by ⇒ Object

Returns the value of attribute modified_by.



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

def modified_by
  @modified_by
end

#modified_by_app ⇒ Object

Returns the value of attribute modified_by_app.



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 43

def modified_by_app
  @modified_by_app
end

#name ⇒ Object

The name of the entity.



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

def name
  @name
end

#primary_edges ⇒ Object

Returns the value of attribute primary_edges.



51
52
53
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 51

def primary_edges
  @primary_edges
end

#primary_sites ⇒ Object

Returns the value of attribute primary_sites.



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 47

def primary_sites
  @primary_sites
end

#secondary_edges ⇒ Object

Returns the value of attribute secondary_edges.



53
54
55
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 53

def secondary_edges
  @secondary_edges
end

#secondary_sites ⇒ Object

Returns the value of attribute secondary_sites.



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 49

def secondary_sites
  @secondary_sites
end

#self_uri ⇒ Object

The URI for this object



68
69
70
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 68

def self_uri
  @self_uri
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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
112
113
114
115
116
117
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 71

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'version' => :'version',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'modified_by' => :'modifiedBy',
    
    :'created_by' => :'createdBy',
    
    :'state' => :'state',
    
    :'modified_by_app' => :'modifiedByApp',
    
    :'created_by_app' => :'createdByApp',
    
    :'primary_sites' => :'primarySites',
    
    :'secondary_sites' => :'secondarySites',
    
    :'primary_edges' => :'primaryEdges',
    
    :'secondary_edges' => :'secondaryEdges',
    
    :'addresses' => :'addresses',
    
    :'edges' => :'edges',
    
    :'edge_auto_update_config' => :'edgeAutoUpdateConfig',
    
    :'location' => :'location',
    
    :'managed' => :'managed',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 120

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'description' => :'String',
    
    :'version' => :'Integer',
    
    :'date_created' => :'DateTime',
    
    :'date_modified' => :'DateTime',
    
    :'modified_by' => :'String',
    
    :'created_by' => :'String',
    
    :'state' => :'String',
    
    :'modified_by_app' => :'String',
    
    :'created_by_app' => :'String',
    
    :'primary_sites' => :'Array<UriReference>',
    
    :'secondary_sites' => :'Array<UriReference>',
    
    :'primary_edges' => :'Array<Edge>',
    
    :'secondary_edges' => :'Array<Edge>',
    
    :'addresses' => :'Array<Contact>',
    
    :'edges' => :'Array<Edge>',
    
    :'edge_auto_update_config' => :'EdgeAutoUpdateConfig',
    
    :'location' => :'LocationDefinition',
    
    :'managed' => :'BOOLEAN',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 611

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      version == o.version &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      modified_by == o.modified_by &&
      created_by == o.created_by &&
      state == o.state &&
      modified_by_app == o.modified_by_app &&
      created_by_app == o.created_by_app &&
      primary_sites == o.primary_sites &&
      secondary_sites == o.secondary_sites &&
      primary_edges == o.primary_edges &&
      secondary_edges == o.secondary_edges &&
      addresses == o.addresses &&
      edges == o.edges &&
      edge_auto_update_config == o.edge_auto_update_config &&
      location == o.location &&
      managed == o.managed &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 669

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



729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 729

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



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 650

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


639
640
641
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 639

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



645
646
647
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 645

def hash
  [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, primary_sites, secondary_sites, primary_edges, secondary_edges, addresses, edges, edge_auto_update_config, location, managed, self_uri].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



382
383
384
385
386
387
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 382

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



712
713
714
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 712

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



717
718
719
720
721
722
723
724
725
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 717

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 



707
708
709
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 707

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



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/purecloudplatformclientv2/models/site.rb', line 391

def valid?
  
  
  
  
  
  
  if @name.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["active", "inactive", "deleted"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @location.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
end