Class: Twilio::REST::Api::V2010::AccountContext::ApplicationList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/application.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ ApplicationList

Initialize the ApplicationList



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 22

def initialize(version, account_sid: nil)
  super(version)

  # Path Solution
  @solution = {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) ⇒ ApplicationInstance

Create the ApplicationInstance



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 65

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)
  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' => message_status_callback,
      'FriendlyName' => friendly_name,
  })

  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.



131
132
133
134
135
136
137
138
139
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 131

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.



168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 168

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.



102
103
104
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 102

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.



150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 150

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 ApplicationInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 119

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



178
179
180
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 178

def to_s
  '#<Twilio.Api.V2010.ApplicationList>'
end