@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
@@ -13000,6 +13000,127 @@ const openapi: OpenAPISpec = {
13000
13000
  type: 'object',
13001
13001
  'x-undocumented': 'Unreleased.',
13002
13002
  },
13003
+ {
13004
+ description:
13005
+ 'Setting the pool heating is pending. The controller has not yet reported the requested state back.',
13006
+ properties: {
13007
+ action_attempt_id: {
13008
+ description: 'ID of the action attempt.',
13009
+ format: 'uuid',
13010
+ type: 'string',
13011
+ },
13012
+ action_type: {
13013
+ description:
13014
+ '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.',
13015
+ enum: ['SET_POOL_HEATING'],
13016
+ type: 'string',
13017
+ 'x-undocumented': 'Unreleased.',
13018
+ },
13019
+ error: {
13020
+ description:
13021
+ 'Errors associated with the action attempt. Null for pending action attempts.',
13022
+ nullable: true,
13023
+ },
13024
+ result: {
13025
+ description:
13026
+ 'Result of the action attempt. Null for pending action attempts.',
13027
+ nullable: true,
13028
+ },
13029
+ status: { enum: ['pending'], type: 'string' },
13030
+ },
13031
+ required: [
13032
+ 'action_attempt_id',
13033
+ 'status',
13034
+ 'result',
13035
+ 'error',
13036
+ 'action_type',
13037
+ ],
13038
+ type: 'object',
13039
+ 'x-undocumented': 'Unreleased.',
13040
+ },
13041
+ {
13042
+ description:
13043
+ 'Setting the pool heating succeeded. The controller reported the requested state back.',
13044
+ properties: {
13045
+ action_attempt_id: {
13046
+ description: 'ID of the action attempt.',
13047
+ format: 'uuid',
13048
+ type: 'string',
13049
+ },
13050
+ action_type: {
13051
+ description:
13052
+ '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.',
13053
+ enum: ['SET_POOL_HEATING'],
13054
+ type: 'string',
13055
+ 'x-undocumented': 'Unreleased.',
13056
+ },
13057
+ error: {
13058
+ description:
13059
+ 'Errors associated with the action attempt. Null for successful action attempts.',
13060
+ nullable: true,
13061
+ },
13062
+ result: {
13063
+ description: 'Result of the action.',
13064
+ properties: {},
13065
+ type: 'object',
13066
+ },
13067
+ status: { enum: ['success'], type: 'string' },
13068
+ },
13069
+ required: [
13070
+ 'action_attempt_id',
13071
+ 'status',
13072
+ 'error',
13073
+ 'action_type',
13074
+ 'result',
13075
+ ],
13076
+ type: 'object',
13077
+ 'x-undocumented': 'Unreleased.',
13078
+ },
13079
+ {
13080
+ description: 'Setting the pool heating failed.',
13081
+ properties: {
13082
+ action_attempt_id: {
13083
+ description: 'ID of the action attempt.',
13084
+ format: 'uuid',
13085
+ type: 'string',
13086
+ },
13087
+ action_type: {
13088
+ description:
13089
+ '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.',
13090
+ enum: ['SET_POOL_HEATING'],
13091
+ type: 'string',
13092
+ 'x-undocumented': 'Unreleased.',
13093
+ },
13094
+ error: {
13095
+ description: 'Error associated with the action.',
13096
+ properties: {
13097
+ message: {
13098
+ description:
13099
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13100
+ type: 'string',
13101
+ },
13102
+ type: { description: 'Type of the error.', type: 'string' },
13103
+ },
13104
+ required: ['type', 'message'],
13105
+ type: 'object',
13106
+ },
13107
+ result: {
13108
+ description:
13109
+ 'Result of the action attempt. Null for failed action attempts.',
13110
+ nullable: true,
13111
+ },
13112
+ status: { enum: ['error'], type: 'string' },
13113
+ },
13114
+ required: [
13115
+ 'action_attempt_id',
13116
+ 'status',
13117
+ 'result',
13118
+ 'action_type',
13119
+ 'error',
13120
+ ],
13121
+ type: 'object',
13122
+ 'x-undocumented': 'Unreleased.',
13123
+ },
13003
13124
  {
13004
13125
  properties: {
13005
13126
  action_attempt_id: {
@@ -14315,6 +14436,7 @@ const openapi: OpenAPISpec = {
14315
14436
  'access_control',
14316
14437
  'camera',
14317
14438
  'speaker',
14439
+ 'pool',
14318
14440
  ],
14319
14441
  type: 'string',
14320
14442
  },
@@ -14483,6 +14605,7 @@ const openapi: OpenAPISpec = {
14483
14605
  'access_control',
14484
14606
  'camera',
14485
14607
  'speaker',
14608
+ 'pool',
14486
14609
  ],
14487
14610
  type: 'string',
14488
14611
  },
@@ -15723,6 +15846,12 @@ const openapi: OpenAPISpec = {
15723
15846
  'Indicates whether the lock supports configuring automatic locking.',
15724
15847
  type: 'boolean',
15725
15848
  },
15849
+ can_control_temperature: {
15850
+ description:
15851
+ 'Indicates whether the device supports controlling its primary target temperature.',
15852
+ type: 'boolean',
15853
+ 'x-undocumented': 'Unreleased.',
15854
+ },
15726
15855
  can_hvac_cool: {
15727
15856
  description: 'Indicates whether the thermostat supports cooling.',
15728
15857
  type: 'boolean',
@@ -15879,11 +16008,19 @@ const openapi: OpenAPISpec = {
15879
16008
  'thermostat',
15880
16009
  'battery',
15881
16010
  'phone',
16011
+ 'pool',
15882
16012
  ],
15883
16013
  type: 'string',
15884
16014
  },
15885
16015
  type: 'array',
15886
16016
  },
