twilio-ruby 5.45.0 → 5.60.0

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

@@ -19,9 +19,10 @@ module Twilio
               # Initialize the FactorList
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The unique SID identifier of the Service.
-              # @param [String] identity 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] identity Customer unique identity for the Entity owner of the
+              #   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)
@@ -31,49 +32,6 @@ module Twilio
                 @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Factors"
               end
 
-              ##
-              # Create the FactorInstance
-              # @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] 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({
-                    '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)
-
-                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
@@ -205,7 +163,9 @@ module Twilio
               # @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)
@@ -242,19 +202,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] 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 used to send the push notifications. Required when
-              #   `factor_type` is `push`
+              #   `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`
               # @return [FactorInstance] Updated FactorInstance
-              def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset)
+              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)
                 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,
                 })
 
                 payload = @version.update('POST', @uri, data: data)
@@ -291,9 +266,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 unique SID identifier of the Service.
-              # @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] identity Customer unique identity for the Entity owner of the
+              #   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)
@@ -426,19 +402,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] 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 used to send the push notifications. Required when
-              #   `factor_type` is `push`
+              #   `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`
               # @return [FactorInstance] Updated FactorInstance
-              def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset)
+              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)
                 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,
                 )
               end
 

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

@@ -0,0 +1,299 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Verify < Domain
+      class V2 < Version
+        class ServiceContext < InstanceContext
+          class EntityContext < InstanceContext
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class NewFactorList < ListResource
+              ##
+              # Initialize the NewFactorList
+              # @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. 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 [NewFactorList] NewFactorList
+              def initialize(version, service_sid: nil, identity: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {service_sid: service_sid, identity: identity}
+                @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Factors"
+              end
+
+              ##
+              # Create the NewFactorInstance
+              # @param [String] friendly_name The friendly name of this Factor. This can be any
+              #   string up to 64 characters, meant for humans to distinguish between Factors.
+              #   For `factor_type` `push`, this could be a device name.
+              #   For `factor_type` `totp`, this value is used as the “account name” in
+              #   constructing the `binding.uri` property.
+              #   At the same time, we recommend avoiding providing PII.
+              # @param [new_factor.FactorTypes] factor_type The Type of this Factor. Currently
+              #   `push` and `totp` are supported. For `totp` to work, you need to contact {Twilio
+              #   sales}[https://www.twilio.com/help/sales] first to have the Verify TOTP feature
+              #   enabled for your Twilio account.
+              # @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.
+              #
+              #   Required when `factor_type` is `push`
+              # @param [String] config_app_id The ID that uniquely identifies your app in the
+              #   Google or Apple store, such as `com.example.myapp`. It can be up to 100
+              #   characters long.
+              #
+              #   Required when `factor_type` is `push`.
+              # @param [new_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. Must be between 32
+              #   and 255 characters long.
+              #
+              #   Required when `factor_type` is `push`.
+              # @param [String] config_sdk_version The Verify Push SDK version used to configure
+              #   the factor
+              #
+              #   Required when `factor_type` is `push`
+              # @param [String] binding_secret The shared secret for TOTP factors encoded in
+              #   Base32. This can be provided when creating the Factor, otherwise it will be
+              #   generated.
+              #
+              #   Used when `factor_type` is `totp`
+              # @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. The default value is defined at the
+              #   service level in the property `totp.time_step`. Defaults to 30 seconds if not
+              #   configured.
+              #
+              #   Used when `factor_type` is `totp`
+              # @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. The
+              #   default value is defined at the service level in the property `totp.skew`. If
+              #   not configured defaults to 1.
+              #
+              #   Used when `factor_type` is `totp`
+              # @param [String] config_code_length Number of digits for generated TOTP codes.
+              #   Must be between 3 and 8, inclusive. The default value is defined at the service
+              #   level in the property `totp.code_length`. If not configured defaults to 6.
+              #
+              #   Used when `factor_type` is `totp`
+              # @param [new_factor.TotpAlgorithms] config_alg The algorithm used to derive the
+              #   TOTP codes. Can be `sha1`, `sha256` or `sha512`. Defaults to `sha1`.
+              #
+              #   Used when `factor_type` is `totp`
+              # @return [NewFactorInstance] Created NewFactorInstance
+              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, binding_secret: :unset, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset)
+                data = Twilio::Values.of({
+                    '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,
+                    'Binding.Secret' => binding_secret,
+                    'Config.TimeStep' => config_time_step,
+                    'Config.Skew' => config_skew,
+                    'Config.CodeLength' => config_code_length,
+                    'Config.Alg' => config_alg,
+                })
+
+                payload = @version.create('POST', @uri, data: data)
+
+                NewFactorInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    identity: @solution[:identity],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Verify.V2.NewFactorList>'
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class NewFactorPage < Page
+              ##
+              # Initialize the NewFactorPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [NewFactorPage] NewFactorPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of NewFactorInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [NewFactorInstance] NewFactorInstance
+              def get_instance(payload)
+                NewFactorInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    identity: @solution[:identity],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Verify.V2.NewFactorPage>'
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class NewFactorInstance < InstanceResource
+              ##
+              # Initialize the NewFactorInstance
+              # @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. 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 [NewFactorInstance] NewFactorInstance
+              def initialize(version, payload, service_sid: nil, identity: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'sid' => payload['sid'],
+                    'account_sid' => payload['account_sid'],
+                    'service_sid' => payload['service_sid'],
+                    'entity_sid' => payload['entity_sid'],
+                    'identity' => payload['identity'],
+                    'binding' => payload['binding'],
+                    'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                    'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                    'friendly_name' => payload['friendly_name'],
+                    'status' => payload['status'],
+                    'factor_type' => payload['factor_type'],
+                    'config' => payload['config'],
+                    'url' => payload['url'],
+                }
+              end
+
+              ##
+              # @return [String] A string that uniquely identifies this Factor.
+              def sid
+                @properties['sid']
+              end
+
+              ##
+              # @return [String] Account Sid.
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [String] Service Sid.
+              def service_sid
+                @properties['service_sid']
+              end
+
+              ##
+              # @return [String] Entity Sid.
+              def entity_sid
+                @properties['entity_sid']
+              end
+
+              ##
+              # @return [String] Unique external identifier of the Entity
+              def identity
+                @properties['identity']
+              end
+
+              ##
+              # @return [Hash] Unique external identifier of the Entity
+              def binding
+                @properties['binding']
+              end
+
+              ##
+              # @return [Time] The date this Factor was created
+              def date_created
+                @properties['date_created']
+              end
+
+              ##
+              # @return [Time] The date this Factor was updated
+              def date_updated
+                @properties['date_updated']
+              end
+
+              ##
+              # @return [String] A human readable description of this resource.
+              def friendly_name
+                @properties['friendly_name']
+              end
+
+              ##
+              # @return [new_factor.FactorStatuses] The Status of this Factor
+              def status
+                @properties['status']
+              end
+
+              ##
+              # @return [new_factor.FactorTypes] The Type of this Factor
+              def factor_type
+                @properties['factor_type']
+              end
+
+              ##
+              # @return [Hash] Binding for a `factor_type`.
+              def config
+                @properties['config']
+              end
+
+              ##
+              # @return [String] The URL of this resource.
+              def url
+                @properties['url']
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                "<Twilio.Verify.V2.NewFactorInstance>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                "<Twilio.Verify.V2.NewFactorInstance>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -32,7 +32,7 @@ module Twilio
             # @param [String] identity The unique external identifier for the Entity of the
             #   Service. 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.
+            #   GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
             # @return [EntityInstance] Created EntityInstance
             def create(identity: nil)
               data = Twilio::Values.of({'Identity' => identity, })
@@ -168,7 +168,9 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The unique SID identifier of the Service.
             # @param [String] identity The unique external identifier for the Entity of the
-            #   Service
+            #   Service. 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 [EntityContext] EntityContext
             def initialize(version, service_sid, identity)
               super(version)
@@ -179,6 +181,7 @@ module Twilio
 
               # Dependents
               @factors = nil
+              @new_factors = nil
               @challenges = nil
             end
 
@@ -225,6 +228,22 @@ module Twilio
               @factors
             end
 
+            ##
+            # Access the new_factors
+            # @return [NewFactorList]
+            # @return [NewFactorContext]
+            def new_factors
+              unless @new_factors
+                @new_factors = NewFactorList.new(
+                    @version,
+                    service_sid: @solution[:service_sid],
+                    identity: @solution[:identity],
+                )
+              end
+
+              @new_factors
+            end
+
             ##
             # Access the challenges
             # @return [ChallengeList]
@@ -271,7 +290,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 The unique external identifier for the Entity of the
-            #   Service
+            #   Service. 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 [EntityInstance] EntityInstance
             def initialize(version, payload, service_sid: nil, identity: nil)
               super(version)
@@ -373,6 +394,13 @@ module Twilio
               context.factors
             end
 
+            ##
+            # Access the new_factors
+            # @return [new_factors] new_factors
+            def new_factors
+              context.new_factors
+            end
+
             ##
             # Access the challenges
             # @return [challenges] challenges

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

@@ -33,7 +33,8 @@ module Twilio
             #   {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`, `whatsapp` 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
@@ -42,10 +43,11 @@ module Twilio
             #   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].
-            # @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`,
-            #   `pr-BR`, `ro`, `ru`, `sv`, `th`, `tl`, `tr`, `vi`, `zh`, `zh-CN`, or `zh-HK.`
+            # @param [String] locale The locale to use for the verification SMS, WhatsApp 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`, `pr-BR`, `ro`, `ru`, `sv`, `th`, `tl`, `tr`, `vi`, `zh`, `zh-CN`, or
+            #   `zh-HK.`
             # @param [String] custom_code A pre-generated code to use for verification. The
             #   code can be between 4 and 10 characters, inclusive.
             # @param [String] amount The amount of the associated PSD2 compliant transaction.
@@ -296,7 +298,7 @@ module Twilio
             end
 
             ##
-            # @return [Hash] An array of verification attempt objects.
+            # @return [Array[Hash]] An array of verification attempt objects.
             def send_code_attempts
               @properties['send_code_attempts']
             end