Class: ConnectWise::ConfigurationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConfigurationsApi

Returns a new instance of ConfigurationsApi.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/configurations_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/configurations_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#company_configurations_count_get(opts = {}) ⇒ Count

Get Configurations Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :managed_identifier (String)

Returns:



18
19
20
21
 
# File 'lib/connectwise-ruby-sdk/api/configurations_api.rb', line 18

def company_configurations_count_get(opts = {})
  data, _status_code, _headers = company_configurations_count_get_with_http_info(opts)
  return data
end

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

Get Configurations Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :managed_identifier (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/configurations_api.rb', line 29

def company_configurations_count_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationsApi.company_configurations_count_get ..."
  end
  # resource path
  local_var_path = "/company/configurations/count"

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?
  query_params[:'managedIdentifier'] = opts[:'managed_identifier'] if !opts[:'managed_identifier'].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: ConfigurationsApi#company_configurations_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_configurations_get(opts = {}) ⇒ Array<Configuration>

Get Configurations

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)
  • :managed_identifier (String)

Returns:



76
77
78
79
 
# File 'lib/connectwise-ruby-sdk/api/configurations_api.rb', line 76

def company_configurations_get(opts = {})
  data, _status_code, _headers = company_configurations_get_with_http_info(opts)
  return data
end

#company_configurations_get_with_http_info(opts = {}) ⇒ Array<(Array<Configuration>, Fixnum, Hash)>

Get Configurations

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)
  • :managed_identifier (String)

Returns:

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

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



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
129
130
131
 
# File 'lib/connectwise-ruby-sdk/api/configurations_api.rb', line 92

def company_configurations_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationsApi.company_configurations_get ..."
  end
  # resource path
  local_var_path = "/company/configurations"

  # 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?
  query_params[:'managedIdentifier'] = opts[:'managed_identifier'] if !opts[:'managed_identifier'].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<Configuration>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationsApi#company_configurations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete Configuration By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


138
139
140
141
 
# File 'lib/connectwise-ruby-sdk/api/configurations_api.rb', line 138

def company_configurations_id_delete(id, opts = {})
  company_configurations_id_delete_with_http_info(id, opts)
  return nil
end

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

Delete Configuration By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/connectwise-ruby-sdk/api/configurations_api.rb', line 148

def company_configurations_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationsApi.company_configurations_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 ConfigurationsApi.company_configurations_id_delete"
  end
  # resource path
  local_var_path = "/company/configurations/{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: ConfigurationsApi#company_configurations_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_configurations_id_get(id, opts = {}) ⇒ Configuration

Get Configuration By Id

Parameters:

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

    the optional parameters

Returns:



188
189
190
191
 
# File 'lib/connectwise-ruby-sdk/api/configurations_api.rb', line 188

def company_configurations_id_get(id, opts = {})
  data, _status_code, _headers = company_configurations_id_get_with_http_info(id, opts)
  return data
end

#company_configurations_id_get_with_http_info(id, opts = {}) ⇒ Array<(Configuration, Fixnum, Hash)>

Get Configuration By Id

Parameters:

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

    the optional parameters

Returns:

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

    Configuration data, response status code and response headers



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
 
# File 'lib/connectwise-ruby-sdk/api/configurations_api.rb', line 198

def company_configurations_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationsApi.company_configurations_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 ConfigurationsApi.company_configurations_id_get"
  end
  # resource path
  local_var_path = "/company/configurations/{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 => 'Configuration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationsApi#company_configurations_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_configurations_id_patch(id, operations, opts = {}) ⇒ Configuration

Update Configuration

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :management_solution_name (String)
  • :managed_identifier (String)
  • :type (String)
  • :level (String)
  • :child_configurations_matching_on (String)
  • :inactivate_configurations_matching_on (String)
  • :inactive_configuration_status_id (Integer)

Returns:



249
250
251
252
 
# File 'lib/connectwise-ruby-sdk/api/configurations_api.rb', line 249

def company_configurations_id_patch(id, operations, opts = {})
  data, _status_code, _headers = company_configurations_id_patch_with_http_info(id, operations, opts)
  return data
end

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

Update Configuration

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :management_solution_name (String)
  • :managed_identifier (String)
  • :type (String)
  • :level (String)
  • :child_configurations_matching_on (String)
  • :inactivate_configurations_matching_on (String)
  • :inactive_configuration_status_id (Integer)

Returns:

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

    Configuration data, response status code and response headers



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
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
 
# File 'lib/connectwise-ruby-sdk/api/configurations_api.rb', line 267

def company_configurations_id_patch_with_http_info(id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationsApi.company_configurations_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 ConfigurationsApi.company_configurations_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 ConfigurationsApi.company_configurations_id_patch"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['Ticket', 'Configuration'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of Ticket, Configuration'
  end
  # resource path
  local_var_path = "/company/configurations/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'managementSolutionName'] = opts[:'management_solution_name'] if !opts[:'management_solution_name'].nil?
  query_params[:'managedIdentifier'] = opts[:'managed_identifier'] if !opts[:'managed_identifier'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'level'] = opts[:'level'] if !opts[:'level'].nil?
  query_params[:'childConfigurationsMatchingOn'] = opts[:'child_configurations_matching_on'] if !opts[:'child_configurations_matching_on'].nil?
  query_params[:'inactivateConfigurationsMatchingOn'] = opts[:'inactivate_configurations_matching_on'] if !opts[:'inactivate_configurations_matching_on'].nil?
  query_params[:'inactiveConfigurationStatusId'] = opts[:'inactive_configuration_status_id'] if !opts[:'inactive_configuration_status_id'].nil?

  # 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 => 'Configuration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationsApi#company_configurations_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_configurations_id_put(id, configuration, opts = {}) ⇒ Configuration

Replace Configuration

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :management_solution_name (String)
  • :managed_identifier (String)
  • :type (String)
  • :level (String)
  • :child_configurations_matching_on (String)
  • :inactivate_configurations_matching_on (String)
  • :inactive_configuration_status_id (Integer)

Returns:



334
335
336
337
 
# File 'lib/connectwise-ruby-sdk/api/configurations_api.rb', line 334

def company_configurations_id_put(id, configuration, opts = {})
  data, _status_code, _headers = company_configurations_id_put_with_http_info(id, configuration, opts)
  return data
end

#company_configurations_id_put_with_http_info(id, configuration, opts = {}) ⇒ Array<(Configuration, Fixnum, Hash)>

Replace Configuration

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :management_solution_name (String)
  • :managed_identifier (String)
  • :type (String)
  • :level (String)
  • :child_configurations_matching_on (String)
  • :inactivate_configurations_matching_on (String)
  • :inactive_configuration_status_id (Integer)

Returns:

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

    Configuration data, response status code and response headers



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
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/connectwise-ruby-sdk/api/configurations_api.rb', line 352

def company_configurations_id_put_with_http_info(id, configuration, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationsApi.company_configurations_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 ConfigurationsApi.company_configurations_id_put"
  end
  # verify the required parameter 'configuration' is set
  if @api_client.config.client_side_validation && configuration.nil?
    fail ArgumentError, "Missing the required parameter 'configuration' when calling ConfigurationsApi.company_configurations_id_put"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['Ticket', 'Configuration'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of Ticket, Configuration'
  end
  # resource path
  local_var_path = "/company/configurations/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'managementSolutionName'] = opts[:'management_solution_name'] if !opts[:'management_solution_name'].nil?
  query_params[:'managedIdentifier'] = opts[:'managed_identifier'] if !opts[:'managed_identifier'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'level'] = opts[:'level'] if !opts[:'level'].nil?
  query_params[:'childConfigurationsMatchingOn'] = opts[:'child_configurations_matching_on'] if !opts[:'child_configurations_matching_on'].nil?
  query_params[:'inactivateConfigurationsMatchingOn'] = opts[:'inactivate_configurations_matching_on'] if !opts[:'inactivate_configurations_matching_on'].nil?
  query_params[:'inactiveConfigurationStatusId'] = opts[:'inactive_configuration_status_id'] if !opts[:'inactive_configuration_status_id'].nil?

  # 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(configuration)
  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 => 'Configuration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationsApi#company_configurations_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#company_configurations_post(configuration, opts = {}) ⇒ Configuration

Create Configuration

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :management_solution_name (String)
  • :managed_identifier (String)
  • :type (String)
  • :level (String)
  • :child_configurations_matching_on (String)
  • :inactivate_configurations_matching_on (String)
  • :inactive_configuration_status_id (Integer)

Returns:



418
419
420
421
 
# File 'lib/connectwise-ruby-sdk/api/configurations_api.rb', line 418

def company_configurations_post(configuration, opts = {})
  data, _status_code, _headers = company_configurations_post_with_http_info(configuration, opts)
  return data
end

#company_configurations_post_with_http_info(configuration, opts = {}) ⇒ Array<(Configuration, Fixnum, Hash)>

Create Configuration

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :management_solution_name (String)
  • :managed_identifier (String)
  • :type (String)
  • :level (String)
  • :child_configurations_matching_on (String)
  • :inactivate_configurations_matching_on (String)
  • :inactive_configuration_status_id (Integer)

Returns:

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

    Configuration data, response status code and response headers



435
436
437
438
439
440
441
442
443
444
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
 
# File 'lib/connectwise-ruby-sdk/api/configurations_api.rb', line 435

def company_configurations_post_with_http_info(configuration, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationsApi.company_configurations_post ..."
  end
  # verify the required parameter 'configuration' is set
  if @api_client.config.client_side_validation && configuration.nil?
    fail ArgumentError, "Missing the required parameter 'configuration' when calling ConfigurationsApi.company_configurations_post"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['Ticket', 'Configuration'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of Ticket, Configuration'
  end
  # resource path
  local_var_path = "/company/configurations"

  # query parameters
  query_params = {}
  query_params[:'managementSolutionName'] = opts[:'management_solution_name'] if !opts[:'management_solution_name'].nil?
  query_params[:'managedIdentifier'] = opts[:'managed_identifier'] if !opts[:'managed_identifier'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'level'] = opts[:'level'] if !opts[:'level'].nil?
  query_params[:'childConfigurationsMatchingOn'] = opts[:'child_configurations_matching_on'] if !opts[:'child_configurations_matching_on'].nil?
  query_params[:'inactivateConfigurationsMatchingOn'] = opts[:'inactivate_configurations_matching_on'] if !opts[:'inactivate_configurations_matching_on'].nil?
  query_params[:'inactiveConfigurationStatusId'] = opts[:'inactive_configuration_status_id'] if !opts[:'inactive_configuration_status_id'].nil?

  # 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(configuration)
  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 => 'Configuration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationsApi#company_configurations_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end