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.



563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 563

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'],
        'whatsapp' => payload['whatsapp'],
        'passkeys' => payload['passkeys'],
        'verify_event_subscription_enabled' => payload['verify_event_subscription_enabled'],
        '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:



854
855
856
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 854

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:



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

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.



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

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:



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

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.

Returns:

  • (Boolean) —

    Whether to allow sending verifications with a custom code instead of a randomly generated one.



669
670
671
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 669

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:



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

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:



717
718
719
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 717

def date_updated
    @properties['date_updated']
end

#default_template_sid ⇒ String

Returns:

  • (String) 


687
688
689
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 687

def default_template_sid
    @properties['default_template_sid']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



736
737
738
739
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 736

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`



663
664
665
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 663

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.



651
652
653
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 651

def dtmf_input_required
    @properties['dtmf_input_required']
end

#entities ⇒ entities

Access the entities

Returns:



875
876
877
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 875

def entities
    context.entities
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



744
745
746
747
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 744

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The name that appears in the body of your verification messages. It can be up to 30 characters long and can include letters, numbers, spaces, dashes, underscores. Phone numbers, special characters or links are NOT allowed. It cannot contain more than 4 (consecutive or non-consecutive) digits. **This value should not contain PII.**.

Returns:

  • (String) —

    The name that appears in the body of your verification messages. It can be up to 30 characters long and can include letters, numbers, spaces, dashes, underscores. Phone numbers, special characters or links are NOT allowed. It cannot contain more than 4 (consecutive or non-consecutive) digits. **This value should not contain PII.**



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



895
896
897
898
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 895

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.



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

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.



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

def lookup_enabled
    @properties['lookup_enabled']
end

#messaging_configurations ⇒ messaging_configurations

Access the messaging_configurations

Returns:



868
869
870
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 868

def messaging_configurations
    context.messaging_configurations
end

#passkeys ⇒ Hash

Returns:

  • (Hash) 


699
700
701
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 699

def passkeys
    @properties['passkeys']
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.



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

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.



675
676
677
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 675

def push
    @properties['push']
end

#rate_limits ⇒ rate_limits

Access the rate_limits

Returns:



882
883
884
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 882

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.



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

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



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

def skip_sms_to_landlines
    @properties['skip_sms_to_landlines']
end

#to_s ⇒ Object

Provide a user friendly representation



888
889
890
891
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 888

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.



681
682
683
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 681

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.



657
658
659
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 657

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, whatsapp_msg_service_sid: :unset, whatsapp_from: :unset, passkeys_relying_party_id: :unset, passkeys_relying_party_name: :unset, passkeys_relying_party_origins: :unset, passkeys_authenticator_attachment: :unset, passkeys_discoverable_credentials: :unset, passkeys_user_verification: :unset, verify_event_subscription_enabled: :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.

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

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

    The SID of the [Messaging Service](www.twilio.com/docs/messaging/services) to associate with the Verification Service.

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

    The WhatsApp number to use as the sender of the verification messages. This number must be associated with the WhatsApp Message Service.

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

    The Relying Party ID for Passkeys. This is the domain of your application, e.g. ‘example.com`. It is used to identify your application when creating Passkeys.

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

    The Relying Party Name for Passkeys. This is the name of your application, e.g. ‘Example App`. It is used to identify your application when creating Passkeys.

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

    The Relying Party Origins for Passkeys. This is the origin of your application, e.g. ‘login.example.com,www.example.com`. It is used to identify your application when creating Passkeys, it can have multiple origins split by `,`.

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

    The Authenticator Attachment for Passkeys. This is the type of authenticator that will be used to create Passkeys. It can be empty or it can have the values ‘platform`, `cross-platform` or `any`.

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

    Indicates whether credentials must be discoverable by the authenticator. It can be empty or it can have the values ‘required`, `preferred` or `discouraged`.

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

    The User Verification for Passkeys. This is the type of user verification that will be used to create Passkeys. It can be empty or it can have the values ‘required`, `preferred` or `discouraged`.

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

    Whether to allow verifications from the service to reach the stream-events sinks if configured

Returns:



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 778

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, 
    whatsapp_msg_service_sid: :unset, 
    whatsapp_from: :unset, 
    passkeys_relying_party_id: :unset, 
    passkeys_relying_party_name: :unset, 
    passkeys_relying_party_origins: :unset, 
    passkeys_authenticator_attachment: :unset, 
    passkeys_discoverable_credentials: :unset, 
    passkeys_user_verification: :unset, 
    verify_event_subscription_enabled: :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, 
        whatsapp_msg_service_sid: whatsapp_msg_service_sid, 
        whatsapp_from: whatsapp_from, 
        passkeys_relying_party_id: passkeys_relying_party_id, 
        passkeys_relying_party_name: passkeys_relying_party_name, 
        passkeys_relying_party_origins: passkeys_relying_party_origins, 
        passkeys_authenticator_attachment: passkeys_authenticator_attachment, 
        passkeys_discoverable_credentials: passkeys_discoverable_credentials, 
        passkeys_user_verification: passkeys_user_verification, 
        verify_event_subscription_enabled: verify_event_subscription_enabled, 
    )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



723
724
725
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 723

def url
    @properties['url']
end

#verification_checks ⇒ verification_checks

Access the verification_checks

Returns:



840
841
842
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 840

def verification_checks
    context.verification_checks
end

#verifications ⇒ verifications

Access the verifications

Returns:



847
848
849
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 847

def verifications
    context.verifications
end

#verify_event_subscription_enabled ⇒ Boolean

Returns Whether to allow verifications from the service to reach the stream-events sinks if configured.

Returns:

  • (Boolean) —

    Whether to allow verifications from the service to reach the stream-events sinks if configured



705
706
707
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 705

def verify_event_subscription_enabled
    @properties['verify_event_subscription_enabled']
end

#webhooks ⇒ webhooks

Access the webhooks

Returns:



861
862
863
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 861

def webhooks
    context.webhooks
end

#whatsapp ⇒ Hash

Returns:

  • (Hash) 


693
694
695
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 693

def whatsapp
    @properties['whatsapp']
end