@seamapi/types 1.1201.0 → 1.1203.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 (32) hide show
  1. package/lib/seam/connect/models/acs/acs-system.d.ts +4 -4
  2. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +9 -9
  3. package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -2
  4. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  5. package/lib/seam/connect/models/action-attempts/{set-pool-heating.d.ts → set-temperature-controller-mode.d.ts} +10 -10
  6. package/lib/seam/connect/models/action-attempts/{set-pool-heating.js → set-temperature-controller-mode.js} +7 -7
  7. package/lib/seam/connect/models/action-attempts/set-temperature-controller-mode.js.map +1 -0
  8. package/lib/seam/connect/models/devices/capability-properties/lock.js +1 -0
  9. package/lib/seam/connect/models/devices/capability-properties/lock.js.map +1 -1
  10. package/lib/seam/connect/models/devices/device-metadata.d.ts +10 -25
  11. package/lib/seam/connect/models/devices/device-metadata.js +7 -19
  12. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  13. package/lib/seam/connect/models/devices/device-type.d.ts +4 -4
  14. package/lib/seam/connect/models/devices/device-type.js +3 -3
  15. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  16. package/lib/seam/connect/models/devices/device.d.ts +27 -48
  17. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +23 -38
  18. package/lib/seam/connect/models/events/devices.d.ts +4 -4
  19. package/lib/seam/connect/models/events/seam-event.d.ts +2 -2
  20. package/lib/seam/connect/openapi.js +34 -43
  21. package/lib/seam/connect/openapi.js.map +1 -1
  22. package/lib/seam/connect/route-types.d.ts +457 -547
  23. package/package.json +1 -1
  24. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -2
  25. package/src/lib/seam/connect/models/action-attempts/set-temperature-controller-mode.ts +54 -0
  26. package/src/lib/seam/connect/models/devices/capability-properties/lock.ts +1 -0
  27. package/src/lib/seam/connect/models/devices/device-metadata.ts +7 -23
  28. package/src/lib/seam/connect/models/devices/device-type.ts +3 -3
  29. package/src/lib/seam/connect/openapi.ts +35 -46
  30. package/src/lib/seam/connect/route-types.ts +457 -581
  31. package/lib/seam/connect/models/action-attempts/set-pool-heating.js.map +0 -1
  32. package/src/lib/seam/connect/models/action-attempts/set-pool-heating.ts +0 -53
@@ -2297,8 +2297,8 @@ export type Routes = {
2297
2297
  result: null
2298
2298
  /** Errors associated with the action attempt. Null for pending action attempts. */
2299
2299
  error: null
2300
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
2301
- action_type: 'SET_POOL_HEATING'
2300
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
2301
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
2302
2302
  }
