Class: Twilio::REST::Api::V2010::AccountContext::ApplicationList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Api::V2010::AccountContext::ApplicationList
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/application.rb
Instance Method Summary collapse
-
#create(api_version: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, voice_caller_id_lookup: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset, sms_status_callback: :unset, message_status_callback: :unset, friendly_name: :unset, public_application_connect_enabled: :unset) ⇒ ApplicationInstance
Create the ApplicationInstance.
-
#each ⇒ Object
When passed a block, yields ApplicationInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of ApplicationInstance records from the API.
-
#initialize(version, account_sid: nil) ⇒ ApplicationList
constructor
Initialize the ApplicationList.
-
#list(friendly_name: :unset, limit: nil, page_size: nil) ⇒ Array
Lists ApplicationInstance records from the API as a list.
-
#page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ApplicationInstance records from the API.
-
#stream(friendly_name: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, account_sid: nil) ⇒ ApplicationList
Initialize the ApplicationList
27 28 29 30 31 32 33 |
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 27 def initialize(version, account_sid: nil) super(version) # Path Solution @solution = { account_sid: account_sid } @uri = "/Accounts/#{@solution[:account_sid]}/Applications.json" end |
Instance Method Details
#create(api_version: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, voice_caller_id_lookup: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset, sms_status_callback: :unset, message_status_callback: :unset, friendly_name: :unset, public_application_connect_enabled: :unset) ⇒ ApplicationInstance
Create the ApplicationInstance
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 53 def create( api_version: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, voice_caller_id_lookup: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset, sms_status_callback: :unset, message_status_callback: :unset, friendly_name: :unset, public_application_connect_enabled: :unset ) data = Twilio::Values.of({ 'ApiVersion' => api_version, 'VoiceUrl' => voice_url, 'VoiceMethod' => voice_method, 'VoiceFallbackUrl' => voice_fallback_url, 'VoiceFallbackMethod' => voice_fallback_method, 'StatusCallback' => status_callback, 'StatusCallbackMethod' => status_callback_method, 'VoiceCallerIdLookup' => voice_caller_id_lookup, 'SmsUrl' => sms_url, 'SmsMethod' => sms_method, 'SmsFallbackUrl' => sms_fallback_url, 'SmsFallbackMethod' => sms_fallback_method, 'SmsStatusCallback' => sms_status_callback, 'MessageStatusCallback' => , 'FriendlyName' => friendly_name, 'PublicApplicationConnectEnabled' => public_application_connect_enabled, }) payload = @version.create('POST', @uri, data: data) ApplicationInstance.new( @version, payload, account_sid: @solution[:account_sid], ) 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.
146 147 148 149 150 151 152 153 154 |
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 146 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.
182 183 184 185 186 187 188 |
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 182 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) ApplicationPage.new(@version, response, @solution) end |
#list(friendly_name: :unset, 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.
112 113 114 115 116 117 118 |
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 112 def list(friendly_name: :unset, limit: nil, page_size: nil) self.stream( friendly_name: friendly_name, limit: limit, page_size: page_size ).entries end |
#page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ApplicationInstance records from the API. Request is executed immediately.
164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 164 def page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'FriendlyName' => friendly_name, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) ApplicationPage.new(@version, response, @solution) end |
#stream(friendly_name: :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.
132 133 134 135 136 137 138 139 140 |
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 132 def stream(friendly_name: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( friendly_name: friendly_name, 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
193 194 195 |
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 193 def to_s '#<Twilio.Api.V2010.ApplicationList>' end |