twilio-ruby 6.8.0 → 7.10.7

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

@@ -21,12 +21,14 @@ module Twilio
                 class EntityContext < InstanceContext
 
                      class FactorList < ListResource
+                
                     ##
                     # Initialize the FactorList
                     # @param [Version] version Version that contains the resource
                     # @return [FactorList] FactorList
                     def initialize(version, service_sid: nil, identity: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid, identity: identity }
                         @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Factors"
@@ -68,7 +70,33 @@ module Twilio
                         page = self.page(
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists FactorPageMetadata records from the API as a list.
+                    # @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
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    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_with_metadata(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        FactorPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -80,9 +108,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -92,14 +124,17 @@ module Twilio
                     # @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 FactorInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         FactorPage.new(@version, response, @solution)
                     end
@@ -136,6 +171,7 @@ module Twilio
                     # @return [FactorContext] FactorContext
                     def initialize(version, service_sid, identity, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, identity: identity, sid: sid,  }
@@ -148,7 +184,31 @@ module Twilio
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete
 
-                        @version.delete('DELETE', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+
+                        @version.delete('DELETE', @uri, headers: headers)
+                    end
+
+                    ##
+                    # Delete the FactorInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          factor_instance = FactorInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          FactorInstanceMetadata.new(@version, factor_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -156,7 +216,13 @@ module Twilio
                     # @return [FactorInstance] Fetched FactorInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         FactorInstance.new(
                             @version,
                             payload,
@@ -166,6 +232,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the FactorInstanceMetadata
+                    # @return [FactorInstance] Fetched FactorInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        factor_instance = FactorInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            identity: @solution[:identity],
+                            sid: @solution[:sid],
+                        )
+                        FactorInstanceMetadata.new(
+                            @version,
+                            factor_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # 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.
@@ -179,15 +272,15 @@ module Twilio
                     # @param [String] config_notification_platform The transport technology used to generate the Notification Token. Can be `apn`, `fcm` or `none`.  Required when `factor_type` is `push`.
                     # @return [FactorInstance] Updated FactorInstance
                     def update(
-                        auth_payload: :unset, 
-                        friendly_name: :unset, 
-                        config_notification_token: :unset, 
-                        config_sdk_version: :unset, 
-                        config_time_step: :unset, 
-                        config_skew: :unset, 
-                        config_code_length: :unset, 
-                        config_alg: :unset, 
-                        config_notification_platform: :unset
+                      auth_payload: :unset, 
+                      friendly_name: :unset, 
+                      config_notification_token: :unset, 
+                      config_sdk_version: :unset, 
+                      config_time_step: :unset, 
+                      config_skew: :unset, 
+                      config_code_length: :unset, 
+                      config_alg: :unset, 
+                      config_notification_platform: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -202,7 +295,13 @@ module Twilio
                             'Config.NotificationPlatform' => config_notification_platform,
                         })
 
-                        payload = @version.update('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
                         FactorInstance.new(
                             @version,
                             payload,
@@ -212,6 +311,64 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the FactorInstanceMetadata
+                    # @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. It can be up to 64 characters.
+                    # @param [String] config_notification_token For APN, the device token. For FCM, the registration token. It is used to send the push notifications. Required when `factor_type` is `push`. If specified, this value must be between 32 and 255 characters long.
+                    # @param [String] config_sdk_version The Verify Push SDK version used to configure the factor
+                    # @param [String] config_time_step Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive
+                    # @param [String] config_skew The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive
+                    # @param [String] config_code_length Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive
+                    # @param [TotpAlgorithms] config_alg 
+                    # @param [String] config_notification_platform The transport technology used to generate the Notification Token. Can be `apn`, `fcm` or `none`.  Required when `factor_type` is `push`.
+                    # @return [FactorInstance] Updated FactorInstance
+                    def update_with_metadata(
+                      auth_payload: :unset, 
+                      friendly_name: :unset, 
+                      config_notification_token: :unset, 
+                      config_sdk_version: :unset, 
+                      config_time_step: :unset, 
+                      config_skew: :unset, 
+                      config_code_length: :unset, 
+                      config_alg: :unset, 
+                      config_notification_platform: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'AuthPayload' => auth_payload,
+                            'FriendlyName' => friendly_name,
+                            'Config.NotificationToken' => config_notification_token,
+                            'Config.SdkVersion' => config_sdk_version,
+                            'Config.TimeStep' => config_time_step,
+                            'Config.Skew' => config_skew,
+                            'Config.CodeLength' => config_code_length,
+                            'Config.Alg' => config_alg,
+                            'Config.NotificationPlatform' => config_notification_platform,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        factor_instance = FactorInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            identity: @solution[:identity],
+                            sid: @solution[:sid],
+                        )
+                        FactorInstanceMetadata.new(
+                            @version,
+                            factor_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -228,6 +385,53 @@ module Twilio
                     end
                 end
 
+                class FactorInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new FactorInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}FactorInstance] factor_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [FactorInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, factor_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @factor_instance = factor_instance
+                    end
+
+                    def factor
+                        @factor_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.FactorInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class FactorListResponse < InstanceListResource
+                    # @param [Array<FactorInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @factor_instance = payload.body[key].map do |data|
+                        FactorInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def factor_instance
+                          @instance
+                      end
+                  end
+
                 class FactorPage < Page
                     ##
                     # Initialize the FactorPage
@@ -237,6 +441,7 @@ module Twilio
                     # @return [FactorPage] FactorPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -256,6 +461,66 @@ module Twilio
                         '<Twilio.Verify.V2.FactorPage>'
                     end
                 end
+
+                class FactorPageMetadata < PageMetadata
+                    attr_reader :factor_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @factor_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @factor_page << FactorListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @factor_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Verify::V2PageMetadata>';
+                    end
+                end
+                class FactorListResponse < InstanceListResource
+
+                    # @param [Array<FactorInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @factor = data_list.map do |data|
+                        FactorInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def factor
+                        @factor
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class FactorInstance < InstanceResource
                     ##
                     # Initialize the FactorInstance
@@ -269,6 +534,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, identity: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -409,15 +675,15 @@ module Twilio
                     # @param [String] config_notification_platform The transport technology used to generate the Notification Token. Can be `apn`, `fcm` or `none`.  Required when `factor_type` is `push`.
                     # @return [FactorInstance] Updated FactorInstance
                     def update(
-                        auth_payload: :unset, 
-                        friendly_name: :unset, 
-                        config_notification_token: :unset, 
-                        config_sdk_version: :unset, 
-                        config_time_step: :unset, 
-                        config_skew: :unset, 
-                        config_code_length: :unset, 
-                        config_alg: :unset, 
-                        config_notification_platform: :unset
+                      auth_payload: :unset, 
+                      friendly_name: :unset, 
+                      config_notification_token: :unset, 
+                      config_sdk_version: :unset, 
+                      config_time_step: :unset, 
+                      config_skew: :unset, 
+                      config_code_length: :unset, 
+                      config_alg: :unset, 
+                      config_notification_platform: :unset
                     )
 
                         context.update(