twilio-ruby 5.6.0 → 5.33.0

data/lib/twilio-ruby/rest/{preview/proxy/service/session/participant/message_interaction.rb → authy/v1/service/entity/factor/challenge.rb}

@@ -3,42 +3,51 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
-    class Preview < Domain
-      class Proxy < Version
+    class Authy < Domain
+      class V1 < Version
         class ServiceContext < InstanceContext
-          class SessionContext < InstanceContext
-            class ParticipantContext < InstanceContext
+          class EntityContext < InstanceContext
+            class FactorContext < 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 MessageInteractionList < ListResource
+              class ChallengeList < ListResource
                 ##
-                # Initialize the MessageInteractionList
+                # Initialize the ChallengeList
                 # @param [Version] version Version that contains the resource
                 # @param [String] service_sid The unique SID identifier of the Service.
-                # @param [String] session_sid The unique SID identifier of the Session.
-                # @param [String] participant_sid The participant_sid
-                # @return [MessageInteractionList] MessageInteractionList
-                def initialize(version, service_sid: nil, session_sid: nil, participant_sid: nil)
+                # @param [String] identity Customer unique identity for the Entity owner of the
+                #   Challenge
+                # @param [String] factor_sid The unique SID identifier of the Factor.
+                # @return [ChallengeList] ChallengeList
+                def initialize(version, service_sid: nil, identity: nil, factor_sid: nil)
                   super(version)
 
                   # Path Solution
-                  @solution = {service_sid: service_sid, session_sid: session_sid, participant_sid: participant_sid}
-                  @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Participants/#{@solution[:participant_sid]}/MessageInteractions"
+                  @solution = {service_sid: service_sid, identity: identity, factor_sid: factor_sid}
+                  @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Factors/#{@solution[:factor_sid]}/Challenges"
                 end
 
                 ##
-                # Retrieve a single page of MessageInteractionInstance records from the API.
+                # Retrieve a single page of ChallengeInstance records from the API.
                 # Request is executed immediately.
-                # @param [String] body The text body of the message to send to the Participant. Up
-                #   to 1600 characters long.
-                # @param [String] media_url The public url of an image or video to send to the
-                #   Participant.
-                # @return [MessageInteractionInstance] Newly created MessageInteractionInstance
-                def create(body: :unset, media_url: :unset)
-                  data = Twilio::Values.of({'Body' => body, 'MediaUrl' => Twilio.serialize_list(media_url) { |e| e }})
+                # @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.
+                # @param [String] hidden_details Details provided to give context about the
+                #   Challenge. Not shown to the end user.
+                # @return [ChallengeInstance] Newly created ChallengeInstance
+                def create(expiration_date: :unset, details: :unset, hidden_details: :unset)
+                  data = Twilio::Values.of({
+                      'ExpirationDate' => Twilio.serialize_iso8601_datetime(expiration_date),
+                      'Details' => details,
+                      'HiddenDetails' => hidden_details,
+                  })
 
                   payload = @version.create(
                       'POST',
@@ -46,19 +55,21 @@ module Twilio
                       data: data
                   )
 
-                  MessageInteractionInstance.new(
+                  ChallengeInstance.new(
                       @version,
                       payload,
                       service_sid: @solution[:service_sid],
-                      session_sid: @solution[:session_sid],
-                      participant_sid: @solution[:participant_sid],
+                      identity: @solution[:identity],
+                      factor_sid: @solution[:factor_sid],
                   )
                 end
 
                 ##
-                # Lists MessageInteractionInstance records from the API as a list.
+                # Lists ChallengeInstance records from the API as a list.
                 # Unlike stream(), this operation is eager and will load `limit` records into
                 # memory before returning.
+                # @param [challenge.ChallengeStatuses] status The Status of the Challenges to
+                #   fetch. One of `pending`, `expired`, `approved` or `denied`.
                 # @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
@@ -66,14 +77,16 @@ 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(limit: nil, page_size: nil)
-                  self.stream(limit: limit, page_size: page_size).entries
+                def list(status: :unset, limit: nil, page_size: nil)
+                  self.stream(status: status, limit: limit, page_size: page_size).entries
                 end
 
                 ##
-                # Streams MessageInteractionInstance records from the API as an Enumerable.
+                # Streams ChallengeInstance records from the API as an Enumerable.
                 # This operation lazily loads records as efficiently as possible until the limit
                 # is reached.
+                # @param [challenge.ChallengeStatuses] status The Status of the Challenges to
+                #   fetch. One of `pending`, `expired`, `approved` or `denied`.
                 # @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
@@ -81,22 +94,22 @@ 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(limit: nil, page_size: nil)
+                def stream(status: :unset, limit: nil, page_size: nil)
                   limits = @version.read_limits(limit, page_size)
 
-                  page = self.page(page_size: limits[:page_size])
+                  page = self.page(status: status, page_size: limits[:page_size], )
 
                   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                 end
 
                 ##
-                # When passed a block, yields MessageInteractionInstance records from the API.
+                # When passed a block, yields ChallengeInstance records from the API.
                 # This operation lazily loads records as efficiently as possible until the limit
                 # is reached.
                 def each
                   limits = @version.read_limits
 
-                  page = self.page(page_size: limits[:page_size])
+                  page = self.page(page_size: limits[:page_size], )
 
                   @version.stream(page,
                                   limit: limits[:limit],
@@ -104,14 +117,17 @@ module Twilio
                 end
 
                 ##
-                # Retrieve a single page of MessageInteractionInstance records from the API.
+                # Retrieve a single page of ChallengeInstance records from the API.
                 # Request is executed immediately.
+                # @param [challenge.ChallengeStatuses] status The Status of the Challenges to
+                #   fetch. One of `pending`, `expired`, `approved` or `denied`.
                 # @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 MessageInteractionInstance
-                def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                # @return [Page] Page of ChallengeInstance
+                def page(status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
                   params = Twilio::Values.of({
+                      'Status' => status,
                       'PageToken' => page_token,
                       'Page' => page_number,
                       'PageSize' => page_size,
@@ -121,38 +137,38 @@ module Twilio
                       @uri,
                       params
                   )
-                  MessageInteractionPage.new(@version, response, @solution)
+                  ChallengePage.new(@version, response, @solution)
                 end
 
                 ##
-                # Retrieve a single page of MessageInteractionInstance records from the API.
+                # Retrieve a single page of ChallengeInstance records from the API.
                 # Request is executed immediately.
                 # @param [String] target_url API-generated URL for the requested results page
-                # @return [Page] Page of MessageInteractionInstance
+                # @return [Page] Page of ChallengeInstance
                 def get_page(target_url)
                   response = @version.domain.request(
                       'GET',
                       target_url
                   )
-                  MessageInteractionPage.new(@version, response, @solution)
+                  ChallengePage.new(@version, response, @solution)
                 end
 
                 ##
                 # Provide a user friendly representation
                 def to_s
-                  '#<Twilio.Preview.Proxy.MessageInteractionList>'
+                  '#<Twilio.Authy.V1.ChallengeList>'
                 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 MessageInteractionPage < Page
+              class ChallengePage < Page
                 ##
-                # Initialize the MessageInteractionPage
+                # Initialize the ChallengePage
                 # @param [Version] version Version that contains the resource
                 # @param [Response] response Response from the API
                 # @param [Hash] solution Path solution for the resource
-                # @return [MessageInteractionPage] MessageInteractionPage
+                # @return [ChallengePage] ChallengePage
                 def initialize(version, response, solution)
                   super(version, response)
 
@@ -161,54 +177,58 @@ module Twilio
                 end
 
                 ##
-                # Build an instance of MessageInteractionInstance
+                # Build an instance of ChallengeInstance
                 # @param [Hash] payload Payload response from the API
-                # @return [MessageInteractionInstance] MessageInteractionInstance
+                # @return [ChallengeInstance] ChallengeInstance
                 def get_instance(payload)
-                  MessageInteractionInstance.new(
+                  ChallengeInstance.new(
                       @version,
                       payload,
                       service_sid: @solution[:service_sid],
-                      session_sid: @solution[:session_sid],
-                      participant_sid: @solution[:participant_sid],
+                      identity: @solution[:identity],
+                      factor_sid: @solution[:factor_sid],
                   )
                 end
 
                 ##
                 # Provide a user friendly representation
                 def to_s
-                  '<Twilio.Preview.Proxy.MessageInteractionPage>'
+                  '<Twilio.Authy.V1.ChallengePage>'
                 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 MessageInteractionContext < InstanceContext
+              class ChallengeContext < InstanceContext
                 ##
-                # Initialize the MessageInteractionContext
+                # Initialize the ChallengeContext
                 # @param [Version] version Version that contains the resource
                 # @param [String] service_sid The unique SID identifier of the Service.
-                # @param [String] session_sid The unique SID identifier of the Session.
-                # @param [String] participant_sid The unique SID identifier of the Participant.
+                # @param [String] identity Customer unique identity for the Entity owner of the
+                #   Challenge
+                # @param [String] factor_sid The unique SID identifier of the Factor.
                 # @param [String] sid A 34 character string that uniquely identifies this
-                #   Interaction.
-                # @return [MessageInteractionContext] MessageInteractionContext
-                def initialize(version, service_sid, session_sid, participant_sid, sid)
+                #   Challenge. It also allows the keyword `latest` to fetch the most recent active
+                #   Challenge created for a Factor.
+                # @return [ChallengeContext] ChallengeContext
+                def initialize(version, service_sid, identity, factor_sid, sid)
                   super(version)
 
                   # Path Solution
-                  @solution = {
-                      service_sid: service_sid,
-                      session_sid: session_sid,
-                      participant_sid: participant_sid,
-                      sid: sid,
-                  }
-                  @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Participants/#{@solution[:participant_sid]}/MessageInteractions/#{@solution[:sid]}"
+                  @solution = {service_sid: service_sid, identity: identity, factor_sid: factor_sid, sid: sid, }
+                  @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Factors/#{@solution[:factor_sid]}/Challenges/#{@solution[:sid]}"
+                end
+
+                ##
+                # Deletes the ChallengeInstance
+                # @return [Boolean] true if delete succeeds, false otherwise
+                def delete
+                  @version.delete('delete', @uri)
                 end
 
                 ##
-                # Fetch a MessageInteractionInstance
-                # @return [MessageInteractionInstance] Fetched MessageInteractionInstance
+                # Fetch a ChallengeInstance
+                # @return [ChallengeInstance] Fetched ChallengeInstance
                 def fetch
                   params = Twilio::Values.of({})
 
@@ -218,12 +238,36 @@ module Twilio
                       params,
                   )
 
-                  MessageInteractionInstance.new(
+                  ChallengeInstance.new(
+                      @version,
+                      payload,
+                      service_sid: @solution[:service_sid],
+                      identity: @solution[:identity],
+                      factor_sid: @solution[:factor_sid],
+                      sid: @solution[:sid],
+                  )
+                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.
+                # @return [ChallengeInstance] Updated ChallengeInstance
+                def update(auth_payload: :unset)
+                  data = Twilio::Values.of({'AuthPayload' => auth_payload, })
+
+                  payload = @version.update(
+                      'POST',
+                      @uri,
+                      data: data,
+                  )
+
+                  ChallengeInstance.new(
                       @version,
                       payload,
                       service_sid: @solution[:service_sid],
-                      session_sid: @solution[:session_sid],
-                      participant_sid: @solution[:participant_sid],
+                      identity: @solution[:identity],
+                      factor_sid: @solution[:factor_sid],
                       sid: @solution[:sid],
                   )
                 end
@@ -232,47 +276,52 @@ module Twilio
                 # Provide a user friendly representation
                 def to_s
                   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-                  "#<Twilio.Preview.Proxy.MessageInteractionContext #{context}>"
+                  "#<Twilio.Authy.V1.ChallengeContext #{context}>"
+                end
+
+                ##
+                # Provide a detailed, user friendly representation
+                def inspect
+                  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                  "#<Twilio.Authy.V1.ChallengeContext #{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.
-              class MessageInteractionInstance < InstanceResource
+              class ChallengeInstance < InstanceResource
                 ##
-                # Initialize the MessageInteractionInstance
+                # Initialize the ChallengeInstance
                 # @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] session_sid The unique SID identifier of the Session.
-                # @param [String] participant_sid The participant_sid
+                # @param [String] identity Customer unique identity for the Entity owner of the
+                #   Challenge
+                # @param [String] factor_sid The unique SID identifier of the Factor.
                 # @param [String] sid A 34 character string that uniquely identifies this
-                #   Interaction.
-                # @return [MessageInteractionInstance] MessageInteractionInstance
-                def initialize(version, payload, service_sid: nil, session_sid: nil, participant_sid: nil, sid: nil)
+                #   Challenge. It also allows the keyword `latest` to fetch the most recent active
+                #   Challenge created for a Factor.
+                # @return [ChallengeInstance] ChallengeInstance
+                def initialize(version, payload, service_sid: nil, identity: nil, factor_sid: nil, sid: nil)
                   super(version)
 
                   # Marshaled Properties
                   @properties = {
                       'sid' => payload['sid'],
-                      'session_sid' => payload['session_sid'],
-                      'service_sid' => payload['service_sid'],
                       'account_sid' => payload['account_sid'],
-                      'data' => payload['data'],
-                      'status' => payload['status'],
-                      'participant_sid' => payload['participant_sid'],
-                      'inbound_participant_sid' => payload['inbound_participant_sid'],
-                      'inbound_resource_sid' => payload['inbound_resource_sid'],
-                      'inbound_resource_status' => payload['inbound_resource_status'],
-                      'inbound_resource_type' => payload['inbound_resource_type'],
-                      'inbound_resource_url' => payload['inbound_resource_url'],
-                      'outbound_participant_sid' => payload['outbound_participant_sid'],
-                      'outbound_resource_sid' => payload['outbound_resource_sid'],
-                      'outbound_resource_status' => payload['outbound_resource_status'],
-                      'outbound_resource_type' => payload['outbound_resource_type'],
-                      'outbound_resource_url' => payload['outbound_resource_url'],
+                      'service_sid' => payload['service_sid'],
+                      'entity_sid' => payload['entity_sid'],
+                      'identity' => payload['identity'],
+                      'factor_sid' => payload['factor_sid'],
                       'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                       'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                      'date_responded' => Twilio.deserialize_iso8601_datetime(payload['date_responded']),
+                      'expiration_date' => Twilio.deserialize_iso8601_datetime(payload['expiration_date']),
+                      'status' => payload['status'],
+                      'responded_reason' => payload['responded_reason'],
+                      'details' => payload['details'],
+                      'hidden_details' => payload['hidden_details'],
+                      'factor_type' => payload['factor_type'],
                       'url' => payload['url'],
                   }
 
@@ -280,8 +329,8 @@ module Twilio
                   @instance_context = nil
                   @params = {
                       'service_sid' => service_sid,
-                      'session_sid' => session_sid,
-                      'participant_sid' => participant_sid,
+                      'identity' => identity,
+                      'factor_sid' => factor_sid,
                       'sid' => sid || @properties['sid'],
                   }
                 end
@@ -289,14 +338,14 @@ module Twilio
                 ##
                 # Generate an instance context for the instance, the context is capable of
                 # performing various actions.  All instance actions are proxied to the context
-                # @return [MessageInteractionContext] MessageInteractionContext for this MessageInteractionInstance
+                # @return [ChallengeContext] ChallengeContext for this ChallengeInstance
                 def context
                   unless @instance_context
-                    @instance_context = MessageInteractionContext.new(
+                    @instance_context = ChallengeContext.new(
                         @version,
                         @params['service_sid'],
-                        @params['session_sid'],
-                        @params['participant_sid'],
+                        @params['identity'],
+                        @params['factor_sid'],
                         @params['sid'],
                     )
                   end
@@ -304,23 +353,11 @@ module Twilio
                 end
 
                 ##
-                # @return [String] A string that uniquely identifies this Interaction.
+                # @return [String] A string that uniquely identifies this Challenge.
                 def sid
                   @properties['sid']
                 end
 
-                ##
-                # @return [String] Session Sid.
-                def session_sid
-                  @properties['session_sid']
-                end
-
-                ##
-                # @return [String] Service Sid.
-                def service_sid
-                  @properties['service_sid']
-                end
-
                 ##
                 # @return [String] Account Sid.
                 def account_sid
@@ -328,120 +365,124 @@ module Twilio
                 end
 
                 ##
-                # @return [String] What happened in this Interaction.
-                def data
-                  @properties['data']
+                # @return [String] Service Sid.
+                def service_sid
+                  @properties['service_sid']
                 end
 
                 ##
-                # @return [message_interaction.Status] The Status of this Interaction
-                def status
-                  @properties['status']
+                # @return [String] Entity Sid.
+                def entity_sid
+                  @properties['entity_sid']
                 end
 
                 ##
-                # @return [String] The participant_sid
-                def participant_sid
-                  @properties['participant_sid']
+                # @return [String] Unique identity of the Entity
+                def identity
+                  @properties['identity']
                 end
 
                 ##
-                # @return [String] The inbound_participant_sid
-                def inbound_participant_sid
-                  @properties['inbound_participant_sid']
+                # @return [String] Factor Sid.
+                def factor_sid
+                  @properties['factor_sid']
                 end
 
                 ##
-                # @return [String] The SID of the inbound resource.
-                def inbound_resource_sid
-                  @properties['inbound_resource_sid']
+                # @return [Time] The date this Challenge was created
+                def date_created
+                  @properties['date_created']
                 end
 
                 ##
-                # @return [message_interaction.ResourceStatus] The Inbound Resource Status of this Interaction
-                def inbound_resource_status
-                  @properties['inbound_resource_status']
+                # @return [Time] The date this Challenge was updated
+                def date_updated
+                  @properties['date_updated']
                 end
 
                 ##
-                # @return [String] The Twilio object type of the inbound resource.
-                def inbound_resource_type
-                  @properties['inbound_resource_type']
+                # @return [Time] The date this Challenge was responded
+                def date_responded
+                  @properties['date_responded']
                 end
 
                 ##
-                # @return [String] The URL of the inbound resource.
-                def inbound_resource_url
-                  @properties['inbound_resource_url']
+                # @return [Time] The date this Challenge is expired
+                def expiration_date
+                  @properties['expiration_date']
                 end
 
                 ##
-                # @return [String] The outbound_participant_sid
-                def outbound_participant_sid
-                  @properties['outbound_participant_sid']
+                # @return [challenge.ChallengeStatuses] The Status of this Challenge
+                def status
+                  @properties['status']
                 end
 
                 ##
-                # @return [String] The SID of the outbound resource.
-                def outbound_resource_sid
-                  @properties['outbound_resource_sid']
+                # @return [challenge.ChallengeReasons] The Reason of this Challenge `status`
+                def responded_reason
+                  @properties['responded_reason']
                 end
 
                 ##
-                # @return [message_interaction.ResourceStatus] The Outbound Resource Status of this Interaction
-                def outbound_resource_status
-                  @properties['outbound_resource_status']
+                # @return [String] Public details provided to contextualize the Challenge
+                def details
+                  @properties['details']
                 end
 
                 ##
-                # @return [String] The Twilio object type of the outbound resource.
-                def outbound_resource_type
-                  @properties['outbound_resource_type']
+                # @return [String] Hidden details provided to contextualize the Challenge
+                def hidden_details
+                  @properties['hidden_details']
                 end
 
                 ##
-                # @return [String] The URL of the outbound resource.
-                def outbound_resource_url
-                  @properties['outbound_resource_url']
+                # @return [challenge.FactorTypes] The Factor Type of this Challenge
+                def factor_type
+                  @properties['factor_type']
                 end
 
                 ##
-                # @return [Time] The date this Interaction was created
-                def date_created
-                  @properties['date_created']
+                # @return [String] The URL of this resource.
+                def url
+                  @properties['url']
                 end
 
                 ##
-                # @return [Time] The date this Interaction was updated
-                def date_updated
-                  @properties['date_updated']
+                # Deletes the ChallengeInstance
+                # @return [Boolean] true if delete succeeds, false otherwise
+                def delete
+                  context.delete
                 end
 
                 ##
-                # @return [String] The URL of this Interaction.
-                def url
-                  @properties['url']
+                # Fetch a ChallengeInstance
+                # @return [ChallengeInstance] Fetched ChallengeInstance
+                def fetch
+                  context.fetch
                 end
 
                 ##
-                # Fetch a MessageInteractionInstance
-                # @return [MessageInteractionInstance] Fetched MessageInteractionInstance
-                def fetch
-                  context.fetch
+                # Update the ChallengeInstance
+                # @param [String] auth_payload The optional payload needed to verify the
+                #   Challenge. E.g., a TOTP would use the numeric code.
+                # @return [ChallengeInstance] Updated ChallengeInstance
+                def update(auth_payload: :unset)
+                  context.update(auth_payload: auth_payload, )
                 end
 
                 ##
                 # Provide a user friendly representation
                 def to_s
                   values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                  "<Twilio.Preview.Proxy.MessageInteractionInstance #{values}>"
+                  "<Twilio.Authy.V1.ChallengeInstance #{values}>"
                 end
 
                 ##
                 # Provide a detailed, user friendly representation
                 def inspect
                   values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-                  "<Twilio.Preview.Proxy.MessageInteractionInstance #{values}>"
+                  "<Twilio.Authy.V1.ChallengeInstance #{values}>"
                 end
               end
             end