twilio-ruby 7.9.1 → 7.10.0

data/lib/twilio-ruby/rest/api/v2010/account/queue/member.rb

@@ -28,6 +28,7 @@ module Twilio
                     # @return [MemberList] MemberList
                     def initialize(version, account_sid: nil, queue_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid, queue_sid: queue_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/Queues/#{@solution[:queue_sid]}/Members.json"
@@ -72,6 +73,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists MemberPageMetadata 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)
+
+                        MemberPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields MemberInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -93,7 +116,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 MemberInstance
-                    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,
@@ -140,6 +163,7 @@ module Twilio
                     # @return [MemberContext] MemberContext
                     def initialize(version, account_sid, queue_sid, call_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, queue_sid: queue_sid, call_sid: call_sid,  }
@@ -168,6 +192,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the MemberInstanceMetadata
+                    # @return [MemberInstance] Fetched MemberInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        member_instance = MemberInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            queue_sid: @solution[:queue_sid],
+                            call_sid: @solution[:call_sid],
+                        )
+                        MemberInstanceMetadata.new(
+                            @version,
+                            member_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the MemberInstance
                     # @param [String] url The absolute URL of the Queue resource.
@@ -199,6 +250,43 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the MemberInstanceMetadata
+                    # @param [String] url The absolute URL of the Queue resource.
+                    # @param [String] method How to pass the update request data. Can be `GET` or `POST` and the default is `POST`. `POST` sends the data as encoded form data and `GET` sends the data as query parameters.
+                    # @return [MemberInstance] Updated MemberInstance
+                    def update_with_metadata(
+                      url: nil, 
+                      method: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Url' => url,
+                            'Method' => method,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        member_instance = MemberInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            queue_sid: @solution[:queue_sid],
+                            call_sid: @solution[:call_sid],
+                        )
+                        MemberInstanceMetadata.new(
+                            @version,
+                            member_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -215,6 +303,53 @@ module Twilio
                     end
                 end
 
+                class MemberInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new MemberInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}MemberInstance] member_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 [MemberInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, member_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @member_instance = member_instance
+                    end
+
+                    def member
+                        @member_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.MemberInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class MemberListResponse < InstanceListResource
+                    # @param [Array<MemberInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @member_instance = payload.body[key].map do |data|
+                        MemberInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def member_instance
+                          @instance
+                      end
+                  end
+
                 class MemberPage < Page
                     ##
                     # Initialize the MemberPage
@@ -224,6 +359,7 @@ module Twilio
                     # @return [MemberPage] MemberPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -243,6 +379,66 @@ module Twilio
                         '<Twilio.Api.V2010.MemberPage>'
                     end
                 end
+
+                class MemberPageMetadata < PageMetadata
+                    attr_reader :member_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @member_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @member_page << MemberListResponse.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
+                        @member_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class MemberListResponse < InstanceListResource
+
+                    # @param [Array<MemberInstance>] 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
+                      @member = data_list.map do |data|
+                        MemberInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def member
+                        @member
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class MemberInstance < InstanceResource
                     ##
                     # Initialize the MemberInstance
@@ -256,6 +452,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, queue_sid: nil, call_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'call_sid' => payload['call_sid'],

data/lib/twilio-ruby/rest/api/v2010/account/queue.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [QueueList] QueueList
                     def initialize(version, account_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/Queues.json"
@@ -61,6 +62,41 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the QueueInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you created to describe this resource. It can be up to 64 characters long.
+                    # @param [String] max_size The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000.
+                    # @return [QueueInstance] Created QueueInstance
+                    def create_with_metadata(
+                      friendly_name: nil, 
+                      max_size: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'MaxSize' => max_size,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        queue_instance = QueueInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                        )
+                        QueueInstanceMetadata.new(
+                            @version,
+                            queue_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists QueueInstance 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 QueuePageMetadata 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)
+
+                        QueuePageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields QueueInstance 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 QueueInstance
-                    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 [QueueContext] QueueContext
                     def initialize(version, account_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, sid: sid,  }
@@ -184,9 +243,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the QueueInstanceMetadata
+                    # @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)
+                          queue_instance = QueueInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          QueueInstanceMetadata.new(@version, queue_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the QueueInstance
                     # @return [QueueInstance] Fetched QueueInstance
@@ -207,6 +286,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the QueueInstanceMetadata
+                    # @return [QueueInstance] Fetched QueueInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        queue_instance = QueueInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        QueueInstanceMetadata.new(
+                            @version,
+                            queue_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the QueueInstance
                     # @param [String] friendly_name A descriptive string that you created to describe this resource. It can be up to 64 characters long.
@@ -237,6 +342,42 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the QueueInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you created to describe this resource. It can be up to 64 characters long.
+                    # @param [String] max_size The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000.
+                    # @return [QueueInstance] Updated QueueInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      max_size: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'MaxSize' => max_size,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        queue_instance = QueueInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        QueueInstanceMetadata.new(
+                            @version,
+                            queue_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the members
                     # @return [MemberList]
@@ -272,6 +413,53 @@ module Twilio
                     end
                 end
 
+                class QueueInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new QueueInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}QueueInstance] queue_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 [QueueInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, queue_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @queue_instance = queue_instance
+                    end
+
+                    def queue
+                        @queue_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.QueueInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class QueueListResponse < InstanceListResource
+                    # @param [Array<QueueInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @queue_instance = payload.body[key].map do |data|
+                        QueueInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def queue_instance
+                          @instance
+                      end
+                  end
+
                 class QueuePage < Page
                     ##
                     # Initialize the QueuePage
@@ -281,6 +469,7 @@ module Twilio
                     # @return [QueuePage] QueuePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -300,6 +489,66 @@ module Twilio
                         '<Twilio.Api.V2010.QueuePage>'
                     end
                 end
+
+                class QueuePageMetadata < PageMetadata
+                    attr_reader :queue_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @queue_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @queue_page << QueueListResponse.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
+                        @queue_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class QueueListResponse < InstanceListResource
+
+                    # @param [Array<QueueInstance>] 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
+                      @queue = data_list.map do |data|
+                        QueueInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def queue
+                        @queue
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class QueueInstance < InstanceResource
                     ##
                     # Initialize the QueueInstance
@@ -313,6 +562,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),