@seamapi/types 1.406.1 → 1.406.3

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 (63) hide show
  1. package/dist/connect.cjs +496 -476
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +753 -614
  4. package/lib/seam/connect/models/events/access-codes.js +4 -9
  5. package/lib/seam/connect/models/events/access-codes.js.map +1 -1
  6. package/lib/seam/connect/models/events/access-grants.js +5 -2
  7. package/lib/seam/connect/models/events/access-grants.js.map +1 -1
  8. package/lib/seam/connect/models/events/access-methods.js +4 -1
  9. package/lib/seam/connect/models/events/access-methods.js.map +1 -1
  10. package/lib/seam/connect/models/events/acs/access-groups.js +4 -1
  11. package/lib/seam/connect/models/events/acs/access-groups.js.map +1 -1
  12. package/lib/seam/connect/models/events/acs/common.js +2 -5
  13. package/lib/seam/connect/models/events/acs/common.js.map +1 -1
  14. package/lib/seam/connect/models/events/acs/credentials.js +4 -1
  15. package/lib/seam/connect/models/events/acs/credentials.js.map +1 -1
  16. package/lib/seam/connect/models/events/acs/encoders.js +1 -4
  17. package/lib/seam/connect/models/events/acs/encoders.js.map +1 -1
  18. package/lib/seam/connect/models/events/acs/entrances.js +1 -1
  19. package/lib/seam/connect/models/events/acs/entrances.js.map +1 -1
  20. package/lib/seam/connect/models/events/acs/systems.js +3 -3
  21. package/lib/seam/connect/models/events/acs/users.js +3 -3
  22. package/lib/seam/connect/models/events/acs/users.js.map +1 -1
  23. package/lib/seam/connect/models/events/action-attempts.js +2 -2
  24. package/lib/seam/connect/models/events/action-attempts.js.map +1 -1
  25. package/lib/seam/connect/models/events/client-sessions.js +1 -1
  26. package/lib/seam/connect/models/events/client-sessions.js.map +1 -1
  27. package/lib/seam/connect/models/events/common.js +1 -1
  28. package/lib/seam/connect/models/events/common.js.map +1 -1
  29. package/lib/seam/connect/models/events/connect-webviews.js +2 -2
  30. package/lib/seam/connect/models/events/connect-webviews.js.map +1 -1
  31. package/lib/seam/connect/models/events/connected-accounts.js +2 -2
  32. package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
  33. package/lib/seam/connect/models/events/devices.js +37 -37
  34. package/lib/seam/connect/models/events/devices.js.map +1 -1
  35. package/lib/seam/connect/models/events/enrollment-automations.js +1 -1
  36. package/lib/seam/connect/models/events/enrollment-automations.js.map +1 -1
  37. package/lib/seam/connect/models/events/phones.js +1 -4
  38. package/lib/seam/connect/models/events/phones.js.map +1 -1
  39. package/lib/seam/connect/openapi.d.ts +110 -0
  40. package/lib/seam/connect/openapi.js +422 -328
  41. package/lib/seam/connect/openapi.js.map +1 -1
  42. package/lib/seam/connect/route-types.d.ts +643 -614
  43. package/package.json +1 -1
  44. package/src/lib/seam/connect/models/events/access-codes.ts +4 -15
  45. package/src/lib/seam/connect/models/events/access-grants.ts +5 -2
  46. package/src/lib/seam/connect/models/events/access-methods.ts +4 -1
  47. package/src/lib/seam/connect/models/events/acs/access-groups.ts +4 -1
  48. package/src/lib/seam/connect/models/events/acs/common.ts +2 -9
  49. package/src/lib/seam/connect/models/events/acs/credentials.ts +4 -1
  50. package/src/lib/seam/connect/models/events/acs/encoders.ts +1 -6
  51. package/src/lib/seam/connect/models/events/acs/entrances.ts +1 -3
  52. package/src/lib/seam/connect/models/events/acs/systems.ts +3 -3
  53. package/src/lib/seam/connect/models/events/acs/users.ts +3 -5
  54. package/src/lib/seam/connect/models/events/action-attempts.ts +2 -4
  55. package/src/lib/seam/connect/models/events/client-sessions.ts +1 -3
  56. package/src/lib/seam/connect/models/events/common.ts +1 -3
  57. package/src/lib/seam/connect/models/events/connect-webviews.ts +2 -6
  58. package/src/lib/seam/connect/models/events/connected-accounts.ts +2 -6
  59. package/src/lib/seam/connect/models/events/devices.ts +37 -77
  60. package/src/lib/seam/connect/models/events/enrollment-automations.ts +1 -3
  61. package/src/lib/seam/connect/models/events/phones.ts +1 -6
  62. package/src/lib/seam/connect/openapi.ts +436 -485
  63. package/src/lib/seam/connect/route-types.ts +643 -614
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.406.1",
3
+ "version": "1.406.3",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -3,31 +3,20 @@ import { z } from 'zod'
3
3
  import { common_event } from './common.js'
4
4
 
5
5
  const access_code_event = common_event.extend({
6
- access_code_id: z
7
- .string()
8
- .uuid()
9
- .describe(
10
- 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
11
- ),
6
+ access_code_id: z.string().uuid().describe('ID of the affected access code.'),
12
7
  device_id: z
13
8
  .string()
14
9
  .uuid()
15
- .describe(
16
- 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
17
- ),
10
+ .describe('ID of the device associated with the affected access code.'),
18
11
  connected_account_id: z
19
12
  .string()
20
13
  .uuid()
21
14
  .describe(
22
- 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
15
+ 'ID of the connected account associated with the affected access codes.',
23
16
  ),
24
17
  })
25
18
 
26
- const code = z
27
- .string()
28
- .describe(
29
- 'Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
30
- )
19
+ const code = z.string().describe('Code for the affected access code.')
31
20
 
32
21
  export const access_code_created_event = access_code_event.extend({
33
22
  event_type: z.literal('access_code.created'),
@@ -3,7 +3,10 @@ import { z } from 'zod'
3
3
  import { common_event } from './common.js'
4
4
 
5
5
  const access_grant_event = common_event.extend({
6
- access_grant_id: z.string().uuid().describe('ID of the access grant.'),
6
+ access_grant_id: z
7
+ .string()
8
+ .uuid()
9
+ .describe('ID of the affected access grant.'),
7
10
  })
8
11
 
9
12
  export const access_grant_created_event = access_grant_event.extend({
@@ -48,7 +51,7 @@ const acs_entrance_id = z
48
51
  .string()
49
52
  .uuid()
50
53
  .describe(
51
- 'ID of the door, an [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).',
54
+ 'ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).',
52
55
  )
53
56
 
54
57
  export const access_grant_access_granted_to_door_event =
@@ -3,7 +3,10 @@ import { z } from 'zod'
3
3
  import { common_event } from './common.js'
4
4
 
5
5
  const access_method_event = common_event.extend({
6
- access_method_id: z.string().uuid().describe('ID of the access method.'),
6
+ access_method_id: z
7
+ .string()
8
+ .uuid()
9
+ .describe('ID of the affected access method.'),
7
10
  })
8
11
 
9
12
  export const access_method_issued_event = access_method_event.extend({
@@ -3,7 +3,10 @@ import { z } from 'zod'
3
3
  import { common_acs_event } from './common.js'
4
4
 
5
5
  const acs_access_group_event = common_acs_event.extend({
6
- acs_access_group_id: z.string().uuid(),
6
+ acs_access_group_id: z
7
+ .string()
8
+ .uuid()
9
+ .describe('ID of the affected access group.'),
7
10
  })
8
11
 
9
12
  export const acs_access_group_deleted_event = acs_access_group_event.extend({
@@ -7,13 +7,6 @@ export const common_acs_event = common_event.extend({
7
7
  .string()
8
8
  .uuid()
9
9
  .optional()
10
- .describe(
11
- 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
12
- ),
13
- acs_system_id: z
14
- .string()
15
- .uuid()
16
- .describe(
17
- 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
18
- ),
10
+ .describe('ID of the connected account.'),
11
+ acs_system_id: z.string().uuid().describe('ID of the access system.'),
19
12
  })
@@ -3,7 +3,10 @@ import { z } from 'zod'
3
3
  import { common_acs_event } from './common.js'
4
4
 
5
5
  const acs_credential_event = common_acs_event.extend({
6
- acs_credential_id: z.string().uuid(),
6
+ acs_credential_id: z
7
+ .string()
8
+ .uuid()
9
+ .describe('ID of the affected credential.'),
7
10
  })
8
11
 
9
12
  export const acs_credential_deleted_event = acs_credential_event.extend({
@@ -3,12 +3,7 @@ import { z } from 'zod'
3
3
  import { common_acs_event } from './common.js'
4
4
 
5
5
  const acs_encoder_event = common_acs_event.extend({
6
- acs_encoder_id: z
7
- .string()
8
- .uuid()
9
- .describe(
10
- 'ID of the [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
11
- ),
6
+ acs_encoder_id: z.string().uuid().describe('ID of the affected encoder.'),
12
7
  })
13
8
 
14
9
  export const acs_encoder_added_event = acs_encoder_event.extend({
@@ -6,9 +6,7 @@ const acs_entrance_event = common_acs_event
6
6
  .extend({
7
7
  acs_entrance_id: z.string().uuid(),
8
8
  })
9
- .describe(
10
- 'ID of the [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).',
11
- )
9
+ .describe('ID of the affected entrance.')
12
10
 
13
11
  export const acs_entrance_added_event = acs_entrance_event.extend({
14
12
  event_type: z.literal('acs_entrance.added'),
@@ -10,7 +10,7 @@ export const acs_system_connected_event = acs_system_event.extend({
10
10
  ---
11
11
  route_path: /acs/systems
12
12
  ---
13
- An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.
13
+ An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.
14
14
  `)
15
15
 
16
16
  export type AcsSystemConnectedEvent = z.infer<typeof acs_system_connected_event>
@@ -21,7 +21,7 @@ export const acs_system_disconnected_event = acs_system_event.extend({
21
21
  ---
22
22
  route_path: /acs/systems
23
23
  ---
24
- An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.
24
+ An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.
25
25
  `)
26
26
 
27
27
  export type AcsSystemDisconnectedEvent = z.infer<
@@ -34,7 +34,7 @@ export const acs_system_added_event = acs_system_event.extend({
34
34
  ---
35
35
  route_path: /acs/systems
36
36
  ---
37
- An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.
37
+ An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was added.
38
38
  `)
39
39
 
40
40
  export type AcsSystemAddedEvent = z.infer<typeof acs_system_added_event>
@@ -6,9 +6,7 @@ const acs_user_event = common_acs_event
6
6
  .extend({
7
7
  acs_user_id: z.string().uuid(),
8
8
  })
9
- .describe(
10
- 'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
11
- )
9
+ .describe('ID of the affected access system user.')
12
10
 
13
11
  export const acs_user_deleted_event = acs_user_event.extend({
14
12
  event_type: z.literal('acs_user.deleted'),
@@ -16,7 +14,7 @@ export const acs_user_deleted_event = acs_user_event.extend({
16
14
  ---
17
15
  route_path: /acs/users
18
16
  ---
19
- An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.
17
+ An [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.
20
18
  `)
21
19
 
22
20
  export type AcsUserDeletedEvent = z.infer<typeof acs_user_deleted_event>
@@ -27,7 +25,7 @@ export const acs_user_created_event = acs_user_event.extend({
27
25
  ---
28
26
  route_path: /acs/users
29
27
  ---
30
- An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.
28
+ An [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.
31
29
  `)
32
30
 
33
31
  export type AcsUserCreatedEvent = z.infer<typeof acs_user_created_event>
@@ -6,10 +6,8 @@ const action_attempt_event = common_event.extend({
6
6
  action_attempt_id: z
7
7
  .string()
8
8
  .uuid()
9
- .describe(
10
- 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).',
11
- ),
12
- action_type: z.string().describe('Type of action.'),
9
+ .describe('ID of the affected action attempt.'),
10
+ action_type: z.string().describe('Type of the action.'),
13
11
  status: z.string().describe('Status of the action.'),
14
12
  })
15
13
 
@@ -6,9 +6,7 @@ const client_session_event = common_event.extend({
6
6
  client_session_id: z
7
7
  .string()
8
8
  .uuid()
9
- .describe(
10
- 'ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
11
- ),
9
+ .describe('ID of the affected client session.'),
12
10
  })
13
11
 
14
12
  export const client_session_deleted_event = client_session_event.extend({
@@ -5,9 +5,7 @@ export const common_event = z.object({
5
5
  workspace_id: z
6
6
  .string()
7
7
  .uuid()
8
- .describe(
9
- 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
10
- ),
8
+ .describe('ID of the workspace associated with the event.'),
11
9
  created_at: z
12
10
  .string()
13
11
  .datetime()
@@ -6,17 +6,13 @@ const connect_webview_event = common_event.extend({
6
6
  connect_webview_id: z
7
7
  .string()
8
8
  .uuid()
9
- .describe(
10
- 'ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
11
- ),
9
+ .describe('ID of the affected Connect Webview.'),
12
10
  })
13
11
 
14
12
  const connected_account_id = z
15
13
  .string()
16
14
  .uuid()
17
- .describe(
18
- 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
19
- )
15
+ .describe('ID of the connected account associated with the event.')
20
16
 
21
17
  export const connect_webview_login_succeeded_event =
22
18
  connect_webview_event.extend({
@@ -6,17 +6,13 @@ const connected_account_event = common_event.extend({
6
6
  connected_account_id: z
7
7
  .string()
8
8
  .uuid()
9
- .describe(
10
- 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
11
- ),
9
+ .describe('ID of the affected connected account.'),
12
10
  })
13
11
 
14
12
  const connect_webview_id = z
15
13
  .string()
16
14
  .uuid()
17
- .describe(
18
- 'ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
19
- )
15
+ .describe('ID of the Connect Webview associated with the event.')
20
16
 
21
17
  export const connected_account_connected_event = connected_account_event.extend(
22
18
  {
@@ -4,13 +4,11 @@ import { climate_setting } from '../thermostats/climate-preset.js'
4
4
  import { common_event } from './common.js'
5
5
 
6
6
  const device_event = common_event.extend({
7
- device_id: z.string().uuid().describe('ID of the device.'),
7
+ device_id: z.string().uuid().describe('ID of the affected device.'),
8
8
  connected_account_id: z
9
9
  .string()
10
10
  .uuid()
11
- .describe(
12
- 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
13
- ),
11
+ .describe('ID of the connected account associated with the event.'),
14
12
  })
15
13
 
16
14
  const battery_level = z
@@ -18,13 +16,13 @@ const battery_level = z
18
16
  .min(0)
19
17
  .max(1)
20
18
  .describe(
21
- 'Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.',
19
+ 'Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device.',
22
20
  )
23
21
 
24
22
  const device_battery_status = z
25
23
  .enum(['critical', 'low', 'good', 'full'])
26
24
  .describe(
27
- 'Battery status of the device, calculated from the numeric `battery_level` value.',
25
+ 'Battery status of the affected device, calculated from the numeric `battery_level` value.',
28
26
  )
29
27
 
30
28
  const disconnection_error_code = z
@@ -34,7 +32,7 @@ const disconnection_error_code = z
34
32
  export const lock_method = z
35
33
  .enum(['keycode', 'manual', 'automatic', 'unknown', 'seamapi'])
36
34
  .describe(
37
- 'Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) was locked or unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
35
+ 'Method by which the affected lock device was locked or unlocked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device.',
38
36
  )
39
37
  export type LockMethod = z.infer<typeof lock_method>
40
38
 
@@ -333,15 +331,11 @@ export const noise_sensor_noise_threshold_triggered_event = device_event.extend(
333
331
  .string()
334
332
  .uuid()
335
333
  .optional()
336
- .describe(
337
- 'ID of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.',
338
- ),
334
+ .describe('ID of the noise threshold that was triggered.'),
339
335
  noise_threshold_name: z
340
336
  .string()
341
337
  .optional()
342
- .describe(
343
- 'Name of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.',
344
- ),
338
+ .describe('Name of the noise threshold that was triggered.'),
345
339
  // TODO: remove metadata from this event
346
340
  noiseaware_metadata: z
347
341
  .record(z.unknown())
@@ -369,18 +363,14 @@ export const lock_locked_event = device_event.extend({
369
363
  .string()
370
364
  .uuid()
371
365
  .optional()
372
- .describe(
373
- 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to lock the device.',
374
- ),
366
+ .describe('ID of the access code that was used to lock the device.'),
375
367
  action_attempt_id: z
376
368
  .string()
377
369
  .uuid()
378
370
  .optional()
379
- .describe(
380
- 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the lock action.',
381
- ),
371
+ .describe('ID of the action attempt associated with the lock action.'),
382
372
  method: lock_method.describe(
383
- 'Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) was locked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
373
+ 'Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device.',
384
374
  ),
385
375
  }).describe(`
386
376
  ---
@@ -398,17 +388,15 @@ export const lock_unlocked_event = device_event.extend({
398
388
  .uuid()
399
389
  .optional()
400
390
  .describe(
401
- 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to unlock the device.',
391
+ 'ID of the access code that was used to unlock the affected device.',
402
392
  ),
403
393
  action_attempt_id: z
404
394
  .string()
405
395
  .uuid()
406
396
  .optional()
407
- .describe(
408
- 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the unlock action.',
409
- ),
397
+ .describe('ID of the action attempt associated with the unlock action.'),
410
398
  method: lock_method.describe(
411
- 'Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
399
+ 'Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
412
400
  ),
413
401
  }).describe(`
414
402
  ---
@@ -425,9 +413,7 @@ export const lock_access_denied_event = device_event.extend({
425
413
  .string()
426
414
  .uuid()
427
415
  .optional()
428
- .describe(
429
- 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts.',
430
- ),
416
+ .describe('ID of the access code that was used in the unlock attempts.'),
431
417
  }).describe(`
432
418
  ---
433
419
  route_path: /locks
@@ -444,17 +430,15 @@ export const thermostat_climate_preset_activated_event = device_event.extend({
444
430
  .uuid()
445
431
  .nullable()
446
432
  .describe(
447
- 'ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that prompted the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to be activated.',
433
+ 'ID of the thermostat schedule that prompted the affected climate preset to be activated.',
448
434
  ),
449
435
  climate_preset_key: z
450
436
  .string()
451
- .describe(
452
- 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated.',
453
- ),
437
+ .describe('Key of the climate preset that was activated.'),
454
438
  is_fallback_climate_preset: z
455
439
  .boolean()
456
440
  .describe(
457
- 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated is the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
441
+ 'Indicates whether the climate preset that was activated is the fallback climate preset for the thermostat.',
458
442
  ),
459
443
  }).describe(`
460
444
  ---
@@ -470,7 +454,7 @@ export type ThermostatClimatePresetActivatedEvent = z.infer<
470
454
  export const thermostat_manually_adjusted_method = z
471
455
  .enum(['seam', 'external'])
472
456
  .describe(
473
- 'Method used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
457
+ 'Method used to adjust the affected thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat.',
474
458
  )
475
459
 
476
460
  export const thermostat_manually_adjusted_event = device_event
@@ -502,38 +486,26 @@ export const temperature_threshold_exceeded_event = device_event.extend({
502
486
  event_type: z.literal('thermostat.temperature_threshold_exceeded'),
503
487
  temperature_celsius: z
504
488
  .number()
505
- .describe(
506
- 'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
507
- ),
489
+ .describe('Temperature, in °C, reported by the affected thermostat.'),
508
490
  temperature_fahrenheit: z
509
491
  .number()
510
- .describe(
511
- 'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
512
- ),
492
+ .describe('Temperature, in °F, reported by the affected thermostat.'),
513
493
  upper_limit_celsius: z
514
494
  .number()
515
495
  .nullable()
516
- .describe(
517
- 'Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
518
- ),
496
+ .describe('Upper temperature limit, in °C, defined by the set threshold.'),
519
497
  upper_limit_fahrenheit: z
520
498
  .number()
521
499
  .nullable()
522
- .describe(
523
- 'Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
524
- ),
500
+ .describe('Upper temperature limit, in °F, defined by the set threshold.'),
525
501
  lower_limit_celsius: z
526
502
  .number()
527
503
  .nullable()
528
- .describe(
529
- 'Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
530
- ),
504
+ .describe('Lower temperature limit, in °C, defined by the set threshold.'),
531
505
  lower_limit_fahrenheit: z
532
506
  .number()
533
507
  .nullable()
534
- .describe(
535
- 'Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
536
- ),
508
+ .describe('Lower temperature limit, in °F, defined by the set threshold.'),
537
509
  }).describe(`
538
510
  ---
539
511
  route_path: /thermostats
@@ -552,37 +524,33 @@ export const temperature_threshold_no_longer_exceeded_event =
552
524
  ),
553
525
  temperature_celsius: z
554
526
  .number()
555
- .describe(
556
- 'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
557
- ),
527
+ .describe('Temperature, in °C, reported by the affected thermostat.'),
558
528
  temperature_fahrenheit: z
559
529
  .number()
560
- .describe(
561
- 'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
562
- ),
530
+ .describe('Temperature, in °F, reported by the affected thermostat.'),
563
531
  upper_limit_celsius: z
564
532
  .number()
565
533
  .nullable()
566
534
  .describe(
567
- 'Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
535
+ 'Upper temperature limit, in °C, defined by the set threshold.',
568
536
  ),
569
537
  upper_limit_fahrenheit: z
570
538
  .number()
571
539
  .nullable()
572
540
  .describe(
573
- 'Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
541
+ 'Upper temperature limit, in °F, defined by the set threshold.',
574
542
  ),
575
543
  lower_limit_celsius: z
576
544
  .number()
577
545
  .nullable()
578
546
  .describe(
579
- 'Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
547
+ 'Lower temperature limit, in °C, defined by the set threshold.',
580
548
  ),
581
549
  lower_limit_fahrenheit: z
582
550
  .number()
583
551
  .nullable()
584
552
  .describe(
585
- 'Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
553
+ 'Lower temperature limit, in °F, defined by the set threshold.',
586
554
  ),
587
555
  }).describe(`
588
556
  ---
@@ -599,25 +567,21 @@ export const temperature_reached_set_point_event = device_event.extend({
599
567
  event_type: z.literal('thermostat.temperature_reached_set_point'),
600
568
  temperature_celsius: z
601
569
  .number()
602
- .describe(
603
- 'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
604
- ),
570
+ .describe('Temperature, in °C, reported by the affected thermostat.'),
605
571
  temperature_fahrenheit: z
606
572
  .number()
607
- .describe(
608
- 'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
609
- ),
573
+ .describe('Temperature, in °F, reported by the affected thermostat.'),
610
574
  desired_temperature_celsius: z
611
575
  .number()
612
576
  .optional()
613
577
  .describe(
614
- "Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
578
+ "Desired temperature, in °C, defined by the affected thermostat's cooling or heating set point.",
615
579
  ),
616
580
  desired_temperature_fahrenheit: z
617
581
  .number()
618
582
  .optional()
619
583
  .describe(
620
- "Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
584
+ "Desired temperature, in °F, defined by the affected thermostat's cooling or heating set point.",
621
585
  ),
622
586
  }).describe(`
623
587
  ---
@@ -634,14 +598,10 @@ export const temperature_changed_event = device_event.extend({
634
598
  event_type: z.literal('thermostat.temperature_changed'),
635
599
  temperature_celsius: z
636
600
  .number()
637
- .describe(
638
- 'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
639
- ),
601
+ .describe('Temperature, in °C, reported by the affected thermostat.'),
640
602
  temperature_fahrenheit: z
641
603
  .number()
642
- .describe(
643
- 'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
644
- ),
604
+ .describe('Temperature, in °F, reported by the affected thermostat.'),
645
605
  }).describe(`
646
606
  ---
647
607
  route_path: /thermostats
@@ -653,7 +613,7 @@ export type TemperatureChangedEvent = z.infer<typeof temperature_changed_event>
653
613
 
654
614
  export const device_name_changed_event = device_event.extend({
655
615
  event_type: z.literal('device.name_changed'),
656
- device_name: z.string().describe('The new name of the device.'),
616
+ device_name: z.string().describe('The new name of the affected device.'),
657
617
  }).describe(`
658
618
  ---
659
619
  route_path: /devices
@@ -6,9 +6,7 @@ const enrollment_automation_event = common_event.extend({
6
6
  enrollment_automation_id: z
7
7
  .string()
8
8
  .uuid()
9
- .describe(
10
- 'ID of the [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut).',
11
- ),
9
+ .describe('ID of the affected enrollment automation.'),
12
10
  })
13
11
 
14
12
  export const enrollment_automation_deleted_event =
@@ -3,12 +3,7 @@ import { z } from 'zod'
3
3
  import { common_event } from './common.js'
4
4
 
5
5
  const phone_event = common_event.extend({
6
- device_id: z
7
- .string()
8
- .uuid()
9
- .describe(
10
- 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
11
- ),
6
+ device_id: z.string().uuid().describe('ID of the affected phone device.'),
12
7
  })
13
8
 
14
9
  export const phone_deactivated_event = phone_event.extend({