@seamapi/types 1.1189.0 → 1.1191.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 (52) hide show
  1. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +75 -0
  2. package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
  3. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  4. package/lib/seam/connect/models/action-attempts/set-pool-heating.d.ts +77 -0
  5. package/lib/seam/connect/models/action-attempts/set-pool-heating.js +43 -0
  6. package/lib/seam/connect/models/action-attempts/set-pool-heating.js.map +1 -0
  7. package/lib/seam/connect/models/connect-webviews/connect-webview.d.ts +3 -3
  8. package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +3 -3
  9. package/lib/seam/connect/models/devices/capabilities-supported.d.ts +1 -1
  10. package/lib/seam/connect/models/devices/capabilities-supported.js +1 -0
  11. package/lib/seam/connect/models/devices/capabilities-supported.js.map +1 -1
  12. package/lib/seam/connect/models/devices/device-provider.d.ts +3 -0
  13. package/lib/seam/connect/models/devices/device-provider.js +1 -0
  14. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  15. package/lib/seam/connect/models/devices/device-type.d.ts +12 -1
  16. package/lib/seam/connect/models/devices/device-type.js +15 -0
  17. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  18. package/lib/seam/connect/models/devices/device.d.ts +108 -6
  19. package/lib/seam/connect/models/devices/device.js +42 -0
  20. package/lib/seam/connect/models/devices/device.js.map +1 -1
  21. package/lib/seam/connect/models/devices/index.d.ts +2 -0
  22. package/lib/seam/connect/models/devices/index.js +2 -0
  23. package/lib/seam/connect/models/devices/index.js.map +1 -1
  24. package/lib/seam/connect/models/devices/phone.d.ts +21 -0
  25. package/lib/seam/connect/models/devices/pool.d.ts +20 -0
  26. package/lib/seam/connect/models/devices/pool.js +26 -0
  27. package/lib/seam/connect/models/devices/pool.js.map +1 -0
  28. package/lib/seam/connect/models/devices/temperature-controller.d.ts +44 -0
  29. package/lib/seam/connect/models/devices/temperature-controller.js +29 -0
  30. package/lib/seam/connect/models/devices/temperature-controller.js.map +1 -0
  31. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +49 -6
  32. package/lib/seam/connect/models/provider-capability.d.ts +1 -1
  33. package/lib/seam/connect/models/provider-capability.js +1 -0
  34. package/lib/seam/connect/models/provider-capability.js.map +1 -1
  35. package/lib/seam/connect/openapi.js +548 -0
  36. package/lib/seam/connect/openapi.js.map +1 -1
  37. package/lib/seam/connect/route-types.d.ts +9059 -796
  38. package/package.json +1 -1
  39. package/src/lib/seam/connect/internal/enums.ts +2 -0
  40. package/src/lib/seam/connect/internal/schemas.ts +1 -0
  41. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
  42. package/src/lib/seam/connect/models/action-attempts/set-pool-heating.ts +53 -0
  43. package/src/lib/seam/connect/models/devices/capabilities-supported.ts +1 -0
  44. package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
  45. package/src/lib/seam/connect/models/devices/device-type.ts +25 -0
  46. package/src/lib/seam/connect/models/devices/device.ts +43 -0
  47. package/src/lib/seam/connect/models/devices/index.ts +2 -0
  48. package/src/lib/seam/connect/models/devices/pool.ts +45 -0
  49. package/src/lib/seam/connect/models/devices/temperature-controller.ts +50 -0
  50. package/src/lib/seam/connect/models/provider-capability.ts +1 -0
  51. package/src/lib/seam/connect/openapi.ts +602 -0
  52. package/src/lib/seam/connect/route-types.ts +9741 -71
@@ -11461,6 +11461,117 @@ const openapi = {
11461
11461
  type: 'object',
11462
11462
  'x-undocumented': 'Unreleased.',
11463
11463
  },
11464
+ {
11465
+ description: 'Setting the pool heating is pending. The controller has not yet reported the requested state back.',
11466
+ properties: {
11467
+ action_attempt_id: {
11468
+ description: 'ID of the action attempt.',
11469
+ format: 'uuid',
11470
+ type: 'string',
11471
+ },
11472
+ action_type: {
11473
+ description: '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.',
11474
+ enum: ['SET_POOL_HEATING'],
11475
+ type: 'string',
11476
+ 'x-undocumented': 'Unreleased.',
11477
+ },
11478
+ error: {
11479
+ description: 'Errors associated with the action attempt. Null for pending action attempts.',
11480
+ nullable: true,
11481
+ },
11482
+ result: {
11483
+ description: 'Result of the action attempt. Null for pending action attempts.',
11484
+ nullable: true,
11485
+ },
11486
+ status: { enum: ['pending'], type: 'string' },
11487
+ },
11488
+ required: [
11489
+ 'action_attempt_id',
11490
+ 'status',
11491
+ 'result',
11492
+ 'error',
11493
+ 'action_type',
11494
+ ],
11495
+ type: 'object',
11496
+ 'x-undocumented': 'Unreleased.',
11497
+ },
11498
+ {
11499
+ description: 'Setting the pool heating succeeded. The controller reported the requested state back.',
11500
+ properties: {
11501
+ action_attempt_id: {
11502
+ description: 'ID of the action attempt.',
11503
+ format: 'uuid',
11504
+ type: 'string',
11505
+ },
11506
+ action_type: {
11507
+ description: '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.',
11508
+ enum: ['SET_POOL_HEATING'],
11509
+ type: 'string',
11510
+ 'x-undocumented': 'Unreleased.',
11511
+ },
11512
+ error: {
11513
+ description: 'Errors associated with the action attempt. Null for successful action attempts.',
11514
+ nullable: true,
11515
+ },
11516
+ result: {
11517
+ description: 'Result of the action.',
11518
+ properties: {},
11519
+ type: 'object',
11520
+ },
11521
+ status: { enum: ['success'], type: 'string' },
11522
+ },
11523
+ required: [
11524
+ 'action_attempt_id',
11525
+ 'status',
11526
+ 'error',
11527
+ 'action_type',
11528
+ 'result',
11529
+ ],
11530
+ type: 'object',
11531
+ 'x-undocumented': 'Unreleased.',
11532
+ },
11533
+ {
11534
+ description: 'Setting the pool heating failed.',
11535
+ properties: {
11536
+ action_attempt_id: {
11537
+ description: 'ID of the action attempt.',
11538
+ format: 'uuid',
11539
+ type: 'string',
11540
+ },
11541
+ action_type: {
11542
+ description: '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.',
11543
+ enum: ['SET_POOL_HEATING'],
11544
+ type: 'string',
11545
+ 'x-undocumented': 'Unreleased.',
11546
+ },
11547
+ error: {
11548
+ description: 'Error associated with the action.',
11549
+ properties: {
11550
+ message: {
11551
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
11552
+ type: 'string',
11553
+ },
11554
+ type: { description: 'Type of the error.', type: 'string' },
11555
+ },
11556
+ required: ['type', 'message'],
11557
+ type: 'object',
11558
+ },
11559
+ result: {
11560
+ description: 'Result of the action attempt. Null for failed action attempts.',
11561
+ nullable: true,
11562
+ },
11563
+ status: { enum: ['error'], type: 'string' },
11564
+ },
11565
+ required: [
11566
+ 'action_attempt_id',
11567
+ 'status',
11568
+ 'result',
11569
+ 'action_type',
11570
+ 'error',
11571
+ ],
11572
+ type: 'object',
11573
+ 'x-undocumented': 'Unreleased.',
11574
+ },
11464
11575
  {
11465
11576
  properties: {
11466
11577
  action_attempt_id: {
@@ -12693,6 +12804,7 @@ const openapi = {
12693
12804
  'access_control',
12694
12805
  'camera',
12695
12806
  'speaker',
12807
+ 'pool',
12696
12808
  ],
12697
12809
  type: 'string',
12698
12810
  },
@@ -12842,6 +12954,7 @@ const openapi = {
12842
12954
  'access_control',
12843
12955
  'camera',
12844
12956
  'speaker',
12957
+ 'pool',
12845
12958
  ],
12846
12959
  type: 'string',
12847
12960
  },
@@ -13954,6 +14067,11 @@ const openapi = {
13954
14067
  description: 'Indicates whether the lock supports configuring automatic locking.',
13955
14068
  type: 'boolean',
13956
14069
  },
14070
+ can_control_temperature: {
14071
+ description: 'Indicates whether the device supports controlling its primary target temperature.',
14072
+ type: 'boolean',
14073
+ 'x-undocumented': 'Unreleased.',
14074
+ },
13957
14075
  can_hvac_cool: {
13958
14076
  description: 'Indicates whether the thermostat supports cooling.',
13959
14077
  type: 'boolean',
@@ -14085,11 +14203,18 @@ const openapi = {
14085
14203
  'thermostat',
14086
14204
  'battery',
14087
14205
  'phone',
14206
+ 'pool',
14088
14207
  ],
14089
14208
  type: 'string',
14090
14209
  },
14091
14210
  type: 'array',
14092
14211
  },
