@seamapi/types 1.915.0 → 1.917.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 (113) hide show
  1. package/dist/connect.cjs +938 -540
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1928 -1071
  4. package/dist/index.cjs +938 -540
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-access-group.js +6 -4
  7. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  8. package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js +1 -1
  9. package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-credential.js +13 -4
  11. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  12. package/lib/seam/connect/models/acs/acs-encoder.js +2 -2
  13. package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
  14. package/lib/seam/connect/models/acs/acs-system.js +17 -7
  15. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  16. package/lib/seam/connect/models/acs/acs-users/acs-user.js +10 -4
  17. package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
  18. package/lib/seam/connect/models/bridges/bridge-connected-system.js +1 -1
  19. package/lib/seam/connect/models/bridges/bridge-connected-system.js.map +1 -1
  20. package/lib/seam/connect/models/bridges/bridge.js +1 -1
  21. package/lib/seam/connect/models/bridges/bridge.js.map +1 -1
  22. package/lib/seam/connect/models/client-sessions/client-session.js +2 -5
  23. package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
  24. package/lib/seam/connect/models/connect-webviews/connect-webview.js +3 -3
  25. package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
  26. package/lib/seam/connect/models/customer/customer.js +1 -1
  27. package/lib/seam/connect/models/customer/customer.js.map +1 -1
  28. package/lib/seam/connect/models/devices/device-provider.js +8 -4
  29. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  30. package/lib/seam/connect/models/devices/device.js +60 -20
  31. package/lib/seam/connect/models/devices/device.js.map +1 -1
  32. package/lib/seam/connect/models/devices/phone.js +11 -7
  33. package/lib/seam/connect/models/devices/phone.js.map +1 -1
  34. package/lib/seam/connect/models/devices/unmanaged-device.js +3 -1
  35. package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
  36. package/lib/seam/connect/models/events/access-codes.js +8 -4
  37. package/lib/seam/connect/models/events/access-codes.js.map +1 -1
  38. package/lib/seam/connect/models/events/acs/entrances.js +3 -5
  39. package/lib/seam/connect/models/events/acs/entrances.js.map +1 -1
  40. package/lib/seam/connect/models/events/acs/users.js +6 -5
  41. package/lib/seam/connect/models/events/acs/users.js.map +1 -1
  42. package/lib/seam/connect/models/events/action-attempts.js +8 -8
  43. package/lib/seam/connect/models/events/client-sessions.js +1 -1
  44. package/lib/seam/connect/models/events/common.js +9 -5
  45. package/lib/seam/connect/models/events/common.js.map +1 -1
  46. package/lib/seam/connect/models/events/connect-webviews.js +4 -4
  47. package/lib/seam/connect/models/events/connect-webviews.js.map +1 -1
  48. package/lib/seam/connect/models/events/connected-accounts.js +10 -10
  49. package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
  50. package/lib/seam/connect/models/events/devices.js +20 -20
  51. package/lib/seam/connect/models/events/devices.js.map +1 -1
  52. package/lib/seam/connect/models/events/seam-event.js +1 -1
  53. package/lib/seam/connect/models/instant-keys/instant-key.js +2 -2
  54. package/lib/seam/connect/models/instant-keys/instant-key.js.map +1 -1
  55. package/lib/seam/connect/models/partner/customer-portal.js +1 -1
  56. package/lib/seam/connect/models/partner/customer-portal.js.map +1 -1
  57. package/lib/seam/connect/models/partner/magic-link.js +1 -1
  58. package/lib/seam/connect/models/partner/magic-link.js.map +1 -1
  59. package/lib/seam/connect/models/spaces/space.js +1 -1
  60. package/lib/seam/connect/models/spaces/space.js.map +1 -1
  61. package/lib/seam/connect/models/thermostats/modes.js +9 -16
  62. package/lib/seam/connect/models/thermostats/modes.js.map +1 -1
  63. package/lib/seam/connect/models/thermostats/thermostat-program.js +1 -1
  64. package/lib/seam/connect/models/thermostats/thermostat-program.js.map +1 -1
  65. package/lib/seam/connect/models/thermostats/thermostat-schedule.js +1 -1
  66. package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
  67. package/lib/seam/connect/models/user-identities/user-identity.js +10 -3
  68. package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
  69. package/lib/seam/connect/models/webhooks/webhook.js +1 -3
  70. package/lib/seam/connect/models/webhooks/webhook.js.map +1 -1
  71. package/lib/seam/connect/models/workspaces/workspace.js +2 -5
  72. package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
  73. package/lib/seam/connect/openapi.js +758 -363
  74. package/lib/seam/connect/openapi.js.map +1 -1
  75. package/lib/seam/connect/route-types.d.ts +1928 -1071
  76. package/package.json +1 -1
  77. package/src/lib/seam/connect/models/acs/acs-access-group.ts +6 -8
  78. package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts +1 -3
  79. package/src/lib/seam/connect/models/acs/acs-credential.ts +15 -4
  80. package/src/lib/seam/connect/models/acs/acs-encoder.ts +2 -2
  81. package/src/lib/seam/connect/models/acs/acs-system.ts +27 -7
  82. package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +12 -4
  83. package/src/lib/seam/connect/models/bridges/bridge-connected-system.ts +1 -3
  84. package/src/lib/seam/connect/models/bridges/bridge.ts +1 -3
  85. package/src/lib/seam/connect/models/client-sessions/client-session.ts +2 -9
  86. package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +5 -5
  87. package/src/lib/seam/connect/models/customer/customer.ts +1 -3
  88. package/src/lib/seam/connect/models/devices/device-provider.ts +10 -4
  89. package/src/lib/seam/connect/models/devices/device.ts +90 -20
  90. package/src/lib/seam/connect/models/devices/phone.ts +13 -7
  91. package/src/lib/seam/connect/models/devices/unmanaged-device.ts +3 -1
  92. package/src/lib/seam/connect/models/events/access-codes.ts +19 -15
  93. package/src/lib/seam/connect/models/events/acs/entrances.ts +3 -5
  94. package/src/lib/seam/connect/models/events/acs/users.ts +6 -5
  95. package/src/lib/seam/connect/models/events/action-attempts.ts +8 -8
  96. package/src/lib/seam/connect/models/events/client-sessions.ts +1 -1
  97. package/src/lib/seam/connect/models/events/common.ts +33 -27
  98. package/src/lib/seam/connect/models/events/connect-webviews.ts +4 -8
  99. package/src/lib/seam/connect/models/events/connected-accounts.ts +10 -14
  100. package/src/lib/seam/connect/models/events/devices.ts +20 -22
  101. package/src/lib/seam/connect/models/events/seam-event.ts +1 -1
  102. package/src/lib/seam/connect/models/instant-keys/instant-key.ts +2 -6
  103. package/src/lib/seam/connect/models/partner/customer-portal.ts +1 -3
  104. package/src/lib/seam/connect/models/partner/magic-link.ts +1 -3
  105. package/src/lib/seam/connect/models/spaces/space.ts +1 -3
  106. package/src/lib/seam/connect/models/thermostats/modes.ts +15 -16
  107. package/src/lib/seam/connect/models/thermostats/thermostat-program.ts +1 -1
  108. package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +1 -3
  109. package/src/lib/seam/connect/models/user-identities/user-identity.ts +10 -5
  110. package/src/lib/seam/connect/models/webhooks/webhook.ts +1 -5
  111. package/src/lib/seam/connect/models/workspaces/workspace.ts +2 -7
  112. package/src/lib/seam/connect/openapi.ts +905 -507
  113. package/src/lib/seam/connect/route-types.ts +1928 -1071
