Class: Twilio::REST::Knowledge::V2::KnowledgeContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/knowledge/v2/knowledge.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, kb_id, knowledge_id) ⇒ KnowledgeContext

Initialize the KnowledgeContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • kb_id (String) —

    A unique Knowledge Base ID using Twilio Type ID (TTID) format

  • knowledge_id (String) —

    A unique Knowledge resource ID using Twilio Type ID (TTID) format



249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 249

def initialize(version, kb_id, knowledge_id)
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)

    # Path Solution
    @solution = { kb_id: kb_id, knowledge_id: knowledge_id,  }
    @uri = "/KnowledgeBases/#{@solution[:kb_id]}/Knowledge/#{@solution[:knowledge_id]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the KnowledgeInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 263

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
    KnowledgeInstance.new(
      @version,
      response.body,
        kb_id: @solution[:kb_id],
        knowledge_id: @solution[:knowledge_id],
    )
    
end

#delete_with_metadata ⇒ Boolean

Delete the KnowledgeInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 282

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      knowledge_instance = KnowledgeInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      KnowledgeInstanceMetadata.new(@version, knowledge_instance, response.headers, response.status_code)
end

#fetch ⇒ KnowledgeInstance

Fetch the KnowledgeInstance

Returns:



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 301

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    KnowledgeInstance.new(
        @version,
        payload,
        kb_id: @solution[:kb_id],
        knowledge_id: @solution[:knowledge_id],
    )
end

#fetch_with_metadata ⇒ KnowledgeInstance

Fetch the KnowledgeInstanceMetadata

Returns:



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 321

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    knowledge_instance = KnowledgeInstance.new(
        @version,
        response.body,
        kb_id: @solution[:kb_id],
        knowledge_id: @solution[:knowledge_id],
    )
    KnowledgeInstanceMetadata.new(
        @version,
        knowledge_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



416
417
418
419
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 416

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Knowledge.V2.KnowledgeContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



409
410
411
412
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 409

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Knowledge.V2.KnowledgeContext #{context}>"
end

#update(refresh: :unset, knowledge_core: :unset) ⇒ KnowledgeInstance

Update the KnowledgeInstance

Parameters:

  • refresh (Boolean) (defaults to: :unset) —

    When true, re-queues processing for this knowledge resource. Idempotent while the resource is already QUEUED or PROCESSING.

  • knowledge_core (KnowledgeCore) (defaults to: :unset)

Returns:



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 349

def update(
  refresh: :unset,
  knowledge_core: :unset
)

    params = Twilio::Values.of({
        'refresh' => refresh,
    })
    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    payload = @version.update('PATCH', @uri, params: params, headers: headers, data: knowledge_core.to_json)
    KnowledgeInstance.new(
        @version,
        payload,
        kb_id: @solution[:kb_id],
        knowledge_id: @solution[:knowledge_id],
    )
end

#update_with_metadata(refresh: :unset, knowledge_core: :unset) ⇒ KnowledgeInstance

Update the KnowledgeInstanceMetadata

Parameters:

  • refresh (Boolean) (defaults to: :unset) —

    When true, re-queues processing for this knowledge resource. Idempotent while the resource is already QUEUED or PROCESSING.

  • knowledge_core (KnowledgeCore) (defaults to: :unset)

Returns:



377
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
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 377

def update_with_metadata(
  refresh: :unset,
knowledge_core: :unset
)

    params = Twilio::Values.of({
        'refresh' => refresh,
    })
    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    response = @version.update_with_metadata('PATCH', @uri, params: params, headers: headers, data: knowledge_core.to_json)
    knowledge_instance = KnowledgeInstance.new(
        @version,
        response.body,
        kb_id: @solution[:kb_id],
        knowledge_id: @solution[:knowledge_id],
    )
    KnowledgeInstanceMetadata.new(
        @version,
        knowledge_instance,
        response.headers,
        response.status_code
    )
end