@seamapi/types 1.914.0 → 1.916.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 (94) hide show
  1. package/dist/connect.cjs +347 -386
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1080 -1056
  4. package/dist/index.cjs +347 -386
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-access-group.js +2 -2
  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 +1 -1
  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 +2 -2
  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 +2 -2
  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 +2 -2
  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/phone.js +1 -1
  29. package/lib/seam/connect/models/events/access-codes.js +25 -13
  30. package/lib/seam/connect/models/events/access-codes.js.map +1 -1
  31. package/lib/seam/connect/models/events/action-attempts.js +8 -8
  32. package/lib/seam/connect/models/events/client-sessions.js +1 -1
  33. package/lib/seam/connect/models/events/common.js +1 -1
  34. package/lib/seam/connect/models/events/common.js.map +1 -1
  35. package/lib/seam/connect/models/events/connect-webviews.js +4 -4
  36. package/lib/seam/connect/models/events/connect-webviews.js.map +1 -1
  37. package/lib/seam/connect/models/events/connected-accounts.js +10 -10
  38. package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
  39. package/lib/seam/connect/models/events/devices.js +20 -20
  40. package/lib/seam/connect/models/events/devices.js.map +1 -1
  41. package/lib/seam/connect/models/events/seam-event.js +1 -1
  42. package/lib/seam/connect/models/instant-keys/instant-key.js +2 -2
  43. package/lib/seam/connect/models/instant-keys/instant-key.js.map +1 -1
  44. package/lib/seam/connect/models/partner/customer-portal.js +1 -1
  45. package/lib/seam/connect/models/partner/customer-portal.js.map +1 -1
  46. package/lib/seam/connect/models/partner/magic-link.js +1 -1
  47. package/lib/seam/connect/models/partner/magic-link.js.map +1 -1
  48. package/lib/seam/connect/models/spaces/space.js +1 -1
  49. package/lib/seam/connect/models/spaces/space.js.map +1 -1
  50. package/lib/seam/connect/models/thermostats/thermostat-program.js +1 -1
  51. package/lib/seam/connect/models/thermostats/thermostat-program.js.map +1 -1
  52. package/lib/seam/connect/models/thermostats/thermostat-schedule.js +1 -1
  53. package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
  54. package/lib/seam/connect/models/user-identities/user-identity.js +1 -1
  55. package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
  56. package/lib/seam/connect/models/webhooks/webhook.js +1 -3
  57. package/lib/seam/connect/models/webhooks/webhook.js.map +1 -1
  58. package/lib/seam/connect/models/workspaces/workspace.js +2 -5
  59. package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
  60. package/lib/seam/connect/openapi.js +270 -267
  61. package/lib/seam/connect/openapi.js.map +1 -1
  62. package/lib/seam/connect/route-types.d.ts +1080 -1056
  63. package/package.json +1 -1
  64. package/src/lib/seam/connect/models/acs/acs-access-group.ts +2 -6
  65. package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts +1 -3
  66. package/src/lib/seam/connect/models/acs/acs-credential.ts +1 -1
  67. package/src/lib/seam/connect/models/acs/acs-encoder.ts +2 -2
  68. package/src/lib/seam/connect/models/acs/acs-system.ts +2 -2
  69. package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +2 -2
  70. package/src/lib/seam/connect/models/bridges/bridge-connected-system.ts +1 -3
  71. package/src/lib/seam/connect/models/bridges/bridge.ts +1 -3
  72. package/src/lib/seam/connect/models/client-sessions/client-session.ts +2 -9
  73. package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +2 -4
  74. package/src/lib/seam/connect/models/customer/customer.ts +1 -3
  75. package/src/lib/seam/connect/models/devices/phone.ts +1 -1
  76. package/src/lib/seam/connect/models/events/access-codes.ts +33 -21
  77. package/src/lib/seam/connect/models/events/action-attempts.ts +8 -8
  78. package/src/lib/seam/connect/models/events/client-sessions.ts +1 -1
  79. package/src/lib/seam/connect/models/events/common.ts +1 -3
  80. package/src/lib/seam/connect/models/events/connect-webviews.ts +4 -8
  81. package/src/lib/seam/connect/models/events/connected-accounts.ts +10 -14
  82. package/src/lib/seam/connect/models/events/devices.ts +20 -22
  83. package/src/lib/seam/connect/models/events/seam-event.ts +1 -1
  84. package/src/lib/seam/connect/models/instant-keys/instant-key.ts +2 -6
  85. package/src/lib/seam/connect/models/partner/customer-portal.ts +1 -3
  86. package/src/lib/seam/connect/models/partner/magic-link.ts +1 -3
  87. package/src/lib/seam/connect/models/spaces/space.ts +1 -3
  88. package/src/lib/seam/connect/models/thermostats/thermostat-program.ts +1 -1
  89. package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +1 -3
  90. package/src/lib/seam/connect/models/user-identities/user-identity.ts +1 -3
  91. package/src/lib/seam/connect/models/webhooks/webhook.ts +1 -5
  92. package/src/lib/seam/connect/models/workspaces/workspace.ts +2 -7
  93. package/src/lib/seam/connect/openapi.ts +270 -411
  94. package/src/lib/seam/connect/route-types.ts +1080 -1056
@@ -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()
@@ -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()
@@ -128,9 +128,7 @@ export const user_identity = z.object({
128
128
  workspace_id: z
129
129
  .string()
130
130
  .uuid()
131
- .describe(
132
- 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity.',
133
- ),
131
+ .describe('ID of the workspace that contains the user identity.'),
134
132
  errors: z
135
133
  .array(user_identity_errors)
136
134
  .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
  ---