twilio-ruby 5.6.0 → 5.33.1

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

@@ -3,38 +3,72 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  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 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 ParticipantList < ListResource
+            class FactorList < ListResource
               ##
-              # Initialize the ParticipantList
+              # Initialize the FactorList
               # @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.
-              # @return [ParticipantList] ParticipantList
-              def initialize(version, service_sid: nil, session_sid: nil)
+              # @param [String] identity Customer unique identity for the Entity owner of the
+              #   Factor
+              # @return [FactorList] FactorList
+              def initialize(version, service_sid: nil, identity: nil)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, session_sid: session_sid}
-                @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Participants"
+                @solution = {service_sid: service_sid, identity: identity}
+                @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Factors"
               end
 
               ##
-              # Lists ParticipantInstance records from the API as a list.
+              # 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. It must be a json string with the
+              #   required properties for the given factor type. 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.
+              # @param [String] config The config required for this Factor. It must be a json
+              #   string with the required properties for the given factor type
+              # @return [FactorInstance] Newly created FactorInstance
+              def create(binding: nil, friendly_name: nil, factor_type: nil, config: nil)
+                data = Twilio::Values.of({
+                    'Binding' => binding,
+                    'FriendlyName' => friendly_name,
+                    'FactorType' => factor_type,
+                    'Config' => config,
+                })
+
+                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
               # memory before returning.
-              # @param [String] identifier The Participant's contact identifier, normally a
-              #   phone number.
-              # @param [participant.ParticipantType] participant_type The Type of this
-              #   Participant. One of `sms`, `voice` or `phone`.
               # @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
@@ -42,23 +76,14 @@ module Twilio
               #    but a limit is defined, stream() will attempt to read the limit with the most
               #    efficient page size, i.e. min(limit, 1000)
               # @return [Array] Array of up to limit results
-              def list(identifier: :unset, participant_type: :unset, limit: nil, page_size: nil)
-                self.stream(
-                    identifier: identifier,
-                    participant_type: participant_type,
-                    limit: limit,
-                    page_size: page_size
-                ).entries
+              def list(limit: nil, page_size: nil)
+                self.stream(limit: limit, page_size: page_size).entries
               end
 
               ##
-              # Streams ParticipantInstance records from the API as an Enumerable.
+              # Streams FactorInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [String] identifier The Participant's contact identifier, normally a
-              #   phone number.
-              # @param [participant.ParticipantType] participant_type The Type of this
-              #   Participant. One of `sms`, `voice` or `phone`.
               # @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,26 +91,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(identifier: :unset, participant_type: :unset, limit: nil, page_size: nil)
+              def stream(limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(
-                    identifier: identifier,
-                    participant_type: participant_type,
-                    page_size: limits[:page_size],
-                )
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
 
               ##
-              # When passed a block, yields ParticipantInstance records from the API.
+              # When passed a block, yields FactorInstance 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],
@@ -93,20 +114,14 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of ParticipantInstance records from the API.
+              # Retrieve a single page of FactorInstance records from the API.
               # Request is executed immediately.
-              # @param [String] identifier The Participant's contact identifier, normally a
-              #   phone number.
-              # @param [participant.ParticipantType] participant_type The Type of this
-              #   Participant. One of `sms`, `voice` or `phone`.
               # @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 ParticipantInstance
-              def page(identifier: :unset, participant_type: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+              # @return [Page] Page of FactorInstance
+              def page(page_token: :unset, page_number: :unset, page_size: :unset)
                 params = Twilio::Values.of({
-                    'Identifier' => identifier,
-                    'ParticipantType' => participant_type,
                     'PageToken' => page_token,
                     'Page' => page_number,
                     'PageSize' => page_size,
@@ -116,69 +131,38 @@ module Twilio
                     @uri,
                     params
                 )
-                ParticipantPage.new(@version, response, @solution)
+                FactorPage.new(@version, response, @solution)
               end
 
               ##
-              # Retrieve a single page of ParticipantInstance records from the API.
+              # Retrieve a single page of FactorInstance records from the API.
               # Request is executed immediately.
               # @param [String] target_url API-generated URL for the requested results page
-              # @return [Page] Page of ParticipantInstance
+              # @return [Page] Page of FactorInstance
               def get_page(target_url)
                 response = @version.domain.request(
                     'GET',
                     target_url
                 )
-                ParticipantPage.new(@version, response, @solution)
-              end
-
-              ##
-              # Retrieve a single page of ParticipantInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] identifier The Participant's contact identifier, normally a
-              #   phone number.
-              # @param [String] friendly_name A human readable description of this resource, up
-              #   to 64 characters.
-              # @param [participant.ParticipantType] participant_type The Type of this
-              #   Participant. One of `sms`, `voice` or `phone`.
-              # @return [ParticipantInstance] Newly created ParticipantInstance
-              def create(identifier: nil, friendly_name: :unset, participant_type: :unset)
-                data = Twilio::Values.of({
-                    'Identifier' => identifier,
-                    'FriendlyName' => friendly_name,
-                    'ParticipantType' => participant_type,
-                })
-
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
-
-                ParticipantInstance.new(
-                    @version,
-                    payload,
-                    service_sid: @solution[:service_sid],
-                    session_sid: @solution[:session_sid],
-                )
+                FactorPage.new(@version, response, @solution)
               end
 
               ##
               # Provide a user friendly representation
               def to_s
-                '#<Twilio.Preview.Proxy.ParticipantList>'
+                '#<Twilio.Authy.V1.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.
-            class ParticipantPage < Page
+            class FactorPage < Page
               ##
-              # Initialize the ParticipantPage
+              # Initialize the FactorPage
               # @param [Version] version Version that contains the resource
               # @param [Response] response Response from the API
               # @param [Hash] solution Path solution for the resource
-              # @return [ParticipantPage] ParticipantPage
+              # @return [FactorPage] FactorPage
               def initialize(version, response, solution)
                 super(version, response)
 
@@ -187,50 +171,57 @@ module Twilio
               end
 
               ##
-              # Build an instance of ParticipantInstance
+              # Build an instance of FactorInstance
               # @param [Hash] payload Payload response from the API
-              # @return [ParticipantInstance] ParticipantInstance
+              # @return [FactorInstance] FactorInstance
               def get_instance(payload)
-                ParticipantInstance.new(
+                FactorInstance.new(
                     @version,
                     payload,
                     service_sid: @solution[:service_sid],
-                    session_sid: @solution[:session_sid],
+                    identity: @solution[:identity],
                 )
               end
 
               ##
               # Provide a user friendly representation
               def to_s
-                '<Twilio.Preview.Proxy.ParticipantPage>'
+                '<Twilio.Authy.V1.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.
-            class ParticipantContext < InstanceContext
+            class FactorContext < InstanceContext
               ##
-              # Initialize the ParticipantContext
+              # Initialize the FactorContext
               # @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] sid A 34 character string that uniquely identifies this
-              #   Participant.
-              # @return [ParticipantContext] ParticipantContext
-              def initialize(version, service_sid, session_sid, sid)
+              # @param [String] identity Customer unique identity for the Entity owner of the
+              #   Factor
+              # @param [String] sid A 34 character string that uniquely identifies this Factor.
+              # @return [FactorContext] FactorContext
+              def initialize(version, service_sid, identity, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, session_sid: session_sid, sid: sid}
-                @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Participants/#{@solution[:sid]}"
+                @solution = {service_sid: service_sid, identity: identity, sid: sid, }
+                @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Factors/#{@solution[:sid]}"
 
                 # Dependents
-                @message_interactions = nil
+                @challenges = nil
               end
 
               ##
-              # Fetch a ParticipantInstance
-              # @return [ParticipantInstance] Fetched ParticipantInstance
+              # Deletes the FactorInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
+              def delete
+                @version.delete('delete', @uri)
+              end
+
+              ##
+              # Fetch a FactorInstance
+              # @return [FactorInstance] Fetched FactorInstance
               def fetch
                 params = Twilio::Values.of({})
 
@@ -240,36 +231,28 @@ module Twilio
                     params,
                 )
 
-                ParticipantInstance.new(
+                FactorInstance.new(
                     @version,
                     payload,
                     service_sid: @solution[:service_sid],
-                    session_sid: @solution[:session_sid],
+                    identity: @solution[:identity],
                     sid: @solution[:sid],
                 )
               end
 
               ##
-              # Deletes the ParticipantInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
-              def delete
-                @version.delete('delete', @uri)
-              end
-
-              ##
-              # Update the ParticipantInstance
-              # @param [participant.ParticipantType] participant_type The Type of this
-              #   Participant. One of `sms`, `voice` or `phone`.
-              # @param [String] identifier The Participant's contact identifier, normally a
-              #   phone number.
-              # @param [String] friendly_name A human readable description of this resource, up
-              #   to 64 characters.
-              # @return [ParticipantInstance] Updated ParticipantInstance
-              def update(participant_type: :unset, identifier: :unset, friendly_name: :unset)
+              # 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] config The new config for this Factor. It must be a json string
+              #   with the required properties for the given factor type
+              # @return [FactorInstance] Updated FactorInstance
+              def update(auth_payload: :unset, friendly_name: :unset, config: :unset)
                 data = Twilio::Values.of({
-                    'ParticipantType' => participant_type,
-                    'Identifier' => identifier,
+                    'AuthPayload' => auth_payload,
                     'FriendlyName' => friendly_name,
+                    'Config' => config,
                 })
 
                 payload = @version.update(
@@ -278,102 +261,106 @@ module Twilio
                     data: data,
                 )
 
-                ParticipantInstance.new(
+                FactorInstance.new(
                     @version,
                     payload,
                     service_sid: @solution[:service_sid],
-                    session_sid: @solution[:session_sid],
+                    identity: @solution[:identity],
                     sid: @solution[:sid],
                 )
               end
 
               ##
-              # Access the message_interactions
-              # @return [MessageInteractionList]
-              # @return [MessageInteractionContext] if sid was passed.
-              def message_interactions(sid=:unset)
+              # 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 MessageInteractionContext.new(
+                  return ChallengeContext.new(
                       @version,
                       @solution[:service_sid],
-                      @solution[:session_sid],
+                      @solution[:identity],
                       @solution[:sid],
                       sid,
                   )
                 end
 
-                unless @message_interactions
-                  @message_interactions = MessageInteractionList.new(
+                unless @challenges
+                  @challenges = ChallengeList.new(
                       @version,
                       service_sid: @solution[:service_sid],
-                      session_sid: @solution[:session_sid],
-                      participant_sid: @solution[:sid],
+                      identity: @solution[:identity],
+                      factor_sid: @solution[:sid],
                   )
                 end
 
-                @message_interactions
+                @challenges
               end
 
               ##
               # Provide a user friendly representation
               def to_s
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-                "#<Twilio.Preview.Proxy.ParticipantContext #{context}>"
+                "#<Twilio.Authy.V1.FactorContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Authy.V1.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.
-            class ParticipantInstance < InstanceResource
+            class FactorInstance < InstanceResource
               ##
-              # Initialize the ParticipantInstance
+              # 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] session_sid The unique SID identifier of the Session.
-              # @param [String] sid A 34 character string that uniquely identifies this
-              #   Participant.
-              # @return [ParticipantInstance] ParticipantInstance
-              def initialize(version, payload, service_sid: nil, session_sid: nil, sid: nil)
+              # @param [String] identity Customer unique identity for the Entity owner of the
+              #   Factor
+              # @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)
                 super(version)
 
                 # Marshaled Properties
                 @properties = {
                     'sid' => payload['sid'],
-                    'session_sid' => payload['session_sid'],
-                    'service_sid' => payload['service_sid'],
                     'account_sid' => payload['account_sid'],
-                    'friendly_name' => payload['friendly_name'],
-                    'participant_type' => payload['participant_type'],
-                    'identifier' => payload['identifier'],
-                    'proxy_identifier' => payload['proxy_identifier'],
+                    'service_sid' => payload['service_sid'],
+                    'entity_sid' => payload['entity_sid'],
+                    'identity' => payload['identity'],
                     'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                     'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                    'friendly_name' => payload['friendly_name'],
+                    'status' => payload['status'],
+                    'factor_type' => payload['factor_type'],
+                    'config' => payload['config'],
                     'url' => payload['url'],
                     'links' => payload['links'],
                 }
 
                 # Context
                 @instance_context = nil
-                @params = {
-                    'service_sid' => service_sid,
-                    'session_sid' => session_sid,
-                    'sid' => sid || @properties['sid'],
-                }
+                @params = {'service_sid' => service_sid, 'identity' => identity, 'sid' => sid || @properties['sid'], }
               end
 
               ##
               # Generate an instance context for the instance, the context is capable of
               # performing various actions.  All instance actions are proxied to the context
-              # @return [ParticipantContext] ParticipantContext for this ParticipantInstance
+              # @return [FactorContext] FactorContext for this FactorInstance
               def context
                 unless @instance_context
-                  @instance_context = ParticipantContext.new(
+                  @instance_context = FactorContext.new(
                       @version,
                       @params['service_sid'],
-                      @params['session_sid'],
+                      @params['identity'],
                       @params['sid'],
                   )
                 end
@@ -381,15 +368,15 @@ module Twilio
               end
 
               ##
-              # @return [String] A string that uniquely identifies this Participant.
+              # @return [String] A string that uniquely identifies this Factor.
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] Session Sid.
-              def session_sid
-                @properties['session_sid']
+              # @return [String] Account Sid.
+              def account_sid
+                @properties['account_sid']
               end
 
               ##
@@ -399,45 +386,51 @@ module Twilio
               end
 
               ##
-              # @return [String] Account Sid.
-              def account_sid
-                @properties['account_sid']
+              # @return [String] Entity Sid.
+              def entity_sid
+                @properties['entity_sid']
               end
 
               ##
-              # @return [String] A human readable description of this resource
-              def friendly_name
-                @properties['friendly_name']
+              # @return [String] Unique identity of the Entity
+              def identity
+                @properties['identity']
               end
 
               ##
-              # @return [participant.ParticipantType] The Type of this Participant
-              def participant_type
-                @properties['participant_type']
+              # @return [Time] The date this Factor was created
+              def date_created
+                @properties['date_created']
               end
 
               ##
-              # @return [String] The Participant's contact identifier, normally a phone number.
-              def identifier
-                @properties['identifier']
+              # @return [Time] The date this Factor was updated
+              def date_updated
+                @properties['date_updated']
               end
 
               ##
-              # @return [String] What this Participant communicates with, normally a phone number.
-              def proxy_identifier
-                @properties['proxy_identifier']
+              # @return [String] A human readable description of this resource.
+              def friendly_name
+                @properties['friendly_name']
               end
 
               ##
-              # @return [Time] The date this Participant was created
-              def date_created
-                @properties['date_created']
+              # @return [factor.FactorStatuses] The Status of this Factor
+              def status
+                @properties['status']
               end
 
               ##
-              # @return [Time] The date this Participant was updated
-              def date_updated
-                @properties['date_updated']
+              # @return [factor.FactorTypes] The Type of this Factor
+              def factor_type
+                @properties['factor_type']
+              end
+
+              ##
+              # @return [Hash] The config
+              def config
+                @properties['config']
               end
 
               ##
@@ -453,55 +446,50 @@ module Twilio
               end
 
               ##
-              # Fetch a ParticipantInstance
-              # @return [ParticipantInstance] Fetched ParticipantInstance
-              def fetch
-                context.fetch
+              # Deletes the FactorInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
+              def delete
+                context.delete
               end
 
               ##
-              # Deletes the ParticipantInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
-              def delete
-                context.delete
+              # Fetch a FactorInstance
+              # @return [FactorInstance] Fetched FactorInstance
+              def fetch
+                context.fetch
               end
 
               ##
-              # Update the ParticipantInstance
-              # @param [participant.ParticipantType] participant_type The Type of this
-              #   Participant. One of `sms`, `voice` or `phone`.
-              # @param [String] identifier The Participant's contact identifier, normally a
-              #   phone number.
-              # @param [String] friendly_name A human readable description of this resource, up
-              #   to 64 characters.
-              # @return [ParticipantInstance] Updated ParticipantInstance
-              def update(participant_type: :unset, identifier: :unset, friendly_name: :unset)
-                context.update(
-                    participant_type: participant_type,
-                    identifier: identifier,
-                    friendly_name: friendly_name,
-                )
+              # 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] config The new config for this Factor. It must be a json string
+              #   with the required properties for the given factor type
+              # @return [FactorInstance] Updated FactorInstance
+              def update(auth_payload: :unset, friendly_name: :unset, config: :unset)
+                context.update(auth_payload: auth_payload, friendly_name: friendly_name, config: config, )
               end
 
               ##
-              # Access the message_interactions
-              # @return [message_interactions] message_interactions
-              def message_interactions
-                context.message_interactions
+              # Access the challenges
+              # @return [challenges] challenges
+              def challenges
+                context.challenges
               end
 
               ##
               # Provide a user friendly representation
               def to_s
                 values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Preview.Proxy.ParticipantInstance #{values}>"
+                "<Twilio.Authy.V1.FactorInstance #{values}>"
               end
 
               ##
               # Provide a detailed, user friendly representation
               def inspect
                 values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Preview.Proxy.ParticipantInstance #{values}>"
+                "<Twilio.Authy.V1.FactorInstance #{values}>"
               end
             end
           end