twilio-ruby 5.40.1 → 5.42.0

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

@@ -13,7 +13,7 @@ module Twilio
         class ServiceContext < InstanceContext
           class EntityContext < 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.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class ChallengeList < ListResource
               ##
               # Initialize the ChallengeList
@@ -34,31 +34,26 @@ module Twilio
               # Create the ChallengeInstance
               # @param [String] factor_sid The unique SID identifier of the Factor.
               # @param [Time] expiration_date The future date in which this Challenge will
-              #   expire, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
-              # @param [String] details Details provided to give context about the Challenge.
-              #   Shown to the end user. It must be a stringified JSON with the following
-              #   structure: {"message": "string", "fields": [ { "label": "string", "value":
-              #   "string"}]}. `message` is required. If you send the `fields` property, each
-              #   field has to include `label` and `value` properties. If you had set
-              #   `include_date=true` in the `push` configuration of the
-              #   [service](https://www.twilio.com/docs/verify/api/service), the response will
-              #   also include the challenge's date created value as an additional field called
-              #   `date`
-              # @param [String] hidden_details Details provided to give context about the
+              #   expire, given in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
+              # @param [String] details_message Shown to the user when the push notification
+              #   arrives. Required when `factor_type` is `push`
+              # @param [Hash] details_fields A list of objects that describe the Fields included
+              #   in the Challenge. Each object contains the label and value of the field. Used
+              #   when `factor_type` is `push`.
+              # @param [Hash] hidden_details Details provided to give context about the
               #   Challenge. Not shown to the end user. It must be a stringified JSON with only
               #   strings values eg. `{"ip": "172.168.1.234"}`
-              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
               # @return [ChallengeInstance] Created ChallengeInstance
-              def create(factor_sid: nil, expiration_date: :unset, details: :unset, hidden_details: :unset, twilio_sandbox_mode: :unset)
+              def create(factor_sid: nil, expiration_date: :unset, details_message: :unset, details_fields: :unset, hidden_details: :unset)
                 data = Twilio::Values.of({
                     'FactorSid' => factor_sid,
                     'ExpirationDate' => Twilio.serialize_iso8601_datetime(expiration_date),
-                    'Details' => details,
-                    'HiddenDetails' => hidden_details,
+                    'Details.Message' => details_message,
+                    'Details.Fields' => Twilio.serialize_list(details_fields) { |e| Twilio.serialize_object(e) },
+                    'HiddenDetails' => Twilio.serialize_object(hidden_details),
                 })
-                headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
 
