Class: ZoomUs::Meetings

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Meetings

Returns a new instance of Meetings.



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

def api_client
  @api_client
end

Instance Method Details

#list_past_meeting_files(meeting_id, opts = {}) ⇒ InlineResponse20084

List Past Meeting Files List files sent via in-meeting chat during a meeting. The in-meeting files are deleted after 24 hours of the meeting completion time.
Scope: ‘meeting:read`, `meeting:read:admin`

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

  • (InlineResponse20084) 


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

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

#list_past_meeting_files_with_http_info(meeting_id, opts = {}) ⇒ Array<(InlineResponse20084, Fixnum, Hash)>

List Past Meeting Files List files sent via in-meeting chat during a meeting. The in-meeting files are deleted after 24 hours of the meeting completion time. &lt;br&gt;&lt;br&gt; Scope: &#x60;meeting:read&#x60;, &#x60;meeting:read:admin&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

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

    InlineResponse20084 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/meetings.rb', line 37

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

#list_past_meeting_polls(meeting_id, opts = {}) ⇒ InlineResponse20083

List Past Meeting’s Poll Results [Polls](support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) allow the meeting host to survey attendees. Use this API to list poll results of a meeting.
Scopes: ‘meeting:read:admin`, `meeting:read`
Prerequisites:
* Host user type must be Pro. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If meeting ID is provided, it will take the last meeting instance.

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

    the optional parameters

Returns:

  • (InlineResponse20083) 


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

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

#list_past_meeting_polls_with_http_info(meeting_id, opts = {}) ⇒ Array<(InlineResponse20083, Fixnum, Hash)>

List Past Meeting&#39;s Poll Results [Polls](support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) allow the meeting host to survey attendees. Use this API to list poll results of a meeting.&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:read:admin&#x60;, &#x60;meeting:read&#x60;&lt;br&gt; Prerequisites:&lt;br&gt; * Host user type must be Pro. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If meeting ID is provided, it will take the last meeting instance.

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

    the optional parameters

Returns:

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

    InlineResponse20083 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/meetings.rb', line 91

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

#meeting(meeting_id, opts = {}) ⇒ InlineResponse20022

Get a Meeting Retrieve the details of a meeting.
Scopes: ‘meeting:read:admin` `meeting:read`

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    Meeting occurrence id

Returns:

  • (InlineResponse20022) 


136
137
138
139
 
# File 'lib/zoom_us/meetings.rb', line 136

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

#meeting_create(user_id, body, opts = {}) ⇒ InlineResponse20110

Create a Meeting Create a meeting for a user.
This API has a daily rate limit of 100 requests per day. Therefore, only 100 **Create a Meeting** API requests are permitted within a 24 hour window for a user.
<aside>The start_url of a meeting is a URL using which a host or an alternative host can start a meeting. The expiration time for the start_url field is two hours for all regular users. For users created using the custCreate option via the [Create Users](marketplace.zoom.us/docs/api-reference/zoom-api/users/usercreate) API, the expiration time of the start_url field is 90 days. For security reasons, the recommended way to retrieve the updated value for the start_url field programmatically (after expiry) is by calling the [Retrieve a Meeting API](marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meeting) and referring to the value of the start_url field in the response.</aside>
Scopes: ‘meeting:write:admin` `meeting:write`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body —

    Meeting object.

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

    the optional parameters

Returns:

  • (InlineResponse20110) 


193
194
195
196
 
# File 'lib/zoom_us/meetings.rb', line 193

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

#meeting_create_with_http_info(user_id, body, opts = {}) ⇒ Array<(InlineResponse20110, Fixnum, Hash)>

Create a Meeting Create a meeting for a user. &lt;br&gt;This API has a daily rate limit of 100 requests per day. Therefore, only 100 **Create a Meeting** API requests are permitted within a 24 hour window for a user.&lt;br&gt; &lt;aside&gt;The &lt;code&gt;start_url&lt;/code&gt; of a meeting is a URL using which a host or an alternative host can start a meeting. The expiration time for the &lt;code&gt;start_url&lt;/code&gt; field is two hours for all regular users. For users created using the &lt;code&gt;custCreate&lt;/code&gt; option via the [Create Users](marketplace.zoom.us/docs/api-reference/zoom-api/users/usercreate) API, the expiration time of the &lt;code&gt;start_url&lt;/code&gt; field is 90 days. For security reasons, the recommended way to retrieve the updated value for the &lt;code&gt;start_url&lt;/code&gt; field programmatically (after expiry) is by calling the [Retrieve a Meeting API](marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meeting) and referring to the value of the &lt;code&gt;start_url&lt;/code&gt; field in the response.&lt;/aside&gt;&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:write:admin&#x60; &#x60;meeting:write&#x60;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body —

    Meeting object.

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

    the optional parameters

Returns:

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

    InlineResponse20110 data, response status code and response headers



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
243
244
245
246
 
# File 'lib/zoom_us/meetings.rb', line 204

def meeting_create_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MeetingsApi.meeting_create ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling MeetingsApi.meeting_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 MeetingsApi.meeting_create"
  end
  # resource path
  local_var_path = '/users/{userId}/meetings'.sub('{' + 'userId' + '}', user_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(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 => 'InlineResponse20110')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeetingsApi#meeting_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#meeting_delete(meeting_id, opts = {}) ⇒ nil

Delete a Meeting Delete a meeting.
Scopes: ‘meeting:write:admin` `meeting:write`

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

  • :schedule_for_reminder (BOOLEAN) —

    &#x60;true&#x60;: Notify host and alternative host about the meeting cancellation via email. &#x60;false&#x60;: Do not send any email notification.

Returns:

  • (nil) 


254
255
256
257
 
# File 'lib/zoom_us/meetings.rb', line 254

def meeting_delete(meeting_id, opts = {})
  meeting_delete_with_http_info(meeting_id, opts)
  nil
end

#meeting_delete_with_http_info(meeting_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Meeting Delete a meeting.&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:write:admin&#x60; &#x60;meeting:write&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

  • :schedule_for_reminder (BOOLEAN) —

    &#x60;true&#x60;: Notify host and alternative host about the meeting cancellation via email. &#x60;false&#x60;: Do not send any email notification.

Returns:

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

    nil, response status code and response headers



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
297
298
299
300
301
302
303
304
305
 
# File 'lib/zoom_us/meetings.rb', line 266

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

  # query parameters
  query_params = {}
  query_params[:'occurrence_id'] = opts[:'occurrence_id'] if !opts[:'occurrence_id'].nil?
  query_params[:'schedule_for_reminder'] = opts[:'schedule_for_reminder'] if !opts[:'schedule_for_reminder'].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(: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: MeetingsApi#meeting_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#meeting_invitation(meeting_id, opts = {}) ⇒ MeetingInvitation

Get Meeting Invitation Retrieve the meeting invite note that was sent for a specific meeting.
Scopes: ‘meeting:read:admin` `meeting:read`

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

  • (MeetingInvitation) 


311
312
313
314
 
# File 'lib/zoom_us/meetings.rb', line 311

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

#meeting_invitation_with_http_info(meeting_id, opts = {}) ⇒ Array<(MeetingInvitation, Fixnum, Hash)>

Get Meeting Invitation Retrieve the meeting invite note that was sent for a specific meeting.&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:read:admin&#x60; &#x60;meeting:read&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

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

    MeetingInvitation data, response status code and response headers



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
356
357
358
359
 
# File 'lib/zoom_us/meetings.rb', line 321

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

#meeting_live_stream_status_update(meeting_id, body, opts = {}) ⇒ nil

Update Live Stream Status Zoom allows users to [live stream a meeting](support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update the status of a meeting’s live stream.
Prerequisites:
* Meeting host must have a Pro license.
Scopes: ‘meeting:write:admin` `meeting:write`

Parameters:

  • meeting_id —

    The meeting ID.

  • body —

    Meeting

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

    the optional parameters

Returns:

  • (nil) 


366
367
368
369
 
# File 'lib/zoom_us/meetings.rb', line 366

def meeting_live_stream_status_update(meeting_id, body, opts = {})
  meeting_live_stream_status_update_with_http_info(meeting_id, body, opts)
  nil
end

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

Update Live Stream Status Zoom allows users to [live stream a meeting](support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update the status of a meeting&#39;s live stream.&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Meeting host must have a Pro license.&lt;br&gt; Scopes: &#x60;meeting:write:admin&#x60; &#x60;meeting:write&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID.

  • body —

    Meeting

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def meeting_live_stream_status_update_with_http_info(meeting_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MeetingsApi.meeting_live_stream_status_update ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling MeetingsApi.meeting_live_stream_status_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 MeetingsApi.meeting_live_stream_status_update"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/livestream/status'.sub('{' + 'meetingId' + '}', meeting_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(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: MeetingsApi#meeting_live_stream_status_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#meeting_live_stream_update(meeting_id, body, opts = {}) ⇒ nil

Update Live Stream Zoom allows users to [live stream a meeting](support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update a meeting’s live stream information.
Prerequisites:
* Meeting host must have a Pro license.
Scopes: ‘meeting:write:admin` `meeting:write`

Parameters:

  • meeting_id —

    The meeting ID.

  • body —

    Meeting

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

    the optional parameters

Returns:

  • (nil) 


425
426
427
428
 
# File 'lib/zoom_us/meetings.rb', line 425

def meeting_live_stream_update(meeting_id, body, opts = {})
  meeting_live_stream_update_with_http_info(meeting_id, body, opts)
  nil
end

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

Update Live Stream Zoom allows users to [live stream a meeting](support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update a meeting&#39;s live stream information.&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Meeting host must have a Pro license.&lt;br&gt; Scopes: &#x60;meeting:write:admin&#x60; &#x60;meeting:write&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID.

  • body —

    Meeting

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

    the optional parameters

Returns:

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

    nil, 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
475
476
477
 
# File 'lib/zoom_us/meetings.rb', line 436

def meeting_live_stream_update_with_http_info(meeting_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MeetingsApi.meeting_live_stream_update ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling MeetingsApi.meeting_live_stream_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 MeetingsApi.meeting_live_stream_update"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/livestream'.sub('{' + 'meetingId' + '}', meeting_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(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: MeetingsApi#meeting_live_stream_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#meeting_poll_create(meeting_id, body, opts = {}) ⇒ InlineResponse20112

Create a Meeting Poll Polls allow the meeting host to survey attendees. Use this API to create a [poll](support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting.
Scopes: ‘meeting:write:admin` `meeting:write`
Prerequisites:
* Host user type must be Pro. * Polling feature should be enabled in the host’s account. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.

Parameters:

  • meeting_id —

    The meeting ID.

  • body —

    Meeting poll object

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

    the optional parameters

Returns:

  • (InlineResponse20112) 


484
485
486
487
 
# File 'lib/zoom_us/meetings.rb', line 484

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

#meeting_poll_create_with_http_info(meeting_id, body, opts = {}) ⇒ Array<(InlineResponse20112, Fixnum, Hash)>

Create a Meeting Poll Polls allow the meeting host to survey attendees. Use this API to create a [poll](support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting.&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:write:admin&#x60; &#x60;meeting:write&#x60;&lt;br&gt; Prerequisites:&lt;br&gt; * Host user type must be Pro. * Polling feature should be enabled in the host&#39;s account. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.

Parameters:

  • meeting_id —

    The meeting ID.

  • body —

    Meeting poll object

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

    the optional parameters

Returns:

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

    InlineResponse20112 data, response status code and response headers



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
533
534
535
536
537
 
# File 'lib/zoom_us/meetings.rb', line 495

def meeting_poll_create_with_http_info(meeting_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MeetingsApi.meeting_poll_create ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling MeetingsApi.meeting_poll_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 MeetingsApi.meeting_poll_create"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/polls'.sub('{' + 'meetingId' + '}', meeting_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(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 => 'InlineResponse20112')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeetingsApi#meeting_poll_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#meeting_poll_delete(meeting_id, poll_id, opts = {}) ⇒ nil

Delete a Meeting Poll Polls allow the meeting host to survey attendees. Use this API to delete a meeting [poll](support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).
Scopes: ‘meeting:write:admin` `meeting:write`
Prerequisites:
* Host user type must be Pro. * Polling feature should be enabled in the host’s account. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.

Parameters:

  • meeting_id —

    The meeting ID.

  • poll_id —

    The poll ID

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

    the optional parameters

Returns:

  • (nil) 


544
545
546
547
 
# File 'lib/zoom_us/meetings.rb', line 544

def meeting_poll_delete(meeting_id, poll_id, opts = {})
  meeting_poll_delete_with_http_info(meeting_id, poll_id, opts)
  nil
end

#meeting_poll_delete_with_http_info(meeting_id, poll_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Meeting Poll Polls allow the meeting host to survey attendees. Use this API to delete a meeting [poll](support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).&lt;br&gt; Scopes: &#x60;meeting:write:admin&#x60; &#x60;meeting:write&#x60;&lt;br&gt; Prerequisites:&lt;br&gt; * Host user type must be Pro. * Polling feature should be enabled in the host&#39;s account. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.

Parameters:

  • meeting_id —

    The meeting ID.

  • poll_id —

    The poll ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/zoom_us/meetings.rb', line 555

def meeting_poll_delete_with_http_info(meeting_id, poll_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MeetingsApi.meeting_poll_delete ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling MeetingsApi.meeting_poll_delete"
  end
  # verify the required parameter 'poll_id' is set
  if @api_client.config.client_side_validation && poll_id.nil?
    fail ArgumentError, "Missing the required parameter 'poll_id' when calling MeetingsApi.meeting_poll_delete"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/polls/{pollId}'.sub('{' + 'meetingId' + '}', meeting_id.to_s).sub('{' + 'pollId' + '}', poll_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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeetingsApi#meeting_poll_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#meeting_poll_get(meeting_id, poll_id, opts = {}) ⇒ InlineResponse20112

Get a Meeting Poll Polls allow the meeting host to survey attendees. Use this API to get information about a specific meeting [poll](support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).
Scopes: ‘meeting:read:admin` `meeting:read`

Parameters:

  • meeting_id —

    The meeting ID.

  • poll_id —

    The poll ID

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

    the optional parameters

Returns:

  • (InlineResponse20112) 


603
604
605
606
 
# File 'lib/zoom_us/meetings.rb', line 603

def meeting_poll_get(meeting_id, poll_id, opts = {})
  data, _status_code, _headers = meeting_poll_get_with_http_info(meeting_id, poll_id, opts)
  data
end

#meeting_poll_get_with_http_info(meeting_id, poll_id, opts = {}) ⇒ Array<(InlineResponse20112, Fixnum, Hash)>

Get a Meeting Poll Polls allow the meeting host to survey attendees. Use this API to get information about a specific meeting [poll](support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:read:admin&#x60; &#x60;meeting:read&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID.

  • poll_id —

    The poll ID

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

    the optional parameters

Returns:

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

    InlineResponse20112 data, response status code and response headers



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
643
644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/zoom_us/meetings.rb', line 614

def meeting_poll_get_with_http_info(meeting_id, poll_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MeetingsApi.meeting_poll_get ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling MeetingsApi.meeting_poll_get"
  end
  # verify the required parameter 'poll_id' is set
  if @api_client.config.client_side_validation && poll_id.nil?
    fail ArgumentError, "Missing the required parameter 'poll_id' when calling MeetingsApi.meeting_poll_get"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/polls/{pollId}'.sub('{' + 'meetingId' + '}', meeting_id.to_s).sub('{' + 'pollId' + '}', poll_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 => 'InlineResponse20112')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeetingsApi#meeting_poll_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#meeting_poll_update(meeting_id, poll_id, body, opts = {}) ⇒ nil

Update a Meeting Poll Polls allow the meeting host to survey attendees. Use this API to update information of a specific meeting [poll](support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings)
Scopes: ‘meeting:write:admin` `meeting:write`

Parameters:

  • meeting_id —

    The meeting ID.

  • poll_id —

    The poll ID

  • body —

    Meeting Poll

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

    the optional parameters

Returns:

  • (nil) 


664
665
666
667
 
# File 'lib/zoom_us/meetings.rb', line 664

def meeting_poll_update(meeting_id, poll_id, body, opts = {})
  meeting_poll_update_with_http_info(meeting_id, poll_id, body, opts)
  nil
end

#meeting_poll_update_with_http_info(meeting_id, poll_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a Meeting Poll Polls allow the meeting host to survey attendees. Use this API to update information of a specific meeting [poll](support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings)&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:write:admin&#x60; &#x60;meeting:write&#x60;

Parameters:

  • meeting_id —

    The meeting ID.

  • poll_id —

    The poll ID

  • body —

    Meeting Poll

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
 
# File 'lib/zoom_us/meetings.rb', line 676

def meeting_poll_update_with_http_info(meeting_id, poll_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MeetingsApi.meeting_poll_update ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling MeetingsApi.meeting_poll_update"
  end
  # verify the required parameter 'poll_id' is set
  if @api_client.config.client_side_validation && poll_id.nil?
    fail ArgumentError, "Missing the required parameter 'poll_id' when calling MeetingsApi.meeting_poll_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 MeetingsApi.meeting_poll_update"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/polls/{pollId}'.sub('{' + 'meetingId' + '}', meeting_id.to_s).sub('{' + 'pollId' + '}', poll_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(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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeetingsApi#meeting_poll_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#meeting_polls(meeting_id, opts = {}) ⇒ Object

List Meeting Polls Polls allow the meeting host to survey attendees. Use this API to list [polls](support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) of a meeting.
Scopes: ‘meeting:read:admin` `meeting:read`
Prerequisites:
* Host user type must be Pro. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

  • (Object) 


727
728
729
730
 
# File 'lib/zoom_us/meetings.rb', line 727

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

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

List Meeting Polls Polls allow the meeting host to survey attendees. Use this API to list [polls](support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) of a meeting.&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:read:admin&#x60; &#x60;meeting:read&#x60;&lt;br&gt; Prerequisites:&lt;br&gt; * Host user type must be Pro. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/zoom_us/meetings.rb', line 737

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

#meeting_registrant_create(meeting_id, body, opts = {}) ⇒ InlineResponse20111

Add Meeting Registrant Register a participant for a meeting.
Scopes: ‘meeting:write:admin` `meeting:write`

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Options Hash (opts):

  • :occurrence_ids (String) —

    Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma.

Returns:

  • (InlineResponse20111) 


783
784
785
786
 
# File 'lib/zoom_us/meetings.rb', line 783

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

#meeting_registrant_create_with_http_info(meeting_id, body, opts = {}) ⇒ Array<(InlineResponse20111, Fixnum, Hash)>

Add Meeting Registrant Register a participant for a meeting.&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:write:admin&#x60; &#x60;meeting:write&#x60;

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Options Hash (opts):

  • :occurrence_ids (String) —

    Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma.

Returns:

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

    InlineResponse20111 data, response status code and response headers



795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'lib/zoom_us/meetings.rb', line 795

def meeting_registrant_create_with_http_info(meeting_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MeetingsApi.meeting_registrant_create ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling MeetingsApi.meeting_registrant_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 MeetingsApi.meeting_registrant_create"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/registrants'.sub('{' + 'meetingId' + '}', meeting_id.to_s)

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

#meeting_registrant_question_update(meeting_id, body, opts = {}) ⇒ nil

Update Registration Questions Update registration questions that will be displayed to users while [registering for a meeeting](support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).
Scopes: ‘meeting:write`, `meeting:write:admin`

Parameters:

  • meeting_id —

    The meeting ID.

  • body —

    Meeting Registrant Questions

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

    the optional parameters

Returns:

  • (nil) 


845
846
847
848
 
# File 'lib/zoom_us/meetings.rb', line 845

def meeting_registrant_question_update(meeting_id, body, opts = {})
  meeting_registrant_question_update_with_http_info(meeting_id, body, opts)
  nil
end

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

Update Registration Questions Update registration questions that will be displayed to users while [registering for a meeeting](support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:write&#x60;, &#x60;meeting:write:admin&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID.

  • body —

    Meeting Registrant Questions

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'lib/zoom_us/meetings.rb', line 856

def meeting_registrant_question_update_with_http_info(meeting_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MeetingsApi.meeting_registrant_question_update ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling MeetingsApi.meeting_registrant_question_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 MeetingsApi.meeting_registrant_question_update"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/registrants/questions'.sub('{' + 'meetingId' + '}', meeting_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(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: MeetingsApi#meeting_registrant_question_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#meeting_registrant_status(meeting_id, body, opts = {}) ⇒ nil

Update Meeting Registrant Status Update a meeting registrant’s status by either approving, cancelling or denying a registrant from joining the meeting.
Scopes: ‘meeting:write:admin` `meeting:write`

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

Returns:

  • (nil) 


905
906
907
908
 
# File 'lib/zoom_us/meetings.rb', line 905

def meeting_registrant_status(meeting_id, body, opts = {})
  meeting_registrant_status_with_http_info(meeting_id, body, opts)
  nil
end

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

Update Meeting Registrant Status Update a meeting registrant&#39;s status by either approving, cancelling or denying a registrant from joining the meeting.&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:write:admin&#x60; &#x60;meeting:write&#x60;

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

Returns:

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

    nil, response status code and response headers



917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
 
# File 'lib/zoom_us/meetings.rb', line 917

def meeting_registrant_status_with_http_info(meeting_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MeetingsApi.meeting_registrant_status ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling MeetingsApi.meeting_registrant_status"
  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 MeetingsApi.meeting_registrant_status"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/registrants/status'.sub('{' + 'meetingId' + '}', meeting_id.to_s)

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

#meeting_registrants(meeting_id, opts = {}) ⇒ RegistrationList

List Meeting Registrants A host or a user with admin permission can require [registration for a Zoom meeting](support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings). Use this API to list users that have registered for a meeting.
Scopes: ‘meeting:read:admin` `meeting:read`

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

  • :status (String) —

    The registrant status:&lt;br&gt;&#x60;pending&#x60; - Registrant&#39;s status is pending.&lt;br&gt;&#x60;approved&#x60; - Registrant&#39;s status is approved.&lt;br&gt;&#x60;denied&#x60; - Registrant&#39;s status is denied. (default to approved)

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

  • (RegistrationList) 


969
970
971
972
 
# File 'lib/zoom_us/meetings.rb', line 969

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

#meeting_registrants_questions_get(meeting_id, opts = {}) ⇒ InlineResponse20025

List Registration Questions List registration questions that will be displayed to users while [registering for a meeeting](support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).
Scopes: ‘meeting:read`, `meeting:read:admin`

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

  • (InlineResponse20025) 


1038
1039
1040
1041
 
# File 'lib/zoom_us/meetings.rb', line 1038

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

#meeting_registrants_questions_get_with_http_info(meeting_id, opts = {}) ⇒ Array<(InlineResponse20025, Fixnum, Hash)>

List Registration Questions List registration questions that will be displayed to users while [registering for a meeeting](support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).&lt;br&gt; Scopes: &#x60;meeting:read&#x60;, &#x60;meeting:read:admin&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

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

    InlineResponse20025 data, response status code and response headers



1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
 
# File 'lib/zoom_us/meetings.rb', line 1048

def meeting_registrants_questions_get_with_http_info(meeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MeetingsApi.meeting_registrants_questions_get ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling MeetingsApi.meeting_registrants_questions_get"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/registrants/questions'.sub('{' + 'meetingId' + '}', meeting_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 => 'InlineResponse20025')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeetingsApi#meeting_registrants_questions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#meeting_registrants_with_http_info(meeting_id, opts = {}) ⇒ Array<(RegistrationList, Fixnum, Hash)>

List Meeting Registrants A host or a user with admin permission can require [registration for a Zoom meeting](support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings). Use this API to list users that have registered for a meeting.&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:read:admin&#x60; &#x60;meeting:read&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

  • :status (String) —

    The registrant status:&lt;br&gt;&#x60;pending&#x60; - Registrant&#39;s status is pending.&lt;br&gt;&#x60;approved&#x60; - Registrant&#39;s status is approved.&lt;br&gt;&#x60;denied&#x60; - Registrant&#39;s status is denied.

  • :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<(RegistrationList, Fixnum, Hash)>) —

    RegistrationList data, response status code and response headers



983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'lib/zoom_us/meetings.rb', line 983

def meeting_registrants_with_http_info(meeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MeetingsApi.meeting_registrants ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling MeetingsApi.meeting_registrants"
  end
  if @api_client.config.client_side_validation && opts[:'status'] && !['pending', 'approved', 'denied'].include?(opts[:'status'])
    fail ArgumentError, 'invalid value for "status", must be one of pending, approved, denied'
  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 MeetingsApi.meeting_registrants, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/meetings/{meetingId}/registrants'.sub('{' + 'meetingId' + '}', meeting_id.to_s)

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

#meeting_status(meeting_id, body, opts = {}) ⇒ nil

Update Meeting Status End a meeting by updating its status.
Scopes: ‘meeting:write:admin` `meeting:write`

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

  • (nil) 


1093
1094
1095
1096
 
# File 'lib/zoom_us/meetings.rb', line 1093

def meeting_status(meeting_id, body, opts = {})
  meeting_status_with_http_info(meeting_id, body, opts)
  nil
end

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

Update Meeting Status End a meeting by updating its status.&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:write:admin&#x60; &#x60;meeting:write&#x60;

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
 
# File 'lib/zoom_us/meetings.rb', line 1104

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

#meeting_update(meeting_id, body, opts = {}) ⇒ nil

Update a Meeting Update the details of a meeting.
This API has a rate limit of 100 requests per day. Therefore, a meeting can only be updated for a maximum of 100 times within a 24 hour window.
Scopes: ‘meeting:write:admin` `meeting:write`

Parameters:

  • meeting_id —

    The meeting ID.

  • body —

    Meeting

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

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    Meeting occurrence id. Support change of agenda, start_time, duration, settings: participant_video, join_before_host, mute_upon_entry, waiting_room, watermark, auto_recording

Returns:

  • (nil) 


1153
1154
1155
1156
 
# File 'lib/zoom_us/meetings.rb', line 1153

def meeting_update(meeting_id, body, opts = {})
  meeting_update_with_http_info(meeting_id, body, opts)
  nil
end

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

Update a Meeting Update the details of a meeting.&lt;br&gt;This API has a rate limit of 100 requests per day. Therefore, a meeting can only be updated for a maximum of 100 times within a 24 hour window.&lt;br&gt; Scopes: &#x60;meeting:write:admin&#x60; &#x60;meeting:write&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID.

  • body —

    Meeting

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

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    Meeting occurrence id. Support change of agenda, start_time, duration, settings: participant_video, join_before_host, mute_upon_entry, waiting_room, watermark, auto_recording

Returns:

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

    nil, response status code and response headers



1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
 
# File 'lib/zoom_us/meetings.rb', line 1165

def meeting_update_with_http_info(meeting_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MeetingsApi.meeting_update ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling MeetingsApi.meeting_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 MeetingsApi.meeting_update"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}'.sub('{' + 'meetingId' + '}', meeting_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'occurrence_id'] = opts[:'occurrence_id'] if !opts[:'occurrence_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 = @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: MeetingsApi#meeting_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#meeting_with_http_info(meeting_id, opts = {}) ⇒ Array<(InlineResponse20022, Fixnum, Hash)>

Get a Meeting Retrieve the details of a meeting.&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:read:admin&#x60; &#x60;meeting:read&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    Meeting occurrence id

Returns:

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

    InlineResponse20022 data, response status code and response headers



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/zoom_us/meetings.rb', line 147

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

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

#meetings(user_id, opts = {}) ⇒ GroupList

List Meetings List all the meetings that were scheduled for a user (meeting host).
Scopes: ‘meeting:read:admin` `meeting:read`

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;scheduled&#x60; - All the scheduled meetings.&lt;br&gt;&#x60;live&#x60; - All the live meetings.&lt;br&gt;&#x60;upcoming&#x60; - All the upcoming meetings. (default to live)

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

  • (GroupList) 


1216
1217
1218
1219
 
# File 'lib/zoom_us/meetings.rb', line 1216

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

#meetings_with_http_info(user_id, opts = {}) ⇒ Array<(GroupList, Fixnum, Hash)>

List Meetings List all the meetings that were scheduled for a user (meeting host).&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:read:admin&#x60; &#x60;meeting:read&#x60;&lt;br&gt;

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;scheduled&#x60; - All the scheduled meetings.&lt;br&gt;&#x60;live&#x60; - All the live meetings.&lt;br&gt;&#x60;upcoming&#x60; - All the upcoming meetings.

  • :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<(GroupList, Fixnum, Hash)>) —

    GroupList data, response status code and response headers



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
 
# File 'lib/zoom_us/meetings.rb', line 1229

def meetings_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MeetingsApi.meetings ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling MeetingsApi.meetings"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['scheduled', 'live', 'upcoming'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of scheduled, live, upcoming'
  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 MeetingsApi.meetings, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/users/{userId}/meetings'.sub('{' + 'userId' + '}', user_id.to_s)

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

#past_meeting_details(meeting_uuid, opts = {}) ⇒ InlineResponse20023

Get Past Meeting Details Get details on a past meeting.
Scopes: ‘meeting:read:admin` `meeting:read` > Note: Please double encode your UUID when using this API if the UUID begins with a ’/‘or contains ’//‘ in it.

Parameters:

  • meeting_uuid —

    The meeting UUID. Please double encode your UUID when using it for other API calls if the UUID begins with a &#39;/&#39;or contains &#39;//&#39; in it.

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

    the optional parameters

Returns:

  • (InlineResponse20023) 


1283
1284
1285
1286
 
# File 'lib/zoom_us/meetings.rb', line 1283

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

#past_meeting_details_with_http_info(meeting_uuid, opts = {}) ⇒ Array<(InlineResponse20023, Fixnum, Hash)>

Get Past Meeting Details Get details on a past meeting. &lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:read:admin&#x60; &#x60;meeting:read&#x60; &gt; Note: Please double encode your UUID when using this API if the UUID begins with a &#39;/&#39;or contains &#39;//&#39; in it.

Parameters:

  • meeting_uuid —

    The meeting UUID. Please double encode your UUID when using it for other API calls if the UUID begins with a &#39;/&#39;or contains &#39;//&#39; in it.

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

    the optional parameters

Returns:

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

    InlineResponse20023 data, response status code and response headers



1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
 
# File 'lib/zoom_us/meetings.rb', line 1293

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

#past_meeting_participants(meeting_uuid, opts = {}) ⇒ InlineResponse20024

Get Past Meeting Participants Retrieve information on participants from a past meeting.
Scopes: ‘meeting:read:admin` `meeting:read` Prerequisites:
* Paid account on a Pro or higher plan.

Note: Please double encode your UUID when using this API if the UUID begins with a ’/‘or contains ’//‘ in it.

Parameters:

  • meeting_uuid —

    The meeting UUID. Please double encode your UUID when using it for other API calls if the UUID begins with a &#39;/&#39;or contains &#39;//&#39; in it.

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

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

  • (InlineResponse20024) 


1339
1340
1341
1342
 
# File 'lib/zoom_us/meetings.rb', line 1339

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

#past_meeting_participants_with_http_info(meeting_uuid, opts = {}) ⇒ Array<(InlineResponse20024, Fixnum, Hash)>

Get Past Meeting Participants Retrieve information on participants from a past meeting. &lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:read:admin&#x60; &#x60;meeting:read&#x60; Prerequisites:&lt;br&gt; * Paid account on a Pro or higher plan. &lt;br&gt; &lt;br&gt; Note: Please double encode your UUID when using this API if the UUID begins with a &#39;/&#39;or contains &#39;//&#39; in it.

Parameters:

  • meeting_uuid —

    The meeting UUID. Please double encode your UUID when using it for other API calls if the UUID begins with a &#39;/&#39;or contains &#39;//&#39; in it.

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

    the optional parameters

Options Hash (opts):

  • :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<(InlineResponse20024, Fixnum, Hash)>) —

    InlineResponse20024 data, response status code and response headers



1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
 
# File 'lib/zoom_us/meetings.rb', line 1351

def past_meeting_participants_with_http_info(meeting_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MeetingsApi.past_meeting_participants ...'
  end
  # verify the required parameter 'meeting_uuid' is set
  if @api_client.config.client_side_validation && meeting_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_uuid' when calling MeetingsApi.past_meeting_participants"
  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 MeetingsApi.past_meeting_participants, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/past_meetings/{meetingUUID}/participants'.sub('{' + 'meetingUUID' + '}', meeting_uuid.to_s)

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

#past_meetings(meeting_id, opts = {}) ⇒ Object

List Ended Meeting Instances Get a list of ended meeting instances
Scopes: ‘meeting:read:admin` `meeting:read`

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

  • (Object) 


1401
1402
1403
1404
 
# File 'lib/zoom_us/meetings.rb', line 1401

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

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

List Ended Meeting Instances Get a list of ended meeting instances&lt;br&gt;&lt;br&gt; Scopes: &#x60;meeting:read:admin&#x60; &#x60;meeting:read&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
 
# File 'lib/zoom_us/meetings.rb', line 1411

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