@seamapi/types 1.1199.0 → 1.1201.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 (68) hide show
  1. package/lib/seam/connect/models/access-grants/access-grant.js +1 -0
  2. package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
  3. package/lib/seam/connect/models/acs/acs-access-group.js +2 -0
  4. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  5. package/lib/seam/connect/models/acs/acs-credential-pool.js +1 -0
  6. package/lib/seam/connect/models/acs/acs-credential-pool.js.map +1 -1
  7. package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js +1 -0
  8. package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js.map +1 -1
  9. package/lib/seam/connect/models/acs/acs-system.js +4 -0
  10. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  11. package/lib/seam/connect/models/acs/acs-users/acs-user.js +1 -0
  12. package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
  13. package/lib/seam/connect/models/client-sessions/client-session.js +1 -0
  14. package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
  15. package/lib/seam/connect/models/connect-webviews/connect-webview.js +2 -0
  16. package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
  17. package/lib/seam/connect/models/connected-accounts/connected-account.js +1 -0
  18. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  19. package/lib/seam/connect/models/customer/customer-portal.js +4 -2
  20. package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
  21. package/lib/seam/connect/models/devices/capability-properties/thermostat.js +3 -0
  22. package/lib/seam/connect/models/devices/capability-properties/thermostat.js.map +1 -1
  23. package/lib/seam/connect/models/devices/device-metadata.d.ts +43 -0
  24. package/lib/seam/connect/models/devices/device-metadata.js +41 -4
  25. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  26. package/lib/seam/connect/models/devices/device-provider.d.ts +2 -1
  27. package/lib/seam/connect/models/devices/device-provider.js +2 -0
  28. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  29. package/lib/seam/connect/models/devices/device-type.d.ts +1 -0
  30. package/lib/seam/connect/models/devices/device-type.js +1 -0
  31. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  32. package/lib/seam/connect/models/devices/device.d.ts +68 -7
  33. package/lib/seam/connect/models/devices/device.js +8 -0
  34. package/lib/seam/connect/models/devices/device.js.map +1 -1
  35. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +50 -7
  36. package/lib/seam/connect/models/events/connected-accounts.js +1 -0
  37. package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
  38. package/lib/seam/connect/models/events/devices.js +1 -0
  39. package/lib/seam/connect/models/events/devices.js.map +1 -1
  40. package/lib/seam/connect/models/thermostats/climate-preset.js +1 -0
  41. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
  42. package/lib/seam/connect/models/workspaces/workspace.js +1 -0
  43. package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
  44. package/lib/seam/connect/openapi.js +147 -7
  45. package/lib/seam/connect/openapi.js.map +1 -1
  46. package/lib/seam/connect/route-types.d.ts +384 -80
  47. package/package.json +1 -1
  48. package/src/lib/seam/connect/models/access-grants/access-grant.ts +1 -0
  49. package/src/lib/seam/connect/models/acs/acs-access-group.ts +2 -0
  50. package/src/lib/seam/connect/models/acs/acs-credential-pool.ts +1 -0
  51. package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts +1 -0
  52. package/src/lib/seam/connect/models/acs/acs-system.ts +4 -0
  53. package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +1 -0
  54. package/src/lib/seam/connect/models/client-sessions/client-session.ts +1 -0
  55. package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +2 -0
  56. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +1 -0
  57. package/src/lib/seam/connect/models/customer/customer-portal.ts +4 -2
  58. package/src/lib/seam/connect/models/devices/capability-properties/thermostat.ts +3 -0
  59. package/src/lib/seam/connect/models/devices/device-metadata.ts +46 -4
  60. package/src/lib/seam/connect/models/devices/device-provider.ts +2 -0
  61. package/src/lib/seam/connect/models/devices/device-type.ts +1 -0
  62. package/src/lib/seam/connect/models/devices/device.ts +8 -0
  63. package/src/lib/seam/connect/models/events/connected-accounts.ts +1 -0
  64. package/src/lib/seam/connect/models/events/devices.ts +1 -0
  65. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +1 -0
  66. package/src/lib/seam/connect/models/workspaces/workspace.ts +1 -0
  67. package/src/lib/seam/connect/openapi.ts +152 -9
  68. package/src/lib/seam/connect/route-types.ts +420 -48
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1199.0",
3
+ "version": "1.1201.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -289,6 +289,7 @@ export const access_grant = z.object({
289
289
  location_ids: z.array(z.string().uuid()).describe(`
290
290
  ---
291
291
  deprecated: Use \`space_ids\`.
292
+ end_of_life: "2026-11-09"
292
293
  ---
293
294
  `),
294
295
  space_ids: z
@@ -127,11 +127,13 @@ const common_acs_access_group = z.object({
127
127
  access_group_type: acs_access_group_external_type.describe(`
128
128
  ---
129
129
  deprecated: Use \`external_type\`.
130
+ end_of_life: "2026-11-09"
130
131
  ---
131
132
  `),
132
133
  access_group_type_display_name: z.string().describe(`
133
134
  ---
134
135
  deprecated: Use \`external_type_display_name\`.
136
+ end_of_life: "2026-11-09"
135
137
  ---
136
138
  `),
137
139
  display_name: z.string().describe('Display name for the access group.'),
@@ -21,6 +21,7 @@ export const acs_credential_pool = z.object({
21
21
  route_path: /acs/credential_pools
22
22
  deprecated: Not used.
23
23
  undocumented: Deprecated. Will be removed.
24
+ end_of_life: "2026-11-09"
24
25
  ---
25
26
  `)
26
27
 
@@ -13,6 +13,7 @@ export const acs_credential_provisioning_automation = z.object({
13
13
  route_path: /acs/credential_provisioning_automations
14
14
  deprecated: Not used.
15
15
  undocumented: Deprecated. Will be removed.
16
+ end_of_life: "2026-11-09"
16
17
  ---
17
18
  `)
18
19
 
@@ -245,6 +245,7 @@ const time_zone_does_not_match_location = common_acs_system_warning
245
245
  `
246
246
  ---
247
247
  deprecated: this field is deprecated.
248
+ end_of_life: "2026-11-09"
248
249
  ---
249
250
  `,
250
251
  ),
@@ -372,6 +373,7 @@ export const acs_system = z
372
373
  `
373
374
  ---
374
375
  deprecated: Use \`external_type\`.
376
+ end_of_life: "2026-11-09"
375
377
  ---
376
378
  `,
377
379
  )
@@ -379,6 +381,7 @@ export const acs_system = z
379
381
  system_type_display_name: z.string().optional().describe(`
380
382
  ---
381
383
  deprecated: Use \`external_type_display_name\`.
384
+ end_of_life: "2026-11-09"
382
385
  ---
383
386
  `),
384
387
  location: acs_location.describe(
@@ -401,6 +404,7 @@ export const acs_system = z
401
404
  connected_account_ids: z.array(z.string().uuid()).describe(`
402
405
  ---
403
406
  deprecated: Use \`connected_account_id\`.
407
+ end_of_life: "2026-11-09"
404
408
  ---
405
409
  IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
406
410
  `),
@@ -213,6 +213,7 @@ const user_fields = z.object({
213
213
  email: z.string().email().optional().describe(`
214
214
  ---
215
215
  deprecated: use email_address.
216
+ end_of_life: "2026-11-09"
216
217
  ---
217
218
  `),
218
219
  email_address: z
@@ -49,6 +49,7 @@ export const client_session = z.object({
49
49
  user_identity_ids: z.array(z.string().uuid()).describe(`
50
50
  ---
51
51
  deprecated: Use \`user_identity_id\` instead.
52
+ end_of_life: "2026-11-09"
52
53
  ---
53
54
  IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
54
55
  `),
@@ -54,6 +54,7 @@ export const connect_webview = z.object({
54
54
  ---
55
55
  undocumented: Unused. Will be removed.
56
56
  deprecated: Unused. Will be removed.
57
+ end_of_life: "2026-11-09"
57
58
  ---
58
59
  `,
59
60
  ),
@@ -62,6 +63,7 @@ export const connect_webview = z.object({
62
63
  ---
63
64
  undocumented: Unused. Will be removed.
64
65
  deprecated: Unused. Will be removed.
66
+ end_of_life: "2026-11-09"
65
67
  ---
66
68
  `,
67
69
  ),
@@ -370,6 +370,7 @@ export const connected_account = z.object({
370
370
  .optional().describe(`
371
371
  ---
372
372
  deprecated: Use \`display_name\` instead.
373
+ end_of_life: "2026-11-09"
373
374
  ---
374
375
  User identifier associated with the connected account.
375
376
  `),
@@ -149,10 +149,11 @@ const base_features = z.object({
149
149
  .default({})
150
150
  .describe('Configuration for the manage feature.'),
151
151
  manage_devices: base_manage_devices_feature.default({}).describe(`
152
- Configuration for the manage devices feature.
153
152
  ---
154
153
  deprecated: Use \`manage\` instead.
154
+ end_of_life: "2026-11-09"
155
155
  ---
156
+ Configuration for the manage devices feature.
156
157
  `),
157
158
  organize: base_organize_feature
158
159
  .default({})
@@ -171,10 +172,11 @@ export const customer_portal_features = z
171
172
  .partial()
172
173
  .describe('Configuration for the manage feature.'),
173
174
  manage_devices: base_manage_devices_feature.partial().describe(`
174
- Configuration for the manage devices feature.
175
175
  ---
176
176
  deprecated: Use \`manage\` instead.
177
+ end_of_life: "2026-11-09"
177
178
  ---
179
+ Configuration for the manage devices feature.
178
180
  `),
179
181
  organize: base_organize_feature
180
182
  .partial()
@@ -71,6 +71,7 @@ export const thermostat_capability_properties = z
71
71
  fan_mode_setting: fan_mode_setting.describe(`
72
72
  ---
73
73
  deprecated: Use \`current_climate_setting.fan_mode_setting\` instead.
74
+ end_of_life: "2026-11-09"
74
75
  property_group_key: thermostats
75
76
  ---
76
77
  `),
@@ -91,6 +92,7 @@ export const thermostat_capability_properties = z
91
92
  default_climate_setting: climate_setting.describe(`
92
93
  ---
93
94
  deprecated: use fallback_climate_preset_key to specify a fallback climate preset instead.
95
+ end_of_life: "2026-11-09"
94
96
  property_group_key: thermostats
95
97
  ---
96
98
  `),
@@ -110,6 +112,7 @@ export const thermostat_capability_properties = z
110
112
  ---
111
113
  property_group_key: thermostats
112
114
  deprecated: Use \`active_thermostat_schedule_id\` with \`/thermostats/schedules/get\` instead.
115
+ end_of_life: "2026-11-09"
113
116
  ---
114
117
  Active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
115
118
  `),
@@ -263,6 +263,7 @@ export const device_metadata = z
263
263
  .partial().describe(`
264
264
  ---
265
265
  deprecated: Use \`salto_ks_metadata\` instead.
266
+ end_of_life: "2026-11-09"
266
267
  ---
267
268
  Metada for a Salto device.
268
269
  `),
@@ -760,6 +761,7 @@ export const device_metadata = z
760
761
  site_id: z.number().nullable().optional().describe(`
761
762
  ---
762
763
  deprecated: Previously marked as "@DEPRECATED."
764
+ end_of_life: "2026-11-09"
763
765
  ---
764
766
  Site ID for a dormakaba Oracode device.
765
767
  `),
@@ -1023,14 +1025,54 @@ export const device_metadata = z
1023
1025
  .optional()
1024
1026
  .describe(`Product type for a Sensi device.`),
1025
1027
  /** @deprecated Seam no longer sets this field. */
1026
- dual_setpoints_not_supported: z
1027
- .boolean()
1028
- .optional()
1029
- .describe(`Deprecated. Seam no longer sets this field.`),
1028
+ dual_setpoints_not_supported: z.boolean().optional().describe(`
1029
+ ---
1030
+ deprecated: Seam no longer sets this field.
1031
+ end_of_life: "2026-11-09"
1032
+ ---
1033
+ `),
1030
1034
  })
1031
1035
  .partial()
1032
1036
  .describe(`Metadata for a Sensi device.`),
1033
1037
 
1038
+ sensibo_metadata: z
1039
+ .object({
1040
+ pod_id: z
1041
+ .string()
1042
+ .optional()
1043
+ .describe(`ID of the Sensibo device, which Sensibo calls a pod.`),
1044
+ room_name: z
1045
+ .string()
1046
+ .optional()
1047
+ .describe(`Name of the room that the Sensibo device is in.`),
1048
+ product_model: z
1049
+ .string()
1050
+ .optional()
1051
+ .describe(
1052
+ `Product model of the Sensibo device, such as \`skyv2\` or \`air\`.`,
1053
+ ),
1054
+ mac_address: z
1055
+ .string()
1056
+ .optional()
1057
+ .describe(`MAC address of the Sensibo device.`),
1058
+ serial_number: z
1059
+ .string()
1060
+ .optional()
1061
+ .describe(`Serial number of the Sensibo device.`),
1062
+ firmware_version: z
1063
+ .string()
1064
+ .optional()
1065
+ .describe(`Firmware version of the Sensibo device.`),
1066
+ temperature_unit: z
1067
+ .string()
1068
+ .optional()
1069
+ .describe(
1070
+ `Temperature unit that the Sensibo device displays: \`C\` or \`F\`.`,
1071
+ ),
1072
+ })
1073
+ .partial()
1074
+ .describe(`Metadata for a Sensibo device.`),
1075
+
1034
1076
  keynest_metadata: z
1035
1077
  .object({
1036
1078
  key_id: z.string().optional().describe(`Key ID for a KeyNest device.`),
@@ -53,6 +53,7 @@ export const DEVICE_PROVIDERS = {
53
53
  TADO: 'tado',
54
54
  SALTO_SPACE: 'salto_space',
55
55
  SENSI: 'sensi',
56
+ SENSIBO: 'sensibo',
56
57
  KEYNEST: 'keynest',
57
58
  KORELOCK: 'korelock',
58
59
  KEYINCODE: 'keyincode',
@@ -184,6 +185,7 @@ export const PROVIDER_CATEGORY_MAP = {
184
185
  'honeywell_resideo',
185
186
  'first_alert',
186
187
  'tado',
188
+ 'sensibo',
187
189
  ],
188
190
  noise_sensors: ['minut', 'noiseaware'],
189
191
  access_control_systems: [
@@ -96,6 +96,7 @@ export const THERMOSTAT_DEVICE_TYPE = {
96
96
  HONEYWELL_RESIDEO_THERMOSTAT: 'honeywell_resideo_thermostat',
97
97
  TADO_THERMOSTAT: 'tado_thermostat',
98
98
  SENSI_THERMOSTAT: 'sensi_thermostat',
99
+ SENSIBO_THERMOSTAT: 'sensibo_thermostat',
99
100
  SMARTTHINGS_THERMOSTAT: 'smartthings_thermostat',
100
101
  } as const
101
102
 
@@ -1102,16 +1102,19 @@ export const common_device_properties = z.object({
1102
1102
  offline_access_codes_supported: z.boolean().optional().describe(`
1103
1103
  ---
1104
1104
  deprecated: use device.can_program_offline_access_codes.
1105
+ end_of_life: "2026-11-09"
1105
1106
  ---
1106
1107
  `),
1107
1108
  online_access_codes_supported: z.boolean().optional().describe(`
1108
1109
  ---
1109
1110
  deprecated: use device.can_program_online_access_codes.
1111
+ end_of_life: "2026-11-09"
1110
1112
  ---
1111
1113
  `),
1112
1114
  accessory_keypad_supported: z.boolean().optional().describe(`
1113
1115
  ---
1114
1116
  deprecated: use device.properties.model.can_connect_accessory_keypad
1117
+ end_of_life: "2026-11-09"
1115
1118
  ---
1116
1119
  `),
1117
1120
  })
@@ -1174,6 +1177,7 @@ export const common_device_properties = z.object({
1174
1177
  ---
1175
1178
  property_group_key: access_codes
1176
1179
  deprecated: use device.can_program_online_access_codes
1180
+ end_of_life: "2026-11-09"
1177
1181
  ---
1178
1182
  Indicates whether it is currently possible to use online access codes for the device.
1179
1183
  `,
@@ -1186,6 +1190,7 @@ export const common_device_properties = z.object({
1186
1190
  ---
1187
1191
  property_group_key: access_codes
1188
1192
  deprecated: use device.can_program_offline_access_codes
1193
+ end_of_life: "2026-11-09"
1189
1194
  ---
1190
1195
  Indicates whether it is currently possible to use offline access codes for the device.
1191
1196
  `,
@@ -1198,6 +1203,7 @@ export const common_device_properties = z.object({
1198
1203
  `
1199
1204
  ---
1200
1205
  deprecated: use device.properties.model.can_connect_accessory_keypad
1206
+ end_of_life: "2026-11-09"
1201
1207
  property_group_key: access_codes
1202
1208
  ---
1203
1209
  `,
@@ -1209,6 +1215,7 @@ export const common_device_properties = z.object({
1209
1215
  `
1210
1216
  ---
1211
1217
  deprecated: use offline_access_codes_enabled
1218
+ end_of_life: "2026-11-09"
1212
1219
  property_group_key: access_codes
1213
1220
  ---
1214
1221
  `,
@@ -1327,6 +1334,7 @@ export const device = z
1327
1334
  timezone: z.string().optional().describe(`
1328
1335
  ---
1329
1336
  deprecated: Use \`time_zone\` instead.
1337
+ end_of_life: "2026-11-09"
1330
1338
  ---
1331
1339
  Time zone of the device location.
1332
1340
  `),
@@ -76,6 +76,7 @@ export const connected_account_successful_login_event =
76
76
  }).describe(`
77
77
  ---
78
78
  deprecated: Use \`connect_webview.login_succeeded\`.
79
+ end_of_life: "2026-11-09"
79
80
  route_path: /connected_accounts
80
81
  ---
81
82
  A connected account had a successful login using a Connect Webview.
@@ -202,6 +202,7 @@ export const device_low_battery_event = device_event.extend({
202
202
  battery_level: battery_level.describe(`
203
203
  ---
204
204
  deprecated: Use device_battery_level and accessory_keypad_battery_level, which distinguish the device's own battery from a paired accessory keypad's battery.
205
+ end_of_life: "2026-11-09"
205
206
  ---
206
207
  Number in the range 0 to 1.0 indicating the level of the battery whose drop triggered this event.
207
208
  `),
@@ -81,6 +81,7 @@ export const climate_preset = z.object({
81
81
  `
82
82
  ---
83
83
  deprecated: Use 'thermostat_schedule.is_override_allowed'
84
+ end_of_life: "2026-11-09"
84
85
  ---
85
86
  Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).`,
86
87
  ),
@@ -12,6 +12,7 @@ export const workspace = z.object({
12
12
  company_name: z.string().describe(`
13
13
  ---
14
14
  deprecated: Use \`connect_partner_name\` instead.
15
+ end_of_life: "2026-11-09"
15
16
  ---
16
17
  Company name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces).
17
18
  `),