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



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
387
388
389
390
391
392
393
394
395
396
397
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 362

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'],
        'verification_attempts' => payload['verification_attempts'] == nil ? payload['verification_attempts'] : payload['verification_attempts'].to_i,
        'verification_call_sids' => payload['verification_call_sids'],
        'verification_call_delay' => payload['verification_call_delay'] == nil ? payload['verification_call_delay'] : payload['verification_call_delay'].to_i,
        'verification_call_extension' => payload['verification_call_extension'],
        'verification_code' => payload['verification_code'],
        'verification_type' => payload['verification_type'],
    }

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

Instance Method Details

#account_sidString



418
419
420
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 418

def 
    @properties['account_sid']
end

#address_sidString



430
431
432
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 430

def address_sid
    @properties['address_sid']
end

#bulk_hosting_request_sidString



514
515
516
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 514

def bulk_hosting_request_sid
    @properties['bulk_hosting_request_sid']
end

#capabilitiesNumbersV2HostedNumberOrderCapabilities



448
449
450
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 448

def capabilities
    @properties['capabilities']
end

#cc_emailsArray<String>



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

def cc_emails
    @properties['cc_emails']
end

#contact_phone_numberString



508
509
510
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 508

def contact_phone_number
    @properties['contact_phone_number']
end

#contact_titleString



502
503
504
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 502

def contact_title
    @properties['contact_title']
end

#contextHostedNumberOrderContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context



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

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

#date_createdTime



472
473
474
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 472

def date_created
    @properties['date_created']
end

#date_updatedTime



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

def date_updated
    @properties['date_updated']
end

#deleteBoolean

Delete the HostedNumberOrderInstance



563
564
565
566
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 563

def delete

    context.delete
end

#emailString



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

def email
    @properties['email']
end

#failure_reasonString



466
467
468
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 466

def failure_reason
    @properties['failure_reason']
end

#fetchHostedNumberOrderInstance

Fetch the HostedNumberOrderInstance



571
572
573
574
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 571

def fetch

    context.fetch
end

#friendly_nameString



454
455
456
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 454

def friendly_name
    @properties['friendly_name']
end

#incoming_phone_number_sidString



424
425
426
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 424

def incoming_phone_number_sid
    @properties['incoming_phone_number_sid']
end

#inspectObject

Provide a detailed, user friendly representation



604
605
606
607
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 604

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

#next_stepString



520
521
522
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 520

def next_step
    @properties['next_step']
end

#phone_numberString



442
443
444
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 442

def phone_number
    @properties['phone_number']
end

#sidString



412
413
414
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 412

def sid
    @properties['sid']
end

#signing_document_sidString



436
437
438
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 436

def signing_document_sid
    @properties['signing_document_sid']
end

#statusStatus



460
461
462
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 460

def status
    @properties['status']
end

#to_sObject

Provide a user friendly representation



597
598
599
600
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 597

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

#update(status: nil, verification_call_delay: :unset, verification_call_extension: :unset) ⇒ HostedNumberOrderInstance

Update the HostedNumberOrderInstance



582
583
584
585
586
587
588
589
590
591
592
593
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 582

def update(
    status: nil, 
    verification_call_delay: :unset, 
    verification_call_extension: :unset
)

    context.update(
        status: status, 
        verification_call_delay: verification_call_delay, 
        verification_call_extension: verification_call_extension, 
    )
end

#urlString



496
497
498
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 496

def url
    @properties['url']
end

#verification_attemptsString



526
527
528
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 526

def verification_attempts
    @properties['verification_attempts']
end

#verification_call_delayString



538
539
540
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 538

def verification_call_delay
    @properties['verification_call_delay']
end

#verification_call_extensionString



544
545
546
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 544

def verification_call_extension
    @properties['verification_call_extension']
end

#verification_call_sidsArray<String>



532
533
534
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 532

def verification_call_sids
    @properties['verification_call_sids']
end

#verification_codeString



550
551
552
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 550

def verification_code
    @properties['verification_code']
end

#verification_typeVerificationType



556
557
558
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 556

def verification_type
    @properties['verification_type']
end