:py:mod:`vendor_fabric.zoom` ============================ .. py:module:: vendor_fabric.zoom .. autodoc2-docstring:: vendor_fabric.zoom :parser: myst :allowtitles: Submodules ---------- .. toctree:: :titlesonly: :maxdepth: 1 vendor_fabric.zoom.tools Package Contents ---------------- Classes ~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`ZoomConnector ` - .. autodoc2-docstring:: vendor_fabric.zoom.ZoomConnector :parser: myst :summary: Data ~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`DEFAULT_REQUEST_TIMEOUT ` - .. autodoc2-docstring:: vendor_fabric.zoom.DEFAULT_REQUEST_TIMEOUT :parser: myst :summary: API ~~~ .. py:data:: DEFAULT_REQUEST_TIMEOUT :canonical: vendor_fabric.zoom.DEFAULT_REQUEST_TIMEOUT :value: 30 .. autodoc2-docstring:: vendor_fabric.zoom.DEFAULT_REQUEST_TIMEOUT :parser: myst .. py:class:: ZoomConnector(client_id: str | None = None, client_secret: str | None = None, account_id: str | None = None, logger: extended_data.logging.Logging | None = None, **kwargs: typing.Any) :canonical: vendor_fabric.zoom.ZoomConnector Bases: :py:obj:`vendor_fabric.base.ConnectorBase` .. autodoc2-docstring:: vendor_fabric.zoom.ZoomConnector :parser: myst .. rubric:: Initialization .. autodoc2-docstring:: vendor_fabric.zoom.ZoomConnector.__init__ :parser: myst .. py:method:: get_access_token() -> str | None :canonical: vendor_fabric.zoom.ZoomConnector.get_access_token .. autodoc2-docstring:: vendor_fabric.zoom.ZoomConnector.get_access_token :parser: myst .. py:method:: get_headers() -> dict[str, str] :canonical: vendor_fabric.zoom.ZoomConnector.get_headers .. autodoc2-docstring:: vendor_fabric.zoom.ZoomConnector.get_headers :parser: myst .. py:method:: list_users() -> extended_data.containers.ExtendedDict :canonical: vendor_fabric.zoom.ZoomConnector.list_users .. autodoc2-docstring:: vendor_fabric.zoom.ZoomConnector.list_users :parser: myst .. py:method:: remove_zoom_user(email: str) -> None :canonical: vendor_fabric.zoom.ZoomConnector.remove_zoom_user .. autodoc2-docstring:: vendor_fabric.zoom.ZoomConnector.remove_zoom_user :parser: myst .. py:method:: create_zoom_user(email: str, first_name: str, last_name: str) -> bool :canonical: vendor_fabric.zoom.ZoomConnector.create_zoom_user .. autodoc2-docstring:: vendor_fabric.zoom.ZoomConnector.create_zoom_user :parser: myst .. py:method:: get_user(user_id: str) -> extended_data.containers.ExtendedDict :canonical: vendor_fabric.zoom.ZoomConnector.get_user .. autodoc2-docstring:: vendor_fabric.zoom.ZoomConnector.get_user :parser: myst .. py:method:: list_meetings(user_id: str, meeting_type: str = 'scheduled') -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedDict] :canonical: vendor_fabric.zoom.ZoomConnector.list_meetings .. autodoc2-docstring:: vendor_fabric.zoom.ZoomConnector.list_meetings :parser: myst .. py:method:: get_meeting(meeting_id: str) -> extended_data.containers.ExtendedDict :canonical: vendor_fabric.zoom.ZoomConnector.get_meeting .. autodoc2-docstring:: vendor_fabric.zoom.ZoomConnector.get_meeting :parser: myst .. py:attribute:: BASE_URL :canonical: vendor_fabric.zoom.ZoomConnector.BASE_URL :type: typing.ClassVar[str] :value: .. py:attribute:: API_KEY_ENV :canonical: vendor_fabric.zoom.ZoomConnector.API_KEY_ENV :type: typing.ClassVar[str] :value: .. py:attribute:: CONNECTOR_CATEGORY :canonical: vendor_fabric.zoom.ZoomConnector.CONNECTOR_CATEGORY :type: typing.ClassVar[str] :value: 'external' .. py:attribute:: CONNECTOR_CAPABILITIES :canonical: vendor_fabric.zoom.ZoomConnector.CONNECTOR_CAPABILITIES :type: typing.ClassVar[tuple[str, ...]] :value: () .. py:attribute:: TIMEOUT :canonical: vendor_fabric.zoom.ZoomConnector.TIMEOUT :type: typing.ClassVar[float] :value: 300.0 .. py:attribute:: MIN_REQUEST_INTERVAL :canonical: vendor_fabric.zoom.ZoomConnector.MIN_REQUEST_INTERVAL :type: typing.ClassVar[float] :value: 0.0 .. py:attribute:: MAX_RETRIES :canonical: vendor_fabric.zoom.ZoomConnector.MAX_RETRIES :type: typing.ClassVar[int] :value: 5 .. py:property:: api_key :canonical: vendor_fabric.zoom.ZoomConnector.api_key :type: str .. py:property:: client :canonical: vendor_fabric.zoom.ZoomConnector.client :type: httpx.Client .. py:method:: close() -> None :canonical: vendor_fabric.zoom.ZoomConnector.close .. py:method:: request(method: str, endpoint: str, *, headers: dict[str, str] | None = None, **kwargs: typing.Any) -> httpx.Response :canonical: vendor_fabric.zoom.ZoomConnector.request .. py:method:: decode_response(response: httpx.Response, *, suffix: str | None = None, as_extended: bool = True) -> typing.Any :canonical: vendor_fabric.zoom.ZoomConnector.decode_response .. py:method:: decode_response_file(response: httpx.Response, *, source: str | None = None, suffix: str | None = None, as_extended: bool = True, metadata: collections.abc.Mapping[str, typing.Any] | None = None) -> extended_data.io.DataFile :canonical: vendor_fabric.zoom.ZoomConnector.decode_response_file .. py:method:: extend_result(value: typing.Any) -> typing.Any :canonical: vendor_fabric.zoom.ZoomConnector.extend_result .. py:method:: request_data(method: str, endpoint: str, *, headers: dict[str, str] | None = None, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any :canonical: vendor_fabric.zoom.ZoomConnector.request_data .. py:method:: request_data_file(method: str, endpoint: str, *, headers: dict[str, str] | None = None, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.io.DataFile :canonical: vendor_fabric.zoom.ZoomConnector.request_data_file .. py:method:: request_workflow(method: str, endpoint: str, *, headers: dict[str, str] | None = None, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow :canonical: vendor_fabric.zoom.ZoomConnector.request_workflow .. py:method:: get(endpoint: str, **kwargs: typing.Any) -> httpx.Response :canonical: vendor_fabric.zoom.ZoomConnector.get .. py:method:: get_data(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any :canonical: vendor_fabric.zoom.ZoomConnector.get_data .. py:method:: get_workflow(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow :canonical: vendor_fabric.zoom.ZoomConnector.get_workflow .. py:method:: post(endpoint: str, **kwargs: typing.Any) -> httpx.Response :canonical: vendor_fabric.zoom.ZoomConnector.post .. py:method:: post_data(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any :canonical: vendor_fabric.zoom.ZoomConnector.post_data .. py:method:: post_workflow(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow :canonical: vendor_fabric.zoom.ZoomConnector.post_workflow .. py:method:: put(endpoint: str, **kwargs: typing.Any) -> httpx.Response :canonical: vendor_fabric.zoom.ZoomConnector.put .. py:method:: put_data(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any :canonical: vendor_fabric.zoom.ZoomConnector.put_data .. py:method:: put_workflow(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow :canonical: vendor_fabric.zoom.ZoomConnector.put_workflow .. py:method:: delete(endpoint: str, **kwargs: typing.Any) -> httpx.Response :canonical: vendor_fabric.zoom.ZoomConnector.delete .. py:method:: delete_data(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any :canonical: vendor_fabric.zoom.ZoomConnector.delete_data .. py:method:: delete_workflow(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow :canonical: vendor_fabric.zoom.ZoomConnector.delete_workflow .. py:method:: patch(endpoint: str, **kwargs: typing.Any) -> httpx.Response :canonical: vendor_fabric.zoom.ZoomConnector.patch .. py:method:: patch_data(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> typing.Any :canonical: vendor_fabric.zoom.ZoomConnector.patch_data .. py:method:: patch_workflow(endpoint: str, *, suffix: str | None = None, as_extended: bool = True, **kwargs: typing.Any) -> extended_data.workflows.DataWorkflow :canonical: vendor_fabric.zoom.ZoomConnector.patch_workflow .. py:method:: download(url: str, output_path: str) -> int :canonical: vendor_fabric.zoom.ZoomConnector.download .. py:attribute:: vendor_capabilities :canonical: vendor_fabric.zoom.ZoomConnector.vendor_capabilities :type: typing.ClassVar[dict[str, vendor_fabric.capabilities.CapabilitySpec]] :value: None .. py:attribute:: vendor_capability_methods :canonical: vendor_fabric.zoom.ZoomConnector.vendor_capability_methods :type: typing.ClassVar[dict[str, str]] :value: None .. py:method:: get_input(k: str, default: typing.Any | None = None, required: bool = False, is_bool: bool = False, is_integer: bool = False, is_float: bool = False, is_path: bool = False, is_datetime: bool = False, as_extended: bool = False) -> typing.Any :canonical: vendor_fabric.zoom.ZoomConnector.get_input .. py:method:: decode_input(k: str, default: typing.Any | None = None, required: bool = False, decode_from_json: bool = False, decode_from_yaml: bool = False, decode_from_base64: bool = False, allow_none: bool = True, as_extended: bool = False) -> typing.Any :canonical: vendor_fabric.zoom.ZoomConnector.decode_input .. py:method:: freeze_inputs() -> extended_data.containers.mappings.ExtendedDict :canonical: vendor_fabric.zoom.ZoomConnector.freeze_inputs .. py:method:: thaw_inputs() -> extended_data.containers.mappings.ExtendedDict :canonical: vendor_fabric.zoom.ZoomConnector.thaw_inputs .. py:method:: snapshot_inputs(*, frozen: bool = False) -> extended_data.containers.mappings.ExtendedDict :canonical: vendor_fabric.zoom.ZoomConnector.snapshot_inputs .. py:method:: replace_inputs(new_inputs: collections.abc.Mapping[str, typing.Any] | None, *, clear_frozen: bool = True) -> extended_data.containers.mappings.ExtendedDict :canonical: vendor_fabric.zoom.ZoomConnector.replace_inputs .. py:method:: merge_inputs(new_inputs: collections.abc.Mapping[str, typing.Any] | None) -> extended_data.containers.mappings.ExtendedDict :canonical: vendor_fabric.zoom.ZoomConnector.merge_inputs .. py:method:: shift_inputs() -> extended_data.containers.mappings.ExtendedDict :canonical: vendor_fabric.zoom.ZoomConnector.shift_inputs