twilio-ruby 6.8.0 → 7.10.7

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

@@ -18,12 +18,14 @@ module Twilio
         class Verify < VerifyBase
             class V2 < Version
                 class TemplateList < ListResource
+                
                     ##
                     # Initialize the TemplateList
                     # @param [Version] version Version that contains the resource
                     # @return [TemplateList] TemplateList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Templates"
@@ -69,7 +71,35 @@ module Twilio
                             friendly_name: friendly_name,
                             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 TemplatePageMetadata records from the API as a list.
+                      # @param [String] friendly_name String filter used to query templates with a given friendly name.
+                    # @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(friendly_name: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        TemplatePageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -81,9 +111,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
 
                     ##
@@ -94,15 +128,18 @@ 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 TemplateInstance
-                    def page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(friendly_name: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'FriendlyName' => friendly_name,
                             '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)
 
                         TemplatePage.new(@version, response, @solution)
                     end
@@ -137,6 +174,7 @@ module Twilio
                     # @return [TemplatePage] TemplatePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -156,6 +194,66 @@ module Twilio
                         '<Twilio.Verify.V2.TemplatePage>'
                     end
                 end
+
+                class TemplatePageMetadata < PageMetadata
+                    attr_reader :template_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @template_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @template_page << TemplateListResponse.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
+                        @template_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Verify::V2PageMetadata>';
+                    end
+                end
+                class TemplateListResponse < InstanceListResource
+
+                    # @param [Array<TemplateInstance>] 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
+                      @template = data_list.map do |data|
+                        TemplateInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def template
+                        @template
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class TemplateInstance < InstanceResource
                     ##
                     # Initialize the TemplateInstance
@@ -169,6 +267,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

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

@@ -18,12 +18,14 @@ module Twilio
         class Verify < VerifyBase
             class V2 < Version
                 class VerificationAttemptList < ListResource
+                
                     ##
                     # Initialize the VerificationAttemptList
                     # @param [Version] version Version that contains the resource
                     # @return [VerificationAttemptList] VerificationAttemptList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Attempts"
@@ -38,7 +40,7 @@ module Twilio
                     # @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] channel_data_to Destination of a verification. It is phone number in E.164 format.
                     # @param [String] country Filter used to query Verification Attempts sent to the specified destination country.
-                    # @param [Channels] channel Filter used to query Verification Attempts by communication channel. Valid values are `SMS` and `CALL`
+                    # @param [Channels] channel Filter used to query Verification Attempts by communication channel.
                     # @param [String] verify_service_sid Filter used to query Verification Attempts by verify service. Only attempts of the provided SID will be returned.
                     # @param [String] verification_sid Filter used to return all the Verification Attempts of a single verification. Only attempts of the provided verification SID will be returned.
                     # @param [ConversionStatus] status Filter used to query Verification Attempts by conversion status. Valid values are `UNCONVERTED`, for attempts that were not converted, and `CONVERTED`, for attempts that were confirmed.
@@ -72,7 +74,7 @@ module Twilio
                     # @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] channel_data_to Destination of a verification. It is phone number in E.164 format.
                     # @param [String] country Filter used to query Verification Attempts sent to the specified destination country.
-                    # @param [Channels] channel Filter used to query Verification Attempts by communication channel. Valid values are `SMS` and `CALL`
+                    # @param [Channels] channel Filter used to query Verification Attempts by communication channel.
                     # @param [String] verify_service_sid Filter used to query Verification Attempts by verify service. Only attempts of the provided SID will be returned.
                     # @param [String] verification_sid Filter used to return all the Verification Attempts of a single verification. Only attempts of the provided verification SID will be returned.
                     # @param [ConversionStatus] status Filter used to query Verification Attempts by conversion status. Valid values are `UNCONVERTED`, for attempts that were not converted, and `CONVERTED`, for attempts that were confirmed.
@@ -97,7 +99,49 @@ module Twilio
                             status: status,
                             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 VerificationAttemptPageMetadata records from the API as a list.
+                      # @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] channel_data_to Destination of a verification. It is phone number in E.164 format.
+                      # @param [String] country Filter used to query Verification Attempts sent to the specified destination country.
+                      # @param [Channels] channel Filter used to query Verification Attempts by communication channel.
+                      # @param [String] verify_service_sid Filter used to query Verification Attempts by verify service. Only attempts of the provided SID will be returned.
+                      # @param [String] verification_sid Filter used to return all the Verification Attempts of a single verification. Only attempts of the provided verification SID will be returned.
+                      # @param [ConversionStatus] status Filter used to query Verification Attempts by conversion status. Valid values are `UNCONVERTED`, for attempts that were not converted, and `CONVERTED`, for attempts that were confirmed.
+                    # @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(date_created_after: :unset, date_created_before: :unset, channel_data_to: :unset, country: :unset, channel: :unset, verify_service_sid: :unset, verification_sid: :unset, status: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'DateCreatedAfter' =>  Twilio.serialize_iso8601_datetime(date_created_after),
+                            'DateCreatedBefore' =>  Twilio.serialize_iso8601_datetime(date_created_before),
+                            'ChannelData.To' => channel_data_to,
+                            'Country' => country,
+                            'Channel' => channel,
+                            'VerifyServiceSid' => verify_service_sid,
+                            'VerificationSid' => verification_sid,
+                            'Status' => status,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        VerificationAttemptPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -109,9 +153,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
 
                     ##
@@ -121,7 +169,7 @@ module Twilio
                     # @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] channel_data_to Destination of a verification. It is phone number in E.164 format.
                     # @param [String] country Filter used to query Verification Attempts sent to the specified destination country.
-                    # @param [Channels] channel Filter used to query Verification Attempts by communication channel. Valid values are `SMS` and `CALL`
+                    # @param [Channels] channel Filter used to query Verification Attempts by communication channel.
                     # @param [String] verify_service_sid Filter used to query Verification Attempts by verify service. Only attempts of the provided SID will be returned.
                     # @param [String] verification_sid Filter used to return all the Verification Attempts of a single verification. Only attempts of the provided verification SID will be returned.
                     # @param [ConversionStatus] status Filter used to query Verification Attempts by conversion status. Valid values are `UNCONVERTED`, for attempts that were not converted, and `CONVERTED`, for attempts that were confirmed.
@@ -129,7 +177,7 @@ 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 VerificationAttemptInstance
-                    def page(date_created_after: :unset, date_created_before: :unset, channel_data_to: :unset, country: :unset, channel: :unset, verify_service_sid: :unset, verification_sid: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(date_created_after: :unset, date_created_before: :unset, channel_data_to: :unset, country: :unset, channel: :unset, verify_service_sid: :unset, verification_sid: :unset, status: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'DateCreatedAfter' =>  Twilio.serialize_iso8601_datetime(date_created_after),
                             'DateCreatedBefore' =>  Twilio.serialize_iso8601_datetime(date_created_before),
@@ -143,8 +191,11 @@ module Twilio
                             '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)
 
                         VerificationAttemptPage.new(@version, response, @solution)
                     end
@@ -179,6 +230,7 @@ module Twilio
                     # @return [VerificationAttemptContext] VerificationAttemptContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -191,7 +243,13 @@ module Twilio
                     # @return [VerificationAttemptInstance] Fetched VerificationAttemptInstance
                     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)
                         VerificationAttemptInstance.new(
                             @version,
                             payload,
@@ -199,6 +257,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the VerificationAttemptInstanceMetadata
+                    # @return [VerificationAttemptInstance] Fetched VerificationAttemptInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        verification_attempt_instance = VerificationAttemptInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        VerificationAttemptInstanceMetadata.new(
+                            @version,
+                            verification_attempt_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -215,6 +298,53 @@ module Twilio
                     end
                 end
 
+                class VerificationAttemptInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new VerificationAttemptInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}VerificationAttemptInstance] verification_attempt_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 [VerificationAttemptInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, verification_attempt_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @verification_attempt_instance = verification_attempt_instance
+                    end
+
+                    def verification_attempt
+                        @verification_attempt_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.VerificationAttemptInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class VerificationAttemptListResponse < InstanceListResource
+                    # @param [Array<VerificationAttemptInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @verification_attempt_instance = payload.body[key].map do |data|
+                        VerificationAttemptInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def verification_attempt_instance
+                          @instance
+                      end
+                  end
+
                 class VerificationAttemptPage < Page
                     ##
                     # Initialize the VerificationAttemptPage
@@ -224,6 +354,7 @@ module Twilio
                     # @return [VerificationAttemptPage] VerificationAttemptPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -243,6 +374,66 @@ module Twilio
                         '<Twilio.Verify.V2.VerificationAttemptPage>'
                     end
                 end
+
+                class VerificationAttemptPageMetadata < PageMetadata
+                    attr_reader :verification_attempt_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @verification_attempt_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @verification_attempt_page << VerificationAttemptListResponse.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_attempt_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Verify::V2PageMetadata>';
+                    end
+                end
+                class VerificationAttemptListResponse < InstanceListResource
+
+                    # @param [Array<VerificationAttemptInstance>] 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_attempt = data_list.map do |data|
+                        VerificationAttemptInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def verification_attempt
+                        @verification_attempt
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class VerificationAttemptInstance < InstanceResource
                     ##
                     # Initialize the VerificationAttemptInstance
@@ -256,6 +447,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -336,7 +528,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Hash] An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately available. More information on pricing is available [here](https://www.twilio.com/verify/pricing).
+                    # @return [Hash] An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately available. More information on pricing is available [here](https://www.twilio.com/en-us/verify/pricing).
                     def price
                         @properties['price']
                     end