@seamapi/types 1.918.0 → 1.920.0

package/src/lib/seam/connect/models/acs/acs-system.ts

@@ -56,10 +56,14 @@ const seam_bridge_disconnected = common_acs_system_error.extend({
   error_code: z
     .literal('seam_bridge_disconnected')
     .describe(error_code_description),
-})
-  .describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
-  This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces).
-  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).`)
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
+    This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces).
+    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).
+    `)
 
 const bridge_disconnected = common_acs_system_error.extend({
   error_code: z.literal('bridge_disconnected').describe(error_code_description),
@@ -69,67 +73,80 @@ const bridge_disconnected = common_acs_system_error.extend({
     .describe(
       'Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).',
     ),
-})
-  .describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if 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).`)
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if 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).
+    `)
 
 const visionline_instance_unreachable = common_acs_system_error.extend({
   error_code: z
     .literal('visionline_instance_unreachable')
     .describe(error_code_description),
-})
-  .describe(`Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
-  For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces).
-  See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).`)
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
+    For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces).
+    See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).
+    `)
 
-const salto_ks_subscription_limit_exceeded = common_acs_system_error
-  .extend({
-    error_code: z
-      .literal('salto_ks_subscription_limit_exceeded')
-      .describe(error_code_description),
-  })
-  .describe(
-    'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
-  )
+const salto_ks_subscription_limit_exceeded = common_acs_system_error.extend({
+  error_code: z
+    .literal('salto_ks_subscription_limit_exceeded')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.
+    `)
 
-const acs_system_disconnected = common_acs_system_error
-  .extend({
-    error_code: z
-      .literal('acs_system_disconnected')
-      .describe(error_code_description),
-  })
-  .describe(
-    'Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system) to resolve the issue.',
-  )
+const acs_system_disconnected = common_acs_system_error.extend({
+  error_code: z
+    .literal('acs_system_disconnected')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system) to resolve the issue.
+    `)
 
-const account_disconnected = common_acs_system_error
-  .extend({
-    error_code: z
-      .literal('account_disconnected')
-      .describe(error_code_description),
-  })
-  .describe(
-    'Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) to restore access.',
-  )
+const account_disconnected = common_acs_system_error.extend({
+  error_code: z
+    .literal('account_disconnected')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) to restore access.
+    `)
 