-                payload = @version.create('POST', @uri, data: data, headers: headers)
+                payload = @version.create('POST', @uri, data: data)
 
                 ChallengeInstance.new(
                     @version,
@@ -75,7 +70,6 @@ module Twilio
               # @param [String] factor_sid The unique SID identifier of the Factor.
               # @param [challenge.ChallengeStatuses] status The Status of the Challenges to
               #   fetch. One of `pending`, `expired`, `approved` or `denied`.
-              # @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
@@ -83,14 +77,8 @@ 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(factor_sid: :unset, status: :unset, twilio_sandbox_mode: :unset, limit: nil, page_size: nil)
-                self.stream(
-                    factor_sid: factor_sid,
-                    status: status,
-                    twilio_sandbox_mode: twilio_sandbox_mode,
-                    limit: limit,
-                    page_size: page_size
-                ).entries
+              def list(factor_sid: :unset, status: :unset, limit: nil, page_size: nil)
+                self.stream(factor_sid: factor_sid, status: status, limit: limit, page_size: page_size).entries
               end
 
               ##
@@ -100,7 +88,6 @@ module Twilio
               # @param [String] factor_sid The unique SID identifier of the Factor.
               # @param [challenge.ChallengeStatuses] status The Status of the Challenges to
               #   fetch. One of `pending`, `expired`, `approved` or `denied`.
-              # @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
@@ -108,15 +95,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(factor_sid: :unset, status: :unset, twilio_sandbox_mode: :unset, limit: nil, page_size: nil)
+              def stream(factor_sid: :unset, status: :unset, limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(
-                    factor_sid: factor_sid,
-                    status: status,
-                    twilio_sandbox_mode: twilio_sandbox_mode,
-                    page_size: limits[:page_size],
-                )
+                page = self.page(factor_sid: factor_sid, status: status, page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -141,12 +123,11 @@ module Twilio
               # @param [String] factor_sid The unique SID identifier of the Factor.
               # @param [challenge.ChallengeStatuses] status The Status of the Challenges to
               #   fetch. One of `pending`, `expired`, `approved` or `denied`.
-              # @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 ChallengeInstance
-              def page(factor_sid: :unset, status: :unset, twilio_sandbox_mode: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+              def page(factor_sid: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
                 params = Twilio::Values.of({
                     'FactorSid' => factor_sid,
                     'Status' => status,
@@ -154,9 +135,8 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
 
-                response = @version.page('GET', @uri, params: params, headers: headers)
+                response = @version.page('GET', @uri, params: params)
 
                 ChallengePage.new(@version, response, @solution)
               end
@@ -182,7 +162,7 @@ module Twilio
             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.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class ChallengePage < Page
               ##
               # Initialize the ChallengePage
@@ -218,7 +198,7 @@ module Twilio
             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.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class ChallengeContext < InstanceContext
               ##
               # Initialize the ChallengeContext
@@ -240,12 +220,9 @@ module Twilio
 
               ##
               # Fetch the ChallengeInstance
-              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
               # @return [ChallengeInstance] Fetched ChallengeInstance
-              def fetch(twilio_sandbox_mode: :unset)
-                headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
-
-                payload = @version.fetch('GET', @uri, headers: headers)
+              def fetch
+                payload = @version.fetch('GET', @uri)
 
                 ChallengeInstance.new(
                     @version,
@@ -260,13 +237,11 @@ module Twilio
               # Update the ChallengeInstance
               # @param [String] auth_payload The optional payload needed to verify the
               #   Challenge. E.g., a TOTP would use the numeric code.
-              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
               # @return [ChallengeInstance] Updated ChallengeInstance
-              def update(auth_payload: :unset, twilio_sandbox_mode: :unset)
+              def update(auth_payload: :unset)
                 data = Twilio::Values.of({'AuthPayload' => auth_payload, })
-                headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
 
-                payload = @version.update('POST', @uri, data: data, headers: headers)
+                payload = @version.update('POST', @uri, data: data)
 
                 ChallengeInstance.new(
                     @version,
@@ -293,7 +268,7 @@ module Twilio
             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.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class ChallengeInstance < InstanceResource
               ##
               # Initialize the ChallengeInstance
@@ -422,13 +397,13 @@ module Twilio
               end
 
               ##
-              # @return [String] Public details provided to contextualize the Challenge
+              # @return [Hash] Details about the Challenge.
               def details
                 @properties['details']
               end
 
               ##
-              # @return [String] Hidden details provided to contextualize the Challenge
+              # @return [Hash] Hidden details about the Challenge
               def hidden_details
                 @properties['hidden_details']
               end
@@ -447,20 +422,18 @@ module Twilio
 
               ##
               # Fetch the ChallengeInstance
-              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
               # @return [ChallengeInstance] Fetched ChallengeInstance
-              def fetch(twilio_sandbox_mode: :unset)
-                context.fetch(twilio_sandbox_mode: twilio_sandbox_mode, )
+              def fetch
+                context.fetch
               end
 
               ##
               # Update the ChallengeInstance
               # @param [String] auth_payload The optional payload needed to verify the
               #   Challenge. E.g., a TOTP would use the numeric code.
-              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
               # @return [ChallengeInstance] Updated ChallengeInstance
-              def update(auth_payload: :unset, twilio_sandbox_mode: :unset)
-                context.update(auth_payload: auth_payload, twilio_sandbox_mode: twilio_sandbox_mode, )
+              def update(auth_payload: :unset)
+                context.update(auth_payload: auth_payload, )
               end
 
               ##

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

@@ -13,7 +13,7 @@ module Twilio
         class ServiceContext < InstanceContext
           class EntityContext < 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.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class FactorList < ListResource
               ##
               # Initialize the FactorList
@@ -33,32 +33,38 @@ module Twilio
 
               ##
               # Create the FactorInstance
-              # @param [String] binding A unique binding for this Factor that identifies it.
-              #   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. 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
-              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
-              # @param [String] authorization The Authorization HTTP request header
+              # @param [String] binding_alg The algorithm used when `factor_type` is `push`.
+              #   Algorithm supported: `ES256`
+              # @param [String] binding_public_key The Ecdsa public key in PKIX, ASN.1 DER
+              #   format encoded in Base64
+              # @param [String] config_app_id The ID that uniquely identifies your app in the
+              #   Google or Apple store, such as `com.example.myapp`. Required when `factor_type`
+              #   is `push`
+              # @param [factor.NotificationPlatforms] config_notification_platform The transport
+              #   technology used to generate the Notification Token. Can be `apn` or `fcm`.
+              #   Required when `factor_type` is `push`
+              # @param [String] config_notification_token For APN, the device token. For FCM the
+              #   registration token. It used to send the push notifications. Required when
+              #   `factor_type` is `push`
+              # @param [String] config_sdk_version The Verify Push SDK version used to configure
+              #   the factor
               # @return [FactorInstance] Created FactorInstance
-              def create(binding: nil, friendly_name: nil, factor_type: nil, config: nil, twilio_sandbox_mode: :unset, authorization: :unset)
+              def create(friendly_name: nil, factor_type: nil, binding_alg: :unset, binding_public_key: :unset, config_app_id: :unset, config_notification_platform: :unset, config_notification_token: :unset, config_sdk_version: :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,
+                    'Binding.Alg' => binding_alg,
+                    'Binding.PublicKey' => binding_public_key,
+                    'Config.AppId' => config_app_id,
+                    'Config.NotificationPlatform' => config_notification_platform,
+                    'Config.NotificationToken' => config_notification_token,
+                    'Config.SdkVersion' => config_sdk_version,
                 })
 
-                payload = @version.create('POST', @uri, data: data, headers: headers)
+                payload = @version.create('POST', @uri, data: data)
 
                 FactorInstance.new(
                     @version,
@@ -72,7 +78,6 @@ 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
@@ -80,15 +85,14 @@ 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(twilio_sandbox_mode: :unset, limit: nil, page_size: nil)
-                self.stream(twilio_sandbox_mode: twilio_sandbox_mode, limit: limit, page_size: page_size).entries
+              def list(limit: nil, page_size: nil)
+                self.stream(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
@@ -96,10 +100,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(twilio_sandbox_mode: :unset, limit: nil, page_size: nil)
+              def stream(limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(twilio_sandbox_mode: twilio_sandbox_mode, page_size: limits[:page_size], )
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -121,20 +125,18 @@ 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(twilio_sandbox_mode: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+              def page(page_token: :unset, page_number: :unset, page_size: :unset)
                 params = Twilio::Values.of({
                     'PageToken' => page_token,
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
 
-                response = @version.page('GET', @uri, params: params, headers: headers)
+                response = @version.page('GET', @uri, params: params)
 
                 FactorPage.new(@version, response, @solution)
               end
@@ -160,7 +162,7 @@ module Twilio
             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.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class FactorPage < Page
               ##
               # Initialize the FactorPage
@@ -196,7 +198,7 @@ module Twilio
             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.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class FactorContext < InstanceContext
               ##
               # Initialize the FactorContext
@@ -216,22 +218,16 @@ module Twilio
 
               ##
               # 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(twilio_sandbox_mode: :unset)
-                headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
-
-                 @version.delete('DELETE', @uri, headers: headers)
+              def delete
+                 @version.delete('DELETE', @uri)
               end
 
               ##
               # Fetch the FactorInstance
-              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
               # @return [FactorInstance] Fetched FactorInstance
-              def fetch(twilio_sandbox_mode: :unset)
-                headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
-
-                payload = @version.fetch('GET', @uri, headers: headers)
+              def fetch
+                payload = @version.fetch('GET', @uri)
 
                 FactorInstance.new(
                     @version,
@@ -247,19 +243,21 @@ module Twilio
               # @param [String] auth_payload The optional payload needed to verify the Factor
               #   for the first time. E.g. for a TOTP, the numeric code.
               # @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
+              # @param [String] config_notification_token For APN, the device token. For FCM the
+              #   registration token. It used to send the push notifications. Required when
+              #   `factor_type` is `push`
+              # @param [String] config_sdk_version The Verify Push SDK version used to configure
+              #   the factor
               # @return [FactorInstance] Updated FactorInstance
-              def update(auth_payload: :unset, friendly_name: :unset, config: :unset, twilio_sandbox_mode: :unset)
+              def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset)
                 data = Twilio::Values.of({
                     'AuthPayload' => auth_payload,
                     'FriendlyName' => friendly_name,
-                    'Config' => config,
+                    'Config.NotificationToken' => config_notification_token,
+                    'Config.SdkVersion' => config_sdk_version,
                 })
-                headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
 
-                payload = @version.update('POST', @uri, data: data, headers: headers)
+                payload = @version.update('POST', @uri, data: data)
 
                 FactorInstance.new(
                     @version,
@@ -286,7 +284,7 @@ module Twilio
             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.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class FactorInstance < InstanceResource
               ##
               # Initialize the FactorInstance
@@ -399,7 +397,7 @@ module Twilio
               end
 
               ##
-              # @return [Hash] The config
+              # @return [Hash] Configurations for a `factor_type`.
               def config
                 @properties['config']
               end
@@ -412,18 +410,16 @@ module Twilio
 
               ##
               # 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(twilio_sandbox_mode: :unset)
-                context.delete(twilio_sandbox_mode: twilio_sandbox_mode, )
+              def delete
+                context.delete
               end
 
               ##
               # Fetch the FactorInstance
-              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
               # @return [FactorInstance] Fetched FactorInstance
-              def fetch(twilio_sandbox_mode: :unset)
-                context.fetch(twilio_sandbox_mode: twilio_sandbox_mode, )
+              def fetch
+                context.fetch
               end
 
               ##
@@ -431,16 +427,18 @@ module Twilio
               # @param [String] auth_payload The optional payload needed to verify the Factor
               #   for the first time. E.g. for a TOTP, the numeric code.
               # @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
+              # @param [String] config_notification_token For APN, the device token. For FCM the
+              #   registration token. It used to send the push notifications. Required when
+              #   `factor_type` is `push`
+              # @param [String] config_sdk_version The Verify Push SDK version used to configure
+              #   the factor
               # @return [FactorInstance] Updated FactorInstance
-              def update(auth_payload: :unset, friendly_name: :unset, config: :unset, twilio_sandbox_mode: :unset)
+              def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset)
                 context.update(
                     auth_payload: auth_payload,
                     friendly_name: friendly_name,
-                    config: config,
-                    twilio_sandbox_mode: twilio_sandbox_mode,
+                    config_notification_token: config_notification_token,
+                    config_sdk_version: config_sdk_version,
                 )
               end