@seamapi/types 1.1202.0 → 1.1203.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/acs/acs-system.d.ts +4 -4
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +9 -9
- package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -2
- 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 → set-temperature-controller-mode.d.ts} +10 -10
- package/lib/seam/connect/models/action-attempts/{set-pool-heating.js → set-temperature-controller-mode.js} +7 -7
- package/lib/seam/connect/models/action-attempts/set-temperature-controller-mode.js.map +1 -0
- package/lib/seam/connect/models/devices/device-metadata.d.ts +10 -25
- package/lib/seam/connect/models/devices/device-metadata.js +7 -19
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device-type.d.ts +4 -4
- package/lib/seam/connect/models/devices/device-type.js +3 -3
- package/lib/seam/connect/models/devices/device-type.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +27 -48
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +23 -38
- package/lib/seam/connect/models/events/devices.d.ts +4 -4
- package/lib/seam/connect/models/events/seam-event.d.ts +2 -2
- package/lib/seam/connect/openapi.js +32 -43
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +421 -529
- package/package.json +1 -1
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -2
- package/src/lib/seam/connect/models/action-attempts/set-temperature-controller-mode.ts +54 -0
- package/src/lib/seam/connect/models/devices/device-metadata.ts +7 -23
- package/src/lib/seam/connect/models/devices/device-type.ts +3 -3
- package/src/lib/seam/connect/openapi.ts +32 -46
- package/src/lib/seam/connect/route-types.ts +421 -563
- package/lib/seam/connect/models/action-attempts/set-pool-heating.js.map +0 -1
- package/src/lib/seam/connect/models/action-attempts/set-pool-heating.ts +0 -53
|
@@ -11493,7 +11493,7 @@ const openapi = {
|
|
|
11493
11493
|
'x-undocumented': 'Unreleased.',
|
|
11494
11494
|
},
|
|
11495
11495
|
{
|
|
11496
|
-
description: 'Setting the
|
|
11496
|
+
description: 'Setting the temperature controller mode is pending. The controller has not yet reported the requested state back.',
|
|
11497
11497
|
properties: {
|
|
11498
11498
|
action_attempt_id: {
|
|
11499
11499
|
description: 'ID of the action attempt.',
|
|
@@ -11501,8 +11501,8 @@ const openapi = {
|
|
|
11501
11501
|
type: 'string',
|
|
11502
11502
|
},
|
|
11503
11503
|
action_type: {
|
|
11504
|
-
description: 'Action attempt to track the status of heating pool or spa water to a set point
|
|
11505
|
-
enum: ['
|
|
11504
|
+
description: 'Action attempt to track the status of setting the mode of a temperature controller, such as 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.',
|
|
11505
|
+
enum: ['SET_TEMPERATURE_CONTROLLER_MODE'],
|
|
11506
11506
|
type: 'string',
|
|
11507
11507
|
'x-undocumented': 'Unreleased.',
|
|
11508
11508
|
},
|
|
@@ -11527,7 +11527,7 @@ const openapi = {
|
|
|
11527
11527
|
'x-undocumented': 'Unreleased.',
|
|
11528
11528
|
},
|
|
11529
11529
|
{
|
|
11530
|
-
description: 'Setting the
|
|
11530
|
+
description: 'Setting the temperature controller mode succeeded. The controller reported the requested state back.',
|
|
11531
11531
|
properties: {
|
|
11532
11532
|
action_attempt_id: {
|
|
11533
11533
|
description: 'ID of the action attempt.',
|
|
@@ -11535,8 +11535,8 @@ const openapi = {
|
|
|
11535
11535
|
type: 'string',
|
|
11536
11536
|
},
|
|
11537
11537
|
action_type: {
|
|
11538
|
-
description: 'Action attempt to track the status of heating pool or spa water to a set point
|
|
11539
|
-
enum: ['
|
|
11538
|
+
description: 'Action attempt to track the status of setting the mode of a temperature controller, such as 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.',
|
|
11539
|
+
enum: ['SET_TEMPERATURE_CONTROLLER_MODE'],
|
|
11540
11540
|
type: 'string',
|
|
11541
11541
|
'x-undocumented': 'Unreleased.',
|
|
11542
11542
|
},
|
|
@@ -11562,7 +11562,7 @@ const openapi = {
|
|
|
11562
11562
|
'x-undocumented': 'Unreleased.',
|
|
11563
11563
|
},
|
|
11564
11564
|
{
|
|
11565
|
-
description: 'Setting the
|
|
11565
|
+
description: 'Setting the temperature controller mode failed.',
|
|
11566
11566
|
properties: {
|
|
11567
11567
|
action_attempt_id: {
|
|
11568
11568
|
description: 'ID of the action attempt.',
|
|
@@ -11570,8 +11570,8 @@ const openapi = {
|
|
|
11570
11570
|
type: 'string',
|
|
11571
11571
|
},
|
|
11572
11572
|
action_type: {
|
|
11573
|
-
description: 'Action attempt to track the status of heating pool or spa water to a set point
|
|
11574
|
-
enum: ['
|
|
11573
|
+
description: 'Action attempt to track the status of setting the mode of a temperature controller, such as 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.',
|
|
11574
|
+
enum: ['SET_TEMPERATURE_CONTROLLER_MODE'],
|
|
11575
11575
|
type: 'string',
|
|
11576
11576
|
'x-undocumented': 'Unreleased.',
|
|
11577
11577
|
},
|
|
@@ -14433,7 +14433,7 @@ const openapi = {
|
|
|
14433
14433
|
},
|
|
14434
14434
|
{
|
|
14435
14435
|
description: 'Device type for pool controllers, pools, and spas.',
|
|
14436
|
-
enum: ['
|
|
14436
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
14437
14437
|
type: 'string',
|
|
14438
14438
|
'x-undocumented': 'Unreleased.',
|
|
14439
14439
|
},
|
|
@@ -15793,35 +15793,22 @@ const openapi = {
|
|
|
15793
15793
|
type: 'object',
|
|
15794
15794
|
},
|
|
15795
15795
|
hayward_omnilogic_metadata: {
|
|
15796
|
-
description: 'Metadata for a Hayward OmniLogic pool controller or
|
|
15796
|
+
description: 'Metadata for a Hayward OmniLogic pool controller, pool, or spa.',
|
|
15797
15797
|
properties: {
|
|
15798
15798
|
backyard_name: {
|
|
15799
|
-
description: 'Name of the
|
|
15799
|
+
description: 'Name of the controller, as set in the Hayward OmniLogic app.',
|
|
15800
15800
|
type: 'string',
|
|
15801
15801
|
},
|
|
15802
|
-
body_of_water_id: {
|
|
15803
|
-
description: 'ID of the body of water within its system. Only present on a pool or spa body.',
|
|
15804
|
-
type: 'string',
|
|
15805
|
-
},
|
|
15806
|
-
body_of_water_name: {
|
|
15807
|
-
description: 'Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body.',
|
|
15808
|
-
type: 'string',
|
|
15809
|
-
},
|
|
15810
|
-
is_shared_equipment: {
|
|
15811
|
-
description: 'Indicates whether the body of water shares its pump and heater with another body of water in the same system.',
|
|
15812
|
-
type: 'boolean',
|
|
15813
|
-
},
|
|
15814
15802
|
msp_system_id: {
|
|
15815
|
-
description: 'ID of the Hayward OmniLogic
|
|
15803
|
+
description: 'ID of the Hayward OmniLogic controller that the device belongs to.',
|
|
15816
15804
|
type: 'string',
|
|
15817
15805
|
},
|
|
15818
|
-
|
|
15819
|
-
description: '
|
|
15820
|
-
enum: ['high', 'low'],
|
|
15806
|
+
system_id: {
|
|
15807
|
+
description: 'ID of the pool or spa within its controller. Only present on a pool or spa.',
|
|
15821
15808
|
type: 'string',
|
|
15822
15809
|
},
|
|
15823
|
-
|
|
15824
|
-
description: '
|
|
15810
|
+
system_name: {
|
|
15811
|
+
description: 'Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa.',
|
|
15825
15812
|
type: 'string',
|
|
15826
15813
|
},
|
|
15827
15814
|
},
|
|
@@ -37639,7 +37626,7 @@ const openapi = {
|
|
|
37639
37626
|
},
|
|
37640
37627
|
{
|
|
37641
37628
|
description: 'Device type for pool controllers, pools, and spas.',
|
|
37642
|
-
enum: ['
|
|
37629
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
37643
37630
|
type: 'string',
|
|
37644
37631
|
'x-undocumented': 'Unreleased.',
|
|
37645
37632
|
},
|
|
@@ -51486,7 +51473,7 @@ const openapi = {
|
|
|
51486
51473
|
},
|
|
51487
51474
|
{
|
|
51488
51475
|
description: 'Device type for pool controllers, pools, and spas.',
|
|
51489
|
-
enum: ['
|
|
51476
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
51490
51477
|
type: 'string',
|
|
51491
51478
|
'x-undocumented': 'Unreleased.',
|
|
51492
51479
|
},
|
|
@@ -51593,7 +51580,7 @@ const openapi = {
|
|
|
51593
51580
|
},
|
|
51594
51581
|
{
|
|
51595
51582
|
description: 'Device type for pool controllers, pools, and spas.',
|
|
51596
|
-
enum: ['
|
|
51583
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
51597
51584
|
type: 'string',
|
|
51598
51585
|
'x-undocumented': 'Unreleased.',
|
|
51599
51586
|
},
|
|
@@ -51857,8 +51844,9 @@ const openapi = {
|
|
|
51857
51844
|
in: 'query',
|
|
51858
51845
|
name: 'parent_device_id',
|
|
51859
51846
|
schema: {
|
|
51860
|
-
description: 'ID of the parent device whose child devices you want to list.',
|
|
51847
|
+
description: 'ID of the parent device whose child devices you want to list. Specify `null` to list devices that have no parent device.',
|
|
51861
51848
|
format: 'uuid',
|
|
51849
|
+
nullable: true,
|
|
51862
51850
|
type: 'string',
|
|
51863
51851
|
'x-undocumented': 'Unreleased.',
|
|
51864
51852
|
},
|
|
@@ -53857,7 +53845,7 @@ const openapi = {
|
|
|
53857
53845
|
},
|
|
53858
53846
|
{
|
|
53859
53847
|
description: 'Device type for pool controllers, pools, and spas.',
|
|
53860
|
-
enum: ['
|
|
53848
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
53861
53849
|
type: 'string',
|
|
53862
53850
|
'x-undocumented': 'Unreleased.',
|
|
53863
53851
|
},
|
|
@@ -53964,7 +53952,7 @@ const openapi = {
|
|
|
53964
53952
|
},
|
|
53965
53953
|
{
|
|
53966
53954
|
description: 'Device type for pool controllers, pools, and spas.',
|
|
53967
|
-
enum: ['
|
|
53955
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
53968
53956
|
type: 'string',
|
|
53969
53957
|
'x-undocumented': 'Unreleased.',
|
|
53970
53958
|
},
|
|
@@ -54176,8 +54164,9 @@ const openapi = {
|
|
|
54176
54164
|
in: 'query',
|
|
54177
54165
|
name: 'parent_device_id',
|
|
54178
54166
|
schema: {
|
|
54179
|
-
description: 'ID of the parent device whose child devices you want to list.',
|
|
54167
|
+
description: 'ID of the parent device whose child devices you want to list. Specify `null` to list devices that have no parent device.',
|
|
54180
54168
|
format: 'uuid',
|
|
54169
|
+
nullable: true,
|
|
54181
54170
|
type: 'string',
|
|
54182
54171
|
'x-undocumented': 'Unreleased.',
|
|
54183
54172
|
},
|
|
@@ -56588,7 +56577,7 @@ const openapi = {
|
|
|
56588
56577
|
},
|
|
56589
56578
|
'/pools/heat': {
|
|
56590
56579
|
post: {
|
|
56591
|
-
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 `
|
|
56580
|
+
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 `temperature_setting_not_confirmed` if it never does. To check whether the water supports temperature control, use `device.can_control_temperature`.",
|
|
56592
56581
|
operationId: 'poolsHeatPost',
|
|
56593
56582
|
requestBody: {
|
|
56594
56583
|
content: {
|
|
@@ -56646,7 +56635,7 @@ const openapi = {
|
|
|
56646
56635
|
],
|
|
56647
56636
|
summary: '/pools/heat',
|
|
56648
56637
|
tags: [],
|
|
56649
|
-
'x-action-attempt-type': '
|
|
56638
|
+
'x-action-attempt-type': 'SET_TEMPERATURE_CONTROLLER_MODE',
|
|
56650
56639
|
'x-fern-sdk-group-name': ['pools'],
|
|
56651
56640
|
'x-fern-sdk-method-name': 'heat',
|
|
56652
56641
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
@@ -56692,7 +56681,7 @@ const openapi = {
|
|
|
56692
56681
|
name: 'device_type',
|
|
56693
56682
|
schema: {
|
|
56694
56683
|
description: 'Device type by which you want to filter pool devices.',
|
|
56695
|
-
enum: ['
|
|
56684
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
56696
56685
|
type: 'string',
|
|
56697
56686
|
'x-undocumented': 'Unreleased.',
|
|
56698
56687
|
},
|
|
@@ -56704,7 +56693,7 @@ const openapi = {
|
|
|
56704
56693
|
description: 'Array of device types by which you want to filter pool devices.',
|
|
56705
56694
|
items: {
|
|
56706
56695
|
description: 'Device type for pool controllers, pools, and spas.',
|
|
56707
|
-
enum: ['
|
|
56696
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
56708
56697
|
type: 'string',
|
|
56709
56698
|
'x-undocumented': 'Unreleased.',
|
|
56710
56699
|
},
|
|
@@ -56753,7 +56742,7 @@ const openapi = {
|
|
|
56753
56742
|
},
|
|
56754
56743
|
'/pools/turn_off': {
|
|
56755
56744
|
post: {
|
|
56756
|
-
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 `
|
|
56745
|
+
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 `temperature_setting_not_confirmed` if it never does. To check whether the water supports temperature control, use `device.can_control_temperature`.',
|
|
56757
56746
|
operationId: 'poolsTurnOffPost',
|
|
56758
56747
|
requestBody: {
|
|
56759
56748
|
content: {
|
|
@@ -56801,7 +56790,7 @@ const openapi = {
|
|
|
56801
56790
|
],
|
|
56802
56791
|
summary: '/pools/turn_off',
|
|
56803
56792
|
tags: [],
|
|
56804
|
-
'x-action-attempt-type': '
|
|
56793
|
+
'x-action-attempt-type': 'SET_TEMPERATURE_CONTROLLER_MODE',
|
|
56805
56794
|
'x-fern-sdk-group-name': ['pools'],
|
|
56806
56795
|
'x-fern-sdk-method-name': 'turn_off',
|
|
56807
56796
|
'x-fern-sdk-return-value': 'action_attempt',
|