twilio-ruby 5.52.0 → 5.67.3

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

@@ -20,7 +20,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
-              #   Challenge. This value must be between 8 and 64 characters long.
+              #   Challenge. 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 [ChallengeList] ChallengeList
               def initialize(version, service_sid: nil, identity: nil)
                 super(version)
@@ -38,16 +40,21 @@ module Twilio
               #   is five (5) minutes after Challenge creation. The max value is sixty (60)
               #   minutes after creation.
               # @param [String] details_message Shown to the user when the push notification
-              #   arrives. Required when `factor_type` is `push`
+              #   arrives. Required when `factor_type` is `push`. Can be up to 256 characters in
+              #   length
               # @param [Array[Hash]] details_fields A list of objects that describe the Fields
               #   included in the Challenge. Each object contains the label and value of the
-              #   field. Used when `factor_type` is `push`.
+              #   field, the label can be up to 36 characters in length and the value can be up to
+              #   128 characters in length. Used when `factor_type` is `push`. There can be up to
+              #   20 details fields.
               # @param [Hash] hidden_details Details provided to give context about the
               #   Challenge. Not shown to the end user. It must be a stringified JSON with only
-              #   strings values eg. `{"ip": "172.168.1.234"}`
+              #   strings values eg. `{"ip": "172.168.1.234"}`. Can be up to 1024 characters in
+              #   length
               # @param [String] auth_payload Optional payload used to verify the Challenge upon
-              #   creation. Only used with a Factor of type `totp` to carry an OTP used in the
-              #   verification.
+              #   creation. Only used with a Factor of type `totp` to carry the TOTP code that
+              #   needs to be verified. For `TOTP` this value must be between 3 and 8 characters
+              #   long.
               # @return [ChallengeInstance] Created ChallengeInstance
               def create(factor_sid: nil, expiration_date: :unset, details_message: :unset, details_fields: :unset, hidden_details: :unset, auth_payload: :unset)
                 data = Twilio::Values.of({
@@ -76,6 +83,9 @@ module Twilio
               # @param [String] factor_sid The unique SID identifier of the Factor.
               # @param [challenge.ChallengeStatuses] status The Status of the Challenges to
               #   fetch. One of `pending`, `expired`, `approved` or `denied`.
+              # @param [challenge.ListOrders] order The desired sort order of the Challenges
+              #   list. One of `asc` or `desc` for ascending and descending respectively. Defaults
+              #   to `asc`.
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit.  Default is no limit
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -83,8 +93,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(factor_sid: :unset, status: :unset, limit: nil, page_size: nil)
-                self.stream(factor_sid: factor_sid, status: status, limit: limit, page_size: page_size).entries
+              def list(factor_sid: :unset, status: :unset, order: :unset, limit: nil, page_size: nil)
+                self.stream(
+                    factor_sid: factor_sid,
+                    status: status,
+                    order: order,
+                    limit: limit,
+                    page_size: page_size
+                ).entries
               end
 
               ##
@@ -94,6 +110,9 @@ module Twilio
               # @param [String] factor_sid The unique SID identifier of the Factor.
               # @param [challenge.ChallengeStatuses] status The Status of the Challenges to
               #   fetch. One of `pending`, `expired`, `approved` or `denied`.
+              # @param [challenge.ListOrders] order The desired sort order of the Challenges
+              #   list. One of `asc` or `desc` for ascending and descending respectively. Defaults
+              #   to `asc`.
               # @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
@@ -101,10 +120,15 @@ module Twilio
               #    but a limit is defined, stream() will attempt to read the limit with the most
               #    efficient page size, i.e. min(limit, 1000)
               # @return [Enumerable] Enumerable that will yield up to limit results
-              def stream(factor_sid: :unset, status: :unset, limit: nil, page_size: nil)
+              def stream(factor_sid: :unset, status: :unset, order: :unset, limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(factor_sid: factor_sid, status: status, page_size: limits[:page_size], )
+                page = self.page(
+                    factor_sid: factor_sid,
+                    status: status,
+                    order: order,
+                    page_size: limits[:page_size],
+                )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -129,14 +153,18 @@ module Twilio
               # @param [String] factor_sid The unique SID identifier of the Factor.
               # @param [challenge.ChallengeStatuses] status The Status of the Challenges to
               #   fetch. One of `pending`, `expired`, `approved` or `denied`.
+              # @param [challenge.ListOrders] order The desired sort order of the Challenges
+              #   list. One of `asc` or `desc` for ascending and descending respectively. Defaults
+              #   to `asc`.
               # @param [String] page_token PageToken provided by the API
               # @param [Integer] page_number Page Number, this value is simply for client state
               # @param [Integer] page_size Number of records to return, defaults to 50
               # @return [Page] Page of ChallengeInstance
-              def page(factor_sid: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+              def page(factor_sid: :unset, status: :unset, order: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
                 params = Twilio::Values.of({
                     'FactorSid' => factor_sid,
                     'Status' => status,
+                    'Order' => order,
                     'PageToken' => page_token,
                     'Page' => page_number,
                     'PageSize' => page_size,
@@ -210,10 +238,10 @@ module Twilio
               # Initialize the ChallengeContext
               # @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. This value must be
-              #   between 8 and 64 characters long.
+              # @param [String] identity Customer unique identity for the Entity owner of the
+              #   Challenges. 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
               #   Challenge.
               # @return [ChallengeContext] ChallengeContext
@@ -246,10 +274,19 @@ module Twilio
               ##
               # Update the ChallengeInstance
               # @param [String] auth_payload The optional payload needed to verify the
-              #   Challenge. E.g., a TOTP would use the numeric code.
+              #   Challenge. E.g., a TOTP would use the numeric code. For `TOTP` this value must
+              #   be between 3 and 8 characters long. For `Push` this value can be up to 5456
+              #   characters in length
+              # @param [Hash] metadata Custom metadata associated with the challenge. This is
+              #   added by the Device/SDK directly to allow for the inclusion of device
+              #   information. It must be a stringified JSON with only strings values eg. `{"os":
+              #   "Android"}`. Can be up to 1024 characters in length.
               # @return [ChallengeInstance] Updated ChallengeInstance
-              def update(auth_payload: :unset)
-                data = Twilio::Values.of({'AuthPayload' => auth_payload, })
+              def update(auth_payload: :unset, metadata: :unset)
+                data = Twilio::Values.of({
+                    'AuthPayload' => auth_payload,
+                    'Metadata' => Twilio.serialize_object(metadata),
+                })
 
                 payload = @version.update('POST', @uri, data: data)
 
@@ -303,7 +340,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
-              #   Challenge. This value must be between 8 and 64 characters long.
+              #   Challenge. 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
               #   Challenge.
               # @return [ChallengeInstance] ChallengeInstance
@@ -326,6 +365,7 @@ module Twilio
                     'responded_reason' => payload['responded_reason'],
                     'details' => payload['details'],
                     'hidden_details' => payload['hidden_details'],
+                    'metadata' => payload['metadata'],
                     'factor_type' => payload['factor_type'],
                     'url' => payload['url'],
                     'links' => payload['links'],
@@ -436,6 +476,12 @@ module Twilio
                 @properties['hidden_details']
               end
 
+              ##
+              # @return [Hash] Metadata of the challenge.
+              def metadata
+                @properties['metadata']
+              end
+
               ##
               # @return [challenge.FactorTypes] The Factor Type of this Challenge
               def factor_type
@@ -464,10 +510,16 @@ module Twilio
               ##
               # Update the ChallengeInstance
               # @param [String] auth_payload The optional payload needed to verify the
-              #   Challenge. E.g., a TOTP would use the numeric code.
+              #   Challenge. E.g., a TOTP would use the numeric code. For `TOTP` this value must
+              #   be between 3 and 8 characters long. For `Push` this value can be up to 5456
+              #   characters in length
+              # @param [Hash] metadata Custom metadata associated with the challenge. This is
+              #   added by the Device/SDK directly to allow for the inclusion of device
+              #   information. It must be a stringified JSON with only strings values eg. `{"os":
+              #   "Android"}`. Can be up to 1024 characters in length.
               # @return [ChallengeInstance] Updated ChallengeInstance
-              def update(auth_payload: :unset)
-                context.update(auth_payload: auth_payload, )
+              def update(auth_payload: :unset, metadata: :unset)
+                context.update(auth_payload: auth_payload, metadata: metadata, )
               end
 
               ##

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

@@ -19,10 +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. This value must be
-              #   between 8 and 64 characters long.
+              # @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)
@@ -163,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. This value must be between 8 and 64 characters long.
+              #   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)
@@ -202,8 +204,8 @@ module Twilio
               #   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 used to send the push notifications. Required when
+              # @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
@@ -217,8 +219,12 @@ module Twilio
               #   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, 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)
+              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,
@@ -228,6 +234,7 @@ module Twilio
                     '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)
@@ -264,10 +271,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. This value must be
-              #   between 8 and 64 characters long.
+              # @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)
@@ -286,6 +293,7 @@ module Twilio
                     'status' => payload['status'],
                     'factor_type' => payload['factor_type'],
                     'config' => payload['config'],
+                    'metadata' => payload['metadata'],
                     'url' => payload['url'],
                 }
 
@@ -376,6 +384,12 @@ module Twilio
                 @properties['config']
               end
 
+              ##
+              # @return [Hash] Metadata of the factor.
+              def metadata
+                @properties['metadata']
+              end
+
               ##
               # @return [String] The URL of this resource.
               def url
@@ -402,8 +416,8 @@ module Twilio
               #   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 used to send the push notifications. Required when
+              # @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
@@ -417,8 +431,12 @@ module Twilio
               #   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, 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)
+              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,
@@ -428,6 +446,7 @@ module Twilio
                     config_skew: config_skew,
                     config_code_length: config_code_length,
                     config_alg: config_alg,
+                    config_notification_platform: config_notification_platform,
                 )
               end
 

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

@@ -19,10 +19,10 @@ module Twilio
               # 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 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. This value must be
-              #   between 8 and 64 characters long.
+              # @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)
@@ -34,45 +34,72 @@ module Twilio
 
               ##
               # Create the NewFactorInstance
-              # @param [String] friendly_name The friendly name of this Factor. It can be up to
-              #   64 characters.
+              # @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 first to have the Verify TOTP feature enabled for your Twilio account.
+              #   `push` and `totp` are 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
+              #   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`. Required when `factor_type`
-              #   is `push`. If specified, it can be up to 100 characters long.
-              # @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. Required when
-              #   `factor_type` is `push`. If specified, this value must be between 32 and 255
+              #   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`,
+              #   `fcm` or `none`.
+              #
+              #   Required when `factor_type` is `push`.
+              # @param [String] config_notification_token For APN, the device token. For FCM,
+              #   the registration token. It is 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
+              #   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. If not configured defaults to 30
-              #   seconds
+              #   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
+              #   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
+              #   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`
+              #   TOTP codes. Can be `sha1`, `sha256` or `sha512`. Defaults to `sha1`.
+              #
+              #   Used when `factor_type` is `totp`
+              # @param [Hash] metadata Custom metadata associated with the factor. This is added
+              #   by the Device/SDK directly to allow for the inclusion of device information. It
+              #   must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can
+              #   be up to 1024 characters in length.
               # @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)
+              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, metadata: :unset)
                 data = Twilio::Values.of({
                     'FriendlyName' => friendly_name,
                     'FactorType' => factor_type,
@@ -87,6 +114,7 @@ module Twilio
                     'Config.Skew' => config_skew,
                     'Config.CodeLength' => config_code_length,
                     'Config.Alg' => config_alg,
+                    'Metadata' => Twilio.serialize_object(metadata),
                 })
 
                 payload = @version.create('POST', @uri, data: data)
@@ -150,10 +178,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. This value must be
-              #   between 8 and 64 characters long.
+              # @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)
@@ -172,6 +200,7 @@ module Twilio
                     'status' => payload['status'],
                     'factor_type' => payload['factor_type'],
                     'config' => payload['config'],
+                    'metadata' => payload['metadata'],
                     'url' => payload['url'],
                 }
               end
@@ -207,7 +236,7 @@ module Twilio
               end
 
               ##
-              # @return [Hash] Unique external identifier of the Entity
+              # @return [Hash] Binding of the factor
               def binding
                 @properties['binding']
               end
@@ -243,11 +272,17 @@ module Twilio
               end
 
               ##
-              # @return [Hash] Binding for a `factor_type`.
+              # @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] The URL of this resource.
               def url

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)
@@ -288,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)

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.
@@ -59,13 +61,20 @@ module Twilio
             #   may include multiple Rate Limit values in each request.
             # @param [Hash] channel_configuration
             #   {`email`}[https://www.twilio.com/docs/verify/email] channel configuration in
-            #   json format. Must include 'from' and 'from_name'.
+            #   json format. The fields 'from' and 'from_name' are optional but if included the
+            #   'from' field must have a valid email address.
             # @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`.
+            # @param [String] template_sid The message
+            #   {template}[https://www.twilio.com/docs/verify/api/templates]. If provided, will
+            #   override the default template for the Service. SMS channel only.
+            # @param [String] template_custom_substitutions A stringified JSON object in which
+            #   the keys are the template's special variables and the values are the variables
+            #   substitutions.
             # @return [VerificationInstance] Created VerificationInstance
-            def create(to: nil, channel: nil, custom_friendly_name: :unset, custom_message: :unset, send_digits: :unset, locale: :unset, custom_code: :unset, amount: :unset, payee: :unset, rate_limits: :unset, channel_configuration: :unset, app_hash: :unset)
+            def create(to: nil, channel: nil, custom_friendly_name: :unset, custom_message: :unset, send_digits: :unset, locale: :unset, custom_code: :unset, amount: :unset, payee: :unset, rate_limits: :unset, channel_configuration: :unset, app_hash: :unset, template_sid: :unset, template_custom_substitutions: :unset)
               data = Twilio::Values.of({
                   'To' => to,
                   'Channel' => channel,
@@ -79,6 +88,8 @@ module Twilio
                   'RateLimits' => Twilio.serialize_object(rate_limits),
                   'ChannelConfiguration' => Twilio.serialize_object(channel_configuration),
                   'AppHash' => app_hash,
+                  'TemplateSid' => template_sid,
+                  'TemplateCustomSubstitutions' => template_custom_substitutions,
               })
 
               payload = @version.create('POST', @uri, data: data)
@@ -216,6 +227,7 @@ module Twilio
                   'send_code_attempts' => payload['send_code_attempts'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                  'sna' => payload['sna'],
                   'url' => payload['url'],
               }
 
@@ -313,6 +325,12 @@ module Twilio
               @properties['date_updated']
             end
 
+            ##
+            # @return [Hash] The set of fields used for a silent network auth (`sna`) verification
+            def sna
+              @properties['sna']
+            end
+
             ##
             # @return [String] The absolute URL of the Verification resource
             def url