Class: ConnectWise::ApiMembersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApiMembersApi

Returns a new instance of ApiMembersApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_system_api_members(client_id, opts = {}) ⇒ Array<ApiMember>

Get List of ApiMember

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

def get_system_api_members(client_id, opts = {})
  data, _status_code, _headers = get_system_api_members_with_http_info(client_id, opts)
  data
end

#get_system_api_members_by_id(id, client_id, opts = {}) ⇒ ApiMember

Get ApiMember

Parameters:

  • id (Integer) —

    apiMemberId

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

def get_system_api_members_by_id(id, client_id, opts = {})
  data, _status_code, _headers = get_system_api_members_by_id_with_http_info(id, client_id, opts)
  data
end

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

Get ApiMember

Parameters:

  • id (Integer) —

    apiMemberId

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

    ApiMember 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/api_members_api.rb', line 133

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

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

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

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

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

Get Count of

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/api_members_api.rb', line 199

def get_system_api_members_count(client_id, opts = {})
  data, _status_code, _headers = get_system_api_members_count_with_http_info(client_id, opts)
  data
end

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

Get Count of

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/api_members_api.rb', line 216

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

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

#get_system_api_members_default(client_id, opts = {}) ⇒ ApiMember

Get ApiMember

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:



280
281
282
283
 
# File 'lib/connect_wise/api/api_members_api.rb', line 280

def get_system_api_members_default(client_id, opts = {})
  data, _status_code, _headers = get_system_api_members_default_with_http_info(client_id, opts)
  data
end

#get_system_api_members_default_with_http_info(client_id, opts = {}) ⇒ Array<(ApiMember, Integer, Hash)>

Get ApiMember

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

    ApiMember data, response status code and response headers

Raises:

  • (ArgumentError) 


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
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/connect_wise/api/api_members_api.rb', line 297

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

  # resource path
  local_var_path = '/system/apiMembers/default'

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

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

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

#get_system_api_members_with_http_info(client_id, opts = {}) ⇒ Array<(Array<ApiMember>, Integer, Hash)>

Get List of ApiMember

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

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

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

  # resource path
  local_var_path = '/system/apiMembers'

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

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

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

#patch_system_api_members_by_id(id, client_id, patch_operation, opts = {}) ⇒ ApiMember

Patch ApiMember

Parameters:

  • id (Integer) —

    apiMemberId

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

    List of PatchOperation

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

    the optional parameters

Returns:



355
356
357
358
 
# File 'lib/connect_wise/api/api_members_api.rb', line 355

def patch_system_api_members_by_id(id, client_id, patch_operation, opts = {})
  data, _status_code, _headers = patch_system_api_members_by_id_with_http_info(id, client_id, patch_operation, opts)
  data
end

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

Patch ApiMember

Parameters:

  • id (Integer) —

    apiMemberId

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

    List of PatchOperation

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

    the optional parameters

Returns:

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

    ApiMember data, response status code and response headers

Raises:

  • (ArgumentError) 


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
415
 
# File 'lib/connect_wise/api/api_members_api.rb', line 366

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

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

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

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

#post_system_api_members(client_id, api_member, opts = {}) ⇒ ApiMember

Post ApiMember

Parameters:

  • client_id (String)
  • api_member (ApiMember) —

    apiMember

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

    the optional parameters

Returns:



422
423
424
425
 
# File 'lib/connect_wise/api/api_members_api.rb', line 422

def post_system_api_members(client_id, api_member, opts = {})
  data, _status_code, _headers = post_system_api_members_with_http_info(client_id, api_member, opts)
  data
end

#post_system_api_members_with_http_info(client_id, api_member, opts = {}) ⇒ Array<(ApiMember, Integer, Hash)>

Post ApiMember

Parameters:

  • client_id (String)
  • api_member (ApiMember) —

    apiMember

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

    the optional parameters

Returns:

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

    ApiMember data, response status code and response headers

Raises:

  • (ArgumentError) 


432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/connect_wise/api/api_members_api.rb', line 432

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

  # resource path
  local_var_path = '/system/apiMembers'

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

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

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

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

#put_system_api_members_by_id(id, client_id, api_member, opts = {}) ⇒ ApiMember

Put ApiMember

Parameters:

  • id (Integer) —

    apiMemberId

  • client_id (String)
  • api_member (ApiMember) —

    apiMember

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

    the optional parameters

Returns:



487
488
489
490
 
# File 'lib/connect_wise/api/api_members_api.rb', line 487

def put_system_api_members_by_id(id, client_id, api_member, opts = {})
  data, _status_code, _headers = put_system_api_members_by_id_with_http_info(id, client_id, api_member, opts)
  data
end

#put_system_api_members_by_id_with_http_info(id, client_id, api_member, opts = {}) ⇒ Array<(ApiMember, Integer, Hash)>

Put ApiMember

Parameters:

  • id (Integer) —

    apiMemberId

  • client_id (String)
  • api_member (ApiMember) —

    apiMember

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

    the optional parameters

Returns:

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

    ApiMember data, response status code and response headers

Raises:

  • (ArgumentError) 


498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/connect_wise/api/api_members_api.rb', line 498

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

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

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

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

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