Class: ZoomUs::Dashboards

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Dashboards

Returns a new instance of Dashboards.



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

def api_client
  @api_client
end

Instance Method Details

#dashboard_client_feedback(from, to, opts = {}) ⇒ InlineResponse20032

List Zoom Meetings Client Feedbacks Retrieve survey results from [Zoom meetings client feedback](support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf).
You can specify a monthly date range for the dashboard data using the ‘from` and `to` query parameters. The month should fall within the last six months. Prerequisites: * Business or higher account * [Feedback to Zoom](support.zoom.us/hc/en-us/articles/115005838023) enabled. Scope: `account:read:admin`

Parameters:

  • from —

    Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

    the optional parameters

Returns:

  • (InlineResponse20032) 


28
29
30
31
 
# File 'lib/zoom_us/dashboards.rb', line 28

def dashboard_client_feedback(from, to, opts = {})
  data, _status_code, _headers = dashboard_client_feedback_with_http_info(from, to, opts)
  data
end

#dashboard_client_feedback_detail(feedback_id, opts = {}) ⇒ InlineResponse20059

Get Zoom Meetings Client Feedback Retrieve detailed information on a [Zoom meetings client feedback](support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf).
You can specify a monthly date range for the dashboard data using the ‘from` and `to` query parameters. The month should fall within the last six months. Prerequisites: * Business or higher account * [Feedback to Zoom](support.zoom.us/hc/en-us/articles/115005838023) enabled. Scope: `dashboard_home:read:admin`
`

Parameters:

  • feedback_id —

    Feedback Detail Id

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

    the optional parameters

Options Hash (opts):

  • :from (Date)
  • :to (Date)
  • :page_size (Integer) — default: default to 30
  • :next_page_token (String)

Returns:

  • (InlineResponse20059) 


93
94
95
96
 
# File 'lib/zoom_us/dashboards.rb', line 93

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

#dashboard_client_feedback_detail_with_http_info(feedback_id, opts = {}) ⇒ Array<(InlineResponse20059, Fixnum, Hash)>

Get Zoom Meetings Client Feedback Retrieve detailed information on a [Zoom meetings client feedback](support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf). &lt;br&gt; You can specify a monthly date range for the dashboard data using the &#x60;from&#x60; and &#x60;to&#x60; query parameters. The month should fall within the last six months. Prerequisites: * Business or higher account * [Feedback to Zoom](support.zoom.us/hc/en-us/articles/115005838023) enabled. Scope: &#x60;dashboard_home:read:admin&#x60;&lt;br&gt; &#x60;

Parameters:

  • feedback_id —

    Feedback Detail Id

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

    the optional parameters

Options Hash (opts):

  • :from (Date)
  • :to (Date)
  • :page_size (Integer)
  • :next_page_token (String)

Returns:

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

    InlineResponse20059 data, response status code and response headers



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/zoom_us/dashboards.rb', line 107

def dashboard_client_feedback_detail_with_http_info(feedback_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsApi.dashboard_client_feedback_detail ...'
  end
  # verify the required parameter 'feedback_id' is set
  if @api_client.config.client_side_validation && feedback_id.nil?
    fail ArgumentError, "Missing the required parameter 'feedback_id' when calling DashboardsApi.dashboard_client_feedback_detail"
  end
  # resource path
  local_var_path = '/metrics/client/feedback/{feedbackId}'.sub('{' + 'feedbackId' + '}', feedback_id.to_s)

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

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

  # form parameters
  form_params = {}

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

#dashboard_client_feedback_with_http_info(from, to, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

List Zoom Meetings Client Feedbacks Retrieve survey results from [Zoom meetings client feedback](support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf). &lt;br&gt; You can specify a monthly date range for the dashboard data using the &#x60;from&#x60; and &#x60;to&#x60; query parameters. The month should fall within the last six months. Prerequisites: * Business or higher account * [Feedback to Zoom](support.zoom.us/hc/en-us/articles/115005838023) enabled. Scope: &#x60;account:read:admin&#x60;&lt;br&gt;

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

    the optional parameters

Returns:

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

    InlineResponse20032 data, response status code and response headers



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
76
77
78
79
80
81
82
83
 
# File 'lib/zoom_us/dashboards.rb', line 39

def dashboard_client_feedback_with_http_info(from, to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsApi.dashboard_client_feedback ...'
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling DashboardsApi.dashboard_client_feedback"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling DashboardsApi.dashboard_client_feedback"
  end
  # resource path
  local_var_path = '/metrics/client/feedback'

  # query parameters
  query_params = {}
  query_params[:'from'] = from
  query_params[:'to'] = to

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

#dashboard_crc(from, to, opts = {}) ⇒ Object

Get CRC Port Usage A Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting. Use this API to get the hour by hour CRC Port usage for a specified period of time. <aside class=‘notice’>We will provide the report for a maximum of one month. For example, if "from" is set to "2017-08-05" and "to" is set to "2017-10-10", we will adjust "from" to "2017-09-10".</aside>
Prerequisites:
* Business, Education or API Plan. * Room Connector must be enabled on the account.
Scopes: ‘dashboard_crc:read:admin`

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

    the optional parameters

