twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/verify/v2/verification_attempts_summary.rb

@@ -18,12 +18,14 @@ module Twilio
         class Verify < VerifyBase
             class V2 < Version
                 class VerificationAttemptsSummaryList < ListResource
+                
                     ##
                     # Initialize the VerificationAttemptsSummaryList
                     # @param [Version] version Version that contains the resource
                     # @return [VerificationAttemptsSummaryList] VerificationAttemptsSummaryList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         
@@ -46,6 +48,7 @@ module Twilio
                     # @return [VerificationAttemptsSummaryContext] VerificationAttemptsSummaryContext
                     def initialize(version)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = {  }
@@ -59,16 +62,16 @@ module Twilio
                     # @param [Time] date_created_after Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
                     # @param [Time] date_created_before Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
                     # @param [String] country Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.
-                    # @param [Channels] channel Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are `SMS`, `CALL` and `WHATSAPP`
+                    # @param [Channels] channel Filter Verification Attempts considered on the summary aggregation by communication channel.
                     # @param [String] destination_prefix Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.
                     # @return [VerificationAttemptsSummaryInstance] Fetched VerificationAttemptsSummaryInstance
                     def fetch(
-                        verify_service_sid: :unset, 
-                        date_created_after: :unset, 
-                        date_created_before: :unset, 
-                        country: :unset, 
-                        channel: :unset, 
-                        destination_prefix: :unset
+                      verify_service_sid: :unset, 
+                      date_created_after: :unset, 
+                      date_created_before: :unset, 
+                      country: :unset, 
+                      channel: :unset, 
+                      destination_prefix: :unset
                     )
 
                         params = Twilio::Values.of({
@@ -79,13 +82,64 @@ module Twilio
                             'Channel' => channel,
                             'DestinationPrefix' => destination_prefix,
                         })
-                        payload = @version.fetch('GET', @uri, params: params)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
                         VerificationAttemptsSummaryInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Fetch the VerificationAttemptsSummaryInstanceMetadata
+                    # @param [String] verify_service_sid Filter used to consider only Verification Attempts of the given verify service on the summary aggregation.
+                    # @param [Time] date_created_after Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
+                    # @param [Time] date_created_before Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
+                    # @param [String] country Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.
+                    # @param [Channels] channel Filter Verification Attempts considered on the summary aggregation by communication channel.
+                    # @param [String] destination_prefix Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.
+                    # @return [VerificationAttemptsSummaryInstance] Fetched VerificationAttemptsSummaryInstance
+                    def fetch_with_metadata(
+                      verify_service_sid: :unset, 
+                      date_created_after: :unset, 
+                      date_created_before: :unset, 
+                      country: :unset, 
+                      channel: :unset, 
+                      destination_prefix: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'VerifyServiceSid' => verify_service_sid,
+                            'DateCreatedAfter' => Twilio.serialize_iso8601_datetime(date_created_after),
+                            'DateCreatedBefore' => Twilio.serialize_iso8601_datetime(date_created_before),
+                            'Country' => country,
+                            'Channel' => channel,
+                            'DestinationPrefix' => destination_prefix,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        verification_attempts_summary_instance = VerificationAttemptsSummaryInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        VerificationAttemptsSummaryInstanceMetadata.new(
+                            @version,
+                            verification_attempts_summary_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -102,6 +156,53 @@ module Twilio
                     end
                 end
 
+                class VerificationAttemptsSummaryInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new VerificationAttemptsSummaryInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}VerificationAttemptsSummaryInstance] verification_attempts_summary_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 [VerificationAttemptsSummaryInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, verification_attempts_summary_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @verification_attempts_summary_instance = verification_attempts_summary_instance
+                    end
+
+                    def verification_attempts_summary
+                        @verification_attempts_summary_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.VerificationAttemptsSummaryInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class VerificationAttemptsSummaryListResponse < InstanceListResource
+                    # @param [Array<VerificationAttemptsSummaryInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @verification_attempts_summary_instance = payload.body[key].map do |data|
+                        VerificationAttemptsSummaryInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def verification_attempts_summary_instance
+                          @instance
+                      end
+                  end
+
                 class VerificationAttemptsSummaryPage < Page
                     ##
                     # Initialize the VerificationAttemptsSummaryPage
@@ -111,6 +212,7 @@ module Twilio
                     # @return [VerificationAttemptsSummaryPage] VerificationAttemptsSummaryPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -130,6 +232,66 @@ module Twilio
                         '<Twilio.Verify.V2.VerificationAttemptsSummaryPage>'
                     end
                 end
+
+                class VerificationAttemptsSummaryPageMetadata < PageMetadata
+                    attr_reader :verification_attempts_summary_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @verification_attempts_summary_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @verification_attempts_summary_page << VerificationAttemptsSummaryListResponse.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
+                        @verification_attempts_summary_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Verify::V2PageMetadata>';
+                    end
+                end
+                class VerificationAttemptsSummaryListResponse < InstanceListResource
+
+                    # @param [Array<VerificationAttemptsSummaryInstance>] 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
+                      @verification_attempts_summary = data_list.map do |data|
+                        VerificationAttemptsSummaryInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def verification_attempts_summary
+                        @verification_attempts_summary
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class VerificationAttemptsSummaryInstance < InstanceResource
                     ##
                     # Initialize the VerificationAttemptsSummaryInstance
@@ -143,6 +305,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'total_attempts' => payload['total_attempts'] == nil ? payload['total_attempts'] : payload['total_attempts'].to_i,
@@ -187,7 +350,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Float] Percentage of the confirmed messages over the total, defined by (total_converted/total_attempts)*100. 
+                    # @return [String] Percentage of the confirmed messages over the total, defined by (total_converted/total_attempts)*100. 
                     def conversion_rate_percentage
                         @properties['conversion_rate_percentage']
                     end
@@ -204,16 +367,16 @@ module Twilio
                     # @param [Time] date_created_after Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
                     # @param [Time] date_created_before Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
                     # @param [String] country Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.
-                    # @param [Channels] channel Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are `SMS`, `CALL` and `WHATSAPP`
+                    # @param [Channels] channel Filter Verification Attempts considered on the summary aggregation by communication channel.
                     # @param [String] destination_prefix Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.
                     # @return [VerificationAttemptsSummaryInstance] Fetched VerificationAttemptsSummaryInstance
                     def fetch(
-                        verify_service_sid: :unset, 
-                        date_created_after: :unset, 
-                        date_created_before: :unset, 
-                        country: :unset, 
-                        channel: :unset, 
-                        destination_prefix: :unset
+                      verify_service_sid: :unset, 
+                      date_created_after: :unset, 
+                      date_created_before: :unset, 
+                      country: :unset, 
+                      channel: :unset, 
+                      destination_prefix: :unset
                     )
 
                         context.fetch(

data/lib/twilio-ruby/rest/verify/v2.rb

@@ -37,6 +37,7 @@ module Twilio
                     if form_type.nil?
                         raise ArgumentError, 'form_type cannot be nil'
                     end
+
                     if form_type == :unset
                         @forms ||= FormList.new self
                     else
@@ -51,6 +52,7 @@ module Twilio
                     if phone_number.nil?
                         raise ArgumentError, 'phone_number cannot be nil'
                     end
+
                     if phone_number == :unset
                         @safelist ||= SafelistList.new self
                     else
@@ -65,6 +67,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @services ||= ServiceList.new self
                     else
@@ -84,6 +87,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @verification_attempts ||= VerificationAttemptList.new self
                     else