twilio-ruby 5.40.3 → 5.44.0

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
 

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

@@ -16,7 +16,7 @@ module Twilio
             # Initialize the MessagingConfigurationList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/verify/api/service) that the resource is
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] that the resource is
             #   associated with.
             # @return [MessagingConfigurationList] MessagingConfigurationList
             def initialize(version, service_sid: nil)
@@ -30,11 +30,11 @@ module Twilio
             ##
             # Create the MessagingConfigurationInstance
             # @param [String] country The
-            #   [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of
+            #   {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
             #   configuration, Country will take the value `all`.
-            # @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
+            # @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] Created MessagingConfigurationInstance
             def create(country: nil, messaging_service_sid: nil)
@@ -166,10 +166,10 @@ module Twilio
             # Initialize the MessagingConfigurationContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/verify/api/service) that the resource is
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] that the resource is
             #   associated with.
             # @param [String] country The
-            #   [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of
+            #   {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
             #   configuration, Country will take the value `all`.
             # @return [MessagingConfigurationContext] MessagingConfigurationContext
@@ -183,8 +183,8 @@ module Twilio
 
             ##
             # Update the MessagingConfigurationInstance
-            # @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
+            # @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] Updated MessagingConfigurationInstance
             def update(messaging_service_sid: nil)
@@ -242,10 +242,10 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/verify/api/service) that the resource is
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] that the resource is
             #   associated with.
             # @param [String] country The
-            #   [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of
+            #   {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
             #   configuration, Country will take the value `all`.
             # @return [MessagingConfigurationInstance] MessagingConfigurationInstance
@@ -327,8 +327,8 @@ module Twilio
 
             ##
             # Update the MessagingConfigurationInstance
-            # @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
+            # @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] Updated MessagingConfigurationInstance
             def update(messaging_service_sid: nil)

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

@@ -16,7 +16,7 @@ module Twilio
             # Initialize the RateLimitList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
             #   associated with.
             # @return [RateLimitList] RateLimitList
             def initialize(version, service_sid: nil)
@@ -163,7 +163,7 @@ module Twilio
             # Initialize the RateLimitContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
             #   associated with.
             # @param [String] sid The Twilio-provided string that uniquely identifies the Rate
             #   Limit resource to fetch.
@@ -250,7 +250,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
             #   associated with.
             # @param [String] sid The Twilio-provided string that uniquely identifies the Rate
             #   Limit resource to fetch.

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

@@ -17,7 +17,7 @@ module Twilio
               # Initialize the BucketList
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+              #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
               #   associated with.
               # @param [String] rate_limit_sid The Twilio-provided string that uniquely
               #   identifies the Rate Limit resource.
@@ -175,7 +175,7 @@ module Twilio
               # Initialize the BucketContext
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+              #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
               #   associated with.
               # @param [String] rate_limit_sid The Twilio-provided string that uniquely
               #   identifies the Rate Limit resource.
@@ -252,7 +252,7 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+              #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
               #   associated with.
               # @param [String] rate_limit_sid The Twilio-provided string that uniquely
               #   identifies the Rate Limit resource.

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

@@ -16,7 +16,7 @@ module Twilio
             # Initialize the VerificationList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
             #   associated with.
             # @return [VerificationList] VerificationList
             def initialize(version, service_sid: nil)
@@ -30,10 +30,10 @@ module Twilio
             ##
             # Create the VerificationInstance
             # @param [String] to The phone number or
-            #   [email](https://www.twilio.com/docs/verify/email) to verify. Phone numbers must
-            #   be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
+            #   {email}[https://www.twilio.com/docs/verify/email] to verify. Phone numbers must
+            #   be in {E.164 format}[https://www.twilio.com/docs/glossary/what-e164].
             # @param [String] channel The verification method to use. Can be:
-            #   [`email`](https://www.twilio.com/docs/verify/email), `sms` or `call`.
+            #   {`email`}[https://www.twilio.com/docs/verify/email], `sms` or `call`.
             # @param [String] custom_friendly_name A custom user defined friendly name that
             #   overwrites the existing one in the verification message
             # @param [String] custom_message The text of a custom message to use for the
@@ -41,7 +41,7 @@ module Twilio
             # @param [String] send_digits The digits to send after a phone call is answered,
             #   for example, to dial an extension. For more information, see the Programmable
             #   Voice documentation of
-            #   [sendDigits](https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits).
+            #   {sendDigits}[https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits].
             # @param [String] locale The locale to use for the verification SMS or call. Can
             #   be: `af`, `ar`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-GB`, `es`, `fi`, `fr`,
             #   `he`, `hi`, `hr`, `hu`, `id`, `it`, `ja`, `ko`, `ms`, `nb`, `nl`, `pl`, `pt`,
@@ -53,15 +53,15 @@ module Twilio
             # @param [String] payee The payee of the associated PSD2 compliant transaction.
             #   Requires the PSD2 Service flag enabled.
             # @param [Hash] rate_limits The custom key-value pairs of Programmable Rate
-            #   Limits. Keys correspond to `unique_name` fields defined when [creating your Rate
-            #   Limit](https://www.twilio.com/docs/verify/api/service-rate-limits). Associated
+            #   Limits. Keys correspond to `unique_name` fields defined when {creating your Rate
+            #   Limit}[https://www.twilio.com/docs/verify/api/service-rate-limits]. Associated
             #   value pairs represent values in the request that you are rate limiting on. You
             #   may include multiple Rate Limit values in each request.
             # @param [Hash] channel_configuration
-            #   [`email`](https://www.twilio.com/docs/verify/email) channel configuration in
+            #   {`email`}[https://www.twilio.com/docs/verify/email] channel configuration in
             #   json format. Must include 'from' and 'from_name'.
-            # @param [String] app_hash Your [App
-            #   Hash](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string)
+            # @param [String] app_hash Your {App
+            #   Hash}[https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string]
             #   to be appended at the end of your verification SMS body. Applies only to SMS.
             #   Example SMS body: `<#> Your AppName verification code is: 1234 He42w354ol9`.
             # @return [VerificationInstance] Created VerificationInstance
@@ -127,7 +127,7 @@ module Twilio
             # Initialize the VerificationContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the verification
-            #   [Service](https://www.twilio.com/docs/verify/api/service) to fetch the resource
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] to fetch the resource
             #   from.
             # @param [String] sid The Twilio-provided string that uniquely identifies the
             #   Verification resource to fetch.
@@ -193,7 +193,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/verify/api/service) the resource is
+            #   {Service}[https://www.twilio.com/docs/verify/api/service] the resource is
             #   associated with.
             # @param [String] sid The Twilio-provided string that uniquely identifies the
             #   Verification resource to fetch.