@seamapi/types 1.866.0 → 1.868.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({
@@ -2029,6 +2046,7 @@ var DEVICE_PROVIDERS = {
   ICAL: "ical",
   LODGIFY: "lodgify",
   HOSTAWAY: "hostaway",
+  GUESTY: "guesty",
   ACUITY_SCHEDULING: "acuity_scheduling",
   OMNITEC: "omnitec"
 };
@@ -2106,7 +2124,7 @@ var PROVIDER_CATEGORY_MAP = {
     "hotek"
   ],
   cameras: ["ring"],
-  connectors: ["ical", "lodgify", "hostaway", "acuity_scheduling"],
+  connectors: ["ical", "lodgify", "hostaway", "guesty", "acuity_scheduling"],
   internal_beta: ALL_DEVICE_PROVIDERS
 };
 var PROVIDER_CATEGORIES = Object.keys(PROVIDER_CATEGORY_MAP);
@@ -7754,6 +7772,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the device is offline.",
                   properties: {
                     created_at: {
@@ -7782,7 +7801,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.",
@@ -7942,6 +7962,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the lock is not connected to a bridge.",
                   properties: {
                     created_at: {
@@ -7971,10 +7992,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.",
@@ -8002,7 +8025,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead."
                 },
                 {
                   description: "Indicates that device credentials are missing.",
@@ -8099,7 +8123,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.",
@@ -8127,7 +8152,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).",
@@ -18156,6 +18182,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the device is offline.",
                   properties: {
                     created_at: {
@@ -18184,7 +18211,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.",
@@ -18344,6 +18372,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the lock is not connected to a bridge.",
                   properties: {
                     created_at: {
@@ -18373,10 +18402,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.",
@@ -18404,7 +18435,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead."
                 },
                 {
                   description: "Indicates that device credentials are missing.",
@@ -18501,7 +18533,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.",
@@ -18529,7 +18562,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).",
@@ -21071,7 +21105,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.",
@@ -21089,7 +21124,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.",
@@ -21685,6 +21721,7 @@ var openapi = {
               "ical",
               "lodgify",
               "hostaway",
+              "guesty",
               "acuity_scheduling",
               "omnitec"
             ],
@@ -32178,6 +32215,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the device is offline.",
                   properties: {
                     created_at: {
@@ -32206,7 +32244,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.",
@@ -32366,6 +32405,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the lock is not connected to a bridge.",
                   properties: {
                     created_at: {
@@ -32395,10 +32435,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.",
@@ -32426,7 +32468,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead."
                 },
                 {
                   description: "Indicates that device credentials are missing.",
@@ -32523,7 +32566,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.",
@@ -32551,7 +32595,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).",
@@ -34840,6 +34885,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the device is offline.",
                   properties: {
                     created_at: {
@@ -34868,7 +34914,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.",
@@ -35028,6 +35075,7 @@ var openapi = {
                   "x-variant-group-key": "locks"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the lock is not connected to a bridge.",
                   properties: {
                     created_at: {
@@ -35057,10 +35105,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.",
@@ -35088,7 +35138,8 @@ var openapi = {
                     "created_at",
                     "error_code"
                   ],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `hub_disconnected` instead."
                 },
                 {
                   description: "Indicates that device credentials are missing.",
@@ -35185,7 +35236,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.",
@@ -35213,7 +35265,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).",
@@ -35476,7 +35529,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.",
@@ -35494,7 +35548,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.",
@@ -52895,6 +52950,7 @@ var openapi = {
                         "ical",
                         "lodgify",
                         "hostaway",
+                        "guesty",
                         "acuity_scheduling",
                         "omnitec",
                         "yale_access",
@@ -56888,6 +56944,7 @@ var openapi = {
                 "ical",
                 "lodgify",
                 "hostaway",
+                "guesty",
                 "acuity_scheduling",
                 "omnitec"
               ],
@@ -57385,6 +57442,7 @@ var openapi = {
                       "ical",
                       "lodgify",
                       "hostaway",
+                      "guesty",
                       "acuity_scheduling",
                       "omnitec"
                     ],
@@ -59026,7 +59084,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: {
@@ -59128,7 +59186,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: {
@@ -59633,6 +59691,7 @@ var openapi = {
                 "ical",
                 "lodgify",
                 "hostaway",
+                "guesty",
                 "acuity_scheduling",
                 "omnitec"
               ],
@@ -60129,6 +60188,7 @@ var openapi = {
                       "ical",
                       "lodgify",
                       "hostaway",
+                      "guesty",
                       "acuity_scheduling",
                       "omnitec"
                     ],
@@ -68508,6 +68568,7 @@ var openapi = {
                       "ical",
                       "lodgify",
                       "hostaway",
+                      "guesty",
                       "acuity_scheduling"
                     ],
                     type: "string"