Class: ZoomUs::RoomsLocation

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RoomsLocation

Returns a new instance of RoomsLocation.



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

def api_client
  @api_client
end

Instance Method Details

#add_azr_location(opts = {}) ⇒ InlineResponse20077

Add a Location Add a location to the [location hierarchial structure(s)](support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) of Zoom Rooms in an account. Prerequisites: * Account owner or admin permissions. * Zoom Rooms Version 4.0 or higher
Scopes: ‘room:write:admin`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body56)

Returns:

  • (InlineResponse20077) 


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

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

#add_azr_location_with_http_info(opts = {}) ⇒ Array<(InlineResponse20077, Fixnum, Hash)>

Add a Location Add a location to the [location hierarchial structure(s)](support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) of Zoom Rooms in an account. Prerequisites: * Account owner or admin permissions. * Zoom Rooms Version 4.0 or higher&lt;br&gt;&lt;br&gt; Scopes: &#x60;room:write:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body56)

Returns:

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

    InlineResponse20077 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_location.rb', line 37

def add_azr_location_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoomsLocationApi.add_azr_location ...'
  end
  # resource path
  local_var_path = '/rooms/locations'

  # 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 => 'InlineResponse20077')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoomsLocationApi#add_azr_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#change_parent_location(location_id, opts = {}) ⇒ Object

Change the Assigned Parent 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 accross various location. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. The location in the lower level in the hierarchy is considered as a child of the location that is a level above in the hierarchy. Use this API to change the parent location of a child location.
For instance, if the location hierarchy is structured in a way where there are two campuses (Campus 1, and Campus 2) in a City and Campus 1 consists of a building named Building 1 with a floor where Zoom Rooms are located, and you would like to rearrange the structure so that Building 1 along with its child locations (floor and Zoom Rooms) are relocated directly under Campus 2 instead of Campus 1, you must provide the location ID of Building 1 in the path parameter of this request and the location ID of Campus 2 as the value of ‘parent_location_id` in the request body.
Prerequisite:
* Account owner or admin permission * Zoom Rooms version 4.0 or higher
Scopes: `room:write:admin`
/n

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body65)

Returns:

  • (Object) 


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

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

#change_parent_location_with_http_info(location_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Change the Assigned Parent 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 accross various location. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. The location in the lower level in the hierarchy is considered as a child of the location that is a level above in the hierarchy. Use this API to change the parent location of a child location. &lt;br&gt;&lt;br&gt; For instance, if the location hierarchy is structured in a way where there are two campuses (Campus 1, and Campus 2) in a City and Campus 1 consists of a building named Building 1 with a floor where Zoom Rooms are located, and you would like to rearrange the structure so that Building 1 along with its child locations (floor and Zoom Rooms) are relocated directly under Campus 2 instead of Campus 1, you must provide the location ID of Building 1 in the path parameter of this request and the location ID of Campus 2 as the value of &#x60;parent_location_id&#x60; in the request body.&lt;br&gt;&lt;br&gt; 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;&lt;br&gt; /n

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body65)

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_location.rb', line 89

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

#get_zr_location_profile(location_id, opts = {}) ⇒ InlineResponse20078

