twilio-ruby 5.31.1 → 5.54.0

data/lib/twilio-ruby/rest/verify/v2/service.rb

@@ -24,10 +24,9 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of ServiceInstance records from the API.
-          # Request is executed immediately.
+          # Create the ServiceInstance
           # @param [String] friendly_name A descriptive string that you create to describe
-          #   the verification service. It can be up to 64 characters long. **This value
+          #   the verification service. It can be up to 30 characters long. **This value
           #   should not contain PII.**
           # @param [String] code_length The length of the verification code to generate.
           #   Must be an integer value between 4 and 10, inclusive.
@@ -41,8 +40,41 @@ module Twilio
           #   use in phone calls. Applies only to TTS languages.
           # @param [Boolean] psd2_enabled Whether to pass PSD2 transaction parameters when
           #   starting a verification.
-          # @return [ServiceInstance] Newly created ServiceInstance
-          def create(friendly_name: nil, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset)
+          # @param [Boolean] do_not_share_warning_enabled 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`
+          # @param [Boolean] custom_code_enabled Whether to allow sending verifications with
+          #   a custom code instead of a randomly generated one. Not available for all
+          #   customers.
+          # @param [Boolean] push_include_date Optional configuration for the Push factors.
+          #   If true, include the date in the Challenge's reponse. Otherwise, the date is
+          #   omitted from the response. See
+          #   {Challenge}[https://www.twilio.com/docs/verify/api/challenge] resource’s details
+          #   parameter for more info. Default: true
+          # @param [String] push_apn_credential_sid 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}[https://www.twilio.com/docs/notify/api/credential-resource]
+          # @param [String] push_fcm_credential_sid 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}[https://www.twilio.com/docs/notify/api/credential-resource]
+          # @param [String] totp_issuer Optional configuration for the TOTP factors. Set
+          #   TOTP Issuer for this service. This will allow to configure the issuer of the
+          #   TOTP URI. Defaults to the service friendly name if not provided.
+          # @param [String] totp_time_step 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
+          # @param [String] totp_code_length Optional configuration for the TOTP factors.
+          #   Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive.
+          #   Defaults to 6
+          # @param [String] totp_skew 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
+          # @return [ServiceInstance] Created ServiceInstance
+          def create(friendly_name: nil, 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)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'CodeLength' => code_length,
@@ -51,13 +83,18 @@ module Twilio
                 'DtmfInputRequired' => dtmf_input_required,
                 'TtsName' => tts_name,
                 'Psd2Enabled' => psd2_enabled,
+                'DoNotShareWarningEnabled' => do_not_share_warning_enabled,
+                'CustomCodeEnabled' => custom_code_enabled,
+                'Push.IncludeDate' => push_include_date,
+                'Push.ApnCredentialSid' => push_apn_credential_sid,
+                'Push.FcmCredentialSid' => push_fcm_credential_sid,
+                'Totp.Issuer' => totp_issuer,
+                'Totp.TimeStep' => totp_time_step,
+                'Totp.CodeLength' => totp_code_length,
+                'Totp.Skew' => totp_skew,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             ServiceInstance.new(@version, payload, )
           end
@@ -123,11 +160,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             ServicePage.new(@version, response, @solution)
           end
 
@@ -199,34 +234,31 @@ module Twilio
             @verification_checks = nil
             @rate_limits = nil
             @messaging_configurations = nil
+            @entities = nil
+            @webhooks = nil
+            @access_tokens = nil
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the ServiceInstance
+          # Delete the ServiceInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
           # Update the ServiceInstance
           # @param [String] friendly_name A descriptive string that you create to describe
-          #   the verification service. It can be up to 64 characters long. **This value
+          #   the verification service. It can be up to 30 characters long. **This value
           #   should not contain PII.**
           # @param [String] code_length The length of the verification code to generate.
           #   Must be an integer value between 4 and 10, inclusive.
@@ -240,8 +272,39 @@ module Twilio
           #   use in phone calls. Applies only to TTS languages.
           # @param [Boolean] psd2_enabled Whether to pass PSD2 transaction parameters when
           #   starting a verification.
+          # @param [Boolean] do_not_share_warning_enabled Whether to add a privacy warning
+          #   at the end of an SMS. **Disabled by default and applies only for SMS.**
+          # @param [Boolean] custom_code_enabled Whether to allow sending verifications with
+          #   a custom code instead of a randomly generated one. Not available for all
+          #   customers.
+          # @param [Boolean] push_include_date Optional configuration for the Push factors.
+          #   If true, include the date in the Challenge's reponse. Otherwise, the date is
+          #   omitted from the response. See
+          #   {Challenge}[https://www.twilio.com/docs/verify/api/challenge] resource’s details
+          #   parameter for more info. Default: true
+          # @param [String] push_apn_credential_sid 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}[https://www.twilio.com/docs/notify/api/credential-resource]
+          # @param [String] push_fcm_credential_sid 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}[https://www.twilio.com/docs/notify/api/credential-resource]
+          # @param [String] totp_issuer Optional configuration for the TOTP factors. Set
+          #   TOTP Issuer for this service. This will allow to configure the issuer of the
+          #   TOTP URI.
+          # @param [String] totp_time_step 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
+          # @param [String] totp_code_length Optional configuration for the TOTP factors.
+          #   Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive.
+          #   Defaults to 6
+          # @param [String] totp_skew 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
           # @return [ServiceInstance] Updated ServiceInstance
-          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)
+          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)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'CodeLength' => code_length,
@@ -250,13 +313,18 @@ module Twilio
                 'DtmfInputRequired' => dtmf_input_required,
                 'TtsName' => tts_name,
                 'Psd2Enabled' => psd2_enabled,
+                'DoNotShareWarningEnabled' => do_not_share_warning_enabled,
+                'CustomCodeEnabled' => custom_code_enabled,
+                'Push.IncludeDate' => push_include_date,
+                'Push.ApnCredentialSid' => push_apn_credential_sid,
+                'Push.FcmCredentialSid' => push_fcm_credential_sid,
+                'Totp.Issuer' => totp_issuer,
+                'Totp.TimeStep' => totp_time_step,
+                'Totp.CodeLength' => totp_code_length,
+                'Totp.Skew' => totp_skew,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -327,6 +395,54 @@ module Twilio
             @messaging_configurations
           end
 
+          ##
+          # Access the entities
+          # @return [EntityList]
+          # @return [EntityContext] if identity was passed.
+          def entities(identity=:unset)
+            raise ArgumentError, 'identity cannot be nil' if identity.nil?
+
+            if identity != :unset
+              return EntityContext.new(@version, @solution[:sid], identity, )
+            end
+
+            unless @entities
+              @entities = EntityList.new(@version, service_sid: @solution[:sid], )
+            end
+
+            @entities
+          end
+
+          ##
+          # Access the webhooks
+          # @return [WebhookList]
+          # @return [WebhookContext] if sid was passed.
+          def webhooks(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return WebhookContext.new(@version, @solution[:sid], sid, )
+            end
+
+            unless @webhooks
+              @webhooks = WebhookList.new(@version, service_sid: @solution[:sid], )
+            end
+
+            @webhooks
+          end
+
+          ##
+          # Access the access_tokens
+          # @return [AccessTokenList]
+          # @return [AccessTokenContext]
+          def access_tokens
+            unless @access_tokens
+              @access_tokens = AccessTokenList.new(@version, service_sid: @solution[:sid], )
+            end
+
+            @access_tokens
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
@@ -364,6 +480,10 @@ module Twilio
                 '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'],
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                 'url' => payload['url'],
@@ -440,6 +560,30 @@ module Twilio
             @properties['tts_name']
           end
 
+          ##
+          # @return [Boolean] Whether to add a security warning at the end of an SMS.
+          def do_not_share_warning_enabled
+            @properties['do_not_share_warning_enabled']
+          end
+
+          ##
+          # @return [Boolean] Whether to allow sending verifications with a custom code.
+          def custom_code_enabled
+            @properties['custom_code_enabled']
+          end
+
+          ##
+          # @return [Hash] The service level configuration of factor push type.
+          def push
+            @properties['push']
+          end
+
+          ##
+          # @return [Hash] The service level configuration of factor TOTP type.
+          def totp
+            @properties['totp']
+          end
+
           ##
           # @return [Time] The RFC 2822 date and time in GMT when the resource was created
           def date_created
@@ -465,14 +609,14 @@ module Twilio
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Deletes the ServiceInstance
+          # Delete the ServiceInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
@@ -481,7 +625,7 @@ module Twilio
           ##
           # Update the ServiceInstance
           # @param [String] friendly_name A descriptive string that you create to describe
-          #   the verification service. It can be up to 64 characters long. **This value
+          #   the verification service. It can be up to 30 characters long. **This value
           #   should not contain PII.**
           # @param [String] code_length The length of the verification code to generate.
           #   Must be an integer value between 4 and 10, inclusive.
@@ -495,8 +639,39 @@ module Twilio
           #   use in phone calls. Applies only to TTS languages.
           # @param [Boolean] psd2_enabled Whether to pass PSD2 transaction parameters when
           #   starting a verification.
+          # @param [Boolean] do_not_share_warning_enabled Whether to add a privacy warning
+          #   at the end of an SMS. **Disabled by default and applies only for SMS.**
+          # @param [Boolean] custom_code_enabled Whether to allow sending verifications with
+          #   a custom code instead of a randomly generated one. Not available for all
+          #   customers.
+          # @param [Boolean] push_include_date Optional configuration for the Push factors.
+          #   If true, include the date in the Challenge's reponse. Otherwise, the date is
+          #   omitted from the response. See
+          #   {Challenge}[https://www.twilio.com/docs/verify/api/challenge] resource’s details
+          #   parameter for more info. Default: true
+          # @param [String] push_apn_credential_sid 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}[https://www.twilio.com/docs/notify/api/credential-resource]
+          # @param [String] push_fcm_credential_sid 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}[https://www.twilio.com/docs/notify/api/credential-resource]
+          # @param [String] totp_issuer Optional configuration for the TOTP factors. Set
+          #   TOTP Issuer for this service. This will allow to configure the issuer of the
+          #   TOTP URI.
+          # @param [String] totp_time_step 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
+          # @param [String] totp_code_length Optional configuration for the TOTP factors.
+          #   Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive.
+          #   Defaults to 6
+          # @param [String] totp_skew 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
           # @return [ServiceInstance] Updated ServiceInstance
-          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)
+          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)
             context.update(
                 friendly_name: friendly_name,
                 code_length: code_length,
@@ -505,6 +680,15 @@ module Twilio
                 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,
             )
           end
 
@@ -536,6 +720,27 @@ module Twilio
             context.messaging_configurations
           end
 
+          ##
+          # Access the entities
+          # @return [entities] entities
+          def entities
+            context.entities
+          end
+
+          ##
+          # Access the webhooks
+          # @return [webhooks] webhooks
+          def webhooks
+            context.webhooks
+          end
+
+          ##
+          # Access the access_tokens
+          # @return [access_tokens] access_tokens
+          def access_tokens
+            context.access_tokens
+          end
+
           ##
           # Provide a user friendly representation
           def to_s

data/lib/twilio-ruby/rest/verify/v2/service/access_token.rb

@@ -0,0 +1,124 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Verify < Domain
+      class V2 < Version
+        class ServiceContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AccessTokenList < ListResource
+            ##
+            # Initialize the AccessTokenList
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The unique string that we created to identify the
+            #   Service resource.
+            # @return [AccessTokenList] AccessTokenList
+            def initialize(version, service_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {service_sid: service_sid}
+              @uri = "/Services/#{@solution[:service_sid]}/AccessTokens"
+            end
+
+            ##
+            # Create the AccessTokenInstance
+            # @param [String] identity The unique external identifier for the Entity of the
+            #   Service. This identifier should be immutable, not PII, and generated by your
+            #   external system, such as your user's UUID, GUID, or SID.
+            # @param [access_token.FactorTypes] factor_type The Type of this Factor. Eg.
+            #   `push`
+            # @return [AccessTokenInstance] Created AccessTokenInstance
+            def create(identity: nil, factor_type: nil)
+              data = Twilio::Values.of({'Identity' => identity, 'FactorType' => factor_type, })
+
+              payload = @version.create('POST', @uri, data: data)
+
+              AccessTokenInstance.new(@version, payload, service_sid: @solution[:service_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Verify.V2.AccessTokenList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AccessTokenPage < Page
+            ##
+            # Initialize the AccessTokenPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [AccessTokenPage] AccessTokenPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of AccessTokenInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [AccessTokenInstance] AccessTokenInstance
+            def get_instance(payload)
+              AccessTokenInstance.new(@version, payload, service_sid: @solution[:service_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Verify.V2.AccessTokenPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AccessTokenInstance < InstanceResource
+            ##
+            # Initialize the AccessTokenInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] service_sid The unique string that we created to identify the
+            #   Service resource.
+            # @return [AccessTokenInstance] AccessTokenInstance
+            def initialize(version, payload, service_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {'token' => payload['token'], }
+            end
+
+            ##
+            # @return [String] Generated access token.
+            def token
+              @properties['token']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Verify.V2.AccessTokenInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Verify.V2.AccessTokenInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end