Class: Twilio::REST::Verify::V2::ServiceInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Verify::V2::ServiceInstance
- Defined in:
- lib/twilio-ruby/rest/verify/v2/service.rb
Instance Method Summary collapse
-
#access_tokens ⇒ access_tokens
Access the access_tokens.
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Service resource.
-
#code_length ⇒ String
The length of the verification code to generate.
-
#context ⇒ ServiceContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#custom_code_enabled ⇒ Boolean
Whether to allow sending verifications with a custom code instead of a randomly generated one.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
- #default_template_sid ⇒ String
-
#delete ⇒ Boolean
Delete the ServiceInstance.
-
#do_not_share_warning_enabled ⇒ Boolean
Whether to add a security warning at the end of an SMS verification body.
-
#dtmf_input_required ⇒ Boolean
Whether to ask the user to press a number before delivering the verify code in a phone call.
-
#entities ⇒ entities
Access the entities.
-
#fetch ⇒ ServiceInstance
Fetch the ServiceInstance.
-
#friendly_name ⇒ String
The string that you assigned to describe the verification service.
-
#initialize(version, payload, sid: nil) ⇒ ServiceInstance
constructor
Initialize the ServiceInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ Hash
The URLs of related resources.
-
#lookup_enabled ⇒ Boolean
Whether to perform a lookup with each verification started and return info about the phone number.
-
#messaging_configurations ⇒ messaging_configurations
Access the messaging_configurations.
-
#psd2_enabled ⇒ Boolean
Whether to pass PSD2 transaction parameters when starting a verification.
-
#push ⇒ Hash
Configurations for the Push factors (channel) created under this Service.
-
#rate_limits ⇒ rate_limits
Access the rate_limits.
-
#sid ⇒ String
The unique string that we created to identify the Service resource.
-
#skip_sms_to_landlines ⇒ Boolean
Whether to skip sending SMS verifications to landlines.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#totp ⇒ Hash
Configurations for the TOTP factors (channel) created under this Service.
-
#tts_name ⇒ String
The name of an alternative text-to-speech service to use in phone calls.
-
#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.
-
#url ⇒ String
The absolute URL of the resource.
-
#verification_checks ⇒ verification_checks
Access the verification_checks.
-
#verifications ⇒ verifications
Access the verifications.
-
#webhooks ⇒ webhooks
Access the webhooks.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ ServiceInstance
Initialize the ServiceInstance
483 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 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 483 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
726 727 728 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 726 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.
532 533 534 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 532 def account_sid @properties['account_sid'] end |
#code_length ⇒ String
Returns The length of the verification code to generate.
544 545 546 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 544 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
517 518 519 520 521 522 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 517 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.
586 587 588 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 586 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.
610 611 612 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 610 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.
616 617 618 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 616 def date_updated @properties['date_updated'] end |
#default_template_sid ⇒ String
604 605 606 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 604 def default_template_sid @properties['default_template_sid'] end |
#delete ⇒ Boolean
Delete the ServiceInstance
635 636 637 638 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 635 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`.
580 581 582 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 580 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.
568 569 570 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 568 def dtmf_input_required @properties['dtmf_input_required'] end |
#entities ⇒ entities
Access the entities
747 748 749 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 747 def entities context.entities end |
#fetch ⇒ ServiceInstance
Fetch the ServiceInstance
643 644 645 646 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 643 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.**.
538 539 540 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 538 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
767 768 769 770 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 767 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Verify.V2.ServiceInstance #{values}>" end |
#links ⇒ Hash
Returns The URLs of related resources.
628 629 630 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 628 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.
550 551 552 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 550 def lookup_enabled @properties['lookup_enabled'] end |
#messaging_configurations ⇒ messaging_configurations
Access the messaging_configurations
740 741 742 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 740 def messaging_configurations context.messaging_configurations end |
#psd2_enabled ⇒ Boolean
Returns Whether to pass PSD2 transaction parameters when starting a verification.
556 557 558 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 556 def psd2_enabled @properties['psd2_enabled'] end |
#push ⇒ Hash
Returns Configurations for the Push factors (channel) created under this Service.
592 593 594 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 592 def push @properties['push'] end |
#rate_limits ⇒ rate_limits
Access the rate_limits
754 755 756 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 754 def rate_limits context.rate_limits end |
#sid ⇒ String
Returns The unique string that we created to identify the Service resource.
526 527 528 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 526 def sid @properties['sid'] end |
#skip_sms_to_landlines ⇒ Boolean
Returns Whether to skip sending SMS verifications to landlines. Requires ‘lookup_enabled`.
562 563 564 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 562 def skip_sms_to_landlines @properties['skip_sms_to_landlines'] end |
#to_s ⇒ Object
Provide a user friendly representation
760 761 762 763 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 760 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.
598 599 600 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 598 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.
574 575 576 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 574 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
668 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 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 668 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.
622 623 624 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 622 def url @properties['url'] end |
#verification_checks ⇒ verification_checks
Access the verification_checks
712 713 714 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 712 def verification_checks context.verification_checks end |
#verifications ⇒ verifications
Access the verifications
719 720 721 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 719 def verifications context.verifications end |
#webhooks ⇒ webhooks
Access the webhooks
733 734 735 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 733 def webhooks context.webhooks end |