Class: ConnectWise::SystemSettingsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SystemSettingsApi

Returns a new instance of SystemSettingsApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_system_settings(client_id, opts = {}) ⇒ Array<SystemSetting>

Get List of SystemSetting

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/system_settings_api.rb', line 33

def get_system_settings(client_id, opts = {})
  data, _status_code, _headers = get_system_settings_with_http_info(client_id, opts)
  data
end

#get_system_settings_by_id(id, client_id, opts = {}) ⇒ SystemSetting

Get SystemSetting

Parameters:

  • id (Integer) —

    settingId

  • 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/system_settings_api.rb', line 115

def get_system_settings_by_id(id, client_id, opts = {})
  data, _status_code, _headers = get_system_settings_by_id_with_http_info(id, client_id, opts)
  data
end

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

Get SystemSetting

Parameters:

  • id (Integer) —

    settingId

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

    SystemSetting 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/system_settings_api.rb', line 133

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

  # resource path
  local_var_path = '/system/settings/{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] || 'SystemSetting'

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

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

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

Get Count of SystemSetting

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:



199
200
201
202
 
# File 'lib/connect_wise/api/system_settings_api.rb', line 199

def get_system_settings_count(client_id, opts = {})
  data, _status_code, _headers = get_system_settings_count_with_http_info(client_id, opts)
  data
end

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

Get Count of SystemSetting

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) 


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
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/connect_wise/api/system_settings_api.rb', line 216

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

  # resource path
  local_var_path = '/system/settings/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: :'SystemSettingsApi.get_system_settings_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: SystemSettingsApi#get_system_settings_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_system_settings_with_http_info(client_id, opts = {}) ⇒ Array<(Array<SystemSetting>, Integer, Hash)>

Get List of SystemSetting

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

    Array<SystemSetting> 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/system_settings_api.rb', line 50

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

  # resource path
  local_var_path = '/system/settings'

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

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

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

#patch_system_settings_by_id(id, client_id, patch_operation, opts = {}) ⇒ SystemSetting

Patch SystemSetting

Parameters:

  • id (Integer) —

    settingId

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

    List of PatchOperation

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

    the optional parameters

Returns:



274
275
276
277
 
# File 'lib/connect_wise/api/system_settings_api.rb', line 274

def patch_system_settings_by_id(id, client_id, patch_operation, opts = {})
  data, _status_code, _headers = patch_system_settings_by_id_with_http_info(id, client_id, patch_operation, opts)
  data
end

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

Patch SystemSetting

Parameters:

  • id (Integer) —

    settingId

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

    List of PatchOperation

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

    the optional parameters

Returns:

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

    SystemSetting data, response status code and response headers

Raises:

  • (ArgumentError) 


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
330
331
332
333
334
 
# File 'lib/connect_wise/api/system_settings_api.rb', line 285

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

  # resource path
  local_var_path = '/system/settings/{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] || 'SystemSetting'

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

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

#put_system_settings_by_id(id, client_id, system_setting, opts = {}) ⇒ SystemSetting

Put SystemSetting

Parameters:

  • id (Integer) —

    settingId

  • client_id (String)
  • system_setting (SystemSetting) —

    systemSetting

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

    the optional parameters

Returns:



342
343
344
345
 
# File 'lib/connect_wise/api/system_settings_api.rb', line 342

def put_system_settings_by_id(id, client_id, system_setting, opts = {})
  data, _status_code, _headers = put_system_settings_by_id_with_http_info(id, client_id, system_setting, opts)
  data
end

#put_system_settings_by_id_with_http_info(id, client_id, system_setting, opts = {}) ⇒ Array<(SystemSetting, Integer, Hash)>

Put SystemSetting

Parameters:

  • id (Integer) —

    settingId

  • client_id (String)
  • system_setting (SystemSetting) —

    systemSetting

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

    the optional parameters

Returns:

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

    SystemSetting data, response status code and response headers

Raises:

  • (ArgumentError) 


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
 
# File 'lib/connect_wise/api/system_settings_api.rb', line 353

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

  # resource path
  local_var_path = '/system/settings/{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(system_setting)

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

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

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