twilio-ruby 5.34.1 → 5.39.0

data/lib/twilio-ruby/rest/{authy/v1 → verify/v2}/service/entity/factor.rb

@@ -8,8 +8,8 @@
 
 module Twilio
   module REST
-    class Authy < Domain
-      class V1 < Version
+    class Verify < Domain
+      class V2 < Version
         class ServiceContext < InstanceContext
           class EntityContext < InstanceContext
             ##
@@ -19,8 +19,9 @@ module Twilio
               # Initialize the FactorList
               # @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 owner of the
-              #   Factor
+              # @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.
               # @return [FactorList] FactorList
               def initialize(version, service_sid: nil, identity: nil)
                 super(version)
@@ -31,31 +32,33 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of FactorInstance records from the API.
-              # Request is executed immediately.
+              # Create the FactorInstance
               # @param [String] binding A unique binding for this Factor that identifies it.
-              #   E.g. a phone number for `sms` factors. It must be a json string with the
-              #   required properties for the given factor type. Required when creating a new
-              #   Factor. This value is never returned because it can contain customer secrets.
+              #   E.g. the algorithm and public key for `push` factors. It must be a json string
+              #   with the required properties for the given factor type. Required when creating a
+              #   new Factor. This value is never returned because it can contain customer
+              #   secrets.
               # @param [String] friendly_name The friendly name of this Factor
-              # @param [factor.FactorTypes] factor_type The Type of this Factor. One of
-              #   `app-push`, `sms`, `totp`, etc.
+              # @param [factor.FactorTypes] factor_type The Type of this Factor. Currently only
+              #   `push` is supported
               # @param [String] config The config required for this Factor. It must be a json
               #   string with the required properties for the given factor type
-              # @return [FactorInstance] Newly created FactorInstance
-              def create(binding: nil, friendly_name: nil, factor_type: nil, config: nil)
+              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
+              # @param [String] authorization The Authorization HTTP request header
+              # @return [FactorInstance] Created FactorInstance
+              def create(binding: nil, friendly_name: nil, factor_type: nil, config: nil, twilio_sandbox_mode: :unset, authorization: :unset)
                 data = Twilio::Values.of({
                     'Binding' => binding,
                     'FriendlyName' => friendly_name,
                     'FactorType' => factor_type,
                     'Config' => config,
                 })
+                headers = Twilio::Values.of({
+                    'Twilio-Sandbox-Mode' => twilio_sandbox_mode,
+                    'Authorization' => authorization,
+                })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data, headers: headers)
 
                 FactorInstance.new(
                     @version,
@@ -69,6 +72,7 @@ module Twilio
               # Lists FactorInstance 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
@@ -76,14 +80,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 FactorInstance 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
@@ -91,10 +96,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
@@ -116,21 +121,21 @@ module Twilio
               ##
               # Retrieve a single page of FactorInstance 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 FactorInstance
-              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)
+
                 FactorPage.new(@version, response, @solution)
               end
 
@@ -150,7 +155,7 @@ module Twilio
               ##
               # Provide a user friendly representation
               def to_s
-                '#<Twilio.Authy.V1.FactorList>'
+                '#<Twilio.Verify.V2.FactorList>'
               end
             end
 
@@ -186,7 +191,7 @@ module Twilio
               ##
               # Provide a user friendly representation
               def to_s
-                '<Twilio.Authy.V1.FactorPage>'
+                '<Twilio.Verify.V2.FactorPage>'
               end
             end
 
@@ -207,29 +212,26 @@ module Twilio
                 # Path Solution
                 @solution = {service_sid: service_sid, identity: identity, sid: sid, }
                 @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Factors/#{@solution[:sid]}"
-
-                # Dependents
-                @challenges = nil
               end
 
               ##
-              # Deletes the FactorInstance
+              # Delete the FactorInstance
+              # @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 FactorInstance
+              # Fetch the FactorInstance
+              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
               # @return [FactorInstance] Fetched FactorInstance
-              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)
 
                 FactorInstance.new(
                     @version,
@@ -247,19 +249,17 @@ module Twilio
               # @param [String] friendly_name The new friendly name of this Factor
               # @param [String] config The new config for this Factor. It must be a json string
               #   with the required properties for the given factor type
+              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
               # @return [FactorInstance] Updated FactorInstance
-              def update(auth_payload: :unset, friendly_name: :unset, config: :unset)
+              def update(auth_payload: :unset, friendly_name: :unset, config: :unset, twilio_sandbox_mode: :unset)
                 data = Twilio::Values.of({
                     'AuthPayload' => auth_payload,
                     'FriendlyName' => friendly_name,
                     'Config' => config,
                 })
+                headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data, headers: headers)
 
                 FactorInstance.new(
                     @version,
@@ -270,47 +270,18 @@ module Twilio
                 )
               end
 
