diff --git a/docs/api-reference/_blueprint.json b/docs/api-reference/_blueprint.json index 7ae000663..d67795ec9 100644 --- a/docs/api-reference/_blueprint.json +++ b/docs/api-reference/_blueprint.json @@ -123921,6 +123921,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -142171,6 +142184,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -142397,6 +142423,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -142569,198 +142608,8 @@ "jsonType": "string" }, { - "name": "event_id", - "description": "ID of the event.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, - { - "name": "event_type", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "enum", - "jsonType": "string", - "values": [ - { - "name": "access_code.name_changed", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - } - ] - }, - { - "name": "from", - "description": "Previous access code name configuration.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "object", - "jsonType": "object", - "propertyGroups": [], - "properties": [ - { - "name": "name", - "description": "Previous name of the access code.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "string", - "jsonType": "string" - } - ] - }, - { - "name": "occurred_at", - "description": "Date and time at which the event occurred.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "datetime", - "jsonType": "string" - }, - { - "name": "to", - "description": "New access code name configuration.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "object", - "jsonType": "object", - "propertyGroups": [], - "properties": [ - { - "name": "name", - "description": "New name of the access code.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "string", - "jsonType": "string" - } - ] - }, - { - "name": "workspace_id", - "description": "ID of the workspace associated with the event.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - } - ], - "description": "The name of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.", - "isDeprecated": false, - "routePath": "/access_codes", - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroups": [], - "resourceSamples": [], - "eventType": "access_code.name_changed" - }, - { - "resourceType": "event", - "properties": [ - { - "name": "access_code_id", - "description": "ID of the affected access code.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, - { - "name": "connected_account_custom_metadata", - "description": "Custom metadata of the connected account, present when connected_account_id is provided.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "record", - "jsonType": "object" - }, - { - "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access code.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, - { - "name": "created_at", - "description": "Date and time at which the event was created.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "datetime", - "jsonType": "string" - }, - { - "name": "description", - "description": "Human-readable description of the change and its source.", + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -142771,32 +142620,6 @@ "format": "string", "jsonType": "string" }, - { - "name": "device_custom_metadata", - "description": "Custom metadata of the device, present when device_id is provided.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "record", - "jsonType": "object" - }, - { - "name": "device_id", - "description": "ID of the device associated with the affected access code.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, { "name": "event_id", "description": "ID of the event.", @@ -142824,7 +142647,7 @@ "jsonType": "string", "values": [ { - "name": "access_code.code_changed", + "name": "access_code.name_changed", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -142837,7 +142660,7 @@ }, { "name": "from", - "description": "Previous pin code configuration.", + "description": "Previous access code name configuration.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -142850,8 +142673,250 @@ "propertyGroups": [], "properties": [ { - "name": "code", - "description": "Previous pin code.", + "name": "name", + "description": "Previous name of the access code.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "to", + "description": "New access code name configuration.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "propertyGroups": [], + "properties": [ + { + "name": "name", + "description": "New name of the access code.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "workspace_id", + "description": "ID of the workspace associated with the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "The name of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.", + "isDeprecated": false, + "routePath": "/access_codes", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": [], + "resourceSamples": [], + "eventType": "access_code.name_changed" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the affected access code.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_custom_metadata", + "description": "Custom metadata of the connected account, present when connected_account_id is provided.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "record", + "jsonType": "object" + }, + { + "name": "connected_account_id", + "description": "ID of the connected account associated with the affected access code.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "description", + "description": "Human-readable description of the change and its source.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_custom_metadata", + "description": "Custom metadata of the device, present when device_id is provided.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "record", + "jsonType": "object" + }, + { + "name": "device_id", + "description": "ID of the device associated with the affected access code.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.code_changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "from", + "description": "Previous pin code configuration.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "propertyGroups": [], + "properties": [ + { + "name": "code", + "description": "Previous pin code.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -143026,6 +143091,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -143268,6 +143346,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -143556,6 +143647,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -143727,6 +143831,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -143885,6 +144002,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -144373,6 +144503,19 @@ } ] }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -144861,6 +145004,19 @@ } ] }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -145032,6 +145188,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -145520,6 +145689,19 @@ } ] }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -146008,6 +146190,19 @@ } ] }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -146166,6 +146361,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -146324,6 +146532,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -146495,6 +146716,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -146653,6 +146887,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -147141,6 +147388,19 @@ } ] }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -147299,6 +147559,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -147457,6 +147730,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -147563,6 +147849,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -147669,6 +147968,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -147775,6 +148087,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -147894,6 +148219,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -148013,6 +148351,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -148145,6 +148496,19 @@ "format": "string", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -148277,6 +148641,19 @@ "format": "string", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -148438,6 +148815,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -148585,6 +148975,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -148719,6 +149122,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -148853,6 +149269,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -149000,6 +149429,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -149147,6 +149589,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -149266,6 +149721,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -149385,6 +149853,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -149724,6 +150205,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -149856,6 +150350,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -149921,7 +150428,152 @@ "jsonType": "string" } ], - "description": "An [access system credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was deleted.", + "description": "An [access system credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was deleted.", + "isDeprecated": false, + "routePath": "/acs/credentials", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": [], + "resourceSamples": [], + "eventType": "acs_credential.deleted" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "acs_credential_id", + "description": "ID of the affected credential.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the access system.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the connected account.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_credential.issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the workspace associated with the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [access system credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was issued.", "isDeprecated": false, "routePath": "/acs/credentials", "deprecationMessage": "", @@ -149931,7 +150583,7 @@ "draftMessage": "", "propertyGroups": [], "resourceSamples": [], - "eventType": "acs_credential.deleted" + "eventType": "acs_credential.issued" }, { "resourceType": "event", @@ -149989,127 +150641,8 @@ "jsonType": "string" }, { - "name": "event_id", - "description": "ID of the event.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, - { - "name": "event_type", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "enum", - "jsonType": "string", - "values": [ - { - "name": "acs_credential.issued", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - } - ] - }, - { - "name": "occurred_at", - "description": "Date and time at which the event occurred.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "datetime", - "jsonType": "string" - }, - { - "name": "workspace_id", - "description": "ID of the workspace associated with the event.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - } - ], - "description": "An [access system credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was issued.", - "isDeprecated": false, - "routePath": "/acs/credentials", - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroups": [], - "resourceSamples": [], - "eventType": "acs_credential.issued" - }, - { - "resourceType": "event", - "properties": [ - { - "name": "acs_credential_id", - "description": "ID of the affected credential.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, - { - "name": "acs_system_id", - "description": "ID of the access system.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, - { - "name": "connected_account_id", - "description": "ID of the connected account.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, - { - "name": "created_at", - "description": "Date and time at which the event was created.", + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -150117,7 +150650,7 @@ "isDraft": false, "draftMessage": "", "propertyGroupKey": null, - "format": "datetime", + "format": "string", "jsonType": "string" }, { @@ -150252,6 +150785,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -150384,6 +150930,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -150516,6 +151075,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -150648,6 +151220,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -150780,6 +151365,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -150912,6 +151510,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -151044,6 +151655,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -151176,6 +151800,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -151282,6 +151919,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -151427,6 +152077,19 @@ "format": "string", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -151559,6 +152222,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -151691,6 +152367,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -151920,6 +152609,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -152039,6 +152741,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -152184,6 +152899,19 @@ "format": "string", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -152303,6 +153031,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -152532,6 +153273,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -152677,6 +153431,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -152835,6 +153602,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -152993,6 +153773,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -153152,59 +153945,179 @@ "jsonType": "string" }, { - "name": "event_id", - "description": "ID of the event.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, - { - "name": "event_type", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "enum", - "jsonType": "string", - "values": [ - { - "name": "action_attempt.unlock_door.failed", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - } - ] - }, - { - "name": "occurred_at", - "description": "Date and time at which the event occurred.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "datetime", - "jsonType": "string" - }, - { - "name": "status", - "description": "Status of the action.", + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "action_attempt.unlock_door.failed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "status", + "description": "Status of the action.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the workspace associated with the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An unlock door action attempt failed.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": [], + "resourceSamples": [], + "eventType": "action_attempt.unlock_door.failed" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the affected action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "Type of the action.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the connected account associated with the action attempt, if applicable.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device associated with the action attempt, if applicable.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -153215,100 +154128,6 @@ "format": "string", "jsonType": "string" }, - { - "name": "workspace_id", - "description": "ID of the workspace associated with the event.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - } - ], - "description": "An unlock door action attempt failed.", - "isDeprecated": false, - "routePath": "/action_attempts", - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroups": [], - "resourceSamples": [], - "eventType": "action_attempt.unlock_door.failed" - }, - { - "resourceType": "event", - "properties": [ - { - "name": "action_attempt_id", - "description": "ID of the affected action attempt.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, - { - "name": "action_type", - "description": "Type of the action.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "string", - "jsonType": "string" - }, - { - "name": "connected_account_id", - "description": "ID of the connected account associated with the action attempt, if applicable.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, - { - "name": "created_at", - "description": "Date and time at which the event was created.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "datetime", - "jsonType": "string" - }, - { - "name": "device_id", - "description": "ID of the device associated with the action attempt, if applicable.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, { "name": "event_id", "description": "ID of the event.", @@ -153467,6 +154286,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -153625,6 +154457,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -153783,6 +154628,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -153941,6 +154799,19 @@ "format": "string", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -154047,6 +154918,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -154205,6 +155089,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -154386,6 +155283,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -154544,6 +155454,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -154702,6 +155625,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -154860,6 +155796,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -155283,6 +156232,19 @@ } ] }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -155706,6 +156668,19 @@ } ] }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -155864,6 +156839,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -156035,6 +157023,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -156261,6 +157262,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -156419,6 +157433,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -156590,6 +157617,19 @@ "format": "string", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -156748,6 +157788,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -156907,127 +157960,179 @@ "jsonType": "string" }, { - "name": "event_id", - "description": "ID of the event.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, - { - "name": "event_type", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "enum", - "jsonType": "string", - "values": [ - { - "name": "device.third_party_integration_no_longer_detected", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - } - ] - }, - { - "name": "occurred_at", - "description": "Date and time at which the event occurred.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "datetime", - "jsonType": "string" - }, - { - "name": "workspace_id", - "description": "ID of the workspace associated with the event.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - } - ], - "description": "Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.", - "isDeprecated": false, - "routePath": "/devices", - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroups": [], - "resourceSamples": [], - "eventType": "device.third_party_integration_no_longer_detected" - }, - { - "resourceType": "event", - "properties": [ - { - "name": "connected_account_custom_metadata", - "description": "Custom metadata of the connected account, present when connected_account_id is provided.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "record", - "jsonType": "object" - }, - { - "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, - { - "name": "created_at", - "description": "Date and time at which the event was created.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "datetime", - "jsonType": "string" - }, - { - "name": "customer_key", - "description": "The customer key associated with the device, if any.", + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.third_party_integration_no_longer_detected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the workspace associated with the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": [], + "resourceSamples": [], + "eventType": "device.third_party_integration_no_longer_detected" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_custom_metadata", + "description": "Custom metadata of the connected account, present when connected_account_id is provided.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "record", + "jsonType": "object" + }, + { + "name": "connected_account_id", + "description": "ID of the connected account associated with the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "customer_key", + "description": "The customer key associated with the device, if any.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_custom_metadata", + "description": "Custom metadata of the device, present when device_id is provided.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "record", + "jsonType": "object" + }, + { + "name": "device_id", + "description": "ID of the affected device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -157038,32 +158143,6 @@ "format": "string", "jsonType": "string" }, - { - "name": "device_custom_metadata", - "description": "Custom metadata of the device, present when device_id is provided.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "record", - "jsonType": "object" - }, - { - "name": "device_id", - "description": "ID of the affected device.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, { "name": "event_id", "description": "ID of the event.", @@ -157222,6 +158301,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -157600,6 +158692,19 @@ } ] }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -157758,6 +158863,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -158136,6 +159254,19 @@ } ] }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -158294,6 +159425,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -158452,6 +159596,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -158830,6 +159987,19 @@ } ] }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -158988,6 +160158,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -159276,6 +160459,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -159616,6 +160812,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -159930,6 +161139,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -160114,6 +161336,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -160324,6 +161559,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -160653,6 +161901,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -160889,6 +162150,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -161151,6 +162425,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -161242,7 +162529,204 @@ "jsonType": "string" } ], - "description": "A [thermostat's](https://docs.seam.co/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", + "description": "A [thermostat's](https://docs.seam.co/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", + "isDeprecated": false, + "routePath": "/thermostats", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": [], + "resourceSamples": [], + "eventType": "thermostat.temperature_reached_set_point" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_custom_metadata", + "description": "Custom metadata of the connected account, present when connected_account_id is provided.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "record", + "jsonType": "object" + }, + { + "name": "connected_account_id", + "description": "ID of the connected account associated with the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "customer_key", + "description": "The customer key associated with the device, if any.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_custom_metadata", + "description": "Custom metadata of the device, present when device_id is provided.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "record", + "jsonType": "object" + }, + { + "name": "device_id", + "description": "ID of the affected device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "thermostat.temperature_changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "temperature_celsius", + "description": "Temperature, in °C, reported by the affected thermostat.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "temperature_fahrenheit", + "description": "Temperature, in °F, reported by the affected thermostat.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "workspace_id", + "description": "ID of the workspace associated with the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [thermostat's](https://docs.seam.co/capability-guides/thermostats) reported temperature changed by at least 1 °C.", "isDeprecated": false, "routePath": "/thermostats", "deprecationMessage": "", @@ -161252,7 +162736,7 @@ "draftMessage": "", "propertyGroups": [], "resourceSamples": [], - "eventType": "thermostat.temperature_reached_set_point" + "eventType": "thermostat.temperature_changed" }, { "resourceType": "event", @@ -161336,153 +162820,8 @@ "jsonType": "string" }, { - "name": "event_id", - "description": "ID of the event.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, - { - "name": "event_type", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "enum", - "jsonType": "string", - "values": [ - { - "name": "thermostat.temperature_changed", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - } - ] - }, - { - "name": "occurred_at", - "description": "Date and time at which the event occurred.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "datetime", - "jsonType": "string" - }, - { - "name": "temperature_celsius", - "description": "Temperature, in °C, reported by the affected thermostat.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "number", - "jsonType": "number" - }, - { - "name": "temperature_fahrenheit", - "description": "Temperature, in °F, reported by the affected thermostat.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "number", - "jsonType": "number" - }, - { - "name": "workspace_id", - "description": "ID of the workspace associated with the event.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - } - ], - "description": "A [thermostat's](https://docs.seam.co/capability-guides/thermostats) reported temperature changed by at least 1 °C.", - "isDeprecated": false, - "routePath": "/thermostats", - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroups": [], - "resourceSamples": [], - "eventType": "thermostat.temperature_changed" - }, - { - "resourceType": "event", - "properties": [ - { - "name": "connected_account_custom_metadata", - "description": "Custom metadata of the connected account, present when connected_account_id is provided.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "record", - "jsonType": "object" - }, - { - "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, - { - "name": "created_at", - "description": "Date and time at which the event was created.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "datetime", - "jsonType": "string" - }, - { - "name": "customer_key", - "description": "The customer key associated with the device, if any.", + "name": "device_name", + "description": "The new name of the affected device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -161494,34 +162833,8 @@ "jsonType": "string" }, { - "name": "device_custom_metadata", - "description": "Custom metadata of the device, present when device_id is provided.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "record", - "jsonType": "object" - }, - { - "name": "device_id", - "description": "ID of the affected device.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, - { - "name": "device_name", - "description": "The new name of the affected device.", + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -161715,6 +163028,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -161954,6 +163280,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -162086,6 +163425,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -162205,6 +163557,19 @@ "format": "id", "jsonType": "string" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -162326,6 +163691,19 @@ "jsonType": "array", "itemFormat": "id" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -162473,6 +163851,19 @@ "jsonType": "array", "itemFormat": "id" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", @@ -162620,6 +164011,19 @@ "jsonType": "array", "itemFormat": "id" }, + { + "name": "event_description", + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, { "name": "event_id", "description": "ID of the event.", diff --git a/docs/api-reference/access_codes/README.md b/docs/api-reference/access_codes/README.md index fe6b19a78..ddc459819 100644 --- a/docs/api-reference/access_codes/README.md +++ b/docs/api-reference/access_codes/README.md @@ -2405,6 +2405,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -2479,6 +2483,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -2534,6 +2542,10 @@ The name of an [access code](https://docs.seam.co/low-level-apis/smart-locks/acc ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -2597,6 +2609,10 @@ The pin code of an [access code](https://docs.seam.co/low-level-apis/smart-locks ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -2660,6 +2676,10 @@ The time frame of an [access code](https://docs.seam.co/low-level-apis/smart-loc ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -2719,6 +2739,10 @@ Mutations were requested on an [access code](https://docs.seam.co/low-level-apis ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -2803,6 +2827,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -2858,6 +2886,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -2909,6 +2941,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -3074,6 +3110,10 @@ There was an unusually long delay in setting an [access code](https://docs.seam. Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -3239,6 +3279,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) f Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -3294,6 +3338,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -3459,6 +3507,10 @@ There was an unusually long delay in removing an [access code](https://docs.seam Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -3624,6 +3676,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) f Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -3675,6 +3731,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -3726,6 +3786,10 @@ An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) w ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -3781,6 +3845,10 @@ A [backup access code](https://docs.seam.co/low-level-apis/smart-locks/access-co ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/access_codes/unmanaged/README.md b/docs/api-reference/access_codes/unmanaged/README.md index 3451d4fe1..0067eae92 100644 --- a/docs/api-reference/access_codes/unmanaged/README.md +++ b/docs/api-reference/access_codes/unmanaged/README.md @@ -1930,6 +1930,10 @@ An [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/acces ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -2095,6 +2099,10 @@ An [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/acces Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -2146,6 +2154,10 @@ An [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/acces ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -2197,6 +2209,10 @@ An [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/acces ID of the device associated with the affected access code. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/access_grants/README.md b/docs/api-reference/access_grants/README.md index 9ce85f8b1..280d12cdc 100644 --- a/docs/api-reference/access_grants/README.md +++ b/docs/api-reference/access_grants/README.md @@ -852,6 +852,10 @@ An Access Grant was created. Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -887,6 +891,10 @@ An Access Grant was deleted. Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -922,6 +930,10 @@ All access requested for an Access Grant was successfully granted. Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -961,6 +973,10 @@ Access requested as part of an Access Grant to a particular door was successfull Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -1000,6 +1016,10 @@ Access to a particular door that was requested as part of an Access Grant was lo Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -1043,6 +1063,10 @@ An Access Grant's start or end time was changed. The new end time for the access grant. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -1086,6 +1110,10 @@ One or more requested access methods could not be created for an Access Grant. Description of why the access methods could not be created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/access_methods/README.md b/docs/api-reference/access_methods/README.md index 80628b2fb..8e07534e3 100644 --- a/docs/api-reference/access_methods/README.md +++ b/docs/api-reference/access_methods/README.md @@ -576,6 +576,10 @@ An access method was issued. Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -623,6 +627,10 @@ An access method was revoked. Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -666,6 +674,10 @@ An access method representing a physical card requires encoding. Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -709,6 +721,10 @@ An access method was deleted. Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -756,6 +772,10 @@ An access method was reissued. Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -803,6 +823,10 @@ An access method was created. Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/acs/access_groups/README.md b/docs/api-reference/acs/access_groups/README.md index c8b56399d..b05f2b232 100644 --- a/docs/api-reference/acs/access_groups/README.md +++ b/docs/api-reference/acs/access_groups/README.md @@ -722,6 +722,10 @@ An ACS access group was deleted. Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/acs/credentials/README.md b/docs/api-reference/acs/credentials/README.md index 2000ea924..25b137c80 100644 --- a/docs/api-reference/acs/credentials/README.md +++ b/docs/api-reference/acs/credentials/README.md @@ -726,6 +726,10 @@ An [access system credential](https://docs.seam.co/low-level-apis/access-systems Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -769,6 +773,10 @@ An [access system credential](https://docs.seam.co/low-level-apis/access-systems Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -812,6 +820,10 @@ An [access system credential](https://docs.seam.co/low-level-apis/access-systems Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -855,6 +867,10 @@ An [access system credential](https://docs.seam.co/low-level-apis/access-systems Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/acs/encoders/README.md b/docs/api-reference/acs/encoders/README.md index d30eb3236..a1f786a22 100644 --- a/docs/api-reference/acs/encoders/README.md +++ b/docs/api-reference/acs/encoders/README.md @@ -154,6 +154,10 @@ An [access system encoder](https://docs.seam.co/low-level-apis/access-systems/wo Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -197,6 +201,10 @@ An [access system encoder](https://docs.seam.co/low-level-apis/access-systems/wo Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/acs/entrances/README.md b/docs/api-reference/acs/entrances/README.md index a2615db7e..492f9ec9c 100644 --- a/docs/api-reference/acs/entrances/README.md +++ b/docs/api-reference/acs/entrances/README.md @@ -696,6 +696,10 @@ An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/r Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -739,6 +743,10 @@ An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/r Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/acs/systems/README.md b/docs/api-reference/acs/systems/README.md index 09af238d5..f31084560 100644 --- a/docs/api-reference/acs/systems/README.md +++ b/docs/api-reference/acs/systems/README.md @@ -781,6 +781,10 @@ An [access system](https://docs.seam.co/low-level-apis/access-systems) was conne Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -820,6 +824,10 @@ An [access system](https://docs.seam.co/low-level-apis/access-systems) was added Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -935,6 +943,10 @@ An [access system](https://docs.seam.co/low-level-apis/access-systems) was disco Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/acs/users/README.md b/docs/api-reference/acs/users/README.md index de76315c4..983edccbc 100644 --- a/docs/api-reference/acs/users/README.md +++ b/docs/api-reference/acs/users/README.md @@ -1199,6 +1199,10 @@ An [access system user](https://docs.seam.co/low-level-apis/access-systems/user- Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -1242,6 +1246,10 @@ An [access system user](https://docs.seam.co/low-level-apis/access-systems/user- Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/action_attempts/README.md b/docs/api-reference/action_attempts/README.md index d1aa6e71c..5b165cef9 100644 --- a/docs/api-reference/action_attempts/README.md +++ b/docs/api-reference/action_attempts/README.md @@ -112,6 +112,10 @@ A lock door action attempt succeeded. ID of the device associated with the action attempt, if applicable. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -163,6 +167,10 @@ A lock door action attempt failed. ID of the device associated with the action attempt, if applicable. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -214,6 +222,10 @@ An unlock door action attempt succeeded. ID of the device associated with the action attempt, if applicable. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -265,6 +277,10 @@ An unlock door action attempt failed. ID of the device associated with the action attempt, if applicable. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -316,6 +332,10 @@ A simulate keypad code entry action attempt succeeded. ID of the device associated with the action attempt, if applicable. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -367,6 +387,10 @@ A simulate keypad code entry action attempt failed. ID of the device associated with the action attempt, if applicable. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -418,6 +442,10 @@ A simulate manual lock via keypad action attempt succeeded. ID of the device associated with the action attempt, if applicable. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -469,6 +497,10 @@ A simulate manual lock via keypad action attempt failed. ID of the device associated with the action attempt, if applicable. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/client_sessions/README.md b/docs/api-reference/client_sessions/README.md index b2ed08773..579ffc0bb 100644 --- a/docs/api-reference/client_sessions/README.md +++ b/docs/api-reference/client_sessions/README.md @@ -174,6 +174,10 @@ A client session was deleted. Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/connect_webviews/README.md b/docs/api-reference/connect_webviews/README.md index 8ee40b56b..c94379cc7 100644 --- a/docs/api-reference/connect_webviews/README.md +++ b/docs/api-reference/connect_webviews/README.md @@ -270,6 +270,10 @@ A Connect Webview login succeeded. The customer key associated with this connect webview, if any. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -305,6 +309,10 @@ A Connect Webview login failed. Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/connected_accounts/README.md b/docs/api-reference/connected_accounts/README.md index 9fdec4e10..4ba84a336 100644 --- a/docs/api-reference/connected_accounts/README.md +++ b/docs/api-reference/connected_accounts/README.md @@ -865,6 +865,10 @@ A connected account was connected for the first time or was reconnected after be The customer key associated with this connected account, if any. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -908,6 +912,10 @@ A connected account was created. Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -951,6 +959,10 @@ A connected account had a successful login using a Connect Webview. Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -1028,6 +1040,10 @@ A connected account was disconnected. Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -1067,6 +1083,10 @@ A connected account completed the first sync with Seam, and the corresponding de Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -1114,6 +1134,10 @@ A connected account was deleted. The customer key associated with this connected account, if any. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -1153,6 +1177,10 @@ A connected account completed the first sync after reconnection with Seam, and t Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -1230,6 +1258,10 @@ A connected account requires reauthorization using a new Connect Webview. The ac Date and time at which the event was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/devices/README.md b/docs/api-reference/devices/README.md index b1ea90bb4..7f50fba13 100644 --- a/docs/api-reference/devices/README.md +++ b/docs/api-reference/devices/README.md @@ -5680,6 +5680,10 @@ The status of a device changed from offline to online. That is, the `device.prop ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -5731,6 +5735,10 @@ A device was added to Seam or was re-added to Seam after having been removed. ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -5782,6 +5790,10 @@ A managed device was successfully converted to an [unmanaged device](https://doc ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -5920,6 +5932,10 @@ The status of a device changed from online to offline. That is, the `device.prop - device_disconnected +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -5971,6 +5987,10 @@ A device detected that it was tampered with, for example, opened or moved. ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -6026,6 +6046,10 @@ A device battery level dropped below the low threshold. ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -6093,6 +6117,10 @@ A device battery status changed since the last `battery_status_changed` event. ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -6144,6 +6172,10 @@ A device was removed externally from the connected account. ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -6199,6 +6231,10 @@ A device was deleted. Name of the deleted device, captured at deletion time. The device record no longer exists when this event fires, so the name is preserved here. Null when the device had no resolvable name. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -6250,6 +6286,10 @@ Seam detected that a device is using a third-party integration that will interfe ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -6301,6 +6341,10 @@ Seam detected that a device is no longer using a third-party integration that wa ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -6352,6 +6396,10 @@ A [Salto device](https://docs.seam.co/device-and-system-integration-guides/salto ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -6403,6 +6451,10 @@ A [Salto device](https://docs.seam.co/device-and-system-integration-guides/salto ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -6530,6 +6582,10 @@ Seam detected a flaky device connection. Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -6581,6 +6637,10 @@ Seam detected that a previously-flaky device connection stabilized. ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -6708,6 +6768,10 @@ A third-party subscription is required to use all device features. Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -6759,6 +6823,10 @@ A third-party subscription is active or no longer required to use all device fea ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -6810,6 +6878,10 @@ An accessory keypad was connected to a device. ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -6937,6 +7009,10 @@ An accessory keypad was disconnected from a device. Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -6992,6 +7068,10 @@ The name of a device was changed. The new name of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -7052,6 +7132,10 @@ A camera was activated, for example, by motion detection. ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -7123,6 +7207,10 @@ A doorbell button was pressed on a device. ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/devices/unmanaged/README.md b/docs/api-reference/devices/unmanaged/README.md index 79adbda38..bd070f4e3 100644 --- a/docs/api-reference/devices/unmanaged/README.md +++ b/docs/api-reference/devices/unmanaged/README.md @@ -2500,6 +2500,10 @@ An [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unm ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -2551,6 +2555,10 @@ The status of an [unmanaged device](https://docs.seam.co/core-concepts/devices/m ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -2689,6 +2697,10 @@ The status of an [unmanaged device](https://docs.seam.co/core-concepts/devices/m - device_disconnected +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/locks/README.md b/docs/api-reference/locks/README.md index a19d653e3..cfc60a3f3 100644 --- a/docs/api-reference/locks/README.md +++ b/docs/api-reference/locks/README.md @@ -4093,6 +4093,10 @@ A [lock](https://docs.seam.co/low-level-apis/smart-locks) was locked. ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -4199,6 +4203,10 @@ A [lock](https://docs.seam.co/low-level-apis/smart-locks) was unlocked. ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -4299,6 +4307,10 @@ The [lock](https://docs.seam.co/low-level-apis/smart-locks) denied access to a u ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/noise_sensors/noise_thresholds/README.md b/docs/api-reference/noise_sensors/noise_thresholds/README.md index e753719f8..a11a3857f 100644 --- a/docs/api-reference/noise_sensors/noise_thresholds/README.md +++ b/docs/api-reference/noise_sensors/noise_thresholds/README.md @@ -129,6 +129,10 @@ Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/ ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/phones/README.md b/docs/api-reference/phones/README.md index 95eca892b..ec05e5d12 100644 --- a/docs/api-reference/phones/README.md +++ b/docs/api-reference/phones/README.md @@ -228,6 +228,10 @@ A phone device was deactivated. ID of the affected phone device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/spaces/README.md b/docs/api-reference/spaces/README.md index 569b02bac..4ccac5db2 100644 --- a/docs/api-reference/spaces/README.md +++ b/docs/api-reference/spaces/README.md @@ -183,6 +183,10 @@ A device was added or removed from a space. IDs of all devices currently attached to the space. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -232,6 +236,10 @@ A space was created. IDs of all devices attached to the space when it was created. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -281,6 +289,10 @@ A space was deleted. IDs of all devices attached to the space when it was deleted. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/docs/api-reference/thermostats/README.md b/docs/api-reference/thermostats/README.md index e45e74940..31b4d6a55 100644 --- a/docs/api-reference/thermostats/README.md +++ b/docs/api-reference/thermostats/README.md @@ -4530,6 +4530,10 @@ A thermostat [climate preset](https://docs.seam.co/capability-guides/thermostats ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -4597,6 +4601,10 @@ A [thermostat](https://docs.seam.co/capability-guides/thermostats) was adjusted ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -4690,6 +4698,10 @@ A [thermostat's](https://docs.seam.co/capability-guides/thermostats) temperature ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -4765,6 +4777,10 @@ A [thermostat's](https://docs.seam.co/capability-guides/thermostats) temperature ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -4848,6 +4864,10 @@ A [thermostat's](https://docs.seam.co/capability-guides/thermostats) temperature ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. @@ -4907,6 +4927,10 @@ A [thermostat's](https://docs.seam.co/capability-guides/thermostats) reported te ID of the affected device. +event_description String + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + event_id UUID ID of the event. diff --git a/mintlify-docs/api/access_codes/events.mdx b/mintlify-docs/api/access_codes/events.mdx index 8dad0dead..5b9c23386 100644 --- a/mintlify-docs/api/access_codes/events.mdx +++ b/mintlify-docs/api/access_codes/events.mdx @@ -17,6 +17,7 @@ An [access code](/low-level-apis/smart-locks/access-codes) was created. "created_at": "2025-01-01T00:00:00.000Z", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was created.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.created", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -52,6 +53,10 @@ An [access code](/low-level-apis/smart-locks/access-codes) was created. ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -86,6 +91,7 @@ An [access code](/low-level-apis/smart-locks/access-codes) was changed. "created_at": "2025-01-01T00:00:00.000Z", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was changed.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.changed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -129,6 +135,10 @@ An [access code](/low-level-apis/smart-locks/access-codes) was changed. ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -162,6 +172,7 @@ The name of an [access code](/low-level-apis/smart-locks/access-codes) was chang "description": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "The name of an [access code](/low-level-apis/smart-locks/access-codes) was changed on the device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.name_changed", "from": { @@ -207,6 +218,10 @@ The name of an [access code](/low-level-apis/smart-locks/access-codes) was chang ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -260,6 +275,7 @@ The pin code of an [access code](/low-level-apis/smart-locks/access-codes) was c "description": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "The pin code of an [access code](/low-level-apis/smart-locks/access-codes) was changed on the device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.code_changed", "from": { @@ -305,6 +321,10 @@ The pin code of an [access code](/low-level-apis/smart-locks/access-codes) was c ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -358,6 +378,7 @@ The time frame of an [access code](/low-level-apis/smart-locks/access-codes) was "description": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "The time frame of an [access code](/low-level-apis/smart-locks/access-codes) was changed on the device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.time_frame_changed", "from": { @@ -405,6 +426,10 @@ The time frame of an [access code](/low-level-apis/smart-locks/access-codes) was ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -463,6 +488,7 @@ Mutations were requested on an [access code](/low-level-apis/smart-locks/access- "created_at": "2025-01-01T00:00:00.000Z", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "Mutations were requested on an [access code](/low-level-apis/smart-locks/access-codes). This event fires at request time, before the change is confirmed on the device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.mutations_requested", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -499,6 +525,10 @@ Mutations were requested on an [access code](/low-level-apis/smart-locks/access- ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -536,6 +566,7 @@ An [access code](/low-level-apis/smart-locks/access-codes) was [scheduled native "created_at": "2025-01-01T00:00:00.000Z", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was [scheduled natively](/low-level-apis/smart-locks/access-codes#native-scheduling) on a device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.scheduled_on_device", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -575,6 +606,10 @@ An [access code](/low-level-apis/smart-locks/access-codes) was [scheduled native ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -608,6 +643,7 @@ An [access code](/low-level-apis/smart-locks/access-codes) was set on a device. "created_at": "2025-01-01T00:00:00.000Z", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was set on a device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.set_on_device", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -647,6 +683,10 @@ An [access code](/low-level-apis/smart-locks/access-codes) was set on a device. ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -679,6 +719,7 @@ An [access code](/low-level-apis/smart-locks/access-codes) was removed from a de "created_at": "2025-01-01T00:00:00.000Z", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was removed from a device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.removed_from_device", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -714,6 +755,10 @@ An [access code](/low-level-apis/smart-locks/access-codes) was removed from a de ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -752,6 +797,7 @@ There was an unusually long delay in setting an [access code](/low-level-apis/sm "device_errors": [], "device_id": "00000000-0000-0000-0000-000000000000", "device_warnings": [], + "event_description": "There was an unusually long delay in setting an [access code](/low-level-apis/smart-locks/access-codes) on a device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.delay_in_setting_on_device", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -811,6 +857,10 @@ There was an unusually long delay in setting an [access code](/low-level-apis/sm Warnings associated with the device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -849,6 +899,7 @@ An [access code](/low-level-apis/smart-locks/access-codes) failed to be set on a "device_errors": [], "device_id": "00000000-0000-0000-0000-000000000000", "device_warnings": [], + "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) failed to be set on a device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.failed_to_set_on_device", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -908,6 +959,10 @@ An [access code](/low-level-apis/smart-locks/access-codes) failed to be set on a Warnings associated with the device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -941,6 +996,7 @@ An [access code](/low-level-apis/smart-locks/access-codes) was deleted. "created_at": "2025-01-01T00:00:00.000Z", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was deleted.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.deleted", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -980,6 +1036,10 @@ An [access code](/low-level-apis/smart-locks/access-codes) was deleted. ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -1018,6 +1078,7 @@ There was an unusually long delay in removing an [access code](/low-level-apis/s "device_errors": [], "device_id": "00000000-0000-0000-0000-000000000000", "device_warnings": [], + "event_description": "There was an unusually long delay in removing an [access code](/low-level-apis/smart-locks/access-codes) from a device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.delay_in_removing_from_device", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -1077,6 +1138,10 @@ There was an unusually long delay in removing an [access code](/low-level-apis/s Warnings associated with the device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -1115,6 +1180,7 @@ An [access code](/low-level-apis/smart-locks/access-codes) failed to be removed "device_errors": [], "device_id": "00000000-0000-0000-0000-000000000000", "device_warnings": [], + "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) failed to be removed from a device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.failed_to_remove_from_device", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -1174,6 +1240,10 @@ An [access code](/low-level-apis/smart-locks/access-codes) failed to be removed Warnings associated with the device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -1206,6 +1276,7 @@ An [access code](/low-level-apis/smart-locks/access-codes) was modified outside "created_at": "2025-01-01T00:00:00.000Z", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was modified outside of Seam.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.modified_external_to_seam", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -1241,6 +1312,10 @@ An [access code](/low-level-apis/smart-locks/access-codes) was modified outside ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -1273,6 +1348,7 @@ An [access code](/low-level-apis/smart-locks/access-codes) was deleted outside o "created_at": "2025-01-01T00:00:00.000Z", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "An [access code](/low-level-apis/smart-locks/access-codes) was deleted outside of Seam.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.deleted_external_to_seam", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -1308,6 +1384,10 @@ An [access code](/low-level-apis/smart-locks/access-codes) was deleted outside o ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -1341,6 +1421,7 @@ A [backup access code](/low-level-apis/smart-locks/access-codes/backup-access-co "created_at": "2025-01-01T00:00:00.000Z", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A [backup access code](/low-level-apis/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.backup_access_code_pulled", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -1380,6 +1461,10 @@ A [backup access code](/low-level-apis/smart-locks/access-codes/backup-access-co ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/access_codes/unmanaged/events.mdx b/mintlify-docs/api/access_codes/unmanaged/events.mdx index 7a7e5f150..5b8054751 100644 --- a/mintlify-docs/api/access_codes/unmanaged/events.mdx +++ b/mintlify-docs/api/access_codes/unmanaged/events.mdx @@ -17,6 +17,7 @@ An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-ex "created_at": "2025-01-01T00:00:00.000Z", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.unmanaged.converted_to_managed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -52,6 +53,10 @@ An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-ex ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -90,6 +95,7 @@ An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-ex "device_errors": [], "device_id": "00000000-0000-0000-0000-000000000000", "device_warnings": [], + "event_description": "An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.unmanaged.failed_to_convert_to_managed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -149,6 +155,10 @@ An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-ex Warnings associated with the device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -181,6 +191,7 @@ An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-ex "created_at": "2025-01-01T00:00:00.000Z", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) was created on a device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.unmanaged.created", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -216,6 +227,10 @@ An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-ex ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -248,6 +263,7 @@ An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-ex "created_at": "2025-01-01T00:00:00.000Z", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_code.unmanaged.removed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -283,6 +299,10 @@ An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-ex ID of the device associated with the affected access code. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/access_grants/events.mdx b/mintlify-docs/api/access_grants/events.mdx index 8dfd6aa08..ba2552748 100644 --- a/mintlify-docs/api/access_grants/events.mdx +++ b/mintlify-docs/api/access_grants/events.mdx @@ -13,6 +13,7 @@ An Access Grant was created. { "access_grant_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An Access Grant was created.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_grant.created", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -32,6 +33,10 @@ An Access Grant was created. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -60,6 +65,7 @@ An Access Grant was deleted. { "access_grant_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An Access Grant was deleted.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_grant.deleted", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -79,6 +85,10 @@ An Access Grant was deleted. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -107,6 +117,7 @@ All access requested for an Access Grant was successfully granted. { "access_grant_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "All access requested for an Access Grant was successfully granted.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_grant.access_granted_to_all_doors", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -126,6 +137,10 @@ All access requested for an Access Grant was successfully granted. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -155,6 +170,7 @@ Access requested as part of an Access Grant to a particular door was successfull "access_grant_id": "00000000-0000-0000-0000-000000000000", "acs_entrance_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "Access requested as part of an Access Grant to a particular door was successfully granted.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_grant.access_granted_to_door", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -178,6 +194,10 @@ Access requested as part of an Access Grant to a particular door was successfull Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -207,6 +227,7 @@ Access to a particular door that was requested as part of an Access Grant was lo "access_grant_id": "00000000-0000-0000-0000-000000000000", "acs_entrance_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "Access to a particular door that was requested as part of an Access Grant was lost.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_grant.access_to_door_lost", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -230,6 +251,10 @@ Access to a particular door that was requested as part of an Access Grant was lo Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -260,6 +285,7 @@ An Access Grant's start or end time was changed. "access_grant_key": "", "created_at": "2025-01-01T00:00:00.000Z", "ends_at": "2025-01-01T00:00:00.000Z", + "event_description": "An Access Grant's start or end time was changed.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_grant.access_times_changed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -288,6 +314,10 @@ An Access Grant's start or end time was changed. The new end time for the access grant. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -321,6 +351,7 @@ One or more requested access methods could not be created for an Access Grant. "access_grant_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", "error_message": "", + "event_description": "One or more requested access methods could not be created for an Access Grant.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_grant.could_not_create_requested_access_methods", "missing_device_ids": [], @@ -345,6 +376,10 @@ One or more requested access methods could not be created for an Access Grant. Description of why the access methods could not be created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/access_methods/events.mdx b/mintlify-docs/api/access_methods/events.mdx index 9a5964235..44e2fa65c 100644 --- a/mintlify-docs/api/access_methods/events.mdx +++ b/mintlify-docs/api/access_methods/events.mdx @@ -16,6 +16,7 @@ An access method was issued. "access_method_id": "00000000-0000-0000-0000-000000000000", "code": "1234", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An access method was issued.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_method.issued", "is_backup_code": true, @@ -48,6 +49,10 @@ An access method was issued. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -82,6 +87,7 @@ An access method was revoked. "access_grant_keys": [], "access_method_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An access method was revoked.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_method.revoked", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -109,6 +115,10 @@ An access method was revoked. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -139,6 +149,7 @@ An access method representing a physical card requires encoding. "access_grant_keys": [], "access_method_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An access method representing a physical card requires encoding.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_method.card_encoding_required", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -166,6 +177,10 @@ An access method representing a physical card requires encoding. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -196,6 +211,7 @@ An access method was deleted. "access_grant_keys": [], "access_method_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An access method was deleted.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_method.deleted", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -223,6 +239,10 @@ An access method was deleted. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -254,6 +274,7 @@ An access method was reissued. "access_method_id": "00000000-0000-0000-0000-000000000000", "code": "1234", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An access method was reissued.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_method.reissued", "is_backup_code": true, @@ -286,6 +307,10 @@ An access method was reissued. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -320,6 +345,7 @@ An access method was created. "access_grant_keys": [], "access_method_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An access method was created.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "access_method.created", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -347,6 +373,10 @@ An access method was created. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/acs/access_groups/events.mdx b/mintlify-docs/api/acs/access_groups/events.mdx index 6ef53ab70..1d235b026 100644 --- a/mintlify-docs/api/acs/access_groups/events.mdx +++ b/mintlify-docs/api/acs/access_groups/events.mdx @@ -15,6 +15,7 @@ An ACS access group was deleted. "acs_system_id": "00000000-0000-0000-0000-000000000000", "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An ACS access group was deleted.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "acs_access_group.deleted", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -42,6 +43,10 @@ An ACS access group was deleted. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/acs/credentials/events.mdx b/mintlify-docs/api/acs/credentials/events.mdx index 5f89c07c1..98964bdaf 100644 --- a/mintlify-docs/api/acs/credentials/events.mdx +++ b/mintlify-docs/api/acs/credentials/events.mdx @@ -15,6 +15,7 @@ An [access system credential](/low-level-apis/access-systems/managing-credential "acs_system_id": "00000000-0000-0000-0000-000000000000", "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An [access system credential](/low-level-apis/access-systems/managing-credentials) was deleted.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "acs_credential.deleted", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -42,6 +43,10 @@ An [access system credential](/low-level-apis/access-systems/managing-credential Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -72,6 +77,7 @@ An [access system credential](/low-level-apis/access-systems/managing-credential "acs_system_id": "00000000-0000-0000-0000-000000000000", "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An [access system credential](/low-level-apis/access-systems/managing-credentials) was issued.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "acs_credential.issued", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -99,6 +105,10 @@ An [access system credential](/low-level-apis/access-systems/managing-credential Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -129,6 +139,7 @@ An [access system credential](/low-level-apis/access-systems/managing-credential "acs_system_id": "00000000-0000-0000-0000-000000000000", "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An [access system credential](/low-level-apis/access-systems/managing-credentials) was reissued.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "acs_credential.reissued", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -156,6 +167,10 @@ An [access system credential](/low-level-apis/access-systems/managing-credential Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -186,6 +201,7 @@ An [access system credential](/low-level-apis/access-systems/managing-credential "acs_system_id": "00000000-0000-0000-0000-000000000000", "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An [access system credential](/low-level-apis/access-systems/managing-credentials) was invalidated. That is, the credential cannot be used anymore.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "acs_credential.invalidated", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -213,6 +229,10 @@ An [access system credential](/low-level-apis/access-systems/managing-credential Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/acs/encoders/events.mdx b/mintlify-docs/api/acs/encoders/events.mdx index b54bbce11..d88570fa1 100644 --- a/mintlify-docs/api/acs/encoders/events.mdx +++ b/mintlify-docs/api/acs/encoders/events.mdx @@ -15,6 +15,7 @@ An [access system encoder](/low-level-apis/access-systems/working-with-card-enco "acs_system_id": "00000000-0000-0000-0000-000000000000", "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An [access system encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was added.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "acs_encoder.added", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -42,6 +43,10 @@ An [access system encoder](/low-level-apis/access-systems/working-with-card-enco Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -72,6 +77,7 @@ An [access system encoder](/low-level-apis/access-systems/working-with-card-enco "acs_system_id": "00000000-0000-0000-0000-000000000000", "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An [access system encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was removed.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "acs_encoder.removed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -99,6 +105,10 @@ An [access system encoder](/low-level-apis/access-systems/working-with-card-enco Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/acs/entrances/events.mdx b/mintlify-docs/api/acs/entrances/events.mdx index 7b49e8466..084234442 100644 --- a/mintlify-docs/api/acs/entrances/events.mdx +++ b/mintlify-docs/api/acs/entrances/events.mdx @@ -15,6 +15,7 @@ An [access system entrance](/low-level-apis/access-systems/retrieving-entrance-d "acs_system_id": "00000000-0000-0000-0000-000000000000", "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An [access system entrance](/low-level-apis/access-systems/retrieving-entrance-details) was added.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "acs_entrance.added", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -42,6 +43,10 @@ An [access system entrance](/low-level-apis/access-systems/retrieving-entrance-d Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -72,6 +77,7 @@ An [access system entrance](/low-level-apis/access-systems/retrieving-entrance-d "acs_system_id": "00000000-0000-0000-0000-000000000000", "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An [access system entrance](/low-level-apis/access-systems/retrieving-entrance-details) was removed.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "acs_entrance.removed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -99,6 +105,10 @@ An [access system entrance](/low-level-apis/access-systems/retrieving-entrance-d Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/acs/systems/events.mdx b/mintlify-docs/api/acs/systems/events.mdx index 36516e960..7dd631814 100644 --- a/mintlify-docs/api/acs/systems/events.mdx +++ b/mintlify-docs/api/acs/systems/events.mdx @@ -14,6 +14,7 @@ An [access system](/low-level-apis/access-systems) was connected. "acs_system_id": "00000000-0000-0000-0000-000000000000", "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An [access system](/low-level-apis/access-systems) was connected.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "acs_system.connected", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -37,6 +38,10 @@ An [access system](/low-level-apis/access-systems) was connected. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -66,6 +71,7 @@ An [access system](/low-level-apis/access-systems) was added. "acs_system_id": "00000000-0000-0000-0000-000000000000", "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An [access system](/low-level-apis/access-systems) was added.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "acs_system.added", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -89,6 +95,10 @@ An [access system](/low-level-apis/access-systems) was added. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -122,6 +132,7 @@ An [access system](/low-level-apis/access-systems) was disconnected. "connected_account_id": "00000000-0000-0000-0000-000000000000", "connected_account_warnings": [], "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An [access system](/low-level-apis/access-systems) was disconnected.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "acs_system.disconnected", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -161,6 +172,10 @@ An [access system](/low-level-apis/access-systems) was disconnected. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/acs/users/events.mdx b/mintlify-docs/api/acs/users/events.mdx index e77218a69..c2baa2406 100644 --- a/mintlify-docs/api/acs/users/events.mdx +++ b/mintlify-docs/api/acs/users/events.mdx @@ -15,6 +15,7 @@ An [access system user](/low-level-apis/access-systems/user-management) was crea "acs_user_id": "00000000-0000-0000-0000-000000000000", "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An [access system user](/low-level-apis/access-systems/user-management) was created.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "acs_user.created", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -42,6 +43,10 @@ An [access system user](/low-level-apis/access-systems/user-management) was crea Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -72,6 +77,7 @@ An [access system user](/low-level-apis/access-systems/user-management) was dele "acs_user_id": "00000000-0000-0000-0000-000000000000", "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "An [access system user](/low-level-apis/access-systems/user-management) was deleted.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "acs_user.deleted", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -99,6 +105,10 @@ An [access system user](/low-level-apis/access-systems/user-management) was dele Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/action_attempts/events.mdx b/mintlify-docs/api/action_attempts/events.mdx index d21b23ecb..0e8294c17 100644 --- a/mintlify-docs/api/action_attempts/events.mdx +++ b/mintlify-docs/api/action_attempts/events.mdx @@ -16,6 +16,7 @@ A lock door action attempt succeeded. "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A lock door action attempt succeeded.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "action_attempt.lock_door.succeeded", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -48,6 +49,10 @@ A lock door action attempt succeeded. ID of the device associated with the action attempt, if applicable. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -83,6 +88,7 @@ A lock door action attempt failed. "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A lock door action attempt failed.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "action_attempt.lock_door.failed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -115,6 +121,10 @@ A lock door action attempt failed. ID of the device associated with the action attempt, if applicable. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -150,6 +160,7 @@ An unlock door action attempt succeeded. "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "An unlock door action attempt succeeded.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "action_attempt.unlock_door.succeeded", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -182,6 +193,10 @@ An unlock door action attempt succeeded. ID of the device associated with the action attempt, if applicable. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -217,6 +232,7 @@ An unlock door action attempt failed. "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "An unlock door action attempt failed.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "action_attempt.unlock_door.failed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -249,6 +265,10 @@ An unlock door action attempt failed. ID of the device associated with the action attempt, if applicable. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -284,6 +304,7 @@ A simulate keypad code entry action attempt succeeded. "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A simulate keypad code entry action attempt succeeded.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "action_attempt.simulate_keypad_code_entry.succeeded", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -316,6 +337,10 @@ A simulate keypad code entry action attempt succeeded. ID of the device associated with the action attempt, if applicable. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -351,6 +376,7 @@ A simulate keypad code entry action attempt failed. "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A simulate keypad code entry action attempt failed.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "action_attempt.simulate_keypad_code_entry.failed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -383,6 +409,10 @@ A simulate keypad code entry action attempt failed. ID of the device associated with the action attempt, if applicable. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -418,6 +448,7 @@ A simulate manual lock via keypad action attempt succeeded. "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A simulate manual lock via keypad action attempt succeeded.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "action_attempt.simulate_manual_lock_via_keypad.succeeded", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -450,6 +481,10 @@ A simulate manual lock via keypad action attempt succeeded. ID of the device associated with the action attempt, if applicable. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -485,6 +520,7 @@ A simulate manual lock via keypad action attempt failed. "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A simulate manual lock via keypad action attempt failed.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "action_attempt.simulate_manual_lock_via_keypad.failed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -517,6 +553,10 @@ A simulate manual lock via keypad action attempt failed. ID of the device associated with the action attempt, if applicable. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/client_sessions/events.mdx b/mintlify-docs/api/client_sessions/events.mdx index 4672d7afb..560ad7b13 100644 --- a/mintlify-docs/api/client_sessions/events.mdx +++ b/mintlify-docs/api/client_sessions/events.mdx @@ -13,6 +13,7 @@ A client session was deleted. { "client_session_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "A client session was deleted.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "client_session.deleted", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -32,6 +33,10 @@ A client session was deleted. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/connect_webviews/events.mdx b/mintlify-docs/api/connect_webviews/events.mdx index ae541645b..8258b4eab 100644 --- a/mintlify-docs/api/connect_webviews/events.mdx +++ b/mintlify-docs/api/connect_webviews/events.mdx @@ -16,6 +16,7 @@ A Connect Webview login succeeded. "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", "customer_key": "", + "event_description": "A Connect Webview login succeeded.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "connect_webview.login_succeeded", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -47,6 +48,10 @@ A Connect Webview login succeeded. The customer key associated with this connect webview, if any. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -75,6 +80,7 @@ A Connect Webview login failed. { "connect_webview_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "A Connect Webview login failed.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "connect_webview.login_failed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -94,6 +100,10 @@ A Connect Webview login failed. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/connected_accounts/events.mdx b/mintlify-docs/api/connected_accounts/events.mdx index 80c02eb1c..67b3d64b3 100644 --- a/mintlify-docs/api/connected_accounts/events.mdx +++ b/mintlify-docs/api/connected_accounts/events.mdx @@ -16,6 +16,7 @@ A connected account was connected for the first time or was reconnected after be "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", "customer_key": "", + "event_description": "A connected account was connected for the first time or was reconnected after being disconnected.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "connected_account.connected", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -47,6 +48,10 @@ A connected account was connected for the first time or was reconnected after be The customer key associated with this connected account, if any. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -77,6 +82,7 @@ A connected account was created. "connected_account_custom_metadata": {}, "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "A connected account was created.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "connected_account.created", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -104,6 +110,10 @@ A connected account was created. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -134,6 +144,7 @@ A connected account had a successful login using a Connect Webview. "connected_account_custom_metadata": {}, "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "A connected account had a successful login using a Connect Webview.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "connected_account.successful_login", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -161,6 +172,10 @@ A connected account had a successful login using a Connect Webview. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -192,6 +207,7 @@ A connected account was disconnected. "connected_account_id": "00000000-0000-0000-0000-000000000000", "connected_account_warnings": [], "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "A connected account was disconnected.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "connected_account.disconnected", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -223,6 +239,10 @@ A connected account was disconnected. Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -252,6 +272,7 @@ A connected account completed the first sync with Seam, and the corresponding de "connected_account_custom_metadata": {}, "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "A connected account completed the first sync with Seam, and the corresponding devices or systems are now available.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "connected_account.completed_first_sync", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -275,6 +296,10 @@ A connected account completed the first sync with Seam, and the corresponding de Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -306,6 +331,7 @@ A connected account was deleted. "connected_account_type": "", "created_at": "2025-01-01T00:00:00.000Z", "customer_key": "", + "event_description": "A connected account was deleted.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "connected_account.deleted", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -337,6 +363,10 @@ A connected account was deleted. The customer key associated with this connected account, if any. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -366,6 +396,7 @@ A connected account completed the first sync after reconnection with Seam, and t "connected_account_custom_metadata": {}, "connected_account_id": "00000000-0000-0000-0000-000000000000", "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "A connected account completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "connected_account.completed_first_sync_after_reconnection", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -389,6 +420,10 @@ A connected account completed the first sync after reconnection with Seam, and t Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -420,6 +455,7 @@ A connected account requires reauthorization using a new Connect Webview. The ac "connected_account_id": "00000000-0000-0000-0000-000000000000", "connected_account_warnings": [], "created_at": "2025-01-01T00:00:00.000Z", + "event_description": "A connected account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "connected_account.reauthorization_requested", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -451,6 +487,10 @@ A connected account requires reauthorization using a new Connect Webview. The ac Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/devices/events.mdx b/mintlify-docs/api/devices/events.mdx index 00d923626..715ff09df 100644 --- a/mintlify-docs/api/devices/events.mdx +++ b/mintlify-docs/api/devices/events.mdx @@ -17,6 +17,7 @@ The status of a device changed from offline to online. That is, the `device.prop "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "The status of a device changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`. Note that some devices operate entirely in offline mode, so Seam never emits a `device.connected` event for these devices.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.connected", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -52,6 +53,10 @@ The status of a device changed from offline to online. That is, the `device.prop ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -84,6 +89,7 @@ A device was added to Seam or was re-added to Seam after having been removed. "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A device was added to Seam or was re-added to Seam after having been removed.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.added", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -119,6 +125,10 @@ A device was added to Seam or was re-added to Seam after having been removed. ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -151,6 +161,7 @@ A managed device was successfully converted to an [unmanaged device](/core-conce "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A managed device was successfully converted to an [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices).", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.converted_to_unmanaged", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -186,6 +197,10 @@ A managed device was successfully converted to an [unmanaged device](/core-conce ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -223,6 +238,7 @@ The status of a device changed from online to offline. That is, the `device.prop "device_id": "00000000-0000-0000-0000-000000000000", "device_warnings": [], "error_code": "account_disconnected", + "event_description": "The status of a device changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.disconnected", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -280,6 +296,10 @@ The status of a device changed from online to offline. That is, the `device.prop Possible values: `account_disconnected`, `hub_disconnected`, `device_disconnected` + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -312,6 +332,7 @@ A device detected that it was tampered with, for example, opened or moved. "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A device detected that it was tampered with, for example, opened or moved.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.tampered", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -347,6 +368,10 @@ A device detected that it was tampered with, for example, opened or moved. ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -380,6 +405,7 @@ A device battery level dropped below the low threshold. "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A device battery level dropped below the low threshold.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.low_battery", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -419,6 +445,10 @@ A device battery level dropped below the low threshold. ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -453,6 +483,7 @@ A device battery status changed since the last `battery_status_changed` event. "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A device battery status changed since the last `battery_status_changed` event.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.battery_status_changed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -498,6 +529,10 @@ A device battery status changed since the last `battery_status_changed` event. ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -530,6 +565,7 @@ A device was removed externally from the connected account. "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A device was removed externally from the connected account.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.removed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -565,6 +601,10 @@ A device was removed externally from the connected account. ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -598,6 +638,7 @@ A device was deleted. "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", "device_name": "", + "event_description": "A device was deleted.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.deleted", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -637,6 +678,10 @@ A device was deleted. Name of the deleted device, captured at deletion time. The device record no longer exists when this event fires, so the name is preserved here. Null when the device had no resolvable name. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -669,6 +714,7 @@ Seam detected that a device is using a third-party integration that will interfe "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "Seam detected that a device is using a third-party integration that will interfere with Seam device management.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.third_party_integration_detected", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -704,6 +750,10 @@ Seam detected that a device is using a third-party integration that will interfe ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -736,6 +786,7 @@ Seam detected that a device is no longer using a third-party integration that wa "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.third_party_integration_no_longer_detected", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -771,6 +822,10 @@ Seam detected that a device is no longer using a third-party integration that wa ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -803,6 +858,7 @@ A [Salto device](/device-and-system-integration-guides/salto-locks) activated pr "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A [Salto device](/device-and-system-integration-guides/salto-locks) activated privacy mode.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.salto.privacy_mode_activated", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -838,6 +894,10 @@ A [Salto device](/device-and-system-integration-guides/salto-locks) activated pr ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -870,6 +930,7 @@ A [Salto device](/device-and-system-integration-guides/salto-locks) deactivated "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A [Salto device](/device-and-system-integration-guides/salto-locks) deactivated privacy mode.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.salto.privacy_mode_deactivated", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -905,6 +966,10 @@ A [Salto device](/device-and-system-integration-guides/salto-locks) deactivated ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -941,6 +1006,7 @@ Seam detected a flaky device connection. "device_errors": [], "device_id": "00000000-0000-0000-0000-000000000000", "device_warnings": [], + "event_description": "Seam detected a flaky device connection.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.connection_became_flaky", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -992,6 +1058,10 @@ Seam detected a flaky device connection. Warnings associated with the device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -1024,6 +1094,7 @@ Seam detected that a previously-flaky device connection stabilized. "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "Seam detected that a previously-flaky device connection stabilized.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.connection_stabilized", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -1059,6 +1130,10 @@ Seam detected that a previously-flaky device connection stabilized. ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -1095,6 +1170,7 @@ A third-party subscription is required to use all device features. "device_errors": [], "device_id": "00000000-0000-0000-0000-000000000000", "device_warnings": [], + "event_description": "A third-party subscription is required to use all device features.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.error.subscription_required", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -1146,6 +1222,10 @@ A third-party subscription is required to use all device features. Warnings associated with the device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -1178,6 +1258,7 @@ A third-party subscription is active or no longer required to use all device fea "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A third-party subscription is active or no longer required to use all device features.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.error.subscription_required.resolved", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -1213,6 +1294,10 @@ A third-party subscription is active or no longer required to use all device fea ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -1245,6 +1330,7 @@ An accessory keypad was connected to a device. "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "An accessory keypad was connected to a device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.accessory_keypad_connected", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -1280,6 +1366,10 @@ An accessory keypad was connected to a device. ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -1316,6 +1406,7 @@ An accessory keypad was disconnected from a device. "device_errors": [], "device_id": "00000000-0000-0000-0000-000000000000", "device_warnings": [], + "event_description": "An accessory keypad was disconnected from a device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.accessory_keypad_disconnected", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -1367,6 +1458,10 @@ An accessory keypad was disconnected from a device. Warnings associated with the device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -1400,6 +1495,7 @@ The name of a device was changed. "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", "device_name": "", + "event_description": "The name of a device was changed.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.name_changed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -1439,6 +1535,10 @@ The name of a device was changed. The new name of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -1472,6 +1572,7 @@ A camera was activated, for example, by motion detection. "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A camera was activated, for example, by motion detection.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "camera.activated", "image_url": "", @@ -1516,6 +1617,10 @@ A camera was activated, for example, by motion detection. ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -1562,6 +1667,7 @@ A doorbell button was pressed on a device. "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A doorbell button was pressed on a device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.doorbell_rang", "image_url": "", @@ -1599,6 +1705,10 @@ A doorbell button was pressed on a device. ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/devices/unmanaged/events.mdx b/mintlify-docs/api/devices/unmanaged/events.mdx index 9ebb73b8f..35fb3be96 100644 --- a/mintlify-docs/api/devices/unmanaged/events.mdx +++ b/mintlify-docs/api/devices/unmanaged/events.mdx @@ -17,6 +17,7 @@ An [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices) was "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "An [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.unmanaged.converted_to_managed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -52,6 +53,10 @@ An [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices) was ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -84,6 +89,7 @@ The status of an [unmanaged device](/core-concepts/devices/managed-and-unmanaged "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "The status of an [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices) changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.unmanaged.connected", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -119,6 +125,10 @@ The status of an [unmanaged device](/core-concepts/devices/managed-and-unmanaged ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -156,6 +166,7 @@ The status of an [unmanaged device](/core-concepts/devices/managed-and-unmanaged "device_id": "00000000-0000-0000-0000-000000000000", "device_warnings": [], "error_code": "account_disconnected", + "event_description": "The status of an [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices) changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "device.unmanaged.disconnected", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -213,6 +224,10 @@ The status of an [unmanaged device](/core-concepts/devices/managed-and-unmanaged Possible values: `account_disconnected`, `hub_disconnected`, `device_disconnected` + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/events/object.mdx b/mintlify-docs/api/events/object.mdx index d03a53dd6..99563eefc 100644 --- a/mintlify-docs/api/events/object.mdx +++ b/mintlify-docs/api/events/object.mdx @@ -32,6 +32,10 @@ description: 'Learn how the event object represents an occurrence in your worksp Date and time at which the event was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/locks/events.mdx b/mintlify-docs/api/locks/events.mdx index ec80efcf5..11ab67b94 100644 --- a/mintlify-docs/api/locks/events.mdx +++ b/mintlify-docs/api/locks/events.mdx @@ -21,6 +21,7 @@ A [lock](/low-level-apis/smart-locks) was locked. "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A [lock](/low-level-apis/smart-locks) was locked.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "lock.locked", "is_via_bluetooth": true, @@ -75,6 +76,10 @@ A [lock](/low-level-apis/smart-locks) was locked. ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -128,6 +133,7 @@ A [lock](/low-level-apis/smart-locks) was unlocked. "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A [lock](/low-level-apis/smart-locks) was unlocked.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "lock.unlocked", "is_via_bluetooth": true, @@ -201,6 +207,10 @@ A [lock](/low-level-apis/smart-locks) was unlocked. ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -257,6 +267,7 @@ The [lock](/low-level-apis/smart-locks) denied access to a user after one or mor "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "The [lock](/low-level-apis/smart-locks) denied access to a user after one or more consecutive invalid attempts to unlock the device.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "lock.access_denied", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -315,6 +326,10 @@ The [lock](/low-level-apis/smart-locks) denied access to a user after one or mor ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/noise_sensors/noise_thresholds/events.mdx b/mintlify-docs/api/noise_sensors/noise_thresholds/events.mdx index 6cb352034..2140bd4f3 100644 --- a/mintlify-docs/api/noise_sensors/noise_thresholds/events.mdx +++ b/mintlify-docs/api/noise_sensors/noise_thresholds/events.mdx @@ -17,6 +17,7 @@ Extended periods of noise or noise exceeding a [threshold](/capability-guides/no "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "Extended periods of noise or noise exceeding a [threshold](/capability-guides/noise-sensors#what-is-a-threshold) were detected.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "noise_sensor.noise_threshold_triggered", "minut_metadata": {}, @@ -58,6 +59,10 @@ Extended periods of noise or noise exceeding a [threshold](/capability-guides/no ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/phones/events.mdx b/mintlify-docs/api/phones/events.mdx index b33fb5239..4c000ea87 100644 --- a/mintlify-docs/api/phones/events.mdx +++ b/mintlify-docs/api/phones/events.mdx @@ -14,6 +14,7 @@ A phone device was deactivated. "created_at": "2025-01-01T00:00:00.000Z", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A phone device was deactivated.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "phone.deactivated", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -37,6 +38,10 @@ A phone device was deactivated. ID of the affected phone device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/spaces/events.mdx b/mintlify-docs/api/spaces/events.mdx index 9b8d812d5..abbf58349 100644 --- a/mintlify-docs/api/spaces/events.mdx +++ b/mintlify-docs/api/spaces/events.mdx @@ -14,6 +14,7 @@ A device was added or removed from a space. "acs_entrance_ids": [], "created_at": "2025-01-01T00:00:00.000Z", "device_ids": [], + "event_description": "A device was added or removed from a space.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "space.device_membership_changed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -39,6 +40,10 @@ A device was added or removed from a space. IDs of all devices currently attached to the space. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -76,6 +81,7 @@ A space was created. "acs_entrance_ids": [], "created_at": "2025-01-01T00:00:00.000Z", "device_ids": [], + "event_description": "A space was created.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "space.created", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -101,6 +107,10 @@ A space was created. IDs of all devices attached to the space when it was created. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -138,6 +148,7 @@ A space was deleted. "acs_entrance_ids": [], "created_at": "2025-01-01T00:00:00.000Z", "device_ids": [], + "event_description": "A space was deleted.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "space.deleted", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -163,6 +174,10 @@ A space was deleted. IDs of all devices attached to the space when it was deleted. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/api/thermostats/events.mdx b/mintlify-docs/api/thermostats/events.mdx index 87c9861a4..408628559 100644 --- a/mintlify-docs/api/thermostats/events.mdx +++ b/mintlify-docs/api/thermostats/events.mdx @@ -18,6 +18,7 @@ A thermostat [climate preset](/capability-guides/thermostats/creating-and-managi "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A thermostat [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "thermostat.climate_preset_activated", "is_fallback_climate_preset": true, @@ -59,6 +60,10 @@ A thermostat [climate preset](/capability-guides/thermostats/creating-and-managi ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -101,6 +106,7 @@ A [thermostat](/capability-guides/thermostats) was adjusted manually. "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A [thermostat](/capability-guides/thermostats) was adjusted manually.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "thermostat.manually_adjusted", "fan_mode_setting": "auto", @@ -149,6 +155,10 @@ A [thermostat](/capability-guides/thermostats) was adjusted manually. ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -207,6 +217,7 @@ A [thermostat's](/capability-guides/thermostats) temperature reading exceeded th "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A [thermostat's](/capability-guides/thermostats) temperature reading exceeded the set [threshold](/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "thermostat.temperature_threshold_exceeded", "lower_limit_celsius": 0, @@ -248,6 +259,10 @@ A [thermostat's](/capability-guides/thermostats) temperature reading exceeded th ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -304,6 +319,7 @@ A [thermostat's](/capability-guides/thermostats) temperature reading no longer e "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A [thermostat's](/capability-guides/thermostats) temperature reading no longer exceeds the set [threshold](/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "thermostat.temperature_threshold_no_longer_exceeded", "lower_limit_celsius": 0, @@ -345,6 +361,10 @@ A [thermostat's](/capability-guides/thermostats) temperature reading no longer e ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -403,6 +423,7 @@ A [thermostat's](/capability-guides/thermostats) temperature reading is within 1 "desired_temperature_fahrenheit": 0, "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A [thermostat's](/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "thermostat.temperature_reached_set_point", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -448,6 +469,10 @@ A [thermostat's](/capability-guides/thermostats) temperature reading is within 1 ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. @@ -488,6 +513,7 @@ A [thermostat's](/capability-guides/thermostats) reported temperature changed by "customer_key": "", "device_custom_metadata": {}, "device_id": "00000000-0000-0000-0000-000000000000", + "event_description": "A [thermostat's](/capability-guides/thermostats) reported temperature changed by at least 1 °C.", "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "thermostat.temperature_changed", "occurred_at": "2025-01-01T00:00:00.000Z", @@ -525,6 +551,10 @@ A [thermostat's](/capability-guides/thermostats) reported temperature changed by ID of the affected device. + + Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. + + ID of the event. diff --git a/mintlify-docs/openapi.json b/mintlify-docs/openapi.json index bbe056451..98ac10ec4 100644 --- a/mintlify-docs/openapi.json +++ b/mintlify-docs/openapi.json @@ -8592,6 +8592,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -8711,6 +8715,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -8801,6 +8809,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -8922,6 +8934,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -9043,6 +9059,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -9172,6 +9192,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -9298,6 +9322,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -9389,6 +9417,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -9476,6 +9508,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -9730,6 +9766,10 @@ }, "type": "array" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -9990,6 +10030,10 @@ }, "type": "array" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -10087,6 +10131,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -10342,6 +10390,10 @@ }, "type": "array" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -10602,6 +10654,10 @@ }, "type": "array" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -10694,6 +10750,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -10780,6 +10840,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -10870,6 +10934,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -10957,6 +11025,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -11211,6 +11283,10 @@ }, "type": "array" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -11303,6 +11379,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -11389,6 +11469,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -11437,6 +11521,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -11483,6 +11571,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -11529,6 +11621,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -11580,6 +11676,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -11632,6 +11732,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -11687,6 +11791,10 @@ "description": "The new end time for the access grant.", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -11741,6 +11849,10 @@ "description": "Description of why the access methods could not be created.", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -11815,6 +11927,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -11881,6 +11997,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -11943,6 +12063,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12005,6 +12129,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12071,6 +12199,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12137,6 +12269,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12189,6 +12325,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12240,6 +12380,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12403,6 +12547,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12463,6 +12611,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12520,6 +12672,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12577,6 +12733,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12634,6 +12794,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12691,6 +12855,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12748,6 +12916,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12805,6 +12977,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12862,6 +13038,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12919,6 +13099,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -12976,6 +13160,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -13033,6 +13221,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -13080,6 +13272,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -13149,6 +13345,10 @@ "description": "The customer key associated with this connected account, if any.", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -13214,6 +13414,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -13281,6 +13485,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -13399,6 +13607,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -13461,6 +13673,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -13529,6 +13745,10 @@ "description": "The customer key associated with this connected account, if any.", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -13589,6 +13809,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -13705,6 +13929,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -13767,6 +13995,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -13833,6 +14065,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -13899,6 +14135,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -13965,6 +14205,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -14031,6 +14275,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -14097,6 +14345,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -14163,6 +14415,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -14229,6 +14485,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -14304,6 +14564,10 @@ "description": "The customer key associated with this connect webview, if any.", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -14351,6 +14615,10 @@ "format": "date-time", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -14434,6 +14702,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -14518,6 +14790,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -14602,6 +14878,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -14686,6 +14966,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -14770,6 +15054,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -14975,6 +15263,10 @@ ], "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -15185,6 +15477,10 @@ ], "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -15274,6 +15570,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -15365,6 +15665,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -15467,6 +15771,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -15553,6 +15861,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -15642,6 +15954,10 @@ "nullable": true, "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -15726,6 +16042,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -15810,6 +16130,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -15894,6 +16218,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -15978,6 +16306,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -16174,6 +16506,10 @@ }, "type": "array" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -16262,6 +16598,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -16458,6 +16798,10 @@ }, "type": "array" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -16546,6 +16890,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -16630,6 +16978,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -16826,6 +17178,10 @@ }, "type": "array" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -16914,6 +17270,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -17045,6 +17405,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -17182,6 +17546,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -17310,6 +17678,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -17402,6 +17774,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -17509,6 +17885,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -17632,6 +18012,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -17756,6 +18140,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -17890,6 +18278,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -17986,6 +18378,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -18086,6 +18482,10 @@ "description": "The new name of the affected device.", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -18178,6 +18578,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -18283,6 +18687,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -18340,6 +18748,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -18400,6 +18812,10 @@ "format": "uuid", "type": "string" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -18457,6 +18873,10 @@ }, "type": "array" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -18526,6 +18946,10 @@ }, "type": "array" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", @@ -18595,6 +19019,10 @@ }, "type": "array" }, + "event_description": { + "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", + "type": "string" + }, "event_id": { "description": "ID of the event.", "format": "uuid", diff --git a/package-lock.json b/package-lock.json index b3411e19a..3546a4368 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.56.0", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.947.0", + "@seamapi/types": "1.948.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", @@ -4094,9 +4094,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.947.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.947.0.tgz", - "integrity": "sha512-pKV5CM8jy0xe+NbcqBtWSw3KkYKrwVc+WslR9jmKUHFIk7w2EsfMmWj08MdU5Ek3GlIA0LSxkiripnHQdZhsPA==", + "version": "1.948.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.948.0.tgz", + "integrity": "sha512-GMuenTTADIo6GnrxcKI06p32Ggla7Xmcu4oSpYP5zRFzTjlQaqjRShwnljGm51EgyaupCp9VEDcZTgSQKbmNtA==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 0bcd7cb19..fc8e780fe 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.56.0", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.947.0", + "@seamapi/types": "1.948.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9",