twilio-ruby 5.31.1 → 5.54.0

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/{authy/v1 → verify/v2}/service/entity/factor.rb

@@ -8,19 +8,21 @@
 
 module Twilio
   module REST
-    class Authy < Domain
-      class V1 < Version
+    class Verify < Domain
+      class V2 < Version
         class ServiceContext < InstanceContext
           class EntityContext < InstanceContext
             ##
-            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class FactorList < ListResource
               ##
               # Initialize the FactorList
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The unique SID identifier of the Service.
-              # @param [String] identity Customer unique identity for the Entity owner of the
-              #   Factor
+              # @param [String] identity The unique external identifier for the Entity of the
+              #   Service. This identifier should be immutable, not PII, and generated by your
+              #   external system, such as your user's UUID, GUID, or SID. This value must be
+              #   between 8 and 64 characters long.
               # @return [FactorList] FactorList
               def initialize(version, service_sid: nil, identity: nil)
                 super(version)
@@ -30,37 +32,6 @@ module Twilio
                 @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Factors"
               end
 
-              ##
-              # Retrieve a single page of FactorInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] binding A unique binding for this Factor that identifies it.
-              #   E.g. a phone number for `sms` factors. Required when creating a new Factor. This
-              #   value is never returned because it can contain customer secrets.
-              # @param [String] friendly_name The friendly name of this Factor
-              # @param [factor.FactorTypes] factor_type The Type of this Factor. One of
-              #   `app-push`, `sms`, `totp`, etc.
-              # @return [FactorInstance] Newly created FactorInstance
-              def create(binding: nil, friendly_name: nil, factor_type: nil)
-                data = Twilio::Values.of({
-                    'Binding' => binding,
-                    'FriendlyName' => friendly_name,
-                    'FactorType' => factor_type,
-                })
-
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
-
-                FactorInstance.new(
-                    @version,
-                    payload,
-                    service_sid: @solution[:service_sid],
-                    identity: @solution[:identity],
-                )
-              end
-
               ##
               # Lists FactorInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
@@ -122,11 +93,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 FactorPage.new(@version, response, @solution)
               end
 
@@ -146,12 +115,12 @@ module Twilio
               ##
               # Provide a user friendly representation
               def to_s
-                '#<Twilio.Authy.V1.FactorList>'
+                '#<Twilio.Verify.V2.FactorList>'
               end
             end
 
             ##
-            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class FactorPage < Page
               ##
               # Initialize the FactorPage
@@ -182,19 +151,19 @@ module Twilio
               ##
               # Provide a user friendly representation
               def to_s
-                '<Twilio.Authy.V1.FactorPage>'
+                '<Twilio.Verify.V2.FactorPage>'
               end
             end
 
             ##
-            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class FactorContext < InstanceContext
               ##
               # Initialize the FactorContext
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The unique SID identifier of the Service.
               # @param [String] identity Customer unique identity for the Entity owner of the
-              #   Factor
+              #   Factor. This 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)
@@ -203,29 +172,20 @@ module Twilio
                 # Path Solution
                 @solution = {service_sid: service_sid, identity: identity, sid: sid, }
                 @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Factors/#{@solution[:sid]}"
-
-                # Dependents
-                @challenges = nil
               end
 
               ##
-              # Deletes the FactorInstance
+              # Delete the FactorInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
-              # Fetch a FactorInstance
+              # Fetch the FactorInstance
               # @return [FactorInstance] Fetched FactorInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 FactorInstance.new(
                     @version,
@@ -240,15 +200,37 @@ module Twilio
               # Update the FactorInstance
               # @param [String] auth_payload The optional payload needed to verify the Factor
               #   for the first time. E.g. for a TOTP, the numeric code.
+              # @param [String] friendly_name The new friendly name of this Factor. It can be up
+              #   to 64 characters.
+              # @param [String] config_notification_token For APN, the device token. For FCM the
+              #   registration token. It used to send the push notifications. Required when
+              #   `factor_type` is `push`. If specified, this value must be between 32 and 255
+              #   characters long.
+              # @param [String] config_sdk_version The Verify Push SDK version used to configure
+              #   the factor
+              # @param [String] config_time_step Defines how often, in seconds, are TOTP codes
+              #   generated. i.e, a new TOTP code is generated every time_step seconds. Must be
+              #   between 20 and 60 seconds, inclusive
+              # @param [String] config_skew The number of time-steps, past and future, that are
+              #   valid for validation of TOTP codes. Must be between 0 and 2, inclusive
+              # @param [String] config_code_length Number of digits for generated TOTP codes.
+              #   Must be between 3 and 8, inclusive
+              # @param [factor.TotpAlgorithms] config_alg The algorithm used to derive the TOTP
+              #   codes. Can be `sha1`, `sha256` or `sha512`
               # @return [FactorInstance] Updated FactorInstance
-              def update(auth_payload: :unset)
-                data = Twilio::Values.of({'AuthPayload' => auth_payload, })
+              def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset)
+                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,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 FactorInstance.new(
                     @version,
@@ -259,60 +241,33 @@ module Twilio
                 )
               end
 
-              ##
-              # Access the challenges
-              # @return [ChallengeList]
-              # @return [ChallengeContext] if sid was passed.
-              def challenges(sid=:unset)
-                raise ArgumentError, 'sid cannot be nil' if sid.nil?
-
-                if sid != :unset
-                  return ChallengeContext.new(
-                      @version,
-                      @solution[:service_sid],
-                      @solution[:identity],
-                      @solution[:sid],
-                      sid,
-                  )
-                end
-
-                unless @challenges
-                  @challenges = ChallengeList.new(
-                      @version,
-                      service_sid: @solution[:service_sid],
-                      identity: @solution[:identity],
-                      factor_sid: @solution[:sid],
-                  )
-                end
-
-                @challenges
-              end
-
               ##
               # Provide a user friendly representation
               def to_s
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-                "#<Twilio.Authy.V1.FactorContext #{context}>"
+                "#<Twilio.Verify.V2.FactorContext #{context}>"
               end
 
               ##
               # Provide a detailed, user friendly representation
               def inspect
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-                "#<Twilio.Authy.V1.FactorContext #{context}>"
+                "#<Twilio.Verify.V2.FactorContext #{context}>"
               end
             end
 
             ##
-            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class FactorInstance < InstanceResource
               ##
               # Initialize the FactorInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] service_sid The unique SID identifier of the Service.
-              # @param [String] identity Customer unique identity for the Entity owner of the
-              #   Factor
+              # @param [String] identity The unique external identifier for the Entity of the
+              #   Service. This identifier should be immutable, not PII, and generated by your
+              #   external system, such as your user's UUID, GUID, or SID. 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)
@@ -330,9 +285,8 @@ module Twilio
                     'friendly_name' => payload['friendly_name'],
                     'status' => payload['status'],
                     'factor_type' => payload['factor_type'],
-                    'factor_strength' => payload['factor_strength'],
+                    'config' => payload['config'],
                     'url' => payload['url'],
-                    'links' => payload['links'],
                 }
 
                 # Context
@@ -381,7 +335,7 @@ module Twilio
               end
 
               ##
-              # @return [String] Unique identity of the Entity
+              # @return [String] Unique external identifier of the Entity
               def identity
                 @properties['identity']
               end
@@ -417,9 +371,9 @@ module Twilio
               end
 
               ##
-              # @return [factor.FactorStrengths] The Strength of this Factor
-              def factor_strength
-                @properties['factor_strength']
+              # @return [Hash] Configurations for a `factor_type`.
+              def config
+                @properties['config']
               end
 
               ##
@@ -429,20 +383,14 @@ module Twilio
               end
 
               ##
-              # @return [String] Nested resource URLs.
-              def links
-                @properties['links']
-              end
-
-              ##
-              # Deletes the FactorInstance
+              # Delete the FactorInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
 
               ##
-              # Fetch a FactorInstance
+              # Fetch the FactorInstance
               # @return [FactorInstance] Fetched FactorInstance
               def fetch
                 context.fetch
@@ -452,30 +400,49 @@ module Twilio
               # Update the FactorInstance
               # @param [String] auth_payload The optional payload needed to verify the Factor
               #   for the first time. E.g. for a TOTP, the numeric code.
+              # @param [String] friendly_name The new friendly name of this Factor. It can be up
+              #   to 64 characters.
+              # @param [String] config_notification_token For APN, the device token. For FCM the
+              #   registration token. It used to send the push notifications. Required when
+              #   `factor_type` is `push`. If specified, this value must be between 32 and 255
+              #   characters long.
+              # @param [String] config_sdk_version The Verify Push SDK version used to configure
+              #   the factor
+              # @param [String] config_time_step Defines how often, in seconds, are TOTP codes
+              #   generated. i.e, a new TOTP code is generated every time_step seconds. Must be
+              #   between 20 and 60 seconds, inclusive
+              # @param [String] config_skew The number of time-steps, past and future, that are
+              #   valid for validation of TOTP codes. Must be between 0 and 2, inclusive
+              # @param [String] config_code_length Number of digits for generated TOTP codes.
+              #   Must be between 3 and 8, inclusive
+              # @param [factor.TotpAlgorithms] config_alg The algorithm used to derive the TOTP
+              #   codes. Can be `sha1`, `sha256` or `sha512`
               # @return [FactorInstance] Updated FactorInstance
-              def update(auth_payload: :unset)
-                context.update(auth_payload: auth_payload, )
-              end
-
-              ##
-              # Access the challenges
-              # @return [challenges] challenges
-              def challenges
-                context.challenges
+              def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset)
+                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
 
               ##
               # Provide a user friendly representation
               def to_s
                 values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Authy.V1.FactorInstance #{values}>"
+                "<Twilio.Verify.V2.FactorInstance #{values}>"
               end
 
               ##
               # Provide a detailed, user friendly representation
               def inspect
                 values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Authy.V1.FactorInstance #{values}>"
+                "<Twilio.Verify.V2.FactorInstance #{values}>"
               end
             end
           end