twilio-ruby 5.6.0 → 5.33.1

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

@@ -3,35 +3,37 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  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
           ##
           # 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 ShortCodeList < ListResource
+          class EntityList < ListResource
             ##
-            # Initialize the ShortCodeList
+            # Initialize the EntityList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The unique SID identifier of the Service.
-            # @return [ShortCodeList] ShortCodeList
+            # @return [EntityList] EntityList
             def initialize(version, service_sid: nil)
               super(version)
 
               # Path Solution
               @solution = {service_sid: service_sid}
-              @uri = "/Services/#{@solution[:service_sid]}/ShortCodes"
+              @uri = "/Services/#{@solution[:service_sid]}/Entities"
             end
 
             ##
-            # Retrieve a single page of ShortCodeInstance records from the API.
+            # Retrieve a single page of EntityInstance records from the API.
             # Request is executed immediately.
-            # @param [String] sid The shortcode Sid that uniquely identifies this resource
-            # @return [ShortCodeInstance] Newly created ShortCodeInstance
-            def create(sid: nil)
-              data = Twilio::Values.of({'Sid' => sid})
+            # @param [String] identity Customer unique identity for the Entity of the Service
+            # @return [EntityInstance] Newly created EntityInstance
+            def create(identity: nil)
+              data = Twilio::Values.of({'Identity' => identity, })
 
               payload = @version.create(
                   'POST',
@@ -39,11 +41,11 @@ module Twilio
                   data: data
               )
 
-              ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              EntityInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
-            # Lists ShortCodeInstance 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 [Integer] limit Upper limit for the number of records to return. stream()
@@ -58,7 +60,7 @@ module Twilio
             end
 
             ##
-            # Streams ShortCodeInstance 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 [Integer] limit Upper limit for the number of records to return. stream()
@@ -71,19 +73,19 @@ module Twilio
             def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(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 ShortCodeInstance 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],
@@ -91,12 +93,12 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of ShortCodeInstance records from the API.
+            # Retrieve a single page of EntityInstance records from the API.
             # Request is executed immediately.
             # @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 ShortCodeInstance
+            # @return [Page] Page of EntityInstance
             def page(page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
                   'PageToken' => page_token,
@@ -108,38 +110,38 @@ module Twilio
                   @uri,
                   params
               )
-              ShortCodePage.new(@version, response, @solution)
+              EntityPage.new(@version, response, @solution)
             end
 
             ##
-            # Retrieve a single page of ShortCodeInstance 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 ShortCodeInstance
+            # @return [Page] Page of EntityInstance
             def get_page(target_url)
               response = @version.domain.request(
                   'GET',
                   target_url
               )
-              ShortCodePage.new(@version, response, @solution)
+              EntityPage.new(@version, response, @solution)
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '#<Twilio.Preview.Proxy.ShortCodeList>'
+              '#<Twilio.Authy.V1.EntityList>'
             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 ShortCodePage < Page
+          class EntityPage < Page
             ##
-            # Initialize the ShortCodePage
+            # 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 [ShortCodePage] ShortCodePage
+            # @return [EntityPage] EntityPage
             def initialize(version, response, solution)
               super(version, response)
 
@@ -148,47 +150,50 @@ module Twilio
             end
 
             ##
-            # Build an instance of ShortCodeInstance
+            # Build an instance of EntityInstance
             # @param [Hash] payload Payload response from the API
-            # @return [ShortCodeInstance] ShortCodeInstance
+            # @return [EntityInstance] EntityInstance
             def get_instance(payload)
-              ShortCodeInstance.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.Preview.Proxy.ShortCodePage>'
+              '<Twilio.Authy.V1.EntityPage>'
             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 ShortCodeContext < InstanceContext
+          class EntityContext < InstanceContext
             ##
-            # Initialize the ShortCodeContext
+            # Initialize the EntityContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The shortcode Sid that uniquely identifies this resource
-            # @return [ShortCodeContext] ShortCodeContext
-            def initialize(version, service_sid, sid)
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @param [String] identity Customer unique identity for the Entity of the Service
+            # @return [EntityContext] EntityContext
+            def initialize(version, service_sid, identity)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, sid: sid}
-              @uri = "/Services/#{@solution[:service_sid]}/ShortCodes/#{@solution[:sid]}"
+              @solution = {service_sid: service_sid, identity: identity, }
+              @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}"
+
+              # Dependents
+              @factors = nil
             end
 
             ##
-            # Deletes the ShortCodeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Deletes the EntityInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
 
             ##
-            # Fetch a ShortCodeInstance
-            # @return [ShortCodeInstance] Fetched ShortCodeInstance
+            # Fetch a EntityInstance
+            # @return [EntityInstance] Fetched EntityInstance
             def fetch
               params = Twilio::Values.of({})
 
@@ -198,65 +203,104 @@ module Twilio
                   params,
               )
 
-              ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              EntityInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  identity: @solution[:identity],
+              )
+            end
+
+            ##
+            # 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 FactorContext.new(@version, @solution[:service_sid], @solution[:identity], sid, )
+              end
+
+              unless @factors
+                @factors = FactorList.new(
+                    @version,
+                    service_sid: @solution[:service_sid],
+                    identity: @solution[:identity],
+                )
+              end
+
+              @factors
             end
 
             ##
             # Provide a user friendly representation
             def to_s
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Preview.Proxy.ShortCodeContext #{context}>"
+              "#<Twilio.Authy.V1.EntityContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Authy.V1.EntityContext #{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 ShortCodeInstance < InstanceResource
+          class EntityInstance < InstanceResource
             ##
-            # Initialize the ShortCodeInstance
+            # 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 unique SID identifier of the Service.
-            # @param [String] sid The shortcode Sid that uniquely identifies this resource
-            # @return [ShortCodeInstance] ShortCodeInstance
-            def initialize(version, payload, service_sid: nil, sid: nil)
+            # @param [String] identity Customer unique identity for the Entity of the Service
+            # @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'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                  'short_code' => payload['short_code'],
-                  'country_code' => payload['country_code'],
-                  'capabilities' => payload['capabilities'],
                   'url' => payload['url'],
+                  'links' => payload['links'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @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 [ShortCodeContext] ShortCodeContext for this ShortCodeInstance
+            # @return [EntityContext] EntityContext for this EntityInstance
             def context
               unless @instance_context
-                @instance_context = ShortCodeContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = EntityContext.new(@version, @params['service_sid'], @params['identity'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] A string that uniquely identifies this resource
+            # @return [String] A string that uniquely identifies this Entity.
             def sid
               @properties['sid']
             end
 
+            ##
+            # @return [String] Unique identity of the Entity
+            def identity
+              @properties['identity']
+            end
+
             ##
             # @return [String] Account Sid.
             def account_sid
@@ -270,35 +314,17 @@ module Twilio
             end
 
             ##
-            # @return [Time] The date this resource was created
+            # @return [Time] The date this Entity was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this resource was last updated
+            # @return [Time] The date this Entity was updated
             def date_updated
               @properties['date_updated']
             end
 
-            ##
-            # @return [String] The short code. e.g., 894546.
-            def short_code
-              @properties['short_code']
-            end
-
-            ##
-            # @return [String] The ISO 3166-1 alpha-2 country code
-            def country_code
-              @properties['country_code']
-            end
-
-            ##
-            # @return [Hash] Indicate if a shortcode can receive messages
-            def capabilities
-              @properties['capabilities']
-            end
-
             ##
             # @return [String] The URL of this resource.
             def url
@@ -306,31 +332,44 @@ module Twilio
             end
 
             ##
-            # Deletes the ShortCodeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [String] Nested resource URLs.
+            def links
+              @properties['links']
+            end
+
+            ##
+            # Deletes the EntityInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
-            # Fetch a ShortCodeInstance
-            # @return [ShortCodeInstance] Fetched ShortCodeInstance
+            # Fetch a EntityInstance
+            # @return [EntityInstance] Fetched EntityInstance
             def fetch
               context.fetch
             end
 
+            ##
+            # Access the factors
+            # @return [factors] factors
+            def factors
+              context.factors
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
               values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Preview.Proxy.ShortCodeInstance #{values}>"
+              "<Twilio.Authy.V1.EntityInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
               values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Preview.Proxy.ShortCodeInstance #{values}>"
+              "<Twilio.Authy.V1.EntityInstance #{values}>"
             end
           end
         end