-              ##
-              # 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],
-                      @solution[:sid],
-                      sid,
-                  )
-                end
-
-                unless @challenges
-                  @challenges = ChallengeList.new(
-                      @version,
-                      service_sid: @solution[:service_sid],
-                      identity: @solution[:identity],
-                      factor_sid: @solution[:sid],
-                  )
-                end
-
-                @challenges
-              end
-
               ##
               # Provide a user friendly representation
               def to_s
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-                "#<Twilio.Authy.V1.FactorContext #{context}>"
+                "#<Twilio.Verify.V2.FactorContext #{context}>"
               end
 
               ##
               # Provide a detailed, user friendly representation
               def inspect
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-                "#<Twilio.Authy.V1.FactorContext #{context}>"
+                "#<Twilio.Verify.V2.FactorContext #{context}>"
               end
             end
 
@@ -322,8 +293,9 @@ 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 owner of the
-              #   Factor
+              # @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 [String] sid A 34 character string that uniquely identifies this Factor.
               # @return [FactorInstance] FactorInstance
               def initialize(version, payload, service_sid: nil, identity: nil, sid: nil)
@@ -343,7 +315,6 @@ module Twilio
                     'factor_type' => payload['factor_type'],
                     'config' => payload['config'],
                     'url' => payload['url'],
-                    'links' => payload['links'],
                 }
 
                 # Context
@@ -392,7 +363,7 @@ module Twilio
               end
 
               ##
-              # @return [String] Unique identity of the Entity
+              # @return [String] Unique external identifier of the Entity
               def identity
                 @properties['identity']
               end
@@ -440,23 +411,19 @@ module Twilio
               end
 
               ##
-              # @return [String] Nested resource URLs.
-              def links
-                @properties['links']
-              end
-
-              ##
-              # Deletes the FactorInstance
+              # Delete the FactorInstance
+              # @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 FactorInstance
+              # Fetch the FactorInstance
+              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
               # @return [FactorInstance] Fetched FactorInstance
-              def fetch
-                context.fetch
+              def fetch(twilio_sandbox_mode: :unset)
+                context.fetch(twilio_sandbox_mode: twilio_sandbox_mode, )
               end
 
               ##
@@ -466,30 +433,29 @@ module Twilio
               # @param [String] friendly_name The new friendly name of this Factor
               # @param [String] config The new config for this Factor. It must be a json string
               #   with the required properties for the given factor type
+              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
               # @return [FactorInstance] Updated FactorInstance
-              def update(auth_payload: :unset, friendly_name: :unset, config: :unset)
-                context.update(auth_payload: auth_payload, friendly_name: friendly_name, config: config, )
-              end
-
-              ##
-              # Access the challenges
-              # @return [challenges] challenges
-              def challenges
-                context.challenges
+              def update(auth_payload: :unset, friendly_name: :unset, config: :unset, twilio_sandbox_mode: :unset)
+                context.update(
+                    auth_payload: auth_payload,
+                    friendly_name: friendly_name,
+                    config: config,
+                    twilio_sandbox_mode: twilio_sandbox_mode,
+                )
               end
 
               ##
               # Provide a user friendly representation
               def to_s
                 values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Authy.V1.FactorInstance #{values}>"
+                "<Twilio.Verify.V2.FactorInstance #{values}>"
               end
 
               ##
               # Provide a detailed, user friendly representation
               def inspect
                 values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Authy.V1.FactorInstance #{values}>"
+                "<Twilio.Verify.V2.FactorInstance #{values}>"
               end
             end
           end

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

@@ -28,8 +28,7 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of MessagingConfigurationInstance records from the API.
-            # Request is executed immediately.
+            # Create the MessagingConfigurationInstance
             # @param [String] country The
             #   [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of
             #   the country this configuration will be applied to. If this is a global
@@ -37,15 +36,11 @@ module Twilio
             # @param [String] messaging_service_sid The SID of the [Messaging
             #   Service](https://www.twilio.com/docs/sms/services/api) to be used to send SMS to
             #   the country of this configuration.
-            # @return [MessagingConfigurationInstance] Newly created MessagingConfigurationInstance
+            # @return [MessagingConfigurationInstance] Created MessagingConfigurationInstance
             def create(country: nil, messaging_service_sid: nil)
               data = Twilio::Values.of({'Country' => country, 'MessagingServiceSid' => messaging_service_sid, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               MessagingConfigurationInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -111,11 +106,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params)
+
               MessagingConfigurationPage.new(@version, response, @solution)
             end
 
@@ -197,11 +190,7 @@ module Twilio
             def update(messaging_service_sid: nil)
               data = Twilio::Values.of({'MessagingServiceSid' => messaging_service_sid, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               MessagingConfigurationInstance.new(
                   @version,
@@ -212,16 +201,10 @@ module Twilio
             end
 
             ##
-            # Fetch a MessagingConfigurationInstance
+            # Fetch the MessagingConfigurationInstance
             # @return [MessagingConfigurationInstance] Fetched MessagingConfigurationInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               MessagingConfigurationInstance.new(
                   @version,
@@ -232,10 +215,10 @@ module Twilio
             end
 
             ##
-            # Deletes the MessagingConfigurationInstance
+            # Delete the MessagingConfigurationInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -353,14 +336,14 @@ module Twilio
             end
 
             ##
-            # Fetch a MessagingConfigurationInstance
+            # Fetch the MessagingConfigurationInstance
             # @return [MessagingConfigurationInstance] Fetched MessagingConfigurationInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the MessagingConfigurationInstance
+            # Delete the MessagingConfigurationInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete