@seamapi/types 1.292.1 → 1.293.0

package/dist/connect.cjs

@@ -14,6 +14,7 @@ __export(schemas_exports, {
   access_code: () => access_code,
   acs_access_group: () => acs_access_group,
   acs_credential: () => acs_credential,
+  acs_encoder: () => acs_encoder,
   acs_entrance: () => acs_entrance,
   acs_system: () => acs_system,
   acs_user: () => acs_user,
@@ -179,6 +180,13 @@ var thermostat_schedule = zod.z.object({
   starts_at: zod.z.string().datetime().describe(
     "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
   ),
+  unstable_is_override_allowed: zod.z.boolean().optional().describe(
+    `
+        ---
+        undocumented: Unstable
+        ---
+        Indicates whether a person at the thermostat can change the thermostat's settings.`
+  ),
   ends_at: zod.z.string().datetime().describe(
     "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
   ),
@@ -1331,6 +1339,38 @@ var acs_credential_on_encoder = zod.z.object({
     common_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional()
   }).optional().describe("Visionline-specific metadata for the credential.")
 });
+var common_acs_encoder_error = zod.z.object({
+  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
+  message: zod.z.string().describe(
+    "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
+  )
+});
+var error_code_description = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
+var acs_encoder_removed = common_acs_encoder_error.extend({
+  error_code: zod.z.literal("acs_encoder_removed").describe(error_code_description),
+  _event_id: zod.z.string().uuid().describe(
+    "ID of the event that was created when the `acs_encoder` was removed."
+  )
+});
+var acs_encoder_error = (
+  // z.union([
+  acs_encoder_removed.describe("Error associated with the `acs_encoder`.")
+);
+zod.z.object({
+  acs_encoder_removed: acs_encoder_removed.optional().nullable()
+});
+var acs_encoder = zod.z.object({
+  acs_encoder_id: zod.z.string().uuid().describe("ID of the `acs_encoder`."),
+  acs_system_id: zod.z.string().uuid().describe(
+    "ID of the access control system that contains the `acs_encoder`."
+  ),
+  workspace_id: zod.z.string().uuid().describe(
+    "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`."
+  ),
+  errors: zod.z.array(acs_encoder_error).describe("Errors associated with the `acs_encoder`."),
+  created_at: zod.z.string().datetime().describe("Date and time at which the `acs_encoder` was created."),
+  display_name: zod.z.string().describe("Display name for the `acs_encoder`.")
+});
 var acs_entrance = zod.z.object({
   acs_system_id: zod.z.string().uuid().describe("ID of the access control system that contains the entrance."),
   acs_entrance_id: zod.z.string().uuid().describe("ID of the entrance."),
@@ -1387,29 +1427,29 @@ var common_acs_system_error = zod.z.object({
     "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
   )
 });
-var error_code_description = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
+var error_code_description2 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
 var seam_bridge_disconnected = common_acs_system_error.extend({
-  error_code: zod.z.literal("seam_bridge_disconnected").describe(error_code_description)
+  error_code: zod.z.literal("seam_bridge_disconnected").describe(error_code_description2)
 }).describe(`Indicates that the Seam API cannot communicate with the [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.
   This error might also occur if the Seam Bridge is connected to the wrong [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.seam_bridge_disconnected).`);
 var visionline_instance_unreachable = common_acs_system_error.extend({
-  error_code: zod.z.literal("visionline_instance_unreachable").describe(error_code_description)
+  error_code: zod.z.literal("visionline_instance_unreachable").describe(error_code_description2)
 }).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_ks_subscription_limit_exceeded = common_acs_system_error.extend({
-  error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description)
+  error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description2)
 }).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 acs_system_disconnected = common_acs_system_error.extend({
-  error_code: zod.z.literal("acs_system_disconnected").describe(error_code_description)
+  error_code: zod.z.literal("acs_system_disconnected").describe(error_code_description2)
 }).describe(
   "Indicates that the access system has been disconnected. See [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(error_code_description)
+  error_code: zod.z.literal("account_disconnected").describe(error_code_description2)
 }).describe(
   "Indicates that the login credentials are invalid. Reconnect the account using the Connect Webview to restore access."
 );
@@ -7218,6 +7258,11 @@ var openapi_default = {
                             description: "ID of the thermostat schedule.",
                             format: "uuid",
                             type: "string"
+                          },
+                          unstable_is_override_allowed: {
+                            description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
+                            type: "boolean",
+                            "x-undocumented": "Unstable"
                           }
                         },
                         required: [
@@ -7967,6 +8012,11 @@ var openapi_default = {
             description: "ID of the thermostat schedule.",
             format: "uuid",
             type: "string"
+          },
+          unstable_is_override_allowed: {
+            description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
+            type: "boolean",
+            "x-undocumented": "Unstable"
           }
         },
         required: [
@@ -11779,13 +11829,13 @@ var openapi_default = {
                     format: "uuid",
                     type: "string"
                   },
-                  device_id: {
-                    description: "ID of the encoder to use for the encoding.",
+                  acs_encoder_id: {
+                    description: "ID of the acs_encoder to use for the encoding.",
                     format: "uuid",
                     type: "string"
                   }
                 },
-                required: ["device_id", "acs_credential_id"],
+                required: ["acs_encoder_id", "acs_credential_id"],
                 type: "object"
               }
             }
