@seamapi/types 1.1201.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/capability-properties/lock.js +1 -0
- package/lib/seam/connect/models/devices/capability-properties/lock.js.map +1 -1
- 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 +34 -43
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +457 -547
- 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/capability-properties/lock.ts +1 -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 +35 -46
- package/src/lib/seam/connect/route-types.ts +457 -581
- 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
package/package.json
CHANGED
|
@@ -19,9 +19,9 @@ import { scan_credential_action_attempt } from './scan-credential.js'
|
|
|
19
19
|
import { scan_to_assign_credential_action_attempt } from './scan-to-assign-credential.js'
|
|
20
20
|
import { set_fan_mode_action_attempt } from './set-fan-mode.js'
|
|
21
21
|
import { set_hvac_mode_action_attempt } from './set-hvac-mode.js'
|
|
22
|
-
import { set_pool_heating_action_attempt } from './set-pool-heating.js'
|
|
23
22
|
import { set_speaker_mute_action_attempt } from './set-speaker-mute.js'
|
|
24
23
|
import { set_speaker_volume_action_attempt } from './set-speaker-volume.js'
|
|
24
|
+
import { set_temperature_controller_mode_action_attempt } from './set-temperature-controller-mode.js'
|
|
25
25
|
import { simulate_keypad_code_entry_action_attempt } from './simulate-keypad-code-entry.js'
|
|
26
26
|
import { simulate_manual_lock_via_keypad_action_attempt } from './simulate-manual-lock-via-keypad.js'
|
|
27
27
|
import { unlock_door_action_attempt } from './unlock-door.js'
|
|
@@ -50,7 +50,7 @@ export const action_attempt = z.union([
|
|
|
50
50
|
...play_speaker_chime_action_attempt.options,
|
|
51
51
|
...play_speaker_favorite_action_attempt.options,
|
|
52
52
|
...play_speaker_audio_clip_action_attempt.options,
|
|
53
|
-
...
|
|
53
|
+
...set_temperature_controller_mode_action_attempt.options,
|
|
54
54
|
...deprecated_action_attempts,
|
|
55
55
|
]).describe(`
|
|
56
56
|
---
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import * as z from 'zod/v3'
|
|
2
|
+
|
|
3
|
+
import {
|
|
4
|
+
common_failed_action_attempt,
|
|
5
|
+
common_pending_action_attempt,
|
|
6
|
+
common_succeeded_action_attempt,
|
|
7
|
+
} from './common.js'
|
|
8
|
+
|
|
9
|
+
const action_type = z.literal('SET_TEMPERATURE_CONTROLLER_MODE').describe(`
|
|
10
|
+
---
|
|
11
|
+
undocumented: Unreleased.
|
|
12
|
+
---
|
|
13
|
+
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.
|
|
14
|
+
`)
|
|
15
|
+
|
|
16
|
+
const error = z
|
|
17
|
+
.object({
|
|
18
|
+
type: z.string().describe('Type of the error.'),
|
|
19
|
+
message: z
|
|
20
|
+
.string()
|
|
21
|
+
.describe(
|
|
22
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
23
|
+
),
|
|
24
|
+
})
|
|
25
|
+
.describe('Error associated with the action.')
|
|
26
|
+
|
|
27
|
+
const result = z.object({}).describe('Result of the action.')
|
|
28
|
+
|
|
29
|
+
export const set_temperature_controller_mode_action_attempt =
|
|
30
|
+
z.discriminatedUnion('status', [
|
|
31
|
+
common_pending_action_attempt.extend({
|
|
32
|
+
action_type,
|
|
33
|
+
}).describe(`
|
|
34
|
+
---
|
|
35
|
+
undocumented: Unreleased.
|
|
36
|
+
---
|
|
37
|
+
Setting the temperature controller mode is pending. The controller has not yet reported the requested state back.
|
|
38
|
+
`),
|
|
39
|
+
common_succeeded_action_attempt.extend({
|
|
40
|
+
action_type,
|
|
41
|
+
result,
|
|
42
|
+
}).describe(`
|
|
43
|
+
---
|
|
44
|
+
undocumented: Unreleased.
|
|
45
|
+
---
|
|
46
|
+
Setting the temperature controller mode succeeded. The controller reported the requested state back.
|
|
47
|
+
`),
|
|
48
|
+
common_failed_action_attempt.extend({ action_type, error }).describe(`
|
|
49
|
+
---
|
|
50
|
+
undocumented: Unreleased.
|
|
51
|
+
---
|
|
52
|
+
Setting the temperature controller mode failed.
|
|
53
|
+
`),
|
|
54
|
+
])
|
|
@@ -1576,41 +1576,25 @@ export const device_metadata = z
|
|
|
1576
1576
|
.string()
|
|
1577
1577
|
.optional()
|
|
1578
1578
|
.describe(
|
|
1579
|
-
'ID of the Hayward OmniLogic
|
|
1579
|
+
'ID of the Hayward OmniLogic controller that the device belongs to.',
|
|
1580
1580
|
),
|
|
1581
1581
|
backyard_name: z
|
|
1582
|
-
.string()
|
|
1583
|
-
.optional()
|
|
1584
|
-
.describe('Name of the system, as set in the Hayward OmniLogic app.'),
|
|
1585
|
-
body_of_water_id: z
|
|
1586
1582
|
.string()
|
|
1587
1583
|
.optional()
|
|
1588
1584
|
.describe(
|
|
1589
|
-
'
|
|
1585
|
+
'Name of the controller, as set in the Hayward OmniLogic app.',
|
|
1590
1586
|
),
|
|
1591
|
-
|
|
1587
|
+
system_id: z
|
|
1592
1588
|
.string()
|
|
1593
1589
|
.optional()
|
|
1594
1590
|
.describe(
|
|
1595
|
-
'
|
|
1591
|
+
'ID of the pool or spa within its controller. Only present on a pool or spa.',
|
|
1596
1592
|
),
|
|
1597
|
-
|
|
1593
|
+
system_name: z
|
|
1598
1594
|
.string()
|
|
1599
1595
|
.optional()
|
|
1600
1596
|
.describe(
|
|
1601
|
-
'
|
|
1602
|
-
),
|
|
1603
|
-
is_shared_equipment: z
|
|
1604
|
-
.boolean()
|
|
1605
|
-
.optional()
|
|
1606
|
-
.describe(
|
|
1607
|
-
'Indicates whether the body of water shares its pump and heater with another body of water in the same system.',
|
|
1608
|
-
),
|
|
1609
|
-
shared_equipment_priority: z
|
|
1610
|
-
.enum(['high', 'low'])
|
|
1611
|
-
.optional()
|
|
1612
|
-
.describe(
|
|
1613
|
-
'Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat.',
|
|
1597
|
+
'Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa.',
|
|
1614
1598
|
),
|
|
1615
1599
|
})
|
|
1616
1600
|
.partial()
|
|
@@ -1618,7 +1602,7 @@ export const device_metadata = z
|
|
|
1618
1602
|
---
|
|
1619
1603
|
undocumented: Unreleased.
|
|
1620
1604
|
---
|
|
1621
|
-
Metadata for a Hayward OmniLogic pool controller or
|
|
1605
|
+
Metadata for a Hayward OmniLogic pool controller, pool, or spa.
|
|
1622
1606
|
`),
|
|
1623
1607
|
})
|
|
1624
1608
|
.partial().describe(`
|
|
@@ -181,12 +181,12 @@ export const sensor_device_type = z
|
|
|
181
181
|
.describe('Device type for environmental sensors.')
|
|
182
182
|
|
|
183
183
|
export type SensorDeviceType = z.infer<typeof sensor_device_type>
|
|
184
|
-
export const
|
|
185
|
-
|
|
184
|
+
export const POOL_CONTROLLER_DEVICE_TYPE = {
|
|
185
|
+
HAYWARD_POOL_CONTROLLER: 'hayward_pool_controller',
|
|
186
186
|
} as const
|
|
187
187
|
|
|
188
188
|
export const POOL_DEVICE_TYPE = {
|
|
189
|
-
...
|
|
189
|
+
...POOL_CONTROLLER_DEVICE_TYPE,
|
|
190
190
|
HAYWARD_POOL: 'hayward_pool',
|
|
191
191
|
} as const
|
|
192
192
|
|
|
@@ -13037,7 +13037,7 @@ const openapi: OpenAPISpec = {
|
|
|
13037
13037
|
},
|
|
13038
13038
|
{
|
|
13039
13039
|
description:
|
|
13040
|
-
'Setting the
|
|
13040
|
+
'Setting the temperature controller mode is pending. The controller has not yet reported the requested state back.',
|
|
13041
13041
|
properties: {
|
|
13042
13042
|
action_attempt_id: {
|
|
13043
13043
|
description: 'ID of the action attempt.',
|
|
@@ -13046,8 +13046,8 @@ const openapi: OpenAPISpec = {
|
|
|
13046
13046
|
},
|
|
13047
13047
|
action_type: {
|
|
13048
13048
|
description:
|
|
13049
|
-
'Action attempt to track the status of heating pool or spa water to a set point
|
|
13050
|
-
enum: ['
|
|
13049
|
+
'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.',
|
|
13050
|
+
enum: ['SET_TEMPERATURE_CONTROLLER_MODE'],
|
|
13051
13051
|
type: 'string',
|
|
13052
13052
|
'x-undocumented': 'Unreleased.',
|
|
13053
13053
|
},
|
|
@@ -13075,7 +13075,7 @@ const openapi: OpenAPISpec = {
|
|
|
13075
13075
|
},
|
|
13076
13076
|
{
|
|
13077
13077
|
description:
|
|
13078
|
-
'Setting the
|
|
13078
|
+
'Setting the temperature controller mode succeeded. The controller reported the requested state back.',
|
|
13079
13079
|
properties: {
|
|
13080
13080
|
action_attempt_id: {
|
|
13081
13081
|
description: 'ID of the action attempt.',
|
|
@@ -13084,8 +13084,8 @@ const openapi: OpenAPISpec = {
|
|
|
13084
13084
|
},
|
|
13085
13085
|
action_type: {
|
|
13086
13086
|
description:
|
|
13087
|
-
'Action attempt to track the status of heating pool or spa water to a set point
|
|
13088
|
-
enum: ['
|
|
13087
|
+
'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.',
|
|
13088
|
+
enum: ['SET_TEMPERATURE_CONTROLLER_MODE'],
|
|
13089
13089
|
type: 'string',
|
|
13090
13090
|
'x-undocumented': 'Unreleased.',
|
|
13091
13091
|
},
|
|
@@ -13112,7 +13112,7 @@ const openapi: OpenAPISpec = {
|
|
|
13112
13112
|
'x-undocumented': 'Unreleased.',
|
|
13113
13113
|
},
|
|
13114
13114
|
{
|
|
13115
|
-
description: 'Setting the
|
|
13115
|
+
description: 'Setting the temperature controller mode failed.',
|
|
13116
13116
|
properties: {
|
|
13117
13117
|
action_attempt_id: {
|
|
13118
13118
|
description: 'ID of the action attempt.',
|
|
@@ -13121,8 +13121,8 @@ const openapi: OpenAPISpec = {
|
|
|
13121
13121
|
},
|
|
13122
13122
|
action_type: {
|
|
13123
13123
|
description:
|
|
13124
|
-
'Action attempt to track the status of heating pool or spa water to a set point
|
|
13125
|
-
enum: ['
|
|
13124
|
+
'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.',
|
|
13125
|
+
enum: ['SET_TEMPERATURE_CONTROLLER_MODE'],
|
|
13126
13126
|
type: 'string',
|
|
13127
13127
|
'x-undocumented': 'Unreleased.',
|
|
13128
13128
|
},
|
|
@@ -16255,7 +16255,7 @@ const openapi: OpenAPISpec = {
|
|
|
16255
16255
|
{
|
|
16256
16256
|
description:
|
|
16257
16257
|
'Device type for pool controllers, pools, and spas.',
|
|
16258
|
-
enum: ['
|
|
16258
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
16259
16259
|
type: 'string',
|
|
16260
16260
|
'x-undocumented': 'Unreleased.',
|
|
16261
16261
|
},
|
|
@@ -17793,42 +17793,26 @@ const openapi: OpenAPISpec = {
|
|
|
17793
17793
|
},
|
|
17794
17794
|
hayward_omnilogic_metadata: {
|
|
17795
17795
|
description:
|
|
17796
|
-
'Metadata for a Hayward OmniLogic pool controller or
|
|
17796
|
+
'Metadata for a Hayward OmniLogic pool controller, pool, or spa.',
|
|
17797
17797
|
properties: {
|
|
17798
17798
|
backyard_name: {
|
|
17799
17799
|
description:
|
|
17800
|
-
'Name of the
|
|
17800
|
+
'Name of the controller, as set in the Hayward OmniLogic app.',
|
|
17801
17801
|
type: 'string',
|
|
17802
17802
|
},
|
|
17803
|
-
body_of_water_id: {
|
|
17804
|
-
description:
|
|
17805
|
-
'ID of the body of water within its system. Only present on a pool or spa body.',
|
|
17806
|
-
type: 'string',
|
|
17807
|
-
},
|
|
17808
|
-
body_of_water_name: {
|
|
17809
|
-
description:
|
|
17810
|
-
'Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body.',
|
|
17811
|
-
type: 'string',
|
|
17812
|
-
},
|
|
17813
|
-
is_shared_equipment: {
|
|
17814
|
-
description:
|
|
17815
|
-
'Indicates whether the body of water shares its pump and heater with another body of water in the same system.',
|
|
17816
|
-
type: 'boolean',
|
|
17817
|
-
},
|
|
17818
17803
|
msp_system_id: {
|
|
17819
17804
|
description:
|
|
17820
|
-
'ID of the Hayward OmniLogic
|
|
17805
|
+
'ID of the Hayward OmniLogic controller that the device belongs to.',
|
|
17821
17806
|
type: 'string',
|
|
17822
17807
|
},
|
|
17823
|
-
|
|
17808
|
+
system_id: {
|
|
17824
17809
|
description:
|
|
17825
|
-
'
|
|
17826
|
-
enum: ['high', 'low'],
|
|
17810
|
+
'ID of the pool or spa within its controller. Only present on a pool or spa.',
|
|
17827
17811
|
type: 'string',
|
|
17828
17812
|
},
|
|
17829
|
-
|
|
17813
|
+
system_name: {
|
|
17830
17814
|
description:
|
|
17831
|
-
'
|
|
17815
|
+
'Name of the pool or spa, as set in the Hayward OmniLogic app. Only present on a pool or spa.',
|
|
17832
17816
|
type: 'string',
|
|
17833
17817
|
},
|
|
17834
17818
|
},
|
|
@@ -19179,6 +19163,7 @@ const openapi: OpenAPISpec = {
|
|
|
19179
19163
|
'x-property-group-key': 'access_codes',
|
|
19180
19164
|
},
|
|
19181
19165
|
keypad_battery: {
|
|
19166
|
+
deprecated: true,
|
|
19182
19167
|
description: 'Keypad battery status.',
|
|
19183
19168
|
properties: {
|
|
19184
19169
|
level: {
|
|
@@ -19190,6 +19175,8 @@ const openapi: OpenAPISpec = {
|
|
|
19190
19175
|
},
|
|
19191
19176
|
required: ['level'],
|
|
19192
19177
|
type: 'object',
|
|
19178
|
+
'x-deprecated':
|
|
19179
|
+
'Use `accessory_keypad.battery` instead.',
|
|
19193
19180
|
'x-property-group-key': 'access_codes',
|
|
19194
19181
|
},
|
|
19195
19182
|
locked: {
|
|
@@ -42129,7 +42116,7 @@ const openapi: OpenAPISpec = {
|
|
|
42129
42116
|
{
|
|
42130
42117
|
description:
|
|
42131
42118
|
'Device type for pool controllers, pools, and spas.',
|
|
42132
|
-
enum: ['
|
|
42119
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
42133
42120
|
type: 'string',
|
|
42134
42121
|
'x-undocumented': 'Unreleased.',
|
|
42135
42122
|
},
|
|
@@ -57108,7 +57095,7 @@ const openapi: OpenAPISpec = {
|
|
|
57108
57095
|
{
|
|
57109
57096
|
description:
|
|
57110
57097
|
'Device type for pool controllers, pools, and spas.',
|
|
57111
|
-
enum: ['
|
|
57098
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
57112
57099
|
type: 'string',
|
|
57113
57100
|
'x-undocumented': 'Unreleased.',
|
|
57114
57101
|
},
|
|
@@ -57217,7 +57204,7 @@ const openapi: OpenAPISpec = {
|
|
|
57217
57204
|
{
|
|
57218
57205
|
description:
|
|
57219
57206
|
'Device type for pool controllers, pools, and spas.',
|
|
57220
|
-
enum: ['
|
|
57207
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
57221
57208
|
type: 'string',
|
|
57222
57209
|
'x-undocumented': 'Unreleased.',
|
|
57223
57210
|
},
|
|
@@ -57490,8 +57477,9 @@ const openapi: OpenAPISpec = {
|
|
|
57490
57477
|
name: 'parent_device_id',
|
|
57491
57478
|
schema: {
|
|
57492
57479
|
description:
|
|
57493
|
-
'ID of the parent device whose child devices you want to list.',
|
|
57480
|
+
'ID of the parent device whose child devices you want to list. Specify `null` to list devices that have no parent device.',
|
|
57494
57481
|
format: 'uuid',
|
|
57482
|
+
nullable: true,
|
|
57495
57483
|
type: 'string',
|
|
57496
57484
|
'x-undocumented': 'Unreleased.',
|
|
57497
57485
|
},
|
|
@@ -59512,7 +59500,7 @@ const openapi: OpenAPISpec = {
|
|
|
59512
59500
|
{
|
|
59513
59501
|
description:
|
|
59514
59502
|
'Device type for pool controllers, pools, and spas.',
|
|
59515
|
-
enum: ['
|
|
59503
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
59516
59504
|
type: 'string',
|
|
59517
59505
|
'x-undocumented': 'Unreleased.',
|
|
59518
59506
|
},
|
|
@@ -59621,7 +59609,7 @@ const openapi: OpenAPISpec = {
|
|
|
59621
59609
|
{
|
|
59622
59610
|
description:
|
|
59623
59611
|
'Device type for pool controllers, pools, and spas.',
|
|
59624
|
-
enum: ['
|
|
59612
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
59625
59613
|
type: 'string',
|
|
59626
59614
|
'x-undocumented': 'Unreleased.',
|
|
59627
59615
|
},
|
|
@@ -59838,8 +59826,9 @@ const openapi: OpenAPISpec = {
|
|
|
59838
59826
|
name: 'parent_device_id',
|
|
59839
59827
|
schema: {
|
|
59840
59828
|
description:
|
|
59841
|
-
'ID of the parent device whose child devices you want to list.',
|
|
59829
|
+
'ID of the parent device whose child devices you want to list. Specify `null` to list devices that have no parent device.',
|
|
59842
59830
|
format: 'uuid',
|
|
59831
|
+
nullable: true,
|
|
59843
59832
|
type: 'string',
|
|
59844
59833
|
'x-undocumented': 'Unreleased.',
|
|
59845
59834
|
},
|
|
@@ -62355,7 +62344,7 @@ const openapi: OpenAPISpec = {
|
|
|
62355
62344
|
'/pools/heat': {
|
|
62356
62345
|
post: {
|
|
62357
62346
|
description:
|
|
62358
|
-
"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 `
|
|
62347
|
+
"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`.",
|
|
62359
62348
|
operationId: 'poolsHeatPost',
|
|
62360
62349
|
requestBody: {
|
|
62361
62350
|
content: {
|
|
@@ -62416,7 +62405,7 @@ const openapi: OpenAPISpec = {
|
|
|
62416
62405
|
],
|
|
62417
62406
|
summary: '/pools/heat',
|
|
62418
62407
|
tags: [],
|
|
62419
|
-
'x-action-attempt-type': '
|
|
62408
|
+
'x-action-attempt-type': 'SET_TEMPERATURE_CONTROLLER_MODE',
|
|
62420
62409
|
'x-fern-sdk-group-name': ['pools'],
|
|
62421
62410
|
'x-fern-sdk-method-name': 'heat',
|
|
62422
62411
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
@@ -62466,7 +62455,7 @@ const openapi: OpenAPISpec = {
|
|
|
62466
62455
|
schema: {
|
|
62467
62456
|
description:
|
|
62468
62457
|
'Device type by which you want to filter pool devices.',
|
|
62469
|
-
enum: ['
|
|
62458
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
62470
62459
|
type: 'string',
|
|
62471
62460
|
'x-undocumented': 'Unreleased.',
|
|
62472
62461
|
},
|
|
@@ -62480,7 +62469,7 @@ const openapi: OpenAPISpec = {
|
|
|
62480
62469
|
items: {
|
|
62481
62470
|
description:
|
|
62482
62471
|
'Device type for pool controllers, pools, and spas.',
|
|
62483
|
-
enum: ['
|
|
62472
|
+
enum: ['hayward_pool_controller', 'hayward_pool'],
|
|
62484
62473
|
type: 'string',
|
|
62485
62474
|
'x-undocumented': 'Unreleased.',
|
|
62486
62475
|
},
|
|
@@ -62530,7 +62519,7 @@ const openapi: OpenAPISpec = {
|
|
|
62530
62519
|
'/pools/turn_off': {
|
|
62531
62520
|
post: {
|
|
62532
62521
|
description:
|
|
62533
|
-
'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 `
|
|
62522
|
+
'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`.',
|
|
62534
62523
|
operationId: 'poolsTurnOffPost',
|
|
62535
62524
|
requestBody: {
|
|
62536
62525
|
content: {
|
|
@@ -62579,7 +62568,7 @@ const openapi: OpenAPISpec = {
|
|
|
62579
62568
|
],
|
|
62580
62569
|
summary: '/pools/turn_off',
|
|
62581
62570
|
tags: [],
|
|
62582
|
-
'x-action-attempt-type': '
|
|
62571
|
+
'x-action-attempt-type': 'SET_TEMPERATURE_CONTROLLER_MODE',
|
|
62583
62572
|
'x-fern-sdk-group-name': ['pools'],
|
|
62584
62573
|
'x-fern-sdk-method-name': 'turn_off',
|
|
62585
62574
|
'x-fern-sdk-return-value': 'action_attempt',
|