twilio-ruby 5.45.0 → 5.60.0

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

@@ -31,19 +31,23 @@ module Twilio
             # Create the WebhookInstance
             # @param [String] friendly_name The string that you assigned to describe the
             #   webhook. **This value should not contain PII.**
-            # @param [String] event_types The array of events that this Webhook is subscribed
-            #   to. Possible event types: `*, factor.deleted, factor.created, factor.verified,
-            #   challenge.approved, challenge.denied`
+            # @param [Array[String]] event_types The array of events that this Webhook is
+            #   subscribed to. Possible event types: `*, factor.deleted, factor.created,
+            #   factor.verified, challenge.approved, challenge.denied`
             # @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)
@@ -191,19 +195,23 @@ module Twilio
             # Update the WebhookInstance
             # @param [String] friendly_name The string that you assigned to describe the
             #   webhook. **This value should not contain PII.**
-            # @param [String] event_types The array of events that this Webhook is subscribed
-            #   to. Possible event types: `*, factor.deleted, factor.created, factor.verified,
-            #   challenge.approved, challenge.denied`
+            # @param [Array[String]] event_types The array of events that this Webhook is
+            #   subscribed to. Possible event types: `*, factor.deleted, factor.created,
+            #   factor.verified, challenge.approved, challenge.denied`
             # @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)
@@ -264,6 +272,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']),
@@ -312,7 +321,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The array of events that this Webhook is subscribed to.
+            # @return [Array[String]] The array of events that this Webhook is subscribed to.
             def event_types
               @properties['event_types']
             end
@@ -323,6 +332,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 +351,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
@@ -357,19 +372,23 @@ module Twilio
             # Update the WebhookInstance
             # @param [String] friendly_name The string that you assigned to describe the
             #   webhook. **This value should not contain PII.**
-            # @param [String] event_types The array of events that this Webhook is subscribed
-            #   to. Possible event types: `*, factor.deleted, factor.created, factor.verified,
-            #   challenge.approved, challenge.denied`
+            # @param [Array[String]] event_types The array of events that this Webhook is
+            #   subscribed to. Possible event types: `*, factor.deleted, factor.created,
+            #   factor.verified, challenge.approved, challenge.denied`
             # @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

@@ -60,8 +60,21 @@ 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
           # @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)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'CodeLength' => code_length,
@@ -75,6 +88,10 @@ 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,
             })
 
             payload = @version.create('POST', @uri, data: data)
@@ -273,8 +290,21 @@ 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
           # @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)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'CodeLength' => code_length,
@@ -288,6 +318,10 @@ 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,
             })
 
             payload = @version.update('POST', @uri, data: data)
@@ -449,6 +483,7 @@ 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'],
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                 'url' => payload['url'],
@@ -543,6 +578,12 @@ module Twilio
             @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
@@ -616,8 +657,21 @@ 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
           # @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)
             context.update(
                 friendly_name: friendly_name,
                 code_length: code_length,
@@ -631,6 +685,10 @@ 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,
             )
           end
 

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

@@ -0,0 +1,206 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Verify < Domain
+      class V2 < Version
+        class TemplateList < ListResource
+          ##
+          # Initialize the TemplateList
+          # @param [Version] version Version that contains the resource
+          # @return [TemplateList] TemplateList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Templates"
+          end
+
+          ##
+          # Lists TemplateInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [String] friendly_name String filter used to query templates with a given
+          #   friendly name
+          # @param [Integer] limit Upper limit for the number of records to return. stream()
+          #    guarantees to never return more than limit.  Default is no limit
+          # @param [Integer] page_size Number of records to fetch per request, when
+          #    not set will use the default value of 50 records.  If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Array] Array of up to limit results
+          def list(friendly_name: :unset, limit: nil, page_size: nil)
+            self.stream(friendly_name: friendly_name, limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams TemplateInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [String] friendly_name String filter used to query templates with a given
+          #   friendly name
+          # @param [Integer] limit Upper limit for the number of records to return. stream()
+          #    guarantees to never return more than limit. Default is no limit.
+          # @param [Integer] page_size Number of records to fetch per request, when
+          #    not set will use the default value of 50 records. If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Enumerable] Enumerable that will yield up to limit results
+          def stream(friendly_name: :unset, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(friendly_name: friendly_name, page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields TemplateInstance records from the API.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          def each
+            limits = @version.read_limits
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+          end
+
+          ##
+          # Retrieve a single page of TemplateInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] friendly_name String filter used to query templates with a given
+          #   friendly name
+          # @param [String] page_token PageToken provided by the API
+          # @param [Integer] page_number Page Number, this value is simply for client state
+          # @param [Integer] page_size Number of records to return, defaults to 50
+          # @return [Page] Page of TemplateInstance
+          def page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'FriendlyName' => friendly_name,
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            TemplatePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of TemplateInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of TemplateInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            TemplatePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Verify.V2.TemplateList>'
+          end
+        end
+
+        class TemplatePage < Page
+          ##
+          # Initialize the TemplatePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [TemplatePage] TemplatePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of TemplateInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [TemplateInstance] TemplateInstance
+          def get_instance(payload)
+            TemplateInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Verify.V2.TemplatePage>'
+          end
+        end
+
+        class TemplateInstance < InstanceResource
+          ##
+          # Initialize the TemplateInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [TemplateInstance] TemplateInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'friendly_name' => payload['friendly_name'],
+                'translations' => payload['translations'],
+            }
+          end
+
+          ##
+          # @return [String] A string that uniquely identifies this Template
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] Account Sid
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] A string to describe the verification template
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [Hash] Ojbect with the template translations.
+          def translations
+            @properties['translations']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Verify.V2.TemplateInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Verify.V2.TemplateInstance>"
+          end
+        end
+      end
+    end
+  end
+end