@seamapi/types 1.166.0 → 1.168.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.
@@ -1064,7 +1064,8 @@ export interface Routes {
1064
1064
  queryParams: {};
1065
1065
  jsonBody: {
1066
1066
  acs_credential_id: string;
1067
- code: string;
1067
+ code?: string | undefined;
1068
+ ends_at?: string | undefined;
1068
1069
  };
1069
1070
  commonParams: {};
1070
1071
  formData: {};
@@ -3402,6 +3403,11 @@ export interface Routes {
3402
3403
  event_id: string;
3403
3404
  device_id?: string | undefined;
3404
3405
  action_attempt_id?: string | undefined;
3406
+ acs_credential_id?: string | undefined;
3407
+ acs_user_id?: string | undefined;
3408
+ acs_system_id?: string | undefined;
3409
+ client_session_id?: string | undefined;
3410
+ enrollment_automation_id?: string | undefined;
3405
3411
  event_type: string;
3406
3412
  workspace_id: string;
3407
3413
  created_at: string;
@@ -3422,8 +3428,8 @@ export interface Routes {
3422
3428
  device_ids?: string[] | undefined;
3423
3429
  access_code_id?: string | undefined;
3424
3430
  access_code_ids?: string[] | undefined;
3425
- event_type?: ('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' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | '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' | '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' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_user.deleted' | 'acs_credential.deleted' | 'enrollment_automation.deleted' | 'client_session.deleted') | undefined;
3426
- event_types?: Array<'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' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | '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' | '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' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_user.deleted' | 'acs_credential.deleted' | 'enrollment_automation.deleted' | 'client_session.deleted'> | undefined;
3431
+ event_type?: ('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' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | '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' | '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' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_user.deleted' | 'acs_credential.deleted' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed') | undefined;
3432
+ event_types?: Array<'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' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | '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' | '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' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_user.deleted' | 'acs_credential.deleted' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed'> | undefined;
3427
3433
  connected_account_id?: string | undefined;
3428
3434
  limit?: number;
3429
3435
  };
@@ -3433,6 +3439,11 @@ export interface Routes {
3433
3439
  event_id: string;
3434
3440
  device_id?: string | undefined;
3435
3441
  action_attempt_id?: string | undefined;
3442
+ acs_credential_id?: string | undefined;
3443
+ acs_user_id?: string | undefined;
3444
+ acs_system_id?: string | undefined;
3445
+ client_session_id?: string | undefined;
3446
+ enrollment_automation_id?: string | undefined;
3436
3447
  event_type: string;
3437
3448
  workspace_id: string;
3438
3449
  created_at: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.166.0",
3
+ "version": "1.168.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -0,0 +1,36 @@
1
+ import { z } from 'zod'
2
+
3
+ import { common_event } from './common.js'
4
+
5
+ const action_attempt_event = common_event.extend({
6
+ action_attempt_id: z.string().uuid().describe(`
7
+ ---
8
+ title: Action Attempt ID
9
+ ---
10
+ The ID of the action attempt.
11
+ `),
12
+ action_type: z.string().describe(`
13
+ ---
14
+ title: Action Type
15
+ ---
16
+ The type of action.
17
+ `),
18
+ status: z.string().describe(`
19
+ ---
20
+ title: Status
21
+ ---
22
+ The status of the action.
23
+ `),
24
+ })
25
+
26
+ export const action_attempt_lock_door_succeeded_event = action_attempt_event
27
+ .extend({
28
+ event_type: z.literal('action_attempt.lock_door.succeeded'),
29
+ })
30
+ .describe('A lock door action attempt succeeded.')
31
+
32
+ export const action_attempt_lock_door_failed_event = action_attempt_event
33
+ .extend({
34
+ event_type: z.literal('action_attempt.lock_door.failed'),
35
+ })
36
+ .describe('A lock door action attempt failed.')
@@ -1,5 +1,6 @@
1
1
  export type * from './access-codes.js'
2
2
  export type * from './acs/index.js'
3
+ export type * from './action-attempts.js'
3
4
  export type * from './client-sessions.js'
4
5
  export type * from './connected-accounts.js'
5
6
  export type * from './devices.js'
@@ -2097,9 +2097,14 @@ export default {
2097
2097
  },
2098
2098
  event: {
2099
2099
  properties: {
2100
+ acs_credential_id: { format: 'uuid', type: 'string' },
2101
+ acs_system_id: { format: 'uuid', type: 'string' },
2102
+ acs_user_id: { format: 'uuid', type: 'string' },
2100
2103
  action_attempt_id: { format: 'uuid', type: 'string' },
2104
+ client_session_id: { format: 'uuid', type: 'string' },
2101
2105
  created_at: { format: 'date-time', type: 'string' },
2102
2106
  device_id: { format: 'uuid', type: 'string' },
2107
+ enrollment_automation_id: { format: 'uuid', type: 'string' },
2103
2108
  event_id: { format: 'uuid', type: 'string' },
2104
2109
  event_type: { type: 'string' },
2105
2110
  occurred_at: { format: 'date-time', type: 'string' },
@@ -4723,8 +4728,9 @@ export default {
4723
4728
  properties: {
4724
4729
  acs_credential_id: { type: 'string' },
4725
4730
  code: { pattern: '^\\d+$', type: 'string' },
4731
+ ends_at: { format: 'date-time', type: 'string' },
4726
4732
  },
4727
- required: ['acs_credential_id', 'code'],
4733
+ required: ['acs_credential_id'],
4728
4734
  type: 'object',
4729
4735
  },
4730
4736
  },
@@ -4769,8 +4775,9 @@ export default {
4769
4775
  properties: {
4770
4776
  acs_credential_id: { type: 'string' },
4771
4777
  code: { pattern: '^\\d+$', type: 'string' },
4778
+ ends_at: { format: 'date-time', type: 'string' },
4772
4779
  },
4773
- required: ['acs_credential_id', 'code'],
4780
+ required: ['acs_credential_id'],
4774
4781
  type: 'object',
4775
4782
  },
4776
4783
  },
@@ -7939,6 +7946,8 @@ export default {
7939
7946
  'acs_credential.deleted',
7940
7947
  'enrollment_automation.deleted',
7941
7948
  'client_session.deleted',
7949
+ 'action_attempt.lock_door.succeeded',
7950
+ 'action_attempt.lock_door.failed',
7942
7951
  ],
7943
7952
  type: 'string',
7944
7953
  },
@@ -7998,6 +8007,8 @@ export default {
7998
8007
  'acs_credential.deleted',
7999
8008
  'enrollment_automation.deleted',
8000
8009
  'client_session.deleted',
8010
+ 'action_attempt.lock_door.succeeded',
8011
+ 'action_attempt.lock_door.failed',
8001
8012
  ],
8002
8013
  type: 'string',
8003
8014
  },
@@ -1156,7 +1156,8 @@ export interface Routes {
1156
1156
  queryParams: {}
1157
1157
  jsonBody: {
1158
1158
  acs_credential_id: string
1159
- code: string
1159
+ code?: string | undefined
1160
+ ends_at?: string | undefined
1160
1161
  }
1161
1162
  commonParams: {}
1162
1163
  formData: {}
@@ -4526,6 +4527,11 @@ export interface Routes {
4526
4527
  event_id: string
4527
4528
  device_id?: string | undefined
4528
4529
  action_attempt_id?: string | undefined
4530
+ acs_credential_id?: string | undefined
4531
+ acs_user_id?: string | undefined
4532
+ acs_system_id?: string | undefined
4533
+ client_session_id?: string | undefined
4534
+ enrollment_automation_id?: string | undefined
4529
4535
  event_type: string
4530
4536
  workspace_id: string
4531
4537
  created_at: string
@@ -4602,6 +4608,8 @@ export interface Routes {
4602
4608
  | 'acs_credential.deleted'
4603
4609
  | 'enrollment_automation.deleted'
4604
4610
  | 'client_session.deleted'
4611
+ | 'action_attempt.lock_door.succeeded'
4612
+ | 'action_attempt.lock_door.failed'
4605
4613
  )
4606
4614
  | undefined
4607
4615
  event_types?:
@@ -4659,6 +4667,8 @@ export interface Routes {
4659
4667
  | 'acs_credential.deleted'
4660
4668
  | 'enrollment_automation.deleted'
4661
4669
  | 'client_session.deleted'
4670
+ | 'action_attempt.lock_door.succeeded'
4671
+ | 'action_attempt.lock_door.failed'
4662
4672
  >
4663
4673
  | undefined
4664
4674
  connected_account_id?: string | undefined
@@ -4670,6 +4680,11 @@ export interface Routes {
4670
4680
  event_id: string
4671
4681
  device_id?: string | undefined
4672
4682
  action_attempt_id?: string | undefined
4683
+ acs_credential_id?: string | undefined
4684
+ acs_user_id?: string | undefined
4685
+ acs_system_id?: string | undefined
4686
+ client_session_id?: string | undefined
4687
+ enrollment_automation_id?: string | undefined
4673
4688
  event_type: string
4674
4689
  workspace_id: string
4675
4690
  created_at: string