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](www.twilio.com/docs/iam/api/account) that created the Trunk 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 date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#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 URL we call using the ‘disaster_recovery_method` if an error occurs while sending SIP traffic towards the 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 ⇒ Hash
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 we created to identify the Trunk resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
- #transfer_caller_id ⇒ TransferCallerId
- #transfer_mode ⇒ TransferSetting
-
#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
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 397 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
439 440 441 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 439 def account_sid @properties['account_sid'] end |
#auth_type ⇒ String
499 500 501 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 499 def auth_type @properties['auth_type'] end |
#auth_type_set ⇒ Array<String>
505 506 507 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 505 def auth_type_set @properties['auth_type_set'] end |
#cnam_lookup_enabled ⇒ Boolean
493 494 495 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 493 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
430 431 432 433 434 435 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 430 def context unless @instance_context @instance_context = TrunkContext.new(@version , @params['sid']) end @instance_context end |
#credentials_lists ⇒ credentials_lists
Access the credentials_lists
599 600 601 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 599 def credentials_lists context.credentials_lists end |
#date_created ⇒ Time
511 512 513 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 511 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
517 518 519 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 517 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the TrunkInstance
542 543 544 545 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 542 def delete context.delete end |
#disaster_recovery_method ⇒ String
451 452 453 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 451 def disaster_recovery_method @properties['disaster_recovery_method'] end |
#disaster_recovery_url ⇒ String
457 458 459 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 457 def disaster_recovery_url @properties['disaster_recovery_url'] end |
#domain_name ⇒ String
445 446 447 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 445 def domain_name @properties['domain_name'] end |
#fetch ⇒ TrunkInstance
Fetch the TrunkInstance
550 551 552 553 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 550 def fetch context.fetch end |
#friendly_name ⇒ String
463 464 465 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 463 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
633 634 635 636 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 633 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
606 607 608 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 606 def ip_access_control_lists context.ip_access_control_lists end |
#links ⇒ Hash
535 536 537 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 535 def links @properties['links'] end |
#origination_urls ⇒ origination_urls
Access the origination_urls
620 621 622 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 620 def origination_urls context.origination_urls end |
#phone_numbers ⇒ phone_numbers
Access the phone_numbers
613 614 615 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 613 def phone_numbers context.phone_numbers end |
#recording ⇒ Hash
475 476 477 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 475 def recording @properties['recording'] end |
#recordings ⇒ recordings
Access the recordings
592 593 594 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 592 def recordings context.recordings end |
#secure ⇒ Boolean
469 470 471 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 469 def secure @properties['secure'] end |
#sid ⇒ String
523 524 525 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 523 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
626 627 628 629 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 626 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Trunking.V1.TrunkInstance #{values}>" end |
#transfer_caller_id ⇒ TransferCallerId
487 488 489 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 487 def transfer_caller_id @properties['transfer_caller_id'] end |
#transfer_mode ⇒ TransferSetting
481 482 483 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 481 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
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 566 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
529 530 531 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 529 def url @properties['url'] end |