class PureCloud::KnowledgeApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 23
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

delete_knowledge_knowledgebase(knowledge_base_id, opts = {}) click to toggle source

Delete knowledge base

@param knowledge_base_id Knowledge base ID @param [Hash] opts the optional parameters @return [KnowledgeBase]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 32
def delete_knowledge_knowledgebase(knowledge_base_id, opts = {})
  data, _status_code, _headers = delete_knowledge_knowledgebase_with_http_info(knowledge_base_id, opts)
  return data
end
delete_knowledge_knowledgebase_language_category(category_id, knowledge_base_id, language_code, opts = {}) click to toggle source

Delete category

@param category_id Category ID @param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @return [KnowledgeCategory]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 99
def delete_knowledge_knowledgebase_language_category(category_id, knowledge_base_id, language_code, opts = {})
  data, _status_code, _headers = delete_knowledge_knowledgebase_language_category_with_http_info(category_id, knowledge_base_id, language_code, opts)
  return data
end
delete_knowledge_knowledgebase_language_category_with_http_info(category_id, knowledge_base_id, language_code, opts = {}) click to toggle source

Delete category

@param category_id Category ID @param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @return [Array<(KnowledgeCategory, Fixnum, Hash)>] KnowledgeCategory data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 111
def delete_knowledge_knowledgebase_language_category_with_http_info(category_id, knowledge_base_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.delete_knowledge_knowledgebase_language_category ..."
  end
  
  
  # verify the required parameter 'category_id' is set
  fail ArgumentError, "Missing the required parameter 'category_id' when calling KnowledgeApi.delete_knowledge_knowledgebase_language_category" if category_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.delete_knowledge_knowledgebase_language_category" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling KnowledgeApi.delete_knowledge_knowledgebase_language_category" if language_code.nil?
  
  # verify enum value
  unless ['en-US'].include?(language_code)
    fail ArgumentError, "invalid value for 'language_code', must be one of en-US"
  end
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}".sub('{format}','json').sub('{' + 'categoryId' + '}', category_id.to_s).sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeCategory')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#delete_knowledge_knowledgebase_language_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_knowledge_knowledgebase_language_document(document_id, knowledge_base_id, language_code, opts = {}) click to toggle source

Delete document

@param document_id Document ID @param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @return [KnowledgeDocument]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 189
def delete_knowledge_knowledgebase_language_document(document_id, knowledge_base_id, language_code, opts = {})
  data, _status_code, _headers = delete_knowledge_knowledgebase_language_document_with_http_info(document_id, knowledge_base_id, language_code, opts)
  return data
end
delete_knowledge_knowledgebase_language_document_with_http_info(document_id, knowledge_base_id, language_code, opts = {}) click to toggle source

Delete document

