@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/lib/seam/connect/models/devices/device-metadata.d.ts +43 -0
- package/lib/seam/connect/models/devices/device-metadata.js +38 -0
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +1 -0
- package/lib/seam/connect/models/devices/device-provider.js +1 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +77 -10
- package/lib/seam/connect/models/devices/device.js +12 -0
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +55 -10
- 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 +73 -1
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +386 -4
- package/package.json +1 -1
- package/src/lib/seam/connect/models/devices/device-metadata.ts +50 -0
- package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
- package/src/lib/seam/connect/models/devices/device.ts +12 -0
- package/src/lib/seam/connect/openapi.ts +86 -1
- package/src/lib/seam/connect/route-types.ts +510 -0
|
@@ -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: "
|
|
146
|
+
status: "low" | "critical" | "good" | "full";
|
|
147
147
|
level: number;
|
|
148
148
|
}, {
|
|
149
|
-
status: "
|
|
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: "
|
|
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: "
|
|
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"]>;
|
|
@@ -3963,6 +4006,8 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
|
|
|
3963
4006
|
created_at: z.ZodString;
|
|
3964
4007
|
is_managed: z.ZodLiteral<true>;
|
|
3965
4008
|
custom_metadata: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
|
|
4009
|
+
parent_device_id: z.ZodOptional<z.ZodString>;
|
|
4010
|
+
child_device_ids: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
3966
4011
|
device_provider: z.ZodOptional<z.ZodObject<{
|
|
3967
4012
|
provider_category: z.ZodString;
|
|
3968
4013
|
device_provider_name: z.ZodString;
|
|
@@ -4087,10 +4132,10 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
|
|
|
4087
4132
|
level: z.ZodNumber;
|
|
4088
4133
|
status: z.ZodEnum<["critical", "low", "good", "full"]>;
|
|
4089
4134
|
}, "strip", z.ZodTypeAny, {
|
|
4090
|
-
status: "
|
|
4135
|
+
status: "low" | "critical" | "good" | "full";
|
|
4091
4136
|
level: number;
|
|
4092
4137
|
}, {
|
|
4093
|
-
status: "
|
|
4138
|
+
status: "low" | "critical" | "good" | "full";
|
|
4094
4139
|
level: number;
|
|
4095
4140
|
}>>;
|
|
4096
4141
|
manufacturer: z.ZodOptional<z.ZodString>;
|
|
@@ -4116,7 +4161,7 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
|
|
|
4116
4161
|
};
|
|
4117
4162
|
online: boolean;
|
|
4118
4163
|
battery?: {
|
|
4119
|
-
status: "
|
|
4164
|
+
status: "low" | "critical" | "good" | "full";
|
|
4120
4165
|
level: number;
|
|
4121
4166
|
} | undefined;
|
|
4122
4167
|
image_url?: string | undefined;
|
|
@@ -4144,7 +4189,7 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
|
|
|
4144
4189
|
};
|
|
4145
4190
|
online: boolean;
|
|
4146
4191
|
battery?: {
|
|
4147
|
-
status: "
|
|
4192
|
+
status: "low" | "critical" | "good" | "full";
|
|
4148
4193
|
level: number;
|
|
4149
4194
|
} | undefined;
|
|
4150
4195
|
image_url?: string | undefined;
|
|
@@ -4472,7 +4517,7 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
|
|
|
4472
4517
|
};
|
|
4473
4518
|
online: boolean;
|
|
4474
4519
|
battery?: {
|
|
4475
|
-
status: "
|
|
4520
|
+
status: "low" | "critical" | "good" | "full";
|
|
4476
4521
|
level: number;
|
|
4477
4522
|
} | undefined;
|
|
4478
4523
|
image_url?: string | undefined;
|
|
@@ -4774,7 +4819,7 @@ export declare const unmanaged_device: z.ZodObject<Pick<{
|
|
|
4774
4819
|
};
|
|
4775
4820
|
online: boolean;
|
|
4776
4821
|
battery?: {
|
|
4777
|
-
status: "
|
|
4822
|
+
status: "low" | "critical" | "good" | "full";
|
|
4778
4823
|
level: number;
|
|
4779
4824
|
} | undefined;
|
|
4780
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: "
|
|
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: "
|
|
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: "
|
|
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: "
|
|
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: "
|
|
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: "
|
|
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;
|
|
@@ -14209,6 +14209,12 @@ const openapi = {
|
|
|
14209
14209
|
},
|
|
14210
14210
|
type: 'array',
|
|
14211
14211
|
},
|
|
14212
|
+
child_device_ids: {
|
|
14213
|
+
description: 'IDs of the child devices that belong to this device. Only present when the device has at least one child.',
|
|
14214
|
+
items: { format: 'uuid', type: 'string' },
|
|
14215
|
+
type: 'array',
|
|
14216
|
+
'x-undocumented': 'Unreleased.',
|
|
14217
|
+
},
|
|
14212
14218
|
co2_ppm: {
|
|
14213
14219
|
description: 'Carbon dioxide concentration in parts per million, if the device measures it.',
|
|
14214
14220
|
format: 'float',
|
|
@@ -15078,6 +15084,12 @@ const openapi = {
|
|
|
15078
15084
|
type: 'number',
|
|
15079
15085
|
'x-property-group-key': 'sensors',
|
|
15080
15086
|
},
|
|
15087
|
+
parent_device_id: {
|
|
15088
|
+
description: '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.',
|
|
15089
|
+
format: 'uuid',
|
|
15090
|
+
type: 'string',
|
|
15091
|
+
'x-undocumented': 'Unreleased.',
|
|
15092
|
+
},
|
|
15081
15093
|
properties: {
|
|
15082
15094
|
allOf: [
|
|
15083
15095
|
{
|
|
@@ -15731,6 +15743,42 @@ const openapi = {
|
|
|
15731
15743
|
},
|
|
15732
15744
|
type: 'object',
|
|
15733
15745
|
},
|
|
15746
|
+
hayward_omnilogic_metadata: {
|
|
15747
|
+
description: 'Metadata for a Hayward OmniLogic pool controller or body of water.',
|
|
15748
|
+
properties: {
|
|
15749
|
+
backyard_name: {
|
|
15750
|
+
description: 'Name of the system, as set in the Hayward OmniLogic app.',
|
|
15751
|
+
type: 'string',
|
|
15752
|
+
},
|
|
15753
|
+
body_of_water_id: {
|
|
15754
|
+
description: 'ID of the body of water within its system. Only present on a pool or spa body.',
|
|
15755
|
+
type: 'string',
|
|
15756
|
+
},
|
|
15757
|
+
body_of_water_name: {
|
|
15758
|
+
description: 'Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body.',
|
|
15759
|
+
type: 'string',
|
|
15760
|
+
},
|
|
15761
|
+
is_shared_equipment: {
|
|
15762
|
+
description: 'Indicates whether the body of water shares its pump and heater with another body of water in the same system.',
|
|
15763
|
+
type: 'boolean',
|
|
15764
|
+
},
|
|
15765
|
+
msp_system_id: {
|
|
15766
|
+
description: 'ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to.',
|
|
15767
|
+
type: 'string',
|
|
15768
|
+
},
|
|
15769
|
+
shared_equipment_priority: {
|
|
15770
|
+
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.',
|
|
15771
|
+
enum: ['high', 'low'],
|
|
15772
|
+
type: 'string',
|
|
15773
|
+
},
|
|
15774
|
+
virtual_heater_id: {
|
|
15775
|
+
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.',
|
|
15776
|
+
type: 'string',
|
|
15777
|
+
},
|
|
15778
|
+
},
|
|
15779
|
+
type: 'object',
|
|
15780
|
+
'x-undocumented': 'Unreleased.',
|
|
15781
|
+
},
|
|
15734
15782
|
honeywell_resideo_metadata: {
|
|
15735
15783
|
description: 'Metadata for a Honeywell Resideo device.',
|
|
15736
15784
|
properties: {
|
|
@@ -18918,6 +18966,7 @@ const openapi = {
|
|
|
18918
18966
|
'aqara',
|
|
18919
18967
|
'eufy',
|
|
18920
18968
|
'sonos',
|
|
18969
|
+
'hayward_omnilogic',
|
|
18921
18970
|
],
|
|
18922
18971
|
type: 'string',
|
|
18923
18972
|
},
|
|
@@ -47636,6 +47685,7 @@ const openapi = {
|
|
|
47636
47685
|
'aqara',
|
|
47637
47686
|
'eufy',
|
|
47638
47687
|
'sonos',
|
|
47688
|
+
'hayward_omnilogic',
|
|
47639
47689
|
'hid_cm',
|
|
47640
47690
|
'google_nest',
|
|
47641
47691
|
'slack',
|
|
@@ -51420,6 +51470,7 @@ const openapi = {
|
|
|
51420
51470
|
'slack',
|
|
51421
51471
|
'yacan',
|
|
51422
51472
|
'sonos',
|
|
51473
|
+
'hayward_omnilogic',
|
|
51423
51474
|
],
|
|
51424
51475
|
type: 'string',
|
|
51425
51476
|
},
|
|
@@ -51599,6 +51650,16 @@ const openapi = {
|
|
|
51599
51650
|
type: 'string',
|
|
51600
51651
|
},
|
|
51601
51652
|
},
|
|
51653
|
+
{
|
|
51654
|
+
in: 'query',
|
|
51655
|
+
name: 'parent_device_id',
|
|
51656
|
+
schema: {
|
|
51657
|
+
description: 'ID of the parent device whose child devices you want to list.',
|
|
51658
|
+
format: 'uuid',
|
|
51659
|
+
type: 'string',
|
|
51660
|
+
'x-undocumented': 'Unreleased.',
|
|
51661
|
+
},
|
|
51662
|
+
},
|
|
51602
51663
|
],
|
|
51603
51664
|
responses: {
|
|
51604
51665
|
'200': {
|
|
@@ -53773,6 +53834,7 @@ const openapi = {
|
|
|
53773
53834
|
'slack',
|
|
53774
53835
|
'yacan',
|
|
53775
53836
|
'sonos',
|
|
53837
|
+
'hayward_omnilogic',
|
|
53776
53838
|
],
|
|
53777
53839
|
type: 'string',
|
|
53778
53840
|
},
|
|
@@ -53901,6 +53963,16 @@ const openapi = {
|
|
|
53901
53963
|
type: 'string',
|
|
53902
53964
|
},
|
|
53903
53965
|
},
|
|
53966
|
+
{
|
|
53967
|
+
in: 'query',
|
|
53968
|
+
name: 'parent_device_id',
|
|
53969
|
+
schema: {
|
|
53970
|
+
description: 'ID of the parent device whose child devices you want to list.',
|
|
53971
|
+
format: 'uuid',
|
|
53972
|
+
type: 'string',
|
|
53973
|
+
'x-undocumented': 'Unreleased.',
|
|
53974
|
+
},
|
|
53975
|
+
},
|
|
53904
53976
|
{
|
|
53905
53977
|
in: 'query',
|
|
53906
53978
|
name: 'limit',
|
|
@@ -56403,7 +56475,7 @@ const openapi = {
|
|
|
56403
56475
|
},
|
|
56404
56476
|
'/pools/list': {
|
|
56405
56477
|
get: {
|
|
56406
|
-
description: 'Returns a list of all pool controllers, pools, and spas.',
|
|
56478
|
+
description: '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`.',
|
|
56407
56479
|
operationId: 'poolsListGet',
|
|
56408
56480
|
parameters: [
|
|
56409
56481
|
{
|