API Reference - Interfaces

Reference documentation for all Interface definitions and protocols.

All documentation is auto-generated from docstrings in the source code.

Data Access

Interface Description
UnitOfWork Unit of Work contract for transaction scopes
SqlDatabase SQL database abstraction interface
SqlRepository Repository interface for SQL backends
ApiRepository Repository interface for REST API backends
SqlMapper SQL mapper interface for model persistence

Model Protocols

Protocol Description
OpenAPIModel Protocol for OpenAPI-generated models
AttrsInstance Protocol for attrs-based model instances
DataclassInstance Protocol for dataclass-based model instances
PydanticInstance Protocol for pydantic-based model instances

Object Manipulation

Interface Description
Updatable Contract for update operations on models
Patchable Contract for patch operations on models

Authentication

Interface Description
Providers Authentication provider interface
TokenFactory Token factory interface

Additional Interfaces

Interface Description
HTTPClient Interface for HTTP client implementations