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

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

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

Client
~~~~~~

.. module:: rapconector.client
.. autoclass:: rapconector.client.Client
    :members:

Document
~~~~~~~~

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

Classes Principais para Documentos Externos
-------------------------------------------

De forma análoga, a funcionalidade do Conector voltada aos diplomas digitais
externos pode ser acessada através da seguinte classe, que tem a API modelada
para ser o mais próximo possível do cliente tradicional:

ExternalClient
~~~~~~~~~~~~~~

.. autoclass:: rapconector.client.ExternalClient
    :members:
    :inherited-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:

DocumentStateChangeTransition
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentStateChangeTransition
    :members:

DocumentValidationResult
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentValidationResult
    :members:

.. _enumeracoes:

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

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

DocumentAuthorizationState
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentAuthorizationState
    :members:

DocumentFormat
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentFormat
    :members:

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

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

DocumentRegistryOrigin
~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentRegistryOrigin
    :members:

DocumentRevocationReason
~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: rapconector.document.DocumentRevocationReason
    :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:

ExternalDocumentType
~~~~~~~~~~~~~~~~~~~~

.. autoclass:: rapconector.document.ExternalDocumentType
    :members:

DocumentRevocationData
~~~~~~~~~~~~~~~~~~~~~~

Deixada por último pois não é exatamente uma classe de enumeração, mas sim uma classe para ajudar a construir os dados de revogação de um documento.

.. autoclass:: rapconector.document.DocumentRevocationData
    :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: