twilio-ruby 5.38.0 → 5.39.0

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

@@ -29,8 +29,8 @@ module Twilio
       end
 
       ##
-      # @param [form.FormTypes] form_type The Type of this Form. One of `form-app-push`,
-      #   `form-sms` or `form-totp`.
+      # @param [form.FormTypes] form_type The Type of this Form. Currently only
+      #   `form-push` is supported.
       # @return [Twilio::REST::Verify::V2::FormInstance] if form_type was passed.
       # @return [Twilio::REST::Verify::V2::FormList]
       def forms(form_type=:unset)

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

@@ -20,8 +20,8 @@ module Twilio
         end
 
         ##
-        # @param [form.FormTypes] form_type The Type of this Form. One of `form-app-push`,
-        #   `form-sms` or `form-totp`.
+        # @param [form.FormTypes] form_type The Type of this Form. Currently only
+        #   `form-push` is supported.
         # @return [Twilio::REST::Verify::V2::FormContext] if form_type was passed.
         # @return [Twilio::REST::Verify::V2::FormList]
         def forms(form_type=:unset)

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

@@ -68,8 +68,8 @@ module Twilio
           ##
           # Initialize the FormContext
           # @param [Version] version Version that contains the resource
-          # @param [form.FormTypes] form_type The Type of this Form. One of `form-app-push`,
-          #   `form-sms` or `form-totp`.
+          # @param [form.FormTypes] form_type The Type of this Form. Currently only
+          #   `form-push` is supported.
           # @return [FormContext] FormContext
           def initialize(version, form_type)
             super(version)
@@ -80,16 +80,10 @@ module Twilio
           end
 
           ##
-          # Fetch a FormInstance
+          # Fetch the FormInstance
           # @return [FormInstance] Fetched FormInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             FormInstance.new(@version, payload, form_type: @solution[:form_type], )
           end
@@ -116,8 +110,8 @@ module Twilio
           # Initialize the FormInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [form.FormTypes] form_type The Type of this Form. One of `form-app-push`,
-          #   `form-sms` or `form-totp`.
+          # @param [form.FormTypes] form_type The Type of this Form. Currently only
+          #   `form-push` is supported.
           # @return [FormInstance] FormInstance
           def initialize(version, payload, form_type: nil)
             super(version)
@@ -171,7 +165,7 @@ module Twilio
           end
 
           ##
-          # Fetch a FormInstance
+          # Fetch the FormInstance
           # @return [FormInstance] Fetched FormInstance
           def fetch
             context.fetch

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

@@ -24,8 +24,7 @@ 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
           #   should not contain PII.**
@@ -48,8 +47,12 @@ module Twilio
           # @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.
-          # @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, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset)
+          # @param [Hash] push The optional service level push factors configuration. If
+          #   present it must be a json string with the following format:
+          #   {"notify_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "include_date":
+          #   true}
+          # @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: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'CodeLength' => code_length,
@@ -60,13 +63,10 @@ module Twilio
                 'Psd2Enabled' => psd2_enabled,
                 'DoNotShareWarningEnabled' => do_not_share_warning_enabled,
                 'CustomCodeEnabled' => custom_code_enabled,
+                'Push' => Twilio.serialize_object(push),
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             ServiceInstance.new(@version, payload, )
           end
@@ -132,11 +132,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params)
+
             ServicePage.new(@version, response, @solution)
           end
 
@@ -210,28 +208,23 @@ module Twilio
             @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
 
           ##
@@ -256,8 +249,12 @@ module Twilio
           # @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 [Hash] push The optional service level push factors configuration. If
+          #   present it must be a json string with the following format:
+          #   {"notify_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "include_date":
+          #   true}
           # @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)
+          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: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'CodeLength' => code_length,
@@ -268,13 +265,10 @@ module Twilio
                 'Psd2Enabled' => psd2_enabled,
                 'DoNotShareWarningEnabled' => do_not_share_warning_enabled,
                 'CustomCodeEnabled' => custom_code_enabled,
+                'Push' => Twilio.serialize_object(push),
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -381,6 +375,18 @@ module Twilio
             @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
@@ -420,6 +426,7 @@ module Twilio
                 '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'],
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                 'url' => payload['url'],
@@ -508,6 +515,12 @@ module Twilio
             @properties['custom_code_enabled']
           end
 
+          ##
+          # @return [Hash] The service level configuration of factor push type.
+          def push
+            @properties['push']
+          end
+
           ##
           # @return [Time] The RFC 2822 date and time in GMT when the resource was created
           def date_created
@@ -533,14 +546,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
@@ -568,8 +581,12 @@ module Twilio
           # @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 [Hash] push The optional service level push factors configuration. If
+          #   present it must be a json string with the following format:
+          #   {"notify_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "include_date":
+          #   true}
           # @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)
+          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: :unset)
             context.update(
                 friendly_name: friendly_name,
                 code_length: code_length,
@@ -580,6 +597,7 @@ module Twilio
                 psd2_enabled: psd2_enabled,
                 do_not_share_warning_enabled: do_not_share_warning_enabled,
                 custom_code_enabled: custom_code_enabled,
+                push: push,
             )
           end
 
@@ -625,6 +643,13 @@ module Twilio
             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 preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          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 preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          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 preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          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

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

@@ -28,18 +28,16 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of EntityInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] identity Customer unique identity for the Entity of the Service
-            # @return [EntityInstance] Newly created EntityInstance
-            def create(identity: nil)
+            # Create the EntityInstance
+            # @param [String] identity The unique external identifier for the Entity of the
+            #   Service
+            # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
+            # @return [EntityInstance] Created EntityInstance
+            def create(identity: nil, twilio_sandbox_mode: :unset)
               data = Twilio::Values.of({'Identity' => identity, })
+              headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data, headers: headers)
 
               EntityInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -48,6 +46,7 @@ module Twilio
             # Lists EntityInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
+            # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
             # @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
@@ -55,14 +54,15 @@ module Twilio
             #    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(limit: nil, page_size: nil)
-              self.stream(limit: limit, page_size: page_size).entries
+            def list(twilio_sandbox_mode: :unset, limit: nil, page_size: nil)
+              self.stream(twilio_sandbox_mode: twilio_sandbox_mode, limit: limit, page_size: page_size).entries
             end
 
             ##
             # Streams EntityInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
+            # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
             # @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
@@ -70,10 +70,10 @@ module Twilio
             #    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(limit: nil, page_size: nil)
+            def stream(twilio_sandbox_mode: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[:page_size], )
+              page = self.page(twilio_sandbox_mode: twilio_sandbox_mode, page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -95,21 +95,21 @@ module Twilio
             ##
             # Retrieve a single page of EntityInstance records from the API.
             # Request is executed immediately.
+            # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
             # @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 EntityInstance
-            def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            def page(twilio_sandbox_mode: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+              headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
+
+              response = @version.page('GET', @uri, params, headers: headers)
+
               EntityPage.new(@version, response, @solution)
             end
 
@@ -171,7 +171,8 @@ module Twilio
             # Initialize the EntityContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The unique SID identifier of the Service.
-            # @param [String] identity Customer unique identity for the Entity of the Service
+            # @param [String] identity The unique external identifier for the Entity of the
+            #   Service
             # @return [EntityContext] EntityContext
             def initialize(version, service_sid, identity)
               super(version)
@@ -182,27 +183,27 @@ module Twilio
 
               # Dependents
               @factors = nil
-              @access_tokens = nil
+              @challenges = nil
             end
 
             ##
-            # Deletes the EntityInstance
+            # Delete the EntityInstance
+            # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
             # @return [Boolean] true if delete succeeds, false otherwise
-            def delete
-              @version.delete('delete', @uri)
+            def delete(twilio_sandbox_mode: :unset)
+              headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
+
+               @version.delete('DELETE', @uri, headers: headers)
             end
 
             ##
-            # Fetch a EntityInstance
+            # Fetch the EntityInstance
+            # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
             # @return [EntityInstance] Fetched EntityInstance
-            def fetch
-              params = Twilio::Values.of({})
+            def fetch(twilio_sandbox_mode: :unset)
+              headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri, headers: headers)
 
               EntityInstance.new(
                   @version,
@@ -235,19 +236,25 @@ module Twilio
             end
 
             ##
-            # Access the access_tokens
-            # @return [AccessTokenList]
-            # @return [AccessTokenContext]
-            def access_tokens
-              unless @access_tokens
-                @access_tokens = AccessTokenList.new(
+            # Access the challenges
+            # @return [ChallengeList]
+            # @return [ChallengeContext] if sid was passed.
+            def challenges(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return ChallengeContext.new(@version, @solution[:service_sid], @solution[:identity], sid, )
+              end
+
+              unless @challenges
+                @challenges = ChallengeList.new(
                     @version,
                     service_sid: @solution[:service_sid],
                     identity: @solution[:identity],
                 )
               end
 
-              @access_tokens
+              @challenges
             end
 
             ##
@@ -273,7 +280,8 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The unique SID identifier of the Service.
-            # @param [String] identity Customer unique identity for the Entity of the Service
+            # @param [String] identity The unique external identifier for the Entity of the
+            #   Service
             # @return [EntityInstance] EntityInstance
             def initialize(version, payload, service_sid: nil, identity: nil)
               super(version)
@@ -313,7 +321,7 @@ module Twilio
             end
 
             ##
-            # @return [String] Unique identity of the Entity
+            # @return [String] Unique external identifier of the Entity
             def identity
               @properties['identity']
             end
@@ -355,17 +363,19 @@ module Twilio
             end
 
             ##
-            # Deletes the EntityInstance
+            # Delete the EntityInstance
+            # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
             # @return [Boolean] true if delete succeeds, false otherwise
-            def delete
-              context.delete
+            def delete(twilio_sandbox_mode: :unset)
+              context.delete(twilio_sandbox_mode: twilio_sandbox_mode, )
             end
 
             ##
-            # Fetch a EntityInstance
+            # Fetch the EntityInstance
+            # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
             # @return [EntityInstance] Fetched EntityInstance
-            def fetch
-              context.fetch
+            def fetch(twilio_sandbox_mode: :unset)
+              context.fetch(twilio_sandbox_mode: twilio_sandbox_mode, )
             end
 
             ##
@@ -376,10 +386,10 @@ module Twilio
             end
 
             ##
-            # Access the access_tokens
-            # @return [access_tokens] access_tokens
-            def access_tokens
-              context.access_tokens
+            # Access the challenges
+            # @return [challenges] challenges
+            def challenges
+              context.challenges
             end
 
             ##