diff --git a/docs/api-reference/_blueprint.json b/docs/api-reference/_blueprint.json index 043fbb1f9..002680f91 100644 --- a/docs/api-reference/_blueprint.json +++ b/docs/api-reference/_blueprint.json @@ -94832,7 +94832,7 @@ "description": "Indicates that the Salto site user limit has been reached." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -94861,7 +94861,7 @@ "jsonType": "string", "values": [ { - "name": "device_offline", + "name": "dormakaba_sites_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -94872,9 +94872,22 @@ } ] }, + { + "name": "is_connected_account_error", + "description": "Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, { "name": "is_device_error", - "description": "Indicates that the error is a device error.", + "description": "Indicates that the error is not a device error.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -94899,7 +94912,7 @@ "jsonType": "string" } ], - "description": "Indicates that the device is offline." + "description": "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support." }, { "variantGroupKey": null, @@ -94931,7 +94944,7 @@ "jsonType": "string", "values": [ { - "name": "device_removed", + "name": "device_offline", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -94969,7 +94982,7 @@ "jsonType": "string" } ], - "description": "Indicates that the device has been removed." + "description": "Indicates that the device is offline." }, { "variantGroupKey": null, @@ -95001,7 +95014,7 @@ "jsonType": "string", "values": [ { - "name": "hub_disconnected", + "name": "device_removed", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -95039,7 +95052,7 @@ "jsonType": "string" } ], - "description": "Indicates that the hub is disconnected." + "description": "Indicates that the device has been removed." }, { "variantGroupKey": null, @@ -95071,7 +95084,7 @@ "jsonType": "string", "values": [ { - "name": "device_disconnected", + "name": "hub_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -95109,10 +95122,10 @@ "jsonType": "string" } ], - "description": "Indicates that the device is disconnected." + "description": "Indicates that the hub is disconnected." }, { - "variantGroupKey": "access_codes", + "variantGroupKey": null, "properties": [ { "name": "created_at", @@ -95141,7 +95154,7 @@ "jsonType": "string", "values": [ { - "name": "empty_backup_access_code_pool", + "name": "device_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -95179,10 +95192,10 @@ "jsonType": "string" } ], - "description": "Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty." + "description": "Indicates that the device is disconnected." }, { - "variantGroupKey": "locks", + "variantGroupKey": "access_codes", "properties": [ { "name": "created_at", @@ -95211,7 +95224,7 @@ "jsonType": "string", "values": [ { - "name": "august_lock_not_authorized", + "name": "empty_backup_access_code_pool", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -95249,7 +95262,7 @@ "jsonType": "string" } ], - "description": "Indicates that the user is not authorized to use the August lock." + "description": "Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty." }, { "variantGroupKey": "locks", @@ -95281,7 +95294,7 @@ "jsonType": "string", "values": [ { - "name": "august_lock_missing_bridge", + "name": "august_lock_not_authorized", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -95319,10 +95332,10 @@ "jsonType": "string" } ], - "description": "Indicates that the lock is not connected to a bridge." + "description": "Indicates that the user is not authorized to use the August lock." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -95351,7 +95364,7 @@ "jsonType": "string", "values": [ { - "name": "ttlock_lock_not_paired_to_gateway", + "name": "august_lock_missing_bridge", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -95389,10 +95402,10 @@ "jsonType": "string" } ], - "description": "Indicates that the lock is not paired with a gateway." + "description": "Indicates that the lock is not connected to a bridge." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -95421,7 +95434,7 @@ "jsonType": "string", "values": [ { - "name": "missing_device_credentials", + "name": "ttlock_lock_not_paired_to_gateway", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -95459,10 +95472,10 @@ "jsonType": "string" } ], - "description": "Indicates that device credentials are missing." + "description": "Indicates that the lock is not paired with a gateway." }, { - "variantGroupKey": "thermostats", + "variantGroupKey": null, "properties": [ { "name": "created_at", @@ -95491,7 +95504,7 @@ "jsonType": "string", "values": [ { - "name": "auxiliary_heat_running", + "name": "missing_device_credentials", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -95529,10 +95542,10 @@ "jsonType": "string" } ], - "description": "Indicates that the auxiliary heat is running." + "description": "Indicates that device credentials are missing." }, { - "variantGroupKey": null, + "variantGroupKey": "thermostats", "properties": [ { "name": "created_at", @@ -95561,7 +95574,7 @@ "jsonType": "string", "values": [ { - "name": "subscription_required", + "name": "auxiliary_heat_running", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -95599,7 +95612,7 @@ "jsonType": "string" } ], - "description": "Indicates that a subscription is required to connect." + "description": "Indicates that the auxiliary heat is running." }, { "variantGroupKey": null, @@ -95631,7 +95644,7 @@ "jsonType": "string", "values": [ { - "name": "lockly_missing_wifi_bridge", + "name": "subscription_required", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -95669,10 +95682,10 @@ "jsonType": "string" } ], - "description": "Indicates that the Lockly lock is not connected to a Wi-Fi bridge." + "description": "Indicates that a subscription is required to connect." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -95701,7 +95714,7 @@ "jsonType": "string", "values": [ { - "name": "bridge_disconnected", + "name": "lockly_missing_wifi_bridge", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -95713,21 +95726,8 @@ ] }, { - "name": "is_bridge_error", - "description": "Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "boolean", - "jsonType": "boolean" - }, - { - "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "name": "is_device_error", + "description": "Indicates that the error is a device error.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -95752,7 +95752,7 @@ "jsonType": "string" } ], - "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)." + "description": "Indicates that the Lockly lock is not connected to a Wi-Fi bridge." }, { "variantGroupKey": null, @@ -95784,7 +95784,7 @@ "jsonType": "string", "values": [ { - "name": "dormakaba_sites_disconnected", + "name": "bridge_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -95835,7 +95835,7 @@ "jsonType": "string" } ], - "description": "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support." + "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)." } ] }, @@ -112128,7 +112128,7 @@ "description": "Indicates that the Salto site user limit has been reached." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -112157,7 +112157,7 @@ "jsonType": "string", "values": [ { - "name": "device_offline", + "name": "dormakaba_sites_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -112168,9 +112168,22 @@ } ] }, + { + "name": "is_connected_account_error", + "description": "Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, { "name": "is_device_error", - "description": "Indicates that the error is a device error.", + "description": "Indicates that the error is not a device error.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -112195,7 +112208,7 @@ "jsonType": "string" } ], - "description": "Indicates that the device is offline." + "description": "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support." }, { "variantGroupKey": null, @@ -112227,7 +112240,7 @@ "jsonType": "string", "values": [ { - "name": "device_removed", + "name": "device_offline", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -112265,7 +112278,7 @@ "jsonType": "string" } ], - "description": "Indicates that the device has been removed." + "description": "Indicates that the device is offline." }, { "variantGroupKey": null, @@ -112297,7 +112310,7 @@ "jsonType": "string", "values": [ { - "name": "hub_disconnected", + "name": "device_removed", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -112335,7 +112348,7 @@ "jsonType": "string" } ], - "description": "Indicates that the hub is disconnected." + "description": "Indicates that the device has been removed." }, { "variantGroupKey": null, @@ -112367,7 +112380,7 @@ "jsonType": "string", "values": [ { - "name": "device_disconnected", + "name": "hub_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -112405,10 +112418,10 @@ "jsonType": "string" } ], - "description": "Indicates that the device is disconnected." + "description": "Indicates that the hub is disconnected." }, { - "variantGroupKey": "access_codes", + "variantGroupKey": null, "properties": [ { "name": "created_at", @@ -112437,7 +112450,7 @@ "jsonType": "string", "values": [ { - "name": "empty_backup_access_code_pool", + "name": "device_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -112475,10 +112488,10 @@ "jsonType": "string" } ], - "description": "Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty." + "description": "Indicates that the device is disconnected." }, { - "variantGroupKey": "locks", + "variantGroupKey": "access_codes", "properties": [ { "name": "created_at", @@ -112507,7 +112520,7 @@ "jsonType": "string", "values": [ { - "name": "august_lock_not_authorized", + "name": "empty_backup_access_code_pool", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -112545,7 +112558,7 @@ "jsonType": "string" } ], - "description": "Indicates that the user is not authorized to use the August lock." + "description": "Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty." }, { "variantGroupKey": "locks", @@ -112577,7 +112590,7 @@ "jsonType": "string", "values": [ { - "name": "august_lock_missing_bridge", + "name": "august_lock_not_authorized", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -112615,10 +112628,10 @@ "jsonType": "string" } ], - "description": "Indicates that the lock is not connected to a bridge." + "description": "Indicates that the user is not authorized to use the August lock." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -112647,7 +112660,7 @@ "jsonType": "string", "values": [ { - "name": "ttlock_lock_not_paired_to_gateway", + "name": "august_lock_missing_bridge", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -112685,10 +112698,10 @@ "jsonType": "string" } ], - "description": "Indicates that the lock is not paired with a gateway." + "description": "Indicates that the lock is not connected to a bridge." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -112717,7 +112730,7 @@ "jsonType": "string", "values": [ { - "name": "missing_device_credentials", + "name": "ttlock_lock_not_paired_to_gateway", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -112755,10 +112768,10 @@ "jsonType": "string" } ], - "description": "Indicates that device credentials are missing." + "description": "Indicates that the lock is not paired with a gateway." }, { - "variantGroupKey": "thermostats", + "variantGroupKey": null, "properties": [ { "name": "created_at", @@ -112787,7 +112800,7 @@ "jsonType": "string", "values": [ { - "name": "auxiliary_heat_running", + "name": "missing_device_credentials", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -112825,10 +112838,10 @@ "jsonType": "string" } ], - "description": "Indicates that the auxiliary heat is running." + "description": "Indicates that device credentials are missing." }, { - "variantGroupKey": null, + "variantGroupKey": "thermostats", "properties": [ { "name": "created_at", @@ -112857,7 +112870,7 @@ "jsonType": "string", "values": [ { - "name": "subscription_required", + "name": "auxiliary_heat_running", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -112895,7 +112908,7 @@ "jsonType": "string" } ], - "description": "Indicates that a subscription is required to connect." + "description": "Indicates that the auxiliary heat is running." }, { "variantGroupKey": null, @@ -112927,7 +112940,7 @@ "jsonType": "string", "values": [ { - "name": "lockly_missing_wifi_bridge", + "name": "subscription_required", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -112965,10 +112978,10 @@ "jsonType": "string" } ], - "description": "Indicates that the Lockly lock is not connected to a Wi-Fi bridge." + "description": "Indicates that a subscription is required to connect." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -112997,7 +113010,7 @@ "jsonType": "string", "values": [ { - "name": "bridge_disconnected", + "name": "lockly_missing_wifi_bridge", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -113009,21 +113022,8 @@ ] }, { - "name": "is_bridge_error", - "description": "Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "boolean", - "jsonType": "boolean" - }, - { - "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "name": "is_device_error", + "description": "Indicates that the error is a device error.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -113048,7 +113048,7 @@ "jsonType": "string" } ], - "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)." + "description": "Indicates that the Lockly lock is not connected to a Wi-Fi bridge." }, { "variantGroupKey": null, @@ -113080,7 +113080,7 @@ "jsonType": "string", "values": [ { - "name": "dormakaba_sites_disconnected", + "name": "bridge_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -113131,7 +113131,7 @@ "jsonType": "string" } ], - "description": "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support." + "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)." } ] }, @@ -119923,7 +119923,7 @@ "description": "Indicates that there are too many backup codes." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -120094,7 +120094,7 @@ "description": "Indicates that the Remote Unlock feature is not enabled in the settings.\"" }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -120550,7 +120550,7 @@ "description": "Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -120721,7 +120721,7 @@ "description": "Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -120778,7 +120778,7 @@ "description": "Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -120835,7 +120835,7 @@ "description": "Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -129558,7 +129558,7 @@ "description": "Indicates that the Salto site user limit has been reached." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -129587,7 +129587,7 @@ "jsonType": "string", "values": [ { - "name": "device_offline", + "name": "dormakaba_sites_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -129598,9 +129598,22 @@ } ] }, + { + "name": "is_connected_account_error", + "description": "Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, { "name": "is_device_error", - "description": "Indicates that the error is a device error.", + "description": "Indicates that the error is not a device error.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -129625,7 +129638,7 @@ "jsonType": "string" } ], - "description": "Indicates that the device is offline." + "description": "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support." }, { "variantGroupKey": null, @@ -129657,7 +129670,7 @@ "jsonType": "string", "values": [ { - "name": "device_removed", + "name": "device_offline", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -129695,7 +129708,7 @@ "jsonType": "string" } ], - "description": "Indicates that the device has been removed." + "description": "Indicates that the device is offline." }, { "variantGroupKey": null, @@ -129727,7 +129740,7 @@ "jsonType": "string", "values": [ { - "name": "hub_disconnected", + "name": "device_removed", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -129765,7 +129778,7 @@ "jsonType": "string" } ], - "description": "Indicates that the hub is disconnected." + "description": "Indicates that the device has been removed." }, { "variantGroupKey": null, @@ -129797,7 +129810,7 @@ "jsonType": "string", "values": [ { - "name": "device_disconnected", + "name": "hub_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -129835,10 +129848,10 @@ "jsonType": "string" } ], - "description": "Indicates that the device is disconnected." + "description": "Indicates that the hub is disconnected." }, { - "variantGroupKey": "access_codes", + "variantGroupKey": null, "properties": [ { "name": "created_at", @@ -129867,7 +129880,7 @@ "jsonType": "string", "values": [ { - "name": "empty_backup_access_code_pool", + "name": "device_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -129905,10 +129918,10 @@ "jsonType": "string" } ], - "description": "Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty." + "description": "Indicates that the device is disconnected." }, { - "variantGroupKey": "locks", + "variantGroupKey": "access_codes", "properties": [ { "name": "created_at", @@ -129937,7 +129950,7 @@ "jsonType": "string", "values": [ { - "name": "august_lock_not_authorized", + "name": "empty_backup_access_code_pool", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -129975,7 +129988,7 @@ "jsonType": "string" } ], - "description": "Indicates that the user is not authorized to use the August lock." + "description": "Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty." }, { "variantGroupKey": "locks", @@ -130007,7 +130020,7 @@ "jsonType": "string", "values": [ { - "name": "august_lock_missing_bridge", + "name": "august_lock_not_authorized", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -130045,10 +130058,10 @@ "jsonType": "string" } ], - "description": "Indicates that the lock is not connected to a bridge." + "description": "Indicates that the user is not authorized to use the August lock." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -130077,7 +130090,7 @@ "jsonType": "string", "values": [ { - "name": "ttlock_lock_not_paired_to_gateway", + "name": "august_lock_missing_bridge", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -130115,10 +130128,10 @@ "jsonType": "string" } ], - "description": "Indicates that the lock is not paired with a gateway." + "description": "Indicates that the lock is not connected to a bridge." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -130147,7 +130160,7 @@ "jsonType": "string", "values": [ { - "name": "missing_device_credentials", + "name": "ttlock_lock_not_paired_to_gateway", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -130185,10 +130198,10 @@ "jsonType": "string" } ], - "description": "Indicates that device credentials are missing." + "description": "Indicates that the lock is not paired with a gateway." }, { - "variantGroupKey": "thermostats", + "variantGroupKey": null, "properties": [ { "name": "created_at", @@ -130217,7 +130230,7 @@ "jsonType": "string", "values": [ { - "name": "auxiliary_heat_running", + "name": "missing_device_credentials", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -130255,10 +130268,10 @@ "jsonType": "string" } ], - "description": "Indicates that the auxiliary heat is running." + "description": "Indicates that device credentials are missing." }, { - "variantGroupKey": null, + "variantGroupKey": "thermostats", "properties": [ { "name": "created_at", @@ -130287,7 +130300,7 @@ "jsonType": "string", "values": [ { - "name": "subscription_required", + "name": "auxiliary_heat_running", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -130325,7 +130338,7 @@ "jsonType": "string" } ], - "description": "Indicates that a subscription is required to connect." + "description": "Indicates that the auxiliary heat is running." }, { "variantGroupKey": null, @@ -130357,7 +130370,7 @@ "jsonType": "string", "values": [ { - "name": "lockly_missing_wifi_bridge", + "name": "subscription_required", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -130395,10 +130408,10 @@ "jsonType": "string" } ], - "description": "Indicates that the Lockly lock is not connected to a Wi-Fi bridge." + "description": "Indicates that a subscription is required to connect." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -130427,7 +130440,7 @@ "jsonType": "string", "values": [ { - "name": "bridge_disconnected", + "name": "lockly_missing_wifi_bridge", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -130439,21 +130452,8 @@ ] }, { - "name": "is_bridge_error", - "description": "Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "boolean", - "jsonType": "boolean" - }, - { - "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "name": "is_device_error", + "description": "Indicates that the error is a device error.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -130478,7 +130478,7 @@ "jsonType": "string" } ], - "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)." + "description": "Indicates that the Lockly lock is not connected to a Wi-Fi bridge." }, { "variantGroupKey": null, @@ -130510,7 +130510,7 @@ "jsonType": "string", "values": [ { - "name": "dormakaba_sites_disconnected", + "name": "bridge_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -130561,7 +130561,7 @@ "jsonType": "string" } ], - "description": "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support." + "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)." } ] }, @@ -137121,7 +137121,7 @@ "description": "Indicates that the Salto site user limit has been reached." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -137150,7 +137150,7 @@ "jsonType": "string", "values": [ { - "name": "device_offline", + "name": "dormakaba_sites_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -137161,9 +137161,22 @@ } ] }, + { + "name": "is_connected_account_error", + "description": "Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, { "name": "is_device_error", - "description": "Indicates that the error is a device error.", + "description": "Indicates that the error is not a device error.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -137188,7 +137201,7 @@ "jsonType": "string" } ], - "description": "Indicates that the device is offline." + "description": "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support." }, { "variantGroupKey": null, @@ -137220,7 +137233,7 @@ "jsonType": "string", "values": [ { - "name": "device_removed", + "name": "device_offline", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -137258,7 +137271,7 @@ "jsonType": "string" } ], - "description": "Indicates that the device has been removed." + "description": "Indicates that the device is offline." }, { "variantGroupKey": null, @@ -137290,7 +137303,7 @@ "jsonType": "string", "values": [ { - "name": "hub_disconnected", + "name": "device_removed", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -137328,7 +137341,7 @@ "jsonType": "string" } ], - "description": "Indicates that the hub is disconnected." + "description": "Indicates that the device has been removed." }, { "variantGroupKey": null, @@ -137360,7 +137373,7 @@ "jsonType": "string", "values": [ { - "name": "device_disconnected", + "name": "hub_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -137398,10 +137411,10 @@ "jsonType": "string" } ], - "description": "Indicates that the device is disconnected." + "description": "Indicates that the hub is disconnected." }, { - "variantGroupKey": "access_codes", + "variantGroupKey": null, "properties": [ { "name": "created_at", @@ -137430,7 +137443,7 @@ "jsonType": "string", "values": [ { - "name": "empty_backup_access_code_pool", + "name": "device_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -137468,10 +137481,10 @@ "jsonType": "string" } ], - "description": "Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty." + "description": "Indicates that the device is disconnected." }, { - "variantGroupKey": "locks", + "variantGroupKey": "access_codes", "properties": [ { "name": "created_at", @@ -137500,7 +137513,7 @@ "jsonType": "string", "values": [ { - "name": "august_lock_not_authorized", + "name": "empty_backup_access_code_pool", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -137538,7 +137551,7 @@ "jsonType": "string" } ], - "description": "Indicates that the user is not authorized to use the August lock." + "description": "Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty." }, { "variantGroupKey": "locks", @@ -137570,7 +137583,7 @@ "jsonType": "string", "values": [ { - "name": "august_lock_missing_bridge", + "name": "august_lock_not_authorized", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -137608,10 +137621,10 @@ "jsonType": "string" } ], - "description": "Indicates that the lock is not connected to a bridge." + "description": "Indicates that the user is not authorized to use the August lock." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -137640,7 +137653,7 @@ "jsonType": "string", "values": [ { - "name": "ttlock_lock_not_paired_to_gateway", + "name": "august_lock_missing_bridge", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -137678,10 +137691,10 @@ "jsonType": "string" } ], - "description": "Indicates that the lock is not paired with a gateway." + "description": "Indicates that the lock is not connected to a bridge." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -137710,7 +137723,7 @@ "jsonType": "string", "values": [ { - "name": "missing_device_credentials", + "name": "ttlock_lock_not_paired_to_gateway", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -137748,10 +137761,10 @@ "jsonType": "string" } ], - "description": "Indicates that device credentials are missing." + "description": "Indicates that the lock is not paired with a gateway." }, { - "variantGroupKey": "thermostats", + "variantGroupKey": null, "properties": [ { "name": "created_at", @@ -137780,7 +137793,7 @@ "jsonType": "string", "values": [ { - "name": "auxiliary_heat_running", + "name": "missing_device_credentials", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -137818,10 +137831,10 @@ "jsonType": "string" } ], - "description": "Indicates that the auxiliary heat is running." + "description": "Indicates that device credentials are missing." }, { - "variantGroupKey": null, + "variantGroupKey": "thermostats", "properties": [ { "name": "created_at", @@ -137850,7 +137863,7 @@ "jsonType": "string", "values": [ { - "name": "subscription_required", + "name": "auxiliary_heat_running", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -137888,7 +137901,7 @@ "jsonType": "string" } ], - "description": "Indicates that a subscription is required to connect." + "description": "Indicates that the auxiliary heat is running." }, { "variantGroupKey": null, @@ -137920,7 +137933,7 @@ "jsonType": "string", "values": [ { - "name": "lockly_missing_wifi_bridge", + "name": "subscription_required", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -137958,10 +137971,10 @@ "jsonType": "string" } ], - "description": "Indicates that the Lockly lock is not connected to a Wi-Fi bridge." + "description": "Indicates that a subscription is required to connect." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -137990,7 +138003,7 @@ "jsonType": "string", "values": [ { - "name": "bridge_disconnected", + "name": "lockly_missing_wifi_bridge", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -138002,21 +138015,8 @@ ] }, { - "name": "is_bridge_error", - "description": "Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "boolean", - "jsonType": "boolean" - }, - { - "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "name": "is_device_error", + "description": "Indicates that the error is a device error.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -138041,7 +138041,7 @@ "jsonType": "string" } ], - "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)." + "description": "Indicates that the Lockly lock is not connected to a Wi-Fi bridge." }, { "variantGroupKey": null, @@ -138073,7 +138073,7 @@ "jsonType": "string", "values": [ { - "name": "dormakaba_sites_disconnected", + "name": "bridge_disconnected", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -138124,7 +138124,7 @@ "jsonType": "string" } ], - "description": "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support." + "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)." } ] }, @@ -138754,7 +138754,7 @@ "description": "Indicates that there are too many backup codes." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -138925,7 +138925,7 @@ "description": "Indicates that the Remote Unlock feature is not enabled in the settings.\"" }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -139381,7 +139381,7 @@ "description": "Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -139552,7 +139552,7 @@ "description": "Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -139609,7 +139609,7 @@ "description": "Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", @@ -139666,7 +139666,7 @@ "description": "Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes." }, { - "variantGroupKey": null, + "variantGroupKey": "locks", "properties": [ { "name": "created_at", diff --git a/docs/api-reference/access_codes/README.md b/docs/api-reference/access_codes/README.md index ae37380e5..df1fb6b3f 100644 --- a/docs/api-reference/access_codes/README.md +++ b/docs/api-reference/access_codes/README.md @@ -887,6 +887,54 @@ Indicates that the Salto site user limit has been reached. Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + +
+dormakaba_sites_disconnected + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + + **`created_at`** *Datetime* + + + Date and time at which Seam created the error. + + + --- + + **`error_code`** *Enum* + + + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + + Enum values: + + - dormakaba_sites_disconnected + + + --- + + **`is_connected_account_error`** *Boolean* + + + Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + + + --- + + **`is_device_error`** *Boolean* + + + Indicates that the error is not a device error. + + + --- + + **`message`** *String* + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + +
device_offline @@ -1415,54 +1463,6 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.s Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
-
-dormakaba_sites_disconnected - -Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. - - **`created_at`** *Datetime* - - - Date and time at which Seam created the error. - - - --- - - **`error_code`** *Enum* - - - Unique identifier of the type of error. Enables quick recognition and categorization of the issue. - - Enum values: - - - dormakaba_sites_disconnected - - - --- - - **`is_bridge_error`** *Boolean* - - - Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). - - - --- - - **`is_connected_account_error`** *Boolean* - - - Indicates whether the error is related specifically to the connected account. - - - --- - - **`message`** *String* - - - Detailed description of the error. Provides insights into the issue and potentially how to rectify it. - -
--- diff --git a/docs/api-reference/access_codes/unmanaged/README.md b/docs/api-reference/access_codes/unmanaged/README.md index 988f5041d..8258c24e5 100644 --- a/docs/api-reference/access_codes/unmanaged/README.md +++ b/docs/api-reference/access_codes/unmanaged/README.md @@ -792,6 +792,54 @@ Indicates that the Salto site user limit has been reached. Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + +
+dormakaba_sites_disconnected + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + + **`created_at`** *Datetime* + + + Date and time at which Seam created the error. + + + --- + + **`error_code`** *Enum* + + + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + + Enum values: + + - dormakaba_sites_disconnected + + + --- + + **`is_connected_account_error`** *Boolean* + + + Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + + + --- + + **`is_device_error`** *Boolean* + + + Indicates that the error is not a device error. + + + --- + + **`message`** *String* + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + +
device_offline @@ -1320,54 +1368,6 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.s Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
-
-dormakaba_sites_disconnected - -Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. - - **`created_at`** *Datetime* - - - Date and time at which Seam created the error. - - - --- - - **`error_code`** *Enum* - - - Unique identifier of the type of error. Enables quick recognition and categorization of the issue. - - Enum values: - - - dormakaba_sites_disconnected - - - --- - - **`is_bridge_error`** *Boolean* - - - Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). - - - --- - - **`is_connected_account_error`** *Boolean* - - - Indicates whether the error is related specifically to the connected account. - - - --- - - **`message`** *String* - - - Detailed description of the error. Provides insights into the issue and potentially how to rectify it. - -
--- diff --git a/docs/api-reference/devices/README.md b/docs/api-reference/devices/README.md index 5b63ab893..8f353da66 100644 --- a/docs/api-reference/devices/README.md +++ b/docs/api-reference/devices/README.md @@ -716,6 +716,54 @@ Indicates that the Salto site user limit has been reached. Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + +
+dormakaba_sites_disconnected + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + + **`created_at`** *Datetime* + + + Date and time at which Seam created the error. + + + --- + + **`error_code`** *Enum* + + + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + + Enum values: + + - dormakaba_sites_disconnected + + + --- + + **`is_connected_account_error`** *Boolean* + + + Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + + + --- + + **`is_device_error`** *Boolean* + + + Indicates that the error is not a device error. + + + --- + + **`message`** *String* + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + +
device_offline @@ -1244,54 +1292,6 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.s Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
-
-dormakaba_sites_disconnected - -Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. - - **`created_at`** *Datetime* - - - Date and time at which Seam created the error. - - - --- - - **`error_code`** *Enum* - - - Unique identifier of the type of error. Enables quick recognition and categorization of the issue. - - Enum values: - - - dormakaba_sites_disconnected - - - --- - - **`is_bridge_error`** *Boolean* - - - Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). - - - --- - - **`is_connected_account_error`** *Boolean* - - - Indicates whether the error is related specifically to the connected account. - - - --- - - **`message`** *String* - - - Detailed description of the error. Provides insights into the issue and potentially how to rectify it. - -
--- @@ -4862,24 +4862,12 @@ Indicates that the device has been removed. --- -**`dormakaba_sites_disconnected`** - -Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. - ---- - **`hub_disconnected`** Indicates that the hub is disconnected. --- -**`lockly_missing_wifi_bridge`** - -Indicates that the Lockly lock is not connected to a Wi-Fi bridge. - ---- - **`missing_device_credentials`** Indicates that device credentials are missing. @@ -4892,12 +4880,6 @@ Indicates that a subscription is required to connect. --- -**`ttlock_lock_not_paired_to_gateway`** - -Indicates that the lock is not paired with a gateway. - ---- - ### Access Codes **`empty_backup_access_code_pool`** @@ -4918,12 +4900,30 @@ Indicates that the user is not authorized to use the August lock. --- +**`dormakaba_sites_disconnected`** + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + +--- + +**`lockly_missing_wifi_bridge`** + +Indicates that the Lockly lock is not connected to a Wi-Fi bridge. + +--- + **`salto_ks_subscription_limit_exceeded`** Indicates that the Salto site user limit has been reached. --- +**`ttlock_lock_not_paired_to_gateway`** + +Indicates that the lock is not paired with a gateway. + +--- + ### Thermostats **`auxiliary_heat_running`** @@ -4946,18 +4946,6 @@ Indicates that the device has a flaky connection. --- -**`lockly_time_zone_not_configured`** - -Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. - ---- - -**`salto_ks_subscription_limit_almost_reached`** - -Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. - ---- - **`scheduled_maintenance_window`** Indicates that a scheduled maintenance window has been detected. @@ -4970,30 +4958,6 @@ Indicates that a third-party integration has been detected. --- -**`ttlock_weak_gateway_signal`** - -Indicates that the gateway signal is weak. - ---- - -**`two_n_device_missing_timezone`** - -Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. - ---- - -**`ultraloq_time_zone_unknown`** - -Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. - ---- - -**`wyze_device_missing_gateway`** - -Indicates that the Wyze Lock is not connected to a gateway. - ---- - ### Access Codes **`many_active_backup_codes`** @@ -5062,24 +5026,60 @@ Indicates that the key is in a locker that does not support the access codes API --- +**`lockly_time_zone_not_configured`** + +Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. + +--- + **`power_saving_mode`** Indicates that the device is in power saving mode and may have limited functionality. --- +**`salto_ks_subscription_limit_almost_reached`** + +Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. + +--- + **`ttlock_lock_gateway_unlocking_not_enabled`** Indicates that the Remote Unlock feature is not enabled in the settings." --- +**`ttlock_weak_gateway_signal`** + +Indicates that the gateway signal is weak. + +--- + +**`two_n_device_missing_timezone`** + +Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. + +--- + +**`ultraloq_time_zone_unknown`** + +Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. + +--- + **`unreliable_online_status`** Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status. --- +**`wyze_device_missing_gateway`** + +Indicates that the Wyze Lock is not connected to a gateway. + +--- + ### Phones **`unknown_issue_with_phone`** diff --git a/docs/api-reference/devices/unmanaged/README.md b/docs/api-reference/devices/unmanaged/README.md index 2ed883f5f..b63417e6f 100644 --- a/docs/api-reference/devices/unmanaged/README.md +++ b/docs/api-reference/devices/unmanaged/README.md @@ -449,6 +449,54 @@ Indicates that the Salto site user limit has been reached. Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + +
+dormakaba_sites_disconnected + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + + **`created_at`** *Datetime* + + + Date and time at which Seam created the error. + + + --- + + **`error_code`** *Enum* + + + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + + Enum values: + + - dormakaba_sites_disconnected + + + --- + + **`is_connected_account_error`** *Boolean* + + + Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + + + --- + + **`is_device_error`** *Boolean* + + + Indicates that the error is not a device error. + + + --- + + **`message`** *String* + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + +
device_offline @@ -977,54 +1025,6 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.s Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
-
-dormakaba_sites_disconnected - -Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. - - **`created_at`** *Datetime* - - - Date and time at which Seam created the error. - - - --- - - **`error_code`** *Enum* - - - Unique identifier of the type of error. Enables quick recognition and categorization of the issue. - - Enum values: - - - dormakaba_sites_disconnected - - - --- - - **`is_bridge_error`** *Boolean* - - - Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). - - - --- - - **`is_connected_account_error`** *Boolean* - - - Indicates whether the error is related specifically to the connected account. - - - --- - - **`message`** *String* - - - Detailed description of the error. Provides insights into the issue and potentially how to rectify it. - -
--- @@ -2156,24 +2156,12 @@ Indicates that the device has been removed. --- -**`dormakaba_sites_disconnected`** - -Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. - ---- - **`hub_disconnected`** Indicates that the hub is disconnected. --- -**`lockly_missing_wifi_bridge`** - -Indicates that the Lockly lock is not connected to a Wi-Fi bridge. - ---- - **`missing_device_credentials`** Indicates that device credentials are missing. @@ -2186,12 +2174,6 @@ Indicates that a subscription is required to connect. --- -**`ttlock_lock_not_paired_to_gateway`** - -Indicates that the lock is not paired with a gateway. - ---- - ### Access Codes **`empty_backup_access_code_pool`** @@ -2212,12 +2194,30 @@ Indicates that the user is not authorized to use the August lock. --- +**`dormakaba_sites_disconnected`** + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + +--- + +**`lockly_missing_wifi_bridge`** + +Indicates that the Lockly lock is not connected to a Wi-Fi bridge. + +--- + **`salto_ks_subscription_limit_exceeded`** Indicates that the Salto site user limit has been reached. --- +**`ttlock_lock_not_paired_to_gateway`** + +Indicates that the lock is not paired with a gateway. + +--- + ### Thermostats **`auxiliary_heat_running`** @@ -2240,18 +2240,6 @@ Indicates that the device has a flaky connection. --- -**`lockly_time_zone_not_configured`** - -Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. - ---- - -**`salto_ks_subscription_limit_almost_reached`** - -Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. - ---- - **`scheduled_maintenance_window`** Indicates that a scheduled maintenance window has been detected. @@ -2264,30 +2252,6 @@ Indicates that a third-party integration has been detected. --- -**`ttlock_weak_gateway_signal`** - -Indicates that the gateway signal is weak. - ---- - -**`two_n_device_missing_timezone`** - -Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. - ---- - -**`ultraloq_time_zone_unknown`** - -Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. - ---- - -**`wyze_device_missing_gateway`** - -Indicates that the Wyze Lock is not connected to a gateway. - ---- - ### Access Codes **`many_active_backup_codes`** @@ -2356,24 +2320,60 @@ Indicates that the key is in a locker that does not support the access codes API --- +**`lockly_time_zone_not_configured`** + +Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. + +--- + **`power_saving_mode`** Indicates that the device is in power saving mode and may have limited functionality. --- +**`salto_ks_subscription_limit_almost_reached`** + +Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. + +--- + **`ttlock_lock_gateway_unlocking_not_enabled`** Indicates that the Remote Unlock feature is not enabled in the settings." --- +**`ttlock_weak_gateway_signal`** + +Indicates that the gateway signal is weak. + +--- + +**`two_n_device_missing_timezone`** + +Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. + +--- + +**`ultraloq_time_zone_unknown`** + +Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. + +--- + **`unreliable_online_status`** Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status. --- +**`wyze_device_missing_gateway`** + +Indicates that the Wyze Lock is not connected to a gateway. + +--- + ### Phones **`unknown_issue_with_phone`** diff --git a/docs/api-reference/locks/README.md b/docs/api-reference/locks/README.md index 1ed1088ba..f4e356e99 100644 --- a/docs/api-reference/locks/README.md +++ b/docs/api-reference/locks/README.md @@ -475,6 +475,54 @@ Indicates that the Salto site user limit has been reached. Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + +
+dormakaba_sites_disconnected + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + + **`created_at`** *Datetime* + + + Date and time at which Seam created the error. + + + --- + + **`error_code`** *Enum* + + + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + + Enum values: + + - dormakaba_sites_disconnected + + + --- + + **`is_connected_account_error`** *Boolean* + + + Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + + + --- + + **`is_device_error`** *Boolean* + + + Indicates that the error is not a device error. + + + --- + + **`message`** *String* + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + +
device_offline @@ -1003,54 +1051,6 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.s Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
-
-dormakaba_sites_disconnected - -Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. - - **`created_at`** *Datetime* - - - Date and time at which Seam created the error. - - - --- - - **`error_code`** *Enum* - - - Unique identifier of the type of error. Enables quick recognition and categorization of the issue. - - Enum values: - - - dormakaba_sites_disconnected - - - --- - - **`is_bridge_error`** *Boolean* - - - Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). - - - --- - - **`is_connected_account_error`** *Boolean* - - - Indicates whether the error is related specifically to the connected account. - - - --- - - **`message`** *String* - - - Detailed description of the error. Provides insights into the issue and potentially how to rectify it. - -
--- @@ -3564,12 +3564,30 @@ Metadata for a Wyze device. ## Errors +**`ttlock_lock_not_paired_to_gateway`** + +Indicates that the lock is not paired with a gateway. + +--- + **`salto_ks_subscription_limit_exceeded`** Indicates that the Salto site user limit has been reached. --- +**`lockly_missing_wifi_bridge`** + +Indicates that the Lockly lock is not connected to a Wi-Fi bridge. + +--- + +**`dormakaba_sites_disconnected`** + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + +--- + **`august_lock_not_authorized`** Indicates that the user is not authorized to use the August lock. @@ -3588,12 +3606,6 @@ Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis --- -**`ttlock_lock_not_paired_to_gateway`** - -Indicates that the lock is not paired with a gateway. - ---- - **`subscription_required`** Indicates that a subscription is required to connect. @@ -3606,12 +3618,6 @@ Indicates that device credentials are missing. --- -**`lockly_missing_wifi_bridge`** - -Indicates that the Lockly lock is not connected to a Wi-Fi bridge. - ---- - **`hub_disconnected`** Indicates that the hub is disconnected. @@ -3648,12 +3654,6 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.s --- -**`dormakaba_sites_disconnected`** - -Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. - ---- - ## Warnings diff --git a/docs/api-reference/thermostats/README.md b/docs/api-reference/thermostats/README.md index fec8cdb20..9cb33d12d 100644 --- a/docs/api-reference/thermostats/README.md +++ b/docs/api-reference/thermostats/README.md @@ -591,6 +591,54 @@ Indicates that the Salto site user limit has been reached. Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + +
+dormakaba_sites_disconnected + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + + **`created_at`** *Datetime* + + + Date and time at which Seam created the error. + + + --- + + **`error_code`** *Enum* + + + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + + Enum values: + + - dormakaba_sites_disconnected + + + --- + + **`is_connected_account_error`** *Boolean* + + + Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + + + --- + + **`is_device_error`** *Boolean* + + + Indicates that the error is not a device error. + + + --- + + **`message`** *String* + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + +
device_offline @@ -1119,54 +1167,6 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.s Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
-
-dormakaba_sites_disconnected - -Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. - - **`created_at`** *Datetime* - - - Date and time at which Seam created the error. - - - --- - - **`error_code`** *Enum* - - - Unique identifier of the type of error. Enables quick recognition and categorization of the issue. - - Enum values: - - - dormakaba_sites_disconnected - - - --- - - **`is_bridge_error`** *Boolean* - - - Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). - - - --- - - **`is_connected_account_error`** *Boolean* - - - Indicates whether the error is related specifically to the connected account. - - - --- - - **`message`** *String* - - - Detailed description of the error. Provides insights into the issue and potentially how to rectify it. - -
--- @@ -4308,12 +4308,6 @@ Indicates that the auxiliary heat is running. --- -**`ttlock_lock_not_paired_to_gateway`** - -Indicates that the lock is not paired with a gateway. - ---- - **`subscription_required`** Indicates that a subscription is required to connect. @@ -4326,12 +4320,6 @@ Indicates that device credentials are missing. --- -**`lockly_missing_wifi_bridge`** - -Indicates that the Lockly lock is not connected to a Wi-Fi bridge. - ---- - **`hub_disconnected`** Indicates that the hub is disconnected. @@ -4368,12 +4356,6 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.s --- -**`dormakaba_sites_disconnected`** - -Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. - ---- - ## Warnings @@ -4389,18 +4371,6 @@ Indicates that the device has a flaky connection. --- -**`lockly_time_zone_not_configured`** - -Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. - ---- - -**`salto_ks_subscription_limit_almost_reached`** - -Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. - ---- - **`scheduled_maintenance_window`** Indicates that a scheduled maintenance window has been detected. @@ -4419,30 +4389,6 @@ Indicates that a third-party integration has been detected. --- -**`ttlock_weak_gateway_signal`** - -Indicates that the gateway signal is weak. - ---- - -**`two_n_device_missing_timezone`** - -Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. - ---- - -**`ultraloq_time_zone_unknown`** - -Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. - ---- - -**`wyze_device_missing_gateway`** - -Indicates that the Wyze Lock is not connected to a gateway. - ---- - ## Events diff --git a/mintlify-docs/api/access_codes/errors.mdx b/mintlify-docs/api/access_codes/errors.mdx index 4b1505154..038ce6ae6 100644 --- a/mintlify-docs/api/access_codes/errors.mdx +++ b/mintlify-docs/api/access_codes/errors.mdx @@ -114,12 +114,6 @@ Indicates that the device has been removed. --- -### `dormakaba_sites_disconnected` - -Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. - ---- - ### `duplicate_code_attempt_prevented` An attempt to modify this access code was prevented. @@ -156,12 +150,6 @@ Admin role required—insufficient permissions to manage PINs on this device. Pl --- -### `lockly_missing_wifi_bridge` - -Indicates that the Lockly lock is not connected to a Wi-Fi bridge. - ---- - ### `missing_device_credentials` Indicates that device credentials are missing. @@ -198,12 +186,6 @@ Indicates that a subscription is required to connect. --- -### `ttlock_lock_not_paired_to_gateway` - -Indicates that the lock is not paired with a gateway. - ---- - ### Access Codes #### `empty_backup_access_code_pool` @@ -226,12 +208,30 @@ Indicates that the user is not authorized to use the August lock. --- +#### `dormakaba_sites_disconnected` + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + +--- + +#### `lockly_missing_wifi_bridge` + +Indicates that the Lockly lock is not connected to a Wi-Fi bridge. + +--- + #### `salto_ks_subscription_limit_exceeded` Indicates that the Salto site user limit has been reached. --- +#### `ttlock_lock_not_paired_to_gateway` + +Indicates that the lock is not paired with a gateway. + +--- + ### Thermostats #### `auxiliary_heat_running` diff --git a/mintlify-docs/api/access_codes/unmanaged/errors.mdx b/mintlify-docs/api/access_codes/unmanaged/errors.mdx index 1208914b2..03da9ac7a 100644 --- a/mintlify-docs/api/access_codes/unmanaged/errors.mdx +++ b/mintlify-docs/api/access_codes/unmanaged/errors.mdx @@ -114,12 +114,6 @@ Indicates that the device has been removed. --- -### `dormakaba_sites_disconnected` - -Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. - ---- - ### `duplicate_code_attempt_prevented` An attempt to modify this access code was prevented. @@ -156,12 +150,6 @@ Admin role required—insufficient permissions to manage PINs on this device. Pl --- -### `lockly_missing_wifi_bridge` - -Indicates that the Lockly lock is not connected to a Wi-Fi bridge. - ---- - ### `missing_device_credentials` Indicates that device credentials are missing. @@ -198,12 +186,6 @@ Indicates that a subscription is required to connect. --- -### `ttlock_lock_not_paired_to_gateway` - -Indicates that the lock is not paired with a gateway. - ---- - ### Access Codes #### `empty_backup_access_code_pool` @@ -226,12 +208,30 @@ Indicates that the user is not authorized to use the August lock. --- +#### `dormakaba_sites_disconnected` + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + +--- + +#### `lockly_missing_wifi_bridge` + +Indicates that the Lockly lock is not connected to a Wi-Fi bridge. + +--- + #### `salto_ks_subscription_limit_exceeded` Indicates that the Salto site user limit has been reached. --- +#### `ttlock_lock_not_paired_to_gateway` + +Indicates that the lock is not paired with a gateway. + +--- + ### Thermostats #### `auxiliary_heat_running` diff --git a/mintlify-docs/api/devices/errors.mdx b/mintlify-docs/api/devices/errors.mdx index b085e49f6..0c5401597 100644 --- a/mintlify-docs/api/devices/errors.mdx +++ b/mintlify-docs/api/devices/errors.mdx @@ -77,24 +77,12 @@ Indicates that the device has been removed. --- -### `dormakaba_sites_disconnected` - -Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. - ---- - ### `hub_disconnected` Indicates that the hub is disconnected. --- -### `lockly_missing_wifi_bridge` - -Indicates that the Lockly lock is not connected to a Wi-Fi bridge. - ---- - ### `missing_device_credentials` Indicates that device credentials are missing. @@ -107,12 +95,6 @@ Indicates that a subscription is required to connect. --- -### `ttlock_lock_not_paired_to_gateway` - -Indicates that the lock is not paired with a gateway. - ---- - ### Access Codes #### `empty_backup_access_code_pool` @@ -135,12 +117,30 @@ Indicates that the user is not authorized to use the August lock. --- +#### `dormakaba_sites_disconnected` + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + +--- + +#### `lockly_missing_wifi_bridge` + +Indicates that the Lockly lock is not connected to a Wi-Fi bridge. + +--- + #### `salto_ks_subscription_limit_exceeded` Indicates that the Salto site user limit has been reached. --- +#### `ttlock_lock_not_paired_to_gateway` + +Indicates that the lock is not paired with a gateway. + +--- + ### Thermostats #### `auxiliary_heat_running` @@ -199,18 +199,6 @@ Indicates that the device has a flaky connection. --- -### `lockly_time_zone_not_configured` - -Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. - ---- - -### `salto_ks_subscription_limit_almost_reached` - -Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. - ---- - ### `scheduled_maintenance_window` Indicates that a scheduled maintenance window has been detected. @@ -223,30 +211,6 @@ Indicates that a third-party integration has been detected. --- -### `ttlock_weak_gateway_signal` - -Indicates that the gateway signal is weak. - ---- - -### `two_n_device_missing_timezone` - -Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. - ---- - -### `ultraloq_time_zone_unknown` - -Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. - ---- - -### `wyze_device_missing_gateway` - -Indicates that the Wyze Lock is not connected to a gateway. - ---- - ### Access Codes #### `many_active_backup_codes` @@ -317,24 +281,60 @@ Indicates that the key is in a locker that does not support the access codes API --- +#### `lockly_time_zone_not_configured` + +Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. + +--- + #### `power_saving_mode` Indicates that the device is in power saving mode and may have limited functionality. --- +#### `salto_ks_subscription_limit_almost_reached` + +Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. + +--- + #### `ttlock_lock_gateway_unlocking_not_enabled` Indicates that the Remote Unlock feature is not enabled in the settings." --- +#### `ttlock_weak_gateway_signal` + +Indicates that the gateway signal is weak. + +--- + +#### `two_n_device_missing_timezone` + +Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. + +--- + +#### `ultraloq_time_zone_unknown` + +Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. + +--- + #### `unreliable_online_status` Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status. --- +#### `wyze_device_missing_gateway` + +Indicates that the Wyze Lock is not connected to a gateway. + +--- + ### Phones #### `unknown_issue_with_phone` diff --git a/mintlify-docs/api/devices/unmanaged/errors.mdx b/mintlify-docs/api/devices/unmanaged/errors.mdx index dd2b6cae0..af3ac4599 100644 --- a/mintlify-docs/api/devices/unmanaged/errors.mdx +++ b/mintlify-docs/api/devices/unmanaged/errors.mdx @@ -77,24 +77,12 @@ Indicates that the device has been removed. --- -### `dormakaba_sites_disconnected` - -Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. - ---- - ### `hub_disconnected` Indicates that the hub is disconnected. --- -### `lockly_missing_wifi_bridge` - -Indicates that the Lockly lock is not connected to a Wi-Fi bridge. - ---- - ### `missing_device_credentials` Indicates that device credentials are missing. @@ -107,12 +95,6 @@ Indicates that a subscription is required to connect. --- -### `ttlock_lock_not_paired_to_gateway` - -Indicates that the lock is not paired with a gateway. - ---- - ### Access Codes #### `empty_backup_access_code_pool` @@ -135,12 +117,30 @@ Indicates that the user is not authorized to use the August lock. --- +#### `dormakaba_sites_disconnected` + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + +--- + +#### `lockly_missing_wifi_bridge` + +Indicates that the Lockly lock is not connected to a Wi-Fi bridge. + +--- + #### `salto_ks_subscription_limit_exceeded` Indicates that the Salto site user limit has been reached. --- +#### `ttlock_lock_not_paired_to_gateway` + +Indicates that the lock is not paired with a gateway. + +--- + ### Thermostats #### `auxiliary_heat_running` @@ -199,18 +199,6 @@ Indicates that the device has a flaky connection. --- -### `lockly_time_zone_not_configured` - -Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. - ---- - -### `salto_ks_subscription_limit_almost_reached` - -Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. - ---- - ### `scheduled_maintenance_window` Indicates that a scheduled maintenance window has been detected. @@ -223,30 +211,6 @@ Indicates that a third-party integration has been detected. --- -### `ttlock_weak_gateway_signal` - -Indicates that the gateway signal is weak. - ---- - -### `two_n_device_missing_timezone` - -Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. - ---- - -### `ultraloq_time_zone_unknown` - -Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. - ---- - -### `wyze_device_missing_gateway` - -Indicates that the Wyze Lock is not connected to a gateway. - ---- - ### Access Codes #### `many_active_backup_codes` @@ -317,24 +281,60 @@ Indicates that the key is in a locker that does not support the access codes API --- +#### `lockly_time_zone_not_configured` + +Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. + +--- + #### `power_saving_mode` Indicates that the device is in power saving mode and may have limited functionality. --- +#### `salto_ks_subscription_limit_almost_reached` + +Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. + +--- + #### `ttlock_lock_gateway_unlocking_not_enabled` Indicates that the Remote Unlock feature is not enabled in the settings." --- +#### `ttlock_weak_gateway_signal` + +Indicates that the gateway signal is weak. + +--- + +#### `two_n_device_missing_timezone` + +Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. + +--- + +#### `ultraloq_time_zone_unknown` + +Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. + +--- + #### `unreliable_online_status` Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status. --- +#### `wyze_device_missing_gateway` + +Indicates that the Wyze Lock is not connected to a gateway. + +--- + ### Phones #### `unknown_issue_with_phone` diff --git a/mintlify-docs/api/locks/errors.mdx b/mintlify-docs/api/locks/errors.mdx index cad40bcd9..fd783b5ea 100644 --- a/mintlify-docs/api/locks/errors.mdx +++ b/mintlify-docs/api/locks/errors.mdx @@ -59,20 +59,38 @@ Indicates that the user is not authorized to use the August lock. --- +### `dormakaba_sites_disconnected` + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + +--- + +### `lockly_missing_wifi_bridge` + +Indicates that the Lockly lock is not connected to a Wi-Fi bridge. + +--- + ### `salto_ks_subscription_limit_exceeded` Indicates that the Salto site user limit has been reached. --- +### `ttlock_lock_not_paired_to_gateway` + +Indicates that the lock is not paired with a gateway. + +--- + ## Warnings Each warning is an object with the following shape: ```json Example warning { - "warning_code": "ttlock_lock_gateway_unlocking_not_enabled", - "message": "Indicates that the Remote Unlock feature is not enabled in the settings.\"", + "warning_code": "wyze_device_missing_gateway", + "message": "Indicates that the Wyze Lock is not connected to a gateway.", "created_at": "2025-01-01T00:00:00.000Z" } ``` @@ -119,20 +137,56 @@ Indicates that the key is in a locker that does not support the access codes API --- +### `lockly_time_zone_not_configured` + +Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. + +--- + ### `power_saving_mode` Indicates that the device is in power saving mode and may have limited functionality. --- +### `salto_ks_subscription_limit_almost_reached` + +Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. + +--- + ### `ttlock_lock_gateway_unlocking_not_enabled` Indicates that the Remote Unlock feature is not enabled in the settings." --- +### `ttlock_weak_gateway_signal` + +Indicates that the gateway signal is weak. + +--- + +### `two_n_device_missing_timezone` + +Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. + +--- + +### `ultraloq_time_zone_unknown` + +Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. + +--- + ### `unreliable_online_status` Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status. --- + +### `wyze_device_missing_gateway` + +Indicates that the Wyze Lock is not connected to a gateway. + +--- diff --git a/package-lock.json b/package-lock.json index aa32ae52d..dc90b0cc9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.55.0", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.922.0", + "@seamapi/types": "1.923.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", @@ -984,9 +984,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.922.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.922.0.tgz", - "integrity": "sha512-YA2MPWun3STPochwIq7XKIcY0NylnxYgh442+GJflIVcOi1kTi1Dr438tIUPPeaAw3fMdWvW1vp9lAjZH4RILQ==", + "version": "1.923.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.923.0.tgz", + "integrity": "sha512-P+PbSpBVjKutdWQLY6gZx1mgGSRxPkxH0gHJiKO12k9zc0LEjWwHQS5kJSqWNMB5e7srJvhMTtw0CjbLz/Jyiw==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index bef9c0ce3..4b7ef67da 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.55.0", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.922.0", + "@seamapi/types": "1.923.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9",