@seamapi/types 1.967.0 → 1.968.0

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

@@ -23491,6 +23491,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;
                 /**
@@ -34085,6 +34090,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;
                 /**
@@ -34379,6 +34389,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;
                 /**
@@ -34661,6 +34676,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;
                 /**
@@ -35197,6 +35217,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;
                 /**
@@ -35474,6 +35499,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;
                 /**
@@ -111179,6 +111209,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;
                 /**
@@ -113852,6 +113887,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;
                     /**
@@ -116009,6 +116049,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.968.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'
 
@@ -333,6 +334,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).',
@@ -32326,6 +32338,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).',

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

@@ -27886,6 +27886,13 @@ export type Routes = {
               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
         /**
@@ -40582,6 +40589,13 @@ export type Routes = {
               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
         /**
@@ -40916,6 +40930,13 @@ export type Routes = {
               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
         /**
@@ -41238,6 +41259,13 @@ export type Routes = {
               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
         /**
@@ -41865,6 +41893,13 @@ export type Routes = {
               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
         /**
@@ -42182,6 +42217,13 @@ export type Routes = {
               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
         /**
@@ -135353,6 +135395,13 @@ export type Routes = {
               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
         /**
@@ -138702,6 +138751,13 @@ export type Routes = {
                     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
               /**
@@ -141316,6 +141372,13 @@ export type Routes = {
                     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
               /**