.. _ref_index_api:

=============
API reference
=============

.. currentmodule:: ansys.openapi.common


This section summarizes OpenAPI-Common public
classes.

.. autosummary::
   :toctree: _autosummary

   ApiClient
   ApiClientFactory
   AuthenticationScheme
   OIDCSessionBuilder
   SessionConfiguration


================
Helper functions
================

This section summarizes OpenAPI-Common helper functions.

.. autosummary::
   :toctree: _autosummary

   generate_user_agent


=======================
Exceptions and warnings
=======================

This section summarizes OpenAPI-Common exceptions and warnings.

.. autosummary::
   :toctree: _autosummary

   ApiException
   ApiConnectionException
   AuthenticationWarning
   UndefinedObjectWarning


============
Type aliases
============
.. currentmodule:: ansys.openapi.common._base

.. autosummary::
   :toctree: _autosummary

   DeserializedType
   SerializedType
   PrimitiveType