twilio-ruby 7.9.1 → 7.10.0

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

@@ -28,6 +28,7 @@ module Twilio
                     # @return [BucketList] BucketList
                     def initialize(version, service_sid: nil, rate_limit_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid, rate_limit_sid: rate_limit_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/RateLimits/#{@solution[:rate_limit_sid]}/Buckets"
@@ -63,6 +64,42 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the BucketInstanceMetadata
+                    # @param [String] max Maximum number of requests permitted in during the interval.
+                    # @param [String] interval Number of seconds that the rate limit will be enforced over.
+                    # @return [BucketInstance] Created BucketInstance
+                    def create_with_metadata(
+                      max: nil, 
+                      interval: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Max' => max,
+                            'Interval' => interval,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        bucket_instance = BucketInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            rate_limit_sid: @solution[:rate_limit_sid],
+                        )
+                        BucketInstanceMetadata.new(
+                            @version,
+                            bucket_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists BucketInstance records from the API as a list.
@@ -102,6 +139,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists BucketPageMetadata 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)
+
+                        BucketPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields BucketInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -123,7 +182,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 BucketInstance
-                    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,
@@ -170,6 +229,7 @@ module Twilio
                     # @return [BucketContext] BucketContext
                     def initialize(version, service_sid, rate_limit_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, rate_limit_sid: rate_limit_sid, sid: sid,  }
@@ -186,9 +246,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the BucketInstanceMetadata
+                    # @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)
+                          bucket_instance = BucketInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          BucketInstanceMetadata.new(@version, bucket_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the BucketInstance
                     # @return [BucketInstance] Fetched BucketInstance
@@ -210,6 +290,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the BucketInstanceMetadata
+                    # @return [BucketInstance] Fetched BucketInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        bucket_instance = BucketInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            rate_limit_sid: @solution[:rate_limit_sid],
+                            sid: @solution[:sid],
+                        )
+                        BucketInstanceMetadata.new(
+                            @version,
+                            bucket_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the BucketInstance
                     # @param [String] max Maximum number of requests permitted in during the interval.
@@ -241,6 +348,43 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the BucketInstanceMetadata
+                    # @param [String] max Maximum number of requests permitted in during the interval.
+                    # @param [String] interval Number of seconds that the rate limit will be enforced over.
+                    # @return [BucketInstance] Updated BucketInstance
+                    def update_with_metadata(
+                      max: :unset, 
+                      interval: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Max' => max,
+                            'Interval' => interval,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        bucket_instance = BucketInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            rate_limit_sid: @solution[:rate_limit_sid],
+                            sid: @solution[:sid],
+                        )
+                        BucketInstanceMetadata.new(
+                            @version,
+                            bucket_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -257,6 +401,53 @@ module Twilio
                     end
                 end
 
+                class BucketInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new BucketInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}BucketInstance] bucket_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 [BucketInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, bucket_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @bucket_instance = bucket_instance
+                    end
+
+                    def bucket
+                        @bucket_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.BucketInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class BucketListResponse < InstanceListResource
+                    # @param [Array<BucketInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @bucket_instance = payload.body[key].map do |data|
+                        BucketInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def bucket_instance
+                          @instance
+                      end
+                  end
+
                 class BucketPage < Page
                     ##
                     # Initialize the BucketPage
@@ -266,6 +457,7 @@ module Twilio
                     # @return [BucketPage] BucketPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -285,6 +477,66 @@ module Twilio
                         '<Twilio.Verify.V2.BucketPage>'
                     end
                 end
+
+                class BucketPageMetadata < PageMetadata
+                    attr_reader :bucket_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @bucket_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @bucket_page << BucketListResponse.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
+                        @bucket_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Verify::V2PageMetadata>';
+                    end
+                end
+                class BucketListResponse < InstanceListResource
+
+                    # @param [Array<BucketInstance>] 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
+                      @bucket = data_list.map do |data|
+                        BucketInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def bucket
+                        @bucket
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class BucketInstance < InstanceResource
                     ##
                     # Initialize the BucketInstance
@@ -298,6 +550,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, rate_limit_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

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

@@ -27,6 +27,7 @@ module Twilio
                     # @return [RateLimitList] RateLimitList
                     def initialize(version, service_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/RateLimits"
@@ -61,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.
@@ -100,6 +136,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     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
+
                     ##
                     # When passed a block, yields RateLimitInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -121,7 +179,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 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,
@@ -167,6 +225,7 @@ module Twilio
                     # @return [RateLimitContext] RateLimitContext
                     def initialize(version, service_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, sid: sid,  }
@@ -184,9 +243,29 @@ module Twilio
                         
                         
                         
+
                         @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
+
                     ##
                     # Fetch the RateLimitInstance
                     # @return [RateLimitInstance] Fetched RateLimitInstance
@@ -207,6 +286,32 @@ 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
@@ -234,6 +339,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]
@@ -269,6 +407,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
@@ -278,6 +463,7 @@ module Twilio
                     # @return [RateLimitPage] RateLimitPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -297,6 +483,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
@@ -310,6 +556,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],