@seamapi/types 1.621.0 → 1.623.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
  };
@@ -57225,10 +57284,11 @@ export type Routes = {
57225
57284
  customer_key: string;
57226
57285
  /** Instance-specific configuration for the connector */
57227
57286
  config: {
57228
- client_token: string;
57229
- access_token: string;
57230
- client: string;
57287
+ client_token?: string | undefined;
57288
+ access_token?: string | undefined;
57289
+ client?: string;
57231
57290
  enterprise_ids?: string[] | undefined;
57291
+ enterprise_id?: string | undefined;
57232
57292
  } | {};
57233
57293
  };
57234
57294
  commonParams: {};
@@ -57279,9 +57339,9 @@ export type Routes = {
57279
57339
  /** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
57280
57340
  between?: (string | Date)[] | undefined;
57281
57341
  /** 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;
57342
+ 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
57343
  /** 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;
57344
+ 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
57345
  /** Numerical limit on the number of events to return. */
57286
57346
  limit?: number;
57287
57347
  };
@@ -59182,6 +59242,25 @@ export type Routes = {
59182
59242
  [x: string]: string | boolean;
59183
59243
  } | undefined;
59184
59244
  event_type: 'phone.deactivated';
59245
+ } | {
59246
+ /** ID of the event. */
59247
+ event_id: string;
59248
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
59249
+ workspace_id: string;
59250
+ /** Date and time at which the event was created. */
59251
+ created_at: string;
59252
+ /** Date and time at which the event occurred. */
59253
+ occurred_at: string;
59254
+ /** ID of the affected space. */
59255
+ space_id: string;
59256
+ /** Type of the event. */
59257
+ event_type: 'space.device_membership_changed';
59258
+ /** Unique key for the space within the workspace. */
59259
+ space_key?: string | undefined;
59260
+ /** IDs of all devices currently attached to the space. */
59261
+ device_ids: string[];
59262
+ /** IDs of all ACS entrances currently attached to the space. */
59263
+ acs_entrance_ids: string[];
59185
59264
  })[];
59186
59265
  };
59187
59266
  };
@@ -59515,19 +59594,6 @@ export type Routes = {
59515
59594
  };
59516
59595
  };
59517
59596
  };
59518
- '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
59519
- route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]';
59520
- method: 'POST';
59521
- queryParams: {};
59522
- jsonBody: {};
59523
- commonParams: {};
59524
- formData: {};
59525
- jsonResponse: {
59526
- success: boolean;
59527
- processed_events: number;
59528
- error?: string | undefined;
59529
- };
59530
- };
59531
59597
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
59532
59598
  route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
59533
59599
  method: 'POST';
@@ -87481,6 +87547,25 @@ export type Routes = {
87481
87547
  [x: string]: string | boolean;
87482
87548
  } | undefined;
87483
87549
  event_type: 'phone.deactivated';
87550
+ } | {
87551
+ /** ID of the event. */
87552
+ event_id: string;
87553
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
87554
+ workspace_id: string;
87555
+ /** Date and time at which the event was created. */
87556
+ created_at: string;
87557
+ /** Date and time at which the event occurred. */
87558
+ occurred_at: string;
87559
+ /** ID of the affected space. */
87560
+ space_id: string;
87561
+ /** Type of the event. */
87562
+ event_type: 'space.device_membership_changed';
87563
+ /** Unique key for the space within the workspace. */
87564
+ space_key?: string | undefined;
87565
+ /** IDs of all devices currently attached to the space. */
87566
+ device_ids: string[];
87567
+ /** IDs of all ACS entrances currently attached to the space. */
87568
+ acs_entrance_ids: string[];
87484
87569
  })[] | undefined;
87485
87570
  instant_keys?: {
87486
87571
  /** 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.623.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
  },
@@ -52395,14 +52477,18 @@ export default {
52395
52477
  {
52396
52478
  properties: {
52397
52479
  access_token: { minLength: 1, type: 'string' },
52398
- client: { minLength: 1, type: 'string' },
52480
+ client: {
52481
+ default: 'seam',
52482
+ minLength: 1,
52483
+ type: 'string',
52484
+ },
52399
52485
  client_token: { minLength: 1, type: 'string' },
52486
+ enterprise_id: { format: 'uuid', type: 'string' },
52400
52487
  enterprise_ids: {
52401
52488
  items: { format: 'uuid', type: 'string' },
52402
52489
  type: 'array',
52403
52490
  },
52404
52491
  },
52405
- required: ['client_token', 'access_token', 'client'],
52406
52492
  type: 'object',
52407
52493
  },
52408
52494
  { properties: {}, type: 'object' },
@@ -52689,6 +52775,7 @@ export default {
52689
52775
  'device.name_changed',
52690
52776
  'enrollment_automation.deleted',
52691
52777
  'phone.deactivated',
52778
+ 'space.device_membership_changed',
52692
52779
  ],
52693
52780
  type: 'string',
52694
52781
  },
@@ -52793,6 +52880,7 @@ export default {
52793
52880
  'device.name_changed',
52794
52881
  'enrollment_automation.deleted',
52795
52882
  'phone.deactivated',
52883
+ 'space.device_membership_changed',
52796
52884
  ],
52797
52885
  type: 'string',
52798
52886
  },
@@ -52960,6 +53048,7 @@ export default {
52960
53048
  'device.name_changed',
52961
53049
  'enrollment_automation.deleted',
52962
53050
  'phone.deactivated',
53051
+ 'space.device_membership_changed',
52963
53052
  ],
52964
53053
  type: 'string',
52965
53054
  },
@@ -53059,6 +53148,7 @@ export default {
53059
53148
  'device.name_changed',
53060
53149
  'enrollment_automation.deleted',
53061
53150
  'phone.deactivated',
53151
+ 'space.device_membership_changed',
53062
53152
  ],
53063
53153
  type: 'string',
53064
53154
  },
@@ -54875,59 +54965,6 @@ export default {
54875
54965
  'x-undocumented': 'Internal endpoint for customer portals.',
54876
54966
  },
54877
54967
  },
54878
- '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
54879
- post: {
54880
- description:
54881
- 'Receives webhook events from external connector APIs and processes them into partner resources.',
54882
- operationId:
54883
- 'seamCustomerV1WebhooksConnectorsByWorkspaceIdByConnectorIdPost',
54884
- requestBody: {
54885
- content: {
54886
- 'application/json': { schema: { properties: {}, type: 'object' } },
54887
- },
54888
- },
54889
- responses: {
54890
- 200: {
54891
- content: {
54892
- 'application/json': {
54893
- schema: {
54894
- properties: {
54895
- error: { type: 'string' },
54896
- ok: { type: 'boolean' },
54897
- processed_events: { format: 'float', type: 'number' },
54898
- success: { type: 'boolean' },
54899
- },
54900
- required: ['success', 'processed_events', 'ok'],
54901
- type: 'object',
54902
- },
54903
- },
54904
- },
54905
- description: 'OK',
54906
- },
54907
- 400: { description: 'Bad Request' },
54908
- 401: { description: 'Unauthorized' },
54909
- },
54910
- security: [
54911
- { pat_with_workspace: [] },
54912
- { console_session_with_workspace: [] },
54913
- { api_key: [] },
54914
- ],
54915
- summary:
54916
- '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]',
54917
- tags: ['/webhooks'],
54918
- 'x-fern-sdk-group-name': [
54919
- 'seam',
54920
- 'customer',
54921
- 'v1',
54922
- 'webhooks',
54923
- 'connectors',
54924
- '[workspace_id]',
54925
- ],
54926
- 'x-fern-sdk-method-name': 'by_connector_id',
54927
- 'x-response-key': null,
54928
- 'x-title': 'Connector Webhook Endpoint',
54929
- },
54930
- },
54931
54968
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
54932
54969
  post: {
54933
54970
  description: