twilio-ruby 5.19.0 → 5.77.0

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

@@ -3,24 +3,24 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 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.
             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
+              #   Factor. This identifier should be immutable, not PII, length between 8 and 64
+              #   characters, and generated by your external system, such as your user's UUID,
+              #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
               # @return [FactorList] FactorList
               def initialize(version, service_sid: nil, identity: nil)
                 super(version)
@@ -30,37 +30,6 @@ module Twilio
                 @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Factors"
               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.
-              # @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)
-                data = Twilio::Values.of({
-                    'Binding' => binding,
-                    'FriendlyName' => friendly_name,
-                    'FactorType' => factor_type,
-                })
-
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
-
-                FactorInstance.new(
-                    @version,
-                    payload,
-                    service_sid: @solution[:service_sid],
-                    identity: @solution[:identity],
-                )
-              end
-
               ##
               # Lists FactorInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
@@ -122,11 +91,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 +113,10 @@ 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.
             class FactorPage < Page
               ##
               # Initialize the FactorPage
@@ -182,19 +147,19 @@ 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.
             class FactorContext < InstanceContext
               ##
               # Initialize the FactorContext
               # @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
+              #   Factor. This identifier should be immutable, not PII, length between 8 and 64
+              #   characters, and generated by your external system, such as your user's UUID,
+              #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
               # @param [String] sid A 34 character string that uniquely identifies this Factor.
               # @return [FactorContext] FactorContext
               def initialize(version, service_sid, identity, sid)
@@ -203,29 +168,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
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # 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 +196,42 @@ 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. It can be up
+              #   to 64 characters.
+              # @param [String] config_notification_token For APN, the device token. For FCM,
+              #   the registration token. It is used to send the push notifications. Required when
+              #   `factor_type` is `push`. If specified, this value must be between 32 and 255
+              #   characters long.
+              # @param [String] config_sdk_version The Verify Push SDK version used to configure
+              #   the factor
+              # @param [String] config_time_step Defines how often, in seconds, are TOTP codes
+              #   generated. i.e, a new TOTP code is generated every time_step seconds. Must be
+              #   between 20 and 60 seconds, inclusive
+              # @param [String] config_skew The number of time-steps, past and future, that are
+              #   valid for validation of TOTP codes. Must be between 0 and 2, inclusive
+              # @param [String] config_code_length Number of digits for generated TOTP codes.
+              #   Must be between 3 and 8, inclusive
+              # @param [factor.TotpAlgorithms] config_alg The algorithm used to derive the TOTP
+              #   codes. Can be `sha1`, `sha256` or `sha512`
+              # @param [String] config_notification_platform The transport technology used to
+              #   generate the Notification Token. Can be `apn`, `fcm` or `none`.
+              #
+              #   Required when `factor_type` is `push`.
               # @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, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset, config_notification_platform: :unset)
+                data = Twilio::Values.of({
+                    'AuthPayload' => auth_payload,
+                    'FriendlyName' => friendly_name,
+                    'Config.NotificationToken' => config_notification_token,
+                    'Config.SdkVersion' => config_sdk_version,
+                    'Config.TimeStep' => config_time_step,
+                    'Config.Skew' => config_skew,
+                    'Config.CodeLength' => config_code_length,
+                    'Config.Alg' => config_alg,
+                    'Config.NotificationPlatform' => config_notification_platform,
+                })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 FactorInstance.new(
                     @version,
@@ -260,44 +243,20 @@ 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
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Verify.V2.FactorContext #{context}>"
               end
 
               ##
-              # Provide a user friendly representation
-              def to_s
+              # 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.
             class FactorInstance < InstanceResource
               ##
               # Initialize the FactorInstance
@@ -305,7 +264,9 @@ module Twilio
               # @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
+              #   Factor. This identifier should be immutable, not PII, length between 8 and 64
+              #   characters, and generated by your external system, such as your user's UUID,
+              #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
               # @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)
@@ -323,8 +284,9 @@ module Twilio
                     'friendly_name' => payload['friendly_name'],
                     'status' => payload['status'],
                     'factor_type' => payload['factor_type'],
+                    'config' => payload['config'],
+                    'metadata' => payload['metadata'],
                     'url' => payload['url'],
-                    'links' => payload['links'],
                 }
 
                 # Context
@@ -373,7 +335,7 @@ module Twilio
               end
 
               ##
-              # @return [String] Unique identity of the Entity
+              # @return [String] Unique external identifier of the Entity
               def identity
                 @properties['identity']
               end
@@ -409,26 +371,32 @@ module Twilio
               end
 
               ##
-              # @return [String] The URL of this resource.
-              def url
-                @properties['url']
+              # @return [Hash] Configurations for a `factor_type`.
+              def config
+                @properties['config']
+              end
+
+              ##
+              # @return [Hash] Metadata of the factor.
+              def metadata
+                @properties['metadata']
               end
 
               ##
-              # @return [String] Nested resource URLs.
-              def links
-                @properties['links']
+              # @return [String] The URL of this resource.
+              def url
+                @properties['url']
               end
 
               ##
-              # Deletes the FactorInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # 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
@@ -438,30 +406,54 @@ 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. It can be up
+              #   to 64 characters.
+              # @param [String] config_notification_token For APN, the device token. For FCM,
+              #   the registration token. It is used to send the push notifications. Required when
+              #   `factor_type` is `push`. If specified, this value must be between 32 and 255
+              #   characters long.
+              # @param [String] config_sdk_version The Verify Push SDK version used to configure
+              #   the factor
+              # @param [String] config_time_step Defines how often, in seconds, are TOTP codes
+              #   generated. i.e, a new TOTP code is generated every time_step seconds. Must be
+              #   between 20 and 60 seconds, inclusive
+              # @param [String] config_skew The number of time-steps, past and future, that are
+              #   valid for validation of TOTP codes. Must be between 0 and 2, inclusive
+              # @param [String] config_code_length Number of digits for generated TOTP codes.
+              #   Must be between 3 and 8, inclusive
+              # @param [factor.TotpAlgorithms] config_alg The algorithm used to derive the TOTP
+              #   codes. Can be `sha1`, `sha256` or `sha512`
+              # @param [String] config_notification_platform The transport technology used to
+              #   generate the Notification Token. Can be `apn`, `fcm` or `none`.
+              #
+              #   Required when `factor_type` is `push`.
               # @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, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset, config_notification_platform: :unset)
+                context.update(
+                    auth_payload: auth_payload,
+                    friendly_name: friendly_name,
+                    config_notification_token: config_notification_token,
+                    config_sdk_version: config_sdk_version,
+                    config_time_step: config_time_step,
+                    config_skew: config_skew,
+                    config_code_length: config_code_length,
+                    config_alg: config_alg,
+                    config_notification_platform: config_notification_platform,
+                )
               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