twilio-ruby 6.8.0 → 7.10.7

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

@@ -20,12 +20,14 @@ module Twilio
                 class ServiceContext < InstanceContext
 
                      class RateLimitList < ListResource
+                
                     ##
                     # Initialize the RateLimitList
                     # @param [Version] version Version that contains the resource
                     # @return [RateLimitList] RateLimitList
                     def initialize(version, service_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/RateLimits"
@@ -37,8 +39,8 @@ module Twilio
                     # @param [String] description Description of this Rate Limit
                     # @return [RateLimitInstance] Created RateLimitInstance
                     def create(
-                        unique_name: nil, 
-                        description: :unset
+                      unique_name: nil, 
+                      description: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -46,7 +48,13 @@ module Twilio
                             'Description' => description,
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
                         RateLimitInstance.new(
                             @version,
                             payload,
@@ -54,6 +62,41 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the RateLimitInstanceMetadata
+                    # @param [String] unique_name Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. **This value should not contain PII.**
+                    # @param [String] description Description of this Rate Limit
+                    # @return [RateLimitInstance] Created RateLimitInstance
+                    def create_with_metadata(
+                      unique_name: nil, 
+                      description: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'UniqueName' => unique_name,
+                            'Description' => description,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        rate_limit_instance = RateLimitInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                        )
+                        RateLimitInstanceMetadata.new(
+                            @version,
+                            rate_limit_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists RateLimitInstance records from the API as a list.
@@ -90,7 +133,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 RateLimitPageMetadata 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)
+
+                        RateLimitPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -102,9 +171,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
 
                     ##
@@ -114,14 +187,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 RateLimitInstance
-                    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)
 
                         RateLimitPage.new(@version, response, @solution)
                     end
@@ -157,6 +233,7 @@ module Twilio
                     # @return [RateLimitContext] RateLimitContext
                     def initialize(version, service_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, sid: sid,  }
@@ -170,7 +247,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 RateLimitInstanceMetadata
+                    # @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)
+                          rateLimit_instance = RateLimitInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          RateLimitInstanceMetadata.new(@version, rateLimit_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -178,7 +279,13 @@ module Twilio
                     # @return [RateLimitInstance] Fetched RateLimitInstance
                     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)
                         RateLimitInstance.new(
                             @version,
                             payload,
@@ -187,19 +294,51 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the RateLimitInstanceMetadata
+                    # @return [RateLimitInstance] Fetched RateLimitInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        rate_limit_instance = RateLimitInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            sid: @solution[:sid],
+                        )
+                        RateLimitInstanceMetadata.new(
+                            @version,
+                            rate_limit_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the RateLimitInstance
                     # @param [String] description Description of this Rate Limit
                     # @return [RateLimitInstance] Updated RateLimitInstance
                     def update(
-                        description: :unset
+                      description: :unset
                     )
 
                         data = Twilio::Values.of({
                             'Description' => description,
                         })
 
-                        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)
                         RateLimitInstance.new(
                             @version,
                             payload,
@@ -208,6 +347,39 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the RateLimitInstanceMetadata
+                    # @param [String] description Description of this Rate Limit
+                    # @return [RateLimitInstance] Updated RateLimitInstance
+                    def update_with_metadata(
+                      description: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Description' => description,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        rate_limit_instance = RateLimitInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            sid: @solution[:sid],
+                        )
+                        RateLimitInstanceMetadata.new(
+                            @version,
+                            rate_limit_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the buckets
                     # @return [BucketList]
@@ -243,6 +415,53 @@ module Twilio
                     end
                 end
 
+                class RateLimitInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new RateLimitInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}RateLimitInstance] rate_limit_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 [RateLimitInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, rate_limit_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @rate_limit_instance = rate_limit_instance
+                    end
+
+                    def rate_limit
+                        @rate_limit_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.RateLimitInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class RateLimitListResponse < InstanceListResource
+                    # @param [Array<RateLimitInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @rate_limit_instance = payload.body[key].map do |data|
+                        RateLimitInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def rate_limit_instance
+                          @instance
+                      end
+                  end
+
                 class RateLimitPage < Page
                     ##
                     # Initialize the RateLimitPage
@@ -252,6 +471,7 @@ module Twilio
                     # @return [RateLimitPage] RateLimitPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -271,6 +491,66 @@ module Twilio
                         '<Twilio.Verify.V2.RateLimitPage>'
                     end
                 end
+
+                class RateLimitPageMetadata < PageMetadata
+                    attr_reader :rate_limit_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @rate_limit_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @rate_limit_page << RateLimitListResponse.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
+                        @rate_limit_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Verify::V2PageMetadata>';
+                    end
+                end
+                class RateLimitListResponse < InstanceListResource
+
+                    # @param [Array<RateLimitInstance>] 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
+                      @rate_limit = data_list.map do |data|
+                        RateLimitInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def rate_limit
+                        @rate_limit
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class RateLimitInstance < InstanceResource
                     ##
                     # Initialize the RateLimitInstance
@@ -284,6 +564,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -388,7 +669,7 @@ module Twilio
                     # @param [String] description Description of this Rate Limit
                     # @return [RateLimitInstance] Updated RateLimitInstance
                     def update(
-                        description: :unset
+                      description: :unset
                     )
 
                         context.update(