@seamapi/types 1.553.0 → 1.555.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 (31) hide show
  1. package/dist/connect.cjs +281 -19
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +928 -4
  4. package/dist/index.cjs +281 -19
  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 +344 -0
  14. package/lib/seam/connect/models/events/access-grants.d.ts +66 -0
  15. package/lib/seam/connect/models/events/access-grants.js +21 -0
  16. package/lib/seam/connect/models/events/access-grants.js.map +1 -1
  17. package/lib/seam/connect/models/events/access-methods.d.ts +65 -0
  18. package/lib/seam/connect/models/events/access-methods.js +12 -0
  19. package/lib/seam/connect/models/events/access-methods.js.map +1 -1
  20. package/lib/seam/connect/models/events/seam-event.d.ts +65 -1
  21. package/lib/seam/connect/openapi.d.ts +379 -0
  22. package/lib/seam/connect/openapi.js +196 -0
  23. package/lib/seam/connect/openapi.js.map +1 -1
  24. package/lib/seam/connect/route-types.d.ts +265 -4
  25. package/package.json +1 -1
  26. package/src/lib/seam/connect/models/access-grants/access-grant.ts +40 -0
  27. package/src/lib/seam/connect/models/access-grants/access-method.ts +40 -0
  28. package/src/lib/seam/connect/models/events/access-grants.ts +27 -0
  29. package/src/lib/seam/connect/models/events/access-methods.ts +15 -0
  30. package/src/lib/seam/connect/openapi.ts +213 -0
  31. package/src/lib/seam/connect/route-types.ts +279 -0
