@seamapi/types 1.604.0 → 1.606.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?: {
@@ -31770,6 +31804,19 @@ export type Routes = {
                     /** Your unique identifier for the user identity. */
                     user_identity_key: string;
                 }[] | undefined;
+                /** List of staff members. */
+                staff_members?: {
+                    /** Your display name for this user identity resource. */
+                    name: string;
+                    /** Email address associated with the user identity. */
+                    email_address?: string | undefined;
+                    /** Phone number associated with the user identity. */
+                    phone_number?: string | undefined;
+                    /** Your unique identifier for the staff. */
+                    staff_member_key: string;
+                    /** List of unique identifiers for the sites the staff member is associated with. */
+                    site_keys: string[];
+                }[] | undefined;
                 /** List of reservations. */
                 reservations?: {
                     /** Your name for this access grant resource. */
@@ -32095,6 +32142,19 @@ export type Routes = {
                 /** Your unique identifier for the user identity. */
                 user_identity_key: string;
             }[] | undefined;
+            /** List of staff members. */
+            staff_members?: {
+                /** Your display name for this user identity resource. */
+                name: string;
+                /** Email address associated with the user identity. */
+                email_address?: string | undefined;
+                /** Phone number associated with the user identity. */
+                phone_number?: string | undefined;
+                /** Your unique identifier for the staff. */
+                staff_member_key: string;
+                /** List of unique identifiers for the sites the staff member is associated with. */
+                site_keys: string[];
+            }[] | undefined;
             /** List of reservations. */
             reservations?: {
                 /** Your name for this access grant resource. */
@@ -59120,6 +59180,48 @@ export type Routes = {
             }[];
         };
     };
+    '/seam/customer/v1/staff_members/list': {
+        route: '/seam/customer/v1/staff_members/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** Filter staff members by space key. */
+            space_key?: string | undefined;
+            /** Filter staff members by space ID (UUID). */
+            space_id?: string | undefined;
+            /** Maximum number of records to return per page. */
+            limit?: number;
+            /** Timestamp by which to limit returned staff members. Returns staff members created before this timestamp. */
+            created_before?: Date | undefined;
+            /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
+            page_cursor?: ((string | undefined) | null) | undefined;
+        };
+        formData: {};
+        jsonResponse: {
+            staff_members: {
+                /** Your display name for this user identity resource. */
+                name: string;
+                /** Email address associated with the user identity. */
+                email_address?: string | undefined;
+                /** Phone number associated with the user identity. */
+                phone_number?: string | undefined;
+                /** Your unique identifier for the staff. */
+                staff_member_key: string;
+                /** List of unique identifiers for the sites the staff member is associated with. */
+                site_keys: string[];
+            }[];
+            /** Information about the current page of results. */
+            pagination: {
+                /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
+                next_page_cursor: string | null;
+                /** Indicates whether there is another page of results after this one. */
+                has_next_page: boolean;
+                /** URL to get the next page of results. */
+                next_page_url: string | null;
+            };
+        };
+    };
     '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
         route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]';
         method: 'POST';
@@ -59572,11 +59674,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?: {
@@ -61151,11 +61253,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 +82487,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/lib/seam/connect/schemas.d.ts

@@ -1 +1 @@
-export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
+export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, staff_member_resource, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';

package/lib/seam/connect/schemas.js

@@ -1,2 +1,2 @@
-export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
+export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, staff_member_resource, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
 //# sourceMappingURL=schemas.js.map

package/lib/seam/connect/schemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,KAAK,EACL,MAAM,EACN,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,qBAAqB,EACrB,MAAM,EACN,eAAe,EACf,WAAW,EACX,UAAU,EACV,eAAe,EACf,UAAU,EACV,UAAU,EACV,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,KAAK,EACL,MAAM,EACN,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,qBAAqB,EACrB,MAAM,EACN,eAAe,EACf,WAAW,EACX,UAAU,EACV,eAAe,EACf,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}

package/package.json

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

package/src/lib/seam/connect/internal/schemas.ts

@@ -74,6 +74,7 @@ export {
   space,
   neutral_resource as space_resource,
   spaces_batch,
+  staff_member_resource,
   tenant_resource,
   thermostat_capability_properties,
   thermostat_device_type,

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/models/customer/customer-data.ts

@@ -20,6 +20,7 @@ import {
 import {
   guest_resource,
   resident_resource,
+  staff_member_resource,
   tenant_resource,
   user_identity_resource,
   user_resource,
@@ -82,6 +83,10 @@ export const customer_data = z.object({
     .array(user_identity_resource)
     .optional()
     .describe('List of user identities.'),
+  staff_members: z
+    .array(staff_member_resource)
+    .optional()
+    .describe('List of staff members.'),
 
   // Access grant resources
   reservations: z

package/src/lib/seam/connect/models/customer/user-identity-resources.ts

@@ -32,6 +32,23 @@ export const user_resource = base_user_identity_resource.extend({
   user_key: z.string().describe('Your unique identifier for the user.'),
 })
 
+// staff resource
+export const staff_member_resource = base_user_identity_resource.extend({
+  staff_member_key: z
+    .string()
+    .describe('Your unique identifier for the staff.'),
+  site_keys: z
+    .array(z.string())
+    .describe(
+      'List of unique identifiers for the sites the staff member is associated with.',
+    ),
+}).describe(`
+  ---
+  route_path: /seam/customer/v1/staff_members
+  ---
+  Represents a staff member for a specific customer.
+`)
+
 export const user_identity_resource = base_user_identity_resource.extend({
   user_identity_key: z
     .string()
@@ -45,6 +62,7 @@ export const user_identity_resource_union = z.union([
   resident_resource,
   user_resource,
   user_identity_resource,
+  staff_member_resource,
 ])
 
 // All user identity key aliases for use in references