Class: ZoomUs::IMGroups

Inherits:
Object
  • Object
show all
Defined in:
lib/zoom_us/im_groups.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IMGroups 



19
20
21
 
# File 'lib/zoom_us/im_groups.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/zoom_us/im_groups.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#im_group(group_id, opts = {}) ⇒ InlineResponse20019

Retrieve an IM Directory Group Retrieve an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.
Scopes: ‘imgroup:read:admin`



27
28
29
30
 
# File 'lib/zoom_us/im_groups.rb', line 27

def im_group(group_id, opts = {})
  data, _status_code, _headers = im_group_with_http_info(group_id, opts)
  data
end

#im_group_create(body, opts = {}) ⇒ nil

Create an IM Directory Group Create an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.
Scopes: ‘imgroup:write:admin`



81
82
83
84
 
# File 'lib/zoom_us/im_groups.rb', line 81

def im_group_create(body, opts = {})
  im_group_create_with_http_info(body, opts)
  nil
end

#im_group_create_with_http_info(body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create an IM Directory Group Create an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.&lt;br&gt;&lt;br&gt; Scopes: &#x60;imgroup:write:admin&#x60;&lt;br&gt;



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
126
127
128
 
# File 'lib/zoom_us/im_groups.rb', line 91

def im_group_create_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IMGroupsApi.im_group_create ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling IMGroupsApi.im_group_create"
  end
  # resource path
  local_var_path = '/im/groups'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IMGroupsApi#im_group_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#im_group_delete(group_id, opts = {}) ⇒ nil

Delete an IM Directory Group Delete an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.
Scopes: ‘imgroup:write:admin`



134
135
136
137
 
# File 'lib/zoom_us/im_groups.rb', line 134

def im_group_delete(group_id, opts = {})
  im_group_delete_with_http_info(group_id, opts)
  nil
end

#im_group_delete_with_http_info(group_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an IM Directory Group Delete an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.&lt;br&gt;&lt;br&gt; Scopes: &#x60;imgroup:write:admin&#x60;&lt;br&gt;



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
 
# File 'lib/zoom_us/im_groups.rb', line 144

def im_group_delete_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IMGroupsApi.im_group_delete ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling IMGroupsApi.im_group_delete"
  end
  # resource path
  local_var_path = '/im/groups/{groupId}'.sub('{' + 'groupId' + '}', group_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', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  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: IMGroupsApi#im_group_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#im_group_members(group_id, opts = {}) ⇒ GroupMemberList

List IM Directory Group Members List the members of an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management).
Scope: ‘imgroup:read:admin`

Options Hash (opts):

  • :page_size (Integer) —

    The number of records returned within a single API call. (default to 30)

  • :page_number (Integer) —

    The current page number of returned records. (default to 1)



189
190
191
192
 
# File 'lib/zoom_us/im_groups.rb', line 189

def im_group_members(group_id, opts = {})
  data, _status_code, _headers = im_group_members_with_http_info(group_id, opts)
  data
end

#im_group_members_create(group_id, body, opts = {}) ⇒ nil

Add IM Directory Group Members Add members to an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.
Scope: ‘imgroup:write:admin`



252
253
254
255
 
# File 'lib/zoom_us/im_groups.rb', line 252

def im_group_members_create(group_id, body, opts = {})
  im_group_members_create_with_http_info(group_id, body, opts)
  nil
end

#im_group_members_create_with_http_info(group_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Add IM Directory Group Members Add members to an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.&lt;br&gt;&lt;br&gt; Scope: &#x60;imgroup:write:admin&#x60;&lt;br&gt;



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
301
302
303
304
 
# File 'lib/zoom_us/im_groups.rb', line 263

def im_group_members_create_with_http_info(group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IMGroupsApi.im_group_members_create ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling IMGroupsApi.im_group_members_create"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling IMGroupsApi.im_group_members_create"
  end
  # resource path
  local_var_path = '/im/groups/{groupId}/members'.sub('{' + 'groupId' + '}', group_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', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IMGroupsApi#im_group_members_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#im_group_members_delete(group_id, member_id, opts = {}) ⇒ nil

Delete an IM Directory Group Member Delete a member from an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.
Scopes: ‘imgroup:write:admin`



311
312
313
314
 
# File 'lib/zoom_us/im_groups.rb', line 311

def im_group_members_delete(group_id, member_id, opts = {})
  im_group_members_delete_with_http_info(group_id, member_id, opts)
  nil
end

#im_group_members_delete_with_http_info(group_id, member_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an IM Directory Group Member Delete a member from an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.&lt;br&gt;&lt;br&gt; Scopes: &#x60;imgroup:write:admin&#x60;&lt;br&gt;



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
362
363
 
# File 'lib/zoom_us/im_groups.rb', line 322

def im_group_members_delete_with_http_info(group_id, member_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IMGroupsApi.im_group_members_delete ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling IMGroupsApi.im_group_members_delete"
  end
  # verify the required parameter 'member_id' is set
  if @api_client.config.client_side_validation && member_id.nil?
    fail ArgumentError, "Missing the required parameter 'member_id' when calling IMGroupsApi.im_group_members_delete"
  end
  # resource path
  local_var_path = '/im/groups/{groupId}/members/{memberId}'.sub('{' + 'groupId' + '}', group_id.to_s).sub('{' + 'memberId' + '}', member_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', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  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: IMGroupsApi#im_group_members_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#im_group_members_with_http_info(group_id, opts = {}) ⇒ Array<(GroupMemberList, Fixnum, Hash)>

List IM Directory Group Members List the members of an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management).&lt;br&gt;&lt;br&gt; Scope: &#x60;imgroup:read:admin&#x60;&lt;br&gt;

Options Hash (opts):

  • :page_size (Integer) —

    The number of records returned within a single API call.

  • :page_number (Integer) —

    The current page number of returned records.



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/zoom_us/im_groups.rb', line 201

def im_group_members_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IMGroupsApi.im_group_members ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling IMGroupsApi.im_group_members"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 300
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IMGroupsApi.im_group_members, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/im/groups/{groupId}/members'.sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page_number'] = opts[:'page_number'] if !opts[:'page_number'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  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 => 'GroupMemberList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IMGroupsApi#im_group_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#im_group_update(group_id, body, opts = {}) ⇒ nil

Update an IM Directory Group Update an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.
Scopes: ‘imgroup:write:admin`



370
371
372
373
 
# File 'lib/zoom_us/im_groups.rb', line 370

def im_group_update(group_id, body, opts = {})
  im_group_update_with_http_info(group_id, body, opts)
  nil
end

#im_group_update_with_http_info(group_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update an IM Directory Group Update an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.&lt;br&gt;&lt;br&gt; Scopes: &#x60;imgroup:write:admin&#x60;&lt;br&gt;



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
416
417
418
419
420
421
422
 
# File 'lib/zoom_us/im_groups.rb', line 381

def im_group_update_with_http_info(group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IMGroupsApi.im_group_update ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling IMGroupsApi.im_group_update"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling IMGroupsApi.im_group_update"
  end
  # resource path
  local_var_path = '/im/groups/{groupId}'.sub('{' + 'groupId' + '}', group_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', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IMGroupsApi#im_group_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#im_group_with_http_info(group_id, opts = {}) ⇒ Array<(InlineResponse20019, Fixnum, Hash)>

Retrieve an IM Directory Group Retrieve an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.&lt;br&gt;&lt;br&gt; Scopes: &#x60;imgroup:read:admin&#x60;&lt;br&gt;



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/zoom_us/im_groups.rb', line 37

def im_group_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IMGroupsApi.im_group ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling IMGroupsApi.im_group"
  end
  # resource path
  local_var_path = '/im/groups/{groupId}'.sub('{' + 'groupId' + '}', group_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', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  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 => 'InlineResponse20019')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IMGroupsApi#im_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#im_groups(opts = {}) ⇒ IMGroupList

List IM Directory Groups List [IM directory groups](support.zoom.us/hc/en-us/articles/203749815-IM-Management).
Scopes: ‘imgroup:read:admin`



427
428
429
430
 
# File 'lib/zoom_us/im_groups.rb', line 427

def im_groups(opts = {})
  data, _status_code, _headers = im_groups_with_http_info(opts)
  data
end

#im_groups_with_http_info(opts = {}) ⇒ Array<(IMGroupList, Fixnum, Hash)>

List IM Directory Groups List [IM directory groups](support.zoom.us/hc/en-us/articles/203749815-IM-Management).&lt;br&gt;&lt;br&gt; Scopes: &#x60;imgroup:read:admin&#x60;&lt;br&gt;



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
 
# File 'lib/zoom_us/im_groups.rb', line 436

def im_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IMGroupsApi.im_groups ...'
  end
  # resource path
  local_var_path = '/im/groups'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  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 => 'IMGroupList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IMGroupsApi#im_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end