Class: Twilio::REST::Trunking::V1::TrunkInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Trunking::V1::TrunkInstance
- Defined in:
- lib/twilio-ruby/rest/trunking/v1/trunk.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the Account that created the resource.
-
#auth_type ⇒ String
The types of authentication mapped to the domain.
-
#auth_type_set ⇒ Array[String]
Reserved.
-
#cnam_lookup_enabled ⇒ Boolean
Whether Caller ID Name (CNAM) lookup is enabled for the trunk.
-
#context ⇒ TrunkContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#credentials_lists ⇒ credentials_lists
Access the credentials_lists.
-
#date_created ⇒ Time
The RFC 2822 date and time in GMT when the resource was created.
-
#date_updated ⇒ Time
The RFC 2822 date and time in GMT when the resource was last updated.
-
#delete ⇒ Boolean
Delete the TrunkInstance.
-
#disaster_recovery_method ⇒ String
The HTTP method we use to call the disaster_recovery_url.
-
#disaster_recovery_url ⇒ String
The HTTP URL that we call if an error occurs while sending SIP traffic towards your configured Origination URL.
-
#domain_name ⇒ String
The unique address you reserve on Twilio to which you route your SIP traffic.
-
#fetch ⇒ TrunkInstance
Fetch the TrunkInstance.
-
#friendly_name ⇒ String
The string that you assigned to describe the resource.
-
#initialize(version, payload, sid: nil) ⇒ TrunkInstance
constructor
Initialize the TrunkInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#ip_access_control_lists ⇒ ip_access_control_lists
Access the ip_access_control_lists.
-
#links ⇒ String
The URLs of related resources.
-
#origination_urls ⇒ origination_urls
Access the origination_urls.
-
#phone_numbers ⇒ phone_numbers
Access the phone_numbers.
-
#recording ⇒ Hash
The recording settings for the trunk.
-
#recordings ⇒ recordings
Access the recordings.
-
#secure ⇒ Boolean
Whether Secure Trunking is enabled for the trunk.
-
#sid ⇒ String
The unique string that identifies the resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#transfer_caller_id ⇒ trunk.TransferCallerId
Caller Id for transfer target.
-
#transfer_mode ⇒ trunk.TransferSetting
The call transfer settings for the trunk.
-
#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.
-
#url ⇒ String
The absolute URL of the resource.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ TrunkInstance
Initialize the TrunkInstance
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_sid ⇒ String
Returns The SID of the Account that created the resource.
427 428 429 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 427 def account_sid @properties['account_sid'] end |
#auth_type ⇒ String
Returns 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_set ⇒ Array[String]
Returns 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_enabled ⇒ Boolean
Returns 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 |
#context ⇒ TrunkContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
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_lists ⇒ credentials_lists
Access the credentials_lists
598 599 600 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 598 def credentials_lists context.credentials_lists end |
#date_created ⇒ Time
Returns 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_updated ⇒ Time
Returns 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 |
#delete ⇒ Boolean
Delete the TrunkInstance
537 538 539 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 537 def delete context.delete end |
#disaster_recovery_method ⇒ String
Returns 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_url ⇒ String
Returns 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_name ⇒ String
Returns 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 |
#fetch ⇒ TrunkInstance
Fetch the TrunkInstance
530 531 532 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 530 def fetch context.fetch end |
#friendly_name ⇒ String
Returns 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 |
#inspect ⇒ Object
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_lists ⇒ ip_access_control_lists
Access the ip_access_control_lists
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 |
#links ⇒ String
Returns 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_urls ⇒ origination_urls
Access the origination_urls
591 592 593 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 591 def origination_urls context.origination_urls end |
#phone_numbers ⇒ phone_numbers
Access the phone_numbers
612 613 614 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 612 def phone_numbers context.phone_numbers end |
#recording ⇒ Hash
Returns 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 |
#recordings ⇒ recordings
Access the recordings
619 620 621 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 619 def recordings context.recordings end |
#secure ⇒ Boolean
Returns 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 |
#sid ⇒ String
Returns 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_s ⇒ Object
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_id ⇒ trunk.TransferCallerId
Returns 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_mode ⇒ trunk.TransferSetting
Returns 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
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 |
#url ⇒ String
Returns 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 |