Class: ConnectWise::ConfigurationTypesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConfigurationTypesApi

Returns a new instance of ConfigurationTypesApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Delete ConfigurationType

Parameters:

  • id (Integer) —

    typeId

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_company_configurations_types_by_id(id, client_id, opts = {})
  delete_company_configurations_types_by_id_with_http_info(id, client_id, opts)
  nil
end

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

Delete ConfigurationType

Parameters:

  • id (Integer) —

    typeId

  • 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/configuration_types_api.rb', line 36

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

  # resource path
  local_var_path = '/company/configurations/types/{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: :'ConfigurationTypesApi.delete_company_configurations_types_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: ConfigurationTypesApi#delete_company_configurations_types_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_company_configurations_types(client_id, opts = {}) ⇒ Array<ConfigurationType>

Get List of ConfigurationType

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/configuration_types_api.rb', line 92

def get_company_configurations_types(client_id, opts = {})
  data, _status_code, _headers = get_company_configurations_types_with_http_info(client_id, opts)
  data
end

#get_company_configurations_types_by_id(id, client_id, opts = {}) ⇒ ConfigurationType

Get ConfigurationType

Parameters:

  • id (Integer) —

    typeId

  • 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/configuration_types_api.rb', line 174

def get_company_configurations_types_by_id(id, client_id, opts = {})
  data, _status_code, _headers = get_company_configurations_types_by_id_with_http_info(id, client_id, opts)
  data
end

#get_company_configurations_types_by_id_usages(id, client_id, opts = {}) ⇒ Array<Usage>

Get List of Usage Count

Parameters:

  • id (Integer) —

    typeId

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



259
260
261
262
 
# File 'lib/connect_wise/api/configuration_types_api.rb', line 259

def get_company_configurations_types_by_id_usages(id, client_id, opts = {})
  data, _status_code, _headers = get_company_configurations_types_by_id_usages_with_http_info(id, client_id, opts)
  data
end

#get_company_configurations_types_by_id_usages_list(id, client_id, opts = {}) ⇒ Array<Usage>

Get List of Usage

Parameters:

  • id (Integer) —

    typeId

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



344
345
346
347
 
# File 'lib/connect_wise/api/configuration_types_api.rb', line 344

def get_company_configurations_types_by_id_usages_list(id, client_id, opts = {})
  data, _status_code, _headers = get_company_configurations_types_by_id_usages_list_with_http_info(id, client_id, opts)
  data
end

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

Get List of Usage

Parameters:

  • id (Integer) —

    typeId

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

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

Raises:

  • (ArgumentError) 


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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/connect_wise/api/configuration_types_api.rb', line 362

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

  # resource path
  local_var_path = '/company/configurations/types/{id}/usages/list'.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] || 'Array<Usage>'

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

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

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

Get List of Usage Count

Parameters:

  • id (Integer) —

    typeId

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

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

Raises:

  • (ArgumentError) 


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
326
327
328
329
 
# File 'lib/connect_wise/api/configuration_types_api.rb', line 277

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

  # resource path
  local_var_path = '/company/configurations/types/{id}/usages'.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] || 'Array<Usage>'

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

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

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

Get ConfigurationType

Parameters:

  • id (Integer) —

    typeId

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

    ConfigurationType 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/configuration_types_api.rb', line 192

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

  # resource path
  local_var_path = '/company/configurations/types/{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] || 'ConfigurationType'

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

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

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

Get Count of ConfigurationType

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:



428
429
430
431
 
# File 'lib/connect_wise/api/configuration_types_api.rb', line 428

def get_company_configurations_types_count(client_id, opts = {})
  data, _status_code, _headers = get_company_configurations_types_count_with_http_info(client_id, opts)
  data
end

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

