Class: Twilio::REST::Intelligence::V2::OperatorList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ OperatorList

Initialize the OperatorList



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

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

Instance Method Details

#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.



111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 111

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



152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 152

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

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



48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/intelligence/v2/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 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 92

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)

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



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

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)

    OperatorPage.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
 
# File 'lib/twilio-ruby/rest/intelligence/v2/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], )

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

#to_s ⇒ Object

Provide a user friendly representation



163
164
165
 
# File 'lib/twilio-ruby/rest/intelligence/v2/operator.rb', line 163

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