twilio-ruby 5.47.0 → 5.74.0

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

@@ -32,8 +32,9 @@ module Twilio
             # @param [String] to The phone number or
             #   {email}[https://www.twilio.com/docs/verify/email] to verify. Phone numbers must
             #   be in {E.164 format}[https://www.twilio.com/docs/glossary/what-e164].
-            # @param [String] channel The verification method to use. Can be:
-            #   {`email`}[https://www.twilio.com/docs/verify/email], `sms` or `call`.
+            # @param [String] channel The verification method to use. One of:
+            #   {`email`}[https://www.twilio.com/docs/verify/email], `sms`, `whatsapp`, `call`,
+            #   or `sna`.
             # @param [String] custom_friendly_name A custom user defined friendly name that
             #   overwrites the existing one in the verification message
             # @param [String] custom_message The text of a custom message to use for the
@@ -42,10 +43,10 @@ module Twilio
             #   for example, to dial an extension. For more information, see the Programmable
             #   Voice documentation of
             #   {sendDigits}[https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits].
-            # @param [String] locale The locale to use for the verification SMS or call. Can
-            #   be: `af`, `ar`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-GB`, `es`, `fi`, `fr`,
-            #   `he`, `hi`, `hr`, `hu`, `id`, `it`, `ja`, `ko`, `ms`, `nb`, `nl`, `pl`, `pt`,
-            #   `pr-BR`, `ro`, `ru`, `sv`, `th`, `tl`, `tr`, `vi`, `zh`, `zh-CN`, or `zh-HK.`
+            # @param [String] locale Locale will automatically resolve based on phone number
+            #   country code for SMS, WhatsApp and call channel verifications. This parameter
+            #   will override the automatic locale. {See supported languages and more
+            #   information here}[https://www.twilio.com/docs/verify/supported-languages].
             # @param [String] custom_code A pre-generated code to use for verification. The
             #   code can be between 4 and 10 characters, inclusive.
             # @param [String] amount The amount of the associated PSD2 compliant transaction.
@@ -59,13 +60,20 @@ module Twilio
             #   may include multiple Rate Limit values in each request.
             # @param [Hash] channel_configuration
             #   {`email`}[https://www.twilio.com/docs/verify/email] channel configuration in
-            #   json format. Must include 'from' and 'from_name'.
+            #   json format. The fields 'from' and 'from_name' are optional but if included the
+            #   'from' field must have a valid email address.
             # @param [String] app_hash Your {App
             #   Hash}[https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string]
             #   to be appended at the end of your verification SMS body. Applies only to SMS.
             #   Example SMS body: `<#> Your AppName verification code is: 1234 He42w354ol9`.
+            # @param [String] template_sid The message
+            #   {template}[https://www.twilio.com/docs/verify/api/templates]. If provided, will
+            #   override the default template for the Service. SMS and Voice channels only.
+            # @param [String] template_custom_substitutions A stringified JSON object in which
+            #   the keys are the template's special variables and the values are the variables
+            #   substitutions.
             # @return [VerificationInstance] Created VerificationInstance
-            def create(to: nil, channel: nil, custom_friendly_name: :unset, custom_message: :unset, send_digits: :unset, locale: :unset, custom_code: :unset, amount: :unset, payee: :unset, rate_limits: :unset, channel_configuration: :unset, app_hash: :unset)
+            def create(to: nil, channel: nil, custom_friendly_name: :unset, custom_message: :unset, send_digits: :unset, locale: :unset, custom_code: :unset, amount: :unset, payee: :unset, rate_limits: :unset, channel_configuration: :unset, app_hash: :unset, template_sid: :unset, template_custom_substitutions: :unset)
               data = Twilio::Values.of({
                   'To' => to,
                   'Channel' => channel,
@@ -79,6 +87,8 @@ module Twilio
                   'RateLimits' => Twilio.serialize_object(rate_limits),
                   'ChannelConfiguration' => Twilio.serialize_object(channel_configuration),
                   'AppHash' => app_hash,
+                  'TemplateSid' => template_sid,
+                  'TemplateCustomSubstitutions' => template_custom_substitutions,
               })
 
               payload = @version.create('POST', @uri, data: data)
@@ -216,6 +226,7 @@ module Twilio
                   'send_code_attempts' => payload['send_code_attempts'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                  'sna' => payload['sna'],
                   'url' => payload['url'],
               }
 
@@ -313,6 +324,12 @@ module Twilio
               @properties['date_updated']
             end
 
