Class: ConnectWise::KnowledgeBaseCategoriesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/api/knowledge_base_categories_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ KnowledgeBaseCategoriesApi

Returns a new instance of KnowledgeBaseCategoriesApi.



17
18
19
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 17

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#delete_service_knowledge_base_categories_by_id(id, client_id, opts = {}) ⇒ nil

Delete KnowledgeBaseCategory

Parameters:

  • id (Integer) —

    knowledgeBaseCategoryId

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

    the optional parameters

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 26

def delete_service_knowledge_base_categories_by_id(id, client_id, opts = {})
  delete_service_knowledge_base_categories_by_id_with_http_info(id, client_id, opts)
  nil
end

#delete_service_knowledge_base_categories_by_id_with_http_info(id, client_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete KnowledgeBaseCategory

Parameters:

  • id (Integer) —

    knowledgeBaseCategoryId

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

    the optional parameters

Returns:

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

    nil, response status code and response headers

Raises:

  • (ArgumentError) 


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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 36

def delete_service_knowledge_base_categories_by_id_with_http_info(id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: KnowledgeBaseCategoriesApi.delete_service_knowledge_base_categories_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling KnowledgeBaseCategoriesApi.delete_service_knowledge_base_categories_by_id" if @api_client.config.client_side_validation && id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling KnowledgeBaseCategoriesApi.delete_service_knowledge_base_categories_by_id" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/service/knowledgeBaseCategories/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'KnowledgeBaseCategoriesApi.delete_service_knowledge_base_categories_by_id',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  @api_client.config.logger.debug "API called: KnowledgeBaseCategoriesApi#delete_service_knowledge_base_categories_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_service_knowledge_base_categories(client_id, opts = {}) ⇒ Array<KnowledgeBaseCategory>

Get List of KnowledgeBaseCategory

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:



92
93
94
95
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 92

def get_service_knowledge_base_categories(client_id, opts = {})
  data, _status_code, _headers = get_service_knowledge_base_categories_with_http_info(client_id, opts)
  data
end

#get_service_knowledge_base_categories_by_id(id, client_id, opts = {}) ⇒ KnowledgeBaseCategory

Get KnowledgeBaseCategory

Parameters:

  • id (Integer) —

    knowledgeBaseCategoryId

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:



174
175
176
177
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 174

def get_service_knowledge_base_categories_by_id(id, client_id, opts = {})
  data, _status_code, _headers = get_service_knowledge_base_categories_by_id_with_http_info(id, client_id, opts)
  data
end

#get_service_knowledge_base_categories_by_id_with_http_info(id, client_id, opts = {}) ⇒ Array<(KnowledgeBaseCategory, Integer, Hash)>

Get KnowledgeBaseCategory

Parameters:

  • id (Integer) —

    knowledgeBaseCategoryId

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:

  • (Array<(KnowledgeBaseCategory, Integer, Hash)>) —

    KnowledgeBaseCategory data, response status code and response headers

Raises:

  • (ArgumentError) 


192
193
194
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
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 192

def get_service_knowledge_base_categories_by_id_with_http_info(id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: KnowledgeBaseCategoriesApi.get_service_knowledge_base_categories_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling KnowledgeBaseCategoriesApi.get_service_knowledge_base_categories_by_id" if @api_client.config.client_side_validation && id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling KnowledgeBaseCategoriesApi.get_service_knowledge_base_categories_by_id" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/service/knowledgeBaseCategories/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'KnowledgeBaseCategory'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'KnowledgeBaseCategoriesApi.get_service_knowledge_base_categories_by_id',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: KnowledgeBaseCategoriesApi#get_service_knowledge_base_categories_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_service_knowledge_base_categories_count(client_id, opts = {}) ⇒ Count

Get Count of KnowledgeBaseCategory

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:



258
259
260
261
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 258

def get_service_knowledge_base_categories_count(client_id, opts = {})
  data, _status_code, _headers = get_service_knowledge_base_categories_count_with_http_info(client_id, opts)
  data
end

#get_service_knowledge_base_categories_count_with_http_info(client_id, opts = {}) ⇒ Array<(Count, Integer, Hash)>

Get Count of KnowledgeBaseCategory

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:

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

    Count data, response status code and response headers

Raises:

  • (ArgumentError) 


275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 275

def get_service_knowledge_base_categories_count_with_http_info(client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: KnowledgeBaseCategoriesApi.get_service_knowledge_base_categories_count ...' if @api_client.config.debugging
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling KnowledgeBaseCategoriesApi.get_service_knowledge_base_categories_count" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/service/knowledgeBaseCategories/count'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Count'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'KnowledgeBaseCategoriesApi.get_service_knowledge_base_categories_count',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: KnowledgeBaseCategoriesApi#get_service_knowledge_base_categories_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_service_knowledge_base_categories_with_http_info(client_id, opts = {}) ⇒ Array<(Array<KnowledgeBaseCategory>, Integer, Hash)>

Get List of KnowledgeBaseCategory

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:

  • (Array<(Array<KnowledgeBaseCategory>, Integer, Hash)>) —

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

Raises:

  • (ArgumentError) 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 109

def get_service_knowledge_base_categories_with_http_info(client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: KnowledgeBaseCategoriesApi.get_service_knowledge_base_categories ...' if @api_client.config.debugging
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling KnowledgeBaseCategoriesApi.get_service_knowledge_base_categories" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/service/knowledgeBaseCategories'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<KnowledgeBaseCategory>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'KnowledgeBaseCategoriesApi.get_service_knowledge_base_categories',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: KnowledgeBaseCategoriesApi#get_service_knowledge_base_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#patch_service_knowledge_base_categories_by_id(id, client_id, patch_operation, opts = {}) ⇒ KnowledgeBaseCategory

Patch KnowledgeBaseCategory

Parameters:

  • id (Integer) —

    knowledgeBaseCategoryId

  • client_id (String)
  • patch_operation (Array<PatchOperation>) —

    List of PatchOperation

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

    the optional parameters

Returns:



333
334
335
336
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 333

def patch_service_knowledge_base_categories_by_id(id, client_id, patch_operation, opts = {})
  data, _status_code, _headers = patch_service_knowledge_base_categories_by_id_with_http_info(id, client_id, patch_operation, opts)
  data
end

#patch_service_knowledge_base_categories_by_id_with_http_info(id, client_id, patch_operation, opts = {}) ⇒ Array<(KnowledgeBaseCategory, Integer, Hash)>

Patch KnowledgeBaseCategory

Parameters:

  • id (Integer) —

    knowledgeBaseCategoryId

  • client_id (String)
  • patch_operation (Array<PatchOperation>) —

    List of PatchOperation

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

    the optional parameters

Returns:

  • (Array<(KnowledgeBaseCategory, Integer, Hash)>) —

    KnowledgeBaseCategory data, response status code and response headers

Raises:

  • (ArgumentError) 


344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 344

def patch_service_knowledge_base_categories_by_id_with_http_info(id, client_id, patch_operation, opts = {})
  @api_client.config.logger.debug 'Calling API: KnowledgeBaseCategoriesApi.patch_service_knowledge_base_categories_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling KnowledgeBaseCategoriesApi.patch_service_knowledge_base_categories_by_id" if @api_client.config.client_side_validation && id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling KnowledgeBaseCategoriesApi.patch_service_knowledge_base_categories_by_id" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'patch_operation' is set
  raise ArgumentError, "Missing the required parameter 'patch_operation' when calling KnowledgeBaseCategoriesApi.patch_service_knowledge_base_categories_by_id" if @api_client.config.client_side_validation && patch_operation.nil?

  # resource path
  local_var_path = '/service/knowledgeBaseCategories/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_operation)

  # return_type
  return_type = opts[:debug_return_type] || 'KnowledgeBaseCategory'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'KnowledgeBaseCategoriesApi.patch_service_knowledge_base_categories_by_id',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  @api_client.config.logger.debug "API called: KnowledgeBaseCategoriesApi#patch_service_knowledge_base_categories_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#post_service_knowledge_base_categories(client_id, knowledge_base_category, opts = {}) ⇒ KnowledgeBaseCategory

Post KnowledgeBaseCategory

Parameters:

  • client_id (String)
  • knowledge_base_category (KnowledgeBaseCategory) —

    knowledgeBaseCategory

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

    the optional parameters

Returns:



400
401
402
403
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 400

def post_service_knowledge_base_categories(client_id, knowledge_base_category, opts = {})
  data, _status_code, _headers = post_service_knowledge_base_categories_with_http_info(client_id, knowledge_base_category, opts)
  data
end

#post_service_knowledge_base_categories_with_http_info(client_id, knowledge_base_category, opts = {}) ⇒ Array<(KnowledgeBaseCategory, Integer, Hash)>

Post KnowledgeBaseCategory

Parameters:

  • client_id (String)
  • knowledge_base_category (KnowledgeBaseCategory) —

    knowledgeBaseCategory

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

    the optional parameters

Returns:

  • (Array<(KnowledgeBaseCategory, Integer, Hash)>) —

    KnowledgeBaseCategory data, response status code and response headers

Raises:

  • (ArgumentError) 


410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 410

def post_service_knowledge_base_categories_with_http_info(client_id, knowledge_base_category, opts = {})
  @api_client.config.logger.debug 'Calling API: KnowledgeBaseCategoriesApi.post_service_knowledge_base_categories ...' if @api_client.config.debugging
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling KnowledgeBaseCategoriesApi.post_service_knowledge_base_categories" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'knowledge_base_category' is set
  raise ArgumentError, "Missing the required parameter 'knowledge_base_category' when calling KnowledgeBaseCategoriesApi.post_service_knowledge_base_categories" if @api_client.config.client_side_validation && knowledge_base_category.nil?

  # resource path
  local_var_path = '/service/knowledgeBaseCategories'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(knowledge_base_category)

  # return_type
  return_type = opts[:debug_return_type] || 'KnowledgeBaseCategory'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'KnowledgeBaseCategoriesApi.post_service_knowledge_base_categories',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  @api_client.config.logger.debug "API called: KnowledgeBaseCategoriesApi#post_service_knowledge_base_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#put_service_knowledge_base_categories_by_id(id, client_id, knowledge_base_category, opts = {}) ⇒ KnowledgeBaseCategory

Put KnowledgeBaseCategory

Parameters:

  • id (Integer) —

    knowledgeBaseCategoryId

  • client_id (String)
  • knowledge_base_category (KnowledgeBaseCategory) —

    knowledgeBaseCategory

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

    the optional parameters

Returns:



465
466
467
468
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 465

def put_service_knowledge_base_categories_by_id(id, client_id, knowledge_base_category, opts = {})
  data, _status_code, _headers = put_service_knowledge_base_categories_by_id_with_http_info(id, client_id, knowledge_base_category, opts)
  data
end

#put_service_knowledge_base_categories_by_id_with_http_info(id, client_id, knowledge_base_category, opts = {}) ⇒ Array<(KnowledgeBaseCategory, Integer, Hash)>

Put KnowledgeBaseCategory

Parameters:

  • id (Integer) —

    knowledgeBaseCategoryId

  • client_id (String)
  • knowledge_base_category (KnowledgeBaseCategory) —

    knowledgeBaseCategory

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

    the optional parameters

Returns:

  • (Array<(KnowledgeBaseCategory, Integer, Hash)>) —

    KnowledgeBaseCategory data, response status code and response headers

Raises:

  • (ArgumentError) 


476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/connect_wise/api/knowledge_base_categories_api.rb', line 476

def put_service_knowledge_base_categories_by_id_with_http_info(id, client_id, knowledge_base_category, opts = {})
  @api_client.config.logger.debug 'Calling API: KnowledgeBaseCategoriesApi.put_service_knowledge_base_categories_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling KnowledgeBaseCategoriesApi.put_service_knowledge_base_categories_by_id" if @api_client.config.client_side_validation && id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling KnowledgeBaseCategoriesApi.put_service_knowledge_base_categories_by_id" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'knowledge_base_category' is set
  raise ArgumentError, "Missing the required parameter 'knowledge_base_category' when calling KnowledgeBaseCategoriesApi.put_service_knowledge_base_categories_by_id" if @api_client.config.client_side_validation && knowledge_base_category.nil?

  # resource path
  local_var_path = '/service/knowledgeBaseCategories/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(knowledge_base_category)

  # return_type
  return_type = opts[:debug_return_type] || 'KnowledgeBaseCategory'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'KnowledgeBaseCategoriesApi.put_service_knowledge_base_categories_by_id',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  @api_client.config.logger.debug "API called: KnowledgeBaseCategoriesApi#put_service_knowledge_base_categories_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end