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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

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

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

    A 34 character string that uniquely identifies this HostedNumberOrder.



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 380

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'].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'].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 Account Sid.

Returns:

  • (String) —

    Account Sid.



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

def 
  @properties['account_sid']
end

#address_sid ⇒ String

Returns Address sid.

Returns:

  • (String) —

    Address sid.



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

def address_sid
  @properties['address_sid']
end

#call_delay ⇒ String

Returns Seconds (0-30) to delay ownership verification call by.

Returns:

  • (String) —

    Seconds (0-30) to delay ownership verification call by.



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

def call_delay
  @properties['call_delay']
end

#capabilities ⇒ String

Returns A mapping of phone number capabilities.

Returns:

  • (String) —

    A mapping of phone number capabilities.



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

def capabilities
  @properties['capabilities']
end

#cc_emails ⇒ String

Returns A list of emails.

Returns:

  • (String) —

    A list of emails.



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

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:



419
420
421
422
423
424
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 419

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

#date_created ⇒ Time

Returns The date this HostedNumberOrder was created.

Returns:

  • (Time) —

    The date this HostedNumberOrder was created.



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this HostedNumberOrder was updated.

Returns:

  • (Time) —

    The date this HostedNumberOrder was updated.



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the HostedNumberOrderInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#email ⇒ String

Returns Email.

Returns:

  • (String) —

    Email.



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

def email
  @properties['email']
end

#extension ⇒ String

Returns Phone extension to use for ownership verification call.

Returns:

  • (String) —

    Phone extension to use for ownership verification call.



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

def extension
  @properties['extension']
end

#failure_reason ⇒ String

Returns Why a hosted_number_order reached status “action-required”.

Returns:

  • (String) —

    Why a hosted_number_order reached status “action-required”



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

def failure_reason
  @properties['failure_reason']
end

#fetch ⇒ HostedNumberOrderInstance

Fetch a HostedNumberOrderInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human readable description of this resource.

Returns:

  • (String) —

    A human readable description of this resource.



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

def friendly_name
  @properties['friendly_name']
end

#incoming_phone_number_sid ⇒ String

Returns IncomingPhoneNumber sid.

Returns:

  • (String) —

    IncomingPhoneNumber sid.



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

def incoming_phone_number_sid
  @properties['incoming_phone_number_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#phone_number ⇒ String

Returns An E164 formatted phone number.

Returns:

  • (String) —

    An E164 formatted phone number.



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

def phone_number
  @properties['phone_number']
end

#sid ⇒ String

Returns HostedNumberOrder sid.

Returns:

  • (String) —

    HostedNumberOrder sid.



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

def sid
  @properties['sid']
end

#signing_document_sid ⇒ String

Returns LOA document sid.

Returns:

  • (String) —

    LOA document sid.



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

def signing_document_sid
  @properties['signing_document_sid']
end

#status ⇒ hosted_number_order.Status

Returns The Status of this HostedNumberOrder.

Returns:

  • (hosted_number_order.Status) —

    The Status of this HostedNumberOrder.



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



619
620
621
622
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 619

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

#unique_name ⇒ String

Returns A unique, developer assigned name of this HostedNumberOrder.

Returns:

  • (String) —

    A unique, developer assigned name of this HostedNumberOrder.



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

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 human readable description of this resource, up to 64 characters.

  • 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 (String) (defaults to: :unset) —

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

  • status (hosted_number_order.Status) (defaults to: :unset) —

    The Status of this HostedNumberOrder. User can only update this to ‘pending-loa` or `pending-verification`.

  • 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 (hosted_number_order.VerificationType) (defaults to: :unset) —

    Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.

  • 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) —

    The extension

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

    The call_delay

Returns:



602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 602

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.



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

def url
  @properties['url']
end

#verification_attempts ⇒ String

Returns The number of attempts made to verify ownership of the phone number.

Returns:

  • (String) —

    The number of attempts made to verify ownership of the phone number.



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

def verification_attempts
  @properties['verification_attempts']
end

#verification_call_sids ⇒ String

Returns List of IDs for ownership verification calls.

Returns:

  • (String) —

    List of IDs for ownership verification calls.



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

def verification_call_sids
  @properties['verification_call_sids']
end

#verification_code ⇒ String

Returns The digits passed during the ownership verification call.

Returns:

  • (String) —

    The digits passed during the ownership verification call.



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

def verification_code
  @properties['verification_code']
end

#verification_document_sid ⇒ String

Returns Verification Document Sid.

Returns:

  • (String) —

    Verification Document Sid.



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

def verification_document_sid
  @properties['verification_document_sid']
end

#verification_type ⇒ hosted_number_order.VerificationType

Returns The method used for verifying ownership of the number to be hosted.

Returns:

  • (hosted_number_order.VerificationType) —

    The method used for verifying ownership of the number to be hosted.



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

def verification_type
  @properties['verification_type']
end