####
Zoom
####

Overview
========

`Zoom <https://www.zoom.com>`__ is a video conferencing platform. This connector supports
fetching users, fetching meetings, fetching metadata for past meetings, and fetching
participants of past meetings via the `Zoom API <https://developers.zoom.us/docs/api/>`__.

.. admonition:: Authentication

   The :class:`~parsons.zoom.zoom.Zoom` class uses server-to-server
   `Zoom Server-to-Server OAuth <https://developers.zoom.us/docs/internal-apps/s2s-oauth/>`__
   to authenticate queries to the Zoom API. You must create a server-to-server application at
   `Zoom App Marketplace - Create App <https://marketplace.zoom.us/develop/create>`__ to obtain an
   ``account_id``, ``client_id``, and ``client_secret`` key.
   You will use this OAuth application to define your scopes,
   which gives your ``Zoom`` connector read permission
   on endpoints of your choosing (`meetings`, `webinars`, `reports`, etc.)

Quickstart
==========

To instantiate the :class:`~parsons.zoom.zoom.Zoom` class,
you can either store your Zoom account ID, client ID, and client secret
as environmental variables (``ZOOM_ACCOUNT_ID``, ``ZOOM_CLIENT_ID``, ``ZOOM_CLIENT_SECRET``)
or pass them in as arguments.

.. code-block:: python
   :caption: Pass credentials via environmental variables

   from parsons import Zoom
   zoom = Zoom(parsons_version="v2")

.. code-block:: python
   :caption: Pass credentials as arguments
   :emphasize-lines: 2-6

   from parsons import Zoom
   zoom = Zoom(
     account_id="my_account_id",
     client_id="my_client_id",
     client_secret="my_client_secret",
     parsons_version="v2",
   )

You can then call class methods:

.. code-block:: python
   :caption: Get a table of host's meetings via their email or user id

   meetings_tbl = zoom.get_meetings('my_name@mail.com')

.. code-block:: python
   :caption: Get the list of participants in a past meeting

   participants_tbl = zoom.get_past_meeting_participants('my_meeting_id')

API
====

.. autoclass:: parsons.zoom.zoom.Zoom
   :inherited-members:
   :members:

.. autoclass:: parsons.zoom.zoom.ZoomV2
   :inherited-members:
   :members:

Legacy API
==========

.. autoclass:: parsons.zoom.zoom.ZoomV1
   :inherited-members:
   :members: