# Aurinko v0.2.1 - Table of Contents

Production-grade Elixir client for the Aurinko Unified Mailbox API.
Covers Email, Calendar, Contacts, Tasks, Webhooks, and Booking with
caching, rate-limiting, circuit breaking, streaming pagination, and telemetry.

## Pages

- [Aurinko](readme.md)
- [Changelog](changelog.md)
- [Getting Started with Aurinko](getting_started.md)

## Modules

- [Aurinko.Application](Aurinko.Application.md): OTP Application entry point for Aurinko.
- [Aurinko.HTTP.Client](Aurinko.HTTP.Client.md): Production HTTP client for the Aurinko API.
- [Aurinko.Logger.JSONFormatter](Aurinko.Logger.JSONFormatter.md): Structured JSON log formatter for production and staging environments.
- [Aurinko.Types](Aurinko.Types.md): Shared type definitions for Aurinko.
- [Aurinko.Types.Calendar](Aurinko.Types.Calendar.md): Represents an Aurinko calendar.
- [Aurinko.Types.CalendarEvent](Aurinko.Types.CalendarEvent.md): Represents an Aurinko calendar event.
- [Aurinko.Types.Contact](Aurinko.Types.Contact.md): Represents an Aurinko contact.
- [Aurinko.Types.Email](Aurinko.Types.Email.md): Represents an Aurinko email message.
- [Aurinko.Types.Pagination](Aurinko.Types.Pagination.md): Represents a paginated API response with delta sync tokens.

- [Aurinko.Types.SyncResult](Aurinko.Types.SyncResult.md): Result of a sync start operation.

- [Aurinko.Types.Task](Aurinko.Types.Task.md): Represents an Aurinko task.
- [Aurinko.Webhook.Handler](Aurinko.Webhook.Handler.md): Behaviour for implementing Aurinko webhook event handlers.
- [Aurinko.Webhook.Verifier](Aurinko.Webhook.Verifier.md): HMAC-SHA256 signature verification for Aurinko webhook payloads.

- Core
  - [Aurinko](Aurinko.md): Aurinko — Production-grade Elixir client for the [Aurinko Unified Mailbox API](https://docs.aurinko.io).
  - [Aurinko.Config](Aurinko.Config.md): Configuration management for Aurinko.

- Authentication
  - [Aurinko.Auth](Aurinko.Auth.md): OAuth authentication helpers for Aurinko.

- APIs
  - [Aurinko.API.Booking](Aurinko.API.Booking.md): Aurinko Booking API — scheduling, availability, and appointment booking.
  - [Aurinko.API.Calendar](Aurinko.API.Calendar.md): Aurinko Calendar API — calendars, events, sync, and free/busy scheduling.
  - [Aurinko.API.Contacts](Aurinko.API.Contacts.md): Aurinko Contacts API — read and manage address book contacts.
  - [Aurinko.API.Email](Aurinko.API.Email.md): Aurinko Email API — messages, drafts, sync, and tracking.
  - [Aurinko.API.Tasks](Aurinko.API.Tasks.md): Aurinko Tasks API — manage task lists and todos.
  - [Aurinko.API.Webhooks](Aurinko.API.Webhooks.md): Aurinko Webhooks API — subscribe to push notifications for data changes.

- Sync & Streaming
  - [Aurinko.Paginator](Aurinko.Paginator.md): Lazy stream-based pagination for all Aurinko list endpoints.
  - [Aurinko.Sync.Orchestrator](Aurinko.Sync.Orchestrator.md): High-level sync orchestrator for email, calendar, and contacts.

- Cache & Rate Limiting
  - [Aurinko.Cache](Aurinko.Cache.md): ETS-backed in-memory cache with per-entry TTL and LRU eviction.
  - [Aurinko.CircuitBreaker](Aurinko.CircuitBreaker.md): Per-endpoint circuit breaker with three states: closed, open, and half-open.
  - [Aurinko.RateLimiter](Aurinko.RateLimiter.md): Token-bucket rate limiter with per-account and global buckets.

- Observability
  - [Aurinko.Telemetry](Aurinko.Telemetry.md): Telemetry instrumentation for Aurinko.

- Errors
  - [Aurinko.Error](Aurinko.Error.md): Structured error types returned by Aurinko API calls.

- Exceptions
  - [Aurinko.ConfigError](Aurinko.ConfigError.md): Raised when Aurinko configuration is invalid or missing.