@seamapi/types 1.918.0 → 1.920.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.
Files changed (37) hide show
  1. package/dist/connect.cjs +592 -184
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +210 -4
  4. package/dist/index.cjs +592 -184
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/access-codes/managed-access-code.js +78 -44
  7. package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
  8. package/lib/seam/connect/models/acs/acs-access-group.js +7 -4
  9. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-encoder.js +7 -3
  11. package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
  12. package/lib/seam/connect/models/acs/acs-system.js +58 -31
  13. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  14. package/lib/seam/connect/models/acs/acs-users/acs-user.js +42 -24
  15. package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
  16. package/lib/seam/connect/models/connected-accounts/connected-account.js +29 -19
  17. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  18. package/lib/seam/connect/models/devices/device.js +51 -27
  19. package/lib/seam/connect/models/devices/device.js.map +1 -1
  20. package/lib/seam/connect/models/events/access-codes.d.ts +118 -0
  21. package/lib/seam/connect/models/events/access-codes.js +34 -0
  22. package/lib/seam/connect/models/events/access-codes.js.map +1 -1
  23. package/lib/seam/connect/models/events/seam-event.d.ts +59 -1
  24. package/lib/seam/connect/openapi.js +230 -3
  25. package/lib/seam/connect/openapi.js.map +1 -1
  26. package/lib/seam/connect/route-types.d.ts +152 -4
  27. package/package.json +1 -1
  28. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +136 -114
  29. package/src/lib/seam/connect/models/acs/acs-access-group.ts +10 -9
  30. package/src/lib/seam/connect/models/acs/acs-encoder.ts +7 -5
  31. package/src/lib/seam/connect/models/acs/acs-system.ts +73 -56
  32. package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +48 -40
  33. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +78 -73
  34. package/src/lib/seam/connect/models/devices/device.ts +70 -46
  35. package/src/lib/seam/connect/models/events/access-codes.ts +48 -0
  36. package/src/lib/seam/connect/openapi.ts +239 -3
  37. package/src/lib/seam/connect/route-types.ts +212 -0
@@ -45442,6 +45442,43 @@ export type Routes = {
45442
45442
  };
45443
45443
  /** Human-readable description of the change and its source. */
45444
45444
  description: string;
45445
+ } | {
45446
+ /** ID of the event. */
45447
+ event_id: string;
45448
+ /** ID of the workspace associated with the event. */
45449
+ workspace_id: string;
45450
+ /** Date and time at which the event was created. */
45451
+ created_at: string;
45452
+ /** Date and time at which the event occurred. */
45453
+ occurred_at: string;
45454
+ /** ID of the affected access code. */
45455
+ access_code_id: string;
45456
+ /** ID of the device associated with the affected access code. */
45457
+ device_id: string;
45458
+ /** ID of the connected account associated with the affected access code. */
45459
+ connected_account_id: string;
45460
+ /** Custom metadata of the device, present when device_id is provided. */
45461
+ device_custom_metadata?: {
45462
+ [x: string]: string | boolean;
45463
+ } | undefined;
45464
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
45465
+ connected_account_custom_metadata?: {
45466
+ [x: string]: string | boolean;
45467
+ } | undefined;
45468
+ event_type: 'access_code.mutations_requested';
45469
+ /** Array of mutations requested on the access code, each containing the mutation type and from/to values. */
45470
+ requested_mutations: {
45471
+ /** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */
45472
+ mutation_code: 'updating_name' | 'updating_code' | 'updating_time_frame' | 'deleting' | 'creating' | 'deferring_creation';
45473
+ /** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
45474
+ from?: {
45475
+ [x: string]: unknown;
45476
+ } | undefined;
45477
+ /** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
45478
+ to?: {
45479
+ [x: string]: unknown;
45480
+ } | undefined;
45481
+ }[];
45445
45482
  } | {
45446
45483
  /** ID of the event. */
45447
45484
  event_id: string;
@@ -48233,9 +48270,9 @@ export type Routes = {
48233
48270
  /** IDs of the access codes for which you want to list events. */
48234
48271
  access_code_ids?: string[] | undefined;
48235
48272
  /** Type of the events that you want to list. */
48236
- event_type?: ('access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_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_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | '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' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.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' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted') | undefined;
48273
+ event_type?: ('access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | 'access_code.mutations_requested' | '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_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | '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' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.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' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted') | undefined;
48237
48274
  /** Types of the events that you want to list. */
48238
- event_types?: ('access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_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_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | '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' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.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' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted')[] | undefined;
48275
+ event_types?: ('access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | 'access_code.mutations_requested' | '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_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | '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' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.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' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted')[] | undefined;
48239
48276
  /** ID of the connected account for which you want to list events. */
48240
48277
  connected_account_id?: string | undefined;
48241
48278
  /** ID of the Connect Webview for which you want to list events. */
@@ -48442,6 +48479,43 @@ export type Routes = {
48442
48479
  };
48443
48480
  /** Human-readable description of the change and its source. */
48444
48481
  description: string;
48482
+ } | {
48483
+ /** ID of the event. */
48484
+ event_id: string;
48485
+ /** ID of the workspace associated with the event. */
48486
+ workspace_id: string;
48487
+ /** Date and time at which the event was created. */
48488
+ created_at: string;
48489
+ /** Date and time at which the event occurred. */
48490
+ occurred_at: string;
48491
+ /** ID of the affected access code. */
48492
+ access_code_id: string;
48493
+ /** ID of the device associated with the affected access code. */
48494
+ device_id: string;
48495
+ /** ID of the connected account associated with the affected access code. */
48496
+ connected_account_id: string;
48497
+ /** Custom metadata of the device, present when device_id is provided. */
48498
+ device_custom_metadata?: {
48499
+ [x: string]: string | boolean;
48500
+ } | undefined;
48501
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
48502
+ connected_account_custom_metadata?: {
48503
+ [x: string]: string | boolean;
48504
+ } | undefined;
48505
+ event_type: 'access_code.mutations_requested';
48506
+ /** Array of mutations requested on the access code, each containing the mutation type and from/to values. */
48507
+ requested_mutations: {
48508
+ /** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */
48509
+ mutation_code: 'updating_name' | 'updating_code' | 'updating_time_frame' | 'deleting' | 'creating' | 'deferring_creation';
48510
+ /** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
48511
+ from?: {
48512
+ [x: string]: unknown;
48513
+ } | undefined;
48514
+ /** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
48515
+ to?: {
48516
+ [x: string]: unknown;
48517
+ } | undefined;
48518
+ }[];
48445
48519
  } | {
48446
48520
  /** ID of the event. */
48447
48521
  event_id: string;
@@ -77099,9 +77173,9 @@ export type Routes = {
77099
77173
  /** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
77100
77174
  between?: (string | Date)[] | undefined;
77101
77175
  /** Type of the events that you want to list. */
77102
- event_type?: ('access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_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_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | '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' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.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' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted') | undefined;
77176
+ event_type?: ('access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | 'access_code.mutations_requested' | '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_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | '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' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.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' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted') | undefined;
77103
77177
  /** Types of the events that you want to list. */
77104
- event_types?: ('access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_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_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | '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' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.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' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted')[] | undefined;
77178
+ event_types?: ('access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | 'access_code.mutations_requested' | '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_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | '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' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.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' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted')[] | undefined;
77105
77179
  /** Numerical limit on the number of events to return. */
77106
77180
  limit?: number;
77107
77181
  };
@@ -77278,6 +77352,43 @@ export type Routes = {
77278
77352
  };
77279
77353
  /** Human-readable description of the change and its source. */
77280
77354
  description: string;
77355
+ } | {
77356
+ /** ID of the event. */
77357
+ event_id: string;
77358
+ /** ID of the workspace associated with the event. */
77359
+ workspace_id: string;
77360
+ /** Date and time at which the event was created. */
77361
+ created_at: string;
77362
+ /** Date and time at which the event occurred. */
77363
+ occurred_at: string;
77364
+ /** ID of the affected access code. */
77365
+ access_code_id: string;
77366
+ /** ID of the device associated with the affected access code. */
77367
+ device_id: string;
77368
+ /** ID of the connected account associated with the affected access code. */
77369
+ connected_account_id: string;
77370
+ /** Custom metadata of the device, present when device_id is provided. */
77371
+ device_custom_metadata?: {
77372
+ [x: string]: string | boolean;
77373
+ } | undefined;
77374
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
77375
+ connected_account_custom_metadata?: {
77376
+ [x: string]: string | boolean;
77377
+ } | undefined;
77378
+ event_type: 'access_code.mutations_requested';
77379
+ /** Array of mutations requested on the access code, each containing the mutation type and from/to values. */
77380
+ requested_mutations: {
77381
+ /** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */
77382
+ mutation_code: 'updating_name' | 'updating_code' | 'updating_time_frame' | 'deleting' | 'creating' | 'deferring_creation';
77383
+ /** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
77384
+ from?: {
77385
+ [x: string]: unknown;
77386
+ } | undefined;
77387
+ /** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
77388
+ to?: {
77389
+ [x: string]: unknown;
77390
+ } | undefined;
77391
+ }[];
77281
77392
  } | {
77282
77393
  /** ID of the event. */
77283
77394
  event_id: string;
@@ -114435,6 +114546,43 @@ export type Routes = {
114435
114546
  };
114436
114547
  /** Human-readable description of the change and its source. */
114437
114548
  description: string;
114549
+ } | {
114550
+ /** ID of the event. */
114551
+ event_id: string;
114552
+ /** ID of the workspace associated with the event. */
114553
+ workspace_id: string;
114554
+ /** Date and time at which the event was created. */
114555
+ created_at: string;
114556
+ /** Date and time at which the event occurred. */
114557
+ occurred_at: string;
114558
+ /** ID of the affected access code. */
114559
+ access_code_id: string;
114560
+ /** ID of the device associated with the affected access code. */
114561
+ device_id: string;
114562
+ /** ID of the connected account associated with the affected access code. */
114563
+ connected_account_id: string;
114564
+ /** Custom metadata of the device, present when device_id is provided. */
114565
+ device_custom_metadata?: {
114566
+ [x: string]: string | boolean;
114567
+ } | undefined;
114568
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
114569
+ connected_account_custom_metadata?: {
114570
+ [x: string]: string | boolean;
114571
+ } | undefined;
114572
+ event_type: 'access_code.mutations_requested';
114573
+ /** Array of mutations requested on the access code, each containing the mutation type and from/to values. */
114574
+ requested_mutations: {
114575
+ /** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */
114576
+ mutation_code: 'updating_name' | 'updating_code' | 'updating_time_frame' | 'deleting' | 'creating' | 'deferring_creation';
114577
+ /** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
114578
+ from?: {
114579
+ [x: string]: unknown;
114580
+ } | undefined;
114581
+ /** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
114582
+ to?: {
114583
+ [x: string]: unknown;
114584
+ } | undefined;
114585
+ }[];
114438
114586
  } | {
114439
114587
  /** ID of the event. */
114440
114588
  event_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.918.0",
3
+ "version": "1.920.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -22,13 +22,14 @@ const common_access_code_error = z.object({
22
22
  const error_code_description =
23
23
  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
24
24
 
25
- const provider_issue = common_access_code_error
26
- .extend({
27
- error_code: z.literal('provider_issue').describe(error_code_description),
28
- })
29
- .describe(
30
- 'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.',
31
- )
25
+ const provider_issue = common_access_code_error.extend({
26
+ error_code: z.literal('provider_issue').describe(error_code_description),
27
+ }).describe(`
28
+ ---
29
+ resource_type: access_code
30
+ ---
31
+ Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.
32
+ `)
32
33
 
33
34
  const modified_field = z.object({
34
35
  field: z
@@ -40,111 +41,130 @@ const modified_field = z.object({
40
41
  to: z.string().nullable().describe('The new value of the field.'),
41
42
  })
42
43
 
43
- const code_modified_external_to_seam_error = common_access_code_error
44
- .extend({
45
- error_code: z
46
- .literal('code_modified_external_to_seam')
47
- .describe(error_code_description),
48
- change_type: z
49
- .enum(['modified', 'removed'])
50
- .optional()
51
- .describe(
52
- "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
53
- ),
54
- modified_fields: z
55
- .array(modified_field)
56
- .optional()
57
- .describe(
58
- 'List of fields that were changed externally, with their previous and new values.',
59
- ),
60
- })
61
- .describe(
62
- 'Code was modified or removed externally after Seam successfully set it on the device.',
63
- )
64
-
65
- const failed_to_set_on_device = common_access_code_error
66
- .extend({
67
- error_code: z
68
- .literal('failed_to_set_on_device')
69
- .describe(error_code_description),
70
- })
71
- .describe('Failed to set code on device.')
44
+ const code_modified_external_to_seam_error = common_access_code_error.extend({
45
+ error_code: z
46
+ .literal('code_modified_external_to_seam')
47
+ .describe(error_code_description),
48
+ change_type: z
49
+ .enum(['modified', 'removed'])
50
+ .optional()
51
+ .describe(
52
+ "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
53
+ ),
54
+ modified_fields: z
55
+ .array(modified_field)
56
+ .optional()
57
+ .describe(
58
+ 'List of fields that were changed externally, with their previous and new values.',
59
+ ),
60
+ }).describe(`
61
+ ---
62
+ resource_type: access_code
63
+ ---
64
+ Code was modified or removed externally after Seam successfully set it on the device.
65
+ `)
72
66
 
73
- const failed_to_remove_from_device = common_access_code_error
74
- .extend({
75
- error_code: z
76
- .literal('failed_to_remove_from_device')
77
- .describe(error_code_description),
78
- })
79
- .describe('Failed to remove code from device.')
67
+ const failed_to_set_on_device = common_access_code_error.extend({
68
+ error_code: z
69
+ .literal('failed_to_set_on_device')
70
+ .describe(error_code_description),
71
+ }).describe(`
72
+ ---
73
+ resource_type: access_code
74
+ ---
75
+ Failed to set code on device.
76
+ `)
80
77
 
81
- const duplicate_code_on_device = common_access_code_error
82
- .extend({
83
- error_code: z
84
- .literal('duplicate_code_on_device')
85
- .describe(error_code_description),
86
- unmanaged_access_code_id: z
87
- .string()
88
- .uuid()
89
- .optional()
90
- .describe(
91
- 'ID of the unmanaged access code that conflicts with this managed access code, when Seam can identify it.',
92
- ),
93
- managed_access_code_id: z
94
- .string()
95
- .uuid()
96
- .optional()
97
- .describe(
98
- 'ID of the managed access code that conflicts with this managed access code, when Seam can identify it.',
99
- ),
100
- })
101
- .describe('Duplicate access code detected on device.')
78
+ const failed_to_remove_from_device = common_access_code_error.extend({
79
+ error_code: z
80
+ .literal('failed_to_remove_from_device')
81
+ .describe(error_code_description),
82
+ }).describe(`
83
+ ---
84
+ resource_type: access_code
85
+ ---
86
+ Failed to remove code from device.
87
+ `)
88
+
89
+ const duplicate_code_on_device = common_access_code_error.extend({
90
+ error_code: z
91
+ .literal('duplicate_code_on_device')
92
+ .describe(error_code_description),
93
+ unmanaged_access_code_id: z
94
+ .string()
95
+ .uuid()
96
+ .optional()
97
+ .describe(
98
+ 'ID of the unmanaged access code that conflicts with this managed access code, when Seam can identify it.',
99
+ ),
100
+ managed_access_code_id: z
101
+ .string()
102
+ .uuid()
103
+ .optional()
104
+ .describe(
105
+ 'ID of the managed access code that conflicts with this managed access code, when Seam can identify it.',
106
+ ),
107
+ }).describe(`
108
+ ---
109
+ resource_type: access_code
110
+ ---
111
+ Duplicate access code detected on device.
112
+ `)
102
113
 
103
- const duplicate_code_attempt_prevented = common_access_code_error
104
- .extend({
105
- error_code: z
106
- .literal('duplicate_code_attempt_prevented')
107
- .describe(error_code_description),
108
- })
109
- .describe('An attempt to modify this access code was prevented.')
114
+ const duplicate_code_attempt_prevented = common_access_code_error.extend({
115
+ error_code: z
116
+ .literal('duplicate_code_attempt_prevented')
117
+ .describe(error_code_description),
118
+ }).describe(`
119
+ ---
120
+ resource_type: access_code
121
+ ---
122
+ An attempt to modify this access code was prevented.
123
+ `)
110
124
 
111
- const no_space_for_access_code_on_device = common_access_code_error
112
- .extend({
113
- error_code: z
114
- .literal('no_space_for_access_code_on_device')
115
- .describe(error_code_description),
116
- })
117
- .describe('No space for access code on device.')
125
+ const no_space_for_access_code_on_device = common_access_code_error.extend({
126
+ error_code: z
127
+ .literal('no_space_for_access_code_on_device')
128
+ .describe(error_code_description),
129
+ }).describe(`
130
+ ---
131
+ resource_type: access_code
132
+ ---
133
+ No space for access code on device.
134
+ `)
118
135
 
119
- const access_code_state_unconfirmed = common_access_code_error
120
- .extend({
121
- error_code: z
122
- .literal('access_code_state_unconfirmed')
123
- .describe(error_code_description),
124
- })
125
- .describe(
126
- 'Indicates that the provider cannot confirm whether the access code was set or removed on the device.',
127
- )
136
+ const access_code_state_unconfirmed = common_access_code_error.extend({
137
+ error_code: z
138
+ .literal('access_code_state_unconfirmed')
139
+ .describe(error_code_description),
140
+ }).describe(`
141
+ ---
142
+ resource_type: access_code
143
+ ---
144
+ Indicates that the provider cannot confirm whether the access code was set or removed on the device.
145
+ `)
128
146
 
129
- const insufficient_permissions = common_access_code_error
130
- .extend({
131
- error_code: z
132
- .literal('insufficient_permissions')
133
- .describe(error_code_description),
134
- })
135
- .describe(
136
- 'Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.',
137
- )
147
+ const insufficient_permissions = common_access_code_error.extend({
148
+ error_code: z
149
+ .literal('insufficient_permissions')
150
+ .describe(error_code_description),
151
+ }).describe(`
152
+ ---
153
+ resource_type: access_code
154
+ ---
155
+ Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.
156
+ `)
138
157
 
139
- const access_code_inactive_error = common_access_code_error
140
- .extend({
141
- error_code: z
142
- .literal('access_code_inactive')
143
- .describe(error_code_description),
144
- })
145
- .describe(
146
- 'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
147
- )
158
+ const access_code_inactive_error = common_access_code_error.extend({
159
+ error_code: z
160
+ .literal('access_code_inactive')
161
+ .describe(error_code_description),
162
+ }).describe(`
163
+ ---
164
+ resource_type: access_code
165
+ ---
166
+ Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.
167
+ `)
148
168
 
149
169
  const salto_ks_user_not_subscribed = common_access_code_error
150
170
  .extend({
@@ -155,21 +175,23 @@ const salto_ks_user_not_subscribed = common_access_code_error
155
175
  .describe(
156
176
  `
157
177
  ---
178
+ resource_type: access_code
158
179
  deprecated: Use \`access_code_inactive\` instead.
159
180
  ---
160
181
  Salto site user is not subscribed.
161
182
  `,
162
183
  )
163
184
 
164
- const replaced_by_newer_access_code = common_access_code_error
165
- .extend({
166
- error_code: z
167
- .literal('replaced_by_newer_access_code')
168
- .describe(error_code_description),
169
- })
170
- .describe(
171
- 'This access code was overridden on the device by a newer access code programmed to the same slot.',
172
- )
185
+ const replaced_by_newer_access_code = common_access_code_error.extend({
186
+ error_code: z
187
+ .literal('replaced_by_newer_access_code')
188
+ .describe(error_code_description),
189
+ }).describe(`
190
+ ---
191
+ resource_type: access_code
192
+ ---
193
+ This access code was overridden on the device by a newer access code programmed to the same slot.
194
+ `)
173
195
 
174
196
  const access_code_error = z
175
197
  .discriminatedUnion('error_code', [
@@ -35,15 +35,16 @@ const error_code_description =
35
35
  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
36
36
 
37
37
  const acs_access_groups_failed_to_create_on_acs_system =
38
- common_acs_access_group_error
39
- .extend({
40
- error_code: z
41
- .literal('failed_to_create_on_acs_system')
42
- .describe(error_code_description),
43
- })
44
- .describe(
45
- `Indicates that the [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
46
- )
38
+ common_acs_access_group_error.extend({
39
+ error_code: z
40
+ .literal('failed_to_create_on_acs_system')
41
+ .describe(error_code_description),
42
+ }).describe(`
43
+ ---
44
+ resource_type: acs_access_group
45
+ ---
46
+ Indicates that the [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
47
+ `)
47
48
 
48
49
  const acs_access_group_errors = z
49
50
  .discriminatedUnion('error_code', [
@@ -21,11 +21,13 @@ const acs_encoder_removed = common_acs_encoder_error.extend({
21
21
 
22
22
  const acs_encoder_error =
23
23
  // z.union([
24
- acs_encoder_removed
25
- // ])
26
- .describe(
27
- 'Error associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
28
- )
24
+ // ])
25
+ acs_encoder_removed.describe(`
26
+ ---
27
+ resource_type: acs_encoder
28
+ ---
29
+ Error associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
30
+ `)
29
31
 
30
32
  const _acs_encoder_error_map = z.object({
31
33
  acs_encoder_removed: acs_encoder_removed.optional().nullable(),