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

Inherits:
Version
  • Object
show all
Defined in:
lib/twilio-ruby/rest/knowledge/v2.rb,
lib/twilio-ruby/rest/knowledge/v2/chunk.rb,
lib/twilio-ruby/rest/knowledge/v2/search.rb,
lib/twilio-ruby/rest/knowledge/v2/knowledge.rb,
lib/twilio-ruby/rest/knowledge/v2/operation.rb,
lib/twilio-ruby/rest/knowledge/v2/knowledge_basis.rb

Defined Under Namespace

Classes: ChunkInstance, ChunkList, ChunkListResponse, ChunkPage, ChunkPageMetadata, KnowledgeBasisContext, KnowledgeBasisInstance, KnowledgeBasisInstanceMetadata, KnowledgeBasisList, KnowledgeBasisListResponse, KnowledgeBasisPage, KnowledgeBasisPageMetadata, KnowledgeContext, KnowledgeInstance, KnowledgeInstanceMetadata, KnowledgeList, KnowledgeListResponse, KnowledgePage, KnowledgePageMetadata, OperationContext, OperationInstance, OperationInstanceMetadata, OperationList, OperationListResponse, OperationPage, OperationPageMetadata, SearchContext, SearchInstance, SearchInstanceMetadata, SearchList, SearchListResponse, SearchPage, SearchPageMetadata

Instance Attribute Summary

Attributes inherited from Version

#domain, #version

Instance Method Summary collapse

Methods inherited from Version

#absolute_url, #create, #create_with_metadata, #delete, #delete_with_metadata, #exception, #fetch, #fetch_with_metadata, #page, #patch, #read_limits, #relative_uri, #request, #stream, #stream_with_metadata, #update, #update_with_metadata

Constructor Details

#initialize(domain) ⇒ V2

Initialize the V2 version of Knowledge



21
22
23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/knowledge/v2.rb', line 21

def initialize(domain)
    super
    @version = 'v2'
    @chunks = nil
    @knowledge = nil
    @knowledge_bases = nil
    @operations = nil
    @search = nil
end

Instance Method Details

#chunks(kb_id = :unset, knowledge_id = :unset) ⇒ Twilio::REST::Knowledge::V2::ChunkList

Parameters:

  • kb_id (String) (defaults to: :unset) —

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

  • knowledge_id (String) (defaults to: :unset) —

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

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/twilio-ruby/rest/knowledge/v2.rb', line 35

def chunks(kb_id=:unset, knowledge_id=:unset)
    if kb_id.nil?
        raise ArgumentError, 'kb_id cannot be nil'
    end
    if knowledge_id.nil?
        raise ArgumentError, 'knowledge_id cannot be nil'
    end

    if kb_id == :unset && knowledge_id == :unset
        @chunks ||= ChunkList.new self
    elsif kb_id != :unset && knowledge_id == :unset
        ChunkList.new(self, kb_id: kb_id)
    else
        ChunkList.new(self, kb_id: kb_id, knowledge_id: knowledge_id)
    end
end

#knowledge(kb_id = :unset, knowledge_id = :unset) ⇒ Twilio::REST::Knowledge::V2::KnowledgeContext, Twilio::REST::Knowledge::V2::KnowledgeList

Parameters:

  • kb_id (String) (defaults to: :unset) —

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

  • knowledge_id (String) (defaults to: :unset)

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/twilio-ruby/rest/knowledge/v2.rb', line 76

def knowledge(kb_id=:unset, knowledge_id=:unset)
    if kb_id.nil?
        raise ArgumentError, 'kb_id cannot be nil'
    end
    if knowledge_id.nil?
        raise ArgumentError, 'knowledge_id cannot be nil'
    end

    if kb_id == :unset && knowledge_id == :unset
        @knowledge ||= KnowledgeList.new self
    elsif kb_id != :unset && knowledge_id == :unset
        KnowledgeList.new(self, kb_id: kb_id)
    else
        KnowledgeContext.new(self, kb_id, knowledge_id)
    end
end

#knowledge_bases(kb_id = :unset) ⇒ Twilio::REST::Knowledge::V2::KnowledgeBasisContext, Twilio::REST::Knowledge::V2::KnowledgeBasisList

Parameters:

  • kb_id (String) (defaults to: :unset) —

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

Returns:



96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/knowledge/v2.rb', line 96

def knowledge_bases(kb_id=:unset)
    if kb_id.nil?
        raise ArgumentError, 'kb_id cannot be nil'
    end

    if kb_id == :unset
        @knowledge_bases ||= KnowledgeBasisList.new self
    else
        KnowledgeBasisContext.new(self, kb_id)
    end
end

#operations(operation_id = :unset) ⇒ Twilio::REST::Knowledge::V2::OperationContext, Twilio::REST::Knowledge::V2::OperationList

Parameters:

  • operation_id (String) (defaults to: :unset) —

    The operation ID returned from a write endpoint.

Returns:



111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/knowledge/v2.rb', line 111

def operations(operation_id=:unset)
    if operation_id.nil?
        raise ArgumentError, 'operation_id cannot be nil'
    end

    if operation_id == :unset
        @operations ||= OperationList.new self
    else
        OperationContext.new(self, operation_id)
    end
end

#search(kb_id = :unset) ⇒ Twilio::REST::Knowledge::V2::SearchContext, Twilio::REST::Knowledge::V2::SearchList

Parameters:

  • kb_id (String) (defaults to: :unset) —

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

Returns:



126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/knowledge/v2.rb', line 126

def search(kb_id=:unset)
    if kb_id.nil?
        raise ArgumentError, 'kb_id cannot be nil'
    end

    if kb_id == :unset
        @search ||= SearchList.new self
    else
        SearchContext.new(self, kb_id)
    end
end

#to_s ⇒ Object

Provide a user friendly representation



139
140
141
 
# File 'lib/twilio-ruby/rest/knowledge/v2.rb', line 139

def to_s
    '<Twilio::REST::Knowledge::V2>';
end