@param document_id Document ID @param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @return [Array<(KnowledgeDocument, Fixnum, Hash)>] KnowledgeDocument data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 201
def delete_knowledge_knowledgebase_language_document_with_http_info(document_id, knowledge_base_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.delete_knowledge_knowledgebase_language_document ..."
  end
  
  
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling KnowledgeApi.delete_knowledge_knowledgebase_language_document" if document_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.delete_knowledge_knowledgebase_language_document" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling KnowledgeApi.delete_knowledge_knowledgebase_language_document" if language_code.nil?
  
  # verify enum value
  unless ['en-US'].include?(language_code)
    fail ArgumentError, "invalid value for 'language_code', must be one of en-US"
  end
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeDocument')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#delete_knowledge_knowledgebase_language_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_knowledge_knowledgebase_with_http_info(knowledge_base_id, opts = {}) click to toggle source

Delete knowledge base

@param knowledge_base_id Knowledge base ID @param [Hash] opts the optional parameters @return [Array<(KnowledgeBase, Fixnum, Hash)>] KnowledgeBase data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 42
def delete_knowledge_knowledgebase_with_http_info(knowledge_base_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.delete_knowledge_knowledgebase ..."
  end
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.delete_knowledge_knowledgebase" if knowledge_base_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}".sub('{format}','json').sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#delete_knowledge_knowledgebase\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_knowledge_knowledgebase(knowledge_base_id, opts = {}) click to toggle source

Get knowledge base

@param knowledge_base_id Knowledge base ID @param [Hash] opts the optional parameters @return [KnowledgeBase]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 277
def get_knowledge_knowledgebase(knowledge_base_id, opts = {})
  data, _status_code, _headers = get_knowledge_knowledgebase_with_http_info(knowledge_base_id, opts)
  return data
end
get_knowledge_knowledgebase_language_categories(knowledge_base_id, language_code, opts = {}) click to toggle source

Get categories

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @option opts [String] :before The cursor that points to the start of the set of entities that has been returned. @option opts [String] :after The cursor that points to the end of the set of entities that has been returned. @option opts [String] :limit Number of entities to return. Maximum of 200. @option opts [String] :page_size Number of entities to return. Maximum of 200. @return [CategoryListing]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 347
def get_knowledge_knowledgebase_language_categories(knowledge_base_id, language_code, opts = {})
  data, _status_code, _headers = get_knowledge_knowledgebase_language_categories_with_http_info(knowledge_base_id, language_code, opts)
  return data
end
get_knowledge_knowledgebase_language_categories_with_http_info(knowledge_base_id, language_code, opts = {}) click to toggle source

Get categories

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @option opts [String] :before The cursor that points to the start of the set of entities that has been returned. @option opts [String] :after The cursor that points to the end of the set of entities that has been returned. @option opts [String] :limit Number of entities to return. Maximum of 200. @option opts [String] :page_size Number of entities to return. Maximum of 200. @return [Array<(CategoryListing, Fixnum, Hash)>] CategoryListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 362
def get_knowledge_knowledgebase_language_categories_with_http_info(knowledge_base_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.get_knowledge_knowledgebase_language_categories ..."
  end
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.get_knowledge_knowledgebase_language_categories" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling KnowledgeApi.get_knowledge_knowledgebase_language_categories" if language_code.nil?
  
  # verify enum value
  unless ['en-US'].include?(language_code)
    fail ArgumentError, "invalid value for 'language_code', must be one of en-US"
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories".sub('{format}','json').sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s)

  # query parameters
  query_params = {}
  query_params[:'before'] = opts[:'before'] if opts[:'before']
  query_params[:'after'] = opts[:'after'] if opts[:'after']
  query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CategoryListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#get_knowledge_knowledgebase_language_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_knowledge_knowledgebase_language_category(category_id, knowledge_base_id, language_code, opts = {}) click to toggle source

Get category

@param category_id Category ID @param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @return [KnowledgeExtendedCategory]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 460
def get_knowledge_knowledgebase_language_category(category_id, knowledge_base_id, language_code, opts = {})
  data, _status_code, _headers = get_knowledge_knowledgebase_language_category_with_http_info(category_id, knowledge_base_id, language_code, opts)
  return data
end
get_knowledge_knowledgebase_language_category_with_http_info(category_id, knowledge_base_id, language_code, opts = {}) click to toggle source

Get category

@param category_id Category ID @param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @return [Array<(KnowledgeExtendedCategory, Fixnum, Hash)>] KnowledgeExtendedCategory data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 472
def get_knowledge_knowledgebase_language_category_with_http_info(category_id, knowledge_base_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.get_knowledge_knowledgebase_language_category ..."
  end
  
  
  # verify the required parameter 'category_id' is set
  fail ArgumentError, "Missing the required parameter 'category_id' when calling KnowledgeApi.get_knowledge_knowledgebase_language_category" if category_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.get_knowledge_knowledgebase_language_category" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling KnowledgeApi.get_knowledge_knowledgebase_language_category" if language_code.nil?
  
  # verify enum value
  unless ['en-US'].include?(language_code)
    fail ArgumentError, "invalid value for 'language_code', must be one of en-US"
  end
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}".sub('{format}','json').sub('{' + 'categoryId' + '}', category_id.to_s).sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeExtendedCategory')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#get_knowledge_knowledgebase_language_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_knowledge_knowledgebase_language_document(document_id, knowledge_base_id, language_code, opts = {}) click to toggle source

Get document

@param document_id Document ID @param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @return [KnowledgeDocument]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 550
def get_knowledge_knowledgebase_language_document(document_id, knowledge_base_id, language_code, opts = {})
  data, _status_code, _headers = get_knowledge_knowledgebase_language_document_with_http_info(document_id, knowledge_base_id, language_code, opts)
  return data
end
get_knowledge_knowledgebase_language_document_with_http_info(document_id, knowledge_base_id, language_code, opts = {}) click to toggle source

Get document

@param document_id Document ID @param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @return [Array<(KnowledgeDocument, Fixnum, Hash)>] KnowledgeDocument data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 562
def get_knowledge_knowledgebase_language_document_with_http_info(document_id, knowledge_base_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.get_knowledge_knowledgebase_language_document ..."
  end
  
  
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling KnowledgeApi.get_knowledge_knowledgebase_language_document" if document_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.get_knowledge_knowledgebase_language_document" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling KnowledgeApi.get_knowledge_knowledgebase_language_document" if language_code.nil?
  
  # verify enum value
  unless ['en-US'].include?(language_code)
    fail ArgumentError, "invalid value for 'language_code', must be one of en-US"
  end
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeDocument')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#get_knowledge_knowledgebase_language_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_knowledge_knowledgebase_language_documents(knowledge_base_id, language_code, opts = {}) click to toggle source

Get documents

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @option opts [String] :before The cursor that points to the start of the set of entities that has been returned. @option opts [String] :after The cursor that points to the end of the set of entities that has been returned. @option opts [String] :limit Number of entities to return. Maximum of 200. @option opts [String] :page_size Number of entities to return. Maximum of 200. @option opts [String] :categories Filter by categories ids, comma separated values expected. @return [DocumentListing]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 644
def get_knowledge_knowledgebase_language_documents(knowledge_base_id, language_code, opts = {})
  data, _status_code, _headers = get_knowledge_knowledgebase_language_documents_with_http_info(knowledge_base_id, language_code, opts)
  return data
end
get_knowledge_knowledgebase_language_documents_with_http_info(knowledge_base_id, language_code, opts = {}) click to toggle source

Get documents

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @option opts [String] :before The cursor that points to the start of the set of entities that has been returned. @option opts [String] :after The cursor that points to the end of the set of entities that has been returned. @option opts [String] :limit Number of entities to return. Maximum of 200. @option opts [String] :page_size Number of entities to return. Maximum of 200. @option opts [String] :categories Filter by categories ids, comma separated values expected. @return [Array<(DocumentListing, Fixnum, Hash)>] DocumentListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 660
def get_knowledge_knowledgebase_language_documents_with_http_info(knowledge_base_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.get_knowledge_knowledgebase_language_documents ..."
  end
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.get_knowledge_knowledgebase_language_documents" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling KnowledgeApi.get_knowledge_knowledgebase_language_documents" if language_code.nil?
  
  # verify enum value
  unless ['en-US'].include?(language_code)
    fail ArgumentError, "invalid value for 'language_code', must be one of en-US"
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents".sub('{format}','json').sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s)

  # query parameters
  query_params = {}
  query_params[:'before'] = opts[:'before'] if opts[:'before']
  query_params[:'after'] = opts[:'after'] if opts[:'after']
  query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'categories'] = opts[:'categories'] if opts[:'categories']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#get_knowledge_knowledgebase_language_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_knowledge_knowledgebase_language_training(knowledge_base_id, language_code, training_id, opts = {}) click to toggle source

Get training detail

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param training_id Training ID @param [Hash] opts the optional parameters @return [KnowledgeTraining]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 765
def get_knowledge_knowledgebase_language_training(knowledge_base_id, language_code, training_id, opts = {})
  data, _status_code, _headers = get_knowledge_knowledgebase_language_training_with_http_info(knowledge_base_id, language_code, training_id, opts)
  return data
end
get_knowledge_knowledgebase_language_training_with_http_info(knowledge_base_id, language_code, training_id, opts = {}) click to toggle source

Get training detail

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param training_id Training ID @param [Hash] opts the optional parameters @return [Array<(KnowledgeTraining, Fixnum, Hash)>] KnowledgeTraining data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 777
def get_knowledge_knowledgebase_language_training_with_http_info(knowledge_base_id, language_code, training_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.get_knowledge_knowledgebase_language_training ..."
  end
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.get_knowledge_knowledgebase_language_training" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling KnowledgeApi.get_knowledge_knowledgebase_language_training" if language_code.nil?
  
  # verify enum value
  unless ['en-US'].include?(language_code)
    fail ArgumentError, "invalid value for 'language_code', must be one of en-US"
  end
  
  
  
  
  
  
  # verify the required parameter 'training_id' is set
  fail ArgumentError, "Missing the required parameter 'training_id' when calling KnowledgeApi.get_knowledge_knowledgebase_language_training" if training_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}".sub('{format}','json').sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s).sub('{' + 'trainingId' + '}', training_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeTraining')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#get_knowledge_knowledgebase_language_training\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_knowledge_knowledgebase_language_trainings(knowledge_base_id, language_code, opts = {}) click to toggle source

Get All trainings information for a knowledgebase

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @option opts [String] :before The cursor that points to the start of the set of entities that has been returned. @option opts [String] :after The cursor that points to the end of the set of entities that has been returned. @option opts [String] :limit Number of entities to return. Maximum of 200. @option opts [String] :page_size Number of entities to return. Maximum of 200. @return [TrainingListing]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 858
def get_knowledge_knowledgebase_language_trainings(knowledge_base_id, language_code, opts = {})
  data, _status_code, _headers = get_knowledge_knowledgebase_language_trainings_with_http_info(knowledge_base_id, language_code, opts)
  return data
end
get_knowledge_knowledgebase_language_trainings_with_http_info(knowledge_base_id, language_code, opts = {}) click to toggle source

Get All trainings information for a knowledgebase

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @option opts [String] :before The cursor that points to the start of the set of entities that has been returned. @option opts [String] :after The cursor that points to the end of the set of entities that has been returned. @option opts [String] :limit Number of entities to return. Maximum of 200. @option opts [String] :page_size Number of entities to return. Maximum of 200. @return [Array<(TrainingListing, Fixnum, Hash)>] TrainingListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 873
def get_knowledge_knowledgebase_language_trainings_with_http_info(knowledge_base_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.get_knowledge_knowledgebase_language_trainings ..."
  end
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.get_knowledge_knowledgebase_language_trainings" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling KnowledgeApi.get_knowledge_knowledgebase_language_trainings" if language_code.nil?
  
  # verify enum value
  unless ['en-US'].include?(language_code)
    fail ArgumentError, "invalid value for 'language_code', must be one of en-US"
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings".sub('{format}','json').sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s)

  # query parameters
  query_params = {}
  query_params[:'before'] = opts[:'before'] if opts[:'before']
  query_params[:'after'] = opts[:'after'] if opts[:'after']
  query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TrainingListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#get_knowledge_knowledgebase_language_trainings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_knowledge_knowledgebase_with_http_info(knowledge_base_id, opts = {}) click to toggle source

Get knowledge base

@param knowledge_base_id Knowledge base ID @param [Hash] opts the optional parameters @return [Array<(KnowledgeBase, Fixnum, Hash)>] KnowledgeBase data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 287
def get_knowledge_knowledgebase_with_http_info(knowledge_base_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.get_knowledge_knowledgebase ..."
  end
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.get_knowledge_knowledgebase" if knowledge_base_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}".sub('{format}','json').sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#get_knowledge_knowledgebase\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_knowledge_knowledgebases(opts = {}) click to toggle source

Get knowledge bases

@param [Hash] opts the optional parameters @option opts [String] :before The cursor that points to the start of the set of entities that has been returned. @option opts [String] :after The cursor that points to the end of the set of entities that has been returned. @option opts [String] :limit Number of entities to return. Maximum of 200. @option opts [String] :page_size Number of entities to return. Maximum of 200. @return [KnowledgeBaseListing]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 972
def get_knowledge_knowledgebases(opts = {})
  data, _status_code, _headers = get_knowledge_knowledgebases_with_http_info(opts)
  return data
end
get_knowledge_knowledgebases_with_http_info(opts = {}) click to toggle source

Get knowledge bases

@param [Hash] opts the optional parameters @option opts [String] :before The cursor that points to the start of the set of entities that has been returned. @option opts [String] :after The cursor that points to the end of the set of entities that has been returned. @option opts [String] :limit Number of entities to return. Maximum of 200. @option opts [String] :page_size Number of entities to return. Maximum of 200. @return [Array<(KnowledgeBaseListing, Fixnum, Hash)>] KnowledgeBaseListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 985
def get_knowledge_knowledgebases_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.get_knowledge_knowledgebases ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'before'] = opts[:'before'] if opts[:'before']
  query_params[:'after'] = opts[:'after'] if opts[:'after']
  query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeBaseListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#get_knowledge_knowledgebases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_knowledge_knowledgebase(knowledge_base_id, body, opts = {}) click to toggle source

Update knowledge base

@param knowledge_base_id Knowledge base ID @param body @param [Hash] opts the optional parameters @return [KnowledgeBase]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1061
def patch_knowledge_knowledgebase(knowledge_base_id, body, opts = {})
  data, _status_code, _headers = patch_knowledge_knowledgebase_with_http_info(knowledge_base_id, body, opts)
  return data
end
patch_knowledge_knowledgebase_language_category(category_id, knowledge_base_id, language_code, body, opts = {}) click to toggle source

Update category

@param category_id Category ID @param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param body @param [Hash] opts the optional parameters @return [KnowledgeExtendedCategory]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1138
def patch_knowledge_knowledgebase_language_category(category_id, knowledge_base_id, language_code, body, opts = {})
  data, _status_code, _headers = patch_knowledge_knowledgebase_language_category_with_http_info(category_id, knowledge_base_id, language_code, body, opts)
  return data
end
patch_knowledge_knowledgebase_language_category_with_http_info(category_id, knowledge_base_id, language_code, body, opts = {}) click to toggle source

Update category

@param category_id Category ID @param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param body @param [Hash] opts the optional parameters @return [Array<(KnowledgeExtendedCategory, Fixnum, Hash)>] KnowledgeExtendedCategory data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1151
def patch_knowledge_knowledgebase_language_category_with_http_info(category_id, knowledge_base_id, language_code, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.patch_knowledge_knowledgebase_language_category ..."
  end
  
  
  # verify the required parameter 'category_id' is set
  fail ArgumentError, "Missing the required parameter 'category_id' when calling KnowledgeApi.patch_knowledge_knowledgebase_language_category" if category_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.patch_knowledge_knowledgebase_language_category" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling KnowledgeApi.patch_knowledge_knowledgebase_language_category" if language_code.nil?
  
  # verify enum value
  unless ['en-US'].include?(language_code)
    fail ArgumentError, "invalid value for 'language_code', must be one of en-US"
  end
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling KnowledgeApi.patch_knowledge_knowledgebase_language_category" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}".sub('{format}','json').sub('{' + 'categoryId' + '}', category_id.to_s).sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeExtendedCategory')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#patch_knowledge_knowledgebase_language_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_knowledge_knowledgebase_language_document(document_id, knowledge_base_id, language_code, body, opts = {}) click to toggle source

Update document

@param document_id Document ID @param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param body @param [Hash] opts the optional parameters @return [KnowledgeDocument]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1238
def patch_knowledge_knowledgebase_language_document(document_id, knowledge_base_id, language_code, body, opts = {})
  data, _status_code, _headers = patch_knowledge_knowledgebase_language_document_with_http_info(document_id, knowledge_base_id, language_code, body, opts)
  return data
end
patch_knowledge_knowledgebase_language_document_with_http_info(document_id, knowledge_base_id, language_code, body, opts = {}) click to toggle source

Update document

@param document_id Document ID @param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param body @param [Hash] opts the optional parameters @return [Array<(KnowledgeDocument, Fixnum, Hash)>] KnowledgeDocument data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1251
def patch_knowledge_knowledgebase_language_document_with_http_info(document_id, knowledge_base_id, language_code, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.patch_knowledge_knowledgebase_language_document ..."
  end
  
  
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling KnowledgeApi.patch_knowledge_knowledgebase_language_document" if document_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.patch_knowledge_knowledgebase_language_document" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling KnowledgeApi.patch_knowledge_knowledgebase_language_document" if language_code.nil?
  
  # verify enum value
  unless ['en-US'].include?(language_code)
    fail ArgumentError, "invalid value for 'language_code', must be one of en-US"
  end
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling KnowledgeApi.patch_knowledge_knowledgebase_language_document" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeDocument')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#patch_knowledge_knowledgebase_language_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_knowledge_knowledgebase_language_documents(knowledge_base_id, language_code, body, opts = {}) click to toggle source

Update documents collection

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param body @param [Hash] opts the optional parameters @return [DocumentListing]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1337
def patch_knowledge_knowledgebase_language_documents(knowledge_base_id, language_code, body, opts = {})
  data, _status_code, _headers = patch_knowledge_knowledgebase_language_documents_with_http_info(knowledge_base_id, language_code, body, opts)
  return data
end
patch_knowledge_knowledgebase_language_documents_with_http_info(knowledge_base_id, language_code, body, opts = {}) click to toggle source

Update documents collection

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param body @param [Hash] opts the optional parameters @return [Array<(DocumentListing, Fixnum, Hash)>] DocumentListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1349
def patch_knowledge_knowledgebase_language_documents_with_http_info(knowledge_base_id, language_code, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.patch_knowledge_knowledgebase_language_documents ..."
  end
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.patch_knowledge_knowledgebase_language_documents" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling KnowledgeApi.patch_knowledge_knowledgebase_language_documents" if language_code.nil?
  
  # verify enum value
  unless ['en-US'].include?(language_code)
    fail ArgumentError, "invalid value for 'language_code', must be one of en-US"
  end
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling KnowledgeApi.patch_knowledge_knowledgebase_language_documents" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents".sub('{format}','json').sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#patch_knowledge_knowledgebase_language_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_knowledge_knowledgebase_with_http_info(knowledge_base_id, body, opts = {}) click to toggle source

Update knowledge base

@param knowledge_base_id Knowledge base ID @param body @param [Hash] opts the optional parameters @return [Array<(KnowledgeBase, Fixnum, Hash)>] KnowledgeBase data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1072
def patch_knowledge_knowledgebase_with_http_info(knowledge_base_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.patch_knowledge_knowledgebase ..."
  end
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.patch_knowledge_knowledgebase" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling KnowledgeApi.patch_knowledge_knowledgebase" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}".sub('{format}','json').sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#patch_knowledge_knowledgebase\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_knowledge_knowledgebase_language_categories(knowledge_base_id, language_code, body, opts = {}) click to toggle source

Create new category

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param body @param [Hash] opts the optional parameters @return [KnowledgeExtendedCategory]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1427
def post_knowledge_knowledgebase_language_categories(knowledge_base_id, language_code, body, opts = {})
  data, _status_code, _headers = post_knowledge_knowledgebase_language_categories_with_http_info(knowledge_base_id, language_code, body, opts)
  return data
end
post_knowledge_knowledgebase_language_categories_with_http_info(knowledge_base_id, language_code, body, opts = {}) click to toggle source

Create new category

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param body @param [Hash] opts the optional parameters @return [Array<(KnowledgeExtendedCategory, Fixnum, Hash)>] KnowledgeExtendedCategory data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1439
def post_knowledge_knowledgebase_language_categories_with_http_info(knowledge_base_id, language_code, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.post_knowledge_knowledgebase_language_categories ..."
  end
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.post_knowledge_knowledgebase_language_categories" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling KnowledgeApi.post_knowledge_knowledgebase_language_categories" if language_code.nil?
  
  # verify enum value
  unless ['en-US'].include?(language_code)
    fail ArgumentError, "invalid value for 'language_code', must be one of en-US"
  end
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling KnowledgeApi.post_knowledge_knowledgebase_language_categories" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories".sub('{format}','json').sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeExtendedCategory')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#post_knowledge_knowledgebase_language_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_knowledge_knowledgebase_language_documents(knowledge_base_id, language_code, body, opts = {}) click to toggle source

Create document

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param body @param [Hash] opts the optional parameters @return [KnowledgeDocument]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1517
def post_knowledge_knowledgebase_language_documents(knowledge_base_id, language_code, body, opts = {})
  data, _status_code, _headers = post_knowledge_knowledgebase_language_documents_with_http_info(knowledge_base_id, language_code, body, opts)
  return data
end
post_knowledge_knowledgebase_language_documents_with_http_info(knowledge_base_id, language_code, body, opts = {}) click to toggle source

Create document

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param body @param [Hash] opts the optional parameters @return [Array<(KnowledgeDocument, Fixnum, Hash)>] KnowledgeDocument data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1529
def post_knowledge_knowledgebase_language_documents_with_http_info(knowledge_base_id, language_code, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.post_knowledge_knowledgebase_language_documents ..."
  end
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.post_knowledge_knowledgebase_language_documents" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling KnowledgeApi.post_knowledge_knowledgebase_language_documents" if language_code.nil?
  
  # verify enum value
  unless ['en-US'].include?(language_code)
    fail ArgumentError, "invalid value for 'language_code', must be one of en-US"
  end
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling KnowledgeApi.post_knowledge_knowledgebase_language_documents" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents".sub('{format}','json').sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeDocument')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#post_knowledge_knowledgebase_language_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_knowledge_knowledgebase_language_training_promote(knowledge_base_id, language_code, training_id, opts = {}) click to toggle source

Promote trained documents from draft state to active.

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param training_id Training ID @param [Hash] opts the optional parameters @return [KnowledgeTraining]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1607
def post_knowledge_knowledgebase_language_training_promote(knowledge_base_id, language_code, training_id, opts = {})
  data, _status_code, _headers = post_knowledge_knowledgebase_language_training_promote_with_http_info(knowledge_base_id, language_code, training_id, opts)
  return data
end
post_knowledge_knowledgebase_language_training_promote_with_http_info(knowledge_base_id, language_code, training_id, opts = {}) click to toggle source

Promote trained documents from draft state to active.

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param training_id Training ID @param [Hash] opts the optional parameters @return [Array<(KnowledgeTraining, Fixnum, Hash)>] KnowledgeTraining data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1619
def post_knowledge_knowledgebase_language_training_promote_with_http_info(knowledge_base_id, language_code, training_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.post_knowledge_knowledgebase_language_training_promote ..."
  end
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.post_knowledge_knowledgebase_language_training_promote" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling KnowledgeApi.post_knowledge_knowledgebase_language_training_promote" if language_code.nil?
  
  # verify enum value
  unless ['en-US'].include?(language_code)
    fail ArgumentError, "invalid value for 'language_code', must be one of en-US"
  end
  
  
  
  
  
  
  # verify the required parameter 'training_id' is set
  fail ArgumentError, "Missing the required parameter 'training_id' when calling KnowledgeApi.post_knowledge_knowledgebase_language_training_promote" if training_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote".sub('{format}','json').sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s).sub('{' + 'trainingId' + '}', training_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeTraining')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#post_knowledge_knowledgebase_language_training_promote\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_knowledge_knowledgebase_language_trainings(knowledge_base_id, language_code, opts = {}) click to toggle source

Trigger training

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @return [KnowledgeTraining]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1696
def post_knowledge_knowledgebase_language_trainings(knowledge_base_id, language_code, opts = {})
  data, _status_code, _headers = post_knowledge_knowledgebase_language_trainings_with_http_info(knowledge_base_id, language_code, opts)
  return data
end
post_knowledge_knowledgebase_language_trainings_with_http_info(knowledge_base_id, language_code, opts = {}) click to toggle source

Trigger training

@param knowledge_base_id Knowledge base ID @param language_code Language code, format: iso2-LOCALE @param [Hash] opts the optional parameters @return [Array<(KnowledgeTraining, Fixnum, Hash)>] KnowledgeTraining data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1707
def post_knowledge_knowledgebase_language_trainings_with_http_info(knowledge_base_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.post_knowledge_knowledgebase_language_trainings ..."
  end
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.post_knowledge_knowledgebase_language_trainings" if knowledge_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling KnowledgeApi.post_knowledge_knowledgebase_language_trainings" if language_code.nil?
  
  # verify enum value
  unless ['en-US'].include?(language_code)
    fail ArgumentError, "invalid value for 'language_code', must be one of en-US"
  end
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings".sub('{format}','json').sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeTraining')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#post_knowledge_knowledgebase_language_trainings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_knowledge_knowledgebase_search(knowledge_base_id, opts = {}) click to toggle source

Search Documents

@param knowledge_base_id Knowledge base ID @param [Hash] opts the optional parameters @option opts [KnowledgeSearchRequest] :body @return [KnowledgeSearchResponse]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1776
def post_knowledge_knowledgebase_search(knowledge_base_id, opts = {})
  data, _status_code, _headers = post_knowledge_knowledgebase_search_with_http_info(knowledge_base_id, opts)
  return data
end
post_knowledge_knowledgebase_search_with_http_info(knowledge_base_id, opts = {}) click to toggle source

Search Documents

@param knowledge_base_id Knowledge base ID @param [Hash] opts the optional parameters @option opts [KnowledgeSearchRequest] :body @return [Array<(KnowledgeSearchResponse, Fixnum, Hash)>] KnowledgeSearchResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1787
def post_knowledge_knowledgebase_search_with_http_info(knowledge_base_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.post_knowledge_knowledgebase_search ..."
  end
  
  
  # verify the required parameter 'knowledge_base_id' is set
  fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeApi.post_knowledge_knowledgebase_search" if knowledge_base_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search".sub('{format}','json').sub('{' + 'knowledgeBaseId' + '}', knowledge_base_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#post_knowledge_knowledgebase_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_knowledge_knowledgebases(body, opts = {}) click to toggle source

Create new knowledge base

@param body @param [Hash] opts the optional parameters @return [KnowledgeBase]

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1848
def post_knowledge_knowledgebases(body, opts = {})
  data, _status_code, _headers = post_knowledge_knowledgebases_with_http_info(body, opts)
  return data
end
post_knowledge_knowledgebases_with_http_info(body, opts = {}) click to toggle source

Create new knowledge base

@param body @param [Hash] opts the optional parameters @return [Array<(KnowledgeBase, Fixnum, Hash)>] KnowledgeBase data, response status code and response headers

# File lib/purecloudplatformclientv2/api/knowledge_api.rb, line 1858
def post_knowledge_knowledgebases_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: KnowledgeApi.post_knowledge_knowledgebases ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling KnowledgeApi.post_knowledge_knowledgebases" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/knowledge/knowledgebases".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KnowledgeBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: KnowledgeApi#post_knowledge_knowledgebases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end