@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.
@@ -143,10 +143,10 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
143
143
  level: z.ZodNumber;
144
144
  status: z.ZodEnum<["critical", "low", "good", "full"]>;
145
145
  }, "strip", z.ZodTypeAny, {
146
- status: "critical" | "low" | "good" | "full";
146
+ status: "low" | "critical" | "good" | "full";
147
147
  level: number;
148
148
  }, {
149
- status: "critical" | "low" | "good" | "full";
149
+ status: "low" | "critical" | "good" | "full";
150
150
  level: number;
151
151
  }>>;
152
152
  manufacturer: z.ZodOptional<z.ZodString>;
@@ -175,7 +175,7 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
175
175
  name: string;
176
176
  };
177
177
  battery?: {
178
- status: "critical" | "low" | "good" | "full";
178
+ status: "low" | "critical" | "good" | "full";
179
179
  level: number;
180
180
  } | undefined;
181
181
  image_url?: string | undefined;
@@ -212,7 +212,7 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
212
212
  name: string;
213
213
  };
214
214
  battery?: {
215
- status: "critical" | "low" | "good" | "full";
215
+ status: "low" | "critical" | "good" | "full";
216
216
  level: number;
217
217
  } | undefined;
218
218
  image_url?: string | undefined;
@@ -1470,6 +1470,31 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
1470
1470
  software_version?: string | undefined;
1471
1471
  bonded_member_models?: string[] | undefined;
1472
1472
  }>>>;
1473
+ hayward_omnilogic_metadata: z.ZodOptional<z.ZodOptional<z.ZodObject<{
1474
+ msp_system_id: z.ZodOptional<z.ZodOptional<z.ZodString>>;
1475
+ backyard_name: z.ZodOptional<z.ZodOptional<z.ZodString>>;
1476
+ body_of_water_id: z.ZodOptional<z.ZodOptional<z.ZodString>>;
1477
+ body_of_water_name: z.ZodOptional<z.ZodOptional<z.ZodString>>;
1478
+ virtual_heater_id: z.ZodOptional<z.ZodOptional<z.ZodString>>;
1479
+ is_shared_equipment: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
1480
+ shared_equipment_priority: z.ZodOptional<z.ZodOptional<z.ZodEnum<["high", "low"]>>>;
1481
+ }, "strip", z.ZodTypeAny, {
1482
+ msp_system_id?: string | undefined;
1483
+ backyard_name?: string | undefined;
1484
+ body_of_water_id?: string | undefined;
1485
+ body_of_water_name?: string | undefined;
1486
+ virtual_heater_id?: string | undefined;
1487
+ is_shared_equipment?: boolean | undefined;
1488
+ shared_equipment_priority?: "high" | "low" | undefined;
1489
+ }, {
1490
+ msp_system_id?: string | undefined;
1491
+ backyard_name?: string | undefined;
1492
+ body_of_water_id?: string | undefined;
1493
+ body_of_water_name?: string | undefined;
1494
+ virtual_heater_id?: string | undefined;
1495
+ is_shared_equipment?: boolean | undefined;
1496
+ shared_equipment_priority?: "high" | "low" | undefined;
1497
+ }>>>;
1473
1498
  }, "strip", z.ZodTypeAny, {
1474
1499
  ecobee_metadata?: {
1475
1500
  device_name?: string | undefined;
@@ -1854,6 +1879,15 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
1854
1879
  software_version?: string | undefined;
1855
1880
  bonded_member_models?: string[] | undefined;
1856
1881
  } | undefined;
1882
+ hayward_omnilogic_metadata?: {
1883
+ msp_system_id?: string | undefined;
1884
+ backyard_name?: string | undefined;
1885
+ body_of_water_id?: string | undefined;
1886
+ body_of_water_name?: string | undefined;
1887
+ virtual_heater_id?: string | undefined;
1888
+ is_shared_equipment?: boolean | undefined;
1889
+ shared_equipment_priority?: "high" | "low" | undefined;
1890
+ } | undefined;
1857
1891
  }, {
1858
1892
  ecobee_metadata?: {
1859
1893
  device_name?: string | undefined;
@@ -2238,6 +2272,15 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
2238
2272
  software_version?: string | undefined;
2239
2273
  bonded_member_models?: string[] | undefined;
2240
2274
  } | undefined;
2275
+ hayward_omnilogic_metadata?: {
2276
+ msp_system_id?: string | undefined;
2277
+ backyard_name?: string | undefined;
2278
+ body_of_water_id?: string | undefined;
2279
+ body_of_water_name?: string | undefined;
2280
+ virtual_heater_id?: string | undefined;
2281
+ is_shared_equipment?: boolean | undefined;
2282
+ shared_equipment_priority?: "high" | "low" | undefined;
2283
+ } | undefined;
2241
2284
  }>>, z.ZodIntersection<z.ZodObject<{
2242
2285
  code_constraints: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodObject<{
2243
2286
  constraint_type: z.ZodEnum<["no_zeros", "cannot_start_with_12", "no_triple_consecutive_ints", "cannot_specify_pin_code", "pin_code_matches_existing_set", "start_date_in_future", "no_ascending_or_descending_sequence", "at_least_three_unique_digits", "cannot_contain_089", "cannot_contain_0789", "unique_first_four_digits", "no_all_same_digits"]>;
@@ -4089,10 +4132,10 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
4089
4132
  level: z.ZodNumber;
4090
4133
  status: z.ZodEnum<["critical", "low", "good", "full"]>;
4091
4134
  }, "strip", z.ZodTypeAny, {
4092
- status: "critical" | "low" | "good" | "full";
4135
+ status: "low" | "critical" | "good" | "full";
4093
4136
  level: number;
4094
4137
  }, {
4095
- status: "critical" | "low" | "good" | "full";
4138
+ status: "low" | "critical" | "good" | "full";
4096
4139
  level: number;
4097
4140
  }>>;
4098
4141
  manufacturer: z.ZodOptional<z.ZodString>;
@@ -4118,7 +4161,7 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
4118
4161
  };
4119
4162
  online: boolean;
4120
4163
  battery?: {
4121
- status: "critical" | "low" | "good" | "full";
4164
+ status: "low" | "critical" | "good" | "full";
4122
4165
  level: number;
4123
4166
  } | undefined;
4124
4167
  image_url?: string | undefined;
@@ -4146,7 +4189,7 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
4146
4189
  };
4147
4190
  online: boolean;
4148
4191
  battery?: {
4149
- status: "critical" | "low" | "good" | "full";
4192
+ status: "low" | "critical" | "good" | "full";
4150
4193
  level: number;
4151
4194
  } | undefined;
4152
4195
  image_url?: string | undefined;
@@ -4474,7 +4517,7 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
4474
4517
  };
4475
4518
  online: boolean;
4476
4519
  battery?: {
4477
- status: "critical" | "low" | "good" | "full";
4520
+ status: "low" | "critical" | "good" | "full";
4478
4521
  level: number;
4479
4522
  } | undefined;
4480
4523
  image_url?: string | undefined;
@@ -4776,7 +4819,7 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
4776
4819
  };
4777
4820
  online: boolean;
4778
4821
  battery?: {
4779
- status: "critical" | "low" | "good" | "full";
4822
+ status: "low" | "critical" | "good" | "full";
4780
4823
  level: number;
4781
4824
  } | undefined;
4782
4825
  image_url?: string | undefined;
@@ -587,7 +587,7 @@ export declare const device_battery_status_changed_event: z.ZodObject<{
587
587
  event_id: string;
588
588
  occurred_at: string;
589
589
  event_type: "device.battery_status_changed";
590
- battery_status: "critical" | "low" | "good" | "full";
590
+ battery_status: "low" | "critical" | "good" | "full";
591
591
  customer_key?: string | undefined;
592
592
  event_description?: string | undefined;
593
593
  device_custom_metadata?: Record<string, string | boolean> | undefined;
@@ -601,7 +601,7 @@ export declare const device_battery_status_changed_event: z.ZodObject<{
601
601
  event_id: string;
602
602
  occurred_at: string;
603
603
  event_type: "device.battery_status_changed";
604
- battery_status: "critical" | "low" | "good" | "full";
604
+ battery_status: "low" | "critical" | "good" | "full";
605
605
  customer_key?: string | undefined;
606
606
  event_description?: string | undefined;
607
607
  device_custom_metadata?: Record<string, string | boolean> | undefined;
@@ -2827,7 +2827,7 @@ export declare const device_events: readonly [z.ZodObject<{
2827
2827
  event_id: string;
2828
2828
  occurred_at: string;
2829
2829
  event_type: "device.battery_status_changed";
2830
- battery_status: "critical" | "low" | "good" | "full";
2830
+ battery_status: "low" | "critical" | "good" | "full";
2831
2831
  customer_key?: string | undefined;
2832
2832
  event_description?: string | undefined;
2833
2833
  device_custom_metadata?: Record<string, string | boolean> | undefined;
@@ -2841,7 +2841,7 @@ export declare const device_events: readonly [z.ZodObject<{
2841
2841
  event_id: string;
2842
2842
  occurred_at: string;
2843
2843
  event_type: "device.battery_status_changed";
2844
- battery_status: "critical" | "low" | "good" | "full";
2844
+ battery_status: "low" | "critical" | "good" | "full";
2845
2845
  customer_key?: string | undefined;
2846
2846
  event_description?: string | undefined;
2847
2847
  device_custom_metadata?: Record<string, string | boolean> | undefined;
@@ -4715,7 +4715,7 @@ export declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObj
4715
4715
  event_id: string;
4716
4716
  occurred_at: string;
4717
4717
  event_type: "device.battery_status_changed";
4718
- battery_status: "critical" | "low" | "good" | "full";
4718
+ battery_status: "low" | "critical" | "good" | "full";
4719
4719
  customer_key?: string | undefined;
4720
4720
  event_description?: string | undefined;
4721
4721
  device_custom_metadata?: Record<string, string | boolean> | undefined;
@@ -4729,7 +4729,7 @@ export declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObj
4729
4729
  event_id: string;
4730
4730
  occurred_at: string;
4731
4731
  event_type: "device.battery_status_changed";
4732
- battery_status: "critical" | "low" | "good" | "full";
4732
+ battery_status: "low" | "critical" | "good" | "full";
4733
4733
  customer_key?: string | undefined;
4734
4734
  event_description?: string | undefined;
4735
4735
  device_custom_metadata?: Record<string, string | boolean> | undefined;
@@ -4756,6 +4756,27 @@ const openapi = {
4756
4756
  required: ['created_at', 'message', 'warning_code'],
4757
4757
  type: 'object',
4758
4758
  },
4759
+ {
4760
+ description: "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.",
4761
+ properties: {
4762
+ created_at: {
4763
+ description: 'Date and time at which Seam created the warning.',
4764
+ format: 'date-time',
4765
+ type: 'string',
4766
+ },
4767
+ message: {
4768
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
4769
+ type: 'string',
4770
+ },
4771
+ warning_code: {
4772
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
4773
+ enum: ['salto_ks_custom_pins_not_supported'],
4774
+ type: 'string',
4775
+ },
4776
+ },
4777
+ required: ['created_at', 'message', 'warning_code'],
4778
+ type: 'object',
4779
+ },
4759
4780
  {
4760
4781
  description: '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).',
4761
4782
  properties: {
@@ -15743,6 +15764,42 @@ const openapi = {
15743
15764
  },
15744
15765
  type: 'object',
15745
15766
  },
15767
+ hayward_omnilogic_metadata: {
15768
+ description: 'Metadata for a Hayward OmniLogic pool controller or body of water.',
15769
+ properties: {
15770
+ backyard_name: {
15771
+ description: 'Name of the system, as set in the Hayward OmniLogic app.',
15772
+ type: 'string',
15773
+ },
15774
+ body_of_water_id: {
15775
+ description: 'ID of the body of water within its system. Only present on a pool or spa body.',
15776
+ type: 'string',
15777
+ },
15778
+ body_of_water_name: {
15779
+ description: 'Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body.',
15780
+ type: 'string',
15781
+ },
15782
+ is_shared_equipment: {
15783
+ description: 'Indicates whether the body of water shares its pump and heater with another body of water in the same system.',
15784
+ type: 'boolean',
15785
+ },
15786
+ msp_system_id: {
15787
+ description: 'ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to.',
15788
+ type: 'string',
15789
+ },
15790
+ shared_equipment_priority: {
15791
+ 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.',
15792
+ enum: ['high', 'low'],
15793
+ type: 'string',
15794
+ },
15795
+ virtual_heater_id: {
15796
+ 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.',
15797
+ type: 'string',
15798
+ },
15799
+ },
15800
+ type: 'object',
15801
+ 'x-undocumented': 'Unreleased.',
15802
+ },
15746
15803
  honeywell_resideo_metadata: {
15747
15804
  description: 'Metadata for a Honeywell Resideo device.',
15748
15805
  properties: {
@@ -18930,6 +18987,7 @@ const openapi = {
18930
18987
  'aqara',
18931
18988
  'eufy',
18932
18989
  'sonos',
18990
+ 'hayward_omnilogic',
18933
18991
  ],
18934
18992
  type: 'string',
18935
18993
  },
@@ -47648,6 +47706,7 @@ const openapi = {
47648
47706
  'aqara',
47649
47707
  'eufy',
47650
47708
  'sonos',
47709
+ 'hayward_omnilogic',
47651
47710
  'hid_cm',
47652
47711
  'google_nest',
47653
47712
  'slack',
@@ -51432,6 +51491,7 @@ const openapi = {
51432
51491
  'slack',
51433
51492
  'yacan',
51434
51493
  'sonos',
51494
+ 'hayward_omnilogic',
51435
51495
  ],
51436
51496
  type: 'string',
51437
51497
  },
@@ -53795,6 +53855,7 @@ const openapi = {
53795
53855
  'slack',
53796
53856
  'yacan',
53797
53857
  'sonos',
53858
+ 'hayward_omnilogic',
53798
53859
  ],
53799
53860
  type: 'string',
53800
53861
  },