@seamapi/types 1.554.0 → 1.556.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 (27) hide show
  1. package/dist/connect.cjs +128 -108
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +376 -403
  4. package/dist/index.cjs +128 -108
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/access-grants/access-grant.d.ts +54 -0
  7. package/lib/seam/connect/models/access-grants/access-grant.js +24 -0
  8. package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
  9. package/lib/seam/connect/models/access-grants/access-method.d.ts +54 -0
  10. package/lib/seam/connect/models/access-grants/access-method.js +24 -0
  11. package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
  12. package/lib/seam/connect/models/acs/acs-credential.d.ts +10 -10
  13. package/lib/seam/connect/models/batch.d.ts +140 -110
  14. package/lib/seam/connect/models/events/access-methods.d.ts +4 -71
  15. package/lib/seam/connect/models/events/access-methods.js +2 -22
  16. package/lib/seam/connect/models/events/access-methods.js.map +1 -1
  17. package/lib/seam/connect/models/events/seam-event.d.ts +3 -36
  18. package/lib/seam/connect/openapi.d.ts +62 -110
  19. package/lib/seam/connect/openapi.js +65 -69
  20. package/lib/seam/connect/openapi.js.map +1 -1
  21. package/lib/seam/connect/route-types.d.ts +85 -94
  22. package/package.json +1 -1
  23. package/src/lib/seam/connect/models/access-grants/access-grant.ts +40 -0
  24. package/src/lib/seam/connect/models/access-grants/access-method.ts +40 -0
  25. package/src/lib/seam/connect/models/events/access-methods.ts +2 -29
  26. package/src/lib/seam/connect/openapi.ts +77 -74
  27. package/src/lib/seam/connect/route-types.ts +81 -99
@@ -10052,6 +10052,15 @@ export type Routes = {
10052
10052
  starts_at: string;
10053
10053
  /** Date and time at which the Access Grant ends. */
10054
10054
  ends_at: string | null;
10055
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
10056
+ warnings: {
10057
+ /** Date and time at which Seam created the warning. */
10058
+ created_at: string;
10059
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
10060
+ message: string;
10061
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
10062
+ warning_code: 'being_deleted';
10063
+ }[];
10055
10064
  /** ID of the customization profile associated with the Access Grant. */
10056
10065
  customization_profile_id?: string | undefined;
10057
10066
  };
@@ -10127,6 +10136,15 @@ export type Routes = {
10127
10136
  starts_at: string;
10128
10137
  /** Date and time at which the Access Grant ends. */
10129
10138
  ends_at: string | null;
10139
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
10140
+ warnings: {
10141
+ /** Date and time at which Seam created the warning. */
10142
+ created_at: string;
10143
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
10144
+ message: string;
10145
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
10146
+ warning_code: 'being_deleted';
10147
+ }[];
10130
10148
  /** ID of the customization profile associated with the Access Grant. */
10131
10149
  customization_profile_id?: string | undefined;
10132
10150
  };
@@ -11894,6 +11912,15 @@ export type Routes = {
11894
11912
  starts_at: string;
11895
11913
  /** Date and time at which the Access Grant ends. */
11896
11914
  ends_at: string | null;
11915
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
11916
+ warnings: {
11917
+ /** Date and time at which Seam created the warning. */
11918
+ created_at: string;
11919
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11920
+ message: string;
11921
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11922
+ warning_code: 'being_deleted';
11923
+ }[];
11897
11924
  /** ID of the customization profile associated with the Access Grant. */
11898
11925
  customization_profile_id?: string | undefined;
11899
11926
  }[];
@@ -13224,6 +13251,15 @@ export type Routes = {
13224
13251
  is_encoding_required?: boolean | undefined;
13225
13252
  /** The actual PIN code for code access methods. */
13226
13253
  code?: (string | null) | undefined;
13254
+ /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
13255
+ warnings: {
13256
+ /** Date and time at which Seam created the warning. */
13257
+ created_at: string;
13258
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13259
+ message: string;
13260
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13261
+ warning_code: 'being_deleted';
13262
+ }[];
13227
13263
  /** ID of the customization profile associated with the access method. */
13228
13264
  customization_profile_id?: string | undefined;
13229
13265
  };
@@ -17283,6 +17319,15 @@ export type Routes = {
17283
17319
  is_encoding_required?: boolean | undefined;
17284
17320
  /** The actual PIN code for code access methods. */
17285
17321
  code?: (string | null) | undefined;
17322
+ /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
17323
+ warnings: {
17324
+ /** Date and time at which Seam created the warning. */
17325
+ created_at: string;
17326
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17327
+ message: string;
17328
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17329
+ warning_code: 'being_deleted';
17330
+ }[];
17286
17331
  /** ID of the customization profile associated with the access method. */
17287
17332
  customization_profile_id?: string | undefined;
17288
17333
  }[] | undefined;
@@ -17329,6 +17374,15 @@ export type Routes = {
17329
17374
  starts_at: string;
17330
17375
  /** Date and time at which the Access Grant ends. */
17331
17376
  ends_at: string | null;
17377
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
17378
+ warnings: {
17379
+ /** Date and time at which Seam created the warning. */
17380
+ created_at: string;
17381
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17382
+ message: string;
17383
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17384
+ warning_code: 'being_deleted';
17385
+ }[];
17332
17386
  /** ID of the customization profile associated with the Access Grant. */
17333
17387
  customization_profile_id?: string | undefined;
17334
17388
  }[] | undefined;
@@ -17917,24 +17971,6 @@ export type Routes = {
17917
17971
  code?: string | undefined;
17918
17972
  /** Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used). */
17919
17973
  is_backup_code?: boolean | undefined;
17920
- } | {
17921
- /** ID of the event. */
17922
- event_id: string;
17923
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
17924
- workspace_id: string;
17925
- /** Date and time at which the event was created. */
17926
- created_at: string;
17927
- /** Date and time at which the event occurred. */
17928
- occurred_at: string;
17929
- /** ID of the affected access method. */
17930
- access_method_id: string;
17931
- /** IDs of the access grants associated with this access method. */
17932
- access_grant_ids: string[];
17933
- /** Keys of the access grants associated with this access method (if present). */
17934
- access_grant_keys?: string[] | undefined;
17935
- event_type: 'access_method.code_changed';
17936
- /** The new PIN code for code access methods (only present when mode is 'code'). */
17937
- code: string;
17938
17974
  } | {
17939
17975
  /** ID of the event. */
17940
17976
  event_id: string;
@@ -20369,6 +20405,15 @@ export type Routes = {
20369
20405
  is_encoding_required?: boolean | undefined;
20370
20406
  /** The actual PIN code for code access methods. */
20371
20407
  code?: (string | null) | undefined;
20408
+ /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
20409
+ warnings: {
20410
+ /** Date and time at which Seam created the warning. */
20411
+ created_at: string;
20412
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20413
+ message: string;
20414
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20415
+ warning_code: 'being_deleted';
20416
+ }[];
20372
20417
  /** ID of the customization profile associated with the access method. */
20373
20418
  customization_profile_id?: string | undefined;
20374
20419
  }[];
@@ -35913,24 +35958,6 @@ export type Routes = {
35913
35958
  code?: string | undefined;
35914
35959
  /** Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used). */
35915
35960
  is_backup_code?: boolean | undefined;
35916
- } | {
35917
- /** ID of the event. */
35918
- event_id: string;
35919
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
35920
- workspace_id: string;
35921
- /** Date and time at which the event was created. */
35922
- created_at: string;
35923
- /** Date and time at which the event occurred. */
35924
- occurred_at: string;
35925
- /** ID of the affected access method. */
35926
- access_method_id: string;
35927
- /** IDs of the access grants associated with this access method. */
35928
- access_grant_ids: string[];
35929
- /** Keys of the access grants associated with this access method (if present). */
35930
- access_grant_keys?: string[] | undefined;
35931
- event_type: 'access_method.code_changed';
35932
- /** The new PIN code for code access methods (only present when mode is 'code'). */
35933
- code: string;
35934
35961
  } | {
35935
35962
  /** ID of the event. */
35936
35963
  event_id: string;
@@ -37256,9 +37283,9 @@ export type Routes = {
37256
37283
  /** IDs of the access codes for which you want to list events. */
37257
37284
  access_code_ids?: string[] | undefined;
37258
37285
  /** Type of the events that you want to list. */
37259
- 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' | 'access_method.code_changed' | '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' | '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;
37286
+ 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' | '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;
37260
37287
  /** Types of the events that you want to list. */
37261
- 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' | 'access_method.code_changed' | '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' | '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;
37288
+ 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' | '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;
37262
37289
  /** ID of the connected account for which you want to list events. */
37263
37290
  connected_account_id?: string | undefined;
37264
37291
  /** ID of the Connect Webview for which you want to list events. */
@@ -37855,24 +37882,6 @@ export type Routes = {
37855
37882
  code?: string | undefined;
37856
37883
  /** Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used). */
37857
37884
  is_backup_code?: boolean | undefined;
37858
- } | {
37859
- /** ID of the event. */
37860
- event_id: string;
37861
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
37862
- workspace_id: string;
37863
- /** Date and time at which the event was created. */
37864
- created_at: string;
37865
- /** Date and time at which the event occurred. */
37866
- occurred_at: string;
37867
- /** ID of the affected access method. */
37868
- access_method_id: string;
37869
- /** IDs of the access grants associated with this access method. */
37870
- access_grant_ids: string[];
37871
- /** Keys of the access grants associated with this access method (if present). */
37872
- access_grant_keys?: string[] | undefined;
37873
- event_type: 'access_method.code_changed';
37874
- /** The new PIN code for code access methods (only present when mode is 'code'). */
37875
- code: string;
37876
37885
  } | {
37877
37886
  /** ID of the event. */
37878
37887
  event_id: string;
@@ -56367,9 +56376,9 @@ export type Routes = {
56367
56376
  /** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
56368
56377
  between?: (string | Date)[] | undefined;
56369
56378
  /** Type of the events that you want to list. */
56370
- 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' | 'access_method.code_changed' | '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' | '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;
56379
+ 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' | '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;
56371
56380
  /** Types of the events that you want to list. */
56372
- 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' | 'access_method.code_changed' | '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' | '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;
56381
+ 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' | '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;
56373
56382
  /** Numerical limit on the number of events to return. */
56374
56383
  limit?: number;
56375
56384
  };
@@ -56960,24 +56969,6 @@ export type Routes = {
56960
56969
  code?: string | undefined;
56961
56970
  /** Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used). */
56962
56971
  is_backup_code?: boolean | undefined;
56963
- } | {
56964
- /** ID of the event. */
56965
- event_id: string;
56966
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
56967
- workspace_id: string;
56968
- /** Date and time at which the event was created. */
56969
- created_at: string;
56970
- /** Date and time at which the event occurred. */
56971
- occurred_at: string;
56972
- /** ID of the affected access method. */
56973
- access_method_id: string;
56974
- /** IDs of the access grants associated with this access method. */
56975
- access_grant_ids: string[];
56976
- /** Keys of the access grants associated with this access method (if present). */
56977
- access_grant_keys?: string[] | undefined;
56978
- event_type: 'access_method.code_changed';
56979
- /** The new PIN code for code access methods (only present when mode is 'code'). */
56980
- code: string;
56981
56972
  } | {
56982
56973
  /** ID of the event. */
56983
56974
  event_id: string;
@@ -83999,6 +83990,15 @@ export type Routes = {
83999
83990
  is_encoding_required?: boolean | undefined;
84000
83991
  /** The actual PIN code for code access methods. */
84001
83992
  code?: (string | null) | undefined;
83993
+ /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
83994
+ warnings: {
83995
+ /** Date and time at which Seam created the warning. */
83996
+ created_at: string;
83997
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
83998
+ message: string;
83999
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
84000
+ warning_code: 'being_deleted';
84001
+ }[];
84002
84002
  /** ID of the customization profile associated with the access method. */
84003
84003
  customization_profile_id?: string | undefined;
84004
84004
  }[] | undefined;
@@ -84045,6 +84045,15 @@ export type Routes = {
84045
84045
  starts_at: string;
84046
84046
  /** Date and time at which the Access Grant ends. */
84047
84047
  ends_at: string | null;
84048
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
84049
+ warnings: {
84050
+ /** Date and time at which Seam created the warning. */
84051
+ created_at: string;
84052
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
84053
+ message: string;
84054
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
84055
+ warning_code: 'being_deleted';
84056
+ }[];
84048
84057
  /** ID of the customization profile associated with the Access Grant. */
84049
84058
  customization_profile_id?: string | undefined;
84050
84059
  }[] | undefined;
@@ -84633,24 +84642,6 @@ export type Routes = {
84633
84642
  code?: string | undefined;
84634
84643
  /** Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used). */
84635
84644
  is_backup_code?: boolean | undefined;
84636
- } | {
84637
- /** ID of the event. */
84638
- event_id: string;
84639
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
84640
- workspace_id: string;
84641
- /** Date and time at which the event was created. */
84642
- created_at: string;
84643
- /** Date and time at which the event occurred. */
84644
- occurred_at: string;
84645
- /** ID of the affected access method. */
84646
- access_method_id: string;
84647
- /** IDs of the access grants associated with this access method. */
84648
- access_grant_ids: string[];
84649
- /** Keys of the access grants associated with this access method (if present). */
84650
- access_grant_keys?: string[] | undefined;
84651
- event_type: 'access_method.code_changed';
84652
- /** The new PIN code for code access methods (only present when mode is 'code'). */
84653
- code: string;
84654
84645
  } | {
84655
84646
  /** ID of the event. */
84656
84647
  event_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.554.0",
3
+ "version": "1.556.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -2,6 +2,41 @@ import { z } from 'zod'
2
2
 
3
3
  import { requested_access_method } from './requested-access-method.js'
4
4
 
5
+ const common_access_grant_warning = z.object({
6
+ created_at: z
7
+ .string()
8
+ .datetime()
9
+ .describe('Date and time at which Seam created the warning.'),
10
+ message: z
11
+ .string()
12
+ .describe(
13
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
14
+ ),
15
+ })
16
+
17
+ const warning_code_description =
18
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
19
+
20
+ const being_deleted = common_access_grant_warning
21
+ .extend({
22
+ warning_code: z.literal('being_deleted').describe(warning_code_description),
23
+ })
24
+ .describe(
25
+ 'Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.',
26
+ )
27
+
28
+ const access_grant_warning = z
29
+ .discriminatedUnion('warning_code', [being_deleted])
30
+ .describe(
31
+ 'Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
32
+ )
33
+
34
+ const _access_grant_warning_map = z.object({
35
+ being_deleted: being_deleted.optional().nullable(),
36
+ })
37
+
38
+ export type AccessGrantWarningMap = z.infer<typeof _access_grant_warning_map>
39
+
5
40
  export const access_grant = z.object({
6
41
  workspace_id: z
7
42
  .string()
@@ -63,6 +98,11 @@ export const access_grant = z.object({
63
98
  .datetime()
64
99
  .nullable()
65
100
  .describe('Date and time at which the Access Grant ends.'),
101
+ warnings: z
102
+ .array(access_grant_warning)
103
+ .describe(
104
+ 'Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
105
+ ),
66
106
  customization_profile_id: z
67
107
  .string()
68
108
  .uuid()
@@ -1,5 +1,40 @@
1
1
  import { z } from 'zod'
2
2
 
3
+ const common_access_method_warning = z.object({
4
+ created_at: z
5
+ .string()
6
+ .datetime()
7
+ .describe('Date and time at which Seam created the warning.'),
8
+ message: z
9
+ .string()
10
+ .describe(
11
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
12
+ ),
13
+ })
14
+
15
+ const warning_code_description =
16
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
17
+
18
+ const being_deleted = common_access_method_warning
19
+ .extend({
20
+ warning_code: z.literal('being_deleted').describe(warning_code_description),
21
+ })
22
+ .describe(
23
+ 'Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.',
24
+ )
25
+
26
+ const access_method_warning = z
27
+ .discriminatedUnion('warning_code', [being_deleted])
28
+ .describe(
29
+ 'Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
30
+ )
31
+
32
+ const _access_method_warning_map = z.object({
33
+ being_deleted: being_deleted.optional().nullable(),
34
+ })
35
+
36
+ export type AccessMethodWarningMap = z.infer<typeof _access_method_warning_map>
37
+
3
38
  export const access_method = z.object({
4
39
  workspace_id: z
5
40
  .string()
@@ -44,6 +79,11 @@ export const access_method = z.object({
44
79
  .nullable()
45
80
  .optional()
46
81
  .describe('The actual PIN code for code access methods.'),
82
+ warnings: z
83
+ .array(access_method_warning)
84
+ .describe(
85
+ 'Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
86
+ ),
47
87
  customization_profile_id: z
48
88
  .string()
49
89
  .uuid()
@@ -73,39 +73,13 @@ export const access_method_deleted_event = access_method_event.extend({
73
73
  An access method was deleted.
74
74
  `)
75
75
 
76
- export const access_method_reissued_event = access_method_event.extend({
76
+ export const access_method_reissued_event = access_method_issued_event.extend({
77
77
  event_type: z.literal('access_method.reissued'),
78
- code: z
79
- .string()
80
- .optional()
81
- .describe(
82
- "The actual PIN code for code access methods (only present when mode is 'code').",
83
- ),
84
- is_backup_code: z
85
- .boolean()
86
- .optional()
87
- .describe(
88
- "Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used).",
89
- ),
90
- }).describe(`
91
- ---
92
- route_path: /access_methods
93
- ---
94
- An access method was reissued due to an Access Grant update.
95
- `)
96
-
97
- export const access_method_code_changed_event = access_method_event.extend({
98
- event_type: z.literal('access_method.code_changed'),
99
- code: z
100
- .string()
101
- .describe(
102
- "The new PIN code for code access methods (only present when mode is 'code').",
103
- ),
104
78
  }).describe(`
105
79
  ---
106
80
  route_path: /access_methods
107
81
  ---
108
- An access method's PIN code was changed.
82
+ An access method was reissued.
109
83
  `)
110
84
 
111
85
  export type AccessMethodRevokedEvent = z.infer<
@@ -118,5 +92,4 @@ export const access_method_events = [
118
92
  access_method_card_encoding_required_event,
119
93
  access_method_deleted_event,
120
94
  access_method_reissued_event,
121
- access_method_code_changed_event,
122
95
  ] as const