Class: ConnectWise::MembersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MembersApi

Returns a new instance of MembersApi.



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

def api_client
  @api_client
end

Instance Method Details

#system_members_count_get(opts = {}) ⇒ Count

Get Members Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



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

def system_members_count_get(opts = {})
  data, _status_code, _headers = system_members_count_get_with_http_info(opts)
  return data
end

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

Get Members Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:

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

    Count data, response status code and response headers



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

def system_members_count_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MembersApi.system_members_count_get ..."
  end
  # resource path
  local_var_path = "/system/members/count"

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

#system_members_get(opts = {}) ⇒ Array<Member>

Get Members

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)

Returns:



72
73
74
75
 
# File 'lib/connectwise-ruby-sdk/api/members_api.rb', line 72

def system_members_get(opts = {})
  data, _status_code, _headers = system_members_get_with_http_info(opts)
  return data
end

#system_members_get_with_http_info(opts = {}) ⇒ Array<(Array<Member>, Fixnum, Hash)>

Get Members

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)

Returns:

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

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



87
88
89
90
91
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
 
# File 'lib/connectwise-ruby-sdk/api/members_api.rb', line 87

def system_members_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MembersApi.system_members_get ..."
  end
  # resource path
  local_var_path = "/system/members"

  # 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?

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

#system_members_id_deactivate_post(id, item, opts = {}) ⇒ MemberDeactivation

Deactivatemember

Parameters:

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

    the optional parameters

Returns:



133
134
135
136
 
# File 'lib/connectwise-ruby-sdk/api/members_api.rb', line 133

def system_members_id_deactivate_post(id, item, opts = {})
  data, _status_code, _headers = system_members_id_deactivate_post_with_http_info(id, item, opts)
  return data
end

#system_members_id_deactivate_post_with_http_info(id, item, opts = {}) ⇒ Array<(MemberDeactivation, Fixnum, Hash)>

Deactivatemember

Parameters:

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

    the optional parameters

Returns:

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

    MemberDeactivation data, response status code and response headers



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

