Class: Twilio::REST::Trunking::V1::TrunkInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/trunking/v1/trunk.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ TrunkInstance

Initialize the TrunkInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • sid (String) (defaults to: nil)

    The unique string that we created to identify the Trunk resource to fetch.


385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 385

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'domain_name' => payload['domain_name'],
      'disaster_recovery_method' => payload['disaster_recovery_method'],
      'disaster_recovery_url' => payload['disaster_recovery_url'],
      'friendly_name' => payload['friendly_name'],
      'secure' => payload['secure'],
      'recording' => payload['recording'],
      'transfer_mode' => payload['transfer_mode'],
      'transfer_caller_id' => payload['transfer_caller_id'],
      'cnam_lookup_enabled' => payload['cnam_lookup_enabled'],
      'auth_type' => payload['auth_type'],
      'auth_type_set' => payload['auth_type_set'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'sid' => payload['sid'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {'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


427
428
429
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 427

def 
  @properties['account_sid']
end

#auth_typeString

Returns The types of authentication mapped to the domain.

Returns:

  • (String)

    The types of authentication mapped to the domain


487
488
489
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 487

def auth_type
  @properties['auth_type']
end

#auth_type_setArray[String]

Returns Reserved.

Returns:

  • (Array[String])

    Reserved


493
494
495
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 493

def auth_type_set
  @properties['auth_type_set']
end

#cnam_lookup_enabledBoolean

Returns Whether Caller ID Name (CNAM) lookup is enabled for the trunk.

Returns:

  • (Boolean)

    Whether Caller ID Name (CNAM) lookup is enabled for the trunk


481
482
483
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 481

def cnam_lookup_enabled
  @properties['cnam_lookup_enabled']
end

#contextTrunkContext

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

Returns:


418
419
420
421
422
423
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 418

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

#credentials_listscredentials_lists

Access the credentials_lists

Returns:


598
599
600
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 598

def credentials_lists
  context.credentials_lists
end

#date_createdTime

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

Returns:

  • (Time)

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


499
500
501
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 499

def date_created
  @properties['date_created']
end

#date_updatedTime

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

Returns:

  • (Time)

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


505
506
507
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 505

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the TrunkInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


537
538
539
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 537

def delete
  context.delete
end

#disaster_recovery_methodString

Returns The HTTP method we use to call the disaster_recovery_url.

Returns:

  • (String)

    The HTTP method we use to call the disaster_recovery_url


439
440
441
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 439

def disaster_recovery_method
  @properties['disaster_recovery_method']
end

#disaster_recovery_urlString

Returns The HTTP URL that we call if an error occurs while sending SIP traffic towards your configured Origination URL.

Returns:

  • (String)

    The HTTP URL that we call if an error occurs while sending SIP traffic towards your configured Origination URL


445
446
447
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 445

def disaster_recovery_url
  @properties['disaster_recovery_url']
end

#domain_nameString

Returns The unique address you reserve on Twilio to which you route your SIP traffic.

Returns:

  • (String)

    The unique address you reserve on Twilio to which you route your SIP traffic


433
434
435
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 433

def domain_name
  @properties['domain_name']
end

#fetchTrunkInstance

Fetch the TrunkInstance

Returns:


530
531
532
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 530

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


451
452
453
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 451

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


632
633
634
635
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 632

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

#ip_access_control_listsip_access_control_lists

Access the ip_access_control_lists

Returns:


605
606
607
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 605

def ip_access_control_lists
  context.ip_access_control_lists
end

Returns The URLs of related resources.

Returns:

  • (String)

    The URLs of related resources


523
524
525
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 523

def links
  @properties['links']
end

#origination_urlsorigination_urls

Access the origination_urls

Returns:


591
592
593
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 591

def origination_urls
  context.origination_urls
end

#phone_numbersphone_numbers

Access the phone_numbers

Returns:


612
613
614
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 612

def phone_numbers
  context.phone_numbers
end

#recordingHash

Returns The recording settings for the trunk.

Returns:

  • (Hash)

    The recording settings for the trunk


463
464
465
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 463

def recording
  @properties['recording']
end

#recordingsrecordings

Access the recordings

Returns:


619
620
621
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 619

def recordings
  context.recordings
end

#secureBoolean

Returns Whether Secure Trunking is enabled for the trunk.

Returns:

  • (Boolean)

    Whether Secure Trunking is enabled for the trunk


457
458
459
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 457

def secure
  @properties['secure']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


511
512
513
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 511

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


625
626
627
628
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 625

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Trunking.V1.TrunkInstance #{values}>"
end

#transfer_caller_idtrunk.TransferCallerId

Returns Caller Id for transfer target.

Returns:

  • (trunk.TransferCallerId)

    Caller Id for transfer target


475
476
477
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 475

def transfer_caller_id
  @properties['transfer_caller_id']
end

#transfer_modetrunk.TransferSetting

Returns The call transfer settings for the trunk.

Returns:

  • (trunk.TransferSetting)

    The call transfer settings for the trunk


469
470
471
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 469

def transfer_mode
  @properties['transfer_mode']
end

#update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset, transfer_caller_id: :unset) ⇒ TrunkInstance

Update the TrunkInstance

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.

  • domain_name (String) (defaults to: :unset)

    The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and `-` and must end with `pstn.twilio.com`. See Termination Settings for more information.

  • disaster_recovery_url (String) (defaults to: :unset)

    The URL we should call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from the URL and execute the instructions like any other normal TwiML call. See Disaster Recovery for more information.

  • disaster_recovery_method (String) (defaults to: :unset)

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

  • transfer_mode (trunk.TransferSetting) (defaults to: :unset)

    The call transfer settings for the trunk. Can be: `enable-all`, `sip-only` and `disable-all`. See Transfer for more information.

  • secure (Boolean) (defaults to: :unset)

    Whether Secure Trunking is enabled for the trunk. If enabled, all calls going through the trunk will be secure using SRTP for media and TLS for signaling. If disabled, then RTP will be used for media. See Secure Trunking for more information.

  • cnam_lookup_enabled (Boolean) (defaults to: :unset)

    Whether Caller ID Name (CNAM) lookup should be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See CNAM Lookups for more information.

  • transfer_caller_id (trunk.TransferCallerId) (defaults to: :unset)

    Caller Id for transfer target. Can be: `from-transferee` (default) or `from-transferor`.

Returns:


575
576
577
578
579
580
581
582
583
584
585
586
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 575

def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset, transfer_caller_id: :unset)
  context.update(
      friendly_name: friendly_name,
      domain_name: domain_name,
      disaster_recovery_url: disaster_recovery_url,
      disaster_recovery_method: disaster_recovery_method,
      transfer_mode: transfer_mode,
      secure: secure,
      cnam_lookup_enabled: cnam_lookup_enabled,
      transfer_caller_id: transfer_caller_id,
  )
end

#urlString

Returns The absolute URL of the resource.

Returns:

  • (String)

    The absolute URL of the resource


517
518
519
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 517

def url
  @properties['url']
end