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.



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 396

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.



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

def 
  @properties['account_sid']
end

#address_sid ⇒ String

Returns Address sid.

Returns:

  • (String) —

    Address sid.



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

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.



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

def call_delay
  @properties['call_delay']
end

#capabilities ⇒ String

Returns A mapping of phone number capabilities.

Returns:

  • (String) —

    A mapping of phone number capabilities.



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

def capabilities
  @properties['capabilities']
end

#cc_emails ⇒ String

Returns A list of emails.

Returns:

  • (String) —

    A list of emails.



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

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:



435
436
437
438
439
440
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 435

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.



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

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.



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the HostedNumberOrderInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#email ⇒ String

Returns Email.

Returns:

  • (String) —

    Email.



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

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.



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

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”



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

def failure_reason
  @properties['failure_reason']
end

#fetch ⇒ HostedNumberOrderInstance

Fetch a HostedNumberOrderInstance

Returns:



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

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.



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

def friendly_name
  @properties['friendly_name']
end

#incoming_phone_number_sid ⇒ String

Returns IncomingPhoneNumber sid.

Returns:

  • (String) —

    IncomingPhoneNumber sid.



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

def incoming_phone_number_sid
  @properties['incoming_phone_number_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



644
645
646
647
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 644

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.



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

def phone_number
  @properties['phone_number']
end

#sid ⇒ String

Returns HostedNumberOrder sid.

Returns:

  • (String) —

    HostedNumberOrder sid.



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

def sid
  @properties['sid']
end

#signing_document_sid ⇒ String

Returns LOA document sid.

Returns:

  • (String) —

    LOA document sid.



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

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.



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



637
638
639
640
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 637

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.



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

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

    User can only post to ‘pending-verification` status to transition the HostedNumberOrder to initiate a verification call or verification of ownership with a copy of a phone bill.

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

    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:



620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 620

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.



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

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.



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

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.



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

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.



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

def verification_code
  @properties['verification_code']
end

#verification_document_sid ⇒ String

Returns Verification Document Sid.

Returns:

  • (String) —

    Verification Document Sid.



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

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.



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

def verification_type
  @properties['verification_type']
end