Class: Twilio::REST::Verify::V2::ServiceInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ServiceInstance

Initialize the ServiceInstance



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 486

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'code_length' => payload['code_length'].to_i,
      'lookup_enabled' => payload['lookup_enabled'],
      'psd2_enabled' => payload['psd2_enabled'],
      'skip_sms_to_landlines' => payload['skip_sms_to_landlines'],
      'dtmf_input_required' => payload['dtmf_input_required'],
      'tts_name' => payload['tts_name'],
      'do_not_share_warning_enabled' => payload['do_not_share_warning_enabled'],
      'custom_code_enabled' => payload['custom_code_enabled'],
      'push' => payload['push'],
      'totp' => payload['totp'],
      'default_template_sid' => payload['default_template_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#access_tokens ⇒ access_tokens

Access the access_tokens



769
770
771
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 769

def access_tokens
  context.access_tokens
end

#account_sid ⇒ String 



535
536
537
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 535

def 
  @properties['account_sid']
end

#code_length ⇒ String 



547
548
549
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 547

def code_length
  @properties['code_length']
end

#context ⇒ ServiceContext

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



520
521
522
523
524
525
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 520

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

#custom_code_enabled ⇒ Boolean 



589
590
591
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 589

def custom_code_enabled
  @properties['custom_code_enabled']
end

#date_created ⇒ Time 



613
614
615
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 613

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



619
620
621
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 619

def date_updated
  @properties['date_updated']
end

#default_template_sid ⇒ String 



607
608
609
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 607

def default_template_sid
  @properties['default_template_sid']
end

#delete ⇒ Boolean

Delete the ServiceInstance



645
646
647
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 645

def delete
  context.delete
end

#do_not_share_warning_enabled ⇒ Boolean 



583
584
585
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 583

def do_not_share_warning_enabled
  @properties['do_not_share_warning_enabled']
end

#dtmf_input_required ⇒ Boolean 



571
572
573
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 571

def dtmf_input_required
  @properties['dtmf_input_required']
end

#entities ⇒ entities

Access the entities



755
756
757
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 755

def entities
  context.entities
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance



638
639
640
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 638

def fetch
  context.fetch
end

#friendly_name ⇒ String 



541
542
543
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 541

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



782
783
784
785
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 782

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

#links ⇒ String 



631
632
633
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 631

def links
  @properties['links']
end

#lookup_enabled ⇒ Boolean 



553
554
555
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 553

def lookup_enabled
  @properties['lookup_enabled']
end

#messaging_configurations ⇒ messaging_configurations

Access the messaging_configurations



748
749
750
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 748

def messaging_configurations
  context.messaging_configurations
end

#psd2_enabled ⇒ Boolean 



559
560
561
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 559

def psd2_enabled
  @properties['psd2_enabled']
end

#push ⇒ Hash 



595
596
597
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 595

def push
  @properties['push']
end

#rate_limits ⇒ rate_limits

Access the rate_limits



741
742
743
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 741

def rate_limits
  context.rate_limits
end

#sid ⇒ String 



529
530
531
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 529

def sid
  @properties['sid']
end

#skip_sms_to_landlines ⇒ Boolean 



565
566
567
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 565

def skip_sms_to_landlines
  @properties['skip_sms_to_landlines']
end

#to_s ⇒ Object

Provide a user friendly representation



775
776
777
778
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 775

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

#totp ⇒ Hash 



601
602
603
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 601

def totp
  @properties['totp']
end

#tts_name ⇒ String 



577
578
579
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 577

def tts_name
  @properties['tts_name']
end

#update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset, totp_issuer: :unset, totp_time_step: :unset, totp_code_length: :unset, totp_skew: :unset, default_template_sid: :unset) ⇒ ServiceInstance

Update the ServiceInstance



702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 702

def update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset, totp_issuer: :unset, totp_time_step: :unset, totp_code_length: :unset, totp_skew: :unset, default_template_sid: :unset)
  context.update(
      friendly_name: friendly_name,
      code_length: code_length,
      lookup_enabled: lookup_enabled,
      skip_sms_to_landlines: skip_sms_to_landlines,
      dtmf_input_required: dtmf_input_required,
      tts_name: tts_name,
      psd2_enabled: psd2_enabled,
      do_not_share_warning_enabled: do_not_share_warning_enabled,
      custom_code_enabled: custom_code_enabled,
      push_include_date: push_include_date,
      push_apn_credential_sid: push_apn_credential_sid,
      push_fcm_credential_sid: push_fcm_credential_sid,
      totp_issuer: totp_issuer,
      totp_time_step: totp_time_step,
      totp_code_length: totp_code_length,
      totp_skew: totp_skew,
      default_template_sid: default_template_sid,
  )
end

#url ⇒ String 



625
626
627
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 625

def url
  @properties['url']
end

#verification_checks ⇒ verification_checks

Access the verification_checks



734
735
736
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 734

def verification_checks
  context.verification_checks
end

#verifications ⇒ verifications

Access the verifications



727
728
729
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 727

def verifications
  context.verifications
end

#webhooks ⇒ webhooks

Access the webhooks



762
763
764
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 762

def webhooks
  context.webhooks
end