ai.newnal.illi.home.defs Documentation (EN)

deviceView object

No description available.

Properties

deviceId string Required

No description available.

maxLength: 64 bytes

firmwareVersion string Optional

No description available.

lastSeenAt string datetime Optional

An RFC 3339 formatted timestamp.

model string Optional

No description available.

online boolean Optional

No description available.

status string Required

No description available.

Known values: registered, awaitingLink, active, unlinked, retired

View raw schema

{
  "properties": {
    "deviceId": {
      "maxLength": 64,
      "type": "string"
    },
    "firmwareVersion": {
      "type": "string"
    },
    "lastSeenAt": {
      "format": "datetime",
      "type": "string"
    },
    "model": {
      "type": "string"
    },
    "online": {
      "type": "boolean"
    },
    "status": {
      "knownValues": [
        "registered",
        "awaitingLink",
        "active",
        "unlinked",
        "retired"
      ],
      "type": "string"
    }
  },
  "required": [
    "deviceId",
    "status"
  ],
  "type": "object"
}

homeSummary object

No description available.

Properties

device ref #deviceView Optional

No description available.

homeId string tid Required

A timestamp-based identifier (TID).

name string Required

No description available.

parents array of ref#parentView Optional

No description available.

role string Required

No description available.

Known values: rootAdmin, mainAdmin, member, parent

View raw schema

{
  "properties": {
    "device": {
      "ref": "#deviceView",
      "type": "ref"
    },
    "homeId": {
      "format": "tid",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "parents": {
      "items": {
        "ref": "#parentView",
        "type": "ref"
      },
      "type": "array"
    },
    "role": {
      "knownValues": [
        "rootAdmin",
        "mainAdmin",
        "member",
        "parent"
      ],
      "type": "string"
    }
  },
  "required": [
    "homeId",
    "name",
    "role"
  ],
  "type": "object"
}

inviteView object

No description available.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

expiresAt string datetime Required

An RFC 3339 formatted timestamp.

inviteId string Required

No description available.

maxUses integer Required

No description available.

note string Optional

No description available.

maxLength: 120 bytes

uses integer Required

No description available.

View raw schema

{
  "properties": {
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "expiresAt": {
      "format": "datetime",
      "type": "string"
    },
    "inviteId": {
      "type": "string"
    },
    "maxUses": {
      "type": "integer"
    },
    "note": {
      "maxLength": 120,
      "type": "string"
    },
    "uses": {
      "type": "integer"
    }
  },
  "required": [
    "inviteId",
    "createdAt",
    "expiresAt",
    "maxUses",
    "uses"
  ],
  "type": "object"
}

limit object

No description available.

Properties

max integer Required

No description available.

used integer Required

No description available.

View raw schema

{
  "properties": {
    "max": {
      "type": "integer"
    },
    "used": {
      "type": "integer"
    }
  },
  "required": [
    "used",
    "max"
  ],
  "type": "object"
}

limits object

No description available.

Properties

admins ref #limit Required

No description available.

parents ref #limit Required

No description available.

View raw schema

{
  "properties": {
    "admins": {
      "ref": "#limit",
      "type": "ref"
    },
    "parents": {
      "ref": "#limit",
      "type": "ref"
    }
  },
  "required": [
    "parents",
    "admins"
  ],
  "type": "object"
}

memberView object

No description available.

Properties

custodyKeyId string Optional

No description available.

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

maxLength: 64 bytes

handle string handle Optional

An AT Protocol handle (e.g., alice.bsky.social).

joinedAt string datetime Required

An RFC 3339 formatted timestamp.

parentSlot integer Optional

No description available.

minimum: 1maximum: 2

photoUrl string uri Optional

A valid URI.

relationship string Optional

No description available.

maxLength: 32 bytes

role string Required

No description available.

Known values: rootAdmin, mainAdmin, member, parent

status string Required

No description available.

Known values: active, removed

View raw schema

{
  "properties": {
    "custodyKeyId": {
      "type": "string"
    },
    "did": {
      "format": "did",
      "type": "string"
    },
    "displayName": {
      "maxLength": 64,
      "type": "string"
    },
    "handle": {
      "format": "handle",
      "type": "string"
    },
    "joinedAt": {
      "format": "datetime",
      "type": "string"
    },
    "parentSlot": {
      "maximum": 2,
      "minimum": 1,
      "type": "integer"
    },
    "photoUrl": {
      "format": "uri",
      "type": "string"
    },
    "relationship": {
      "maxLength": 32,
      "type": "string"
    },
    "role": {
      "knownValues": [
        "rootAdmin",
        "mainAdmin",
        "member",
        "parent"
      ],
      "type": "string"
    },
    "status": {
      "knownValues": [
        "active",
        "removed"
      ],
      "type": "string"
    }
  },
  "required": [
    "did",
    "role",
    "status",
    "joinedAt"
  ],
  "type": "object"
}

parentView object

No description available.

Properties

delegation string Optional

No description available.

Known values: ok, unavailable, none

honorific string Optional

No description available.

linked boolean Required

No description available.

linkedDid string did Optional

A decentralized identifier (DID).

linkedHandle string handle Optional

An AT Protocol handle (e.g., alice.bsky.social).

name string Optional

No description available.

photoUrl string uri Optional

A valid URI.

slot integer Required

No description available.

minimum: 1maximum: 2

View raw schema

{
  "properties": {
    "delegation": {
      "knownValues": [
        "ok",
        "unavailable",
        "none"
      ],
      "type": "string"
    },
    "honorific": {
      "type": "string"
    },
    "linked": {
      "type": "boolean"
    },
    "linkedDid": {
      "format": "did",
      "type": "string"
    },
    "linkedHandle": {
      "format": "handle",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "photoUrl": {
      "format": "uri",
      "type": "string"
    },
    "slot": {
      "maximum": 2,
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "slot",
    "linked"
  ],
  "type": "object"
}

syncView object

No description available.

Properties

lastReconciledAt string datetime Optional

An RFC 3339 formatted timestamp.

spaceRev string tid Optional

A timestamp-based identifier (TID).

status string Required

No description available.

Known values: active, paused, deleted

View raw schema

{
  "properties": {
    "lastReconciledAt": {
      "format": "datetime",
      "type": "string"
    },
    "spaceRev": {
      "format": "tid",
      "type": "string"
    },
    "status": {
      "knownValues": [
        "active",
        "paused",
        "deleted"
      ],
      "type": "string"
    }
  },
  "required": [
    "status"
  ],
  "type": "object"
}