@seamapi/types 1.967.0 → 1.969.0

package/lib/seam/connect/route-types.d.ts

@@ -23296,6 +23296,12 @@ export type Routes = {
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
+                } | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    warning_code: 'acs_user_inactive';
                 } | {
                     /** Date and time at which Seam created the warning. */
                     created_at: string;
@@ -23491,6 +23497,11 @@ export type Routes = {
                     /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                     audit_openings?: (boolean | undefined) | undefined;
                 } | undefined;
+                /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                salto_ks_metadata?: {
+                    /** 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. */
+                    is_subscribed?: (boolean | undefined) | undefined;
+                } | undefined;
                 /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -33890,6 +33901,12 @@ export type Routes = {
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
+                } | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    warning_code: 'acs_user_inactive';
                 } | {
                     /** Date and time at which Seam created the warning. */
                     created_at: string;
@@ -34085,6 +34102,11 @@ export type Routes = {
                     /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                     audit_openings?: (boolean | undefined) | undefined;
                 } | undefined;
+                /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                salto_ks_metadata?: {
+                    /** 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. */
+                    is_subscribed?: (boolean | undefined) | undefined;
+                } | undefined;
                 /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -34184,6 +34206,12 @@ export type Routes = {
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
+                } | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    warning_code: 'acs_user_inactive';
                 } | {
                     /** Date and time at which Seam created the warning. */
                     created_at: string;
@@ -34379,6 +34407,11 @@ export type Routes = {
                     /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                     audit_openings?: (boolean | undefined) | undefined;
                 } | undefined;
+                /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                salto_ks_metadata?: {
+                    /** 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. */
+                    is_subscribed?: (boolean | undefined) | undefined;
+                } | undefined;
                 /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -34466,6 +34499,12 @@ export type Routes = {
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
+                } | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    warning_code: 'acs_user_inactive';
                 } | {
                     /** Date and time at which Seam created the warning. */
                     created_at: string;
@@ -34661,6 +34700,11 @@ export type Routes = {
                     /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                     audit_openings?: (boolean | undefined) | undefined;
                 } | undefined;
+                /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                salto_ks_metadata?: {
+                    /** 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. */
+                    is_subscribed?: (boolean | undefined) | undefined;
+                } | undefined;
                 /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -35002,6 +35046,12 @@ export type Routes = {
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
+                } | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    warning_code: 'acs_user_inactive';
                 } | {
                     /** Date and time at which Seam created the warning. */
                     created_at: string;
@@ -35197,6 +35247,11 @@ export type Routes = {
                     /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                     audit_openings?: (boolean | undefined) | undefined;
                 } | undefined;
+                /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                salto_ks_metadata?: {
+                    /** 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. */
+                    is_subscribed?: (boolean | undefined) | undefined;
+                } | undefined;
                 /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -35279,6 +35334,12 @@ export type Routes = {
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
+                } | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    warning_code: 'acs_user_inactive';
                 } | {
                     /** Date and time at which Seam created the warning. */
                     created_at: string;
@@ -35474,6 +35535,11 @@ export type Routes = {
                     /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                     audit_openings?: (boolean | undefined) | undefined;
                 } | undefined;
+                /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                salto_ks_metadata?: {
+                    /** 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. */
+                    is_subscribed?: (boolean | undefined) | undefined;
+                } | undefined;
                 /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -110984,6 +111050,12 @@ export type Routes = {
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
+                } | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    warning_code: 'acs_user_inactive';
                 } | {
                     /** Date and time at which Seam created the warning. */
                     created_at: string;
@@ -111179,6 +111251,11 @@ export type Routes = {
                     /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                     audit_openings?: (boolean | undefined) | undefined;
                 } | undefined;
+                /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                salto_ks_metadata?: {
+                    /** 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. */
+                    is_subscribed?: (boolean | undefined) | undefined;
+                } | undefined;
                 /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -113657,6 +113734,12 @@ export type Routes = {
                         /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                         message: string;
                         warning_code: 'salto_ks_user_not_subscribed';
+                    } | {
+                        /** Date and time at which Seam created the warning. */
+                        created_at: string;
+                        /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        warning_code: 'acs_user_inactive';
                     } | {
                         /** Date and time at which Seam created the warning. */
                         created_at: string;
@@ -113852,6 +113935,11 @@ export type Routes = {
                         /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                         audit_openings?: (boolean | undefined) | undefined;
                     } | undefined;
+                    /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                    salto_ks_metadata?: {
+                        /** 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. */
+                        is_subscribed?: (boolean | undefined) | undefined;
+                    } | undefined;
                     /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                     full_name?: string | undefined;
                     /**
@@ -115814,6 +115902,12 @@ export type Routes = {
                         /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                         message: string;
                         warning_code: 'salto_ks_user_not_subscribed';
+                    } | {
+                        /** Date and time at which Seam created the warning. */
+                        created_at: string;
+                        /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                        message: string;
+                        warning_code: 'acs_user_inactive';
                     } | {
                         /** Date and time at which Seam created the warning. */
                         created_at: string;
@@ -116009,6 +116103,11 @@ export type Routes = {
                         /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                         audit_openings?: (boolean | undefined) | undefined;
                     } | undefined;
+                    /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                    salto_ks_metadata?: {
+                        /** 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. */
+                        is_subscribed?: (boolean | undefined) | undefined;
+                    } | undefined;
                     /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                     full_name?: string | undefined;
                     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.967.0",
+  "version": "1.969.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts

@@ -2,6 +2,7 @@ import { z } from 'zod'
 
 import { loose_phone_number } from '../../phone-number.js'
 import { schedule } from '../../schedule.js'
+import { acs_user_salto_ks_metadata } from '../metadata/salto.js'
 import { acs_user_salto_space_metadata } from '../metadata/salto-space.js'
 import { acs_user_pending_mutations } from './pending-mutations.js'
 
@@ -148,6 +149,14 @@ const acs_users_salto_ks_user_not_subscribed = common_acs_user_warning
     '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’t 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.',
   )
 
+export const acs_user_inactive = common_acs_user_warning
+  .extend({
+    warning_code: 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—for 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.',
+  )
+
 export const unknown_issue_with_acs_user = common_acs_user_warning
   .extend({
     warning_code: z.literal('unknown_issue_with_acs_user'),
@@ -169,6 +178,7 @@ const _acs_users_warning_map = z.object({
   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(),
@@ -179,6 +189,7 @@ export const acs_users_warnings = 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,
   ])
@@ -333,6 +344,11 @@ const common_acs_user = z
       .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)
 

package/src/lib/seam/connect/models/acs/metadata/salto.ts

@@ -41,3 +41,19 @@ export const acs_entrance_salto_ks_metadata = z
 export type AcsEntranceSaltoKSMetadata = z.infer<
   typeof acs_entrance_salto_ks_metadata
 >
+
+export const acs_user_salto_ks_metadata = z
+  .object({
+    is_subscribed: 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.',
+  )
+
+export type AcsUserSaltoKSMetadata = z.infer<typeof acs_user_salto_ks_metadata>

package/src/lib/seam/connect/openapi.ts

@@ -5569,6 +5569,18 @@ const openapi: OpenAPISpec = {
               '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).',
@@ -5659,6 +5671,29 @@ const openapi: OpenAPISpec = {
                   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—for 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.',
@@ -32326,6 +32361,18 @@ const openapi: OpenAPISpec = {
               '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).',
@@ -32416,6 +32463,29 @@ const openapi: OpenAPISpec = {
                   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—for 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.',