Class: PureCloud::KnowledgeDocument

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KnowledgeDocument

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

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
212
213
214
215
216
217
218
219
220
221
# File 'lib/purecloudplatformclientv2/models/knowledge_document.rb', line 113

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

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

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

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

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

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

  
end

Instance Attribute Details

#categoriesObject

Document categories


42
43
44
# File 'lib/purecloudplatformclientv2/models/knowledge_document.rb', line 42

def categories
  @categories
end

#date_createdObject

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


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

def date_created
  @date_created
end

#date_modifiedObject

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


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

def date_modified
  @date_modified
end

#external_urlObject

External URL to the document


48
49
50
# File 'lib/purecloudplatformclientv2/models/knowledge_document.rb', line 48

def external_url
  @external_url
end

#faqObject

FAQ document details


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

def faq
  @faq
end

#idObject

The globally unique identifier for the object.


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

def id
  @id
end

#knowledge_baseObject

Knowledge base which document does belong to


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

def knowledge_base
  @knowledge_base
end

#language_codeObject

Language of the document


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

def language_code
  @language_code
end

#nameObject

Returns the value of attribute name.


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

def name
  @name
end

#self_uriObject

The URI for this object


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

def self_uri
  @self_uri
end

#typeObject

Document type


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

def type
  @type
end

Class Method Details

.attribute_mapObject

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

[View source]

54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/purecloudplatformclientv2/models/knowledge_document.rb', line 54

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'language_code' => :'languageCode',
    
    :'type' => :'type',
    
    :'faq' => :'faq',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'categories' => :'categories',
    
    :'knowledge_base' => :'knowledgeBase',
    
    :'external_url' => :'externalUrl',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_typesObject

Attribute type mapping.

[View source]

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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'language_code' => :'String',
    
    :'type' => :'String',
    
    :'faq' => :'DocumentFaq',
    
    :'date_created' => :'DateTime',
    
    :'date_modified' => :'DateTime',
    
    :'categories' => :'Array<KnowledgeCategory>',
    
    :'knowledge_base' => :'KnowledgeBase',
    
    :'external_url' => :'String',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared

[View source]

378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'lib/purecloudplatformclientv2/models/knowledge_document.rb', line 378

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      language_code == o.language_code &&
      type == o.type &&
      faq == o.faq &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      categories == o.categories &&
      knowledge_base == o.knowledge_base &&
      external_url == o.external_url &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object

[View source]

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

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

[View source]

486
487
488
489
490
491
492
493
494
495
496
497
498
# File 'lib/purecloudplatformclientv2/models/knowledge_document.rb', line 486

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

[View source]

407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
# File 'lib/purecloudplatformclientv2/models/knowledge_document.rb', line 407

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
[View source]

396
397
398
# File 'lib/purecloudplatformclientv2/models/knowledge_document.rb', line 396

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code

[View source]

402
403
404
# File 'lib/purecloudplatformclientv2/models/knowledge_document.rb', line 402

def hash
  [id, name, language_code, type, faq, date_created, date_modified, categories, knowledge_base, external_url, self_uri].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons

[View source]

225
226
227
228
229
230
# File 'lib/purecloudplatformclientv2/models/knowledge_document.rb', line 225

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))

[View source]

469
470
471
# File 'lib/purecloudplatformclientv2/models/knowledge_document.rb', line 469

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash

[View source]

474
475
476
477
478
479
480
481
482
# File 'lib/purecloudplatformclientv2/models/knowledge_document.rb', line 474

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_sObject

[View source]

464
465
466
# File 'lib/purecloudplatformclientv2/models/knowledge_document.rb', line 464

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

[View source]

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

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

  
  
  allowed_values = ["en-US"]
  if @language_code && !allowed_values.include?(@language_code)
    return false
  end
  
  
  
  
  if @type.nil?
    return false
  end

  
  
  allowed_values = ["Faq"]
  if @type && !allowed_values.include?(@type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end