-const salto_ks_certification_expired = common_acs_system_error
-  .extend({
-    error_code: z
-      .literal('salto_ks_certification_expired')
-      .describe(error_code_description),
-  })
-  .describe(
-    'Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access.',
-  )
-const provider_service_unavailable = common_acs_system_error
-  .extend({
-    error_code: z
-      .literal('provider_service_unavailable')
-      .describe(error_code_description),
-  })
-  .describe(
-    "Indicates that the access control system provider's service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again.",
-  )
+const salto_ks_certification_expired = common_acs_system_error.extend({
+  error_code: z
+    .literal('salto_ks_certification_expired')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access.
+    `)
+const provider_service_unavailable = common_acs_system_error.extend({
+  error_code: z
+    .literal('provider_service_unavailable')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    Indicates that the access control system provider's service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again.
+    `)
 
 const acs_system_error = z
   .discriminatedUnion('error_code', [

package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts

@@ -30,53 +30,61 @@ const common_acs_user_error = z.object({
     ),
 })
 
-const acs_users_deleted_externally = common_acs_user_error
-  .extend({
-    error_code: z.literal('deleted_externally'),
-  })
-  .describe(
-    `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems) outside of Seam.`,
-  )
+const acs_users_deleted_externally = common_acs_user_error.extend({
+  error_code: z.literal('deleted_externally'),
+}).describe(`
+    ---
+    resource_type: acs_user
+    ---
+    Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems) outside of Seam.
+    `)
 
-const acs_users_salto_ks_subscription_limit_exceeded = common_acs_user_error
-  .extend({
+const acs_users_salto_ks_subscription_limit_exceeded =
+  common_acs_user_error.extend({
     error_code: z.literal('salto_ks_subscription_limit_exceeded'),
-  })
-  .describe(
-    `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.`,
-  )
+  }).describe(`
+    ---
+    resource_type: acs_user
+    ---
+    Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.
+    `)
 
-const acs_users_failed_to_create_on_acs_system = common_acs_user_error
-  .extend({
-    error_code: z.literal('failed_to_create_on_acs_system'),
-  })
-  .describe(
-    `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
-  )
+const acs_users_failed_to_create_on_acs_system = common_acs_user_error.extend({
+  error_code: z.literal('failed_to_create_on_acs_system'),
+}).describe(`
+    ---
+    resource_type: acs_user
+    ---
+    Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
+    `)
 
-const acs_users_failed_to_update_on_acs_system = common_acs_user_error
-  .extend({
-    error_code: z.literal('failed_to_update_on_acs_system'),
-  })
-  .describe(
-    `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not updated on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
-  )
+const acs_users_failed_to_update_on_acs_system = common_acs_user_error.extend({
+  error_code: z.literal('failed_to_update_on_acs_system'),
+}).describe(`
+    ---
+    resource_type: acs_user
+    ---
+    Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not updated on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
+    `)
 
-const acs_users_failed_to_delete_on_acs_system = common_acs_user_error
-  .extend({
-    error_code: z.literal('failed_to_delete_on_acs_system'),
-  })
-  .describe(
-    `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not deleted on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
-  )
+const acs_users_failed_to_delete_on_acs_system = common_acs_user_error.extend({
+  error_code: z.literal('failed_to_delete_on_acs_system'),
+}).describe(`
+    ---
+    resource_type: acs_user
+    ---
+    Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not deleted on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
+    `)
 
-const acs_users_latch_conflict_with_resident_user = common_acs_user_error
-  .extend({
+const acs_users_latch_conflict_with_resident_user =
+  common_acs_user_error.extend({
     error_code: z.literal('latch_conflict_with_resident_user'),
-  })
-  .describe(
-    `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).`,
-  )
+  }).describe(`
+    ---
+    resource_type: acs_user
+    ---
+    Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).
+    `)
 
 const acs_user_errors = z
   .discriminatedUnion('error_code', [

package/src/lib/seam/connect/models/connected-accounts/connected-account.ts

@@ -45,86 +45,91 @@ const common_connected_account_warning = z.object({
     ),
 })
 
-export const account_disconnected = common_connected_account_error
-  .extend({
-    error_code: z
-      .literal('account_disconnected')
-      .describe(error_code_description),
-  })
-  .describe('Indicates that the account is disconnected.')
+export const account_disconnected = common_connected_account_error.extend({
+  error_code: z
+    .literal('account_disconnected')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: connected_account
+    ---
+    Indicates that the account is disconnected.
+    `)
 
