Class: ZoomUs::Rooms

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Rooms

Returns a new instance of Rooms.



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

def api_client
  @api_client
end

Instance Method Details

#add_a_room(opts = {}) ⇒ InlineResponse201

Add a Zoom Room Use this API to [add a Zoom Room](support.zoom.us/hc/en-us/articles/202822279-Add-Zoom-Rooms-on-Web-Portal) to a Zoom account.
Prerequisites:
* Pro or a higher plan with [Zoom Room](zoom.us/zoomrooms) license.
Scopes: ‘room:write:admin`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body2)

Returns:

  • (InlineResponse201) 


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

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

#add_a_room_with_http_info(opts = {}) ⇒ Array<(InlineResponse201, Fixnum, Hash)>

Add a Zoom Room Use this API to [add a Zoom Room](support.zoom.us/hc/en-us/articles/202822279-Add-Zoom-Rooms-on-Web-Portal) to a Zoom account.&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Pro or a higher plan with [Zoom Room](zoom.us/zoomrooms) license.&lt;br&gt; Scopes: &#x60;room:write:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body2)

Returns:

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

    InlineResponse201 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
 
# File 'lib/zoom_us/rooms.rb', line 37

def add_a_room_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoomsApi.add_a_room ...'
  end
  # resource path
  local_var_path = '/rooms'

  # 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(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse201')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoomsApi#add_a_room\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#change_zr_location(room_id, opts = {}) ⇒ Object

Change a Zoom Room’s Location An account owner of a Zoom account can establish a [Zoom Rooms Location Hierarchy](support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to better organize Zoom Rooms spread accress various location. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. Use this API to assign a new location for a Zoom Room. Note that the Zoom Room can be assigned only to the lowest level location available in the hierarchy. Prerequisite:
* Account owner or admin permission * Zoom Rooms version 4.0 or higher
Scopes: ‘room:write:admin`

Parameters:

  • room_id —

    Unique Identifier of the Zoom Room.

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

    the optional parameters

Options Hash (opts):

  • :body (Body64)

Returns:

  • (Object) 


78
79
80
81
 
# File 'lib/zoom_us/rooms.rb', line 78

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

#change_zr_location_with_http_info(room_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Change a Zoom Room&#39;s Location An account owner of a Zoom account can establish a [Zoom Rooms Location Hierarchy](support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to better organize Zoom Rooms spread accress various location. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. Use this API to assign a new location for a Zoom Room. Note that the Zoom Room can be assigned only to the lowest level location available in the hierarchy. Prerequisite:&lt;br&gt; * Account owner or admin permission * Zoom Rooms version 4.0 or higher&lt;br&gt; Scopes: &#x60;room:write:admin&#x60;&lt;br&gt;

Parameters:

  • room_id —

    Unique Identifier of the Zoom Room.

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

    the optional parameters

Options Hash (opts):

  • :body (Body64)

Returns:

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

    Object data, response status code and response headers



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

def change_zr_location_with_http_info(room_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoomsApi.change_zr_location ...'
  end
  # verify the required parameter 'room_id' is set
  if @api_client.config.client_side_validation && room_id.nil?
    fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.change_zr_location"
  end
  # resource path
  local_var_path = '/rooms/{roomId}/location'.sub('{' + 'roomId' + '}', room_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(:PUT, 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: RoomsApi#change_zr_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_a_zoom_room(room_id, opts = {}) ⇒ Object

Delete a Zoom Room [Remove](support.zoom.us/hc/en-us/articles/360033432032-Zoom-Room-Device-Profiles#h_e55b2092-c418-4b02-819f-44de51448900) a specific Zoom Room profile from a Zoom account.
Prerequisites:
* Pro or a higher plan with [Zoom Room](zoom.us/zoomrooms) license.
Scopes: ‘room:write:admin`

Parameters:

  • room_id —

    Unique Identifier of a Zoom Room.

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

    the optional parameters

Returns:

  • (Object) 


133
134
135
136
 
# File 'lib/zoom_us/rooms.rb', line 133

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

#delete_a_zoom_room_with_http_info(room_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Delete a Zoom Room [Remove](support.zoom.us/hc/en-us/articles/360033432032-Zoom-Room-Device-Profiles#h_e55b2092-c418-4b02-819f-44de51448900) a specific Zoom Room profile from a Zoom account.&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Pro or a higher plan with [Zoom Room](zoom.us/zoomrooms) license.&lt;br&gt; Scopes: &#x60;room:write:admin&#x60;&lt;br&gt;

Parameters:

  • room_id —

    Unique Identifier of a Zoom Room.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



143
144
145
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
 
# File 'lib/zoom_us/rooms.rb', line 143

def delete_a_zoom_room_with_http_info(room_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoomsApi.delete_a_zoom_room ...'
  end
  # verify the required parameter 'room_id' is set
  if @api_client.config.client_side_validation && room_id.nil?
    fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.delete_a_zoom_room"
  end
  # resource path
  local_var_path = '/rooms/{roomId}'.sub('{' + 'roomId' + '}', room_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,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoomsApi#delete_a_zoom_room\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zr_profile(room_id, opts = {}) ⇒ InlineResponse20080

Get Zoom Room Profile

Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to get detailed information on a specific Zoom Room in a Zoom account.  **Prerequisites:**<br> * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.<br> **Scopes**: `room:read:admin`<br>

Parameters:

Returns:

  • (InlineResponse20080) 


187
188
189
190
 
# File 'lib/zoom_us/rooms.rb', line 187

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

#get_zr_profile_with_http_info(room_id, opts = {}) ⇒ Array<(InlineResponse20080, Fixnum, Hash)>

Get Zoom Room Profile

Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to get detailed information on a specific Zoom Room in a Zoom account.  **Prerequisites:**&lt;br&gt; * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.&lt;br&gt; **Scopes**: &#x60;room:read:admin&#x60;&lt;br&gt;

Parameters:

Returns:

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

    InlineResponse20080 data, response status code and response headers



197
198
199
200
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.rb', line 197

def get_zr_profile_with_http_info(room_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoomsApi.get_zr_profile ...'
  end
  # verify the required parameter 'room_id' is set
  if @api_client.config.client_side_validation && room_id.nil?
    fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.get_zr_profile"
  end
  # resource path
  local_var_path = '/rooms/{roomId}'.sub('{' + 'roomId' + '}', room_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 => 'InlineResponse20080')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoomsApi#get_zr_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zr_settings(setting_type, room_id, opts = {}) ⇒ Object

Get Zoom Room Settings Get information on meeting or alert settings applied to a specific Zoom Room. By default, only **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.

  • room_id —

    Unique identifier of the Zoom Room.

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

    the optional parameters

Returns:

  • (Object) 


242
243
244
245
 
# File 'lib/zoom_us/rooms.rb', line 242

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

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

Get Zoom Room Settings Get information on meeting or alert settings applied to a specific Zoom Room. By default, only **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; 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;

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.

  • room_id —

    Unique identifier of the Zoom Room.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



253
254
255
256
257
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
296
 
# File 'lib/zoom_us/rooms.rb', line 253

def get_zr_settings_with_http_info(setting_type, room_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoomsApi.get_zr_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 RoomsApi.get_zr_settings"
  end
  # verify the required parameter 'room_id' is set
  if @api_client.config.client_side_validation && room_id.nil?
    fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.get_zr_settings"
  end
  # resource path
  local_var_path = '/rooms/{roomId}/settings'.sub('{' + 'roomId' + '}', room_id.to_s)

  # 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: RoomsApi#get_zr_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_zoom_rooms(opts = {}) ⇒ InlineResponse2002

List Zoom Rooms Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to list all the existing [Zoom Rooms](support.zoom.us/hc/en-us/articles/207483343-Getting-Started-with-Zoom-Rooms) in a Zoom account.
Prerequisites:
* Pro or a higher plan with [Zoom Room](zoom.us/zoomrooms) license.
Scopes: ‘room:read:admin`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    The status of the Zoom Room.

  • :type (String) —

    Type of the Zoom Rooms.

  • :unassigned_rooms (BOOLEAN) —

    Use this query parameter with a value of &#x60;true&#x60; if you would like to see Zoom Rooms in your account that have not been assigned to anyone yet. (default to false)

  • :page_size (Integer) —

    The number of records returned within a single API call. (default to 30)

  • :next_page_token (String) —

    The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

  • :location_id (String) —

    Parent location ID of the Zoom Room.

Returns:

  • (InlineResponse2002) 


307
308
309
310
 
# File 'lib/zoom_us/rooms.rb', line 307

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

#list_zoom_rooms_with_http_info(opts = {}) ⇒ Array<(InlineResponse2002, Fixnum, Hash)>

List Zoom Rooms Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to list all the existing [Zoom Rooms](support.zoom.us/hc/en-us/articles/207483343-Getting-Started-with-Zoom-Rooms) in a Zoom account.&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Pro or a higher plan with [Zoom Room](zoom.us/zoomrooms) license.&lt;br&gt; Scopes: &#x60;room:read:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    The status of the Zoom Room.

  • :type (String) —

    Type of the Zoom Rooms.

  • :unassigned_rooms (BOOLEAN) —

    Use this query parameter with a value of &#x60;true&#x60; if you would like to see Zoom Rooms in your account that have not been assigned to anyone yet.

  • :page_size (Integer) —

    The number of records returned within a single API call.

  • :next_page_token (String) —

    The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

  • :location_id (String) —

    Parent location ID of the Zoom Room.

Returns:

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

    InlineResponse2002 data, response status code and response headers



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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/zoom_us/rooms.rb', line 322

def list_zoom_rooms_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoomsApi.list_zoom_rooms ...'
  end
  if @api_client.config.client_side_validation && opts[:'status'] && !['Offline', 'Available', 'InMeeting', 'UnderConstruction'].include?(opts[:'status'])
    fail ArgumentError, 'invalid value for "status", must be one of Offline, Available, InMeeting, UnderConstruction'
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['ZoomRoom', 'SchedulingDisplayOnly', 'DigitalSignageOnly'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of ZoomRoom, SchedulingDisplayOnly, DigitalSignageOnly'
  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 RoomsApi.list_zoom_rooms, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/rooms'

  # query parameters
  query_params = {}
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'unassigned_rooms'] = opts[:'unassigned_rooms'] if !opts[:'unassigned_rooms'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page_token'] = opts[:'next_page_token'] if !opts[:'next_page_token'].nil?
  query_params[:'location_id'] = opts[:'location_id'] if !opts[:'location_id'].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 => 'InlineResponse2002')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoomsApi#list_zoom_rooms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_zr_devices(room_id, opts = {}) ⇒ InlineResponse20081

List Zoom Room Devices List information about the devices that are being used for a specific [Zoom Room](support.zoom.us/hc/en-us/articles/207483343-Getting-Started-with-Zoom-Rooms) in an account. Prerequisites:
* Pro or a higher plan with [Zoom Room](zoom.us/zoomrooms) license.
* Account owner or admin permissions. Scopes: ‘room:read:admin`

Parameters:

Returns:

  • (InlineResponse20081) 


378
379
380
381
 
# File 'lib/zoom_us/rooms.rb', line 378

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

#list_zr_devices_with_http_info(room_id, opts = {}) ⇒ Array<(InlineResponse20081, Fixnum, Hash)>

List Zoom Room Devices List information about the devices that are being used for a specific [Zoom Room](support.zoom.us/hc/en-us/articles/207483343-Getting-Started-with-Zoom-Rooms) in an account. Prerequisites:&lt;br&gt; * Pro or a higher plan with [Zoom Room](zoom.us/zoomrooms) license.&lt;br&gt; * Account owner or admin permissions. Scopes: &#x60;room:read:admin&#x60;&lt;br&gt;

Parameters:

Returns:

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

    InlineResponse20081 data, response status code and response headers



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
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/zoom_us/rooms.rb', line 388

def list_zr_devices_with_http_info(room_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoomsApi.list_zr_devices ...'
  end
  # verify the required parameter 'room_id' is set
  if @api_client.config.client_side_validation && room_id.nil?
    fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.list_zr_devices"
  end
  # resource path
  local_var_path = '/rooms/{roomId}/devices'.sub('{' + 'roomId' + '}', room_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 => 'InlineResponse20081')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoomsApi#list_zr_devices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_room_profile(room_id, opts = {}) ⇒ Object

Update a Zoom Room Profile Update basic information on a specific Zoom Room in a Zoom account.
Prerequisites:
* Pro or a higher plan with [Zoom Room](zoom.us/zoomrooms) license.
Scopes: ‘room:write:admin`

Parameters:

  • room_id —

    Unique Identifier of a Zoom Room.

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

    the optional parameters

Options Hash (opts):

  • :body (Body59)

Returns:

  • (Object) 


433
434
435
436
 
# File 'lib/zoom_us/rooms.rb', line 433

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

#update_room_profile_with_http_info(room_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Update a Zoom Room Profile Update basic information on a specific Zoom Room in a Zoom account.&lt;br&gt; Prerequisites:&lt;br&gt; * Pro or a higher plan with [Zoom Room](zoom.us/zoomrooms) license.&lt;br&gt; Scopes: &#x60;room:write:admin&#x60;&lt;br&gt;

Parameters:

  • room_id —

    Unique Identifier of a Zoom Room.

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

    the optional parameters

Options Hash (opts):

  • :body (Body59)

Returns:

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

    Object data, response status code and response headers



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
475
476
477
478
479
480
481
482
 
# File 'lib/zoom_us/rooms.rb', line 444

def update_room_profile_with_http_info(room_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoomsApi.update_room_profile ...'
  end
  # verify the required parameter 'room_id' is set
  if @api_client.config.client_side_validation && room_id.nil?
    fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.update_room_profile"
  end
  # resource path
  local_var_path = '/rooms/{roomId}'.sub('{' + 'roomId' + '}', room_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: RoomsApi#update_room_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_zr_settings(room_id, opts = {}) ⇒ Object

Update Zoom Room Settings Update either meeting or alert settings applied to a specific Zoom Room. To update **Alert Settings**, specify ‘alert` as the value of the `setting_type` query parameter. To update **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:

  • room_id —

    Unique Identifier of the Zoom Room.

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

    the optional parameters

Options Hash (opts):

  • :body (Object)
  • :setting_type (String) —

    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.

Returns:

  • (Object) 


490
491
492
493
 
# File 'lib/zoom_us/rooms.rb', line 490

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

#update_zr_settings_with_http_info(room_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Update Zoom Room Settings Update either meeting or alert settings applied to a specific Zoom Room. To update **Alert Settings**, specify &#x60;alert&#x60; as the value of the &#x60;setting_type&#x60; query parameter. To update **Meeting Settings**, specify &#x60;meeting&#x60; as the value of the &#x60;setting_type&#x60; query parameter.&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:

  • room_id —

    Unique Identifier of the Zoom Room.

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

    the optional parameters

Options Hash (opts):

  • :body (Object)
  • :setting_type (String) —

    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.

Returns:

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

    Object data, response status code and response headers



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
534
535
536
537
538
539
540
541
 
# File 'lib/zoom_us/rooms.rb', line 502

def update_zr_settings_with_http_info(room_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoomsApi.update_zr_settings ...'
  end
  # verify the required parameter 'room_id' is set
  if @api_client.config.client_side_validation && room_id.nil?
    fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomsApi.update_zr_settings"
  end
  # resource path
  local_var_path = '/rooms/{roomId}/settings'.sub('{' + 'roomId' + '}', room_id.to_s)

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