@seamapi/types 1.951.0 → 1.953.0

package/dist/index.cjs

@@ -1647,10 +1647,19 @@ var salto_ks_privacy_mode = common_device_warning.extend({
   warning_code: zod.z.literal("salto_ks_privacy_mode").describe(warning_code_description2)
 }).describe(`
     ---
+    deprecated: Use \`privacy_mode\` instead.
     variant_group_key: access_codes
     ---
     Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.
   `);
+var privacy_mode = common_device_warning.extend({
+  warning_code: zod.z.literal("privacy_mode").describe(warning_code_description2)
+}).describe(`
+    ---
+    variant_group_key: access_codes
+    ---
+    Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled.
+  `);
 var salto_ks_subscription_limit_almost_reached2 = common_device_warning.extend(
   {
     warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(warning_code_description2)
@@ -1844,6 +1853,7 @@ var device_warning = zod.z.discriminatedUnion("warning_code", [
   device_has_flaky_connection,
   salto_ks_office_mode,
   salto_ks_privacy_mode,
+  privacy_mode,
   salto_ks_subscription_limit_almost_reached2,
   salto_ks_lock_access_code_support_removed,
   unknown_issue_with_phone,
@@ -1877,6 +1887,7 @@ zod.z.object({
   scheduled_maintenance_window: scheduled_maintenance_window2.optional().nullable(),
   salto_ks_office_mode: salto_ks_office_mode.optional().nullable(),
   salto_ks_privacy_mode: salto_ks_privacy_mode.optional().nullable(),
+  privacy_mode: privacy_mode.optional().nullable(),
   salto_ks_subscription_limit_almost_reached: salto_ks_subscription_limit_almost_reached2.optional().nullable(),
   salto_ks_lock_access_code_support_removed: salto_ks_lock_access_code_support_removed.optional().nullable(),
   unknown_issue_with_phone: unknown_issue_with_phone.optional().nullable(),
@@ -4002,6 +4013,11 @@ var entrance_setup_required = common_acs_entrance_warning.extend({
 );
 var salto_ks_privacy_mode2 = common_acs_entrance_warning.extend({
   warning_code: zod.z.literal("salto_ks_privacy_mode").describe(warning_code_description8)
+}).describe(
+  "deprecated: Use `privacy_mode` instead. Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access."
+);
+var privacy_mode2 = common_acs_entrance_warning.extend({
+  warning_code: zod.z.literal("privacy_mode").describe(warning_code_description8)
 }).describe(
   "Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access."
 );
@@ -4009,7 +4025,8 @@ var acs_entrance_warning = zod.z.discriminatedUnion("warning_code", [
   salto_ks_entrance_access_code_support_removed,
   entrance_shares_zone,
   entrance_setup_required,
-  salto_ks_privacy_mode2
+  salto_ks_privacy_mode2,
+  privacy_mode2
 ]).describe(
   "Warning associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details)."
 );
@@ -4017,7 +4034,8 @@ zod.z.object({
   salto_ks_entrance_access_code_support_removed: salto_ks_entrance_access_code_support_removed.optional().nullable(),
   entrance_shares_zone: entrance_shares_zone.optional().nullable(),
   entrance_setup_required: entrance_setup_required.optional().nullable(),
-  salto_ks_privacy_mode: salto_ks_privacy_mode2.optional().nullable()
+  salto_ks_privacy_mode: salto_ks_privacy_mode2.optional().nullable(),
+  privacy_mode: privacy_mode2.optional().nullable()
 });
 var acs_entrance_capability_flags = zod.z.object({
   can_unlock_with_mobile_key: zod.z.boolean().optional().describe(
@@ -5598,6 +5616,16 @@ var common_event_warning = zod.z.object({
 }).describe(
   "Warning associated with the resource, including the warning code, message, and creation timestamp."
 );
+var lock_access_denied_reason = zod.z.enum([
+  "unknown_code",
+  "expired_code",
+  "blocklisted_code",
+  "too_many_attempts",
+  "blocked_by_privacy_mode",
+  "credential_error"
+]).describe(
+  "Normalized reason a lock denied access. Provider-agnostic; not all providers report every value."
+);
 
 // src/lib/seam/connect/models/events/access-codes.ts
 var access_code_event = common_event.extend({
@@ -6764,7 +6792,13 @@ var lock_access_denied_event = device_event.extend({
       ---
       ID of the ACS entrance associated with the access-denied event.
     `),
-  device_id: zod.z.string().uuid().optional().describe("ID of the affected device.")
+  device_id: zod.z.string().uuid().optional().describe("ID of the affected device."),
+  reason: zod.z.object({
+    reason_code: lock_access_denied_reason,
+    message: zod.z.string().describe("Human-readable explanation of why access was denied.")
+  }).optional().describe(
+    "Why access was denied, when the provider reports a determinable cause. Omitted when unknown."
+  )
 }).describe(`
   ---
   route_path: /locks
@@ -11389,7 +11423,7 @@ var openapi = {
                   type: "object"
                 },
                 {
-                  description: "Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.",
+                  description: "deprecated: Use `privacy_mode` instead. Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the warning.",
@@ -11408,6 +11442,27 @@ var openapi = {
                   },
                   required: ["created_at", "message", "warning_code"],
                   type: "object"
+                },
+                {
+                  description: "Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.",
+                  properties: {
+                    created_at: {
+                      description: "Date and time at which Seam created the warning.",
+                      format: "date-time",
+                      type: "string"
+                    },
+                    message: {
+                      description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    },
+                    warning_code: {
+                      description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
+                      enum: ["privacy_mode"],
+                      type: "string"
+                    }
+                  },
+                  required: ["created_at", "message", "warning_code"],
+                  type: "object"
                 }
               ]
             },
@@ -22502,6 +22557,7 @@ var openapi = {
                   "x-variant-group-key": "access_codes"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.",
                   properties: {
                     created_at: {
@@ -22521,6 +22577,29 @@ var openapi = {
                   },
                   required: ["message", "created_at", "warning_code"],
                   type: "object",
+                  "x-deprecated": "Use `privacy_mode` instead.",
+                  "x-variant-group-key": "access_codes"
+                },
+                {
+                  description: "Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled.",
+                  properties: {
+                    created_at: {
+                      description: "Date and time at which Seam created the warning.",
+                      format: "date-time",
+                      type: "string"
+                    },
+                    message: {
+                      description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    },
+                    warning_code: {
+                      description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
+                      enum: ["privacy_mode"],
+                      type: "string"
+                    }
+                  },
+                  required: ["message", "created_at", "warning_code"],
+                  type: "object",
                   "x-variant-group-key": "access_codes"
                 },
                 {
@@ -30972,6 +31051,29 @@ var openapi = {
                 format: "date-time",
                 type: "string"
               },
+              reason: {
+                description: "Why access was denied, when the provider reports a determinable cause. Omitted when unknown.",
+                properties: {
+                  message: {
+                    description: "Human-readable explanation of why access was denied.",
+                    type: "string"
+                  },
+                  reason_code: {
+                    description: "Normalized reason a lock denied access. Provider-agnostic; not all providers report every value.",
+                    enum: [
+                      "unknown_code",
+                      "expired_code",
+                      "blocklisted_code",
+                      "too_many_attempts",
+                      "blocked_by_privacy_mode",
+                      "credential_error"
+                    ],
+                    type: "string"
+                  }
+                },
+                required: ["reason_code", "message"],
+                type: "object"
+              },
               user_identity_id: {
                 description: "\n      undocumented: Unreleased.\n      ---\n      ID of the user identity associated with the access-denied event.\n    ",
                 format: "uuid",
@@ -32954,7 +33056,7 @@ var openapi = {
                                     type: "object"
                                   },
                                   {
-                                    description: "Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.",
+                                    description: "deprecated: Use `privacy_mode` instead. Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.",
                                     properties: {
                                       created_at: {
                                         description: "Date and time at which Seam created the warning.",
@@ -32977,6 +33079,31 @@ var openapi = {
                                       "warning_code"
                                     ],
                                     type: "object"
+                                  },
+                                  {
+                                    description: "Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.",
+                                    properties: {
+                                      created_at: {
+                                        description: "Date and time at which Seam created the warning.",
+                                        format: "date-time",
+                                        type: "string"
+                                      },
+                                      message: {
+                                        description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
+                                        type: "string"
+                                      },
+                                      warning_code: {
+                                        description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
+                                        enum: ["privacy_mode"],
+                                        type: "string"
+                                      }
+                                    },
+                                    required: [
+                                      "created_at",
+                                      "message",
+                                      "warning_code"
+                                    ],
+                                    type: "object"
                                   }
                                 ]
                               },
@@ -37993,6 +38120,7 @@ var openapi = {
                   "x-variant-group-key": "access_codes"
                 },
                 {
+                  deprecated: true,
                   description: "Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.",
                   properties: {
                     created_at: {
@@ -38012,6 +38140,29 @@ var openapi = {
                   },
                   required: ["message", "created_at", "warning_code"],
                   type: "object",
+                  "x-deprecated": "Use `privacy_mode` instead.",
+                  "x-variant-group-key": "access_codes"
+                },
+                {
+                  description: "Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled.",
+                  properties: {
+                    created_at: {
+                      description: "Date and time at which Seam created the warning.",
+                      format: "date-time",
+                      type: "string"
+                    },
+                    message: {
+                      description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    },
+                    warning_code: {
+                      description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
+                      enum: ["privacy_mode"],
+                      type: "string"
+                    }
+                  },
+                  required: ["message", "created_at", "warning_code"],
+                  type: "object",
                   "x-variant-group-key": "access_codes"
                 },
                 {