Class: Twilio::REST::Intelligence::V3::OperatorList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/intelligence/v3/operator.rb

Defined Under Namespace

Classes: LanguageOperator, OperatorContextKnowledge, OperatorContextMemory

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ OperatorList

Initialize the OperatorList

Parameters:

  • version (Version) —

    Version that contains the resource



96
97
98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/intelligence/v3/operator.rb', line 96

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

Instance Method Details

#create(language_operator: nil) ⇒ OperatorInstance

Create the OperatorInstance

Parameters:

  • language_operator (LanguageOperator) (defaults to: nil) —

    Create Language Operator request

Returns:



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/twilio-ruby/rest/intelligence/v3/operator.rb', line 109

def create(language_operator: 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: language_operator.to_json)
    OperatorInstance.new(
        @version,
        payload,
    )
end

#create_with_metadata(language_operator: nil) ⇒ OperatorInstance

Create the OperatorInstanceMetadata

Parameters:

  • language_operator (LanguageOperator) (defaults to: nil) —

    Create Language Operator request

Returns:



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/twilio-ruby/rest/intelligence/v3/operator.rb', line 129

def create_with_metadata(language_operator: 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: language_operator.to_json)
    operator_instance = OperatorInstance.new(
        @version,
        response.body,
    )
    OperatorInstanceMetadata.new(
        @version,
        operator_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/twilio-ruby/rest/intelligence/v3/operator.rb', line 226

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of OperatorInstance



265
266
267
268
269
270
271
 
# File 'lib/twilio-ruby/rest/intelligence/v3/operator.rb', line 265

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

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

Lists OperatorInstance 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) —

    Token for pagination

  • 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



164
165
166
167
168
169
170
 
# File 'lib/twilio-ruby/rest/intelligence/v3/operator.rb', line 164

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

#list_with_metadata(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



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/twilio-ruby/rest/intelligence/v3/operator.rb', line 208

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

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

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

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

Returns Page of OperatorInstance.

Returns:

  • (Page) —

    Page of OperatorInstance



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/twilio-ruby/rest/intelligence/v3/operator.rb', line 246

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

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

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

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

    Token for pagination

  • 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



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

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

    page = self.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



276
277
278
 
# File 'lib/twilio-ruby/rest/intelligence/v3/operator.rb', line 276

def to_s
    '#<Twilio.Intelligence.V3.OperatorList>'
end