Class: Twilio::REST::Api::V2010::AccountContext::ApplicationContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ ApplicationContext

Initialize the ApplicationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The SID of the Account that created the Application resource to fetch.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Application resource to fetch.


222
223
224
225
226
227
228
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 222

def initialize(version, , sid)
  super(version)

  # Path Solution
  @solution = {account_sid: , sid: sid, }
  @uri = "/Accounts/#{@solution[:account_sid]}/Applications/#{@solution[:sid]}.json"
end

Instance Method Details

#delete ⇒ Boolean

Delete the ApplicationInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


233
234
235
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 233

def delete
   @version.delete('DELETE', @uri)
end

#fetch ⇒ ApplicationInstance

Fetch the ApplicationInstance

Returns:


240
241
242
243
244
245
246
247
248
249
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 240

def fetch
  payload = @version.fetch('GET', @uri)

  ApplicationInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


325
326
327
328
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 325

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Api.V2010.ApplicationContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation


318
319
320
321
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 318

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Api.V2010.ApplicationContext #{context}>"
end

#update(friendly_name: :unset, 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) ⇒ ApplicationInstance

Update the ApplicationInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

  • api_version (String) (defaults to: :unset) —

    The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`. The default value is your account's default API version.

  • voice_url (String) (defaults to: :unset) —

    The URL we should call when the phone number assigned to this application receives a call.

  • voice_method (String) (defaults to: :unset) —

    The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.

  • voice_fallback_url (String) (defaults to: :unset) —

    The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.

  • voice_fallback_method (String) (defaults to: :unset) —

    The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.

  • status_callback (String) (defaults to: :unset) —

    The URL we should call using the `status_callback_method` to send status information to your application.

  • status_callback_method (String) (defaults to: :unset) —

    The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`.

  • voice_caller_id_lookup (Boolean) (defaults to: :unset) —

    Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`.

  • sms_url (String) (defaults to: :unset) —

    The URL we should call when the phone number receives an incoming SMS message.

  • sms_method (String) (defaults to: :unset) —

    The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`.

  • sms_fallback_url (String) (defaults to: :unset) —

    The URL that we should call when an error occurs while retrieving or executing the TwiML from `sms_url`.

  • sms_fallback_method (String) (defaults to: :unset) —

    The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`.

  • sms_status_callback (String) (defaults to: :unset) —

    Same as message_status_callback: The URL we should call using a POST method to send status information about SMS messages sent by the application. Deprecated, included for backwards compatibility.

  • message_status_callback (String) (defaults to: :unset) —

    The URL we should call using a POST method to send message status information to your application.

Returns:


287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 287

def update(friendly_name: :unset, 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)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      '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,
  })

  payload = @version.update('POST', @uri, data: data)

  ApplicationInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end