Class: Twilio::REST::Knowledge::V1::KnowledgeContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, id) ⇒ KnowledgeContext

Initialize the KnowledgeContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • id (String) 


377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 377

def initialize(version, id)
    super(version)
    

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

    # Dependents
    @chunks = nil
    @knowledge_status = nil
end

Instance Method Details

#chunks ⇒ ChunkList, ChunkContext

Access the chunks

Returns:

  • (ChunkList)
  • (ChunkContext) 


517
518
519
520
521
522
523
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 517

def chunks
  unless @chunks
    @chunks = ChunkList.new(
            @version, )
  end
  @chunks
end

#delete ⇒ Boolean

Delete the KnowledgeInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



392
393
394
395
396
397
398
399
400
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 392

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the KnowledgeInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 405

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:



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 424

def fetch

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

#fetch_with_metadata ⇒ KnowledgeInstance

Fetch the KnowledgeInstanceMetadata

Returns:



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 443

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,
        id: @solution[:id],
    )
    KnowledgeInstanceMetadata.new(
        @version,
        knowledge_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



544
545
546
547
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 544

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

#knowledge_status ⇒ KnowledgeStatusList, KnowledgeStatusContext

Access the knowledge_status

Returns:

  • (KnowledgeStatusList)
  • (KnowledgeStatusContext) 


528
529
530
531
532
533
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 528

def knowledge_status
    KnowledgeStatusContext.new(
            @version,
            @solution[:id]
            )
end

#to_s ⇒ Object

Provide a user friendly representation



537
538
539
540
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 537

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

#update(knowledge_v1_service_update_knowledge_request: :unset) ⇒ KnowledgeInstance

Update the KnowledgeInstance

Parameters:

  • knowledge_v1_service_update_knowledge_request (KnowledgeV1ServiceUpdateKnowledgeRequest) (defaults to: :unset)

Returns:



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 469

def update(knowledge_v1_service_update_knowledge_request: :unset
)

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

#update_with_metadata(knowledge_v1_service_update_knowledge_request: :unset) ⇒ KnowledgeInstance

Update the KnowledgeInstanceMetadata

Parameters:

  • knowledge_v1_service_update_knowledge_request (KnowledgeV1ServiceUpdateKnowledgeRequest) (defaults to: :unset)

Returns:



490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 490

def update_with_metadata(knowledge_v1_service_update_knowledge_request: :unset
)

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