Get Count of ConfigurationType

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) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/connect_wise/api/configuration_types_api.rb', line 445

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

  # resource path
  local_var_path = '/company/configurations/types/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: :'ConfigurationTypesApi.get_company_configurations_types_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: ConfigurationTypesApi#get_company_configurations_types_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_company_configurations_types_with_http_info(client_id, opts = {}) ⇒ Array<(Array<ConfigurationType>, Integer, Hash)>

Get List of ConfigurationType

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

    Array<ConfigurationType> 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/configuration_types_api.rb', line 109

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

  # resource path
  local_var_path = '/company/configurations/types'

  # 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<ConfigurationType>'

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

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

#patch_company_configurations_types_by_id(id, client_id, patch_operation, opts = {}) ⇒ ConfigurationType

Patch ConfigurationType

Parameters:

  • id (Integer) —

    typeId

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

    List of PatchOperation

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

    the optional parameters

Returns:



503
504
505
506
 
# File 'lib/connect_wise/api/configuration_types_api.rb', line 503

def patch_company_configurations_types_by_id(id, client_id, patch_operation, opts = {})
  data, _status_code, _headers = patch_company_configurations_types_by_id_with_http_info(id, client_id, patch_operation, opts)
  data
end

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

Patch ConfigurationType

Parameters:

  • id (Integer) —

    typeId

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

    List of PatchOperation

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

    the optional parameters

Returns:

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

    ConfigurationType data, response status code and response headers

Raises:

  • (ArgumentError) 


514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/connect_wise/api/configuration_types_api.rb', line 514

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

  # resource path
  local_var_path = '/company/configurations/types/{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] || 'ConfigurationType'

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

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

#post_company_configurations_types(client_id, configuration_type, opts = {}) ⇒ ConfigurationType

Post ConfigurationType

Parameters:

  • client_id (String)
  • configuration_type (ConfigurationType) —

    configurationType

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

    the optional parameters

Returns:



570
571
572
573
 
# File 'lib/connect_wise/api/configuration_types_api.rb', line 570

def post_company_configurations_types(client_id, configuration_type, opts = {})
  data, _status_code, _headers = post_company_configurations_types_with_http_info(client_id, configuration_type, opts)
  data
end

#post_company_configurations_types_with_http_info(client_id, configuration_type, opts = {}) ⇒ Array<(ConfigurationType, Integer, Hash)>

Post ConfigurationType

Parameters:

  • client_id (String)
  • configuration_type (ConfigurationType) —

    configurationType

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

    the optional parameters

Returns:

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

    ConfigurationType data, response status code and response headers

Raises:

  • (ArgumentError) 


580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/connect_wise/api/configuration_types_api.rb', line 580

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

  # resource path
  local_var_path = '/company/configurations/types'

  # 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(configuration_type)

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

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

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

#put_company_configurations_types_by_id(id, client_id, configuration_type, opts = {}) ⇒ ConfigurationType

Put ConfigurationType

Parameters:

  • id (Integer) —

    typeId

  • client_id (String)
  • configuration_type (ConfigurationType) —

    configurationType

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

    the optional parameters

Returns:



635
636
637
638
 
# File 'lib/connect_wise/api/configuration_types_api.rb', line 635

def put_company_configurations_types_by_id(id, client_id, configuration_type, opts = {})
  data, _status_code, _headers = put_company_configurations_types_by_id_with_http_info(id, client_id, configuration_type, opts)
  data
end

#put_company_configurations_types_by_id_with_http_info(id, client_id, configuration_type, opts = {}) ⇒ Array<(ConfigurationType, Integer, Hash)>

Put ConfigurationType

Parameters:

  • id (Integer) —

    typeId

  • client_id (String)
  • configuration_type (ConfigurationType) —

    configurationType

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

    the optional parameters

Returns:

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

    ConfigurationType data, response status code and response headers

Raises:

  • (ArgumentError) 


646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
 
# File 'lib/connect_wise/api/configuration_types_api.rb', line 646

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

  # resource path
  local_var_path = '/company/configurations/types/{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(configuration_type)

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

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

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