@seamapi/types 1.621.0 → 1.622.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -19588,6 +19588,25 @@ export type Routes = {
19588
19588
  [x: string]: string | boolean;
19589
19589
  } | undefined;
19590
19590
  event_type: 'phone.deactivated';
19591
+ } | {
19592
+ /** ID of the event. */
19593
+ event_id: string;
19594
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
19595
+ workspace_id: string;
19596
+ /** Date and time at which the event was created. */
19597
+ created_at: string;
19598
+ /** Date and time at which the event occurred. */
19599
+ occurred_at: string;
19600
+ /** ID of the affected space. */
19601
+ space_id: string;
19602
+ /** Type of the event. */
19603
+ event_type: 'space.device_membership_changed';
19604
+ /** Unique key for the space within the workspace. */
19605
+ space_key?: string | undefined;
19606
+ /** IDs of all devices currently attached to the space. */
19607
+ device_ids: string[];
19608
+ /** IDs of all ACS entrances currently attached to the space. */
19609
+ acs_entrance_ids: string[];
19591
19610
  })[] | undefined;
19592
19611
  instant_keys?: {
19593
19612
  /** ID of the Instant Key. */
@@ -32208,6 +32227,8 @@ export type Routes = {
32208
32227
  booking_keys?: string[] | undefined;
32209
32228
  /** List of access grant keys to delete. */
32210
32229
  access_grant_keys?: string[] | undefined;
32230
+ /** List of staff member keys to delete. */
32231
+ staff_member_keys?: string[] | undefined;
32211
32232
  };
32212
32233
  formData: {};
32213
32234
  jsonResponse: {};
@@ -37922,6 +37943,25 @@ export type Routes = {
37922
37943
  [x: string]: string | boolean;
37923
37944
  } | undefined;
37924
37945
  event_type: 'phone.deactivated';
37946
+ } | {
37947
+ /** ID of the event. */
37948
+ event_id: string;
37949
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
37950
+ workspace_id: string;
37951
+ /** Date and time at which the event was created. */
37952
+ created_at: string;
37953
+ /** Date and time at which the event occurred. */
37954
+ occurred_at: string;
37955
+ /** ID of the affected space. */
37956
+ space_id: string;
37957
+ /** Type of the event. */
37958
+ event_type: 'space.device_membership_changed';
37959
+ /** Unique key for the space within the workspace. */
37960
+ space_key?: string | undefined;
37961
+ /** IDs of all devices currently attached to the space. */
37962
+ device_ids: string[];
37963
+ /** IDs of all ACS entrances currently attached to the space. */
37964
+ acs_entrance_ids: string[];
37925
37965
  }) | undefined;
37926
37966
  message?: string | undefined;
37927
37967
  };
@@ -37953,9 +37993,9 @@ export type Routes = {
37953
37993
  /** IDs of the access codes for which you want to list events. */
37954
37994
  access_code_ids?: string[] | undefined;
37955
37995
  /** Type of the events that you want to list. */
37956
- event_type?: ('access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | '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' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'enrollment_automation.deleted' | 'phone.deactivated') | undefined;
37996
+ event_type?: ('access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | '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' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed') | undefined;
37957
37997
  /** Types of the events that you want to list. */
37958
- event_types?: ('access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | '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' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'enrollment_automation.deleted' | 'phone.deactivated')[] | undefined;
37998
+ event_types?: ('access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | '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' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed')[] | undefined;
37959
37999
  /** ID of the connected account for which you want to list events. */
37960
38000
  connected_account_id?: string | undefined;
37961
38001
  /** ID of the Connect Webview for which you want to list events. */
@@ -39862,6 +39902,25 @@ export type Routes = {
39862
39902
  [x: string]: string | boolean;
39863
39903
  } | undefined;
39864
39904
  event_type: 'phone.deactivated';
39905
+ } | {
39906
+ /** ID of the event. */
39907
+ event_id: string;
39908
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
39909
+ workspace_id: string;
39910
+ /** Date and time at which the event was created. */
39911
+ created_at: string;
39912
+ /** Date and time at which the event occurred. */
39913
+ occurred_at: string;
39914
+ /** ID of the affected space. */
39915
+ space_id: string;
39916
+ /** Type of the event. */
39917
+ event_type: 'space.device_membership_changed';
39918
+ /** Unique key for the space within the workspace. */
39919
+ space_key?: string | undefined;
39920
+ /** IDs of all devices currently attached to the space. */
39921
+ device_ids: string[];
39922
+ /** IDs of all ACS entrances currently attached to the space. */
39923
+ acs_entrance_ids: string[];
39865
39924
  })[];
39866
39925
  };
39867
39926
  };
@@ -57279,9 +57338,9 @@ export type Routes = {
57279
57338
  /** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
57280
57339
  between?: (string | Date)[] | undefined;
57281
57340
  /** Type of the events that you want to list. */
57282
- event_type?: ('access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | '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' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'enrollment_automation.deleted' | 'phone.deactivated') | undefined;
57341
+ event_type?: ('access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | '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' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed') | undefined;
57283
57342
  /** Types of the events that you want to list. */
57284
- event_types?: ('access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | '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' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'enrollment_automation.deleted' | 'phone.deactivated')[] | undefined;
57343
+ event_types?: ('access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | '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' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed')[] | undefined;
57285
57344
  /** Numerical limit on the number of events to return. */
57286
57345
  limit?: number;
57287
57346
  };
@@ -59182,6 +59241,25 @@ export type Routes = {
59182
59241
  [x: string]: string | boolean;
59183
59242
  } | undefined;
59184
59243
  event_type: 'phone.deactivated';
59244
+ } | {
59245
+ /** ID of the event. */
59246
+ event_id: string;
59247
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
59248
+ workspace_id: string;
59249
+ /** Date and time at which the event was created. */
59250
+ created_at: string;
59251
+ /** Date and time at which the event occurred. */
59252
+ occurred_at: string;
59253
+ /** ID of the affected space. */
59254
+ space_id: string;
59255
+ /** Type of the event. */
59256
+ event_type: 'space.device_membership_changed';
59257
+ /** Unique key for the space within the workspace. */
59258
+ space_key?: string | undefined;
59259
+ /** IDs of all devices currently attached to the space. */
59260
+ device_ids: string[];
59261
+ /** IDs of all ACS entrances currently attached to the space. */
59262
+ acs_entrance_ids: string[];
59185
59263
  })[];
59186
59264
  };
59187
59265
  };
@@ -87481,6 +87559,25 @@ export type Routes = {
87481
87559
  [x: string]: string | boolean;
87482
87560
  } | undefined;
87483
87561
  event_type: 'phone.deactivated';
87562
+ } | {
87563
+ /** ID of the event. */
87564
+ event_id: string;
87565
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
87566
+ workspace_id: string;
87567
+ /** Date and time at which the event was created. */
87568
+ created_at: string;
87569
+ /** Date and time at which the event occurred. */
87570
+ occurred_at: string;
87571
+ /** ID of the affected space. */
87572
+ space_id: string;
87573
+ /** Type of the event. */
87574
+ event_type: 'space.device_membership_changed';
87575
+ /** Unique key for the space within the workspace. */
87576
+ space_key?: string | undefined;
87577
+ /** IDs of all devices currently attached to the space. */
87578
+ device_ids: string[];
87579
+ /** IDs of all ACS entrances currently attached to the space. */
87580
+ acs_entrance_ids: string[];
87484
87581
  })[] | undefined;
87485
87582
  instant_keys?: {
87486
87583
  /** ID of the Instant Key. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.621.0",
3
+ "version": "1.622.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -80,6 +80,10 @@ export const customer_delete_data = z.object({
80
80
  .array(z.string())
81
81
  .optional()
82
82
  .describe('List of access grant keys to delete.'),
83
+ staff_member_keys: z
84
+ .array(z.string())
85
+ .optional()
86
+ .describe('List of staff member keys to delete.'),
83
87
  })
84
88
 
85
89
  export type CustomerDeleteData = z.infer<typeof customer_delete_data>
@@ -11,6 +11,7 @@ import { connected_account_events } from './connected-accounts.js'
11
11
  import { device_events } from './devices.js'
12
12
  import { enrollment_automation_events } from './enrollment-automations.js'
13
13
  import { phone_events } from './phones.js'
14
+ import { space_events } from './spaces.js'
14
15
 
15
16
  export const seam_event = z.discriminatedUnion('event_type', [
16
17
  ...access_code_events,
@@ -24,6 +25,7 @@ export const seam_event = z.discriminatedUnion('event_type', [
24
25
  ...device_events,
25
26
  ...enrollment_automation_events,
26
27
  ...phone_events,
28
+ ...space_events,
27
29
  ]).describe(`
28
30
  ---
29
31
  route_path: /events
@@ -0,0 +1,34 @@
1
+ import { z } from 'zod'
2
+
3
+ import { common_event } from './common.js'
4
+
5
+ const space_event = common_event.extend({
6
+ space_id: z.string().uuid().describe('ID of the affected space.'),
7
+ })
8
+
9
+ export const space_device_membership_changed_event = space_event.extend({
10
+ event_type: z
11
+ .literal('space.device_membership_changed')
12
+ .describe('Type of the event.'),
13
+ space_key: z
14
+ .string()
15
+ .optional()
16
+ .describe('Unique key for the space within the workspace.'),
17
+ device_ids: z
18
+ .array(z.string().uuid())
19
+ .describe('IDs of all devices currently attached to the space.'),
20
+ acs_entrance_ids: z
21
+ .array(z.string().uuid())
22
+ .describe('IDs of all ACS entrances currently attached to the space.'),
23
+ }).describe(`
24
+ ---
25
+ route_path: /spaces
26
+ ---
27
+ A device was added or removed from a space.
28
+ `)
29
+
30
+ export type SpaceDeviceMembershipChangedEvent = z.infer<
31
+ typeof space_device_membership_changed_event
32
+ >
33
+
34
+ export const space_events = [space_device_membership_changed_event] as const
@@ -19466,6 +19466,70 @@ export default {
19466
19466
  type: 'object',
19467
19467
  'x-route-path': '/phones',
19468
19468
  },
19469
+ {
19470
+ description: 'A device was added or removed from a space.',
19471
+ properties: {
19472
+ acs_entrance_ids: {
19473
+ description:
19474
+ 'IDs of all ACS entrances currently attached to the space.',
19475
+ items: { format: 'uuid', type: 'string' },
19476
+ type: 'array',
19477
+ },
19478
+ created_at: {
19479
+ description: 'Date and time at which the event was created.',
19480
+ format: 'date-time',
19481
+ type: 'string',
19482
+ },
19483
+ device_ids: {
19484
+ description:
19485
+ 'IDs of all devices currently attached to the space.',
19486
+ items: { format: 'uuid', type: 'string' },
19487
+ type: 'array',
19488
+ },
19489
+ event_id: {
19490
+ description: 'ID of the event.',
19491
+ format: 'uuid',
19492
+ type: 'string',
19493
+ },
19494
+ event_type: {
19495
+ description: 'Type of the event.',
19496
+ enum: ['space.device_membership_changed'],
19497
+ type: 'string',
19498
+ },
19499
+ occurred_at: {
19500
+ description: 'Date and time at which the event occurred.',
19501
+ format: 'date-time',
19502
+ type: 'string',
19503
+ },
19504
+ space_id: {
19505
+ description: 'ID of the affected space.',
19506
+ format: 'uuid',
19507
+ type: 'string',
19508
+ },
19509
+ space_key: {
19510
+ description: 'Unique key for the space within the workspace.',
19511
+ type: 'string',
19512
+ },
19513
+ workspace_id: {
19514
+ description:
19515
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.',
19516
+ format: 'uuid',
19517
+ type: 'string',
19518
+ },
19519
+ },
19520
+ required: [
19521
+ 'event_id',
19522
+ 'workspace_id',
19523
+ 'created_at',
19524
+ 'occurred_at',
19525
+ 'space_id',
19526
+ 'event_type',
19527
+ 'device_ids',
19528
+ 'acs_entrance_ids',
19529
+ ],
19530
+ type: 'object',
19531
+ 'x-route-path': '/spaces',
19532
+ },
19469
19533
  ],
19470
19534
  'x-route-path': '/events',
19471
19535
  },
@@ -42353,6 +42417,15 @@ export default {
42353
42417
  type: 'array',
42354
42418
  },
42355
42419
  },
42420
+ {
42421
+ in: 'query',
42422
+ name: 'staff_member_keys',
42423
+ schema: {
42424
+ description: 'List of staff member keys to delete.',
42425
+ items: { type: 'string' },
42426
+ type: 'array',
42427
+ },
42428
+ },
42356
42429
  ],
42357
42430
  responses: {
42358
42431
  200: {
@@ -42462,6 +42535,11 @@ export default {
42462
42535
  items: { type: 'string' },
42463
42536
  type: 'array',
42464
42537
  },
42538
+ staff_member_keys: {
42539
+ description: 'List of staff member keys to delete.',
42540
+ items: { type: 'string' },
42541
+ type: 'array',
42542
+ },
42465
42543
  tenant_keys: {
42466
42544
  description: 'List of tenant keys to delete.',
42467
42545
  items: { type: 'string' },
@@ -46409,6 +46487,7 @@ export default {
46409
46487
  'device.name_changed',
46410
46488
  'enrollment_automation.deleted',
46411
46489
  'phone.deactivated',
46490
+ 'space.device_membership_changed',
46412
46491
  ],
46413
46492
  type: 'string',
46414
46493
  },
@@ -46512,6 +46591,7 @@ export default {
46512
46591
  'device.name_changed',
46513
46592
  'enrollment_automation.deleted',
46514
46593
  'phone.deactivated',
46594
+ 'space.device_membership_changed',
46515
46595
  ],
46516
46596
  type: 'string',
46517
46597
  },
@@ -46770,6 +46850,7 @@ export default {
46770
46850
  'device.name_changed',
46771
46851
  'enrollment_automation.deleted',
46772
46852
  'phone.deactivated',
46853
+ 'space.device_membership_changed',
46773
46854
  ],
46774
46855
  type: 'string',
46775
46856
  },
@@ -46869,6 +46950,7 @@ export default {
46869
46950
  'device.name_changed',
46870
46951
  'enrollment_automation.deleted',
46871
46952
  'phone.deactivated',
46953
+ 'space.device_membership_changed',
46872
46954
  ],
46873
46955
  type: 'string',
46874
46956
  },
@@ -52689,6 +52771,7 @@ export default {
52689
52771
  'device.name_changed',
52690
52772
  'enrollment_automation.deleted',
52691
52773
  'phone.deactivated',
52774
+ 'space.device_membership_changed',
52692
52775
  ],
52693
52776
  type: 'string',
52694
52777
  },
@@ -52793,6 +52876,7 @@ export default {
52793
52876
  'device.name_changed',
52794
52877
  'enrollment_automation.deleted',
52795
52878
  'phone.deactivated',
52879
+ 'space.device_membership_changed',
52796
52880
  ],
52797
52881
  type: 'string',
52798
52882
  },
@@ -52960,6 +53044,7 @@ export default {
52960
53044
  'device.name_changed',
52961
53045
  'enrollment_automation.deleted',
52962
53046
  'phone.deactivated',
53047
+ 'space.device_membership_changed',
52963
53048
  ],
52964
53049
  type: 'string',
52965
53050
  },
@@ -53059,6 +53144,7 @@ export default {
53059
53144
  'device.name_changed',
53060
53145
  'enrollment_automation.deleted',
53061
53146
  'phone.deactivated',
53147
+ 'space.device_membership_changed',
53062
53148
  ],
53063
53149
  type: 'string',
53064
53150
  },
@@ -22819,6 +22819,26 @@ export type Routes = {
22819
22819
  | undefined
22820
22820
  event_type: 'phone.deactivated'
22821
22821
  }
22822
+ | {
22823
+ /** ID of the event. */
22824
+ event_id: string
22825
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
22826
+ workspace_id: string
22827
+ /** Date and time at which the event was created. */
22828
+ created_at: string
22829
+ /** Date and time at which the event occurred. */
22830
+ occurred_at: string
22831
+ /** ID of the affected space. */
22832
+ space_id: string
22833
+ /** Type of the event. */
22834
+ event_type: 'space.device_membership_changed'
22835
+ /** Unique key for the space within the workspace. */
22836
+ space_key?: string | undefined
22837
+ /** IDs of all devices currently attached to the space. */
22838
+ device_ids: string[]
22839
+ /** IDs of all ACS entrances currently attached to the space. */
22840
+ acs_entrance_ids: string[]
22841
+ }
22822
22842
  )[]
22823
22843
  | undefined
22824
22844
  instant_keys?:
@@ -37398,6 +37418,8 @@ export type Routes = {
37398
37418
  booking_keys?: string[] | undefined
37399
37419
  /** List of access grant keys to delete. */
37400
37420
  access_grant_keys?: string[] | undefined
37421
+ /** List of staff member keys to delete. */
37422
+ staff_member_keys?: string[] | undefined
37401
37423
  }
37402
37424
  formData: {}
37403
37425
  jsonResponse: {}
@@ -44719,6 +44741,26 @@ export type Routes = {
44719
44741
  | undefined
44720
44742
  event_type: 'phone.deactivated'
44721
44743
  }
44744
+ | {
44745
+ /** ID of the event. */
44746
+ event_id: string
44747
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
44748
+ workspace_id: string
44749
+ /** Date and time at which the event was created. */
44750
+ created_at: string
44751
+ /** Date and time at which the event occurred. */
44752
+ occurred_at: string
44753
+ /** ID of the affected space. */
44754
+ space_id: string
44755
+ /** Type of the event. */
44756
+ event_type: 'space.device_membership_changed'
44757
+ /** Unique key for the space within the workspace. */
44758
+ space_key?: string | undefined
44759
+ /** IDs of all devices currently attached to the space. */
44760
+ device_ids: string[]
44761
+ /** IDs of all ACS entrances currently attached to the space. */
44762
+ acs_entrance_ids: string[]
44763
+ }
44722
44764
  )
