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.



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 360

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'],
      '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'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid']}
end

Instance Method Details

#account_sid ⇒ String

Returns Account Sid.

Returns:

  • (String) —

    Account Sid.



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

def 
  @properties['account_sid']
end

#address_sid ⇒ String

Returns Address sid.

Returns:

  • (String) —

    Address sid.



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

def address_sid
  @properties['address_sid']
end

#capabilities ⇒ String

Returns A mapping of phone number capabilities.

Returns:

  • (String) —

    A mapping of phone number capabilities.



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

def capabilities
  @properties['capabilities']
end

#cc_emails ⇒ String

Returns A list of emails.

Returns:

  • (String) —

    A list of emails.



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

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:



392
393
394
395
396
397
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 392

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.



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

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.



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the HostedNumberOrderInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#email ⇒ String

Returns Email.

Returns:

  • (String) —

    Email.



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

def email
  @properties['email']
end

#fetch ⇒ HostedNumberOrderInstance

Fetch a HostedNumberOrderInstance

Returns:



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

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.



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

def friendly_name
  @properties['friendly_name']
end

#incoming_phone_number_sid ⇒ String

Returns IncomingPhoneNumber sid.

Returns:

  • (String) —

    IncomingPhoneNumber sid.



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

def incoming_phone_number_sid
  @properties['incoming_phone_number_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

def phone_number
  @properties['phone_number']
end

#sid ⇒ String

Returns HostedNumberOrder sid.

Returns:

  • (String) —

    HostedNumberOrder sid.



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

def sid
  @properties['sid']
end

#signing_document_sid ⇒ String

Returns LOA document sid.

Returns:

  • (String) —

    LOA document sid.



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

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.



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

def unique_name
  @properties['unique_name']
end

#update(friendly_name: :unset, unique_name: :unset, email: :unset, cc_emails: :unset, status: :unset, verification_code: :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.

Returns:



525
526
527
528
529
530
531
532
533
534
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 525

def update(friendly_name: :unset, unique_name: :unset, email: :unset, cc_emails: :unset, status: :unset, verification_code: :unset)
  context.update(
      friendly_name: friendly_name,
      unique_name: unique_name,
      email: email,
      cc_emails: cc_emails,
      status: status,
      verification_code: verification_code,
  )
end

#url ⇒ String

Returns The URL of this HostedNumberOrder.

Returns:

  • (String) —

    The URL of this HostedNumberOrder.



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

def url
  @properties['url']
end

#verification_attempts ⇒ String

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

Returns:

  • (String) —

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



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

def verification_attempts
  @properties['verification_attempts']
end