twilio-ruby 7.10.5 → 7.10.6

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

@@ -0,0 +1,714 @@
+##
+#    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 KnowledgeList < ListResource
+                
+                    class KnowledgeCore
+                            # @param [name]: [String] The name of the knowledge source.
+                            # @param [description]: [String] A detailed description of the knowledge source and when to use it.  This helps provide context about the content and its intended purpose.
+                            # @param [source]: [KnowledgeList.KnowledgeSourceTypes] 
+                        attr_accessor :name, :description, :source
+                        def initialize(payload)
+                                @name = payload["name"]
+                                @description = payload["description"]
+                                @source = payload["source"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "name": @name,
+                                "description": @description,
+                                "source": @source,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the KnowledgeList
+                    # @param [Version] version Version that contains the resource
+                    # @return [KnowledgeList] KnowledgeList
+                    def initialize(version, kb_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = { kb_id: kb_id }
+                        @uri = "/KnowledgeBases/#{@solution[:kb_id]}/Knowledge"
+                        
+                    end
+                    ##
+                    # Create the KnowledgeInstance
+                    # @param [KnowledgeCore] knowledge_core 
+                    # @return [KnowledgeInstance] Created KnowledgeInstance
+                    def create(knowledge_core: nil
+                    )
+
+                        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_core.to_json)
+                        KnowledgeInstance.new(
+                            @version,
+                            payload,
+                            kb_id: @solution[:kb_id],
+                        )
+                    end
+
+                    ##
+                    # Create the KnowledgeInstanceMetadata
+                    # @param [KnowledgeCore] knowledge_core 
+                    # @return [KnowledgeInstance] Created KnowledgeInstance
+                    def create_with_metadata(knowledge_core: 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_core.to_json)
+                        knowledge_instance = KnowledgeInstance.new(
+                            @version,
+                            response.body,
+                            kb_id: @solution[:kb_id],
+                        )
+                        KnowledgeInstanceMetadata.new(
+                            @version,
+                            knowledge_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+                    ##
+                    # Lists KnowledgeInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [String] page The page index. This value is simply for client state.
+                    # @param [String] page_token The token for the page of results to retrieve.
+                    # @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(page: :unset, page_token: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            page: page,
+                            page_token: page_token,
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @param [String] page The page index. This value is simply for client state.
+                    # @param [String] page_token The token for the page of results to retrieve.
+                    # @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 [Enumerable] Enumerable that will yield up to limit results
+                    def stream(page: :unset, page_token: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            page: page,
+                            page_token: page_token,
+                            page_size: limits[:page_size], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists KnowledgePageMetadata records from the API as a list.
+                      # @param [String] page The page index. This value is simply for client state.
+                      # @param [String] page_token The token for the page of results to retrieve.
+                    # @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(page: :unset, page_token: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'page' => page,
+                            'pageToken' => page_token,
+                            
+                            '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
+                    # is reached.
+                    def each
+                        limits = @version.read_limits
+
+                        page = self.page(page_size: limits[:page_size], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
+                    end
+
+                    ##
+                    # Retrieve a single page of KnowledgeInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] page The page index. This value is simply for client state.
+                    # @param [String] page_token The token for the page of results to retrieve.
+                    
+                    # @return [Page] Page of KnowledgeInstance
+                    def page(page: :unset, page_token: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'page' => page,
+                            'pageToken' => page_token,
+                                                        'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        KnowledgePage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of KnowledgeInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of KnowledgeInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    KnowledgePage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Knowledge.V2.KnowledgeList>'
+                    end
+                end
+
+
+                class KnowledgeContext < InstanceContext
+                    ##
+                    # Initialize the KnowledgeContext
+                    # @param [Version] version Version that contains the resource
+                    # @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 [KnowledgeContext] KnowledgeContext
+                    def initialize(version, kb_id, knowledge_id)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { kb_id: kb_id, knowledge_id: knowledge_id,  }
+                        @uri = "/KnowledgeBases/#{@solution[:kb_id]}/Knowledge/#{@solution[:knowledge_id]}"
+
+                        
+                    end
+                    ##
+                    # Delete the KnowledgeInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                        KnowledgeInstance.new(
+                          @version,
+                          response.body,
+                            kb_id: @solution[:kb_id],
+                            knowledge_id: @solution[:knowledge_id],
+                        )
+                        
+                    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
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        KnowledgeInstance.new(
+                            @version,
+                            payload,
+                            kb_id: @solution[:kb_id],
+                            knowledge_id: @solution[:knowledge_id],
+                        )
+                    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,
+                            kb_id: @solution[:kb_id],
+                            knowledge_id: @solution[:knowledge_id],
+                        )
+                        KnowledgeInstanceMetadata.new(
+                            @version,
+                            knowledge_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Update the KnowledgeInstance
+                    # @param [Boolean] refresh When true, re-queues processing for this knowledge resource. Idempotent while the resource is already QUEUED or PROCESSING.
+                    # @param [KnowledgeCore] knowledge_core 
+                    # @return [KnowledgeInstance] Updated KnowledgeInstance
+                    def update(
+                      refresh: :unset,
+                      knowledge_core: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'refresh' => refresh,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.update('PATCH', @uri, params: params, headers: headers, data: knowledge_core.to_json)
+                        KnowledgeInstance.new(
+                            @version,
+                            payload,
+                            kb_id: @solution[:kb_id],
+                            knowledge_id: @solution[:knowledge_id],
+                        )
+                    end
+
+                    ##
+                    # Update the KnowledgeInstanceMetadata
+                    # @param [Boolean] refresh When true, re-queues processing for this knowledge resource. Idempotent while the resource is already QUEUED or PROCESSING.
+                    # @param [KnowledgeCore] knowledge_core 
+                    # @return [KnowledgeInstance] Updated KnowledgeInstance
+                    def update_with_metadata(
+                      refresh: :unset,
+                    knowledge_core: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'refresh' => refresh,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('PATCH', @uri, params: params, headers: headers, data: knowledge_core.to_json)
+                        knowledge_instance = KnowledgeInstance.new(
+                            @version,
+                            response.body,
+                            kb_id: @solution[:kb_id],
+                            knowledge_id: @solution[:knowledge_id],
+                        )
+                        KnowledgeInstanceMetadata.new(
+                            @version,
+                            knowledge_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.KnowledgeContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Knowledge.V2.KnowledgeContext #{context}>"
+                    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 < TokenPage
+                    ##
+                    # Initialize the KnowledgePage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [KnowledgePage] KnowledgePage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of KnowledgeInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [KnowledgeInstance] KnowledgeInstance
+                    def get_instance(payload)
+                        KnowledgeInstance.new(@version, payload, kb_id: @solution[:kb_id])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Knowledge.V2.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::V2PageMetadata>';
+                    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
+                    # @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 Knowledge
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [KnowledgeInstance] KnowledgeInstance
+                    def initialize(version, payload , kb_id: nil, knowledge_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'name' => payload['name'],
+                            'description' => payload['description'],
+                            'source' => payload['source'],
+                            'id' => payload['id'],
+                            'status' => payload['status'],
+                            'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                            'updated_at' => Twilio.deserialize_iso8601_datetime(payload['updated_at']),
+                            'code' => payload['code'],
+                            'message' => payload['message'],
+                            'more_info' => payload['more_info'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'kb_id' => kb_id  || @properties['kb_id']  ,'knowledge_id' => knowledge_id  || @properties['knowledge_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 [KnowledgeContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = KnowledgeContext.new(@version , @params['kb_id'], @params['knowledge_id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The name of the knowledge source.
+                    def name
+                        @properties['name']
+                    end
+                    
+                    ##
+                    # @return [String] A detailed description of the knowledge source and when to use it.  This helps provide context about the content and its intended purpose.
+                    def description
+                        @properties['description']
+                    end
+                    
+                    ##
+                    # @return [KnowledgeSourceTypes] 
+                    def source
+                        @properties['source']
+                    end
+                    
+                    ##
+                    # @return [String] The unique identifier of knowledge source.
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] The status of processing the knowledge source ('SCHEDULED', 'QUEUED', 'PROCESSING', 'COMPLETED', 'FAILED').
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the Knowledge was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def created_at
+                        @properties['created_at']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the Knowledge was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def updated_at
+                        @properties['updated_at']
+                    end
+                    
+                    ##
+                    # @return [String] The Twilio error code.
+                    def code
+                        @properties['code']
+                    end
+                    
+                    ##
+                    # @return [String] A human readable message describing the error.
+                    def message
+                        @properties['message']
+                    end
+                    
+                    ##
+                    # @return [String] A URL to a [Twilio error directory](https://www.twilio.com/docs/api/errors) page with more information about the error code.
+                    def more_info
+                        @properties['more_info']
+                    end
+                    
+                    ##
+                    # Delete the KnowledgeInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the KnowledgeInstance
+                    # @return [KnowledgeInstance] Fetched KnowledgeInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Update the KnowledgeInstance
+                    # @param [Boolean] refresh When true, re-queues processing for this knowledge resource. Idempotent while the resource is already QUEUED or PROCESSING.
+                    # @param [KnowledgeCore] knowledge_core 
+                    # @return [KnowledgeInstance] Updated KnowledgeInstance
+                    def update(
+                      refresh: :unset,
+                      knowledge_core: :unset
+                    )
+
+                        context.update(
+                            refresh: refresh, 
+                            knowledge_core: knowledge_core, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Knowledge.V2.KnowledgeInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Knowledge.V2.KnowledgeInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end