def system_members_id_deactivate_post_with_http_info(id, item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MembersApi.system_members_id_deactivate_post ..."
  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 MembersApi.system_members_id_deactivate_post"
  end
  # verify the required parameter 'item' is set
  if @api_client.config.client_side_validation && item.nil?
    fail ArgumentError, "Missing the required parameter 'item' when calling MembersApi.system_members_id_deactivate_post"
  end
  # resource path
  local_var_path = "/system/members/{id}/deactivate".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'])
  # 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(item)
  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 => 'MemberDeactivation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MembersApi#system_members_id_deactivate_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_members_id_get(id, opts = {}) ⇒ Member

Get Member By Id

Parameters:

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

    the optional parameters

Returns:



193
194
195
196
 
# File 'lib/connectwise-ruby-sdk/api/members_api.rb', line 193

def system_members_id_get(id, opts = {})
  data, _status_code, _headers = system_members_id_get_with_http_info(id, opts)
  return data
end

#system_members_id_get_with_http_info(id, opts = {}) ⇒ Array<(Member, Fixnum, Hash)>

Get Member By Id

Parameters:

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

    the optional parameters

Returns:

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

    Member data, response status code and response headers



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

def system_members_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MembersApi.system_members_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 MembersApi.system_members_id_get"
  end
  # resource path
  local_var_path = "/system/members/{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 => 'Member')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MembersApi#system_members_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_members_id_patch(id, operations, opts = {}) ⇒ Member

Update Member

Parameters:

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

    the optional parameters

Returns:



247
248
249
250
 
# File 'lib/connectwise-ruby-sdk/api/members_api.rb', line 247

def system_members_id_patch(id, operations, opts = {})
  data, _status_code, _headers = system_members_id_patch_with_http_info(id, operations, opts)
  return data
end

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

Update Member

Parameters:

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

    the optional parameters

Returns:

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

    Member data, response status code and response headers



258
259
260
261
262
263
264
265
266
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
 
# File 'lib/connectwise-ruby-sdk/api/members_api.rb', line 258

def system_members_id_patch_with_http_info(id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MembersApi.system_members_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 MembersApi.system_members_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 MembersApi.system_members_id_patch"
  end
  # resource path
  local_var_path = "/system/members/{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'])
  # 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 => 'Member')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MembersApi#system_members_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_members_id_put(id, member, opts = {}) ⇒ Member

Replace Member

Parameters:

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

    the optional parameters

Returns:



308
309
310
311
 
# File 'lib/connectwise-ruby-sdk/api/members_api.rb', line 308

def system_members_id_put(id, member, opts = {})
  data, _status_code, _headers = system_members_id_put_with_http_info(id, member, opts)
  return data
end

#system_members_id_put_with_http_info(id, member, opts = {}) ⇒ Array<(Member, Fixnum, Hash)>

Replace Member

Parameters:

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

    the optional parameters

Returns:

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

    Member data, response status code and response headers



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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/connectwise-ruby-sdk/api/members_api.rb', line 319

def system_members_id_put_with_http_info(id, member, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MembersApi.system_members_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 MembersApi.system_members_id_put"
  end
  # verify the required parameter 'member' is set
  if @api_client.config.client_side_validation && member.nil?
    fail ArgumentError, "Missing the required parameter 'member' when calling MembersApi.system_members_id_put"
  end
  # resource path
  local_var_path = "/system/members/{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'])
  # 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(member)
  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 => 'Member')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MembersApi#system_members_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete Member Unused Time Sheets

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


368
369
370
371
 
# File 'lib/connectwise-ruby-sdk/api/members_api.rb', line 368

def system_members_id_unused_time_sheets_delete(id, opts = {})
  system_members_id_unused_time_sheets_delete_with_http_info(id, opts)
  return nil
end

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

Delete Member Unused Time Sheets

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def system_members_id_unused_time_sheets_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MembersApi.system_members_id_unused_time_sheets_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 MembersApi.system_members_id_unused_time_sheets_delete"
  end
  # resource path
  local_var_path = "/system/members/{id}/unusedTimeSheets".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: MembersApi#system_members_id_unused_time_sheets_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_members_member_identifier_tokens_post(member_identifier, opts = {}) ⇒ Token

Create Token By Member Identifier

Parameters:

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

    the optional parameters

Returns:



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

def system_members_member_identifier_tokens_post(member_identifier, opts = {})
  data, _status_code, _headers = system_members_member_identifier_tokens_post_with_http_info(member_identifier, opts)
  return data
end

#system_members_member_identifier_tokens_post_with_http_info(member_identifier, opts = {}) ⇒ Array<(Token, Fixnum, Hash)>

Create Token By Member Identifier

Parameters:

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

    the optional parameters

Returns:

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

    Token data, response status code and response headers



428
429
430
431
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
 
# File 'lib/connectwise-ruby-sdk/api/members_api.rb', line 428

def system_members_member_identifier_tokens_post_with_http_info(member_identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MembersApi.system_members_member_identifier_tokens_post ..."
  end
  # verify the required parameter 'member_identifier' is set
  if @api_client.config.client_side_validation && member_identifier.nil?
    fail ArgumentError, "Missing the required parameter 'member_identifier' when calling MembersApi.system_members_member_identifier_tokens_post"
  end
  # resource path
  local_var_path = "/system/members/{memberIdentifier}/tokens".sub('{' + 'memberIdentifier' + '}', member_identifier.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(: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 => 'Token')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MembersApi#system_members_member_identifier_tokens_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_members_post(member, opts = {}) ⇒ Member

Create Member

Parameters:

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

    the optional parameters

Returns:



471
472
473
474
 
# File 'lib/connectwise-ruby-sdk/api/members_api.rb', line 471

def system_members_post(member, opts = {})
  data, _status_code, _headers = system_members_post_with_http_info(member, opts)
  return data
end

#system_members_post_with_http_info(member, opts = {}) ⇒ Array<(Member, Fixnum, Hash)>

Create Member

Parameters:

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

    the optional parameters

Returns:

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

    Member data, response status code and response headers



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/connectwise-ruby-sdk/api/members_api.rb', line 481

def system_members_post_with_http_info(member, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MembersApi.system_members_post ..."
  end
  # verify the required parameter 'member' is set
  if @api_client.config.client_side_validation && member.nil?
    fail ArgumentError, "Missing the required parameter 'member' when calling MembersApi.system_members_post"
  end
  # resource path
  local_var_path = "/system/members"

  # query parameters
  query_params = {}

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