@seamapi/types 1.1188.0 → 1.1190.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 (55) 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 +206 -101
  19. package/lib/seam/connect/models/devices/device.js +46 -1
  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 +119 -70
  32. package/lib/seam/connect/models/devices/unmanaged-device.js +5 -2
  33. package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
  34. package/lib/seam/connect/models/provider-capability.d.ts +1 -1
  35. package/lib/seam/connect/models/provider-capability.js +1 -0
  36. package/lib/seam/connect/models/provider-capability.js.map +1 -1
  37. package/lib/seam/connect/openapi.js +536 -2
  38. package/lib/seam/connect/openapi.js.map +1 -1
  39. package/lib/seam/connect/route-types.d.ts +9160 -899
  40. package/package.json +1 -1
  41. package/src/lib/seam/connect/internal/enums.ts +2 -0
  42. package/src/lib/seam/connect/internal/schemas.ts +1 -0
  43. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
  44. package/src/lib/seam/connect/models/action-attempts/set-pool-heating.ts +53 -0
  45. package/src/lib/seam/connect/models/devices/capabilities-supported.ts +1 -0
  46. package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
  47. package/src/lib/seam/connect/models/devices/device-type.ts +25 -0
  48. package/src/lib/seam/connect/models/devices/device.ts +52 -2
  49. package/src/lib/seam/connect/models/devices/index.ts +2 -0
  50. package/src/lib/seam/connect/models/devices/pool.ts +45 -0
  51. package/src/lib/seam/connect/models/devices/temperature-controller.ts +50 -0
  52. package/src/lib/seam/connect/models/devices/unmanaged-device.ts +21 -14
  53. package/src/lib/seam/connect/models/provider-capability.ts +1 -0
  54. package/src/lib/seam/connect/openapi.ts +585 -2
  55. package/src/lib/seam/connect/route-types.ts +36423 -26133
@@ -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,6 +16008,7 @@ const openapi: OpenAPISpec = {
15879
16008
  'thermostat',
15880
16009
  'battery',
15881
16010
  'phone',
16011
+ 'pool',
15882
16012
  ],
15883
16013
  type: 'string',
15884
16014
  },
@@ -16072,6 +16202,13 @@ const openapi: OpenAPISpec = {
16072
16202
  enum: ['alertify_sensor'],
16073
16203
  type: 'string',
16074
16204
  },
16205
+ {
16206
+ description:
16207
+ 'Device type for pool controllers, pools, and spas.',
16208
+ enum: ['hayward_pool_system', 'hayward_pool'],
16209
+ type: 'string',
16210
+ 'x-undocumented': 'Unreleased.',
16211
+ },
16075
16212
  ],
16076
16213
  },
16077
16214
  display_name: {
@@ -16639,10 +16776,17 @@ const openapi: OpenAPISpec = {
16639
16776
  locks: { name: 'Locks' },
16640
16777
  noise_sensors: { name: 'Noise Sensors' },
16641
16778
  phones: { name: 'Phones' },
16779
+ pools: { name: 'Pools' },
16642
16780
  provider_metadata: { name: 'Provider Metadata' },
16643
16781
  thermostats: { name: 'Thermostats' },
16644
16782
  },
16645
16783
  },
