@seamapi/types 1.470.0 → 1.472.0

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

@@ -11433,6 +11433,11 @@ export type Routes = {
                         /** Description of the room in the Salto Space access system. */
                         room_description?: string | undefined;
                     } | undefined;
+                    /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                    dormakaba_ambiance_metadata?: {
+                        /** Name of the access point in the dormakaba Ambiance access system. */
+                        access_point_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. */
@@ -14539,6 +14544,11 @@ export type Routes = {
                         /** Description of the room in the Salto Space access system. */
                         room_description?: string | undefined;
                     } | undefined;
+                    /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                    dormakaba_ambiance_metadata?: {
+                        /** Name of the access point in the dormakaba Ambiance access system. */
+                        access_point_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. */
@@ -17143,6 +17153,11 @@ export type Routes = {
                     /** Description of the room in the Salto Space access system. */
                     room_description?: string | undefined;
                 } | undefined;
+                /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                dormakaba_ambiance_metadata?: {
+                    /** Name of the access point in the dormakaba Ambiance access system. */
+                    access_point_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. */
@@ -18475,6 +18490,11 @@ export type Routes = {
                     /** Description of the room in the Salto Space access system. */
                     room_description?: string | undefined;
                 } | undefined;
+                /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                dormakaba_ambiance_metadata?: {
+                    /** Name of the access point in the dormakaba Ambiance access system. */
+                    access_point_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. */
@@ -21897,6 +21917,11 @@ export type Routes = {
                     /** Description of the room in the Salto Space access system. */
                     room_description?: string | undefined;
                 } | undefined;
+                /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                dormakaba_ambiance_metadata?: {
+                    /** Name of the access point in the dormakaba Ambiance access system. */
+                    access_point_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. */
@@ -22046,6 +22071,11 @@ export type Routes = {
                     /** Description of the room in the Salto Space access system. */
                     room_description?: string | undefined;
                 } | undefined;
+                /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                dormakaba_ambiance_metadata?: {
+                    /** Name of the access point in the dormakaba Ambiance access system. */
+                    access_point_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. */
@@ -23460,6 +23490,11 @@ export type Routes = {
                     /** Description of the room in the Salto Space access system. */
                     room_description?: string | undefined;
                 } | undefined;
+                /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                dormakaba_ambiance_metadata?: {
+                    /** Name of the access point in the dormakaba Ambiance access system. */
+                    access_point_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. */
@@ -54723,6 +54758,11 @@ export type Routes = {
                                 /** Description of the room in the Salto Space access system. */
                                 room_description?: string | undefined;
                             } | undefined;
+                            /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                            dormakaba_ambiance_metadata?: {
+                                /** Name of the access point in the dormakaba Ambiance access system. */
+                                access_point_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. */
@@ -56259,6 +56299,11 @@ export type Routes = {
                         /** Description of the room in the Salto Space access system. */
                         room_description?: string | undefined;
                     } | undefined;
+                    /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                    dormakaba_ambiance_metadata?: {
+                        /** Name of the access point in the dormakaba Ambiance access system. */
+                        access_point_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. */
@@ -77256,6 +77301,11 @@ export type Routes = {
                         /** Description of the room in the Salto Space access system. */
                         room_description?: string | undefined;
                     } | undefined;
+                    /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                    dormakaba_ambiance_metadata?: {
+                        /** Name of the access point in the dormakaba Ambiance access system. */
+                        access_point_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.470.0",
+  "version": "1.472.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

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

@@ -1,5 +1,6 @@
 import { z } from 'zod'
 
+import { acs_entrance_dormakaba_ambiance_metadata } from './metadata/dormakaba-ambiance.js'
 import {
   acs_entrance_assa_abloy_vostio_metadata,
   acs_entrance_dormakaba_community_metadata,
@@ -109,6 +110,11 @@ export const acs_entrance = z
       .describe(
         'Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
       ),
+    dormakaba_ambiance_metadata: acs_entrance_dormakaba_ambiance_metadata
+      .optional()
+      .describe(
+        'dormakaba Ambiance-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/dormakaba-ambiance.ts

@@ -0,0 +1,17 @@
+import { z } from 'zod'
+
+export const acs_entrance_dormakaba_ambiance_metadata = z
+  .object({
+    access_point_name: z
+      .string()
+      .describe(
+        'Name of the access point in the dormakaba Ambiance access system.',
+      ),
+  })
+  .describe(
+    'dormakaba Ambiance-specific metadata associated with the entrance.',
+  )
+
+export type AcsEntranceDormakabaAmbianceMetadata = z.infer<
+  typeof acs_entrance_dormakaba_ambiance_metadata
+>

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

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

package/src/lib/seam/connect/models/instant-keys/instant-key.ts

@@ -34,8 +34,7 @@ export const instant_key = z.object({
     .describe('Date and time at which the Instant Key expires.'),
 }).describe(`
   ---
-  route_path: /user_identities
-  undocumented: Unreleased.
+  route_path: /instant_keys
   ---
   Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.
 

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

@@ -2774,6 +2774,19 @@ export default {
               'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
             type: 'string',
           },
+          dormakaba_ambiance_metadata: {
+            description:
+              'dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+            properties: {
+              access_point_name: {
+                description:
+                  'Name of the access point in the dormakaba Ambiance access system.',
+                type: 'string',
+              },
+            },
+            required: ['access_point_name'],
+            type: 'object',
+          },
           dormakaba_community_metadata: {
             description:
               'dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -19065,8 +19078,7 @@ export default {
           'expires_at',
         ],
         type: 'object',
-        'x-route-path': '/user_identities',
-        'x-undocumented': 'Unreleased.',
+        'x-route-path': '/instant_keys',
       },
       location: {
         properties: {
@@ -19517,6 +19529,19 @@ export default {
                                 'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
                               type: 'string',
                             },
+                            dormakaba_ambiance_metadata: {
+                              description:
+                                'dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+                              properties: {
+                                access_point_name: {
+                                  description:
+                                    'Name of the access point in the dormakaba Ambiance access system.',
+                                  type: 'string',
+                                },
+                              },
+                              required: ['access_point_name'],
+                              type: 'object',
+                            },
                             dormakaba_community_metadata: {
                               description:
                                 'dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',

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

@@ -13026,6 +13026,13 @@ export type Routes = {
                     room_description?: string | undefined
                   }
                 | undefined
+              /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              dormakaba_ambiance_metadata?:
+                | {
+                    /** Name of the access point in the dormakaba Ambiance access system. */
+                    access_point_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. */
@@ -16744,6 +16751,13 @@ export type Routes = {
                     room_description?: string | undefined
                   }
                 | undefined
+              /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              dormakaba_ambiance_metadata?:
+                | {
+                    /** Name of the access point in the dormakaba Ambiance access system. */
+                    access_point_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. */
@@ -19857,6 +19871,13 @@ export type Routes = {
               room_description?: string | undefined
             }
           | undefined
+        /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        dormakaba_ambiance_metadata?:
+          | {
+              /** Name of the access point in the dormakaba Ambiance access system. */
+              access_point_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. */
@@ -21413,6 +21434,13 @@ export type Routes = {
               room_description?: string | undefined
             }
           | undefined
+        /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        dormakaba_ambiance_metadata?:
+          | {
+              /** Name of the access point in the dormakaba Ambiance access system. */
+              access_point_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. */
@@ -25340,6 +25368,13 @@ export type Routes = {
               room_description?: string | undefined
             }
           | undefined
+        /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        dormakaba_ambiance_metadata?:
+          | {
+              /** Name of the access point in the dormakaba Ambiance access system. */
+              access_point_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. */
@@ -25512,6 +25547,13 @@ export type Routes = {
               room_description?: string | undefined
             }
           | undefined
+        /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        dormakaba_ambiance_metadata?:
+          | {
+              /** Name of the access point in the dormakaba Ambiance access system. */
+              access_point_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. */
@@ -27217,6 +27259,13 @@ export type Routes = {
               room_description?: string | undefined
             }
           | undefined
+        /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        dormakaba_ambiance_metadata?:
+          | {
+              /** Name of the access point in the dormakaba Ambiance access system. */
+              access_point_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. */
@@ -65054,6 +65103,13 @@ export type Routes = {
                     room_description?: string | undefined
                   }
                 | undefined
+              /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              dormakaba_ambiance_metadata?:
+                | {
+                    /** Name of the access point in the dormakaba Ambiance access system. */
+                    access_point_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. */
@@ -66960,6 +67016,13 @@ export type Routes = {
                     room_description?: string | undefined
                   }
                 | undefined
+              /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              dormakaba_ambiance_metadata?:
+                | {
+                    /** Name of the access point in the dormakaba Ambiance access system. */
+                    access_point_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. */
@@ -91733,6 +91796,13 @@ export type Routes = {
                     room_description?: string | undefined
                   }
                 | undefined
+              /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              dormakaba_ambiance_metadata?:
+                | {
+                    /** Name of the access point in the dormakaba Ambiance access system. */
+                    access_point_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. */