@seamapi/types 1.603.0 → 1.605.0

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

@@ -9912,6 +9912,8 @@ export type Routes = {
             name?: (string | undefined) | null;
             /** Unique key for the access grant within the workspace. */
             access_grant_key?: string | undefined;
+            /** Reservation key for the access grant. */
+            reservation_key?: string | undefined;
             /**
              * @deprecated Use `space_ids`.*/
             location_ids?: string[] | undefined;
@@ -9957,6 +9959,8 @@ export type Routes = {
                 access_grant_id: string;
                 /** Unique key for the access grant within the workspace. */
                 access_grant_key?: string | undefined;
+                /** Reservation key for the access grant. */
+                reservation_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -10041,6 +10045,8 @@ export type Routes = {
                 access_grant_id: string;
                 /** Unique key for the access grant within the workspace. */
                 access_grant_key?: string | undefined;
+                /** Reservation key for the access grant. */
+                reservation_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -11375,11 +11381,11 @@ export type Routes = {
                     /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     hotek_metadata?: {
                         /** Room number of the entrance. */
-                        room_number: string;
+                        room_number?: string | undefined;
                         /** Display name of the entrance. */
-                        display_name: string;
-                        /** Type of door. */
-                        door_type: 'common_area' | 'guest';
+                        common_area_number?: string | undefined;
+                        /** Display name of the entrance. */
+                        common_area_name?: string | undefined;
                     } | undefined;
                     /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     visionline_metadata?: {
@@ -11820,6 +11826,8 @@ export type Routes = {
                 access_grant_id: string;
                 /** Unique key for the access grant within the workspace. */
                 access_grant_key?: string | undefined;
+                /** Reservation key for the access grant. */
+                reservation_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -11896,6 +11904,8 @@ export type Routes = {
                 access_grant_id: string;
                 /** Unique key for the access grant within the workspace. */
                 access_grant_key?: string | undefined;
+                /** Reservation key for the access grant. */
+                reservation_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -11963,6 +11973,8 @@ export type Routes = {
                 workspace_id: string;
                 /** ID of the Access Grant. */
                 access_grant_id: string;
+                /** Reservation key for the access grant. */
+                reservation_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -12027,6 +12039,8 @@ export type Routes = {
                 workspace_id: string;
                 /** ID of the Access Grant. */
                 access_grant_id: string;
+                /** Reservation key for the access grant. */
+                reservation_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -14799,11 +14813,11 @@ export type Routes = {
                     /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     hotek_metadata?: {
                         /** Room number of the entrance. */
-                        room_number: string;
+                        room_number?: string | undefined;
                         /** Display name of the entrance. */
-                        display_name: string;
-                        /** Type of door. */
-                        door_type: 'common_area' | 'guest';
+                        common_area_number?: string | undefined;
+                        /** Display name of the entrance. */
+                        common_area_name?: string | undefined;
                     } | undefined;
                     /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     visionline_metadata?: {
@@ -17522,6 +17536,8 @@ export type Routes = {
                     access_grant_id: string;
                     /** Unique key for the access grant within the workspace. */
                     access_grant_key?: string | undefined;
+                    /** Reservation key for the access grant. */
+                    reservation_key?: string | undefined;
                     /** ID of user identity to which the Access Grant gives access. */
                     user_identity_id: string;
                     /**
@@ -20854,11 +20870,11 @@ export type Routes = {
                 /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 hotek_metadata?: {
                     /** Room number of the entrance. */
-                    room_number: string;
+                    room_number?: string | undefined;
                     /** Display name of the entrance. */
-                    display_name: string;
-                    /** Type of door. */
-                    door_type: 'common_area' | 'guest';
+                    common_area_number?: string | undefined;
+                    /** Display name of the entrance. */
+                    common_area_name?: string | undefined;
                 } | undefined;
                 /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 visionline_metadata?: {
@@ -22220,11 +22236,11 @@ export type Routes = {
                 /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 hotek_metadata?: {
                     /** Room number of the entrance. */
-                    room_number: string;
+                    room_number?: string | undefined;
                     /** Display name of the entrance. */
-                    display_name: string;
-                    /** Type of door. */
-                    door_type: 'common_area' | 'guest';
+                    common_area_number?: string | undefined;
+                    /** Display name of the entrance. */
+                    common_area_name?: string | undefined;
                 } | undefined;
                 /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 visionline_metadata?: {
@@ -25686,11 +25702,11 @@ export type Routes = {
                 /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 hotek_metadata?: {
                     /** Room number of the entrance. */
-                    room_number: string;
+                    room_number?: string | undefined;
                     /** Display name of the entrance. */
-                    display_name: string;
-                    /** Type of door. */
-                    door_type: 'common_area' | 'guest';
+                    common_area_number?: string | undefined;
+                    /** Display name of the entrance. */
+                    common_area_name?: string | undefined;
                 } | undefined;
                 /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 visionline_metadata?: {
@@ -25853,11 +25869,11 @@ export type Routes = {
                 /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 hotek_metadata?: {
                     /** Room number of the entrance. */
-                    room_number: string;
+                    room_number?: string | undefined;
                     /** Display name of the entrance. */
-                    display_name: string;
-                    /** Type of door. */
-                    door_type: 'common_area' | 'guest';
+                    common_area_number?: string | undefined;
+                    /** Display name of the entrance. */
+                    common_area_name?: string | undefined;
                 } | undefined;
                 /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 visionline_metadata?: {
@@ -26495,6 +26511,40 @@ export type Routes = {
             }[];
         };
     };
+    '/acs/systems/report_devices': {
+        route: '/acs/systems/report_devices';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of the ACS system to report resources for */
+            acs_system_id: string;
+            /** Array of ACS encoders to report */
+            acs_encoders?: {
+                /** Whether the encoder is removed */
+                is_removed?: boolean | undefined;
+                hotek_metadata: {
+                    /** The encoder number determined by the USB port connection. */
+                    encoder_number: string;
+                };
+            }[] | undefined;
+            /** Array of ACS entrances to report */
+            acs_entrances?: {
+                /** Whether the entrance is removed */
+                is_removed?: boolean | undefined;
+                /** Hotek-specific metadata associated with the entrance. */
+                hotek_metadata: {
+                    /** The room number identifier */
+                    room_number?: string | undefined;
+                    /** The common area name */
+                    common_area_name?: string | undefined;
+                    common_area_number?: string | undefined;
+                };
+            }[] | undefined;
+        };
+        formData: {};
+        jsonResponse: {};
+    };
     '/acs/users/add_to_access_group': {
         route: '/acs/users/add_to_access_group';
         method: 'PUT' | 'POST';
@@ -27294,11 +27344,11 @@ export type Routes = {
                 /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 hotek_metadata?: {
                     /** Room number of the entrance. */
-                    room_number: string;
+                    room_number?: string | undefined;
                     /** Display name of the entrance. */
-                    display_name: string;
-                    /** Type of door. */
-                    door_type: 'common_area' | 'guest';
+                    common_area_number?: string | undefined;
+                    /** Display name of the entrance. */
+                    common_area_name?: string | undefined;
                 } | undefined;
                 /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 visionline_metadata?: {
@@ -59556,11 +59606,11 @@ export type Routes = {
                             /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                             hotek_metadata?: {
                                 /** Room number of the entrance. */
-                                room_number: string;
+                                room_number?: string | undefined;
+                                /** Display name of the entrance. */
+                                common_area_number?: string | undefined;
                                 /** Display name of the entrance. */
-                                display_name: string;
-                                /** Type of door. */
-                                door_type: 'common_area' | 'guest';
+                                common_area_name?: string | undefined;
                             } | undefined;
                             /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                             visionline_metadata?: {
@@ -61135,11 +61185,11 @@ export type Routes = {
                     /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     hotek_metadata?: {
                         /** Room number of the entrance. */
-                        room_number: string;
+                        room_number?: string | undefined;
                         /** Display name of the entrance. */
-                        display_name: string;
-                        /** Type of door. */
-                        door_type: 'common_area' | 'guest';
+                        common_area_number?: string | undefined;
+                        /** Display name of the entrance. */
+                        common_area_name?: string | undefined;
                     } | undefined;
                     /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     visionline_metadata?: {
@@ -82369,11 +82419,11 @@ export type Routes = {
                     /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     hotek_metadata?: {
                         /** Room number of the entrance. */
-                        room_number: string;
+                        room_number?: string | undefined;
                         /** Display name of the entrance. */
-                        display_name: string;
-                        /** Type of door. */
-                        door_type: 'common_area' | 'guest';
+                        common_area_number?: string | undefined;
+                        /** Display name of the entrance. */
+                        common_area_name?: string | undefined;
                     } | undefined;
                     /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     visionline_metadata?: {
@@ -85092,6 +85142,8 @@ export type Routes = {
                     access_grant_id: string;
                     /** Unique key for the access grant within the workspace. */
                     access_grant_key?: string | undefined;
+                    /** Reservation key for the access grant. */
+                    reservation_key?: string | undefined;
                     /** ID of user identity to which the Access Grant gives access. */
                     user_identity_id: string;
                     /**

package/package.json

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

package/src/lib/seam/connect/models/access-grants/access-grant.ts

@@ -47,6 +47,10 @@ export const access_grant = z.object({
     .string()
     .optional()
     .describe('Unique key for the access grant within the workspace.'),
+  reservation_key: z
+    .string()
+    .optional()
+    .describe('Reservation key for the access grant.'),
   user_identity_id: z
     .string()
     .uuid()

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

@@ -3,9 +3,10 @@ import { z } from 'zod'
 export const acs_entrance_hotek_metadata = z
   .object({
     room_number: z.string().describe('Room number of the entrance.'),
-    display_name: z.string().describe('Display name of the entrance.'),
-    door_type: z.enum(['common_area', 'guest']).describe('Type of door.'),
+    common_area_number: z.string().describe('Display name of the entrance.'),
+    common_area_name: z.string().describe('Display name of the entrance.'),
   })
+  .partial()
   .describe('Hotek-specific metadata associated with the entrance.')
 
 export type AcsEntranceHotekMetadata = z.infer<

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

@@ -1896,6 +1896,10 @@ export default {
             },
             type: 'array',
           },
+          reservation_key: {
+            description: 'Reservation key for the access grant.',
+            type: 'string',
+          },
           space_ids: {
             description:
               'IDs of the spaces to which the Access Grant gives access.',
@@ -2899,13 +2903,12 @@ export default {
             description:
               'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
             properties: {
-              display_name: {
+              common_area_name: {
                 description: 'Display name of the entrance.',
                 type: 'string',
               },
-              door_type: {
-                description: 'Type of door.',
-                enum: ['common_area', 'guest'],
+              common_area_number: {
+                description: 'Display name of the entrance.',
                 type: 'string',
               },
               room_number: {
@@ -2913,7 +2916,6 @@ export default {
                 type: 'string',
               },
             },
-            required: ['room_number', 'display_name', 'door_type'],
             type: 'object',
           },
           latch_metadata: {
@@ -19933,13 +19935,12 @@ export default {
                               description:
                                 'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
                               properties: {
-                                display_name: {
+                                common_area_name: {
                                   description: 'Display name of the entrance.',
                                   type: 'string',
                                 },
-                                door_type: {
-                                  description: 'Type of door.',
-                                  enum: ['common_area', 'guest'],
+                                common_area_number: {
+                                  description: 'Display name of the entrance.',
                                   type: 'string',
                                 },
                                 room_number: {
@@ -19947,11 +19948,6 @@ export default {
                                   type: 'string',
                                 },
                               },
-                              required: [
-                                'room_number',
-                                'display_name',
-                                'door_type',
-                              ],
                               type: 'object',
                             },
                             latch_metadata: {
@@ -28450,6 +28446,10 @@ export default {
                         },
                         type: 'array',
                       },
+                      reservation_key: {
+                        description: 'Reservation key for the access grant.',
+                        type: 'string',
+                      },
                       space_ids: {
                         description:
                           'Set of IDs of existing spaces to which access is being granted.',
@@ -29369,6 +29369,10 @@ export default {
                           },
                           type: 'array',
                         },
+                        reservation_key: {
+                          description: 'Reservation key for the access grant.',
+                          type: 'string',
+                        },
                         space_ids: {
                           description:
                             'IDs of the spaces to which the Access Grant gives access.',
@@ -29599,6 +29603,10 @@ export default {
                           },
                           type: 'array',
                         },
+                        reservation_key: {
+                          description: 'Reservation key for the access grant.',
+                          type: 'string',
+                        },
                         space_ids: {
                           description:
                             'IDs of the spaces to which the Access Grant gives access.',
@@ -29846,6 +29854,11 @@ export default {
                             },
                             type: 'array',
                           },
+                          reservation_key: {
+                            description:
+                              'Reservation key for the access grant.',
+                            type: 'string',
+                          },
                           space_ids: {
                             description:
                               'IDs of the spaces to which the Access Grant gives access.',
@@ -30090,6 +30103,11 @@ export default {
                             },
                             type: 'array',
                           },
+                          reservation_key: {
+                            description:
+                              'Reservation key for the access grant.',
+                            type: 'string',
+                          },
                           space_ids: {
                             description:
                               'IDs of the spaces to which the Access Grant gives access.',
@@ -36339,6 +36357,119 @@ export default {
         'x-title': 'List Compatible Credential Manager ACS Systems',
       },
     },
+    '/acs/systems/report_devices': {
+      post: {
+        description:
+          'Reports ACS system resources including encoders and entrances with their metadata.\n\nThis endpoint allows reporting of:\n- ACS encoders with removal status and encoder port metadata\n- ACS entrances with room number metadata',
+        operationId: 'acsSystemsReportDevicesPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  acs_encoders: {
+                    default: [],
+                    description: 'Array of ACS encoders to report',
+                    items: {
+                      properties: {
+                        hotek_metadata: {
+                          properties: {
+                            encoder_number: {
+                              description:
+                                'The encoder number determined by the USB port connection.',
+                              type: 'string',
+                            },
+                          },
+                          required: ['encoder_number'],
+                          type: 'object',
+                        },
+                        is_removed: {
+                          default: false,
+                          description: 'Whether the encoder is removed',
+                          type: 'boolean',
+                        },
+                      },
+                      required: ['hotek_metadata'],
+                      type: 'object',
+                    },
+                    type: 'array',
+                  },
+                  acs_entrances: {
+                    default: [],
+                    description: 'Array of ACS entrances to report',
+                    items: {
+                      properties: {
+                        hotek_metadata: {
+                          description:
+                            'Hotek-specific metadata associated with the entrance.',
+                          properties: {
+                            common_area_name: {
+                              description: 'The common area name',
+                              type: 'string',
+                            },
+                            common_area_number: {
+                              description: 'The room number identifier',
+                              type: 'string',
+                            },
+                            room_number: {
+                              description: 'The room number identifier',
+                              type: 'string',
+                            },
+                          },
+                          type: 'object',
+                        },
+                        is_removed: {
+                          default: false,
+                          description: 'Whether the entrance is removed',
+                          type: 'boolean',
+                        },
+                      },
+                      required: ['hotek_metadata'],
+                      type: 'object',
+                    },
+                    type: 'array',
+                  },
+                  acs_system_id: {
+                    description: 'ID of the ACS system to report resources for',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                },
+                required: ['acs_system_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: { ok: { type: 'boolean' } },
+                  required: ['ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/acs/systems/report_devices',
+        tags: ['/acs'],
+        'x-fern-sdk-group-name': ['acs', 'systems'],
+        'x-fern-sdk-method-name': 'report_devices',
+        'x-response-key': null,
+        'x-title': 'Report ACS Resources',
+      },
+    },
     '/acs/users/add_to_access_group': {
       post: {
         description: