@seamapi/types 1.872.0 → 1.873.0

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

@@ -13886,6 +13886,13 @@ export type Routes = {
                         message: string;
                         /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                         warning_code: 'entrance_setup_required';
+                    } | {
+                        /** 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;
+                        /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                        warning_code: 'salto_ks_privacy_mode';
                     })[];
                     /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     latch_metadata?: {
@@ -14004,6 +14011,8 @@ export type Routes = {
                         /** Total count of entry relays for an Avigilon Alta system. */
                         entry_relays_total_count: number;
                     } | undefined;
+                    /** Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked. */
+                    is_locked?: boolean | undefined;
                     /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
                     can_unlock_with_mobile_key?: boolean | undefined;
                     /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -18572,6 +18581,13 @@ export type Routes = {
                         message: string;
                         /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                         warning_code: 'entrance_setup_required';
+                    } | {
+                        /** 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;
+                        /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                        warning_code: 'salto_ks_privacy_mode';
                     })[];
                     /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     latch_metadata?: {
@@ -18690,6 +18706,8 @@ export type Routes = {
                         /** Total count of entry relays for an Avigilon Alta system. */
                         entry_relays_total_count: number;
                     } | undefined;
+                    /** Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked. */
+                    is_locked?: boolean | undefined;
                     /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
                     can_unlock_with_mobile_key?: boolean | undefined;
                     /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -20006,6 +20024,13 @@ export type Routes = {
                     message: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'entrance_setup_required';
+                } | {
+                    /** 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;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'salto_ks_privacy_mode';
                 })[];
                 /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 latch_metadata?: {
@@ -20124,6 +20149,8 @@ export type Routes = {
                     /** Total count of entry relays for an Avigilon Alta system. */
                     entry_relays_total_count: number;
                 } | undefined;
+                /** Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked. */
+                is_locked?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
                 can_unlock_with_mobile_key?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -21741,6 +21768,13 @@ export type Routes = {
                     message: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'entrance_setup_required';
+                } | {
+                    /** 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;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'salto_ks_privacy_mode';
                 })[];
                 /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 latch_metadata?: {
@@ -21859,6 +21893,8 @@ export type Routes = {
                     /** Total count of entry relays for an Avigilon Alta system. */
                     entry_relays_total_count: number;
                 } | undefined;
+                /** Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked. */
+                is_locked?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
                 can_unlock_with_mobile_key?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -27293,6 +27329,13 @@ export type Routes = {
                     message: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'entrance_setup_required';
+                } | {
+                    /** 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;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'salto_ks_privacy_mode';
                 })[];
                 /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 latch_metadata?: {
@@ -27411,6 +27454,8 @@ export type Routes = {
                     /** Total count of entry relays for an Avigilon Alta system. */
                     entry_relays_total_count: number;
                 } | undefined;
+                /** Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked. */
+                is_locked?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
                 can_unlock_with_mobile_key?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -27514,6 +27559,13 @@ export type Routes = {
                     message: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'entrance_setup_required';
+                } | {
+                    /** 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;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'salto_ks_privacy_mode';
                 })[];
                 /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 latch_metadata?: {
@@ -27632,6 +27684,8 @@ export type Routes = {
                     /** Total count of entry relays for an Avigilon Alta system. */
                     entry_relays_total_count: number;
                 } | undefined;
+                /** Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked. */
+                is_locked?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
                 can_unlock_with_mobile_key?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -30724,6 +30778,13 @@ export type Routes = {
                     message: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'entrance_setup_required';
+                } | {
+                    /** 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;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'salto_ks_privacy_mode';
                 })[];
                 /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 latch_metadata?: {
@@ -30842,6 +30903,8 @@ export type Routes = {
                     /** Total count of entry relays for an Avigilon Alta system. */
                     entry_relays_total_count: number;
                 } | undefined;
+                /** Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked. */
+                is_locked?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
                 can_unlock_with_mobile_key?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -74472,6 +74535,13 @@ export type Routes = {
                                 message: string;
                                 /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                                 warning_code: 'entrance_setup_required';
+                            } | {
+                                /** 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;
+                                /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                                warning_code: 'salto_ks_privacy_mode';
                             })[];
                             /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                             latch_metadata?: {
@@ -74590,6 +74660,8 @@ export type Routes = {
                                 /** Total count of entry relays for an Avigilon Alta system. */
                                 entry_relays_total_count: number;
                             } | undefined;
