Cloud SDK Reference
========================================

The Cloud SDK is part of the ``formant`` Python package. Instantiate a single
client, then use ``admin``, ``query``, and ``ingest`` for API access.

.. highlight:: python
.. code-block:: python

   from formant.sdk.cloud import Client

   client = Client()
   client.query.queries.query(...)
   client.admin.devices.query(...)
   client.ingest_datapoints({"items": [...]})

Authenticate by setting ``FORMANT_EMAIL`` and ``FORMANT_PASSWORD``, or pass
``email`` and ``password`` to ``Client``.

Client
------

.. autoclass:: formant.sdk.cloud.v2.client.Client
   :members:

Admin API
---------

Access admin endpoints via ``client.admin``.

.. autoclass:: formant.sdk.cloud.v2.src.admin_api.AdminAPI
   :members:
   :exclude-members: client, get_client, _resolve_organization_id

Devices
~~~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.devices.devices.Devices
   :members:
   :exclude-members: _get_client

Commands
~~~~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.commands.commands.Commands
   :members:
   :exclude-members: _get_client, _get_organization_id, _resolve_organization_id

Files
~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.files.files.Files
   :members:
   :exclude-members: _get_client, _begin_upload, _complete_upload, _create_etags, _begin_upload_async, _complete_upload_async

Adapters
~~~~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.adapters.adapters.Adapters
   :members:
   :exclude-members: _get_client

Annotations
~~~~~~~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.annotations.annotations.Annotations
   :members:
   :exclude-members: _get_client

Events
~~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.events.events.Events
   :members:
   :exclude-members: _get_client

Views
~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.views.views.Views
   :members:
   :exclude-members: _get_client

Interventions
~~~~~~~~~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.interventions.interventions.Interventions
   :members:
   :exclude-members: _get_client

Organizations
~~~~~~~~~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.organizations.organizations.Organizations
   :members:
   :exclude-members: _get_client

Query API
---------

Access query endpoints via ``client.query``.

.. autoclass:: formant.sdk.cloud.v2.src.query_api.QueryAPI
   :members:

Queries
~~~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.queries.queries.Queries
   :members:
   :exclude-members: _get_client

Stream current value
~~~~~~~~~~~~~~~~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.stream_current.stream_current.StreamCurrent
   :members:
   :exclude-members: _get_client

Metadata
~~~~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.metadata.metadata.Metadata
   :members:
   :exclude-members: _get_client

Online devices
~~~~~~~~~~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.online_devices.online_devices.OnlineDevices
   :members:
   :exclude-members: _get_client

Presence
~~~~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.presence.presence.Presence
   :members:
   :exclude-members: _get_client

Count
~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.count.count.Count
   :members:
   :exclude-members: _get_client

Ingest API
----------

Access ingest endpoints via ``client.ingest``.

.. autoclass:: formant.sdk.cloud.v2.src.ingest_api.IngestAPI
   :members:

Ingest
~~~~~~

.. autoclass:: formant.sdk.cloud.v2.src.resources.ingest.ingest.Ingest
   :members:
   :exclude-members: _get_client