@seamapi/types 1.967.0 → 1.969.0

package/dist/connect.cjs

@@ -3619,6 +3619,13 @@ var acs_entrance_salto_ks_metadata = zod.z.object({
   intrusion_alarm: zod.z.boolean().optional().describe("Indicates whether an intrusion alarm is active on the door."),
   privacy_mode: zod.z.boolean().optional().describe("Indicates whether privacy mode is enabled for the lock.")
 }).partial().describe("Salto KS-specific metadata associated with the entrance.");
+var acs_user_salto_ks_metadata = zod.z.object({
+  is_subscribed: zod.z.boolean().optional().describe(
+    "Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked."
+  )
+}).partial().describe(
+  "Salto KS-specific metadata associated with the access system user."
+);
 var acs_entrance_salto_space_metadata = zod.z.object({
   door_id: zod.z.string().optional().describe("Door ID in the Salto Space access system."),
   door_name: zod.z.string().optional().describe("Name of the door in the Salto Space access system."),
@@ -4638,6 +4645,11 @@ var acs_users_salto_ks_user_not_subscribed = common_acs_user_warning.extend({
 }).describe(
   "Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn\u2019t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed."
 );
+var acs_user_inactive = common_acs_user_warning.extend({
+  warning_code: zod.z.literal("acs_user_inactive")
+}).describe(
+  "Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) exists but is not currently able to gain access\u2014for example, because their access schedule has not started yet or has ended, the access system has reached its limit for active users, or they have been unsubscribed or deactivated. Refer to the warning message for the provider-specific reason. This is distinct from `is_suspended`, which indicates the user has been explicitly blocked."
+);
 var unknown_issue_with_acs_user = common_acs_user_warning.extend({
   warning_code: zod.z.literal("unknown_issue_with_acs_user")
 }).describe(
@@ -4651,12 +4663,14 @@ var latch_resident_user = common_acs_user_warning.extend({
 zod.z.object({
   being_deleted: acs_users_being_deleted.optional().nullable(),
   salto_ks_user_not_subscribed: acs_users_salto_ks_user_not_subscribed.optional().nullable(),
+  acs_user_inactive: acs_user_inactive.optional().nullable(),
   unknown_issue_with_acs_user: unknown_issue_with_acs_user.optional().nullable(),
   latch_resident_user: latch_resident_user.optional().nullable()
 });
 var acs_users_warnings = zod.z.discriminatedUnion("warning_code", [
   acs_users_being_deleted,
   acs_users_salto_ks_user_not_subscribed,
+  acs_user_inactive,
   unknown_issue_with_acs_user,
   latch_resident_user
 ]).describe(
@@ -4741,6 +4755,9 @@ var common_acs_user = zod.z.object({
     `),
   salto_space_metadata: acs_user_salto_space_metadata.optional().describe(
     "Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management)."
+  ),
+  salto_ks_metadata: acs_user_salto_ks_metadata.optional().describe(
+    "Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management)."
   )
 }).merge(user_fields);
 var acs_user = common_acs_user.merge(
@@ -12515,6 +12532,16 @@ var openapi = {
             description: "Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
             type: "string"
           },
+          salto_ks_metadata: {
+            description: "Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).",
+            properties: {
+              is_subscribed: {
+                description: "Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked.",
+                type: "boolean"
+              }
+            },
+            type: "object"
+          },
           salto_space_metadata: {
             description: "Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).",
             properties: {
@@ -12591,6 +12618,26 @@ var openapi = {
                   required: ["created_at", "message", "warning_code"],
                   type: "object"
                 },
+                {
+                  description: "Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) exists but is not currently able to gain access\u2014for example, because their access schedule has not started yet or has ended, the access system has reached its limit for active users, or they have been unsubscribed or deactivated. Refer to the warning message for the provider-specific reason. This is distinct from `is_suspended`, which indicates the user has been explicitly blocked.",
+                  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: {
+                      enum: ["acs_user_inactive"],
+                      type: "string"
+                    }
+                  },
+                  required: ["created_at", "message", "warning_code"],
+                  type: "object"
+                },
                 {
                   description: "An unknown issue occurred while syncing the state of this [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.",
                   properties: {
@@ -36535,6 +36582,16 @@ var openapi = {
             description: "Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
             type: "string"
           },
+          salto_ks_metadata: {
+            description: "Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).",
+            properties: {
+              is_subscribed: {
+                description: "Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked.",
+                type: "boolean"
+              }
+            },
+            type: "object"
+          },
           salto_space_metadata: {
             description: "Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).",
             properties: {
@@ -36611,6 +36668,26 @@ var openapi = {
                   required: ["created_at", "message", "warning_code"],
                   type: "object"
                 },
+                {
+                  description: "Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) exists but is not currently able to gain access\u2014for example, because their access schedule has not started yet or has ended, the access system has reached its limit for active users, or they have been unsubscribed or deactivated. Refer to the warning message for the provider-specific reason. This is distinct from `is_suspended`, which indicates the user has been explicitly blocked.",
+                  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: {
+                      enum: ["acs_user_inactive"],
+                      type: "string"
+                    }
+                  },
+                  required: ["created_at", "message", "warning_code"],
+                  type: "object"
+                },
                 {
                   description: "An unknown issue occurred while syncing the state of this [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.",
                   properties: {