+                            /** Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked. */
+                            is_locked?: boolean | undefined;
                             /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
                             can_unlock_with_mobile_key?: boolean | undefined;
                             /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -76326,6 +76398,13 @@ export type Routes = {
                         message: string;
                         /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                         warning_code: 'entrance_setup_required';
+                    } | {
+                        /** 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;
+                        /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                        warning_code: 'salto_ks_privacy_mode';
                     })[];
                     /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     latch_metadata?: {
@@ -76444,6 +76523,8 @@ export type Routes = {
                         /** Total count of entry relays for an Avigilon Alta system. */
                         entry_relays_total_count: number;
                     } | undefined;
+                    /** Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked. */
+                    is_locked?: boolean | undefined;
                     /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
                     can_unlock_with_mobile_key?: boolean | undefined;
                     /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -98611,6 +98692,13 @@ export type Routes = {
                     message: string;
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'entrance_setup_required';
+                } | {
+                    /** 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;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'salto_ks_privacy_mode';
                 })[];
                 /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 latch_metadata?: {
@@ -98729,6 +98817,8 @@ export type Routes = {
                     /** Total count of entry relays for an Avigilon Alta system. */
                     entry_relays_total_count: number;
                 } | undefined;
+                /** Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked. */
+                is_locked?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
                 can_unlock_with_mobile_key?: boolean | undefined;
                 /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -101132,6 +101222,13 @@ export type Routes = {
                         message: string;
                         /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                         warning_code: 'entrance_setup_required';
+                    } | {
+                        /** 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;
+                        /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                        warning_code: 'salto_ks_privacy_mode';
                     })[];
                     /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     latch_metadata?: {
@@ -101250,6 +101347,8 @@ export type Routes = {
                         /** Total count of entry relays for an Avigilon Alta system. */
                         entry_relays_total_count: number;
                     } | undefined;
+                    /** Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked. */
+                    is_locked?: boolean | undefined;
                     /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
                     can_unlock_with_mobile_key?: boolean | undefined;
                     /** Indicates whether the ACS entrance can be unlocked with card credentials. */

package/package.json

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

package/src/lib/seam/connect/models/acs/acs-entrance.ts

@@ -59,11 +59,22 @@ const entrance_setup_required = common_acs_entrance_warning
     'Indicates that this entrance requires additional configuration in the access control system before Seam can fully manage it.',
   )
 
+const salto_ks_privacy_mode = common_acs_entrance_warning
+  .extend({
+    warning_code: z
+      .literal('salto_ks_privacy_mode')
+      .describe(warning_code_description),
+  })
+  .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.',
+  )
+
 const acs_entrance_warning = z
   .discriminatedUnion('warning_code', [
     salto_ks_entrance_access_code_support_removed,
     entrance_shares_zone,
     entrance_setup_required,
+    salto_ks_privacy_mode,
   ])
   .describe(
     'Warning associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -74,6 +85,7 @@ const _acs_entrance_warning_map = z.object({
     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_mode.optional().nullable(),
 })
 
 export type AcsEntranceWarningMap = z.infer<typeof _acs_entrance_warning_map>
@@ -218,6 +230,12 @@ export const acs_entrance = z
       .describe(
         'Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
       ),
+    is_locked: z
+      .boolean()
+      .optional()
+      .describe(
+        'Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked.',
+      ),
   })
   .merge(acs_entrance_capability_flags).describe(`
   ---

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

@@ -4650,6 +4650,11 @@ const openapi: OpenAPISpec = {
             },
             type: 'object',
           },
+          is_locked: {
+            description:
+              'Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked.',
+            type: 'boolean',
+          },
           latch_metadata: {
             description:
               'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -4902,6 +4907,31 @@ const openapi: OpenAPISpec = {
                   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: ['salto_ks_privacy_mode'],
+                      type: 'string',
+                    },
+                  },
+                  required: ['created_at', 'message', 'warning_code'],
+                  type: 'object',
+                },
               ],
             },
             type: 'array',
@@ -26178,6 +26208,11 @@ const openapi: OpenAPISpec = {
                               },
                               type: 'object',
                             },
+                            is_locked: {
+                              description:
+                                'Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked.',
+                              type: 'boolean',
+                            },
                             latch_metadata: {
                               description:
                                 'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -26454,6 +26489,35 @@ const openapi: OpenAPISpec = {
                                     ],
                                     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: ['salto_ks_privacy_mode'],
+                                        type: 'string',
+                                      },
+                                    },
+                                    required: [
+                                      'created_at',
+                                      'message',
+                                      'warning_code',
+                                    ],
+                                    type: 'object',
+                                  },
                                 ],
                               },
                               type: 'array',