ds_provider_tripletex_py_lib.enums
==================================

.. py:module:: ds_provider_tripletex_py_lib.enums

.. autoapi-nested-parse::

   **File:** ``enums.py``
   **Region:** ``ds_provider_tripletex_py_lib/enums``

   Constants for the Tripletex provider.

   .. rubric:: Example

   >>> ResourceType.LINKED_SERVICE
   'ds.resource.linked-service.tripletex'
   >>> ResourceType.DATASET
   'ds.resource.dataset.tripletex'
   >>> TripletexProductName.CUSTOMER
   'customer'



Classes
-------

.. autoapisummary::

   ds_provider_tripletex_py_lib.enums.ResourceType
   ds_provider_tripletex_py_lib.enums.OperationType
   ds_provider_tripletex_py_lib.enums.PaginationKind
   ds_provider_tripletex_py_lib.enums.TripletexProductName


Module Contents
---------------

.. py:class:: ResourceType

   Bases: :py:obj:`enum.StrEnum`


   Constants for Tripletex provider resource identifiers.


   .. py:attribute:: LINKED_SERVICE
      :value: 'ds.resource.linked-service.tripletex'



   .. py:attribute:: DATASET
      :value: 'ds.resource.dataset.tripletex'



.. py:class:: OperationType

   Bases: :py:obj:`enum.StrEnum`


   Dataset operations a product's packaged assets may define.

   Only ``READ`` is implemented -- this provider is read-only.


   .. py:attribute:: READ
      :value: 'read'



   .. py:attribute:: CREATE
      :value: 'create'



   .. py:attribute:: UPDATE
      :value: 'update'



   .. py:attribute:: DELETE
      :value: 'delete'



.. py:class:: PaginationKind

   Bases: :py:obj:`enum.StrEnum`


   How a Tripletex product's ``read`` requests are paginated.

   Declared per product in ``assets/<product_name>/read/metadata.json``.


   .. py:attribute:: OFFSET
      :value: 'offset'


      Plain ``from``/``count`` offset pagination -- the default for most entities.


   .. py:attribute:: DATE_WINDOW
      :value: 'date_window'


      Rolling date-window pagination, required by the ``ledger/posting`` endpoint.


.. py:class:: TripletexProductName

   Bases: :py:obj:`enum.StrEnum`


   Tripletex product names available through the Tripletex v2 API.

   Each value names an ``assets/<product_name>/read/metadata.json`` file loaded
   via ``read_info.get_read_info()``, which defines the API path and
   field projection for that product. The ``_lite`` variants read from the
   same endpoint as their full counterpart but project a smaller field set.


   .. py:attribute:: CUSTOMER
      :value: 'customer'



   .. py:attribute:: CUSTOMER_LITE
      :value: 'customer_lite'



   .. py:attribute:: DEPARTMENT
      :value: 'department'



   .. py:attribute:: DEPARTMENT_LITE
      :value: 'department_lite'



   .. py:attribute:: EMPLOYEE
      :value: 'employee'



   .. py:attribute:: EMPLOYEE_LITE
      :value: 'employee_lite'



   .. py:attribute:: LEDGER_ACCOUNT
      :value: 'ledger_account'



   .. py:attribute:: LEDGER_ACCOUNT_LITE
      :value: 'ledger_account_lite'



   .. py:attribute:: LEDGER_POSTING
      :value: 'ledger_posting'



   .. py:attribute:: LEDGER_VAT_TYPE
      :value: 'ledger_vat_type'



   .. py:attribute:: PRODUCT
      :value: 'product'



   .. py:attribute:: PROJECT
      :value: 'project'



   .. py:attribute:: PROJECT_LITE
      :value: 'project_lite'



   .. py:attribute:: SUPPLIER
      :value: 'supplier'



   .. py:attribute:: SUPPLIER_LITE
      :value: 'supplier_lite'



   .. py:attribute:: SUPPLIER_BANK_ACCOUNTS_LITE
      :value: 'supplier_bank_accounts_lite'



   .. py:attribute:: CURRENCY
      :value: 'currency'



   .. py:attribute:: BALANCE_SHEET
      :value: 'balance_sheet'