class ZoomUs::RoomsAccount
Attributes
Public Class Methods
# File lib/zoom_us/rooms_account.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get Zoom Room Account Profile Get details on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms
admin permission. To get information on an individual Room Profile, use [Get Zoom Room Profile API](marketplace.zoom.us/docs/api-reference/zoom-api/rooms/getzrprofile) instead. Prerequisites:
* Zoom account owner or Zoom Rooms
admin permissions
Scopes: `room:read:admin`
@param [Hash] opts the optional parameters @return [InlineResponse20075]
# File lib/zoom_us/rooms_account.rb, line 26 def get_zr_account_profile(opts = {}) data, _status_code, _headers = get_zr_account_profile_with_http_info(opts) data end
Get Zoom Room Account Profile Get details on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms
admin permission. To get information on an individual Room Profile, use [Get Zoom Room Profile API](marketplace.zoom.us/docs/api-reference/zoom-api/rooms/getzrprofile) instead. Prerequisites:<br> * Zoom account owner or Zoom Rooms
admin permissions<br> Scopes: `room:read:admin`<br> @param [Hash] opts the optional parameters @return [Array<(InlineResponse20075, Fixnum, Hash)>] InlineResponse20075 data, response status code and response headers
# File lib/zoom_us/rooms_account.rb, line 35 def get_zr_account_profile_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RoomsAccountApi.get_zr_account_profile ...' end # resource path local_var_path = '/rooms/account_profile' # 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 => 'InlineResponse20075') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoomsAccountApi#get_zr_account_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Zoom Room Account Settings Get details on Account Settings of a Zoom Room. With this API, you can view either the **Account Meeting Settings** or the **Alert Settings** (Client Alert Settings and Notfication Settings) of the Zoom Rooms
account. By default, only **Account Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.
Prerequisites:
* Zoom Room licenses * Owner or Admin privileges on the Zoom Account.
Scopes: `room:read:admin`
@param setting_type The type of setting that you would like to retrieve.<br> `alert`: Alert Settings applied on the Zoom Rooms
Account.<br> `meeting`: Meeting settings of the Zoom Rooms
Account. @param [Hash] opts the optional parameters @return [Object]
# File lib/zoom_us/rooms_account.rb, line 75 def get_zr_account_settings(setting_type, opts = {}) data, _status_code, _headers = get_zr_account_settings_with_http_info(setting_type, opts) data end
Get Zoom Room Account Settings Get details on Account Settings of a Zoom Room. With this API, you can view either the **Account Meeting Settings** or the **Alert Settings** (Client Alert Settings and Notfication Settings) of the Zoom Rooms
account. By default, only **Account Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.<br><br> Prerequisites:<br> * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.<br> Scopes: `room:read:admin`<br><br> @param setting_type The type of setting that you would like to retrieve.<br> `alert`: Alert Settings applied on the Zoom Rooms
Account.<br> `meeting`: Meeting settings of the Zoom Rooms
Account. @param [Hash] opts the optional parameters @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
# File lib/zoom_us/rooms_account.rb, line 85 def get_zr_account_settings_with_http_info(setting_type, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RoomsAccountApi.get_zr_account_settings ...' end # verify the required parameter 'setting_type' is set if @api_client.config.client_side_validation && setting_type.nil? fail ArgumentError, "Missing the required parameter 'setting_type' when calling RoomsAccountApi.get_zr_account_settings" end # verify enum value if @api_client.config.client_side_validation && !['meeting', 'alert'].include?(setting_type) fail ArgumentError, "invalid value for 'setting_type', must be one of meeting, alert" end # resource path local_var_path = '/rooms/account_settings' # query parameters query_params = {} query_params[:'setting_type'] = setting_type # 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: RoomsAccountApi#get_zr_account_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update Zoom Room Account Settings Update account settings applied for Zoom Rooms
in a Zoom account. With this API, you can update either the **Account Meeting Settings** or the **Alert Settings** (Client Alert Settings and Notfication Settings) of the Zoom Rooms
account by specifying the required setting type in the `setting_type` parameter. To update only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter and to update only **Account Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter.
Prerequisites:
* Zoom Room licenses * Owner or Admin privileges on the Zoom Account.
Scopes: `room:write:admin`
@param setting_type The type of setting that you would like to update.<br> `alert`: Alert Settings applied on the Zoom Rooms
Account.<br> `meeting`: Meeting settings of the Zoom Rooms
Account. @param [Hash] opts the optional parameters @option opts [Object] :body @return [Object]
# File lib/zoom_us/rooms_account.rb, line 135 def update_zoom_room_acc_settings(setting_type, opts = {}) data, _status_code, _headers = update_zoom_room_acc_settings_with_http_info(setting_type, opts) data end
Update Zoom Room Account Settings Update account settings applied for Zoom Rooms
in a Zoom account. With this API, you can update either the **Account Meeting Settings** or the **Alert Settings** (Client Alert Settings and Notfication Settings) of the Zoom Rooms
account by specifying the required setting type in the `setting_type` parameter. To update only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter and to update only **Account Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter.<br><br> Prerequisites:<br> * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.<br> Scopes: `room:write:admin`<br> @param setting_type The type of setting that you would like to update.<br> `alert`: Alert Settings applied on the Zoom Rooms
Account.<br> `meeting`: Meeting settings of the Zoom Rooms
Account. @param [Hash] opts the optional parameters @option opts [Object] :body @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
# File lib/zoom_us/rooms_account.rb, line 146 def update_zoom_room_acc_settings_with_http_info(setting_type, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RoomsAccountApi.update_zoom_room_acc_settings ...' end # verify the required parameter 'setting_type' is set if @api_client.config.client_side_validation && setting_type.nil? fail ArgumentError, "Missing the required parameter 'setting_type' when calling RoomsAccountApi.update_zoom_room_acc_settings" end # resource path local_var_path = '/rooms/account_settings' # query parameters query_params = {} query_params[:'setting_type'] = setting_type # 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: RoomsAccountApi#update_zoom_room_acc_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update Zoom Room Account Profile Update information on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms
admin permission. To update information on an individual Room Profile, use [Update Zoom Room Profile API](marketplace.zoom.us/docs/api-reference/zoom-api/rooms/updatezrprofile) instead. Prerequisites:
* Zoom account owner or Zoom Rooms
admin permissions
Scopes: `room:write:admin`
@param [Hash] opts the optional parameters @option opts [Body55] :body @return [Object]
# File lib/zoom_us/rooms_account.rb, line 191 def update_zr_acc_profile(opts = {}) data, _status_code, _headers = update_zr_acc_profile_with_http_info(opts) data end
Update Zoom Room Account Profile Update information on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms
admin permission. To update information on an individual Room Profile, use [Update Zoom Room Profile API](marketplace.zoom.us/docs/api-reference/zoom-api/rooms/updatezrprofile) instead. Prerequisites:<br> * Zoom account owner or Zoom Rooms
admin permissions<br> Scopes: `room:write:admin`<br> @param [Hash] opts the optional parameters @option opts [Body55] :body @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
# File lib/zoom_us/rooms_account.rb, line 201 def update_zr_acc_profile_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RoomsAccountApi.update_zr_acc_profile ...' end # resource path local_var_path = '/rooms/account_profile' # 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: RoomsAccountApi#update_zr_acc_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end