@seamapi/types 1.1190.0 → 1.1192.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1190.0",
3
+ "version": "1.1192.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -1492,6 +1492,56 @@ export const device_metadata = z
1492
1492
  ---
1493
1493
  Metadata for a Sonos speaker.
1494
1494
  `),
1495
+ hayward_omnilogic_metadata: z
1496
+ .object({
1497
+ msp_system_id: z
1498
+ .string()
1499
+ .optional()
1500
+ .describe(
1501
+ 'ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to.',
1502
+ ),
1503
+ backyard_name: z
1504
+ .string()
1505
+ .optional()
1506
+ .describe('Name of the system, as set in the Hayward OmniLogic app.'),
1507
+ body_of_water_id: z
1508
+ .string()
1509
+ .optional()
1510
+ .describe(
1511
+ 'ID of the body of water within its system. Only present on a pool or spa body.',
1512
+ ),
1513
+ body_of_water_name: z
1514
+ .string()
1515
+ .optional()
1516
+ .describe(
1517
+ 'Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body.',
1518
+ ),
1519
+ virtual_heater_id: z
1520
+ .string()
1521
+ .optional()
1522
+ .describe(
1523
+ '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.',
1524
+ ),
1525
+ is_shared_equipment: z
1526
+ .boolean()
1527
+ .optional()
1528
+ .describe(
1529
+ 'Indicates whether the body of water shares its pump and heater with another body of water in the same system.',
1530
+ ),
1531
+ shared_equipment_priority: z
1532
+ .enum(['high', 'low'])
1533
+ .optional()
1534
+ .describe(
1535
+ '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.',
1536
+ ),
1537
+ })
1538
+ .partial()
1539
+ .optional().describe(`
1540
+ ---
1541
+ undocumented: Unreleased.
1542
+ ---
1543
+ Metadata for a Hayward OmniLogic pool controller or body of water.
1544
+ `),
1495
1545
  })
1496
1546
  .partial().describe(`
1497
1547
  ---
@@ -79,6 +79,7 @@ export const DEVICE_PROVIDERS = {
79
79
  AQARA: 'aqara',
80
80
  EUFY: 'eufy',
81
81
  SONOS: 'sonos',
82
+ HAYWARD_OMNILOGIC: 'hayward_omnilogic',
82
83
  } as const
83
84
 
84
85
  export type DeviceProviderName =
@@ -1400,6 +1400,18 @@ export const device = z
1400
1400
  'Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).',
1401
1401
  ),
1402
1402
  custom_metadata,
1403
+ parent_device_id: z.string().uuid().optional().describe(`
1404
+ ---
1405
+ undocumented: Unreleased.
1406
+ ---
1407
+ ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent.
1408
+ `),
1409
+ child_device_ids: z.array(z.string().uuid()).optional().describe(`
1410
+ ---
1411
+ undocumented: Unreleased.
1412
+ ---
1413
+ IDs of the child devices that belong to this device. Only present when the device has at least one child.
1414
+ `),
1403
1415
  device_provider: device_provider_info.optional().describe(`
1404
1416
  ---
1405
1417
  property_group_key: hardware
@@ -16014,6 +16014,13 @@ const openapi: OpenAPISpec = {
16014
16014
  },
16015
16015
  type: 'array',
16016
16016
  },
16017
+ child_device_ids: {
16018
+ description:
16019
+ 'IDs of the child devices that belong to this device. Only present when the device has at least one child.',
16020
+ items: { format: 'uuid', type: 'string' },
16021
+ type: 'array',
16022
+ 'x-undocumented': 'Unreleased.',
16023
+ },
16017
16024
  co2_ppm: {
16018
16025
  description:
16019
16026
  'Carbon dioxide concentration in parts per million, if the device measures it.',
@@ -16992,6 +16999,13 @@ const openapi: OpenAPISpec = {
16992
16999
  type: 'number',
16993
17000
  'x-property-group-key': 'sensors',
16994
17001
  },
17002
+ parent_device_id: {
17003
+ description:
17004
+ 'ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent.',
17005
+ format: 'uuid',
17006
+ type: 'string',
17007
+ 'x-undocumented': 'Unreleased.',
17008
+ },
16995
17009
  properties: {
16996
17010
  allOf: [
16997
17011
  {
@@ -17726,6 +17740,50 @@ const openapi: OpenAPISpec = {
17726
17740
  },
17727
17741
  type: 'object',
17728
17742
  },
17743
+ hayward_omnilogic_metadata: {
17744
+ description:
17745
+ 'Metadata for a Hayward OmniLogic pool controller or body of water.',
17746
+ properties: {
17747
+ backyard_name: {
17748
+ description:
17749
+ 'Name of the system, as set in the Hayward OmniLogic app.',
17750
+ type: 'string',
17751
+ },
17752
+ body_of_water_id: {
17753
+ description:
17754
+ 'ID of the body of water within its system. Only present on a pool or spa body.',
17755
+ type: 'string',
17756
+ },
17757
+ body_of_water_name: {
17758
+ description:
17759
+ 'Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body.',
17760
+ type: 'string',
17761
+ },
17762
+ is_shared_equipment: {
17763
+ description:
17764
+ 'Indicates whether the body of water shares its pump and heater with another body of water in the same system.',
17765
+ type: 'boolean',
17766
+ },
17767
+ msp_system_id: {
17768
+ description:
17769
+ 'ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to.',
17770
+ type: 'string',
17771
+ },
17772
+ shared_equipment_priority: {
17773
+ description:
17774
+ '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.',
17775
+ enum: ['high', 'low'],
17776
+ type: 'string',
17777
+ },
17778
+ virtual_heater_id: {
17779
+ description:
17780
+ '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.',
17781
+ type: 'string',
17782
+ },
17783
+ },
17784
+ type: 'object',
17785
+ 'x-undocumented': 'Unreleased.',
17786
+ },
17729
17787
  honeywell_resideo_metadata: {
17730
17788
  description: 'Metadata for a Honeywell Resideo device.',
17731
17789
  properties: {
@@ -21356,6 +21414,7 @@ const openapi: OpenAPISpec = {
21356
21414
  'aqara',
21357
21415
  'eufy',
21358
21416
  'sonos',
21417
+ 'hayward_omnilogic',
21359
21418
  ],
21360
21419
  type: 'string',
21361
21420
  },
@@ -52837,6 +52896,7 @@ const openapi: OpenAPISpec = {
52837
52896
  'aqara',
52838
52897
  'eufy',
52839
52898
  'sonos',
52899
+ 'hayward_omnilogic',
52840
52900
  'hid_cm',
52841
52901
  'google_nest',
52842
52902
  'slack',
@@ -57012,6 +57072,7 @@ const openapi: OpenAPISpec = {
57012
57072
  'slack',
57013
57073
  'yacan',
57014
57074
  'sonos',
57075
+ 'hayward_omnilogic',
57015
57076
  ],
57016
57077
  type: 'string',
57017
57078
  },
@@ -57199,6 +57260,17 @@ const openapi: OpenAPISpec = {
57199
57260
  type: 'string',
57200
57261
  },
57201
57262
  },
57263
+ {
57264
+ in: 'query',
57265
+ name: 'parent_device_id',
57266
+ schema: {
57267
+ description:
57268
+ 'ID of the parent device whose child devices you want to list.',
57269
+ format: 'uuid',
57270
+ type: 'string',
57271
+ 'x-undocumented': 'Unreleased.',
57272
+ },
57273
+ },
57202
57274
  ],
57203
57275
  responses: {
57204
57276
  '200': {
@@ -59397,6 +59469,7 @@ const openapi: OpenAPISpec = {
59397
59469
  'slack',
59398
59470
  'yacan',
59399
59471
  'sonos',
59472
+ 'hayward_omnilogic',
59400
59473
  ],
59401
59474
  type: 'string',
59402
59475
  },
@@ -59529,6 +59602,17 @@ const openapi: OpenAPISpec = {
59529
59602
  type: 'string',
59530
59603
  },
59531
59604
  },
59605
+ {
59606
+ in: 'query',
59607
+ name: 'parent_device_id',
59608
+ schema: {
59609
+ description:
59610
+ 'ID of the parent device whose child devices you want to list.',
59611
+ format: 'uuid',
59612
+ type: 'string',
59613
+ 'x-undocumented': 'Unreleased.',
59614
+ },
59615
+ },
59532
59616
  {
59533
59617
  in: 'query',
59534
59618
  name: 'limit',
@@ -62139,7 +62223,8 @@ const openapi: OpenAPISpec = {
62139
62223
  },
62140
62224
  '/pools/list': {
62141
62225
  get: {
62142
- description: 'Returns a list of all pool controllers, pools, and spas.',
62226
+ description:
62227
+ 'Returns a list of all pool controllers, pools, and spas. Each controller lists its pools and spas in `child_device_ids`, and each pool or spa carries its controller in `parent_device_id`.',
62143
62228
  operationId: 'poolsListGet',
62144
62229
  parameters: [
62145
62230
  {