Returns:

  • (Object) 


156
157
158
159
 
# File 'lib/zoom_us/dashboards.rb', line 156

def dashboard_crc(from, to, opts = {})
  data, _status_code, _headers = dashboard_crc_with_http_info(from, to, opts)
  data
end

#dashboard_crc_with_http_info(from, to, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Get CRC Port Usage A Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting. Use this API to get the hour by hour CRC Port usage for a specified period of time. &lt;aside class&#x3D;&#39;notice&#39;&gt;We will provide the report for a maximum of one month. For example, if &quot;from&quot; is set to &quot;2017-08-05&quot; and &quot;to&quot; is set to &quot;2017-10-10&quot;, we will adjust &quot;from&quot; to &quot;2017-09-10&quot;.&lt;/aside&gt;&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Business, Education or API Plan. * Room Connector must be enabled on the account.&lt;br&gt;&lt;br&gt; Scopes: &#x60;dashboard_crc:read:admin&#x60;&lt;br&gt;

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/zoom_us/dashboards.rb', line 167

def dashboard_crc_with_http_info(from, to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsApi.dashboard_crc ...'
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling DashboardsApi.dashboard_crc"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling DashboardsApi.dashboard_crc"
  end
  # resource path
  local_var_path = '/metrics/crc'

  # query parameters
  query_params = {}
  query_params[:'from'] = from
  query_params[:'to'] = to

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

#dashboard_im(from, to, opts = {}) ⇒ InlineResponse20031

Get IM Metrics Get [metrics](support.zoom.us/hc/en-us/articles/204654719-Dashboard#h_cc7e9749-1c70-4afb-a9a2-9680654821e4) on how users are utilizing the Zoom Chat Client.

You can specify a monthly date range for the dashboard data using the ‘from` and `to` query parameters. The month should fall within the last six months. Scope: `dashboard_im:read:admin`
Prerequisites:
* Business or a higher plan.

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

  • (InlineResponse20031) 


220
221
222
223
 
# File 'lib/zoom_us/dashboards.rb', line 220

def dashboard_im(from, to, opts = {})
  data, _status_code, _headers = dashboard_im_with_http_info(from, to, opts)
  data
end

#dashboard_im_with_http_info(from, to, opts = {}) ⇒ Array<(InlineResponse20031, Fixnum, Hash)>

Get IM Metrics Get [metrics](support.zoom.us/hc/en-us/articles/204654719-Dashboard#h_cc7e9749-1c70-4afb-a9a2-9680654821e4) on how users are utilizing the Zoom Chat Client.&lt;br&gt;&lt;br&gt; &lt;br&gt; You can specify a monthly date range for the dashboard data using the &#x60;from&#x60; and &#x60;to&#x60; query parameters. The month should fall within the last six months. Scope: &#x60;dashboard_im:read:admin&#x60;&lt;br&gt; Prerequisites:&lt;br&gt; * Business or a higher plan.

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

    InlineResponse20031 data, response status code and response headers



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/zoom_us/dashboards.rb', line 233

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

  # resource path
  local_var_path = '/metrics/im'

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

#dashboard_issue_detail_zoom_room(zoomroom_id, from, to, opts = {}) ⇒ InlineResponse20033

Get Issues of Zoom Rooms Get information about the issues that occured on the Top 25 **Zoom Rooms with issues** in an acount.
You can specify a monthly date range for the dashboard data using the ‘from` and `to` query parameters. The month should fall within the last six months. Scope: `dashboard_home:read:admin`

Prerequisites:
* Business or a higher plan. * Zoom Room must be enabled in the account.

Parameters:

  • zoomroom_id —

    The Zoom room ID.

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

  • (InlineResponse20033) 


293
294
295
296
 
# File 'lib/zoom_us/dashboards.rb', line 293

def dashboard_issue_detail_zoom_room(zoomroom_id, from, to, opts = {})
  data, _status_code, _headers = dashboard_issue_detail_zoom_room_with_http_info(zoomroom_id, from, to, opts)
  data
end

#dashboard_issue_detail_zoom_room_with_http_info(zoomroom_id, from, to, opts = {}) ⇒ Array<(InlineResponse20033, Fixnum, Hash)>

Get Issues of Zoom Rooms Get information about the issues that occured on the Top 25 **Zoom Rooms with issues** in an acount. &lt;br&gt; You can specify a monthly date range for the dashboard data using the &#x60;from&#x60; and &#x60;to&#x60; query parameters. The month should fall within the last six months. Scope: &#x60;dashboard_home:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: &lt;br&gt; * Business or a higher plan. * Zoom Room must be enabled in the account.

Parameters:

  • zoomroom_id —

    The Zoom room ID.

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

    InlineResponse20033 data, response status code and response headers



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/zoom_us/dashboards.rb', line 307

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

  # resource path
  local_var_path = '/metrics/issues/zoomrooms/{zoomroomId}'.sub('{' + 'zoomroomId' + '}', zoomroom_id.to_s)

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

#dashboard_issue_zoom_room(from, to, opts = {}) ⇒ Object

Get Top 25 Zoom Rooms with Issues Get information on top 25 Zoom Rooms with issues in a month. The month specified with the "from" and "to" range should fall within the last six months.
Scope: ‘dashboard_home:read:admin`

Prerequisites:
* Business or a higher plan. * Zoom Room must be enabled in the account.

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

    the optional parameters

Returns:

  • (Object) 


368
369
370
371
 
# File 'lib/zoom_us/dashboards.rb', line 368

def dashboard_issue_zoom_room(from, to, opts = {})
  data, _status_code, _headers = dashboard_issue_zoom_room_with_http_info(from, to, opts)
  data
end

#dashboard_issue_zoom_room_with_http_info(from, to, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Get Top 25 Zoom Rooms with Issues Get information on top 25 Zoom Rooms with issues in a month. The month specified with the &quot;from&quot; and &quot;to&quot; range should fall within the last six months.&lt;br&gt; Scope: &#x60;dashboard_home:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Business or a higher plan. * Zoom Room must be enabled in the account.

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
421
422
423
 
# File 'lib/zoom_us/dashboards.rb', line 379

def dashboard_issue_zoom_room_with_http_info(from, to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsApi.dashboard_issue_zoom_room ...'
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling DashboardsApi.dashboard_issue_zoom_room"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling DashboardsApi.dashboard_issue_zoom_room"
  end
  # resource path
  local_var_path = '/metrics/issues/zoomrooms'

  # query parameters
  query_params = {}
  query_params[:'from'] = from
  query_params[:'to'] = to

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

#dashboard_meeting_detail(meeting_id, opts = {}) ⇒ MeetingMetrics

Get Meeting Details Get details on live or past meetings. This overview will show if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account.
You can specify a monthly date range for the dashboard data using the ‘from` and `to` query parameters. The month should fall within the last six months.
Scopes: `dashboard_meetings:read:admin`

Prerequisites:
* Business or a higher plan.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;past&#x60; - Past meetings.&lt;br&gt;&#x60;pastOne&#x60; - Past one user meetings.&lt;br&gt;&#x60;live&#x60; - Live meetings. (default to live)

Returns:

  • (MeetingMetrics) 


430
431
432
433
 
# File 'lib/zoom_us/dashboards.rb', line 430

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

#dashboard_meeting_detail_with_http_info(meeting_id, opts = {}) ⇒ Array<(MeetingMetrics, Fixnum, Hash)>

Get Meeting Details Get details on live or past meetings. This overview will show if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account.&lt;br&gt; You can specify a monthly date range for the dashboard data using the &#x60;from&#x60; and &#x60;to&#x60; query parameters. The month should fall within the last six months. &lt;br&gt; Scopes: &#x60;dashboard_meetings:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: &lt;br&gt; * Business or a higher plan.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;past&#x60; - Past meetings.&lt;br&gt;&#x60;pastOne&#x60; - Past one user meetings.&lt;br&gt;&#x60;live&#x60; - Live meetings.

Returns:

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

    MeetingMetrics data, response status code and response headers



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
478
479
480
481
482
483
 
# File 'lib/zoom_us/dashboards.rb', line 441

def dashboard_meeting_detail_with_http_info(meeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsApi.dashboard_meeting_detail ...'
  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 DashboardsApi.dashboard_meeting_detail"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['past', 'pastOne', 'live'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of past, pastOne, live'
  end
  # resource path
  local_var_path = '/metrics/meetings/{meetingId}'.sub('{' + 'meetingId' + '}', meeting_id.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = 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 => 'MeetingMetrics')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsApi#dashboard_meeting_detail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#dashboard_meeting_participant_qos(meeting_id, participant_id, opts = {}) ⇒ ParticipantQOS

Get Meeting Participant QOS Retrieve the quality of service for participants from live or past meetings. This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.
Scopes: ‘dashboard:read:admin`

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

  • participant_id —

    Participant ID.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;past&#x60; - Past meetings.&lt;br&gt;&#x60;live&#x60; - Live Meetings. (default to live)

Returns:

  • (ParticipantQOS) 


491
492
493
494
 
# File 'lib/zoom_us/dashboards.rb', line 491

def dashboard_meeting_participant_qos(meeting_id, participant_id, opts = {})
  data, _status_code, _headers = dashboard_meeting_participant_qos_with_http_info(meeting_id, participant_id, opts)
  data
end

#dashboard_meeting_participant_qos_with_http_info(meeting_id, participant_id, opts = {}) ⇒ Array<(ParticipantQOS, Fixnum, Hash)>

Get Meeting Participant QOS Retrieve the quality of service for participants from live or past meetings. This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields. &lt;br&gt;&lt;br&gt; Scopes: &#x60;dashboard:read:admin&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

  • participant_id —

    Participant ID.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;past&#x60; - Past meetings.&lt;br&gt;&#x60;live&#x60; - Live Meetings.

Returns:

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

    ParticipantQOS data, response status code and response headers



503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/zoom_us/dashboards.rb', line 503

def dashboard_meeting_participant_qos_with_http_info(meeting_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsApi.dashboard_meeting_participant_qos ...'
  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 DashboardsApi.dashboard_meeting_participant_qos"
  end
  # verify the required parameter 'participant_id' is set
  if @api_client.config.client_side_validation && participant_id.nil?
    fail ArgumentError, "Missing the required parameter 'participant_id' when calling DashboardsApi.dashboard_meeting_participant_qos"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['past', 'pastOne', 'live'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of past, pastOne, live'
  end
  # resource path
  local_var_path = '/metrics/meetings/{meetingId}/participants/{participantId}/qos'.sub('{' + 'meetingId' + '}', meeting_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = 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 => 'ParticipantQOS')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsApi#dashboard_meeting_participant_qos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#dashboard_meeting_participant_share(meeting_id, opts = {}) ⇒ InlineResponse20028

Get Sharing/Recording Details of Meeting Participants Retrieve the sharing and recording details of participants from live or past meetings.
You can specify a monthly date range for the dashboard data using the ‘from` and `to` query parameters. The month should fall within the last six months.
Scopes: `dashboard:read:admin`

Prerequisites:
* Business or a higher plan.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;past&#x60; - Past meetings.&lt;br&gt;&#x60;live&#x60; - Live Meetings. (default to live)

  • :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 exceed the current page size. The expiration period for this token is 15 minutes.

Returns:

  • (InlineResponse20028) 


558
559
560
561
 
# File 'lib/zoom_us/dashboards.rb', line 558

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

#dashboard_meeting_participant_share_with_http_info(meeting_id, opts = {}) ⇒ Array<(InlineResponse20028, Fixnum, Hash)>

Get Sharing/Recording Details of Meeting Participants Retrieve the sharing and recording details of participants from live or past meetings.&lt;br&gt;&lt;br&gt; You can specify a monthly date range for the dashboard data using the &#x60;from&#x60; and &#x60;to&#x60; query parameters. The month should fall within the last six months.&lt;br&gt; Scopes: &#x60;dashboard:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: &lt;br&gt; * Business or a higher plan.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;past&#x60; - Past meetings.&lt;br&gt;&#x60;live&#x60; - Live Meetings.

  • :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 exceed the current page size. The expiration period for this token is 15 minutes.

Returns:

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

    InlineResponse20028 data, response status code and response headers



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
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/zoom_us/dashboards.rb', line 571

def dashboard_meeting_participant_share_with_http_info(meeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsApi.dashboard_meeting_participant_share ...'
  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 DashboardsApi.dashboard_meeting_participant_share"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['past', 'pastOne', 'live'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of past, pastOne, live'
  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 DashboardsApi.dashboard_meeting_participant_share, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/metrics/meetings/{meetingId}/participants/sharing'.sub('{' + 'meetingId' + '}', meeting_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[:'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 => 'InlineResponse20028')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsApi#dashboard_meeting_participant_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#dashboard_meeting_participants(meeting_id, opts = {}) ⇒ InlineResponse20027

List Meeting Participants Get a list of participants from live or past meetings.
If you do not provide the ‘type` query parameter, the default value will be set to `live` and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for `type`.
You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. Scopes: `dashboard_meetings:read:admin`

Prerequisites: Business or a higher plan.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;past&#x60; - Past meetings.&lt;br&gt;&#x60;pastOne&#x60; - Past one user meetings.&lt;br&gt;&#x60;live&#x60; - Live meetings. (default to live)

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

  • (InlineResponse20027) 


628
629
630
631
 
# File 'lib/zoom_us/dashboards.rb', line 628

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

#dashboard_meeting_participants_qos(meeting_id, opts = {}) ⇒ ParticipantQOSList

List Meeting Participants QOS Get a list of meeting participants from live or past meetings along with the quality of service they recieve during the meeting such as connection quality for sending/receiving video, audio, and shared content.
If you do not provide the ‘type` query parameter, the default value will be set to `live` and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for `type`.

You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. Scopes: `dashboard_meetings:read:admin`

Prerequisites:
* Business or a higher plan.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;past&#x60; - Past meetings.&lt;br&gt;&#x60;live&#x60; - Live Meetings. (default to live)

  • :page_size (Integer) —

    The number of items returned per page. (default to 1)

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

  • (ParticipantQOSList) 


698
699
700
701
 
# File 'lib/zoom_us/dashboards.rb', line 698

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

#dashboard_meeting_participants_qos_with_http_info(meeting_id, opts = {}) ⇒ Array<(ParticipantQOSList, Fixnum, Hash)>

List Meeting Participants QOS Get a list of meeting participants from live or past meetings along with the quality of service they recieve during the meeting such as connection quality for sending/receiving video, audio, and shared content.&lt;br&gt;If you do not provide the &#x60;type&#x60; query parameter, the default value will be set to &#x60;live&#x60; and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for &#x60;type&#x60;.&lt;br&gt; &lt;br&gt; You can specify a monthly date range for the dashboard data using the &#x60;from&#x60; and &#x60;to&#x60; query parameters. The month should fall within the last six months. Scopes: &#x60;dashboard_meetings:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: &lt;br&gt; * Business or a higher plan.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;past&#x60; - Past meetings.&lt;br&gt;&#x60;live&#x60; - Live Meetings.

  • :page_size (Integer) —

    The number of items returned per page.

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

    ParticipantQOSList data, response status code and response headers



711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
 
# File 'lib/zoom_us/dashboards.rb', line 711

def dashboard_meeting_participants_qos_with_http_info(meeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsApi.dashboard_meeting_participants_qos ...'
  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 DashboardsApi.dashboard_meeting_participants_qos"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['past', 'pastOne', 'live'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of past, pastOne, live'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling DashboardsApi.dashboard_meeting_participants_qos, must be smaller than or equal to 10.'
  end

  # resource path
  local_var_path = '/metrics/meetings/{meetingId}/participants/qos'.sub('{' + 'meetingId' + '}', meeting_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[:'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 => 'ParticipantQOSList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsApi#dashboard_meeting_participants_qos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#dashboard_meeting_participants_with_http_info(meeting_id, opts = {}) ⇒ Array<(InlineResponse20027, Fixnum, Hash)>

List Meeting Participants Get a list of participants from live or past meetings.&lt;br&gt;&lt;br&gt; If you do not provide the &#x60;type&#x60; query parameter, the default value will be set to &#x60;live&#x60; and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for &#x60;type&#x60;. &lt;br&gt; You can specify a monthly date range for the dashboard data using the &#x60;from&#x60; and &#x60;to&#x60; query parameters. The month should fall within the last six months. Scopes: &#x60;dashboard_meetings:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: Business or a higher plan.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;past&#x60; - Past meetings.&lt;br&gt;&#x60;pastOne&#x60; - Past one user meetings.&lt;br&gt;&#x60;live&#x60; - Live meetings.

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

    InlineResponse20027 data, response status code and response headers



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

def dashboard_meeting_participants_with_http_info(meeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsApi.dashboard_meeting_participants ...'
  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 DashboardsApi.dashboard_meeting_participants"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['past', 'pastOne', 'live'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of past, pastOne, live'
  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 DashboardsApi.dashboard_meeting_participants, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/metrics/meetings/{meetingId}/participants'.sub('{' + 'meetingId' + '}', meeting_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[:'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 => 'InlineResponse20027')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsApi#dashboard_meeting_participants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#dashboard_meetings(from, to, opts = {}) ⇒ InlineResponse20026

List Meetings List total live or past meetings that occurred during a specified period of time. This overview will show if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account.
You can specify a monthly date range for the dashboard data using the ‘from` and `to` query parameters. The month should fall within the last six months.
Scopes: `dashboard_meetings:read:admin`
Prerequisites:
* Business or a higher plan.

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;past&#x60; - Past meetings.&lt;br&gt;&#x60;pastOne&#x60; - Past one user meetings. &lt;br&gt;&#x60;live&#x60; - Live meetings. (default to live)

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

  • (InlineResponse20026) 


769
770
771
772
 
# File 'lib/zoom_us/dashboards.rb', line 769

def dashboard_meetings(from, to, opts = {})
  data, _status_code, _headers = dashboard_meetings_with_http_info(from, to, opts)
  data
end

#dashboard_meetings_with_http_info(from, to, opts = {}) ⇒ Array<(InlineResponse20026, Fixnum, Hash)>

List Meetings List total live or past meetings that occurred during a specified period of time. This overview will show if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account.&lt;br&gt; You can specify a monthly date range for the dashboard data using the &#x60;from&#x60; and &#x60;to&#x60; query parameters. The month should fall within the last six months.&lt;br&gt; Scopes: &#x60;dashboard_meetings:read:admin&#x60;&lt;br&gt; Prerequisites: &lt;br&gt; * Business or a higher plan.&lt;br&gt;&lt;br&gt;

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;past&#x60; - Past meetings.&lt;br&gt;&#x60;pastOne&#x60; - Past one user meetings. &lt;br&gt;&#x60;live&#x60; - Live meetings.

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

    InlineResponse20026 data, response status code and response headers



783
784
785
786
787
788
789
790
791
792
793
794
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
 
# File 'lib/zoom_us/dashboards.rb', line 783

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

  # resource path
  local_var_path = '/metrics/meetings'

  # query parameters
  query_params = {}
  query_params[:'from'] = from
  query_params[:'to'] = to
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page_token'] = opts[:'next_page_token'] if !opts[:'next_page_token'].nil?

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

  # form parameters
  form_params = {}

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

#dashboard_webinar_detail(webinar_id, opts = {}) ⇒ WebinarMetrics

Get Webinar Details Retrieve details from live or past webinars.
Scopes: ‘dashboard:read:admin`

Prerequisites:
* Business, Education or API Plan with Webinar add-on.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The webinar type. (default to live)

Returns:

  • (WebinarMetrics) 


844
845
846
847
 
# File 'lib/zoom_us/dashboards.rb', line 844

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

#dashboard_webinar_detail_with_http_info(webinar_id, opts = {}) ⇒ Array<(WebinarMetrics, Fixnum, Hash)>

Get Webinar Details Retrieve details from live or past webinars.&lt;br&gt;&lt;br&gt; Scopes: &#x60;dashboard:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Business, Education or API Plan with Webinar add-on.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The webinar type.

Returns:

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

    WebinarMetrics data, response status code and response headers



855
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/dashboards.rb', line 855

def dashboard_webinar_detail_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsApi.dashboard_webinar_detail ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling DashboardsApi.dashboard_webinar_detail"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['past', 'live'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of past, live'
  end
  # resource path
  local_var_path = '/metrics/webinars/{webinarId}'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = 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 => 'WebinarMetrics')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsApi#dashboard_webinar_detail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#dashboard_webinar_participant_qos(webinar_id, participant_id, opts = {}) ⇒ ParticipantQOS

Get Webinar Participant QOS Retrieve details on the quality of service that participants from live or past webinars recieved.
This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.
Scopes: ‘dashboard:read:admin`

Prerequisites:
* Business, Education or API Plan with Zoom Rooms set up.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

  • participant_id —

    Participant ID.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The webinar type. (default to live)

Returns:

  • (ParticipantQOS) 


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

def dashboard_webinar_participant_qos(webinar_id, participant_id, opts = {})
  data, _status_code, _headers = dashboard_webinar_participant_qos_with_http_info(webinar_id, participant_id, opts)
  data
end

#dashboard_webinar_participant_qos_with_http_info(webinar_id, participant_id, opts = {}) ⇒ Array<(ParticipantQOS, Fixnum, Hash)>

Get Webinar Participant QOS Retrieve details on the quality of service that participants from live or past webinars recieved.&lt;br&gt;This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.&lt;br&gt; Scopes: &#x60;dashboard:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: &lt;br&gt; * Business, Education or API Plan with Zoom Rooms set up.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

  • participant_id —

    Participant ID.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The webinar type.

Returns:

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

    ParticipantQOS data, 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
960
961
962
963
 
# File 'lib/zoom_us/dashboards.rb', line 917

def dashboard_webinar_participant_qos_with_http_info(webinar_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsApi.dashboard_webinar_participant_qos ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling DashboardsApi.dashboard_webinar_participant_qos"
  end
  # verify the required parameter 'participant_id' is set
  if @api_client.config.client_side_validation && participant_id.nil?
    fail ArgumentError, "Missing the required parameter 'participant_id' when calling DashboardsApi.dashboard_webinar_participant_qos"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['past', 'live'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of past, live'
  end
  # resource path
  local_var_path = '/metrics/webinars/{webinarId}/participants/{participantId}/qos'.sub('{' + 'webinarId' + '}', webinar_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = 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 => 'ParticipantQOS')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsApi#dashboard_webinar_participant_qos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#dashboard_webinar_participant_share(webinar_id, opts = {}) ⇒ InlineResponse20028

Get Sharing/Recording Details of Webinar Participants Retrieve the sharing and recording details of participants from live or past webinars.
Scopes: ‘dashboard:read:admin`

Prerequisites:
* Business, Education or API Plan with Webinar add-on.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The webinar type. (default to live)

  • :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 exceed the current page size. The expiration period for this token is 15 minutes.

Returns:

  • (InlineResponse20028) 


972
973
974
975
 
# File 'lib/zoom_us/dashboards.rb', line 972

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

#dashboard_webinar_participant_share_with_http_info(webinar_id, opts = {}) ⇒ Array<(InlineResponse20028, Fixnum, Hash)>

Get Sharing/Recording Details of Webinar Participants Retrieve the sharing and recording details of participants from live or past webinars. &lt;br&gt;&lt;br&gt; Scopes: &#x60;dashboard:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Business, Education or API Plan with Webinar add-on.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The webinar type.

  • :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 exceed the current page size. The expiration period for this token is 15 minutes.

Returns:

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

    InlineResponse20028 data, response status code and response headers



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
1033
 
# File 'lib/zoom_us/dashboards.rb', line 985

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

  # resource path
  local_var_path = '/metrics/webinars/{webinarId}/participants/sharing'.sub('{' + 'webinarId' + '}', webinar_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[:'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 => 'InlineResponse20028')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsApi#dashboard_webinar_participant_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#dashboard_webinar_participants(webinar_id, opts = {}) ⇒ InlineResponse20030

Get Webinar Participants Retrieve details on participants from live or past webinars.
Scopes: ‘dashboard:read:admin`

Prerequisites:
* Business, Education or API Plan with Webinar add-on.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The webinar type. (default to live)

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

  • (InlineResponse20030) 


1042
1043
1044
1045
 
# File 'lib/zoom_us/dashboards.rb', line 1042

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

#dashboard_webinar_participants_qos(webinar_id, opts = {}) ⇒ ParticipantQOSList

List Webinar Participant QOS Retrieve a list of participants from live or past webinars and the quality of service they received.
This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.
Scopes: ‘dashboard:read:admin`

Prerequisites: * Business, Education or API Plan with Webinar add-on.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The webinar type. (default to live)

  • :page_size (Integer) —

    The number of items returned per page. (default to 1)

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

  • (ParticipantQOSList) 


1112
1113
1114
1115
 
# File 'lib/zoom_us/dashboards.rb', line 1112

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

#dashboard_webinar_participants_qos_with_http_info(webinar_id, opts = {}) ⇒ Array<(ParticipantQOSList, Fixnum, Hash)>

List Webinar Participant QOS Retrieve a list of participants from live or past webinars and the quality of service they received.&lt;br&gt;This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.&lt;br&gt; Scopes: &#x60;dashboard:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: * Business, Education or API Plan with Webinar add-on.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The webinar type.

  • :page_size (Integer) —

    The number of items returned per page.

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

    ParticipantQOSList data, response status code and response headers



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/zoom_us/dashboards.rb', line 1125

def dashboard_webinar_participants_qos_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsApi.dashboard_webinar_participants_qos ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling DashboardsApi.dashboard_webinar_participants_qos"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['past', 'live'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of past, live'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling DashboardsApi.dashboard_webinar_participants_qos, must be smaller than or equal to 10.'
  end

  # resource path
  local_var_path = '/metrics/webinars/{webinarId}/participants/qos'.sub('{' + 'webinarId' + '}', webinar_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[:'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 => 'ParticipantQOSList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsApi#dashboard_webinar_participants_qos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#dashboard_webinar_participants_with_http_info(webinar_id, opts = {}) ⇒ Array<(InlineResponse20030, Fixnum, Hash)>

Get Webinar Participants Retrieve details on participants from live or past webinars.&lt;br&gt;&lt;br&gt; Scopes: &#x60;dashboard:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Business, Education or API Plan with Webinar add-on.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The webinar type.

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

    InlineResponse20030 data, response status code and response headers



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
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
 
# File 'lib/zoom_us/dashboards.rb', line 1055

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

  # resource path
  local_var_path = '/metrics/webinars/{webinarId}/participants'.sub('{' + 'webinarId' + '}', webinar_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[:'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 => 'InlineResponse20030')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DashboardsApi#dashboard_webinar_participants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#dashboard_webinars(from, to, opts = {}) ⇒ InlineResponse20029

List Webinars List all the live or past webinars from a specified period of time.
Scopes: ‘dashboard:read:admin`
Prerequisites:
* Business, Education or API Plan with Webinar add-on.

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The webinar type. (default to live)

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

  • (InlineResponse20029) 


1183
1184
1185
1186
 
# File 'lib/zoom_us/dashboards.rb', line 1183

def dashboard_webinars(from, to, opts = {})
  data, _status_code, _headers = dashboard_webinars_with_http_info(from, to, opts)
  data
end

#dashboard_webinars_with_http_info(from, to, opts = {}) ⇒ Array<(InlineResponse20029, Fixnum, Hash)>

List Webinars List all the live or past webinars from a specified period of time. &lt;br&gt;&lt;br&gt; Scopes: &#x60;dashboard:read:admin&#x60;&lt;br&gt; Prerequisites:&lt;br&gt; * Business, Education or API Plan with Webinar add-on.

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The webinar type.

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

    InlineResponse20029 data, response status code and response headers



1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
 
# File 'lib/zoom_us/dashboards.rb', line 1197

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

  # resource path
  local_var_path = '/metrics/webinars'

  # query parameters
  query_params = {}
  query_params[:'from'] = from
  query_params[:'to'] = to
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page_token'] = opts[:'next_page_token'] if !opts[:'next_page_token'].nil?

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

  # form parameters
  form_params = {}

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

#dashboard_zoom_room(zoomroom_id, from, to, opts = {}) ⇒ Object

Get Zoom Rooms Details The Zoom Rooms dashboard metrics lets you know the type of configuration a Zoom room has and details on the meetings held in that room. Use this API to retrieve information on a specific room.
Scopes: ‘dashboard_zr:read:admin`

Prerequisites:
* Business, Education or API Plan with Zoom Rooms set up.

Parameters:

  • zoomroom_id —

    The Zoom room ID.

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

  • (Object) 


1261
1262
1263
1264
 
# File 'lib/zoom_us/dashboards.rb', line 1261

def dashboard_zoom_room(zoomroom_id, from, to, opts = {})
  data, _status_code, _headers = dashboard_zoom_room_with_http_info(zoomroom_id, from, to, opts)
  data
end

#dashboard_zoom_room_issue(from, to, opts = {}) ⇒ Object

Get Top 25 issues of Zoom Rooms Get Top 25 issues of Zoom Rooms.
Scopes: ‘dashboard_zr:read:admin`

Prerequisites:
* Business, Education or API Plan with Zoom Rooms set up.

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

    the optional parameters

Returns:

  • (Object) 


1336
1337
1338
1339
 
# File 'lib/zoom_us/dashboards.rb', line 1336

def dashboard_zoom_room_issue(from, to, opts = {})
  data, _status_code, _headers = dashboard_zoom_room_issue_with_http_info(from, to, opts)
  data
end

#dashboard_zoom_room_issue_with_http_info(from, to, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Get Top 25 issues of Zoom Rooms Get Top 25 issues of Zoom Rooms.&lt;br&gt; Scopes: &#x60;dashboard_zr:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Business, Education or API Plan with Zoom Rooms set up.

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



1347
1348
1349
1350
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
 
# File 'lib/zoom_us/dashboards.rb', line 1347

def dashboard_zoom_room_issue_with_http_info(from, to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsApi.dashboard_zoom_room_issue ...'
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling DashboardsApi.dashboard_zoom_room_issue"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling DashboardsApi.dashboard_zoom_room_issue"
  end
  # resource path
  local_var_path = '/metrics/zoomrooms/issues'

  # query parameters
  query_params = {}
  query_params[:'from'] = from
  query_params[:'to'] = to

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

#dashboard_zoom_room_with_http_info(zoomroom_id, from, to, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Get Zoom Rooms Details The Zoom Rooms dashboard metrics lets you know the type of configuration a Zoom room has and details on the meetings held in that room. Use this API to retrieve information on a specific room.&lt;br&gt;&lt;br&gt; Scopes: &#x60;dashboard_zr:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Business, Education or API Plan with Zoom Rooms set up.

Parameters:

  • zoomroom_id —

    The Zoom room ID.

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

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

    Object data, response status code and response headers



1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
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
 
# File 'lib/zoom_us/dashboards.rb', line 1275

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

  # resource path
  local_var_path = '/metrics/zoomrooms/{zoomroomId}'.sub('{' + 'zoomroomId' + '}', zoomroom_id.to_s)

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

#dashboard_zoom_rooms(opts = {}) ⇒ ZoomRoomList

List Zoom Rooms List information on all Zoom Rooms in an account.
Scopes: ‘dashboard_zr:read:admin` Prerequisites:
* Business, Education or API Plan with Zoom Rooms set up.

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:

  • (ZoomRoomList) 


1398
1399
1400
1401
 
# File 'lib/zoom_us/dashboards.rb', line 1398

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

#dashboard_zoom_rooms_with_http_info(opts = {}) ⇒ Array<(ZoomRoomList, Fixnum, Hash)>

List Zoom Rooms List information on all Zoom Rooms in an account.&lt;br&gt;&lt;br&gt; Scopes: &#x60;dashboard_zr:read:admin&#x60; Prerequisites:&lt;br&gt; * Business, Education or API Plan with Zoom Rooms set up.

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<(ZoomRoomList, Fixnum, Hash)>) —

    ZoomRoomList data, response status code and response headers



1409
1410
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/dashboards.rb', line 1409

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

  # resource path
  local_var_path = '/metrics/zoomrooms'

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

#list_meeting_satisfaction(opts = {}) ⇒ InlineResponse20087

List Client Meeting Satisfaction If the [End of Meeting Feedback Survey](support.zoom.us/hc/en-us/articles/115005855266) option is enabled, attendees will be prompted with a survey window where they can tap either the **Thumbs Up** or **Thumbs Down** button that indicates their Zoom meeting experience. With this API, you can get information on the attendees’ meeting satisfaction. Specify a monthly date range for the query using the from and to query parameters. The month should fall within the last six months. To get information on the survey results with negative experiences (indicated by **Thumbs Down**), use the [Get Zoom Meetings Client Feedback API](marketplace.zoom.us/docs/api-reference/zoom-api/dashboards/dashboardclientfeedbackdetail).
Scopes: ‘dashboard:read:admin`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Date) —

    The start date for the query in “yyyy-mm-dd” format.

  • :to (Date) —

    The end date for the query in “yyyy-mm-dd” format.

Returns:

  • (InlineResponse20087) 


1456
1457
1458
1459
 
# File 'lib/zoom_us/dashboards.rb', line 1456

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

#list_meeting_satisfaction_with_http_info(opts = {}) ⇒ Array<(InlineResponse20087, Fixnum, Hash)>

List Client Meeting Satisfaction If the [End of Meeting Feedback Survey](support.zoom.us/hc/en-us/articles/115005855266) option is enabled, attendees will be prompted with a survey window where they can tap either the **Thumbs Up** or **Thumbs Down** button that indicates their Zoom meeting experience. With this API, you can get information on the attendees&#39; meeting satisfaction. Specify a monthly date range for the query using the from and to query parameters. The month should fall within the last six months. To get information on the survey results with negative experiences (indicated by **Thumbs Down**), use the [Get Zoom Meetings Client Feedback API](marketplace.zoom.us/docs/api-reference/zoom-api/dashboards/dashboardclientfeedbackdetail).&lt;br&gt; Scopes: &#x60;dashboard:read:admin&#x60;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Date) —

    The start date for the query in “yyyy-mm-dd” format.

  • :to (Date) —

    The end date for the query in “yyyy-mm-dd” format.

Returns:

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

    InlineResponse20087 data, response status code and response headers



1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
 
# File 'lib/zoom_us/dashboards.rb', line 1467

def list_meeting_satisfaction_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsApi.list_meeting_satisfaction ...'
  end
  # resource path
  local_var_path = '/metrics/client/satisfaction'

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