14212
+ child_device_ids: {
14213
+ description: 'IDs of the child devices that belong to this device. Only present when the device has at least one child.',
14214
+ items: { format: 'uuid', type: 'string' },
14215
+ type: 'array',
14216
+ 'x-undocumented': 'Unreleased.',
14217
+ },
14093
14218
  co2_ppm: {
14094
14219
  description: 'Carbon dioxide concentration in parts per million, if the device measures it.',
14095
14220
  format: 'float',
@@ -14266,6 +14391,12 @@ const openapi = {
14266
14391
  enum: ['alertify_sensor'],
14267
14392
  type: 'string',
14268
14393
  },
14394
+ {
14395
+ description: 'Device type for pool controllers, pools, and spas.',
14396
+ enum: ['hayward_pool_system', 'hayward_pool'],
14397
+ type: 'string',
14398
+ 'x-undocumented': 'Unreleased.',
14399
+ },
14269
14400
  ],
14270
14401
  },
14271
14402
  display_name: {
@@ -14763,6 +14894,7 @@ const openapi = {
14763
14894
  locks: { name: 'Locks' },
14764
14895
  noise_sensors: { name: 'Noise Sensors' },
14765
14896
  phones: { name: 'Phones' },
14897
+ pools: { name: 'Pools' },
14766
14898
  provider_metadata: { name: 'Provider Metadata' },
14767
14899
  thermostats: { name: 'Thermostats' },
14768
14900
  },
@@ -14794,6 +14926,18 @@ const openapi = {
14794
14926
  type: 'boolean',
14795
14927
  'x-property-group-key': 'sensors',
14796
14928
  },
14929
+ is_spa: {
14930
+ description: 'Indicates whether the device represents spa water rather than pool water. Present only on pool and spa devices.',
14931
+ type: 'boolean',
14932
+ 'x-property-group-key': 'pools',
14933
+ 'x-undocumented': 'Unreleased.',
14934
+ },
14935
+ is_water_circulating: {
14936
+ description: 'Indicates whether the water is circulating. Temperature readings are only live while it is circulating. Omitted if the controller does not report it.',
14937
+ type: 'boolean',
14938
+ 'x-property-group-key': 'pools',
14939
+ 'x-undocumented': 'Unreleased.',
14940
+ },
14797
14941
  location: {
14798
14942
  description: 'Location information for the device.',
14799
14943
  properties: {
@@ -14940,6 +15084,12 @@ const openapi = {
14940
15084
  type: 'number',
14941
15085
  'x-property-group-key': 'sensors',
14942
15086
  },
15087
+ parent_device_id: {
15088
+ description: '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.',
15089
+ format: 'uuid',
15090
+ type: 'string',
15091
+ 'x-undocumented': 'Unreleased.',
15092
+ },
14943
15093
  properties: {
14944
15094
  allOf: [
14945
15095
  {
@@ -17791,6 +17941,13 @@ const openapi = {
17791
17941
  type: 'number',
17792
17942
  'x-property-group-key': 'sensors',
17793
17943
  },
17944
+ salt_ppm: {
17945
+ description: 'Salt level reported by the chlorinator, in parts per million. Omitted if the system has no salt chlorinator.',
17946
+ format: 'float',
17947
+ type: 'number',
17948
+ 'x-property-group-key': 'pools',
17949
+ 'x-undocumented': 'Unreleased.',
17950
+ },
17794
17951
  space_ids: {
17795
17952
  description: 'IDs of the spaces the device is in.',
17796
17953
  items: { format: 'uuid', type: 'string' },
@@ -17808,6 +17965,30 @@ const openapi = {
17808
17965
  type: 'number',
17809
17966
  'x-property-group-key': 'sensors',
17810
17967
  },
17968
+ temperature_setting: {
17969
+ description: "Current setting of the device's primary temperature controller.",
17970
+ properties: {
17971
+ controller_mode: {
17972
+ description: "Operating mode requested from the device's primary temperature controller.",
17973
+ enum: ['heat', 'off'],
17974
+ type: 'string',
17975
+ },
17976
+ heating_set_point_celsius: {
17977
+ description: 'Temperature to which the controller should heat, in °C. The controller can retain this value while it is off.',
17978
+ format: 'float',
17979
+ type: 'number',
17980
+ },
17981
+ heating_set_point_fahrenheit: {
17982
+ description: 'Temperature to which the controller should heat, in °F. The controller can retain this value while it is off.',
17983
+ format: 'float',
17984
+ type: 'number',
17985
+ },
17986
+ },
17987
+ required: ['controller_mode'],
17988
+ type: 'object',
17989
+ 'x-property-group-key': 'temperature_controllers',
17990
+ 'x-undocumented': 'Unreleased.',
17991
+ },
17811
17992
  warnings: {
17812
17993
  description: 'Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
17813
17994
  items: {
@@ -18295,6 +18476,29 @@ const openapi = {
18295
18476
  type: 'object',
18296
18477
  'x-variant-group-key': 'locks',
18297
18478
  },
18479
+ {
18480
+ description: 'Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back.',
18481
+ properties: {
18482
+ created_at: {
18483
+ description: 'Date and time at which Seam created the warning.',
18484
+ format: 'date-time',
18485
+ type: 'string',
18486
+ },
18487
+ message: {
18488
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
18489
+ type: 'string',
18490
+ },
18491
+ warning_code: {
18492
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
18493
+ enum: ['service_mode'],
18494
+ type: 'string',
18495
+ },
18496
+ },
18497
+ required: ['message', 'created_at', 'warning_code'],
18498
+ type: 'object',
18499
+ 'x-undocumented': 'Unreleased.',
18500
+ 'x-variant-group-key': 'pools',
18501
+ },
18298
18502
  {
18299
18503
  description: 'Indicates a provider-specific issue that may affect device functionality.',
18300
18504
  properties: {
@@ -18471,6 +18675,7 @@ const openapi = {
18471
18675
  locks: { name: 'Locks' },
18472
18676
  noise_sensors: { name: 'Noise Sensors' },
18473
18677
  phones: { name: 'Phones' },
18678
+ pools: { name: 'Pools' },
18474
18679
  provider_metadata: { name: 'Provider Metadata' },
18475
18680
  thermostats: { name: 'Thermostats' },
18476
18681
  },
@@ -18503,9 +18708,11 @@ const openapi = {
18503
18708
  locks: { name: 'Locks' },
18504
18709
  noise_sensors: { name: 'Noise Sensors' },
18505
18710
  phones: { name: 'Phones' },
18711
+ pools: { name: 'Pools' },
18506
18712
  provider_metadata: { name: 'Provider Metadata' },
18507
18713
  sensors: { name: 'Sensors' },
18508
18714
  speakers: { name: 'Speakers' },
18715
+ temperature_controllers: { name: 'Temperature Controllers' },
18509
18716
  thermostats: { name: 'Thermostats' },
18510
18717
  },
18511
18718
  'x-route-path': '/devices',
@@ -18520,6 +18727,11 @@ const openapi = {
18520
18727
  description: 'Indicates whether the lock supports configuring automatic locking.',
18521
18728
  type: 'boolean',
18522
18729
  },
18730
+ can_control_temperature: {
18731
+ description: 'Indicates whether the device supports controlling its primary target temperature.',
18732
+ type: 'boolean',
18733
+ 'x-undocumented': 'Unreleased.',
18734
+ },
18523
18735
  can_hvac_cool: {
18524
18736
  description: 'Indicates whether the thermostat supports cooling.',
18525
18737
  type: 'boolean',
@@ -30280,6 +30492,7 @@ const openapi = {
30280
30492
  locks: { name: 'Locks' },
30281
30493
  noise_sensors: { name: 'Noise Sensors' },
30282
30494
  phones: { name: 'Phones' },
30495
+ pools: { name: 'Pools' },
30283
30496
  provider_metadata: { name: 'Provider Metadata' },
30284
30497
  thermostats: { name: 'Thermostats' },
30285
30498
  },
@@ -30818,6 +31031,29 @@ const openapi = {
30818
31031
  type: 'object',
30819
31032
  'x-variant-group-key': 'locks',
30820
31033
  },
31034
+ {
31035
+ description: 'Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back.',
31036
+ properties: {
31037
+ created_at: {
31038
+ description: 'Date and time at which Seam created the warning.',
31039
+ format: 'date-time',
31040
+ type: 'string',
31041
+ },
31042
+ message: {
31043
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
31044
+ type: 'string',
31045
+ },
31046
+ warning_code: {
31047
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
31048
+ enum: ['service_mode'],
31049
+ type: 'string',
31050
+ },
31051
+ },
31052
+ required: ['message', 'created_at', 'warning_code'],
31053
+ type: 'object',
31054
+ 'x-undocumented': 'Unreleased.',
31055
+ 'x-variant-group-key': 'pools',
31056
+ },
30821
31057
  {
30822
31058
  description: 'Indicates a provider-specific issue that may affect device functionality.',
30823
31059
  properties: {
@@ -30994,6 +31230,7 @@ const openapi = {
30994
31230
  locks: { name: 'Locks' },
30995
31231
  noise_sensors: { name: 'Noise Sensors' },
30996
31232
  phones: { name: 'Phones' },
31233
+ pools: { name: 'Pools' },
30997
31234
  provider_metadata: { name: 'Provider Metadata' },
30998
31235
  thermostats: { name: 'Thermostats' },
30999
31236
  },
@@ -36919,6 +37156,11 @@ const openapi = {
36919
37156
  description: 'Indicates whether the lock supports configuring automatic locking.',
36920
37157
  type: 'boolean',
36921
37158
  },
37159
+ can_control_temperature: {
37160
+ description: 'Indicates whether the device supports controlling its primary target temperature.',
37161
+ type: 'boolean',
37162
+ 'x-undocumented': 'Unreleased.',
37163
+ },
36922
37164
  can_hvac_cool: {
36923
37165
  description: 'Indicates whether the thermostat supports cooling.',
36924
37166
  type: 'boolean',
@@ -37050,6 +37292,7 @@ const openapi = {
37050
37292
  'thermostat',
37051
37293
  'battery',
37052
37294
  'phone',
37295
+ 'pool',
37053
37296
  ],
37054
37297
  type: 'string',
37055
37298
  },
@@ -37169,6 +37412,12 @@ const openapi = {
37169
37412
  enum: ['alertify_sensor'],
37170
37413
  type: 'string',
37171
37414
  },
37415
+ {
37416
+ description: 'Device type for pool controllers, pools, and spas.',
37417
+ enum: ['hayward_pool_system', 'hayward_pool'],
37418
+ type: 'string',
37419
+ 'x-undocumented': 'Unreleased.',
37420
+ },
37172
37421
  ],
37173
37422
  },
37174
37423
  display_name: {
@@ -37666,6 +37915,7 @@ const openapi = {
37666
37915
  locks: { name: 'Locks' },
37667
37916
  noise_sensors: { name: 'Noise Sensors' },
37668
37917
  phones: { name: 'Phones' },
37918
+ pools: { name: 'Pools' },
37669
37919
  provider_metadata: { name: 'Provider Metadata' },
37670
37920
  thermostats: { name: 'Thermostats' },
37671
37921
  },
@@ -38340,6 +38590,29 @@ const openapi = {
38340
38590
  type: 'object',
38341
38591
  'x-variant-group-key': 'locks',
38342
38592
  },
38593
+ {
38594
+ description: 'Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back.',
38595
+ properties: {
38596
+ created_at: {
38597
+ description: 'Date and time at which Seam created the warning.',
38598
+ format: 'date-time',
38599
+ type: 'string',
38600
+ },
38601
+ message: {
38602
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
38603
+ type: 'string',
38604
+ },
38605
+ warning_code: {
38606
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
38607
+ enum: ['service_mode'],
38608
+ type: 'string',
38609
+ },
38610
+ },
38611
+ required: ['message', 'created_at', 'warning_code'],
38612
+ type: 'object',
38613
+ 'x-undocumented': 'Unreleased.',
38614
+ 'x-variant-group-key': 'pools',
38615
+ },
38343
38616
  {
38344
38617
  description: 'Indicates a provider-specific issue that may affect device functionality.',
38345
38618
  properties: {
@@ -38516,6 +38789,7 @@ const openapi = {
38516
38789
  locks: { name: 'Locks' },
38517
38790
  noise_sensors: { name: 'Noise Sensors' },
38518
38791
  phones: { name: 'Phones' },
38792
+ pools: { name: 'Pools' },
38519
38793
  provider_metadata: { name: 'Provider Metadata' },
38520
38794
  thermostats: { name: 'Thermostats' },
38521
38795
  },
@@ -47289,6 +47563,7 @@ const openapi = {
47289
47563
  'access_control',
47290
47564
  'camera',
47291
47565
  'speaker',
47566
+ 'pool',
47292
47567
  ],
47293
47568
  type: 'string',
47294
47569
  },
@@ -48042,6 +48317,7 @@ const openapi = {
48042
48317
  'access_control',
48043
48318
  'camera',
48044
48319
  'speaker',
48320
+ 'pool',
48045
48321
  ],
48046
48322
  type: 'string',
48047
48323
  },
@@ -50972,6 +51248,12 @@ const openapi = {
50972
51248
  enum: ['alertify_sensor'],
50973
51249
  type: 'string',
50974
51250
  },
51251
+ {
51252
+ description: 'Device type for pool controllers, pools, and spas.',
51253
+ enum: ['hayward_pool_system', 'hayward_pool'],
51254
+ type: 'string',
51255
+ 'x-undocumented': 'Unreleased.',
51256
+ },
50975
51257
  ],
50976
51258
  },
50977
51259
  },
@@ -51071,6 +51353,12 @@ const openapi = {
51071
51353
  enum: ['alertify_sensor'],
51072
51354
  type: 'string',
51073
51355
  },
51356
+ {
51357
+ description: 'Device type for pool controllers, pools, and spas.',
51358
+ enum: ['hayward_pool_system', 'hayward_pool'],
51359
+ type: 'string',
51360
+ 'x-undocumented': 'Unreleased.',
51361
+ },
51074
51362
  ],
51075
51363
  },
51076
51364
  type: 'array',
@@ -51242,6 +51530,7 @@ const openapi = {
51242
51530
  'can_play_speaker_chime',
51243
51531
  'can_play_speaker_favorite',
51244
51532
  'can_play_speaker_audio_clip',
51533
+ 'can_control_temperature',
51245
51534
  ],
51246
51535
  type: 'string',
51247
51536
  },
@@ -51285,6 +51574,7 @@ const openapi = {
51285
51574
  'can_play_speaker_chime',
51286
51575
  'can_play_speaker_favorite',
51287
51576
  'can_play_speaker_audio_clip',
51577
+ 'can_control_temperature',
51288
51578
  ],
51289
51579
  type: 'string',
51290
51580
  },
@@ -51321,6 +51611,16 @@ const openapi = {
51321
51611
  type: 'string',
51322
51612
  },
51323
51613
  },
51614
+ {
51615
+ in: 'query',
51616
+ name: 'parent_device_id',
51617
+ schema: {
51618
+ description: 'ID of the parent device whose child devices you want to list.',
51619
+ format: 'uuid',
51620
+ type: 'string',
51621
+ 'x-undocumented': 'Unreleased.',
51622
+ },
51623
+ },
51324
51624
  ],
51325
51625
  responses: {
51326
51626
  '200': {
@@ -53311,6 +53611,12 @@ const openapi = {
53311
53611
  enum: ['alertify_sensor'],
53312
53612
  type: 'string',
53313
53613
  },
53614
+ {
53615
+ description: 'Device type for pool controllers, pools, and spas.',
53616
+ enum: ['hayward_pool_system', 'hayward_pool'],
53617
+ type: 'string',
53618
+ 'x-undocumented': 'Unreleased.',
53619
+ },
53314
53620
  ],
53315
53621
  },
53316
53622
  },
@@ -53410,6 +53716,12 @@ const openapi = {
53410
53716
  enum: ['alertify_sensor'],
53411
53717
  type: 'string',
53412
53718
  },
53719
+ {
53720
+ description: 'Device type for pool controllers, pools, and spas.',
53721
+ enum: ['hayward_pool_system', 'hayward_pool'],
53722
+ type: 'string',
53723
+ 'x-undocumented': 'Unreleased.',
53724
+ },
53413
53725
  ],
53414
53726
  },
53415
53727
  type: 'array',
@@ -53550,6 +53862,7 @@ const openapi = {
53550
53862
  'can_play_speaker_chime',
53551
53863
  'can_play_speaker_favorite',
53552
53864
  'can_play_speaker_audio_clip',
53865
+ 'can_control_temperature',
53553
53866
  ],
53554
53867
  type: 'string',
53555
53868
  },
@@ -53593,6 +53906,7 @@ const openapi = {
53593
53906
  'can_play_speaker_chime',
53594
53907
  'can_play_speaker_favorite',
53595
53908
  'can_play_speaker_audio_clip',
53909
+ 'can_control_temperature',
53596
53910
  ],
53597
53911
  type: 'string',
53598
53912
  },
@@ -53609,6 +53923,16 @@ const openapi = {
53609
53923
  type: 'string',
53610
53924
  },
53611
53925
  },
53926
+ {
53927
+ in: 'query',
53928
+ name: 'parent_device_id',
53929
+ schema: {
53930
+ description: 'ID of the parent device whose child devices you want to list.',
53931
+ format: 'uuid',
53932
+ type: 'string',
53933
+ 'x-undocumented': 'Unreleased.',
53934
+ },
53935
+ },
53612
53936
  {
53613
53937
  in: 'query',
53614
53938
  name: 'limit',
@@ -56040,6 +56364,230 @@ const openapi = {
56040
56364
  'x-title': 'Create a Sandbox Phone',
56041
56365
  },
56042
56366
  },
56367
+ '/pools/heat': {
56368
+ post: {
56369
+ description: "Requests heating of specified pool or spa water to a set point. The set point must be within the range reported by the device's `properties.min_heating_set_point_*` and `properties.max_heating_set_point_*` fields. The returned action attempt stays `pending` until the pool controller reports the requested state back, which can take up to 90 seconds, and fails with `pool_heating_confirmation_timeout` if it never does. To check whether the water supports temperature control, use `device.can_control_temperature`.",
56370
+ operationId: 'poolsHeatPost',
56371
+ requestBody: {
56372
+ content: {
56373
+ 'application/json': {
56374
+ schema: {
56375
+ properties: {
56376
+ device_id: {
56377
+ description: 'ID of the device for the pool or spa water that you want to heat.',
56378
+ format: 'uuid',
56379
+ type: 'string',
56380
+ },
56381
+ heating_set_point_celsius: {
56382
+ description: 'Target water temperature in °C. Provide exactly one of `heating_set_point_celsius` and `heating_set_point_fahrenheit`.',
56383
+ format: 'float',
56384
+ type: 'number',
56385
+ },
56386
+ heating_set_point_fahrenheit: {
56387
+ description: 'Target water temperature in °F. Provide exactly one of `heating_set_point_celsius` and `heating_set_point_fahrenheit`.',
56388
+ format: 'float',
56389
+ type: 'number',
56390
+ },
56391
+ },
56392
+ required: ['device_id'],
56393
+ type: 'object',
56394
+ },
56395
+ },
56396
+ },
56397
+ },
56398
+ responses: {
56399
+ '200': {
56400
+ content: {
56401
+ 'application/json': {
56402
+ schema: {
56403
+ properties: {
56404
+ action_attempt: {
56405
+ $ref: '#/components/schemas/action_attempt',
56406
+ },
56407
+ ok: { type: 'boolean' },
56408
+ },
56409
+ required: ['action_attempt', 'ok'],
56410
+ type: 'object',
56411
+ },
56412
+ },
56413
+ },
56414
+ description: 'OK',
56415
+ },
56416
+ '400': { description: 'Bad Request' },
56417
+ '401': { description: 'Unauthorized' },
56418
+ },
56419
+ security: [
56420
+ { client_session: [] },
56421
+ { pat_with_workspace: [] },
56422
+ { console_session_with_workspace: [] },
56423
+ { api_key: [] },
56424
+ ],
56425
+ summary: '/pools/heat',
56426
+ tags: [],
56427
+ 'x-action-attempt-type': 'SET_POOL_HEATING',
56428
+ 'x-fern-sdk-group-name': ['pools'],
56429
+ 'x-fern-sdk-method-name': 'heat',
56430
+ 'x-fern-sdk-return-value': 'action_attempt',
56431
+ 'x-response-key': 'action_attempt',
56432
+ 'x-title': 'Heat a Pool or Spa',
56433
+ 'x-undocumented': 'Unreleased.',
56434
+ },
56435
+ },
56436
+ '/pools/list': {
56437
+ get: {
56438
+ description: 'Returns a list of all pool controllers, pools, and spas. Each controller lists its pools and spas in `child_device_ids`, and each pool or spa carries its controller in `parent_device_id`.',
56439
+ operationId: 'poolsListGet',
56440
+ parameters: [
56441
+ {
56442
+ in: 'query',
56443
+ name: 'customer_key',
56444
+ schema: {
56445
+ description: 'Customer key for which you want to list devices.',
56446
+ minLength: 1,
56447
+ type: 'string',
56448
+ },
56449
+ },
56450
+ {
56451
+ in: 'query',
56452
+ name: 'connected_account_id',
56453
+ schema: {
56454
+ description: 'ID of the connected account for which you want to list devices.',
56455
+ format: 'uuid',
56456
+ type: 'string',
56457
+ },
56458
+ },
56459
+ {
56460
+ in: 'query',
56461
+ name: 'connect_webview_id',
56462
+ schema: {
56463
+ description: 'ID of the Connect Webview for which you want to list devices.',
56464
+ format: 'uuid',
56465
+ type: 'string',
56466
+ },
56467
+ },
56468
+ {
56469
+ in: 'query',
56470
+ name: 'device_type',
56471
+ schema: {
56472
+ description: 'Device type by which you want to filter pool devices.',
56473
+ enum: ['hayward_pool_system', 'hayward_pool'],
56474
+ type: 'string',
56475
+ 'x-undocumented': 'Unreleased.',
56476
+ },
56477
+ },
56478
+ {
56479
+ in: 'query',
56480
+ name: 'device_types',
56481
+ schema: {
56482
+ description: 'Array of device types by which you want to filter pool devices.',
56483
+ items: {
56484
+ description: 'Device type for pool controllers, pools, and spas.',
56485
+ enum: ['hayward_pool_system', 'hayward_pool'],
56486
+ type: 'string',
56487
+ 'x-undocumented': 'Unreleased.',
56488
+ },
56489
+ type: 'array',
56490
+ },
56491
+ },
56492
+ ],
56493
+ responses: {
56494
+ '200': {
56495
+ content: {
56496
+ 'application/json': {
56497
+ schema: {
56498
+ properties: {
56499
+ devices: {
56500
+ items: { $ref: '#/components/schemas/device' },
56501
+ type: 'array',
56502
+ },
56503
+ ok: { type: 'boolean' },
56504
+ },
56505
+ required: ['devices', 'ok'],
56506
+ type: 'object',
56507
+ },
56508
+ },
56509
+ },
56510
+ description: 'OK',
56511
+ },
56512
+ '400': { description: 'Bad Request' },
56513
+ '401': { description: 'Unauthorized' },
56514
+ },
56515
+ security: [
56516
+ { api_key: [] },
56517
+ { pat_with_workspace: [] },
56518
+ { console_session_with_workspace: [] },
56519
+ { client_session: [] },
56520
+ { support_read_only_token: [] },
56521
+ ],
56522
+ summary: '/pools/list',
56523
+ tags: [],
56524
+ 'x-fern-sdk-group-name': ['pools'],
56525
+ 'x-fern-sdk-method-name': 'list',
56526
+ 'x-fern-sdk-return-value': 'devices',
56527
+ 'x-response-key': 'devices',
56528
+ 'x-title': 'List Pool Devices',
56529
+ 'x-undocumented': 'Unreleased.',
56530
+ },
56531
+ },
56532
+ '/pools/turn_off': {
56533
+ post: {
56534
+ description: 'Turns off the temperature controller of specified pool or spa water. The set point is left unchanged, and other equipment such as pumps, lights, and chlorinators is not affected. The returned action attempt stays `pending` until the pool controller reports temperature control as off, which can take up to 90 seconds, and fails with `pool_heating_confirmation_timeout` if it never does. To check whether the water supports temperature control, use `device.can_control_temperature`.',
56535
+ operationId: 'poolsTurnOffPost',
56536
+ requestBody: {
56537
+ content: {
56538
+ 'application/json': {
56539
+ schema: {
56540
+ properties: {
56541
+ device_id: {
56542
+ description: 'ID of the device for the pool or spa water whose temperature control you want to turn off.',
56543
+ format: 'uuid',
56544
+ type: 'string',
56545
+ },
56546
+ },
56547
+ required: ['device_id'],
56548
+ type: 'object',
56549
+ },
56550
+ },
56551
+ },
56552
+ },
56553
+ responses: {
56554
+ '200': {
56555
+ content: {
56556
+ 'application/json': {
56557
+ schema: {
56558
+ properties: {
56559
+ action_attempt: {
56560
+ $ref: '#/components/schemas/action_attempt',
56561
+ },
56562
+ ok: { type: 'boolean' },
56563
+ },
56564
+ required: ['action_attempt', 'ok'],
56565
+ type: 'object',
56566
+ },
56567
+ },
56568
+ },
56569
+ description: 'OK',
56570
+ },
56571
+ '400': { description: 'Bad Request' },
56572
+ '401': { description: 'Unauthorized' },
56573
+ },
56574
+ security: [
56575
+ { client_session: [] },
56576
+ { pat_with_workspace: [] },
56577
+ { console_session_with_workspace: [] },
56578
+ { api_key: [] },
56579
+ ],
56580
+ summary: '/pools/turn_off',
56581
+ tags: [],
56582
+ 'x-action-attempt-type': 'SET_POOL_HEATING',
56583
+ 'x-fern-sdk-group-name': ['pools'],
56584
+ 'x-fern-sdk-method-name': 'turn_off',
56585
+ 'x-fern-sdk-return-value': 'action_attempt',
56586
+ 'x-response-key': 'action_attempt',
56587
+ 'x-title': 'Turn Off Temperature Control of a Pool or Spa',
56588
+ 'x-undocumented': 'Unreleased.',
56589
+ },
56590
+ },
56043
56591
  '/seam/bridge/v1/bridge_client_sessions/create': {
56044
56592
  post: {
56045
56593
  description: 'Creates a new [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge) client session.',