Class: ZoomUs::Accounts

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Accounts

Returns a new instance of Accounts.



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

def api_client
  @api_client
end

Instance Method Details

#account(account_id, opts = {}) ⇒ InlineResponse20012

Get a Sub Account Get a Sub Account under the Master Account. <aside>Your account must be a Master Account in order to retrieve Sub Accounts. Zoom only assigns this privilege to trusted partners.</aside>
Prerequisites: * Pro or a higher paid account with Master Account option enabled.
Scope: ‘account:write:admin`

Parameters:

  • account_id —

    The account ID.

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

    the optional parameters

Returns:

  • (InlineResponse20012) 


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

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

#account_create(body, opts = {}) ⇒ InlineResponse2015

Create a Sub Account Create a Sub Account under the Master Account. <aside>Your account must be a Master Account in order to create Sub Accounts. Zoom only assigns this privilege to trusted partners. Please note: the created user will receive a confirmation email.</aside>
Prerequisites:
* Pro or a higher paid account with Master Account option enabled.
Scope: ‘account:write:admin`

Parameters:

  • body —

    Account.

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

    the optional parameters

Returns:

  • (InlineResponse2015) 


81
82
83
84
 
# File 'lib/zoom_us/accounts.rb', line 81

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

#account_create_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse2015, Fixnum, Hash)>

Create a Sub Account Create a Sub Account under the Master Account. &lt;aside&gt;Your account must be a Master Account in order to create Sub Accounts. Zoom only assigns this privilege to trusted partners. Please note: the created user will receive a confirmation email.&lt;/aside&gt;&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Pro or a higher paid account with Master Account option enabled. &lt;br&gt; Scope: &#x60;account:write:admin&#x60;&lt;br&gt;

Parameters:

  • body —

    Account.

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

    the optional parameters

Returns:

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

    InlineResponse2015 data, response status code and response headers



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
129
 
# File 'lib/zoom_us/accounts.rb', line 91

def (body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.account_create ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountsApi.account_create"
  end
  # resource path
  local_var_path = '/accounts'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2015')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#account_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#account_disassociate(account_id, opts = {}) ⇒ nil

Disassociate a Sub Account Disassociate a Sub Account from the Master Account. This will leave the Sub Account intact but it will no longer be associated with the master account.
<aside>Your account must be a Master Account in order to disassociate Sub Accounts. Zoom only assigns this privilege to trusted partners.</aside>
Prerequisites: * Pro or a higher paid account with Master Account option enabled.
Scope: ‘account:write:admin`

Parameters:

  • account_id —

    The account ID.

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

    the optional parameters

Returns:

  • (nil) 


135
136
137
138
 
# File 'lib/zoom_us/accounts.rb', line 135

def (, opts = {})
  (, opts)
  nil
end

#account_disassociate_with_http_info(account_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Disassociate a Sub Account Disassociate a Sub Account from the Master Account. This will leave the Sub Account intact but it will no longer be associated with the master account.&lt;br&gt; &lt;aside&gt;Your account must be a Master Account in order to disassociate Sub Accounts. Zoom only assigns this privilege to trusted partners.&lt;/aside&gt; &lt;br&gt; Prerequisites: * Pro or a higher paid account with Master Account option enabled. &lt;br&gt; Scope: &#x60;account:write:admin&#x60;&lt;br&gt;

Parameters:

  • account_id —

    The account ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
182
 
# File 'lib/zoom_us/accounts.rb', line 145

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.account_disassociate ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.account_disassociate"
  end
  # resource path
  local_var_path = '/accounts/{accountId}'.sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#account_disassociate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#account_managed_domain(account_id, opts = {}) ⇒ InlineResponse20013

Get Managed Domains Get a Sub Account’s [managed domains](support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-).
To get managed domains of the Master Account, provide ‘me` as the value for accountId in the path parameter. Provide the Sub Account’s Account ID as the value of accountId path parameter to get managed domains of the Sub Account. Prerequisites:
* Pro or a higher paid account with Master Account option enabled.
Scope: ‘account:read:admin`

Parameters:

  • account_id —

    The account ID.

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

    the optional parameters

Returns:

  • (InlineResponse20013) 


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

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

#account_managed_domain_with_http_info(account_id, opts = {}) ⇒ Array<(InlineResponse20013, Fixnum, Hash)>

Get Managed Domains Get a Sub Account&#39;s [managed domains](support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-).&lt;br&gt;&lt;br&gt; To get managed domains of the Master Account, provide &#x60;me&#x60; as the value for accountId in the path parameter. Provide the Sub Account&#39;s Account ID as the value of accountId path parameter to get managed domains of the Sub Account. Prerequisites:&lt;br&gt; * Pro or a higher paid account with Master Account option enabled. &lt;br&gt; Scope: &#x60;account:read:admin&#x60;&lt;br&gt;

Parameters:

  • account_id —

    The account ID.

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

    the optional parameters

Returns:

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

    InlineResponse20013 data, response status code and response headers



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
236
 
# File 'lib/zoom_us/accounts.rb', line 198

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

#account_options_update(account_id, body, opts = {}) ⇒ nil

Update Options Update a Sub Account’s options under the Master Account.
<aside>Your account must be a Master Account in order to update the options for Sub Accounts. Zoom only assigns this privilege to trusted partners. </aside> Prerequisites: * Pro or a higher paid account with Master Account option enabled.
Scope: ‘account:write:admin`

Parameters:

  • account_id —

    The account ID.

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

    the optional parameters

Returns:

  • (nil) 


243
244
245
246
 
# File 'lib/zoom_us/accounts.rb', line 243

def (, body, opts = {})
  (, body, opts)
  nil
end

#account_options_update_with_http_info(account_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update Options Update a Sub Account&#39;s options under the Master Account.&lt;br&gt; &lt;aside&gt;Your account must be a Master Account in order to update the options for Sub Accounts. Zoom only assigns this privilege to trusted partners. &lt;/aside&gt; Prerequisites: * Pro or a higher paid account with Master Account option enabled. &lt;br&gt; Scope: &#x60;account:write:admin&#x60;&lt;br&gt;

Parameters:

  • account_id —

    The account ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def (, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.account_options_update ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.account_options_update"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountsApi.account_options_update"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/options'.sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#account_options_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#account_settings(account_id, opts = {}) ⇒ Object

Get Settings Get the settings of a Sub Account under a Master Account.
To get the settings of a Master Account, use ‘me` as the value for the `accountId` path parameter.<p style="background-color:#FEEFB3; color:#9F6000; padding:8px">Note: The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p> Prerequisites: * The Sub Account must be a paid account.
Scopes: `account:read:admin`

Parameters:

  • account_id —

    The account ID.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


302
303
304
305
 
# File 'lib/zoom_us/accounts.rb', line 302

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

#account_settings_update(account_id, body, opts = {}) ⇒ nil

Update Settings Update the settings of a Sub Account that is under a Master Account.
To update the settings of the Master Account, use ‘me` as the value of the `accountId` path parameter.<p style="background-color:#FEEFB3; color:#9F6000">
Note:</b> The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p> Prerequisites: * The Sub Account must be a paid account.
Scopes: `account:write:admin`

Parameters:

  • account_id —

    The account ID.

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

    the optional parameters

Options Hash (opts):

  • :option (String)

Returns:

  • (nil) 


363
364
365
366
 
# File 'lib/zoom_us/accounts.rb', line 363

def (, body, opts = {})
  (, body, opts)
  nil
end

#account_settings_update_with_http_info(account_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update Settings Update the settings of a Sub Account that is under a Master Account.&lt;br&gt; To update the settings of the Master Account, use &#x60;me&#x60; as the value of the &#x60;accountId&#x60; path parameter.&lt;p style&#x3D;&quot;background-color:#FEEFB3; color:#9F6000&quot;&gt;&lt;br&gt;Note:&lt;/b&gt; The &#x60;force_pmi_jbh_password&#x60; field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.&lt;/p&gt; Prerequisites: * The Sub Account must be a paid account.&lt;br&gt; Scopes: &#x60;account:write:admin&#x60; &lt;br&gt;

Parameters:

  • account_id —

    The account ID.

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

    the optional parameters

Options Hash (opts):

  • :option (String)

Returns:

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

    nil, response status code and response headers



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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/zoom_us/accounts.rb', line 375

def (, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.account_settings_update ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.account_settings_update"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountsApi.account_settings_update"
  end
  if @api_client.config.client_side_validation && opts[:'option'] && !['meeting_authentication', 'recording_authentication'].include?(opts[:'option'])
    fail ArgumentError, 'invalid value for "option", must be one of meeting_authentication, recording_authentication'
  end
  # resource path
  local_var_path = '/accounts/{accountId}/settings'.sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'option'] = opts[:'option'] if !opts[:'option'].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(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#account_settings_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get Settings Get the settings of a Sub Account under a Master Account.&lt;br&gt; To get the settings of a Master Account, use &#x60;me&#x60; as the value for the &#x60;accountId&#x60; path parameter.&lt;p style&#x3D;&quot;background-color:#FEEFB3; color:#9F6000; padding:8px&quot;&gt;&lt;b&gt;Note:&lt;/b&gt; The &#x60;force_pmi_jbh_password&#x60; field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.&lt;/p&gt; Prerequisites: * The Sub Account must be a paid account.&lt;br&gt; Scopes: &#x60;account:read:admin&#x60; &lt;br&gt;

Parameters:

  • account_id —

    The account ID.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object data, response status code and response headers



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
355
 
# File 'lib/zoom_us/accounts.rb', line 313

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.account_settings ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.account_settings"
  end
  if @api_client.config.client_side_validation && opts[:'option'] && !['meeting_authentication', 'recording_authentication'].include?(opts[:'option'])
    fail ArgumentError, 'invalid value for "option", must be one of meeting_authentication, recording_authentication'
  end
  # resource path
  local_var_path = '/accounts/{accountId}/settings'.sub('{' + 'accountId' + '}', .to_s)

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

#account_trusted_domain(account_id, opts = {}) ⇒ Object

Get Trusted Domains Get trusted domains of a Sub Account. To get the trusted domains of a Master Account, use ‘me` as the value for the `accountId` path parameter. Prerequisites:
* The Sub Account must be a paid account.
Scope: `account:read:admin`

Parameters:

  • account_id —

    The account ID.

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

    the optional parameters

Returns:

  • (Object) 


426
427
428
429
 
# File 'lib/zoom_us/accounts.rb', line 426

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

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

Get Trusted Domains Get trusted domains of a Sub Account. To get the trusted domains of a Master Account, use &#x60;me&#x60; as the value for the &#x60;accountId&#x60; path parameter. Prerequisites:&lt;br&gt; * The Sub Account must be a paid account.&lt;br&gt; Scope: &#x60;account:read:admin&#x60;&lt;br&gt;

Parameters:

  • account_id —

    The account ID.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/zoom_us/accounts.rb', line 436

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

#account_with_http_info(account_id, opts = {}) ⇒ Array<(InlineResponse20012, Fixnum, Hash)>

Get a Sub Account Get a Sub Account under the Master Account. &lt;aside&gt;Your account must be a Master Account in order to retrieve Sub Accounts. Zoom only assigns this privilege to trusted partners.&lt;/aside&gt;&lt;br&gt;&lt;br&gt; Prerequisites: * Pro or a higher paid account with Master Account option enabled. &lt;br&gt; Scope: &#x60;account:write:admin&#x60;&lt;br&gt;

Parameters:

  • account_id —

    The account ID.

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

    the optional parameters

Returns:

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

    InlineResponse20012 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
72
73
74
75
 
# File 'lib/zoom_us/accounts.rb', line 37

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

#accounts(opts = {}) ⇒ AccountList

List Sub Accounts List all the Sub Accounts under the Master Account.
<aside>Only master accounts can create and have sub accounts. Zoom only assigns this privilege to trusted partners.</aside>
Prerequisites:
* Pro or a higher paid account with Master Account option enabled.
Scope: ‘account:read:admin`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

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

  • :page_number (Integer) —

    The current page number of returned records. (default to 1)

Returns:

  • (AccountList) 


481
482
483
484
 
# File 'lib/zoom_us/accounts.rb', line 481

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

#accounts_with_http_info(opts = {}) ⇒ Array<(AccountList, Fixnum, Hash)>

List Sub Accounts List all the Sub Accounts under the Master Account.&lt;br&gt; &lt;aside&gt;Only master accounts can create and have sub accounts. Zoom only assigns this privilege to trusted partners.&lt;/aside&gt; &lt;br&gt;Prerequisites:&lt;br&gt; * Pro or a higher paid account with Master Account option enabled. &lt;br&gt; Scope: &#x60;account:read:admin&#x60; &lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records returned within a single API call.

  • :page_number (Integer) —

    The current page number of returned records.

Returns:

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

    AccountList data, response status code and response headers



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
524
525
526
527
528
529
530
531
532
 
# File 'lib/zoom_us/accounts.rb', line 492

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

  # resource path
  local_var_path = '/accounts'

  # query parameters
  query_params = {}
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page_number'] = opts[:'page_number'] if !opts[:'page_number'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AccountList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_lock_settings(account_id, opts = {}) ⇒ InlineResponse20070

Get Locked Settings [Account Locked Settings](support.zoom.us/hc/en-us/articles/115005269866) allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to retrieve an account’s locked settings.<p style="background-color:#FEEFB3; color:#9F6000">Note: The force_pmi_jbh_password field under meeting settings was deprecated on September 22, 2019. Use require_password_for_pmi_meetings field as an alternative for the same functionality.</p> Prerequisites: * Pro or a higher paid account with Master Account option enabled.
Scope: ‘account:read:admin`.
Scope: account:read:admin

Parameters:

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

    the optional parameters

Returns:

  • (InlineResponse20070) 


538
539
540
541
 
# File 'lib/zoom_us/accounts.rb', line 538

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

#get_account_lock_settings_with_http_info(account_id, opts = {}) ⇒ Array<(InlineResponse20070, Fixnum, Hash)>

Get Locked Settings [Account Locked Settings](support.zoom.us/hc/en-us/articles/115005269866) allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to retrieve an account&#39;s locked settings.&lt;p style&#x3D;&quot;background-color:#FEEFB3; color:#9F6000&quot;&gt;&lt;b&gt;Note:&lt;/b&gt; The &lt;code&gt;force_pmi_jbh_password&lt;/code&gt; field under meeting settings was deprecated on September 22, 2019. Use &lt;code&gt;require_password_for_pmi_meetings&lt;/code&gt; field as an alternative for the same functionality.&lt;/p&gt; Prerequisites: * Pro or a higher paid account with Master Account option enabled. &lt;br&gt; Scope: &#x60;account:read:admin&#x60;. &lt;br&gt; Scope: account:read:admin

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20070 data, response status code and response headers



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/zoom_us/accounts.rb', line 548

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

#update_account_lock_settings(account_id, opts = {}) ⇒ Object

Update Locked Settings [Account Locked Settings](support.zoom.us/hc/en-us/articles/115005269866) allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to update an account’s locked settings.<p style="background-color:#FEEFB3; color:#9F6000">
Note:</b> The ‘force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p> Prerequisites:
* Pro or a higher paid account with Master Account option enabled.
Scope: `account:write:admin`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body51)

Returns:

  • (Object) 


593
594
595
596
 
# File 'lib/zoom_us/accounts.rb', line 593

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

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

Update Locked Settings [Account Locked Settings](support.zoom.us/hc/en-us/articles/115005269866) allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to update an account&#39;s locked settings.&lt;p style&#x3D;&quot;background-color:#FEEFB3; color:#9F6000&quot;&gt;&lt;br&gt;Note:&lt;/b&gt; The &#x60;force_pmi_jbh_password&#x60; field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.&lt;/p&gt; Prerequisites:&lt;br&gt; * Pro or a higher paid account with Master Account option enabled. &lt;br&gt; Scope: &#x60;account:write:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Body51)

Returns:

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

    Object data, response status code and response headers



604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
 
# File 'lib/zoom_us/accounts.rb', line 604

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

#update_account_owner(account_id, opts = {}) ⇒ Object

Update the Account Owner The current account owner can [change the owner of an account](support.zoom.us/hc/en-us/articles/115005686983-Change-Account-Owner) to another user on the same account.
Use this API to change the owner of an account. Prerequisites:
* Account owner or admin permissions.
* Pro or a higher plan with Master Account option enabled.. Scopes: ‘account:write:admin` or `account:master`

Parameters:

  • account_id —

    Account Id of the account.

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

    the optional parameters

Options Hash (opts):

  • :body (Body53)

Returns:

  • (Object) 


649
650
651
652
 
# File 'lib/zoom_us/accounts.rb', line 649

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

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

Update the Account Owner The current account owner can [change the owner of an account](support.zoom.us/hc/en-us/articles/115005686983-Change-Account-Owner) to another user on the same account.&lt;br&gt; Use this API to change the owner of an account. Prerequisites:&lt;br&gt; * Account owner or admin permissions.&lt;br&gt; * Pro or a higher plan with Master Account option enabled.. Scopes: &#x60;account:write:admin&#x60; or &#x60;account:master&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • account_id —

    Account Id of the account.

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

    the optional parameters

Options Hash (opts):

  • :body (Body53)

Returns:

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

    Object data, response status code and response headers



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/zoom_us/accounts.rb', line 660

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