twilio-ruby 5.40.3 → 5.74.1

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

@@ -0,0 +1,199 @@
+##
+# 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
+              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 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] 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. Can be an
+                #   integer between 0 and 300. Default is 300. Delivery is attempted until the TTL
+                #   elapses, even if the device is offline. 0 means that the notification delivery
+                #   is attempted immediately, only once, and is not stored for future delivery.
+                # @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
+
+              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
+
+              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 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] 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'] == nil ? payload['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/challenge.rb

@@ -12,15 +12,15 @@ module Twilio
       class V2 < Version
         class ServiceContext < InstanceContext
           class EntityContext < InstanceContext
-            ##
-            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
             class ChallengeList < ListResource
               ##
               # Initialize the ChallengeList
               # @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 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)
@@ -33,32 +33,38 @@ module Twilio
               ##
               # Create the ChallengeInstance
               # @param [String] factor_sid The unique SID identifier of the Factor.
-              # @param [Time] expiration_date The future date in which this Challenge will
-              #   expire, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
-              # @param [String] details Details provided to give context about the Challenge.
-              #   Shown to the end user. It must be a stringified JSON with the following
-              #   structure: {"message": "string", "fields": [ { "label": "string", "value":
-              #   "string"}]}. `message` is required. If you send the `fields` property, each
-              #   field has to include `label` and `value` properties. If you had set
-              #   `include_date=true` in the `push` configuration of the
-              #   [service](https://www.twilio.com/docs/verify/api/service), the response will
-              #   also include the challenge's date created value as an additional field called
-              #   `date`
-              # @param [String] hidden_details Details provided to give context about the
+              # @param [Time] expiration_date The date-time when this Challenge expires, given
+              #   in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. The default value
+              #   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`. 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, 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"}`
-              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
+              #   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 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: :unset, hidden_details: :unset, twilio_sandbox_mode: :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' => details,
-                    'HiddenDetails' => hidden_details,
+                    '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,
                 })
-                headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
 
-                payload = @version.create('POST', @uri, data: data, headers: headers)
+                payload = @version.create('POST', @uri, data: data)
 
                 ChallengeInstance.new(
                     @version,
@@ -75,7 +81,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 [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
+              # @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,11 +91,11 @@ 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, twilio_sandbox_mode: :unset, limit: nil, page_size: nil)
+              def list(factor_sid: :unset, status: :unset, order: :unset, limit: nil, page_size: nil)
                 self.stream(
                     factor_sid: factor_sid,
                     status: status,
-                    twilio_sandbox_mode: twilio_sandbox_mode,
+                    order: order,
                     limit: limit,
                     page_size: page_size
                 ).entries
@@ -100,7 +108,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 [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
+              # @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
@@ -108,13 +118,13 @@ 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, twilio_sandbox_mode: :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,
-                    twilio_sandbox_mode: twilio_sandbox_mode,
+                    order: order,
                     page_size: limits[:page_size],
                 )
 
@@ -141,22 +151,24 @@ 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 [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
+              # @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, twilio_sandbox_mode: :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,
                 })
-                headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
 
-                response = @version.page('GET', @uri, params: params, headers: headers)
+                response = @version.page('GET', @uri, params: params)
 
                 ChallengePage.new(@version, response, @solution)
               end
@@ -181,8 +193,6 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
             class ChallengePage < Page
               ##
               # Initialize the ChallengePage
@@ -217,16 +227,15 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
             class ChallengeContext < InstanceContext
               ##
               # 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.
+              # @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
@@ -236,16 +245,16 @@ 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
 
               ##
               # Fetch the ChallengeInstance
-              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
               # @return [ChallengeInstance] Fetched ChallengeInstance
-              def fetch(twilio_sandbox_mode: :unset)
-                headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
-
-                payload = @version.fetch('GET', @uri, headers: headers)
+              def fetch
+                payload = @version.fetch('GET', @uri)
 
                 ChallengeInstance.new(
                     @version,
@@ -259,14 +268,21 @@ 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.
-              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
+              #   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, twilio_sandbox_mode: :unset)
-                data = Twilio::Values.of({'AuthPayload' => auth_payload, })
-                headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })
+              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, headers: headers)
+                payload = @version.update('POST', @uri, data: data)
 
                 ChallengeInstance.new(
                     @version,
@@ -277,6 +293,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
@@ -292,8 +325,6 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
             class ChallengeInstance < InstanceResource
               ##
               # Initialize the ChallengeInstance
@@ -301,7 +332,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
+              #   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
@@ -324,8 +357,10 @@ 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'],
                 }
 
                 # Context
@@ -404,7 +439,7 @@ module Twilio
               end
 
               ##
-              # @return [Time] The date this Challenge is expired
+              # @return [Time] The date-time when this Challenge expires
               def expiration_date
                 @properties['expiration_date']
               end
@@ -422,17 +457,23 @@ module Twilio
               end
 
               ##
-              # @return [String] Public details provided to contextualize the Challenge
+              # @return [Hash] Details about the Challenge.
               def details
                 @properties['details']
               end
 
               ##
-              # @return [String] Hidden details provided to contextualize the Challenge
+              # @return [Hash] Hidden details about the Challenge
               def hidden_details
                 @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
@@ -445,22 +486,39 @@ module Twilio
                 @properties['url']
               end
 
+              ##
+              # @return [String] Nested resource URLs.
+              def links
+                @properties['links']
+              end
+
               ##
               # Fetch the ChallengeInstance
-              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
               # @return [ChallengeInstance] Fetched ChallengeInstance
-              def fetch(twilio_sandbox_mode: :unset)
-                context.fetch(twilio_sandbox_mode: twilio_sandbox_mode, )
+              def fetch
+                context.fetch
               end
 
               ##
               # Update the ChallengeInstance
               # @param [String] auth_payload The optional payload needed to verify the
-              #   Challenge. E.g., a TOTP would use the numeric code.
-              # @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
+              #   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, twilio_sandbox_mode: :unset)
-                context.update(auth_payload: auth_payload, twilio_sandbox_mode: twilio_sandbox_mode, )
+              def update(auth_payload: :unset, metadata: :unset)
+                context.update(auth_payload: auth_payload, metadata: metadata, )
+              end
+
+              ##
+              # Access the notifications
+              # @return [notifications] notifications
+              def notifications
+                context.notifications
               end
 
               ##