44723
44765
  | undefined
44724
44766
  message?: string | undefined
@@ -44845,6 +44887,7 @@ export type Routes = {
44845
44887
  | 'device.name_changed'
44846
44888
  | 'enrollment_automation.deleted'
44847
44889
  | 'phone.deactivated'
44890
+ | 'space.device_membership_changed'
44848
44891
  )
44849
44892
  | undefined
44850
44893
  /** Types of the events that you want to list. */
@@ -44942,6 +44985,7 @@ export type Routes = {
44942
44985
  | 'device.name_changed'
44943
44986
  | 'enrollment_automation.deleted'
44944
44987
  | 'phone.deactivated'
44988
+ | 'space.device_membership_changed'
44945
44989
  )[]
44946
44990
  | undefined
44947
44991
  /** ID of the connected account for which you want to list events. */
@@ -47177,6 +47221,26 @@ export type Routes = {
47177
47221
  | undefined
47178
47222
  event_type: 'phone.deactivated'
47179
47223
  }
47224
+ | {
47225
+ /** ID of the event. */
47226
+ event_id: string
47227
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
47228
+ workspace_id: string
47229
+ /** Date and time at which the event was created. */
47230
+ created_at: string
47231
+ /** Date and time at which the event occurred. */
47232
+ occurred_at: string
47233
+ /** ID of the affected space. */
47234
+ space_id: string
47235
+ /** Type of the event. */
47236
+ event_type: 'space.device_membership_changed'
47237
+ /** Unique key for the space within the workspace. */
47238
+ space_key?: string | undefined
47239
+ /** IDs of all devices currently attached to the space. */
47240
+ device_ids: string[]
47241
+ /** IDs of all ACS entrances currently attached to the space. */
47242
+ acs_entrance_ids: string[]
47243
+ }
47180
47244
  )[]
47181
47245
  }
47182
47246
  }
@@ -68186,6 +68250,7 @@ export type Routes = {
68186
68250
  | 'device.name_changed'
68187
68251
  | 'enrollment_automation.deleted'
68188
68252
  | 'phone.deactivated'
68253
+ | 'space.device_membership_changed'
68189
68254
  )
68190
68255
  | undefined
68191
68256
  /** Types of the events that you want to list. */
@@ -68283,6 +68348,7 @@ export type Routes = {
68283
68348
  | 'device.name_changed'
68284
68349
  | 'enrollment_automation.deleted'
68285
68350
  | 'phone.deactivated'
68351
+ | 'space.device_membership_changed'
68286
68352
  )[]
68287
68353
  | undefined
68288
68354
  /** Numerical limit on the number of events to return. */
@@ -70512,6 +70578,26 @@ export type Routes = {
70512
70578
  | undefined
70513
70579
  event_type: 'phone.deactivated'
70514
70580
  }
70581
+ | {
70582
+ /** ID of the event. */
70583
+ event_id: string
70584
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
70585
+ workspace_id: string
70586
+ /** Date and time at which the event was created. */
70587
+ created_at: string
70588
+ /** Date and time at which the event occurred. */
70589
+ occurred_at: string
70590
+ /** ID of the affected space. */
70591
+ space_id: string
70592
+ /** Type of the event. */
70593
+ event_type: 'space.device_membership_changed'
70594
+ /** Unique key for the space within the workspace. */
70595
+ space_key?: string | undefined
70596
+ /** IDs of all devices currently attached to the space. */
70597
+ device_ids: string[]
70598
+ /** IDs of all ACS entrances currently attached to the space. */
70599
+ acs_entrance_ids: string[]
70600
+ }
70515
70601
  )[]
70516
70602
  }
70517
70603
  }
@@ -104170,6 +104256,26 @@ export type Routes = {
104170
104256
  | undefined
104171
104257
  event_type: 'phone.deactivated'
104172
104258
  }
104259
+ | {
104260
+ /** ID of the event. */
104261
+ event_id: string
104262
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
104263
+ workspace_id: string
104264
+ /** Date and time at which the event was created. */
104265
+ created_at: string
104266
+ /** Date and time at which the event occurred. */
104267
+ occurred_at: string
104268
+ /** ID of the affected space. */
104269
+ space_id: string
104270
+ /** Type of the event. */
104271
+ event_type: 'space.device_membership_changed'
104272
+ /** Unique key for the space within the workspace. */
104273
+ space_key?: string | undefined
104274
+ /** IDs of all devices currently attached to the space. */
104275
+ device_ids: string[]
104276
+ /** IDs of all ACS entrances currently attached to the space. */
104277
+ acs_entrance_ids: string[]
104278
+ }
104173
104279
  )[]
104174
104280
  | undefined
104175
104281
  instant_keys?: