twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/{notify/v1/service/user.rb → verify/v2/service/entity.rb}

@@ -3,55 +3,49 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
-    class Notify < Domain
-      class V1 < Version
+    class Verify < Domain
+      class V2 < Version
         class ServiceContext < InstanceContext
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class UserList < ListResource
+          class EntityList < ListResource
             ##
-            # Initialize the UserList
+            # Initialize the EntityList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @return [UserList] UserList
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @return [EntityList] EntityList
             def initialize(version, service_sid: nil)
               super(version)
 
               # Path Solution
               @solution = {service_sid: service_sid}
-              @uri = "/Services/#{@solution[:service_sid]}/Users"
+              @uri = "/Services/#{@solution[:service_sid]}/Entities"
             end
 
             ##
-            # Retrieve a single page of UserInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] identity The identity
-            # @param [String] segment The segment
-            # @return [UserInstance] Newly created UserInstance
-            def create(identity: nil, segment: :unset)
-              data = Twilio::Values.of({
-                  'Identity' => identity,
-                  'Segment' => Twilio.serialize_list(segment) { |e| e },
-              })
+            # Create the EntityInstance
+            # @param [String] identity The unique external identifier for the Entity of the
+            #   Service. 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 [EntityInstance] Created EntityInstance
+            def create(identity: nil)
+              data = Twilio::Values.of({'Identity' => identity, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              UserInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              EntityInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
-            # Lists UserInstance records from the API as a list.
+            # Lists EntityInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] identity The identity
-            # @param [String] segment The segment
             # @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
@@ -59,16 +53,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(identity: :unset, segment: :unset, limit: nil, page_size: nil)
-              self.stream(identity: identity, segment: segment, 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 UserInstance records from the API as an Enumerable.
+            # Streams EntityInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] identity The identity
-            # @param [String] segment The segment
             # @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
@@ -76,22 +68,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(identity: :unset, segment: :unset, limit: nil, page_size: nil)
+            def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(identity: identity, segment: segment, 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 UserInstance records from the API.
+            # When passed a block, yields EntityInstance 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],
@@ -99,59 +91,53 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of UserInstance records from the API.
+            # Retrieve a single page of EntityInstance records from the API.
             # Request is executed immediately.
-            # @param [String] identity The identity
-            # @param [String] segment The segment
             # @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 UserInstance
-            def page(identity: :unset, segment: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            # @return [Page] Page of EntityInstance
+            def page(page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
-                  'Identity' => Twilio.serialize_list(identity) { |e| e },
-                  'Segment' => segment,
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
-              UserPage.new(@version, response, @solution)
+
+              response = @version.page('GET', @uri, params: params)
+
+              EntityPage.new(@version, response, @solution)
             end
 
             ##
-            # Retrieve a single page of UserInstance records from the API.
+            # Retrieve a single page of EntityInstance records from the API.
             # Request is executed immediately.
             # @param [String] target_url API-generated URL for the requested results page
-            # @return [Page] Page of UserInstance
+            # @return [Page] Page of EntityInstance
             def get_page(target_url)
               response = @version.domain.request(
                   'GET',
                   target_url
               )
-              UserPage.new(@version, response, @solution)
+              EntityPage.new(@version, response, @solution)
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '#<Twilio.Notify.V1.UserList>'
+              '#<Twilio.Verify.V2.EntityList>'
             end
           end
 
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class UserPage < Page
+          class EntityPage < Page
             ##
-            # Initialize the UserPage
+            # Initialize the EntityPage
             # @param [Version] version Version that contains the resource
             # @param [Response] response Response from the API
             # @param [Hash] solution Path solution for the resource
-            # @return [UserPage] UserPage
+            # @return [EntityPage] EntityPage
             def initialize(version, response, solution)
               super(version, response)
 
@@ -160,61 +146,59 @@ module Twilio
             end
 
             ##
-            # Build an instance of UserInstance
+            # Build an instance of EntityInstance
             # @param [Hash] payload Payload response from the API
-            # @return [UserInstance] UserInstance
+            # @return [EntityInstance] EntityInstance
             def get_instance(payload)
-              UserInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              EntityInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '<Twilio.Notify.V1.UserPage>'
+              '<Twilio.Verify.V2.EntityPage>'
             end
           end
 
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class UserContext < InstanceContext
+          class EntityContext < InstanceContext
             ##
-            # Initialize the UserContext
+            # Initialize the EntityContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] identity The identity
-            # @return [UserContext] UserContext
+            # @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, 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 [EntityContext] EntityContext
             def initialize(version, service_sid, identity)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, identity: identity}
-              @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:identity]}"
+              @solution = {service_sid: service_sid, identity: identity, }
+              @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}"
 
               # Dependents
-              @bindings = nil
-              @segment_memberships = nil
+              @factors = nil
+              @new_factors = nil
+              @challenges = nil
             end
 
             ##
-            # Deletes the UserInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the EntityInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
-            # Fetch a UserInstance
-            # @return [UserInstance] Fetched UserInstance
+            # Fetch the EntityInstance
+            # @return [EntityInstance] Fetched EntityInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
-              UserInstance.new(
+              EntityInstance.new(
                   @version,
                   payload,
                   service_sid: @solution[:service_sid],
@@ -223,193 +207,219 @@ module Twilio
             end
 
             ##
-            # Access the bindings
-            # @return [UserBindingList]
-            # @return [UserBindingContext] if sid was passed.
-            def bindings(sid=:unset)
+            # Access the factors
+            # @return [FactorList]
+            # @return [FactorContext] if sid was passed.
+            def factors(sid=:unset)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return UserBindingContext.new(@version, @solution[:service_sid], @solution[:identity], sid)
+                return FactorContext.new(@version, @solution[:service_sid], @solution[:identity], sid, )
               end
 
-              unless @bindings
-                @bindings = UserBindingList.new(
+              unless @factors
+                @factors = FactorList.new(
                     @version,
                     service_sid: @solution[:service_sid],
                     identity: @solution[:identity],
                 )
               end
 
-              @bindings
+              @factors
             end
 
             ##
-            # Access the segment_memberships
-            # @return [SegmentMembershipList]
-            # @return [SegmentMembershipContext] if segment was passed.
-            def segment_memberships(segment=:unset)
-              raise ArgumentError, 'segment cannot be nil' if segment.nil?
+            # Access the new_factors
+            # @return [NewFactorList]
+            # @return [NewFactorContext]
+            def new_factors
+              unless @new_factors
+                @new_factors = NewFactorList.new(
+                    @version,
+                    service_sid: @solution[:service_sid],
+                    identity: @solution[:identity],
+                )
+              end
 
-              if segment != :unset
-                return SegmentMembershipContext.new(@version, @solution[:service_sid], @solution[:identity], segment)
+              @new_factors
+            end
+
+            ##
+            # Access the challenges
+            # @return [ChallengeList]
+            # @return [ChallengeContext] if sid was passed.
+            def challenges(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return ChallengeContext.new(@version, @solution[:service_sid], @solution[:identity], sid, )
               end
 
-              unless @segment_memberships
-                @segment_memberships = SegmentMembershipList.new(
+              unless @challenges
+                @challenges = ChallengeList.new(
                     @version,
                     service_sid: @solution[:service_sid],
                     identity: @solution[:identity],
                 )
               end
 
-              @segment_memberships
+              @challenges
             end
 
             ##
             # Provide a user friendly representation
             def to_s
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Notify.V1.UserContext #{context}>"
+              "#<Twilio.Verify.V2.EntityContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Verify.V2.EntityContext #{context}>"
             end
           end
 
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class UserInstance < InstanceResource
+          class EntityInstance < InstanceResource
             ##
-            # Initialize the UserInstance
+            # Initialize the EntityInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The service_sid
-            # @param [String] identity The identity
-            # @return [UserInstance] UserInstance
+            # @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, 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 [EntityInstance] EntityInstance
             def initialize(version, payload, service_sid: nil, identity: nil)
               super(version)
 
               # Marshaled Properties
               @properties = {
                   'sid' => payload['sid'],
+                  'identity' => payload['identity'],
                   'account_sid' => payload['account_sid'],
                   'service_sid' => payload['service_sid'],
-                  'identity' => payload['identity'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                  'segments' => payload['segments'],
                   'url' => payload['url'],
                   'links' => payload['links'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'identity' => identity || @properties['identity']}
+              @params = {'service_sid' => service_sid, 'identity' => identity || @properties['identity'], }
             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 [UserContext] UserContext for this UserInstance
+            # @return [EntityContext] EntityContext for this EntityInstance
             def context
               unless @instance_context
-                @instance_context = UserContext.new(@version, @params['service_sid'], @params['identity'])
+                @instance_context = EntityContext.new(@version, @params['service_sid'], @params['identity'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] A string that uniquely identifies this Entity.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] Unique external identifier of the Entity
+            def identity
+              @properties['identity']
+            end
+
+            ##
+            # @return [String] Account Sid.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] Service Sid.
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The identity
-            def identity
-              @properties['identity']
-            end
-
-            ##
-            # @return [Time] The date_created
+            # @return [Time] The date this Entity was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date this Entity was updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The segments
-            def segments
-              @properties['segments']
-            end
-
-            ##
-            # @return [String] The url
+            # @return [String] The URL of this resource.
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] Nested resource URLs.
             def links
               @properties['links']
             end
 
             ##
-            # Deletes the UserInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the EntityInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
-            # Fetch a UserInstance
-            # @return [UserInstance] Fetched UserInstance
+            # Fetch the EntityInstance
+            # @return [EntityInstance] Fetched EntityInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Access the bindings
-            # @return [bindings] bindings
-            def bindings
-              context.bindings
+            # Access the factors
+            # @return [factors] factors
+            def factors
+              context.factors
+            end
+
+            ##
+            # Access the new_factors
+            # @return [new_factors] new_factors
+            def new_factors
+              context.new_factors
             end
 
             ##
-            # Access the segment_memberships
-            # @return [segment_memberships] segment_memberships
-            def segment_memberships
-              context.segment_memberships
+            # 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.Notify.V1.UserInstance #{values}>"
+              "<Twilio.Verify.V2.EntityInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
               values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Notify.V1.UserInstance #{values}>"
+              "<Twilio.Verify.V2.EntityInstance #{values}>"
             end
           end
         end