@seamapi/http 2.50.0 → 2.51.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 (64) hide show
  1. package/lib/resources/access-grant.d.ts +0 -4
  2. package/lib/resources/acs-access-group.d.ts +0 -8
  3. package/lib/resources/acs-system.d.ts +14 -16
  4. package/lib/resources/acs-user.d.ts +0 -4
  5. package/lib/resources/client-session.d.ts +0 -5
  6. package/lib/resources/connect-webview.d.ts +1 -1
  7. package/lib/resources/connected-account.d.ts +1 -27
  8. package/lib/resources/device-provider.d.ts +1 -1
  9. package/lib/resources/device.d.ts +112 -254
  10. package/lib/resources/event.d.ts +4 -43
  11. package/lib/resources/phone.d.ts +30 -0
  12. package/lib/resources/unmanaged-access-grant.d.ts +0 -4
  13. package/lib/resources/unmanaged-device.d.ts +34 -31
  14. package/lib/resources/workspace.d.ts +0 -5
  15. package/lib/routes/access-codes/access-codes.d.ts +0 -4
  16. package/lib/routes/access-grants/access-grants.d.ts +0 -25
  17. package/lib/routes/acs/entrances/entrances.d.ts +0 -4
  18. package/lib/routes/acs/users/users.d.ts +1 -9
  19. package/lib/routes/acs/users/users.js +0 -1
  20. package/lib/routes/acs/users/users.js.map +1 -1
  21. package/lib/routes/client-sessions/client-sessions.d.ts +1 -16
  22. package/lib/routes/client-sessions/client-sessions.js +0 -1
  23. package/lib/routes/client-sessions/client-sessions.js.map +1 -1
  24. package/lib/routes/connect-webviews/connect-webviews.d.ts +2 -2
  25. package/lib/routes/connected-accounts/connected-accounts.d.ts +1 -1
  26. package/lib/routes/customers/customers.d.ts +4 -12
  27. package/lib/routes/devices/devices.d.ts +3 -7
  28. package/lib/routes/devices/unmanaged/unmanaged.d.ts +3 -3
  29. package/lib/routes/locks/locks.d.ts +3 -3
  30. package/lib/routes/spaces/spaces.d.ts +13 -0
  31. package/lib/routes/thermostats/thermostats.d.ts +3 -13
  32. package/lib/routes/workspaces/workspaces.d.ts +0 -21
  33. package/lib/version.d.ts +1 -1
  34. package/lib/version.js +1 -1
  35. package/package.json +2 -2
  36. package/src/lib/resources/access-grant.ts +0 -5
  37. package/src/lib/resources/acs-access-group.ts +0 -20
  38. package/src/lib/resources/acs-system.ts +17 -35
  39. package/src/lib/resources/acs-user.ts +0 -4
  40. package/src/lib/resources/client-session.ts +0 -6
  41. package/src/lib/resources/connect-webview.ts +1 -0
  42. package/src/lib/resources/connected-account.ts +1 -28
  43. package/src/lib/resources/device-provider.ts +3 -0
  44. package/src/lib/resources/device.ts +2297 -2448
  45. package/src/lib/resources/event.ts +4 -53
  46. package/src/lib/resources/phone.ts +36 -0
  47. package/src/lib/resources/unmanaged-access-grant.ts +0 -5
  48. package/src/lib/resources/unmanaged-device.ts +118 -105
  49. package/src/lib/resources/workspace.ts +0 -6
  50. package/src/lib/routes/access-codes/access-codes.ts +0 -4
  51. package/src/lib/routes/access-grants/access-grants.ts +0 -27
  52. package/src/lib/routes/acs/entrances/entrances.ts +0 -4
  53. package/src/lib/routes/acs/users/users.ts +0 -10
  54. package/src/lib/routes/client-sessions/client-sessions.ts +0 -17
  55. package/src/lib/routes/connect-webviews/connect-webviews.ts +4 -0
  56. package/src/lib/routes/connected-accounts/connected-accounts.ts +1 -0
  57. package/src/lib/routes/customers/customers.ts +4 -14
  58. package/src/lib/routes/devices/devices.ts +11 -4
  59. package/src/lib/routes/devices/unmanaged/unmanaged.ts +11 -0
  60. package/src/lib/routes/locks/locks.ts +3 -0
  61. package/src/lib/routes/spaces/spaces.ts +16 -0
  62. package/src/lib/routes/thermostats/thermostats.ts +3 -10
  63. package/src/lib/routes/workspaces/workspaces.ts +0 -21
  64. package/src/lib/version.ts +1 -1
@@ -97,7 +97,7 @@ export type Device = {
97
97
  /**
98
98
  * Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
99
99
  */
100
- capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
100
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone' | 'pool'>;
101
101
  /**
102
102
  * Carbon dioxide concentration in parts per million, if the device measures it.
103
103
  */
@@ -163,7 +163,7 @@ export type Device = {
163
163
  /**
164
164
  * Type of the device. The `august_lock` and `yale_lock` values are deprecated. Use `yale_access_lock` in place of `august_lock`, and `yale_access_lock` or `yale_home_lock` in place of `yale_lock`.
165
165
  */
166
- device_type: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'yale_access_lock' | 'yale_home_lock' | 'yale_connect_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker' | 'alertify_sensor';
166
+ device_type: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'yale_access_lock' | 'yale_home_lock' | 'yale_connect_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'tuya_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'sensibo_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker' | 'alertify_sensor' | 'hayward_pool_system' | 'hayward_pool';
167
167
  /**
168
168
  * Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
169
169
  */
@@ -460,14 +460,18 @@ export type Device = {
460
460
  */
461
461
  message: string;
462
462
  }>;
463
+ /**
464
+ * Estimated number of occupants detected by the device.
465
+ */
466
+ estimated_occupant_count?: number | undefined;
463
467
  /**
464
468
  * Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
465
469
  */
466
470
  is_managed: true;
467
471
  /**
468
- * Indicates whether the device detects that the space is occupied, if the device measures occupancy.
472
+ * Indicates whether the device detects occupancy.
469
473
  */
470
- is_occupied?: boolean | undefined;
474
+ is_occupancy_detected?: boolean | undefined;
471
475
  /**
472
476
  * Indicates whether the device detects smoking, if the device measures it.
473
477
  */
@@ -488,11 +492,6 @@ export type Device = {
488
492
  * Time zone of the device location.
489
493
  */
490
494
  time_zone?: string | undefined;
491
- /**
492
- * Time zone of the device location.
493
- * @deprecated Use `time_zone` instead.
494
- */
495
- timezone?: string | undefined;
496
495
  } | undefined;
497
496
  /**
498
497
  * Mold risk level as reported by the device, if the device measures it.
@@ -519,9 +518,13 @@ export type Device = {
519
518
  */
520
519
  display_name: string;
521
520
  /**
522
- * Indicates whether the device detects that the space is occupied, if the device measures occupancy.
521
+ * Estimated number of occupants detected by the device.
522
+ */
523
+ estimated_occupant_count?: number | undefined;
524
+ /**
525
+ * Indicates whether the device detects occupancy.
523
526
  */
524
- is_occupied?: boolean | undefined;
527
+ is_occupancy_detected?: boolean | undefined;
525
528
  /**
526
529
  * Indicates whether the device detects smoking, if the device measures it.
527
530
  */
@@ -538,10 +541,6 @@ export type Device = {
538
541
  * Noise level as a Noise Risk Score (NRS), if the device reports one.
539
542
  */
540
543
  noise_level_nrs?: number | undefined;
541
- /**
542
- * Number of occupants the device detects, if the device counts occupants.
543
- */
544
- occupant_count?: number | undefined;
545
544
  /**
546
545
  * Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.
547
546
  */
@@ -571,14 +570,10 @@ export type Device = {
571
570
  * Noise level as a Noise Risk Score (NRS), if the device reports one.
572
571
  */
573
572
  noise_level_nrs?: number | undefined;
574
- /**
575
- * Number of occupants the device detects, if the device counts occupants.
576
- */
577
- occupant_count?: number | undefined;
578
573
  /**
579
574
  * Properties of the device.
580
575
  */
581
- properties: {
576
+ properties?: {
582
577
  /**
583
578
  * Accessory keypad properties and state.
584
579
  */
@@ -644,10 +639,6 @@ export type Device = {
644
639
  * Device model-related properties.
645
640
  */
646
641
  model: {
647
- /**
648
- * @deprecated use device.properties.model.can_connect_accessory_keypad
649
- */
650
- accessory_keypad_supported?: boolean | undefined;
651
642
  /**
652
643
  * Indicates whether the device can connect a accessory keypad.
653
644
  */
@@ -664,14 +655,6 @@ export type Device = {
664
655
  * Display name that corresponds to the manufacturer-specific terminology for the device.
665
656
  */
666
657
  manufacturer_display_name: string;
667
- /**
668
- * @deprecated use device.can_program_offline_access_codes.
669
- */
670
- offline_access_codes_supported?: boolean | undefined;
671
- /**
672
- * @deprecated use device.can_program_online_access_codes.
673
- */
674
- online_access_codes_supported?: boolean | undefined;
675
658
  };
676
659
  /**
677
660
  * Name of the device.
@@ -682,32 +665,14 @@ export type Device = {
682
665
  * Indicates current noise level in decibels, if the device supports noise detection.
683
666
  */
684
667
  noise_level_decibels?: number | undefined;
685
- /**
686
- * Indicates whether it is currently possible to use offline access codes for the device.
687
- * @deprecated use device.can_program_offline_access_codes
688
- */
689
- offline_access_codes_enabled?: boolean | undefined;
690
668
  /**
691
669
  * Indicates whether the device is online.
692
670
  */
693
671
  online: boolean;
694
- /**
695
- * Indicates whether it is currently possible to use online access codes for the device.
696
- * @deprecated use device.can_program_online_access_codes
697
- */
698
- online_access_codes_enabled?: boolean | undefined;
699
672
  /**
700
673
  * Serial number of the device.
701
674
  */
702
675
  serial_number?: string | undefined;
703
- /**
704
- * @deprecated use device.properties.model.can_connect_accessory_keypad
705
- */
706
- supports_accessory_keypad?: boolean | undefined;
707
- /**
708
- * @deprecated use offline_access_codes_enabled
709
- */
710
- supports_offline_access_codes?: boolean | undefined;
711
676
  /**
712
677
  * ASSA ABLOY Credential Service metadata for the phone.
713
678
  */
@@ -1019,11 +984,6 @@ export type Device = {
1019
984
  */
1020
985
  prefix?: number | undefined;
1021
986
  }> | undefined;
1022
- /**
1023
- * Site ID for a dormakaba Oracode device.
1024
- * @deprecated Previously marked as "@DEPRECATED."
1025
- */
1026
- site_id?: number | null | undefined;
1027
987
  /**
1028
988
  * Site name for a dormakaba Oracode device.
1029
989
  */
@@ -1582,44 +1542,6 @@ export type Device = {
1582
1542
  */
1583
1543
  site_name?: string | undefined;
1584
1544
  } | undefined;
1585
- /**
1586
- * Metada for a Salto device.
1587
- * @deprecated Use `salto_ks_metadata` instead.
1588
- */
1589
- salto_metadata?: {
1590
- /**
1591
- * Battery level for a Salto device.
1592
- */
1593
- battery_level?: string | undefined;
1594
- /**
1595
- * Customer reference for a Salto device.
1596
- */
1597
- customer_reference?: string | undefined;
1598
- /**
1599
- * Lock ID for a Salto device.
1600
- */
1601
- lock_id?: string | undefined;
1602
- /**
1603
- * Lock type for a Salto device.
1604
- */
1605
- lock_type?: string | undefined;
1606
- /**
1607
- * Locked state for a Salto device.
1608
- */
1609
- locked_state?: string | undefined;
1610
- /**
1611
- * Model for a Salto device.
1612
- */
1613
- model?: string | undefined;
1614
- /**
1615
- * Site ID for the Salto KS site to which the device belongs.
1616
- */
1617
- site_id?: string | undefined;
1618
- /**
1619
- * Site name for the Salto KS site to which the device belongs.
1620
- */
1621
- site_name?: string | undefined;
1622
- } | undefined;
1623
1545
  /**
1624
1546
  * Metadata for a Schlage device.
1625
1547
  */
@@ -1666,15 +1588,44 @@ export type Device = {
1666
1588
  * Device name for a Sensi device.
1667
1589
  */
1668
1590
  device_name?: string | undefined;
1669
- /**
1670
- * Deprecated. Seam no longer sets this field.
1671
- */
1672
- dual_setpoints_not_supported?: boolean | undefined;
1673
1591
  /**
1674
1592
  * Product type for a Sensi device.
1675
1593
  */
1676
1594
  product_type?: string | undefined;
1677
1595
  } | undefined;
1596
+ /**
1597
+ * Metadata for a Sensibo device.
1598
+ */
1599
+ sensibo_metadata?: {
1600
+ /**
1601
+ * Firmware version of the Sensibo device.
1602
+ */
1603
+ firmware_version?: string | undefined;
1604
+ /**
1605
+ * MAC address of the Sensibo device.
1606
+ */
1607
+ mac_address?: string | undefined;
1608
+ /**
1609
+ * ID of the Sensibo device, which Sensibo calls a pod.
1610
+ */
1611
+ pod_id?: string | undefined;
1612
+ /**
1613
+ * Product model of the Sensibo device, such as `skyv2` or `air`.
1614
+ */
1615
+ product_model?: string | undefined;
1616
+ /**
1617
+ * Name of the room that the Sensibo device is in.
1618
+ */
1619
+ room_name?: string | undefined;
1620
+ /**
1621
+ * Serial number of the Sensibo device.
1622
+ */
1623
+ serial_number?: string | undefined;
1624
+ /**
1625
+ * Temperature unit that the Sensibo device displays: `C` or `F`.
1626
+ */
1627
+ temperature_unit?: string | undefined;
1628
+ } | undefined;
1678
1629
  /**
1679
1630
  * Metadata for a SmartThings device.
1680
1631
  */
@@ -1858,6 +1809,39 @@ export type Device = {
1858
1809
  wireless_keypad_name?: string | undefined;
1859
1810
  }> | undefined;
1860
1811
  } | undefined;
1812
+ /**
1813
+ * Metadata for a Tuya device.
1814
+ */
1815
+ tuya_metadata?: {
1816
+ /**
1817
+ * Tuya product category code for the device (e.g. ms).
1818
+ */
1819
+ category?: string | undefined;
1820
+ /**
1821
+ * Device ID for a Tuya device.
1822
+ */
1823
+ device_id?: string | undefined;
1824
+ /**
1825
+ * Device name for a Tuya device.
1826
+ */
1827
+ device_name?: string | undefined;
1828
+ /**
1829
+ * Model reported for a Tuya device.
1830
+ */
1831
+ model?: string | null | undefined;
1832
+ /**
1833
+ * Tuya product ID for the device.
1834
+ */
1835
+ product_id?: string | undefined;
1836
+ /**
1837
+ * Tuya product name for the device.
1838
+ */
1839
+ product_name?: string | undefined;
1840
+ /**
1841
+ * Time zone reported for a Tuya device (e.g. +08:00).
1842
+ */
1843
+ time_zone?: string | null | undefined;
1844
+ } | undefined;
1861
1845
  /**
1862
1846
  * Metadata for a 2N device.
1863
1847
  */
@@ -2176,69 +2160,6 @@ export type Device = {
2176
2160
  * Indicates whether the device supports a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes).
2177
2161
  */
2178
2162
  supports_backup_access_code_pool?: boolean | undefined;
2179
- /**
2180
- * Active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
2181
- * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead.
2182
- */
2183
- active_thermostat_schedule?: {
2184
- /**
2185
- * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
2186
- */
2187
- climate_preset_key: string;
2188
- /**
2189
- * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.
2190
- */
2191
- created_at: string;
2192
- /**
2193
- * ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device.
2194
- */
2195
- device_id: string;
2196
- /**
2197
- * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
2198
- */
2199
- ends_at: string;
2200
- /**
2201
- * Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
2202
- */
2203
- errors: Array<{
2204
- /**
2205
- * Date and time at which Seam created the error.
2206
- */
2207
- created_at: string;
2208
- /**
2209
- * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
2210
- */
2211
- error_code: string;
2212
- /**
2213
- * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
2214
- */
2215
- message: string;
2216
- }>;
2217
- /**
2218
- * Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.
2219
- */
2220
- is_override_allowed?: boolean | undefined;
2221
- /**
2222
- * Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
2223
- */
2224
- max_override_period_minutes?: number | null | undefined;
2225
- /**
2226
- * User-friendly name to identify the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
2227
- */
2228
- name: string | null;
2229
- /**
2230
- * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
2231
- */
2232
- starts_at: string;
2233
- /**
2234
- * ID of the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
2235
- */
2236
- thermostat_schedule_id: string;
2237
- /**
2238
- * ID of the workspace that contains the thermostat schedule.
2239
- */
2240
- workspace_id: string;
2241
- } | null | undefined;
2242
2163
  /**
2243
2164
  * ID of the active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
2244
2165
  */
@@ -2316,11 +2237,6 @@ export type Device = {
2316
2237
  * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
2317
2238
  */
2318
2239
  hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined;
2319
- /**
2320
- * 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).
2321
- * @deprecated Use 'thermostat_schedule.is_override_allowed'
2322
- */
2323
- manual_override_allowed: boolean;
2324
2240
  /**
2325
2241
  * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2326
2242
  */
@@ -2403,90 +2319,6 @@ export type Device = {
2403
2319
  * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
2404
2320
  */
2405
2321
  hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined;
2406
- /**
2407
- * 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).
2408
- * @deprecated Use 'thermostat_schedule.is_override_allowed'
2409
- */
2410
- manual_override_allowed?: boolean | undefined;
2411
- /**
2412
- * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2413
- */
2414
- name?: string | null | undefined;
2415
- } | undefined;
2416
- /**
2417
- * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead.
2418
- */
2419
- default_climate_setting?: {
2420
- /**
2421
- * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
2422
- */
2423
- can_delete?: boolean | undefined;
2424
- /**
2425
- * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
2426
- */
2427
- can_edit?: boolean | undefined;
2428
- /**
2429
- * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.
2430
- */
2431
- can_use_with_thermostat_daily_programs?: boolean | undefined;
2432
- /**
2433
- * Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2434
- */
2435
- climate_preset_key?: string | undefined;
2436
- /**
2437
- * The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
2438
- */
2439
- climate_preset_mode?: 'home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied' | undefined;
2440
- /**
2441
- * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2442
- */
2443
- cooling_set_point_celsius?: number | undefined;
2444
- /**
2445
- * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2446
- */
2447
- cooling_set_point_fahrenheit?: number | undefined;
2448
- /**
2449
- * Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2450
- */
2451
- display_name?: string | undefined;
2452
- /**
2453
- * Metadata specific to the Ecobee climate, if applicable.
2454
- */
2455
- ecobee_metadata?: {
2456
- /**
2457
- * Reference to the Ecobee climate, if applicable.
2458
- */
2459
- climate_ref?: string | undefined;
2460
- /**
2461
- * Indicates if the climate preset is optimized by Ecobee.
2462
- */
2463
- is_optimized?: boolean | undefined;
2464
- /**
2465
- * Indicates whether the climate preset is owned by the user or the system.
2466
- */
2467
- owner?: 'user' | 'system' | undefined;
2468
- } | undefined;
2469
- /**
2470
- * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
2471
- */
2472
- fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined;
2473
- /**
2474
- * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2475
- */
2476
- heating_set_point_celsius?: number | undefined;
2477
- /**
2478
- * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2479
- */
2480
- heating_set_point_fahrenheit?: number | undefined;
2481
- /**
2482
- * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
2483
- */
2484
- hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined;
2485
- /**
2486
- * 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).
2487
- * @deprecated Use 'thermostat_schedule.is_override_allowed'
2488
- */
2489
- manual_override_allowed?: boolean | undefined;
2490
2322
  /**
2491
2323
  * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2492
2324
  */
@@ -2496,10 +2328,6 @@ export type Device = {
2496
2328
  * Key of the [fallback climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.
2497
2329
  */
2498
2330
  fallback_climate_preset_key?: string | null | undefined;
2499
- /**
2500
- * @deprecated Use `current_climate_setting.fan_mode_setting` instead.
2501
- */
2502
- fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined;
2503
2331
  /**
2504
2332
  * Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.
2505
2333
  */
@@ -2676,7 +2504,7 @@ export type Device = {
2676
2504
  */
2677
2505
  wednesday_program_id: string | null;
2678
2506
  } | null | undefined;
2679
- };
2507
+ } | undefined;
2680
2508
  /**
2681
2509
  * Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.
2682
2510
  */
@@ -3029,6 +2857,21 @@ export type Device = {
3029
2857
  */
3030
2858
  warning_code: 'hub_required_for_additional_capabilities';
3031
2859
  } /**
2860
+ * Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back.
2861
+ */ | {
2862
+ /**
2863
+ * Date and time at which Seam created the warning.
2864
+ */
2865
+ created_at: string;
2866
+ /**
2867
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
2868
+ */
2869
+ message: string;
2870
+ /**
2871
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
2872
+ */
2873
+ warning_code: 'service_mode';
2874
+ } /**
3032
2875
  * Indicates a provider-specific issue that may affect device functionality.
3033
2876
  */ | {
3034
2877
  /**
@@ -3127,6 +2970,21 @@ export type Device = {
3127
2970
  */
3128
2971
  warning_code: 'max_access_codes_reached';
3129
2972
  } /**
2973
+ * Indicates that a third-party subscription is required to enable additional device capabilities.
2974
+ */ | {
2975
+ /**
2976
+ * Date and time at which Seam created the warning.
2977
+ */
2978
+ created_at: string;
2979
+ /**
2980
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
2981
+ */
2982
+ message: string;
2983
+ /**
2984
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
2985
+ */
2986
+ warning_code: 'subscription_required_for_additional_capabilities';
2987
+ } /**
3130
2988
  * Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.
3131
2989
  */ | {
3132
2990
  /**
@@ -2649,40 +2649,6 @@ export type SeamEvent = {
2649
2649
  * ID of the workspace associated with the event.
2650
2650
  */
2651
2651
  workspace_id: string;
2652
- } | {
2653
- /**
2654
- * ID of the Connect Webview associated with the event.
2655
- */
2656
- connect_webview_id: string;
2657
- /**
2658
- * Custom metadata of the connected account, present when connected_account_id is provided.
2659
- */
2660
- connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
2661
- /**
2662
- * ID of the affected connected account.
2663
- */
2664
- connected_account_id: string;
2665
- /**
2666
- * Date and time at which the event was created.
2667
- */
2668
- created_at: string;
2669
- /**
2670
- * Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.
2671
- */
2672
- event_description?: string | undefined;
2673
- /**
2674
- * ID of the event.
2675
- */
2676
- event_id: string;
2677
- event_type: 'connected_account.successful_login';
2678
- /**
2679
- * Date and time at which the event occurred.
2680
- */
2681
- occurred_at: string;
2682
- /**
2683
- * ID of the workspace associated with the event.
2684
- */
2685
- workspace_id: string;
2686
2652
  } | {
2687
2653
  /**
2688
2654
  * Custom metadata of the connected account, present when connected_account_id is provided.
@@ -3790,11 +3756,6 @@ export type SeamEvent = {
3790
3756
  * Number in the range 0 to 1.0 indicating the battery level of the affected device's paired accessory keypad, when the device has one and its level is known.
3791
3757
  */
3792
3758
  accessory_keypad_battery_level?: number | undefined;
3793
- /**
3794
- * Number in the range 0 to 1.0 indicating the level of the battery whose drop triggered this event.
3795
- * @deprecated Use device_battery_level and accessory_keypad_battery_level, which distinguish the device's own battery from a paired accessory keypad's battery.
3796
- */
3797
- battery_level: number;
3798
3759
  /**
3799
3760
  * Custom metadata of the connected account, present when connected_account_id is provided.
3800
3761
  */
@@ -5404,10 +5365,6 @@ export type SeamEvent = {
5404
5365
  */
5405
5366
  workspace_id: string;
5406
5367
  } | {
5407
- /**
5408
- * The reason the camera was activated.
5409
- */
5410
- activation_reason: 'motion_detected';
5411
5368
  /**
5412
5369
  * Custom metadata of the connected account, present when connected_account_id is provided.
5413
5370
  */
@@ -5445,6 +5402,10 @@ export type SeamEvent = {
5445
5402
  * URL to a thumbnail image captured at the time of activation.
5446
5403
  */
5447
5404
  image_url?: string | undefined;
5405
+ /**
5406
+ * Whether motion detection activated the camera, if known.
5407
+ */
5408
+ is_motion_detected?: boolean | undefined;
5448
5409
  /**
5449
5410
  * IDs of the media, such as a video clip and a thumbnail image, captured for this activation. Use `/media/get` to retrieve each one.
5450
5411
  */
@@ -690,6 +690,21 @@ export type Phone = {
690
690
  */
691
691
  warning_code: 'hub_required_for_additional_capabilities';
692
692
  } /**
693
+ * Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back.
694
+ */ | {
695
+ /**
696
+ * Date and time at which Seam created the warning.
697
+ */
698
+ created_at: string;
699
+ /**
700
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
701
+ */
702
+ message: string;
703
+ /**
704
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
705
+ */
706
+ warning_code: 'service_mode';
707
+ } /**
693
708
  * Indicates a provider-specific issue that may affect device functionality.
694
709
  */ | {
695
710
  /**
@@ -788,6 +803,21 @@ export type Phone = {
788
803
  */
789
804
  warning_code: 'max_access_codes_reached';
790
805
  } /**
806
+ * Indicates that a third-party subscription is required to enable additional device capabilities.
807
+ */ | {
808
+ /**
809
+ * Date and time at which Seam created the warning.
810
+ */
811
+ created_at: string;
812
+ /**
813
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
814
+ */
815
+ message: string;
816
+ /**
817
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
818
+ */
819
+ warning_code: 'subscription_required_for_additional_capabilities';
820
+ } /**
791
821
  * Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.
792
822
  */ | {
793
823
  /**
@@ -62,10 +62,6 @@ export type UnmanagedAccessGrant = {
62
62
  */
63
63
  message: string;
64
64
  }>;
65
- /**
66
- * @deprecated Use `space_ids`.
67
- */
68
- location_ids: Array<string>;
69
65
  /**
70
66
  * Name of the Access Grant. If not provided, the display name will be computed.
71
67
  */