Class: Twilio::REST::Knowledge::V1::KnowledgeList

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

Defined Under Namespace

Classes: KnowledgeV1ServiceCreateKnowledgeRequest, KnowledgeV1ServiceCreatePolicyRequest, KnowledgeV1ServiceUpdateKnowledgeRequest

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ KnowledgeList

Initialize the KnowledgeList

Parameters:

  • version (Version) —

    Version that contains the resource



190
191
192
193
194
195
196
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 190

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/Knowledge"
    
end

Instance Method Details

#create(knowledge_v1_service_create_knowledge_request: nil) ⇒ KnowledgeInstance

Create the KnowledgeInstance

Parameters:

Returns:



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 201

def create(knowledge_v1_service_create_knowledge_request: 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_v1_service_create_knowledge_request.to_json)
    KnowledgeInstance.new(
        @version,
        payload,
    )
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.



264
265
266
267
268
269
270
271
272
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 264

def each
    limits = @version.read_limits

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

    @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit]).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



303
304
305
306
307
308
309
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 303

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

#list(tags: :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:

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

    Json array of tag and value pairs for tag filtering.

  • 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



230
231
232
233
234
235
236
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 230

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

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

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

Parameters:

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

    Json array of tag and value pairs for tag filtering.

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

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

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

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of KnowledgeInstance



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

def page(tags: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'Tags' => tags,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(tags: :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:

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

    Json array of tag and value pairs for tag filtering.

  • 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



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

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

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

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



314
315
316
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 314

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