@seamapi/types 1.303.0 → 1.304.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.
@@ -7905,6 +7905,7 @@ export interface Routes {
7905
7905
  commonParams: {};
7906
7906
  formData: {};
7907
7907
  jsonResponse: {
7908
+ /** Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
7908
7909
  acs_user: {
7909
7910
  /** ID of the `acs_user`. */
7910
7911
  acs_user_id: string;
@@ -8020,6 +8021,7 @@ export interface Routes {
8020
8021
  };
8021
8022
  formData: {};
8022
8023
  jsonResponse: {
8024
+ /** Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
8023
8025
  acs_user: {
8024
8026
  /** ID of the `acs_user`. */
8025
8027
  acs_user_id: string;
@@ -8332,6 +8334,7 @@ export interface Routes {
8332
8334
  };
8333
8335
  formData: {};
8334
8336
  jsonResponse: {
8337
+ /** Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
8335
8338
  acs_user: {
8336
8339
  /** ID of the `acs_user`. */
8337
8340
  acs_user_id: string;
@@ -12158,8 +12161,8 @@ export interface Routes {
12158
12161
  acs_system_ids?: string[] | undefined;
12159
12162
  access_code_id?: string | undefined;
12160
12163
  access_code_ids?: string[] | undefined;
12161
- event_type?: ('device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.added' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | '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' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_system.added' | 'acs_system.connected' | 'acs_user.deleted' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_encoder.added' | 'acs_encoder.removed' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded') | undefined;
12162
- event_types?: Array<'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.added' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | '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' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_system.added' | 'acs_system.connected' | 'acs_user.deleted' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_encoder.added' | 'acs_encoder.removed' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded'> | undefined;
12164
+ event_type?: ('device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.added' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | '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' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_system.added' | 'acs_system.connected' | 'acs_system.disconnected' | 'acs_user.deleted' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_encoder.added' | 'acs_encoder.removed' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded') | undefined;
12165
+ event_types?: Array<'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.added' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | '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' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_system.added' | 'acs_system.connected' | 'acs_system.disconnected' | 'acs_user.deleted' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_encoder.added' | 'acs_encoder.removed' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded'> | undefined;
12163
12166
  connected_account_id?: string | undefined;
12164
12167
  connect_webview_id?: string | undefined;
12165
12168
  limit?: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.303.0",
3
+ "version": "1.304.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -234,25 +234,25 @@ const common_acs_user = z
234
234
  })
235
235
  .merge(user_fields)
236
236
 
237
- export const acs_user = common_acs_user.merge(
238
- z
239
- .object({
237
+ export const acs_user = common_acs_user
238
+ .merge(
239
+ z.object({
240
240
  is_managed: z.literal(true),
241
- })
242
- .describe(
243
- 'Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
244
- ),
245
- )
241
+ }),
242
+ )
243
+ .describe(
244
+ 'Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
245
+ )
246
246
 
247
- export const unmanaged_acs_user = common_acs_user.merge(
248
- z
249
- .object({
247
+ export const unmanaged_acs_user = common_acs_user
248
+ .merge(
249
+ z.object({
250
250
  is_managed: z.literal(false),
251
- })
252
- .describe(
253
- 'Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
254
- ),
255
- )
251
+ }),
252
+ )
253
+ .describe(
254
+ 'Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
255
+ )
256
256
 
257
257
  export type AcsUser = z.output<typeof acs_user>
258
258
  export type AcsUnmanagedUser = z.output<typeof unmanaged_acs_user>
@@ -12,6 +12,16 @@ export const acs_system_connected_event = acs_system_event
12
12
 
13
13
  export type AcsSystemConnectedEvent = z.infer<typeof acs_system_connected_event>
14
14
 
15
+ export const acs_system_disconnected_event = acs_system_event
16
+ .extend({
17
+ event_type: z.literal('acs_system.disconnected'),
18
+ })
19
+ .describe('An ACS system was disconnected.')
20
+
21
+ export type AcsSystemDisconnectedEvent = z.infer<
22
+ typeof acs_system_disconnected_event
23
+ >
24
+
15
25
  export const acs_system_added_event = acs_system_event
16
26
  .extend({
17
27
  event_type: z.literal('acs_system.added'),
@@ -23,4 +33,5 @@ export type AcsSystemAddedEvent = z.infer<typeof acs_system_added_event>
23
33
  export const acs_system_events = [
24
34
  acs_system_connected_event,
25
35
  acs_system_added_event,
36
+ acs_system_disconnected_event,
26
37
  ] as const
@@ -1050,6 +1050,8 @@ export default {
1050
1050
  type: 'object',
1051
1051
  },
1052
1052
  acs_user: {
1053
+ description:
1054
+ 'Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1053
1055
  properties: {
1054
1056
  access_schedule: {
1055
1057
  description:
@@ -11725,6 +11727,8 @@ export default {
11725
11727
  schema: {
11726
11728
  properties: {
11727
11729
  acs_user: {
11730
+ description:
11731
+ 'Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
11728
11732
  properties: {
11729
11733
  access_schedule: {
11730
11734
  description:
@@ -12118,6 +12122,8 @@ export default {
12118
12122
  properties: {
12119
12123
  acs_users: {
12120
12124
  items: {
12125
+ description:
12126
+ 'Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
12121
12127
  properties: {
12122
12128
  access_schedule: {
12123
12129
  description:
@@ -15115,6 +15121,7 @@ export default {
15115
15121
  'access_code.backup_access_code_pulled',
15116
15122
  'acs_system.added',
15117
15123
  'acs_system.connected',
15124
+ 'acs_system.disconnected',
15118
15125
  'acs_user.deleted',
15119
15126
  'acs_credential.deleted',
15120
15127
  'acs_credential.issued',
@@ -15191,6 +15198,7 @@ export default {
15191
15198
  'access_code.backup_access_code_pulled',
15192
15199
  'acs_system.added',
15193
15200
  'acs_system.connected',
15201
+ 'acs_system.disconnected',
15194
15202
  'acs_user.deleted',
15195
15203
  'acs_credential.deleted',
15196
15204
  'acs_credential.issued',
@@ -9240,6 +9240,7 @@ export interface Routes {
9240
9240
  commonParams: {}
9241
9241
  formData: {}
9242
9242
  jsonResponse: {
9243
+ /** Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
9243
9244
  acs_user: {
9244
9245
  /** ID of the `acs_user`. */
9245
9246
  acs_user_id: string
@@ -9375,6 +9376,7 @@ export interface Routes {
9375
9376
  }
9376
9377
  formData: {}
9377
9378
  jsonResponse: {
9379
+ /** Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
9378
9380
  acs_user: {
9379
9381
  /** ID of the `acs_user`. */
9380
9382
  acs_user_id: string
@@ -9748,6 +9750,7 @@ export interface Routes {
9748
9750
  }
9749
9751
  formData: {}
9750
9752
  jsonResponse: {
9753
+ /** Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
9751
9754
  acs_user: {
9752
9755
  /** ID of the `acs_user`. */
9753
9756
  acs_user_id: string
@@ -14849,6 +14852,7 @@ export interface Routes {
14849
14852
  | 'access_code.backup_access_code_pulled'
14850
14853
  | 'acs_system.added'
14851
14854
  | 'acs_system.connected'
14855
+ | 'acs_system.disconnected'
14852
14856
  | 'acs_user.deleted'
14853
14857
  | 'acs_credential.deleted'
14854
14858
  | 'acs_credential.issued'
@@ -14923,6 +14927,7 @@ export interface Routes {
14923
14927
  | 'access_code.backup_access_code_pulled'
14924
14928
  | 'acs_system.added'
14925
14929
  | 'acs_system.connected'
14930
+ | 'acs_system.disconnected'
14926
14931
  | 'acs_user.deleted'
14927
14932
  | 'acs_credential.deleted'
14928
14933
  | 'acs_credential.issued'