2303
2303
  | {
2304
2304
  /** ID of the action attempt. */
@@ -2306,8 +2306,8 @@ export type Routes = {
2306
2306
  status: 'success'
2307
2307
  /** Errors associated with the action attempt. Null for successful action attempts. */
2308
2308
  error: null
2309
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
2310
- action_type: 'SET_POOL_HEATING'
2309
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
2310
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
2311
2311
  /** Result of the action. */
2312
2312
  result: {}
2313
2313
  }
@@ -2317,8 +2317,8 @@ export type Routes = {
2317
2317
  status: 'error'
2318
2318
  /** Result of the action attempt. Null for failed action attempts. */
2319
2319
  result: null
2320
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
2321
- action_type: 'SET_POOL_HEATING'
2320
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
2321
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
2322
2322
  /** Error associated with the action. */
2323
2323
  error: {
2324
2324
  /** Type of the error. */
@@ -6042,8 +6042,8 @@ export type Routes = {
6042
6042
  result: null
6043
6043
  /** Errors associated with the action attempt. Null for pending action attempts. */
6044
6044
  error: null
6045
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
6046
- action_type: 'SET_POOL_HEATING'
6045
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
6046
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
6047
6047
  }
6048
6048
  | {
6049
6049
  /** ID of the action attempt. */
@@ -6051,8 +6051,8 @@ export type Routes = {
6051
6051
  status: 'success'
6052
6052
  /** Errors associated with the action attempt. Null for successful action attempts. */
6053
6053
  error: null
6054
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
6055
- action_type: 'SET_POOL_HEATING'
6054
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
6055
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
6056
6056
  /** Result of the action. */
6057
6057
  result: {}
6058
6058
  }
@@ -6062,8 +6062,8 @@ export type Routes = {
6062
6062
  status: 'error'
6063
6063
  /** Result of the action attempt. Null for failed action attempts. */
6064
6064
  result: null
6065
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
6066
- action_type: 'SET_POOL_HEATING'
6065
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
6066
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
6067
6067
  /** Error associated with the action. */
6068
6068
  error: {
6069
6069
  /** Type of the error. */
@@ -11604,8 +11604,8 @@ export type Routes = {
11604
11604
  result: null
11605
11605
  /** Errors associated with the action attempt. Null for pending action attempts. */
11606
11606
  error: null
11607
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
11608
- action_type: 'SET_POOL_HEATING'
11607
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
11608
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
11609
11609
  }
11610
11610
  | {
11611
11611
  /** ID of the action attempt. */
@@ -11613,8 +11613,8 @@ export type Routes = {
11613
11613
  status: 'success'
11614
11614
  /** Errors associated with the action attempt. Null for successful action attempts. */
11615
11615
  error: null
11616
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
11617
- action_type: 'SET_POOL_HEATING'
11616
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
11617
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
11618
11618
  /** Result of the action. */
11619
11619
  result: {}
11620
11620
  }
@@ -11624,8 +11624,8 @@ export type Routes = {
11624
11624
  status: 'error'
11625
11625
  /** Result of the action attempt. Null for failed action attempts. */
11626
11626
  result: null
11627
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
11628
- action_type: 'SET_POOL_HEATING'
11627
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
11628
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
11629
11629
  /** Error associated with the action. */
11630
11630
  error: {
11631
11631
  /** Type of the error. */
@@ -15200,8 +15200,8 @@ export type Routes = {
15200
15200
  result: null
15201
15201
  /** Errors associated with the action attempt. Null for pending action attempts. */
15202
15202
  error: null
15203
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
15204
- action_type: 'SET_POOL_HEATING'
15203
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
15204
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
15205
15205
  }
15206
15206
  | {
15207
15207
  /** ID of the action attempt. */
@@ -15209,8 +15209,8 @@ export type Routes = {
15209
15209
  status: 'success'
15210
15210
  /** Errors associated with the action attempt. Null for successful action attempts. */
15211
15211
  error: null
15212
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
15213
- action_type: 'SET_POOL_HEATING'
15212
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
15213
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
15214
15214
  /** Result of the action. */
15215
15215
  result: {}
15216
15216
  }
@@ -15220,8 +15220,8 @@ export type Routes = {
15220
15220
  status: 'error'
15221
15221
  /** Result of the action attempt. Null for failed action attempts. */
15222
15222
  result: null
15223
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
15224
- action_type: 'SET_POOL_HEATING'
15223
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
15224
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
15225
15225
  /** Error associated with the action. */
15226
15226
  error: {
15227
15227
  /** Type of the error. */
@@ -16266,7 +16266,7 @@ export type Routes = {
16266
16266
  )
16267
16267
  | 'sonos_speaker'
16268
16268
  | 'alertify_sensor'
16269
- | ('hayward_pool_system' | 'hayward_pool')
16269
+ | ('hayward_pool_controller' | 'hayward_pool')
16270
16270
  /** IDs of the spaces the device is in. */
16271
16271
  space_ids: string[]
16272
16272
  /** Optional nickname to describe the device, settable through Seam. */
@@ -17367,29 +17367,18 @@ export type Routes = {
17367
17367
  | undefined
17368
17368
  )
17369
17369
  | undefined
17370
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
17370
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
17371
17371
  hayward_omnilogic_metadata?:
17372
17372
  | (
17373
17373
  | {
17374
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
17374
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
17375
17375
  msp_system_id?: (string | undefined) | undefined
17376
- /** Name of the system, as set in the Hayward OmniLogic app. */
17376
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
17377
17377
  backyard_name?: (string | undefined) | undefined
17378
- /** ID of the body of water within its system. Only present on a pool or spa body. */
17379
- body_of_water_id?:
17380
- (string | undefined) | undefined
17381
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
17382
- body_of_water_name?:
17383
- (string | undefined) | undefined
17384
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
17385
- virtual_heater_id?:
17386
- (string | undefined) | undefined
17387
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
17388
- is_shared_equipment?:
17389
- (boolean | undefined) | undefined
17390
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
17391
- shared_equipment_priority?:
17392
- (('high' | 'low') | undefined) | undefined
17378
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
17379
+ system_id?: (string | undefined) | undefined
17380
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
17381
+ system_name?: (string | undefined) | undefined
17393
17382
  }
17394
17383
  | undefined
17395
17384
  )
@@ -17511,7 +17500,8 @@ export type Routes = {
17511
17500
  (boolean | undefined) | undefined
17512
17501
  /** Indicates whether the lock is locked. */
17513
17502
  locked?: (boolean | undefined) | undefined
17514
- /** Keypad battery status. */
17503
+ /** Keypad battery status.
17504
+ * @deprecated Use `accessory_keypad.battery` instead.*/
17515
17505
  keypad_battery?:
17516
17506
  | (
17517
17507
  | {
@@ -23050,8 +23040,8 @@ export type Routes = {
23050
23040
  result: null
23051
23041
  /** Errors associated with the action attempt. Null for pending action attempts. */
23052
23042
  error: null
23053
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
23054
- action_type: 'SET_POOL_HEATING'
23043
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
23044
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
23055
23045
  }
23056
23046
  | {
23057
23047
  /** ID of the action attempt. */
@@ -23059,8 +23049,8 @@ export type Routes = {
23059
23049
  status: 'success'
23060
23050
  /** Errors associated with the action attempt. Null for successful action attempts. */
23061
23051
  error: null
23062
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
23063
- action_type: 'SET_POOL_HEATING'
23052
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
23053
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
23064
23054
  /** Result of the action. */
23065
23055
  result: {}
23066
23056
  }
@@ -23070,8 +23060,8 @@ export type Routes = {
23070
23060
  status: 'error'
23071
23061
  /** Result of the action attempt. Null for failed action attempts. */
23072
23062
  result: null
23073
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
23074
- action_type: 'SET_POOL_HEATING'
23063
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
23064
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
23075
23065
  /** Error associated with the action. */
23076
23066
  error: {
23077
23067
  /** Type of the error. */
@@ -25657,8 +25647,8 @@ export type Routes = {
25657
25647
  result: null
25658
25648
  /** Errors associated with the action attempt. Null for pending action attempts. */
25659
25649
  error: null
25660
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
25661
- action_type: 'SET_POOL_HEATING'
25650
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
25651
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
25662
25652
  }
25663
25653
  | {
25664
25654
  /** ID of the action attempt. */
@@ -25666,8 +25656,8 @@ export type Routes = {
25666
25656
  status: 'success'
25667
25657
  /** Errors associated with the action attempt. Null for successful action attempts. */
25668
25658
  error: null
25669
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
25670
- action_type: 'SET_POOL_HEATING'
25659
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
25660
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
25671
25661
  /** Result of the action. */
25672
25662
  result: {}
25673
25663
  }
@@ -25677,8 +25667,8 @@ export type Routes = {
25677
25667
  status: 'error'
25678
25668
  /** Result of the action attempt. Null for failed action attempts. */
25679
25669
  result: null
25680
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
25681
- action_type: 'SET_POOL_HEATING'
25670
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
25671
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
25682
25672
  /** Error associated with the action. */
25683
25673
  error: {
25684
25674
  /** Type of the error. */
@@ -26359,7 +26349,7 @@ export type Routes = {
26359
26349
  )
26360
26350
  | 'sonos_speaker'
26361
26351
  | 'alertify_sensor'
26362
- | ('hayward_pool_system' | 'hayward_pool')
26352
+ | ('hayward_pool_controller' | 'hayward_pool')
26363
26353
  /** IDs of the spaces the device is in. */
26364
26354
  space_ids: string[]
26365
26355
  /** Optional nickname to describe the device, settable through Seam. */
@@ -27460,29 +27450,18 @@ export type Routes = {
27460
27450
  | undefined
27461
27451
  )
27462
27452
  | undefined
27463
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
27453
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
27464
27454
  hayward_omnilogic_metadata?:
27465
27455
  | (
27466
27456
  | {
27467
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
27457
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
27468
27458
  msp_system_id?: (string | undefined) | undefined
27469
- /** Name of the system, as set in the Hayward OmniLogic app. */
27459
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
27470
27460
  backyard_name?: (string | undefined) | undefined
27471
- /** ID of the body of water within its system. Only present on a pool or spa body. */
27472
- body_of_water_id?:
27473
- (string | undefined) | undefined
27474
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
27475
- body_of_water_name?:
27476
- (string | undefined) | undefined
27477
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
27478
- virtual_heater_id?:
27479
- (string | undefined) | undefined
27480
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
27481
- is_shared_equipment?:
27482
- (boolean | undefined) | undefined
27483
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
27484
- shared_equipment_priority?:
27485
- (('high' | 'low') | undefined) | undefined
27461
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
27462
+ system_id?: (string | undefined) | undefined
27463
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
27464
+ system_name?: (string | undefined) | undefined
27486
27465
  }
27487
27466
  | undefined
27488
27467
  )
@@ -27604,7 +27583,8 @@ export type Routes = {
27604
27583
  (boolean | undefined) | undefined
27605
27584
  /** Indicates whether the lock is locked. */
27606
27585
  locked?: (boolean | undefined) | undefined
27607
- /** Keypad battery status. */
27586
+ /** Keypad battery status.
27587
+ * @deprecated Use `accessory_keypad.battery` instead.*/
27608
27588
  keypad_battery?:
27609
27589
  | (
27610
27590
  | {
@@ -32259,8 +32239,8 @@ export type Routes = {
32259
32239
  result: null
32260
32240
  /** Errors associated with the action attempt. Null for pending action attempts. */
32261
32241
  error: null
32262
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
32263
- action_type: 'SET_POOL_HEATING'
32242
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
32243
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
32264
32244
  }
32265
32245
  | {
32266
32246
  /** ID of the action attempt. */
@@ -32268,8 +32248,8 @@ export type Routes = {
32268
32248
  status: 'success'
32269
32249
  /** Errors associated with the action attempt. Null for successful action attempts. */
32270
32250
  error: null
32271
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
32272
- action_type: 'SET_POOL_HEATING'
32251
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
32252
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
32273
32253
  /** Result of the action. */
32274
32254
  result: {}
32275
32255
  }
@@ -32279,8 +32259,8 @@ export type Routes = {
32279
32259
  status: 'error'
32280
32260
  /** Result of the action attempt. Null for failed action attempts. */
32281
32261
  result: null
32282
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
32283
- action_type: 'SET_POOL_HEATING'
32262
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
32263
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
32284
32264
  /** Error associated with the action. */
32285
32265
  error: {
32286
32266
  /** Type of the error. */
@@ -39130,8 +39110,8 @@ export type Routes = {
39130
39110
  result: null
39131
39111
  /** Errors associated with the action attempt. Null for pending action attempts. */
39132
39112
  error: null
39133
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
39134
- action_type: 'SET_POOL_HEATING'
39113
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
39114
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
39135
39115
  }
39136
39116
  | {
39137
39117
  /** ID of the action attempt. */
@@ -39139,8 +39119,8 @@ export type Routes = {
39139
39119
  status: 'success'
39140
39120
  /** Errors associated with the action attempt. Null for successful action attempts. */
39141
39121
  error: null
39142
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
39143
- action_type: 'SET_POOL_HEATING'
39122
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
39123
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
39144
39124
  /** Result of the action. */
39145
39125
  result: {}
39146
39126
  }
@@ -39150,8 +39130,8 @@ export type Routes = {
39150
39130
  status: 'error'
39151
39131
  /** Result of the action attempt. Null for failed action attempts. */
39152
39132
  result: null
39153
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
39154
- action_type: 'SET_POOL_HEATING'
39133
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
39134
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
39155
39135
  /** Error associated with the action. */
39156
39136
  error: {
39157
39137
  /** Type of the error. */
@@ -41825,8 +41805,8 @@ export type Routes = {
41825
41805
  result: null
41826
41806
  /** Errors associated with the action attempt. Null for pending action attempts. */
41827
41807
  error: null
41828
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
41829
- action_type: 'SET_POOL_HEATING'
41808
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
41809
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
41830
41810
  }
41831
41811
  | {
41832
41812
  /** ID of the action attempt. */
@@ -41834,8 +41814,8 @@ export type Routes = {
41834
41814
  status: 'success'
41835
41815
  /** Errors associated with the action attempt. Null for successful action attempts. */
41836
41816
  error: null
41837
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
41838
- action_type: 'SET_POOL_HEATING'
41817
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
41818
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
41839
41819
  /** Result of the action. */
41840
41820
  result: {}
41841
41821
  }
@@ -41845,8 +41825,8 @@ export type Routes = {
41845
41825
  status: 'error'
41846
41826
  /** Result of the action attempt. Null for failed action attempts. */
41847
41827
  result: null
41848
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
41849
- action_type: 'SET_POOL_HEATING'
41828
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
41829
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
41850
41830
  /** Error associated with the action. */
41851
41831
  error: {
41852
41832
  /** Type of the error. */
@@ -44419,8 +44399,8 @@ export type Routes = {
44419
44399
  result: null
44420
44400
  /** Errors associated with the action attempt. Null for pending action attempts. */
44421
44401
  error: null
44422
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
44423
- action_type: 'SET_POOL_HEATING'
44402
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
44403
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
44424
44404
  }
44425
44405
  | {
44426
44406
  /** ID of the action attempt. */
@@ -44428,8 +44408,8 @@ export type Routes = {
44428
44408
  status: 'success'
44429
44409
  /** Errors associated with the action attempt. Null for successful action attempts. */
44430
44410
  error: null
44431
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
44432
- action_type: 'SET_POOL_HEATING'
44411
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
44412
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
44433
44413
  /** Result of the action. */
44434
44414
  result: {}
44435
44415
  }
@@ -44439,8 +44419,8 @@ export type Routes = {
44439
44419
  status: 'error'
44440
44420
  /** Result of the action attempt. Null for failed action attempts. */
44441
44421
  result: null
44442
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
44443
- action_type: 'SET_POOL_HEATING'
44422
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
44423
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
44444
44424
  /** Error associated with the action. */
44445
44425
  error: {
44446
44426
  /** Type of the error. */
@@ -47906,8 +47886,8 @@ export type Routes = {
47906
47886
  result: null
47907
47887
  /** Errors associated with the action attempt. Null for pending action attempts. */
47908
47888
  error: null
47909
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
47910
- action_type: 'SET_POOL_HEATING'
47889
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
47890
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
47911
47891
  }
47912
47892
  | {
47913
47893
  /** ID of the action attempt. */
@@ -47915,8 +47895,8 @@ export type Routes = {
47915
47895
  status: 'success'
47916
47896
  /** Errors associated with the action attempt. Null for successful action attempts. */
47917
47897
  error: null
47918
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
47919
- action_type: 'SET_POOL_HEATING'
47898
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
47899
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
47920
47900
  /** Result of the action. */
47921
47901
  result: {}
47922
47902
  }
@@ -47926,8 +47906,8 @@ export type Routes = {
47926
47906
  status: 'error'
47927
47907
  /** Result of the action attempt. Null for failed action attempts. */
47928
47908
  result: null
47929
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
47930
- action_type: 'SET_POOL_HEATING'
47909
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
47910
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
47931
47911
  /** Error associated with the action. */
47932
47912
  error: {
47933
47913
  /** Type of the error. */
@@ -53347,8 +53327,8 @@ export type Routes = {
53347
53327
  result: null
53348
53328
  /** Errors associated with the action attempt. Null for pending action attempts. */
53349
53329
  error: null
53350
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
53351
- action_type: 'SET_POOL_HEATING'
53330
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
53331
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
53352
53332
  }
53353
53333
  | {
53354
53334
  /** ID of the action attempt. */
@@ -53356,8 +53336,8 @@ export type Routes = {
53356
53336
  status: 'success'
53357
53337
  /** Errors associated with the action attempt. Null for successful action attempts. */
53358
53338
  error: null
53359
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
53360
- action_type: 'SET_POOL_HEATING'
53339
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
53340
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
53361
53341
  /** Result of the action. */
53362
53342
  result: {}
53363
53343
  }
@@ -53367,8 +53347,8 @@ export type Routes = {
53367
53347
  status: 'error'
53368
53348
  /** Result of the action attempt. Null for failed action attempts. */
53369
53349
  result: null
53370
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
53371
- action_type: 'SET_POOL_HEATING'
53350
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
53351
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
53372
53352
  /** Error associated with the action. */
53373
53353
  error: {
53374
53354
  /** Type of the error. */
@@ -55931,8 +55911,8 @@ export type Routes = {
55931
55911
  result: null
55932
55912
  /** Errors associated with the action attempt. Null for pending action attempts. */
55933
55913
  error: null
55934
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
55935
- action_type: 'SET_POOL_HEATING'
55914
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
55915
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
55936
55916
  }
55937
55917
  | {
55938
55918
  /** ID of the action attempt. */
@@ -55940,8 +55920,8 @@ export type Routes = {
55940
55920
  status: 'success'
55941
55921
  /** Errors associated with the action attempt. Null for successful action attempts. */
55942
55922
  error: null
55943
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
55944
- action_type: 'SET_POOL_HEATING'
55923
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
55924
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
55945
55925
  /** Result of the action. */
55946
55926
  result: {}
55947
55927
  }
@@ -55951,8 +55931,8 @@ export type Routes = {
55951
55931
  status: 'error'
55952
55932
  /** Result of the action attempt. Null for failed action attempts. */
55953
55933
  result: null
55954
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
55955
- action_type: 'SET_POOL_HEATING'
55934
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
55935
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
55956
55936
  /** Error associated with the action. */
55957
55937
  error: {
55958
55938
  /** Type of the error. */
@@ -59147,7 +59127,7 @@ export type Routes = {
59147
59127
  )
59148
59128
  | 'sonos_speaker'
59149
59129
  | 'alertify_sensor'
59150
- | ('hayward_pool_system' | 'hayward_pool')
59130
+ | ('hayward_pool_controller' | 'hayward_pool')
59151
59131
  /** IDs of the spaces the device is in. */
59152
59132
  space_ids: string[]
59153
59133
  /** Optional nickname to describe the device, settable through Seam. */
@@ -60206,25 +60186,18 @@ export type Routes = {
60206
60186
  | undefined
60207
60187
  )
60208
60188
  | undefined
60209
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
60189
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
60210
60190
  hayward_omnilogic_metadata?:
60211
60191
  | (
60212
60192
  | {
60213
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
60193
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
60214
60194
  msp_system_id?: (string | undefined) | undefined
60215
- /** Name of the system, as set in the Hayward OmniLogic app. */
60195
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
60216
60196
  backyard_name?: (string | undefined) | undefined
60217
- /** ID of the body of water within its system. Only present on a pool or spa body. */
60218
- body_of_water_id?: (string | undefined) | undefined
60219
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
60220
- body_of_water_name?: (string | undefined) | undefined
60221
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
60222
- virtual_heater_id?: (string | undefined) | undefined
60223
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
60224
- is_shared_equipment?: (boolean | undefined) | undefined
60225
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
60226
- shared_equipment_priority?:
60227
- (('high' | 'low') | undefined) | undefined
60197
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
60198
+ system_id?: (string | undefined) | undefined
60199
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
60200
+ system_name?: (string | undefined) | undefined
60228
60201
  }
60229
60202
  | undefined
60230
60203
  )
@@ -60343,7 +60316,8 @@ export type Routes = {
60343
60316
  has_native_entry_events?: (boolean | undefined) | undefined
60344
60317
  /** Indicates whether the lock is locked. */
60345
60318
  locked?: (boolean | undefined) | undefined
60346
- /** Keypad battery status. */
60319
+ /** Keypad battery status.
60320
+ * @deprecated Use `accessory_keypad.battery` instead.*/
60347
60321
  keypad_battery?:
60348
60322
  | (
60349
60323
  | {
@@ -61469,7 +61443,7 @@ export type Routes = {
61469
61443
  )
61470
61444
  | 'sonos_speaker'
61471
61445
  | 'alertify_sensor'
61472
- | ('hayward_pool_system' | 'hayward_pool')
61446
+ | ('hayward_pool_controller' | 'hayward_pool')
61473
61447
  )
61474
61448
  | undefined
61475
61449
  /** Array of device types for which you want to list devices. */
@@ -61534,7 +61508,7 @@ export type Routes = {
61534
61508
  )
61535
61509
  | 'sonos_speaker'
61536
61510
  | 'alertify_sensor'
61537
- | ('hayward_pool_system' | 'hayward_pool')
61511
+ | ('hayward_pool_controller' | 'hayward_pool')
61538
61512
  )[]
61539
61513
  | undefined
61540
61514
  /** Manufacturer for which you want to list devices. */
@@ -61702,8 +61676,8 @@ export type Routes = {
61702
61676
  space_id?: string | undefined
61703
61677
  /** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`. */
61704
61678
  search?: string | undefined
61705
- /** ID of the parent device whose child devices you want to list. */
61706
- parent_device_id?: string | undefined
61679
+ /** ID of the parent device whose child devices you want to list. Specify `null` to list devices that have no parent device. */
61680
+ parent_device_id?: (string | null) | undefined
61707
61681
  }
61708
61682
  formData: {}
61709
61683
  jsonResponse: {
@@ -61771,7 +61745,7 @@ export type Routes = {
61771
61745
  )
61772
61746
  | 'sonos_speaker'
61773
61747
  | 'alertify_sensor'
61774
- | ('hayward_pool_system' | 'hayward_pool')
61748
+ | ('hayward_pool_controller' | 'hayward_pool')
61775
61749
  /** IDs of the spaces the device is in. */
61776
61750
  space_ids: string[]
61777
61751
  /** Optional nickname to describe the device, settable through Seam. */
@@ -62830,25 +62804,18 @@ export type Routes = {
62830
62804
  | undefined
62831
62805
  )
62832
62806
  | undefined
62833
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
62807
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
62834
62808
  hayward_omnilogic_metadata?:
62835
62809
  | (
62836
62810
  | {
62837
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
62811
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
62838
62812
  msp_system_id?: (string | undefined) | undefined
62839
- /** Name of the system, as set in the Hayward OmniLogic app. */
62813
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
62840
62814
  backyard_name?: (string | undefined) | undefined
62841
- /** ID of the body of water within its system. Only present on a pool or spa body. */
62842
- body_of_water_id?: (string | undefined) | undefined
62843
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
62844
- body_of_water_name?: (string | undefined) | undefined
62845
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
62846
- virtual_heater_id?: (string | undefined) | undefined
62847
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
62848
- is_shared_equipment?: (boolean | undefined) | undefined
62849
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
62850
- shared_equipment_priority?:
62851
- (('high' | 'low') | undefined) | undefined
62815
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
62816
+ system_id?: (string | undefined) | undefined
62817
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
62818
+ system_name?: (string | undefined) | undefined
62852
62819
  }
62853
62820
  | undefined
62854
62821
  )
@@ -62967,7 +62934,8 @@ export type Routes = {
62967
62934
  has_native_entry_events?: (boolean | undefined) | undefined
62968
62935
  /** Indicates whether the lock is locked. */
62969
62936
  locked?: (boolean | undefined) | undefined
62970
- /** Keypad battery status. */
62937
+ /** Keypad battery status.
62938
+ * @deprecated Use `accessory_keypad.battery` instead.*/
62971
62939
  keypad_battery?:
62972
62940
  | (
62973
62941
  | {
@@ -65691,7 +65659,7 @@ export type Routes = {
65691
65659
  )
65692
65660
  | 'sonos_speaker'
65693
65661
  | 'alertify_sensor'
65694
- | ('hayward_pool_system' | 'hayward_pool')
65662
+ | ('hayward_pool_controller' | 'hayward_pool')
65695
65663
  /** Unique identifier for the account associated with the device. */
65696
65664
  connected_account_id: string
65697
65665
  /** Location information for the device. */
@@ -66366,7 +66334,7 @@ export type Routes = {
66366
66334
  )
66367
66335
  | 'sonos_speaker'
66368
66336
  | 'alertify_sensor'
66369
- | ('hayward_pool_system' | 'hayward_pool')
66337
+ | ('hayward_pool_controller' | 'hayward_pool')
66370
66338
  )
66371
66339
  | undefined
66372
66340
  /** Array of device types for which you want to list devices. */
@@ -66431,7 +66399,7 @@ export type Routes = {
66431
66399
  )
66432
66400
  | 'sonos_speaker'
66433
66401
  | 'alertify_sensor'
66434
- | ('hayward_pool_system' | 'hayward_pool')
66402
+ | ('hayward_pool_controller' | 'hayward_pool')
66435
66403
  )[]
66436
66404
  | undefined
66437
66405
  /** Manufacturer for which you want to list devices. */
@@ -66584,8 +66552,8 @@ export type Routes = {
66584
66552
  | undefined
66585
66553
  /** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`. */
66586
66554
  search?: string | undefined
66587
- /** ID of the parent device whose child devices you want to list. */
66588
- parent_device_id?: string | undefined
66555
+ /** ID of the parent device whose child devices you want to list. Specify `null` to list devices that have no parent device. */
66556
+ parent_device_id?: (string | null) | undefined
66589
66557
  /** Numerical limit on the number of devices to return. */
66590
66558
  limit?: number
66591
66559
  }
@@ -66655,7 +66623,7 @@ export type Routes = {
66655
66623
  )
66656
66624
  | 'sonos_speaker'
66657
66625
  | 'alertify_sensor'
66658
- | ('hayward_pool_system' | 'hayward_pool')
66626
+ | ('hayward_pool_controller' | 'hayward_pool')
66659
66627
  /** Unique identifier for the account associated with the device. */
66660
66628
  connected_account_id: string
66661
66629
  /** Location information for the device. */
@@ -78452,8 +78420,8 @@ export type Routes = {
78452
78420
  result: null
78453
78421
  /** Errors associated with the action attempt. Null for pending action attempts. */
78454
78422
  error: null
78455
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
78456
- action_type: 'SET_POOL_HEATING'
78423
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
78424
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
78457
78425
  }
78458
78426
  | {
78459
78427
  /** ID of the action attempt. */
@@ -78461,8 +78429,8 @@ export type Routes = {
78461
78429
  status: 'success'
78462
78430
  /** Errors associated with the action attempt. Null for successful action attempts. */
78463
78431
  error: null
78464
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
78465
- action_type: 'SET_POOL_HEATING'
78432
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
78433
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
78466
78434
  /** Result of the action. */
78467
78435
  result: {}
78468
78436
  }
@@ -78472,8 +78440,8 @@ export type Routes = {
78472
78440
  status: 'error'
78473
78441
  /** Result of the action attempt. Null for failed action attempts. */
78474
78442
  result: null
78475
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
78476
- action_type: 'SET_POOL_HEATING'
78443
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
78444
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
78477
78445
  /** Error associated with the action. */
78478
78446
  error: {
78479
78447
  /** Type of the error. */
@@ -78851,7 +78819,7 @@ export type Routes = {
78851
78819
  )
78852
78820
  | 'sonos_speaker'
78853
78821
  | 'alertify_sensor'
78854
- | ('hayward_pool_system' | 'hayward_pool')
78822
+ | ('hayward_pool_controller' | 'hayward_pool')
78855
78823
  /** IDs of the spaces the device is in. */
78856
78824
  space_ids: string[]
78857
78825
  /** Optional nickname to describe the device, settable through Seam. */
@@ -79910,25 +79878,18 @@ export type Routes = {
79910
79878
  | undefined
79911
79879
  )
79912
79880
  | undefined
79913
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
79881
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
79914
79882
  hayward_omnilogic_metadata?:
79915
79883
  | (
79916
79884
  | {
79917
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
79885
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
79918
79886
  msp_system_id?: (string | undefined) | undefined
79919
- /** Name of the system, as set in the Hayward OmniLogic app. */
79887
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
79920
79888
  backyard_name?: (string | undefined) | undefined
79921
- /** ID of the body of water within its system. Only present on a pool or spa body. */
79922
- body_of_water_id?: (string | undefined) | undefined
79923
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
79924
- body_of_water_name?: (string | undefined) | undefined
79925
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
79926
- virtual_heater_id?: (string | undefined) | undefined
79927
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
79928
- is_shared_equipment?: (boolean | undefined) | undefined
79929
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
79930
- shared_equipment_priority?:
79931
- (('high' | 'low') | undefined) | undefined
79889
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
79890
+ system_id?: (string | undefined) | undefined
79891
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
79892
+ system_name?: (string | undefined) | undefined
79932
79893
  }
79933
79894
  | undefined
79934
79895
  )
@@ -80047,7 +80008,8 @@ export type Routes = {
80047
80008
  has_native_entry_events?: (boolean | undefined) | undefined
80048
80009
  /** Indicates whether the lock is locked. */
80049
80010
  locked?: (boolean | undefined) | undefined
80050
- /** Keypad battery status. */
80011
+ /** Keypad battery status.
80012
+ * @deprecated Use `accessory_keypad.battery` instead.*/
80051
80013
  keypad_battery?:
80052
80014
  | (
80053
80015
  | {
@@ -81159,7 +81121,7 @@ export type Routes = {
81159
81121
  )
81160
81122
  | 'sonos_speaker'
81161
81123
  | 'alertify_sensor'
81162
- | ('hayward_pool_system' | 'hayward_pool')
81124
+ | ('hayward_pool_controller' | 'hayward_pool')
81163
81125
  /** IDs of the spaces the device is in. */
81164
81126
  space_ids: string[]
81165
81127
  /** Optional nickname to describe the device, settable through Seam. */
@@ -82218,25 +82180,18 @@ export type Routes = {
82218
82180
  | undefined
82219
82181
  )
82220
82182
  | undefined
82221
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
82183
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
82222
82184
  hayward_omnilogic_metadata?:
82223
82185
  | (
82224
82186
  | {
82225
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
82187
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
82226
82188
  msp_system_id?: (string | undefined) | undefined
82227
- /** Name of the system, as set in the Hayward OmniLogic app. */
82189
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
82228
82190
  backyard_name?: (string | undefined) | undefined
82229
- /** ID of the body of water within its system. Only present on a pool or spa body. */
82230
- body_of_water_id?: (string | undefined) | undefined
82231
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
82232
- body_of_water_name?: (string | undefined) | undefined
82233
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
82234
- virtual_heater_id?: (string | undefined) | undefined
82235
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
82236
- is_shared_equipment?: (boolean | undefined) | undefined
82237
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
82238
- shared_equipment_priority?:
82239
- (('high' | 'low') | undefined) | undefined
82191
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
82192
+ system_id?: (string | undefined) | undefined
82193
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
82194
+ system_name?: (string | undefined) | undefined
82240
82195
  }
82241
82196
  | undefined
82242
82197
  )
@@ -82355,7 +82310,8 @@ export type Routes = {
82355
82310
  has_native_entry_events?: (boolean | undefined) | undefined
82356
82311
  /** Indicates whether the lock is locked. */
82357
82312
  locked?: (boolean | undefined) | undefined
82358
- /** Keypad battery status. */
82313
+ /** Keypad battery status.
82314
+ * @deprecated Use `accessory_keypad.battery` instead.*/
82359
82315
  keypad_battery?:
82360
82316
  | (
82361
82317
  | {
@@ -83608,7 +83564,7 @@ export type Routes = {
83608
83564
  )
83609
83565
  | 'sonos_speaker'
83610
83566
  | 'alertify_sensor'
83611
- | ('hayward_pool_system' | 'hayward_pool')
83567
+ | ('hayward_pool_controller' | 'hayward_pool')
83612
83568
  /** IDs of the spaces the device is in. */
83613
83569
  space_ids: string[]
83614
83570
  /** Optional nickname to describe the device, settable through Seam. */
@@ -84667,25 +84623,18 @@ export type Routes = {
84667
84623
  | undefined
84668
84624
  )
84669
84625
  | undefined
84670
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
84626
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
84671
84627
  hayward_omnilogic_metadata?:
84672
84628
  | (
84673
84629
  | {
84674
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
84630
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
84675
84631
  msp_system_id?: (string | undefined) | undefined
84676
- /** Name of the system, as set in the Hayward OmniLogic app. */
84632
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
84677
84633
  backyard_name?: (string | undefined) | undefined
84678
- /** ID of the body of water within its system. Only present on a pool or spa body. */
84679
- body_of_water_id?: (string | undefined) | undefined
84680
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
84681
- body_of_water_name?: (string | undefined) | undefined
84682
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
84683
- virtual_heater_id?: (string | undefined) | undefined
84684
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
84685
- is_shared_equipment?: (boolean | undefined) | undefined
84686
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
84687
- shared_equipment_priority?:
84688
- (('high' | 'low') | undefined) | undefined
84634
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
84635
+ system_id?: (string | undefined) | undefined
84636
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
84637
+ system_name?: (string | undefined) | undefined
84689
84638
  }
84690
84639
  | undefined
84691
84640
  )
@@ -84804,7 +84753,8 @@ export type Routes = {
84804
84753
  has_native_entry_events?: (boolean | undefined) | undefined
84805
84754
  /** Indicates whether the lock is locked. */
84806
84755
  locked?: (boolean | undefined) | undefined
84807
- /** Keypad battery status. */
84756
+ /** Keypad battery status.
84757
+ * @deprecated Use `accessory_keypad.battery` instead.*/
84808
84758
  keypad_battery?:
84809
84759
  | (
84810
84760
  | {
@@ -85915,7 +85865,7 @@ export type Routes = {
85915
85865
  )
85916
85866
  | 'sonos_speaker'
85917
85867
  | 'alertify_sensor'
85918
- | ('hayward_pool_system' | 'hayward_pool')
85868
+ | ('hayward_pool_controller' | 'hayward_pool')
85919
85869
  /** IDs of the spaces the device is in. */
85920
85870
  space_ids: string[]
85921
85871
  /** Optional nickname to describe the device, settable through Seam. */
@@ -86974,25 +86924,18 @@ export type Routes = {
86974
86924
  | undefined
86975
86925
  )
86976
86926
  | undefined
86977
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
86927
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
86978
86928
  hayward_omnilogic_metadata?:
86979
86929
  | (
86980
86930
  | {
86981
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
86931
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
86982
86932
  msp_system_id?: (string | undefined) | undefined
86983
- /** Name of the system, as set in the Hayward OmniLogic app. */
86933
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
86984
86934
  backyard_name?: (string | undefined) | undefined
86985
- /** ID of the body of water within its system. Only present on a pool or spa body. */
86986
- body_of_water_id?: (string | undefined) | undefined
86987
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
86988
- body_of_water_name?: (string | undefined) | undefined
86989
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
86990
- virtual_heater_id?: (string | undefined) | undefined
86991
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
86992
- is_shared_equipment?: (boolean | undefined) | undefined
86993
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
86994
- shared_equipment_priority?:
86995
- (('high' | 'low') | undefined) | undefined
86935
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
86936
+ system_id?: (string | undefined) | undefined
86937
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
86938
+ system_name?: (string | undefined) | undefined
86996
86939
  }
86997
86940
  | undefined
86998
86941
  )
@@ -87111,7 +87054,8 @@ export type Routes = {
87111
87054
  has_native_entry_events?: (boolean | undefined) | undefined
87112
87055
  /** Indicates whether the lock is locked. */
87113
87056
  locked?: (boolean | undefined) | undefined
87114
- /** Keypad battery status. */
87057
+ /** Keypad battery status.
87058
+ * @deprecated Use `accessory_keypad.battery` instead.*/
87115
87059
  keypad_battery?:
87116
87060
  | (
87117
87061
  | {
@@ -90423,8 +90367,8 @@ export type Routes = {
90423
90367
  result: null
90424
90368
  /** Errors associated with the action attempt. Null for pending action attempts. */
90425
90369
  error: null
90426
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
90427
- action_type: 'SET_POOL_HEATING'
90370
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
90371
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
90428
90372
  }
90429
90373
  | {
90430
90374
  /** ID of the action attempt. */
@@ -90432,8 +90376,8 @@ export type Routes = {
90432
90376
  status: 'success'
90433
90377
  /** Errors associated with the action attempt. Null for successful action attempts. */
90434
90378
  error: null
90435
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
90436
- action_type: 'SET_POOL_HEATING'
90379
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
90380
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
90437
90381
  /** Result of the action. */
90438
90382
  result: {}
90439
90383
  }
@@ -90443,8 +90387,8 @@ export type Routes = {
90443
90387
  status: 'error'
90444
90388
  /** Result of the action attempt. Null for failed action attempts. */
90445
90389
  result: null
90446
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
90447
- action_type: 'SET_POOL_HEATING'
90390
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
90391
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
90448
90392
  /** Error associated with the action. */
90449
90393
  error: {
90450
90394
  /** Type of the error. */
@@ -93008,8 +92952,8 @@ export type Routes = {
93008
92952
  result: null
93009
92953
  /** Errors associated with the action attempt. Null for pending action attempts. */
93010
92954
  error: null
93011
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
93012
- action_type: 'SET_POOL_HEATING'
92955
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
92956
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
93013
92957
  }
93014
92958
  | {
93015
92959
  /** ID of the action attempt. */
@@ -93017,8 +92961,8 @@ export type Routes = {
93017
92961
  status: 'success'
93018
92962
  /** Errors associated with the action attempt. Null for successful action attempts. */
93019
92963
  error: null
93020
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
93021
- action_type: 'SET_POOL_HEATING'
92964
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
92965
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
93022
92966
  /** Result of the action. */
93023
92967
  result: {}
93024
92968
  }
@@ -93028,8 +92972,8 @@ export type Routes = {
93028
92972
  status: 'error'
93029
92973
  /** Result of the action attempt. Null for failed action attempts. */
93030
92974
  result: null
93031
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
93032
- action_type: 'SET_POOL_HEATING'
92975
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
92976
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
93033
92977
  /** Error associated with the action. */
93034
92978
  error: {
93035
92979
  /** Type of the error. */
@@ -95591,8 +95535,8 @@ export type Routes = {
95591
95535
  result: null
95592
95536
  /** Errors associated with the action attempt. Null for pending action attempts. */
95593
95537
  error: null
95594
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
95595
- action_type: 'SET_POOL_HEATING'
95538
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
95539
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
95596
95540
  }
95597
95541
  | {
95598
95542
  /** ID of the action attempt. */
@@ -95600,8 +95544,8 @@ export type Routes = {
95600
95544
  status: 'success'
95601
95545
  /** Errors associated with the action attempt. Null for successful action attempts. */
95602
95546
  error: null
95603
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
95604
- action_type: 'SET_POOL_HEATING'
95547
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
95548
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
95605
95549
  /** Result of the action. */
95606
95550
  result: {}
95607
95551
  }
@@ -95611,8 +95555,8 @@ export type Routes = {
95611
95555
  status: 'error'
95612
95556
  /** Result of the action attempt. Null for failed action attempts. */
95613
95557
  result: null
95614
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
95615
- action_type: 'SET_POOL_HEATING'
95558
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
95559
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
95616
95560
  /** Error associated with the action. */
95617
95561
  error: {
95618
95562
  /** Type of the error. */
@@ -98174,8 +98118,8 @@ export type Routes = {
98174
98118
  result: null
98175
98119
  /** Errors associated with the action attempt. Null for pending action attempts. */
98176
98120
  error: null
98177
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
98178
- action_type: 'SET_POOL_HEATING'
98121
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
98122
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
98179
98123
  }
98180
98124
  | {
98181
98125
  /** ID of the action attempt. */
@@ -98183,8 +98127,8 @@ export type Routes = {
98183
98127
  status: 'success'
98184
98128
  /** Errors associated with the action attempt. Null for successful action attempts. */
98185
98129
  error: null
98186
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
98187
- action_type: 'SET_POOL_HEATING'
98130
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
98131
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
98188
98132
  /** Result of the action. */
98189
98133
  result: {}
98190
98134
  }
@@ -98194,8 +98138,8 @@ export type Routes = {
98194
98138
  status: 'error'
98195
98139
  /** Result of the action attempt. Null for failed action attempts. */
98196
98140
  result: null
98197
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
98198
- action_type: 'SET_POOL_HEATING'
98141
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
98142
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
98199
98143
  /** Error associated with the action. */
98200
98144
  error: {
98201
98145
  /** Type of the error. */
@@ -98621,7 +98565,7 @@ export type Routes = {
98621
98565
  )
98622
98566
  | 'sonos_speaker'
98623
98567
  | 'alertify_sensor'
98624
- | ('hayward_pool_system' | 'hayward_pool')
98568
+ | ('hayward_pool_controller' | 'hayward_pool')
98625
98569
  /** IDs of the spaces the device is in. */
98626
98570
  space_ids: string[]
98627
98571
  /** Optional nickname to describe the device, settable through Seam. */
@@ -99680,25 +99624,18 @@ export type Routes = {
99680
99624
  | undefined
99681
99625
  )
99682
99626
  | undefined
99683
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
99627
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
99684
99628
  hayward_omnilogic_metadata?:
99685
99629
  | (
99686
99630
  | {
99687
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
99631
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
99688
99632
  msp_system_id?: (string | undefined) | undefined
99689
- /** Name of the system, as set in the Hayward OmniLogic app. */
99633
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
99690
99634
  backyard_name?: (string | undefined) | undefined
99691
- /** ID of the body of water within its system. Only present on a pool or spa body. */
99692
- body_of_water_id?: (string | undefined) | undefined
99693
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
99694
- body_of_water_name?: (string | undefined) | undefined
99695
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
99696
- virtual_heater_id?: (string | undefined) | undefined
99697
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
99698
- is_shared_equipment?: (boolean | undefined) | undefined
99699
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
99700
- shared_equipment_priority?:
99701
- (('high' | 'low') | undefined) | undefined
99635
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
99636
+ system_id?: (string | undefined) | undefined
99637
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
99638
+ system_name?: (string | undefined) | undefined
99702
99639
  }
99703
99640
  | undefined
99704
99641
  )
@@ -99817,7 +99754,8 @@ export type Routes = {
99817
99754
  has_native_entry_events?: (boolean | undefined) | undefined
99818
99755
  /** Indicates whether the lock is locked. */
99819
99756
  locked?: (boolean | undefined) | undefined
99820
- /** Keypad battery status. */
99757
+ /** Keypad battery status.
99758
+ * @deprecated Use `accessory_keypad.battery` instead.*/
99821
99759
  keypad_battery?:
99822
99760
  | (
99823
99761
  | {
@@ -100928,7 +100866,7 @@ export type Routes = {
100928
100866
  )
100929
100867
  | 'sonos_speaker'
100930
100868
  | 'alertify_sensor'
100931
- | ('hayward_pool_system' | 'hayward_pool')
100869
+ | ('hayward_pool_controller' | 'hayward_pool')
100932
100870
  /** IDs of the spaces the device is in. */
100933
100871
  space_ids: string[]
100934
100872
  /** Optional nickname to describe the device, settable through Seam. */
@@ -101987,25 +101925,18 @@ export type Routes = {
101987
101925
  | undefined
101988
101926
  )
101989
101927
  | undefined
101990
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
101928
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
101991
101929
  hayward_omnilogic_metadata?:
101992
101930
  | (
101993
101931
  | {
101994
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
101932
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
101995
101933
  msp_system_id?: (string | undefined) | undefined
101996
- /** Name of the system, as set in the Hayward OmniLogic app. */
101934
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
101997
101935
  backyard_name?: (string | undefined) | undefined
101998
- /** ID of the body of water within its system. Only present on a pool or spa body. */
101999
- body_of_water_id?: (string | undefined) | undefined
102000
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
102001
- body_of_water_name?: (string | undefined) | undefined
102002
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
102003
- virtual_heater_id?: (string | undefined) | undefined
102004
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
102005
- is_shared_equipment?: (boolean | undefined) | undefined
102006
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
102007
- shared_equipment_priority?:
102008
- (('high' | 'low') | undefined) | undefined
101936
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
101937
+ system_id?: (string | undefined) | undefined
101938
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
101939
+ system_name?: (string | undefined) | undefined
102009
101940
  }
102010
101941
  | undefined
102011
101942
  )
@@ -102124,7 +102055,8 @@ export type Routes = {
102124
102055
  has_native_entry_events?: (boolean | undefined) | undefined
102125
102056
  /** Indicates whether the lock is locked. */
102126
102057
  locked?: (boolean | undefined) | undefined
102127
- /** Keypad battery status. */
102058
+ /** Keypad battery status.
102059
+ * @deprecated Use `accessory_keypad.battery` instead.*/
102128
102060
  keypad_battery?:
102129
102061
  | (
102130
102062
  | {
@@ -105446,8 +105378,8 @@ export type Routes = {
105446
105378
  result: null
105447
105379
  /** Errors associated with the action attempt. Null for pending action attempts. */
105448
105380
  error: null
105449
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
105450
- action_type: 'SET_POOL_HEATING'
105381
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
105382
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
105451
105383
  }
105452
105384
  | {
105453
105385
  /** ID of the action attempt. */
@@ -105455,8 +105387,8 @@ export type Routes = {
105455
105387
  status: 'success'
105456
105388
  /** Errors associated with the action attempt. Null for successful action attempts. */
105457
105389
  error: null
105458
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
105459
- action_type: 'SET_POOL_HEATING'
105390
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
105391
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
105460
105392
  /** Result of the action. */
105461
105393
  result: {}
105462
105394
  }
@@ -105466,8 +105398,8 @@ export type Routes = {
105466
105398
  status: 'error'
105467
105399
  /** Result of the action attempt. Null for failed action attempts. */
105468
105400
  result: null
105469
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
105470
- action_type: 'SET_POOL_HEATING'
105401
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
105402
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
105471
105403
  /** Error associated with the action. */
105472
105404
  error: {
105473
105405
  /** Type of the error. */
@@ -108048,8 +107980,8 @@ export type Routes = {
108048
107980
  result: null
108049
107981
  /** Errors associated with the action attempt. Null for pending action attempts. */
108050
107982
  error: null
108051
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
108052
- action_type: 'SET_POOL_HEATING'
107983
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
107984
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
108053
107985
  }
108054
107986
  | {
108055
107987
  /** ID of the action attempt. */
@@ -108057,8 +107989,8 @@ export type Routes = {
108057
107989
  status: 'success'
108058
107990
  /** Errors associated with the action attempt. Null for successful action attempts. */
108059
107991
  error: null
108060
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
108061
- action_type: 'SET_POOL_HEATING'
107992
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
107993
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
108062
107994
  /** Result of the action. */
108063
107995
  result: {}
108064
107996
  }
@@ -108068,8 +108000,8 @@ export type Routes = {
108068
108000
  status: 'error'
108069
108001
  /** Result of the action attempt. Null for failed action attempts. */
108070
108002
  result: null
108071
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
108072
- action_type: 'SET_POOL_HEATING'
108003
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
108004
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
108073
108005
  /** Error associated with the action. */
108074
108006
  error: {
108075
108007
  /** Type of the error. */
@@ -110706,8 +110638,8 @@ export type Routes = {
110706
110638
  result: null
110707
110639
  /** Errors associated with the action attempt. Null for pending action attempts. */
110708
110640
  error: null
110709
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
110710
- action_type: 'SET_POOL_HEATING'
110641
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
110642
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
110711
110643
  }
110712
110644
  | {
110713
110645
  /** ID of the action attempt. */
@@ -110715,8 +110647,8 @@ export type Routes = {
110715
110647
  status: 'success'
110716
110648
  /** Errors associated with the action attempt. Null for successful action attempts. */
110717
110649
  error: null
110718
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
110719
- action_type: 'SET_POOL_HEATING'
110650
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
110651
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
110720
110652
  /** Result of the action. */
110721
110653
  result: {}
110722
110654
  }
@@ -110726,8 +110658,8 @@ export type Routes = {
110726
110658
  status: 'error'
110727
110659
  /** Result of the action attempt. Null for failed action attempts. */
110728
110660
  result: null
110729
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
110730
- action_type: 'SET_POOL_HEATING'
110661
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
110662
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
110731
110663
  /** Error associated with the action. */
110732
110664
  error: {
110733
110665
  /** Type of the error. */
@@ -114776,8 +114708,8 @@ export type Routes = {
114776
114708
  result: null
114777
114709
  /** Errors associated with the action attempt. Null for pending action attempts. */
114778
114710
  error: null
114779
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
114780
- action_type: 'SET_POOL_HEATING'
114711
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
114712
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
114781
114713
  }
114782
114714
  | {
114783
114715
  /** ID of the action attempt. */
@@ -114785,8 +114717,8 @@ export type Routes = {
114785
114717
  status: 'success'
114786
114718
  /** Errors associated with the action attempt. Null for successful action attempts. */
114787
114719
  error: null
114788
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
114789
- action_type: 'SET_POOL_HEATING'
114720
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
114721
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
114790
114722
  /** Result of the action. */
114791
114723
  result: {}
114792
114724
  }
@@ -114796,8 +114728,8 @@ export type Routes = {
114796
114728
  status: 'error'
114797
114729
  /** Result of the action attempt. Null for failed action attempts. */
114798
114730
  result: null
114799
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
114800
- action_type: 'SET_POOL_HEATING'
114731
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
114732
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
114801
114733
  /** Error associated with the action. */
114802
114734
  error: {
114803
114735
  /** Type of the error. */
@@ -115110,9 +115042,9 @@ export type Routes = {
115110
115042
  /** ID of the Connect Webview for which you want to list devices. */
115111
115043
  connect_webview_id?: string | undefined
115112
115044
  /** Device type by which you want to filter pool devices. */
115113
- device_type?: ('hayward_pool_system' | 'hayward_pool') | undefined
115045
+ device_type?: ('hayward_pool_controller' | 'hayward_pool') | undefined
115114
115046
  /** Array of device types by which you want to filter pool devices. */
115115
- device_types?: ('hayward_pool_system' | 'hayward_pool')[] | undefined
115047
+ device_types?: ('hayward_pool_controller' | 'hayward_pool')[] | undefined
115116
115048
  }
115117
115049
  formData: {}
115118
115050
  jsonResponse: {
@@ -115180,7 +115112,7 @@ export type Routes = {
115180
115112
  )
115181
115113
  | 'sonos_speaker'
115182
115114
  | 'alertify_sensor'
115183
- | ('hayward_pool_system' | 'hayward_pool')
115115
+ | ('hayward_pool_controller' | 'hayward_pool')
115184
115116
  /** IDs of the spaces the device is in. */
115185
115117
  space_ids: string[]
115186
115118
  /** Optional nickname to describe the device, settable through Seam. */
@@ -116239,25 +116171,18 @@ export type Routes = {
116239
116171
  | undefined
116240
116172
  )
116241
116173
  | undefined
116242
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
116174
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
116243
116175
  hayward_omnilogic_metadata?:
116244
116176
  | (
116245
116177
  | {
116246
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
116178
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
116247
116179
  msp_system_id?: (string | undefined) | undefined
116248
- /** Name of the system, as set in the Hayward OmniLogic app. */
116180
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
116249
116181
  backyard_name?: (string | undefined) | undefined
116250
- /** ID of the body of water within its system. Only present on a pool or spa body. */
116251
- body_of_water_id?: (string | undefined) | undefined
116252
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
116253
- body_of_water_name?: (string | undefined) | undefined
116254
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
116255
- virtual_heater_id?: (string | undefined) | undefined
116256
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
116257
- is_shared_equipment?: (boolean | undefined) | undefined
116258
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
116259
- shared_equipment_priority?:
116260
- (('high' | 'low') | undefined) | undefined
116182
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
116183
+ system_id?: (string | undefined) | undefined
116184
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
116185
+ system_name?: (string | undefined) | undefined
116261
116186
  }
116262
116187
  | undefined
116263
116188
  )
@@ -116376,7 +116301,8 @@ export type Routes = {
116376
116301
  has_native_entry_events?: (boolean | undefined) | undefined
116377
116302
  /** Indicates whether the lock is locked. */
116378
116303
  locked?: (boolean | undefined) | undefined
116379
- /** Keypad battery status. */
116304
+ /** Keypad battery status.
116305
+ * @deprecated Use `accessory_keypad.battery` instead.*/
116380
116306
  keypad_battery?:
116381
116307
  | (
116382
116308
  | {
@@ -119688,8 +119614,8 @@ export type Routes = {
119688
119614
  result: null
119689
119615
  /** Errors associated with the action attempt. Null for pending action attempts. */
119690
119616
  error: null
119691
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
119692
- action_type: 'SET_POOL_HEATING'
119617
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
119618
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
119693
119619
  }
119694
119620
  | {
119695
119621
  /** ID of the action attempt. */
@@ -119697,8 +119623,8 @@ export type Routes = {
119697
119623
  status: 'success'
119698
119624
  /** Errors associated with the action attempt. Null for successful action attempts. */
119699
119625
  error: null
119700
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
119701
- action_type: 'SET_POOL_HEATING'
119626
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
119627
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
119702
119628
  /** Result of the action. */
119703
119629
  result: {}
119704
119630
  }
@@ -119708,8 +119634,8 @@ export type Routes = {
119708
119634
  status: 'error'
119709
119635
  /** Result of the action attempt. Null for failed action attempts. */
119710
119636
  result: null
119711
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
119712
- action_type: 'SET_POOL_HEATING'
119637
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
119638
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
119713
119639
  /** Error associated with the action. */
119714
119640
  error: {
119715
119641
  /** Type of the error. */
@@ -124988,8 +124914,8 @@ export type Routes = {
124988
124914
  result: null
124989
124915
  /** Errors associated with the action attempt. Null for pending action attempts. */
124990
124916
  error: null
124991
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
124992
- action_type: 'SET_POOL_HEATING'
124917
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
124918
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
124993
124919
  }
124994
124920
  | {
124995
124921
  /** ID of the action attempt. */
@@ -124997,8 +124923,8 @@ export type Routes = {
124997
124923
  status: 'success'
124998
124924
  /** Errors associated with the action attempt. Null for successful action attempts. */
124999
124925
  error: null
125000
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
125001
- action_type: 'SET_POOL_HEATING'
124926
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
124927
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
125002
124928
  /** Result of the action. */
125003
124929
  result: {}
125004
124930
  }
@@ -125008,8 +124934,8 @@ export type Routes = {
125008
124934
  status: 'error'
125009
124935
  /** Result of the action attempt. Null for failed action attempts. */
125010
124936
  result: null
125011
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
125012
- action_type: 'SET_POOL_HEATING'
124937
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
124938
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
125013
124939
  /** Error associated with the action. */
125014
124940
  error: {
125015
124941
  /** Type of the error. */
@@ -138582,7 +138508,7 @@ export type Routes = {
138582
138508
  )
138583
138509
  | 'sonos_speaker'
138584
138510
  | 'alertify_sensor'
138585
- | ('hayward_pool_system' | 'hayward_pool')
138511
+ | ('hayward_pool_controller' | 'hayward_pool')
138586
138512
  /** IDs of the spaces the device is in. */
138587
138513
  space_ids: string[]
138588
138514
  /** Optional nickname to describe the device, settable through Seam. */
@@ -139683,29 +139609,18 @@ export type Routes = {
139683
139609
  | undefined
139684
139610
  )
139685
139611
  | undefined
139686
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
139612
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
139687
139613
  hayward_omnilogic_metadata?:
139688
139614
  | (
139689
139615
  | {
139690
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
139616
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
139691
139617
  msp_system_id?: (string | undefined) | undefined
139692
- /** Name of the system, as set in the Hayward OmniLogic app. */
139618
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
139693
139619
  backyard_name?: (string | undefined) | undefined
139694
- /** ID of the body of water within its system. Only present on a pool or spa body. */
139695
- body_of_water_id?:
139696
- (string | undefined) | undefined
139697
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
139698
- body_of_water_name?:
139699
- (string | undefined) | undefined
139700
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
139701
- virtual_heater_id?:
139702
- (string | undefined) | undefined
139703
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
139704
- is_shared_equipment?:
139705
- (boolean | undefined) | undefined
139706
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
139707
- shared_equipment_priority?:
139708
- (('high' | 'low') | undefined) | undefined
139620
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
139621
+ system_id?: (string | undefined) | undefined
139622
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
139623
+ system_name?: (string | undefined) | undefined
139709
139624
  }
139710
139625
  | undefined
139711
139626
  )
@@ -139827,7 +139742,8 @@ export type Routes = {
139827
139742
  (boolean | undefined) | undefined
139828
139743
  /** Indicates whether the lock is locked. */
139829
139744
  locked?: (boolean | undefined) | undefined
139830
- /** Keypad battery status. */
139745
+ /** Keypad battery status.
139746
+ * @deprecated Use `accessory_keypad.battery` instead.*/
139831
139747
  keypad_battery?:
139832
139748
  | (
139833
139749
  | {
@@ -144377,8 +144293,8 @@ export type Routes = {
144377
144293
  result: null
144378
144294
  /** Errors associated with the action attempt. Null for pending action attempts. */
144379
144295
  error: null
144380
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
144381
- action_type: 'SET_POOL_HEATING'
144296
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
144297
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
144382
144298
  }
144383
144299
  | {
144384
144300
  /** ID of the action attempt. */
@@ -144386,8 +144302,8 @@ export type Routes = {
144386
144302
  status: 'success'
144387
144303
  /** Errors associated with the action attempt. Null for successful action attempts. */
144388
144304
  error: null
144389
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
144390
- action_type: 'SET_POOL_HEATING'
144305
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
144306
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
144391
144307
  /** Result of the action. */
144392
144308
  result: {}
144393
144309
  }
@@ -144397,8 +144313,8 @@ export type Routes = {
144397
144313
  status: 'error'
144398
144314
  /** Result of the action attempt. Null for failed action attempts. */
144399
144315
  result: null
144400
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
144401
- action_type: 'SET_POOL_HEATING'
144316
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
144317
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
144402
144318
  /** Error associated with the action. */
144403
144319
  error: {
144404
144320
  /** Type of the error. */
@@ -146960,8 +146876,8 @@ export type Routes = {
146960
146876
  result: null
146961
146877
  /** Errors associated with the action attempt. Null for pending action attempts. */
146962
146878
  error: null
146963
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
146964
- action_type: 'SET_POOL_HEATING'
146879
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
146880
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
146965
146881
  }
146966
146882
  | {
146967
146883
  /** ID of the action attempt. */
@@ -146969,8 +146885,8 @@ export type Routes = {
146969
146885
  status: 'success'
146970
146886
  /** Errors associated with the action attempt. Null for successful action attempts. */
146971
146887
  error: null
146972
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
146973
- action_type: 'SET_POOL_HEATING'
146888
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
146889
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
146974
146890
  /** Result of the action. */
146975
146891
  result: {}
146976
146892
  }
@@ -146980,8 +146896,8 @@ export type Routes = {
146980
146896
  status: 'error'
146981
146897
  /** Result of the action attempt. Null for failed action attempts. */
146982
146898
  result: null
146983
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
146984
- action_type: 'SET_POOL_HEATING'
146899
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
146900
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
146985
146901
  /** Error associated with the action. */
146986
146902
  error: {
146987
146903
  /** Type of the error. */
@@ -149547,8 +149463,8 @@ export type Routes = {
149547
149463
  result: null
149548
149464
  /** Errors associated with the action attempt. Null for pending action attempts. */
149549
149465
  error: null
149550
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
149551
- action_type: 'SET_POOL_HEATING'
149466
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
149467
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
149552
149468
  }
149553
149469
  | {
149554
149470
  /** ID of the action attempt. */
@@ -149556,8 +149472,8 @@ export type Routes = {
149556
149472
  status: 'success'
149557
149473
  /** Errors associated with the action attempt. Null for successful action attempts. */
149558
149474
  error: null
149559
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
149560
- action_type: 'SET_POOL_HEATING'
149475
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
149476
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
149561
149477
  /** Result of the action. */
149562
149478
  result: {}
149563
149479
  }
@@ -149567,8 +149483,8 @@ export type Routes = {
149567
149483
  status: 'error'
149568
149484
  /** Result of the action attempt. Null for failed action attempts. */
149569
149485
  result: null
149570
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
149571
- action_type: 'SET_POOL_HEATING'
149486
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
149487
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
149572
149488
  /** Error associated with the action. */
149573
149489
  error: {
149574
149490
  /** Type of the error. */
@@ -152132,8 +152048,8 @@ export type Routes = {
152132
152048
  result: null
152133
152049
  /** Errors associated with the action attempt. Null for pending action attempts. */
152134
152050
  error: null
152135
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
152136
- action_type: 'SET_POOL_HEATING'
152051
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
152052
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
152137
152053
  }
152138
152054
  | {
152139
152055
  /** ID of the action attempt. */
@@ -152141,8 +152057,8 @@ export type Routes = {
152141
152057
  status: 'success'
152142
152058
  /** Errors associated with the action attempt. Null for successful action attempts. */
152143
152059
  error: null
152144
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
152145
- action_type: 'SET_POOL_HEATING'
152060
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
152061
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
152146
152062
  /** Result of the action. */
152147
152063
  result: {}
152148
152064
  }
@@ -152152,8 +152068,8 @@ export type Routes = {
152152
152068
  status: 'error'
152153
152069
  /** Result of the action attempt. Null for failed action attempts. */
152154
152070
  result: null
152155
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
152156
- action_type: 'SET_POOL_HEATING'
152071
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
152072
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
152157
152073
  /** Error associated with the action. */
152158
152074
  error: {
152159
152075
  /** Type of the error. */
@@ -154719,8 +154635,8 @@ export type Routes = {
154719
154635
  result: null
154720
154636
  /** Errors associated with the action attempt. Null for pending action attempts. */
154721
154637
  error: null
154722
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
154723
- action_type: 'SET_POOL_HEATING'
154638
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
154639
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
154724
154640
  }
154725
154641
  | {
154726
154642
  /** ID of the action attempt. */
@@ -154728,8 +154644,8 @@ export type Routes = {
154728
154644
  status: 'success'
154729
154645
  /** Errors associated with the action attempt. Null for successful action attempts. */
154730
154646
  error: null
154731
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
154732
- action_type: 'SET_POOL_HEATING'
154647
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
154648
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
154733
154649
  /** Result of the action. */
154734
154650
  result: {}
154735
154651
  }
@@ -154739,8 +154655,8 @@ export type Routes = {
154739
154655
  status: 'error'
154740
154656
  /** Result of the action attempt. Null for failed action attempts. */
154741
154657
  result: null
154742
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
154743
- action_type: 'SET_POOL_HEATING'
154658
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
154659
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
154744
154660
  /** Error associated with the action. */
154745
154661
  error: {
154746
154662
  /** Type of the error. */
@@ -157302,8 +157218,8 @@ export type Routes = {
157302
157218
  result: null
157303
157219
  /** Errors associated with the action attempt. Null for pending action attempts. */
157304
157220
  error: null
157305
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
157306
- action_type: 'SET_POOL_HEATING'
157221
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
157222
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
157307
157223
  }
157308
157224
  | {
157309
157225
  /** ID of the action attempt. */
@@ -157311,8 +157227,8 @@ export type Routes = {
157311
157227
  status: 'success'
157312
157228
  /** Errors associated with the action attempt. Null for successful action attempts. */
157313
157229
  error: null
157314
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
157315
- action_type: 'SET_POOL_HEATING'
157230
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
157231
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
157316
157232
  /** Result of the action. */
157317
157233
  result: {}
157318
157234
  }
@@ -157322,8 +157238,8 @@ export type Routes = {
157322
157238
  status: 'error'
157323
157239
  /** Result of the action attempt. Null for failed action attempts. */
157324
157240
  result: null
157325
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
157326
- action_type: 'SET_POOL_HEATING'
157241
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
157242
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
157327
157243
  /** Error associated with the action. */
157328
157244
  error: {
157329
157245
  /** Type of the error. */
@@ -159887,8 +159803,8 @@ export type Routes = {
159887
159803
  result: null
159888
159804
  /** Errors associated with the action attempt. Null for pending action attempts. */
159889
159805
  error: null
159890
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
159891
- action_type: 'SET_POOL_HEATING'
159806
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
159807
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
159892
159808
  }
159893
159809
  | {
159894
159810
  /** ID of the action attempt. */
@@ -159896,8 +159812,8 @@ export type Routes = {
159896
159812
  status: 'success'
159897
159813
  /** Errors associated with the action attempt. Null for successful action attempts. */
159898
159814
  error: null
159899
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
159900
- action_type: 'SET_POOL_HEATING'
159815
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
159816
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
159901
159817
  /** Result of the action. */
159902
159818
  result: {}
159903
159819
  }
@@ -159907,8 +159823,8 @@ export type Routes = {
159907
159823
  status: 'error'
159908
159824
  /** Result of the action attempt. Null for failed action attempts. */
159909
159825
  result: null
159910
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
159911
- action_type: 'SET_POOL_HEATING'
159826
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
159827
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
159912
159828
  /** Error associated with the action. */
159913
159829
  error: {
159914
159830
  /** Type of the error. */
@@ -162470,8 +162386,8 @@ export type Routes = {
162470
162386
  result: null
162471
162387
  /** Errors associated with the action attempt. Null for pending action attempts. */
162472
162388
  error: null
162473
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
162474
- action_type: 'SET_POOL_HEATING'
162389
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
162390
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
162475
162391
  }
162476
162392
  | {
162477
162393
  /** ID of the action attempt. */
@@ -162479,8 +162395,8 @@ export type Routes = {
162479
162395
  status: 'success'
162480
162396
  /** Errors associated with the action attempt. Null for successful action attempts. */
162481
162397
  error: null
162482
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
162483
- action_type: 'SET_POOL_HEATING'
162398
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
162399
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
162484
162400
  /** Result of the action. */
162485
162401
  result: {}
162486
162402
  }
@@ -162490,8 +162406,8 @@ export type Routes = {
162490
162406
  status: 'error'
162491
162407
  /** Result of the action attempt. Null for failed action attempts. */
162492
162408
  result: null
162493
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
162494
- action_type: 'SET_POOL_HEATING'
162409
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
162410
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
162495
162411
  /** Error associated with the action. */
162496
162412
  error: {
162497
162413
  /** Type of the error. */
@@ -165055,8 +164971,8 @@ export type Routes = {
165055
164971
  result: null
165056
164972
  /** Errors associated with the action attempt. Null for pending action attempts. */
165057
164973
  error: null
165058
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
165059
- action_type: 'SET_POOL_HEATING'
164974
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
164975
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
165060
164976
  }
165061
164977
  | {
165062
164978
  /** ID of the action attempt. */
@@ -165064,8 +164980,8 @@ export type Routes = {
165064
164980
  status: 'success'
165065
164981
  /** Errors associated with the action attempt. Null for successful action attempts. */
165066
164982
  error: null
165067
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
165068
- action_type: 'SET_POOL_HEATING'
164983
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
164984
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
165069
164985
  /** Result of the action. */
165070
164986
  result: {}
165071
164987
  }
@@ -165075,8 +164991,8 @@ export type Routes = {
165075
164991
  status: 'error'
165076
164992
  /** Result of the action attempt. Null for failed action attempts. */
165077
164993
  result: null
165078
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
165079
- action_type: 'SET_POOL_HEATING'
164994
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
164995
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
165080
164996
  /** Error associated with the action. */
165081
164997
  error: {
165082
164998
  /** Type of the error. */
@@ -167638,8 +167554,8 @@ export type Routes = {
167638
167554
  result: null
167639
167555
  /** Errors associated with the action attempt. Null for pending action attempts. */
167640
167556
  error: null
167641
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
167642
- action_type: 'SET_POOL_HEATING'
167557
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
167558
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
167643
167559
  }
167644
167560
  | {
167645
167561
  /** ID of the action attempt. */
@@ -167647,8 +167563,8 @@ export type Routes = {
167647
167563
  status: 'success'
167648
167564
  /** Errors associated with the action attempt. Null for successful action attempts. */
167649
167565
  error: null
167650
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
167651
- action_type: 'SET_POOL_HEATING'
167566
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
167567
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
167652
167568
  /** Result of the action. */
167653
167569
  result: {}
167654
167570
  }
@@ -167658,8 +167574,8 @@ export type Routes = {
167658
167574
  status: 'error'
167659
167575
  /** Result of the action attempt. Null for failed action attempts. */
167660
167576
  result: null
167661
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
167662
- action_type: 'SET_POOL_HEATING'
167577
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
167578
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
167663
167579
  /** Error associated with the action. */
167664
167580
  error: {
167665
167581
  /** Type of the error. */
@@ -170225,8 +170141,8 @@ export type Routes = {
170225
170141
  result: null
170226
170142
  /** Errors associated with the action attempt. Null for pending action attempts. */
170227
170143
  error: null
170228
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
170229
- action_type: 'SET_POOL_HEATING'
170144
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
170145
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
170230
170146
  }
170231
170147
  | {
170232
170148
  /** ID of the action attempt. */
@@ -170234,8 +170150,8 @@ export type Routes = {
170234
170150
  status: 'success'
170235
170151
  /** Errors associated with the action attempt. Null for successful action attempts. */
170236
170152
  error: null
170237
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
170238
- action_type: 'SET_POOL_HEATING'
170153
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
170154
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
170239
170155
  /** Result of the action. */
170240
170156
  result: {}
170241
170157
  }
@@ -170245,8 +170161,8 @@ export type Routes = {
170245
170161
  status: 'error'
170246
170162
  /** Result of the action attempt. Null for failed action attempts. */
170247
170163
  result: null
170248
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
170249
- action_type: 'SET_POOL_HEATING'
170164
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
170165
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
170250
170166
  /** Error associated with the action. */
170251
170167
  error: {
170252
170168
  /** Type of the error. */
@@ -172925,8 +172841,8 @@ export type Routes = {
172925
172841
  result: null
172926
172842
  /** Errors associated with the action attempt. Null for pending action attempts. */
172927
172843
  error: null
172928
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
172929
- action_type: 'SET_POOL_HEATING'
172844
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
172845
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
172930
172846
  }
172931
172847
  | {
172932
172848
  /** ID of the action attempt. */
@@ -172934,8 +172850,8 @@ export type Routes = {
172934
172850
  status: 'success'
172935
172851
  /** Errors associated with the action attempt. Null for successful action attempts. */
172936
172852
  error: null
172937
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
172938
- action_type: 'SET_POOL_HEATING'
172853
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
172854
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
172939
172855
  /** Result of the action. */
172940
172856
  result: {}
172941
172857
  }
@@ -172945,8 +172861,8 @@ export type Routes = {
172945
172861
  status: 'error'
172946
172862
  /** Result of the action attempt. Null for failed action attempts. */
172947
172863
  result: null
172948
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
172949
- action_type: 'SET_POOL_HEATING'
172864
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
172865
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
172950
172866
  /** Error associated with the action. */
172951
172867
  error: {
172952
172868
  /** Type of the error. */
@@ -173339,7 +173255,7 @@ export type Routes = {
173339
173255
  )
173340
173256
  | 'sonos_speaker'
173341
173257
  | 'alertify_sensor'
173342
- | ('hayward_pool_system' | 'hayward_pool')
173258
+ | ('hayward_pool_controller' | 'hayward_pool')
173343
173259
  /** IDs of the spaces the device is in. */
173344
173260
  space_ids: string[]
173345
173261
  /** Optional nickname to describe the device, settable through Seam. */
@@ -174398,25 +174314,18 @@ export type Routes = {
174398
174314
  | undefined
174399
174315
  )
174400
174316
  | undefined
174401
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
174317
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
174402
174318
  hayward_omnilogic_metadata?:
174403
174319
  | (
174404
174320
  | {
174405
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
174321
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
174406
174322
  msp_system_id?: (string | undefined) | undefined
174407
- /** Name of the system, as set in the Hayward OmniLogic app. */
174323
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
174408
174324
  backyard_name?: (string | undefined) | undefined
174409
- /** ID of the body of water within its system. Only present on a pool or spa body. */
174410
- body_of_water_id?: (string | undefined) | undefined
174411
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
174412
- body_of_water_name?: (string | undefined) | undefined
174413
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
174414
- virtual_heater_id?: (string | undefined) | undefined
174415
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
174416
- is_shared_equipment?: (boolean | undefined) | undefined
174417
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
174418
- shared_equipment_priority?:
174419
- (('high' | 'low') | undefined) | undefined
174325
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
174326
+ system_id?: (string | undefined) | undefined
174327
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
174328
+ system_name?: (string | undefined) | undefined
174420
174329
  }
174421
174330
  | undefined
174422
174331
  )
@@ -174535,7 +174444,8 @@ export type Routes = {
174535
174444
  has_native_entry_events?: (boolean | undefined) | undefined
174536
174445
  /** Indicates whether the lock is locked. */
174537
174446
  locked?: (boolean | undefined) | undefined
174538
- /** Keypad battery status. */
174447
+ /** Keypad battery status.
174448
+ * @deprecated Use `accessory_keypad.battery` instead.*/
174539
174449
  keypad_battery?:
174540
174450
  | (
174541
174451
  | {
@@ -177851,8 +177761,8 @@ export type Routes = {
177851
177761
  result: null
177852
177762
  /** Errors associated with the action attempt. Null for pending action attempts. */
177853
177763
  error: null
177854
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
177855
- action_type: 'SET_POOL_HEATING'
177764
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
177765
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
177856
177766
  }
177857
177767
  | {
177858
177768
  /** ID of the action attempt. */
@@ -177860,8 +177770,8 @@ export type Routes = {
177860
177770
  status: 'success'
177861
177771
  /** Errors associated with the action attempt. Null for successful action attempts. */
177862
177772
  error: null
177863
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
177864
- action_type: 'SET_POOL_HEATING'
177773
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
177774
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
177865
177775
  /** Result of the action. */
177866
177776
  result: {}
177867
177777
  }
@@ -177871,8 +177781,8 @@ export type Routes = {
177871
177781
  status: 'error'
177872
177782
  /** Result of the action attempt. Null for failed action attempts. */
177873
177783
  result: null
177874
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
177875
- action_type: 'SET_POOL_HEATING'
177784
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
177785
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
177876
177786
  /** Error associated with the action. */
177877
177787
  error: {
177878
177788
  /** Type of the error. */
@@ -180442,8 +180352,8 @@ export type Routes = {
180442
180352
  result: null
180443
180353
  /** Errors associated with the action attempt. Null for pending action attempts. */
180444
180354
  error: null
180445
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
180446
- action_type: 'SET_POOL_HEATING'
180355
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
180356
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
180447
180357
  }
180448
180358
  | {
180449
180359
  /** ID of the action attempt. */
@@ -180451,8 +180361,8 @@ export type Routes = {
180451
180361
  status: 'success'
180452
180362
  /** Errors associated with the action attempt. Null for successful action attempts. */
180453
180363
  error: null
180454
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
180455
- action_type: 'SET_POOL_HEATING'
180364
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
180365
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
180456
180366
  /** Result of the action. */
180457
180367
  result: {}
180458
180368
  }
@@ -180462,8 +180372,8 @@ export type Routes = {
180462
180372
  status: 'error'
180463
180373
  /** Result of the action attempt. Null for failed action attempts. */
180464
180374
  result: null
180465
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
180466
- action_type: 'SET_POOL_HEATING'
180375
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
180376
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
180467
180377
  /** Error associated with the action. */
180468
180378
  error: {
180469
180379
  /** Type of the error. */
@@ -180878,7 +180788,7 @@ export type Routes = {
180878
180788
  )
180879
180789
  | 'sonos_speaker'
180880
180790
  | 'alertify_sensor'
180881
- | ('hayward_pool_system' | 'hayward_pool')
180791
+ | ('hayward_pool_controller' | 'hayward_pool')
180882
180792
  /** IDs of the spaces the device is in. */
180883
180793
  space_ids: string[]
180884
180794
  /** Optional nickname to describe the device, settable through Seam. */
@@ -181937,25 +181847,18 @@ export type Routes = {
181937
181847
  | undefined
181938
181848
  )
181939
181849
  | undefined
181940
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
181850
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
181941
181851
  hayward_omnilogic_metadata?:
181942
181852
  | (
181943
181853
  | {
181944
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
181854
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
181945
181855
  msp_system_id?: (string | undefined) | undefined
181946
- /** Name of the system, as set in the Hayward OmniLogic app. */
181856
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
181947
181857
  backyard_name?: (string | undefined) | undefined
181948
- /** ID of the body of water within its system. Only present on a pool or spa body. */
181949
- body_of_water_id?: (string | undefined) | undefined
181950
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
181951
- body_of_water_name?: (string | undefined) | undefined
181952
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
181953
- virtual_heater_id?: (string | undefined) | undefined
181954
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
181955
- is_shared_equipment?: (boolean | undefined) | undefined
181956
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
181957
- shared_equipment_priority?:
181958
- (('high' | 'low') | undefined) | undefined
181858
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
181859
+ system_id?: (string | undefined) | undefined
181860
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
181861
+ system_name?: (string | undefined) | undefined
181959
181862
  }
181960
181863
  | undefined
181961
181864
  )
@@ -182074,7 +181977,8 @@ export type Routes = {
182074
181977
  has_native_entry_events?: (boolean | undefined) | undefined
182075
181978
  /** Indicates whether the lock is locked. */
182076
181979
  locked?: (boolean | undefined) | undefined
182077
- /** Keypad battery status. */
181980
+ /** Keypad battery status.
181981
+ * @deprecated Use `accessory_keypad.battery` instead.*/
182078
181982
  keypad_battery?:
182079
181983
  | (
182080
181984
  | {
@@ -183185,7 +183089,7 @@ export type Routes = {
183185
183089
  )
183186
183090
  | 'sonos_speaker'
183187
183091
  | 'alertify_sensor'
183188
- | ('hayward_pool_system' | 'hayward_pool')
183092
+ | ('hayward_pool_controller' | 'hayward_pool')
183189
183093
  /** IDs of the spaces the device is in. */
183190
183094
  space_ids: string[]
183191
183095
  /** Optional nickname to describe the device, settable through Seam. */
@@ -184244,25 +184148,18 @@ export type Routes = {
184244
184148
  | undefined
184245
184149
  )
184246
184150
  | undefined
184247
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
184151
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
184248
184152
  hayward_omnilogic_metadata?:
184249
184153
  | (
184250
184154
  | {
184251
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
184155
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
184252
184156
  msp_system_id?: (string | undefined) | undefined
184253
- /** Name of the system, as set in the Hayward OmniLogic app. */
184157
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
184254
184158
  backyard_name?: (string | undefined) | undefined
184255
- /** ID of the body of water within its system. Only present on a pool or spa body. */
184256
- body_of_water_id?: (string | undefined) | undefined
184257
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
184258
- body_of_water_name?: (string | undefined) | undefined
184259
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
184260
- virtual_heater_id?: (string | undefined) | undefined
184261
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
184262
- is_shared_equipment?: (boolean | undefined) | undefined
184263
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
184264
- shared_equipment_priority?:
184265
- (('high' | 'low') | undefined) | undefined
184159
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
184160
+ system_id?: (string | undefined) | undefined
184161
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
184162
+ system_name?: (string | undefined) | undefined
184266
184163
  }
184267
184164
  | undefined
184268
184165
  )
@@ -184381,7 +184278,8 @@ export type Routes = {
184381
184278
  has_native_entry_events?: (boolean | undefined) | undefined
184382
184279
  /** Indicates whether the lock is locked. */
184383
184280
  locked?: (boolean | undefined) | undefined
184384
- /** Keypad battery status. */
184281
+ /** Keypad battery status.
184282
+ * @deprecated Use `accessory_keypad.battery` instead.*/
184385
184283
  keypad_battery?:
184386
184284
  | (
184387
184285
  | {
@@ -187693,8 +187591,8 @@ export type Routes = {
187693
187591
  result: null
187694
187592
  /** Errors associated with the action attempt. Null for pending action attempts. */
187695
187593
  error: null
187696
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
187697
- action_type: 'SET_POOL_HEATING'
187594
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
187595
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
187698
187596
  }
187699
187597
  | {
187700
187598
  /** ID of the action attempt. */
@@ -187702,8 +187600,8 @@ export type Routes = {
187702
187600
  status: 'success'
187703
187601
  /** Errors associated with the action attempt. Null for successful action attempts. */
187704
187602
  error: null
187705
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
187706
- action_type: 'SET_POOL_HEATING'
187603
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
187604
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
187707
187605
  /** Result of the action. */
187708
187606
  result: {}
187709
187607
  }
@@ -187713,8 +187611,8 @@ export type Routes = {
187713
187611
  status: 'error'
187714
187612
  /** Result of the action attempt. Null for failed action attempts. */
187715
187613
  result: null
187716
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
187717
- action_type: 'SET_POOL_HEATING'
187614
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
187615
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
187718
187616
  /** Error associated with the action. */
187719
187617
  error: {
187720
187618
  /** Type of the error. */
@@ -190485,8 +190383,8 @@ export type Routes = {
190485
190383
  result: null
190486
190384
  /** Errors associated with the action attempt. Null for pending action attempts. */
190487
190385
  error: null
190488
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
190489
- action_type: 'SET_POOL_HEATING'
190386
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
190387
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
190490
190388
  }
190491
190389
  | {
190492
190390
  /** ID of the action attempt. */
@@ -190494,8 +190392,8 @@ export type Routes = {
190494
190392
  status: 'success'
190495
190393
  /** Errors associated with the action attempt. Null for successful action attempts. */
190496
190394
  error: null
190497
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
190498
- action_type: 'SET_POOL_HEATING'
190395
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
190396
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
190499
190397
  /** Result of the action. */
190500
190398
  result: {}
190501
190399
  }
@@ -190505,8 +190403,8 @@ export type Routes = {
190505
190403
  status: 'error'
190506
190404
  /** Result of the action attempt. Null for failed action attempts. */
190507
190405
  result: null
190508
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
190509
- action_type: 'SET_POOL_HEATING'
190406
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
190407
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
190510
190408
  /** Error associated with the action. */
190511
190409
  error: {
190512
190410
  /** Type of the error. */
@@ -193106,8 +193004,8 @@ export type Routes = {
193106
193004
  result: null
193107
193005
  /** Errors associated with the action attempt. Null for pending action attempts. */
193108
193006
  error: null
193109
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
193110
- action_type: 'SET_POOL_HEATING'
193007
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
193008
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
193111
193009
  }
193112
193010
  | {
193113
193011
  /** ID of the action attempt. */
@@ -193115,8 +193013,8 @@ export type Routes = {
193115
193013
  status: 'success'
193116
193014
  /** Errors associated with the action attempt. Null for successful action attempts. */
193117
193015
  error: null
193118
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
193119
- action_type: 'SET_POOL_HEATING'
193016
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
193017
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
193120
193018
  /** Result of the action. */
193121
193019
  result: {}
193122
193020
  }
@@ -193126,8 +193024,8 @@ export type Routes = {
193126
193024
  status: 'error'
193127
193025
  /** Result of the action attempt. Null for failed action attempts. */
193128
193026
  result: null
193129
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
193130
- action_type: 'SET_POOL_HEATING'
193027
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
193028
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
193131
193029
  /** Error associated with the action. */
193132
193030
  error: {
193133
193031
  /** Type of the error. */
@@ -195843,8 +195741,8 @@ export type Routes = {
195843
195741
  result: null
195844
195742
  /** Errors associated with the action attempt. Null for pending action attempts. */
195845
195743
  error: null
195846
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
195847
- action_type: 'SET_POOL_HEATING'
195744
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
195745
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
195848
195746
  }
195849
195747
  | {
195850
195748
  /** ID of the action attempt. */
@@ -195852,8 +195750,8 @@ export type Routes = {
195852
195750
  status: 'success'
195853
195751
  /** Errors associated with the action attempt. Null for successful action attempts. */
195854
195752
  error: null
195855
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
195856
- action_type: 'SET_POOL_HEATING'
195753
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
195754
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
195857
195755
  /** Result of the action. */
195858
195756
  result: {}
195859
195757
  }
@@ -195863,8 +195761,8 @@ export type Routes = {
195863
195761
  status: 'error'
195864
195762
  /** Result of the action attempt. Null for failed action attempts. */
195865
195763
  result: null
195866
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
195867
- action_type: 'SET_POOL_HEATING'
195764
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
195765
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
195868
195766
  /** Error associated with the action. */
195869
195767
  error: {
195870
195768
  /** Type of the error. */
@@ -197007,7 +196905,7 @@ export type Routes = {
197007
196905
  )
197008
196906
  | 'sonos_speaker'
197009
196907
  | 'alertify_sensor'
197010
- | ('hayward_pool_system' | 'hayward_pool')
196908
+ | ('hayward_pool_controller' | 'hayward_pool')
197011
196909
  /** IDs of the spaces the device is in. */
197012
196910
  space_ids: string[]
197013
196911
  /** Optional nickname to describe the device, settable through Seam. */
@@ -198066,25 +197964,18 @@ export type Routes = {
198066
197964
  | undefined
198067
197965
  )
198068
197966
  | undefined
198069
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
197967
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
198070
197968
  hayward_omnilogic_metadata?:
198071
197969
  | (
198072
197970
  | {
198073
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
197971
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
198074
197972
  msp_system_id?: (string | undefined) | undefined
198075
- /** Name of the system, as set in the Hayward OmniLogic app. */
197973
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
198076
197974
  backyard_name?: (string | undefined) | undefined
198077
- /** ID of the body of water within its system. Only present on a pool or spa body. */
198078
- body_of_water_id?: (string | undefined) | undefined
198079
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
198080
- body_of_water_name?: (string | undefined) | undefined
198081
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
198082
- virtual_heater_id?: (string | undefined) | undefined
198083
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
198084
- is_shared_equipment?: (boolean | undefined) | undefined
198085
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
198086
- shared_equipment_priority?:
198087
- (('high' | 'low') | undefined) | undefined
197975
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
197976
+ system_id?: (string | undefined) | undefined
197977
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
197978
+ system_name?: (string | undefined) | undefined
198088
197979
  }
198089
197980
  | undefined
198090
197981
  )
@@ -198203,7 +198094,8 @@ export type Routes = {
198203
198094
  has_native_entry_events?: (boolean | undefined) | undefined
198204
198095
  /** Indicates whether the lock is locked. */
198205
198096
  locked?: (boolean | undefined) | undefined
198206
- /** Keypad battery status. */
198097
+ /** Keypad battery status.
198098
+ * @deprecated Use `accessory_keypad.battery` instead.*/
198207
198099
  keypad_battery?:
198208
198100
  | (
198209
198101
  | {
@@ -199316,7 +199208,7 @@ export type Routes = {
199316
199208
  )
199317
199209
  | 'sonos_speaker'
199318
199210
  | 'alertify_sensor'
199319
- | ('hayward_pool_system' | 'hayward_pool')
199211
+ | ('hayward_pool_controller' | 'hayward_pool')
199320
199212
  /** IDs of the spaces the device is in. */
199321
199213
  space_ids: string[]
199322
199214
  /** Optional nickname to describe the device, settable through Seam. */
@@ -200375,25 +200267,18 @@ export type Routes = {
200375
200267
  | undefined
200376
200268
  )
200377
200269
  | undefined
200378
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
200270
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
200379
200271
  hayward_omnilogic_metadata?:
200380
200272
  | (
200381
200273
  | {
200382
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
200274
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
200383
200275
  msp_system_id?: (string | undefined) | undefined
200384
- /** Name of the system, as set in the Hayward OmniLogic app. */
200276
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
200385
200277
  backyard_name?: (string | undefined) | undefined
200386
- /** ID of the body of water within its system. Only present on a pool or spa body. */
200387
- body_of_water_id?: (string | undefined) | undefined
200388
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
200389
- body_of_water_name?: (string | undefined) | undefined
200390
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
200391
- virtual_heater_id?: (string | undefined) | undefined
200392
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
200393
- is_shared_equipment?: (boolean | undefined) | undefined
200394
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
200395
- shared_equipment_priority?:
200396
- (('high' | 'low') | undefined) | undefined
200278
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
200279
+ system_id?: (string | undefined) | undefined
200280
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
200281
+ system_name?: (string | undefined) | undefined
200397
200282
  }
200398
200283
  | undefined
200399
200284
  )
@@ -200512,7 +200397,8 @@ export type Routes = {
200512
200397
  has_native_entry_events?: (boolean | undefined) | undefined
200513
200398
  /** Indicates whether the lock is locked. */
200514
200399
  locked?: (boolean | undefined) | undefined
200515
- /** Keypad battery status. */
200400
+ /** Keypad battery status.
200401
+ * @deprecated Use `accessory_keypad.battery` instead.*/
200516
200402
  keypad_battery?:
200517
200403
  | (
200518
200404
  | {
@@ -204348,7 +204234,7 @@ export type Routes = {
204348
204234
  )
204349
204235
  | 'sonos_speaker'
204350
204236
  | 'alertify_sensor'
204351
- | ('hayward_pool_system' | 'hayward_pool')
204237
+ | ('hayward_pool_controller' | 'hayward_pool')
204352
204238
  /** IDs of the spaces the device is in. */
204353
204239
  space_ids: string[]
204354
204240
  /** Optional nickname to describe the device, settable through Seam. */
@@ -205449,29 +205335,18 @@ export type Routes = {
205449
205335
  | undefined
205450
205336
  )
205451
205337
  | undefined
205452
- /** Metadata for a Hayward OmniLogic pool controller or body of water. */
205338
+ /** Metadata for a Hayward OmniLogic pool controller, pool, or spa. */
205453
205339
  hayward_omnilogic_metadata?:
205454
205340
  | (
205455
205341
  | {
205456
- /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
205342
+ /** ID of the Hayward OmniLogic controller that the device belongs to. */
205457
205343
  msp_system_id?: (string | undefined) | undefined
205458
- /** Name of the system, as set in the Hayward OmniLogic app. */
205344
+ /** Name of the controller, as set in the Hayward OmniLogic app. */
205459
205345
  backyard_name?: (string | undefined) | undefined
205460
- /** ID of the body of water within its system. Only present on a pool or spa body. */
205461
- body_of_water_id?:
205462
- (string | undefined) | undefined
205463
- /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
205464
- body_of_water_name?:
205465
- (string | undefined) | undefined
205466
- /** ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body. */
205467
- virtual_heater_id?:
205468
- (string | undefined) | undefined
205469
- /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
205470
- is_shared_equipment?:
205471
- (boolean | undefined) | undefined
205472
- /** Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat. */
205473
- shared_equipment_priority?:
205474
- (('high' | 'low') | undefined) | undefined
205346
+ /** ID of the pool or spa within its controller. Only present on a pool or spa. */
205347
+ system_id?: (string | undefined) | undefined
205348
+ /** Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa. */
205349
+ system_name?: (string | undefined) | undefined
205475
205350
  }
205476
205351
  | undefined
205477
205352
  )
@@ -205593,7 +205468,8 @@ export type Routes = {
205593
205468
  (boolean | undefined) | undefined
205594
205469
  /** Indicates whether the lock is locked. */
205595
205470
  locked?: (boolean | undefined) | undefined
205596
- /** Keypad battery status. */
205471
+ /** Keypad battery status.
205472
+ * @deprecated Use `accessory_keypad.battery` instead.*/
205597
205473
  keypad_battery?:
205598
205474
  | (
205599
205475
  | {
@@ -209978,8 +209854,8 @@ export type Routes = {
209978
209854
  result: null
209979
209855
  /** Errors associated with the action attempt. Null for pending action attempts. */
209980
209856
  error: null
209981
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
209982
- action_type: 'SET_POOL_HEATING'
209857
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
209858
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
209983
209859
  }
209984
209860
  | {
209985
209861
  /** ID of the action attempt. */
@@ -209987,8 +209863,8 @@ export type Routes = {
209987
209863
  status: 'success'
209988
209864
  /** Errors associated with the action attempt. Null for successful action attempts. */
209989
209865
  error: null
209990
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
209991
- action_type: 'SET_POOL_HEATING'
209866
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
209867
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
209992
209868
  /** Result of the action. */
209993
209869
  result: {}
209994
209870
  }
@@ -209998,8 +209874,8 @@ export type Routes = {
209998
209874
  status: 'error'
209999
209875
  /** Result of the action attempt. Null for failed action attempts. */
210000
209876
  result: null
210001
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
210002
- action_type: 'SET_POOL_HEATING'
209877
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
209878
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
210003
209879
  /** Error associated with the action. */
210004
209880
  error: {
210005
209881
  /** Type of the error. */
@@ -210904,7 +210780,7 @@ export type Routes = {
210904
210780
  )
210905
210781
  | 'sonos_speaker'
210906
210782
  | 'alertify_sensor'
210907
- | ('hayward_pool_system' | 'hayward_pool')
210783
+ | ('hayward_pool_controller' | 'hayward_pool')
210908
210784
  /** Unique identifier for the account associated with the device. */
210909
210785
  connected_account_id: string
210910
210786
  /** Location information for the device. */
@@ -220617,8 +220493,8 @@ export type Routes = {
220617
220493
  result: null
220618
220494
  /** Errors associated with the action attempt. Null for pending action attempts. */
220619
220495
  error: null
220620
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
220621
- action_type: 'SET_POOL_HEATING'
220496
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
220497
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
220622
220498
  }
220623
220499
  | {
220624
220500
  /** ID of the action attempt. */
@@ -220626,8 +220502,8 @@ export type Routes = {
220626
220502
  status: 'success'
220627
220503
  /** Errors associated with the action attempt. Null for successful action attempts. */
220628
220504
  error: null
220629
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
220630
- action_type: 'SET_POOL_HEATING'
220505
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
220506
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
220631
220507
  /** Result of the action. */
220632
220508
  result: {}
220633
220509
  }
@@ -220637,8 +220513,8 @@ export type Routes = {
220637
220513
  status: 'error'
220638
220514
  /** Result of the action attempt. Null for failed action attempts. */
220639
220515
  result: null
220640
- /** Action attempt to track the status of heating pool or spa water to a set point, or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
220641
- action_type: 'SET_POOL_HEATING'
220516
+ /** Action attempt to track the status of setting the mode of a temperature controller, such as heating pool or spa water to a set point or turning its heating off. The attempt succeeds only once the controller reports the requested state back. */
220517
+ action_type: 'SET_TEMPERATURE_CONTROLLER_MODE'
220642
220518
  /** Error associated with the action. */
220643
220519
  error: {
220644
220520
  /** Type of the error. */