@@ -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;
@@ -17811,6 +17865,24 @@ export type Routes = {
17811
17865
  event_type: 'access_grant.access_to_door_lost';
17812
17866
  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
17813
17867
  acs_entrance_id: string;
17868
+ } | {
17869
+ /** ID of the event. */
17870
+ event_id: string;
17871
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
17872
+ workspace_id: string;
17873
+ /** Date and time at which the event was created. */
17874
+ created_at: string;
17875
+ /** Date and time at which the event occurred. */
17876
+ occurred_at: string;
17877
+ /** ID of the affected Access Grant. */
17878
+ access_grant_id: string;
17879
+ event_type: 'access_grant.access_times_changed';
17880
+ /** Key of the affected Access Grant (if present). */
17881
+ access_grant_key?: string | undefined;
17882
+ /** The new start time for the access grant. */
17883
+ starts_at?: string | undefined;
17884
+ /** The new end time for the access grant. */
17885
+ ends_at?: string | undefined;
17814
17886
  } | {
17815
17887
  /** ID of the event. */
17816
17888
  event_id: string;
@@ -17899,6 +17971,24 @@ export type Routes = {
17899
17971
  code?: string | undefined;
17900
17972
  /** Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used). */
17901
17973
  is_backup_code?: boolean | undefined;
17974
+ } | {
17975
+ /** ID of the event. */
17976
+ event_id: string;
17977
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
17978
+ workspace_id: string;
17979
+ /** Date and time at which the event was created. */
17980
+ created_at: string;
17981
+ /** Date and time at which the event occurred. */
17982
+ occurred_at: string;
17983
+ /** ID of the affected access method. */
17984
+ access_method_id: string;
17985
+ /** IDs of the access grants associated with this access method. */
17986
+ access_grant_ids: string[];
17987
+ /** Keys of the access grants associated with this access method (if present). */
17988
+ access_grant_keys?: string[] | undefined;
17989
+ event_type: 'access_method.code_changed';
17990
+ /** The new PIN code for code access methods (only present when mode is 'code'). */
17991
+ code: string;
17902
17992
  } | {
17903
17993
  /** ID of the event. */
17904
17994
  event_id: string;
@@ -20333,6 +20423,15 @@ export type Routes = {
20333
20423
  is_encoding_required?: boolean | undefined;
20334
20424
  /** The actual PIN code for code access methods. */
20335
20425
  code?: (string | null) | undefined;
20426
+ /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
20427
+ warnings: {
20428
+ /** Date and time at which Seam created the warning. */
20429
+ created_at: string;
20430
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20431
+ message: string;
20432
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20433
+ warning_code: 'being_deleted';
20434
+ }[];
20336
20435
  /** ID of the customization profile associated with the access method. */
20337
20436
  customization_profile_id?: string | undefined;
20338
20437
  }[];
@@ -35771,6 +35870,24 @@ export type Routes = {
35771
35870
  event_type: 'access_grant.access_to_door_lost';
35772
35871
  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
35773
35872
  acs_entrance_id: string;
35873
+ } | {
35874
+ /** ID of the event. */
35875
+ event_id: string;
35876
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
35877
+ workspace_id: string;
35878
+ /** Date and time at which the event was created. */
35879
+ created_at: string;
35880
+ /** Date and time at which the event occurred. */
35881
+ occurred_at: string;
35882
+ /** ID of the affected Access Grant. */
35883
+ access_grant_id: string;
35884
+ event_type: 'access_grant.access_times_changed';
35885
+ /** Key of the affected Access Grant (if present). */
35886
+ access_grant_key?: string | undefined;
35887
+ /** The new start time for the access grant. */
35888
+ starts_at?: string | undefined;
35889
+ /** The new end time for the access grant. */
35890
+ ends_at?: string | undefined;
35774
35891
  } | {
35775
35892
  /** ID of the event. */
35776
35893
  event_id: string;
@@ -35859,6 +35976,24 @@ export type Routes = {
35859
35976
  code?: string | undefined;
35860
35977
  /** Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used). */
35861
35978
  is_backup_code?: boolean | undefined;
35979
+ } | {
35980
+ /** ID of the event. */
35981
+ event_id: string;
35982
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
35983
+ workspace_id: string;
35984
+ /** Date and time at which the event was created. */
35985
+ created_at: string;
35986
+ /** Date and time at which the event occurred. */
35987
+ occurred_at: string;
35988
+ /** ID of the affected access method. */
35989
+ access_method_id: string;
35990
+ /** IDs of the access grants associated with this access method. */
35991
+ access_grant_ids: string[];
35992
+ /** Keys of the access grants associated with this access method (if present). */
35993
+ access_grant_keys?: string[] | undefined;
35994
+ event_type: 'access_method.code_changed';
35995
+ /** The new PIN code for code access methods (only present when mode is 'code'). */
35996
+ code: string;
35862
35997
  } | {
35863
35998
  /** ID of the event. */
35864
35999
  event_id: string;
@@ -37184,9 +37319,9 @@ export type Routes = {
37184
37319
  /** IDs of the access codes for which you want to list events. */
37185
37320
  access_code_ids?: string[] | undefined;
37186
37321
  /** Type of the events that you want to list. */
37187
- 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_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;
37322
+ 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;
37188
37323
  /** Types of the events that you want to list. */
37189
- 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_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;
37324
+ 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;
37190
37325
  /** ID of the connected account for which you want to list events. */
37191
37326
  connected_account_id?: string | undefined;
37192
37327
  /** ID of the Connect Webview for which you want to list events. */
@@ -37677,6 +37812,24 @@ export type Routes = {
37677
37812
  event_type: 'access_grant.access_to_door_lost';
37678
37813
  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
37679
37814
  acs_entrance_id: string;
37815
+ } | {
37816
+ /** ID of the event. */
37817
+ event_id: string;
37818
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
37819
+ workspace_id: string;
37820
+ /** Date and time at which the event was created. */
37821
+ created_at: string;
37822
+ /** Date and time at which the event occurred. */
37823
+ occurred_at: string;
37824
+ /** ID of the affected Access Grant. */
37825
+ access_grant_id: string;
37826
+ event_type: 'access_grant.access_times_changed';
37827
+ /** Key of the affected Access Grant (if present). */
37828
+ access_grant_key?: string | undefined;
37829
+ /** The new start time for the access grant. */
37830
+ starts_at?: string | undefined;
37831
+ /** The new end time for the access grant. */
37832
+ ends_at?: string | undefined;
37680
37833
  } | {
37681
37834
  /** ID of the event. */
37682
37835
  event_id: string;
@@ -37765,6 +37918,24 @@ export type Routes = {
37765
37918
  code?: string | undefined;
37766
37919
  /** Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used). */
37767
37920
  is_backup_code?: boolean | undefined;
37921
+ } | {
37922
+ /** ID of the event. */
37923
+ event_id: string;
37924
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
37925
+ workspace_id: string;
37926
+ /** Date and time at which the event was created. */
37927
+ created_at: string;
37928
+ /** Date and time at which the event occurred. */
37929
+ occurred_at: string;
37930
+ /** ID of the affected access method. */
37931
+ access_method_id: string;
37932
+ /** IDs of the access grants associated with this access method. */
37933
+ access_grant_ids: string[];
37934
+ /** Keys of the access grants associated with this access method (if present). */
37935
+ access_grant_keys?: string[] | undefined;
37936
+ event_type: 'access_method.code_changed';
37937
+ /** The new PIN code for code access methods (only present when mode is 'code'). */
37938
+ code: string;
37768
37939
  } | {
37769
37940
  /** ID of the event. */
37770
37941
  event_id: string;
@@ -56259,9 +56430,9 @@ export type Routes = {
56259
56430
  /** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
56260
56431
  between?: (string | Date)[] | undefined;
56261
56432
  /** Type of the events that you want to list. */
56262
- 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_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;
56433
+ 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;
56263
56434
  /** Types of the events that you want to list. */
56264
- 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_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;
56435
+ 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;
56265
56436
  /** Numerical limit on the number of events to return. */
56266
56437
  limit?: number;
56267
56438
  };
@@ -56746,6 +56917,24 @@ export type Routes = {
56746
56917
  event_type: 'access_grant.access_to_door_lost';
56747
56918
  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
56748
56919
  acs_entrance_id: string;
56920
+ } | {
56921
+ /** ID of the event. */
56922
+ event_id: string;
56923
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
56924
+ workspace_id: string;
56925
+ /** Date and time at which the event was created. */
56926
+ created_at: string;
56927
+ /** Date and time at which the event occurred. */
56928
+ occurred_at: string;
56929
+ /** ID of the affected Access Grant. */
56930
+ access_grant_id: string;
56931
+ event_type: 'access_grant.access_times_changed';
56932
+ /** Key of the affected Access Grant (if present). */
56933
+ access_grant_key?: string | undefined;
56934
+ /** The new start time for the access grant. */
56935
+ starts_at?: string | undefined;
56936
+ /** The new end time for the access grant. */
56937
+ ends_at?: string | undefined;
56749
56938
  } | {
56750
56939
  /** ID of the event. */
56751
56940
  event_id: string;
@@ -56834,6 +57023,24 @@ export type Routes = {
56834
57023
  code?: string | undefined;
56835
57024
  /** Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used). */
56836
57025
  is_backup_code?: boolean | undefined;
57026
+ } | {
57027
+ /** ID of the event. */
57028
+ event_id: string;
57029
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
57030
+ workspace_id: string;
57031
+ /** Date and time at which the event was created. */
57032
+ created_at: string;
57033
+ /** Date and time at which the event occurred. */
57034
+ occurred_at: string;
57035
+ /** ID of the affected access method. */
57036
+ access_method_id: string;
57037
+ /** IDs of the access grants associated with this access method. */
57038
+ access_grant_ids: string[];
57039
+ /** Keys of the access grants associated with this access method (if present). */
57040
+ access_grant_keys?: string[] | undefined;
57041
+ event_type: 'access_method.code_changed';
57042
+ /** The new PIN code for code access methods (only present when mode is 'code'). */
57043
+ code: string;
56837
57044
  } | {
56838
57045
  /** ID of the event. */
56839
57046
  event_id: string;
@@ -83855,6 +84062,15 @@ export type Routes = {
83855
84062
  is_encoding_required?: boolean | undefined;
83856
84063
  /** The actual PIN code for code access methods. */
83857
84064
  code?: (string | null) | undefined;
84065
+ /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
84066
+ warnings: {
84067
+ /** Date and time at which Seam created the warning. */
84068
+ created_at: string;
84069
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
84070
+ message: string;
84071
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
84072
+ warning_code: 'being_deleted';
84073
+ }[];
83858
84074
  /** ID of the customization profile associated with the access method. */
83859
84075
  customization_profile_id?: string | undefined;
83860
84076
  }[] | undefined;
@@ -83901,6 +84117,15 @@ export type Routes = {
83901
84117
  starts_at: string;
83902
84118
  /** Date and time at which the Access Grant ends. */
83903
84119
  ends_at: string | null;
84120
+ /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
84121
+ warnings: {
84122
+ /** Date and time at which Seam created the warning. */
84123
+ created_at: string;
84124
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
84125
+ message: string;
84126
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
84127
+ warning_code: 'being_deleted';
84128
+ }[];
83904
84129
  /** ID of the customization profile associated with the Access Grant. */
83905
84130
  customization_profile_id?: string | undefined;
83906
84131
  }[] | undefined;
@@ -84383,6 +84608,24 @@ export type Routes = {
84383
84608
  event_type: 'access_grant.access_to_door_lost';
84384
84609
  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
84385
84610
  acs_entrance_id: string;
84611
+ } | {
84612
+ /** ID of the event. */
84613
+ event_id: string;
84614
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
84615
+ workspace_id: string;
84616
+ /** Date and time at which the event was created. */
84617
+ created_at: string;
84618
+ /** Date and time at which the event occurred. */
84619
+ occurred_at: string;
84620
+ /** ID of the affected Access Grant. */
84621
+ access_grant_id: string;
84622
+ event_type: 'access_grant.access_times_changed';
84623
+ /** Key of the affected Access Grant (if present). */
84624
+ access_grant_key?: string | undefined;
84625
+ /** The new start time for the access grant. */
84626
+ starts_at?: string | undefined;
84627
+ /** The new end time for the access grant. */
84628
+ ends_at?: string | undefined;
84386
84629
  } | {
84387
84630
  /** ID of the event. */
84388
84631
  event_id: string;
@@ -84471,6 +84714,24 @@ export type Routes = {
84471
84714
  code?: string | undefined;
84472
84715
  /** Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used). */
84473
84716
  is_backup_code?: boolean | undefined;
84717
+ } | {
84718
+ /** ID of the event. */
84719
+ event_id: string;
84720
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
84721
+ workspace_id: string;
84722
+ /** Date and time at which the event was created. */
84723
+ created_at: string;
84724
+ /** Date and time at which the event occurred. */
84725
+ occurred_at: string;
84726
+ /** ID of the affected access method. */
84727
+ access_method_id: string;
84728
+ /** IDs of the access grants associated with this access method. */
84729
+ access_grant_ids: string[];
84730
+ /** Keys of the access grants associated with this access method (if present). */
84731
+ access_grant_keys?: string[] | undefined;
84732
+ event_type: 'access_method.code_changed';
84733
+ /** The new PIN code for code access methods (only present when mode is 'code'). */
84734
+ code: string;
84474
84735
  } | {
84475
84736
  /** ID of the event. */
84476
84737
  event_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.553.0",
3
+ "version": "1.555.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()
@@ -79,10 +79,37 @@ export type AccessGrantAccessToDoorLostEvent = z.infer<
79
79
  typeof access_grant_access_to_door_lost_event
80
80
  >
81
81
 
82
+ export const access_grant_access_times_changed_event =
83
+ access_grant_event.extend({
84
+ event_type: z.literal('access_grant.access_times_changed'),
85
+ access_grant_key: z
86
+ .string()
87
+ .optional()
88
+ .describe('Key of the affected Access Grant (if present).'),
89
+ starts_at: z
90
+ .string()
91
+ .optional()
92
+ .describe('The new start time for the access grant.'),
93
+ ends_at: z
94
+ .string()
95
+ .optional()
96
+ .describe('The new end time for the access grant.'),
97
+ }).describe(`
98
+ ---
99
+ route_path: /access_grants
100
+ ---
101
+ An Access Grant's start or end time was changed.
102
+ `)
103
+
104
+ export type AccessGrantAccessTimesChangedEvent = z.infer<
105
+ typeof access_grant_access_times_changed_event
106
+ >
107
+
82
108
  export const access_grant_events = [
83
109
  access_grant_created_event,
84
110
  access_grant_deleted_event,
85
111
  access_grant_access_granted_to_all_doors_event,
86
112
  access_grant_access_granted_to_door_event,
87
113
  access_grant_access_to_door_lost_event,
114
+ access_grant_access_times_changed_event,
88
115
  ] as const