Package com.mypurecloud.sdk.v2.api

Class KnowledgeApi

java.lang.Object
com.mypurecloud.sdk.v2.api.KnowledgeApi
public class KnowledgeApi extends Object

  • Constructor Details

    • KnowledgeApi

      public KnowledgeApi()

    • KnowledgeApi

      public KnowledgeApi(ApiClient apiClient)

  • Method Details

    • deleteKnowledgeConnection

      public ConnectionResponse deleteKnowledgeConnection(String connectionId) throws IOException, ApiException
      Delete connection
      Parameters:
      connectionId - Connection ID (required)
      Returns:
      ConnectionResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeConnectionWithHttpInfo

      public ApiResponse<ConnectionResponse> deleteKnowledgeConnectionWithHttpInfo(String connectionId) throws IOException
      Delete connection
      Parameters:
      connectionId - Connection ID (required)
      Returns:
      ConnectionResponse
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeConnection

      public ConnectionResponse deleteKnowledgeConnection(DeleteKnowledgeConnectionRequest request) throws IOException, ApiException
      Delete connection
      Parameters:
      request - The request object
      Returns:
      ConnectionResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeConnection

      public ApiResponse<ConnectionResponse> deleteKnowledgeConnection(ApiRequest<Void> request) throws IOException
      Delete connection
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebase

      public KnowledgeBase deleteKnowledgeKnowledgebase(String knowledgeBaseId) throws IOException, ApiException
      Delete knowledge base
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      Returns:
      KnowledgeBase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseWithHttpInfo

      public ApiResponse<KnowledgeBase> deleteKnowledgeKnowledgebaseWithHttpInfo(String knowledgeBaseId) throws IOException
      Delete knowledge base
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      Returns:
      KnowledgeBase
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebase

      public KnowledgeBase deleteKnowledgeKnowledgebase(DeleteKnowledgeKnowledgebaseRequest request) throws IOException, ApiException
      Delete knowledge base
      Parameters:
      request - The request object
      Returns:
      KnowledgeBase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebase

      public ApiResponse<KnowledgeBase> deleteKnowledgeKnowledgebase(ApiRequest<Void> request) throws IOException
      Delete knowledge base
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseCategory

      public CategoryResponse deleteKnowledgeKnowledgebaseCategory(String knowledgeBaseId, String categoryId) throws IOException, ApiException
      Delete category
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      categoryId - Category ID (required)
      Returns:
      CategoryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseCategoryWithHttpInfo

      public ApiResponse<CategoryResponse> deleteKnowledgeKnowledgebaseCategoryWithHttpInfo(String knowledgeBaseId, String categoryId) throws IOException
      Delete category
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      categoryId - Category ID (required)
      Returns:
      CategoryResponse
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseCategory

      public CategoryResponse deleteKnowledgeKnowledgebaseCategory(DeleteKnowledgeKnowledgebaseCategoryRequest request) throws IOException, ApiException
      Delete category
      Parameters:
      request - The request object
      Returns:
      CategoryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseCategory

      public ApiResponse<CategoryResponse> deleteKnowledgeKnowledgebaseCategory(ApiRequest<Void> request) throws IOException
      Delete category
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseDocument

      public void deleteKnowledgeKnowledgebaseDocument(String knowledgeBaseId, String documentId) throws IOException, ApiException
      Delete document.
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseDocumentWithHttpInfo

      public ApiResponse<Void> deleteKnowledgeKnowledgebaseDocumentWithHttpInfo(String knowledgeBaseId, String documentId) throws IOException
      Delete document.
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseDocument

      public void deleteKnowledgeKnowledgebaseDocument(DeleteKnowledgeKnowledgebaseDocumentRequest request) throws IOException, ApiException
      Delete document.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseDocument

      public ApiResponse<Void> deleteKnowledgeKnowledgebaseDocument(ApiRequest<Void> request) throws IOException
      Delete document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseDocumentVariation

      public void deleteKnowledgeKnowledgebaseDocumentVariation(String documentVariationId, String documentId, String knowledgeBaseId) throws IOException, ApiException
      Delete a variation for a document.
      Parameters:
      documentVariationId - Globally unique identifier for a document variation. (required)
      documentId - Globally unique identifier for a document. (required)
      knowledgeBaseId - Globally unique identifier for a knowledge base. (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseDocumentVariationWithHttpInfo

      public ApiResponse<Void> deleteKnowledgeKnowledgebaseDocumentVariationWithHttpInfo(String documentVariationId, String documentId, String knowledgeBaseId) throws IOException
      Delete a variation for a document.
      Parameters:
      documentVariationId - Globally unique identifier for a document variation. (required)
      documentId - Globally unique identifier for a document. (required)
      knowledgeBaseId - Globally unique identifier for a knowledge base. (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseDocumentVariation

      public void deleteKnowledgeKnowledgebaseDocumentVariation(DeleteKnowledgeKnowledgebaseDocumentVariationRequest request) throws IOException, ApiException
      Delete a variation for a document.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseDocumentVariation

      public ApiResponse<Void> deleteKnowledgeKnowledgebaseDocumentVariation(ApiRequest<Void> request) throws IOException
      Delete a variation for a document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseExportJob

      public void deleteKnowledgeKnowledgebaseExportJob(String knowledgeBaseId, String exportJobId) throws IOException, ApiException
      Delete export job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      exportJobId - Export job ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseExportJobWithHttpInfo

      public ApiResponse<Void> deleteKnowledgeKnowledgebaseExportJobWithHttpInfo(String knowledgeBaseId, String exportJobId) throws IOException
      Delete export job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      exportJobId - Export job ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseExportJob

      public void deleteKnowledgeKnowledgebaseExportJob(DeleteKnowledgeKnowledgebaseExportJobRequest request) throws IOException, ApiException
      Delete export job
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseExportJob

      public ApiResponse<Void> deleteKnowledgeKnowledgebaseExportJob(ApiRequest<Void> request) throws IOException
      Delete export job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseImportJob

      public void deleteKnowledgeKnowledgebaseImportJob(String knowledgeBaseId, String importJobId) throws IOException, ApiException
      Delete import job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      importJobId - Import job ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseImportJobWithHttpInfo

      public ApiResponse<Void> deleteKnowledgeKnowledgebaseImportJobWithHttpInfo(String knowledgeBaseId, String importJobId) throws IOException
      Delete import job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      importJobId - Import job ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseImportJob

      public void deleteKnowledgeKnowledgebaseImportJob(DeleteKnowledgeKnowledgebaseImportJobRequest request) throws IOException, ApiException
      Delete import job
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseImportJob

      public ApiResponse<Void> deleteKnowledgeKnowledgebaseImportJob(ApiRequest<Void> request) throws IOException
      Delete import job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseLabel

      public LabelResponse deleteKnowledgeKnowledgebaseLabel(String knowledgeBaseId, String labelId) throws IOException, ApiException
      Delete label
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      labelId - Label ID (required)
      Returns:
      LabelResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseLabelWithHttpInfo

      public ApiResponse<LabelResponse> deleteKnowledgeKnowledgebaseLabelWithHttpInfo(String knowledgeBaseId, String labelId) throws IOException
      Delete label
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      labelId - Label ID (required)
      Returns:
      LabelResponse
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseLabel

      public LabelResponse deleteKnowledgeKnowledgebaseLabel(DeleteKnowledgeKnowledgebaseLabelRequest request) throws IOException, ApiException
      Delete label
      Parameters:
      request - The request object
      Returns:
      LabelResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseLabel

      public ApiResponse<LabelResponse> deleteKnowledgeKnowledgebaseLabel(ApiRequest<Void> request) throws IOException
      Delete label
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId

      public void deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(String knowledgeBaseId, String sourceId) throws IOException, ApiException
      Delete Salesforce Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseSourcesSalesforceSourceIdWithHttpInfo

      public ApiResponse<Void> deleteKnowledgeKnowledgebaseSourcesSalesforceSourceIdWithHttpInfo(String knowledgeBaseId, String sourceId) throws IOException
      Delete Salesforce Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId

      public void deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(DeleteKnowledgeKnowledgebaseSourcesSalesforceSourceIdRequest request) throws IOException, ApiException
      Delete Salesforce Knowledge integration source
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId

      public ApiResponse<Void> deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(ApiRequest<Void> request) throws IOException
      Delete Salesforce Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseSourcesServicenowSourceId

      public void deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(String knowledgeBaseId, String sourceId) throws IOException, ApiException
      Delete ServiceNow Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseSourcesServicenowSourceIdWithHttpInfo

      public ApiResponse<Void> deleteKnowledgeKnowledgebaseSourcesServicenowSourceIdWithHttpInfo(String knowledgeBaseId, String sourceId) throws IOException
      Delete ServiceNow Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseSourcesServicenowSourceId

      public void deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(DeleteKnowledgeKnowledgebaseSourcesServicenowSourceIdRequest request) throws IOException, ApiException
      Delete ServiceNow Knowledge integration source
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseSourcesServicenowSourceId

      public ApiResponse<Void> deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(ApiRequest<Void> request) throws IOException
      Delete ServiceNow Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseSynchronizeJob

      public void deleteKnowledgeKnowledgebaseSynchronizeJob(String knowledgeBaseId, String syncJobId) throws IOException, ApiException
      Delete synchronization job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      syncJobId - Synchronization job ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseSynchronizeJobWithHttpInfo

      public ApiResponse<Void> deleteKnowledgeKnowledgebaseSynchronizeJobWithHttpInfo(String knowledgeBaseId, String syncJobId) throws IOException
      Delete synchronization job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      syncJobId - Synchronization job ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseSynchronizeJob

      public void deleteKnowledgeKnowledgebaseSynchronizeJob(DeleteKnowledgeKnowledgebaseSynchronizeJobRequest request) throws IOException, ApiException
      Delete synchronization job
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeKnowledgebaseSynchronizeJob

      public ApiResponse<Void> deleteKnowledgeKnowledgebaseSynchronizeJob(ApiRequest<Void> request) throws IOException
      Delete synchronization job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeSetting

      public void deleteKnowledgeSetting(String knowledgeSettingId) throws IOException, ApiException
      Delete Knowledge setting.
      Parameters:
      knowledgeSettingId - Knowledge Setting ID. (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeSettingWithHttpInfo

      public ApiResponse<Void> deleteKnowledgeSettingWithHttpInfo(String knowledgeSettingId) throws IOException
      Delete Knowledge setting.
      Parameters:
      knowledgeSettingId - Knowledge Setting ID. (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeSetting

      public void deleteKnowledgeSetting(DeleteKnowledgeSettingRequest request) throws IOException, ApiException
      Delete Knowledge setting.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeSetting

      public ApiResponse<Void> deleteKnowledgeSetting(ApiRequest<Void> request) throws IOException
      Delete Knowledge setting.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeSource

      public void deleteKnowledgeSource(String sourceId) throws IOException, ApiException
      Delete source
      Parameters:
      sourceId - Source ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeSourceWithHttpInfo

      public ApiResponse<Void> deleteKnowledgeSourceWithHttpInfo(String sourceId) throws IOException
      Delete source
      Parameters:
      sourceId - Source ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteKnowledgeSource

      public void deleteKnowledgeSource(DeleteKnowledgeSourceRequest request) throws IOException, ApiException
      Delete source
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteKnowledgeSource

      public ApiResponse<Void> deleteKnowledgeSource(ApiRequest<Void> request) throws IOException
      Delete source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeConnection

      public ConnectionResponse getKnowledgeConnection(String connectionId, List<String> expand) throws IOException, ApiException
      Get connection
      Parameters:
      connectionId - Connection ID (required)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      Returns:
      ConnectionResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeConnectionWithHttpInfo

      public ApiResponse<ConnectionResponse> getKnowledgeConnectionWithHttpInfo(String connectionId, List<String> expand) throws IOException
      Get connection
      Parameters:
      connectionId - Connection ID (required)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      Returns:
      ConnectionResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeConnection

      public ConnectionResponse getKnowledgeConnection(GetKnowledgeConnectionRequest request) throws IOException, ApiException
      Get connection
      Parameters:
      request - The request object
      Returns:
      ConnectionResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeConnection

      public ApiResponse<ConnectionResponse> getKnowledgeConnection(ApiRequest<Void> request) throws IOException
      Get connection
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeConnectionOptions

      public ConnectionOptionListing getKnowledgeConnectionOptions(String connectionId, String after, String pageSize, String parentId) throws IOException, ApiException
      Get connection options
      Parameters:
      connectionId - Connection ID (required)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of results per page. Minimum: 25, Maximum: 500. (optional, default to 200)
      parentId - The id of the parent option whose children to be listed. (optional)
      Returns:
      ConnectionOptionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeConnectionOptionsWithHttpInfo

      public ApiResponse<ConnectionOptionListing> getKnowledgeConnectionOptionsWithHttpInfo(String connectionId, String after, String pageSize, String parentId) throws IOException
      Get connection options
      Parameters:
      connectionId - Connection ID (required)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of results per page. Minimum: 25, Maximum: 500. (optional, default to 200)
      parentId - The id of the parent option whose children to be listed. (optional)
      Returns:
      ConnectionOptionListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeConnectionOptions

      public ConnectionOptionListing getKnowledgeConnectionOptions(GetKnowledgeConnectionOptionsRequest request) throws IOException, ApiException
      Get connection options
      Parameters:
      request - The request object
      Returns:
      ConnectionOptionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeConnectionOptions

      public ApiResponse<ConnectionOptionListing> getKnowledgeConnectionOptions(ApiRequest<Void> request) throws IOException
      Get connection options
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeConnections

      public ConnectionListing getKnowledgeConnections() throws IOException, ApiException
      Get connections
      Returns:
      ConnectionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeConnectionsWithHttpInfo

      public ApiResponse<ConnectionListing> getKnowledgeConnectionsWithHttpInfo() throws IOException
      Get connections
      Returns:
      ConnectionListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeConnections

      public ConnectionListing getKnowledgeConnections(GetKnowledgeConnectionsRequest request) throws IOException, ApiException
      Get connections
      Parameters:
      request - The request object
      Returns:
      ConnectionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeConnections

      public ApiResponse<ConnectionListing> getKnowledgeConnections(ApiRequest<Void> request) throws IOException
      Get connections
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeGuestSessionCategories

      public GuestCategoryResponseListing getKnowledgeGuestSessionCategories(String sessionId, String before, String after, String pageSize, String parentId, Boolean isRoot, String name, String sortBy, String expand, Boolean includeDocumentCount) throws IOException, ApiException
      Get categories
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      parentId - If specified, retrieves the children categories by parent category ID. (optional)
      isRoot - If specified, retrieves only the root categories. (optional)
      name - Filter to return the categories that starts with the given category name. (optional)
      sortBy - Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (optional, default to Name)
      expand - The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors. (optional)
      includeDocumentCount - If specified, retrieves the number of documents related to category. (optional)
      Returns:
      GuestCategoryResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeGuestSessionCategoriesWithHttpInfo

      public ApiResponse<GuestCategoryResponseListing> getKnowledgeGuestSessionCategoriesWithHttpInfo(String sessionId, String before, String after, String pageSize, String parentId, Boolean isRoot, String name, String sortBy, String expand, Boolean includeDocumentCount) throws IOException
      Get categories
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      parentId - If specified, retrieves the children categories by parent category ID. (optional)
      isRoot - If specified, retrieves only the root categories. (optional)
      name - Filter to return the categories that starts with the given category name. (optional)
      sortBy - Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (optional, default to Name)
      expand - The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors. (optional)
      includeDocumentCount - If specified, retrieves the number of documents related to category. (optional)
      Returns:
      GuestCategoryResponseListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeGuestSessionCategories

      public GuestCategoryResponseListing getKnowledgeGuestSessionCategories(GetKnowledgeGuestSessionCategoriesRequest request) throws IOException, ApiException
      Get categories
      Parameters:
      request - The request object
      Returns:
      GuestCategoryResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeGuestSessionCategories

      public ApiResponse<GuestCategoryResponseListing> getKnowledgeGuestSessionCategories(ApiRequest<Void> request) throws IOException
      Get categories
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeGuestSessionDocument

      public KnowledgeGuestDocumentResponse getKnowledgeGuestSessionDocument(String sessionId, String documentId) throws IOException, ApiException
      Get a knowledge document by ID.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      documentId - Document ID (required)
      Returns:
      KnowledgeGuestDocumentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeGuestSessionDocumentWithHttpInfo

      public ApiResponse<KnowledgeGuestDocumentResponse> getKnowledgeGuestSessionDocumentWithHttpInfo(String sessionId, String documentId) throws IOException
      Get a knowledge document by ID.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      documentId - Document ID (required)
      Returns:
      KnowledgeGuestDocumentResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeGuestSessionDocument

      public KnowledgeGuestDocumentResponse getKnowledgeGuestSessionDocument(GetKnowledgeGuestSessionDocumentRequest request) throws IOException, ApiException
      Get a knowledge document by ID.
      Parameters:
      request - The request object
      Returns:
      KnowledgeGuestDocumentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeGuestSessionDocument

      public ApiResponse<KnowledgeGuestDocumentResponse> getKnowledgeGuestSessionDocument(ApiRequest<Void> request) throws IOException
      Get a knowledge document by ID.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeGuestSessionDocuments

      public KnowledgeGuestDocumentResponseListing getKnowledgeGuestSessionDocuments(String sessionId, List<String> categoryId, Integer pageSize) throws IOException, ApiException
      Get documents.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      categoryId - If specified, retrieves documents associated with category ids, comma separated values expected. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      Returns:
      KnowledgeGuestDocumentResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeGuestSessionDocumentsWithHttpInfo

      public ApiResponse<KnowledgeGuestDocumentResponseListing> getKnowledgeGuestSessionDocumentsWithHttpInfo(String sessionId, List<String> categoryId, Integer pageSize) throws IOException
      Get documents.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      categoryId - If specified, retrieves documents associated with category ids, comma separated values expected. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      Returns:
      KnowledgeGuestDocumentResponseListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeGuestSessionDocuments

      public KnowledgeGuestDocumentResponseListing getKnowledgeGuestSessionDocuments(GetKnowledgeGuestSessionDocumentsRequest request) throws IOException, ApiException
      Get documents.
      Parameters:
      request - The request object
      Returns:
      KnowledgeGuestDocumentResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeGuestSessionDocuments

      public ApiResponse<KnowledgeGuestDocumentResponseListing> getKnowledgeGuestSessionDocuments(ApiRequest<Void> request) throws IOException
      Get documents.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeIntegrationOptions

      public KnowledgeIntegrationOptionsResponse getKnowledgeIntegrationOptions(String integrationId, List<String> knowledgeBaseIds) throws IOException, ApiException
      Get sync options available for a knowledge-connect integration
      Parameters:
      integrationId - Integration ID (required)
      knowledgeBaseIds - Narrowing down filtering option results by knowledge base. (optional)
      Returns:
      KnowledgeIntegrationOptionsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeIntegrationOptionsWithHttpInfo

      public ApiResponse<KnowledgeIntegrationOptionsResponse> getKnowledgeIntegrationOptionsWithHttpInfo(String integrationId, List<String> knowledgeBaseIds) throws IOException
      Get sync options available for a knowledge-connect integration
      Parameters:
      integrationId - Integration ID (required)
      knowledgeBaseIds - Narrowing down filtering option results by knowledge base. (optional)
      Returns:
      KnowledgeIntegrationOptionsResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeIntegrationOptions

      public KnowledgeIntegrationOptionsResponse getKnowledgeIntegrationOptions(GetKnowledgeIntegrationOptionsRequest request) throws IOException, ApiException
      Get sync options available for a knowledge-connect integration
      Parameters:
      request - The request object
      Returns:
      KnowledgeIntegrationOptionsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeIntegrationOptions

      public ApiResponse<KnowledgeIntegrationOptionsResponse> getKnowledgeIntegrationOptions(ApiRequest<Void> request) throws IOException
      Get sync options available for a knowledge-connect integration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebase

      public KnowledgeBase getKnowledgeKnowledgebase(String knowledgeBaseId) throws IOException, ApiException
      Get knowledge base
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      Returns:
      KnowledgeBase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseWithHttpInfo

      public ApiResponse<KnowledgeBase> getKnowledgeKnowledgebaseWithHttpInfo(String knowledgeBaseId) throws IOException
      Get knowledge base
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      Returns:
      KnowledgeBase
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebase

      public KnowledgeBase getKnowledgeKnowledgebase(GetKnowledgeKnowledgebaseRequest request) throws IOException, ApiException
      Get knowledge base
      Parameters:
      request - The request object
      Returns:
      KnowledgeBase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebase

      public ApiResponse<KnowledgeBase> getKnowledgeKnowledgebase(ApiRequest<Void> request) throws IOException
      Get knowledge base
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseCategories

      public CategoryResponseListing getKnowledgeKnowledgebaseCategories(String knowledgeBaseId, String before, String after, String pageSize, String parentId, Boolean isRoot, String name, String sortBy, String expand, Boolean includeDocumentCount) throws IOException, ApiException
      Get categories
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      parentId - If specified, retrieves the children categories by parent category ID. (optional)
      isRoot - If specified, retrieves only the root categories. (optional)
      name - Filter to return the categories that starts with the given category name. (optional)
      sortBy - Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (optional, default to Name)
      expand - The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors. (optional)
      includeDocumentCount - If specified, retrieves the number of documents related to category. (optional)
      Returns:
      CategoryResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseCategoriesWithHttpInfo

      public ApiResponse<CategoryResponseListing> getKnowledgeKnowledgebaseCategoriesWithHttpInfo(String knowledgeBaseId, String before, String after, String pageSize, String parentId, Boolean isRoot, String name, String sortBy, String expand, Boolean includeDocumentCount) throws IOException
      Get categories
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      parentId - If specified, retrieves the children categories by parent category ID. (optional)
      isRoot - If specified, retrieves only the root categories. (optional)
      name - Filter to return the categories that starts with the given category name. (optional)
      sortBy - Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (optional, default to Name)
      expand - The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors. (optional)
      includeDocumentCount - If specified, retrieves the number of documents related to category. (optional)
      Returns:
      CategoryResponseListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseCategories

      public CategoryResponseListing getKnowledgeKnowledgebaseCategories(GetKnowledgeKnowledgebaseCategoriesRequest request) throws IOException, ApiException
      Get categories
      Parameters:
      request - The request object
      Returns:
      CategoryResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseCategories

      public ApiResponse<CategoryResponseListing> getKnowledgeKnowledgebaseCategories(ApiRequest<Void> request) throws IOException
      Get categories
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseCategory

      public CategoryResponse getKnowledgeKnowledgebaseCategory(String knowledgeBaseId, String categoryId) throws IOException, ApiException
      Get category
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      categoryId - Category ID (required)
      Returns:
      CategoryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseCategoryWithHttpInfo

      public ApiResponse<CategoryResponse> getKnowledgeKnowledgebaseCategoryWithHttpInfo(String knowledgeBaseId, String categoryId) throws IOException
      Get category
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      categoryId - Category ID (required)
      Returns:
      CategoryResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseCategory

      public CategoryResponse getKnowledgeKnowledgebaseCategory(GetKnowledgeKnowledgebaseCategoryRequest request) throws IOException, ApiException
      Get category
      Parameters:
      request - The request object
      Returns:
      CategoryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseCategory

      public ApiResponse<CategoryResponse> getKnowledgeKnowledgebaseCategory(ApiRequest<Void> request) throws IOException
      Get category
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocument

      public KnowledgeDocumentResponse getKnowledgeKnowledgebaseDocument(String knowledgeBaseId, String documentId, List<String> expand, String state) throws IOException, ApiException
      Get document.
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      expand - The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20. (optional)
      state - \"when state is \"Draft\", draft version of the document is returned,otherwise by default published version is returned in the response. (optional)
      Returns:
      KnowledgeDocumentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentWithHttpInfo

      public ApiResponse<KnowledgeDocumentResponse> getKnowledgeKnowledgebaseDocumentWithHttpInfo(String knowledgeBaseId, String documentId, List<String> expand, String state) throws IOException
      Get document.
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      expand - The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20. (optional)
      state - \"when state is \"Draft\", draft version of the document is returned,otherwise by default published version is returned in the response. (optional)
      Returns:
      KnowledgeDocumentResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocument

      public KnowledgeDocumentResponse getKnowledgeKnowledgebaseDocument(GetKnowledgeKnowledgebaseDocumentRequest request) throws IOException, ApiException
      Get document.
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocument

      public ApiResponse<KnowledgeDocumentResponse> getKnowledgeKnowledgebaseDocument(ApiRequest<Void> request) throws IOException
      Get document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentFeedback

      public KnowledgeDocumentFeedbackResponseListing getKnowledgeKnowledgebaseDocumentFeedback(String knowledgeBaseId, String documentId, String before, String after, String pageSize, Boolean onlyCommented, String documentVersionId, String documentVariationId, String appType, String queryType, String userId, String queueId, String state) throws IOException, ApiException
      Get a list of feedback records given on a document
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      onlyCommented - If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false. (optional)
      documentVersionId - Document version ID to filter by. Supported only if onlyCommented=true is set. (optional)
      documentVariationId - Document variation ID to filter by. Supported only if onlyCommented=true is set. (optional)
      appType - Application type to filter by. Supported only if onlyCommented=true is set. (optional)
      queryType - Query type to filter by. Supported only if onlyCommented=true is set. (optional)
      userId - The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set. (optional)
      queueId - Queue ID to filter by. Supported only if onlyCommented=true is set. (optional)
      state - State to filter by. Supported only if onlyCommented=true is set. Default: Final (optional)
      Returns:
      KnowledgeDocumentFeedbackResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentFeedbackWithHttpInfo

      public ApiResponse<KnowledgeDocumentFeedbackResponseListing> getKnowledgeKnowledgebaseDocumentFeedbackWithHttpInfo(String knowledgeBaseId, String documentId, String before, String after, String pageSize, Boolean onlyCommented, String documentVersionId, String documentVariationId, String appType, String queryType, String userId, String queueId, String state) throws IOException
      Get a list of feedback records given on a document
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      onlyCommented - If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false. (optional)
      documentVersionId - Document version ID to filter by. Supported only if onlyCommented=true is set. (optional)
      documentVariationId - Document variation ID to filter by. Supported only if onlyCommented=true is set. (optional)
      appType - Application type to filter by. Supported only if onlyCommented=true is set. (optional)
      queryType - Query type to filter by. Supported only if onlyCommented=true is set. (optional)
      userId - The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set. (optional)
      queueId - Queue ID to filter by. Supported only if onlyCommented=true is set. (optional)
      state - State to filter by. Supported only if onlyCommented=true is set. Default: Final (optional)
      Returns:
      KnowledgeDocumentFeedbackResponseListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentFeedback

      public KnowledgeDocumentFeedbackResponseListing getKnowledgeKnowledgebaseDocumentFeedback(GetKnowledgeKnowledgebaseDocumentFeedbackRequest request) throws IOException, ApiException
      Get a list of feedback records given on a document
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentFeedbackResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentFeedback

      public ApiResponse<KnowledgeDocumentFeedbackResponseListing> getKnowledgeKnowledgebaseDocumentFeedback(ApiRequest<Void> request) throws IOException
      Get a list of feedback records given on a document
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId

      public KnowledgeDocumentFeedbackResponse getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(String knowledgeBaseId, String documentId, String feedbackId) throws IOException, ApiException
      Get a single feedback record given on a document
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      feedbackId - Feedback ID. (required)
      Returns:
      KnowledgeDocumentFeedbackResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentFeedbackFeedbackIdWithHttpInfo

      public ApiResponse<KnowledgeDocumentFeedbackResponse> getKnowledgeKnowledgebaseDocumentFeedbackFeedbackIdWithHttpInfo(String knowledgeBaseId, String documentId, String feedbackId) throws IOException
      Get a single feedback record given on a document
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      feedbackId - Feedback ID. (required)
      Returns:
      KnowledgeDocumentFeedbackResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId

      public KnowledgeDocumentFeedbackResponse getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(GetKnowledgeKnowledgebaseDocumentFeedbackFeedbackIdRequest request) throws IOException, ApiException
      Get a single feedback record given on a document
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentFeedbackResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId

      public ApiResponse<KnowledgeDocumentFeedbackResponse> getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(ApiRequest<Void> request) throws IOException
      Get a single feedback record given on a document
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVariation

      public DocumentVariationResponse getKnowledgeKnowledgebaseDocumentVariation(String documentVariationId, String documentId, String knowledgeBaseId, String documentState, List<String> expand) throws IOException, ApiException
      Get a variation for a document.
      Parameters:
      documentVariationId - Globally unique identifier for a document variation. (required)
      documentId - Globally unique identifier for a document. (required)
      knowledgeBaseId - Globally unique identifier for a knowledge base. (required)
      documentState - The state of the document. (optional)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      Returns:
      DocumentVariationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVariationWithHttpInfo

      public ApiResponse<DocumentVariationResponse> getKnowledgeKnowledgebaseDocumentVariationWithHttpInfo(String documentVariationId, String documentId, String knowledgeBaseId, String documentState, List<String> expand) throws IOException
      Get a variation for a document.
      Parameters:
      documentVariationId - Globally unique identifier for a document variation. (required)
      documentId - Globally unique identifier for a document. (required)
      knowledgeBaseId - Globally unique identifier for a knowledge base. (required)
      documentState - The state of the document. (optional)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      Returns:
      DocumentVariationResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVariation

      public DocumentVariationResponse getKnowledgeKnowledgebaseDocumentVariation(GetKnowledgeKnowledgebaseDocumentVariationRequest request) throws IOException, ApiException
      Get a variation for a document.
      Parameters:
      request - The request object
      Returns:
      DocumentVariationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVariation

      public ApiResponse<DocumentVariationResponse> getKnowledgeKnowledgebaseDocumentVariation(ApiRequest<Void> request) throws IOException
      Get a variation for a document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVariations

      public DocumentVariationResponseListing getKnowledgeKnowledgebaseDocumentVariations(String knowledgeBaseId, String documentId, String before, String after, String pageSize, String documentState, List<String> expand) throws IOException, ApiException
      Get variations for a document.
      Parameters:
      knowledgeBaseId - Globally unique identifier for the knowledge base. (required)
      documentId - Globally unique identifier for the document. (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      documentState - The state of the document. (optional)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      Returns:
      DocumentVariationResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVariationsWithHttpInfo

      public ApiResponse<DocumentVariationResponseListing> getKnowledgeKnowledgebaseDocumentVariationsWithHttpInfo(String knowledgeBaseId, String documentId, String before, String after, String pageSize, String documentState, List<String> expand) throws IOException
      Get variations for a document.
      Parameters:
      knowledgeBaseId - Globally unique identifier for the knowledge base. (required)
      documentId - Globally unique identifier for the document. (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      documentState - The state of the document. (optional)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      Returns:
      DocumentVariationResponseListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVariations

      public DocumentVariationResponseListing getKnowledgeKnowledgebaseDocumentVariations(GetKnowledgeKnowledgebaseDocumentVariationsRequest request) throws IOException, ApiException
      Get variations for a document.
      Parameters:
      request - The request object
      Returns:
      DocumentVariationResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVariations

      public ApiResponse<DocumentVariationResponseListing> getKnowledgeKnowledgebaseDocumentVariations(ApiRequest<Void> request) throws IOException
      Get variations for a document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersion

      public KnowledgeDocumentVersion getKnowledgeKnowledgebaseDocumentVersion(String knowledgeBaseId, String documentId, String versionId, List<String> expand) throws IOException, ApiException
      Get document version.
      Parameters:
      knowledgeBaseId - Globally unique identifier for the knowledge base. (required)
      documentId - Globally unique identifier for the document. (required)
      versionId - Globally unique identifier for the document version. (required)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      Returns:
      KnowledgeDocumentVersion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersionWithHttpInfo

      public ApiResponse<KnowledgeDocumentVersion> getKnowledgeKnowledgebaseDocumentVersionWithHttpInfo(String knowledgeBaseId, String documentId, String versionId, List<String> expand) throws IOException
      Get document version.
      Parameters:
      knowledgeBaseId - Globally unique identifier for the knowledge base. (required)
      documentId - Globally unique identifier for the document. (required)
      versionId - Globally unique identifier for the document version. (required)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      Returns:
      KnowledgeDocumentVersion
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersion

      public KnowledgeDocumentVersion getKnowledgeKnowledgebaseDocumentVersion(GetKnowledgeKnowledgebaseDocumentVersionRequest request) throws IOException, ApiException
      Get document version.
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentVersion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersion

      public ApiResponse<KnowledgeDocumentVersion> getKnowledgeKnowledgebaseDocumentVersion(ApiRequest<Void> request) throws IOException
      Get document version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersionVariation

      public KnowledgeDocumentVersionVariation getKnowledgeKnowledgebaseDocumentVersionVariation(String knowledgeBaseId, String documentId, String versionId, String variationId) throws IOException, ApiException
      Get variation for the given document version.
      Parameters:
      knowledgeBaseId - Globally unique identifier for the knowledge base. (required)
      documentId - Globally unique identifier for the document. (required)
      versionId - Globally unique identifier for the document version. (required)
      variationId - Globally unique identifier for the document version variation. (required)
      Returns:
      KnowledgeDocumentVersionVariation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersionVariationWithHttpInfo

      public ApiResponse<KnowledgeDocumentVersionVariation> getKnowledgeKnowledgebaseDocumentVersionVariationWithHttpInfo(String knowledgeBaseId, String documentId, String versionId, String variationId) throws IOException
      Get variation for the given document version.
      Parameters:
      knowledgeBaseId - Globally unique identifier for the knowledge base. (required)
      documentId - Globally unique identifier for the document. (required)
      versionId - Globally unique identifier for the document version. (required)
      variationId - Globally unique identifier for the document version variation. (required)
      Returns:
      KnowledgeDocumentVersionVariation
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersionVariation

      public KnowledgeDocumentVersionVariation getKnowledgeKnowledgebaseDocumentVersionVariation(GetKnowledgeKnowledgebaseDocumentVersionVariationRequest request) throws IOException, ApiException
      Get variation for the given document version.
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentVersionVariation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersionVariation

      public ApiResponse<KnowledgeDocumentVersionVariation> getKnowledgeKnowledgebaseDocumentVersionVariation(ApiRequest<Void> request) throws IOException
      Get variation for the given document version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersionVariations

      public KnowledgeDocumentVersionVariationListing getKnowledgeKnowledgebaseDocumentVersionVariations(String knowledgeBaseId, String documentId, String versionId, String before, String after, String pageSize) throws IOException, ApiException
      Get variations for the given document version.
      Parameters:
      knowledgeBaseId - Globally unique identifier for the knowledge base. (required)
      documentId - Globally unique identifier for the document. (required)
      versionId - Globally unique identifier for the document version. (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      Returns:
      KnowledgeDocumentVersionVariationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersionVariationsWithHttpInfo

      public ApiResponse<KnowledgeDocumentVersionVariationListing> getKnowledgeKnowledgebaseDocumentVersionVariationsWithHttpInfo(String knowledgeBaseId, String documentId, String versionId, String before, String after, String pageSize) throws IOException
      Get variations for the given document version.
      Parameters:
      knowledgeBaseId - Globally unique identifier for the knowledge base. (required)
      documentId - Globally unique identifier for the document. (required)
      versionId - Globally unique identifier for the document version. (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      Returns:
      KnowledgeDocumentVersionVariationListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersionVariations

      public KnowledgeDocumentVersionVariationListing getKnowledgeKnowledgebaseDocumentVersionVariations(GetKnowledgeKnowledgebaseDocumentVersionVariationsRequest request) throws IOException, ApiException
      Get variations for the given document version.
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentVersionVariationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersionVariations

      public ApiResponse<KnowledgeDocumentVersionVariationListing> getKnowledgeKnowledgebaseDocumentVersionVariations(ApiRequest<Void> request) throws IOException
      Get variations for the given document version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersions

      public KnowledgeDocumentVersionListing getKnowledgeKnowledgebaseDocumentVersions(String knowledgeBaseId, String documentId, String before, String after, String pageSize, List<String> expand) throws IOException, ApiException
      Get document versions.
      Parameters:
      knowledgeBaseId - Globally unique identifier for the knowledge base. (required)
      documentId - Globally unique identifier for the document. (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      Returns:
      KnowledgeDocumentVersionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersionsWithHttpInfo

      public ApiResponse<KnowledgeDocumentVersionListing> getKnowledgeKnowledgebaseDocumentVersionsWithHttpInfo(String knowledgeBaseId, String documentId, String before, String after, String pageSize, List<String> expand) throws IOException
      Get document versions.
      Parameters:
      knowledgeBaseId - Globally unique identifier for the knowledge base. (required)
      documentId - Globally unique identifier for the document. (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      Returns:
      KnowledgeDocumentVersionListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersions

      public KnowledgeDocumentVersionListing getKnowledgeKnowledgebaseDocumentVersions(GetKnowledgeKnowledgebaseDocumentVersionsRequest request) throws IOException, ApiException
      Get document versions.
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentVersionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentVersions

      public ApiResponse<KnowledgeDocumentVersionListing> getKnowledgeKnowledgebaseDocumentVersions(ApiRequest<Void> request) throws IOException
      Get document versions.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocuments

      public KnowledgeDocumentResponseListing getKnowledgeKnowledgebaseDocuments(String knowledgeBaseId, String before, String after, String pageSize, String interval, List<String> documentId, List<String> categoryId, Boolean includeSubcategories, Boolean includeDrafts, List<String> labelIds, List<String> expand, List<String> externalIds) throws IOException, ApiException
      Get documents.
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      interval - Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ (optional)
      documentId - Retrieves the specified documents, comma separated values expected. (optional)
      categoryId - If specified, retrieves documents associated with category ids, comma separated values expected. (optional)
      includeSubcategories - Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories. (optional)
      includeDrafts - If includeDrafts is true, Documents in the draft state are also returned in the response. (optional)
      labelIds - If specified, retrieves documents associated with label ids, comma separated values expected. (optional)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      externalIds - If specified, retrieves documents associated with external ids, comma separated values expected. (optional)
      Returns:
      KnowledgeDocumentResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentsWithHttpInfo

      public ApiResponse<KnowledgeDocumentResponseListing> getKnowledgeKnowledgebaseDocumentsWithHttpInfo(String knowledgeBaseId, String before, String after, String pageSize, String interval, List<String> documentId, List<String> categoryId, Boolean includeSubcategories, Boolean includeDrafts, List<String> labelIds, List<String> expand, List<String> externalIds) throws IOException
      Get documents.
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      interval - Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ (optional)
      documentId - Retrieves the specified documents, comma separated values expected. (optional)
      categoryId - If specified, retrieves documents associated with category ids, comma separated values expected. (optional)
      includeSubcategories - Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories. (optional)
      includeDrafts - If includeDrafts is true, Documents in the draft state are also returned in the response. (optional)
      labelIds - If specified, retrieves documents associated with label ids, comma separated values expected. (optional)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      externalIds - If specified, retrieves documents associated with external ids, comma separated values expected. (optional)
      Returns:
      KnowledgeDocumentResponseListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocuments

      public KnowledgeDocumentResponseListing getKnowledgeKnowledgebaseDocuments(GetKnowledgeKnowledgebaseDocumentsRequest request) throws IOException, ApiException
      Get documents.
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocuments

      public ApiResponse<KnowledgeDocumentResponseListing> getKnowledgeKnowledgebaseDocuments(ApiRequest<Void> request) throws IOException
      Get documents.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentsFeedback

      public KnowledgeDocumentFeedbackResponseListing getKnowledgeKnowledgebaseDocumentsFeedback(String knowledgeBaseId, String before, String after, String pageSize, Boolean onlyCommented, String documentVersionId, String documentVariationId, String appType, String queryType, String userId, String queueId, String state) throws IOException, ApiException
      Get a list of feedback records given on documents in a knowledge base
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      onlyCommented - If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false. (optional)
      documentVersionId - Document version ID to filter by. Supported only if onlyCommented=true is set. (optional)
      documentVariationId - Document variation ID to filter by. Supported only if onlyCommented=true is set. (optional)
      appType - Application type to filter by. Supported only if onlyCommented=true is set. (optional)
      queryType - Query type to filter by. Supported only if onlyCommented=true is set. (optional)
      userId - The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set. (optional)
      queueId - Queue ID to filter by. Supported only if onlyCommented=true is set. (optional)
      state - State to filter by. Supported only if onlyCommented=true is set. Default: Final (optional)
      Returns:
      KnowledgeDocumentFeedbackResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentsFeedbackWithHttpInfo

      public ApiResponse<KnowledgeDocumentFeedbackResponseListing> getKnowledgeKnowledgebaseDocumentsFeedbackWithHttpInfo(String knowledgeBaseId, String before, String after, String pageSize, Boolean onlyCommented, String documentVersionId, String documentVariationId, String appType, String queryType, String userId, String queueId, String state) throws IOException
      Get a list of feedback records given on documents in a knowledge base
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      onlyCommented - If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false. (optional)
      documentVersionId - Document version ID to filter by. Supported only if onlyCommented=true is set. (optional)
      documentVariationId - Document variation ID to filter by. Supported only if onlyCommented=true is set. (optional)
      appType - Application type to filter by. Supported only if onlyCommented=true is set. (optional)
      queryType - Query type to filter by. Supported only if onlyCommented=true is set. (optional)
      userId - The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set. (optional)
      queueId - Queue ID to filter by. Supported only if onlyCommented=true is set. (optional)
      state - State to filter by. Supported only if onlyCommented=true is set. Default: Final (optional)
      Returns:
      KnowledgeDocumentFeedbackResponseListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentsFeedback

      public KnowledgeDocumentFeedbackResponseListing getKnowledgeKnowledgebaseDocumentsFeedback(GetKnowledgeKnowledgebaseDocumentsFeedbackRequest request) throws IOException, ApiException
      Get a list of feedback records given on documents in a knowledge base
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentFeedbackResponseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseDocumentsFeedback

      public ApiResponse<KnowledgeDocumentFeedbackResponseListing> getKnowledgeKnowledgebaseDocumentsFeedback(ApiRequest<Void> request) throws IOException
      Get a list of feedback records given on documents in a knowledge base
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseExportJob

      public KnowledgeExportJobResponse getKnowledgeKnowledgebaseExportJob(String knowledgeBaseId, String exportJobId) throws IOException, ApiException
      Get export job report
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      exportJobId - Export job ID (required)
      Returns:
      KnowledgeExportJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseExportJobWithHttpInfo

      public ApiResponse<KnowledgeExportJobResponse> getKnowledgeKnowledgebaseExportJobWithHttpInfo(String knowledgeBaseId, String exportJobId) throws IOException
      Get export job report
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      exportJobId - Export job ID (required)
      Returns:
      KnowledgeExportJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseExportJob

      public KnowledgeExportJobResponse getKnowledgeKnowledgebaseExportJob(GetKnowledgeKnowledgebaseExportJobRequest request) throws IOException, ApiException
      Get export job report
      Parameters:
      request - The request object
      Returns:
      KnowledgeExportJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseExportJob

      public ApiResponse<KnowledgeExportJobResponse> getKnowledgeKnowledgebaseExportJob(ApiRequest<Void> request) throws IOException
      Get export job report
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseImportJob

      public KnowledgeImportJobResponse getKnowledgeKnowledgebaseImportJob(String knowledgeBaseId, String importJobId, List<String> expand) throws IOException, ApiException
      Get import job report
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      importJobId - Import job ID (required)
      expand - If expand contains 'urls' downloadURL and failedEntitiesURL will be filled. (optional)
      Returns:
      KnowledgeImportJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseImportJobWithHttpInfo

      public ApiResponse<KnowledgeImportJobResponse> getKnowledgeKnowledgebaseImportJobWithHttpInfo(String knowledgeBaseId, String importJobId, List<String> expand) throws IOException
      Get import job report
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      importJobId - Import job ID (required)
      expand - If expand contains 'urls' downloadURL and failedEntitiesURL will be filled. (optional)
      Returns:
      KnowledgeImportJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseImportJob

      public KnowledgeImportJobResponse getKnowledgeKnowledgebaseImportJob(GetKnowledgeKnowledgebaseImportJobRequest request) throws IOException, ApiException
      Get import job report
      Parameters:
      request - The request object
      Returns:
      KnowledgeImportJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseImportJob

      public ApiResponse<KnowledgeImportJobResponse> getKnowledgeKnowledgebaseImportJob(ApiRequest<Void> request) throws IOException
      Get import job report
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseLabel

      public LabelResponse getKnowledgeKnowledgebaseLabel(String knowledgeBaseId, String labelId) throws IOException, ApiException
      Get label
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      labelId - Label ID (required)
      Returns:
      LabelResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseLabelWithHttpInfo

      public ApiResponse<LabelResponse> getKnowledgeKnowledgebaseLabelWithHttpInfo(String knowledgeBaseId, String labelId) throws IOException
      Get label
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      labelId - Label ID (required)
      Returns:
      LabelResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseLabel

      public LabelResponse getKnowledgeKnowledgebaseLabel(GetKnowledgeKnowledgebaseLabelRequest request) throws IOException, ApiException
      Get label
      Parameters:
      request - The request object
      Returns:
      LabelResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseLabel

      public ApiResponse<LabelResponse> getKnowledgeKnowledgebaseLabel(ApiRequest<Void> request) throws IOException
      Get label
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseLabels

      public LabelListing getKnowledgeKnowledgebaseLabels(String knowledgeBaseId, String before, String after, String pageSize, String name, Boolean includeDocumentCount) throws IOException, ApiException
      Get labels
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      name - Filter to return the labels that contains the given phrase in the name. (optional)
      includeDocumentCount - If specified, retrieves the number of documents related to label. (optional)
      Returns:
      LabelListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseLabelsWithHttpInfo

      public ApiResponse<LabelListing> getKnowledgeKnowledgebaseLabelsWithHttpInfo(String knowledgeBaseId, String before, String after, String pageSize, String name, Boolean includeDocumentCount) throws IOException
      Get labels
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      name - Filter to return the labels that contains the given phrase in the name. (optional)
      includeDocumentCount - If specified, retrieves the number of documents related to label. (optional)
      Returns:
      LabelListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseLabels

      public LabelListing getKnowledgeKnowledgebaseLabels(GetKnowledgeKnowledgebaseLabelsRequest request) throws IOException, ApiException
      Get labels
      Parameters:
      request - The request object
      Returns:
      LabelListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseLabels

      public ApiResponse<LabelListing> getKnowledgeKnowledgebaseLabels(ApiRequest<Void> request) throws IOException
      Get labels
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseOperations

      public OperationListing getKnowledgeKnowledgebaseOperations(String knowledgeBaseId, String before, String after, String pageSize, List<String> userId, List<String> type, List<String> status, String interval, List<String> sourceId) throws IOException, ApiException
      Get operations
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      userId - If specified, retrieves operations associated with user ids, comma separated values expected. (optional)
      type - If specified, retrieves operations with specified operation type, comma separated values expected. (optional)
      status - If specified, retrieves operations with specified operation status, comma separated values expected. (optional)
      interval - Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ (optional)
      sourceId - If specified, retrieves operations associated with source ids, comma separated values expected. (optional)
      Returns:
      OperationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseOperationsWithHttpInfo

      public ApiResponse<OperationListing> getKnowledgeKnowledgebaseOperationsWithHttpInfo(String knowledgeBaseId, String before, String after, String pageSize, List<String> userId, List<String> type, List<String> status, String interval, List<String> sourceId) throws IOException
      Get operations
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      userId - If specified, retrieves operations associated with user ids, comma separated values expected. (optional)
      type - If specified, retrieves operations with specified operation type, comma separated values expected. (optional)
      status - If specified, retrieves operations with specified operation status, comma separated values expected. (optional)
      interval - Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ (optional)
      sourceId - If specified, retrieves operations associated with source ids, comma separated values expected. (optional)
      Returns:
      OperationListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseOperations

      public OperationListing getKnowledgeKnowledgebaseOperations(GetKnowledgeKnowledgebaseOperationsRequest request) throws IOException, ApiException
      Get operations
      Parameters:
      request - The request object
      Returns:
      OperationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseOperations

      public ApiResponse<OperationListing> getKnowledgeKnowledgebaseOperations(ApiRequest<Void> request) throws IOException
      Get operations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseOperationsUsersQuery

      public OperationCreatorUserResponse getKnowledgeKnowledgebaseOperationsUsersQuery(String knowledgeBaseId) throws IOException, ApiException
      Get ids of operation creator users and oauth clients
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      Returns:
      OperationCreatorUserResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseOperationsUsersQueryWithHttpInfo

      public ApiResponse<OperationCreatorUserResponse> getKnowledgeKnowledgebaseOperationsUsersQueryWithHttpInfo(String knowledgeBaseId) throws IOException
      Get ids of operation creator users and oauth clients
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      Returns:
      OperationCreatorUserResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseOperationsUsersQuery

      public OperationCreatorUserResponse getKnowledgeKnowledgebaseOperationsUsersQuery(GetKnowledgeKnowledgebaseOperationsUsersQueryRequest request) throws IOException, ApiException
      Get ids of operation creator users and oauth clients
      Parameters:
      request - The request object
      Returns:
      OperationCreatorUserResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseOperationsUsersQuery

      public ApiResponse<OperationCreatorUserResponse> getKnowledgeKnowledgebaseOperationsUsersQuery(ApiRequest<Void> request) throws IOException
      Get ids of operation creator users and oauth clients
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseParseJob

      public KnowledgeParseJobResponse getKnowledgeKnowledgebaseParseJob(String knowledgeBaseId, String parseJobId, List<String> expand) throws IOException, ApiException
      Get parse job report
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      parseJobId - Parse job ID (required)
      expand - If expand contains 'urls' downloadURL and failedEntitiesURL will be filled. (optional)
      Returns:
      KnowledgeParseJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseParseJobWithHttpInfo

      public ApiResponse<KnowledgeParseJobResponse> getKnowledgeKnowledgebaseParseJobWithHttpInfo(String knowledgeBaseId, String parseJobId, List<String> expand) throws IOException
      Get parse job report
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      parseJobId - Parse job ID (required)
      expand - If expand contains 'urls' downloadURL and failedEntitiesURL will be filled. (optional)
      Returns:
      KnowledgeParseJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseParseJob

      public KnowledgeParseJobResponse getKnowledgeKnowledgebaseParseJob(GetKnowledgeKnowledgebaseParseJobRequest request) throws IOException, ApiException
      Get parse job report
      Parameters:
      request - The request object
      Returns:
      KnowledgeParseJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseParseJob

      public ApiResponse<KnowledgeParseJobResponse> getKnowledgeKnowledgebaseParseJob(ApiRequest<Void> request) throws IOException
      Get parse job report
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSources

      public List<SourceBaseResponse> getKnowledgeKnowledgebaseSources(String knowledgeBaseId, String type, List<String> expand, List<String> ids) throws IOException, ApiException
      Get Knowledge integration sources
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      type - If specified, retrieves integration sources with specified integration type. (optional)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      ids - If specified, retrieves integration sources with specified IDs. (optional)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSourcesWithHttpInfo

      public ApiResponse<List<SourceBaseResponse>> getKnowledgeKnowledgebaseSourcesWithHttpInfo(String knowledgeBaseId, String type, List<String> expand, List<String> ids) throws IOException
      Get Knowledge integration sources
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      type - If specified, retrieves integration sources with specified integration type. (optional)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      ids - If specified, retrieves integration sources with specified IDs. (optional)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSources

      public List<SourceBaseResponse> getKnowledgeKnowledgebaseSources(GetKnowledgeKnowledgebaseSourcesRequest request) throws IOException, ApiException
      Get Knowledge integration sources
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSources

      public ApiResponse<List<SourceBaseResponse>> getKnowledgeKnowledgebaseSources(ApiRequest<Void> request) throws IOException
      Get Knowledge integration sources
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSourcesSalesforceSourceId

      public SalesforceSourceResponse getKnowledgeKnowledgebaseSourcesSalesforceSourceId(String knowledgeBaseId, String sourceId, List<String> expand) throws IOException, ApiException
      Get Salesforce Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      Returns:
      SalesforceSourceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSourcesSalesforceSourceIdWithHttpInfo

      public ApiResponse<SalesforceSourceResponse> getKnowledgeKnowledgebaseSourcesSalesforceSourceIdWithHttpInfo(String knowledgeBaseId, String sourceId, List<String> expand) throws IOException
      Get Salesforce Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      Returns:
      SalesforceSourceResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSourcesSalesforceSourceId

      public SalesforceSourceResponse getKnowledgeKnowledgebaseSourcesSalesforceSourceId(GetKnowledgeKnowledgebaseSourcesSalesforceSourceIdRequest request) throws IOException, ApiException
      Get Salesforce Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      SalesforceSourceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSourcesSalesforceSourceId

      public ApiResponse<SalesforceSourceResponse> getKnowledgeKnowledgebaseSourcesSalesforceSourceId(ApiRequest<Void> request) throws IOException
      Get Salesforce Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSourcesServicenowSourceId

      public ServiceNowSourceResponse getKnowledgeKnowledgebaseSourcesServicenowSourceId(String knowledgeBaseId, String sourceId, List<String> expand) throws IOException, ApiException
      Get ServiceNow Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      Returns:
      ServiceNowSourceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSourcesServicenowSourceIdWithHttpInfo

      public ApiResponse<ServiceNowSourceResponse> getKnowledgeKnowledgebaseSourcesServicenowSourceIdWithHttpInfo(String knowledgeBaseId, String sourceId, List<String> expand) throws IOException
      Get ServiceNow Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      expand - The specified entity attributes will be filled. Comma separated values expected. (optional)
      Returns:
      ServiceNowSourceResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSourcesServicenowSourceId

      public ServiceNowSourceResponse getKnowledgeKnowledgebaseSourcesServicenowSourceId(GetKnowledgeKnowledgebaseSourcesServicenowSourceIdRequest request) throws IOException, ApiException
      Get ServiceNow Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      ServiceNowSourceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSourcesServicenowSourceId

      public ApiResponse<ServiceNowSourceResponse> getKnowledgeKnowledgebaseSourcesServicenowSourceId(ApiRequest<Void> request) throws IOException
      Get ServiceNow Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSynchronizeJob

      public KnowledgeSyncJobResponse getKnowledgeKnowledgebaseSynchronizeJob(String knowledgeBaseId, String syncJobId) throws IOException, ApiException
      Get synchronization job report
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      syncJobId - Synchronization job ID (required)
      Returns:
      KnowledgeSyncJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSynchronizeJobWithHttpInfo

      public ApiResponse<KnowledgeSyncJobResponse> getKnowledgeKnowledgebaseSynchronizeJobWithHttpInfo(String knowledgeBaseId, String syncJobId) throws IOException
      Get synchronization job report
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      syncJobId - Synchronization job ID (required)
      Returns:
      KnowledgeSyncJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSynchronizeJob

      public KnowledgeSyncJobResponse getKnowledgeKnowledgebaseSynchronizeJob(GetKnowledgeKnowledgebaseSynchronizeJobRequest request) throws IOException, ApiException
      Get synchronization job report
      Parameters:
      request - The request object
      Returns:
      KnowledgeSyncJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseSynchronizeJob

      public ApiResponse<KnowledgeSyncJobResponse> getKnowledgeKnowledgebaseSynchronizeJob(ApiRequest<Void> request) throws IOException
      Get synchronization job report
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUnansweredGroup

      public UnansweredGroup getKnowledgeKnowledgebaseUnansweredGroup(String knowledgeBaseId, String groupId, String app, LocalDate dateStart, LocalDate dateEnd) throws IOException, ApiException
      Get knowledge base unanswered group for a particular groupId
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      groupId - The ID of the group to be retrieved. (required)
      app - The app value to be used for filtering phrases. (optional)
      dateStart - The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      dateEnd - The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      Returns:
      UnansweredGroup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUnansweredGroupWithHttpInfo

      public ApiResponse<UnansweredGroup> getKnowledgeKnowledgebaseUnansweredGroupWithHttpInfo(String knowledgeBaseId, String groupId, String app, LocalDate dateStart, LocalDate dateEnd) throws IOException
      Get knowledge base unanswered group for a particular groupId
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      groupId - The ID of the group to be retrieved. (required)
      app - The app value to be used for filtering phrases. (optional)
      dateStart - The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      dateEnd - The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      Returns:
      UnansweredGroup
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUnansweredGroup

      public UnansweredGroup getKnowledgeKnowledgebaseUnansweredGroup(GetKnowledgeKnowledgebaseUnansweredGroupRequest request) throws IOException, ApiException
      Get knowledge base unanswered group for a particular groupId
      Parameters:
      request - The request object
      Returns:
      UnansweredGroup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUnansweredGroup

      public ApiResponse<UnansweredGroup> getKnowledgeKnowledgebaseUnansweredGroup(ApiRequest<Void> request) throws IOException
      Get knowledge base unanswered group for a particular groupId
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup

      public UnansweredPhraseGroup getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(String knowledgeBaseId, String groupId, String phraseGroupId, String app, LocalDate dateStart, LocalDate dateEnd) throws IOException, ApiException
      Get knowledge base unanswered phrase group for a particular phraseGroupId
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      groupId - The ID of the group to be retrieved. (required)
      phraseGroupId - The ID of the phraseGroup to be retrieved. (required)
      app - The app value to be used for filtering phrases. (optional)
      dateStart - The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      dateEnd - The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      Returns:
      UnansweredPhraseGroup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUnansweredGroupPhrasegroupWithHttpInfo

      public ApiResponse<UnansweredPhraseGroup> getKnowledgeKnowledgebaseUnansweredGroupPhrasegroupWithHttpInfo(String knowledgeBaseId, String groupId, String phraseGroupId, String app, LocalDate dateStart, LocalDate dateEnd) throws IOException
      Get knowledge base unanswered phrase group for a particular phraseGroupId
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      groupId - The ID of the group to be retrieved. (required)
      phraseGroupId - The ID of the phraseGroup to be retrieved. (required)
      app - The app value to be used for filtering phrases. (optional)
      dateStart - The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      dateEnd - The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      Returns:
      UnansweredPhraseGroup
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup

      public UnansweredPhraseGroup getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(GetKnowledgeKnowledgebaseUnansweredGroupPhrasegroupRequest request) throws IOException, ApiException
      Get knowledge base unanswered phrase group for a particular phraseGroupId
      Parameters:
      request - The request object
      Returns:
      UnansweredPhraseGroup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup

      public ApiResponse<UnansweredPhraseGroup> getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(ApiRequest<Void> request) throws IOException
      Get knowledge base unanswered phrase group for a particular phraseGroupId
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUnansweredGroups

      public UnansweredGroups getKnowledgeKnowledgebaseUnansweredGroups(String knowledgeBaseId, String app, LocalDate dateStart, LocalDate dateEnd) throws IOException, ApiException
      Get knowledge base unanswered groups
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      app - The app value to be used for filtering phrases. (optional)
      dateStart - The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      dateEnd - The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      Returns:
      UnansweredGroups
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUnansweredGroupsWithHttpInfo

      public ApiResponse<UnansweredGroups> getKnowledgeKnowledgebaseUnansweredGroupsWithHttpInfo(String knowledgeBaseId, String app, LocalDate dateStart, LocalDate dateEnd) throws IOException
      Get knowledge base unanswered groups
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      app - The app value to be used for filtering phrases. (optional)
      dateStart - The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      dateEnd - The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      Returns:
      UnansweredGroups
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUnansweredGroups

      public UnansweredGroups getKnowledgeKnowledgebaseUnansweredGroups(GetKnowledgeKnowledgebaseUnansweredGroupsRequest request) throws IOException, ApiException
      Get knowledge base unanswered groups
      Parameters:
      request - The request object
      Returns:
      UnansweredGroups
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUnansweredGroups

      public ApiResponse<UnansweredGroups> getKnowledgeKnowledgebaseUnansweredGroups(ApiRequest<Void> request) throws IOException
      Get knowledge base unanswered groups
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUploadsUrlsJob

      public GetUploadSourceUrlJobStatusResponse getKnowledgeKnowledgebaseUploadsUrlsJob(String knowledgeBaseId, String jobId) throws IOException, ApiException
      Get content upload from URL job status
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      jobId - Upload job ID (required)
      Returns:
      GetUploadSourceUrlJobStatusResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUploadsUrlsJobWithHttpInfo

      public ApiResponse<GetUploadSourceUrlJobStatusResponse> getKnowledgeKnowledgebaseUploadsUrlsJobWithHttpInfo(String knowledgeBaseId, String jobId) throws IOException
      Get content upload from URL job status
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      jobId - Upload job ID (required)
      Returns:
      GetUploadSourceUrlJobStatusResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUploadsUrlsJob

      public GetUploadSourceUrlJobStatusResponse getKnowledgeKnowledgebaseUploadsUrlsJob(GetKnowledgeKnowledgebaseUploadsUrlsJobRequest request) throws IOException, ApiException
      Get content upload from URL job status
      Parameters:
      request - The request object
      Returns:
      GetUploadSourceUrlJobStatusResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebaseUploadsUrlsJob

      public ApiResponse<GetUploadSourceUrlJobStatusResponse> getKnowledgeKnowledgebaseUploadsUrlsJob(ApiRequest<Void> request) throws IOException
      Get content upload from URL job status
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebases

      public KnowledgeBaseListing getKnowledgeKnowledgebases(String before, String after, String limit, String pageSize, String name, String coreLanguage, Boolean published, String sortBy, String sortOrder) throws IOException, ApiException
      Get knowledge bases
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      limit - Number of entities to return. Maximum of 100. Deprecated in favour of pageSize (optional)
      pageSize - Number of entities to return. Maximum of 100. (optional)
      name - Filter by Name. (optional)
      coreLanguage - Filter by core language. (optional)
      published - Filter by published status. (optional)
      sortBy - Sort by. (optional)
      sortOrder - Sort Order. (optional)
      Returns:
      KnowledgeBaseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebasesWithHttpInfo

      public ApiResponse<KnowledgeBaseListing> getKnowledgeKnowledgebasesWithHttpInfo(String before, String after, String limit, String pageSize, String name, String coreLanguage, Boolean published, String sortBy, String sortOrder) throws IOException
      Get knowledge bases
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      limit - Number of entities to return. Maximum of 100. Deprecated in favour of pageSize (optional)
      pageSize - Number of entities to return. Maximum of 100. (optional)
      name - Filter by Name. (optional)
      coreLanguage - Filter by core language. (optional)
      published - Filter by published status. (optional)
      sortBy - Sort by. (optional)
      sortOrder - Sort Order. (optional)
      Returns:
      KnowledgeBaseListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebases

      public KnowledgeBaseListing getKnowledgeKnowledgebases(GetKnowledgeKnowledgebasesRequest request) throws IOException, ApiException
      Get knowledge bases
      Parameters:
      request - The request object
      Returns:
      KnowledgeBaseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeKnowledgebases

      public ApiResponse<KnowledgeBaseListing> getKnowledgeKnowledgebases(ApiRequest<Void> request) throws IOException
      Get knowledge bases
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeSetting

      public KnowledgeSettingsResponse getKnowledgeSetting(String knowledgeSettingId) throws IOException, ApiException
      Get Knowledge setting.
      Parameters:
      knowledgeSettingId - Knowledge Setting ID. (required)
      Returns:
      KnowledgeSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeSettingWithHttpInfo

      public ApiResponse<KnowledgeSettingsResponse> getKnowledgeSettingWithHttpInfo(String knowledgeSettingId) throws IOException
      Get Knowledge setting.
      Parameters:
      knowledgeSettingId - Knowledge Setting ID. (required)
      Returns:
      KnowledgeSettingsResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeSetting

      public KnowledgeSettingsResponse getKnowledgeSetting(GetKnowledgeSettingRequest request) throws IOException, ApiException
      Get Knowledge setting.
      Parameters:
      request - The request object
      Returns:
      KnowledgeSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeSetting

      public ApiResponse<KnowledgeSettingsResponse> getKnowledgeSetting(ApiRequest<Void> request) throws IOException
      Get Knowledge setting.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeSettings

      public KnowledgeSettingListing getKnowledgeSettings(String before, String after, String pageSize, String name, String sourceId, String sortBy, String sortOrder) throws IOException, ApiException
      Get Knowledge settings.
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      name - Knowledge setting name to search upon. (optional)
      sourceId - Source ID to filter knowledge settings by. (optional)
      sortBy - Field to sort the knowledge settings on. (optional)
      sortOrder - Sorting order for knowledge settings. (optional)
      Returns:
      KnowledgeSettingListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeSettingsWithHttpInfo

      public ApiResponse<KnowledgeSettingListing> getKnowledgeSettingsWithHttpInfo(String before, String after, String pageSize, String name, String sourceId, String sortBy, String sortOrder) throws IOException
      Get Knowledge settings.
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      name - Knowledge setting name to search upon. (optional)
      sourceId - Source ID to filter knowledge settings by. (optional)
      sortBy - Field to sort the knowledge settings on. (optional)
      sortOrder - Sorting order for knowledge settings. (optional)
      Returns:
      KnowledgeSettingListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeSettings

      public KnowledgeSettingListing getKnowledgeSettings(GetKnowledgeSettingsRequest request) throws IOException, ApiException
      Get Knowledge settings.
      Parameters:
      request - The request object
      Returns:
      KnowledgeSettingListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeSettings

      public ApiResponse<KnowledgeSettingListing> getKnowledgeSettings(ApiRequest<Void> request) throws IOException
      Get Knowledge settings.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeSource

      public V3SourceExpandableResponse getKnowledgeSource(String sourceId, List<String> expand) throws IOException, ApiException
      Get source
      Parameters:
      sourceId - Source ID (required)
      expand - Optional fields to expand for the Source. (optional)
      Returns:
      V3SourceExpandableResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeSourceWithHttpInfo

      public ApiResponse<V3SourceExpandableResponse> getKnowledgeSourceWithHttpInfo(String sourceId, List<String> expand) throws IOException
      Get source
      Parameters:
      sourceId - Source ID (required)
      expand - Optional fields to expand for the Source. (optional)
      Returns:
      V3SourceExpandableResponse
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeSource

      public V3SourceExpandableResponse getKnowledgeSource(GetKnowledgeSourceRequest request) throws IOException, ApiException
      Get source
      Parameters:
      request - The request object
      Returns:
      V3SourceExpandableResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeSource

      public ApiResponse<V3SourceExpandableResponse> getKnowledgeSource(ApiRequest<Void> request) throws IOException
      Get source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeSourceSynchronization

      public V3Synchronization getKnowledgeSourceSynchronization(String sourceId, String synchronizationId) throws IOException, ApiException
      Get a specific synchronization of a source.
      Parameters:
      sourceId - Source ID (required)
      synchronizationId - Synchronization ID (required)
      Returns:
      V3Synchronization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeSourceSynchronizationWithHttpInfo

      public ApiResponse<V3Synchronization> getKnowledgeSourceSynchronizationWithHttpInfo(String sourceId, String synchronizationId) throws IOException
      Get a specific synchronization of a source.
      Parameters:
      sourceId - Source ID (required)
      synchronizationId - Synchronization ID (required)
      Returns:
      V3Synchronization
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeSourceSynchronization

      public V3Synchronization getKnowledgeSourceSynchronization(GetKnowledgeSourceSynchronizationRequest request) throws IOException, ApiException
      Get a specific synchronization of a source.
      Parameters:
      request - The request object
      Returns:
      V3Synchronization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeSourceSynchronization

      public ApiResponse<V3Synchronization> getKnowledgeSourceSynchronization(ApiRequest<Void> request) throws IOException
      Get a specific synchronization of a source.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeSourceSynchronizations

      public V3SynchronizationListing getKnowledgeSourceSynchronizations(String sourceId, String before, String after, String pageSize) throws IOException, ApiException
      Get synchronizations of a source.
      Parameters:
      sourceId - Source ID (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      Returns:
      V3SynchronizationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeSourceSynchronizationsWithHttpInfo

      public ApiResponse<V3SynchronizationListing> getKnowledgeSourceSynchronizationsWithHttpInfo(String sourceId, String before, String after, String pageSize) throws IOException
      Get synchronizations of a source.
      Parameters:
      sourceId - Source ID (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      Returns:
      V3SynchronizationListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeSourceSynchronizations

      public V3SynchronizationListing getKnowledgeSourceSynchronizations(GetKnowledgeSourceSynchronizationsRequest request) throws IOException, ApiException
      Get synchronizations of a source.
      Parameters:
      request - The request object
      Returns:
      V3SynchronizationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeSourceSynchronizations

      public ApiResponse<V3SynchronizationListing> getKnowledgeSourceSynchronizations(ApiRequest<Void> request) throws IOException
      Get synchronizations of a source.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeSources

      public V3SourceExpandableListing getKnowledgeSources(List<String> expand) throws IOException, ApiException
      List sources
      Parameters:
      expand - Optional fields to expand for the Source. (optional)
      Returns:
      V3SourceExpandableListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeSourcesWithHttpInfo

      public ApiResponse<V3SourceExpandableListing> getKnowledgeSourcesWithHttpInfo(List<String> expand) throws IOException
      List sources
      Parameters:
      expand - Optional fields to expand for the Source. (optional)
      Returns:
      V3SourceExpandableListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeSources

      public V3SourceExpandableListing getKnowledgeSources(GetKnowledgeSourcesRequest request) throws IOException, ApiException
      List sources
      Parameters:
      request - The request object
      Returns:
      V3SourceExpandableListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeSources

      public ApiResponse<V3SourceExpandableListing> getKnowledgeSources(ApiRequest<Void> request) throws IOException
      List sources
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeSourcesSynchronizations

      public V3SynchronizationListing getKnowledgeSourcesSynchronizations(String before, String after, String pageSize) throws IOException, ApiException
      Get synchronizations of all sources of the organization.
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      Returns:
      V3SynchronizationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeSourcesSynchronizationsWithHttpInfo

      public ApiResponse<V3SynchronizationListing> getKnowledgeSourcesSynchronizationsWithHttpInfo(String before, String after, String pageSize) throws IOException
      Get synchronizations of all sources of the organization.
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      Returns:
      V3SynchronizationListing
      Throws:
      IOException - if the request fails to be processed

    • getKnowledgeSourcesSynchronizations

      public V3SynchronizationListing getKnowledgeSourcesSynchronizations(GetKnowledgeSourcesSynchronizationsRequest request) throws IOException, ApiException
      Get synchronizations of all sources of the organization.
      Parameters:
      request - The request object
      Returns:
      V3SynchronizationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getKnowledgeSourcesSynchronizations

      public ApiResponse<V3SynchronizationListing> getKnowledgeSourcesSynchronizations(ApiRequest<Void> request) throws IOException
      Get synchronizations of all sources of the organization.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeConnection

      public ConnectionResponse patchKnowledgeConnection(String connectionId, ConnectionUpdateRequest body) throws IOException, ApiException
      Update connection
      Parameters:
      connectionId - Connection ID (required)
      body - (optional)
      Returns:
      ConnectionResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeConnectionWithHttpInfo

      public ApiResponse<ConnectionResponse> patchKnowledgeConnectionWithHttpInfo(String connectionId, ConnectionUpdateRequest body) throws IOException
      Update connection
      Parameters:
      connectionId - Connection ID (required)
      body - (optional)
      Returns:
      ConnectionResponse
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeConnection

      public ConnectionResponse patchKnowledgeConnection(PatchKnowledgeConnectionRequest request) throws IOException, ApiException
      Update connection
      Parameters:
      request - The request object
      Returns:
      ConnectionResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeConnection

      public ApiResponse<ConnectionResponse> patchKnowledgeConnection(ApiRequest<ConnectionUpdateRequest> request) throws IOException
      Update connection
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeGuestSessionDocumentsSearchSearchId

      public void patchKnowledgeGuestSessionDocumentsSearchSearchId(String sessionId, String searchId, SearchUpdateRequest body) throws IOException, ApiException
      Update search result.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      searchId - Search Result ID (required)
      body - (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeGuestSessionDocumentsSearchSearchIdWithHttpInfo

      public ApiResponse<Void> patchKnowledgeGuestSessionDocumentsSearchSearchIdWithHttpInfo(String sessionId, String searchId, SearchUpdateRequest body) throws IOException
      Update search result.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      searchId - Search Result ID (required)
      body - (required)
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeGuestSessionDocumentsSearchSearchId

      public void patchKnowledgeGuestSessionDocumentsSearchSearchId(PatchKnowledgeGuestSessionDocumentsSearchSearchIdRequest request) throws IOException, ApiException
      Update search result.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeGuestSessionDocumentsSearchSearchId

      public ApiResponse<Void> patchKnowledgeGuestSessionDocumentsSearchSearchId(ApiRequest<SearchUpdateRequest> request) throws IOException
      Update search result.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebase

      public KnowledgeBase patchKnowledgeKnowledgebase(String knowledgeBaseId, KnowledgeBaseUpdateRequest body) throws IOException, ApiException
      Update knowledge base
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeBase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseWithHttpInfo

      public ApiResponse<KnowledgeBase> patchKnowledgeKnowledgebaseWithHttpInfo(String knowledgeBaseId, KnowledgeBaseUpdateRequest body) throws IOException
      Update knowledge base
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeBase
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebase

      public KnowledgeBase patchKnowledgeKnowledgebase(PatchKnowledgeKnowledgebaseRequest request) throws IOException, ApiException
      Update knowledge base
      Parameters:
      request - The request object
      Returns:
      KnowledgeBase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebase

      public ApiResponse<KnowledgeBase> patchKnowledgeKnowledgebase(ApiRequest<KnowledgeBaseUpdateRequest> request) throws IOException
      Update knowledge base
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseCategory

      public CategoryResponse patchKnowledgeKnowledgebaseCategory(String knowledgeBaseId, String categoryId, CategoryUpdateRequest body) throws IOException, ApiException
      Update category
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      categoryId - Category ID (required)
      body - (required)
      Returns:
      CategoryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseCategoryWithHttpInfo

      public ApiResponse<CategoryResponse> patchKnowledgeKnowledgebaseCategoryWithHttpInfo(String knowledgeBaseId, String categoryId, CategoryUpdateRequest body) throws IOException
      Update category
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      categoryId - Category ID (required)
      body - (required)
      Returns:
      CategoryResponse
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseCategory

      public CategoryResponse patchKnowledgeKnowledgebaseCategory(PatchKnowledgeKnowledgebaseCategoryRequest request) throws IOException, ApiException
      Update category
      Parameters:
      request - The request object
      Returns:
      CategoryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseCategory

      public ApiResponse<CategoryResponse> patchKnowledgeKnowledgebaseCategory(ApiRequest<CategoryUpdateRequest> request) throws IOException
      Update category
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseChunksSearchSearchId

      public void patchKnowledgeKnowledgebaseChunksSearchSearchId(String knowledgeBaseId, String searchId, ChunkSearchRegisterRequest body) throws IOException, ApiException
      Register chunk search result.
      Parameters:
      knowledgeBaseId - Knowledge Base ID (required)
      searchId - Unique identifier of search request (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseChunksSearchSearchIdWithHttpInfo

      public ApiResponse<Void> patchKnowledgeKnowledgebaseChunksSearchSearchIdWithHttpInfo(String knowledgeBaseId, String searchId, ChunkSearchRegisterRequest body) throws IOException
      Register chunk search result.
      Parameters:
      knowledgeBaseId - Knowledge Base ID (required)
      searchId - Unique identifier of search request (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseChunksSearchSearchId

      public void patchKnowledgeKnowledgebaseChunksSearchSearchId(PatchKnowledgeKnowledgebaseChunksSearchSearchIdRequest request) throws IOException, ApiException
      Register chunk search result.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseChunksSearchSearchId

      public ApiResponse<Void> patchKnowledgeKnowledgebaseChunksSearchSearchId(ApiRequest<ChunkSearchRegisterRequest> request) throws IOException
      Register chunk search result.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocument

      public KnowledgeDocumentResponse patchKnowledgeKnowledgebaseDocument(String knowledgeBaseId, String documentId, KnowledgeDocumentReq body) throws IOException, ApiException
      Update document.
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      body - (required)
      Returns:
      KnowledgeDocumentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocumentWithHttpInfo

      public ApiResponse<KnowledgeDocumentResponse> patchKnowledgeKnowledgebaseDocumentWithHttpInfo(String knowledgeBaseId, String documentId, KnowledgeDocumentReq body) throws IOException
      Update document.
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      body - (required)
      Returns:
      KnowledgeDocumentResponse
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocument

      public KnowledgeDocumentResponse patchKnowledgeKnowledgebaseDocument(PatchKnowledgeKnowledgebaseDocumentRequest request) throws IOException, ApiException
      Update document.
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocument

      public ApiResponse<KnowledgeDocumentResponse> patchKnowledgeKnowledgebaseDocument(ApiRequest<KnowledgeDocumentReq> request) throws IOException
      Update document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId

      public KnowledgeDocumentFeedbackResponse patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(String knowledgeBaseId, String documentId, String feedbackId, KnowledgeDocumentFeedbackUpdateRequest body) throws IOException, ApiException
      Update feedback on a document
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      feedbackId - Feedback ID. (required)
      body - (optional)
      Returns:
      KnowledgeDocumentFeedbackResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackIdWithHttpInfo

      public ApiResponse<KnowledgeDocumentFeedbackResponse> patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackIdWithHttpInfo(String knowledgeBaseId, String documentId, String feedbackId, KnowledgeDocumentFeedbackUpdateRequest body) throws IOException
      Update feedback on a document
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      feedbackId - Feedback ID. (required)
      body - (optional)
      Returns:
      KnowledgeDocumentFeedbackResponse
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId

      public KnowledgeDocumentFeedbackResponse patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(PatchKnowledgeKnowledgebaseDocumentFeedbackFeedbackIdRequest request) throws IOException, ApiException
      Update feedback on a document
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentFeedbackResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId

      public ApiResponse<KnowledgeDocumentFeedbackResponse> patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(ApiRequest<KnowledgeDocumentFeedbackUpdateRequest> request) throws IOException
      Update feedback on a document
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocumentVariation

      public DocumentVariationResponse patchKnowledgeKnowledgebaseDocumentVariation(String documentVariationId, String documentId, String knowledgeBaseId, DocumentVariationRequest body) throws IOException, ApiException
      Update a variation for a document.
      Parameters:
      documentVariationId - Globally unique identifier for a document variation. (required)
      documentId - Globally unique identifier for a document. (required)
      knowledgeBaseId - Globally unique identifier for a knowledge base. (required)
      body - (required)
      Returns:
      DocumentVariationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocumentVariationWithHttpInfo

      public ApiResponse<DocumentVariationResponse> patchKnowledgeKnowledgebaseDocumentVariationWithHttpInfo(String documentVariationId, String documentId, String knowledgeBaseId, DocumentVariationRequest body) throws IOException
      Update a variation for a document.
      Parameters:
      documentVariationId - Globally unique identifier for a document variation. (required)
      documentId - Globally unique identifier for a document. (required)
      knowledgeBaseId - Globally unique identifier for a knowledge base. (required)
      body - (required)
      Returns:
      DocumentVariationResponse
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocumentVariation

      public DocumentVariationResponse patchKnowledgeKnowledgebaseDocumentVariation(PatchKnowledgeKnowledgebaseDocumentVariationRequest request) throws IOException, ApiException
      Update a variation for a document.
      Parameters:
      request - The request object
      Returns:
      DocumentVariationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocumentVariation

      public ApiResponse<DocumentVariationResponse> patchKnowledgeKnowledgebaseDocumentVariation(ApiRequest<DocumentVariationRequest> request) throws IOException
      Update a variation for a document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocumentsSearchSearchId

      public void patchKnowledgeKnowledgebaseDocumentsSearchSearchId(String knowledgeBaseId, String searchId, SearchUpdateRequest body) throws IOException, ApiException
      Update search result.
      Parameters:
      knowledgeBaseId - The ID of knowledge base containing the documents to query. (required)
      searchId - Search Result ID (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocumentsSearchSearchIdWithHttpInfo

      public ApiResponse<Void> patchKnowledgeKnowledgebaseDocumentsSearchSearchIdWithHttpInfo(String knowledgeBaseId, String searchId, SearchUpdateRequest body) throws IOException
      Update search result.
      Parameters:
      knowledgeBaseId - The ID of knowledge base containing the documents to query. (required)
      searchId - Search Result ID (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocumentsSearchSearchId

      public void patchKnowledgeKnowledgebaseDocumentsSearchSearchId(PatchKnowledgeKnowledgebaseDocumentsSearchSearchIdRequest request) throws IOException, ApiException
      Update search result.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseDocumentsSearchSearchId

      public ApiResponse<Void> patchKnowledgeKnowledgebaseDocumentsSearchSearchId(ApiRequest<SearchUpdateRequest> request) throws IOException
      Update search result.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseImportJob

      public KnowledgeImportJobResponse patchKnowledgeKnowledgebaseImportJob(String knowledgeBaseId, String importJobId, ImportStatusRequest body) throws IOException, ApiException
      Start import job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      importJobId - Import job ID (required)
      body - (required)
      Returns:
      KnowledgeImportJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseImportJobWithHttpInfo

      public ApiResponse<KnowledgeImportJobResponse> patchKnowledgeKnowledgebaseImportJobWithHttpInfo(String knowledgeBaseId, String importJobId, ImportStatusRequest body) throws IOException
      Start import job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      importJobId - Import job ID (required)
      body - (required)
      Returns:
      KnowledgeImportJobResponse
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseImportJob

      public KnowledgeImportJobResponse patchKnowledgeKnowledgebaseImportJob(PatchKnowledgeKnowledgebaseImportJobRequest request) throws IOException, ApiException
      Start import job
      Parameters:
      request - The request object
      Returns:
      KnowledgeImportJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseImportJob

      public ApiResponse<KnowledgeImportJobResponse> patchKnowledgeKnowledgebaseImportJob(ApiRequest<ImportStatusRequest> request) throws IOException
      Start import job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseLabel

      public LabelResponse patchKnowledgeKnowledgebaseLabel(String knowledgeBaseId, String labelId, LabelUpdateRequest body) throws IOException, ApiException
      Update label
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      labelId - Label ID (required)
      body - (required)
      Returns:
      LabelResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseLabelWithHttpInfo

      public ApiResponse<LabelResponse> patchKnowledgeKnowledgebaseLabelWithHttpInfo(String knowledgeBaseId, String labelId, LabelUpdateRequest body) throws IOException
      Update label
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      labelId - Label ID (required)
      body - (required)
      Returns:
      LabelResponse
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseLabel

      public LabelResponse patchKnowledgeKnowledgebaseLabel(PatchKnowledgeKnowledgebaseLabelRequest request) throws IOException, ApiException
      Update label
      Parameters:
      request - The request object
      Returns:
      LabelResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseLabel

      public ApiResponse<LabelResponse> patchKnowledgeKnowledgebaseLabel(ApiRequest<LabelUpdateRequest> request) throws IOException
      Update label
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseParseJob

      public void patchKnowledgeKnowledgebaseParseJob(String knowledgeBaseId, String parseJobId, KnowledgeParseJobRequestPatch body) throws IOException, ApiException
      Send update to the parse operation
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      parseJobId - Parse job ID (required)
      body - (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseParseJobWithHttpInfo

      public ApiResponse<Void> patchKnowledgeKnowledgebaseParseJobWithHttpInfo(String knowledgeBaseId, String parseJobId, KnowledgeParseJobRequestPatch body) throws IOException
      Send update to the parse operation
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      parseJobId - Parse job ID (required)
      body - (required)
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseParseJob

      public void patchKnowledgeKnowledgebaseParseJob(PatchKnowledgeKnowledgebaseParseJobRequest request) throws IOException, ApiException
      Send update to the parse operation
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseParseJob

      public ApiResponse<Void> patchKnowledgeKnowledgebaseParseJob(ApiRequest<KnowledgeParseJobRequestPatch> request) throws IOException
      Send update to the parse operation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseSynchronizeJob

      public KnowledgeSyncJobResponse patchKnowledgeKnowledgebaseSynchronizeJob(String knowledgeBaseId, String syncJobId, SyncStatusRequest body) throws IOException, ApiException
      Update synchronization job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      syncJobId - Synchronization job ID (required)
      body - (required)
      Returns:
      KnowledgeSyncJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseSynchronizeJobWithHttpInfo

      public ApiResponse<KnowledgeSyncJobResponse> patchKnowledgeKnowledgebaseSynchronizeJobWithHttpInfo(String knowledgeBaseId, String syncJobId, SyncStatusRequest body) throws IOException
      Update synchronization job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      syncJobId - Synchronization job ID (required)
      body - (required)
      Returns:
      KnowledgeSyncJobResponse
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseSynchronizeJob

      public KnowledgeSyncJobResponse patchKnowledgeKnowledgebaseSynchronizeJob(PatchKnowledgeKnowledgebaseSynchronizeJobRequest request) throws IOException, ApiException
      Update synchronization job
      Parameters:
      request - The request object
      Returns:
      KnowledgeSyncJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseSynchronizeJob

      public ApiResponse<KnowledgeSyncJobResponse> patchKnowledgeKnowledgebaseSynchronizeJob(ApiRequest<SyncStatusRequest> request) throws IOException
      Update synchronization job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup

      public UnansweredPhraseGroupUpdateResponse patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(String knowledgeBaseId, String groupId, String phraseGroupId, UnansweredPhraseGroupPatchRequestBody body) throws IOException, ApiException
      Update a Knowledge base unanswered phrase group
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      groupId - The ID of the group to be updated. (required)
      phraseGroupId - The ID of the phraseGroup to be updated. (required)
      body - Request body of the update unanswered group endpoint. (required)
      Returns:
      UnansweredPhraseGroupUpdateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroupWithHttpInfo

      public ApiResponse<UnansweredPhraseGroupUpdateResponse> patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroupWithHttpInfo(String knowledgeBaseId, String groupId, String phraseGroupId, UnansweredPhraseGroupPatchRequestBody body) throws IOException
      Update a Knowledge base unanswered phrase group
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      groupId - The ID of the group to be updated. (required)
      phraseGroupId - The ID of the phraseGroup to be updated. (required)
      body - Request body of the update unanswered group endpoint. (required)
      Returns:
      UnansweredPhraseGroupUpdateResponse
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup

      public UnansweredPhraseGroupUpdateResponse patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(PatchKnowledgeKnowledgebaseUnansweredGroupPhrasegroupRequest request) throws IOException, ApiException
      Update a Knowledge base unanswered phrase group
      Parameters:
      request - The request object
      Returns:
      UnansweredPhraseGroupUpdateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup

      public ApiResponse<UnansweredPhraseGroupUpdateResponse> patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(ApiRequest<UnansweredPhraseGroupPatchRequestBody> request) throws IOException
      Update a Knowledge base unanswered phrase group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeSetting

      public KnowledgeSettingsResponse patchKnowledgeSetting(String knowledgeSettingId, KnowledgeSettingsRequest body) throws IOException, ApiException
      Update Knowledge setting.
      Parameters:
      knowledgeSettingId - Knowledge Setting ID. (required)
      body - (required)
      Returns:
      KnowledgeSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeSettingWithHttpInfo

      public ApiResponse<KnowledgeSettingsResponse> patchKnowledgeSettingWithHttpInfo(String knowledgeSettingId, KnowledgeSettingsRequest body) throws IOException
      Update Knowledge setting.
      Parameters:
      knowledgeSettingId - Knowledge Setting ID. (required)
      body - (required)
      Returns:
      KnowledgeSettingsResponse
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeSetting

      public KnowledgeSettingsResponse patchKnowledgeSetting(PatchKnowledgeSettingRequest request) throws IOException, ApiException
      Update Knowledge setting.
      Parameters:
      request - The request object
      Returns:
      KnowledgeSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeSetting

      public ApiResponse<KnowledgeSettingsResponse> patchKnowledgeSetting(ApiRequest<KnowledgeSettingsRequest> request) throws IOException
      Update Knowledge setting.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeSourceSynchronization

      public V3Synchronization patchKnowledgeSourceSynchronization(String sourceId, String synchronizationId, V3SynchronizationUpdateRequest body) throws IOException, ApiException
      Update synchronization.
      Parameters:
      sourceId - Source ID (required)
      synchronizationId - Synchronization ID (required)
      body - (required)
      Returns:
      V3Synchronization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeSourceSynchronizationWithHttpInfo

      public ApiResponse<V3Synchronization> patchKnowledgeSourceSynchronizationWithHttpInfo(String sourceId, String synchronizationId, V3SynchronizationUpdateRequest body) throws IOException
      Update synchronization.
      Parameters:
      sourceId - Source ID (required)
      synchronizationId - Synchronization ID (required)
      body - (required)
      Returns:
      V3Synchronization
      Throws:
      IOException - if the request fails to be processed

    • patchKnowledgeSourceSynchronization

      public V3Synchronization patchKnowledgeSourceSynchronization(PatchKnowledgeSourceSynchronizationRequest request) throws IOException, ApiException
      Update synchronization.
      Parameters:
      request - The request object
      Returns:
      V3Synchronization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchKnowledgeSourceSynchronization

      public ApiResponse<V3Synchronization> patchKnowledgeSourceSynchronization(ApiRequest<V3SynchronizationUpdateRequest> request) throws IOException
      Update synchronization.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeConnections

      public ConnectionCreateResponse postKnowledgeConnections(ConnectionCreateRequest body) throws IOException, ApiException
      Create new connection
      Parameters:
      body - (required)
      Returns:
      ConnectionCreateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeConnectionsWithHttpInfo

      public ApiResponse<ConnectionCreateResponse> postKnowledgeConnectionsWithHttpInfo(ConnectionCreateRequest body) throws IOException
      Create new connection
      Parameters:
      body - (required)
      Returns:
      ConnectionCreateResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeConnections

      public ConnectionCreateResponse postKnowledgeConnections(PostKnowledgeConnectionsRequest request) throws IOException, ApiException
      Create new connection
      Parameters:
      request - The request object
      Returns:
      ConnectionCreateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeConnections

      public ApiResponse<ConnectionCreateResponse> postKnowledgeConnections(ApiRequest<ConnectionCreateRequest> request) throws IOException
      Create new connection
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeDocumentuploads

      public UploadUrlResponse postKnowledgeDocumentuploads(UploadUrlRequest body) throws IOException, ApiException
      Creates a presigned URL for uploading a knowledge import file with a set of documents
      Parameters:
      body - query (required)
      Returns:
      UploadUrlResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeDocumentuploadsWithHttpInfo

      public ApiResponse<UploadUrlResponse> postKnowledgeDocumentuploadsWithHttpInfo(UploadUrlRequest body) throws IOException
      Creates a presigned URL for uploading a knowledge import file with a set of documents
      Parameters:
      body - query (required)
      Returns:
      UploadUrlResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeDocumentuploads

      public UploadUrlResponse postKnowledgeDocumentuploads(PostKnowledgeDocumentuploadsRequest request) throws IOException, ApiException
      Creates a presigned URL for uploading a knowledge import file with a set of documents
      Parameters:
      request - The request object
      Returns:
      UploadUrlResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeDocumentuploads

      public ApiResponse<UploadUrlResponse> postKnowledgeDocumentuploads(ApiRequest<UploadUrlRequest> request) throws IOException
      Creates a presigned URL for uploading a knowledge import file with a set of documents
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentCopies

      public void postKnowledgeGuestSessionDocumentCopies(String sessionId, String documentId, KnowledgeGuestDocumentCopy body) throws IOException, ApiException
      Indicate that the document was copied by the user.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      documentId - Document ID (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentCopiesWithHttpInfo

      public ApiResponse<Void> postKnowledgeGuestSessionDocumentCopiesWithHttpInfo(String sessionId, String documentId, KnowledgeGuestDocumentCopy body) throws IOException
      Indicate that the document was copied by the user.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      documentId - Document ID (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentCopies

      public void postKnowledgeGuestSessionDocumentCopies(PostKnowledgeGuestSessionDocumentCopiesRequest request) throws IOException, ApiException
      Indicate that the document was copied by the user.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentCopies

      public ApiResponse<Void> postKnowledgeGuestSessionDocumentCopies(ApiRequest<KnowledgeGuestDocumentCopy> request) throws IOException
      Indicate that the document was copied by the user.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentFeedback

      public KnowledgeGuestDocumentFeedback postKnowledgeGuestSessionDocumentFeedback(String sessionId, String documentId, KnowledgeGuestDocumentFeedback body) throws IOException, ApiException
      Give feedback on a document
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      documentId - Document ID. (required)
      body - (optional)
      Returns:
      KnowledgeGuestDocumentFeedback
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentFeedbackWithHttpInfo

      public ApiResponse<KnowledgeGuestDocumentFeedback> postKnowledgeGuestSessionDocumentFeedbackWithHttpInfo(String sessionId, String documentId, KnowledgeGuestDocumentFeedback body) throws IOException
      Give feedback on a document
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      documentId - Document ID. (required)
      body - (optional)
      Returns:
      KnowledgeGuestDocumentFeedback
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentFeedback

      public KnowledgeGuestDocumentFeedback postKnowledgeGuestSessionDocumentFeedback(PostKnowledgeGuestSessionDocumentFeedbackRequest request) throws IOException, ApiException
      Give feedback on a document
      Parameters:
      request - The request object
      Returns:
      KnowledgeGuestDocumentFeedback
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentFeedback

      public ApiResponse<KnowledgeGuestDocumentFeedback> postKnowledgeGuestSessionDocumentFeedback(ApiRequest<KnowledgeGuestDocumentFeedback> request) throws IOException
      Give feedback on a document
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentViews

      public void postKnowledgeGuestSessionDocumentViews(String sessionId, String documentId, KnowledgeGuestDocumentView body) throws IOException, ApiException
      Create view event for a document.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      documentId - Document ID (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentViewsWithHttpInfo

      public ApiResponse<Void> postKnowledgeGuestSessionDocumentViewsWithHttpInfo(String sessionId, String documentId, KnowledgeGuestDocumentView body) throws IOException
      Create view event for a document.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      documentId - Document ID (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentViews

      public void postKnowledgeGuestSessionDocumentViews(PostKnowledgeGuestSessionDocumentViewsRequest request) throws IOException, ApiException
      Create view event for a document.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentViews

      public ApiResponse<Void> postKnowledgeGuestSessionDocumentViews(ApiRequest<KnowledgeGuestDocumentView> request) throws IOException
      Create view event for a document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsAnswers

      public KnowledgeGuestAnswerDocumentsResponse postKnowledgeGuestSessionDocumentsAnswers(String sessionId, KnowledgeDocumentsAnswerFilter body) throws IOException, ApiException
      Answer documents.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      body - (required)
      Returns:
      KnowledgeGuestAnswerDocumentsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsAnswersWithHttpInfo

      public ApiResponse<KnowledgeGuestAnswerDocumentsResponse> postKnowledgeGuestSessionDocumentsAnswersWithHttpInfo(String sessionId, KnowledgeDocumentsAnswerFilter body) throws IOException
      Answer documents.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      body - (required)
      Returns:
      KnowledgeGuestAnswerDocumentsResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsAnswers

      public KnowledgeGuestAnswerDocumentsResponse postKnowledgeGuestSessionDocumentsAnswers(PostKnowledgeGuestSessionDocumentsAnswersRequest request) throws IOException, ApiException
      Answer documents.
      Parameters:
      request - The request object
      Returns:
      KnowledgeGuestAnswerDocumentsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsAnswers

      public ApiResponse<KnowledgeGuestAnswerDocumentsResponse> postKnowledgeGuestSessionDocumentsAnswers(ApiRequest<KnowledgeDocumentsAnswerFilter> request) throws IOException
      Answer documents.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsPresentations

      public void postKnowledgeGuestSessionDocumentsPresentations(String sessionId, KnowledgeGuestDocumentPresentation body) throws IOException, ApiException
      Indicate that documents were presented to the user.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsPresentationsWithHttpInfo

      public ApiResponse<Void> postKnowledgeGuestSessionDocumentsPresentationsWithHttpInfo(String sessionId, KnowledgeGuestDocumentPresentation body) throws IOException
      Indicate that documents were presented to the user.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsPresentations

      public void postKnowledgeGuestSessionDocumentsPresentations(PostKnowledgeGuestSessionDocumentsPresentationsRequest request) throws IOException, ApiException
      Indicate that documents were presented to the user.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsPresentations

      public ApiResponse<Void> postKnowledgeGuestSessionDocumentsPresentations(ApiRequest<KnowledgeGuestDocumentPresentation> request) throws IOException
      Indicate that documents were presented to the user.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsSearch

      public KnowledgeDocumentGuestSearch postKnowledgeGuestSessionDocumentsSearch(String sessionId, List<String> expand, KnowledgeDocumentGuestSearchRequest body) throws IOException, ApiException
      Search the documents in a guest session.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      expand - Fields, if any, to expand for each document in the search result matching the query. (optional)
      body - (optional)
      Returns:
      KnowledgeDocumentGuestSearch
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsSearchWithHttpInfo

      public ApiResponse<KnowledgeDocumentGuestSearch> postKnowledgeGuestSessionDocumentsSearchWithHttpInfo(String sessionId, List<String> expand, KnowledgeDocumentGuestSearchRequest body) throws IOException
      Search the documents in a guest session.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      expand - Fields, if any, to expand for each document in the search result matching the query. (optional)
      body - (optional)
      Returns:
      KnowledgeDocumentGuestSearch
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsSearch

      public KnowledgeDocumentGuestSearch postKnowledgeGuestSessionDocumentsSearch(PostKnowledgeGuestSessionDocumentsSearchRequest request) throws IOException, ApiException
      Search the documents in a guest session.
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentGuestSearch
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsSearch

      public ApiResponse<KnowledgeDocumentGuestSearch> postKnowledgeGuestSessionDocumentsSearch(ApiRequest<KnowledgeDocumentGuestSearchRequest> request) throws IOException
      Search the documents in a guest session.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsSearchSuggestions

      public KnowledgeGuestDocumentSuggestion postKnowledgeGuestSessionDocumentsSearchSuggestions(String sessionId, KnowledgeGuestDocumentSuggestionRequest body) throws IOException, ApiException
      Query the knowledge documents to provide suggestions for auto completion.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      body - (optional)
      Returns:
      KnowledgeGuestDocumentSuggestion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsSearchSuggestionsWithHttpInfo

      public ApiResponse<KnowledgeGuestDocumentSuggestion> postKnowledgeGuestSessionDocumentsSearchSuggestionsWithHttpInfo(String sessionId, KnowledgeGuestDocumentSuggestionRequest body) throws IOException
      Query the knowledge documents to provide suggestions for auto completion.
      Parameters:
      sessionId - Knowledge guest session ID. (required)
      body - (optional)
      Returns:
      KnowledgeGuestDocumentSuggestion
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsSearchSuggestions

      public KnowledgeGuestDocumentSuggestion postKnowledgeGuestSessionDocumentsSearchSuggestions(PostKnowledgeGuestSessionDocumentsSearchSuggestionsRequest request) throws IOException, ApiException
      Query the knowledge documents to provide suggestions for auto completion.
      Parameters:
      request - The request object
      Returns:
      KnowledgeGuestDocumentSuggestion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionDocumentsSearchSuggestions

      public ApiResponse<KnowledgeGuestDocumentSuggestion> postKnowledgeGuestSessionDocumentsSearchSuggestions(ApiRequest<KnowledgeGuestDocumentSuggestionRequest> request) throws IOException
      Query the knowledge documents to provide suggestions for auto completion.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessions

      public KnowledgeGuestSession postKnowledgeGuestSessions(KnowledgeGuestSession body) throws IOException, ApiException
      Create guest session
      Parameters:
      body - (required)
      Returns:
      KnowledgeGuestSession
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessionsWithHttpInfo

      public ApiResponse<KnowledgeGuestSession> postKnowledgeGuestSessionsWithHttpInfo(KnowledgeGuestSession body) throws IOException
      Create guest session
      Parameters:
      body - (required)
      Returns:
      KnowledgeGuestSession
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessions

      public KnowledgeGuestSession postKnowledgeGuestSessions(PostKnowledgeGuestSessionsRequest request) throws IOException, ApiException
      Create guest session
      Parameters:
      request - The request object
      Returns:
      KnowledgeGuestSession
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeGuestSessions

      public ApiResponse<KnowledgeGuestSession> postKnowledgeGuestSessions(ApiRequest<KnowledgeGuestSession> request) throws IOException
      Create guest session
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseCategories

      public CategoryResponse postKnowledgeKnowledgebaseCategories(String knowledgeBaseId, CategoryCreateRequest body) throws IOException, ApiException
      Create new category
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      CategoryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseCategoriesWithHttpInfo

      public ApiResponse<CategoryResponse> postKnowledgeKnowledgebaseCategoriesWithHttpInfo(String knowledgeBaseId, CategoryCreateRequest body) throws IOException
      Create new category
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      CategoryResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseCategories

      public CategoryResponse postKnowledgeKnowledgebaseCategories(PostKnowledgeKnowledgebaseCategoriesRequest request) throws IOException, ApiException
      Create new category
      Parameters:
      request - The request object
      Returns:
      CategoryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseCategories

      public ApiResponse<CategoryResponse> postKnowledgeKnowledgebaseCategories(ApiRequest<CategoryCreateRequest> request) throws IOException
      Create new category
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseChunksSearch

      public KnowledgeDocumentChunkResponse postKnowledgeKnowledgebaseChunksSearch(String knowledgeBaseId, KnowledgeDocumentChunkRequest body) throws IOException, ApiException
      Search for chunks in a knowledge base
      Parameters:
      knowledgeBaseId - Knowledge Base ID (required)
      body - (optional)
      Returns:
      KnowledgeDocumentChunkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseChunksSearchWithHttpInfo

      public ApiResponse<KnowledgeDocumentChunkResponse> postKnowledgeKnowledgebaseChunksSearchWithHttpInfo(String knowledgeBaseId, KnowledgeDocumentChunkRequest body) throws IOException
      Search for chunks in a knowledge base
      Parameters:
      knowledgeBaseId - Knowledge Base ID (required)
      body - (optional)
      Returns:
      KnowledgeDocumentChunkResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseChunksSearch

      public KnowledgeDocumentChunkResponse postKnowledgeKnowledgebaseChunksSearch(PostKnowledgeKnowledgebaseChunksSearchRequest request) throws IOException, ApiException
      Search for chunks in a knowledge base
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentChunkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseChunksSearch

      public ApiResponse<KnowledgeDocumentChunkResponse> postKnowledgeKnowledgebaseChunksSearch(ApiRequest<KnowledgeDocumentChunkRequest> request) throws IOException
      Search for chunks in a knowledge base
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentCopies

      public void postKnowledgeKnowledgebaseDocumentCopies(String knowledgeBaseId, String documentId, KnowledgeDocumentCopy body) throws IOException, ApiException
      Indicate that the document was copied by the user.
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentCopiesWithHttpInfo

      public ApiResponse<Void> postKnowledgeKnowledgebaseDocumentCopiesWithHttpInfo(String knowledgeBaseId, String documentId, KnowledgeDocumentCopy body) throws IOException
      Indicate that the document was copied by the user.
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentCopies

      public void postKnowledgeKnowledgebaseDocumentCopies(PostKnowledgeKnowledgebaseDocumentCopiesRequest request) throws IOException, ApiException
      Indicate that the document was copied by the user.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentCopies

      public ApiResponse<Void> postKnowledgeKnowledgebaseDocumentCopies(ApiRequest<KnowledgeDocumentCopy> request) throws IOException
      Indicate that the document was copied by the user.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentFeedback

      public KnowledgeDocumentFeedbackResponse postKnowledgeKnowledgebaseDocumentFeedback(String knowledgeBaseId, String documentId, KnowledgeDocumentFeedback body) throws IOException, ApiException
      Give feedback on a document
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      body - (optional)
      Returns:
      KnowledgeDocumentFeedbackResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentFeedbackWithHttpInfo

      public ApiResponse<KnowledgeDocumentFeedbackResponse> postKnowledgeKnowledgebaseDocumentFeedbackWithHttpInfo(String knowledgeBaseId, String documentId, KnowledgeDocumentFeedback body) throws IOException
      Give feedback on a document
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      body - (optional)
      Returns:
      KnowledgeDocumentFeedbackResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentFeedback

      public KnowledgeDocumentFeedbackResponse postKnowledgeKnowledgebaseDocumentFeedback(PostKnowledgeKnowledgebaseDocumentFeedbackRequest request) throws IOException, ApiException
      Give feedback on a document
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentFeedbackResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentFeedback

      public ApiResponse<KnowledgeDocumentFeedbackResponse> postKnowledgeKnowledgebaseDocumentFeedback(ApiRequest<KnowledgeDocumentFeedback> request) throws IOException
      Give feedback on a document
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentVariations

      public DocumentVariationResponse postKnowledgeKnowledgebaseDocumentVariations(String knowledgeBaseId, String documentId, DocumentVariationRequest body) throws IOException, ApiException
      Create a variation for a document.
      Parameters:
      knowledgeBaseId - Globally unique identifier for the knowledge base. (required)
      documentId - Globally unique identifier for the document. (required)
      body - (required)
      Returns:
      DocumentVariationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentVariationsWithHttpInfo

      public ApiResponse<DocumentVariationResponse> postKnowledgeKnowledgebaseDocumentVariationsWithHttpInfo(String knowledgeBaseId, String documentId, DocumentVariationRequest body) throws IOException
      Create a variation for a document.
      Parameters:
      knowledgeBaseId - Globally unique identifier for the knowledge base. (required)
      documentId - Globally unique identifier for the document. (required)
      body - (required)
      Returns:
      DocumentVariationResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentVariations

      public DocumentVariationResponse postKnowledgeKnowledgebaseDocumentVariations(PostKnowledgeKnowledgebaseDocumentVariationsRequest request) throws IOException, ApiException
      Create a variation for a document.
      Parameters:
      request - The request object
      Returns:
      DocumentVariationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentVariations

      public ApiResponse<DocumentVariationResponse> postKnowledgeKnowledgebaseDocumentVariations(ApiRequest<DocumentVariationRequest> request) throws IOException
      Create a variation for a document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentVersions

      public KnowledgeDocumentVersion postKnowledgeKnowledgebaseDocumentVersions(String knowledgeBaseId, String documentId, KnowledgeDocumentVersion body) throws IOException, ApiException
      Creates or restores a document version.
      Parameters:
      knowledgeBaseId - Globally unique identifier for the knowledge base. (required)
      documentId - Globally unique identifier for the document. (required)
      body - (required)
      Returns:
      KnowledgeDocumentVersion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentVersionsWithHttpInfo

      public ApiResponse<KnowledgeDocumentVersion> postKnowledgeKnowledgebaseDocumentVersionsWithHttpInfo(String knowledgeBaseId, String documentId, KnowledgeDocumentVersion body) throws IOException
      Creates or restores a document version.
      Parameters:
      knowledgeBaseId - Globally unique identifier for the knowledge base. (required)
      documentId - Globally unique identifier for the document. (required)
      body - (required)
      Returns:
      KnowledgeDocumentVersion
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentVersions

      public KnowledgeDocumentVersion postKnowledgeKnowledgebaseDocumentVersions(PostKnowledgeKnowledgebaseDocumentVersionsRequest request) throws IOException, ApiException
      Creates or restores a document version.
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentVersion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentVersions

      public ApiResponse<KnowledgeDocumentVersion> postKnowledgeKnowledgebaseDocumentVersions(ApiRequest<KnowledgeDocumentVersion> request) throws IOException
      Creates or restores a document version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentViews

      public void postKnowledgeKnowledgebaseDocumentViews(String knowledgeBaseId, String documentId, KnowledgeDocumentView body) throws IOException, ApiException
      Create view for a document.
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentViewsWithHttpInfo

      public ApiResponse<Void> postKnowledgeKnowledgebaseDocumentViewsWithHttpInfo(String knowledgeBaseId, String documentId, KnowledgeDocumentView body) throws IOException
      Create view for a document.
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      documentId - Document ID. (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentViews

      public void postKnowledgeKnowledgebaseDocumentViews(PostKnowledgeKnowledgebaseDocumentViewsRequest request) throws IOException, ApiException
      Create view for a document.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentViews

      public ApiResponse<Void> postKnowledgeKnowledgebaseDocumentViews(ApiRequest<KnowledgeDocumentView> request) throws IOException
      Create view for a document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocuments

      public KnowledgeDocumentResponse postKnowledgeKnowledgebaseDocuments(String knowledgeBaseId, KnowledgeDocumentCreateRequest body) throws IOException, ApiException
      Create document.
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeDocumentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsWithHttpInfo

      public ApiResponse<KnowledgeDocumentResponse> postKnowledgeKnowledgebaseDocumentsWithHttpInfo(String knowledgeBaseId, KnowledgeDocumentCreateRequest body) throws IOException
      Create document.
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeDocumentResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocuments

      public KnowledgeDocumentResponse postKnowledgeKnowledgebaseDocuments(PostKnowledgeKnowledgebaseDocumentsRequest request) throws IOException, ApiException
      Create document.
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocuments

      public ApiResponse<KnowledgeDocumentResponse> postKnowledgeKnowledgebaseDocuments(ApiRequest<KnowledgeDocumentCreateRequest> request) throws IOException
      Create document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsAnswers

      public KnowledgeAnswerDocumentsResponse postKnowledgeKnowledgebaseDocumentsAnswers(String knowledgeBaseId, KnowledgeDocumentsAnswerFilter body) throws IOException, ApiException
      Answer documents.
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeAnswerDocumentsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsAnswersWithHttpInfo

      public ApiResponse<KnowledgeAnswerDocumentsResponse> postKnowledgeKnowledgebaseDocumentsAnswersWithHttpInfo(String knowledgeBaseId, KnowledgeDocumentsAnswerFilter body) throws IOException
      Answer documents.
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeAnswerDocumentsResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsAnswers

      public KnowledgeAnswerDocumentsResponse postKnowledgeKnowledgebaseDocumentsAnswers(PostKnowledgeKnowledgebaseDocumentsAnswersRequest request) throws IOException, ApiException
      Answer documents.
      Parameters:
      request - The request object
      Returns:
      KnowledgeAnswerDocumentsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsAnswers

      public ApiResponse<KnowledgeAnswerDocumentsResponse> postKnowledgeKnowledgebaseDocumentsAnswers(ApiRequest<KnowledgeDocumentsAnswerFilter> request) throws IOException
      Answer documents.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsBulkRemove

      public BulkResponse postKnowledgeKnowledgebaseDocumentsBulkRemove(String knowledgeBaseId, KnowledgeDocumentBulkRemoveRequest body) throws IOException, ApiException
      Bulk remove documents.
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      BulkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsBulkRemoveWithHttpInfo

      public ApiResponse<BulkResponse> postKnowledgeKnowledgebaseDocumentsBulkRemoveWithHttpInfo(String knowledgeBaseId, KnowledgeDocumentBulkRemoveRequest body) throws IOException
      Bulk remove documents.
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      BulkResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsBulkRemove

      public BulkResponse postKnowledgeKnowledgebaseDocumentsBulkRemove(PostKnowledgeKnowledgebaseDocumentsBulkRemoveRequest request) throws IOException, ApiException
      Bulk remove documents.
      Parameters:
      request - The request object
      Returns:
      BulkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsBulkRemove

      public ApiResponse<BulkResponse> postKnowledgeKnowledgebaseDocumentsBulkRemove(ApiRequest<KnowledgeDocumentBulkRemoveRequest> request) throws IOException
      Bulk remove documents.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsBulkUpdate

      public BulkResponse postKnowledgeKnowledgebaseDocumentsBulkUpdate(String knowledgeBaseId, KnowledgeDocumentBulkUpdateRequest body) throws IOException, ApiException
      Bulk update documents.
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      BulkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsBulkUpdateWithHttpInfo

      public ApiResponse<BulkResponse> postKnowledgeKnowledgebaseDocumentsBulkUpdateWithHttpInfo(String knowledgeBaseId, KnowledgeDocumentBulkUpdateRequest body) throws IOException
      Bulk update documents.
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      BulkResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsBulkUpdate

      public BulkResponse postKnowledgeKnowledgebaseDocumentsBulkUpdate(PostKnowledgeKnowledgebaseDocumentsBulkUpdateRequest request) throws IOException, ApiException
      Bulk update documents.
      Parameters:
      request - The request object
      Returns:
      BulkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsBulkUpdate

      public ApiResponse<BulkResponse> postKnowledgeKnowledgebaseDocumentsBulkUpdate(ApiRequest<KnowledgeDocumentBulkUpdateRequest> request) throws IOException
      Bulk update documents.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsPresentations

      public void postKnowledgeKnowledgebaseDocumentsPresentations(String knowledgeBaseId, KnowledgeDocumentPresentation body) throws IOException, ApiException
      Indicate that documents were presented to the user.
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsPresentationsWithHttpInfo

      public ApiResponse<Void> postKnowledgeKnowledgebaseDocumentsPresentationsWithHttpInfo(String knowledgeBaseId, KnowledgeDocumentPresentation body) throws IOException
      Indicate that documents were presented to the user.
      Parameters:
      knowledgeBaseId - Knowledge base ID. (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsPresentations

      public void postKnowledgeKnowledgebaseDocumentsPresentations(PostKnowledgeKnowledgebaseDocumentsPresentationsRequest request) throws IOException, ApiException
      Indicate that documents were presented to the user.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsPresentations

      public ApiResponse<Void> postKnowledgeKnowledgebaseDocumentsPresentations(ApiRequest<KnowledgeDocumentPresentation> request) throws IOException
      Indicate that documents were presented to the user.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsQuery

      public KnowledgeDocumentQueryResponse postKnowledgeKnowledgebaseDocumentsQuery(String knowledgeBaseId, List<String> expand, KnowledgeDocumentQuery body) throws IOException, ApiException
      Query for knowledge documents.
      Parameters:
      knowledgeBaseId - Knowledge Base ID (required)
      expand - Fields, if any, to expand for each document in the search result matching the query. (optional)
      body - (optional)
      Returns:
      KnowledgeDocumentQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsQueryWithHttpInfo

      public ApiResponse<KnowledgeDocumentQueryResponse> postKnowledgeKnowledgebaseDocumentsQueryWithHttpInfo(String knowledgeBaseId, List<String> expand, KnowledgeDocumentQuery body) throws IOException
      Query for knowledge documents.
      Parameters:
      knowledgeBaseId - Knowledge Base ID (required)
      expand - Fields, if any, to expand for each document in the search result matching the query. (optional)
      body - (optional)
      Returns:
      KnowledgeDocumentQueryResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsQuery

      public KnowledgeDocumentQueryResponse postKnowledgeKnowledgebaseDocumentsQuery(PostKnowledgeKnowledgebaseDocumentsQueryRequest request) throws IOException, ApiException
      Query for knowledge documents.
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsQuery

      public ApiResponse<KnowledgeDocumentQueryResponse> postKnowledgeKnowledgebaseDocumentsQuery(ApiRequest<KnowledgeDocumentQuery> request) throws IOException
      Query for knowledge documents.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsSearch

      public KnowledgeDocumentSearch postKnowledgeKnowledgebaseDocumentsSearch(String knowledgeBaseId, List<String> expand, KnowledgeDocumentSearchRequest body) throws IOException, ApiException
      Search the documents in a knowledge base.
      Parameters:
      knowledgeBaseId - The ID of knowledge base containing the documents to query. (required)
      expand - Fields, if any, to expand for each document in the search result matching the query. (optional)
      body - (optional)
      Returns:
      KnowledgeDocumentSearch
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsSearchWithHttpInfo

      public ApiResponse<KnowledgeDocumentSearch> postKnowledgeKnowledgebaseDocumentsSearchWithHttpInfo(String knowledgeBaseId, List<String> expand, KnowledgeDocumentSearchRequest body) throws IOException
      Search the documents in a knowledge base.
      Parameters:
      knowledgeBaseId - The ID of knowledge base containing the documents to query. (required)
      expand - Fields, if any, to expand for each document in the search result matching the query. (optional)
      body - (optional)
      Returns:
      KnowledgeDocumentSearch
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsSearch

      public KnowledgeDocumentSearch postKnowledgeKnowledgebaseDocumentsSearch(PostKnowledgeKnowledgebaseDocumentsSearchRequest request) throws IOException, ApiException
      Search the documents in a knowledge base.
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentSearch
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsSearch

      public ApiResponse<KnowledgeDocumentSearch> postKnowledgeKnowledgebaseDocumentsSearch(ApiRequest<KnowledgeDocumentSearchRequest> request) throws IOException
      Search the documents in a knowledge base.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsSearchSuggestions

      public KnowledgeDocumentSuggestion postKnowledgeKnowledgebaseDocumentsSearchSuggestions(String knowledgeBaseId, KnowledgeDocumentSuggestionRequest body) throws IOException, ApiException
      Query the knowledge documents to provide suggestions for auto completion.
      Parameters:
      knowledgeBaseId - The ID of knowledge base containing the documents to query. (required)
      body - (optional)
      Returns:
      KnowledgeDocumentSuggestion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsSearchSuggestionsWithHttpInfo

      public ApiResponse<KnowledgeDocumentSuggestion> postKnowledgeKnowledgebaseDocumentsSearchSuggestionsWithHttpInfo(String knowledgeBaseId, KnowledgeDocumentSuggestionRequest body) throws IOException
      Query the knowledge documents to provide suggestions for auto completion.
      Parameters:
      knowledgeBaseId - The ID of knowledge base containing the documents to query. (required)
      body - (optional)
      Returns:
      KnowledgeDocumentSuggestion
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsSearchSuggestions

      public KnowledgeDocumentSuggestion postKnowledgeKnowledgebaseDocumentsSearchSuggestions(PostKnowledgeKnowledgebaseDocumentsSearchSuggestionsRequest request) throws IOException, ApiException
      Query the knowledge documents to provide suggestions for auto completion.
      Parameters:
      request - The request object
      Returns:
      KnowledgeDocumentSuggestion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsSearchSuggestions

      public ApiResponse<KnowledgeDocumentSuggestion> postKnowledgeKnowledgebaseDocumentsSearchSuggestions(ApiRequest<KnowledgeDocumentSuggestionRequest> request) throws IOException
      Query the knowledge documents to provide suggestions for auto completion.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd

      public BulkResponse postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(String knowledgeBaseId, KnowledgeDocumentBulkVersionAddRequest body) throws IOException, ApiException
      Bulk add document versions.
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      BulkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsVersionsBulkAddWithHttpInfo

      public ApiResponse<BulkResponse> postKnowledgeKnowledgebaseDocumentsVersionsBulkAddWithHttpInfo(String knowledgeBaseId, KnowledgeDocumentBulkVersionAddRequest body) throws IOException
      Bulk add document versions.
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      BulkResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd

      public BulkResponse postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(PostKnowledgeKnowledgebaseDocumentsVersionsBulkAddRequest request) throws IOException, ApiException
      Bulk add document versions.
      Parameters:
      request - The request object
      Returns:
      BulkResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd

      public ApiResponse<BulkResponse> postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(ApiRequest<KnowledgeDocumentBulkVersionAddRequest> request) throws IOException
      Bulk add document versions.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseExportJobs

      public KnowledgeExportJobResponse postKnowledgeKnowledgebaseExportJobs(String knowledgeBaseId, KnowledgeExportJobRequest body) throws IOException, ApiException
      Create export job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeExportJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseExportJobsWithHttpInfo

      public ApiResponse<KnowledgeExportJobResponse> postKnowledgeKnowledgebaseExportJobsWithHttpInfo(String knowledgeBaseId, KnowledgeExportJobRequest body) throws IOException
      Create export job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeExportJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseExportJobs

      public KnowledgeExportJobResponse postKnowledgeKnowledgebaseExportJobs(PostKnowledgeKnowledgebaseExportJobsRequest request) throws IOException, ApiException
      Create export job
      Parameters:
      request - The request object
      Returns:
      KnowledgeExportJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseExportJobs

      public ApiResponse<KnowledgeExportJobResponse> postKnowledgeKnowledgebaseExportJobs(ApiRequest<KnowledgeExportJobRequest> request) throws IOException
      Create export job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseImportJobs

      public KnowledgeImportJobResponse postKnowledgeKnowledgebaseImportJobs(String knowledgeBaseId, KnowledgeImportJobRequest body) throws IOException, ApiException
      Create import job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeImportJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseImportJobsWithHttpInfo

      public ApiResponse<KnowledgeImportJobResponse> postKnowledgeKnowledgebaseImportJobsWithHttpInfo(String knowledgeBaseId, KnowledgeImportJobRequest body) throws IOException
      Create import job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeImportJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseImportJobs

      public KnowledgeImportJobResponse postKnowledgeKnowledgebaseImportJobs(PostKnowledgeKnowledgebaseImportJobsRequest request) throws IOException, ApiException
      Create import job
      Parameters:
      request - The request object
      Returns:
      KnowledgeImportJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseImportJobs

      public ApiResponse<KnowledgeImportJobResponse> postKnowledgeKnowledgebaseImportJobs(ApiRequest<KnowledgeImportJobRequest> request) throws IOException
      Create import job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseLabels

      public LabelResponse postKnowledgeKnowledgebaseLabels(String knowledgeBaseId, LabelCreateRequest body) throws IOException, ApiException
      Create new label
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      LabelResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseLabelsWithHttpInfo

      public ApiResponse<LabelResponse> postKnowledgeKnowledgebaseLabelsWithHttpInfo(String knowledgeBaseId, LabelCreateRequest body) throws IOException
      Create new label
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      LabelResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseLabels

      public LabelResponse postKnowledgeKnowledgebaseLabels(PostKnowledgeKnowledgebaseLabelsRequest request) throws IOException, ApiException
      Create new label
      Parameters:
      request - The request object
      Returns:
      LabelResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseLabels

      public ApiResponse<LabelResponse> postKnowledgeKnowledgebaseLabels(ApiRequest<LabelCreateRequest> request) throws IOException
      Create new label
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseParseJobImport

      public void postKnowledgeKnowledgebaseParseJobImport(String knowledgeBaseId, String parseJobId, KnowledgeParseJobRequestImport body) throws IOException, ApiException
      Import the parsed articles
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      parseJobId - Parse job ID (required)
      body - (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseParseJobImportWithHttpInfo

      public ApiResponse<Void> postKnowledgeKnowledgebaseParseJobImportWithHttpInfo(String knowledgeBaseId, String parseJobId, KnowledgeParseJobRequestImport body) throws IOException
      Import the parsed articles
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      parseJobId - Parse job ID (required)
      body - (required)
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseParseJobImport

      public void postKnowledgeKnowledgebaseParseJobImport(PostKnowledgeKnowledgebaseParseJobImportRequest request) throws IOException, ApiException
      Import the parsed articles
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseParseJobImport

      public ApiResponse<Void> postKnowledgeKnowledgebaseParseJobImport(ApiRequest<KnowledgeParseJobRequestImport> request) throws IOException
      Import the parsed articles
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseParseJobs

      public KnowledgeParseJobResponse postKnowledgeKnowledgebaseParseJobs(String knowledgeBaseId, KnowledgeParseJobRequest body) throws IOException, ApiException
      Create parse job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeParseJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseParseJobsWithHttpInfo

      public ApiResponse<KnowledgeParseJobResponse> postKnowledgeKnowledgebaseParseJobsWithHttpInfo(String knowledgeBaseId, KnowledgeParseJobRequest body) throws IOException
      Create parse job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeParseJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseParseJobs

      public KnowledgeParseJobResponse postKnowledgeKnowledgebaseParseJobs(PostKnowledgeKnowledgebaseParseJobsRequest request) throws IOException, ApiException
      Create parse job
      Parameters:
      request - The request object
      Returns:
      KnowledgeParseJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseParseJobs

      public ApiResponse<KnowledgeParseJobResponse> postKnowledgeKnowledgebaseParseJobs(ApiRequest<KnowledgeParseJobRequest> request) throws IOException
      Create parse job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesSalesforce

      public KnowledgeSyncJobResponse postKnowledgeKnowledgebaseSourcesSalesforce(String knowledgeBaseId, SalesforceSourceRequest body) throws IOException, ApiException
      Create Salesforce Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeSyncJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesSalesforceWithHttpInfo

      public ApiResponse<KnowledgeSyncJobResponse> postKnowledgeKnowledgebaseSourcesSalesforceWithHttpInfo(String knowledgeBaseId, SalesforceSourceRequest body) throws IOException
      Create Salesforce Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeSyncJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesSalesforce

      public KnowledgeSyncJobResponse postKnowledgeKnowledgebaseSourcesSalesforce(PostKnowledgeKnowledgebaseSourcesSalesforceRequest request) throws IOException, ApiException
      Create Salesforce Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      KnowledgeSyncJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesSalesforce

      public ApiResponse<KnowledgeSyncJobResponse> postKnowledgeKnowledgebaseSourcesSalesforce(ApiRequest<SalesforceSourceRequest> request) throws IOException
      Create Salesforce Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync

      public SourceSyncResponse postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(String knowledgeBaseId, String sourceId, Object body) throws IOException, ApiException
      Start sync on Salesforce Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      body - (optional)
      Returns:
      SourceSyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSyncWithHttpInfo

      public ApiResponse<SourceSyncResponse> postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSyncWithHttpInfo(String knowledgeBaseId, String sourceId, Object body) throws IOException
      Start sync on Salesforce Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      body - (optional)
      Returns:
      SourceSyncResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync

      public SourceSyncResponse postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(PostKnowledgeKnowledgebaseSourcesSalesforceSourceIdSyncRequest request) throws IOException, ApiException
      Start sync on Salesforce Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      SourceSyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync

      public ApiResponse<SourceSyncResponse> postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(ApiRequest<Object> request) throws IOException
      Start sync on Salesforce Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesServicenow

      public KnowledgeSyncJobResponse postKnowledgeKnowledgebaseSourcesServicenow(String knowledgeBaseId, ServiceNowSourceRequest body) throws IOException, ApiException
      Create ServiceNow Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeSyncJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesServicenowWithHttpInfo

      public ApiResponse<KnowledgeSyncJobResponse> postKnowledgeKnowledgebaseSourcesServicenowWithHttpInfo(String knowledgeBaseId, ServiceNowSourceRequest body) throws IOException
      Create ServiceNow Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeSyncJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesServicenow

      public KnowledgeSyncJobResponse postKnowledgeKnowledgebaseSourcesServicenow(PostKnowledgeKnowledgebaseSourcesServicenowRequest request) throws IOException, ApiException
      Create ServiceNow Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      KnowledgeSyncJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesServicenow

      public ApiResponse<KnowledgeSyncJobResponse> postKnowledgeKnowledgebaseSourcesServicenow(ApiRequest<ServiceNowSourceRequest> request) throws IOException
      Create ServiceNow Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync

      public SourceSyncResponse postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(String knowledgeBaseId, String sourceId, Object body) throws IOException, ApiException
      Start synchronization on ServiceNow Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      body - (optional)
      Returns:
      SourceSyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesServicenowSourceIdSyncWithHttpInfo

      public ApiResponse<SourceSyncResponse> postKnowledgeKnowledgebaseSourcesServicenowSourceIdSyncWithHttpInfo(String knowledgeBaseId, String sourceId, Object body) throws IOException
      Start synchronization on ServiceNow Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      body - (optional)
      Returns:
      SourceSyncResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync

      public SourceSyncResponse postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(PostKnowledgeKnowledgebaseSourcesServicenowSourceIdSyncRequest request) throws IOException, ApiException
      Start synchronization on ServiceNow Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      SourceSyncResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync

      public ApiResponse<SourceSyncResponse> postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(ApiRequest<Object> request) throws IOException
      Start synchronization on ServiceNow Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSynchronizeJobs

      public KnowledgeSyncJobResponse postKnowledgeKnowledgebaseSynchronizeJobs(String knowledgeBaseId, KnowledgeSyncJobRequest body) throws IOException, ApiException
      Create synchronization job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeSyncJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSynchronizeJobsWithHttpInfo

      public ApiResponse<KnowledgeSyncJobResponse> postKnowledgeKnowledgebaseSynchronizeJobsWithHttpInfo(String knowledgeBaseId, KnowledgeSyncJobRequest body) throws IOException
      Create synchronization job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - (required)
      Returns:
      KnowledgeSyncJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSynchronizeJobs

      public KnowledgeSyncJobResponse postKnowledgeKnowledgebaseSynchronizeJobs(PostKnowledgeKnowledgebaseSynchronizeJobsRequest request) throws IOException, ApiException
      Create synchronization job
      Parameters:
      request - The request object
      Returns:
      KnowledgeSyncJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseSynchronizeJobs

      public ApiResponse<KnowledgeSyncJobResponse> postKnowledgeKnowledgebaseSynchronizeJobs(ApiRequest<KnowledgeSyncJobRequest> request) throws IOException
      Create synchronization job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseUploadsUrlsJobs

      public CreateUploadSourceUrlJobResponse postKnowledgeKnowledgebaseUploadsUrlsJobs(String knowledgeBaseId, CreateUploadSourceUrlJobRequest body) throws IOException, ApiException
      Create content upload from URL job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - uploadRequest (required)
      Returns:
      CreateUploadSourceUrlJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseUploadsUrlsJobsWithHttpInfo

      public ApiResponse<CreateUploadSourceUrlJobResponse> postKnowledgeKnowledgebaseUploadsUrlsJobsWithHttpInfo(String knowledgeBaseId, CreateUploadSourceUrlJobRequest body) throws IOException
      Create content upload from URL job
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      body - uploadRequest (required)
      Returns:
      CreateUploadSourceUrlJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseUploadsUrlsJobs

      public CreateUploadSourceUrlJobResponse postKnowledgeKnowledgebaseUploadsUrlsJobs(PostKnowledgeKnowledgebaseUploadsUrlsJobsRequest request) throws IOException, ApiException
      Create content upload from URL job
      Parameters:
      request - The request object
      Returns:
      CreateUploadSourceUrlJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebaseUploadsUrlsJobs

      public ApiResponse<CreateUploadSourceUrlJobResponse> postKnowledgeKnowledgebaseUploadsUrlsJobs(ApiRequest<CreateUploadSourceUrlJobRequest> request) throws IOException
      Create content upload from URL job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebases

      public KnowledgeBase postKnowledgeKnowledgebases(KnowledgeBaseCreateRequest body) throws IOException, ApiException
      Create new knowledge base
      Parameters:
      body - (required)
      Returns:
      KnowledgeBase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebasesWithHttpInfo

      public ApiResponse<KnowledgeBase> postKnowledgeKnowledgebasesWithHttpInfo(KnowledgeBaseCreateRequest body) throws IOException
      Create new knowledge base
      Parameters:
      body - (required)
      Returns:
      KnowledgeBase
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebases

      public KnowledgeBase postKnowledgeKnowledgebases(PostKnowledgeKnowledgebasesRequest request) throws IOException, ApiException
      Create new knowledge base
      Parameters:
      request - The request object
      Returns:
      KnowledgeBase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeKnowledgebases

      public ApiResponse<KnowledgeBase> postKnowledgeKnowledgebases(ApiRequest<KnowledgeBaseCreateRequest> request) throws IOException
      Create new knowledge base
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeSearch

      public KnowledgeSourcesSearchResponse postKnowledgeSearch(KnowledgeSourcesSearchRequest body) throws IOException, ApiException
      Get Knowledge Search
      Parameters:
      body - (optional)
      Returns:
      KnowledgeSourcesSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeSearchWithHttpInfo

      public ApiResponse<KnowledgeSourcesSearchResponse> postKnowledgeSearchWithHttpInfo(KnowledgeSourcesSearchRequest body) throws IOException
      Get Knowledge Search
      Parameters:
      body - (optional)
      Returns:
      KnowledgeSourcesSearchResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeSearch

      public KnowledgeSourcesSearchResponse postKnowledgeSearch(PostKnowledgeSearchRequest request) throws IOException, ApiException
      Get Knowledge Search
      Parameters:
      request - The request object
      Returns:
      KnowledgeSourcesSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeSearch

      public ApiResponse<KnowledgeSourcesSearchResponse> postKnowledgeSearch(ApiRequest<KnowledgeSourcesSearchRequest> request) throws IOException
      Get Knowledge Search
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeSearchPreview

      public KnowledgeSearchPreviewResponse postKnowledgeSearchPreview(KnowledgeSearchPreviewRequest body) throws IOException, ApiException
      Get Knowledge Search Preview
      Parameters:
      body - (optional)
      Returns:
      KnowledgeSearchPreviewResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeSearchPreviewWithHttpInfo

      public ApiResponse<KnowledgeSearchPreviewResponse> postKnowledgeSearchPreviewWithHttpInfo(KnowledgeSearchPreviewRequest body) throws IOException
      Get Knowledge Search Preview
      Parameters:
      body - (optional)
      Returns:
      KnowledgeSearchPreviewResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeSearchPreview

      public KnowledgeSearchPreviewResponse postKnowledgeSearchPreview(PostKnowledgeSearchPreviewRequest request) throws IOException, ApiException
      Get Knowledge Search Preview
      Parameters:
      request - The request object
      Returns:
      KnowledgeSearchPreviewResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeSearchPreview

      public ApiResponse<KnowledgeSearchPreviewResponse> postKnowledgeSearchPreview(ApiRequest<KnowledgeSearchPreviewRequest> request) throws IOException
      Get Knowledge Search Preview
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeSettings

      public KnowledgeSettingsResponse postKnowledgeSettings(KnowledgeSettingsRequest body) throws IOException, ApiException
      Create Knowledge setting.
      Parameters:
      body - (optional)
      Returns:
      KnowledgeSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeSettingsWithHttpInfo

      public ApiResponse<KnowledgeSettingsResponse> postKnowledgeSettingsWithHttpInfo(KnowledgeSettingsRequest body) throws IOException
      Create Knowledge setting.
      Parameters:
      body - (optional)
      Returns:
      KnowledgeSettingsResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeSettings

      public KnowledgeSettingsResponse postKnowledgeSettings(PostKnowledgeSettingsRequest request) throws IOException, ApiException
      Create Knowledge setting.
      Parameters:
      request - The request object
      Returns:
      KnowledgeSettingsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeSettings

      public ApiResponse<KnowledgeSettingsResponse> postKnowledgeSettings(ApiRequest<KnowledgeSettingsRequest> request) throws IOException
      Create Knowledge setting.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeSourceSynchronizationUploads

      public V3SynchronizationUploadUrlResponse postKnowledgeSourceSynchronizationUploads(String sourceId, String synchronizationId, V3SynchronizationUploadUrlRequest body) throws IOException, ApiException
      Create presigned URL for uploading a file in the synchronization.
      Parameters:
      sourceId - Source ID (required)
      synchronizationId - Synchronization ID (required)
      body - (required)
      Returns:
      V3SynchronizationUploadUrlResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeSourceSynchronizationUploadsWithHttpInfo

      public ApiResponse<V3SynchronizationUploadUrlResponse> postKnowledgeSourceSynchronizationUploadsWithHttpInfo(String sourceId, String synchronizationId, V3SynchronizationUploadUrlRequest body) throws IOException
      Create presigned URL for uploading a file in the synchronization.
      Parameters:
      sourceId - Source ID (required)
      synchronizationId - Synchronization ID (required)
      body - (required)
      Returns:
      V3SynchronizationUploadUrlResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeSourceSynchronizationUploads

      public V3SynchronizationUploadUrlResponse postKnowledgeSourceSynchronizationUploads(PostKnowledgeSourceSynchronizationUploadsRequest request) throws IOException, ApiException
      Create presigned URL for uploading a file in the synchronization.
      Parameters:
      request - The request object
      Returns:
      V3SynchronizationUploadUrlResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeSourceSynchronizationUploads

      public ApiResponse<V3SynchronizationUploadUrlResponse> postKnowledgeSourceSynchronizationUploads(ApiRequest<V3SynchronizationUploadUrlRequest> request) throws IOException
      Create presigned URL for uploading a file in the synchronization.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeSourceSynchronizations

      public V3Synchronization postKnowledgeSourceSynchronizations(String sourceId, V3StartManualSyncRequest body) throws IOException, ApiException
      Start a manual synchronization from a source.
      Parameters:
      sourceId - Source ID (required)
      body - (optional)
      Returns:
      V3Synchronization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeSourceSynchronizationsWithHttpInfo

      public ApiResponse<V3Synchronization> postKnowledgeSourceSynchronizationsWithHttpInfo(String sourceId, V3StartManualSyncRequest body) throws IOException
      Start a manual synchronization from a source.
      Parameters:
      sourceId - Source ID (required)
      body - (optional)
      Returns:
      V3Synchronization
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeSourceSynchronizations

      public V3Synchronization postKnowledgeSourceSynchronizations(PostKnowledgeSourceSynchronizationsRequest request) throws IOException, ApiException
      Start a manual synchronization from a source.
      Parameters:
      request - The request object
      Returns:
      V3Synchronization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeSourceSynchronizations

      public ApiResponse<V3Synchronization> postKnowledgeSourceSynchronizations(ApiRequest<V3StartManualSyncRequest> request) throws IOException
      Start a manual synchronization from a source.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeSources

      public V3SourceDetailedResponse postKnowledgeSources(V3SourceCreateRequest body) throws IOException, ApiException
      Create a new source
      Parameters:
      body - (required)
      Returns:
      V3SourceDetailedResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeSourcesWithHttpInfo

      public ApiResponse<V3SourceDetailedResponse> postKnowledgeSourcesWithHttpInfo(V3SourceCreateRequest body) throws IOException
      Create a new source
      Parameters:
      body - (required)
      Returns:
      V3SourceDetailedResponse
      Throws:
      IOException - if the request fails to be processed

    • postKnowledgeSources

      public V3SourceDetailedResponse postKnowledgeSources(PostKnowledgeSourcesRequest request) throws IOException, ApiException
      Create a new source
      Parameters:
      request - The request object
      Returns:
      V3SourceDetailedResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postKnowledgeSources

      public ApiResponse<V3SourceDetailedResponse> postKnowledgeSources(ApiRequest<V3SourceCreateRequest> request) throws IOException
      Create a new source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putKnowledgeKnowledgebaseSourcesSalesforceSourceId

      public SalesforceSourceResponse putKnowledgeKnowledgebaseSourcesSalesforceSourceId(String knowledgeBaseId, String sourceId, SalesforceSourceRequest body) throws IOException, ApiException
      Update Salesforce Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      body - (required)
      Returns:
      SalesforceSourceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putKnowledgeKnowledgebaseSourcesSalesforceSourceIdWithHttpInfo

      public ApiResponse<SalesforceSourceResponse> putKnowledgeKnowledgebaseSourcesSalesforceSourceIdWithHttpInfo(String knowledgeBaseId, String sourceId, SalesforceSourceRequest body) throws IOException
      Update Salesforce Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      body - (required)
      Returns:
      SalesforceSourceResponse
      Throws:
      IOException - if the request fails to be processed

    • putKnowledgeKnowledgebaseSourcesSalesforceSourceId

      public SalesforceSourceResponse putKnowledgeKnowledgebaseSourcesSalesforceSourceId(PutKnowledgeKnowledgebaseSourcesSalesforceSourceIdRequest request) throws IOException, ApiException
      Update Salesforce Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      SalesforceSourceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putKnowledgeKnowledgebaseSourcesSalesforceSourceId

      public ApiResponse<SalesforceSourceResponse> putKnowledgeKnowledgebaseSourcesSalesforceSourceId(ApiRequest<SalesforceSourceRequest> request) throws IOException
      Update Salesforce Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putKnowledgeKnowledgebaseSourcesServicenowSourceId

      public ServiceNowSourceResponse putKnowledgeKnowledgebaseSourcesServicenowSourceId(String knowledgeBaseId, String sourceId, ServiceNowSourceRequest body) throws IOException, ApiException
      Update ServiceNow Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      body - (required)
      Returns:
      ServiceNowSourceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putKnowledgeKnowledgebaseSourcesServicenowSourceIdWithHttpInfo

      public ApiResponse<ServiceNowSourceResponse> putKnowledgeKnowledgebaseSourcesServicenowSourceIdWithHttpInfo(String knowledgeBaseId, String sourceId, ServiceNowSourceRequest body) throws IOException
      Update ServiceNow Knowledge integration source
      Parameters:
      knowledgeBaseId - Knowledge base ID (required)
      sourceId - Source ID (required)
      body - (required)
      Returns:
      ServiceNowSourceResponse
      Throws:
      IOException - if the request fails to be processed

    • putKnowledgeKnowledgebaseSourcesServicenowSourceId

      public ServiceNowSourceResponse putKnowledgeKnowledgebaseSourcesServicenowSourceId(PutKnowledgeKnowledgebaseSourcesServicenowSourceIdRequest request) throws IOException, ApiException
      Update ServiceNow Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      ServiceNowSourceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putKnowledgeKnowledgebaseSourcesServicenowSourceId

      public ApiResponse<ServiceNowSourceResponse> putKnowledgeKnowledgebaseSourcesServicenowSourceId(ApiRequest<ServiceNowSourceRequest> request) throws IOException
      Update ServiceNow Knowledge integration source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putKnowledgeSource

      public V3SourceDetailedResponse putKnowledgeSource(String sourceId, V3SourceUpdateRequest body) throws IOException, ApiException
      Update the source
      Parameters:
      sourceId - Source ID (required)
      body - (required)
      Returns:
      V3SourceDetailedResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putKnowledgeSourceWithHttpInfo

      public ApiResponse<V3SourceDetailedResponse> putKnowledgeSourceWithHttpInfo(String sourceId, V3SourceUpdateRequest body) throws IOException
      Update the source
      Parameters:
      sourceId - Source ID (required)
      body - (required)
      Returns:
      V3SourceDetailedResponse
      Throws:
      IOException - if the request fails to be processed

    • putKnowledgeSource

      public V3SourceDetailedResponse putKnowledgeSource(PutKnowledgeSourceRequest request) throws IOException, ApiException
      Update the source
      Parameters:
      request - The request object
      Returns:
      V3SourceDetailedResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putKnowledgeSource

      public ApiResponse<V3SourceDetailedResponse> putKnowledgeSource(ApiRequest<V3SourceUpdateRequest> request) throws IOException
      Update the source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed