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



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 379

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 



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

def 
  @properties['account_sid']
end

#address_sid ⇒ String 



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

def address_sid
  @properties['address_sid']
end

#call_delay ⇒ String 



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

def call_delay
  @properties['call_delay']
end

#capabilities ⇒ String 



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

def capabilities
  @properties['capabilities']
end

#cc_emails ⇒ String 



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

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



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

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

#date_created ⇒ Time 



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the HostedNumberOrderInstance



573
574
575
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 573

def delete
  context.delete
end

#email ⇒ String 



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

def email
  @properties['email']
end

#extension ⇒ String 



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

def extension
  @properties['extension']
end

#failure_reason ⇒ String 



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

def failure_reason
  @properties['failure_reason']
end

#fetch ⇒ HostedNumberOrderInstance

Fetch the HostedNumberOrderInstance



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

def fetch
  context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
  @properties['friendly_name']
end

#incoming_phone_number_sid ⇒ String 



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

def incoming_phone_number_sid
  @properties['incoming_phone_number_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



627
628
629
630
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 627

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

#phone_number ⇒ String 



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

def phone_number
  @properties['phone_number']
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#signing_document_sid ⇒ String 



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

def signing_document_sid
  @properties['signing_document_sid']
end

#status ⇒ hosted_number_order.Status 



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



620
621
622
623
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 620

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

#unique_name ⇒ String 



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

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



603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 603

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 



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

def url
  @properties['url']
end

#verification_attempts ⇒ String 



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

def verification_attempts
  @properties['verification_attempts']
end

#verification_call_sids ⇒ String 



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

def verification_call_sids
  @properties['verification_call_sids']
end

#verification_code ⇒ String 



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

def verification_code
  @properties['verification_code']
end

#verification_document_sid ⇒ String 



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

def verification_document_sid
  @properties['verification_document_sid']
end

#verification_type ⇒ hosted_number_order.VerificationType 



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

def verification_type
  @properties['verification_type']
end