class ConnectWise::KnowledgeBaseArticlesApi
Attributes
Public Class Methods
# File lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb, line 8 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get Knowledge Base Articles Count
@param [Hash] opts the optional parameters @option opts [String] :conditions @option opts [String] :custom_field_conditions @return [Count]
# File lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb, line 18 def service_knowledge_base_articles_count_get(opts = {}) data, _status_code, _headers = service_knowledge_base_articles_count_get_with_http_info(opts) return data end
Get Knowledge Base Articles Count
@param [Hash] opts the optional parameters @option opts [String] :conditions @option opts [String] :custom_field_conditions @return [Array<(Count
, Fixnum, Hash)>] Count
data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb, line 29 def service_knowledge_base_articles_count_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: KnowledgeBaseArticlesApi.service_knowledge_base_articles_count_get ..." end # resource path local_var_path = "/service/knowledgeBaseArticles/count" # query parameters query_params = {} query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil? query_params[:'customFieldConditions'] = opts[:'custom_field_conditions'] if !opts[:'custom_field_conditions'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['BasicAuth'] 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 => 'Count') if @api_client.config.debugging @api_client.config.logger.debug "API called: KnowledgeBaseArticlesApi#service_knowledge_base_articles_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Knowledge Base Articles @param [Hash] opts the optional parameters @option opts [String] :conditions @option opts [String] :order_by @option opts [String] :childconditions @option opts [String] :customfieldconditions @option opts [Integer] :page @option opts [Integer] :page_size @return [Array<KnowledgeBaseArticle>]
# File lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb, line 75 def service_knowledge_base_articles_get(opts = {}) data, _status_code, _headers = service_knowledge_base_articles_get_with_http_info(opts) return data end
Get Knowledge Base Articles @param [Hash] opts the optional parameters @option opts [String] :conditions @option opts [String] :order_by @option opts [String] :childconditions @option opts [String] :customfieldconditions @option opts [Integer] :page @option opts [Integer] :page_size @return [Array<(Array<KnowledgeBaseArticle>, Fixnum, Hash)>] Array<KnowledgeBaseArticle> data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb, line 90 def service_knowledge_base_articles_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: KnowledgeBaseArticlesApi.service_knowledge_base_articles_get ..." end # resource path local_var_path = "/service/knowledgeBaseArticles" # query parameters query_params = {} query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil? query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil? query_params[:'childconditions'] = opts[:'childconditions'] if !opts[:'childconditions'].nil? query_params[:'customfieldconditions'] = opts[:'customfieldconditions'] if !opts[:'customfieldconditions'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['BasicAuth'] 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 => 'Array<KnowledgeBaseArticle>') if @api_client.config.debugging @api_client.config.logger.debug "API called: KnowledgeBaseArticlesApi#service_knowledge_base_articles_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete Knowledge Base Article By Id @param id @param [Hash] opts the optional parameters @return [nil]
# File lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb, line 135 def service_knowledge_base_articles_id_delete(id, opts = {}) service_knowledge_base_articles_id_delete_with_http_info(id, opts) return nil end
Delete Knowledge Base Article By Id @param id @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb, line 145 def service_knowledge_base_articles_id_delete_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: KnowledgeBaseArticlesApi.service_knowledge_base_articles_id_delete ..." end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling KnowledgeBaseArticlesApi.service_knowledge_base_articles_id_delete" end # resource path local_var_path = "/service/knowledgeBaseArticles/{id}".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['BasicAuth'] 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) if @api_client.config.debugging @api_client.config.logger.debug "API called: KnowledgeBaseArticlesApi#service_knowledge_base_articles_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Knowledge Base Article By Id @param id @param [Hash] opts the optional parameters @return [KnowledgeBaseArticle]
# File lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb, line 185 def service_knowledge_base_articles_id_get(id, opts = {}) data, _status_code, _headers = service_knowledge_base_articles_id_get_with_http_info(id, opts) return data end
Get Knowledge Base Article By Id @param id @param [Hash] opts the optional parameters @return [Array<(KnowledgeBaseArticle
, Fixnum, Hash)>] KnowledgeBaseArticle
data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb, line 195 def service_knowledge_base_articles_id_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: KnowledgeBaseArticlesApi.service_knowledge_base_articles_id_get ..." end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling KnowledgeBaseArticlesApi.service_knowledge_base_articles_id_get" end # resource path local_var_path = "/service/knowledgeBaseArticles/{id}".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['BasicAuth'] 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 => 'KnowledgeBaseArticle') if @api_client.config.debugging @api_client.config.logger.debug "API called: KnowledgeBaseArticlesApi#service_knowledge_base_articles_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update Knowledge Base Article @param id @param operations @param [Hash] opts the optional parameters @return [KnowledgeBaseArticle]
# File lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb, line 239 def service_knowledge_base_articles_id_patch(id, operations, opts = {}) data, _status_code, _headers = service_knowledge_base_articles_id_patch_with_http_info(id, operations, opts) return data end
Update Knowledge Base Article @param id @param operations @param [Hash] opts the optional parameters @return [Array<(KnowledgeBaseArticle
, Fixnum, Hash)>] KnowledgeBaseArticle
data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb, line 250 def service_knowledge_base_articles_id_patch_with_http_info(id, operations, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: KnowledgeBaseArticlesApi.service_knowledge_base_articles_id_patch ..." end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling KnowledgeBaseArticlesApi.service_knowledge_base_articles_id_patch" end # verify the required parameter 'operations' is set if @api_client.config.client_side_validation && operations.nil? fail ArgumentError, "Missing the required parameter 'operations' when calling KnowledgeBaseArticlesApi.service_knowledge_base_articles_id_patch" end # resource path local_var_path = "/service/knowledgeBaseArticles/{id}".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(operations) auth_names = ['BasicAuth'] 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 => 'KnowledgeBaseArticle') if @api_client.config.debugging @api_client.config.logger.debug "API called: KnowledgeBaseArticlesApi#service_knowledge_base_articles_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Replace Knowledge Base Article @param id @param knowledge_base_article @param [Hash] opts the optional parameters @return [KnowledgeBaseArticle]
# File lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb, line 300 def service_knowledge_base_articles_id_put(id, knowledge_base_article, opts = {}) data, _status_code, _headers = service_knowledge_base_articles_id_put_with_http_info(id, knowledge_base_article, opts) return data end
Replace Knowledge Base Article @param id @param knowledge_base_article @param [Hash] opts the optional parameters @return [Array<(KnowledgeBaseArticle
, Fixnum, Hash)>] KnowledgeBaseArticle
data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb, line 311 def service_knowledge_base_articles_id_put_with_http_info(id, knowledge_base_article, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: KnowledgeBaseArticlesApi.service_knowledge_base_articles_id_put ..." end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling KnowledgeBaseArticlesApi.service_knowledge_base_articles_id_put" end # verify the required parameter 'knowledge_base_article' is set if @api_client.config.client_side_validation && knowledge_base_article.nil? fail ArgumentError, "Missing the required parameter 'knowledge_base_article' when calling KnowledgeBaseArticlesApi.service_knowledge_base_articles_id_put" end # resource path local_var_path = "/service/knowledgeBaseArticles/{id}".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(knowledge_base_article) auth_names = ['BasicAuth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'KnowledgeBaseArticle') if @api_client.config.debugging @api_client.config.logger.debug "API called: KnowledgeBaseArticlesApi#service_knowledge_base_articles_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create Knowledge Base Article @param knowledge_base_article @param [Hash] opts the optional parameters @return [KnowledgeBaseArticle]
# File lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb, line 360 def service_knowledge_base_articles_post(knowledge_base_article, opts = {}) data, _status_code, _headers = service_knowledge_base_articles_post_with_http_info(knowledge_base_article, opts) return data end
Create Knowledge Base Article @param knowledge_base_article @param [Hash] opts the optional parameters @return [Array<(KnowledgeBaseArticle
, Fixnum, Hash)>] KnowledgeBaseArticle
data, response status code and response headers
# File lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb, line 370 def service_knowledge_base_articles_post_with_http_info(knowledge_base_article, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: KnowledgeBaseArticlesApi.service_knowledge_base_articles_post ..." end # verify the required parameter 'knowledge_base_article' is set if @api_client.config.client_side_validation && knowledge_base_article.nil? fail ArgumentError, "Missing the required parameter 'knowledge_base_article' when calling KnowledgeBaseArticlesApi.service_knowledge_base_articles_post" end # resource path local_var_path = "/service/knowledgeBaseArticles" # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(knowledge_base_article) auth_names = ['BasicAuth'] 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 => 'KnowledgeBaseArticle') if @api_client.config.debugging @api_client.config.logger.debug "API called: KnowledgeBaseArticlesApi#service_knowledge_base_articles_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end