AccessGrid.HidOrg (AccessGrid v0.1.0)

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.

The activate endpoint (activate_hid_org/2) may return extra fields like already_completed: true or job_queued: true to indicate state — those are not surfaced on this struct. Use org.status to determine activation state.

Summary

Types

t()

Functions

from_response(data)

Creates a HidOrg struct from an API response map.

Types

t()

@type t() :: %AccessGrid.HidOrg{
  created_at: String.t() | nil,
  first_name: String.t() | nil,
  full_address: String.t() | nil,
  id: String.t() | nil,
  last_name: String.t() | nil,
  name: String.t() | nil,
  phone: String.t() | nil,
  slug: String.t() | nil,
  status: String.t() | nil
}

Functions

from_response(data)

@spec from_response(map()) :: t()

Creates a HidOrg struct from an API response map.