@seamapi/types 1.604.0 → 1.605.0

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

@@ -11381,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?: {
@@ -14813,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?: {
@@ -20870,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?: {
@@ -22236,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?: {
@@ -25702,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?: {
@@ -25869,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?: {
@@ -26511,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';
@@ -27310,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?: {
@@ -59572,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?: {
@@ -61151,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?: {
@@ -82385,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?: {

package/package.json

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

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

@@ -2903,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: {
@@ -2917,7 +2916,6 @@ export default {
                 type: 'string',
               },
             },
-            required: ['room_number', 'display_name', 'door_type'],
             type: 'object',
           },
           latch_metadata: {
@@ -19937,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: {
@@ -19951,11 +19948,6 @@ export default {
                                   type: 'string',
                                 },
                               },
-                              required: [
-                                'room_number',
-                                'display_name',
-                                'door_type',
-                              ],
                               type: 'object',
                             },
                             latch_metadata: {
@@ -36365,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:

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

@@ -13000,11 +13000,11 @@ export type Routes = {
               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). */
@@ -17112,11 +17112,11 @@ export type Routes = {
               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). */
@@ -24246,11 +24246,11 @@ export type Routes = {
         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). */
@@ -25856,11 +25856,11 @@ export type Routes = {
         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). */
@@ -29860,11 +29860,11 @@ export type Routes = {
         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). */
@@ -30054,11 +30054,11 @@ export type Routes = {
         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). */
@@ -30895,6 +30895,44 @@ 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'
@@ -31798,11 +31836,11 @@ export type Routes = {
         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). */
@@ -70952,11 +70990,11 @@ export type Routes = {
               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). */
@@ -72921,11 +72959,11 @@ export type Routes = {
               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). */
@@ -98093,11 +98131,11 @@ export type Routes = {
               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). */