Documentação da API
===================

Classes Principais
------------------

Toda a funcionalidade do Conector pode ser acessada através dessas duas classes.

Client
~~~~~~

.. automodule:: rapconector.client
    :members:

Document
~~~~~~~~

.. module:: rapconector.document
.. autoclass:: rapconector.document.Document
    :members:

Tipos de retorno
----------------

As classes abaixo representam os tipos de objetos que são retornados pelo
Conector.

DocumentAuthenticityResult
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentAuthenticityResult
    :members:

DocumentGroup
~~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentGroup
    :members:

DocumentSignature
~~~~~~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentSignature
    :members:

DocumentState
~~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentState
    :members:

DocumentStateChange
~~~~~~~~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentStateChange
    :members:

.. _enumeracoes:

Enumerações
-----------

Enums para facilitar o tratamento de strings e constantes númericas comumente
utilizadas e retornadas pelo Conector.

DocumentProcessingStep
~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentProcessingStep
    :members:

DocumentSignatureState
~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentSignatureState
    :members:

DocumentStateCode
~~~~~~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentStateCode
    :members:

DocumentType
~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentType
    :members:

DocumentVersion
~~~~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentVersion
    :members:

Exceções
--------

Exceções que podem ser levantadas pelos métodos das classes principais.

AuthenticationError
~~~~~~~~~~~~~~~~~~~

.. autoclass:: rapconector.errors.AuthenticationError
    :members:

NotFoundError
~~~~~~~~~~~~~

.. autoclass:: rapconector.errors.NotFoundError
    :members:

ServerError
~~~~~~~~~~~

.. autoclass:: rapconector.errors.ServerError
    :members: