# AccessGrid v0.1.0 - Table of Contents

> An Elixir client for the AccessGrid API

## Pages

- [Testing](testing.md)
- [LICENSE](license.md)

## Modules

- [AccessGrid](AccessGrid.md): 

- API Resources
  - [AccessGrid.AccessPasses](AccessGrid.AccessPasses.md): Manages access-pass lifecycle operations against `/v1/key-cards`.
  - [AccessGrid.Console](AccessGrid.Console.md): Manages enterprise template and logging operations.

- Structs
  - [AccessGrid.AccessPass](AccessGrid.AccessPass.md): Represents an access pass — the credential issued to an end user. Returned
by `AccessGrid.AccessPasses` operations (issue, get, update, list, suspend,
resume, unlink, delete).

  - [AccessGrid.CardTemplate](AccessGrid.CardTemplate.md): Represents a full card template configuration.
  - [AccessGrid.CardTemplate.PublishResult](AccessGrid.CardTemplate.PublishResult.md): Response from publishing a card template via
`AccessGrid.Console.publish_template/2`. Contains the template id and the
resulting publish status
  - [AccessGrid.CardTemplate.Result](AccessGrid.CardTemplate.Result.md): Represents the response from template create/update operations.
  - [AccessGrid.CardTemplate.Summary](AccessGrid.CardTemplate.Summary.md): Represents a minimal template reference embedded in `AccessGrid.CardTemplatePair.Summary`.
  - [AccessGrid.CardTemplatePair](AccessGrid.CardTemplatePair.md): Full representation of a template pair, as returned by
`AccessGrid.Console.read_template/2` when the resolved id belongs to a pair.
  - [AccessGrid.CardTemplatePair.Summary](AccessGrid.CardTemplatePair.Summary.md): Minimal representation of a template pair, as returned by
`AccessGrid.Console.list_card_template_pairs/1`.
  - [AccessGrid.CredentialProfile](AccessGrid.CredentialProfile.md): Credential profile bound to a specific reader app (e.g. `"KEY-ID-main"`).
Returned by `AccessGrid.Console.list_credential_profiles/1` and
`AccessGrid.Console.create_credential_profile/2`.
  - [AccessGrid.Event](AccessGrid.Event.md): Represents a template activity log event.
  - [AccessGrid.HidOrg](AccessGrid.HidOrg.md): HID Origo organization registered to the account. Returned by
`AccessGrid.Console.list_hid_orgs/1`, `AccessGrid.Console.create_hid_org/2`,
and `AccessGrid.Console.activate_hid_org/2`.
  - [AccessGrid.IosPreflight](AccessGrid.IosPreflight.md): Response from `AccessGrid.Console.ios_preflight/3` — the identifiers needed
to drive Apple Wallet In-App Provisioning for a specific access pass.
  - [AccessGrid.LandingPage](AccessGrid.LandingPage.md): Account-scoped landing page where pass holders are directed before installing
a pass. Returned by `AccessGrid.Console.list_landing_pages/1`,
`AccessGrid.Console.create_landing_page/2`, and
`AccessGrid.Console.update_landing_page/3`.

  - [AccessGrid.LedgerItem](AccessGrid.LedgerItem.md): A line item from the account's billing ledger. Returned by
`AccessGrid.Console.list_ledger_items/1`.
  - [AccessGrid.LedgerItem.AccessPass](AccessGrid.LedgerItem.AccessPass.md): Narrow access-pass representation embedded in `AccessGrid.LedgerItem`. Returned
with just enough fields to identify the pass behind a ledger line; for the full
access-pass shape, use `AccessGrid.AccessPasses.get/2`.
  - [AccessGrid.LedgerItem.CardTemplate](AccessGrid.LedgerItem.CardTemplate.md): Narrow card-template representation embedded in
`AccessGrid.LedgerItem.AccessPass`. Returned with just enough fields to identify
the template behind a ledger line; for the full template shape, use
`AccessGrid.Console.read_template/2`.

  - [AccessGrid.SmartTapReveal](AccessGrid.SmartTapReveal.md): Response from `AccessGrid.Console.reveal_smart_tap/3` — the Smart Tap
credentials for a card template, encrypted with the caller's ephemeral public
key.
  - [AccessGrid.Webhook](AccessGrid.Webhook.md): Webhook subscription that receives event notifications. Returned by
`AccessGrid.Console.list_webhooks/1` and `AccessGrid.Console.create_webhook/2`.

- Core
  - [AccessGrid.Client](AccessGrid.Client.md): Holds configuration for AccessGrid API authentication.
  - [AccessGrid.Types](AccessGrid.Types.md): Shared type definitions for the AccessGrid client.

- Utilities
  - [AccessGrid.Params](AccessGrid.Params.md): Helpers for composing SDK request params. Currently just `require/2` for
client-side required-field presence checks — used internally by `Console`
and `AccessPasses` create/action functions to surface "you forgot X" without
a round-trip to the API.

  - [AccessGrid.Utils](AccessGrid.Utils.md): Utility helpers for composing API request params.

- HTTP
  - [AccessGrid.HttpClient](AccessGrid.HttpClient.md): HTTP client dispatcher.
  - [AccessGrid.HttpClient.Behaviour](AccessGrid.HttpClient.Behaviour.md): Behaviour for HTTP clients.
  - [AccessGrid.HttpClient.Req](AccessGrid.HttpClient.Req.md): HTTP client implementation using Req.

  - [AccessGrid.HttpFailure](AccessGrid.HttpFailure.md): Represents an HTTP request failure.
  - [AccessGrid.HttpResponse](AccessGrid.HttpResponse.md): Represents a successful HTTP response (2xx status codes).