Class: Twilio::REST::Numbers::V2::HostedNumberOrderInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Numbers::V2::HostedNumberOrderInstance
- Defined in:
- lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
A 34 character string that uniquely identifies the account.
-
#address_sid ⇒ String
A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.
-
#bulk_hosting_request_sid ⇒ String
A 34 character string that uniquely identifies the bulk hosting request associated with this HostedNumberOrder.
- #capabilities ⇒ NumbersV2HostedNumberOrderCapabilities
-
#cc_emails ⇒ Array<String>
A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.
-
#contact_phone_number ⇒ String
The contact phone number of the person authorized to sign the Authorization Document.
-
#contact_title ⇒ String
The title of the person authorized to sign the Authorization Document for this phone number.
-
#context ⇒ HostedNumberOrderContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date this resource was created, given as [GMT RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date that this resource was updated, given as [GMT RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#delete ⇒ Boolean
Delete the HostedNumberOrderInstance.
-
#email ⇒ String
Email of the owner of this phone number that is being hosted.
-
#failure_reason ⇒ String
A message that explains why a hosted_number_order went to status "action-required".
-
#fetch ⇒ HostedNumberOrderInstance
Fetch the HostedNumberOrderInstance.
-
#friendly_name ⇒ String
A 128 character string that is a human-readable text that describes this resource.
-
#incoming_phone_number_sid ⇒ String
A 34 character string that uniquely identifies the [IncomingPhoneNumber](www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the phone number being hosted.
-
#initialize(version, payload, sid: nil) ⇒ HostedNumberOrderInstance
constructor
Initialize the HostedNumberOrderInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#next_step ⇒ String
The next step you need to take to complete the hosted number order and request it successfully.
-
#phone_number ⇒ String
Phone number to be hosted.
-
#sid ⇒ String
A 34 character string that uniquely identifies this HostedNumberOrder.
-
#signing_document_sid ⇒ String
A 34 character string that uniquely identifies the [Authorization Document](www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource) the user needs to sign.
- #status ⇒ Status
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(status: nil, verification_call_delay: :unset, verification_call_extension: :unset) ⇒ HostedNumberOrderInstance
Update the HostedNumberOrderInstance.
-
#url ⇒ String
The URL of this HostedNumberOrder.
-
#verification_attempts ⇒ String
The number of attempts made to verify ownership via a call for the hosted phone number.
-
#verification_call_delay ⇒ String
The number of seconds to wait before initiating the ownership verification call.
-
#verification_call_extension ⇒ String
The numerical extension to dial when making the ownership verification call.
-
#verification_call_sids ⇒ Array<String>
The Call SIDs that identify the calls placed to verify ownership.
-
#verification_code ⇒ String
The digits the user must pass in the ownership verification call.
- #verification_type ⇒ VerificationType
Constructor Details
#initialize(version, payload, sid: nil) ⇒ HostedNumberOrderInstance
Initialize the HostedNumberOrderInstance
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 663 def initialize(version, payload , sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'account_sid' => payload['account_sid'], 'incoming_phone_number_sid' => payload['incoming_phone_number_sid'], 'address_sid' => payload['address_sid'], 'signing_document_sid' => payload['signing_document_sid'], 'phone_number' => payload['phone_number'], 'capabilities' => payload['capabilities'], 'friendly_name' => payload['friendly_name'], 'status' => payload['status'], 'failure_reason' => payload['failure_reason'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'email' => payload['email'], 'cc_emails' => payload['cc_emails'], 'url' => payload['url'], 'contact_title' => payload['contact_title'], 'contact_phone_number' => payload['contact_phone_number'], 'bulk_hosting_request_sid' => payload['bulk_hosting_request_sid'], 'next_step' => payload['next_step'], 'verification_attempts' => payload['verification_attempts'] == nil ? payload['verification_attempts'] : payload['verification_attempts'].to_i, 'verification_call_sids' => payload['verification_call_sids'], 'verification_call_delay' => payload['verification_call_delay'] == nil ? payload['verification_call_delay'] : payload['verification_call_delay'].to_i, 'verification_call_extension' => payload['verification_call_extension'], 'verification_code' => payload['verification_code'], 'verification_type' => payload['verification_type'], } # Context @instance_context = nil @params = { 'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
720 721 722 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 720 def account_sid @properties['account_sid'] end |
#address_sid ⇒ String
732 733 734 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 732 def address_sid @properties['address_sid'] end |
#bulk_hosting_request_sid ⇒ String
816 817 818 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 816 def bulk_hosting_request_sid @properties['bulk_hosting_request_sid'] end |
#capabilities ⇒ NumbersV2HostedNumberOrderCapabilities
750 751 752 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 750 def capabilities @properties['capabilities'] end |
#cc_emails ⇒ Array<String>
792 793 794 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 792 def cc_emails @properties['cc_emails'] end |
#contact_phone_number ⇒ String
810 811 812 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 810 def contact_phone_number @properties['contact_phone_number'] end |
#contact_title ⇒ String
804 805 806 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 804 def contact_title @properties['contact_title'] end |
#context ⇒ HostedNumberOrderContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
705 706 707 708 709 710 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 705 def context unless @instance_context @instance_context = HostedNumberOrderContext.new(@version , @params['sid']) end @instance_context end |
#date_created ⇒ Time
774 775 776 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 774 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
780 781 782 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 780 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the HostedNumberOrderInstance
865 866 867 868 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 865 def delete context.delete end |
#email ⇒ String
786 787 788 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 786 def email @properties['email'] end |
#failure_reason ⇒ String
768 769 770 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 768 def failure_reason @properties['failure_reason'] end |
#fetch ⇒ HostedNumberOrderInstance
Fetch the HostedNumberOrderInstance
873 874 875 876 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 873 def fetch context.fetch end |
#friendly_name ⇒ String
756 757 758 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 756 def friendly_name @properties['friendly_name'] end |
#incoming_phone_number_sid ⇒ String
726 727 728 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 726 def incoming_phone_number_sid @properties['incoming_phone_number_sid'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
906 907 908 909 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 906 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Numbers.V2.HostedNumberOrderInstance #{values}>" end |
#next_step ⇒ String
822 823 824 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 822 def next_step @properties['next_step'] end |
#phone_number ⇒ String
744 745 746 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 744 def phone_number @properties['phone_number'] end |
#sid ⇒ String
714 715 716 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 714 def sid @properties['sid'] end |
#signing_document_sid ⇒ String
738 739 740 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 738 def signing_document_sid @properties['signing_document_sid'] end |
#status ⇒ Status
762 763 764 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 762 def status @properties['status'] end |
#to_s ⇒ Object
Provide a user friendly representation
899 900 901 902 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 899 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Numbers.V2.HostedNumberOrderInstance #{values}>" end |
#update(status: nil, verification_call_delay: :unset, verification_call_extension: :unset) ⇒ HostedNumberOrderInstance
Update the HostedNumberOrderInstance
884 885 886 887 888 889 890 891 892 893 894 895 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 884 def update( status: nil, verification_call_delay: :unset, verification_call_extension: :unset ) context.update( status: status, verification_call_delay: verification_call_delay, verification_call_extension: verification_call_extension, ) end |
#url ⇒ String
798 799 800 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 798 def url @properties['url'] end |
#verification_attempts ⇒ String
828 829 830 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 828 def verification_attempts @properties['verification_attempts'] end |
#verification_call_delay ⇒ String
840 841 842 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 840 def verification_call_delay @properties['verification_call_delay'] end |
#verification_call_extension ⇒ String
846 847 848 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 846 def verification_call_extension @properties['verification_call_extension'] end |
#verification_call_sids ⇒ Array<String>
834 835 836 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 834 def verification_call_sids @properties['verification_call_sids'] end |
#verification_code ⇒ String
852 853 854 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 852 def verification_code @properties['verification_code'] end |
#verification_type ⇒ VerificationType
858 859 860 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 858 def verification_type @properties['verification_type'] end |