API
===

This section provides detailed documentation for all public APIs in the Online Retail Simulator.

Core Functions
--------------

.. automodule:: online_retail_simulator
   :members:
   :undoc-members:
   :show-inheritance:

Simulation Module
-----------------

.. automodule:: online_retail_simulator.simulate
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:

Products Generation
~~~~~~~~~~~~~~~~~~~

.. automodule:: online_retail_simulator.simulate.products
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: online_retail_simulator.simulate.products_rule_based
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: online_retail_simulator.simulate.products_synthesizer_based
   :members:
   :undoc-members:
   :show-inheritance:

Metrics Generation
~~~~~~~~~~~~~~~~~~

.. automodule:: online_retail_simulator.simulate.metrics
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: online_retail_simulator.simulate.metrics_rule_based
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: online_retail_simulator.simulate.metrics_synthesizer_based
   :members:
   :undoc-members:
   :show-inheritance:

Enrichment Module
-----------------

.. automodule:: online_retail_simulator.enrich
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:

.. automodule:: online_retail_simulator.enrich.enrichment
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: online_retail_simulator.enrich.enrichment_library
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: online_retail_simulator.enrich.enrichment_registry
   :members:
   :undoc-members:
   :show-inheritance:

Configuration Module
--------------------

.. automodule:: online_retail_simulator.config_processor
   :members:
   :undoc-members:
   :show-inheritance: