Modules
AccessGrid is an Elixir SDK for interacting with the AccessGrid.com API. This SDK provides a simple interface for managing NFC key cards, card templates, landing pages, credential profiles, webhooks, HID Origo organizations, and ledger items. Full docs at https://www.accessgrid.com/docs.
Represents an access pass — the credential issued to an end user. Returned
by AccessGrid.AccessPasses operations (issue, get, update, list, suspend,
resume, unlink, delete).
Manages access-pass lifecycle operations against /v1/key-cards.
Represents a full card template configuration.
Response from publishing a card template via
AccessGrid.Console.publish_template/2. Contains the template id and the
resulting publish status
Represents the response from template create/update operations.
Represents a minimal template reference embedded in AccessGrid.CardTemplatePair.Summary.
Full representation of a template pair, as returned by
AccessGrid.Console.read_template/2 when the resolved id belongs to a pair.
Minimal representation of a template pair, as returned by
AccessGrid.Console.list_card_template_pairs/1.
Holds configuration for AccessGrid API authentication.
Manages enterprise template and logging operations.
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.
Represents a template activity log event.
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.
HTTP client dispatcher.
Behaviour for HTTP clients.
HTTP client implementation using Req.
Represents an HTTP request failure.
Represents a successful HTTP response (2xx status codes).
Response from AccessGrid.Console.ios_preflight/3 — the identifiers needed
to drive Apple Wallet In-App Provisioning for a specific access pass.
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.
A line item from the account's billing ledger. Returned by
AccessGrid.Console.list_ledger_items/1.
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.
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.
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.
Response from AccessGrid.Console.reveal_smart_tap/3 — the Smart Tap
credentials for a card template, encrypted with the caller's ephemeral public
key.
Shared type definitions for the AccessGrid client.
Utility helpers for composing API request params.
Webhook subscription that receives event notifications. Returned by
AccessGrid.Console.list_webhooks/1 and AccessGrid.Console.create_webhook/2.