@@ -11836,28 +11886,28 @@ var openapi_default = {
                 oneOf: [
                   {
                     properties: {
-                      acs_system_ids: {
+                      acs_encoder_ids: {
                         items: { format: "uuid", type: "string" },
                         type: "array"
                       },
-                      device_ids: {
+                      acs_system_ids: {
                         items: { format: "uuid", type: "string" },
                         type: "array"
                       },
                       limit: { default: 500, format: "float", type: "number" }
                     },
-                    required: ["acs_system_ids", "device_ids"],
+                    required: ["acs_system_ids", "acs_encoder_ids"],
                     type: "object"
                   },
                   {
                     properties: {
-                      device_ids: {
+                      acs_encoder_ids: {
                         items: { format: "uuid", type: "string" },
                         type: "array"
                       },
                       limit: { default: 500, format: "float", type: "number" }
                     },
-                    required: ["device_ids"],
+                    required: ["acs_encoder_ids"],
                     type: "object"
                   },
                   {
@@ -11882,13 +11932,84 @@ var openapi_default = {
               "application/json": {
                 schema: {
                   properties: {
-                    devices: {
-                      items: { $ref: "#/components/schemas/device" },
+                    acs_encoders: {
+                      items: {
+                        properties: {
+                          acs_encoder_id: {
+                            description: "ID of the `acs_encoder`.",
+                            format: "uuid",
+                            type: "string"
+                          },
+                          acs_system_id: {
+                            description: "ID of the access control system that contains the `acs_encoder`.",
+                            format: "uuid",
+                            type: "string"
+                          },
+                          created_at: {
+                            description: "Date and time at which the `acs_encoder` was created.",
+                            format: "date-time",
+                            type: "string"
+                          },
+                          display_name: {
+                            description: "Display name for the `acs_encoder`.",
+                            type: "string"
+                          },
+                          errors: {
+                            description: "Errors associated with the `acs_encoder`.",
+                            items: {
+                              description: "Error associated with the `acs_encoder`.",
+                              properties: {
+                                _event_id: {
+                                  description: "ID of the event that was created when the `acs_encoder` was removed.",
+                                  format: "uuid",
+                                  type: "string"
+                                },
+                                created_at: {
+                                  description: "Date and time at which Seam created the error.",
+                                  format: "date-time",
+                                  type: "string"
+                                },
+                                error_code: {
+                                  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
+                                  enum: ["acs_encoder_removed"],
+                                  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",
+                                "_event_id"
+                              ],
+                              type: "object"
+                            },
+                            type: "array"
+                          },
+                          workspace_id: {
+                            description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.",
+                            format: "uuid",
+                            type: "string"
+                          }
+                        },
+                        required: [
+                          "acs_encoder_id",
+                          "acs_system_id",
+                          "workspace_id",
+                          "errors",
+                          "created_at",
+                          "display_name"
+                        ],
+                        type: "object"
+                      },
                       type: "array"
                     },
                     ok: { type: "boolean" }
                   },
-                  required: ["devices", "ok"],
+                  required: ["acs_encoders", "ok"],
                   type: "object"
                 }
               }
@@ -11907,8 +12028,8 @@ var openapi_default = {
         tags: ["/acs"],
         "x-fern-sdk-group-name": ["acs", "encoders"],
         "x-fern-sdk-method-name": "list",
-        "x-fern-sdk-return-value": "devices",
-        "x-response-key": "devices",
+        "x-fern-sdk-return-value": "acs_encoders",
+        "x-response-key": "acs_encoders",
         "x-undocumented": "Encoders are in alpha."
       }
     },
@@ -11920,18 +12041,18 @@ var openapi_default = {
             "application/json": {
               schema: {
                 properties: {
-                  acs_system_id: {
-                    description: "ID of the acs_system the encoder belongs to.",
+                  acs_encoder_id: {
+                    description: "ID of the acs_encoder to use for the scan.",
                     format: "uuid",
                     type: "string"
                   },
-                  device_id: {
-                    description: "ID of the encoder to use for the scan.",
+                  acs_system_id: {
+                    description: "ID of the acs_system the encoder belongs to.",
                     format: "uuid",
                     type: "string"
                   }
                 },
-                required: ["acs_system_id", "device_id"],
+                required: ["acs_system_id", "acs_encoder_id"],
                 type: "object"
               }
             }
@@ -18729,6 +18850,7 @@ var openapi_default = {
                     description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
                     type: "string"
                   },
+                  is_override_allowed: { default: false, type: "boolean" },
                   max_override_period_minutes: {
                     default: 0,
                     description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
@@ -18980,6 +19102,7 @@ var openapi_default = {
                     description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
                     type: "string"
                   },
+                  is_override_allowed: { type: "boolean" },
                   max_override_period_minutes: {
                     description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
                     minimum: 0,
@@ -19049,6 +19172,7 @@ var openapi_default = {
                     description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
                     type: "string"
                   },
+                  is_override_allowed: { type: "boolean" },
                   max_override_period_minutes: {
                     description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
                     minimum: 0,