16017
+ child_device_ids: {
16018
+ description:
16019
+ 'IDs of the child devices that belong to this device. Only present when the device has at least one child.',
16020
+ items: { format: 'uuid', type: 'string' },
16021
+ type: 'array',
16022
+ 'x-undocumented': 'Unreleased.',
16023
+ },
15887
16024
  co2_ppm: {
15888
16025
  description:
15889
16026
  'Carbon dioxide concentration in parts per million, if the device measures it.',
@@ -16072,6 +16209,13 @@ const openapi: OpenAPISpec = {
16072
16209
  enum: ['alertify_sensor'],
16073
16210
  type: 'string',
16074
16211
  },
16212
+ {
16213
+ description:
16214
+ 'Device type for pool controllers, pools, and spas.',
16215
+ enum: ['hayward_pool_system', 'hayward_pool'],
16216
+ type: 'string',
16217
+ 'x-undocumented': 'Unreleased.',
16218
+ },
16075
16219
  ],
16076
16220
  },
16077
16221
  display_name: {
@@ -16639,6 +16783,7 @@ const openapi: OpenAPISpec = {
16639
16783
  locks: { name: 'Locks' },
16640
16784
  noise_sensors: { name: 'Noise Sensors' },
16641
16785
  phones: { name: 'Phones' },
16786
+ pools: { name: 'Pools' },
16642
16787
  provider_metadata: { name: 'Provider Metadata' },
16643
16788
  thermostats: { name: 'Thermostats' },
16644
16789
  },
@@ -16673,6 +16818,20 @@ const openapi: OpenAPISpec = {
16673
16818
  type: 'boolean',
16674
16819
  'x-property-group-key': 'sensors',
16675
16820
  },
16821
+ is_spa: {
16822
+ description:
16823
+ 'Indicates whether the device represents spa water rather than pool water. Present only on pool and spa devices.',
16824
+ type: 'boolean',
16825
+ 'x-property-group-key': 'pools',
16826
+ 'x-undocumented': 'Unreleased.',
16827
+ },
16828
+ is_water_circulating: {
16829
+ description:
16830
+ 'Indicates whether the water is circulating. Temperature readings are only live while it is circulating. Omitted if the controller does not report it.',
16831
+ type: 'boolean',
16832
+ 'x-property-group-key': 'pools',
16833
+ 'x-undocumented': 'Unreleased.',
16834
+ },
16676
16835
  location: {
16677
16836
  description: 'Location information for the device.',
16678
16837
  properties: {
@@ -16840,6 +16999,13 @@ const openapi: OpenAPISpec = {
16840
16999
  type: 'number',
16841
17000
  'x-property-group-key': 'sensors',
16842
17001
  },
17002
+ parent_device_id: {
17003
+ description:
17004
+ '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.',
17005
+ format: 'uuid',
17006
+ type: 'string',
17007
+ 'x-undocumented': 'Unreleased.',
17008
+ },
16843
17009
  properties: {
16844
17010
  allOf: [
16845
17011
  {
@@ -20059,6 +20225,14 @@ const openapi: OpenAPISpec = {
20059
20225
  type: 'number',
20060
20226
  'x-property-group-key': 'sensors',
20061
20227
  },
20228
+ salt_ppm: {
20229
+ description:
20230
+ 'Salt level reported by the chlorinator, in parts per million. Omitted if the system has no salt chlorinator.',
20231
+ format: 'float',
20232
+ type: 'number',
20233
+ 'x-property-group-key': 'pools',
20234
+ 'x-undocumented': 'Unreleased.',
20235
+ },
20062
20236
  space_ids: {
20063
20237
  description: 'IDs of the spaces the device is in.',
20064
20238
  items: { format: 'uuid', type: 'string' },
@@ -20078,6 +20252,34 @@ const openapi: OpenAPISpec = {
20078
20252
  type: 'number',
20079
20253
  'x-property-group-key': 'sensors',
20080
20254
  },
20255
+ temperature_setting: {
20256
+ description:
20257
+ "Current setting of the device's primary temperature controller.",
20258
+ properties: {
20259
+ controller_mode: {
20260
+ description:
20261
+ "Operating mode requested from the device's primary temperature controller.",
20262
+ enum: ['heat', 'off'],
20263
+ type: 'string',
20264
+ },
20265
+ heating_set_point_celsius: {
20266
+ description:
20267
+ 'Temperature to which the controller should heat, in °C. The controller can retain this value while it is off.',
20268
+ format: 'float',
20269
+ type: 'number',
20270
+ },
20271
+ heating_set_point_fahrenheit: {
20272
+ description:
20273
+ 'Temperature to which the controller should heat, in °F. The controller can retain this value while it is off.',
20274
+ format: 'float',
20275
+ type: 'number',
20276
+ },
20277
+ },
20278
+ required: ['controller_mode'],
20279
+ type: 'object',
20280
+ 'x-property-group-key': 'temperature_controllers',
20281
+ 'x-undocumented': 'Unreleased.',
20282
+ },
20081
20283
  warnings: {
20082
20284
  description:
20083
20285
  '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.',
@@ -20653,6 +20855,33 @@ const openapi: OpenAPISpec = {
20653
20855
  type: 'object',
20654
20856
  'x-variant-group-key': 'locks',
20655
20857
  },
20858
+ {
20859
+ description:
20860
+ 'Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back.',
20861
+ properties: {
20862
+ created_at: {
20863
+ description:
20864
+ 'Date and time at which Seam created the warning.',
20865
+ format: 'date-time',
20866
+ type: 'string',
20867
+ },
20868
+ message: {
20869
+ description:
20870
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20871
+ type: 'string',
20872
+ },
20873
+ warning_code: {
20874
+ description:
20875
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20876
+ enum: ['service_mode'],
20877
+ type: 'string',
20878
+ },
20879
+ },
20880
+ required: ['message', 'created_at', 'warning_code'],
20881
+ type: 'object',
20882
+ 'x-undocumented': 'Unreleased.',
20883
+ 'x-variant-group-key': 'pools',
20884
+ },
20656
20885
  {
20657
20886
  description:
20658
20887
  'Indicates a provider-specific issue that may affect device functionality.',
@@ -20859,6 +21088,7 @@ const openapi: OpenAPISpec = {
20859
21088
  locks: { name: 'Locks' },
20860
21089
  noise_sensors: { name: 'Noise Sensors' },
20861
21090
  phones: { name: 'Phones' },
21091
+ pools: { name: 'Pools' },
20862
21092
  provider_metadata: { name: 'Provider Metadata' },
20863
21093
  thermostats: { name: 'Thermostats' },
20864
21094
  },
@@ -20892,9 +21122,11 @@ const openapi: OpenAPISpec = {
20892
21122
  locks: { name: 'Locks' },
20893
21123
  noise_sensors: { name: 'Noise Sensors' },
20894
21124
  phones: { name: 'Phones' },
21125
+ pools: { name: 'Pools' },
20895
21126
  provider_metadata: { name: 'Provider Metadata' },
20896
21127
  sensors: { name: 'Sensors' },
20897
21128
  speakers: { name: 'Speakers' },
21129
+ temperature_controllers: { name: 'Temperature Controllers' },
20898
21130
  thermostats: { name: 'Thermostats' },
20899
21131
  },
20900
21132
  'x-route-path': '/devices',
@@ -20911,6 +21143,12 @@ const openapi: OpenAPISpec = {
20911
21143
  'Indicates whether the lock supports configuring automatic locking.',
20912
21144
  type: 'boolean',
20913
21145
  },
21146
+ can_control_temperature: {
21147
+ description:
21148
+ 'Indicates whether the device supports controlling its primary target temperature.',
21149
+ type: 'boolean',
21150
+ 'x-undocumented': 'Unreleased.',
21151
+ },
20914
21152
  can_hvac_cool: {
20915
21153
  description: 'Indicates whether the thermostat supports cooling.',
20916
21154
  type: 'boolean',
@@ -33742,6 +33980,7 @@ const openapi: OpenAPISpec = {
33742
33980
  locks: { name: 'Locks' },
33743
33981
  noise_sensors: { name: 'Noise Sensors' },
33744
33982
  phones: { name: 'Phones' },
33983
+ pools: { name: 'Pools' },
33745
33984
  provider_metadata: { name: 'Provider Metadata' },
33746
33985
  thermostats: { name: 'Thermostats' },
33747
33986
  },
@@ -34374,6 +34613,33 @@ const openapi: OpenAPISpec = {
34374
34613
  type: 'object',
34375
34614
  'x-variant-group-key': 'locks',
34376
34615
  },
34616
+ {
34617
+ description:
34618
+ 'Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back.',
34619
+ properties: {
34620
+ created_at: {
34621
+ description:
34622
+ 'Date and time at which Seam created the warning.',
34623
+ format: 'date-time',
34624
+ type: 'string',
34625
+ },
34626
+ message: {
34627
+ description:
34628
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
34629
+ type: 'string',
34630
+ },
34631
+ warning_code: {
34632
+ description:
34633
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
34634
+ enum: ['service_mode'],
34635
+ type: 'string',
34636
+ },
34637
+ },
34638
+ required: ['message', 'created_at', 'warning_code'],
34639
+ type: 'object',
34640
+ 'x-undocumented': 'Unreleased.',
34641
+ 'x-variant-group-key': 'pools',
34642
+ },
34377
34643
  {
34378
34644
  description:
34379
34645
  'Indicates a provider-specific issue that may affect device functionality.',
@@ -34580,6 +34846,7 @@ const openapi: OpenAPISpec = {
34580
34846
  locks: { name: 'Locks' },
34581
34847
  noise_sensors: { name: 'Noise Sensors' },
34582
34848
  phones: { name: 'Phones' },
34849
+ pools: { name: 'Pools' },
34583
34850
  provider_metadata: { name: 'Provider Metadata' },
34584
34851
  thermostats: { name: 'Thermostats' },
34585
34852
  },
@@ -41323,6 +41590,12 @@ const openapi: OpenAPISpec = {
41323
41590
  'Indicates whether the lock supports configuring automatic locking.',
41324
41591
  type: 'boolean',
41325
41592
  },
41593
+ can_control_temperature: {
41594
+ description:
41595
+ 'Indicates whether the device supports controlling its primary target temperature.',
41596
+ type: 'boolean',
41597
+ 'x-undocumented': 'Unreleased.',
41598
+ },
41326
41599
  can_hvac_cool: {
41327
41600
  description: 'Indicates whether the thermostat supports cooling.',
41328
41601
  type: 'boolean',
@@ -41479,6 +41752,7 @@ const openapi: OpenAPISpec = {
41479
41752
  'thermostat',
41480
41753
  'battery',
41481
41754
  'phone',
41755
+ 'pool',
41482
41756
  ],
41483
41757
  type: 'string',
41484
41758
  },
@@ -41602,6 +41876,13 @@ const openapi: OpenAPISpec = {
41602
41876
  enum: ['alertify_sensor'],
41603
41877
  type: 'string',
41604
41878
  },
41879
+ {
41880
+ description:
41881
+ 'Device type for pool controllers, pools, and spas.',
41882
+ enum: ['hayward_pool_system', 'hayward_pool'],
41883
+ type: 'string',
41884
+ 'x-undocumented': 'Unreleased.',
41885
+ },
41605
41886
  ],
41606
41887
  },
41607
41888
  display_name: {
@@ -42169,6 +42450,7 @@ const openapi: OpenAPISpec = {
42169
42450
  locks: { name: 'Locks' },
42170
42451
  noise_sensors: { name: 'Noise Sensors' },
42171
42452
  phones: { name: 'Phones' },
42453
+ pools: { name: 'Pools' },
42172
42454
  provider_metadata: { name: 'Provider Metadata' },
42173
42455
  thermostats: { name: 'Thermostats' },
42174
42456
  },
@@ -42947,6 +43229,33 @@ const openapi: OpenAPISpec = {
42947
43229
  type: 'object',
42948
43230
  'x-variant-group-key': 'locks',
42949
43231
  },
43232
+ {
43233
+ description:
43234
+ 'Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back.',
43235
+ properties: {
43236
+ created_at: {
43237
+ description:
43238
+ 'Date and time at which Seam created the warning.',
43239
+ format: 'date-time',
43240
+ type: 'string',
43241
+ },
43242
+ message: {
43243
+ description:
43244
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
43245
+ type: 'string',
43246
+ },
43247
+ warning_code: {
43248
+ description:
43249
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
43250
+ enum: ['service_mode'],
43251
+ type: 'string',
43252
+ },
43253
+ },
43254
+ required: ['message', 'created_at', 'warning_code'],
43255
+ type: 'object',
43256
+ 'x-undocumented': 'Unreleased.',
43257
+ 'x-variant-group-key': 'pools',
43258
+ },
42950
43259
  {
42951
43260
  description:
42952
43261
  'Indicates a provider-specific issue that may affect device functionality.',
@@ -43153,6 +43462,7 @@ const openapi: OpenAPISpec = {
43153
43462
  locks: { name: 'Locks' },
43154
43463
  noise_sensors: { name: 'Noise Sensors' },
43155
43464
  phones: { name: 'Phones' },
43465
+ pools: { name: 'Pools' },
43156
43466
  provider_metadata: { name: 'Provider Metadata' },
43157
43467
  thermostats: { name: 'Thermostats' },
43158
43468
  },
@@ -52455,6 +52765,7 @@ const openapi: OpenAPISpec = {
52455
52765
  'access_control',
52456
52766
  'camera',
52457
52767
  'speaker',
52768
+ 'pool',
52458
52769
  ],
52459
52770
  type: 'string',
52460
52771
  },
@@ -53243,6 +53554,7 @@ const openapi: OpenAPISpec = {
53243
53554
  'access_control',
53244
53555
  'camera',
53245
53556
  'speaker',
53557
+ 'pool',
53246
53558
  ],
53247
53559
  type: 'string',
53248
53560
  },
@@ -56527,6 +56839,13 @@ const openapi: OpenAPISpec = {
56527
56839
  enum: ['alertify_sensor'],
56528
56840
  type: 'string',
56529
56841
  },
56842
+ {
56843
+ description:
56844
+ 'Device type for pool controllers, pools, and spas.',
56845
+ enum: ['hayward_pool_system', 'hayward_pool'],
56846
+ type: 'string',
56847
+ 'x-undocumented': 'Unreleased.',
56848
+ },
56530
56849
  ],
56531
56850
  },
56532
56851
  },
@@ -56627,6 +56946,13 @@ const openapi: OpenAPISpec = {
56627
56946
  enum: ['alertify_sensor'],
56628
56947
  type: 'string',
56629
56948
  },
56949
+ {
56950
+ description:
56951
+ 'Device type for pool controllers, pools, and spas.',
56952
+ enum: ['hayward_pool_system', 'hayward_pool'],
56953
+ type: 'string',
56954
+ 'x-undocumented': 'Unreleased.',
56955
+ },
56630
56956
  ],
56631
56957
  },
56632
56958
  type: 'array',
@@ -56804,6 +57130,7 @@ const openapi: OpenAPISpec = {
56804
57130
  'can_play_speaker_chime',
56805
57131
  'can_play_speaker_favorite',
56806
57132
  'can_play_speaker_audio_clip',
57133
+ 'can_control_temperature',
56807
57134
  ],
56808
57135
  type: 'string',
56809
57136
  },
@@ -56847,6 +57174,7 @@ const openapi: OpenAPISpec = {
56847
57174
  'can_play_speaker_chime',
56848
57175
  'can_play_speaker_favorite',
56849
57176
  'can_play_speaker_audio_clip',
57177
+ 'can_control_temperature',
56850
57178
  ],
56851
57179
  type: 'string',
56852
57180
  },
@@ -56885,6 +57213,17 @@ const openapi: OpenAPISpec = {
56885
57213
  type: 'string',
56886
57214
  },
56887
57215
  },
57216
+ {
57217
+ in: 'query',
57218
+ name: 'parent_device_id',
57219
+ schema: {
57220
+ description:
57221
+ 'ID of the parent device whose child devices you want to list.',
57222
+ format: 'uuid',
57223
+ type: 'string',
57224
+ 'x-undocumented': 'Unreleased.',
57225
+ },
57226
+ },
56888
57227
  ],
