Welcome to OpenBankProject Client Documentation
=============================================

This library provides a Python client for interacting with the OpenBankProject API. It supports various authentication methods and provides a comprehensive set of features for working with banks, accounts, transactions, and more.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   getting_started/installation
   getting_started/quickstart
   getting_started/authentication
   modules

.. toctree::
   :maxdepth: 2
   :caption: Core Components

   modules/openbankproject_client.client
   modules/openbankproject_client.auth
   modules/openbankproject_client.errors

.. toctree::
   :maxdepth: 2
   :caption: Account Management

   modules/openbankproject_client.extended_account
   modules/openbankproject_client.extended_bank
   modules/openbankproject_client.account_holder
   modules/openbankproject_client.account_metadata
   modules/openbankproject_client.account_public
   modules/openbankproject_client.account_application
   modules/openbankproject_client.account_access

.. toctree::
   :maxdepth: 2
   :caption: Transaction Management

   modules/openbankproject_client.transaction
   modules/openbankproject_client.transaction_metadata
   modules/openbankproject_client.transaction_request
   modules/openbankproject_client.standing_order
   modules/openbankproject_client.direct_debit

.. toctree::
   :maxdepth: 2
   :caption: User Management

   modules/openbankproject_client.user
   modules/openbankproject_client.customer
   modules/openbankproject_client.role
   modules/openbankproject_client.kyc
   modules/openbankproject_client.user_invitation

.. toctree::
   :maxdepth: 2
   :caption: API Management

   modules/openbankproject_client.api_management
   modules/openbankproject_client.api_favorite
   modules/openbankproject_client.api_collection
   modules/openbankproject_client.api_configuration
   modules/openbankproject_client.dynamic_endpoint
   modules/openbankproject_client.dynamic_entity
   modules/openbankproject_client.dynamic_message_doc
   modules/openbankproject_client.dynamic_resource_doc

.. toctree::
   :maxdepth: 2
   :caption: Additional Features

   modules/openbankproject_client.atm
   modules/openbankproject_client.branch
   modules/openbankproject_client.card
   modules/openbankproject_client.consent
   modules/openbankproject_client.counterparty
   modules/openbankproject_client.counterparty_metadata
   modules/openbankproject_client.counterparty_limits
   modules/openbankproject_client.customer_meeting
   modules/openbankproject_client.customer_message
   modules/openbankproject_client.fx
   modules/openbankproject_client.metric
   modules/openbankproject_client.product
   modules/openbankproject_client.scope
   modules/openbankproject_client.view_custom
   modules/openbankproject_client.view_system
   modules/openbankproject_client.webhook
   modules/openbankproject_client.webui_props

.. toctree::
   :maxdepth: 2
   :caption: Examples

   modules/openbankproject_client.examples

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`