class ZoomUs::Groups

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/zoom_us/groups.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_group_lock_settings(group_id, opts = {}) click to toggle source

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`
@param group_id Id of the group. @param [Hash] opts the optional parameters @return [InlineResponse20069]

# 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 = {}) click to toggle source

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; @param group_id Id of the group. @param [Hash] opts the optional parameters @return [Array<(InlineResponse20069, Fixnum, Hash)>] InlineResponse20069 data, response status code and response headers

# 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 = {}) click to toggle source

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`
@param group_id @param [Hash] opts the optional parameters @option opts [String] :option &#x60;meeting_authentication&#x60;: Use this query parameter to view [meeting authentication configuration](support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied on the account.&lt;br&gt;&#x60;recording_authentication&#x60;: Use this query parameter to view [recording authentication configuration](support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied on the account. @return [Object]

# 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 = {}) click to toggle source

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; @param group_id @param [Hash] opts the optional parameters @option opts [String] :option &#x60;meeting_authentication&#x60;: Use this query parameter to view [meeting authentication configuration](support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied on the account.&lt;br&gt;&#x60;recording_authentication&#x60;: Use this query parameter to view [recording authentication configuration](support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied on the account. @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers

# 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 = {}) click to toggle source

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`
@param group_id The group ID.&lt;br&gt; Can be retrieved by calling [GET /groups](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). @param [Hash] opts the optional parameters @return [InlineResponse20017]

# 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 = {}) click to toggle source

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`
@param body @param [Hash] opts the optional parameters @return [nil]

# 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 = {}) click to toggle source

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; @param body @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# 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 = {}) click to toggle source

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`
@param group_id The group ID.&lt;br&gt; Can be retrieved by calling [GET /groups](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). @param [Hash] opts the optional parameters @return [nil]

# 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 = {}) click to toggle source

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; @param group_id The group ID.&lt;br&gt; Can be retrieved by calling [GET /groups](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# 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 = {}) click to toggle source

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`
@param group_id The Id of the group. @param [Hash] opts the optional parameters @option opts [Body50] :body @return [Object]

# 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 = {}) click to toggle source

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; @param group_id The Id of the group. @param [Hash] opts the optional parameters @option opts [Body50] :body @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers

# 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 = {}) click to toggle source

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`
@param group_id The group ID.&lt;br&gt; Can be retrieved by calling [GET /groups](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). @param [Hash] opts the optional parameters @option opts [Integer] :page_size The number of records returned within a single API call. (default to 30) @option opts [Integer] :page_number The current page number of returned records. (default to 1) @return [InlineResponse20018]

# 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 = {}) click to toggle source

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`
@param group_id The group ID.&lt;br&gt; Can be retrieved by calling [GET /groups](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). @param body @param [Hash] opts the optional parameters @return [nil]

# 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 = {}) click to toggle source

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; @param group_id The group ID.&lt;br&gt; Can be retrieved by calling [GET /groups](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). @param body @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# 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 = {}) click to toggle source

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`
@param group_id The group ID.&lt;br&gt; Can be retrieved by calling [GET /groups](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). @param member_id The member ID. @param [Hash] opts the optional parameters @return [nil]

# 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 = {}) click to toggle source

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; @param group_id The group ID.&lt;br&gt; Can be retrieved by calling [GET /groups](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). @param member_id The member ID. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# 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 = {}) click to toggle source

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; @param group_id The group ID.&lt;br&gt; Can be retrieved by calling [GET /groups](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). @param [Hash] opts the optional parameters @option opts [Integer] :page_size The number of records returned within a single API call. @option opts [Integer] :page_number The current page number of returned records. @return [Array<(InlineResponse20018, Fixnum, Hash)>] InlineResponse20018 data, response status code and response headers

# 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 = {}) click to toggle source

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`
@param group_id The group ID.&lt;br&gt; Can be retrieved by calling [GET /groups](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). @param body @param [Hash] opts the optional parameters @return [nil]

# 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 = {}) click to toggle source

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; @param group_id The group ID.&lt;br&gt; Can be retrieved by calling [GET /groups](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). @param body @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# 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 = {}) click to toggle source

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; @param group_id The group ID.&lt;br&gt; Can be retrieved by calling [GET /groups](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). @param [Hash] opts the optional parameters @return [Array<(InlineResponse20017, Fixnum, Hash)>] InlineResponse20017 data, response status code and response headers

# 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 = {}) click to toggle source

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`
@param [Hash] opts the optional parameters @return [InlineResponse20016]

# 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 = {}) click to toggle source

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; @param [Hash] opts the optional parameters @return [Array<(InlineResponse20016, Fixnum, Hash)>] InlineResponse20016 data, response status code and response headers

# 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 = {}) click to toggle source

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` @param 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. @param 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. @param [Hash] opts the optional parameters @option opts [Body18] :body @return [Object]

# 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 = {}) click to toggle source

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; @param 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. @param 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. @param [Hash] opts the optional parameters @option opts [Body18] :body @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers

# 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_with_http_info(group_id, opts = {}) click to toggle source

Update a Group&#39;s Settings Update settings for a [group](support.zoom.us/hc/en-us/articles/204519819-Group-Management-).<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; @param group_id Id of the group. @param [Hash] opts the optional parameters @option opts [Object] :body @option opts [String] :option @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# 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