@seamapi/types 1.1189.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.
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +75 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/set-pool-heating.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/set-pool-heating.js +43 -0
- package/lib/seam/connect/models/action-attempts/set-pool-heating.js.map +1 -0
- package/lib/seam/connect/models/connect-webviews/connect-webview.d.ts +3 -3
- package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +3 -3
- package/lib/seam/connect/models/devices/capabilities-supported.d.ts +1 -1
- package/lib/seam/connect/models/devices/capabilities-supported.js +1 -0
- package/lib/seam/connect/models/devices/capabilities-supported.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +3 -0
- package/lib/seam/connect/models/devices/device-provider.js +1 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/devices/device-type.d.ts +12 -1
- package/lib/seam/connect/models/devices/device-type.js +15 -0
- package/lib/seam/connect/models/devices/device-type.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +102 -6
- package/lib/seam/connect/models/devices/device.js +30 -0
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/index.d.ts +2 -0
- package/lib/seam/connect/models/devices/index.js +2 -0
- package/lib/seam/connect/models/devices/index.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.d.ts +21 -0
- package/lib/seam/connect/models/devices/pool.d.ts +20 -0
- package/lib/seam/connect/models/devices/pool.js +26 -0
- package/lib/seam/connect/models/devices/pool.js.map +1 -0
- package/lib/seam/connect/models/devices/temperature-controller.d.ts +44 -0
- package/lib/seam/connect/models/devices/temperature-controller.js +29 -0
- package/lib/seam/connect/models/devices/temperature-controller.js.map +1 -0
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +47 -6
- package/lib/seam/connect/models/provider-capability.d.ts +1 -1
- package/lib/seam/connect/models/provider-capability.js +1 -0
- package/lib/seam/connect/models/provider-capability.js.map +1 -1
- package/lib/seam/connect/openapi.js +516 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +8983 -796
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/enums.ts +2 -0
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
- package/src/lib/seam/connect/models/action-attempts/set-pool-heating.ts +53 -0
- package/src/lib/seam/connect/models/devices/capabilities-supported.ts +1 -0
- package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
- package/src/lib/seam/connect/models/devices/device-type.ts +25 -0
- package/src/lib/seam/connect/models/devices/device.ts +31 -0
- package/src/lib/seam/connect/models/devices/index.ts +2 -0
- package/src/lib/seam/connect/models/devices/pool.ts +45 -0
- package/src/lib/seam/connect/models/devices/temperature-controller.ts +50 -0
- package/src/lib/seam/connect/models/provider-capability.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +565 -0
- package/src/lib/seam/connect/route-types.ts +9665 -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,6 +14203,7 @@ const openapi = {
|
|
|
14085
14203
|
'thermostat',
|
|
14086
14204
|
'battery',
|
|
14087
14205
|
'phone',
|
|
14206
|
+
'pool',
|
|
14088
14207
|
],
|
|
14089
14208
|
type: 'string',
|
|
14090
14209
|
},
|
|
@@ -14266,6 +14385,12 @@ const openapi = {
|
|
|
14266
14385
|
enum: ['alertify_sensor'],
|
|
14267
14386
|
type: 'string',
|
|
14268
14387
|
},
|
|
14388
|
+
{
|
|
14389
|
+
description: 'Device type for pool controllers, pools, and spas.',
|
|
14390
|
+
enum: ['hayward_pool_system', 'hayward_pool'],
|
|
14391
|
+
type: 'string',
|
|
14392
|
+
'x-undocumented': 'Unreleased.',
|
|
14393
|
+
},
|
|
14269
14394
|
],
|
|
14270
14395
|
},
|
|
14271
14396
|
display_name: {
|
|
@@ -14763,6 +14888,7 @@ const openapi = {
|
|
|
14763
14888
|
locks: { name: 'Locks' },
|
|
14764
14889
|
noise_sensors: { name: 'Noise Sensors' },
|
|
14765
14890
|
phones: { name: 'Phones' },
|
|
14891
|
+
pools: { name: 'Pools' },
|
|
14766
14892
|
provider_metadata: { name: 'Provider Metadata' },
|
|
14767
14893
|
thermostats: { name: 'Thermostats' },
|
|
14768
14894
|
},
|
|
@@ -14794,6 +14920,18 @@ const openapi = {
|
|
|
14794
14920
|
type: 'boolean',
|
|
14795
14921
|
'x-property-group-key': 'sensors',
|
|
14796
14922
|
},
|
|
14923
|
+
is_spa: {
|
|
14924
|
+
description: 'Indicates whether the device represents spa water rather than pool water. Present only on pool and spa devices.',
|
|
14925
|
+
type: 'boolean',
|
|
14926
|
+
'x-property-group-key': 'pools',
|
|
14927
|
+
'x-undocumented': 'Unreleased.',
|
|
14928
|
+
},
|
|
14929
|
+
is_water_circulating: {
|
|
14930
|
+
description: 'Indicates whether the water is circulating. Temperature readings are only live while it is circulating. Omitted if the controller does not report it.',
|
|
14931
|
+
type: 'boolean',
|
|
14932
|
+
'x-property-group-key': 'pools',
|
|
14933
|
+
'x-undocumented': 'Unreleased.',
|
|
14934
|
+
},
|
|
14797
14935
|
location: {
|
|
14798
14936
|
description: 'Location information for the device.',
|
|
14799
14937
|
properties: {
|
|
@@ -17791,6 +17929,13 @@ const openapi = {
|
|
|
17791
17929
|
type: 'number',
|
|
17792
17930
|
'x-property-group-key': 'sensors',
|
|
17793
17931
|
},
|
|
17932
|
+
salt_ppm: {
|
|
17933
|
+
description: 'Salt level reported by the chlorinator, in parts per million. Omitted if the system has no salt chlorinator.',
|
|
17934
|
+
format: 'float',
|
|
17935
|
+
type: 'number',
|
|
17936
|
+
'x-property-group-key': 'pools',
|
|
17937
|
+
'x-undocumented': 'Unreleased.',
|
|
17938
|
+
},
|
|
17794
17939
|
space_ids: {
|
|
17795
17940
|
description: 'IDs of the spaces the device is in.',
|
|
17796
17941
|
items: { format: 'uuid', type: 'string' },
|
|
@@ -17808,6 +17953,30 @@ const openapi = {
|
|
|
17808
17953
|
type: 'number',
|
|
17809
17954
|
'x-property-group-key': 'sensors',
|
|
17810
17955
|
},
|
|
17956
|
+
temperature_setting: {
|
|
17957
|
+
description: "Current setting of the device's primary temperature controller.",
|
|
17958
|
+
properties: {
|
|
17959
|
+
controller_mode: {
|
|
17960
|
+
description: "Operating mode requested from the device's primary temperature controller.",
|
|
17961
|
+
enum: ['heat', 'off'],
|
|
17962
|
+
type: 'string',
|
|
17963
|
+
},
|
|
17964
|
+
heating_set_point_celsius: {
|
|
17965
|
+
description: 'Temperature to which the controller should heat, in °C. The controller can retain this value while it is off.',
|
|
17966
|
+
format: 'float',
|
|
17967
|
+
type: 'number',
|
|
17968
|
+
},
|
|
17969
|
+
heating_set_point_fahrenheit: {
|
|
17970
|
+
description: 'Temperature to which the controller should heat, in °F. The controller can retain this value while it is off.',
|
|
17971
|
+
format: 'float',
|
|
17972
|
+
type: 'number',
|
|
17973
|
+
},
|
|
17974
|
+
},
|
|
17975
|
+
required: ['controller_mode'],
|
|
17976
|
+
type: 'object',
|
|
17977
|
+
'x-property-group-key': 'temperature_controllers',
|
|
17978
|
+
'x-undocumented': 'Unreleased.',
|
|
17979
|
+
},
|
|
17811
17980
|
warnings: {
|
|
17812
17981
|
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
17982
|
items: {
|
|
@@ -18295,6 +18464,29 @@ const openapi = {
|
|
|
18295
18464
|
type: 'object',
|
|
18296
18465
|
'x-variant-group-key': 'locks',
|
|
18297
18466
|
},
|
|
18467
|
+
{
|
|
18468
|
+
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.',
|
|
18469
|
+
properties: {
|
|
18470
|
+
created_at: {
|
|
18471
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18472
|
+
format: 'date-time',
|
|
18473
|
+
type: 'string',
|
|
18474
|
+
},
|
|
18475
|
+
message: {
|
|
18476
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18477
|
+
type: 'string',
|
|
18478
|
+
},
|
|
18479
|
+
warning_code: {
|
|
18480
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18481
|
+
enum: ['service_mode'],
|
|
18482
|
+
type: 'string',
|
|
18483
|
+
},
|
|
18484
|
+
},
|
|
18485
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
18486
|
+
type: 'object',
|
|
18487
|
+
'x-undocumented': 'Unreleased.',
|
|
18488
|
+
'x-variant-group-key': 'pools',
|
|
18489
|
+
},
|
|
18298
18490
|
{
|
|
18299
18491
|
description: 'Indicates a provider-specific issue that may affect device functionality.',
|
|
18300
18492
|
properties: {
|
|
@@ -18471,6 +18663,7 @@ const openapi = {
|
|
|
18471
18663
|
locks: { name: 'Locks' },
|
|
18472
18664
|
noise_sensors: { name: 'Noise Sensors' },
|
|
18473
18665
|
phones: { name: 'Phones' },
|
|
18666
|
+
pools: { name: 'Pools' },
|
|
18474
18667
|
provider_metadata: { name: 'Provider Metadata' },
|
|
18475
18668
|
thermostats: { name: 'Thermostats' },
|
|
18476
18669
|
},
|
|
@@ -18503,9 +18696,11 @@ const openapi = {
|
|
|
18503
18696
|
locks: { name: 'Locks' },
|
|
18504
18697
|
noise_sensors: { name: 'Noise Sensors' },
|
|
18505
18698
|
phones: { name: 'Phones' },
|
|
18699
|
+
pools: { name: 'Pools' },
|
|
18506
18700
|
provider_metadata: { name: 'Provider Metadata' },
|
|
18507
18701
|
sensors: { name: 'Sensors' },
|
|
18508
18702
|
speakers: { name: 'Speakers' },
|
|
18703
|
+
temperature_controllers: { name: 'Temperature Controllers' },
|
|
18509
18704
|
thermostats: { name: 'Thermostats' },
|
|
18510
18705
|
},
|
|
18511
18706
|
'x-route-path': '/devices',
|
|
@@ -18520,6 +18715,11 @@ const openapi = {
|
|
|
18520
18715
|
description: 'Indicates whether the lock supports configuring automatic locking.',
|
|
18521
18716
|
type: 'boolean',
|
|
18522
18717
|
},
|
|
18718
|
+
can_control_temperature: {
|
|
18719
|
+
description: 'Indicates whether the device supports controlling its primary target temperature.',
|
|
18720
|
+
type: 'boolean',
|
|
18721
|
+
'x-undocumented': 'Unreleased.',
|
|
18722
|
+
},
|
|
18523
18723
|
can_hvac_cool: {
|
|
18524
18724
|
description: 'Indicates whether the thermostat supports cooling.',
|
|
18525
18725
|
type: 'boolean',
|
|
@@ -30280,6 +30480,7 @@ const openapi = {
|
|
|
30280
30480
|
locks: { name: 'Locks' },
|
|
30281
30481
|
noise_sensors: { name: 'Noise Sensors' },
|
|
30282
30482
|
phones: { name: 'Phones' },
|
|
30483
|
+
pools: { name: 'Pools' },
|
|
30283
30484
|
provider_metadata: { name: 'Provider Metadata' },
|
|
30284
30485
|
thermostats: { name: 'Thermostats' },
|
|
30285
30486
|
},
|
|
@@ -30818,6 +31019,29 @@ const openapi = {
|
|
|
30818
31019
|
type: 'object',
|
|
30819
31020
|
'x-variant-group-key': 'locks',
|
|
30820
31021
|
},
|
|
31022
|
+
{
|
|
31023
|
+
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.',
|
|
31024
|
+
properties: {
|
|
31025
|
+
created_at: {
|
|
31026
|
+
description: 'Date and time at which Seam created the warning.',
|
|
31027
|
+
format: 'date-time',
|
|
31028
|
+
type: 'string',
|
|
31029
|
+
},
|
|
31030
|
+
message: {
|
|
31031
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31032
|
+
type: 'string',
|
|
31033
|
+
},
|
|
31034
|
+
warning_code: {
|
|
31035
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31036
|
+
enum: ['service_mode'],
|
|
31037
|
+
type: 'string',
|
|
31038
|
+
},
|
|
31039
|
+
},
|
|
31040
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31041
|
+
type: 'object',
|
|
31042
|
+
'x-undocumented': 'Unreleased.',
|
|
31043
|
+
'x-variant-group-key': 'pools',
|
|
31044
|
+
},
|
|
30821
31045
|
{
|
|
30822
31046
|
description: 'Indicates a provider-specific issue that may affect device functionality.',
|
|
30823
31047
|
properties: {
|
|
@@ -30994,6 +31218,7 @@ const openapi = {
|
|
|
30994
31218
|
locks: { name: 'Locks' },
|
|
30995
31219
|
noise_sensors: { name: 'Noise Sensors' },
|
|
30996
31220
|
phones: { name: 'Phones' },
|
|
31221
|
+
pools: { name: 'Pools' },
|
|
30997
31222
|
provider_metadata: { name: 'Provider Metadata' },
|
|
30998
31223
|
thermostats: { name: 'Thermostats' },
|
|
30999
31224
|
},
|
|
@@ -36919,6 +37144,11 @@ const openapi = {
|
|
|
36919
37144
|
description: 'Indicates whether the lock supports configuring automatic locking.',
|
|
36920
37145
|
type: 'boolean',
|
|
36921
37146
|
},
|
|
37147
|
+
can_control_temperature: {
|
|
37148
|
+
description: 'Indicates whether the device supports controlling its primary target temperature.',
|
|
37149
|
+
type: 'boolean',
|
|
37150
|
+
'x-undocumented': 'Unreleased.',
|
|
37151
|
+
},
|
|
36922
37152
|
can_hvac_cool: {
|
|
36923
37153
|
description: 'Indicates whether the thermostat supports cooling.',
|
|
36924
37154
|
type: 'boolean',
|
|
@@ -37050,6 +37280,7 @@ const openapi = {
|
|
|
37050
37280
|
'thermostat',
|
|
37051
37281
|
'battery',
|
|
37052
37282
|
'phone',
|
|
37283
|
+
'pool',
|
|
37053
37284
|
],
|
|
37054
37285
|
type: 'string',
|
|
37055
37286
|
},
|
|
@@ -37169,6 +37400,12 @@ const openapi = {
|
|
|
37169
37400
|
enum: ['alertify_sensor'],
|
|
37170
37401
|
type: 'string',
|
|
37171
37402
|
},
|
|
37403
|
+
{
|
|
37404
|
+
description: 'Device type for pool controllers, pools, and spas.',
|
|
37405
|
+
enum: ['hayward_pool_system', 'hayward_pool'],
|
|
37406
|
+
type: 'string',
|
|
37407
|
+
'x-undocumented': 'Unreleased.',
|
|
37408
|
+
},
|
|
37172
37409
|
],
|
|
37173
37410
|
},
|
|
37174
37411
|
display_name: {
|
|
@@ -37666,6 +37903,7 @@ const openapi = {
|
|
|
37666
37903
|
locks: { name: 'Locks' },
|
|
37667
37904
|
noise_sensors: { name: 'Noise Sensors' },
|
|
37668
37905
|
phones: { name: 'Phones' },
|
|
37906
|
+
pools: { name: 'Pools' },
|
|
37669
37907
|
provider_metadata: { name: 'Provider Metadata' },
|
|
37670
37908
|
thermostats: { name: 'Thermostats' },
|
|
37671
37909
|
},
|
|
@@ -38340,6 +38578,29 @@ const openapi = {
|
|
|
38340
38578
|
type: 'object',
|
|
38341
38579
|
'x-variant-group-key': 'locks',
|
|
38342
38580
|
},
|
|
38581
|
+
{
|
|
38582
|
+
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.',
|
|
38583
|
+
properties: {
|
|
38584
|
+
created_at: {
|
|
38585
|
+
description: 'Date and time at which Seam created the warning.',
|
|
38586
|
+
format: 'date-time',
|
|
38587
|
+
type: 'string',
|
|
38588
|
+
},
|
|
38589
|
+
message: {
|
|
38590
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
38591
|
+
type: 'string',
|
|
38592
|
+
},
|
|
38593
|
+
warning_code: {
|
|
38594
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
38595
|
+
enum: ['service_mode'],
|
|
38596
|
+
type: 'string',
|
|
38597
|
+
},
|
|
38598
|
+
},
|
|
38599
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
38600
|
+
type: 'object',
|
|
38601
|
+
'x-undocumented': 'Unreleased.',
|
|
38602
|
+
'x-variant-group-key': 'pools',
|
|
38603
|
+
},
|
|
38343
38604
|
{
|
|
38344
38605
|
description: 'Indicates a provider-specific issue that may affect device functionality.',
|
|
38345
38606
|
properties: {
|
|
@@ -38516,6 +38777,7 @@ const openapi = {
|
|
|
38516
38777
|
locks: { name: 'Locks' },
|
|
38517
38778
|
noise_sensors: { name: 'Noise Sensors' },
|
|
38518
38779
|
phones: { name: 'Phones' },
|
|
38780
|
+
pools: { name: 'Pools' },
|
|
38519
38781
|
provider_metadata: { name: 'Provider Metadata' },
|
|
38520
38782
|
thermostats: { name: 'Thermostats' },
|
|
38521
38783
|
},
|
|
@@ -47289,6 +47551,7 @@ const openapi = {
|
|
|
47289
47551
|
'access_control',
|
|
47290
47552
|
'camera',
|
|
47291
47553
|
'speaker',
|
|
47554
|
+
'pool',
|
|
47292
47555
|
],
|
|
47293
47556
|
type: 'string',
|
|
47294
47557
|
},
|
|
@@ -48042,6 +48305,7 @@ const openapi = {
|
|
|
48042
48305
|
'access_control',
|
|
48043
48306
|
'camera',
|
|
48044
48307
|
'speaker',
|
|
48308
|
+
'pool',
|
|
48045
48309
|
],
|
|
48046
48310
|
type: 'string',
|
|
48047
48311
|
},
|
|
@@ -50972,6 +51236,12 @@ const openapi = {
|
|
|
50972
51236
|
enum: ['alertify_sensor'],
|
|
50973
51237
|
type: 'string',
|
|
50974
51238
|
},
|
|
51239
|
+
{
|
|
51240
|
+
description: 'Device type for pool controllers, pools, and spas.',
|
|
51241
|
+
enum: ['hayward_pool_system', 'hayward_pool'],
|
|
51242
|
+
type: 'string',
|
|
51243
|
+
'x-undocumented': 'Unreleased.',
|
|
51244
|
+
},
|
|
50975
51245
|
],
|
|
50976
51246
|
},
|
|
50977
51247
|
},
|
|
@@ -51071,6 +51341,12 @@ const openapi = {
|
|
|
51071
51341
|
enum: ['alertify_sensor'],
|
|
51072
51342
|
type: 'string',
|
|
51073
51343
|
},
|
|
51344
|
+
{
|
|
51345
|
+
description: 'Device type for pool controllers, pools, and spas.',
|
|
51346
|
+
enum: ['hayward_pool_system', 'hayward_pool'],
|
|
51347
|
+
type: 'string',
|
|
51348
|
+
'x-undocumented': 'Unreleased.',
|
|
51349
|
+
},
|
|
51074
51350
|
],
|
|
51075
51351
|
},
|
|
51076
51352
|
type: 'array',
|
|
@@ -51242,6 +51518,7 @@ const openapi = {
|
|
|
51242
51518
|
'can_play_speaker_chime',
|
|
51243
51519
|
'can_play_speaker_favorite',
|
|
51244
51520
|
'can_play_speaker_audio_clip',
|
|
51521
|
+
'can_control_temperature',
|
|
51245
51522
|
],
|
|
51246
51523
|
type: 'string',
|
|
51247
51524
|
},
|
|
@@ -51285,6 +51562,7 @@ const openapi = {
|
|
|
51285
51562
|
'can_play_speaker_chime',
|
|
51286
51563
|
'can_play_speaker_favorite',
|
|
51287
51564
|
'can_play_speaker_audio_clip',
|
|
51565
|
+
'can_control_temperature',
|
|
51288
51566
|
],
|
|
51289
51567
|
type: 'string',
|
|
51290
51568
|
},
|
|
@@ -53311,6 +53589,12 @@ const openapi = {
|
|
|
53311
53589
|
enum: ['alertify_sensor'],
|
|
53312
53590
|
type: 'string',
|
|
53313
53591
|
},
|
|
53592
|
+
{
|
|
53593
|
+
description: 'Device type for pool controllers, pools, and spas.',
|
|
53594
|
+
enum: ['hayward_pool_system', 'hayward_pool'],
|
|
53595
|
+
type: 'string',
|
|
53596
|
+
'x-undocumented': 'Unreleased.',
|
|
53597
|
+
},
|
|
53314
53598
|
],
|
|
53315
53599
|
},
|
|
53316
53600
|
},
|
|
@@ -53410,6 +53694,12 @@ const openapi = {
|
|
|
53410
53694
|
enum: ['alertify_sensor'],
|
|
53411
53695
|
type: 'string',
|
|
53412
53696
|
},
|
|
53697
|
+
{
|
|
53698
|
+
description: 'Device type for pool controllers, pools, and spas.',
|
|
53699
|
+
enum: ['hayward_pool_system', 'hayward_pool'],
|
|
53700
|
+
type: 'string',
|
|
53701
|
+
'x-undocumented': 'Unreleased.',
|
|
53702
|
+
},
|
|
53413
53703
|
],
|
|
53414
53704
|
},
|
|
53415
53705
|
type: 'array',
|
|
@@ -53550,6 +53840,7 @@ const openapi = {
|
|
|
53550
53840
|
'can_play_speaker_chime',
|
|
53551
53841
|
'can_play_speaker_favorite',
|
|
53552
53842
|
'can_play_speaker_audio_clip',
|
|
53843
|
+
'can_control_temperature',
|
|
53553
53844
|
],
|
|
53554
53845
|
type: 'string',
|
|
53555
53846
|
},
|
|
@@ -53593,6 +53884,7 @@ const openapi = {
|
|
|
53593
53884
|
'can_play_speaker_chime',
|
|
53594
53885
|
'can_play_speaker_favorite',
|
|
53595
53886
|
'can_play_speaker_audio_clip',
|
|
53887
|
+
'can_control_temperature',
|
|
53596
53888
|
],
|
|
53597
53889
|
type: 'string',
|
|
53598
53890
|
},
|
|
@@ -56040,6 +56332,230 @@ const openapi = {
|
|
|
56040
56332
|
'x-title': 'Create a Sandbox Phone',
|
|
56041
56333
|
},
|
|
56042
56334
|
},
|
|
56335
|
+
'/pools/heat': {
|
|
56336
|
+
post: {
|
|
56337
|
+
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`.",
|
|
56338
|
+
operationId: 'poolsHeatPost',
|
|
56339
|
+
requestBody: {
|
|
56340
|
+
content: {
|
|
56341
|
+
'application/json': {
|
|
56342
|
+
schema: {
|
|
56343
|
+
properties: {
|
|
56344
|
+
device_id: {
|
|
56345
|
+
description: 'ID of the device for the pool or spa water that you want to heat.',
|
|
56346
|
+
format: 'uuid',
|
|
56347
|
+
type: 'string',
|
|
56348
|
+
},
|
|
56349
|
+
heating_set_point_celsius: {
|
|
56350
|
+
description: 'Target water temperature in °C. Provide exactly one of `heating_set_point_celsius` and `heating_set_point_fahrenheit`.',
|
|
56351
|
+
format: 'float',
|
|
56352
|
+
type: 'number',
|
|
56353
|
+
},
|
|
56354
|
+
heating_set_point_fahrenheit: {
|
|
56355
|
+
description: 'Target water temperature in °F. Provide exactly one of `heating_set_point_celsius` and `heating_set_point_fahrenheit`.',
|
|
56356
|
+
format: 'float',
|
|
56357
|
+
type: 'number',
|
|
56358
|
+
},
|
|
56359
|
+
},
|
|
56360
|
+
required: ['device_id'],
|
|
56361
|
+
type: 'object',
|
|
56362
|
+
},
|
|
56363
|
+
},
|
|
56364
|
+
},
|
|
56365
|
+
},
|
|
56366
|
+
responses: {
|
|
56367
|
+
'200': {
|
|
56368
|
+
content: {
|
|
56369
|
+
'application/json': {
|
|
56370
|
+
schema: {
|
|
56371
|
+
properties: {
|
|
56372
|
+
action_attempt: {
|
|
56373
|
+
$ref: '#/components/schemas/action_attempt',
|
|
56374
|
+
},
|
|
56375
|
+
ok: { type: 'boolean' },
|
|
56376
|
+
},
|
|
56377
|
+
required: ['action_attempt', 'ok'],
|
|
56378
|
+
type: 'object',
|
|
56379
|
+
},
|
|
56380
|
+
},
|
|
56381
|
+
},
|
|
56382
|
+
description: 'OK',
|
|
56383
|
+
},
|
|
56384
|
+
'400': { description: 'Bad Request' },
|
|
56385
|
+
'401': { description: 'Unauthorized' },
|
|
56386
|
+
},
|
|
56387
|
+
security: [
|
|
56388
|
+
{ client_session: [] },
|
|
56389
|
+
{ pat_with_workspace: [] },
|
|
56390
|
+
{ console_session_with_workspace: [] },
|
|
56391
|
+
{ api_key: [] },
|
|
56392
|
+
],
|
|
56393
|
+
summary: '/pools/heat',
|
|
56394
|
+
tags: [],
|
|
56395
|
+
'x-action-attempt-type': 'SET_POOL_HEATING',
|
|
56396
|
+
'x-fern-sdk-group-name': ['pools'],
|
|
56397
|
+
'x-fern-sdk-method-name': 'heat',
|
|
56398
|
+
'x-fern-sdk-return-value': 'action_attempt',
|
|
56399
|
+
'x-response-key': 'action_attempt',
|
|
56400
|
+
'x-title': 'Heat a Pool or Spa',
|
|
56401
|
+
'x-undocumented': 'Unreleased.',
|
|
56402
|
+
},
|
|
56403
|
+
},
|
|
56404
|
+
'/pools/list': {
|
|
56405
|
+
get: {
|
|
56406
|
+
description: 'Returns a list of all pool controllers, pools, and spas.',
|
|
56407
|
+
operationId: 'poolsListGet',
|
|
56408
|
+
parameters: [
|
|
56409
|
+
{
|
|
56410
|
+
in: 'query',
|
|
56411
|
+
name: 'customer_key',
|
|
56412
|
+
schema: {
|
|
56413
|
+
description: 'Customer key for which you want to list devices.',
|
|
56414
|
+
minLength: 1,
|
|
56415
|
+
type: 'string',
|
|
56416
|
+
},
|
|
56417
|
+
},
|
|
56418
|
+
{
|
|
56419
|
+
in: 'query',
|
|
56420
|
+
name: 'connected_account_id',
|
|
56421
|
+
schema: {
|
|
56422
|
+
description: 'ID of the connected account for which you want to list devices.',
|
|
56423
|
+
format: 'uuid',
|
|
56424
|
+
type: 'string',
|
|
56425
|
+
},
|
|
56426
|
+
},
|
|
56427
|
+
{
|
|
56428
|
+
in: 'query',
|
|
56429
|
+
name: 'connect_webview_id',
|
|
56430
|
+
schema: {
|
|
56431
|
+
description: 'ID of the Connect Webview for which you want to list devices.',
|
|
56432
|
+
format: 'uuid',
|
|
56433
|
+
type: 'string',
|
|
56434
|
+
},
|
|
56435
|
+
},
|
|
56436
|
+
{
|
|
56437
|
+
in: 'query',
|
|
56438
|
+
name: 'device_type',
|
|
56439
|
+
schema: {
|
|
56440
|
+
description: 'Device type by which you want to filter pool devices.',
|
|
56441
|
+
enum: ['hayward_pool_system', 'hayward_pool'],
|
|
56442
|
+
type: 'string',
|
|
56443
|
+
'x-undocumented': 'Unreleased.',
|
|
56444
|
+
},
|
|
56445
|
+
},
|
|
56446
|
+
{
|
|
56447
|
+
in: 'query',
|
|
56448
|
+
name: 'device_types',
|
|
56449
|
+
schema: {
|
|
56450
|
+
description: 'Array of device types by which you want to filter pool devices.',
|
|
56451
|
+
items: {
|
|
56452
|
+
description: 'Device type for pool controllers, pools, and spas.',
|
|
56453
|
+
enum: ['hayward_pool_system', 'hayward_pool'],
|
|
56454
|
+
type: 'string',
|
|
56455
|
+
'x-undocumented': 'Unreleased.',
|
|
56456
|
+
},
|
|
56457
|
+
type: 'array',
|
|
56458
|
+
},
|
|
56459
|
+
},
|
|
56460
|
+
],
|
|
56461
|
+
responses: {
|
|
56462
|
+
'200': {
|
|
56463
|
+
content: {
|
|
56464
|
+
'application/json': {
|
|
56465
|
+
schema: {
|
|
56466
|
+
properties: {
|
|
56467
|
+
devices: {
|
|
56468
|
+
items: { $ref: '#/components/schemas/device' },
|
|
56469
|
+
type: 'array',
|
|
56470
|
+
},
|
|
56471
|
+
ok: { type: 'boolean' },
|
|
56472
|
+
},
|
|
56473
|
+
required: ['devices', 'ok'],
|
|
56474
|
+
type: 'object',
|
|
56475
|
+
},
|
|
56476
|
+
},
|
|
56477
|
+
},
|
|
56478
|
+
description: 'OK',
|
|
56479
|
+
},
|
|
56480
|
+
'400': { description: 'Bad Request' },
|
|
56481
|
+
'401': { description: 'Unauthorized' },
|
|
56482
|
+
},
|
|
56483
|
+
security: [
|
|
56484
|
+
{ api_key: [] },
|
|
56485
|
+
{ pat_with_workspace: [] },
|
|
56486
|
+
{ console_session_with_workspace: [] },
|
|
56487
|
+
{ client_session: [] },
|
|
56488
|
+
{ support_read_only_token: [] },
|
|
56489
|
+
],
|
|
56490
|
+
summary: '/pools/list',
|
|
56491
|
+
tags: [],
|
|
56492
|
+
'x-fern-sdk-group-name': ['pools'],
|
|
56493
|
+
'x-fern-sdk-method-name': 'list',
|
|
56494
|
+
'x-fern-sdk-return-value': 'devices',
|
|
56495
|
+
'x-response-key': 'devices',
|
|
56496
|
+
'x-title': 'List Pool Devices',
|
|
56497
|
+
'x-undocumented': 'Unreleased.',
|
|
56498
|
+
},
|
|
56499
|
+
},
|
|
56500
|
+
'/pools/turn_off': {
|
|
56501
|
+
post: {
|
|
56502
|
+
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`.',
|
|
56503
|
+
operationId: 'poolsTurnOffPost',
|
|
56504
|
+
requestBody: {
|
|
56505
|
+
content: {
|
|
56506
|
+
'application/json': {
|
|
56507
|
+
schema: {
|
|
56508
|
+
properties: {
|
|
56509
|
+
device_id: {
|
|
56510
|
+
description: 'ID of the device for the pool or spa water whose temperature control you want to turn off.',
|
|
56511
|
+
format: 'uuid',
|
|
56512
|
+
type: 'string',
|
|
56513
|
+
},
|
|
56514
|
+
},
|
|
56515
|
+
required: ['device_id'],
|
|
56516
|
+
type: 'object',
|
|
56517
|
+
},
|
|
56518
|
+
},
|
|
56519
|
+
},
|
|
56520
|
+
},
|
|
56521
|
+
responses: {
|
|
56522
|
+
'200': {
|
|
56523
|
+
content: {
|
|
56524
|
+
'application/json': {
|
|
56525
|
+
schema: {
|
|
56526
|
+
properties: {
|
|
56527
|
+
action_attempt: {
|
|
56528
|
+
$ref: '#/components/schemas/action_attempt',
|
|
56529
|
+
},
|
|
56530
|
+
ok: { type: 'boolean' },
|
|
56531
|
+
},
|
|
56532
|
+
required: ['action_attempt', 'ok'],
|
|
56533
|
+
type: 'object',
|
|
56534
|
+
},
|
|
56535
|
+
},
|
|
56536
|
+
},
|
|
56537
|
+
description: 'OK',
|
|
56538
|
+
},
|
|
56539
|
+
'400': { description: 'Bad Request' },
|
|
56540
|
+
'401': { description: 'Unauthorized' },
|
|
56541
|
+
},
|
|
56542
|
+
security: [
|
|
56543
|
+
{ client_session: [] },
|
|
56544
|
+
{ pat_with_workspace: [] },
|
|
56545
|
+
{ console_session_with_workspace: [] },
|
|
56546
|
+
{ api_key: [] },
|
|
56547
|
+
],
|
|
56548
|
+
summary: '/pools/turn_off',
|
|
56549
|
+
tags: [],
|
|
56550
|
+
'x-action-attempt-type': 'SET_POOL_HEATING',
|
|
56551
|
+
'x-fern-sdk-group-name': ['pools'],
|
|
56552
|
+
'x-fern-sdk-method-name': 'turn_off',
|
|
56553
|
+
'x-fern-sdk-return-value': 'action_attempt',
|
|
56554
|
+
'x-response-key': 'action_attempt',
|
|
56555
|
+
'x-title': 'Turn Off Temperature Control of a Pool or Spa',
|
|
56556
|
+
'x-undocumented': 'Unreleased.',
|
|
56557
|
+
},
|
|
56558
|
+
},
|
|
56043
56559
|
'/seam/bridge/v1/bridge_client_sessions/create': {
|
|
56044
56560
|
post: {
|
|
56045
56561
|
description: 'Creates a new [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge) client session.',
|