@seamapi/types 1.731.0 → 1.733.0

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

@@ -11894,6 +11894,15 @@ export type Routes = {
                         /** Name of the access point in the dormakaba Ambiance access system. */
                         access_point_name: string;
                     } | undefined;
+                    /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                    brivo_metadata?: {
+                        /** ID of the access point in the Brivo access system. */
+                        access_point_id: string;
+                        /** ID of the site that the access point belongs to. */
+                        site_id: number;
+                        /** Name of the site that the access point belongs to. */
+                        site_name: string;
+                    } | 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. */
@@ -15959,6 +15968,15 @@ export type Routes = {
                         /** Name of the access point in the dormakaba Ambiance access system. */
                         access_point_name: string;
                     } | undefined;
+                    /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                    brivo_metadata?: {
+                        /** ID of the access point in the Brivo access system. */
+                        access_point_id: string;
+                        /** ID of the site that the access point belongs to. */
+                        site_id: number;
+                        /** Name of the site that the access point belongs to. */
+                        site_name: string;
+                    } | 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. */
@@ -17042,6 +17060,15 @@ export type Routes = {
                     /** Name of the access point in the dormakaba Ambiance access system. */
                     access_point_name: string;
                 } | undefined;
+                /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                brivo_metadata?: {
+                    /** ID of the access point in the Brivo access system. */
+                    access_point_id: string;
+                    /** ID of the site that the access point belongs to. */
+                    site_id: number;
+                    /** Name of the site that the access point belongs to. */
+                    site_name: string;
+                } | 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. */
@@ -18468,6 +18495,15 @@ export type Routes = {
                     /** Name of the access point in the dormakaba Ambiance access system. */
                     access_point_name: string;
                 } | undefined;
+                /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                brivo_metadata?: {
+                    /** ID of the access point in the Brivo access system. */
+                    access_point_id: string;
+                    /** ID of the site that the access point belongs to. */
+                    site_id: number;
+                    /** Name of the site that the access point belongs to. */
+                    site_name: string;
+                } | 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. */
@@ -21963,6 +21999,15 @@ export type Routes = {
                     /** Name of the access point in the dormakaba Ambiance access system. */
                     access_point_name: string;
                 } | undefined;
+                /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                brivo_metadata?: {
+                    /** ID of the access point in the Brivo access system. */
+                    access_point_id: string;
+                    /** ID of the site that the access point belongs to. */
+                    site_id: number;
+                    /** Name of the site that the access point belongs to. */
+                    site_name: string;
+                } | 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. */
@@ -22133,6 +22178,15 @@ export type Routes = {
                     /** Name of the access point in the dormakaba Ambiance access system. */
                     access_point_name: string;
                 } | undefined;
+                /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                brivo_metadata?: {
+                    /** ID of the access point in the Brivo access system. */
+                    access_point_id: string;
+                    /** ID of the site that the access point belongs to. */
+                    site_id: number;
+                    /** Name of the site that the access point belongs to. */
+                    site_name: string;
+                } | 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. */
@@ -23671,6 +23725,15 @@ export type Routes = {
                     /** Name of the access point in the dormakaba Ambiance access system. */
                     access_point_name: string;
                 } | undefined;
+                /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                brivo_metadata?: {
+                    /** ID of the access point in the Brivo access system. */
+                    access_point_id: string;
+                    /** ID of the site that the access point belongs to. */
+                    site_id: number;
+                    /** Name of the site that the access point belongs to. */
+                    site_name: string;
+                } | 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. */
@@ -28093,6 +28156,8 @@ export type Routes = {
                 resource_type: 'reservation' | 'space';
                 resource_key: string;
             } | undefined;
