Class: Twilio::REST::Knowledge::V1::KnowledgeInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, id: nil) ⇒ KnowledgeInstance

Initialize the KnowledgeInstance



696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 696

def initialize(version, payload , id: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'description' => payload['description'],
        'id' => payload['id'],
        'account_sid' => payload['account_sid'],
        'knowledge_source_details' => payload['knowledge_source_details'],
        'name' => payload['name'],
        'status' => payload['status'],
        'type' => payload['type'],
        'url' => payload['url'],
        'embedding_model' => payload['embedding_model'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
    }

    # Context
    @instance_context = nil
    @params = { 'id' => id  || @properties['id']  , }
end

Instance Method Details

#account_sid ⇒ String 



745
746
747
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 745

def 
    @properties['account_sid']
end

#chunks ⇒ chunks

Access the chunks



827
828
829
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 827

def chunks
    context.chunks
end

#context ⇒ KnowledgeContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context



724
725
726
727
728
729
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 724

def context
    unless @instance_context
        @instance_context = KnowledgeContext.new(@version , @params['id'])
    end
    @instance_context
end

#date_created ⇒ Time 



787
788
789
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 787

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



793
794
795
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 793

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the KnowledgeInstance



800
801
802
803
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 800

def delete

    context.delete
end

#description ⇒ String 



733
734
735
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 733

def description
    @properties['description']
end

#embedding_model ⇒ String 



781
782
783
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 781

def embedding_model
    @properties['embedding_model']
end

#fetch ⇒ KnowledgeInstance

Fetch the KnowledgeInstance



808
809
810
811
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 808

def fetch

    context.fetch
end

#id ⇒ String 



739
740
741
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 739

def id
    @properties['id']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



847
848
849
850
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 847

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Knowledge.V1.KnowledgeInstance #{values}>"
end

#knowledge_source_details ⇒ Hash 



751
752
753
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 751

def knowledge_source_details
    @properties['knowledge_source_details']
end

#knowledge_status ⇒ knowledge_status

Access the knowledge_status



834
835
836
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 834

def knowledge_status
    context.knowledge_status
end

#name ⇒ String 



757
758
759
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 757

def name
    @properties['name']
end

#status ⇒ String 



763
764
765
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 763

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



840
841
842
843
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 840

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Knowledge.V1.KnowledgeInstance #{values}>"
end

#type ⇒ String 



769
770
771
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 769

def type
    @properties['type']
end

#update(knowledge_v1_service_update_knowledge_request: :unset) ⇒ KnowledgeInstance

Update the KnowledgeInstance



817
818
819
820
821
822
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 817

def update(knowledge_v1_service_update_knowledge_request: :unset
)

    context.update(
    )
end

#url ⇒ String 



775
776
777
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 775

def url
    @properties['url']
end