Class: ZoomUs::RoomsAccount

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RoomsAccount

Returns a new instance of RoomsAccount.



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

def api_client
  @api_client
end

Instance Method Details

#get_zr_account_profile(opts = {}) ⇒ InlineResponse20075

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`

Parameters:

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

    the optional parameters

Returns:

  • (InlineResponse20075) 


26
27
28
29
 
# File 'lib/zoom_us/rooms_account.rb', line 26

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

#get_zr_account_profile_with_http_info(opts = {}) ⇒ Array<(InlineResponse20075, Fixnum, Hash)>

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:&lt;br&gt; * Zoom account owner or Zoom Rooms admin permissions&lt;br&gt; Scopes: &#x60;room:read:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20075 data, response status code and response headers



35
36
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
 
# File 'lib/zoom_us/rooms_account.rb', line 35

def (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_zr_account_settings(setting_type, opts = {}) ⇒ Object

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`

Parameters:

  • setting_type —

    The type of setting that you would like to retrieve.&lt;br&gt; &#x60;alert&#x60;: Alert Settings applied on the Zoom Rooms Account.&lt;br&gt; &#x60;meeting&#x60;: Meeting settings of the Zoom Rooms Account.

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

    the optional parameters

Returns:

  • (Object) 


75
76
77
78
 
# File 'lib/zoom_us/rooms_account.rb', line 75

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

#get_zr_account_settings_with_http_info(setting_type, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

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 &#x60;alert&#x60; as the value of the &#x60;setting_type&#x60; query parameter.&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.&lt;br&gt; Scopes: &#x60;room:read:admin&#x60;&lt;br&gt;&lt;br&gt;

Parameters:

  • setting_type —

    The type of setting that you would like to retrieve.&lt;br&gt; &#x60;alert&#x60;: Alert Settings applied on the Zoom Rooms Account.&lt;br&gt; &#x60;meeting&#x60;: Meeting settings of the Zoom Rooms Account.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/zoom_us/rooms_account.rb', line 85

def (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_acc_settings(setting_type, opts = {}) ⇒ Object

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`

Parameters:

  • setting_type —

    The type of setting that you would like to update.&lt;br&gt; &#x60;alert&#x60;: Alert Settings applied on the Zoom Rooms Account.&lt;br&gt; &#x60;meeting&#x60;: Meeting settings of the Zoom Rooms Account.

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

    the optional parameters

Options Hash (opts):

  • :body (Object)

Returns:

  • (Object) 


135
136
137
138
 
# 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_acc_settings_with_http_info(setting_type, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

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 &#x60;setting_type&#x60; parameter. To update only **Alert Settings**, specify &#x60;alert&#x60; as the value of the &#x60;setting_type&#x60; query parameter and to update only **Account Meeting Settings**, specify &#x60;meeting&#x60; as the value of the &#x60;setting_type&#x60; query parameter.&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.&lt;br&gt; Scopes: &#x60;room:write:admin&#x60;&lt;br&gt;

Parameters:

  • setting_type —

    The type of setting that you would like to update.&lt;br&gt; &#x60;alert&#x60;: Alert Settings applied on the Zoom Rooms Account.&lt;br&gt; &#x60;meeting&#x60;: Meeting settings of the Zoom Rooms Account.

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

    the optional parameters

Options Hash (opts):

  • :body (Object)

Returns:

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

    Object data, response status code and response headers



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# 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_zr_acc_profile(opts = {}) ⇒ Object

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`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body55)

Returns:

  • (Object) 


191
192
193
194
 
# 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_zr_acc_profile_with_http_info(opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

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:&lt;br&gt; * Zoom account owner or Zoom Rooms admin permissions&lt;br&gt; Scopes: &#x60;room:write:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body55)

Returns:

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

    Object data, response status code and response headers



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# 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