56889
57228
  responses: {
56890
57229
  '200': {
@@ -58896,6 +59235,13 @@ const openapi: OpenAPISpec = {
58896
59235
  enum: ['alertify_sensor'],
58897
59236
  type: 'string',
58898
59237
  },
59238
+ {
59239
+ description:
59240
+ 'Device type for pool controllers, pools, and spas.',
59241
+ enum: ['hayward_pool_system', 'hayward_pool'],
59242
+ type: 'string',
59243
+ 'x-undocumented': 'Unreleased.',
59244
+ },
58899
59245
  ],
58900
59246
  },
58901
59247
  },
@@ -58996,6 +59342,13 @@ const openapi: OpenAPISpec = {
58996
59342
  enum: ['alertify_sensor'],
58997
59343
  type: 'string',
58998
59344
  },
59345
+ {
59346
+ description:
59347
+ 'Device type for pool controllers, pools, and spas.',
59348
+ enum: ['hayward_pool_system', 'hayward_pool'],
59349
+ type: 'string',
59350
+ 'x-undocumented': 'Unreleased.',
59351
+ },
58999
59352
  ],
59000
59353
  },
59001
59354
  type: 'array',
@@ -59139,6 +59492,7 @@ const openapi: OpenAPISpec = {
59139
59492
  'can_play_speaker_chime',
59140
59493
  'can_play_speaker_favorite',
59141
59494
  'can_play_speaker_audio_clip',
59495
+ 'can_control_temperature',
59142
59496
  ],
