class ZoomUs::IMGroups
Attributes
Public Class Methods
# File lib/zoom_us/im_groups.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
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`
@param group_id The group ID.<br> Can be retrieved by calling [GET /groups](marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups). @param [Hash] opts the optional parameters @return [InlineResponse20019]
# 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
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`
@param body @param [Hash] opts the optional parameters @return [nil]
# 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
Create an IM Directory Group Create an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br> Scopes: `imgroup:write:admin`<br> @param body @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# 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
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`
@param group_id The group ID.<br> 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/im_groups.rb, line 134 def im_group_delete(group_id, opts = {}) im_group_delete_with_http_info(group_id, opts) nil end
Delete an IM Directory Group Delete an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br> Scopes: `imgroup:write:admin`<br> @param group_id The group ID.<br> 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/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
List IM Directory Group Members List the members of an [IM directory group](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 [GroupMemberList]
# 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
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`
@param group_id The group ID.<br> 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/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
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.<br><br> Scope: `imgroup:write:admin`<br> @param group_id The group ID.<br> 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/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
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`
@param group_id The group ID.<br> 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/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
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.<br><br> Scopes: `imgroup:write:admin`<br> @param group_id The group ID.<br> 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/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
List IM Directory Group Members List the members of an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management).<br><br> Scope: `imgroup:read:admin`<br> @param group_id The group ID.<br> 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<(GroupMemberList, Fixnum, Hash)>] GroupMemberList data, response status code and response headers
# 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
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`
@param group_id The group ID.<br> 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/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
Update an IM Directory Group Update an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br> Scopes: `imgroup:write:admin`<br> @param group_id The group ID.<br> 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/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
Retrieve an IM Directory Group Retrieve an [IM directory group](support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br> Scopes: `imgroup:read:admin`<br> @param group_id The group ID.<br> 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<(InlineResponse20019, Fixnum, Hash)>] InlineResponse20019 data, response status code and response headers
# 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
List IM Directory Groups
List [IM directory groups](
# 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
List IM Directory Groups
List [IM directory groups](support.zoom.us/hc/en-us/articles/203749815-IM-Management).<br><br> Scopes: `imgroup:read:admin`<br> @param [Hash] opts the optional parameters @return [Array<(IMGroupList, Fixnum, Hash)>] IMGroupList data, response status code and response headers
# 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