Class: Twilio::REST::Numbers::V2::ApplicationList

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

Defined Under Namespace

Classes: CreateShortCodeApplicationRequest, CreateShortCodeApplicationRequestBusinessInformation, CreateShortCodeApplicationRequestSetup

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ ApplicationList

Initialize the ApplicationList



75
76
77
78
79
80
81
82
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 75

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

Instance Method Details

#create(create_short_code_application_request: nil) ⇒ ApplicationInstance

Create the ApplicationInstance



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 87

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

#create_with_metadata(create_short_code_application_request: nil) ⇒ ApplicationInstance

Create the ApplicationInstanceMetadata



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 107

def create_with_metadata(create_short_code_application_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: create_short_code_application_request.to_json)
    application_instance = ApplicationInstance.new(
        @version,
        response.body,
    )
    ApplicationInstanceMetadata.new(
        @version,
        application_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



194
195
196
197
198
199
200
201
202
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 194

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



231
232
233
234
235
236
237
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 231

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

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

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



141
142
143
144
145
146
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 141

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

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

Lists ApplicationPageMetadata records from the API as a list.



177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 177

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

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

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

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

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 211

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

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

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

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



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

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

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



242
243
244
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 242

def to_s
    '#<Twilio.Numbers.V2.ApplicationList>'
end