Class: PureCloud::DocumentationResult

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/documentation_result.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentationResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
379
380
381
382
383
384
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 177

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
  if attributes.has_key?(:'service-area')
    
    if (value = attributes[:'service-area']).is_a?(Array)
      self.service_area = value
    end
    
    
  
  end

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

  
end

Instance Attribute Details

#categories ⇒ Object

The category of the documentation entity. Will be returned in responses for certain entities.



25
26
27
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 25

def categories
  @categories
end

#content ⇒ Object

The text or html content for the documentation entity. Will be returned in responses for certain entities.



31
32
33
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 31

def content
  @content
end

#description ⇒ Object

The description of the documentation entity. Will be returned in responses for certain entities.



28
29
30
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 28

def description
  @description
end

#excerpt ⇒ Object

The excerpt of the documentation entity. Will be returned in responses for certain entities.



34
35
36
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 34

def excerpt
  @excerpt
end

#facet_feature ⇒ Object

The facet feature of the documentation entity. Will be returned in responses for certain entities.



58
59
60
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 58

def facet_feature
  @facet_feature
end

#facet_role ⇒ Object

The facet role of the documentation entity. Will be returned in responses for certain entities.



61
62
63
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 61

def facet_role
  @facet_role
end

#facet_service ⇒ Object

The facet service of the documentation entity. Will be returned in responses for certain entities.



64
65
66
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 64

def facet_service
  @facet_service
end

#faq_categories ⇒ Object

The faq categories of the documentation entity. Will be returned in responses for certain entities.



67
68
69
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 67

def faq_categories
  @faq_categories
end

#get_type ⇒ Object

The search type. Will be returned in responses for certain entities.



55
56
57
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 55

def get_type
  @get_type
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 22

def id
  @id
end

#link ⇒ Object

URL link for the documentation entity. Will be returned in responses for certain entities.



37
38
39
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 37

def link
  @link
end

#modified ⇒ Object

The modified date for the documentation entity. Will be returned in responses for certain entities. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



40
41
42
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 40

def modified
  @modified
end

#name ⇒ Object

The name of the documentation entity. Will be returned in responses for certain entities.



43
44
45
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 43

def name
  @name
end

#releasenote_category ⇒ Object

The releasenote category of the documentation entity. Will be returned in responses for certain entities.



70
71
72
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 70

def releasenote_category
  @releasenote_category
end

#releasenote_tag ⇒ Object

The releasenote tag of the documentation entity. Will be returned in responses for certain entities.



73
74
75
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 73

def releasenote_tag
  @releasenote_tag
end

#service ⇒ Object

The service of the documentation entity. Will be returned in responses for certain entities.



46
47
48
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 46

def service
  @service
end

#service_area ⇒ Object

The service area of the documentation entity. Will be returned in responses for certain entities.



76
77
78
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 76

def service_area
  @service_area
end

#slug ⇒ Object

The slug of the documentation entity. Will be returned in responses for certain entities.



49
50
51
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 49

def slug
  @slug
end

#title ⇒ Object

The title of the documentation entity. Will be returned in responses for certain entities.



52
53
54
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 52

def title
  @title
end

#video_categories ⇒ Object

The video categories of the documentation entity. Will be returned in responses for certain entities.



79
80
81
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 79

def video_categories
  @video_categories
end

Class Method Details

.attribute_map ⇒ Object

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



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
125
126
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 82

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'categories' => :'categories',
    
    :'description' => :'description',
    
    :'content' => :'content',
    
    :'excerpt' => :'excerpt',
    
    :'link' => :'link',
    
    :'modified' => :'modified',
    
    :'name' => :'name',
    
    :'service' => :'service',
    
    :'slug' => :'slug',
    
    :'title' => :'title',
    
    :'get_type' => :'get_type',
    
    :'facet_feature' => :'facet_feature',
    
    :'facet_role' => :'facet_role',
    
    :'facet_service' => :'facet_service',
    
    :'faq_categories' => :'faq_categories',
    
    :'releasenote_category' => :'releasenote_category',
    
    :'releasenote_tag' => :'releasenote_tag',
    
    :'service_area' => :'service-area',
    
    :'video_categories' => :'video_categories'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 129

def self.swagger_types
  {
    
    :'id' => :'Integer',
    
    :'categories' => :'Array<Integer>',
    
    :'description' => :'String',
    
    :'content' => :'String',
    
    :'excerpt' => :'String',
    
    :'link' => :'String',
    
    :'modified' => :'DateTime',
    
    :'name' => :'String',
    
    :'service' => :'Array<Integer>',
    
    :'slug' => :'String',
    
    :'title' => :'String',
    
    :'get_type' => :'String',
    
    :'facet_feature' => :'Array<Integer>',
    
    :'facet_role' => :'Array<Integer>',
    
    :'facet_service' => :'Array<Integer>',
    
    :'faq_categories' => :'Array<Integer>',
    
    :'releasenote_category' => :'Array<Integer>',
    
    :'releasenote_tag' => :'Array<Integer>',
    
    :'service_area' => :'Array<Integer>',
    
    :'video_categories' => :'Array<Integer>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 589

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      categories == o.categories &&
      description == o.description &&
      content == o.content &&
      excerpt == o.excerpt &&
      link == o.link &&
      modified == o.modified &&
      name == o.name &&
      service == o.service &&
      slug == o.slug &&
      title == o.title &&
      get_type == o.get_type &&
      facet_feature == o.facet_feature &&
      facet_role == o.facet_role &&
      facet_service == o.facet_service &&
      faq_categories == o.faq_categories &&
      releasenote_category == o.releasenote_category &&
      releasenote_tag == o.releasenote_tag &&
      service_area == o.service_area &&
      video_categories == o.video_categories
end

#_deserialize(type, value) ⇒ Object 



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 646

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



706
707
708
709
710
711
712
713
714
715
716
717
718
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 706

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



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 627

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


616
617
618
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 616

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



622
623
624
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 622

def hash
  [id, categories, description, content, excerpt, link, modified, name, service, slug, title, get_type, facet_feature, facet_role, facet_service, faq_categories, releasenote_category, releasenote_tag, service_area, video_categories].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



388
389
390
391
392
393
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 388

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



689
690
691
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 689

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



694
695
696
697
698
699
700
701
702
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 694

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 



684
685
686
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 684

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



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
 
# File 'lib/purecloudclient_v2a/models/documentation_result.rb', line 397

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

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end