# API Reference

This part of the documentation covers all the interfaces of the DBnomics toolbox.

## `dbnomics_toolbox.fetcher_utils`

```{eval-rst}
.. automodule:: dbnomics_toolbox.fetcher_utils
    :no-members:

Constants
---------

.. automodule:: dbnomics_toolbox.fetcher_utils.constants

Errors
------

.. automodule:: dbnomics_toolbox.fetcher_utils.errors

Source data dir managers
------------------------

.. automodule:: dbnomics_toolbox.fetcher_utils.source_data_dir_managers

Import utilities
----------------

.. automodule:: dbnomics_toolbox.fetcher_utils.import_utils

Logging utilities
-----------------

.. automodule:: dbnomics_toolbox.fetcher_utils.logging_utils

ZIP utilities
-------------

.. automodule:: dbnomics_toolbox.fetcher_utils.zip_utils

CLI utilities
-------------

.. automodule:: dbnomics_toolbox.fetcher_utils.cli_utils.argparse_parsers

.. automodule:: dbnomics_toolbox.fetcher_utils.cli_utils.argparse_configuration

.. automodule:: dbnomics_toolbox.fetcher_utils.cli_utils.base_fetcher_cli

.. automodule:: dbnomics_toolbox.fetcher_utils.cli_utils.download_cli

.. automodule:: dbnomics_toolbox.fetcher_utils.cli_utils.convert_cli

.. automodule:: dbnomics_toolbox.fetcher_utils.cli_utils.factories

.. automodule:: dbnomics_toolbox.fetcher_utils.cli_utils.logging_utils

Fetcher definition
------------------

.. automodule:: dbnomics_toolbox.fetcher_utils.fetcher_definition.base_connector

.. automodule:: dbnomics_toolbox.fetcher_utils.fetcher_definition.protocols

File utilities
--------------

.. automodule:: dbnomics_toolbox.fetcher_utils.file_utils
    :no-members:

.. automodule:: dbnomics_toolbox.fetcher_utils.file_utils.common

.. automodule:: dbnomics_toolbox.fetcher_utils.file_utils.errors

.. automodule:: dbnomics_toolbox.fetcher_utils.file_utils.json_utils

.. automodule:: dbnomics_toolbox.fetcher_utils.file_utils.xml_utils.iterators

.. automodule:: dbnomics_toolbox.fetcher_utils.file_utils.xml_utils.namespace_utils

.. automodule:: dbnomics_toolbox.fetcher_utils.file_utils.xml_utils.parsers

.. automodule:: dbnomics_toolbox.fetcher_utils.file_utils.xml_utils.reformatters

.. automodule:: dbnomics_toolbox.fetcher_utils.file_utils.xml_utils.types

.. automodule:: dbnomics_toolbox.fetcher_utils.file_utils.xml_utils.writers

.. automodule:: dbnomics_toolbox.fetcher_utils.file_utils.xml_utils.xpath_builder

.. automodule:: dbnomics_toolbox.fetcher_utils.file_utils.xml_utils.errors

MIME type utilities
-------------------

.. automodule:: dbnomics_toolbox.fetcher_utils.mimetype

.. automodule:: dbnomics_toolbox.fetcher_utils.mimetype.errors

Partitions
----------

.. automodule:: dbnomics_toolbox.fetcher_utils.partitions
    :no-members:

.. automodule:: dbnomics_toolbox.fetcher_utils.partitions.base_partition

.. automodule:: dbnomics_toolbox.fetcher_utils.partitions.dimension_partition

.. automodule:: dbnomics_toolbox.fetcher_utils.partitions.period_range_partition

.. automodule:: dbnomics_toolbox.fetcher_utils.partitions.range_partition

.. automodule:: dbnomics_toolbox.fetcher_utils.partitions.url_partition

.. automodule:: dbnomics_toolbox.fetcher_utils.partitions.partition_state_repo

.. automodule:: dbnomics_toolbox.fetcher_utils.partitions.errors

Processors
----------

.. automodule:: dbnomics_toolbox.fetcher_utils.processors.base_processor

.. automodule:: dbnomics_toolbox.fetcher_utils.processors.base_downloader

.. automodule:: dbnomics_toolbox.fetcher_utils.processors.base_converter

.. automodule:: dbnomics_toolbox.fetcher_utils.processors.base_dataset_converter

.. automodule:: dbnomics_toolbox.fetcher_utils.processors.protocols

.. automodule:: dbnomics_toolbox.fetcher_utils.processors.downloader_state_repo

.. automodule:: dbnomics_toolbox.fetcher_utils.processors.processor_report

.. automodule:: dbnomics_toolbox.fetcher_utils.processors.skip_reasons

.. automodule:: dbnomics_toolbox.fetcher_utils.processors.logging_utils

.. automodule:: dbnomics_toolbox.fetcher_utils.processors.errors

Resources
---------

.. automodule:: dbnomics_toolbox.fetcher_utils.resources
    :no-members:

.. automodule:: dbnomics_toolbox.fetcher_utils.resources.base_resource

.. automodule:: dbnomics_toolbox.fetcher_utils.resources.file_resource

.. automodule:: dbnomics_toolbox.fetcher_utils.resources.http_resource

.. automodule:: dbnomics_toolbox.fetcher_utils.resources.sdmx_resource

.. automodule:: dbnomics_toolbox.fetcher_utils.resources.resource_group

.. automodule:: dbnomics_toolbox.fetcher_utils.resources.page_resource_group

.. automodule:: dbnomics_toolbox.fetcher_utils.resources.base_partition_group

.. automodule:: dbnomics_toolbox.fetcher_utils.resources.resource_id

.. automodule:: dbnomics_toolbox.fetcher_utils.resources.errors
```

