@seamapi/types 1.326.0 → 1.328.0

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

@@ -25,6 +25,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -817,6 +818,7 @@ export interface Routes {
                     message: string;
                 };
             };
+            /**  */
             access_code: {
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
@@ -1102,6 +1104,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -1924,6 +1927,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             access_code: {
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
@@ -2194,6 +2198,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             backup_access_code: {
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
@@ -2316,6 +2321,7 @@ export interface Routes {
                 /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
                 is_offline_access_code: boolean;
             };
+            /**  */
             access_code: {
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
@@ -2452,6 +2458,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             access_code: {
                 /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
                 type: 'time_bound' | 'ongoing';
@@ -2580,6 +2587,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -3386,6 +3394,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             access_code: {
                 /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
                 type: 'time_bound' | 'ongoing';
@@ -3644,6 +3653,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -4612,7 +4622,6 @@ export interface Routes {
                 } | undefined;
                 dormakaba_community_metadata?: {
                     access_point_name: string;
-                    common_area_number?: number | undefined;
                 } | undefined;
                 assa_abloy_vostio_metadata?: {
                     door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
@@ -4875,6 +4884,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             acs_credential_provisioning_automation: {
                 acs_credential_provisioning_automation_id: string;
                 credential_manager_acs_system_id: string;
@@ -5556,7 +5566,6 @@ export interface Routes {
                 } | undefined;
                 dormakaba_community_metadata?: {
                     access_point_name: string;
-                    common_area_number?: number | undefined;
                 } | undefined;
                 assa_abloy_vostio_metadata?: {
                     door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
@@ -6037,6 +6046,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -6888,6 +6898,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -7811,7 +7822,6 @@ export interface Routes {
                 } | undefined;
                 dormakaba_community_metadata?: {
                     access_point_name: string;
-                    common_area_number?: number | undefined;
                 } | undefined;
                 assa_abloy_vostio_metadata?: {
                     door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
@@ -7890,7 +7900,6 @@ export interface Routes {
                 } | undefined;
                 dormakaba_community_metadata?: {
                     access_point_name: string;
-                    common_area_number?: number | undefined;
                 } | undefined;
                 assa_abloy_vostio_metadata?: {
                     door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
@@ -8809,7 +8818,6 @@ export interface Routes {
                 } | undefined;
                 dormakaba_community_metadata?: {
                     access_point_name: string;
-                    common_area_number?: number | undefined;
                 } | undefined;
                 assa_abloy_vostio_metadata?: {
                     door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
@@ -9122,6 +9130,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -10734,6 +10743,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             client_session: {
                 client_session_id: string;
                 workspace_id: string;
@@ -10770,6 +10780,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             client_session: {
                 client_session_id: string;
                 workspace_id: string;
@@ -10798,6 +10809,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             client_session: {
                 client_session_id: string;
                 workspace_id: string;
@@ -10826,6 +10838,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             client_session: {
                 client_session_id: string;
                 workspace_id: string;
@@ -10896,6 +10909,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             connect_webview: {
                 connect_webview_id: string;
                 workspace_id: string;
@@ -10944,6 +10958,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             connect_webview: {
                 connect_webview_id: string;
                 workspace_id: string;
@@ -11036,6 +11051,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             connected_account: {
                 connected_account_id?: string | undefined;
                 created_at?: string | undefined;
@@ -11121,6 +11137,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             connected_account: {
                 connected_account_id?: string | undefined;
                 created_at?: string | undefined;
@@ -11173,6 +11190,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             device: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -12447,6 +12465,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             device: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -12845,6 +12864,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             event?: ({
                 /** ID of the event. */
                 event_id: string;
@@ -13243,6 +13263,21 @@ export interface Routes {
                 /** ID of the [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
                 acs_encoder_id: string;
                 event_type: 'acs_encoder.removed';
+            } | {
+                /** ID of the event. */
+                event_id: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
+                workspace_id: string;
+                /** Date and time at which the event was created. */
+                created_at: string;
+                /** Date and time at which the event occurred. */
+                occurred_at: string;
+                /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
+                connected_account_id?: string | undefined;
+                /** ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). */
+                acs_system_id: string;
+                acs_access_group_id: string;
+                event_type: 'acs_access_group.deleted';
             } | {
                 /** ID of the event. */
                 event_id: string;
@@ -14000,8 +14035,8 @@ export interface Routes {
             acs_system_ids?: string[] | undefined;
             access_code_id?: string | undefined;
             access_code_ids?: string[] | undefined;
-            event_type?: ('device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.added' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_system.added' | 'acs_system.connected' | 'acs_system.disconnected' | 'acs_user.deleted' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_encoder.added' | 'acs_encoder.removed' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point') | undefined;
-            event_types?: Array<'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.added' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_system.added' | 'acs_system.connected' | 'acs_system.disconnected' | 'acs_user.deleted' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_encoder.added' | 'acs_encoder.removed' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point'> | undefined;
+            event_type?: ('device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.added' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_system.added' | 'acs_system.connected' | 'acs_system.disconnected' | 'acs_access_group.deleted' | 'acs_user.deleted' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_encoder.added' | 'acs_encoder.removed' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point') | undefined;
+            event_types?: Array<'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.added' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_system.added' | 'acs_system.connected' | 'acs_system.disconnected' | 'acs_access_group.deleted' | 'acs_user.deleted' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_encoder.added' | 'acs_encoder.removed' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point'> | undefined;
             connected_account_id?: string | undefined;
             connect_webview_id?: string | undefined;
             limit?: number;
@@ -14406,6 +14441,21 @@ export interface Routes {
                 /** ID of the [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
                 acs_encoder_id: string;
                 event_type: 'acs_encoder.removed';
+            } | {
+                /** ID of the event. */
+                event_id: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
+                workspace_id: string;
+                /** Date and time at which the event was created. */
+                created_at: string;
+                /** Date and time at which the event occurred. */
+                occurred_at: string;
+                /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
+                connected_account_id?: string | undefined;
+                /** ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). */
+                acs_system_id: string;
+                acs_access_group_id: string;
+                event_type: 'acs_access_group.deleted';
             } | {
                 /** ID of the event. */
                 event_id: string;
@@ -15158,6 +15208,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             lock: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -15739,6 +15790,7 @@ export interface Routes {
                 can_simulate_connection?: boolean | undefined;
                 can_simulate_disconnection?: boolean | undefined;
             };
+            /**  */
             device: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -17532,6 +17584,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -18337,6 +18390,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -19141,6 +19195,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             network: {
                 network_id: string;
                 workspace_id: string;
@@ -20380,6 +20435,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -21172,6 +21228,7 @@ export interface Routes {
                     message: string;
                 };
             };
+            /**  */
             noise_threshold: {
                 noise_threshold_id: string;
                 device_id: string;
@@ -21195,6 +21252,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -21999,6 +22057,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             noise_threshold: {
                 noise_threshold_id: string;
                 device_id: string;
@@ -22049,6 +22108,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -23024,6 +23084,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             phone: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -23160,6 +23221,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -23971,6 +24033,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -24823,6 +24886,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             thermostat: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -25423,6 +25487,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -26238,6 +26303,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -28244,6 +28310,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -29235,6 +29302,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -30069,6 +30137,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -32607,6 +32676,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             webhook: {
                 webhook_id: string;
                 url: string;
@@ -32636,6 +32706,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             webhook: {
                 webhook_id: string;
                 url: string;
@@ -32690,6 +32761,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             workspace: {
                 workspace_id: string;
                 name: string;
@@ -32709,6 +32781,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             workspace: {
                 workspace_id: string;
                 name: string;
@@ -32747,6 +32820,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;

package/package.json

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

package/src/lib/seam/connect/models/access-codes/managed-access-code.ts

@@ -138,6 +138,10 @@ export const access_code = z.object({
     .describe(
       'Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.',
     ),
-})
+}).describe(`
+  ---
+  route_path: /access_codes
+  ---
+`)
 
 export type AccessCode = z.infer<typeof access_code>

package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts

@@ -19,6 +19,10 @@ export const unmanaged_access_code = access_code
   .extend({
     is_managed: z.literal(false),
     status: z.enum(['set']),
-  })
+  }).describe(`
+    ---
+    route_path: /access_codes/unmanaged
+    ---
+  `)
 
 export type UnmanagedAccessCode = z.infer<typeof unmanaged_access_code>

package/src/lib/seam/connect/models/acs/acs-access-group.ts

@@ -100,9 +100,13 @@ const common_acs_access_group = z.object({
 
 export const acs_access_group = common_acs_access_group.extend({
   is_managed: z.literal(true),
-})
-  .describe(`Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
-The \`acs_access_group\` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).`)
+}).describe(`
+    ---
+    route_path: /acs/access_groups
+    ---
+    Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
+    The \`acs_access_group\` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+  `)
 export const unmanaged_acs_access_group = common_acs_access_group.extend({
   is_managed: z.literal(false),
 })

package/src/lib/seam/connect/models/acs/acs-credential-pool.ts

@@ -14,6 +14,10 @@ export const acs_credential_pool = z.object({
   external_type_display_name: z.string(),
   created_at: z.string().datetime(),
   workspace_id: z.string().uuid(),
-})
+}).describe(`
+  ---
+  route_path: /acs/credential_pools
+  ---
+`)
 
 export type AcsCredentialPool = z.output<typeof acs_credential_pool>

package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts

@@ -6,42 +6,45 @@ export const acs_credential_provisioning_automation = z.object({
   user_identity_id: z.string().uuid(),
   created_at: z.string().datetime(),
   workspace_id: z.string().uuid(),
-})
+}).describe(`
+  ---
+  route_path: /acs/credential_provisioning_automations
+  ---
+`)
 
-export const enrollment_automation = z
-  .object({
-    enrollment_automation_id: z
-      .string()
-      .uuid()
-      .describe('ID of the enrollment automation.'),
-    credential_manager_acs_system_id: z
-      .string()
-      .uuid()
-      .describe(
-        'ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.',
-      ),
-    user_identity_id: z
-      .string()
-      .uuid()
-      .describe(
-        'ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
-      ),
-    created_at: z
-      .string()
-      .datetime()
-      .describe(
-        'Date and time at which the enrollment automation was created.',
-      ),
-    workspace_id: z
-      .string()
-      .uuid()
-      .describe(
-        'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation.',
-      ),
-  })
-  .describe(
-    'Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development).',
-  )
+export const enrollment_automation = z.object({
+  enrollment_automation_id: z
+    .string()
+    .uuid()
+    .describe('ID of the enrollment automation.'),
+  credential_manager_acs_system_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.',
+    ),
+  user_identity_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
+    ),
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which the enrollment automation was created.'),
+  workspace_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation.',
+    ),
+}).describe(`
+  ---
+  route_path: /user_identities/enrollment_automations
+  ---
+  Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development).
+`)
 
 export type EnrollmentAutomation = z.output<typeof enrollment_automation>