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 SID of the Account that created the Application resource.

  • sid (String) (defaults to: nil)

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


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 342

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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


387
388
389
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 387

def 
  @properties['account_sid']
end

#api_versionString

Returns The API version used to start a new TwiML session.

Returns:

  • (String)

    The API version used to start a new TwiML session


393
394
395
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 393

def api_version
  @properties['api_version']
end

#contextApplicationContext

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

Returns:


378
379
380
381
382
383
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 378

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

#date_createdTime

Returns The RFC 2822 date and time in GMT that the resource was created.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT that the resource was created


399
400
401
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 399

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The RFC 2822 date and time in GMT that the resource was last updated.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT that the resource was last updated


405
406
407
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 405

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the ApplicationInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


508
509
510
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 508

def delete
  context.delete
end

#fetchApplicationInstance

Fetch the ApplicationInstance

Returns:


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

def fetch
  context.fetch
end

#friendly_nameString

Returns The string that you assigned to describe the resource.

Returns:

  • (String)

    The string that you assigned to describe the resource


411
412
413
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 411

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


584
585
586
587
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 584

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

#message_status_callbackString

Returns The URL to send message status information to your application.

Returns:

  • (String)

    The URL to send message status information to your application


417
418
419
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 417

def message_status_callback
  @properties['message_status_callback']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#sms_fallback_methodString

Returns The HTTP method used with sms_fallback_url.

Returns:

  • (String)

    The HTTP method used with sms_fallback_url


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

def sms_fallback_method
  @properties['sms_fallback_method']
end

#sms_fallback_urlString

Returns The URL that we call when an error occurs while retrieving or executing the TwiML.

Returns:

  • (String)

    The URL that we call when an error occurs while retrieving or executing the TwiML


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

def sms_fallback_url
  @properties['sms_fallback_url']
end

#sms_methodString

Returns The HTTP method to use with sms_url.

Returns:

  • (String)

    The HTTP method to use with sms_url


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

def sms_method
  @properties['sms_method']
end

#sms_status_callbackString

Returns The URL to send status information to your application.

Returns:

  • (String)

    The URL to send status information to your application


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

def sms_status_callback
  @properties['sms_status_callback']
end

#sms_urlString

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

Returns:

  • (String)

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


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

def sms_url
  @properties['sms_url']
end

#status_callbackString

Returns The URL to send status information to your application.

Returns:

  • (String)

    The URL to send status information to your application


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

def status_callback
  @properties['status_callback']
end

#status_callback_methodString

Returns The HTTP method we use to call status_callback.

Returns:

  • (String)

    The HTTP method we use to call status_callback


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

def status_callback_method
  @properties['status_callback_method']
end

#to_sObject

Provide a user friendly representation


577
578
579
580
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 577

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 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:


555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
# File 'lib/twilio-ruby/rest/api/v2010/account/application.rb', line 555

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

#uriString

Returns The URI of the resource, relative to `api.twilio.com`.

Returns:


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

def uri
  @properties['uri']
end

#voice_caller_id_lookupBoolean

Returns Whether to lookup the caller's name.

Returns:

  • (Boolean)

    Whether to lookup the caller's name


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

def voice_caller_id_lookup
  @properties['voice_caller_id_lookup']
end

#voice_fallback_methodString

Returns The HTTP method used with voice_fallback_url.

Returns:

  • (String)

    The HTTP method used with voice_fallback_url


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

def voice_fallback_method
  @properties['voice_fallback_method']
end

#voice_fallback_urlString

Returns The URL we call when a TwiML error occurs.

Returns:

  • (String)

    The URL we call when a TwiML error occurs


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

def voice_fallback_url
  @properties['voice_fallback_url']
end

#voice_methodString

Returns The HTTP method used with the voice_url.

Returns:

  • (String)

    The HTTP method used with the voice_url


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

def voice_method
  @properties['voice_method']
end

#voice_urlString

Returns The URL we call when the phone number receives a call.

Returns:

  • (String)

    The URL we call when the phone number receives a call


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

def voice_url
  @properties['voice_url']
end