API Reference¶
Auto-generated documentation from source code docstrings.
Core¶
| Module | Description |
|---|---|
| OdooClient | High-level sync client with domain namespaces |
| OdooConfig | Pydantic-based configuration from env variables |
| Transport | Transport abstraction (JSON-2 + legacy JSON-RPC) |
| Exceptions | Exception hierarchy (including Odoo server-side errors) |
Domain Namespaces (Sync)¶
Domain operations are accessed as namespaces on the client (e.g. client.helpdesk.list()).
| Namespace | Odoo Model | Description |
|---|---|---|
client.helpdesk |
helpdesk.ticket |
Helpdesk ticket operations (enterprise) |
client.tasks |
project.task |
Project task operations |
client.projects |
project.project |
Project operations |
client.crm |
crm.lead |
CRM lead/opportunity operations |
client.knowledge |
knowledge.article |
Knowledge article operations (enterprise) |
client.timer |
account.analytic.line |
Timer and timesheet management |
client.generic |
any model | Generic model operations |
client.security |
res.groups / res.users |
Security group management |
Shared¶
| Module | Description |
|---|---|
| Base Operations | Shared CRUD, messaging, attachment helpers (base class for domain namespaces) |
| Auth | Authentication and sudo utilities |
Async API¶
Vodoo provides a full async API via AsyncOdooClient with the same namespace interface as the sync client but using async/await and httpx for non-blocking HTTP.
| Module | Description |
|---|---|
| Async Overview | Quick start, concurrency patterns, AsyncOdooClient |
| Async Helpdesk | AsyncHelpdeskNamespace |
| Async Project Tasks | AsyncTaskNamespace |
| Async Projects | AsyncProjectNamespace |
| Async CRM | AsyncCRMNamespace |
| Async Knowledge | AsyncKnowledgeNamespace |
| Async Timers | AsyncTimerNamespace |
| Async Generic CRUD | AsyncGenericNamespace |
| Async Security | AsyncSecurityNamespace |
| Async Base | AsyncDomainNamespace base class |
| Async Auth | Async authentication utilities |