Class: Twilio::REST::Numbers::V3::HostedNumberOrderInstance

Inherits:

InstanceResource

Object
InstanceResource
Twilio::REST::Numbers::V3::HostedNumberOrderInstance

show all

Defined in:: lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb

Instance Method Summary collapse

#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 ⇒ NumbersV3HostedNumbersHostedNumberOrderCapabilities
#cc_emails ⇒ Array<String>

A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.
#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.
#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\”.
#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) ⇒ 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.
#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) ⇒ `HostedNumberOrderInstance`

Initialize the HostedNumberOrderInstance

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 296

def initialize(version, payload )
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)
    
    # 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'],
    }
end

Instance Method Details

#account_sid ⇒ `String`



338
339
340

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 338

def account_sid
    @properties['account_sid']
end

#address_sid ⇒ `String`



350
351
352

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 350

def address_sid
    @properties['address_sid']
end

#call_delay ⇒ `String`



452
453
454

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 452

def call_delay
    @properties['call_delay']
end

#capabilities ⇒ `NumbersV3HostedNumbersHostedNumberOrderCapabilities`



368
369
370

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 368

def capabilities
    @properties['capabilities']
end

#cc_emails ⇒ `Array<String>`



422
423
424

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 422

def cc_emails
    @properties['cc_emails']
end

#date_created ⇒ `Time`



398
399
400

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 398

def date_created
    @properties['date_created']
end

#date_updated ⇒ `Time`



404
405
406

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 404

def date_updated
    @properties['date_updated']
end

#email ⇒ `String`



416
417
418

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 416

def email
    @properties['email']
end

#extension ⇒ `String`



446
447
448

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 446

def extension
    @properties['extension']
end

#failure_reason ⇒ `String`



392
393
394

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 392

def failure_reason
    @properties['failure_reason']
end

#friendly_name ⇒ `String`



374
375
376

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 374

def friendly_name
    @properties['friendly_name']
end

#incoming_phone_number_sid ⇒ `String`



344
345
346

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 344

def incoming_phone_number_sid
    @properties['incoming_phone_number_sid']
end

#inspect ⇒ `Object`

Provide a detailed, user friendly representation



476
477
478

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 476

def inspect
    "<Twilio.Numbers.V3.HostedNumberOrderInstance>"
end

#phone_number ⇒ `String`



362
363
364

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 362

def phone_number
    @properties['phone_number']
end

#sid ⇒ `String`



332
333
334

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 332

def sid
    @properties['sid']
end

#signing_document_sid ⇒ `String`



356
357
358

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 356

def signing_document_sid
    @properties['signing_document_sid']
end

#status ⇒ `Status`



386
387
388

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 386

def status
    @properties['status']
end

#to_s ⇒ `Object`

Provide a user friendly representation



470
471
472

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 470

def to_s
    "<Twilio.Numbers.V3.HostedNumberOrderInstance>"
end

#unique_name ⇒ `String`



380
381
382

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 380

def unique_name
    @properties['unique_name']
end

#url ⇒ `String`



428
429
430

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 428

def url
    @properties['url']
end

#verification_attempts ⇒ `String`



410
411
412

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 410

def verification_attempts
    @properties['verification_attempts']
end

#verification_call_sids ⇒ `Array<String>`



464
465
466

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 464

def verification_call_sids
    @properties['verification_call_sids']
end

#verification_code ⇒ `String`



458
459
460

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 458

def verification_code
    @properties['verification_code']
end

#verification_document_sid ⇒ `String`



440
441
442

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 440

def verification_document_sid
    @properties['verification_document_sid']
end

#verification_type ⇒ `VerificationType`



434
435
436

# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 434

def verification_type
    @properties['verification_type']
end

Class: Twilio::REST::Numbers::V3::HostedNumberOrderInstance

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ HostedNumberOrderInstance

Instance Method Details

#account_sid ⇒ String

#address_sid ⇒ String

#call_delay ⇒ String

#capabilities ⇒ NumbersV3HostedNumbersHostedNumberOrderCapabilities

#cc_emails ⇒ Array<String>

#date_created ⇒ Time

#date_updated ⇒ Time

#email ⇒ String

#extension ⇒ String

#failure_reason ⇒ String

#friendly_name ⇒ String

#incoming_phone_number_sid ⇒ String

#inspect ⇒ Object

#phone_number ⇒ String

#sid ⇒ String

#signing_document_sid ⇒ String

#status ⇒ Status

#to_s ⇒ Object

#unique_name ⇒ String

#url ⇒ String

#verification_attempts ⇒ String

#verification_call_sids ⇒ Array<String>

#verification_code ⇒ String

#verification_document_sid ⇒ String

#verification_type ⇒ VerificationType

#initialize(version, payload) ⇒ `HostedNumberOrderInstance`

#account_sid ⇒ `String`

#address_sid ⇒ `String`

#call_delay ⇒ `String`

#capabilities ⇒ `NumbersV3HostedNumbersHostedNumberOrderCapabilities`

#cc_emails ⇒ `Array<String>`

#date_created ⇒ `Time`

#date_updated ⇒ `Time`

#email ⇒ `String`

#extension ⇒ `String`

#failure_reason ⇒ `String`

#friendly_name ⇒ `String`

#incoming_phone_number_sid ⇒ `String`

#inspect ⇒ `Object`

#phone_number ⇒ `String`

#sid ⇒ `String`

#signing_document_sid ⇒ `String`

#status ⇒ `Status`

#to_s ⇒ `Object`

#unique_name ⇒ `String`

#url ⇒ `String`

#verification_attempts ⇒ `String`

#verification_call_sids ⇒ `Array<String>`

#verification_code ⇒ `String`

#verification_document_sid ⇒ `String`

#verification_type ⇒ `VerificationType`