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



190
191
192
193
194
195
196
197
 
# 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



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

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

#create_with_metadata(knowledge_v1_service_create_knowledge_request: nil) ⇒ KnowledgeInstance

Create the KnowledgeInstanceMetadata



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 222

def create_with_metadata(knowledge_v1_service_create_knowledge_request: 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_v1_service_create_knowledge_request.to_json)
    knowledge_instance = KnowledgeInstance.new(
        @version,
        response.body,
    )
    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.



315
316
317
318
319
320
321
322
323
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 315

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.



354
355
356
357
358
359
360
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 354

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.



257
258
259
260
261
262
263
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 257

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

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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 297

def list_with_metadata(tags: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'Tags' => tags,
        
        '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(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.



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 333

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.



277
278
279
280
281
282
283
284
285
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 277

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



365
366
367
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 365

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