twilio-ruby 7.9.1 → 7.10.0

data/lib/twilio-ruby/rest/knowledge/v1/knowledge/knowledge_status.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [KnowledgeStatusList] KnowledgeStatusList
                     def initialize(version, id: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { id: id }
                         
@@ -50,6 +51,7 @@ module Twilio
                     # @return [KnowledgeStatusContext] KnowledgeStatusContext
                     def initialize(version, id)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { id: id,  }
@@ -76,6 +78,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the KnowledgeStatusInstanceMetadata
+                    # @return [KnowledgeStatusInstance] Fetched KnowledgeStatusInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        knowledge_status_instance = KnowledgeStatusInstance.new(
+                            @version,
+                            response.body,
+                            id: @solution[:id],
+                        )
+                        KnowledgeStatusInstanceMetadata.new(
+                            @version,
+                            knowledge_status_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -92,6 +119,53 @@ module Twilio
                     end
                 end
 
+                class KnowledgeStatusInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new KnowledgeStatusInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}KnowledgeStatusInstance] knowledge_status_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 [KnowledgeStatusInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, knowledge_status_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @knowledge_status_instance = knowledge_status_instance
+                    end
+
+                    def knowledge_status
+                        @knowledge_status_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.KnowledgeStatusInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class KnowledgeStatusListResponse < InstanceListResource
+                    # @param [Array<KnowledgeStatusInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @knowledge_status_instance = payload.body[key].map do |data|
+                        KnowledgeStatusInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def knowledge_status_instance
+                          @instance
+                      end
+                  end
+
                 class KnowledgeStatusPage < Page
                     ##
                     # Initialize the KnowledgeStatusPage
@@ -101,6 +175,7 @@ module Twilio
                     # @return [KnowledgeStatusPage] KnowledgeStatusPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -120,6 +195,66 @@ module Twilio
                         '<Twilio.Knowledge.V1.KnowledgeStatusPage>'
                     end
                 end
+
+                class KnowledgeStatusPageMetadata < PageMetadata
+                    attr_reader :knowledge_status_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @knowledge_status_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @knowledge_status_page << KnowledgeStatusListResponse.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
+                        @knowledge_status_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Knowledge::V1PageMetadata>';
+                    end
+                end
+                class KnowledgeStatusListResponse < InstanceListResource
+
+                    # @param [Array<KnowledgeStatusInstance>] 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
+                      @knowledge_status = data_list.map do |data|
+                        KnowledgeStatusInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def knowledge_status
+                        @knowledge_status
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class KnowledgeStatusInstance < InstanceResource
                     ##
                     # Initialize the KnowledgeStatusInstance
@@ -133,6 +268,7 @@ module Twilio
                     def initialize(version, payload , id: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

data/lib/twilio-ruby/rest/knowledge/v1/knowledge.rb

@@ -189,6 +189,7 @@ module Twilio
                     # @return [KnowledgeList] KnowledgeList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Knowledge"
@@ -214,6 +215,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the KnowledgeInstanceMetadata
+                    # @param [KnowledgeV1ServiceCreateKnowledgeRequest] knowledge_v1_service_create_knowledge_request 
+                    # @return [KnowledgeInstance] Created KnowledgeInstance
+                    def create_with_metadata(knowledge_v1_service_create_knowledge_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: knowledge_v1_service_create_knowledge_request.to_json)
+                        knowledge_instance = KnowledgeInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        KnowledgeInstanceMetadata.new(
+                            @version,
+                            knowledge_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists KnowledgeInstance records from the API as a list.
@@ -257,6 +284,30 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists KnowledgePageMetadata records from the API as a list.
+                      # @param [String] tags Json array of tag and value pairs for tag filtering.
+                    # @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(tags: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Tags' => tags,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        KnowledgePageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields KnowledgeInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -279,7 +330,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 KnowledgeInstance
-                    def page(tags: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(tags: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Tags' => tags,
                             'PageToken' => page_token,
@@ -325,6 +376,7 @@ module Twilio
                     # @return [KnowledgeContext] KnowledgeContext
                     def initialize(version, id)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { id: id,  }
@@ -343,9 +395,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the KnowledgeInstanceMetadata
+                    # @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)
+                          knowledge_instance = KnowledgeInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          KnowledgeInstanceMetadata.new(@version, knowledge_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the KnowledgeInstance
                     # @return [KnowledgeInstance] Fetched KnowledgeInstance
@@ -365,6 +437,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the KnowledgeInstanceMetadata
+                    # @return [KnowledgeInstance] Fetched KnowledgeInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        knowledge_instance = KnowledgeInstance.new(
+                            @version,
+                            response.body,
+                            id: @solution[:id],
+                        )
+                        KnowledgeInstanceMetadata.new(
+                            @version,
+                            knowledge_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the KnowledgeInstance
                     # @param [KnowledgeV1ServiceUpdateKnowledgeRequest] knowledge_v1_service_update_knowledge_request 
@@ -386,6 +483,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the KnowledgeInstanceMetadata
+                    # @param [KnowledgeV1ServiceUpdateKnowledgeRequest] knowledge_v1_service_update_knowledge_request 
+                    # @return [KnowledgeInstance] Updated KnowledgeInstance
+                    def update_with_metadata(knowledge_v1_service_update_knowledge_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('PUT', @uri, headers: headers, data: knowledge_v1_service_update_knowledge_request.to_json)
+                        knowledge_instance = KnowledgeInstance.new(
+                            @version,
+                            response.body,
+                            id: @solution[:id],
+                        )
+                        KnowledgeInstanceMetadata.new(
+                            @version,
+                            knowledge_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the chunks
                     # @return [ChunkList]
@@ -423,6 +547,53 @@ module Twilio
                     end
                 end
 
+                class KnowledgeInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new KnowledgeInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}KnowledgeInstance] knowledge_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 [KnowledgeInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, knowledge_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @knowledge_instance = knowledge_instance
+                    end
+
+                    def knowledge
+                        @knowledge_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.KnowledgeInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class KnowledgeListResponse < InstanceListResource
+                    # @param [Array<KnowledgeInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @knowledge_instance = payload.body[key].map do |data|
+                        KnowledgeInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def knowledge_instance
+                          @instance
+                      end
+                  end
+
                 class KnowledgePage < Page
                     ##
                     # Initialize the KnowledgePage
@@ -432,6 +603,7 @@ module Twilio
                     # @return [KnowledgePage] KnowledgePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -451,6 +623,66 @@ module Twilio
                         '<Twilio.Knowledge.V1.KnowledgePage>'
                     end
                 end
+
+                class KnowledgePageMetadata < PageMetadata
+                    attr_reader :knowledge_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @knowledge_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @knowledge_page << KnowledgeListResponse.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
+                        @knowledge_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Knowledge::V1PageMetadata>';
+                    end
+                end
+                class KnowledgeListResponse < InstanceListResource
+
+                    # @param [Array<KnowledgeInstance>] 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
+                      @knowledge = data_list.map do |data|
+                        KnowledgeInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def knowledge
+                        @knowledge
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class KnowledgeInstance < InstanceResource
                     ##
                     # Initialize the KnowledgeInstance
@@ -464,6 +696,7 @@ module Twilio
                     def initialize(version, payload , id: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'description' => payload['description'],