Class: Twilio::REST::Numbers::V2::HostedNumberOrderInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb

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

  • account_sid (String) —

    The SID of the Account that created this HostedNumberOrder resource.

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

    The SID of the Call resource to fetch.



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 317

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'],
        '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']),
        'email' => payload['email'],
        'cc_emails' => payload['cc_emails'],
        'url' => payload['url'],
        'contact_title' => payload['contact_title'],
        'contact_phone_number' => payload['contact_phone_number'],
        'bulk_hosting_request_sid' => payload['bulk_hosting_request_sid'],
        'next_step' => payload['next_step'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns A 34 character string that uniquely identifies the account.

Returns:

  • (String) —

    A 34 character string that uniquely identifies the account.



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

def 
    @properties['account_sid']
end

#address_sid ⇒ String

Returns A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.

Returns:

  • (String) —

    A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.



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

def address_sid
    @properties['address_sid']
end

#bulk_hosting_request_sid ⇒ String

Returns A 34 character string that uniquely identifies the bulk hosting request associated with this HostedNumberOrder.

Returns:

  • (String) —

    A 34 character string that uniquely identifies the bulk hosting request associated with this HostedNumberOrder.



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

def bulk_hosting_request_sid
    @properties['bulk_hosting_request_sid']
end

#capabilities ⇒ NumbersV2HostedNumberOrderCapabilities

Returns:

  • (NumbersV2HostedNumberOrderCapabilities) 


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

def capabilities
    @properties['capabilities']
end

#cc_emails ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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



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

def cc_emails
    @properties['cc_emails']
end

#contact_phone_number ⇒ String

Returns The contact phone number of the person authorized to sign the Authorization Document.

Returns:

  • (String) —

    The contact phone number of the person authorized to sign the Authorization Document.



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

def contact_phone_number
    @properties['contact_phone_number']
end

#contact_title ⇒ String

Returns The title of the person authorized to sign the Authorization Document for this phone number.

Returns:

  • (String) —

    The title of the person authorized to sign the Authorization Document for this phone number.



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

def contact_title
    @properties['contact_title']
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:



352
353
354
355
356
357
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 352

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

#date_created ⇒ Time

Returns The date this resource was created, given as [GMT RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was updated, given as [GMT RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the HostedNumberOrderInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



476
477
478
479
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 476

def delete

    context.delete
end

#email ⇒ String

Returns Email of the owner of this phone number that is being hosted.

Returns:

  • (String) —

    Email of the owner of this phone number that is being hosted.



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

def email
    @properties['email']
end

#failure_reason ⇒ String

Returns A message that explains why a hosted_number_order went to status "action-required".

Returns:

  • (String) —

    A message that explains why a hosted_number_order went to status "action-required"



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

def failure_reason
    @properties['failure_reason']
end

#fetch ⇒ HostedNumberOrderInstance

Fetch the HostedNumberOrderInstance

Returns:



484
485
486
487
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 484

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns A 128 character string that is a human-readable text that describes this resource.

Returns:

  • (String) —

    A 128 character string that is a human-readable text that describes this resource.



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

def friendly_name
    @properties['friendly_name']
end

#incoming_phone_number_sid ⇒ String

Returns 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.

Returns:



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

def incoming_phone_number_sid
    @properties['incoming_phone_number_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



498
499
500
501
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 498

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

#next_step ⇒ String

Returns The next step you need to take to complete the hosted number order and request it successfully.

Returns:

  • (String) —

    The next step you need to take to complete the hosted number order and request it successfully.



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

def next_step
    @properties['next_step']
end

#phone_number ⇒ String

Returns Phone number to be hosted. This must be in [E.164](en.wikipedia.org/wiki/E.164) format, e.g., +16175551212.

Returns:



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

def phone_number
    @properties['phone_number']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this HostedNumberOrder.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this HostedNumberOrder.



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

def sid
    @properties['sid']
end

#signing_document_sid ⇒ String

Returns 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.

Returns:



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

def signing_document_sid
    @properties['signing_document_sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



491
492
493
494
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 491

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

#url ⇒ String

Returns The URL of this HostedNumberOrder.

Returns:

  • (String) —

    The URL of this HostedNumberOrder.



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

def url
    @properties['url']
end