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

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

Defined Under Namespace

Classes: KnowledgeCore

Instance Method Summary collapse

Constructor Details

#initialize(version, kb_id: nil) ⇒ KnowledgeList

Initialize the KnowledgeList

Parameters:

  • version (Version) —

    Version that contains the resource



46
47
48
49
50
51
52
53
54
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 46

def initialize(version, kb_id: nil)
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)
    # Path Solution
    @solution = { kb_id: kb_id }
    @uri = "/KnowledgeBases/#{@solution[:kb_id]}/Knowledge"
    
end

Instance Method Details

#create(knowledge_core: nil) ⇒ KnowledgeInstance

Create the KnowledgeInstance

Parameters:

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 59

def create(knowledge_core: nil
)

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

#create_with_metadata(knowledge_core: nil) ⇒ KnowledgeInstance

Create the KnowledgeInstanceMetadata

Parameters:

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 80

def create_with_metadata(knowledge_core: nil
)

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

#each ⇒ Object

When passed a block, yields KnowledgeInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 184

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of KnowledgeInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of KnowledgeInstance



225
226
227
228
229
230
231
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 225

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
KnowledgePage.new(@version, response, @solution)
end

#list(page: :unset, page_token: :unset, limit: nil, page_size: nil) ⇒ Array

Lists KnowledgeInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

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

    The page index. This value is simply for client state.

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

    The token for the page of results to retrieve.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



117
118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 117

def list(page: :unset, page_token: :unset, limit: nil, page_size: nil)
    self.stream(
        page: page,
        page_token: page_token,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(page: :unset, page_token: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 165

def list_with_metadata(page: :unset, page_token: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'page' => page,
        'pageToken' => page_token,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    KnowledgePageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(page: :unset, page_token: :unset, page_size: :unset) ⇒ Page

Returns Page of KnowledgeInstance.

Returns:

  • (Page) —

    Page of KnowledgeInstance



205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 205

def page(page: :unset, page_token: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'page' => page,
        'pageToken' => page_token,
                                    'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    KnowledgePage.new(@version, response, @solution)
end

#stream(page: :unset, page_token: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

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

    The page index. This value is simply for client state.

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

    The token for the page of results to retrieve.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 139

def stream(page: :unset, page_token: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        page: page,
        page_token: page_token,
        page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



236
237
238
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge.rb', line 236

def to_s
    '#<Twilio.Knowledge.V2.KnowledgeList>'
end