@seamapi/types 1.242.0 → 1.243.0

package/dist/connect.cjs

@@ -143,7 +143,7 @@ var climate_preset = zod.z.object({
   climate_preset_key: zod.z.string(),
   can_edit: zod.z.boolean(),
   can_delete: zod.z.boolean(),
-  name: zod.z.string().nullable(),
+  name: zod.z.string().nullable().default(null),
   display_name: zod.z.string(),
   fan_mode_setting: fan_mode_setting.optional(),
   hvac_mode_setting: hvac_mode_setting.optional(),
@@ -339,11 +339,7 @@ var smartlock = zod.z.object({
     can_remotely_lock: true,
     can_remotely_unlock: true,
     can_program_offline_access_codes: true,
-    can_program_online_access_codes: true,
-    can_hvac_heat: true,
-    can_hvac_cool: true,
-    can_hvac_heat_cool: true,
-    can_turn_off_hvac: true
+    can_program_online_access_codes: true
   })
 );
 var sensor = zod.z.object({
@@ -369,7 +365,14 @@ var thermostat = zod.z.object({
   software_features: zod.z.object({
     can_program_climate_schedules: zod.z.boolean()
   })
-});
+}).merge(
+  device_model_capability_flags.pick({
+    can_hvac_heat: true,
+    can_hvac_cool: true,
+    can_hvac_heat_cool: true,
+    can_turn_off_hvac: true
+  })
+);
 var relay = zod.z.object({
   main_category: zod.z.literal(device_category.enum.relay)
 });
@@ -558,7 +561,21 @@ var device_metadata = zod.z.object({
   ttlock_metadata: zod.z.object({
     lock_id: zod.z.number(),
     lock_alias: zod.z.string(),
-    feature_value: zod.z.string()
+    feature_value: zod.z.string(),
+    features: zod.z.object({
+      passcode: zod.z.boolean(),
+      passcode_management: zod.z.boolean(),
+      unlock_via_gateway: zod.z.boolean(),
+      lock_command: zod.z.boolean(),
+      incomplete_keyboard_passcode: zod.z.boolean()
+    }),
+    has_gateway: zod.z.boolean().optional(),
+    wireless_keypads: zod.z.array(
+      zod.z.object({
+        wireless_keypad_id: zod.z.number(),
+        wireless_keypad_name: zod.z.string()
+      })
+    ).optional()
   }),
   seam_bridge_metadata: zod.z.object({
     unlock_method: zod.z.enum(["bridge", "doorking"]).optional(),
@@ -1220,27 +1237,34 @@ var visionline_instance_unreachable = common_acs_system_error.extend({
 }).describe(`Indicates that the Seam Bridge is functioning correctly and the Seam API can communicate with the Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/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/latest/core-concepts/workspaces).
   See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).`);
-var salto_site_user_limit_reached = common_acs_system_error.extend({
-  error_code: zod.z.literal("salto_site_user_limit_reached").describe(
+var salto_ks_subscription_limit_exceeded = common_acs_system_error.extend({
+  error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").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."
   )
 });
-var salto_seam_integration_blocked = common_acs_system_error.extend({
-  error_code: zod.z.literal("salto_seam_integration_blocked").describe(
-    "Indicates that the Seam Integration user site is blocked. This means that Seam does not have permission to access Salto resources. Go to Salto Dashboard to remove 'Seam Integration' block"
+var acs_system_disconnected = common_acs_system_error.extend({
+  error_code: zod.z.literal("acs_system_disconnected").describe(
+    "Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue."
+  )
+});
+var account_disconnected = common_acs_system_error.extend({
+  error_code: zod.z.literal("account_disconnected").describe(
+    "Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access."
   )
 });
 var acs_system_error = zod.z.union([
   seam_bridge_disconnected,
   visionline_instance_unreachable,
-  salto_site_user_limit_reached,
-  salto_seam_integration_blocked
+  salto_ks_subscription_limit_exceeded,
+  acs_system_disconnected,
+  account_disconnected
 ]).describe("Error associated with the `acs_system`.");
 zod.z.object({
   seam_bridge_disconnected: seam_bridge_disconnected.optional().nullable(),
   visionline_instance_unreachable: visionline_instance_unreachable.optional().nullable(),
-  salto_site_user_limit_reached: salto_site_user_limit_reached.optional().nullable(),
-  salto_seam_integration_blocked: salto_seam_integration_blocked.optional().nullable()
+  salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded.optional().nullable(),
+  acs_system_disconnected: acs_system_disconnected.optional().nullable(),
+  account_disconnected: account_disconnected.optional().nullable()
 });
 var common_acs_system_warning = zod.z.object({
   created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
@@ -1248,17 +1272,17 @@ var common_acs_system_warning = zod.z.object({
     "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
   )
 });
-var salto_site_user_limit_almost_reached = common_acs_system_warning.extend({
-  warning_code: zod.z.literal("salto_site_user_limit_almost_reached").describe(
-    "You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit."
+var salto_ks_subscription_limit_almost_reached = common_acs_system_warning.extend({
+  warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(
+    "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this."
   )
 });
 var acs_system_warning = (
   // z.union([
-  salto_site_user_limit_almost_reached.describe("Warning associated with the `acs_system`.")
+  salto_ks_subscription_limit_almost_reached.describe("Warning associated with the `acs_system`.")
 );
 zod.z.object({
-  salto_site_user_limit_almost_reached: salto_site_user_limit_almost_reached.optional().nullable()
+  salto_ks_subscription_limit_almost_reached: salto_ks_subscription_limit_almost_reached.optional().nullable()
 });
 var acs_system = zod.z.object({
   acs_system_id: zod.z.string().uuid().describe("ID of the `acs_system`."),
@@ -2857,7 +2881,27 @@ var openapi_default = {
                     },
                     error_code: {
                       description: "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.",
-                      enum: ["salto_site_user_limit_reached"],
+                      enum: ["salto_ks_subscription_limit_exceeded"],
+                      type: "string"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
+                  },
+                  required: ["created_at", "message", "error_code"],
+                  type: "object"
+                },
+                {
+                  properties: {
+                    created_at: {
+                      description: "Date and time at which Seam created the error.",
+                      format: "date-time",
+                      type: "string"
+                    },
+                    error_code: {
+                      description: "Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue.",
+                      enum: ["acs_system_disconnected"],
                       type: "string"
                     },
                     message: {
@@ -2876,8 +2920,8 @@ var openapi_default = {
                       type: "string"
                     },
                     error_code: {
-                      description: "Indicates that the Seam Integration user site is blocked. This means that Seam does not have permission to access Salto resources. Go to Salto Dashboard to remove 'Seam Integration' block",
-                      enum: ["salto_seam_integration_blocked"],
+                      description: "Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access.",
+                      enum: ["account_disconnected"],
                       type: "string"
                     },
                     message: {
@@ -2963,8 +3007,8 @@ var openapi_default = {
                   type: "string"
                 },
                 warning_code: {
-                  description: "You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit.",
-                  enum: ["salto_site_user_limit_almost_reached"],
+                  description: "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this.",
+                  enum: ["salto_ks_subscription_limit_almost_reached"],
                   type: "string"
                 }
               },
@@ -5310,10 +5354,50 @@ var openapi_default = {
                       ttlock_metadata: {
                         properties: {
                           feature_value: { type: "string" },
+                          features: {
+                            properties: {
+                              incomplete_keyboard_passcode: { type: "boolean" },
+                              lock_command: { type: "boolean" },
+                              passcode: { type: "boolean" },
+                              passcode_management: { type: "boolean" },
+                              unlock_via_gateway: { type: "boolean" }
+                            },
+                            required: [
+                              "passcode",
+                              "passcode_management",
+                              "unlock_via_gateway",
+                              "lock_command",
+                              "incomplete_keyboard_passcode"
+                            ],
+                            type: "object"
+                          },
+                          has_gateway: { type: "boolean" },
                           lock_alias: { type: "string" },
-                          lock_id: { format: "float", type: "number" }
+                          lock_id: { format: "float", type: "number" },
+                          wireless_keypads: {
+                            items: {
+                              properties: {
+                                wireless_keypad_id: {
+                                  format: "float",
+                                  type: "number"
+                                },
+                                wireless_keypad_name: { type: "string" }
+                              },
+                              required: [
+                                "wireless_keypad_id",
+                                "wireless_keypad_name"
+                              ],
+                              type: "object"
+                            },
+                            type: "array"
+                          }
                         },
-                        required: ["lock_id", "lock_alias", "feature_value"],
+                        required: [
+                          "lock_id",
+                          "lock_alias",
+                          "feature_value",
+                          "features"
+                        ],
                         type: "object"
                       },
                       two_n_metadata: {
@@ -5490,13 +5574,16 @@ var openapi_default = {
                               type: "string"
                             },
                             manual_override_allowed: { type: "boolean" },
-                            name: { nullable: true, type: "string" }
+                            name: {
+                              default: null,
+                              nullable: true,
+                              type: "string"
+                            }
                           },
                           required: [
                             "climate_preset_key",
                             "can_edit",
                             "can_delete",
-                            "name",
                             "display_name",
                             "manual_override_allowed"
                           ],
@@ -5542,7 +5629,11 @@ var openapi_default = {
                             type: "string"
                           },
                           manual_override_allowed: { type: "boolean" },
-                          name: { nullable: true, type: "string" }
+                          name: {
+                            default: null,
+                            nullable: true,
+                            type: "string"
+                          }
                         },
                         type: "object"
                       },
@@ -5578,7 +5669,11 @@ var openapi_default = {
                             type: "string"
                           },
                           manual_override_allowed: { type: "boolean" },
-                          name: { nullable: true, type: "string" }
+                          name: {
+                            default: null,
+                            nullable: true,
+                            type: "string"
+                          }
                         },
                         type: "object",
                         "x-deprecated": "use fallback_climate_preset_key to specify a fallback climate preset instead."
@@ -14797,12 +14892,11 @@ var openapi_default = {
                     type: "string"
                   },
                   manual_override_allowed: { type: "boolean" },
-                  name: { nullable: true, type: "string" }
+                  name: { default: null, nullable: true, type: "string" }
                 },
                 required: [
                   "device_id",
                   "climate_preset_key",
-                  "name",
                   "manual_override_allowed"
                 ],
                 type: "object"
@@ -14847,13 +14941,12 @@ var openapi_default = {
                           type: "string"
                         },
                         manual_override_allowed: { type: "boolean" },
-                        name: { nullable: true, type: "string" }
+                        name: { default: null, nullable: true, type: "string" }
                       },
                       required: [
                         "climate_preset_key",
                         "can_edit",
                         "can_delete",
-                        "name",
                         "display_name",
                         "manual_override_allowed"
                       ],
@@ -15854,12 +15947,11 @@ var openapi_default = {
                     type: "string"
                   },
                   manual_override_allowed: { type: "boolean" },
-                  name: { nullable: true, type: "string" }
+                  name: { default: null, nullable: true, type: "string" }
                 },
                 required: [
                   "device_id",
                   "climate_preset_key",
-                  "name",
                   "manual_override_allowed"
                 ],
                 type: "object"
@@ -15904,13 +15996,12 @@ var openapi_default = {
                           type: "string"
                         },
                         manual_override_allowed: { type: "boolean" },
-                        name: { nullable: true, type: "string" }
+                        name: { default: null, nullable: true, type: "string" }
                       },
                       required: [
                         "climate_preset_key",
                         "can_edit",
                         "can_delete",
-                        "name",
                         "display_name",
                         "manual_override_allowed"
                       ],
@@ -15968,12 +16059,11 @@ var openapi_default = {
                     type: "string"
                   },
                   manual_override_allowed: { type: "boolean" },
-                  name: { nullable: true, type: "string" }
+                  name: { default: null, nullable: true, type: "string" }
                 },
                 required: [
                   "device_id",
                   "climate_preset_key",
-                  "name",
                   "manual_override_allowed"
                 ],
                 type: "object"
@@ -16018,13 +16108,12 @@ var openapi_default = {
                           type: "string"
                         },
                         manual_override_allowed: { type: "boolean" },
-                        name: { nullable: true, type: "string" }
+                        name: { default: null, nullable: true, type: "string" }
                       },
                       required: [
                         "climate_preset_key",
                         "can_edit",
                         "can_delete",
-                        "name",
                         "display_name",
                         "manual_override_allowed"
                       ],