twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/knowledge/v2/search.rb

@@ -0,0 +1,355 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio Knowledge API
+#    APIs for managing knowledge bases and knowledge content for AI-powered applications.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Knowledge < KnowledgeBase
+            class V2 < Version
+                class SearchList < ListResource
+                
+                    class KnowledgeSearch
+                            # @param [query]: [String] The query to search the knowledge source.
+                            # @param [top]: [String] The top K results to return.
+                            # @param [knowledge_ids]: [Array<String>] The list of knowledge IDs to search.
+                        attr_accessor :query, :top, :knowledge_ids
+                        def initialize(payload)
+                                @query = payload["query"]
+                                @top = payload["top"]
+                                @knowledge_ids = payload["knowledge_ids"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "query": @query,
+                                "top": @top,
+                                "knowledgeIds": @knowledge_ids,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the SearchList
+                    # @param [Version] version Version that contains the resource
+                    # @return [SearchList] SearchList
+                    def initialize(version)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Knowledge.V2.SearchList>'
+                    end
+                end
+
+
+                class SearchContext < InstanceContext
+                    ##
+                    # Initialize the SearchContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] kb_id A unique Knowledge Base ID using Twilio Type ID (TTID) format
+                    # @return [SearchContext] SearchContext
+                    def initialize(version, kb_id)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { kb_id: kb_id,  }
+                        @uri = "/KnowledgeBases/#{@solution[:kb_id]}/Search"
+
+                        
+                    end
+                    ##
+                    # Create the SearchInstance
+                    # @param [KnowledgeSearch] knowledge_search 
+                    # @return [SearchInstance] Created SearchInstance
+                    def create(knowledge_search: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: knowledge_search.to_json)
+                        SearchInstance.new(
+                            @version,
+                            payload,
+                            kb_id: @solution[:kb_id],
+                        )
+                    end
+
+                    ##
+                    # Create the SearchInstanceMetadata
+                    # @param [KnowledgeSearch] knowledge_search 
+                    # @return [SearchInstance] Created SearchInstance
+                    def create_with_metadata(knowledge_search: :unset
+                    )
+
+                        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_search.to_json)
+                        search_instance = SearchInstance.new(
+                            @version,
+                            response.body,
+                            kb_id: @solution[:kb_id],
+                        )
+                        SearchInstanceMetadata.new(
+                            @version,
+                            search_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Knowledge.V2.SearchContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Knowledge.V2.SearchContext #{context}>"
+                    end
+                end
+
+                class SearchInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new SearchInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}SearchInstance] search_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 [SearchInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, search_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @search_instance = search_instance
+                    end
+
+                    def search
+                        @search_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.SearchInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class SearchListResponse < InstanceListResource
+                    # @param [Array<SearchInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @search_instance = payload.body[key].map do |data|
+                        SearchInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def search_instance
+                          @instance
+                      end
+                  end
+
+                class SearchPage < TokenPage
+                    ##
+                    # Initialize the SearchPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [SearchPage] SearchPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of SearchInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [SearchInstance] SearchInstance
+                    def get_instance(payload)
+                        SearchInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Knowledge.V2.SearchPage>'
+                    end
+                end
+
+                class SearchPageMetadata < PageMetadata
+                    attr_reader :search_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @search_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @search_page << SearchListResponse.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
+                        @search_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Knowledge::V2PageMetadata>';
+                    end
+                end
+                class SearchListResponse < InstanceListResource
+
+                    # @param [Array<SearchInstance>] 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
+                      @search = data_list.map do |data|
+                        SearchInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def search
+                        @search
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class SearchInstance < InstanceResource
+                    ##
+                    # Initialize the SearchInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Search
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [SearchInstance] SearchInstance
+                    def initialize(version, payload , kb_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'chunks' => payload['chunks'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'kb_id' => kb_id  || @properties['kb_id']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [SearchContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = SearchContext.new(@version , @params['kb_id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [Array<KnowledgeChunkResult>] 
+                    def chunks
+                        @properties['chunks']
+                    end
+                    
+                    ##
+                    # Create the SearchInstance
+                    # @param [KnowledgeSearch] knowledge_search 
+                    # @return [SearchInstance] Created SearchInstance
+                    def create(knowledge_search: :unset
+                    )
+
+                        context.create(
+                            knowledge_search: knowledge_search, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Knowledge.V2.SearchInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Knowledge.V2.SearchInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,145 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio Knowledge API
+#    APIs for managing knowledge bases and knowledge content for AI-powered applications.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+module Twilio
+    module REST
+        class Knowledge
+            class V2 < Version
+                ##
+                # Initialize the V2 version of Knowledge
+                def initialize(domain)
+                    super
+                    @version = 'v2'
+                    @chunks = nil
+                    @knowledge = nil
+                    @knowledge_bases = nil
+                    @operations = nil
+                    @search = nil
+                end
+
+                ##
+                # @param [String] kb_id A unique Knowledge Base ID using Twilio Type ID (TTID) format
+                # @param [String] knowledge_id A unique Knowledge resource ID using Twilio Type ID (TTID) format
+                # @return [Twilio::REST::Knowledge::V2::ChunkList]
+                def chunks(kb_id=:unset, knowledge_id=:unset)
+                    if kb_id.nil?
+                        raise ArgumentError, 'kb_id cannot be nil'
+                    end
+                    if knowledge_id.nil?
+                        raise ArgumentError, 'knowledge_id cannot be nil'
+                    end
+
+                    if kb_id == :unset && knowledge_id == :unset
+                        @chunks ||= ChunkList.new self
+                    elsif kb_id != :unset && knowledge_id == :unset
+                        ChunkList.new(self, kb_id: kb_id)
+                    else
+                        ChunkList.new(self, kb_id: kb_id, knowledge_id: knowledge_id)
+                    end
+                end
+                ##
+                # @param [String] kb_id A unique Knowledge Base ID using Twilio Type ID (TTID) format
+                # @param [String] knowledge_id A unique Knowledge resource ID using Twilio Type ID (TTID) format
+                # @return [Twilio::REST::Knowledge::V2::ChunkList]
+                def chunks(kb_id=:unset, knowledge_id=:unset)
+                    if kb_id.nil?
+                        raise ArgumentError, 'kb_id cannot be nil'
+                    end
+                    if knowledge_id.nil?
+                        raise ArgumentError, 'knowledge_id cannot be nil'
+                    end
+
+                    if kb_id == :unset && knowledge_id == :unset
+                        @chunks ||= ChunkList.new self
+                    elsif kb_id != :unset && knowledge_id == :unset
+                        ChunkList.new(self, kb_id: kb_id)
+                    else
+                        ChunkList.new(self, kb_id: kb_id, knowledge_id: knowledge_id)
+                    end
+                end
+                ##
+                # @param [String] kb_id A unique Knowledge Base ID using Twilio Type ID (TTID) format
+                # @param [String] knowledge_id
+                # @return [Twilio::REST::Knowledge::V2::KnowledgeContext] if knowledge_id was passed.
+                # @return [Twilio::REST::Knowledge::V2::KnowledgeList]
+                def knowledge(kb_id=:unset, knowledge_id=:unset)
+                    if kb_id.nil?
+                        raise ArgumentError, 'kb_id cannot be nil'
+                    end
+                    if knowledge_id.nil?
+                        raise ArgumentError, 'knowledge_id cannot be nil'
+                    end
+
+                    if kb_id == :unset && knowledge_id == :unset
+                        @knowledge ||= KnowledgeList.new self
+                    elsif kb_id != :unset && knowledge_id == :unset
+                        KnowledgeList.new(self, kb_id: kb_id)
+                    else
+                        KnowledgeContext.new(self, kb_id, knowledge_id)
+                    end
+                end
+                ##
+                # @param [String] kb_id A unique Knowledge Base ID using Twilio Type ID (TTID) format
+                # @return [Twilio::REST::Knowledge::V2::KnowledgeBasisContext] if kbId was passed.
+                # @return [Twilio::REST::Knowledge::V2::KnowledgeBasisList]
+                def knowledge_bases(kb_id=:unset)
+                    if kb_id.nil?
+                        raise ArgumentError, 'kb_id cannot be nil'
+                    end
+
+                    if kb_id == :unset
+                        @knowledge_bases ||= KnowledgeBasisList.new self
+                    else
+                        KnowledgeBasisContext.new(self, kb_id)
+                    end
+                end
+                ##
+                # @param [String] operation_id The operation ID returned from a write endpoint.
+                # @return [Twilio::REST::Knowledge::V2::OperationContext] if operationId was passed.
+                # @return [Twilio::REST::Knowledge::V2::OperationList]
+                def operations(operation_id=:unset)
+                    if operation_id.nil?
+                        raise ArgumentError, 'operation_id cannot be nil'
+                    end
+
+                    if operation_id == :unset
+                        @operations ||= OperationList.new self
+                    else
+                        OperationContext.new(self, operation_id)
+                    end
+                end
+                ##
+                # @param [String] kb_id A unique Knowledge Base ID using Twilio Type ID (TTID) format
+                # @return [Twilio::REST::Knowledge::V2::SearchContext] if kbId was passed.
+                # @return [Twilio::REST::Knowledge::V2::SearchList]
+                def search(kb_id=:unset)
+                    if kb_id.nil?
+                        raise ArgumentError, 'kb_id cannot be nil'
+                    end
+
+                    if kb_id == :unset
+                        @search ||= SearchList.new self
+                    else
+                        SearchContext.new(self, kb_id)
+                    end
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::Knowledge::V2>';
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,6 @@
+module Twilio
+    module REST
+      class Knowledge < KnowledgeBase;
+      end
+    end
+end

data/lib/twilio-ruby/rest/knowledge_base.rb

@@ -0,0 +1,43 @@
+##
+ # This code was generated by
+ # ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ #  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ #  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ #
+ # NOTE: This class is auto generated by OpenAPI Generator.
+ # https://openapi-generator.tech
+ # Do not edit the class manually.
+# frozen_string_literal: true
+module Twilio
+  module REST
+    class KnowledgeBase < Domain
+      ##
+      # Initialize knowledge domain
+      #
+      # @param twilio - The twilio client
+      #
+      def initialize(twilio)
+        super(twilio)
+        @base_url =  "https://knowledge.twilio.com"
+        @host = "knowledge.twilio.com"
+        @port = 443
+        @v1 = nil
+        @v2 = nil
+      end
+
+      def v1
+        @v1 ||= Knowledge::V1.new self
+      end
+
+      def v2
+        @v2 ||= Knowledge::V2.new self
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '<Twilio::REST::Knowledge>';
+      end
+    end
+  end
+end