Class: Twilio::REST::Api::V2010::AccountContext::ApplicationInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ ApplicationInstance

Initialize the ApplicationInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) (defaults to: nil) —

    The unique id of the Account that created this application.

  • sid (String) (defaults to: nil) —

    The application Sid that that uniquely identifies this resource



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 369

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'api_version' => payload['api_version'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'friendly_name' => payload['friendly_name'],
      'message_status_callback' => payload['message_status_callback'],
      'sid' => payload['sid'],
      'sms_fallback_method' => payload['sms_fallback_method'],
      'sms_fallback_url' => payload['sms_fallback_url'],
      'sms_method' => payload['sms_method'],
      'sms_status_callback' => payload['sms_status_callback'],
      'sms_url' => payload['sms_url'],
      'status_callback' => payload['status_callback'],
      'status_callback_method' => payload['status_callback_method'],
      'uri' => payload['uri'],
      'voice_caller_id_lookup' => payload['voice_caller_id_lookup'],
      'voice_fallback_method' => payload['voice_fallback_method'],
      'voice_fallback_url' => payload['voice_fallback_url'],
      'voice_method' => payload['voice_method'],
      'voice_url' => payload['voice_url'],
  }

  # Context
  @instance_context = nil
  @params = {
      'account_sid' => ,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns A string that uniquely identifies this resource.

Returns:

  • (String) —

    A string that uniquely identifies this resource



421
422
423
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 421

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The API version to use.

Returns:

  • (String) —

    The API version to use



427
428
429
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 427

def api_version
  @properties['api_version']
end

#context ⇒ ApplicationContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



408
409
410
411
412
413
414
415
416
417
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 408

def context
  unless @instance_context
    @instance_context = ApplicationContext.new(
        @version,
        @params['account_sid'],
        @params['sid'],
    )
  end
  @instance_context
end

#date_created ⇒ Time

Returns Date this resource was created.

Returns:

  • (Time) —

    Date this resource was created



433
434
435
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 433

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns Date this resource was last updated.

Returns:

  • (Time) —

    Date this resource was last updated



439
440
441
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 439

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ApplicationInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



542
543
544
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 542

def delete
  context.delete
end

#fetch ⇒ ApplicationInstance

Fetch a ApplicationInstance

Returns:



549
550
551
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 549

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns Human readable description of this resource.

Returns:

  • (String) —

    Human readable description of this resource



445
446
447
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 445

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



618
619
620
621
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 618

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.ApplicationInstance #{values}>"
end

#message_status_callback ⇒ String

Returns URL to make requests to with status updates.

Returns:

  • (String) —

    URL to make requests to with status updates



451
452
453
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 451

def message_status_callback
  @properties['message_status_callback']
end

#sid ⇒ String

Returns A string that uniquely identifies this resource.

Returns:

  • (String) —

    A string that uniquely identifies this resource



457
458
459
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 457

def sid
  @properties['sid']
end

#sms_fallback_method ⇒ String

Returns HTTP method to use with sms_fallback_method.

Returns:

  • (String) —

    HTTP method to use with sms_fallback_method



463
464
465
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 463

def sms_fallback_method
  @properties['sms_fallback_method']
end

#sms_fallback_url ⇒ String

Returns Fallback URL if there’s an error parsing TwiML.

Returns:

  • (String) —

    Fallback URL if there’s an error parsing TwiML



469
470
471
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 469

def sms_fallback_url
  @properties['sms_fallback_url']
end

#sms_method ⇒ String

Returns HTTP method to use with sms_url.

Returns:

  • (String) —

    HTTP method to use with sms_url



475
476
477
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 475

def sms_method
  @properties['sms_method']
end

#sms_status_callback ⇒ String

Returns URL Twilio with request with status updates.

Returns:

  • (String) —

    URL Twilio with request with status updates



481
482
483
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 481

def sms_status_callback
  @properties['sms_status_callback']
end

#sms_url ⇒ String

Returns URL Twilio will request when receiving an SMS.

Returns:

  • (String) —

    URL Twilio will request when receiving an SMS



487
488
489
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 487

def sms_url
  @properties['sms_url']
end

#status_callback ⇒ String

Returns URL to hit with status updates.

Returns:

  • (String) —

    URL to hit with status updates



493
494
495
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 493

def status_callback
  @properties['status_callback']
end

#status_callback_method ⇒ String

Returns HTTP method to use with the status callback.

Returns:

  • (String) —

    HTTP method to use with the status callback



499
500
501
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 499

def status_callback_method
  @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



611
612
613
614
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 611

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.ApplicationInstance #{values}>"
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 human readable descriptive text for this resource, up to 64 characters long.

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

    Requests to this application will start a new TwiML session with this API version.

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

    The URL Twilio will request when a phone number assigned to this application receives a call.

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

    The HTTP method Twilio will use when requesting the above ‘Url`. Either `GET` or `POST`.

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

    The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by ‘Url`.

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

    The HTTP method Twilio will use when requesting the ‘VoiceFallbackUrl`. Either `GET` or `POST`.

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

    The URL that Twilio will request to pass status parameters (such as call ended) to your application.

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

    The HTTP method Twilio will use to make requests to the ‘StatusCallback` URL. Either `GET` or `POST`.

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

    Look up the caller’s caller-ID name from the CNAM database (additional charges apply). Either ‘true` or `false`.

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

    The URL Twilio will request when a phone number assigned to this application receives an incoming SMS message.

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

    The HTTP method Twilio will use when making requests to the ‘SmsUrl`. Either `GET` or `POST`.

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

    The URL that Twilio will request if an error occurs retrieving or executing the TwiML from ‘SmsUrl`.

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

    The HTTP method Twilio will use when requesting the above URL. Either ‘GET` or `POST`.

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

    The URL that Twilio will ‘POST` to when a message is sent via the `/SMS/Messages` endpoint if you specify the `Sid` of this application on an outgoing SMS request.

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

    Twilio will make a ‘POST` request to this URL to pass status parameters (such as sent or failed) to your application if you use the `/Messages` endpoint to send the message and specify this application’s ‘Sid` as the `ApplicationSid` on an outgoing SMS request.

Returns:



589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 589

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)
  context.update(
      friendly_name: friendly_name,
      api_version: api_version,
      voice_url: voice_url,
      voice_method: voice_method,
      voice_fallback_url: voice_fallback_url,
      voice_fallback_method: voice_fallback_method,
      status_callback: status_callback,
      status_callback_method: status_callback_method,
      voice_caller_id_lookup: voice_caller_id_lookup,
      sms_url: sms_url,
      sms_method: sms_method,
      sms_fallback_url: sms_fallback_url,
      sms_fallback_method: sms_fallback_method,
      sms_status_callback: sms_status_callback,
      message_status_callback: message_status_callback,
  )
end

#uri ⇒ String

Returns URI for this resource.

Returns:

  • (String) —

    URI for this resource



505
506
507
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 505

def uri
  @properties['uri']
end

#voice_caller_id_lookup ⇒ Boolean

Returns True or False.

Returns:

  • (Boolean) —

    True or False



511
512
513
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 511

def voice_caller_id_lookup
  @properties['voice_caller_id_lookup']
end

#voice_fallback_method ⇒ String

Returns HTTP method to use with the fallback url.

Returns:

  • (String) —

    HTTP method to use with the fallback url



517
518
519
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 517

def voice_fallback_method
  @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

Returns Fallback URL.

Returns:

  • (String) —

    Fallback URL



523
524
525
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 523

def voice_fallback_url
  @properties['voice_fallback_url']
end

#voice_method ⇒ String

Returns HTTP method to use with the URL.

Returns:

  • (String) —

    HTTP method to use with the URL



529
530
531
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 529

def voice_method
  @properties['voice_method']
end

#voice_url ⇒ String

Returns URL Twilio will make requests to when relieving a call.

Returns:

  • (String) —

    URL Twilio will make requests to when relieving a call



535
536
537
 
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 535

def voice_url
  @properties['voice_url']
end