Class: ConnectWise::KnowledgeBaseArticlesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ KnowledgeBaseArticlesApi

Returns a new instance of KnowledgeBaseArticlesApi.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb', line 8

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



6
7
8
 
# File 'lib/connectwise-ruby-sdk/api/knowledge_base_articles_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#service_knowledge_base_articles_count_get(opts = {}) ⇒ Count

Get Knowledge Base Articles Count

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :custom_field_conditions (String)

Returns:



18
19
20
21
 
# 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

#service_knowledge_base_articles_count_get_with_http_info(opts = {}) ⇒ Array<(Count, Fixnum, Hash)>

Get Knowledge Base Articles Count

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :custom_field_conditions (String)

Returns:

  • (Array<(Count, Fixnum, Hash)>) —

    Count data, response status code and response headers



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# 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

#service_knowledge_base_articles_get(opts = {}) ⇒ Array<KnowledgeBaseArticle>

Get Knowledge Base Articles

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:



75
76
77
78
 
# 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

#service_knowledge_base_articles_get_with_http_info(opts = {}) ⇒ Array<(Array<KnowledgeBaseArticle>, Fixnum, Hash)>

Get Knowledge Base Articles

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:

  • (Array<(Array<KnowledgeBaseArticle>, Fixnum, Hash)>) —

    Array<KnowledgeBaseArticle> data, response status code and response headers



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# 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

#service_knowledge_base_articles_id_delete(id, opts = {}) ⇒ nil

Delete Knowledge Base Article By Id

Parameters:

  • id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


135
136
137
138
 
# 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

#service_knowledge_base_articles_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Knowledge Base Article By Id

Parameters:

  • id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# 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

#service_knowledge_base_articles_id_get(id, opts = {}) ⇒ KnowledgeBaseArticle

Get Knowledge Base Article By Id

Parameters:

  • id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



185
186
187
188
 
# 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

#service_knowledge_base_articles_id_get_with_http_info(id, opts = {}) ⇒ Array<(KnowledgeBaseArticle, Fixnum, Hash)>

Get Knowledge Base Article By Id

Parameters:

  • id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(KnowledgeBaseArticle, Fixnum, Hash)>) —

    KnowledgeBaseArticle data, response status code and response headers



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# 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

#service_knowledge_base_articles_id_patch(id, operations, opts = {}) ⇒ KnowledgeBaseArticle

Update Knowledge Base Article

Parameters:

  • id
  • operations
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



239
240
241
242
 
# 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

#service_knowledge_base_articles_id_patch_with_http_info(id, operations, opts = {}) ⇒ Array<(KnowledgeBaseArticle, Fixnum, Hash)>

Update Knowledge Base Article

Parameters:

  • id
  • operations
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(KnowledgeBaseArticle, Fixnum, Hash)>) —

    KnowledgeBaseArticle data, response status code and response headers



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# 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

#service_knowledge_base_articles_id_put(id, knowledge_base_article, opts = {}) ⇒ KnowledgeBaseArticle

Replace Knowledge Base Article

Parameters:

  • id
  • knowledge_base_article
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



300
301
302
303
 
# 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

#service_knowledge_base_articles_id_put_with_http_info(id, knowledge_base_article, opts = {}) ⇒ Array<(KnowledgeBaseArticle, Fixnum, Hash)>

Replace Knowledge Base Article

Parameters:

  • id
  • knowledge_base_article
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(KnowledgeBaseArticle, Fixnum, Hash)>) —

    KnowledgeBaseArticle data, response status code and response headers



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# 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

#service_knowledge_base_articles_post(knowledge_base_article, opts = {}) ⇒ KnowledgeBaseArticle

Create Knowledge Base Article

Parameters:

  • knowledge_base_article
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



360
361
362
363
 
# 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

#service_knowledge_base_articles_post_with_http_info(knowledge_base_article, opts = {}) ⇒ Array<(KnowledgeBaseArticle, Fixnum, Hash)>

Create Knowledge Base Article

Parameters:

  • knowledge_base_article
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(KnowledgeBaseArticle, Fixnum, Hash)>) —

    KnowledgeBaseArticle data, response status code and response headers



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# 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