Class: ConnectWise::KnowledgeBaseSettingsesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ KnowledgeBaseSettingsesApi

Returns a new instance of KnowledgeBaseSettingsesApi.



17
18
19
 
# File 'lib/connect_wise/api/knowledge_base_settingses_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_settingses_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#get_service_knowledgebasesettings(client_id, opts = {}) ⇒ KnowledgeBaseSettings

Get KnowledgeBaseSettings

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:



33
34
35
36
 
# File 'lib/connect_wise/api/knowledge_base_settingses_api.rb', line 33

def get_service_knowledgebasesettings(client_id, opts = {})
  data, _status_code, _headers = get_service_knowledgebasesettings_with_http_info(client_id, opts)
  data
end

#get_service_knowledgebasesettings_by_id(id, client_id, opts = {}) ⇒ KnowledgeBaseSettings

Get KnowledgeBaseSettings

Parameters:

  • id (Integer) —

    knowledgebasesettingId

  • 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:



115
116
117
118
 
# File 'lib/connect_wise/api/knowledge_base_settingses_api.rb', line 115

def get_service_knowledgebasesettings_by_id(id, client_id, opts = {})
  data, _status_code, _headers = get_service_knowledgebasesettings_by_id_with_http_info(id, client_id, opts)
  data
end

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

Get KnowledgeBaseSettings

Parameters:

  • id (Integer) —

    knowledgebasesettingId

  • 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<(KnowledgeBaseSettings, Integer, Hash)>) —

    KnowledgeBaseSettings data, response status code and response headers

Raises:

  • (ArgumentError) 


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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/connect_wise/api/knowledge_base_settingses_api.rb', line 133

def get_service_knowledgebasesettings_by_id_with_http_info(id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: KnowledgeBaseSettingsesApi.get_service_knowledgebasesettings_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling KnowledgeBaseSettingsesApi.get_service_knowledgebasesettings_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 KnowledgeBaseSettingsesApi.get_service_knowledgebasesettings_by_id" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/service/knowledgebasesettings/{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] || 'KnowledgeBaseSettings'

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

  new_options = opts.merge(
    operation: :'KnowledgeBaseSettingsesApi.get_service_knowledgebasesettings_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: KnowledgeBaseSettingsesApi#get_service_knowledgebasesettings_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_service_knowledgebasesettings_with_http_info(client_id, opts = {}) ⇒ Array<(KnowledgeBaseSettings, Integer, Hash)>

Get KnowledgeBaseSettings

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<(KnowledgeBaseSettings, Integer, Hash)>) —

    KnowledgeBaseSettings data, response status code and response headers

Raises:

  • (ArgumentError) 


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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/connect_wise/api/knowledge_base_settingses_api.rb', line 50

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

  # resource path
  local_var_path = '/service/knowledgebasesettings'

  # 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] || 'KnowledgeBaseSettings'

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

  new_options = opts.merge(
    operation: :'KnowledgeBaseSettingsesApi.get_service_knowledgebasesettings',
    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: KnowledgeBaseSettingsesApi#get_service_knowledgebasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#patch_service_knowledgebasesettings_by_id(id, client_id, patch_operation, opts = {}) ⇒ KnowledgeBaseSettings

Patch KnowledgeBaseSettings

Parameters:

  • id (Integer) —

    knowledgebasesettingId

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

    List of PatchOperation

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

    the optional parameters

Returns:



193
194
195
196
 
# File 'lib/connect_wise/api/knowledge_base_settingses_api.rb', line 193

def patch_service_knowledgebasesettings_by_id(id, client_id, patch_operation, opts = {})
  data, _status_code, _headers = patch_service_knowledgebasesettings_by_id_with_http_info(id, client_id, patch_operation, opts)
  data
end

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

Patch KnowledgeBaseSettings

Parameters:

  • id (Integer) —

    knowledgebasesettingId

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

    List of PatchOperation

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

    the optional parameters

Returns:

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

    KnowledgeBaseSettings data, response status code and response headers

Raises:

  • (ArgumentError) 


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
245
246
247
248
249
250
251
252
253
 
# File 'lib/connect_wise/api/knowledge_base_settingses_api.rb', line 204

def patch_service_knowledgebasesettings_by_id_with_http_info(id, client_id, patch_operation, opts = {})
  @api_client.config.logger.debug 'Calling API: KnowledgeBaseSettingsesApi.patch_service_knowledgebasesettings_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling KnowledgeBaseSettingsesApi.patch_service_knowledgebasesettings_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 KnowledgeBaseSettingsesApi.patch_service_knowledgebasesettings_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 KnowledgeBaseSettingsesApi.patch_service_knowledgebasesettings_by_id" if @api_client.config.client_side_validation && patch_operation.nil?

  # resource path
  local_var_path = '/service/knowledgebasesettings/{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] || 'KnowledgeBaseSettings'

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

  new_options = opts.merge(
    operation: :'KnowledgeBaseSettingsesApi.patch_service_knowledgebasesettings_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: KnowledgeBaseSettingsesApi#patch_service_knowledgebasesettings_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#post_service_knowledgebasesettings(client_id, knowledge_base_settings, opts = {}) ⇒ KnowledgeBaseSettings

Post KnowledgeBaseSettings

Parameters:

  • client_id (String)
  • knowledge_base_settings (KnowledgeBaseSettings) —

    knowledgeBaseSettings

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

    the optional parameters

Returns:



260
261
262
263
 
# File 'lib/connect_wise/api/knowledge_base_settingses_api.rb', line 260

def post_service_knowledgebasesettings(client_id, knowledge_base_settings, opts = {})
  data, _status_code, _headers = post_service_knowledgebasesettings_with_http_info(client_id, knowledge_base_settings, opts)
  data
end

#post_service_knowledgebasesettings_with_http_info(client_id, knowledge_base_settings, opts = {}) ⇒ Array<(KnowledgeBaseSettings, Integer, Hash)>

Post KnowledgeBaseSettings

Parameters:

  • client_id (String)
  • knowledge_base_settings (KnowledgeBaseSettings) —

    knowledgeBaseSettings

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

    the optional parameters

Returns:

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

    KnowledgeBaseSettings data, response status code and response headers

Raises:

  • (ArgumentError) 


270
271
272
273
274
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
 
# File 'lib/connect_wise/api/knowledge_base_settingses_api.rb', line 270

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

  # resource path
  local_var_path = '/service/knowledgebasesettings'

  # 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_settings)

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

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

  new_options = opts.merge(
    operation: :'KnowledgeBaseSettingsesApi.post_service_knowledgebasesettings',
    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: KnowledgeBaseSettingsesApi#post_service_knowledgebasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#put_service_knowledgebasesettings_by_id(id, client_id, knowledge_base_settings, opts = {}) ⇒ KnowledgeBaseSettings

Put KnowledgeBaseSettings

Parameters:

  • id (Integer) —

    knowledgebasesettingId

  • client_id (String)
  • knowledge_base_settings (KnowledgeBaseSettings) —

    knowledgeBaseSettings

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

    the optional parameters

Returns:



325
326
327
328
 
# File 'lib/connect_wise/api/knowledge_base_settingses_api.rb', line 325

def put_service_knowledgebasesettings_by_id(id, client_id, knowledge_base_settings, opts = {})
  data, _status_code, _headers = put_service_knowledgebasesettings_by_id_with_http_info(id, client_id, knowledge_base_settings, opts)
  data
end

#put_service_knowledgebasesettings_by_id_with_http_info(id, client_id, knowledge_base_settings, opts = {}) ⇒ Array<(KnowledgeBaseSettings, Integer, Hash)>

Put KnowledgeBaseSettings

Parameters:

  • id (Integer) —

    knowledgebasesettingId

  • client_id (String)
  • knowledge_base_settings (KnowledgeBaseSettings) —

    knowledgeBaseSettings

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

    the optional parameters

Returns:

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

    KnowledgeBaseSettings data, response status code and response headers

Raises:

  • (ArgumentError) 


336
337
338
339
340
341
342
343
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
 
# File 'lib/connect_wise/api/knowledge_base_settingses_api.rb', line 336

def put_service_knowledgebasesettings_by_id_with_http_info(id, client_id, knowledge_base_settings, opts = {})
  @api_client.config.logger.debug 'Calling API: KnowledgeBaseSettingsesApi.put_service_knowledgebasesettings_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling KnowledgeBaseSettingsesApi.put_service_knowledgebasesettings_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 KnowledgeBaseSettingsesApi.put_service_knowledgebasesettings_by_id" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'knowledge_base_settings' is set
  raise ArgumentError, "Missing the required parameter 'knowledge_base_settings' when calling KnowledgeBaseSettingsesApi.put_service_knowledgebasesettings_by_id" if @api_client.config.client_side_validation && knowledge_base_settings.nil?

  # resource path
  local_var_path = '/service/knowledgebasesettings/{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_settings)

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

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

  new_options = opts.merge(
    operation: :'KnowledgeBaseSettingsesApi.put_service_knowledgebasesettings_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: KnowledgeBaseSettingsesApi#put_service_knowledgebasesettings_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end