Class: Twilio::REST::Intelligence::V2::PrebuiltOperatorList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ PrebuiltOperatorList

Initialize the PrebuiltOperatorList



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/intelligence/v2/prebuilt_operator.rb', line 26

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

Instance Method Details

#each ⇒ Object

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



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/twilio-ruby/rest/intelligence/v2/prebuilt_operator.rb', line 115

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



160
161
162
163
164
165
166
 
# File 'lib/twilio-ruby/rest/intelligence/v2/prebuilt_operator.rb', line 160

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

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

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



48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/intelligence/v2/prebuilt_operator.rb', line 48

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

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/twilio-ruby/rest/intelligence/v2/prebuilt_operator.rb', line 96

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

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

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

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

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



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

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

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

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

#stream(availability: :unset, language_code: :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.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/intelligence/v2/prebuilt_operator.rb', line 70

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

    page = self.page(
        availability: availability,
        language_code: language_code,
        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



171
172
173
 
# File 'lib/twilio-ruby/rest/intelligence/v2/prebuilt_operator.rb', line 171

def to_s
    '#<Twilio.Intelligence.V2.PrebuiltOperatorList>'
end