@seamapi/types 1.867.0 → 1.869.0

package/dist/connect.cjs

@@ -1313,7 +1313,14 @@ var common_device_error = zod.z.object({
 var error_code_description2 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
 var device_offline = common_device_error.extend({
   error_code: zod.z.literal("device_offline").describe(error_code_description2)
-}).describe("Indicates that the device is offline.");
+}).describe(
+  `
+    ---
+    deprecated: Use \`device_disconnected\` instead.
+    ---
+    Indicates that the device is offline.
+    `
+);
 var device_removed = common_device_error.extend({
   error_code: zod.z.literal("device_removed").describe(error_code_description2)
 }).describe("Indicates that the device has been removed.");
@@ -1350,6 +1357,7 @@ var august_lock_missing_bridge = common_device_error.extend({
   error_code: zod.z.literal("august_lock_missing_bridge").describe(error_code_description2)
 }).describe(`
     ---
+    deprecated: Use \`hub_disconnected\` instead.
     variant_group_key: locks
     ---
     Indicates that the lock is not connected to a bridge.
@@ -1369,6 +1377,9 @@ var salto_ks_subscription_limit_exceeded2 = common_device_error.extend({
 var ttlock_lock_not_paired_to_gateway = common_device_error.extend({
   error_code: zod.z.literal("ttlock_lock_not_paired_to_gateway").describe(error_code_description2)
 }).describe(`
+    ---
+    deprecated: Use \`hub_disconnected\` instead.
+    ---
     Indicates that the lock is not paired with a gateway.
     `);
 var missing_device_credentials = common_device_error.extend({
@@ -1388,6 +1399,9 @@ var subscription_required = common_device_error.extend({
 var lockly_missing_wifi_bridge = common_device_error.extend({
   error_code: zod.z.literal("lockly_missing_wifi_bridge").describe(error_code_description2)
 }).describe(`
+    ---
+    deprecated: Use \`hub_disconnected\` instead.
+    ---
     Indicates that the Lockly lock is not connected to a Wi-Fi bridge.
     `);
 var device_error = zod.z.discriminatedUnion("error_code", [
@@ -1477,6 +1491,9 @@ var salto_ks_lock_access_code_support_removed = common_device_warning.extend({
 var wyze_device_missing_gateway = common_device_warning.extend({
   warning_code: zod.z.literal("wyze_device_missing_gateway").describe(warning_code_description2)
 }).describe(`
+    ---
+    deprecated: Use \`hub_disconnected\` device error instead.
+    ---
     Indicates that the Wyze Lock is not connected to a gateway.
     `);
 var third_party_integration_detected = common_device_warning.extend({
@@ -2348,10 +2365,24 @@ var salto_ks_user_not_subscribed = common_access_code_error.extend({
 }).describe("Salto site user is not subscribed.");
 var wyze_duplicate_code_name = common_access_code_error.extend({
   error_code: zod.z.literal("wyze_duplicate_code_name").describe(error_code_description3)
-}).describe("Duplicate access code name detected.");
+}).describe(
+  `
+    ---
+    deprecated: Use \`duplicate_code_on_device\` instead.
+    ---
+    Duplicate access code name detected.
+    `
+);
 var wyze_potential_duplicate_code = common_access_code_error.extend({
   error_code: zod.z.literal("wyze_potential_duplicate_code").describe(error_code_description3)
-}).describe("Potential duplicate access code detected.");
+}).describe(
+  `
+    ---
+    deprecated: Use \`duplicate_code_on_device\` instead.
+    ---
+    Potential duplicate access code detected.
+    `
+);
 var dormakaba_oracode_invalid_time_range = common_access_code_error.extend({
   error_code: zod.z.literal("dormakaba_oracode_invalid_time_range").describe(error_code_description3)
 }).describe(
@@ -2431,7 +2462,14 @@ var code_modified_external_to_seam_warning = common_access_code_warning.extend({
 );
 var schlage_detected_duplicate = common_access_code_warning.extend({
   warning_code: zod.z.literal("schlage_detected_duplicate").describe(warning_code_description3)
-}).describe("Duplicate access code detected.");
+}).describe(
+  `
+    ---
+    deprecated: Use \`duplicate_code_on_device\` error instead.
+    ---
+    Duplicate access code detected.
+    `
+);
 var schlage_creation_outage = common_access_code_warning.extend({
   warning_code: zod.z.literal("schlage_creation_outage").describe(warning_code_description3)
 }).describe("Received an error when attempting to create this code.");
@@ -7524,6 +7562,7 @@ var openapi = {
                   type: "object"
                 },
                 {
+                  deprecated: true,
                   description: "Duplicate access code name detected.",
                   properties: {
                     created_at: {
@@ -7547,9 +7586,11 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `duplicate_code_on_device` instead."
                 },
                 {
+                  deprecated: true,
                   description: "Potential duplicate access code detected.",
                   properties: {
                     created_at: {
@@ -7573,7 +7614,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `duplicate_code_on_device` instead."
                 },
                 {
                   description: "No Dormakaba Oracode user levels configured for the requested time range.",
@@ -7755,6 +7797,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the device is offline.",
                   properties: {
                     created_at: {
@@ -7783,7 +7826,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `device_disconnected` instead."
                 },
                 {
                   description: "Indicates that the device has been removed.",
@@ -7943,6 +7987,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the lock is not connected to a bridge.",
                   properties: {
                     created_at: {
@@ -7972,10 +8017,12 @@ var openapi = {
                     "error_code"
                   ],
                   type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead.",
                   "x-variant-group-key": "locks"
                 },
                 {
-                  description: "\n    Indicates that the lock is not paired with a gateway.\n    ",
+                  deprecated: true,
+                  description: "Indicates that the lock is not paired with a gateway.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the error.",
@@ -8003,7 +8050,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead."
                 },
                 {
                   description: "Indicates that device credentials are missing.",
@@ -8100,7 +8148,8 @@ var openapi = {
                   type: "object"
                 },
                 {
-                  description: "\n    Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n    ",
+                  deprecated: true,
+                  description: "Indicates that the Lockly lock is not connected to a Wi-Fi bridge.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the error.",
@@ -8128,7 +8177,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead."
                 },
                 {
                   description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/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/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
@@ -8509,6 +8559,7 @@ var openapi = {
                   type: "object"
                 },
                 {
+                  deprecated: true,
                   description: "Duplicate access code detected.",
                   properties: {
                     created_at: {
@@ -8527,7 +8578,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "warning_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `duplicate_code_on_device` error instead."
                 },
                 {
                   description: "Received an error when attempting to create this code.",
@@ -18157,6 +18209,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the device is offline.",
                   properties: {
                     created_at: {
@@ -18185,7 +18238,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `device_disconnected` instead."
                 },
                 {
                   description: "Indicates that the device has been removed.",
@@ -18345,6 +18399,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the lock is not connected to a bridge.",
                   properties: {
                     created_at: {
@@ -18374,10 +18429,12 @@ var openapi = {
                     "error_code"
                   ],
                   type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead.",
                   "x-variant-group-key": "locks"
                 },
                 {
-                  description: "\n    Indicates that the lock is not paired with a gateway.\n    ",
+                  deprecated: true,
+                  description: "Indicates that the lock is not paired with a gateway.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the error.",
@@ -18405,7 +18462,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead."
                 },
                 {
                   description: "Indicates that device credentials are missing.",
@@ -18502,7 +18560,8 @@ var openapi = {
                   type: "object"
                 },
                 {
-                  description: "\n    Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n    ",
+                  deprecated: true,
+                  description: "Indicates that the Lockly lock is not connected to a Wi-Fi bridge.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the error.",
@@ -18530,7 +18589,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead."
                 },
                 {
                   description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/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/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
@@ -21072,7 +21132,8 @@ var openapi = {
                   "x-variant-group-key": "access_codes"
                 },
                 {
-                  description: "\n    Indicates that the Wyze Lock is not connected to a gateway.\n    ",
+                  deprecated: true,
+                  description: "Indicates that the Wyze Lock is not connected to a gateway.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the warning.",
@@ -21090,7 +21151,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "created_at", "warning_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `hub_disconnected` device error instead."
                 },
                 {
                   description: "Indicates that a third-party integration has been detected.",
@@ -31949,6 +32011,7 @@ var openapi = {
                   type: "object"
                 },
                 {
+                  deprecated: true,
                   description: "Duplicate access code name detected.",
                   properties: {
                     created_at: {
@@ -31972,9 +32035,11 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `duplicate_code_on_device` instead."
                 },
                 {
+                  deprecated: true,
                   description: "Potential duplicate access code detected.",
                   properties: {
                     created_at: {
@@ -31998,7 +32063,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `duplicate_code_on_device` instead."
                 },
                 {
                   description: "No Dormakaba Oracode user levels configured for the requested time range.",
@@ -32180,6 +32246,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the device is offline.",
                   properties: {
                     created_at: {
@@ -32208,7 +32275,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `device_disconnected` instead."
                 },
                 {
                   description: "Indicates that the device has been removed.",
@@ -32368,6 +32436,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the lock is not connected to a bridge.",
                   properties: {
                     created_at: {
@@ -32397,10 +32466,12 @@ var openapi = {
                     "error_code"
                   ],
                   type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead.",
                   "x-variant-group-key": "locks"
                 },
                 {
-                  description: "\n    Indicates that the lock is not paired with a gateway.\n    ",
+                  deprecated: true,
+                  description: "Indicates that the lock is not paired with a gateway.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the error.",
@@ -32428,7 +32499,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead."
                 },
                 {
                   description: "Indicates that device credentials are missing.",
@@ -32525,7 +32597,8 @@ var openapi = {
                   type: "object"
                 },
                 {
-                  description: "\n    Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n    ",
+                  deprecated: true,
+                  description: "Indicates that the Lockly lock is not connected to a Wi-Fi bridge.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the error.",
@@ -32553,7 +32626,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead."
                 },
                 {
                   description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/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/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
@@ -32651,6 +32725,7 @@ var openapi = {
                   type: "object"
                 },
                 {
+                  deprecated: true,
                   description: "Duplicate access code detected.",
                   properties: {
                     created_at: {
@@ -32669,7 +32744,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "warning_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `duplicate_code_on_device` error instead."
                 },
                 {
                   description: "Received an error when attempting to create this code.",
@@ -34842,6 +34918,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the device is offline.",
                   properties: {
                     created_at: {
@@ -34870,7 +34947,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `device_disconnected` instead."
                 },
                 {
                   description: "Indicates that the device has been removed.",
@@ -35030,6 +35108,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the lock is not connected to a bridge.",
                   properties: {
                     created_at: {
@@ -35059,10 +35138,12 @@ var openapi = {
                     "error_code"
                   ],
                   type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead.",
                   "x-variant-group-key": "locks"
                 },
                 {
-                  description: "\n    Indicates that the lock is not paired with a gateway.\n    ",
+                  deprecated: true,
+                  description: "Indicates that the lock is not paired with a gateway.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the error.",
@@ -35090,7 +35171,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead."
                 },
                 {
                   description: "Indicates that device credentials are missing.",
@@ -35187,7 +35269,8 @@ var openapi = {
                   type: "object"
                 },
                 {
-                  description: "\n    Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n    ",
+                  deprecated: true,
+                  description: "Indicates that the Lockly lock is not connected to a Wi-Fi bridge.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the error.",
@@ -35215,7 +35298,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead."
                 },
                 {
                   description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/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/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
@@ -35478,7 +35562,8 @@ var openapi = {
                   "x-variant-group-key": "access_codes"
                 },
                 {
-                  description: "\n    Indicates that the Wyze Lock is not connected to a gateway.\n    ",
+                  deprecated: true,
+                  description: "Indicates that the Wyze Lock is not connected to a gateway.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the warning.",
@@ -35496,7 +35581,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "created_at", "warning_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `hub_disconnected` device error instead."
                 },
                 {
                   description: "Indicates that a third-party integration has been detected.",
@@ -59031,7 +59117,7 @@ var openapi = {
     },
     "/devices/simulate/connect_to_hub": {
       post: {
-        description: "Simulates bringing the Wi\u2011Fi hub (bridge) back online for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August and TTLock locks.\nThis will clear the corresponding `hub_disconnected` or\n`ttlock_lock_not_paired_to_gateway` error on the device.",
+        description: "Simulates bringing the Wi\u2011Fi hub (bridge) back online for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August and TTLock locks.\nThis will clear the `hub_disconnected` error on the device.",
         operationId: "devicesSimulateConnectToHubPost",
         requestBody: {
           content: {
@@ -59133,7 +59219,7 @@ var openapi = {
     },
     "/devices/simulate/disconnect_from_hub": {
       post: {
-        description: "Simulates taking the Wi\u2011Fi hub (bridge) offline for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August, TTLock, and IglooHome devices.\nThis will set the corresponding `hub_disconnected` or\n`ttlock_lock_not_paired_to_gateway` error on the device, or mark the\nIglooHome bridge offline in sandbox.",
+        description: "Simulates taking the Wi\u2011Fi hub (bridge) offline for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August, TTLock, and IglooHome devices.\nThis will set the `hub_disconnected` error on the device, or mark the\nIglooHome bridge offline in sandbox.",
         operationId: "devicesSimulateDisconnectFromHubPost",
         requestBody: {
           content: {