@seamapi/types 1.405.0 → 1.406.1

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 (54) hide show
  1. package/dist/connect.cjs +2217 -559
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +7283 -405
  4. package/lib/seam/connect/models/devices/capabilities-supported.js +3 -1
  5. package/lib/seam/connect/models/devices/capabilities-supported.js.map +1 -1
  6. package/lib/seam/connect/models/devices/capability-properties/access-code.js +53 -21
  7. package/lib/seam/connect/models/devices/capability-properties/access-code.js.map +1 -1
  8. package/lib/seam/connect/models/devices/capability-properties/lock.js +20 -4
  9. package/lib/seam/connect/models/devices/capability-properties/lock.js.map +1 -1
  10. package/lib/seam/connect/models/devices/capability-properties/thermostat.js +175 -31
  11. package/lib/seam/connect/models/devices/capability-properties/thermostat.js.map +1 -1
  12. package/lib/seam/connect/models/devices/device-metadata.js +455 -191
  13. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  14. package/lib/seam/connect/models/devices/device-type.js +8 -6
  15. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  16. package/lib/seam/connect/models/devices/device.js +171 -80
  17. package/lib/seam/connect/models/devices/device.js.map +1 -1
  18. package/lib/seam/connect/models/devices/phone-properties.js +5 -7
  19. package/lib/seam/connect/models/devices/phone-properties.js.map +1 -1
  20. package/lib/seam/connect/models/devices/phone.js +22 -8
  21. package/lib/seam/connect/models/devices/phone.js.map +1 -1
  22. package/lib/seam/connect/models/devices/unmanaged-device.js +35 -1
  23. package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
  24. package/lib/seam/connect/models/events/devices.d.ts +4 -4
  25. package/lib/seam/connect/models/events/seam-event.d.ts +2 -2
  26. package/lib/seam/connect/models/index.d.ts +1 -0
  27. package/lib/seam/connect/models/index.js +1 -0
  28. package/lib/seam/connect/models/index.js.map +1 -1
  29. package/lib/seam/connect/models/partner/index.d.ts +1 -0
  30. package/lib/seam/connect/models/partner/index.js +2 -0
  31. package/lib/seam/connect/models/partner/index.js.map +1 -0
  32. package/lib/seam/connect/models/partner/resources.d.ts +42 -0
  33. package/lib/seam/connect/models/partner/resources.js +19 -0
  34. package/lib/seam/connect/models/partner/resources.js.map +1 -0
  35. package/lib/seam/connect/openapi.d.ts +979 -47
  36. package/lib/seam/connect/openapi.js +1331 -205
  37. package/lib/seam/connect/openapi.js.map +1 -1
  38. package/lib/seam/connect/route-types.d.ts +6264 -318
  39. package/package.json +2 -2
  40. package/src/lib/seam/connect/models/devices/capabilities-supported.ts +3 -1
  41. package/src/lib/seam/connect/models/devices/capability-properties/access-code.ts +64 -34
  42. package/src/lib/seam/connect/models/devices/capability-properties/lock.ts +20 -4
  43. package/src/lib/seam/connect/models/devices/capability-properties/thermostat.ts +175 -31
  44. package/src/lib/seam/connect/models/devices/device-metadata.ts +457 -193
  45. package/src/lib/seam/connect/models/devices/device-type.ts +10 -6
  46. package/src/lib/seam/connect/models/devices/device.ts +173 -96
  47. package/src/lib/seam/connect/models/devices/phone-properties.ts +34 -36
  48. package/src/lib/seam/connect/models/devices/phone.ts +22 -19
  49. package/src/lib/seam/connect/models/devices/unmanaged-device.ts +35 -1
  50. package/src/lib/seam/connect/models/index.ts +1 -0
  51. package/src/lib/seam/connect/models/partner/index.ts +1 -0
  52. package/src/lib/seam/connect/models/partner/resources.ts +24 -0
  53. package/src/lib/seam/connect/openapi.ts +1577 -210
  54. package/src/lib/seam/connect/route-types.ts +6267 -318
@@ -1,248 +1,512 @@
1
1
  import { z } from 'zod';
2
2
  export const dormakaba_oracode_time_slot = z.object({
3
- name: z.string(),
4
- prefix: z.number(),
3
+ name: z.string().describe(`Name of a time slot for a dormakaba Oracode device.
4
+ `),
5
+ prefix: z.number()
6
+ .describe(`Prefix for a time slot for a dormakaba Oracode device.
7
+ `),
5
8
  // Seam TOD
6
- check_in_time: z.string(),
9
+ check_in_time: z.string()
10
+ .describe(`Check in time for a time slot for a dormakaba Oracode device.
11
+ `),
7
12
  // Seam TOD
8
- check_out_time: z.string(),
9
- is_24_hour: z.boolean(),
10
- is_biweekly_mode: z.boolean(),
11
- is_one_shot: z.boolean(),
12
- is_master: z.boolean(),
13
- ext_dormakaba_oracode_user_level_prefix: z.number(),
14
- dormakaba_oracode_user_level_id: z.string().uuid(),
15
- });
13
+ check_out_time: z.string()
14
+ .describe(`Checkout time for a time slot for a dormakaba Oracode device.
15
+ `),
16
+ is_24_hour: z.boolean()
17
+ .describe(`Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot.
18
+ `),
19
+ is_biweekly_mode: z.boolean()
20
+ .describe(`Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode.
21
+ `),
22
+ is_one_shot: z.boolean()
23
+ .describe(`Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot.
24
+ `),
25
+ is_master: z.boolean()
26
+ .describe(`Indicates whether a time slot for a dormakaba Oracode device is a master time slot.
27
+ `),
28
+ ext_dormakaba_oracode_user_level_prefix: z.number()
29
+ .describe(`Prefix for a user level for a dormakaba Oracode device.
30
+ `),
31
+ dormakaba_oracode_user_level_id: z.string().uuid()
32
+ .describe(`ID of a user level for a dormakaba Oracode device.
33
+ `),
34
+ }).describe(`Time slot for a dormakaba Oracode device.
35
+ `);
16
36
  export const device_metadata = z
