twilio-ruby 5.31.0 → 5.46.0

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

@@ -8,19 +8,20 @@
 
 module Twilio
   module REST
-    class Authy < Domain
-      class V1 < Version
+    class Verify < Domain
+      class V2 < Version
         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
               # @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,27 +32,39 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of FactorInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] binding A unique binding for this Factor that identifies it.
-              #   E.g. a phone number for `sms` factors. Required when creating a new Factor. This
-              #   value is never returned because it can contain customer secrets.
+              # Create the FactorInstance
               # @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.
-              # @return [FactorInstance] Newly created FactorInstance
-              def create(binding: nil, friendly_name: nil, factor_type: nil)
+              # @param [factor.FactorTypes] factor_type The Type of this Factor. Currently only
+              #   `push` is supported
+              # @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(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,
+                    '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
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 FactorInstance.new(
                     @version,
@@ -122,11 +135,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 FactorPage.new(@version, response, @solution)
               end
 
@@ -146,12 +157,12 @@ module Twilio
               ##
               # Provide a user friendly representation
               def to_s
-                '#<Twilio.Authy.V1.FactorList>'
+                '#<Twilio.Verify.V2.FactorList>'
               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.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class FactorPage < Page
               ##
               # Initialize the FactorPage
@@ -182,12 +193,12 @@ module Twilio
               ##
               # Provide a user friendly representation
               def to_s
-                '<Twilio.Authy.V1.FactorPage>'
+                '<Twilio.Verify.V2.FactorPage>'
               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.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class FactorContext < InstanceContext
               ##
               # Initialize the FactorContext
@@ -203,29 +214,20 @@ 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
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
-              # Fetch a FactorInstance
+              # Fetch the FactorInstance
               # @return [FactorInstance] Fetched FactorInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 FactorInstance.new(
                     @version,
@@ -240,15 +242,22 @@ module Twilio
               # Update the FactorInstance
               # @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_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)
-                data = Twilio::Values.of({'AuthPayload' => auth_payload, })
+              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.NotificationToken' => config_notification_token,
+                    'Config.SdkVersion' => config_sdk_version,
+                })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 FactorInstance.new(
                     @version,
@@ -259,60 +268,32 @@ 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
 
             ##
-            # 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
               # @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)
@@ -330,9 +311,8 @@ module Twilio
                     'friendly_name' => payload['friendly_name'],
                     'status' => payload['status'],
                     'factor_type' => payload['factor_type'],
-                    'factor_strength' => payload['factor_strength'],
+                    'config' => payload['config'],
                     'url' => payload['url'],
-                    'links' => payload['links'],
                 }
 
                 # Context
@@ -381,7 +361,7 @@ module Twilio
               end
 
               ##
-              # @return [String] Unique identity of the Entity
+              # @return [String] Unique external identifier of the Entity
               def identity
                 @properties['identity']
               end
@@ -417,9 +397,9 @@ module Twilio
               end
 
               ##
-              # @return [factor.FactorStrengths] The Strength of this Factor
-              def factor_strength
-                @properties['factor_strength']
+              # @return [Hash] Configurations for a `factor_type`.
+              def config
+                @properties['config']
               end
 
               ##
@@ -429,20 +409,14 @@ module Twilio
               end
 
               ##
-              # @return [String] Nested resource URLs.
-              def links
-                @properties['links']
-              end
-
-              ##
-              # Deletes the FactorInstance
+              # Delete the FactorInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
 
               ##
-              # Fetch a FactorInstance
+              # Fetch the FactorInstance
               # @return [FactorInstance] Fetched FactorInstance
               def fetch
                 context.fetch
@@ -452,30 +426,34 @@ module Twilio
               # Update the FactorInstance
               # @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_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)
-                context.update(auth_payload: auth_payload, )
-              end
-
-              ##
-              # Access the challenges
-              # @return [challenges] challenges
-              def challenges
-                context.challenges
+              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_notification_token: config_notification_token,
+                    config_sdk_version: config_sdk_version,
+                )
               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

@@ -11,14 +11,12 @@ module Twilio
     class Verify < Domain
       class V2 < Version
         class ServiceContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class MessagingConfigurationList < ListResource
             ##
             # 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,24 +28,19 @@ 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
+            #   {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] 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
@@ -113,11 +106,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               MessagingConfigurationPage.new(@version, response, @solution)
             end
 
@@ -141,8 +132,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class MessagingConfigurationPage < Page
             ##
             # Initialize the MessagingConfigurationPage
@@ -172,17 +161,15 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class MessagingConfigurationContext < InstanceContext
             ##
             # 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
@@ -196,18 +183,14 @@ 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 = Twilio::Values.of({'MessagingServiceSid' => messaging_service_sid, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               MessagingConfigurationInstance.new(
                   @version,
@@ -218,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,
@@ -238,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
 
             ##
@@ -259,18 +236,16 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class MessagingConfigurationInstance < InstanceResource
             ##
             # Initialize the MessagingConfigurationInstance
             # @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
@@ -352,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)
@@ -361,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