@seamapi/types 1.1190.0 → 1.1192.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.
@@ -17336,6 +17336,33 @@ export type Routes = {
17336
17336
  | undefined
17337
17337
  )
17338
17338
  | undefined
17339
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
17340
+ hayward_omnilogic_metadata?:
17341
+ | (
17342
+ | {
17343
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
17344
+ msp_system_id?: (string | undefined) | undefined
17345
+ /** Name of the system, as set in the Hayward OmniLogic app. */
17346
+ backyard_name?: (string | undefined) | undefined
17347
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
17348
+ body_of_water_id?:
17349
+ (string | undefined) | undefined
17350
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
17351
+ body_of_water_name?:
17352
+ (string | undefined) | undefined
17353
+ /** 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. */
17354
+ virtual_heater_id?:
17355
+ (string | undefined) | undefined
17356
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
17357
+ is_shared_equipment?:
17358
+ (boolean | undefined) | undefined
17359
+ /** 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. */
17360
+ shared_equipment_priority?:
17361
+ (('high' | 'low') | undefined) | undefined
17362
+ }
17363
+ | undefined
17364
+ )
17365
+ | undefined
17339
17366
  }) &
17340
17367
  ({
17341
17368
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -18356,6 +18383,10 @@ export type Routes = {
18356
18383
  custom_metadata: {
18357
18384
  [x: string]: string | boolean
18358
18385
  }
18386
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
18387
+ parent_device_id?: string | undefined
18388
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
18389
+ child_device_ids?: string[] | undefined
18359
18390
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
18360
18391
  device_provider?:
18361
18392
  | {
@@ -27341,6 +27372,33 @@ export type Routes = {
27341
27372
  | undefined
27342
27373
  )
27343
27374
  | undefined
27375
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
27376
+ hayward_omnilogic_metadata?:
27377
+ | (
27378
+ | {
27379
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
27380
+ msp_system_id?: (string | undefined) | undefined
27381
+ /** Name of the system, as set in the Hayward OmniLogic app. */
27382
+ backyard_name?: (string | undefined) | undefined
27383
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
27384
+ body_of_water_id?:
27385
+ (string | undefined) | undefined
27386
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
27387
+ body_of_water_name?:
27388
+ (string | undefined) | undefined
27389
+ /** 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. */
27390
+ virtual_heater_id?:
27391
+ (string | undefined) | undefined
27392
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
27393
+ is_shared_equipment?:
27394
+ (boolean | undefined) | undefined
27395
+ /** 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. */
27396
+ shared_equipment_priority?:
27397
+ (('high' | 'low') | undefined) | undefined
27398
+ }
27399
+ | undefined
27400
+ )
27401
+ | undefined
27344
27402
  }) &
27345
27403
  ({
27346
27404
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -28361,6 +28419,10 @@ export type Routes = {
28361
28419
  custom_metadata: {
28362
28420
  [x: string]: string | boolean
28363
28421
  }
28422
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
28423
+ parent_device_id?: string | undefined
28424
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
28425
+ child_device_ids?: string[] | undefined
28364
28426
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
28365
28427
  device_provider?:
28366
28428
  | {
@@ -56609,6 +56671,7 @@ export type Routes = {
56609
56671
  | 'aqara'
56610
56672
  | 'eufy'
56611
56673
  | 'sonos'
56674
+ | 'hayward_omnilogic'
56612
56675
  | 'hid_cm'
56613
56676
  | 'google_nest'
56614
56677
  | 'slack'
@@ -59984,6 +60047,29 @@ export type Routes = {
59984
60047
  | undefined
59985
60048
  )
59986
60049
  | undefined
60050
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
60051
+ hayward_omnilogic_metadata?:
60052
+ | (
60053
+ | {
60054
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
60055
+ msp_system_id?: (string | undefined) | undefined
60056
+ /** Name of the system, as set in the Hayward OmniLogic app. */
60057
+ backyard_name?: (string | undefined) | undefined
60058
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
60059
+ body_of_water_id?: (string | undefined) | undefined
60060
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
60061
+ body_of_water_name?: (string | undefined) | undefined
60062
+ /** 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. */
60063
+ virtual_heater_id?: (string | undefined) | undefined
60064
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
60065
+ is_shared_equipment?: (boolean | undefined) | undefined
60066
+ /** 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. */
60067
+ shared_equipment_priority?:
60068
+ (('high' | 'low') | undefined) | undefined
60069
+ }
60070
+ | undefined
60071
+ )
60072
+ | undefined
59987
60073
  }) &
59988
60074
  ({
59989
60075
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -60971,6 +61057,10 @@ export type Routes = {
60971
61057
  custom_metadata: {
60972
61058
  [x: string]: string | boolean
60973
61059
  }
61060
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
61061
+ parent_device_id?: string | undefined
61062
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
61063
+ child_device_ids?: string[] | undefined
60974
61064
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
60975
61065
  device_provider?:
60976
61066
  | {
@@ -61341,6 +61431,7 @@ export type Routes = {
61341
61431
  | 'slack'
61342
61432
  | 'yacan'
61343
61433
  | 'sonos'
61434
+ | 'hayward_omnilogic'
61344
61435
  )
61345
61436
  | undefined
61346
61437
  /** Array of device IDs for which you want to list devices. */
@@ -61438,6 +61529,8 @@ export type Routes = {
61438
61529
  space_id?: string | undefined
61439
61530
  /** 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`. */
61440
61531
  search?: string | undefined
61532
+ /** ID of the parent device whose child devices you want to list. */
61533
+ parent_device_id?: string | undefined
61441
61534
  }
61442
61535
  formData: {}
61443
61536
  jsonResponse: {
@@ -62523,6 +62616,29 @@ export type Routes = {
62523
62616
  | undefined
62524
62617
  )
62525
62618
  | undefined
62619
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
62620
+ hayward_omnilogic_metadata?:
62621
+ | (
62622
+ | {
62623
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
62624
+ msp_system_id?: (string | undefined) | undefined
62625
+ /** Name of the system, as set in the Hayward OmniLogic app. */
62626
+ backyard_name?: (string | undefined) | undefined
62627
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
62628
+ body_of_water_id?: (string | undefined) | undefined
62629
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
62630
+ body_of_water_name?: (string | undefined) | undefined
62631
+ /** 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. */
62632
+ virtual_heater_id?: (string | undefined) | undefined
62633
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
62634
+ is_shared_equipment?: (boolean | undefined) | undefined
62635
+ /** 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. */
62636
+ shared_equipment_priority?:
62637
+ (('high' | 'low') | undefined) | undefined
62638
+ }
62639
+ | undefined
62640
+ )
62641
+ | undefined
62526
62642
  }) &
62527
62643
  ({
62528
62644
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -63510,6 +63626,10 @@ export type Routes = {
63510
63626
  custom_metadata: {
63511
63627
  [x: string]: string | boolean
63512
63628
  }
63629
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
63630
+ parent_device_id?: string | undefined
63631
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
63632
+ child_device_ids?: string[] | undefined
63513
63633
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
63514
63634
  device_provider?:
63515
63635
  | {
@@ -63784,6 +63904,7 @@ export type Routes = {
63784
63904
  | 'aqara'
63785
63905
  | 'eufy'
63786
63906
  | 'sonos'
63907
+ | 'hayward_omnilogic'
63787
63908
  /** Display name for the device provider. */
63788
63909
  display_name: string
63789
63910
  /** Image URL for the device provider. */
@@ -66140,6 +66261,7 @@ export type Routes = {
66140
66261
  | 'slack'
66141
66262
  | 'yacan'
66142
66263
  | 'sonos'
66264
+ | 'hayward_omnilogic'
66143
66265
  )
66144
66266
  | undefined
66145
66267
  /** Array of device IDs for which you want to list devices. */
@@ -66222,6 +66344,8 @@ export type Routes = {
66222
66344
  | undefined
66223
66345
  /** 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`. */
66224
66346
  search?: string | undefined
66347
+ /** ID of the parent device whose child devices you want to list. */
66348
+ parent_device_id?: string | undefined
66225
66349
  /** Numerical limit on the number of devices to return. */
66226
66350
  limit?: number
66227
66351
  }
@@ -79495,6 +79619,29 @@ export type Routes = {
79495
79619
  | undefined
79496
79620
  )
79497
79621
  | undefined
79622
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
79623
+ hayward_omnilogic_metadata?:
79624
+ | (
79625
+ | {
79626
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
79627
+ msp_system_id?: (string | undefined) | undefined
79628
+ /** Name of the system, as set in the Hayward OmniLogic app. */
79629
+ backyard_name?: (string | undefined) | undefined
79630
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
79631
+ body_of_water_id?: (string | undefined) | undefined
79632
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
79633
+ body_of_water_name?: (string | undefined) | undefined
79634
+ /** 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. */
79635
+ virtual_heater_id?: (string | undefined) | undefined
79636
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
79637
+ is_shared_equipment?: (boolean | undefined) | undefined
79638
+ /** 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. */
79639
+ shared_equipment_priority?:
79640
+ (('high' | 'low') | undefined) | undefined
79641
+ }
79642
+ | undefined
79643
+ )
79644
+ | undefined
79498
79645
  }) &
79499
79646
  ({
79500
79647
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -80482,6 +80629,10 @@ export type Routes = {
80482
80629
  custom_metadata: {
80483
80630
  [x: string]: string | boolean
80484
80631
  }
80632
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
80633
+ parent_device_id?: string | undefined
80634
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
80635
+ child_device_ids?: string[] | undefined
80485
80636
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
80486
80637
  device_provider?:
80487
80638
  | {
@@ -81727,6 +81878,29 @@ export type Routes = {
81727
81878
  | undefined
81728
81879
  )
81729
81880
  | undefined
81881
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
81882
+ hayward_omnilogic_metadata?:
81883
+ | (
81884
+ | {
81885
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
81886
+ msp_system_id?: (string | undefined) | undefined
81887
+ /** Name of the system, as set in the Hayward OmniLogic app. */
81888
+ backyard_name?: (string | undefined) | undefined
81889
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
81890
+ body_of_water_id?: (string | undefined) | undefined
81891
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
81892
+ body_of_water_name?: (string | undefined) | undefined
81893
+ /** 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. */
81894
+ virtual_heater_id?: (string | undefined) | undefined
81895
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
81896
+ is_shared_equipment?: (boolean | undefined) | undefined
81897
+ /** 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. */
81898
+ shared_equipment_priority?:
81899
+ (('high' | 'low') | undefined) | undefined
81900
+ }
81901
+ | undefined
81902
+ )
81903
+ | undefined
81730
81904
  }) &
81731
81905
  ({
81732
81906
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -82714,6 +82888,10 @@ export type Routes = {
82714
82888
  custom_metadata: {
82715
82889
  [x: string]: string | boolean
82716
82890
  }
82891
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
82892
+ parent_device_id?: string | undefined
82893
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
82894
+ child_device_ids?: string[] | undefined
82717
82895
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
82718
82896
  device_provider?:
82719
82897
  | {
@@ -84097,6 +84275,29 @@ export type Routes = {
84097
84275
  | undefined
84098
84276
  )
84099
84277
  | undefined
84278
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
84279
+ hayward_omnilogic_metadata?:
84280
+ | (
84281
+ | {
84282
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
84283
+ msp_system_id?: (string | undefined) | undefined
84284
+ /** Name of the system, as set in the Hayward OmniLogic app. */
84285
+ backyard_name?: (string | undefined) | undefined
84286
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
84287
+ body_of_water_id?: (string | undefined) | undefined
84288
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
84289
+ body_of_water_name?: (string | undefined) | undefined
84290
+ /** 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. */
84291
+ virtual_heater_id?: (string | undefined) | undefined
84292
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
84293
+ is_shared_equipment?: (boolean | undefined) | undefined
84294
+ /** 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. */
84295
+ shared_equipment_priority?:
84296
+ (('high' | 'low') | undefined) | undefined
84297
+ }
84298
+ | undefined
84299
+ )
84300
+ | undefined
84100
84301
  }) &
84101
84302
  ({
84102
84303
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -85084,6 +85285,10 @@ export type Routes = {
85084
85285
  custom_metadata: {
85085
85286
  [x: string]: string | boolean
85086
85287
  }
85288
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
85289
+ parent_device_id?: string | undefined
85290
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
85291
+ child_device_ids?: string[] | undefined
85087
85292
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
85088
85293
  device_provider?:
85089
85294
  | {
@@ -86328,6 +86533,29 @@ export type Routes = {
86328
86533
  | undefined
86329
86534
  )
86330
86535
  | undefined
86536
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
86537
+ hayward_omnilogic_metadata?:
86538
+ | (
86539
+ | {
86540
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
86541
+ msp_system_id?: (string | undefined) | undefined
86542
+ /** Name of the system, as set in the Hayward OmniLogic app. */
86543
+ backyard_name?: (string | undefined) | undefined
86544
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
86545
+ body_of_water_id?: (string | undefined) | undefined
86546
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
86547
+ body_of_water_name?: (string | undefined) | undefined
86548
+ /** 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. */
86549
+ virtual_heater_id?: (string | undefined) | undefined
86550
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
86551
+ is_shared_equipment?: (boolean | undefined) | undefined
86552
+ /** 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. */
86553
+ shared_equipment_priority?:
86554
+ (('high' | 'low') | undefined) | undefined
86555
+ }
86556
+ | undefined
86557
+ )
86558
+ | undefined
86331
86559
  }) &
86332
86560
  ({
86333
86561
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -87315,6 +87543,10 @@ export type Routes = {
87315
87543
  custom_metadata: {
87316
87544
  [x: string]: string | boolean
87317
87545
  }
87546
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
87547
+ parent_device_id?: string | undefined
87548
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
87549
+ child_device_ids?: string[] | undefined
87318
87550
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
87319
87551
  device_provider?:
87320
87552
  | {
@@ -98962,6 +99194,29 @@ export type Routes = {
98962
99194
  | undefined
98963
99195
  )
98964
99196
  | undefined
99197
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
99198
+ hayward_omnilogic_metadata?:
99199
+ | (
99200
+ | {
99201
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
99202
+ msp_system_id?: (string | undefined) | undefined
99203
+ /** Name of the system, as set in the Hayward OmniLogic app. */
99204
+ backyard_name?: (string | undefined) | undefined
99205
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
99206
+ body_of_water_id?: (string | undefined) | undefined
99207
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
99208
+ body_of_water_name?: (string | undefined) | undefined
99209
+ /** 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. */
99210
+ virtual_heater_id?: (string | undefined) | undefined
99211
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
99212
+ is_shared_equipment?: (boolean | undefined) | undefined
99213
+ /** 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. */
99214
+ shared_equipment_priority?:
99215
+ (('high' | 'low') | undefined) | undefined
99216
+ }
99217
+ | undefined
99218
+ )
99219
+ | undefined
98965
99220
  }) &
98966
99221
  ({
98967
99222
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -99949,6 +100204,10 @@ export type Routes = {
99949
100204
  custom_metadata: {
99950
100205
  [x: string]: string | boolean
99951
100206
  }
100207
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
100208
+ parent_device_id?: string | undefined
100209
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
100210
+ child_device_ids?: string[] | undefined
99952
100211
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
99953
100212
  device_provider?:
99954
100213
  | {
@@ -101193,6 +101452,29 @@ export type Routes = {
101193
101452
  | undefined
101194
101453
  )
101195
101454
  | undefined
101455
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
101456
+ hayward_omnilogic_metadata?:
101457
+ | (
101458
+ | {
101459
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
101460
+ msp_system_id?: (string | undefined) | undefined
101461
+ /** Name of the system, as set in the Hayward OmniLogic app. */
101462
+ backyard_name?: (string | undefined) | undefined
101463
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
101464
+ body_of_water_id?: (string | undefined) | undefined
101465
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
101466
+ body_of_water_name?: (string | undefined) | undefined
101467
+ /** 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. */
101468
+ virtual_heater_id?: (string | undefined) | undefined
101469
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
101470
+ is_shared_equipment?: (boolean | undefined) | undefined
101471
+ /** 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. */
101472
+ shared_equipment_priority?:
101473
+ (('high' | 'low') | undefined) | undefined
101474
+ }
101475
+ | undefined
101476
+ )
101477
+ | undefined
101196
101478
  }) &
101197
101479
  ({
101198
101480
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -102180,6 +102462,10 @@ export type Routes = {
102180
102462
  custom_metadata: {
102181
102463
  [x: string]: string | boolean
102182
102464
  }
102465
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
102466
+ parent_device_id?: string | undefined
102467
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
102468
+ child_device_ids?: string[] | undefined
102183
102469
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
102184
102470
  device_provider?:
102185
102471
  | {
@@ -115351,6 +115637,29 @@ export type Routes = {
115351
115637
  | undefined
115352
115638
  )
115353
115639
  | undefined
115640
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
115641
+ hayward_omnilogic_metadata?:
115642
+ | (
115643
+ | {
115644
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
115645
+ msp_system_id?: (string | undefined) | undefined
115646
+ /** Name of the system, as set in the Hayward OmniLogic app. */
115647
+ backyard_name?: (string | undefined) | undefined
115648
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
115649
+ body_of_water_id?: (string | undefined) | undefined
115650
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
115651
+ body_of_water_name?: (string | undefined) | undefined
115652
+ /** 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. */
115653
+ virtual_heater_id?: (string | undefined) | undefined
115654
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
115655
+ is_shared_equipment?: (boolean | undefined) | undefined
115656
+ /** 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. */
115657
+ shared_equipment_priority?:
115658
+ (('high' | 'low') | undefined) | undefined
115659
+ }
115660
+ | undefined
115661
+ )
115662
+ | undefined
115354
115663
  }) &
115355
115664
  ({
115356
115665
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -116338,6 +116647,10 @@ export type Routes = {
116338
116647
  custom_metadata: {
116339
116648
  [x: string]: string | boolean
116340
116649
  }
116650
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
116651
+ parent_device_id?: string | undefined
116652
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
116653
+ child_device_ids?: string[] | undefined
116341
116654
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
116342
116655
  device_provider?:
116343
116656
  | {
@@ -138706,6 +139019,33 @@ export type Routes = {
138706
139019
  | undefined
138707
139020
  )
138708
139021
  | undefined
139022
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
139023
+ hayward_omnilogic_metadata?:
139024
+ | (
139025
+ | {
139026
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
139027
+ msp_system_id?: (string | undefined) | undefined
139028
+ /** Name of the system, as set in the Hayward OmniLogic app. */
139029
+ backyard_name?: (string | undefined) | undefined
139030
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
139031
+ body_of_water_id?:
139032
+ (string | undefined) | undefined
139033
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
139034
+ body_of_water_name?:
139035
+ (string | undefined) | undefined
139036
+ /** 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. */
139037
+ virtual_heater_id?:
139038
+ (string | undefined) | undefined
139039
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
139040
+ is_shared_equipment?:
139041
+ (boolean | undefined) | undefined
139042
+ /** 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. */
139043
+ shared_equipment_priority?:
139044
+ (('high' | 'low') | undefined) | undefined
139045
+ }
139046
+ | undefined
139047
+ )
139048
+ | undefined
138709
139049
  }) &
138710
139050
  ({
138711
139051
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -139726,6 +140066,10 @@ export type Routes = {
139726
140066
  custom_metadata: {
139727
140067
  [x: string]: string | boolean
139728
140068
  }
140069
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
140070
+ parent_device_id?: string | undefined
140071
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
140072
+ child_device_ids?: string[] | undefined
139729
140073
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
139730
140074
  device_provider?:
139731
140075
  | {
@@ -173328,6 +173672,29 @@ export type Routes = {
173328
173672
  | undefined
173329
173673
  )
173330
173674
  | undefined
173675
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
173676
+ hayward_omnilogic_metadata?:
173677
+ | (
173678
+ | {
173679
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
173680
+ msp_system_id?: (string | undefined) | undefined
173681
+ /** Name of the system, as set in the Hayward OmniLogic app. */
173682
+ backyard_name?: (string | undefined) | undefined
173683
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
173684
+ body_of_water_id?: (string | undefined) | undefined
173685
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
173686
+ body_of_water_name?: (string | undefined) | undefined
173687
+ /** 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. */
173688
+ virtual_heater_id?: (string | undefined) | undefined
173689
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
173690
+ is_shared_equipment?: (boolean | undefined) | undefined
173691
+ /** 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. */
173692
+ shared_equipment_priority?:
173693
+ (('high' | 'low') | undefined) | undefined
173694
+ }
173695
+ | undefined
173696
+ )
173697
+ | undefined
173331
173698
  }) &
173332
173699
  ({
173333
173700
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -174315,6 +174682,10 @@ export type Routes = {
174315
174682
  custom_metadata: {
174316
174683
  [x: string]: string | boolean
174317
174684
  }
174685
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
174686
+ parent_device_id?: string | undefined
174687
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
174688
+ child_device_ids?: string[] | undefined
174318
174689
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
174319
174690
  device_provider?:
174320
174691
  | {
@@ -180792,6 +181163,29 @@ export type Routes = {
180792
181163
  | undefined
180793
181164
  )
180794
181165
  | undefined
181166
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
181167
+ hayward_omnilogic_metadata?:
181168
+ | (
181169
+ | {
181170
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
181171
+ msp_system_id?: (string | undefined) | undefined
181172
+ /** Name of the system, as set in the Hayward OmniLogic app. */
181173
+ backyard_name?: (string | undefined) | undefined
181174
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
181175
+ body_of_water_id?: (string | undefined) | undefined
181176
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
181177
+ body_of_water_name?: (string | undefined) | undefined
181178
+ /** 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. */
181179
+ virtual_heater_id?: (string | undefined) | undefined
181180
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
181181
+ is_shared_equipment?: (boolean | undefined) | undefined
181182
+ /** 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. */
181183
+ shared_equipment_priority?:
181184
+ (('high' | 'low') | undefined) | undefined
181185
+ }
181186
+ | undefined
181187
+ )
181188
+ | undefined
180795
181189
  }) &
180796
181190
  ({
180797
181191
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -181779,6 +182173,10 @@ export type Routes = {
181779
182173
  custom_metadata: {
181780
182174
  [x: string]: string | boolean
181781
182175
  }
182176
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
182177
+ parent_device_id?: string | undefined
182178
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
182179
+ child_device_ids?: string[] | undefined
181782
182180
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
181783
182181
  device_provider?:
181784
182182
  | {
@@ -183023,6 +183421,29 @@ export type Routes = {
183023
183421
  | undefined
183024
183422
  )
183025
183423
  | undefined
183424
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
183425
+ hayward_omnilogic_metadata?:
183426
+ | (
183427
+ | {
183428
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
183429
+ msp_system_id?: (string | undefined) | undefined
183430
+ /** Name of the system, as set in the Hayward OmniLogic app. */
183431
+ backyard_name?: (string | undefined) | undefined
183432
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
183433
+ body_of_water_id?: (string | undefined) | undefined
183434
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
183435
+ body_of_water_name?: (string | undefined) | undefined
183436
+ /** 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. */
183437
+ virtual_heater_id?: (string | undefined) | undefined
183438
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
183439
+ is_shared_equipment?: (boolean | undefined) | undefined
183440
+ /** 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. */
183441
+ shared_equipment_priority?:
183442
+ (('high' | 'low') | undefined) | undefined
183443
+ }
183444
+ | undefined
183445
+ )
183446
+ | undefined
183026
183447
  }) &
183027
183448
  ({
183028
183449
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -184010,6 +184431,10 @@ export type Routes = {
184010
184431
  custom_metadata: {
184011
184432
  [x: string]: string | boolean
184012
184433
  }
184434
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
184435
+ parent_device_id?: string | undefined
184436
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
184437
+ child_device_ids?: string[] | undefined
184013
184438
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
184014
184439
  device_provider?:
184015
184440
  | {
@@ -196773,6 +197198,29 @@ export type Routes = {
196773
197198
  | undefined
196774
197199
  )
196775
197200
  | undefined
197201
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
197202
+ hayward_omnilogic_metadata?:
197203
+ | (
197204
+ | {
197205
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
197206
+ msp_system_id?: (string | undefined) | undefined
197207
+ /** Name of the system, as set in the Hayward OmniLogic app. */
197208
+ backyard_name?: (string | undefined) | undefined
197209
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
197210
+ body_of_water_id?: (string | undefined) | undefined
197211
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
197212
+ body_of_water_name?: (string | undefined) | undefined
197213
+ /** 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. */
197214
+ virtual_heater_id?: (string | undefined) | undefined
197215
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
197216
+ is_shared_equipment?: (boolean | undefined) | undefined
197217
+ /** 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. */
197218
+ shared_equipment_priority?:
197219
+ (('high' | 'low') | undefined) | undefined
197220
+ }
197221
+ | undefined
197222
+ )
197223
+ | undefined
196776
197224
  }) &
196777
197225
  ({
196778
197226
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -197760,6 +198208,10 @@ export type Routes = {
197760
198208
  custom_metadata: {
197761
198209
  [x: string]: string | boolean
197762
198210
  }
198211
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
198212
+ parent_device_id?: string | undefined
198213
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
198214
+ child_device_ids?: string[] | undefined
197763
198215
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
197764
198216
  device_provider?:
197765
198217
  | {
@@ -199006,6 +199458,29 @@ export type Routes = {
199006
199458
  | undefined
199007
199459
  )
199008
199460
  | undefined
199461
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
199462
+ hayward_omnilogic_metadata?:
199463
+ | (
199464
+ | {
199465
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
199466
+ msp_system_id?: (string | undefined) | undefined
199467
+ /** Name of the system, as set in the Hayward OmniLogic app. */
199468
+ backyard_name?: (string | undefined) | undefined
199469
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
199470
+ body_of_water_id?: (string | undefined) | undefined
199471
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
199472
+ body_of_water_name?: (string | undefined) | undefined
199473
+ /** 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. */
199474
+ virtual_heater_id?: (string | undefined) | undefined
199475
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
199476
+ is_shared_equipment?: (boolean | undefined) | undefined
199477
+ /** 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. */
199478
+ shared_equipment_priority?:
199479
+ (('high' | 'low') | undefined) | undefined
199480
+ }
199481
+ | undefined
199482
+ )
199483
+ | undefined
199009
199484
  }) &
199010
199485
  ({
199011
199486
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -199993,6 +200468,10 @@ export type Routes = {
199993
200468
  custom_metadata: {
199994
200469
  [x: string]: string | boolean
199995
200470
  }
200471
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
200472
+ parent_device_id?: string | undefined
200473
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
200474
+ child_device_ids?: string[] | undefined
199996
200475
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
199997
200476
  device_provider?:
199998
200477
  | {
@@ -204006,6 +204485,33 @@ export type Routes = {
204006
204485
  | undefined
204007
204486
  )
204008
204487
  | undefined
204488
+ /** Metadata for a Hayward OmniLogic pool controller or body of water. */
204489
+ hayward_omnilogic_metadata?:
204490
+ | (
204491
+ | {
204492
+ /** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
204493
+ msp_system_id?: (string | undefined) | undefined
204494
+ /** Name of the system, as set in the Hayward OmniLogic app. */
204495
+ backyard_name?: (string | undefined) | undefined
204496
+ /** ID of the body of water within its system. Only present on a pool or spa body. */
204497
+ body_of_water_id?:
204498
+ (string | undefined) | undefined
204499
+ /** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
204500
+ body_of_water_name?:
204501
+ (string | undefined) | undefined
204502
+ /** 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. */
204503
+ virtual_heater_id?:
204504
+ (string | undefined) | undefined
204505
+ /** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
204506
+ is_shared_equipment?:
204507
+ (boolean | undefined) | undefined
204508
+ /** 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. */
204509
+ shared_equipment_priority?:
204510
+ (('high' | 'low') | undefined) | undefined
204511
+ }
204512
+ | undefined
204513
+ )
204514
+ | undefined
204009
204515
  }) &
204010
204516
  ({
204011
204517
  /** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
@@ -205026,6 +205532,10 @@ export type Routes = {
205026
205532
  custom_metadata: {
205027
205533
  [x: string]: string | boolean
205028
205534
  }
205535
+ /** ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent. */
205536
+ parent_device_id?: string | undefined
205537
+ /** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
205538
+ child_device_ids?: string[] | undefined
205029
205539
  /** Provider of the device. Represents the third-party service through which the device is controlled. */
205030
205540
  device_provider?:
205031
205541
  | {