## `dbnomics_toolbox.file_utils`

```{eval-rst}
.. automodule:: dbnomics_toolbox.file_utils
```

## `dbnomics_toolbox.http_utils`

```{eval-rst}
.. automodule:: dbnomics_toolbox.http_utils

HTTP constants
--------------

.. automodule:: dbnomics_toolbox.http_utils.constants

.. autodata:: dbnomics_toolbox.http_utils.constants.DEFAULT_USER_AGENT

Requests helpers
----------------

.. automodule:: dbnomics_toolbox.http_utils.requests.timeouts
```

## `dbnomics_toolbox.io`

```{eval-rst}
.. automodule:: dbnomics_toolbox.io

Parsing
-------

.. automodule:: dbnomics_toolbox.io.parsing

Formats
-------

.. automodule:: dbnomics_toolbox.io.formats

Codecs
------

.. automodule:: dbnomics_toolbox.io.codecs

Protocols
~~~~~~~~~

.. automodule:: dbnomics_toolbox.io.codecs.protocols
```

## `dbnomics_toolbox.model`

```{eval-rst}
.. automodule:: dbnomics_toolbox.model
    :no-members:

Identifiers
-----------

.. automodule:: dbnomics_toolbox.model.identifiers
    :no-members:

.. automodule:: dbnomics_toolbox.model.identifiers.provider_code

.. automodule:: dbnomics_toolbox.model.identifiers.provider_snapshot_id

Entities
--------

.. automodule:: dbnomics_toolbox.model.attributes.attribute

.. automodule:: dbnomics_toolbox.model.attributes.attribute_value

.. automodule:: dbnomics_toolbox.model.attributes.dataset_attributes

.. automodule:: dbnomics_toolbox.model.category_tree.category_tree

.. automodule:: dbnomics_toolbox.model.category_tree.category

.. automodule:: dbnomics_toolbox.model.category_tree.category_tree_node

.. automodule:: dbnomics_toolbox.model.category_tree.dataset_reference

.. automodule:: dbnomics_toolbox.model.dataset_family

.. automodule:: dbnomics_toolbox.model.dataset_metadata

.. automodule:: dbnomics_toolbox.model.dataset_vintage

.. automodule:: dbnomics_toolbox.model.dimensions.dimension

.. automodule:: dbnomics_toolbox.model.dimensions.dimension_role

.. automodule:: dbnomics_toolbox.model.dimensions.dimension_value

.. automodule:: dbnomics_toolbox.model.dimensions.dataset_dimensions

.. automodule:: dbnomics_toolbox.model.errors

.. automodule:: dbnomics_toolbox.model.factories

.. automodule:: dbnomics_toolbox.model.frequency

.. automodule:: dbnomics_toolbox.model.observations.observation

.. automodule:: dbnomics_toolbox.model.observations.observation_collection_services

.. automodule:: dbnomics_toolbox.model.observations.observation_value_range

.. automodule:: dbnomics_toolbox.model.observations.period_domain

.. automodule:: dbnomics_toolbox.model.observations.types

.. automodule:: dbnomics_toolbox.model.provider_metadata

.. automethod:: dbnomics_toolbox.model.provider_metadata.ProviderMetadata.__init__

.. automodule:: dbnomics_toolbox.model.provider_snapshot

.. automodule:: dbnomics_toolbox.model.series

.. automodule:: dbnomics_toolbox.model.series_dimensions

.. automodule:: dbnomics_toolbox.model.series_metadata

.. automodule:: dbnomics_toolbox.model.url

.. autodata:: dbnomics_toolbox.model.url.Url

Periods
-------

.. automodule:: dbnomics_toolbox.model.periods
```

## `dbnomics_toolbox.retry_utils`

```{eval-rst}
.. automodule:: dbnomics_toolbox.retry_utils

Run
---

.. automodule:: dbnomics_toolbox.retry_utils.run

Requests
--------

.. automodule:: dbnomics_toolbox.retry_utils.requests
```

## `dbnomics_toolbox.sdmx_utils`

```{eval-rst}
.. automodule:: dbnomics_toolbox.sdmx_utils
    :no-members:

SDMX 2.1
--------

.. automodule:: dbnomics_toolbox.sdmx_utils.v2_1

SDMX 2.1 directory manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: dbnomics_toolbox.sdmx_utils.v2_1.sdmx_dir_manager

SDMX 2.1 normalization utils
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: dbnomics_toolbox.sdmx_utils.v2_1.normalization_utils

SDMX 2.1 processors
~~~~~~~~~~~~~~~~~~~

.. automodule:: dbnomics_toolbox.sdmx_utils.v2_1.processors

SDMX 2.1 model
~~~~~~~~~~~~~~

.. automodule:: dbnomics_toolbox.sdmx_utils.v2_1.model
```

## `dbnomics_toolbox.storage`

```{eval-rst}
Storage interface
-----------------

.. automodule:: dbnomics_toolbox.storage

File-system adapter
-------------------

.. automodule:: dbnomics_toolbox.storage.adapters.filesystem
.. automodule:: dbnomics_toolbox.storage.adapters.filesystem.model
```

## `dbnomics_toolbox.validation`

```{eval-rst}
Types
-----

.. automodule:: dbnomics_toolbox.validation.types

Protocols
---------

.. automodule:: dbnomics_toolbox.validation.protocols

Validators
----------

.. automodule:: dbnomics_toolbox.validation.validators

Walkers
-------

.. automodule:: dbnomics_toolbox.validation.walkers
```