@@ -32,7 +32,7 @@ export const action_attempt_lock_door_succeeded_event =
32
32
  ---
33
33
  route_path: /action_attempts
34
34
  ---
35
- A lock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded.
35
+ A lock door action attempt succeeded.
36
36
  `)
37
37
 
38
38
  export const action_attempt_lock_door_failed_event =
@@ -42,7 +42,7 @@ export const action_attempt_lock_door_failed_event =
42
42
  ---
43
43
  route_path: /action_attempts
44
44
  ---
45
- A lock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed.
45
+ A lock door action attempt failed.
46
46
  `)
47
47
 
48
48
  export const action_attempt_unlock_door_succeeded_event =
@@ -52,7 +52,7 @@ export const action_attempt_unlock_door_succeeded_event =
52
52
  ---
53
53
  route_path: /action_attempts
54
54
  ---
55
- An unlock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded.
55
+ An unlock door action attempt succeeded.
56
56
  `)
57
57
 
58
58
  export const action_attempt_unlock_door_failed_event =
@@ -62,7 +62,7 @@ export const action_attempt_unlock_door_failed_event =
62
62
  ---
63
63
  route_path: /action_attempts
64
64
  ---
65
- An unlock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed.
65
+ An unlock door action attempt failed.
66
66
  `)
67
67
 
68
68
  export const action_attempt_simulate_keypad_code_entry_succeeded_event =
@@ -74,7 +74,7 @@ export const action_attempt_simulate_keypad_code_entry_succeeded_event =
74
74
  ---
75
75
  route_path: /action_attempts
76
76
  ---
77
- A simulate keypad code entry [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded.
77
+ A simulate keypad code entry action attempt succeeded.
78
78
  `)
79
79
 
80
80
  export const action_attempt_simulate_keypad_code_entry_failed_event =
@@ -84,7 +84,7 @@ export const action_attempt_simulate_keypad_code_entry_failed_event =
84
84
  ---
85
85
  route_path: /action_attempts
86
86
  ---
87
- A simulate keypad code entry [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed.
87
+ A simulate keypad code entry action attempt failed.
88
88
  `)
89
89
 
90
90
  export const action_attempt_simulate_manual_lock_via_keypad_succeeded_event =
@@ -96,7 +96,7 @@ export const action_attempt_simulate_manual_lock_via_keypad_succeeded_event =
96
96
  ---
97
97
  route_path: /action_attempts
98
98
  ---
99
- A simulate manual lock via keypad [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded.
99
+ A simulate manual lock via keypad action attempt succeeded.
100
100
  `)
101
101
 
102
102
  export const action_attempt_simulate_manual_lock_via_keypad_failed_event =
@@ -108,7 +108,7 @@ export const action_attempt_simulate_manual_lock_via_keypad_failed_event =
108
108
  ---
109
109
  route_path: /action_attempts
110
110
  ---
111
- A simulate manual lock via keypad [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed.
111
+ A simulate manual lock via keypad action attempt failed.
112
112
  `)
113
113
 
114
114
  export const action_attempt_events = [
@@ -15,7 +15,7 @@ export const client_session_deleted_event = client_session_event.extend({
15
15
  ---
16
16
  route_path: /client_sessions
17
17
  ---
18
- A [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was deleted.
18
+ A client session was deleted.
19
19
  `)
20
20
 
21
21
  export type ClientSessionDeletedEvent = z.infer<
@@ -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/core-concepts/workspaces) associated with the event.',
10
- ),
8
+ .describe('ID of the workspace associated with the event.'),
11
9
  created_at: z
12
10
  .string()
13
11
  .datetime()
@@ -23,28 +21,36 @@ const error_code_description =
23
21
  const warning_code_description =
24
22
  'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
25
23
 
26
- export const common_event_error = z.object({
27
- created_at: z
28
- .string()
29
- .datetime()
30
- .describe('Date and time at which Seam created the error.'),
31
- message: z
32
- .string()
33
- .describe(
34
- 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
35
- ),
36
- error_code: z.string().describe(error_code_description),
37
- })
24
+ export const common_event_error = z
25
+ .object({
26
+ created_at: z
27
+ .string()
28
+ .datetime()
29
+ .describe('Date and time at which Seam created the error.'),
30
+ message: z
31
+ .string()
32
+ .describe(
33
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
34
+ ),
35
+ error_code: z.string().describe(error_code_description),
36
+ })
37
+ .describe(
38
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
39
+ )
38
40
 
39
- export const common_event_warning = z.object({
40
- created_at: z
41
- .string()
42
- .datetime()
43
- .describe('Date and time at which Seam created the warning.'),
44
- message: z
45
- .string()
46
- .describe(
47
- 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
48
- ),
49
- warning_code: z.string().describe(warning_code_description),
50
- })
41
+ export const common_event_warning = z
42
+ .object({
43
+ created_at: z
44
+ .string()
45
+ .datetime()
46
+ .describe('Date and time at which Seam created the warning.'),
47
+ message: z
48
+ .string()
49
+ .describe(
50
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
51
+ ),
52
+ warning_code: z.string().describe(warning_code_description),
53
+ })
54
+ .describe(
55
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
56
+ )
@@ -7,17 +7,13 @@ const connect_webview_event = common_event.extend({
7
7
  connect_webview_id: z
8
8
  .string()
9
9
  .uuid()
10
- .describe(
11
- 'ID of the affected [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).',
12
- ),
10
+ .describe('ID of the affected Connect Webview.'),
13
11
  })
14
12
 
15
13
  const connected_account_id = z
16
14
  .string()
17
15
  .uuid()
18
- .describe(
19
- 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.',
20
- )
16
+ .describe('ID of the connected account associated with the event.')
21
17
 
22
18
  const connected_account_custom_metadata = custom_metadata
23
19
  .optional()
@@ -40,7 +36,7 @@ export const connect_webview_login_succeeded_event =
40
36
  ---
41
37
  route_path: /connect_webviews
42
38
  ---
43
- A [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) login succeeded.
39
+ A Connect Webview login succeeded.
44
40
  `)
45
41
 
46
42
  export type ConnectWebviewLoginSucceededEvent = z.infer<
@@ -53,7 +49,7 @@ export const connect_webview_login_failed_event = connect_webview_event.extend({
53
49
  ---
54
50
  route_path: /connect_webviews
55
51
  ---
56
- A [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) login failed.
52
+ A Connect Webview login failed.
57
53
  `)
58
54
 
59
55
  export type ConnectWebviewLoginFailedEvent = z.infer<
@@ -11,9 +11,7 @@ const connected_account_event = common_event.extend({
11
11
  connected_account_id: z
12
12
  .string()
13
13
  .uuid()
14
- .describe(
15
- 'ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts).',
16
- ),
14
+ .describe('ID of the affected connected account.'),
17
15
  connected_account_custom_metadata: custom_metadata
18
16
  .optional()
19
17
  .describe(
@@ -24,9 +22,7 @@ const connected_account_event = common_event.extend({
24
22
  const connect_webview_id = z
25
23
  .string()
26
24
  .uuid()
27
- .describe(
28
- 'ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event.',
29
- )
25
+ .describe('ID of the Connect Webview associated with the event.')
30
26
 
31
27
  const connected_account_event_issue_properties = {
32
28
  connected_account_errors: z
@@ -52,7 +48,7 @@ export const connected_account_connected_event = connected_account_event.extend(
52
48
  ---
53
49
  route_path: /connected_accounts
54
50
  ---
55
- A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was connected for the first time or was reconnected after being disconnected.
51
+ A connected account was connected for the first time or was reconnected after being disconnected.
56
52
  `)
57
53
 
58
54
  export type ConnectedAccountConnectedEvent = z.infer<
@@ -66,7 +62,7 @@ export const connected_account_created_event = connected_account_event.extend({
66
62
  ---
67
63
  route_path: /connected_accounts
68
64
  ---
69
- A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was created.
65
+ A connected account was created.
70
66
  `)
71
67
 
72
68
  export type ConnectedAccountCreatedEvent = z.infer<
@@ -82,7 +78,7 @@ export const connected_account_successful_login_event =
82
78
  deprecated: Use \`connect_webview.login_succeeded\`.
83
79
  route_path: /connected_accounts
84
80
  ---
85
- A [connected account](https://docs.seam.co/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).
81
+ A connected account had a successful login using a Connect Webview.
86
82
  `)
87
83
 
88
84
  /** @deprecated Rely on ConnectWebviewLoginSucceededEvent instead */
@@ -98,7 +94,7 @@ export const connected_account_disconnected_event = connected_account_event
98
94
  ---
99
95
  route_path: /connected_accounts
100
96
  ---
101
- A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was disconnected.
97
+ A connected account was disconnected.
102
98
  `)
103
99
 
104
100
  export type ConnectedAccountDisconnectedEvent = z.infer<
@@ -112,7 +108,7 @@ export const connected_account_completed_first_sync_event =
112
108
  ---
113
109
  route_path: /connected_accounts
114
110
  ---
115
- A [connected account](https://docs.seam.co/core-concepts/connected-accounts) completed the first sync with Seam, and the corresponding devices or systems are now available.
111
+ A connected account completed the first sync with Seam, and the corresponding devices or systems are now available.
116
112
  `)
117
113
 
118
114
  export type ConnectedAccountCompletedFirstSyncEvent = z.infer<
@@ -135,7 +131,7 @@ export const connected_account_deleted_event = connected_account_event.extend({
135
131
  ---
136
132
  route_path: /connected_accounts
137
133
  ---
138
- A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was deleted.
134
+ A connected account was deleted.
139
135
  `)
140
136
 
141
137
  export type ConnectedAccountDeletedEvent = z.infer<
@@ -151,7 +147,7 @@ export const connected_account_completed_first_sync_after_reconnection_event =
151
147
  ---
152
148
  route_path: /connected_accounts
153
149
  ---
154
- A [connected account](https://docs.seam.co/core-concepts/connected-accounts) completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.
150
+ A connected account completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.
155
151
  `)
156
152
 
157
153
  export type ConnectedAccountCompletedFirstSyncAfterReconnectionEvent = z.infer<
@@ -167,7 +163,7 @@ export const connected_account_reauthorization_requested_event =
167
163
  ---
168
164
  route_path: /connected_accounts
169
165
  ---
170
- A [connected account](https://docs.seam.co/core-concepts/connected-accounts) requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.
166
+ A connected account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.
171
167
  `)
172
168
 
173
169
  export type ConnectedAccountReauthorizationRequestedEvent = z.infer<
@@ -13,9 +13,7 @@ const device_event = common_event.extend({
13
13
  connected_account_id: z
14
14
  .string()
15
15
  .uuid()
16
- .describe(
17
- 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.',
18
- ),
16
+ .describe('ID of the connected account associated with the event.'),
19
17
  customer_key: z
20
18
  .string()
21
19
  .optional()
@@ -78,7 +76,7 @@ export const device_connected_event = device_event.extend({
78
76
  ---
79
77
  route_path: /devices
80
78
  ---
81
- The status of a [device](https://docs.seam.co/core-concepts/devices) changed from offline to online. That is, the \`device.properties.online\` property changed from \`false\` to \`true\`. Note that some devices operate entirely in offline mode, so Seam never emits a \`device.connected\` event for these devices.
79
+ The status of a device changed from offline to online. That is, the \`device.properties.online\` property changed from \`false\` to \`true\`. Note that some devices operate entirely in offline mode, so Seam never emits a \`device.connected\` event for these devices.
82
80
  `)
83
81
 
84
82
  export type DeviceConnectedEvent = z.infer<typeof device_connected_event>
@@ -89,7 +87,7 @@ export const device_added_event = device_event.extend({
89
87
  ---
90
88
  route_path: /devices
91
89
  ---
92
- A [device](https://docs.seam.co/core-concepts/devices) was added to Seam or was re-added to Seam after having been removed.
90
+ A device was added to Seam or was re-added to Seam after having been removed.
93
91
  `)
94
92
 
95
93
  export type DeviceAddedEvent = z.infer<typeof device_added_event>
@@ -142,7 +140,7 @@ export const device_disconnected_event = device_event
142
140
  ---
143
141
  route_path: /devices
144
142
  ---
145
- The status of a [device](https://docs.seam.co/core-concepts/devices) changed from online to offline. That is, the \`device.properties.online\` property changed from \`true\` to \`false\`.
143
+ The status of a device changed from online to offline. That is, the \`device.properties.online\` property changed from \`true\` to \`false\`.
146
144
  `)
147
145
 
148
146
  export type DeviceDisconnectedEvent = z.infer<typeof device_disconnected_event>
@@ -169,7 +167,7 @@ export const device_tampered_event = device_event.extend({
169
167
  ---
170
168
  route_path: /devices
171
169
  ---
172
- A [device](https://docs.seam.co/core-concepts/devices) detected that it was tampered with, for example, opened or moved.
170
+ A device detected that it was tampered with, for example, opened or moved.
173
171
  `)
174
172
 
175
173
  export type DeviceTamperedEvent = z.infer<typeof device_tampered_event>
@@ -181,7 +179,7 @@ export const device_low_battery_event = device_event.extend({
181
179
  ---
182
180
  route_path: /devices
183
181
  ---
184
- A [device](https://docs.seam.co/core-concepts/devices) battery level dropped below the low threshold.
182
+ A device battery level dropped below the low threshold.
185
183
  `)
186
184
 
187
185
  export type DeviceLowBatteryEvent = z.infer<typeof device_low_battery_event>
@@ -194,7 +192,7 @@ export const device_battery_status_changed_event = device_event.extend({
194
192
  ---
195
193
  route_path: /devices
196
194
  ---
197
- A [device](https://docs.seam.co/core-concepts/devices) battery status changed since the last \`battery_status_changed\` event.
195
+ A device battery status changed since the last \`battery_status_changed\` event.
198
196
  `)
199
197
 
200
198
  export type DeviceBatteryStatusChangedEvent = z.infer<
@@ -207,7 +205,7 @@ export const device_removed_event = device_event.extend({
207
205
  ---
208
206
  route_path: /devices
209
207
  ---
210
- A [device](https://docs.seam.co/core-concepts/devices) was removed externally from the [connected account](https://docs.seam.co/core-concepts/connected-accounts).
208
+ A device was removed externally from the connected account.
211
209
  `)
212
210
 
213
211
  export type DeviceRemovedEvent = z.infer<typeof device_removed_event>
@@ -225,7 +223,7 @@ export const device_deleted_event = device_event.extend({
225
223
  ---
226
224
  route_path: /devices
227
225
  ---
228
- A [device](https://docs.seam.co/core-concepts/devices) was deleted.
226
+ A device was deleted.
229
227
  `)
230
228
 
231
229
  export type DeviceDeletedEvent = z.infer<typeof device_deleted_event>
@@ -237,7 +235,7 @@ export const device_third_party_integration_detected_event =
237
235
  ---
238
236
  route_path: /devices
239
237
  ---
240
- Seam detected that a [device](https://docs.seam.co/core-concepts/devices) is using a third-party integration that will interfere with Seam device management.
238
+ Seam detected that a device is using a third-party integration that will interfere with Seam device management.
241
239
  `)
242
240
 
243
241
  export type DeviceThirdPartyIntegrationDetectedEvent = z.infer<
@@ -251,7 +249,7 @@ export const device_third_party_integration_no_longer_detected_event =
251
249
  ---
252
250
  route_path: /devices
253
251
  ---
254
- Seam detected that a [device](https://docs.seam.co/core-concepts/devices) is no longer using a third-party integration that was interfering with Seam device management.
252
+ Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.
255
253
  `)
256
254
 
257
255
  export type DeviceThirdPartyIntegrationNoLongerDetectedEvent = z.infer<
@@ -292,7 +290,7 @@ export const device_connection_became_flaky_event = device_event
292
290
  ---
293
291
  route_path: /devices
294
292
  ---
295
- Seam detected a flaky [device](https://docs.seam.co/core-concepts/devices) connection.
293
+ Seam detected a flaky device connection.
296
294
  `)
297
295
 
298
296
  export type DeviceConnectionBecameFlakyEvent = z.infer<
@@ -305,7 +303,7 @@ export const device_connection_stabilized_event = device_event.extend({
305
303
  ---
306
304
  route_path: /devices
307
305
  ---
308
- Seam detected that a previously-flaky [device](https://docs.seam.co/core-concepts/devices) connection stabilized.
306
+ Seam detected that a previously-flaky device connection stabilized.
309
307
  `)
310
308
 
311
309
  export type DeviceConnectionStabilizedEvent = z.infer<
@@ -320,7 +318,7 @@ export const device_error_subscription_required_event = device_event
320
318
  ---
321
319
  route_path: /devices
322
320
  ---
323
- A third-party subscription is required to use all [device](https://docs.seam.co/core-concepts/devices) features.
321
+ A third-party subscription is required to use all device features.
324
322
  `)
325
323
 
326
324
  export type DeviceErrorSubscriptionRequiredEvent = z.infer<
@@ -334,7 +332,7 @@ export const device_error_subscription_required_resolved_event =
334
332
  ---
335
333
  route_path: /devices
336
334
  ---
337
- A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/core-concepts/devices) features.
335
+ A third-party subscription is active or no longer required to use all device features.
338
336
  `)
339
337
 
340
338
  export type DeviceErrorSubscriptionRequiredResolvedEvent = z.infer<
@@ -347,7 +345,7 @@ export const device_accessory_keypad_connected_event = device_event.extend({
347
345
  ---
348
346
  route_path: /devices
349
347
  ---
350
- An accessory keypad was connected to a [device](https://docs.seam.co/core-concepts/devices).
348
+ An accessory keypad was connected to a device.
351
349
  `)
352
350
 
353
351
  export type DeviceAccessoryKeypadConnectedEvent = z.infer<
@@ -362,7 +360,7 @@ export const device_accessory_keypad_disconnected_event = device_event
362
360
  ---
363
361
  route_path: /devices
364
362
  ---
365
- An accessory keypad was disconnected from a [device](https://docs.seam.co/core-concepts/devices).
363
+ An accessory keypad was disconnected from a device.
366
364
  `)
367
365
 
368
366
  export type DeviceAccessoryKeypadDisconnectedEvent = z.infer<
@@ -724,7 +722,7 @@ export const device_name_changed_event = device_event.extend({
724
722
  ---
725
723
  route_path: /devices
726
724
  ---
727
- The name of a [device](https://docs.seam.co/core-concepts/devices) was changed.
725
+ The name of a device was changed.
728
726
  `)
729
727
 
730
728
  export type DeviceNameChangedEvent = z.infer<typeof device_name_changed_event>
@@ -752,7 +750,7 @@ export const camera_activated_event = device_event.extend({
752
750
  ---
753
751
  route_path: /devices
754
752
  ---
755
- A [camera](https://docs.seam.co/core-concepts/devices) was activated, for example, by motion detection.
753
+ A camera was activated, for example, by motion detection.
756
754
  `)
757
755
 
758
756
  export type CameraActivatedEvent = z.infer<typeof camera_activated_event>
@@ -777,7 +775,7 @@ export const device_doorbell_rang_event = device_event.extend({
777
775
  ---
778
776
  route_path: /devices
779
777
  ---
780
- A doorbell button was pressed on a [device](https://docs.seam.co/core-concepts/devices).
778
+ A doorbell button was pressed on a device.
781
779
  `)
782
780
 
783
781
  export type DeviceDoorbellRangEvent = z.infer<typeof device_doorbell_rang_event>
@@ -32,7 +32,7 @@ export const seam_event = z.discriminatedUnion('event_type', [
32
32
  ---
33
33
  Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a \`lock.unlocked\` event. When a device's battery level is low, Seam creates a \`device.battery_low\` event.
34
34
 
35
- As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.
35
+ As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate webhook system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.
36
36
  `)
37
37
 
38
38
  export type SeamEvent = z.infer<typeof seam_event>
@@ -5,9 +5,7 @@ export const instant_key = z.object({
5
5
  workspace_id: z
6
6
  .string()
7
7
  .uuid()
8
- .describe(
9
- 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Instant Key.',
10
- ),
8
+ .describe('ID of the workspace that contains the Instant Key.'),
11
9
  created_at: z
12
10
  .string()
13
11
  .datetime()
@@ -21,9 +19,7 @@ export const instant_key = z.object({
21
19
  client_session_id: z
22
20
  .string()
23
21
  .uuid()
24
- .describe(
25
- 'ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) associated with the Instant Key.',
26
- ),
22
+ .describe('ID of the client session associated with the Instant Key.'),
27
23
  user_identity_id: z
28
24
  .string()
29
25
  .uuid()
@@ -11,9 +11,7 @@ export const customer_portal = z
11
11
  workspace_id: z
12
12
  .string()
13
13
  .uuid()
14
- .describe(
15
- 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the customer portal.',
16
- ),
14
+ .describe('ID of the workspace associated with the customer portal.'),
17
15
  created_at: z
18
16
  .string()
19
17
  .datetime()
@@ -10,9 +10,7 @@ export const magic_link = z.object({
10
10
  workspace_id: z
11
11
  .string()
12
12
  .uuid()
13
- .describe(
14
- 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the magic link.',
15
- ),
13
+ .describe('ID of the workspace associated with the magic link.'),
16
14
  created_at: z
17
15
  .string()
18
16
  .datetime()
@@ -40,9 +40,7 @@ export const space = z.object({
40
40
  workspace_id: z
41
41
  .string()
42
42
  .uuid()
43
- .describe(
44
- 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space.',
45
- ),
43
+ .describe('ID of the workspace associated with the space.'),
46
44
  space_key: z
47
45
  .string()
48
46
  .optional()
@@ -1,16 +1,18 @@
1
1
  import { z } from 'zod'
2
2
 
3
- export const hvac_mode_setting = z.enum([
4
- 'off',
5
- 'heat',
6
- 'cool',
7
- 'heat_cool',
8
- 'eco',
9
- ])
3
+ export const hvac_mode_setting = z
4
+ .enum(['off', 'heat', 'cool', 'heat_cool', 'eco'])
5
+ .describe(
6
+ 'HVAC mode setting for the thermostat, such as `heat`, `cool`, `heat_cool`, `eco`, or `off`.',
7
+ )
10
8
 
11
9
  export type HvacModeSetting = z.infer<typeof hvac_mode_setting>
12
10
 
13
- export const fan_mode_setting = z.enum(['auto', 'on', 'circulate'])
11
+ export const fan_mode_setting = z
12
+ .enum(['auto', 'on', 'circulate'])
13
+ .describe(
14
+ 'Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.',
15
+ )
14
16
 
15
17
  export type FanModeSetting = z.infer<typeof fan_mode_setting>
16
18
 
@@ -20,13 +22,10 @@ export type AvailableFanModeSettings = z.infer<
20
22
  typeof available_fan_mode_settings
21
23
  >
22
24
 
23
- export const climate_preset_mode = z.enum([
24
- 'home',
25
- 'away',
26
- 'wake',
27
- 'sleep',
28
- 'occupied',
29
- 'unoccupied',
30
- ])
25
+ export const climate_preset_mode = z
26
+ .enum(['home', 'away', 'wake', 'sleep', 'occupied', 'unoccupied'])
27
+ .describe(
28
+ 'Climate preset mode for the thermostat, such as `home`, `away`, `wake`, `sleep`, `occupied`, or `unoccupied`.',
29
+ )
31
30
 
32
31
  export type ClimatePresetMode = z.infer<typeof climate_preset_mode>
@@ -40,7 +40,7 @@ export const thermostat_daily_program = z.object({
40
40
  .string()
41
41
  .uuid()
42
42
  .describe(
43
- 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program.',
43
+ 'ID of the workspace that contains the thermostat daily program.',
44
44
  ),
45
45
  created_at: z
46
46
  .string()
@@ -54,9 +54,7 @@ export const thermostat_schedule = z.object({
54
54
  workspace_id: z
55
55
  .string()
56
56
  .uuid()
57
- .describe(
58
- 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule.',
59
- ),
57
+ .describe('ID of the workspace that contains the thermostat schedule.'),
60
58
  created_at: z
61
59
  .string()
62
60
  .datetime()
@@ -119,8 +119,15 @@ export const user_identity = z.object({
119
119
  .describe(
120
120
  'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
121
121
  ),
122
- display_name: z.string().min(1),
123
- full_name: z.string().min(1).nullable(),
122
+ display_name: z
123
+ .string()
124
+ .min(1)
125
+ .describe('Display name for the user identity.'),
126
+ full_name: z
127
+ .string()
128
+ .min(1)
129
+ .nullable()
130
+ .describe('Full name of the user associated with the user identity.'),
124
131
  created_at: z
125
132
  .string()
126
133
  .datetime()
@@ -128,9 +135,7 @@ export const user_identity = z.object({
128
135
  workspace_id: z
129
136
  .string()
130
137
  .uuid()
131
- .describe(
132
- 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity.',
133
- ),
138
+ .describe('ID of the workspace that contains the user identity.'),
134
139
  errors: z
135
140
  .array(user_identity_errors)
136
141
  .describe(
@@ -1,11 +1,7 @@
1
1
  import { z } from 'zod'
2
2
 
3
3
  export const webhook = z.object({
4
- webhook_id: z
5
- .string()
6
- .describe(
7
- 'ID of the [webhook](https://docs.seam.co/developer-tools/webhooks).',
8
- ),
4
+ webhook_id: z.string().describe('ID of the webhook.'),
9
5
  url: z
10
6
  .string()
11
7
  .describe(
@@ -3,12 +3,7 @@ import { z } from 'zod'
3
3
  import { hex_color_code } from '../colors.js'
4
4
 
5
5
  export const workspace = z.object({
6
- workspace_id: z
7
- .string()
8
- .uuid()
9
- .describe(
10
- 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces).',
11
- ),
6
+ workspace_id: z.string().uuid().describe('ID of the workspace.'),
12
7
  name: z
13
8
  .string()
14
9
  .describe(
@@ -86,7 +81,7 @@ export const workspace = z.object({
86
81
  .uuid()
87
82
  .nullable()
88
83
  .describe(
89
- 'ID of the organization to which the [workspace](https://docs.seam.co/core-concepts/workspaces) belongs, or `null` if the workspace is not assigned to an organization.',
84
+ 'ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization.',
90
85
  ),
91
86
  }).describe(`
92
87
  ---