Class: ZoomUs::Groups

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Groups

Returns a new instance of Groups.



19
20
21
 
# File 'lib/zoom_us/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/groups.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_group_lock_settings(group_id, opts = {}) ⇒ InlineResponse20069

Get Locked Settings Retrieve a [group’s](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually. <p style="background-color:#FEEFB3; color:#9F6000">
Note:</b> The ‘force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p> Prerequisite: Pro, Business, or Education account
Scopes: `group:read:admin`

Parameters:

  • group_id —

    Id of the group.

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

    the optional parameters

Returns:

  • (InlineResponse20069) 


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

def get_group_lock_settings(group_id, opts = {})
  data, _status_code, _headers = get_group_lock_settings_with_http_info(group_id, opts)
  data
end

#get_group_lock_settings_with_http_info(group_id, opts = {}) ⇒ Array<(InlineResponse20069, Fixnum, Hash)>

Get Locked Settings Retrieve a [group&#39;s](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually. &lt;p style&#x3D;&quot;background-color:#FEEFB3; color:#9F6000&quot;&gt;&lt;br&gt;Note:&lt;/b&gt; The &#x60;force_pmi_jbh_password&#x60; field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.&lt;/p&gt; Prerequisite: Pro, Business, or Education account&lt;br&gt; Scopes: &#x60;group:read:admin&#x60;&lt;br&gt;

Parameters:

  • group_id —

    Id of the group.

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

    the optional parameters

Returns:

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

    InlineResponse20069 data, response status code and response headers



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/groups.rb', line 37

def get_group_lock_settings_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.get_group_lock_settings ...'
  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 GroupsApi.get_group_lock_settings"
  end
  # resource path
  local_var_path = '/groups/{groupId}/lock_settings'.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 => 'InlineResponse20069')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#get_group_lock_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_group_settings(group_id, opts = {}) ⇒ Object

Get a Group’s Settings Get settings for a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-). Prerequisite: Pro, Business, or Education account
Scopes: ‘group:read:admin`

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


82
83
84
85
 
# File 'lib/zoom_us/groups.rb', line 82

def get_group_settings(group_id, opts = {})
  data, _status_code, _headers = get_group_settings_with_http_info(group_id, opts)
  data
end

#get_group_settings_with_http_info(group_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Get a Group&#39;s Settings Get settings for a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-). Prerequisite: Pro, Business, or Education account&lt;br&gt; Scopes: &#x60;group:read:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object data, response status code and response headers



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
132
133
134
135
 
# File 'lib/zoom_us/groups.rb', line 93

def get_group_settings_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.get_group_settings ...'
  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 GroupsApi.get_group_settings"
  end
  if @api_client.config.client_side_validation && opts[:'option'] && !['meeting_authentication', 'recording_authentication'].include?(opts[:'option'])
    fail ArgumentError, 'invalid value for "option", must be one of meeting_authentication, recording_authentication'
  end
  # resource path
  local_var_path = '/groups/{groupId}/settings'.sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'option'] = opts[:'option'] if !opts[:'option'].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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#get_group_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#group(group_id, opts = {}) ⇒ InlineResponse20017

Get a Group Get a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. Prerequisite: Pro, Business, or Education account
Scopes: ‘group:read:admin`

Parameters:

Returns:

  • (InlineResponse20017) 


141
142
143
144
 
# File 'lib/zoom_us/groups.rb', line 141

def group(group_id, opts = {})
  data, _status_code, _headers = group_with_http_info(group_id, opts)
  data
end

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

Create a Group Create a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. Prerequisite: Pro or higher account.
Scopes: ‘group:write:admin`

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


195
196
197
198
 
# File 'lib/zoom_us/groups.rb', line 195

def group_create(body, opts = {})
  group_create_with_http_info(body, opts)
  nil
end

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

Create a Group Create a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. Prerequisite: Pro or higher account.&lt;br&gt; Scopes: &#x60;group:write:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def group_create_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.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 GroupsApi.group_create"
  end
  # resource path
  local_var_path = '/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: GroupsApi#group_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a Group Delete a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-). Prerequisite: Pro, Business, or Education account
Scopes: ‘group:write:admin`

Parameters:

Returns:

  • (nil) 


248
249
250
251
 
# File 'lib/zoom_us/groups.rb', line 248

def group_delete(group_id, opts = {})
  group_delete_with_http_info(group_id, opts)
  nil
end

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

Delete a Group Delete a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-). Prerequisite: Pro, Business, or Education account&lt;br&gt; Scopes: &#x60;group:write:admin&#x60;&lt;br&gt;

Parameters:

Returns:

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

    nil, 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
 
# File 'lib/zoom_us/groups.rb', line 258

def group_delete_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.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 GroupsApi.group_delete"
  end
  # resource path
  local_var_path = '/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: GroupsApi#group_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#group_locked_settings(group_id, opts = {}) ⇒ Object

Update Locked Settings Update a [group’s](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually. <p style="background-color:#FEEFB3; color:#9F6000">
Note:</b> The ‘force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p> Prerequisite: Pro, Business, or Education account
Scopes: `group:write:admin`

Parameters:

  • group_id —

    The Id of the group.

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

    the optional parameters

Options Hash (opts):

  • :body (Body50)

Returns:

  • (Object) 


302
303
304
305
 
# File 'lib/zoom_us/groups.rb', line 302

def group_locked_settings(group_id, opts = {})
  data, _status_code, _headers = group_locked_settings_with_http_info(group_id, opts)
  data
end

#group_locked_settings_with_http_info(group_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Update Locked Settings Update a [group&#39;s](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually. &lt;p style&#x3D;&quot;background-color:#FEEFB3; color:#9F6000&quot;&gt;&lt;br&gt;Note:&lt;/b&gt; The &#x60;force_pmi_jbh_password&#x60; field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.&lt;/p&gt; Prerequisite: Pro, Business, or Education account&lt;br&gt; Scopes: &#x60;group:write:admin&#x60;&lt;br&gt;

Parameters:

  • group_id —

    The Id of the group.

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

    the optional parameters

Options Hash (opts):

  • :body (Body50)

Returns:

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

    Object data, response status code and response headers



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
348
349
350
351
 
# File 'lib/zoom_us/groups.rb', line 313

def group_locked_settings_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.group_locked_settings ...'
  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 GroupsApi.group_locked_settings"
  end
  # resource path
  local_var_path = '/groups/{groupId}/lock_settings'.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(opts[:'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,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#group_locked_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#group_members(group_id, opts = {}) ⇒ InlineResponse20018

List Group Members List the members of a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. Prerequisite: Pro, Business, or Education account
Scopes: ‘group:read:admin`

Parameters:

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)

Returns:

  • (InlineResponse20018) 


359
360
361
362
 
# File 'lib/zoom_us/groups.rb', line 359

def group_members(group_id, opts = {})
  data, _status_code, _headers = group_members_with_http_info(group_id, opts)
  data
end

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

Add Group Members Add members to a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. Prerequisite: Pro, Business, or Education account
Scopes: ‘group:write:admin`

Parameters:

Returns:

  • (nil) 


422
423
424
425
 
# File 'lib/zoom_us/groups.rb', line 422

def group_members_create(group_id, body, opts = {})
  group_members_create_with_http_info(group_id, body, opts)
  nil
end

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

Add Group Members Add members to a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. Prerequisite: Pro, Business, or Education account&lt;br&gt; Scopes: &#x60;group:write:admin&#x60;&lt;br&gt;

Parameters:

Returns:

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

    nil, response status code and response headers



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

def group_members_create_with_http_info(group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.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 GroupsApi.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 GroupsApi.group_members_create"
  end
  # resource path
  local_var_path = '/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: GroupsApi#group_members_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a Group Member Delete a member from a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) in a Zoom account. Prerequisite: Pro, Business, or Education account
Scopes: ‘group:write:admin`

Parameters:

Returns:

  • (nil) 


481
482
483
484
 
# File 'lib/zoom_us/groups.rb', line 481

def group_members_delete(group_id, member_id, opts = {})
  group_members_delete_with_http_info(group_id, member_id, opts)
  nil
end

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

Delete a Group Member Delete a member from a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) in a Zoom account. Prerequisite: Pro, Business, or Education account&lt;br&gt; Scopes: &#x60;group:write:admin&#x60;&lt;br&gt;

Parameters:

Returns:

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

    nil, response status code and response headers



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
520
521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/zoom_us/groups.rb', line 492

def group_members_delete_with_http_info(group_id, member_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.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 GroupsApi.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 GroupsApi.group_members_delete"
  end
  # resource path
  local_var_path = '/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: GroupsApi#group_members_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#group_members_with_http_info(group_id, opts = {}) ⇒ Array<(InlineResponse20018, Fixnum, Hash)>

List Group Members List the members of a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. Prerequisite: Pro, Business, or Education account&lt;br&gt; Scopes: &#x60;group:read:admin&#x60;&lt;br&gt;

Parameters:

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.

Returns:

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

    InlineResponse20018 data, response status code and response headers



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/zoom_us/groups.rb', line 371

def group_members_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.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 GroupsApi.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 GroupsApi.group_members, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/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 => 'InlineResponse20018')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#group_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a Group Update a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. Prerequisite: Pro, Business, or Education account
Scopes: ‘group:write:admin`

Parameters:

Returns:

  • (nil) 


540
541
542
543
 
# File 'lib/zoom_us/groups.rb', line 540

def group_update(group_id, body, opts = {})
  group_update_with_http_info(group_id, body, opts)
  nil
end

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

Update a Group Update a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. Prerequisite: Pro, Business, or Education account&lt;br&gt; Scopes: &#x60;group:write:admin&#x60;&lt;br&gt;

Parameters:

Returns:

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

    nil, response status code and response headers



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
 
# File 'lib/zoom_us/groups.rb', line 551

def group_update_with_http_info(group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.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 GroupsApi.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 GroupsApi.group_update"
  end
  # resource path
  local_var_path = '/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: GroupsApi#group_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#group_with_http_info(group_id, opts = {}) ⇒ Array<(InlineResponse20017, Fixnum, Hash)>

Get a Group Get a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. Prerequisite: Pro, Business, or Education account&lt;br&gt; Scopes: &#x60;group:read:admin&#x60;&lt;br&gt;

Parameters:

Returns:

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

    InlineResponse20017 data, response status code and response headers



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
187
188
189
 
# File 'lib/zoom_us/groups.rb', line 151

def group_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.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 GroupsApi.group"
  end
  # resource path
  local_var_path = '/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 => 'InlineResponse20017')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#groups(opts = {}) ⇒ InlineResponse20016

List Groups List [groups](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. Prerequisite: Pro or higher account.
Scopes: ‘group:read:admin`

Parameters:

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

    the optional parameters

Returns:

  • (InlineResponse20016) 


597
598
599
600
 
# File 'lib/zoom_us/groups.rb', line 597

def groups(opts = {})
  data, _status_code, _headers = groups_with_http_info(opts)
  data
end

#groups_with_http_info(opts = {}) ⇒ Array<(InlineResponse20016, Fixnum, Hash)>

List Groups List [groups](support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. Prerequisite: Pro or higher account.&lt;br&gt; Scopes: &#x60;group:read:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20016 data, response status code and response headers



606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
 
# File 'lib/zoom_us/groups.rb', line 606

def groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.groups ...'
  end
  # resource path
  local_var_path = '/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 => 'InlineResponse20016')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_a_group_member(group_id, member_id, opts = {}) ⇒ Object

Update a Group Member If a user is a member in multiple groups, you can [set a primary group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-#h_d07c7dcd-4fd8-485a-b5fe-a322e8d21c09) for the user. The group member will use the primary group’s settings by default. However, if settings are locked in other groups, those settings will continue to be locked for that user. By default, the primary group is the first group that user is added to.
Use this API to perform either of the following tasks: * Simultaneously remove a member from one group and move the member to a different group. * Set a primary group for the user
Prerequisites: * Pro or higher account
Scopes: ‘group:write:admin`

Parameters:

  • group_id —

    Unique Identifier of the group. Can be retrieved by calling [GET /groups](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.&lt;br&gt; To change a member&#39;s primary group, provide the groupId of the member&#39;s current primary group as the value of this field.&lt;br&gt; To remove a member from one group and move the member to another group, provide the groupId of the group from which the member is to be moved.

  • member_id —

    Unique Identifier of the group member. Can be retrieved by calling the [List Group Members](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groupmembers) API.

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

    the optional parameters

Options Hash (opts):

  • :body (Body18)

Returns:

  • (Object) 


648
649
650
651
 
# File 'lib/zoom_us/groups.rb', line 648

def update_a_group_member(group_id, member_id, opts = {})
  data, _status_code, _headers = update_a_group_member_with_http_info(group_id, member_id, opts)
  data
end

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

Update a Group Member If a user is a member in multiple groups, you can [set a primary group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-#h_d07c7dcd-4fd8-485a-b5fe-a322e8d21c09) for the user. The group member will use the primary group&#39;s settings by default. However, if settings are locked in other groups, those settings will continue to be locked for that user. By default, the primary group is the first group that user is added to.&lt;br&gt;&lt;br&gt; Use this API to perform either of the following tasks: * Simultaneously remove a member from one group and move the member to a different group. * Set a primary group for the user&lt;br&gt;&lt;br&gt; Prerequisites: * Pro or higher account&lt;br&gt; Scopes: &#x60;group:write:admin&#x60;

Parameters:

  • group_id —

    Unique Identifier of the group. Can be retrieved by calling [GET /groups](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.&lt;br&gt; To change a member&#39;s primary group, provide the groupId of the member&#39;s current primary group as the value of this field.&lt;br&gt; To remove a member from one group and move the member to another group, provide the groupId of the group from which the member is to be moved.

  • member_id —

    Unique Identifier of the group member. Can be retrieved by calling the [List Group Members](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groupmembers) API.

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

    the optional parameters

Options Hash (opts):

  • :body (Body18)

Returns:

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

    Object data, response status code and response headers



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
 
# File 'lib/zoom_us/groups.rb', line 660

def update_a_group_member_with_http_info(group_id, member_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.update_a_group_member ...'
  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 GroupsApi.update_a_group_member"
  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 GroupsApi.update_a_group_member"
  end
  # resource path
  local_var_path = '/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 = @api_client.object_to_http_body(opts[:'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,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#update_a_group_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a Group’s Settings Update settings for a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-).<p style="background-color:#FEEFB3; color:#9F6000">
Note:</b> The ‘force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p> Prerequisite: Pro, Business, or Education account
Scopes: `group:write:admin`

Parameters:

  • group_id —

    Id of the group.

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

    the optional parameters

Options Hash (opts):

  • :body (Object)
  • :option (String)

Returns:

  • (nil) 


710
711
712
713
 
# File 'lib/zoom_us/groups.rb', line 710

def update_group_settings(group_id, opts = {})
  update_group_settings_with_http_info(group_id, opts)
  nil
end

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

Update a Group&#39;s Settings Update settings for a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-).&lt;p style&#x3D;&quot;background-color:#FEEFB3; color:#9F6000&quot;&gt;&lt;br&gt;Note:&lt;/b&gt; The &#x60;force_pmi_jbh_password&#x60; field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.&lt;/p&gt; Prerequisite: Pro, Business, or Education account&lt;br&gt; Scopes: &#x60;group:write:admin&#x60;&lt;br&gt;

Parameters:

  • group_id —

    Id of the group.

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

    the optional parameters

Options Hash (opts):

  • :body (Object)
  • :option (String)

Returns:

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

    nil, response status code and response headers



722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
 
# File 'lib/zoom_us/groups.rb', line 722

def update_group_settings_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.update_group_settings ...'
  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 GroupsApi.update_group_settings"
  end
  if @api_client.config.client_side_validation && opts[:'option'] && !['meeting_authentication', 'recording_authentication'].include?(opts[:'option'])
    fail ArgumentError, 'invalid value for "option", must be one of meeting_authentication, recording_authentication'
  end
  # resource path
  local_var_path = '/groups/{groupId}/settings'.sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'option'] = opts[:'option'] if !opts[:'option'].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 = @api_client.object_to_http_body(opts[:'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: GroupsApi#update_group_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end