Class: Twilio::REST::Numbers::V2::HostedNumberOrderInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the HostedNumberOrderInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this HostedNumberOrder resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



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

Returns A 34 character string that uniquely identifies the account.

Returns:

  • (String) —

    A 34 character string that uniquely identifies the account.



720
721
722
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 720

def 
    @properties['account_sid']
end

#address_sid ⇒ String

Returns A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.

Returns:

  • (String) —

    A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.



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

Returns A 34 character string that uniquely identifies the bulk hosting request associated with this HostedNumberOrder.

Returns:

  • (String) —

    A 34 character string that uniquely identifies the bulk hosting request associated with this HostedNumberOrder.



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

Returns:

  • (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>

Returns A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.

Returns:

  • (Array<String>) —

    A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.



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

Returns The contact phone number of the person authorized to sign the Authorization Document.

Returns:

  • (String) —

    The contact phone number of the person authorized to sign the Authorization Document.



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

Returns The title of the person authorized to sign the Authorization Document for this phone number.

Returns:

  • (String) —

    The title of the person authorized to sign the Authorization Document for this phone number.



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

Returns:



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

Returns The date this resource was created, given as [GMT RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

Returns The date that this resource was updated, given as [GMT RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



865
866
867
868
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 865

def delete

    context.delete
end

#email ⇒ String

Returns Email of the owner of this phone number that is being hosted.

Returns:

  • (String) —

    Email of the owner of this phone number that is being hosted.



786
787
788
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 786

def email
    @properties['email']
end

#failure_reason ⇒ String

Returns A message that explains why a hosted_number_order went to status "action-required".

Returns:

  • (String) —

    A message that explains why a hosted_number_order went to status "action-required"



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

Returns:



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

Returns A 128 character string that is a human-readable text that describes this resource.

Returns:

  • (String) —

    A 128 character string that is a human-readable text that describes this resource.



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

Returns 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.

Returns:



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

Returns The next step you need to take to complete the hosted number order and request it successfully.

Returns:

  • (String) —

    The next step you need to take to complete the hosted number order and request it successfully.



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

Returns Phone number to be hosted. This must be in [E.164](en.wikipedia.org/wiki/E.164) format, e.g., +16175551212.

Returns:



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

Returns A 34 character string that uniquely identifies this HostedNumberOrder.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this HostedNumberOrder.



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

Returns 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.

Returns:



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

Returns:

  • (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

Parameters:

  • status (Status) (defaults to: nil)
  • verification_call_delay (String) (defaults to: :unset) —

    The number of seconds to wait before initiating the ownership verification call. Can be a value between 0 and 60, inclusive.

  • verification_call_extension (String) (defaults to: :unset) —

    The numerical extension to dial when making the ownership verification call.

Returns:



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

Returns The URL of this HostedNumberOrder.

Returns:

  • (String) —

    The URL of this HostedNumberOrder.



798
799
800
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 798

def url
    @properties['url']
end

#verification_attempts ⇒ String

Returns The number of attempts made to verify ownership via a call for the hosted phone number.

Returns:

  • (String) —

    The number of attempts made to verify ownership via a call for the hosted phone number.



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

Returns The number of seconds to wait before initiating the ownership verification call. Can be a value between 0 and 60, inclusive.

Returns:

  • (String) —

    The number of seconds to wait before initiating the ownership verification call. Can be a value between 0 and 60, inclusive.



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

Returns The numerical extension to dial when making the ownership verification call.

Returns:

  • (String) —

    The numerical extension to dial when making the ownership verification call.



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>

Returns The Call SIDs that identify the calls placed to verify ownership.

Returns:

  • (Array<String>) —

    The Call SIDs that identify the calls placed to verify ownership.



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

Returns The digits the user must pass in the ownership verification call.

Returns:

  • (String) —

    The digits the user must pass in the ownership verification call.



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

Returns:

  • (VerificationType) 


858
859
860
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 858

def verification_type
    @properties['verification_type']
end