Class: PureCloud::KnowledgeSearchRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KnowledgeSearchRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/purecloudplatformclientv2/models/knowledge_search_request.rb', line 79

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

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

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

  
end

Instance Attribute Details

#document_type ⇒ Object

Document type to be used while searching



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

def document_type
  @document_type
end

#language_code ⇒ Object

query search for specific languageCode



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

def language_code
  @language_code
end

#page_number ⇒ Object

Page number of the returned results



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

def page_number
  @page_number
end

#page_size ⇒ Object

Page size of the returned results



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

def page_size
  @page_size
end

#query ⇒ Object

Input query to search content in the knowledge base



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

def query
  @query
end

#search_on_draft_documents ⇒ Object

If true the search query will be executed on draft documents, else it will be on active documents



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

def search_on_draft_documents
  @search_on_draft_documents
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'query' => :'query',
    
    :'page_size' => :'pageSize',
    
    :'page_number' => :'pageNumber',
    
    :'document_type' => :'documentType',
    
    :'language_code' => :'languageCode',
    
    :'search_on_draft_documents' => :'searchOnDraftDocuments'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'query' => :'String',
    
    :'page_size' => :'Integer',
    
    :'page_number' => :'Integer',
    
    :'document_type' => :'String',
    
    :'language_code' => :'String',
    
    :'search_on_draft_documents' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
246
247
 
# File 'lib/purecloudplatformclientv2/models/knowledge_search_request.rb', line 238

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      query == o.query &&
      page_size == o.page_size &&
      page_number == o.page_number &&
      document_type == o.document_type &&
      language_code == o.language_code &&
      search_on_draft_documents == o.search_on_draft_documents
end

#_deserialize(type, value) ⇒ Object 



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

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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/purecloudplatformclientv2/models/knowledge_search_request.rb', line 341

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/purecloudplatformclientv2/models/knowledge_search_request.rb', line 262

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


251
252
253
 
# File 'lib/purecloudplatformclientv2/models/knowledge_search_request.rb', line 251

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



257
258
259
 
# File 'lib/purecloudplatformclientv2/models/knowledge_search_request.rb', line 257

def hash
  [query, page_size, page_number, document_type, language_code, search_on_draft_documents].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



144
145
146
147
148
149
 
# File 'lib/purecloudplatformclientv2/models/knowledge_search_request.rb', line 144

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



324
325
326
 
# File 'lib/purecloudplatformclientv2/models/knowledge_search_request.rb', line 324

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



329
330
331
332
333
334
335
336
337
 
# File 'lib/purecloudplatformclientv2/models/knowledge_search_request.rb', line 329

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 



319
320
321
 
# File 'lib/purecloudplatformclientv2/models/knowledge_search_request.rb', line 319

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



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

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

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

  
  
  
  
  
  
  
  
end