-export const bridge_disconnected = common_connected_account_error
-  .extend({
-    error_code: z
-      .literal('bridge_disconnected')
-      .describe(error_code_description),
-  })
-  .describe(
-    '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).',
-  )
+export const bridge_disconnected = common_connected_account_error.extend({
+  error_code: z.literal('bridge_disconnected').describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: connected_account
+    ---
+    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).
+    `)
 
 export const salto_ks_subscription_limit_exceeded =
-  common_connected_account_error
-    .extend({
-      error_code: z
-        .literal('salto_ks_subscription_limit_exceeded')
-        .describe(error_code_description),
-      salto_ks_metadata: z
-        .object({
-          sites: z
-            .array(
-              z
-                .object({
-                  site_id: z
-                    .string()
-                    .describe(
-                      'ID of a Salto site associated with the connected account that has an error.',
-                    ),
-                  site_name: z
-                    .string()
-                    .describe(
-                      'Name of a Salto site associated with the connected account that has an error.',
-                    ),
-                  subscribed_site_user_count: z
-                    .number()
-                    .int()
-                    .min(0)
-                    .describe(
-                      'Count of subscribed site users for a Salto site associated with the connected account that has an error.',
-                    ),
-                  site_user_subscription_limit: z
-                    .number()
-                    .int()
-                    .min(0)
-                    .describe(
-                      'Subscription limit of site users for a Salto site associated with the connected account that has an error.',
-                    ),
-                })
-                .describe(
-                  'Salto site associated with the connected account that has an error.',
-                ),
-            )
-            .describe(
-              'Salto sites associated with the connected account that has an error.',
-            ),
-        })
-        .describe(
-          'Salto KS metadata associated with the connected account that has an error.',
-        ),
-    })
-    .describe(
-      'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
-    )
+  common_connected_account_error.extend({
+    error_code: z
+      .literal('salto_ks_subscription_limit_exceeded')
+      .describe(error_code_description),
+    salto_ks_metadata: z
+      .object({
+        sites: z
+          .array(
+            z
+              .object({
+                site_id: z
+                  .string()
+                  .describe(
+                    'ID of a Salto site associated with the connected account that has an error.',
+                  ),
+                site_name: z
+                  .string()
+                  .describe(
+                    'Name of a Salto site associated with the connected account that has an error.',
+                  ),
+                subscribed_site_user_count: z
+                  .number()
+                  .int()
+                  .min(0)
+                  .describe(
+                    'Count of subscribed site users for a Salto site associated with the connected account that has an error.',
+                  ),
+                site_user_subscription_limit: z
+                  .number()
+                  .int()
+                  .min(0)
+                  .describe(
+                    'Subscription limit of site users for a Salto site associated with the connected account that has an error.',
+                  ),
+              })
+              .describe(
+                'Salto site associated with the connected account that has an error.',
+              ),
+          )
+          .describe(
+            'Salto sites associated with the connected account that has an error.',
+          ),
+      })
+      .describe(
+        'Salto KS metadata associated with the connected account that has an error.',
+      ),
+  }).describe(`
+    ---
+    resource_type: connected_account
+    ---
+    Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.
+    `)
 
-export const dormakaba_sites_disconnected = common_connected_account_error
-  .extend({
+export const dormakaba_sites_disconnected =
+  common_connected_account_error.extend({
     error_code: z
       .literal('dormakaba_sites_disconnected')
       .describe(error_code_description),
-  })
-  .describe(
-    'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.',
-  )
+  }).describe(`
+    ---
+    resource_type: connected_account
+    ---
+    Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.
+    `)
 
 export const connected_account_error = z.discriminatedUnion('error_code', [
   account_disconnected,

package/src/lib/seam/connect/models/devices/device.ts

@@ -134,47 +134,58 @@ const device_offline = common_device_error
   .describe(
     `
     ---
+    resource_type: device
     deprecated: Use \`device_disconnected\` instead.
     ---
     Indicates that the device is offline.
     `,
   )
 
-const device_removed = common_device_error
-  .extend({
-    error_code: z.literal('device_removed').describe(error_code_description),
-  })
-  .describe('Indicates that the device has been removed.')
+const device_removed = common_device_error.extend({
+  error_code: z.literal('device_removed').describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: device
+    ---
+    Indicates that the device has been removed.
+    `)
 
-const hub_disconnected = common_device_error
-  .extend({
-    error_code: z.literal('hub_disconnected').describe(error_code_description),
-  })
-  .describe('Indicates that the hub is disconnected.')
+const hub_disconnected = common_device_error.extend({
+  error_code: z.literal('hub_disconnected').describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: device
+    ---
+    Indicates that the hub is disconnected.
+    `)
 
-const device_disconnected = common_device_error
-  .extend({
-    error_code: z
-      .literal('device_disconnected')
-      .describe(error_code_description),
-  })
-  .describe('Indicates that the device is disconnected.')
+const device_disconnected = common_device_error.extend({
+  error_code: z.literal('device_disconnected').describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: device
+    ---
+    Indicates that the device is disconnected.
+    `)
 
-const account_disconnected = common_device_error
-  .extend({
-    error_code: z
-      .literal('account_disconnected')
-      .describe(error_code_description),
-    is_connected_account_error: z
-      .literal(true)
-      .describe(
-        'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.',
-      ),
-    is_device_error: z
-      .literal(false)
-      .describe('Indicates that the error is not a device error.'),
-  })
-  .describe('Indicates that the account is disconnected.')
+const account_disconnected = common_device_error.extend({
+  error_code: z
+    .literal('account_disconnected')
+    .describe(error_code_description),
+  is_connected_account_error: z
+    .literal(true)
+    .describe(
+      'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.',
+    ),
+  is_device_error: z
+    .literal(false)
+    .describe('Indicates that the error is not a device error.'),
+}).describe(`
+    ---
+    resource_type: connected_account
+    ---
+    Indicates that the account is disconnected.
+    `)
 
 const empty_backup_access_code_pool = common_device_error.extend({
   error_code: z
@@ -182,6 +193,7 @@ const empty_backup_access_code_pool = common_device_error.extend({
     .describe(error_code_description),
 }).describe(`
     ---
+    resource_type: device
     variant_group_key: access_codes
     ---
     Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
@@ -193,6 +205,7 @@ const august_lock_not_authorized = common_device_error.extend({
     .describe(error_code_description),
 }).describe(`
     ---
+    resource_type: device
     variant_group_key: locks
     ---
     Indicates that the user is not authorized to use the August lock.
@@ -204,6 +217,7 @@ const august_lock_missing_bridge = common_device_error.extend({
     .describe(error_code_description),
 }).describe(`
     ---
+    resource_type: device
     deprecated: Use \`hub_disconnected\` instead.
     variant_group_key: locks
     ---
@@ -224,6 +238,7 @@ const salto_ks_subscription_limit_exceeded = common_device_error.extend({
     .describe('Indicates that the error is not a device error.'),
 }).describe(`
     ---
+    resource_type: connected_account
     variant_group_key: locks
     ---
     Indicates that the Salto site user limit has been reached.
@@ -235,18 +250,22 @@ const ttlock_lock_not_paired_to_gateway = common_device_error.extend({
     .describe(error_code_description),
 }).describe(`
     ---
+    resource_type: device
     deprecated: Use \`hub_disconnected\` instead.
     ---
     Indicates that the lock is not paired with a gateway.
     `)
 
-const missing_device_credentials = common_device_error
-  .extend({
-    error_code: z
-      .literal('missing_device_credentials')
-      .describe(error_code_description),
-  })
-  .describe('Indicates that device credentials are missing.')
+const missing_device_credentials = common_device_error.extend({
+  error_code: z
+    .literal('missing_device_credentials')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: device
+    ---
+    Indicates that device credentials are missing.
+    `)
 
 const auxiliary_heat_running = common_device_error.extend({
   error_code: z
@@ -254,18 +273,22 @@ const auxiliary_heat_running = common_device_error.extend({
     .describe(error_code_description),
 }).describe(`
     ---
+    resource_type: device
     variant_group_key: thermostats
     ---
     Indicates that the auxiliary heat is running.
     `)
 
-const subscription_required = common_device_error
-  .extend({
-    error_code: z
-      .literal('subscription_required')
-      .describe(error_code_description),
-  })
-  .describe('Indicates that a subscription is required to connect.')
+const subscription_required = common_device_error.extend({
+  error_code: z
+    .literal('subscription_required')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: device
+    ---
+    Indicates that a subscription is required to connect.
+    `)
 
 const lockly_missing_wifi_bridge = common_device_error.extend({
   error_code: z
@@ -273,6 +296,7 @@ const lockly_missing_wifi_bridge = common_device_error.extend({
     .describe(error_code_description),
 }).describe(`
     ---
+    resource_type: device
     deprecated: Use \`hub_disconnected\` instead.
     ---
     Indicates that the Lockly lock is not connected to a Wi-Fi bridge.