# hawk_ex v0.1.0 - Table of Contents

> SaaS billing infrastructure for Phoenix applications: plans, subscriptions, entitlements, audit logs, and CSV exports.

## Pages

- [HawkEx](readme.md)
- [Changelog](changelog.md)
- [LICENSE](license.md)

## Modules

- [HawkEx](HawkEx.md): Public convenience API for HawkEx entitlement checks.
- [HawkEx.Audit](HawkEx.Audit.md): Records and queries audit log entries.
- [HawkEx.Audit.Log](HawkEx.Audit.Log.md): Ecto schema for an append-only audit log entry.
- [HawkEx.Billing](HawkEx.Billing.md): Public API for plan and subscription management.
- [HawkEx.Billing.Feature](HawkEx.Billing.Feature.md): Ecto schema for a feature that can be granted by a plan.
- [HawkEx.Billing.Plan](HawkEx.Billing.Plan.md): Ecto schema for a billable plan.
- [HawkEx.Billing.PlanFeature](HawkEx.Billing.PlanFeature.md): Ecto schema for the value a plan grants for a feature.
- [HawkEx.Billing.Subscription](HawkEx.Billing.Subscription.md): Ecto schema for an account's subscription to a plan.
- [HawkEx.CSV](HawkEx.CSV.md): CSV export tools for Phoenix SaaS applications.
- [HawkEx.CSV.Export](HawkEx.CSV.Export.md): Ecto schema for a CSV export job and its generated file.
- [HawkEx.CSV.ExportWorker](HawkEx.CSV.ExportWorker.md): Oban worker that generates asynchronous CSV exports.
- [HawkEx.CSV.Exporter](HawkEx.CSV.Exporter.md): Generates CSV content from HawkEx formatter modules.
- [HawkEx.CSV.Formatter](HawkEx.CSV.Formatter.md): Behaviour for CSV export formatters.
- [HawkEx.CSV.Formatters.AuditLogs](HawkEx.CSV.Formatters.AuditLogs.md): Built-in CSV formatter for account audit logs.
- [HawkEx.CSV.Formatters.Subscriptions](HawkEx.CSV.Formatters.Subscriptions.md): Built-in CSV formatter for account subscriptions.
- [HawkEx.CSV.Storage](HawkEx.CSV.Storage.md): Behaviour and dispatch helpers for CSV export storage adapters.
- [HawkEx.CSV.Storage.Local](HawkEx.CSV.Storage.Local.md): Local filesystem storage adapter for CSV exports.
- [HawkEx.CSV.Storage.S3](HawkEx.CSV.Storage.S3.md): Amazon S3 storage adapter for CSV exports.
- [HawkEx.Config](HawkEx.Config.md): Runtime configuration access for HawkEx.
- [HawkEx.Entitlements](HawkEx.Entitlements.md): Entitlement checks and entitlement reporting.
- [HawkEx.Events](HawkEx.Events.md): Broadcasts HawkEx business events through the host application's PubSub.
- [HawkEx.Pagination](HawkEx.Pagination.md): Shared offset-based pagination helper.

## Mix Tasks

- [mix hawk_ex.install](Mix.Tasks.HawkEx.Install.md): Installs HawkEx migrations into a Phoenix application.