17
37
  .object({
18
38
  august_metadata: z.object({
19
- lock_id: z.string(),
20
- lock_name: z.string(),
21
- house_name: z.string(),
22
- has_keypad: z.boolean(),
23
- keypad_battery_level: z.string().optional(),
24
- model: z.string().optional(),
25
- house_id: z.string().optional(),
26
- }),
39
+ lock_id: z.string().describe(`Lock ID for an August device.
40
+ `),
41
+ lock_name: z.string().describe(`Lock name for an August device.
42
+ `),
43
+ house_name: z.string().describe(`House name for an August device.
44
+ `),
45
+ has_keypad: z.boolean()
46
+ .describe(`Indicates whether an August device has a keypad.
47
+ `),
48
+ keypad_battery_level: z.string().optional()
49
+ .describe(`Keypad battery level for an August device.
50
+ `),
51
+ model: z.string().optional().describe(`Model for an August device.
52
+ `),
53
+ house_id: z.string().optional().describe(`House ID for an August device.
54
+ `),
55
+ }).describe(`Metadata for an August device.
56
+ `),
27
57
  avigilon_alta_metadata: z.object({
28
- entry_name: z.string(),
29
- org_name: z.string(),
30
- zone_id: z.number(),
31
- zone_name: z.string(),
32
- site_id: z.number(),
33
- site_name: z.string(),
34
- entry_relays_total_count: z.number(),
35
- }),
58
+ entry_name: z.string().describe(`Entry name for an Avigilon Alta system.
59
+ `),
60
+ org_name: z.string()
61
+ .describe(`Organization name for an Avigilon Alta system.
62
+ `),
63
+ zone_id: z.number().describe(`Zone ID for an Avigilon Alta system.
64
+ `),
65
+ zone_name: z.string().describe(`Zone name for an Avigilon Alta system.
66
+ `),
67
+ site_id: z.number().describe(`Site ID for an Avigilon Alta system.
68
+ `),
69
+ site_name: z.string().describe(`Site name for an Avigilon Alta system.
70
+ `),
71
+ entry_relays_total_count: z.number()
72
+ .describe(`Total count of entry relays for an Avigilon Alta system.
73
+ `),
74
+ }).describe(`Metadata for an Avigilon Alta system.
75
+ `),
36
76
  schlage_metadata: z.object({
37
- device_id: z.string(),
38
- device_name: z.string(),
39
- model: z.string().optional(),
40
- }),
77
+ device_id: z.string().describe(`Device ID for a Schlage device.
78
+ `),
79
+ device_name: z.string().describe(`Device name for a Schlage device.
80
+ `),
81
+ model: z.string().optional().describe(`Model for a Schlage device.
82
+ `),
83
+ }).describe(`Metadata for a Schlage device.
84
+ `),
41
85
  smartthings_metadata: z.object({
42
- device_id: z.string(),
43
- device_name: z.string(),
44
- model: z.string().optional(),
45
- location_id: z.string().optional(),
46
- }),
86
+ device_id: z.string().describe(`Device ID for a SmartThings device.
87
+ `),
88
+ device_name: z.string().describe(`Device name for a SmartThings device.
89
+ `),
90
+ model: z.string().optional().describe(`Model for a SmartThings device.
91
+ `),
92
+ location_id: z.string().optional()
93
+ .describe(`Location ID for a SmartThings device.
94
+ `),
95
+ }).describe(`Metadata for a SmartThings device.
96
+ `),
47
97
  lockly_metadata: z.object({
48
- device_id: z.string(),
49
- device_name: z.string(),
50
- model: z.string().optional(),
51
- }),
98
+ device_id: z.string().describe(`Device ID for a Lockly device.
99
+ `),
100
+ device_name: z.string().describe(`Device name for a Lockly device.
101
+ `),
102
+ model: z.string().optional().describe(`Model for a Lockly device.
103
+ `),
104
+ }).describe(`Metadata for a Lockly device.
105
+ `),
52
106
  nuki_metadata: z.object({
53
- device_id: z.string(),
54
- device_name: z.string(),
55
- keypad_battery_critical: z.boolean().optional(),
56
- keypad_paired: z.boolean().optional(),
57
- keypad_2_paired: z.boolean().optional(),
58
- }),
107
+ device_id: z.string().describe(`Device ID for a Nuki device.
108
+ `),
109
+ device_name: z.string().describe(`Device name for a Nuki device.
110
+ `),
111
+ keypad_battery_critical: z.boolean().optional()
112
+ .describe(`Indicates whether the keypad battery is in a critical state for a Nuki device.
113
+ `),
114
+ keypad_paired: z.boolean().optional()
115
+ .describe(`Indicates whether the keypad is paired for a Nuki device.
116
+ `),
117
+ keypad_2_paired: z.boolean().optional()
118
+ .describe(`Indicates whether keypad 2 is paired for a Nuki device.
119
+ `),
120
+ }).describe(`Metadata for a Nuki device.
121
+ `),
59
122
  kwikset_metadata: z.object({
60
- device_id: z.string(),
61
- device_name: z.string(),
62
- model_number: z.string(),
63
- }),
123
+ device_id: z.string().describe(`Device ID for a Kwikset device.
124
+ `),
125
+ device_name: z.string().describe(`Device name for a Kwikset device.
126
+ `),
127
+ model_number: z.string().describe(`Model number for a Kwikset device.
128
+ `),
129
+ }).describe(`Metadata for a Kwikset device.
130
+ `),
64
131
  salto_metadata: z.object({
65
- lock_id: z.string(),
66
- customer_reference: z.string(),
67
- lock_type: z.string(),
68
- battery_level: z.string(),
69
- locked_state: z.string(),
70
- model: z.string().optional(),
132
+ lock_id: z.string().describe(`Lock ID for a Salto device.
133
+ `),
134
+ customer_reference: z.string()
135
+ .describe(`Customer reference for a Salto device.
136
+ `),
137
+ lock_type: z.string().describe(`Lock type for a Salto device.
138
+ `),
139
+ battery_level: z.string().describe(`Battery level for a Salto device.
140
+ `),
141
+ locked_state: z.string().describe(`Locked state for a Salto device.
142
+ `),
143
+ model: z.string().optional().describe(`Model for a Salto device.
144
+ `),
71
145
  }).describe(`
72
146
  ---
73
147
  deprecated: Use \`salto_ks_metadata \` instead.
148
+ ---
149
+ Metada for a Salto device.
74
150
  `),
75
151
  salto_ks_metadata: z.object({
76
- lock_id: z.string(),
77
- customer_reference: z.string(),
78
- lock_type: z.string(),
79
- battery_level: z.string(),
80
- locked_state: z.string(),
81
- model: z.string().optional(),
82
- }),
152
+ lock_id: z.string().describe(`Lock ID for a Salto KS device.
153
+ `),
154
+ customer_reference: z.string()
155
+ .describe(`Customer reference for a Salto KS device.
156
+ `),
157
+ lock_type: z.string().describe(`Lock type for a Salto KS device.
158
+ `),
159
+ battery_level: z.string().describe(`Battery level for a Salto KS device.
160
+ `),
161
+ locked_state: z.string().describe(`Locked state for a Salto KS device.
162
+ `),
163
+ model: z.string().optional().describe(`Model for a Salto KS device.
164
+ `),
165
+ }).describe(`Metadata for a Salto KS device.
166
+ `),
83
167
  genie_metadata: z.object({
84
- device_name: z.string(),
85
- door_name: z.string(),
86
- }),
168
+ device_name: z.string().describe(`Lock name for a Genie device.
169
+ `),
170
+ door_name: z.string().describe(`Door name for a Genie device.
171
+ `),
172
+ }).describe(`Metadata for a Genie device.
173
+ `),
87
174
  brivo_metadata: z.object({
88
- device_name: z.string(),
89
- }),
175
+ device_name: z.string().describe(`Device name for a Brivo device.
176
+ `),
177
+ }).describe(`Metadata for a Brivo device.
178
+ `),
90
179
  igloo_metadata: z.object({
91
- device_id: z.string(),
92
- bridge_id: z.string(),
93
- model: z.string().optional(),
94
- }),
180
+ device_id: z.string().describe(`Device ID for an igloo device.
181
+ `),
182
+ bridge_id: z.string().describe(`Bridge ID for an igloo device.
183
+ `),
184
+ model: z.string().optional().describe(`Model for an igloo device.
185
+ `),
186
+ }).describe(`Metadata for an igloo device.
187
+ `),
95
188
  noiseaware_metadata: z.object({
96
- device_model: z.enum(['indoor', 'outdoor']),
97
- noise_level_nrs: z.number(),
98
- noise_level_decibel: z.number(),
99
- device_name: z.string(),
100
- device_id: z.string(),
101
- }),
189
+ device_model: z.enum(['indoor', 'outdoor'])
190
+ .describe(`Device model for a NoiseAware device.
191
+ `),
192
+ noise_level_nrs: z.number()
193
+ .describe(`Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device.
194
+ `),
195
+ noise_level_decibel: z.number()
196
+ .describe(`Noise level, in decibels, for a NoiseAware device.
197
+ `),
198
+ device_name: z.string().describe(`Device name for a NoiseAware device.
199
+ `),
200
+ device_id: z.string().describe(`Device ID for a NoiseAware device.
201
+ `),
202
+ }).describe(`Metadata for a NoiseAware device.
203
+ `),
102
204
  minut_metadata: z.object({
103
- device_id: z.string(),
104
- device_name: z.string(),
205
+ device_id: z.string().describe(`Device ID for a Minut device.
206
+ `),
207
+ device_name: z.string().describe(`Device name for a Minut device.
208
+ `),
105
209
  latest_sensor_values: z.object({
106
210
  temperature: z.object({
107
- time: z.string(),
108
- value: z.number(),
109
- }),
211
+ time: z.string()
212
+ .describe(`Time of latest temperature reading for a Minut device.
213
+ `),
214
+ value: z.number()
215
+ .describe(`Value of latest temperature reading for a Minut device.
216
+ `),
217
+ }).describe(`Latest temperature reading for a Minut device.
218
+ `),
110
219
  sound: z.object({
111
- time: z.string(),
112
- value: z.number(),
113
- }),
220
+ time: z.string()
221
+ .describe(`Time of latest sound reading for a Minut device.
222
+ `),
223
+ value: z.number()
224
+ .describe(`Value of latest sound reading for a Minut device.
225
+ `),
226
+ }).describe(`Latest sound reading for a Minut device.
227
+ `),
114
228
  humidity: z.object({
115
- time: z.string(),
116
- value: z.number(),
117
- }),
229
+ time: z.string()
230
+ .describe(`Time of latest humidity reading for a Minut device.
231
+ `),
232
+ value: z.number()
233
+ .describe(`Value of latest humidity reading for a Minut device.
234
+ `),
235
+ }).describe(`Latest humidity reading for a Minut device.
236
+ `),
118
237
  pressure: z.object({
119
- time: z.string(),
120
- value: z.number(),
121
- }),
238
+ time: z.string()
239
+ .describe(`Time of latest pressure reading for a Minut device.
240
+ `),
241
+ value: z.number()
242
+ .describe(`Value of latest pressure reading for a Minut device.
243
+ `),
244
+ }).describe(`Latest pressure reading for a Minut device.
245
+ `),
122
246
  accelerometer_z: z.object({
123
- time: z.string(),
124
- value: z.number(),
125
- }),
126
- }),
127
- }),
247
+ time: z.string()
248
+ .describe(`Time of latest accelerometer Z-axis reading for a Minut device.
249
+ `),
250
+ value: z.number()
251
+ .describe(`Value of latest accelerometer Z-axis reading for a Minut device.
252
+ `),
253
+ }).describe(`Latest accelerometer Z-axis reading for a Minut device.
254
+ `),
255
+ }).describe(`Latest sensor values for a Minut device.
256
+ `),
257
+ }).describe(`Metadata for a Minut device.
258
+ `),
128
259
  four_suites_metadata: z.object({
129
- device_id: z.number(),
130
- device_name: z.string(),
131
- reclose_delay_in_seconds: z.number(),
132
- }),
260
+ device_id: z.number().describe(`Device ID for a 4SUITES device.
261
+ `),
262
+ device_name: z.string().describe(`Device name for a 4SUITES device.
263
+ `),
264
+ reclose_delay_in_seconds: z.number()
265
+ .describe(`Reclose delay, in seconds, for a 4SUITES device.
266
+ `),
267
+ }).describe(`Metadata for a 4SUITES device.
268
+ `),
133
269
  two_n_metadata: z.object({
134
- device_id: z.number(),
135
- device_name: z.string(),
136
- }),
270
+ device_id: z.number().describe(`Device ID for a 2N device.
271
+ `),
272
+ device_name: z.string().describe(`Device name for a 2N device.
273
+ `),
274
+ }).describe(`Metadata for a 2N device.
275
+ `),
137
276
  controlbyweb_metadata: z.object({
138
- device_id: z.string(),
139
- device_name: z.string(),
140
- relay_name: z.string().nullable(),
141
- }),
277
+ device_id: z.string().describe(`Device ID for a ControlByWeb device.
278
+ `),
279
+ device_name: z.string().describe(`Device name for a ControlByWeb device.
280
+ `),
281
+ relay_name: z.string().nullable()
282
+ .describe(`Relay name for a ControlByWeb device.
283
+ `),
284
+ }).describe(`Metadata for a ControlByWeb device.
285
+ `),
142
286
  ttlock_metadata: z.object({
143
- lock_id: z.number(),
144
- lock_alias: z.string(),
145
- feature_value: z.string(),
287
+ lock_id: z.number().describe(`Lock ID for a TTLock device.
288
+ `),
289
+ lock_alias: z.string().describe(`Lock alias for a TTLock device.
290
+ `),
291
+ feature_value: z.string().describe(`Feature value for a TTLock device.
292
+ `),
146
293
  features: z.object({
147
- passcode: z.boolean(),
148
- passcode_management: z.boolean(),
149
- unlock_via_gateway: z.boolean(),
150
- lock_command: z.boolean(),
151
- incomplete_keyboard_passcode: z.boolean(),
152
- wifi: z.boolean(),
153
- }),
154
- has_gateway: z.boolean().optional(),
294
+ passcode: z.boolean()
295
+ .describe(`Indicates whether a TTLock device supports a passcode.
296
+ `),
297
+ passcode_management: z.boolean()
298
+ .describe(`Indicates whether a TTLock device supports passcode management.
299
+ `),
300
+ unlock_via_gateway: z.boolean()
301
+ .describe(`Indicates whether a TTLock device supports unlock via gateway.
302
+ `),
303
+ lock_command: z.boolean()
304
+ .describe(`Indicates whether a TTLock device supports the lock command.
305
+ `),
306
+ incomplete_keyboard_passcode: z.boolean()
307
+ .describe(`Indicates whether a TTLock device supports an incomplete keyboard passcode.
308
+ `),
309
+ wifi: z.boolean()
310
+ .describe(`Indicates whether a TTLock device supports Wi-Fi.
311
+ `),
312
+ }).describe(`Features for a TTLock device.
313
+ `),
314
+ has_gateway: z.boolean().optional()
315
+ .describe(`Indicates whether a TTLock device has a gateway.
316
+ `),
155
317
  wireless_keypads: z
156
318
  .array(z.object({
157
- wireless_keypad_id: z.number(),
158
- wireless_keypad_name: z.string(),
319
+ wireless_keypad_id: z.number()
320
+ .describe(`ID for a wireless keypad for a TTLock device.
321
+ `),
322
+ wireless_keypad_name: z.string()
323
+ .describe(`Name for a wireless keypad for a TTLock device.
324
+ `),
159
325
  }))
160
- .optional(),
161
- }),
326
+ .optional().describe(`Wireless keypads for a TTLock device.
327
+ `),
328
+ }).describe(`Metadata for a TTLock device.
329
+ `),
162
330
  seam_bridge_metadata: z.object({
163
- unlock_method: z.enum(['bridge', 'doorking']).optional(),
164
- device_num: z.number(),
165
- name: z.string(),
166
- }),
331
+ unlock_method: z.enum(['bridge', 'doorking']).optional()
332
+ .describe(`Unlock method for Seam Bridge.
333
+ `),
334
+ device_num: z.number().describe(`Device number for Seam Bridge.
335
+ `),
336
+ name: z.string().describe(`Name for Seam Bridge.
337
+ `),
338
+ }).describe(`Metadata for Seam Bridge.
339
+ `),
167
340
  igloohome_metadata: z.object({
168
- device_id: z.string(),
169
- device_name: z.string(),
170
- bridge_id: z.string().optional(),
171
- bridge_name: z.string().optional(),
172
- keypad_id: z.string().optional(),
173
- }),
341
+ device_id: z.string().describe(`Device ID for an igloohome device.
342
+ `),
343
+ device_name: z.string().describe(`Device name for an igloohome device.
344
+ `),
345
+ bridge_id: z.string().optional()
346
+ .describe(`Bridge ID for an igloohome device.
347
+ `),
348
+ bridge_name: z.string().optional()
349
+ .describe(`Bridge name for an igloohome device.
350
+ `),
351
+ keypad_id: z.string().optional()
352
+ .describe(`Keypad ID for an igloohome device.
353
+ `),
354
+ }).describe(`Metadata for an igloohome device.
355
+ `),
174
356
  nest_metadata: z.object({
175
- nest_device_id: z.string(),
176
- device_name: z.string(), // set by Google
177
- device_custom_name: z.string(), // set by device owner
178
- display_name: z.string().optional(),
179
- }),
357
+ nest_device_id: z.string().describe(`Device ID for a Google Nest device.
358
+ `),
359
+ device_name: z.string()
360
+ .describe(`Device name for a Google Nest device. Google sets this value.
361
+ `), // set by Google
362
+ device_custom_name: z.string()
363
+ .describe(`Custom device name for a Google Nest device. The device owner sets this value.
364
+ `), // set by device owner
365
+ display_name: z.string().optional()
366
+ .describe(`Display name for a Google Nest device.
367
+ `),
368
+ }).describe(`Metadata for a Google Nest device.
369
+ `),
180
370
  ecobee_metadata: z.object({
181
- ecobee_device_id: z.string(),
182
- device_name: z.string(),
183
- }),
371
+ ecobee_device_id: z.string().describe(`Device ID for an ecobee device.
372
+ `),
373
+ device_name: z.string().describe(`Device name for an ecobee device.
374
+ `),
375
+ }).describe(`Metadata for an ecobee device.
376
+ `),
184
377
  honeywell_resideo_metadata: z.object({
185
- honeywell_resideo_device_id: z.string(),
186
- device_name: z.string(),
187
- }),
378
+ honeywell_resideo_device_id: z.string()
379
+ .describe(`Device ID for a Honeywell Resideo device.
380
+ `),
381
+ device_name: z.string()
382
+ .describe(`Device name for a Honeywell Resideo device.
383
+ `),
384
+ }).describe(`Metadata for a Honeywell Resideo device.
385
+ `),
188
386
  hubitat_metadata: z.object({
189
- device_id: z.string(),
190
- device_name: z.string(),
191
- device_label: z.string(),
192
- }),
387
+ device_id: z.string().describe(`Device ID for a Hubitat device.
388
+ `),
389
+ device_name: z.string().describe(`Device name for a Hubitat device.
390
+ `),
391
+ device_label: z.string().describe(`Device label for a Hubitat device.
392
+ `),
393
+ }).describe(`Metadata for a Hubitat device.
394
+ `),
193
395
  dormakaba_oracode_metadata: z.object({
194
- door_id: z.number().optional(),
195
- door_name: z.string(),
196
- device_id: z.number().or(z.string()).optional(),
197
- door_is_wireless: z.boolean(),
198
- site_id: z.number().nullable().describe('@DEPRECATED'),
199
- site_name: z.string(),
200
- iana_timezone: z.string().optional(),
201
- predefined_time_slots: z.array(dormakaba_oracode_time_slot).optional(),
202
- }),
396
+ door_id: z.number().optional()
397
+ .describe(`Door ID for a dormakaba Oracode device.
398
+ `),
399
+ door_name: z.string().describe(`Door name for a dormakaba Oracode device.
400
+ `),
401
+ device_id: z.number().or(z.string()).optional()
402
+ .describe(`Device ID for a dormakaba Oracode device.
403
+ `),
404
+ door_is_wireless: z.boolean()
405
+ .describe(`Indicates whether a door is wireless for a dormakaba Oracode device.
406
+ `),
407
+ site_id: z.number().nullable().describe(`
408
+ ---
409
+ deprecated: Previously marked as "@DEPRECATED."
410
+ ---
411
+ Site ID for a dormakaba Oracode device.
412
+ `),
413
+ site_name: z.string().describe(`Site name for a dormakaba Oracode device.
414
+ `),
415
+ iana_timezone: z.string().optional()
416
+ .describe(`IANA time zone for a dormakaba Oracode device.
417
+ `),
418
+ predefined_time_slots: z.array(dormakaba_oracode_time_slot).optional()
419
+ .describe(`Predefined time slots for a dormakaba Oracode device.
420
+ `),
421
+ }).describe(`Metadata for a dormakaba Oracode device.
422
+ `),
203
423
  wyze_metadata: z.object({
204
- device_id: z.string(),
205
- device_name: z.string(),
206
- product_name: z.string(),
207
- product_type: z.string(),
208
- product_model: z.string(),
209
- device_info_model: z.string(),
210
- keypad_uuid: z.string().optional(),
211
- locker_status_hardlock: z.number().optional(),
212
- }),
424
+ device_id: z.string().describe(`Device ID for a Wyze device.
425
+ `),
426
+ device_name: z.string().describe(`Device name for a Wyze device.
427
+ `),
428
+ product_name: z.string().describe(`Product name for a Wyze device.
429
+ `),
430
+ product_type: z.string().describe(`Product type for a Wyze device.
431
+ `),
432
+ product_model: z.string().describe(`Product model for a Wyze device.
433
+ `),
434
+ device_info_model: z.string()
435
+ .describe(`Device information model for a Wyze device.
436
+ `),
437
+ keypad_uuid: z.string().optional()
438
+ .describe(`Keypad UUID for a Wyze device.
439
+ `),
440
+ locker_status_hardlock: z.number().optional()
441
+ .describe(`Locker status (hardlock) for a Wyze device.
442
+ `),
443
+ }).describe(`Metadata for a Wyze device.
444
+ `),
213
445
  tedee_metadata: z.object({
214
- device_id: z.number(),
215
- serial_number: z.string(),
216
- device_name: z.string(),
217
- device_model: z.string(),
218
- bridge_id: z.number(),
219
- bridge_name: z.string(),
220
- keypad_id: z.number().optional(),
221
- }),
446
+ device_id: z.number().describe(`Device ID for a Tedee device.
447
+ `),
448
+ serial_number: z.string().describe(`Serial number for a Tedee device.
449
+ `),
450
+ device_name: z.string().describe(`Device name for a Tedee device.
451
+ `),
452
+ device_model: z.string().describe(`Device model for a Tedee device.
453
+ `),
454
+ bridge_id: z.number().describe(`Bridge ID for a Tedee device.
455
+ `),
456
+ bridge_name: z.string().describe(`Bridge name for a Tedee device.
457
+ `),
458
+ keypad_id: z.number().optional().describe(`Keypad ID for a Tedee device.
459
+ `),
460
+ }).describe(`Metadata for a Tedee device.
461
+ `),
222
462
  visionline_metadata: z.object({
223
- encoder_id: z.string(),
224
- }),
463
+ encoder_id: z.string()
464
+ .describe(`Encoder ID for an ASSA ABLOY Visionline system.
465
+ `),
466
+ }).describe(`Metadata for an ASSA ABLOY Visionline system.
467
+ `),
225
468
  akiles_metadata: z.object({
226
- gadget_name: z.string(),
227
- gadget_id: z.string(),
228
- product_name: z.string(),
469
+ gadget_name: z.string().describe(`Gadget name for an Akiles device.
470
+ `),
471
+ gadget_id: z.string().describe(`Gadget ID for an Akiles device.
472
+ `),
473
+ product_name: z.string().describe(`Product name for an Akiles device.
474
+ `),
229
475
  /**
230
476
  * Group ID to add users to for this device
231
477
  */
232
- _member_group_id: z.string().optional(),
233
- }),
478
+ _member_group_id: z.string().optional()
479
+ .describe(`Group ID to which to add users for an Akiles device.
480
+ `),
481
+ }).describe(`Metadata for an Akiles device.
482
+ `),
234
483
  assa_abloy_vostio_metadata: z.object({
235
- encoder_name: z.string(),
236
- }),
484
+ encoder_name: z.string()
485
+ .describe(`Encoder name for an ASSA ABLOY Vostio system.
486
+ `),
487
+ }).describe(`Metadata for an ASSA ABLOY Vostio system.
488
+ `),
237
489
  tado_metadata: z.object({
238
- serial_no: z.string(),
239
- device_type: z.string(),
240
- }),
490
+ serial_no: z.string().describe(`Serial number for a tado° device.
491
+ `),
492
+ device_type: z.string().describe(`Device type for a tado° device.
493
+ `),
494
+ }).describe(`Metadata for a tado° device.
495
+ `),
241
496
  sensi_metadata: z.object({
242
- device_id: z.string(),
243
- device_name: z.string(),
244
- product_type: z.string(),
245
- }),
497
+ device_id: z.string().describe(`Device ID for a Sensi device.
498
+ `),
499
+ device_name: z.string().describe(`Device name for a Sensi device.
500
+ `),
501
+ product_type: z.string().describe(`Product type for a Sensi device.
502
+ `),
503
+ }).describe(`Metadata for a Sensi device.
504
+ `),
246
505
  })
247
- .partial();
506
+ .partial().describe(`
507
+ ---
508
+ property_group_key: provider_metadata
509
+ ---
510
+ Provider-specific metadata.
511
+ `);
248
512
  //# sourceMappingURL=device-metadata.js.map