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

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 Service resource.

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

    The SID of the Call resource to fetch.



484
485
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
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 484

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'] == nil ? payload['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

Returns:



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

def access_tokens
    context.access_tokens
end

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Service resource.

Returns:



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

def 
    @properties['account_sid']
end

#code_length ⇒ String

Returns The length of the verification code to generate.

Returns:

  • (String) —

    The length of the verification code to generate.



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

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

Returns:



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

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

#custom_code_enabled ⇒ Boolean

Returns Whether to allow sending verifications with a custom code instead of a randomly generated one. Not available for all customers.

Returns:

  • (Boolean) —

    Whether to allow sending verifications with a custom code instead of a randomly generated one. Not available for all customers.



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

def custom_code_enabled
    @properties['custom_code_enabled']
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#default_template_sid ⇒ String

Returns:

  • (String) 


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

def default_template_sid
    @properties['default_template_sid']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#do_not_share_warning_enabled ⇒ Boolean

Returns Whether to add a security warning at the end of an SMS verification body. Disabled by default and applies only to SMS. Example SMS body: ‘Your AppName verification code is: 1234. Don’t share this code with anyone; our employees will never ask for the code`.

Returns:

  • (Boolean) —

    Whether to add a security warning at the end of an SMS verification body. Disabled by default and applies only to SMS. Example SMS body: ‘Your AppName verification code is: 1234. Don’t share this code with anyone; our employees will never ask for the code`



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

def do_not_share_warning_enabled
    @properties['do_not_share_warning_enabled']
end

#dtmf_input_required ⇒ Boolean

Returns Whether to ask the user to press a number before delivering the verify code in a phone call.

Returns:

  • (Boolean) —

    Whether to ask the user to press a number before delivering the verify code in a phone call.



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

def dtmf_input_required
    @properties['dtmf_input_required']
end

#entities ⇒ entities

Access the entities

Returns:



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

def entities
    context.entities
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the verification service. It can be up to 32 characters long. **This value should not contain PII.**.

Returns:

  • (String) —

    The string that you assigned to describe the verification service. It can be up to 32 characters long. **This value should not contain PII.**



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



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

def links
    @properties['links']
end

#lookup_enabled ⇒ Boolean

Returns Whether to perform a lookup with each verification started and return info about the phone number.

Returns:

  • (Boolean) —

    Whether to perform a lookup with each verification started and return info about the phone number.



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

def lookup_enabled
    @properties['lookup_enabled']
end

#messaging_configurations ⇒ messaging_configurations

Access the messaging_configurations

Returns:



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

def messaging_configurations
    context.messaging_configurations
end

#psd2_enabled ⇒ Boolean

Returns Whether to pass PSD2 transaction parameters when starting a verification.

Returns:

  • (Boolean) —

    Whether to pass PSD2 transaction parameters when starting a verification.



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

def psd2_enabled
    @properties['psd2_enabled']
end

#push ⇒ Hash

Returns Configurations for the Push factors (channel) created under this Service.

Returns:

  • (Hash) —

    Configurations for the Push factors (channel) created under this Service.



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

def push
    @properties['push']
end

#rate_limits ⇒ rate_limits

Access the rate_limits

Returns:



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

def rate_limits
    context.rate_limits
end

#sid ⇒ String

Returns The unique string that we created to identify the Service resource.

Returns:

  • (String) —

    The unique string that we created to identify the Service resource.



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

def sid
    @properties['sid']
end

#skip_sms_to_landlines ⇒ Boolean

Returns Whether to skip sending SMS verifications to landlines. Requires ‘lookup_enabled`.

Returns:

  • (Boolean) —

    Whether to skip sending SMS verifications to landlines. Requires ‘lookup_enabled`.



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

def skip_sms_to_landlines
    @properties['skip_sms_to_landlines']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#totp ⇒ Hash

Returns Configurations for the TOTP factors (channel) created under this Service.

Returns:

  • (Hash) —

    Configurations for the TOTP factors (channel) created under this Service.



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

def totp
    @properties['totp']
end

#tts_name ⇒ String

Returns The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.

Returns:

  • (String) —

    The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.



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

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

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you create to describe the verification service. It can be up to 32 characters long. **This value should not contain PII.**

  • code_length (String) (defaults to: :unset) —

    The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive.

  • lookup_enabled (Boolean) (defaults to: :unset) —

    Whether to perform a lookup with each verification started and return info about the phone number.

  • skip_sms_to_landlines (Boolean) (defaults to: :unset) —

    Whether to skip sending SMS verifications to landlines. Requires ‘lookup_enabled`.

  • dtmf_input_required (Boolean) (defaults to: :unset) —

    Whether to ask the user to press a number before delivering the verify code in a phone call.

  • tts_name (String) (defaults to: :unset) —

    The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.

  • psd2_enabled (Boolean) (defaults to: :unset) —

    Whether to pass PSD2 transaction parameters when starting a verification.

  • do_not_share_warning_enabled (Boolean) (defaults to: :unset) —

    Whether to add a privacy warning at the end of an SMS. **Disabled by default and applies only for SMS.**

  • custom_code_enabled (Boolean) (defaults to: :unset) —

    Whether to allow sending verifications with a custom code instead of a randomly generated one. Not available for all customers.

  • push_include_date (Boolean) (defaults to: :unset) —

    Optional configuration for the Push factors. If true, include the date in the Challenge’s response. Otherwise, the date is omitted from the response. See [Challenge](www.twilio.com/docs/verify/api/challenge) resource’s details parameter for more info. Default: false. Deprecated do not use this parameter.

  • push_apn_credential_sid (String) (defaults to: :unset) —

    Optional configuration for the Push factors. Set the APN Credential for this service. This will allow to send push notifications to iOS devices. See [Credential Resource](www.twilio.com/docs/notify/api/credential-resource)

  • push_fcm_credential_sid (String) (defaults to: :unset) —

    Optional configuration for the Push factors. Set the FCM Credential for this service. This will allow to send push notifications to Android devices. See [Credential Resource](www.twilio.com/docs/notify/api/credential-resource)

  • totp_issuer (String) (defaults to: :unset) —

    Optional configuration for the TOTP factors. Set TOTP Issuer for this service. This will allow to configure the issuer of the TOTP URI.

  • totp_time_step (String) (defaults to: :unset) —

    Optional configuration for the TOTP factors. Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. Defaults to 30 seconds

  • totp_code_length (String) (defaults to: :unset) —

    Optional configuration for the TOTP factors. Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. Defaults to 6

  • totp_skew (String) (defaults to: :unset) —

    Optional configuration for the TOTP factors. The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. Defaults to 1

  • default_template_sid (String) (defaults to: :unset) —

    The default message [template](www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only.

Returns:



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 669

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

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



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

def url
    @properties['url']
end

#verification_checks ⇒ verification_checks

Access the verification_checks

Returns:



713
714
715
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 713

def verification_checks
    context.verification_checks
end

#verifications ⇒ verifications

Access the verifications

Returns:



720
721
722
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 720

def verifications
    context.verifications
end

#webhooks ⇒ webhooks

Access the webhooks

Returns:



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

def webhooks
    context.webhooks
end