Expand description
Types used as operation parameters and responses.
Modules§
- error
- Error types.
Structs§
- Accept
Eula Request - Request to accept EULA and provision user
- Accept
Eula Response - Response after accepting EULA
- Access
Invite Granted Portal AccessInviteGrantedPortal- Access
Invite List Item AccessInviteListItem- Access
Portal List Item AccessPortalListItem- AddBuilding
User Payload AddBuildingUserPayload- AddRoles
Request - Request type for adding/deleting roles (org_id -> list of role names).
- Apartment
Floor List Response - Distinct apartment floors for a directory device (efficient SQL).
- Apartment
Floor Summary - One distinct floor row for a directory device (apartment entities).
- ApiError
Response - A minimal, user-facing error body for public API responses.
- ApiKey
List Item - Response for API key list item (no token).
- Backend
Status BackendStatus- Billing
Event - Provider-emitted event after webhook validation. Handlers translate this into
internal state (e.g.
billing_subscriptionsrows, tier_id changes on the org). - Billing
Plan Response BillingPlanResponse- Billing
Webhook Payload BillingWebhookPayload- Billing
Webhook Response BillingWebhookResponse- Building
User Response BuildingUserResponse- Checkout
Request CheckoutRequest- Create
Access Invite Request CreateAccessInviteRequest- Create
Access Invite Response CreateAccessInviteResponse- Create
Access Portal Request CreateAccessPortalRequest- Create
Access Portal Response CreateAccessPortalResponse- Create
ApiKey Request CreateApiKeyRequest- Create
ApiKey Response - Response for API key creation (token shown once).
- Create
Device Request CreateDeviceRequest- Create
Entity Request CreateEntityRequest- Create
Integration Request CreateIntegrationRequest- Create
Organization Request CreateOrganizationRequest- Create
User Request CreateUserRequest- Create
Zone Request CreateZoneRequest- Delete
Roles Request - Request type for deleting roles (org_id -> list of role names).
- Device
- A physical or virtual device belonging to an org and integration.
- Device
Entity Metadata Definition Query DeviceEntityMetadataDefinitionQuery- Device
Metadata Definition Response - Device metadata definition response (schema + current data) for schema-driven edit UI.
- Device
Response DeviceResponse- Door
Restrictions Response DoorRestrictionsResponse- Effective
Limit - Resolved limit for
(subject, key, period), with provenance so the dashboard can explain to admins which line of policy is in effect. - Entity
- The actual controllable “button” or “sensor”.
- Entity
Metadata Definition Response EntityMetadataDefinitionResponse- Entity
Response EntityResponse- Eula
Response - EULA content response
- Execute
Scripting Request ExecuteScriptingRequest- Execute
Scripting Response ExecuteScriptingResponse- GetAccess
Portal Response - Response for get access portal by ID (includes integration_id for navigation).
- HashMap
HashMap- Integration
- Credential/Auth for a specific cloud instance.
- Integration
Device Metadata Schema Response - JSON Schema for
devices.device_metadatafor an integration’s provider (no device instance required). - Integration
Response IntegrationResponse- Invite
Schedule Combined InviteScheduleCombined- Invite
Schedule Entry Input InviteScheduleEntryInput- Invite
Schedule Entry Snapshot InviteScheduleEntrySnapshot- Invite
Schedule Snapshot InviteScheduleSnapshot- Invite
Window InviteWindow- LanAgent
Bootstrap Token Request LanAgentBootstrapTokenRequest- LanAgent
Bootstrap Token Response LanAgentBootstrapTokenResponse- LanAgent
CliToken Response LanAgentCliTokenResponse- LanAgent
Meta Response LanAgentMetaResponse- LanAgent
Task Spec Request LanAgentTaskSpecRequest- LanAgent
Task Spec Response LanAgentTaskSpecResponse- Lights
Auto OffDuration - Map of light entity ULID to auto-off duration in seconds. Serializes as JSON object with string keys.
- List
Devices Query ListDevicesQuery- List
Entities Query - List entities for the organization context (X-Org).
- List
Integration Access Invites Response ListIntegrationAccessInvitesResponse- List
Integration Access Portals Response ListIntegrationAccessPortalsResponse- List
Integrations Query ListIntegrationsQuery- List
OrgUsers Query ListOrgUsersQuery- List
Orgs Query ListOrgsQuery- Localized
String - Localized string dictionary.
- MeApartment
Asset MeApartmentAsset- MeApartments
Response MeApartmentsResponse- MeInvitation
Asset MeInvitationAsset- MeInvitations
Response MeInvitationsResponse- MePush
Subscription Status Response MePushSubscriptionStatusResponse- MePush
Vapid Public KeyResponse MePushVapidPublicKeyResponse- Multi
Resource Output Options - Options for list and other multi-resource operations.
Contains single-resource options in a flat manner plus
only_deletedand pagination. - Multi
Resource Output Options Query MultiResourceOutputOptionsQuery- Notify
Portal Message Body NotifyPortalMessageBody- OrgPermissions
Response - Permissions the current user has in this org (for UI: gray out / tooltips). Returns a list of permission keys (e.g. “users:create”, “users:list”) that the user is granted.
- Organization
- An organization (tenant) with optional parent for hierarchy.
- Organization
Response OrganizationResponse- Paginated
Response - Paginated response body for list endpoints.
- Paginated
Response Entity Response - Paginated response body for list endpoints.
- Paginated
Response Entity Response Items Item PaginatedResponseEntityResponseItemsItem- Pagination
Query - Pagination query parameters. Flatten into list-endpoint query structs. When not provided, defaults to first page (limit from config, offset=0).
- Patch
Entity Request - Shallow-merge into existing
entity_metadata(PATCH). Does not replace the whole map. - Peer
JsConfig PeerJsConfig- Plan
Quota Response PlanQuotaResponse- Plan
Response PlanResponse- Plans
Response PlansResponse- Portal
Request PortalRequest- Portal
Response PortalResponse- Post
MePush Subscription Payload PostMePushSubscriptionPayload- Public
Invite Execute Request PublicInviteExecuteRequest- Public
Invite Execute Response PublicInviteExecuteResponse- Public
Invite Response PublicInviteResponse- Public
Portal Create Session Request PublicPortalCreateSessionRequest- Public
Portal Create Session Response PublicPortalCreateSessionResponse- Public
Portal Light PublicPortalLight- Public
Portal Open Rate Limit PublicPortalOpenRateLimit- Public
Portal Reachable Response PublicPortalReachableResponse- Public
Portal Response PublicPortalResponse- Public
Portal Target PublicPortalTarget- Public
Portal Targets Response PublicPortalTargetsResponse- Public
Session Response PublicSessionResponse- Public
Session Streams Response PublicSessionStreamsResponse- Quota
Override Request QuotaOverrideRequest- Quota
Report - Full quota report for an org; powers
/dashboard/billing. - Quota
Usage - Single (key, period) entry in a usage report.
- Role
- A role name (e.g. admin, users:read) assigned to a user in an org.
- Search
Users Query SearchUsersQuery- SetDoor
Restrictions Payload SetDoorRestrictionsPayload- Single
Resource Output Options - Options for single-resource operations (get/create/update/delete/restore).
Used when listing/filtering by
only_deletedis not applicable. - Single
Resource Output Options Query - Query parameters for single-resource operations (get/create/update/delete/restore).
Omits
only_deletedsince it only applies to list endpoints. - Storage
Features StorageFeatures- Subscription
Ref - External subscription reference.
- Update
Access Invite Request UpdateAccessInviteRequest- Update
Access Portal Request UpdateAccessPortalRequest- Update
ApiKey Request UpdateApiKeyRequest- Update
Device Request UpdateDeviceRequest- Update
Entity Request UpdateEntityRequest- Update
Integration Request UpdateIntegrationRequest- Update
Organization Request UpdateOrganizationRequest- Update
User Request UpdateUserRequest- Update
Zone Request UpdateZoneRequest- User
- A provisioned user (identity) in the system.
- User
Response UserResponse- Zone
- A logical or physical space (recursive for hierarchy).
- Zone
Response ZoneResponse
Enums§
- Billing
Event Kind BillingEventKind- Entity
Type - Entity type (apartment, switch, light, sensor…).
- Integration
Health - Integration status (active, disabled, error).
- Invite
Recurrence Series End - How the recurring series ends (from
invite_recurrence), for admin/public display. - Invite
Schedule Kind InviteScheduleKind- Limit
Source LimitSource- Provider
Type - Integration provider type (e.g. homeassistant, knx, mqtt).
- Public
Invite Grant PublicInviteGrant- Public
Invite State PublicInviteState- Public
Portal Mode PublicPortalMode- Public
Session Role PublicSessionRole- Quota
Key - A metered resource. Lifetime keys count current rows in their source-of-truth
table; temporal keys accumulate via
usage_events+quota_counters. - Quota
Period - Window kind for a quota.
Lifetimeis “ever / right now”;Day/Week/Monthreset on calendar boundaries (UTC);PerSessionresets per opaque session id.