16784
+ is_door_locked: {
16785
+ description: 'Indicates whether the lock is locked.',
16786
+ type: 'boolean',
16787
+ 'x-property-group-key': 'locks',
16788
+ 'x-undocumented': 'Unreleased.',
16789
+ },
16646
16790
  is_managed: {
16647
16791
  description:
16648
16792
  'Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).',
@@ -16655,12 +16799,32 @@ const openapi: OpenAPISpec = {
16655
16799
  type: 'boolean',
16656
16800
  'x-property-group-key': 'sensors',
16657
16801
  },
16802
+ is_online: {
16803
+ description: 'Indicates whether the device is online.',
16804
+ type: 'boolean',
16805
+ 'x-property-group-key': 'hardware',
16806
+ 'x-undocumented': 'Unreleased.',
16807
+ },
16658
16808
  is_smoking_detected: {
16659
16809
  description:
16660
16810
  'Indicates whether the device detects smoking, if the device measures it.',
16661
16811
  type: 'boolean',
16662
16812
  'x-property-group-key': 'sensors',
16663
16813
  },
16814
+ is_spa: {
16815
+ description:
16816
+ 'Indicates whether the device represents spa water rather than pool water. Present only on pool and spa devices.',
16817
+ type: 'boolean',
16818
+ 'x-property-group-key': 'pools',
16819
+ 'x-undocumented': 'Unreleased.',
16820
+ },
16821
+ is_water_circulating: {
16822
+ description:
16823
+ 'Indicates whether the water is circulating. Temperature readings are only live while it is circulating. Omitted if the controller does not report it.',
16824
+ type: 'boolean',
16825
+ 'x-property-group-key': 'pools',
16826
+ 'x-undocumented': 'Unreleased.',
16827
+ },
16664
16828
  location: {
16665
16829
  description: 'Location information for the device.',
16666
16830
  properties: {
@@ -20047,6 +20211,14 @@ const openapi: OpenAPISpec = {
20047
20211
  type: 'number',
20048
20212
  'x-property-group-key': 'sensors',
20049
20213
  },
20214
+ salt_ppm: {
20215
+ description:
20216
+ 'Salt level reported by the chlorinator, in parts per million. Omitted if the system has no salt chlorinator.',
20217
+ format: 'float',
20218
+ type: 'number',
20219
+ 'x-property-group-key': 'pools',
20220
+ 'x-undocumented': 'Unreleased.',
20221
+ },
20050
20222
  space_ids: {
20051
20223
  description: 'IDs of the spaces the device is in.',
20052
20224
  items: { format: 'uuid', type: 'string' },
@@ -20066,6 +20238,34 @@ const openapi: OpenAPISpec = {
20066
20238
  type: 'number',
20067
20239
  'x-property-group-key': 'sensors',
20068
20240
  },
20241
+ temperature_setting: {
20242
+ description:
20243
+ "Current setting of the device's primary temperature controller.",
20244
+ properties: {
20245
+ controller_mode: {
20246
+ description:
20247
+ "Operating mode requested from the device's primary temperature controller.",
20248
+ enum: ['heat', 'off'],
20249
+ type: 'string',
20250
+ },
20251
+ heating_set_point_celsius: {
20252
+ description:
20253
+ 'Temperature to which the controller should heat, in °C. The controller can retain this value while it is off.',
20254
+ format: 'float',
20255
+ type: 'number',
20256
+ },
20257
+ heating_set_point_fahrenheit: {
20258
+ description:
20259
+ 'Temperature to which the controller should heat, in °F. The controller can retain this value while it is off.',
20260
+ format: 'float',
20261
+ type: 'number',
20262
+ },
20263
+ },
20264
+ required: ['controller_mode'],
20265
+ type: 'object',
20266
+ 'x-property-group-key': 'temperature_controllers',
20267
+ 'x-undocumented': 'Unreleased.',
20268
+ },
20069
20269
  warnings: {
20070
20270
  description:
20071
20271
  '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.',
@@ -20641,6 +20841,33 @@ const openapi: OpenAPISpec = {
20641
20841
  type: 'object',
20642
20842
  'x-variant-group-key': 'locks',
20643
20843
  },
20844
+ {
20845
+ description:
20846
+ 'Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back.',
20847
+ properties: {
20848
+ created_at: {
20849
+ description:
20850
+ 'Date and time at which Seam created the warning.',
20851
+ format: 'date-time',
20852
+ type: 'string',
20853
+ },
20854
+ message: {
20855
+ description:
20856
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20857
+ type: 'string',
20858
+ },
20859
+ warning_code: {
20860
+ description:
20861
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20862
+ enum: ['service_mode'],
20863
+ type: 'string',
20864
+ },
20865
+ },
20866
+ required: ['message', 'created_at', 'warning_code'],
20867
+ type: 'object',
20868
+ 'x-undocumented': 'Unreleased.',
20869
+ 'x-variant-group-key': 'pools',
20870
+ },
20644
20871
  {
20645
20872
  description:
20646
20873
  'Indicates a provider-specific issue that may affect device functionality.',
@@ -20847,6 +21074,7 @@ const openapi: OpenAPISpec = {
20847
21074
  locks: { name: 'Locks' },
20848
21075
  noise_sensors: { name: 'Noise Sensors' },
20849
21076
  phones: { name: 'Phones' },
21077
+ pools: { name: 'Pools' },
20850
21078
  provider_metadata: { name: 'Provider Metadata' },
20851
21079
  thermostats: { name: 'Thermostats' },
20852
21080
  },
@@ -20864,7 +21092,7 @@ const openapi: OpenAPISpec = {
20864
21092
  'space_ids',
20865
21093
  'display_name',
20866
21094
  'capabilities_supported',
20867
- 'properties',
21095
+ 'is_online',
20868
21096
  'connected_account_id',
20869
21097
  'workspace_id',
20870
21098
  'errors',
@@ -20880,9 +21108,11 @@ const openapi: OpenAPISpec = {
20880
21108
  locks: { name: 'Locks' },
20881
21109
  noise_sensors: { name: 'Noise Sensors' },
20882
21110
  phones: { name: 'Phones' },
21111
+ pools: { name: 'Pools' },
20883
21112
  provider_metadata: { name: 'Provider Metadata' },
20884
21113
  sensors: { name: 'Sensors' },
20885
21114
  speakers: { name: 'Speakers' },
21115
+ temperature_controllers: { name: 'Temperature Controllers' },
20886
21116
  thermostats: { name: 'Thermostats' },
20887
21117
  },
20888
21118
  'x-route-path': '/devices',
@@ -20899,6 +21129,12 @@ const openapi: OpenAPISpec = {
20899
21129
  'Indicates whether the lock supports configuring automatic locking.',
20900
21130
  type: 'boolean',
20901
21131
  },
21132
+ can_control_temperature: {
21133
+ description:
21134
+ 'Indicates whether the device supports controlling its primary target temperature.',
21135
+ type: 'boolean',
21136
+ 'x-undocumented': 'Unreleased.',
21137
+ },
20902
21138
  can_hvac_cool: {
20903
21139
  description: 'Indicates whether the thermostat supports cooling.',
20904
21140
  type: 'boolean',
@@ -33730,6 +33966,7 @@ const openapi: OpenAPISpec = {
33730
33966
  locks: { name: 'Locks' },
33731
33967
  noise_sensors: { name: 'Noise Sensors' },
33732
33968
  phones: { name: 'Phones' },
33969
+ pools: { name: 'Pools' },
33733
33970
  provider_metadata: { name: 'Provider Metadata' },
33734
33971
  thermostats: { name: 'Thermostats' },
33735
33972
  },
@@ -34362,6 +34599,33 @@ const openapi: OpenAPISpec = {
34362
34599
  type: 'object',
34363
34600
  'x-variant-group-key': 'locks',
34364
34601
  },
34602
+ {
34603
+ description:
34604
+ 'Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back.',
34605
+ properties: {
34606
+ created_at: {
34607
+ description:
34608
+ 'Date and time at which Seam created the warning.',
34609
+ format: 'date-time',
34610
+ type: 'string',
34611
+ },
34612
+ message: {
34613
+ description:
34614
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
34615
+ type: 'string',
34616
+ },
34617
+ warning_code: {
34618
+ description:
34619
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
34620
+ enum: ['service_mode'],
34621
+ type: 'string',
34622
+ },
34623
+ },
34624
+ required: ['message', 'created_at', 'warning_code'],
34625
+ type: 'object',
34626
+ 'x-undocumented': 'Unreleased.',
34627
+ 'x-variant-group-key': 'pools',
34628
+ },
34365
34629
  {
34366
34630
  description:
34367
34631
  'Indicates a provider-specific issue that may affect device functionality.',
@@ -34568,6 +34832,7 @@ const openapi: OpenAPISpec = {
34568
34832
  locks: { name: 'Locks' },
34569
34833
  noise_sensors: { name: 'Noise Sensors' },
34570
34834
  phones: { name: 'Phones' },
34835
+ pools: { name: 'Pools' },
34571
34836
  provider_metadata: { name: 'Provider Metadata' },
34572
34837
  thermostats: { name: 'Thermostats' },
34573
34838
  },
@@ -41311,6 +41576,12 @@ const openapi: OpenAPISpec = {
41311
41576
  'Indicates whether the lock supports configuring automatic locking.',
41312
41577
  type: 'boolean',
41313
41578
  },
41579
+ can_control_temperature: {
41580
+ description:
41581
+ 'Indicates whether the device supports controlling its primary target temperature.',
41582
+ type: 'boolean',
41583
+ 'x-undocumented': 'Unreleased.',
41584
+ },
41314
41585
  can_hvac_cool: {
41315
41586
  description: 'Indicates whether the thermostat supports cooling.',
41316
41587
  type: 'boolean',
@@ -41467,6 +41738,7 @@ const openapi: OpenAPISpec = {
41467
41738
  'thermostat',
41468
41739
  'battery',
41469
41740
  'phone',
41741
+ 'pool',
41470
41742
  ],
41471
41743
  type: 'string',
41472
41744
  },
@@ -41590,6 +41862,13 @@ const openapi: OpenAPISpec = {
41590
41862
  enum: ['alertify_sensor'],
41591
41863
  type: 'string',
41592
41864
  },
41865
+ {
41866
+ description:
41867
+ 'Device type for pool controllers, pools, and spas.',
41868
+ enum: ['hayward_pool_system', 'hayward_pool'],
41869
+ type: 'string',
41870
+ 'x-undocumented': 'Unreleased.',
41871
+ },
41593
41872
  ],
41594
41873
  },
41595
41874
  display_name: {
@@ -42157,6 +42436,7 @@ const openapi: OpenAPISpec = {
42157
42436
  locks: { name: 'Locks' },
42158
42437
  noise_sensors: { name: 'Noise Sensors' },
42159
42438
  phones: { name: 'Phones' },
42439
+ pools: { name: 'Pools' },
42160
42440
  provider_metadata: { name: 'Provider Metadata' },
42161
42441
  thermostats: { name: 'Thermostats' },
42162
42442
  },
@@ -42166,6 +42446,12 @@ const openapi: OpenAPISpec = {
42166
42446
  enum: [false],
42167
42447
  type: 'boolean',
42168
42448
  },
42449
+ is_online: {
42450
+ description: 'Indicates whether the device is online.',
42451
+ type: 'boolean',
42452
+ 'x-property-group-key': 'hardware',
42453
+ 'x-undocumented': 'Unreleased.',
42454
+ },
42169
42455
  location: {
42170
42456
  description: 'Location information for the device.',
42171
42457
  properties: {
@@ -42929,6 +43215,33 @@ const openapi: OpenAPISpec = {
42929
43215
  type: 'object',
42930
43216
  'x-variant-group-key': 'locks',
42931
43217
  },
43218
+ {
43219
+ description:
43220
+ 'Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back.',
43221
+ properties: {
43222
+ created_at: {
43223
+ description:
43224
+ 'Date and time at which Seam created the warning.',
43225
+ format: 'date-time',
43226
+ type: 'string',
43227
+ },
43228
+ message: {
43229
+ description:
43230
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
43231
+ type: 'string',
43232
+ },
43233
+ warning_code: {
43234
+ description:
43235
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
43236
+ enum: ['service_mode'],
43237
+ type: 'string',
43238
+ },
43239
+ },
43240
+ required: ['message', 'created_at', 'warning_code'],
43241
+ type: 'object',
43242
+ 'x-undocumented': 'Unreleased.',
43243
+ 'x-variant-group-key': 'pools',
43244
+ },
42932
43245
  {
42933
43246
  description:
42934
43247
  'Indicates a provider-specific issue that may affect device functionality.',
@@ -43135,6 +43448,7 @@ const openapi: OpenAPISpec = {
43135
43448
  locks: { name: 'Locks' },
43136
43449
  noise_sensors: { name: 'Noise Sensors' },
43137
43450
  phones: { name: 'Phones' },
43451
+ pools: { name: 'Pools' },
43138
43452
  provider_metadata: { name: 'Provider Metadata' },
43139
43453
  thermostats: { name: 'Thermostats' },
43140
43454
  },
@@ -43157,8 +43471,8 @@ const openapi: OpenAPISpec = {
43157
43471
  'created_at',
43158
43472
  'custom_metadata',
43159
43473
  'display_name',
43474
+ 'is_online',
43160
43475
  'is_managed',
43161
- 'properties',
43162
43476
  ],
43163
43477
  type: 'object',
43164
43478
  'x-property-groups': {
@@ -52437,6 +52751,7 @@ const openapi: OpenAPISpec = {
52437
52751
  'access_control',
52438
52752
  'camera',
52439
52753
  'speaker',
52754
+ 'pool',
52440
52755
  ],
52441
52756
  type: 'string',
52442
52757
  },
@@ -53225,6 +53540,7 @@ const openapi: OpenAPISpec = {
53225
53540
  'access_control',
53226
53541
  'camera',
53227
53542
  'speaker',
53543
+ 'pool',
53228
53544
  ],
53229
53545
  type: 'string',
53230
53546
  },
@@ -56509,6 +56825,13 @@ const openapi: OpenAPISpec = {
56509
56825
  enum: ['alertify_sensor'],
56510
56826
  type: 'string',
56511
56827
  },
56828
+ {
56829
+ description:
56830
+ 'Device type for pool controllers, pools, and spas.',
56831
+ enum: ['hayward_pool_system', 'hayward_pool'],
56832
+ type: 'string',
56833
+ 'x-undocumented': 'Unreleased.',
56834
+ },
56512
56835
  ],
56513
56836
  },
56514
56837
  },
@@ -56609,6 +56932,13 @@ const openapi: OpenAPISpec = {
56609
56932
  enum: ['alertify_sensor'],
56610
56933
  type: 'string',
56611
56934
  },
56935
+ {
56936
+ description:
56937
+ 'Device type for pool controllers, pools, and spas.',
56938
+ enum: ['hayward_pool_system', 'hayward_pool'],
56939
+ type: 'string',
56940
+ 'x-undocumented': 'Unreleased.',
56941
+ },
56612
56942
  ],
56613
56943
  },
56614
56944
  type: 'array',
@@ -56786,6 +57116,7 @@ const openapi: OpenAPISpec = {
56786
57116
  'can_play_speaker_chime',
56787
57117
  'can_play_speaker_favorite',
56788
57118
  'can_play_speaker_audio_clip',
57119
+ 'can_control_temperature',
56789
57120
  ],
56790
57121
  type: 'string',
56791
57122
  },
@@ -56829,6 +57160,7 @@ const openapi: OpenAPISpec = {
56829
57160
  'can_play_speaker_chime',
56830
57161
  'can_play_speaker_favorite',
56831
57162
  'can_play_speaker_audio_clip',
57163
+ 'can_control_temperature',
56832
57164
  ],
56833
57165
  type: 'string',
56834
57166
  },
@@ -58878,6 +59210,13 @@ const openapi: OpenAPISpec = {
58878
59210
  enum: ['alertify_sensor'],
58879
59211
  type: 'string',
58880
59212
  },
59213
+ {
59214
+ description:
59215
+ 'Device type for pool controllers, pools, and spas.',
59216
+ enum: ['hayward_pool_system', 'hayward_pool'],
59217
+ type: 'string',
59218
+ 'x-undocumented': 'Unreleased.',
59219
+ },
58881
59220
  ],
58882
59221
  },
58883
59222
  },
@@ -58978,6 +59317,13 @@ const openapi: OpenAPISpec = {
58978
59317
  enum: ['alertify_sensor'],
58979
59318
  type: 'string',
58980
59319
  },
59320
+ {
59321
+ description:
59322
+ 'Device type for pool controllers, pools, and spas.',
59323
+ enum: ['hayward_pool_system', 'hayward_pool'],
59324
+ type: 'string',
59325
+ 'x-undocumented': 'Unreleased.',
59326
+ },
58981
59327
  ],
58982
59328
  },
58983
59329
  type: 'array',
@@ -59121,6 +59467,7 @@ const openapi: OpenAPISpec = {
59121
59467
  'can_play_speaker_chime',
59122
59468
  'can_play_speaker_favorite',
59123
59469
  'can_play_speaker_audio_clip',
59470
+ 'can_control_temperature',
59124
59471
  ],
59125
59472
  type: 'string',
59126
59473
  },
@@ -59164,6 +59511,7 @@ const openapi: OpenAPISpec = {
59164
59511
  'can_play_speaker_chime',
59165
59512
  'can_play_speaker_favorite',
59166
59513
  'can_play_speaker_audio_clip',
59514
+ 'can_control_temperature',
59167
59515
  ],
59168
59516
  type: 'string',
59169
59517
  },
@@ -61716,6 +62064,241 @@ const openapi: OpenAPISpec = {
61716
62064
  'x-title': 'Create a Sandbox Phone',
61717
62065
  },
61718
62066
  },
62067
+ '/pools/heat': {
62068
+ post: {
62069
+ description:
62070
+ "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`.",
62071
+ operationId: 'poolsHeatPost',
62072
+ requestBody: {
62073
+ content: {
62074
+ 'application/json': {
62075
+ schema: {
62076
+ properties: {
62077
+ device_id: {
62078
+ description:
62079
+ 'ID of the device for the pool or spa water that you want to heat.',
62080
+ format: 'uuid',
62081
+ type: 'string',
62082
+ },
62083
+ heating_set_point_celsius: {
62084
+ description:
62085
+ 'Target water temperature in °C. Provide exactly one of `heating_set_point_celsius` and `heating_set_point_fahrenheit`.',
62086
+ format: 'float',
62087
+ type: 'number',
62088
+ },
62089
+ heating_set_point_fahrenheit: {
62090
+ description:
62091
+ 'Target water temperature in °F. Provide exactly one of `heating_set_point_celsius` and `heating_set_point_fahrenheit`.',
62092
+ format: 'float',
62093
+ type: 'number',
62094
+ },
62095
+ },
62096
+ required: ['device_id'],
62097
+ type: 'object',
62098
+ },
62099
+ },
62100
+ },
62101
+ },
62102
+ responses: {
62103
+ '200': {
62104
+ content: {
62105
+ 'application/json': {
62106
+ schema: {
62107
+ properties: {
62108
+ action_attempt: {
62109
+ $ref: '#/components/schemas/action_attempt',
62110
+ },
62111
+ ok: { type: 'boolean' },
62112
+ },
62113
+ required: ['action_attempt', 'ok'],
62114
+ type: 'object',
62115
+ },
62116
+ },
62117
+ },
62118
+ description: 'OK',
62119
+ },
62120
+ '400': { description: 'Bad Request' },
62121
+ '401': { description: 'Unauthorized' },
62122
+ },
62123
+ security: [
62124
+ { client_session: [] },
62125
+ { pat_with_workspace: [] },
62126
+ { console_session_with_workspace: [] },
62127
+ { api_key: [] },
62128
+ ],
62129
+ summary: '/pools/heat',
62130
+ tags: [],
62131
+ 'x-action-attempt-type': 'SET_POOL_HEATING',
62132
+ 'x-fern-sdk-group-name': ['pools'],
62133
+ 'x-fern-sdk-method-name': 'heat',
62134
+ 'x-fern-sdk-return-value': 'action_attempt',
62135
+ 'x-response-key': 'action_attempt',
62136
+ 'x-title': 'Heat a Pool or Spa',
62137
+ 'x-undocumented': 'Unreleased.',
62138
+ },
62139
+ },
62140
+ '/pools/list': {
62141
+ get: {
62142
+ description: 'Returns a list of all pool controllers, pools, and spas.',
62143
+ operationId: 'poolsListGet',
62144
+ parameters: [
62145
+ {
62146
+ in: 'query',
62147
+ name: 'customer_key',
62148
+ schema: {
62149
+ description: 'Customer key for which you want to list devices.',
62150
+ minLength: 1,
62151
+ type: 'string',
62152
+ },
62153
+ },
62154
+ {
62155
+ in: 'query',
62156
+ name: 'connected_account_id',
62157
+ schema: {
62158
+ description:
62159
+ 'ID of the connected account for which you want to list devices.',
62160
+ format: 'uuid',
62161
+ type: 'string',
62162
+ },
62163
+ },
62164
+ {
62165
+ in: 'query',
62166
+ name: 'connect_webview_id',
62167
+ schema: {
62168
+ description:
62169
+ 'ID of the Connect Webview for which you want to list devices.',
62170
+ format: 'uuid',
62171
+ type: 'string',
62172
+ },
62173
+ },
62174
+ {
62175
+ in: 'query',
62176
+ name: 'device_type',
62177
+ schema: {
62178
+ description:
62179
+ 'Device type by which you want to filter pool devices.',
62180
+ enum: ['hayward_pool_system', 'hayward_pool'],
62181
+ type: 'string',
62182
+ 'x-undocumented': 'Unreleased.',
62183
+ },
62184
+ },
62185
+ {
62186
+ in: 'query',
62187
+ name: 'device_types',
62188
+ schema: {
62189
+ description:
62190
+ 'Array of device types by which you want to filter pool devices.',
62191
+ items: {
62192
+ description:
62193
+ 'Device type for pool controllers, pools, and spas.',
62194
+ enum: ['hayward_pool_system', 'hayward_pool'],
62195
+ type: 'string',
62196
+ 'x-undocumented': 'Unreleased.',
62197
+ },
62198
+ type: 'array',
62199
+ },
62200
+ },
62201
+ ],
62202
+ responses: {
62203
+ '200': {
62204
+ content: {
62205
+ 'application/json': {
62206
+ schema: {
62207
+ properties: {
62208
+ devices: {
62209
+ items: { $ref: '#/components/schemas/device' },
62210
+ type: 'array',
62211
+ },
62212
+ ok: { type: 'boolean' },
62213
+ },
62214
+ required: ['devices', 'ok'],
62215
+ type: 'object',
62216
+ },
62217
+ },
62218
+ },
62219
+ description: 'OK',
62220
+ },
62221
+ '400': { description: 'Bad Request' },
62222
+ '401': { description: 'Unauthorized' },
62223
+ },
62224
+ security: [
62225
+ { api_key: [] },
62226
+ { pat_with_workspace: [] },
62227
+ { console_session_with_workspace: [] },
62228
+ { client_session: [] },
62229
+ { support_read_only_token: [] },
62230
+ ],
62231
+ summary: '/pools/list',
62232
+ tags: [],
62233
+ 'x-fern-sdk-group-name': ['pools'],
62234
+ 'x-fern-sdk-method-name': 'list',
62235
+ 'x-fern-sdk-return-value': 'devices',
62236
+ 'x-response-key': 'devices',
62237
+ 'x-title': 'List Pool Devices',
62238
+ 'x-undocumented': 'Unreleased.',
62239
+ },
62240
+ },
62241
+ '/pools/turn_off': {
62242
+ post: {
62243
+ description:
62244
+ '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`.',
62245
+ operationId: 'poolsTurnOffPost',
62246
+ requestBody: {
62247
+ content: {
62248
+ 'application/json': {
62249
+ schema: {
62250
+ properties: {
62251
+ device_id: {
62252
+ description:
62253
+ 'ID of the device for the pool or spa water whose temperature control you want to turn off.',
62254
+ format: 'uuid',
62255
+ type: 'string',
62256
+ },
62257
+ },
62258
+ required: ['device_id'],
62259
+ type: 'object',
62260
+ },
62261
+ },
62262
+ },
62263
+ },
62264
+ responses: {
62265
+ '200': {
62266
+ content: {
62267
+ 'application/json': {
62268
+ schema: {
62269
+ properties: {
62270
+ action_attempt: {
62271
+ $ref: '#/components/schemas/action_attempt',
62272
+ },
62273
+ ok: { type: 'boolean' },
62274
+ },
62275
+ required: ['action_attempt', 'ok'],
62276
+ type: 'object',
62277
+ },
62278
+ },
62279
+ },
62280
+ description: 'OK',
62281
+ },
62282
+ '400': { description: 'Bad Request' },
62283
+ '401': { description: 'Unauthorized' },
62284
+ },
62285
+ security: [
62286
+ { client_session: [] },
62287
+ { pat_with_workspace: [] },
62288
+ { console_session_with_workspace: [] },
62289
+ { api_key: [] },
62290
+ ],
62291
+ summary: '/pools/turn_off',
62292
+ tags: [],
62293
+ 'x-action-attempt-type': 'SET_POOL_HEATING',
62294
+ 'x-fern-sdk-group-name': ['pools'],
62295
+ 'x-fern-sdk-method-name': 'turn_off',
62296
+ 'x-fern-sdk-return-value': 'action_attempt',
62297
+ 'x-response-key': 'action_attempt',
62298
+ 'x-title': 'Turn Off Temperature Control of a Pool or Spa',
62299
+ 'x-undocumented': 'Unreleased.',
62300
+ },
62301
+ },
61719
62302
  '/seam/bridge/v1/bridge_client_sessions/create': {
61720
62303
  post: {
61721
62304
  description: