twilio-ruby 5.47.0 → 5.52.0

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

@@ -179,6 +179,7 @@ module Twilio
 
               # Dependents
               @factors = nil
+              @new_factors = nil
               @challenges = nil
             end
 
@@ -225,6 +226,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]
@@ -373,6 +390,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/entity/challenge.rb

@@ -20,7 +20,7 @@ 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
+              #   Challenge. This value must be between 8 and 64 characters long.
               # @return [ChallengeList] ChallengeList
               def initialize(version, service_sid: nil, identity: nil)
                 super(version)
@@ -45,14 +45,18 @@ module Twilio
               # @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"}`
+              # @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.
               # @return [ChallengeInstance] Created ChallengeInstance
-              def create(factor_sid: nil, expiration_date: :unset, details_message: :unset, details_fields: :unset, hidden_details: :unset)
+              def create(factor_sid: nil, expiration_date: :unset, details_message: :unset, details_fields: :unset, hidden_details: :unset, auth_payload: :unset)
                 data = Twilio::Values.of({
                     'FactorSid' => factor_sid,
                     'ExpirationDate' => Twilio.serialize_iso8601_datetime(expiration_date),
                     'Details.Message' => details_message,
                     'Details.Fields' => Twilio.serialize_list(details_fields) { |e| Twilio.serialize_object(e) },
                     'HiddenDetails' => Twilio.serialize_object(hidden_details),
+                    'AuthPayload' => auth_payload,
                 })
 
                 payload = @version.create('POST', @uri, data: data)
@@ -208,7 +212,8 @@ module 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.
+              #   external system, such as your user's UUID, GUID, or SID. This value must be
+              #   between 8 and 64 characters long.
               # @param [String] sid A 34 character string that uniquely identifies this
               #   Challenge.
               # @return [ChallengeContext] ChallengeContext
@@ -218,6 +223,9 @@ module Twilio
                 # Path Solution
                 @solution = {service_sid: service_sid, identity: identity, sid: sid, }
                 @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Challenges/#{@solution[:sid]}"
+
+                # Dependents
+                @notifications = nil
               end
 
               ##
@@ -254,6 +262,23 @@ module Twilio
                 )
               end
 
+              ##
+              # Access the notifications
+              # @return [NotificationList]
+              # @return [NotificationContext]
+              def notifications
+                unless @notifications
+                  @notifications = NotificationList.new(
+                      @version,
+                      service_sid: @solution[:service_sid],
+                      identity: @solution[:identity],
+                      challenge_sid: @solution[:sid],
+                  )
+                end
+
+                @notifications
+              end
+
               ##
               # Provide a user friendly representation
               def to_s
@@ -278,7 +303,7 @@ 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
+              #   Challenge. This value must be between 8 and 64 characters long.
               # @param [String] sid A 34 character string that uniquely identifies this
               #   Challenge.
               # @return [ChallengeInstance] ChallengeInstance
@@ -303,6 +328,7 @@ module Twilio
                     'hidden_details' => payload['hidden_details'],
                     'factor_type' => payload['factor_type'],
                     'url' => payload['url'],
+                    'links' => payload['links'],
                 }
 
                 # Context
@@ -422,6 +448,12 @@ module Twilio
                 @properties['url']
               end
 
+              ##
+              # @return [String] Nested resource URLs.
+              def links
+                @properties['links']
+              end
+
               ##
               # Fetch the ChallengeInstance
               # @return [ChallengeInstance] Fetched ChallengeInstance
@@ -438,6 +470,13 @@ module Twilio
                 context.update(auth_payload: auth_payload, )
               end
 
+              ##
+              # Access the notifications
+              # @return [notifications] notifications
+              def notifications
+                context.notifications
+              end
+
               ##
               # Provide a user friendly representation
               def to_s

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

@@ -0,0 +1,202 @@
+##
+# 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
+            class ChallengeContext < InstanceContext
+              ##
+              # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+              class NotificationList < ListResource
+                ##
+                # Initialize the NotificationList
+                # @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.
+                # @param [String] challenge_sid The unique SID identifier of the Challenge.
+                # @return [NotificationList] NotificationList
+                def initialize(version, service_sid: nil, identity: nil, challenge_sid: nil)
+                  super(version)
+
+                  # Path Solution
+                  @solution = {service_sid: service_sid, identity: identity, challenge_sid: challenge_sid}
+                  @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Challenges/#{@solution[:challenge_sid]}/Notifications"
+                end
+
+                ##
+                # Create the NotificationInstance
+                # @param [String] ttl How long, in seconds, the Notification is valid. Delivery
+                #   will be attempted if the device is offline until the TTL elapses. 0 means that
+                #   the notification delivery is attempted immediately, only once, and is not stored
+                #   for future delivery. Must be an integer between 0 and 300 seconds, inclusive.
+                #   Defaults to 300 seconds.
+                # @return [NotificationInstance] Created NotificationInstance
+                def create(ttl: :unset)
+                  data = Twilio::Values.of({'Ttl' => ttl, })
+
+                  payload = @version.create('POST', @uri, data: data)
+
+                  NotificationInstance.new(
+                      @version,
+                      payload,
+                      service_sid: @solution[:service_sid],
+                      identity: @solution[:identity],
+                      challenge_sid: @solution[:challenge_sid],
+                  )
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  '#<Twilio.Verify.V2.NotificationList>'
+                end
+              end
+
+              ##
+              # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+              class NotificationPage < Page
+                ##
+                # Initialize the NotificationPage
+                # @param [Version] version Version that contains the resource
+                # @param [Response] response Response from the API
+                # @param [Hash] solution Path solution for the resource
+                # @return [NotificationPage] NotificationPage
+                def initialize(version, response, solution)
+                  super(version, response)
+
+                  # Path Solution
+                  @solution = solution
+                end
+
+                ##
+                # Build an instance of NotificationInstance
+                # @param [Hash] payload Payload response from the API
+                # @return [NotificationInstance] NotificationInstance
+                def get_instance(payload)
+                  NotificationInstance.new(
+                      @version,
+                      payload,
+                      service_sid: @solution[:service_sid],
+                      identity: @solution[:identity],
+                      challenge_sid: @solution[:challenge_sid],
+                  )
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  '<Twilio.Verify.V2.NotificationPage>'
+                end
+              end
+
+              ##
+              # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+              class NotificationInstance < InstanceResource
+                ##
+                # Initialize the NotificationInstance
+                # @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
+                #   Challenge. This value must be between 8 and 64 characters long.
+                # @param [String] challenge_sid The unique SID identifier of the Challenge.
+                # @return [NotificationInstance] NotificationInstance
+                def initialize(version, payload, service_sid: nil, identity: nil, challenge_sid: 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'],
+                      'challenge_sid' => payload['challenge_sid'],
+                      'priority' => payload['priority'],
+                      'ttl' => payload['ttl'].to_i,
+                      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  }
+                end
+
+                ##
+                # @return [String] A string that uniquely identifies this Notification.
+                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 [String] Challenge Sid.
+                def challenge_sid
+                  @properties['challenge_sid']
+                end
+
+                ##
+                # @return [String] The priority of the Notification.
+                def priority
+                  @properties['priority']
+                end
+
+                ##
+                # @return [String] How long, in seconds, the Notification is valid.
+                def ttl
+                  @properties['ttl']
+                end
+
+                ##
+                # @return [Time] The date this Notification was created
+                def date_created
+                  @properties['date_created']
+                end
+
+                ##
+                # Provide a user friendly representation
+                def to_s
+                  "<Twilio.Verify.V2.NotificationInstance>"
+                end
+
+                ##
+                # Provide a detailed, user friendly representation
+                def inspect
+                  "<Twilio.Verify.V2.NotificationInstance>"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -21,7 +21,8 @@ module 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.
+              #   external system, such as your user's UUID, GUID, or SID. This value must be
+              #   between 8 and 64 characters long.
               # @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,7 @@ 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 value must be between 8 and 64 characters long.
               # @param [String] sid A 34 character string that uniquely identifies this Factor.
               # @return [FactorContext] FactorContext
               def initialize(version, service_sid, identity, sid)
@@ -242,19 +200,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)
@@ -293,7 +266,8 @@ module 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.
+              #   external system, such as your user's UUID, GUID, or SID. This value must be
+              #   between 8 and 64 characters long.
               # @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 +400,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