Get Zoom Room Location Profile Each location type of the [Zoom Rooms location hierarchy](support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) has a profile page that includes information such as name of the location, address, support email, etc. Use this API to retrieve information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located. Prerequisite:
* Account owner or admin permission * Zoom Rooms version 4.0 or higher
Scopes: ‘room:read:admin`

Parameters:

Returns:

  • (InlineResponse20078) 


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

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

#get_zr_location_profile_with_http_info(location_id, opts = {}) ⇒ Array<(InlineResponse20078, Fixnum, Hash)>

Get Zoom Room Location Profile Each location type of the [Zoom Rooms location hierarchy](support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) has a profile page that includes information such as name of the location, address, support email, etc. Use this API to retrieve information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located. Prerequisite:&lt;br&gt; * Account owner or admin permission * Zoom Rooms version 4.0 or higher&lt;br&gt; Scopes: &#x60;room:read:admin&#x60;&lt;br&gt;

Parameters:

Returns:

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

    InlineResponse20078 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_location.rb', line 143

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

#get_zr_location_settings(setting_type, location_id, opts = {}) ⇒ Object

Get Location Settings Get information on meeting or alert settings applied to Zoom Rooms located in a specific location. 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.

  • location_id —

    Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).

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

    the optional parameters

Returns:

  • (Object) 


188
189
190
191
 
# File 'lib/zoom_us/rooms_location.rb', line 188

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

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

Get Location Settings Get information on meeting or alert settings applied to Zoom Rooms located in a specific location. 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;&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.

  • location_id —

    Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
236
237
238
239
240
241
242
 
# File 'lib/zoom_us/rooms_location.rb', line 199

def get_zr_location_settings_with_http_info(setting_type, location_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoomsLocationApi.get_zr_location_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 RoomsLocationApi.get_zr_location_settings"
  end
  # verify the required parameter 'location_id' is set
  if @api_client.config.client_side_validation && location_id.nil?
    fail ArgumentError, "Missing the required parameter 'location_id' when calling RoomsLocationApi.get_zr_location_settings"
  end
  # resource path
  local_var_path = '/rooms/locations/{locationId}/settings'.sub('{' + 'locationId' + '}', location_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: RoomsLocationApi#get_zr_location_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zr_location_structure(opts = {}) ⇒ InlineResponse20079

Get Zoom Room Location Structure Get the [location hierarchial structure(s)](support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) applied on the Zoom Rooms in an account.
Prerequisites:
* Zoom Rooms version 4.0 or higher * Account owner or admin permissions
Scopes: ‘room:read:admin`

Parameters:

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

    the optional parameters

Returns:

  • (InlineResponse20079) 


247
248
249
250
 
# File 'lib/zoom_us/rooms_location.rb', line 247

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

#get_zr_location_structure_with_http_info(opts = {}) ⇒ Array<(InlineResponse20079, Fixnum, Hash)>

Get Zoom Room Location Structure Get the [location hierarchial structure(s)](support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) applied on the Zoom Rooms in an account.&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Zoom Rooms version 4.0 or higher * Account owner or admin permissions&lt;br&gt; Scopes: &#x60;room:read:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20079 data, response status code and response headers



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

def get_zr_location_structure_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoomsLocationApi.get_zr_location_structure ...'
  end
  # resource path
  local_var_path = '/rooms/locations/structure'

  # 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 => 'InlineResponse20079')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoomsLocationApi#get_zr_location_structure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_zr_locations(opts = {}) ⇒ InlineResponse20076

List Zoom Room Locations A Zoom account owner or a Zoom Room administrator can establish a [location hierarchy](support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to help manage Zoom Rooms that are spread among a variety of locations. Use this API to list the different location types used for Zoom Rooms in an account.
Prerequisites: * Account owner or admin permissions. * Zoom Rooms Version 4.0 or higher
Scopes: ‘room:read:admin`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :parent_location_id (String) —

    A unique identifier for the parent location. For instance, if a Zoom Room is located in Floor 1 of Building A, the location of Building A will be the parent location of Floor 1. Use this parameter to filter the response by a specific location hierarchy level.

  • :type (String) —

    Use this field to filter the response by the type of location. The value can be one of the following: &#x60;country&#x60;, &#x60;states&#x60;, &#x60;city&#x60;, &#x60;campus&#x60;, &#x60;building&#x60;, &#x60;floor&#x60;.

  • :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.

Returns:

  • (InlineResponse20076) 


299
300
301
302
 
# File 'lib/zoom_us/rooms_location.rb', line 299

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

#list_zr_locations_with_http_info(opts = {}) ⇒ Array<(InlineResponse20076, Fixnum, Hash)>

List Zoom Room Locations A Zoom account owner or a Zoom Room administrator can establish a [location hierarchy](support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to help manage Zoom Rooms that are spread among a variety of locations. Use this API to list the different location types used for Zoom Rooms in an account.&lt;br&gt;&lt;br&gt; Prerequisites: * Account owner or admin permissions. * Zoom Rooms Version 4.0 or higher&lt;br&gt;&lt;br&gt; Scopes: &#x60;room:read:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :parent_location_id (String) —

    A unique identifier for the parent location. For instance, if a Zoom Room is located in Floor 1 of Building A, the location of Building A will be the parent location of Floor 1. Use this parameter to filter the response by a specific location hierarchy level.

  • :type (String) —

    Use this field to filter the response by the type of location. The value can be one of the following: &#x60;country&#x60;, &#x60;states&#x60;, &#x60;city&#x60;, &#x60;campus&#x60;, &#x60;building&#x60;, &#x60;floor&#x60;.

  • :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.

Returns:

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

    InlineResponse20076 data, response status code and response headers



312
313
314
315
316
317
318
319
320
321
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
 
# File 'lib/zoom_us/rooms_location.rb', line 312

def list_zr_locations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoomsLocationApi.list_zr_locations ...'
  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 RoomsLocationApi.list_zr_locations, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/rooms/locations'

  # query parameters
  query_params = {}
  query_params[:'parent_location_id'] = opts[:'parent_location_id'] if !opts[:'parent_location_id'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].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?

  # 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 => 'InlineResponse20076')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoomsLocationApi#list_zr_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_zoom_rooms_location_structure(opts = {}) ⇒ Object

Update Zoom Rooms Location Structure Update the [location hierarchial structure(s)](support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) applied on the Zoom Rooms in an account.
Prerequisites:
* Zoom Rooms version 4.0 or higher * Account owner or admin permissions
Scopes: ‘room:write:admin`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body58)

Returns:

  • (Object) 


360
361
362
363
 
# File 'lib/zoom_us/rooms_location.rb', line 360

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

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

Update Zoom Rooms Location Structure Update the [location hierarchial structure(s)](support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) applied on the Zoom Rooms in an account.&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Zoom Rooms version 4.0 or higher * Account owner or 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 (Body58)

Returns:

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

    Object data, response status code and response headers



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/zoom_us/rooms_location.rb', line 370

def update_zoom_rooms_location_structure_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoomsLocationApi.update_zoom_rooms_location_structure ...'
  end
  # resource path
  local_var_path = '/rooms/locations/structure'

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

#update_zr_location_profile(location_id, opts = {}) ⇒ Object

Update Zoom Room Location Profile Each location type of the [Zoom Rooms location hierarchy](support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) has a profile page that includes information such as name of the location, address, support email, etc. Use this API to update information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located. Prerequisite:
* Account owner or admin permission * Zoom Rooms version 4.0 or higher
Scopes: ‘room:write:admin`

Parameters:

Options Hash (opts):

  • :body (Body57)

Returns:

  • (Object) 


411
412
413
414
 
# File 'lib/zoom_us/rooms_location.rb', line 411

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

#update_zr_location_profile_with_http_info(location_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Update Zoom Room Location Profile Each location type of the [Zoom Rooms location hierarchy](support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) has a profile page that includes information such as name of the location, address, support email, etc. Use this API to update information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located. 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:

Options Hash (opts):

  • :body (Body57)

Returns:

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

    Object data, response status code and response headers



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/zoom_us/rooms_location.rb', line 422

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

#update_zr_location_settings(setting_type, location_id, opts = {}) ⇒ Object

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

  • 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.

  • location_id —

    Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).

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

    the optional parameters

Options Hash (opts):

  • :body (Object)

Returns:

  • (Object) 


468
469
470
471
 
# File 'lib/zoom_us/rooms_location.rb', line 468

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

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

Update Location Settings Update information on either meeting or alert settings applied to Zoom Rooms located in a specific location. To update **Alert Settings**, specify &#x60;alert&#x60; as the value of the &#x60;setting_type&#x60; query parameter. Similarly, to update **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.

  • location_id —

    Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).

  • 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



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/zoom_us/rooms_location.rb', line 480

def update_zr_location_settings_with_http_info(setting_type, location_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoomsLocationApi.update_zr_location_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 RoomsLocationApi.update_zr_location_settings"
  end
  # verify the required parameter 'location_id' is set
  if @api_client.config.client_side_validation && location_id.nil?
    fail ArgumentError, "Missing the required parameter 'location_id' when calling RoomsLocationApi.update_zr_location_settings"
  end
  # resource path
  local_var_path = '/rooms/locations/{locationId}/settings'.sub('{' + 'locationId' + '}', location_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 = @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: RoomsLocationApi#update_zr_location_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end