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

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

Defined Under Namespace

Classes: KnowledgeBaseCore, UpdateKnowledgeBaseRequest

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ KnowledgeBasisList

Initialize the KnowledgeBasisList

Parameters:

  • version (Version) —

    Version that contains the resource



92
93
94
95
96
97
98
99
100
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge_basis.rb', line 92

def initialize(version)
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)
    # Path Solution
    @solution = {  }
    @uri = "/ControlPlane/KnowledgeBases"
    
end

Instance Method Details

#create(knowledge_base_core: nil) ⇒ KnowledgeBasisInstance

Create the KnowledgeBasisInstance

Parameters:

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge_basis.rb', line 105

def create(knowledge_base_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_base_core.to_json)
    KnowledgeBasisInstance.new(
        @version,
        payload,
    )
end

#create_with_metadata(knowledge_base_core: nil) ⇒ KnowledgeBasisInstance

Create the KnowledgeBasisInstanceMetadata

Parameters:

Returns:



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge_basis.rb', line 125

def create_with_metadata(knowledge_base_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_base_core.to_json)
    knowledge_basis_instance = KnowledgeBasisInstance.new(
        @version,
        response.body,
    )
    KnowledgeBasisInstanceMetadata.new(
        @version,
        knowledge_basis_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge_basis.rb', line 228

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 KnowledgeBasisInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of KnowledgeBasisInstance



269
270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge_basis.rb', line 269

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

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

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

Parameters:

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

    The token for the page of results to retrieve.

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

    Either ‘ASC’ or ‘DESC’ to sort results ascending or descending respectively.

  • 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



161
162
163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge_basis.rb', line 161

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

#list_with_metadata(page_token: :unset, order_by: :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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge_basis.rb', line 209

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

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

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

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

Returns Page of KnowledgeBasisInstance.

Returns:

  • (Page) —

    Page of KnowledgeBasisInstance



249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge_basis.rb', line 249

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

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

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

#stream(page_token: :unset, order_by: :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_token (String) (defaults to: :unset) —

    The token for the page of results to retrieve.

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

    Either ‘ASC’ or ‘DESC’ to sort results ascending or descending respectively.

  • 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



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

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

    page = self.page(
        page_token: page_token,
        order_by: order_by,
        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



280
281
282
 
# File 'lib/twilio-ruby/rest/knowledge/v2/knowledge_basis.rb', line 280

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