@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.
Files changed (32) hide show
  1. package/lib/seam/connect/models/acs/acs-system.d.ts +4 -4
  2. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +9 -9
  3. package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -2
  4. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  5. package/lib/seam/connect/models/action-attempts/{set-pool-heating.d.ts → set-temperature-controller-mode.d.ts} +10 -10
  6. package/lib/seam/connect/models/action-attempts/{set-pool-heating.js → set-temperature-controller-mode.js} +7 -7
  7. package/lib/seam/connect/models/action-attempts/set-temperature-controller-mode.js.map +1 -0
  8. package/lib/seam/connect/models/devices/capability-properties/lock.js +1 -0
  9. package/lib/seam/connect/models/devices/capability-properties/lock.js.map +1 -1
  10. package/lib/seam/connect/models/devices/device-metadata.d.ts +10 -25
  11. package/lib/seam/connect/models/devices/device-metadata.js +7 -19
  12. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  13. package/lib/seam/connect/models/devices/device-type.d.ts +4 -4
  14. package/lib/seam/connect/models/devices/device-type.js +3 -3
  15. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  16. package/lib/seam/connect/models/devices/device.d.ts +27 -48
  17. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +23 -38
  18. package/lib/seam/connect/models/events/devices.d.ts +4 -4
  19. package/lib/seam/connect/models/events/seam-event.d.ts +2 -2
  20. package/lib/seam/connect/openapi.js +34 -43
  21. package/lib/seam/connect/openapi.js.map +1 -1
  22. package/lib/seam/connect/route-types.d.ts +457 -547
  23. package/package.json +1 -1
  24. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -2
  25. package/src/lib/seam/connect/models/action-attempts/set-temperature-controller-mode.ts +54 -0
  26. package/src/lib/seam/connect/models/devices/capability-properties/lock.ts +1 -0
  27. package/src/lib/seam/connect/models/devices/device-metadata.ts +7 -23
  28. package/src/lib/seam/connect/models/devices/device-type.ts +3 -3
  29. package/src/lib/seam/connect/openapi.ts +35 -46
  30. package/src/lib/seam/connect/route-types.ts +457 -581
  31. package/lib/seam/connect/models/action-attempts/set-pool-heating.js.map +0 -1
  32. 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 pool heating is pending. The controller has not yet reported the requested state back.',
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, or turning its heating off. The attempt succeeds only once the controller reports the requested state back.',
11505
- enum: ['SET_POOL_HEATING'],
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 pool heating succeeded. The controller reported the requested state back.',
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, or turning its heating off. The attempt succeeds only once the controller reports the requested state back.',
11539
- enum: ['SET_POOL_HEATING'],
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 pool heating failed.',
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, or turning its heating off. The attempt succeeds only once the controller reports the requested state back.',
11574
- enum: ['SET_POOL_HEATING'],
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: ['hayward_pool_system', 'hayward_pool'],
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 body of water.',
15796
+ description: 'Metadata for a Hayward OmniLogic pool controller, pool, or spa.',
15797
15797
  properties: {
15798
15798
  backyard_name: {
15799
- description: 'Name of the system, as set in the Hayward OmniLogic app.',
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 system (the controller, called an MSP by Hayward) that the device belongs to.',
15803
+ description: 'ID of the Hayward OmniLogic controller that the device belongs to.',
15816
15804
  type: 'string',
15817
15805
  },
15818
- shared_equipment_priority: {
15819
- description: '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.',
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
- virtual_heater_id: {
15824
- description: 'ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body.',
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
  },
@@ -17054,6 +17041,7 @@ const openapi = {
17054
17041
  'x-property-group-key': 'access_codes',
17055
17042
  },
17056
17043
  keypad_battery: {
17044
+ deprecated: true,
17057
17045
  description: 'Keypad battery status.',
17058
17046
  properties: {
17059
17047
  level: {
@@ -17064,6 +17052,7 @@ const openapi = {
17064
17052
  },
17065
17053
  required: ['level'],
17066
17054
  type: 'object',
17055
+ 'x-deprecated': 'Use `accessory_keypad.battery` instead.',
17067
17056
  'x-property-group-key': 'access_codes',
17068
17057
  },
17069
17058
  locked: {
@@ -37637,7 +37626,7 @@ const openapi = {
37637
37626
  },
37638
37627
  {
37639
37628
  description: 'Device type for pool controllers, pools, and spas.',
37640
- enum: ['hayward_pool_system', 'hayward_pool'],
37629
+ enum: ['hayward_pool_controller', 'hayward_pool'],
37641
37630
  type: 'string',
37642
37631
  'x-undocumented': 'Unreleased.',
37643
37632
  },
@@ -51484,7 +51473,7 @@ const openapi = {
51484
51473
  },
51485
51474
  {
51486
51475
  description: 'Device type for pool controllers, pools, and spas.',
51487
- enum: ['hayward_pool_system', 'hayward_pool'],
51476
+ enum: ['hayward_pool_controller', 'hayward_pool'],
51488
51477
  type: 'string',
51489
51478
  'x-undocumented': 'Unreleased.',
51490
51479
  },
@@ -51591,7 +51580,7 @@ const openapi = {
51591
51580
  },
51592
51581
  {
51593
51582
  description: 'Device type for pool controllers, pools, and spas.',
51594
- enum: ['hayward_pool_system', 'hayward_pool'],
51583
+ enum: ['hayward_pool_controller', 'hayward_pool'],
51595
51584
  type: 'string',
51596
51585
  'x-undocumented': 'Unreleased.',
51597
51586
  },
@@ -51855,8 +51844,9 @@ const openapi = {
51855
51844
  in: 'query',
51856
51845
  name: 'parent_device_id',
51857
51846
  schema: {
51858
- 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.',
51859
51848
  format: 'uuid',
51849
+ nullable: true,
51860
51850
  type: 'string',
51861
51851
  'x-undocumented': 'Unreleased.',
51862
51852
  },
@@ -53855,7 +53845,7 @@ const openapi = {
53855
53845
  },
53856
53846
  {
53857
53847
  description: 'Device type for pool controllers, pools, and spas.',
53858
- enum: ['hayward_pool_system', 'hayward_pool'],
53848
+ enum: ['hayward_pool_controller', 'hayward_pool'],
53859
53849
  type: 'string',
53860
53850
  'x-undocumented': 'Unreleased.',
53861
53851
  },
@@ -53962,7 +53952,7 @@ const openapi = {
53962
53952
  },
53963
53953
  {
53964
53954
  description: 'Device type for pool controllers, pools, and spas.',
53965
- enum: ['hayward_pool_system', 'hayward_pool'],
53955
+ enum: ['hayward_pool_controller', 'hayward_pool'],
53966
53956
  type: 'string',
53967
53957
  'x-undocumented': 'Unreleased.',
53968
53958
  },
@@ -54174,8 +54164,9 @@ const openapi = {
54174
54164
  in: 'query',
54175
54165
  name: 'parent_device_id',
54176
54166
  schema: {
54177
- 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.',
54178
54168
  format: 'uuid',
54169
+ nullable: true,
54179
54170
  type: 'string',
54180
54171
  'x-undocumented': 'Unreleased.',
54181
54172
  },
@@ -56586,7 +56577,7 @@ const openapi = {
56586
56577
  },
56587
56578
  '/pools/heat': {
56588
56579
  post: {
56589
- 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`.",
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`.",
56590
56581
  operationId: 'poolsHeatPost',
56591
56582
  requestBody: {
56592
56583
  content: {
@@ -56644,7 +56635,7 @@ const openapi = {
56644
56635
  ],
56645
56636
  summary: '/pools/heat',
56646
56637
  tags: [],
56647
- 'x-action-attempt-type': 'SET_POOL_HEATING',
56638
+ 'x-action-attempt-type': 'SET_TEMPERATURE_CONTROLLER_MODE',
56648
56639
  'x-fern-sdk-group-name': ['pools'],
56649
56640
  'x-fern-sdk-method-name': 'heat',
56650
56641
  'x-fern-sdk-return-value': 'action_attempt',
@@ -56690,7 +56681,7 @@ const openapi = {
56690
56681
  name: 'device_type',
56691
56682
  schema: {
56692
56683
  description: 'Device type by which you want to filter pool devices.',
56693
- enum: ['hayward_pool_system', 'hayward_pool'],
56684
+ enum: ['hayward_pool_controller', 'hayward_pool'],
56694
56685
  type: 'string',
56695
56686
  'x-undocumented': 'Unreleased.',
56696
56687
  },
@@ -56702,7 +56693,7 @@ const openapi = {
56702
56693
  description: 'Array of device types by which you want to filter pool devices.',
56703
56694
  items: {
56704
56695
  description: 'Device type for pool controllers, pools, and spas.',
56705
- enum: ['hayward_pool_system', 'hayward_pool'],
56696
+ enum: ['hayward_pool_controller', 'hayward_pool'],
56706
56697
  type: 'string',
56707
56698
  'x-undocumented': 'Unreleased.',
56708
56699
  },
@@ -56751,7 +56742,7 @@ const openapi = {
56751
56742
  },
56752
56743
  '/pools/turn_off': {
56753
56744
  post: {
56754
- 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`.',
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`.',
56755
56746
  operationId: 'poolsTurnOffPost',
56756
56747
  requestBody: {
56757
56748
  content: {
@@ -56799,7 +56790,7 @@ const openapi = {
56799
56790
  ],
56800
56791
  summary: '/pools/turn_off',
56801
56792
  tags: [],
56802
- 'x-action-attempt-type': 'SET_POOL_HEATING',
56793
+ 'x-action-attempt-type': 'SET_TEMPERATURE_CONTROLLER_MODE',
56803
56794
  'x-fern-sdk-group-name': ['pools'],
56804
56795
  'x-fern-sdk-method-name': 'turn_off',
56805
56796
  'x-fern-sdk-return-value': 'action_attempt',