+            ##
+            # @return [Hash] The set of fields used for a silent network auth (`sna`) verification
+            def sna
+              @properties['sna']
+            end
+
             ##
             # @return [String] The absolute URL of the Verification resource
             def url

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

@@ -42,7 +42,7 @@ module Twilio
             # @param [String] payee The payee of the associated PSD2 compliant transaction.
             #   Requires the PSD2 Service flag enabled.
             # @return [VerificationCheckInstance] Created VerificationCheckInstance
-            def create(code: nil, to: :unset, verification_sid: :unset, amount: :unset, payee: :unset)
+            def create(code: :unset, to: :unset, verification_sid: :unset, amount: :unset, payee: :unset)
               data = Twilio::Values.of({
                   'Code' => code,
                   'To' => to,
@@ -117,6 +117,7 @@ module Twilio
                   'payee' => payload['payee'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                  'sna_attempts_error_codes' => payload['sna_attempts_error_codes'],
               }
             end
 
@@ -186,6 +187,12 @@ module Twilio
               @properties['date_updated']
             end
 
+            ##
+            # @return [Array[Hash]] List of error codes as a result of attempting a verification using the `sna` channel.
+            def sna_attempts_error_codes
+              @properties['sna_attempts_error_codes']
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

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

@@ -11,8 +11,6 @@ module Twilio
     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 WebhookList < ListResource
             ##
             # Initialize the WebhookList
@@ -37,13 +35,17 @@ module Twilio
             # @param [String] webhook_url The URL associated with this Webhook.
             # @param [webhook.Status] status The webhook status. Default value is `enabled`.
             #   One of: `enabled` or `disabled`
+            # @param [webhook.Version] version The webhook version. Default value is `v2`
+            #   which includes all the latest fields. Version `v1` is legacy and may be removed
+            #   in the future.
             # @return [WebhookInstance] Created WebhookInstance
-            def create(friendly_name: nil, event_types: nil, webhook_url: nil, status: :unset)
+            def create(friendly_name: nil, event_types: nil, webhook_url: nil, status: :unset, version: :unset)
               data = Twilio::Values.of({
                   'FriendlyName' => friendly_name,
                   'EventTypes' => Twilio.serialize_list(event_types) { |e| e },
                   'WebhookUrl' => webhook_url,
                   'Status' => status,
+                  'Version' => version,
               })
 
               payload = @version.create('POST', @uri, data: data)
@@ -138,8 +140,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class WebhookPage < Page
             ##
             # Initialize the WebhookPage
@@ -169,8 +169,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class WebhookContext < InstanceContext
             ##
             # Initialize the WebhookContext
@@ -197,13 +195,17 @@ module Twilio
             # @param [String] webhook_url The URL associated with this Webhook.
             # @param [webhook.Status] status The webhook status. Default value is `enabled`.
             #   One of: `enabled` or `disabled`
+            # @param [webhook.Version] version The webhook version. Default value is `v2`
+            #   which includes all the latest fields. Version `v1` is legacy and may be removed
+            #   in the future.
             # @return [WebhookInstance] Updated WebhookInstance
-            def update(friendly_name: :unset, event_types: :unset, webhook_url: :unset, status: :unset)
+            def update(friendly_name: :unset, event_types: :unset, webhook_url: :unset, status: :unset, version: :unset)
               data = Twilio::Values.of({
                   'FriendlyName' => friendly_name,
                   'EventTypes' => Twilio.serialize_list(event_types) { |e| e },
                   'WebhookUrl' => webhook_url,
                   'Status' => status,
+                  'Version' => version,
               })
 
               payload = @version.update('POST', @uri, data: data)
@@ -242,8 +244,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class WebhookInstance < InstanceResource
             ##
             # Initialize the WebhookInstance
@@ -264,6 +264,7 @@ module Twilio
                   'friendly_name' => payload['friendly_name'],
                   'event_types' => payload['event_types'],
                   'status' => payload['status'],
+                  'version' => payload['version'],
                   'webhook_url' => payload['webhook_url'],
                   'webhook_method' => payload['webhook_method'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
@@ -323,6 +324,12 @@ module Twilio
               @properties['status']
             end
 
+            ##
+            # @return [webhook.Version] The webhook version
+            def version
+              @properties['version']
+            end
+
             ##
             # @return [String] The URL associated with this Webhook.
             def webhook_url
@@ -336,13 +343,13 @@ module Twilio
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
@@ -363,13 +370,17 @@ module Twilio
             # @param [String] webhook_url The URL associated with this Webhook.
             # @param [webhook.Status] status The webhook status. Default value is `enabled`.
             #   One of: `enabled` or `disabled`
+            # @param [webhook.Version] version The webhook version. Default value is `v2`
+            #   which includes all the latest fields. Version `v1` is legacy and may be removed
+            #   in the future.
             # @return [WebhookInstance] Updated WebhookInstance
-            def update(friendly_name: :unset, event_types: :unset, webhook_url: :unset, status: :unset)
+            def update(friendly_name: :unset, event_types: :unset, webhook_url: :unset, status: :unset, version: :unset)
               context.update(
                   friendly_name: friendly_name,
                   event_types: event_types,
                   webhook_url: webhook_url,
                   status: status,
+                  version: version,
               )
             end
 

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

@@ -48,10 +48,12 @@ module Twilio
           #   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
+          #   If true, include the date in the Challenge's response. 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
+          #   parameter for more info. Default: false. **Deprecated** do not use this
+          #   parameter. This timestamp value is the same one as the one found in
+          #   `date_created`, please use that one instead.
           # @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
@@ -60,8 +62,24 @@ module Twilio
           #   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
+          # @param [String] default_template_sid The default message
+          #   {template}[https://www.twilio.com/docs/verify/api/templates]. Will be used for
+          #   all SMS verifications unless explicitly overriden. SMS channel only.
           # @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)
+          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, default_template_sid: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'CodeLength' => code_length,
@@ -75,6 +93,11 @@ module Twilio
                 '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,
+                'DefaultTemplateSid' => default_template_sid,
             })
 
             payload = @version.create('POST', @uri, data: data)
@@ -261,10 +284,11 @@ module Twilio
           #   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
+          #   If true, include the date in the Challenge's response. 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
+          #   parameter for more info. Default: false. **Deprecated** do not use this
+          #   parameter.
           # @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
@@ -273,8 +297,24 @@ module Twilio
           #   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
+          # @param [String] default_template_sid The default message
+          #   {template}[https://www.twilio.com/docs/verify/api/templates]. Will be used for
+          #   all SMS verifications unless explicitly overriden. SMS channel only.
           # @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, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :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, default_template_sid: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'CodeLength' => code_length,
@@ -288,6 +328,11 @@ module Twilio
                 '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,
+                'DefaultTemplateSid' => default_template_sid,
             })
 
             payload = @version.update('POST', @uri, data: data)
@@ -400,8 +445,14 @@ module Twilio
           ##
           # Access the access_tokens
           # @return [AccessTokenList]
-          # @return [AccessTokenContext]
-          def access_tokens
+          # @return [AccessTokenContext] if sid was passed.
+          def access_tokens(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return AccessTokenContext.new(@version, @solution[:sid], sid, )
+            end
+
             unless @access_tokens
               @access_tokens = AccessTokenList.new(@version, service_sid: @solution[:sid], )
             end
@@ -440,7 +491,7 @@ module Twilio
                 'sid' => payload['sid'],
                 'account_sid' => payload['account_sid'],
                 'friendly_name' => payload['friendly_name'],
-                'code_length' => payload['code_length'].to_i,
+                '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'],
@@ -449,6 +500,8 @@ module Twilio
                 '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'],
@@ -543,6 +596,18 @@ module Twilio
             @properties['push']
           end
 
+          ##
+          # @return [Hash] The service level configuration of factor TOTP type.
+          def totp
+            @properties['totp']
+          end
+
+          ##
+          # @return [String] The default_template_sid
+          def default_template_sid
+            @properties['default_template_sid']
+          end
+
           ##
           # @return [Time] The RFC 2822 date and time in GMT when the resource was created
           def date_created
@@ -604,10 +669,11 @@ module Twilio
           #   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
+          #   If true, include the date in the Challenge's response. 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
+          #   parameter for more info. Default: false. **Deprecated** do not use this
+          #   parameter.
           # @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
@@ -616,8 +682,24 @@ module Twilio
           #   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
+          # @param [String] default_template_sid The default message
+          #   {template}[https://www.twilio.com/docs/verify/api/templates]. Will be used for
+          #   all SMS verifications unless explicitly overriden. SMS channel only.
           # @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, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :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, default_template_sid: :unset)
             context.update(
                 friendly_name: friendly_name,
                 code_length: code_length,
@@ -631,6 +713,11 @@ module Twilio
                 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