59143
59497
  type: 'string',
59144
59498
  },
@@ -59182,6 +59536,7 @@ const openapi: OpenAPISpec = {
59182
59536
  'can_play_speaker_chime',
59183
59537
  'can_play_speaker_favorite',
59184
59538
  'can_play_speaker_audio_clip',
59539
+ 'can_control_temperature',
59185
59540
  ],
59186
59541
  type: 'string',
59187
59542
  },
@@ -59199,6 +59554,17 @@ const openapi: OpenAPISpec = {
59199
59554
  type: 'string',
59200
59555
  },
59201
59556
  },
59557
+ {
59558
+ in: 'query',
59559
+ name: 'parent_device_id',
59560
+ schema: {
59561
+ description:
59562
+ 'ID of the parent device whose child devices you want to list.',
59563
+ format: 'uuid',
59564
+ type: 'string',
59565
+ 'x-undocumented': 'Unreleased.',
59566
+ },
59567
+ },
59202
59568
  {
59203
59569
  in: 'query',
59204
59570
  name: 'limit',
@@ -61734,6 +62100,242 @@ const openapi: OpenAPISpec = {
61734
62100
  'x-title': 'Create a Sandbox Phone',
61735
62101
  },
61736
62102
  },
62103
+ '/pools/heat': {
62104
+ post: {
62105
+ description:
62106
+ "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`.",
62107
+ operationId: 'poolsHeatPost',
62108
+ requestBody: {
62109
+ content: {
62110
+ 'application/json': {
62111
+ schema: {
62112
+ properties: {
62113
+ device_id: {
62114
+ description:
62115
+ 'ID of the device for the pool or spa water that you want to heat.',
62116
+ format: 'uuid',
62117
+ type: 'string',
62118
+ },
62119
+ heating_set_point_celsius: {
62120
+ description:
62121
+ 'Target water temperature in °C. Provide exactly one of `heating_set_point_celsius` and `heating_set_point_fahrenheit`.',
62122
+ format: 'float',
62123
+ type: 'number',
62124
+ },
62125
+ heating_set_point_fahrenheit: {
62126
+ description:
62127
+ 'Target water temperature in °F. Provide exactly one of `heating_set_point_celsius` and `heating_set_point_fahrenheit`.',
62128
+ format: 'float',
62129
+ type: 'number',
62130
+ },
62131
+ },
62132
+ required: ['device_id'],
62133
+ type: 'object',
62134
+ },
62135
+ },
62136
+ },
62137
+ },
62138
+ responses: {
62139
+ '200': {
62140
+ content: {
62141
+ 'application/json': {
62142
+ schema: {
62143
+ properties: {
62144
+ action_attempt: {
62145
+ $ref: '#/components/schemas/action_attempt',
62146
+ },
62147
+ ok: { type: 'boolean' },
62148
+ },
62149
+ required: ['action_attempt', 'ok'],
62150
+ type: 'object',
62151
+ },
62152
+ },
62153
+ },
62154
+ description: 'OK',
62155
+ },
62156
+ '400': { description: 'Bad Request' },
62157
+ '401': { description: 'Unauthorized' },
62158
+ },
62159
+ security: [
62160
+ { client_session: [] },
62161
+ { pat_with_workspace: [] },
62162
+ { console_session_with_workspace: [] },
62163
+ { api_key: [] },
62164
+ ],
62165
+ summary: '/pools/heat',
62166
+ tags: [],
62167
+ 'x-action-attempt-type': 'SET_POOL_HEATING',
62168
+ 'x-fern-sdk-group-name': ['pools'],
62169
+ 'x-fern-sdk-method-name': 'heat',
62170
+ 'x-fern-sdk-return-value': 'action_attempt',
62171
+ 'x-response-key': 'action_attempt',
62172
+ 'x-title': 'Heat a Pool or Spa',
62173
+ 'x-undocumented': 'Unreleased.',
62174
+ },
62175
+ },
62176
+ '/pools/list': {
62177
+ get: {
62178
+ description:
62179
+ '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`.',
62180
+ operationId: 'poolsListGet',
62181
+ parameters: [
62182
+ {
62183
+ in: 'query',
62184
+ name: 'customer_key',
62185
+ schema: {
62186
+ description: 'Customer key for which you want to list devices.',
62187
+ minLength: 1,
62188
+ type: 'string',
62189
+ },
62190
+ },
62191
+ {
62192
+ in: 'query',
62193
+ name: 'connected_account_id',
62194
+ schema: {
62195
+ description:
62196
+ 'ID of the connected account for which you want to list devices.',
62197
+ format: 'uuid',
62198
+ type: 'string',
62199
+ },
62200
+ },
62201
+ {
62202
+ in: 'query',
62203
+ name: 'connect_webview_id',
62204
+ schema: {
62205
+ description:
62206
+ 'ID of the Connect Webview for which you want to list devices.',
62207
+ format: 'uuid',
62208
+ type: 'string',
62209
+ },
62210
+ },
62211
+ {
62212
+ in: 'query',
62213
+ name: 'device_type',
62214
+ schema: {
62215
+ description:
62216
+ 'Device type by which you want to filter pool devices.',
62217
+ enum: ['hayward_pool_system', 'hayward_pool'],
62218
+ type: 'string',
62219
+ 'x-undocumented': 'Unreleased.',
62220
+ },
62221
+ },
62222
+ {
62223
+ in: 'query',
62224
+ name: 'device_types',
62225
+ schema: {
62226
+ description:
62227
+ 'Array of device types by which you want to filter pool devices.',
62228
+ items: {
62229
+ description:
62230
+ 'Device type for pool controllers, pools, and spas.',
62231
+ enum: ['hayward_pool_system', 'hayward_pool'],
62232
+ type: 'string',
62233
+ 'x-undocumented': 'Unreleased.',
62234
+ },
62235
+ type: 'array',
62236
+ },
62237
+ },
62238
+ ],
62239
+ responses: {
62240
+ '200': {
62241
+ content: {
62242
+ 'application/json': {
62243
+ schema: {
62244
+ properties: {
62245
+ devices: {
62246
+ items: { $ref: '#/components/schemas/device' },
62247
+ type: 'array',
62248
+ },
62249
+ ok: { type: 'boolean' },
62250
+ },
62251
+ required: ['devices', 'ok'],
62252
+ type: 'object',
62253
+ },
62254
+ },
62255
+ },
62256
+ description: 'OK',
62257
+ },
62258
+ '400': { description: 'Bad Request' },
62259
+ '401': { description: 'Unauthorized' },
62260
+ },
62261
+ security: [
62262
+ { api_key: [] },
62263
+ { pat_with_workspace: [] },
62264
+ { console_session_with_workspace: [] },
62265
+ { client_session: [] },
62266
+ { support_read_only_token: [] },
62267
+ ],
62268
+ summary: '/pools/list',
62269
+ tags: [],
62270
+ 'x-fern-sdk-group-name': ['pools'],
62271
+ 'x-fern-sdk-method-name': 'list',
62272
+ 'x-fern-sdk-return-value': 'devices',
62273
+ 'x-response-key': 'devices',
62274
+ 'x-title': 'List Pool Devices',
62275
+ 'x-undocumented': 'Unreleased.',
62276
+ },
62277
+ },
62278
+ '/pools/turn_off': {
62279
+ post: {
62280
+ description:
62281
+ '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`.',
62282
+ operationId: 'poolsTurnOffPost',
62283
+ requestBody: {
62284
+ content: {
62285
+ 'application/json': {
62286
+ schema: {
62287
+ properties: {
62288
+ device_id: {
62289
+ description:
62290
+ 'ID of the device for the pool or spa water whose temperature control you want to turn off.',
62291
+ format: 'uuid',
62292
+ type: 'string',
62293
+ },
62294
+ },
62295
+ required: ['device_id'],
62296
+ type: 'object',
62297
+ },
62298
+ },
62299
+ },
62300
+ },
62301
+ responses: {
62302
+ '200': {
62303
+ content: {
62304
+ 'application/json': {
62305
+ schema: {
62306
+ properties: {
62307
+ action_attempt: {
62308
+ $ref: '#/components/schemas/action_attempt',
62309
+ },
62310
+ ok: { type: 'boolean' },
62311
+ },
62312
+ required: ['action_attempt', 'ok'],
62313
+ type: 'object',
62314
+ },
62315
+ },
62316
+ },
62317
+ description: 'OK',
62318
+ },
62319
+ '400': { description: 'Bad Request' },
62320
+ '401': { description: 'Unauthorized' },
62321
+ },
62322
+ security: [
62323
+ { client_session: [] },
62324
+ { pat_with_workspace: [] },
62325
+ { console_session_with_workspace: [] },
62326
+ { api_key: [] },
62327
+ ],
62328
+ summary: '/pools/turn_off',
62329
+ tags: [],
62330
+ 'x-action-attempt-type': 'SET_POOL_HEATING',
62331
+ 'x-fern-sdk-group-name': ['pools'],
62332
+ 'x-fern-sdk-method-name': 'turn_off',
62333
+ 'x-fern-sdk-return-value': 'action_attempt',
62334
+ 'x-response-key': 'action_attempt',
62335
+ 'x-title': 'Turn Off Temperature Control of a Pool or Spa',
62336
+ 'x-undocumented': 'Unreleased.',
62337
+ },
62338
+ },
61737
62339
  '/seam/bridge/v1/bridge_client_sessions/create': {
61738
62340
  post: {
61739
62341
  description: