@seamapi/types 1.381.0 → 1.382.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.
@@ -18934,6 +18934,21 @@ export interface Routes {
18934
18934
  acs_system_id: string;
18935
18935
  acs_credential_id: string;
18936
18936
  event_type: 'acs_credential.invalidated';
18937
+ } | {
18938
+ /** ID of the event. */
18939
+ event_id: string;
18940
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
18941
+ workspace_id: string;
18942
+ /** Date and time at which the event was created. */
18943
+ created_at: string;
18944
+ /** Date and time at which the event occurred. */
18945
+ occurred_at: string;
18946
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
18947
+ connected_account_id?: string | undefined;
18948
+ /** ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). */
18949
+ acs_system_id: string;
18950
+ acs_user_id: string;
18951
+ event_type: 'acs_user.created';
18937
18952
  } | {
18938
18953
  /** ID of the event. */
18939
18954
  event_id: string;
@@ -19817,8 +19832,8 @@ export interface Routes {
19817
19832
  acs_system_ids?: string[] | undefined;
19818
19833
  access_code_id?: string | undefined;
19819
19834
  access_code_ids?: string[] | undefined;
19820
- 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' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | '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;
19821
- event_types?: Array<'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' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | '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;
19835
+ 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' | '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;
19836
+ event_types?: Array<'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' | '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;
19822
19837
  connected_account_id?: string | undefined;
19823
19838
  connect_webview_id?: string | undefined;
19824
19839
  limit?: number;
@@ -20207,6 +20222,21 @@ export interface Routes {
20207
20222
  acs_system_id: string;
20208
20223
  acs_credential_id: string;
20209
20224
  event_type: 'acs_credential.invalidated';
20225
+ } | {
20226
+ /** ID of the event. */
20227
+ event_id: string;
20228
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
20229
+ workspace_id: string;
20230
+ /** Date and time at which the event was created. */
20231
+ created_at: string;
20232
+ /** Date and time at which the event occurred. */
20233
+ occurred_at: string;
20234
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
20235
+ connected_account_id?: string | undefined;
20236
+ /** ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). */
20237
+ acs_system_id: string;
20238
+ acs_user_id: string;
20239
+ event_type: 'acs_user.created';
20210
20240
  } | {
20211
20241
  /** ID of the event. */
20212
20242
  event_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.381.0",
3
+ "version": "1.382.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -21,4 +21,18 @@ export const acs_user_deleted_event = acs_user_event.extend({
21
21
 
22
22
  export type AcsUserDeletedEvent = z.infer<typeof acs_user_deleted_event>
23
23
 
24
- export const acs_user_events = [acs_user_deleted_event] as const
24
+ export const acs_user_created_event = acs_user_event.extend({
25
+ event_type: z.literal('acs_user.created'),
26
+ }).describe(`
27
+ ---
28
+ route_path: /acs/users
29
+ ---
30
+ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.
31
+ `)
32
+
33
+ export type AcsUserCreatedEvent = z.infer<typeof acs_user_created_event>
34
+
35
+ export const acs_user_events = [
36
+ acs_user_created_event,
37
+ acs_user_deleted_event,
38
+ ] as const
@@ -10448,6 +10448,58 @@ export default {
10448
10448
  type: 'object',
10449
10449
  'x-route-path': '/acs/credentials',
10450
10450
  },
10451
+ {
10452
+ description:
10453
+ 'An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.',
10454
+ properties: {
10455
+ acs_system_id: {
10456
+ description:
10457
+ 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
10458
+ format: 'uuid',
10459
+ type: 'string',
10460
+ },
10461
+ acs_user_id: { format: 'uuid', type: 'string' },
10462
+ connected_account_id: {
10463
+ description:
10464
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
10465
+ format: 'uuid',
10466
+ type: 'string',
10467
+ },
10468
+ created_at: {
10469
+ description: 'Date and time at which the event was created.',
10470
+ format: 'date-time',
10471
+ type: 'string',
10472
+ },
10473
+ event_id: {
10474
+ description: 'ID of the event.',
10475
+ format: 'uuid',
10476
+ type: 'string',
10477
+ },
10478
+ event_type: { enum: ['acs_user.created'], type: 'string' },
10479
+ occurred_at: {
10480
+ description: 'Date and time at which the event occurred.',
10481
+ format: 'date-time',
10482
+ type: 'string',
10483
+ },
10484
+ workspace_id: {
10485
+ description:
10486
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
10487
+ format: 'uuid',
10488
+ type: 'string',
10489
+ },
10490
+ },
10491
+ required: [
10492
+ 'event_id',
10493
+ 'workspace_id',
10494
+ 'created_at',
10495
+ 'occurred_at',
10496
+ 'acs_system_id',
10497
+ 'acs_user_id',
10498
+ 'event_type',
10499
+ ],
10500
+ type: 'object',
10501
+ 'x-route-path': '/acs/users',
10502
+ },
10451
10503
  {
10452
10504
  description:
10453
10505
  'An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.',
@@ -25525,6 +25577,7 @@ export default {
25525
25577
  'acs_credential.issued',
25526
25578
  'acs_credential.reissued',
25527
25579
  'acs_credential.invalidated',
25580
+ 'acs_user.created',
25528
25581
  'acs_user.deleted',
25529
25582
  'acs_encoder.added',
25530
25583
  'acs_encoder.removed',
@@ -25610,6 +25663,7 @@ export default {
25610
25663
  'acs_credential.issued',
25611
25664
  'acs_credential.reissued',
25612
25665
  'acs_credential.invalidated',
25666
+ 'acs_user.created',
25613
25667
  'acs_user.deleted',
25614
25668
  'acs_encoder.added',
25615
25669
  'acs_encoder.removed',
@@ -22645,6 +22645,22 @@ export interface Routes {
22645
22645
  acs_credential_id: string
22646
22646
  event_type: 'acs_credential.invalidated'
22647
22647
  }
22648
+ | {
22649
+ /** ID of the event. */
22650
+ event_id: string
22651
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
22652
+ workspace_id: string
22653
+ /** Date and time at which the event was created. */
22654
+ created_at: string
22655
+ /** Date and time at which the event occurred. */
22656
+ occurred_at: string
22657
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
22658
+ connected_account_id?: string | undefined
22659
+ /** ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). */
22660
+ acs_system_id: string
22661
+ acs_user_id: string
22662
+ event_type: 'acs_user.created'
22663
+ }
22648
22664
  | {
22649
22665
  /** ID of the event. */
22650
22666
  event_id: string
@@ -23630,6 +23646,7 @@ export interface Routes {
23630
23646
  | 'acs_credential.issued'
23631
23647
  | 'acs_credential.reissued'
23632
23648
  | 'acs_credential.invalidated'
23649
+ | 'acs_user.created'
23633
23650
  | 'acs_user.deleted'
23634
23651
  | 'acs_encoder.added'
23635
23652
  | 'acs_encoder.removed'
@@ -23713,6 +23730,7 @@ export interface Routes {
23713
23730
  | 'acs_credential.issued'
23714
23731
  | 'acs_credential.reissued'
23715
23732
  | 'acs_credential.invalidated'
23733
+ | 'acs_user.created'
23716
23734
  | 'acs_user.deleted'
23717
23735
  | 'acs_encoder.added'
23718
23736
  | 'acs_encoder.removed'
@@ -24183,6 +24201,22 @@ export interface Routes {
24183
24201
  acs_credential_id: string
24184
24202
  event_type: 'acs_credential.invalidated'
24185
24203
  }
24204
+ | {
24205
+ /** ID of the event. */
24206
+ event_id: string
24207
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
24208
+ workspace_id: string
24209
+ /** Date and time at which the event was created. */
24210
+ created_at: string
24211
+ /** Date and time at which the event occurred. */
24212
+ occurred_at: string
24213
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
24214
+ connected_account_id?: string | undefined
24215
+ /** ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). */
24216
+ acs_system_id: string
24217
+ acs_user_id: string
24218
+ event_type: 'acs_user.created'
24219
+ }
24186
24220
  | {
24187
24221
  /** ID of the event. */
24188
24222
  event_id: string