+            /** Whether the portal is in developer mode. Only available for Seam employees. */
+            _dev?: boolean;
         } & {
             customer_data?: {
                 /** Your unique identifier for the customer. */
@@ -61852,6 +61917,15 @@ export type Routes = {
                                 /** Name of the access point in the dormakaba Ambiance access system. */
                                 access_point_name: string;
                             } | undefined;
+                            /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                            brivo_metadata?: {
+                                /** ID of the access point in the Brivo access system. */
+                                access_point_id: string;
+                                /** ID of the site that the access point belongs to. */
+                                site_id: number;
+                                /** Name of the site that the access point belongs to. */
+                                site_name: string;
+                            } | 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. */
@@ -63545,6 +63619,15 @@ export type Routes = {
                         /** Name of the access point in the dormakaba Ambiance access system. */
                         access_point_name: string;
                     } | undefined;
+                    /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                    brivo_metadata?: {
+                        /** ID of the access point in the Brivo access system. */
+                        access_point_id: string;
+                        /** ID of the site that the access point belongs to. */
+                        site_id: number;
+                        /** Name of the site that the access point belongs to. */
+                        site_name: string;
+                    } | 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. */
@@ -85539,6 +85622,15 @@ export type Routes = {
                         /** Name of the access point in the dormakaba Ambiance access system. */
                         access_point_name: string;
                     } | undefined;
+                    /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                    brivo_metadata?: {
+                        /** ID of the access point in the Brivo access system. */
+                        access_point_id: string;
+                        /** ID of the site that the access point belongs to. */
+                        site_id: number;
+                        /** Name of the site that the access point belongs to. */
+                        site_name: string;
+                    } | 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.731.0",
+  "version": "1.733.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

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

@@ -3,6 +3,7 @@ import { z } from 'zod'
 import { acs_entrance_dormakaba_ambiance_metadata } from './metadata/dormakaba-ambiance.js'
 import {
   acs_entrance_assa_abloy_vostio_metadata,
+  acs_entrance_brivo_metadata,
   acs_entrance_dormakaba_community_metadata,
   acs_entrance_hotek_metadata,
   acs_entrance_latch_metadata,
@@ -130,6 +131,11 @@ export const acs_entrance = z
       .describe(
         'dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
       ),
+    brivo_metadata: acs_entrance_brivo_metadata
+      .optional()
+      .describe(
+        'Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      ),
   })
   .merge(acs_entrance_capability_flags).describe(`
   ---

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

@@ -0,0 +1,19 @@
+import { z } from 'zod'
+
+export const acs_entrance_brivo_metadata = z
+  .object({
+    access_point_id: z
+      .string()
+      .describe('ID of the access point in the Brivo access system.'),
+    site_id: z
+      .number()
+      .describe('ID of the site that the access point belongs to.'),
+    site_name: z
+      .string()
+      .describe('Name of the site that the access point belongs to.'),
+  })
+  .describe('Brivo-specific metadata associated with the entrance.')
+
+export type AcsEntranceBrivoMetadata = z.infer<
+  typeof acs_entrance_brivo_metadata
+>

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

@@ -1,4 +1,5 @@
 export * from './assa-abloy-vostio.js'
+export * from './brivo.js'
 export * from './dormakaba-ambiance.js'
 export * from './dormakaba-community.js'
 export * from './hotek.js'

package/src/lib/seam/connect/models/customer/customer-portal.ts

@@ -173,6 +173,14 @@ export const portal_configuration_base = z.object({
 })
 
 export const portal_configuration = portal_configuration_base
+  .extend({
+    _dev: z.boolean().default(false).describe(`
+        ---
+        undocumented: Internal developer mode flag.
+        ---
+        Whether the portal is in developer mode. Only available for Seam employees.
+      `),
+  })
   .default({
     features: {
       connect: { exclude: false },

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

@@ -3452,6 +3452,29 @@ export default {
             required: ['door_type', 'door_name'],
             type: 'object',
           },
+          brivo_metadata: {
+            description:
+              'Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+            properties: {
+              access_point_id: {
+                description:
+                  'ID of the access point in the Brivo access system.',
+                type: 'string',
+              },
+              site_id: {
+                description: 'ID of the site that the access point belongs to.',
+                format: 'float',
+                type: 'number',
+              },
+              site_name: {
+                description:
+                  'Name of the site that the access point belongs to.',
+                type: 'string',
+              },
+            },
+            required: ['access_point_id', 'site_id', 'site_name'],
+            type: 'object',
+          },
           can_belong_to_reservation: {
             description:
               'Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.',
@@ -23387,6 +23410,34 @@ export default {
                               required: ['door_type', 'door_name'],
                               type: 'object',
                             },
+                            brivo_metadata: {
+                              description:
+                                'Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+                              properties: {
+                                access_point_id: {
+                                  description:
+                                    'ID of the access point in the Brivo access system.',
+                                  type: 'string',
+                                },
+                                site_id: {
+                                  description:
+                                    'ID of the site that the access point belongs to.',
+                                  format: 'float',
+                                  type: 'number',
+                                },
+                                site_name: {
+                                  description:
+                                    'Name of the site that the access point belongs to.',
+                                  type: 'string',
+                                },
+                              },
+                              required: [
+                                'access_point_id',
+                                'site_id',
+                                'site_name',
+                              ],
+                              type: 'object',
+                            },
                             can_belong_to_reservation: {
                               description:
                                 'Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.',
@@ -47937,6 +47988,13 @@ export default {
                     },
                     description: 'Configuration for a customer portal',
                     properties: {
+                      _dev: {
+                        default: false,
+                        description:
+                          'Whether the portal is in developer mode. Only available for Seam employees.',
+                        type: 'boolean',
+                        'x-undocumented': 'Internal developer mode flag.',
+                      },
                       customer_resources_filters: {
                         description:
                           'Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata.',

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

@@ -13615,6 +13615,17 @@ export type Routes = {
                     access_point_name: string
                   }
                 | undefined
+              /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              brivo_metadata?:
+                | {
+                    /** ID of the access point in the Brivo access system. */
+                    access_point_id: string
+                    /** ID of the site that the access point belongs to. */
+                    site_id: number
+                    /** Name of the site that the access point belongs to. */
+                    site_name: string
+                  }
+                | 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. */
@@ -18426,6 +18437,17 @@ export type Routes = {
                     access_point_name: string
                   }
                 | undefined
+              /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              brivo_metadata?:
+                | {
+                    /** ID of the access point in the Brivo access system. */
+                    access_point_id: string
+                    /** ID of the site that the access point belongs to. */
+                    site_id: number
+                    /** Name of the site that the access point belongs to. */
+                    site_name: string
+                  }
+                | 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. */
@@ -19653,6 +19675,17 @@ export type Routes = {
               access_point_name: string
             }
           | undefined
+        /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        brivo_metadata?:
+          | {
+              /** ID of the access point in the Brivo access system. */
+              access_point_id: string
+              /** ID of the site that the access point belongs to. */
+              site_id: number
+              /** Name of the site that the access point belongs to. */
+              site_name: string
+            }
+          | 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. */
@@ -21336,6 +21369,17 @@ export type Routes = {
               access_point_name: string
             }
           | undefined
+        /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        brivo_metadata?:
+          | {
+              /** ID of the access point in the Brivo access system. */
+              access_point_id: string
+              /** ID of the site that the access point belongs to. */
+              site_id: number
+              /** Name of the site that the access point belongs to. */
+              site_name: string
+            }
+          | 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. */
@@ -25370,6 +25414,17 @@ export type Routes = {
               access_point_name: string
             }
           | undefined
+        /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        brivo_metadata?:
+          | {
+              /** ID of the access point in the Brivo access system. */
+              access_point_id: string
+              /** ID of the site that the access point belongs to. */
+              site_id: number
+              /** Name of the site that the access point belongs to. */
+              site_name: string
+            }
+          | 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. */
@@ -25567,6 +25622,17 @@ export type Routes = {
               access_point_name: string
             }
           | undefined
+        /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        brivo_metadata?:
+          | {
+              /** ID of the access point in the Brivo access system. */
+              access_point_id: string
+              /** ID of the site that the access point belongs to. */
+              site_id: number
+              /** Name of the site that the access point belongs to. */
+              site_name: string
+            }
+          | 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. */
@@ -27421,6 +27487,17 @@ export type Routes = {
               access_point_name: string
             }
           | undefined
+        /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        brivo_metadata?:
+          | {
+              /** ID of the access point in the Brivo access system. */
+              access_point_id: string
+              /** ID of the site that the access point belongs to. */
+              site_id: number
+              /** Name of the site that the access point belongs to. */
+              site_name: string
+            }
+          | 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. */
@@ -32472,6 +32549,8 @@ export type Routes = {
             resource_key: string
           }
         | undefined
+      /** Whether the portal is in developer mode. Only available for Seam employees. */
+      _dev?: boolean
     } & {
       customer_data?:
         | {
@@ -73375,6 +73454,17 @@ export type Routes = {
                     access_point_name: string
                   }
                 | undefined
+              /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              brivo_metadata?:
+                | {
+                    /** ID of the access point in the Brivo access system. */
+                    access_point_id: string
+                    /** ID of the site that the access point belongs to. */
+                    site_id: number
+                    /** Name of the site that the access point belongs to. */
+                    site_name: string
+                  }
+                | 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. */
@@ -75469,6 +75559,17 @@ export type Routes = {
                     access_point_name: string
                   }
                 | undefined
+              /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              brivo_metadata?:
+                | {
+                    /** ID of the access point in the Brivo access system. */
+                    access_point_id: string
+                    /** ID of the site that the access point belongs to. */
+                    site_id: number
+                    /** Name of the site that the access point belongs to. */
+                    site_name: string
+                  }
+                | 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. */
@@ -101463,6 +101564,17 @@ export type Routes = {
                     access_point_name: string
                   }
                 | undefined
+              /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              brivo_metadata?:
+                | {
+                    /** ID of the access point in the Brivo access system. */
+                    access_point_id: string
+                    /** ID of the site that the access point belongs to. */
+                    site_id: number
+                    /** Name of the site that the access point belongs to. */
+                    site_name: string
+                  }
+                | 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. */