@seamapi/types 1.1191.0 → 1.1193.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.
@@ -223,6 +223,16 @@ const salto_ks_subscription_limit_almost_reached = common_acs_system_warning
223
223
  'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue.',
224
224
  )
225
225
 
226
+ const salto_ks_custom_pins_not_supported = common_acs_system_warning
227
+ .extend({
228
+ warning_code: z
229
+ .literal('salto_ks_custom_pins_not_supported')
230
+ .describe(warning_code_description),
231
+ })
232
+ .describe(
233
+ "Indicates that the Salto KS site does not accept custom PIN codes, either because its Salto subscription does not include the Custom PIN feature or because Custom PIN is turned off in the site's settings. Salto KS generates every PIN on the site, so a PIN code requested on an access grant or reservation is replaced with a Salto-generated one. The message says which of the two applies.",
234
+ )
235
+
226
236
  const time_zone_does_not_match_location = common_acs_system_warning
227
237
  .extend({
228
238
  warning_code: z
@@ -267,6 +277,7 @@ const unknown_issue_with_acs_system = common_acs_system_warning.extend({
267
277
  const acs_system_warning = z
268
278
  .discriminatedUnion('warning_code', [
269
279
  salto_ks_subscription_limit_almost_reached,
280
+ salto_ks_custom_pins_not_supported,
270
281
  time_zone_does_not_match_location,
271
282
  setup_required,
272
283
  unknown_issue_with_acs_system,
@@ -278,6 +289,8 @@ const acs_system_warning = z
278
289
  const _acs_system_warning_map = z.object({
279
290
  salto_ks_subscription_limit_almost_reached:
280
291
  salto_ks_subscription_limit_almost_reached.optional(),
292
+ salto_ks_custom_pins_not_supported:
293
+ salto_ks_custom_pins_not_supported.optional(),
281
294
  time_zone_does_not_match_location:
282
295
  time_zone_does_not_match_location.optional(),
283
296
  setup_required: setup_required.optional(),
@@ -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 =
@@ -5416,6 +5416,31 @@ const openapi: OpenAPISpec = {
5416
5416
  required: ['created_at', 'message', 'warning_code'],
5417
5417
  type: 'object',
5418
5418
  },
5419
+ {
5420
+ description:
5421
+ "Indicates that the Salto KS site does not accept custom PIN codes, either because its Salto subscription does not include the Custom PIN feature or because Custom PIN is turned off in the site's settings. Salto KS generates every PIN on the site, so a PIN code requested on an access grant or reservation is replaced with a Salto-generated one. The message says which of the two applies.",
5422
+ properties: {
5423
+ created_at: {
5424
+ description:
5425
+ 'Date and time at which Seam created the warning.',
5426
+ format: 'date-time',
5427
+ type: 'string',
5428
+ },
5429
+ message: {
5430
+ description:
5431
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
5432
+ type: 'string',
5433
+ },
5434
+ warning_code: {
5435
+ description:
5436
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5437
+ enum: ['salto_ks_custom_pins_not_supported'],
5438
+ type: 'string',
5439
+ },
5440
+ },
5441
+ required: ['created_at', 'message', 'warning_code'],
5442
+ type: 'object',
5443
+ },
5419
5444
  {
5420
5445
  description:
5421
5446
  'Indicates the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
@@ -17740,6 +17765,50 @@ const openapi: OpenAPISpec = {
17740
17765
  },
17741
17766
  type: 'object',
17742
17767
  },
17768
+ hayward_omnilogic_metadata: {
17769
+ description:
17770
+ 'Metadata for a Hayward OmniLogic pool controller or body of water.',
17771
+ properties: {
17772
+ backyard_name: {
17773
+ description:
17774
+ 'Name of the system, as set in the Hayward OmniLogic app.',
17775
+ type: 'string',
17776
+ },
17777
+ body_of_water_id: {
17778
+ description:
17779
+ 'ID of the body of water within its system. Only present on a pool or spa body.',
17780
+ type: 'string',
17781
+ },
17782
+ body_of_water_name: {
17783
+ description:
17784
+ 'Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body.',
17785
+ type: 'string',
17786
+ },
17787
+ is_shared_equipment: {
17788
+ description:
17789
+ 'Indicates whether the body of water shares its pump and heater with another body of water in the same system.',
17790
+ type: 'boolean',
17791
+ },
17792
+ msp_system_id: {
17793
+ description:
17794
+ 'ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to.',
17795
+ type: 'string',
17796
+ },
17797
+ shared_equipment_priority: {
17798
+ description:
17799
+ '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.',
17800
+ enum: ['high', 'low'],
17801
+ type: 'string',
17802
+ },
17803
+ virtual_heater_id: {
17804
+ description:
17805
+ '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.',
17806
+ type: 'string',
17807
+ },
17808
+ },
17809
+ type: 'object',
17810
+ 'x-undocumented': 'Unreleased.',
17811
+ },
17743
17812
  honeywell_resideo_metadata: {
17744
17813
  description: 'Metadata for a Honeywell Resideo device.',
17745
17814
  properties: {
@@ -21370,6 +21439,7 @@ const openapi: OpenAPISpec = {
21370
21439
  'aqara',
21371
21440
  'eufy',
21372
21441
  'sonos',
21442
+ 'hayward_omnilogic',
21373
21443
  ],
21374
21444
  type: 'string',
21375
21445
  },
@@ -52851,6 +52921,7 @@ const openapi: OpenAPISpec = {
52851
52921
  'aqara',
52852
52922
  'eufy',
52853
52923
  'sonos',
52924
+ 'hayward_omnilogic',
52854
52925
  'hid_cm',
52855
52926
  'google_nest',
52856
52927
  'slack',
@@ -57026,6 +57097,7 @@ const openapi: OpenAPISpec = {
57026
57097
  'slack',
57027
57098
  'yacan',
57028
57099
  'sonos',
57100
+ 'hayward_omnilogic',
57029
57101
  ],
57030
57102
  type: 'string',
57031
57103
  },
@@ -59422,6 +59494,7 @@ const openapi: OpenAPISpec = {
59422
59494
  'slack',
59423
59495
  'yacan',
59424
59496
  'sonos',
59497
+ 'hayward_omnilogic',
59425
59498
  ],
59426
59499
  type: 'string',
59427
59500
  },