Class: Twilio::REST::Preview::HostedNumbers::HostedNumberOrderInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/hosted_numbers/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.



719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 719

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'],
        'unique_name' => payload['unique_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']),
        'verification_attempts' => payload['verification_attempts'] == nil ? payload['verification_attempts'] : payload['verification_attempts'].to_i,
        'email' => payload['email'],
        'cc_emails' => payload['cc_emails'],
        'url' => payload['url'],
        'verification_type' => payload['verification_type'],
        'verification_document_sid' => payload['verification_document_sid'],
        'extension' => payload['extension'],
        'call_delay' => payload['call_delay'] == nil ? payload['call_delay'] : payload['call_delay'].to_i,
        'verification_code' => payload['verification_code'],
        'verification_call_sids' => payload['verification_call_sids'],
    }

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



774
775
776
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 774

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.



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

def address_sid
    @properties['address_sid']
end

#call_delay ⇒ String

Returns A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call.

Returns:

  • (String) —

    A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call.



888
889
890
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 888

def call_delay
    @properties['call_delay']
end

#capabilities ⇒ PreviewHostedNumbersHostedNumberOrderCapabilities

Returns:

  • (PreviewHostedNumbersHostedNumberOrderCapabilities) 


804
805
806
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 804

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.



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

def cc_emails
    @properties['cc_emails']
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:



759
760
761
762
763
764
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 759

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:



834
835
836
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 834

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:



840
841
842
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 840

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the HostedNumberOrderInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



907
908
909
910
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 907

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.



852
853
854
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 852

def email
    @properties['email']
end

#extension ⇒ String

Returns A numerical extension to be used when making the ownership verification call.

Returns:

  • (String) —

    A numerical extension to be used when making the ownership verification call.



882
883
884
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 882

def extension
    @properties['extension']
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"



828
829
830
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 828

def failure_reason
    @properties['failure_reason']
end

#fetch ⇒ HostedNumberOrderInstance

Fetch the HostedNumberOrderInstance

Returns:



915
916
917
918
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 915

def fetch

    context.fetch
end

#friendly_name ⇒ String

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

Returns:

  • (String) —

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



810
811
812
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 810

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:



780
781
782
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 780

def incoming_phone_number_sid
    @properties['incoming_phone_number_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



969
970
971
972
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 969

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Preview.HostedNumbers.HostedNumberOrderInstance #{values}>"
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:



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

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.



768
769
770
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 768

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:



792
793
794
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 792

def signing_document_sid
    @properties['signing_document_sid']
end

#status ⇒ Status

Returns:

  • (Status) 


822
823
824
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 822

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



962
963
964
965
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 962

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

#unique_name ⇒ String

Returns Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.

Returns:

  • (String) —

    Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.



816
817
818
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 816

def unique_name
    @properties['unique_name']
end

#update(friendly_name: :unset, unique_name: :unset, email: :unset, cc_emails: :unset, status: :unset, verification_code: :unset, verification_type: :unset, verification_document_sid: :unset, extension: :unset, call_delay: :unset) ⇒ HostedNumberOrderInstance

Update the HostedNumberOrderInstance

Parameters:

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

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

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

    Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.

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

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

  • cc_emails (Array[String]) (defaults to: :unset) —

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

  • status (Status) (defaults to: :unset)
  • verification_code (String) (defaults to: :unset) —

    A verification code that is given to the user via a phone call to the phone number that is being hosted.

  • verification_type (VerificationType) (defaults to: :unset)
  • verification_document_sid (String) (defaults to: :unset) —

    Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.

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

    Digits to dial after connecting the verification call.

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

    The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0.

Returns:



933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 933

def update(
  friendly_name: :unset, 
  unique_name: :unset, 
  email: :unset, 
  cc_emails: :unset, 
  status: :unset, 
  verification_code: :unset, 
  verification_type: :unset, 
  verification_document_sid: :unset, 
  extension: :unset, 
  call_delay: :unset
)

    context.update(
        friendly_name: friendly_name, 
        unique_name: unique_name, 
        email: email, 
        cc_emails: cc_emails, 
        status: status, 
        verification_code: verification_code, 
        verification_type: verification_type, 
        verification_document_sid: verification_document_sid, 
        extension: extension, 
        call_delay: call_delay, 
    )
end

#url ⇒ String

Returns The URL of this HostedNumberOrder.

Returns:

  • (String) —

    The URL of this HostedNumberOrder.



864
865
866
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 864

def url
    @properties['url']
end

#verification_attempts ⇒ String

Returns The number of attempts made to verify ownership of the phone number that is being hosted.

Returns:

  • (String) —

    The number of attempts made to verify ownership of the phone number that is being hosted.



846
847
848
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 846

def verification_attempts
    @properties['verification_attempts']
end

#verification_call_sids ⇒ Array<String>

Returns A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification.

Returns:

  • (Array<String>) —

    A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification.



900
901
902
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 900

def verification_call_sids
    @properties['verification_call_sids']
end

#verification_code ⇒ String

Returns A verification code provided in the response for a user to enter when they pick up the phone call.

Returns:

  • (String) —

    A verification code provided in the response for a user to enter when they pick up the phone call.



894
895
896
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 894

def verification_code
    @properties['verification_code']
end

#verification_document_sid ⇒ String

Returns A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted.

Returns:

  • (String) —

    A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted.



876
877
878
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 876

def verification_document_sid
    @properties['verification_document_sid']
end

#verification_type ⇒ VerificationType

Returns:

  • (VerificationType) 


870
871
872
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 870

def verification_type
    @properties['verification_type']
end