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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Preview::HostedNumbers::HostedNumberOrderInstance

Defined in:

lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb

Instance Method Summary

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

• #call_delay ⇒ String

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

• #capabilities ⇒ PreviewHostedNumbersHostedNumberOrderCapabilities
• #cc_emails ⇒ Array<String>

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

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

• #extension ⇒ String

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

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

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

• #unique_name ⇒ 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.

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

• #url ⇒ String

  The URL of this HostedNumberOrder.

• #verification_attempts ⇒ String

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

• #verification_call_sids ⇒ Array<String>

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

• #verification_code ⇒ String

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

• #verification_document_sid ⇒ 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.

• #verification_type ⇒ VerificationType

Constructor Details

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

Initialize the HostedNumberOrderInstance

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

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

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

def account_sid
    @properties['account_sid']
end

#address_sid ⇒ String

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

def address_sid
    @properties['address_sid']
end

#call_delay ⇒ String

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

def call_delay
    @properties['call_delay']
end

#capabilities ⇒ PreviewHostedNumbersHostedNumberOrderCapabilities

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

def capabilities
    @properties['capabilities']
end

#cc_emails ⇒ Array<String>

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

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

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

def context
    unless @instance_context
        @instance_context = HostedNumberOrderContext.new(@version , @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time

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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the HostedNumberOrderInstance

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

def delete

    context.delete
end

#email ⇒ String

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

def email
    @properties['email']
end

#extension ⇒ String

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

def extension
    @properties['extension']
end

#failure_reason ⇒ String

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

def failure_reason
    @properties['failure_reason']
end

#fetch ⇒ HostedNumberOrderInstance

Fetch the HostedNumberOrderInstance

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

def fetch

    context.fetch
end

#friendly_name ⇒ String

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

def friendly_name
    @properties['friendly_name']
end

#incoming_phone_number_sid ⇒ String

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

def incoming_phone_number_sid
    @properties['incoming_phone_number_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#phone_number ⇒ String

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

def phone_number
    @properties['phone_number']
end

#sid ⇒ String

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

def sid
    @properties['sid']
end

#signing_document_sid ⇒ String

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

def signing_document_sid
    @properties['signing_document_sid']
end

#status ⇒ Status

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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#unique_name ⇒ String

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

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

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

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

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

def url
    @properties['url']
end

#verification_attempts ⇒ String

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

def verification_attempts
    @properties['verification_attempts']
end

#verification_call_sids ⇒ Array<String>

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

def verification_call_sids
    @properties['verification_call_sids']
end

#verification_code ⇒ String

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

def verification_code
    @properties['verification_code']
end

#verification_document_sid ⇒ String

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

def verification_document_sid
    @properties['verification_document_sid']
end

#verification_type ⇒ VerificationType

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

def verification_type
    @properties['verification_type']
end