@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
|
@@ -15054,6 +15054,23 @@ export type Routes = {
|
|
|
15054
15054
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
15055
15055
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
15056
15056
|
} | undefined) | undefined;
|
|
15057
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
15058
|
+
hayward_omnilogic_metadata?: ({
|
|
15059
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
15060
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
15061
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
15062
|
+
backyard_name?: (string | undefined) | undefined;
|
|
15063
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
15064
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
15065
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
15066
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
15067
|
+
/** 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. */
|
|
15068
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
15069
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
15070
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
15071
|
+
/** 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. */
|
|
15072
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
15073
|
+
} | undefined) | undefined;
|
|
15057
15074
|
}) & ({
|
|
15058
15075
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
15059
15076
|
code_constraints?: (({
|
|
@@ -15834,6 +15851,10 @@ export type Routes = {
|
|
|
15834
15851
|
custom_metadata: {
|
|
15835
15852
|
[x: string]: string | boolean;
|
|
15836
15853
|
};
|
|
15854
|
+
/** 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. */
|
|
15855
|
+
parent_device_id?: string | undefined;
|
|
15856
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
15857
|
+
child_device_ids?: string[] | undefined;
|
|
15837
15858
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
15838
15859
|
device_provider?: {
|
|
15839
15860
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -23460,6 +23481,23 @@ export type Routes = {
|
|
|
23460
23481
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
23461
23482
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
23462
23483
|
} | undefined) | undefined;
|
|
23484
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
23485
|
+
hayward_omnilogic_metadata?: ({
|
|
23486
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
23487
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
23488
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
23489
|
+
backyard_name?: (string | undefined) | undefined;
|
|
23490
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
23491
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
23492
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
23493
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
23494
|
+
/** 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. */
|
|
23495
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
23496
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
23497
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
23498
|
+
/** 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. */
|
|
23499
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
23500
|
+
} | undefined) | undefined;
|
|
23463
23501
|
}) & ({
|
|
23464
23502
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
23465
23503
|
code_constraints?: (({
|
|
@@ -24240,6 +24278,10 @@ export type Routes = {
|
|
|
24240
24278
|
custom_metadata: {
|
|
24241
24279
|
[x: string]: string | boolean;
|
|
24242
24280
|
};
|
|
24281
|
+
/** 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. */
|
|
24282
|
+
parent_device_id?: string | undefined;
|
|
24283
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
24284
|
+
child_device_ids?: string[] | undefined;
|
|
24243
24285
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
24244
24286
|
device_provider?: {
|
|
24245
24287
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -48530,7 +48572,7 @@ export type Routes = {
|
|
|
48530
48572
|
/** Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error. */
|
|
48531
48573
|
customer_key?: string | undefined;
|
|
48532
48574
|
/** Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with no filters. */
|
|
48533
|
-
accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'yale_access' | 'yale_home' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'alertify' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos' | 'hid_cm' | 'google_nest' | 'slack')[] | undefined;
|
|
48575
|
+
accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'yale_access' | 'yale_home' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'alertify' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos' | 'hayward_omnilogic' | 'hid_cm' | 'google_nest' | 'slack')[] | undefined;
|
|
48534
48576
|
/** Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with the desired `provider_category` filter. */
|
|
48535
48577
|
provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors' | 'internal_beta') | undefined;
|
|
48536
48578
|
/** Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://www.seam.co/docs/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://www.seam.co/docs/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. */
|
|
@@ -51295,6 +51337,23 @@ export type Routes = {
|
|
|
51295
51337
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
51296
51338
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
51297
51339
|
} | undefined) | undefined;
|
|
51340
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
51341
|
+
hayward_omnilogic_metadata?: ({
|
|
51342
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
51343
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
51344
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
51345
|
+
backyard_name?: (string | undefined) | undefined;
|
|
51346
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
51347
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
51348
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
51349
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
51350
|
+
/** 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. */
|
|
51351
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
51352
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
51353
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
51354
|
+
/** 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. */
|
|
51355
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
51356
|
+
} | undefined) | undefined;
|
|
51298
51357
|
}) & ({
|
|
51299
51358
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
51300
51359
|
code_constraints?: (({
|
|
@@ -52075,6 +52134,10 @@ export type Routes = {
|
|
|
52075
52134
|
custom_metadata: {
|
|
52076
52135
|
[x: string]: string | boolean;
|
|
52077
52136
|
};
|
|
52137
|
+
/** 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. */
|
|
52138
|
+
parent_device_id?: string | undefined;
|
|
52139
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
52140
|
+
child_device_ids?: string[] | undefined;
|
|
52078
52141
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
52079
52142
|
device_provider?: {
|
|
52080
52143
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -52250,7 +52313,7 @@ export type Routes = {
|
|
|
52250
52313
|
/** Array of device types for which you want to list devices. */
|
|
52251
52314
|
device_types?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'yale_access_lock' | 'yale_home_lock' | 'yale_connect_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera') | 'sonos_speaker' | 'alertify_sensor' | ('hayward_pool_system' | 'hayward_pool'))[] | undefined;
|
|
52252
52315
|
/** Manufacturer for which you want to list devices. */
|
|
52253
|
-
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'ubiquiti' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'alertify' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos') | undefined;
|
|
52316
|
+
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'ubiquiti' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'alertify' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos' | 'hayward_omnilogic') | undefined;
|
|
52254
52317
|
/** Array of device IDs for which you want to list devices. */
|
|
52255
52318
|
device_ids?: string[] | undefined;
|
|
52256
52319
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -52276,6 +52339,8 @@ export type Routes = {
|
|
|
52276
52339
|
space_id?: string | undefined;
|
|
52277
52340
|
/** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`. */
|
|
52278
52341
|
search?: string | undefined;
|
|
52342
|
+
/** ID of the parent device whose child devices you want to list. */
|
|
52343
|
+
parent_device_id?: string | undefined;
|
|
52279
52344
|
};
|
|
52280
52345
|
formData: {};
|
|
52281
52346
|
jsonResponse: {
|
|
@@ -53107,6 +53172,23 @@ export type Routes = {
|
|
|
53107
53172
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
53108
53173
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
53109
53174
|
} | undefined) | undefined;
|
|
53175
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
53176
|
+
hayward_omnilogic_metadata?: ({
|
|
53177
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
53178
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
53179
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
53180
|
+
backyard_name?: (string | undefined) | undefined;
|
|
53181
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
53182
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
53183
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
53184
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
53185
|
+
/** 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. */
|
|
53186
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
53187
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
53188
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
53189
|
+
/** 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. */
|
|
53190
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
53191
|
+
} | undefined) | undefined;
|
|
53110
53192
|
}) & ({
|
|
53111
53193
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
53112
53194
|
code_constraints?: (({
|
|
@@ -53887,6 +53969,10 @@ export type Routes = {
|
|
|
53887
53969
|
custom_metadata: {
|
|
53888
53970
|
[x: string]: string | boolean;
|
|
53889
53971
|
};
|
|
53972
|
+
/** 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. */
|
|
53973
|
+
parent_device_id?: string | undefined;
|
|
53974
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
53975
|
+
child_device_ids?: string[] | undefined;
|
|
53890
53976
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
53891
53977
|
device_provider?: {
|
|
53892
53978
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -54065,7 +54151,7 @@ export type Routes = {
|
|
|
54065
54151
|
jsonResponse: {
|
|
54066
54152
|
device_providers: {
|
|
54067
54153
|
/** Name of the device provider. */
|
|
54068
|
-
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'yale_access' | 'yale_home' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'alertify' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos';
|
|
54154
|
+
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'yale_access' | 'yale_home' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'alertify' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos' | 'hayward_omnilogic';
|
|
54069
54155
|
/** Display name for the device provider. */
|
|
54070
54156
|
display_name: string;
|
|
54071
54157
|
/** Image URL for the device provider. */
|
|
@@ -54810,7 +54896,7 @@ export type Routes = {
|
|
|
54810
54896
|
/** Array of device types for which you want to list devices. */
|
|
54811
54897
|
device_types?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'yale_access_lock' | 'yale_home_lock' | 'yale_connect_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera') | 'sonos_speaker' | 'alertify_sensor' | ('hayward_pool_system' | 'hayward_pool'))[] | undefined;
|
|
54812
54898
|
/** Manufacturer for which you want to list devices. */
|
|
54813
|
-
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'ubiquiti' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'alertify' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos') | undefined;
|
|
54899
|
+
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'ubiquiti' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'alertify' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos' | 'hayward_omnilogic') | undefined;
|
|
54814
54900
|
/** Array of device IDs for which you want to list devices. */
|
|
54815
54901
|
device_ids?: string[] | undefined;
|
|
54816
54902
|
/** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
|
|
@@ -54823,6 +54909,8 @@ export type Routes = {
|
|
|
54823
54909
|
exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_activate_weekly_program' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock' | 'can_stream_live_video' | 'can_set_speaker_volume' | 'can_mute_speaker' | 'can_unmute_speaker' | 'can_pause_speaker_playback' | 'can_resume_speaker_playback' | 'can_play_speaker_chime' | 'can_play_speaker_favorite' | 'can_play_speaker_audio_clip' | 'can_control_temperature')[] | undefined;
|
|
54824
54910
|
/** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`. */
|
|
54825
54911
|
search?: string | undefined;
|
|
54912
|
+
/** ID of the parent device whose child devices you want to list. */
|
|
54913
|
+
parent_device_id?: string | undefined;
|
|
54826
54914
|
/** Numerical limit on the number of devices to return. */
|
|
54827
54915
|
limit?: number;
|
|
54828
54916
|
};
|
|
@@ -66219,6 +66307,23 @@ export type Routes = {
|
|
|
66219
66307
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
66220
66308
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
66221
66309
|
} | undefined) | undefined;
|
|
66310
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
66311
|
+
hayward_omnilogic_metadata?: ({
|
|
66312
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
66313
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
66314
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
66315
|
+
backyard_name?: (string | undefined) | undefined;
|
|
66316
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
66317
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
66318
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
66319
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
66320
|
+
/** 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. */
|
|
66321
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
66322
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
66323
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
66324
|
+
/** 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. */
|
|
66325
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
66326
|
+
} | undefined) | undefined;
|
|
66222
66327
|
}) & ({
|
|
66223
66328
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
66224
66329
|
code_constraints?: (({
|
|
@@ -66999,6 +67104,10 @@ export type Routes = {
|
|
|
66999
67104
|
custom_metadata: {
|
|
67000
67105
|
[x: string]: string | boolean;
|
|
67001
67106
|
};
|
|
67107
|
+
/** 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. */
|
|
67108
|
+
parent_device_id?: string | undefined;
|
|
67109
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
67110
|
+
child_device_ids?: string[] | undefined;
|
|
67002
67111
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
67003
67112
|
device_provider?: {
|
|
67004
67113
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -67981,6 +68090,23 @@ export type Routes = {
|
|
|
67981
68090
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
67982
68091
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
67983
68092
|
} | undefined) | undefined;
|
|
68093
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
68094
|
+
hayward_omnilogic_metadata?: ({
|
|
68095
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
68096
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
68097
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
68098
|
+
backyard_name?: (string | undefined) | undefined;
|
|
68099
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
68100
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
68101
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
68102
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
68103
|
+
/** 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. */
|
|
68104
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
68105
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
68106
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
68107
|
+
/** 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. */
|
|
68108
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
68109
|
+
} | undefined) | undefined;
|
|
67984
68110
|
}) & ({
|
|
67985
68111
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
67986
68112
|
code_constraints?: (({
|
|
@@ -68761,6 +68887,10 @@ export type Routes = {
|
|
|
68761
68887
|
custom_metadata: {
|
|
68762
68888
|
[x: string]: string | boolean;
|
|
68763
68889
|
};
|
|
68890
|
+
/** 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. */
|
|
68891
|
+
parent_device_id?: string | undefined;
|
|
68892
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
68893
|
+
child_device_ids?: string[] | undefined;
|
|
68764
68894
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
68765
68895
|
device_provider?: {
|
|
68766
68896
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -69766,6 +69896,23 @@ export type Routes = {
|
|
|
69766
69896
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
69767
69897
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
69768
69898
|
} | undefined) | undefined;
|
|
69899
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
69900
|
+
hayward_omnilogic_metadata?: ({
|
|
69901
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
69902
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
69903
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
69904
|
+
backyard_name?: (string | undefined) | undefined;
|
|
69905
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
69906
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
69907
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
69908
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
69909
|
+
/** 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. */
|
|
69910
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
69911
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
69912
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
69913
|
+
/** 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. */
|
|
69914
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
69915
|
+
} | undefined) | undefined;
|
|
69769
69916
|
}) & ({
|
|
69770
69917
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
69771
69918
|
code_constraints?: (({
|
|
@@ -70546,6 +70693,10 @@ export type Routes = {
|
|
|
70546
70693
|
custom_metadata: {
|
|
70547
70694
|
[x: string]: string | boolean;
|
|
70548
70695
|
};
|
|
70696
|
+
/** 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. */
|
|
70697
|
+
parent_device_id?: string | undefined;
|
|
70698
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
70699
|
+
child_device_ids?: string[] | undefined;
|
|
70549
70700
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
70550
70701
|
device_provider?: {
|
|
70551
70702
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -71527,6 +71678,23 @@ export type Routes = {
|
|
|
71527
71678
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
71528
71679
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
71529
71680
|
} | undefined) | undefined;
|
|
71681
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
71682
|
+
hayward_omnilogic_metadata?: ({
|
|
71683
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
71684
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
71685
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
71686
|
+
backyard_name?: (string | undefined) | undefined;
|
|
71687
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
71688
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
71689
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
71690
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
71691
|
+
/** 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. */
|
|
71692
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
71693
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
71694
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
71695
|
+
/** 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. */
|
|
71696
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
71697
|
+
} | undefined) | undefined;
|
|
71530
71698
|
}) & ({
|
|
71531
71699
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
71532
71700
|
code_constraints?: (({
|
|
@@ -72307,6 +72475,10 @@ export type Routes = {
|
|
|
72307
72475
|
custom_metadata: {
|
|
72308
72476
|
[x: string]: string | boolean;
|
|
72309
72477
|
};
|
|
72478
|
+
/** 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. */
|
|
72479
|
+
parent_device_id?: string | undefined;
|
|
72480
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
72481
|
+
child_device_ids?: string[] | undefined;
|
|
72310
72482
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
72311
72483
|
device_provider?: {
|
|
72312
72484
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -82303,6 +82475,23 @@ export type Routes = {
|
|
|
82303
82475
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
82304
82476
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
82305
82477
|
} | undefined) | undefined;
|
|
82478
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
82479
|
+
hayward_omnilogic_metadata?: ({
|
|
82480
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
82481
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
82482
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
82483
|
+
backyard_name?: (string | undefined) | undefined;
|
|
82484
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
82485
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
82486
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
82487
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
82488
|
+
/** 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. */
|
|
82489
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
82490
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
82491
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
82492
|
+
/** 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. */
|
|
82493
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
82494
|
+
} | undefined) | undefined;
|
|
82306
82495
|
}) & ({
|
|
82307
82496
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
82308
82497
|
code_constraints?: (({
|
|
@@ -83083,6 +83272,10 @@ export type Routes = {
|
|
|
83083
83272
|
custom_metadata: {
|
|
83084
83273
|
[x: string]: string | boolean;
|
|
83085
83274
|
};
|
|
83275
|
+
/** 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. */
|
|
83276
|
+
parent_device_id?: string | undefined;
|
|
83277
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
83278
|
+
child_device_ids?: string[] | undefined;
|
|
83086
83279
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
83087
83280
|
device_provider?: {
|
|
83088
83281
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -84064,6 +84257,23 @@ export type Routes = {
|
|
|
84064
84257
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
84065
84258
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
84066
84259
|
} | undefined) | undefined;
|
|
84260
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
84261
|
+
hayward_omnilogic_metadata?: ({
|
|
84262
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
84263
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
84264
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
84265
|
+
backyard_name?: (string | undefined) | undefined;
|
|
84266
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
84267
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
84268
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
84269
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
84270
|
+
/** 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. */
|
|
84271
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
84272
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
84273
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
84274
|
+
/** 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. */
|
|
84275
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
84276
|
+
} | undefined) | undefined;
|
|
84067
84277
|
}) & ({
|
|
84068
84278
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
84069
84279
|
code_constraints?: (({
|
|
@@ -84844,6 +85054,10 @@ export type Routes = {
|
|
|
84844
85054
|
custom_metadata: {
|
|
84845
85055
|
[x: string]: string | boolean;
|
|
84846
85056
|
};
|
|
85057
|
+
/** 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. */
|
|
85058
|
+
parent_device_id?: string | undefined;
|
|
85059
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
85060
|
+
child_device_ids?: string[] | undefined;
|
|
84847
85061
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
84848
85062
|
device_provider?: {
|
|
84849
85063
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -96199,6 +96413,23 @@ export type Routes = {
|
|
|
96199
96413
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
96200
96414
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
96201
96415
|
} | undefined) | undefined;
|
|
96416
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
96417
|
+
hayward_omnilogic_metadata?: ({
|
|
96418
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
96419
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
96420
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
96421
|
+
backyard_name?: (string | undefined) | undefined;
|
|
96422
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
96423
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
96424
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
96425
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
96426
|
+
/** 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. */
|
|
96427
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
96428
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
96429
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
96430
|
+
/** 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. */
|
|
96431
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
96432
|
+
} | undefined) | undefined;
|
|
96202
96433
|
}) & ({
|
|
96203
96434
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
96204
96435
|
code_constraints?: (({
|
|
@@ -96979,6 +97210,10 @@ export type Routes = {
|
|
|
96979
97210
|
custom_metadata: {
|
|
96980
97211
|
[x: string]: string | boolean;
|
|
96981
97212
|
};
|
|
97213
|
+
/** 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. */
|
|
97214
|
+
parent_device_id?: string | undefined;
|
|
97215
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
97216
|
+
child_device_ids?: string[] | undefined;
|
|
96982
97217
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
96983
97218
|
device_provider?: {
|
|
96984
97219
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -116127,6 +116362,23 @@ export type Routes = {
|
|
|
116127
116362
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
116128
116363
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
116129
116364
|
} | undefined) | undefined;
|
|
116365
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
116366
|
+
hayward_omnilogic_metadata?: ({
|
|
116367
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
116368
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
116369
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
116370
|
+
backyard_name?: (string | undefined) | undefined;
|
|
116371
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
116372
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
116373
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
116374
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
116375
|
+
/** 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. */
|
|
116376
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
116377
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
116378
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
116379
|
+
/** 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. */
|
|
116380
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
116381
|
+
} | undefined) | undefined;
|
|
116130
116382
|
}) & ({
|
|
116131
116383
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
116132
116384
|
code_constraints?: (({
|
|
@@ -116907,6 +117159,10 @@ export type Routes = {
|
|
|
116907
117159
|
custom_metadata: {
|
|
116908
117160
|
[x: string]: string | boolean;
|
|
116909
117161
|
};
|
|
117162
|
+
/** 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. */
|
|
117163
|
+
parent_device_id?: string | undefined;
|
|
117164
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
117165
|
+
child_device_ids?: string[] | undefined;
|
|
116910
117166
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
116911
117167
|
device_provider?: {
|
|
116912
117168
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -145874,6 +146130,23 @@ export type Routes = {
|
|
|
145874
146130
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
145875
146131
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
145876
146132
|
} | undefined) | undefined;
|
|
146133
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
146134
|
+
hayward_omnilogic_metadata?: ({
|
|
146135
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
146136
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
146137
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
146138
|
+
backyard_name?: (string | undefined) | undefined;
|
|
146139
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
146140
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
146141
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
146142
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
146143
|
+
/** 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. */
|
|
146144
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
146145
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
146146
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
146147
|
+
/** 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. */
|
|
146148
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
146149
|
+
} | undefined) | undefined;
|
|
145877
146150
|
}) & ({
|
|
145878
146151
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
145879
146152
|
code_constraints?: (({
|
|
@@ -146654,6 +146927,10 @@ export type Routes = {
|
|
|
146654
146927
|
custom_metadata: {
|
|
146655
146928
|
[x: string]: string | boolean;
|
|
146656
146929
|
};
|
|
146930
|
+
/** 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. */
|
|
146931
|
+
parent_device_id?: string | undefined;
|
|
146932
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
146933
|
+
child_device_ids?: string[] | undefined;
|
|
146657
146934
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
146658
146935
|
device_provider?: {
|
|
146659
146936
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -152147,6 +152424,23 @@ export type Routes = {
|
|
|
152147
152424
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
152148
152425
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
152149
152426
|
} | undefined) | undefined;
|
|
152427
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
152428
|
+
hayward_omnilogic_metadata?: ({
|
|
152429
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
152430
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
152431
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
152432
|
+
backyard_name?: (string | undefined) | undefined;
|
|
152433
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
152434
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
152435
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
152436
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
152437
|
+
/** 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. */
|
|
152438
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
152439
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
152440
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
152441
|
+
/** 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. */
|
|
152442
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
152443
|
+
} | undefined) | undefined;
|
|
152150
152444
|
}) & ({
|
|
152151
152445
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
152152
152446
|
code_constraints?: (({
|
|
@@ -152927,6 +153221,10 @@ export type Routes = {
|
|
|
152927
153221
|
custom_metadata: {
|
|
152928
153222
|
[x: string]: string | boolean;
|
|
152929
153223
|
};
|
|
153224
|
+
/** 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. */
|
|
153225
|
+
parent_device_id?: string | undefined;
|
|
153226
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
153227
|
+
child_device_ids?: string[] | undefined;
|
|
152930
153228
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
152931
153229
|
device_provider?: {
|
|
152932
153230
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -153908,6 +154206,23 @@ export type Routes = {
|
|
|
153908
154206
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
153909
154207
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
153910
154208
|
} | undefined) | undefined;
|
|
154209
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
154210
|
+
hayward_omnilogic_metadata?: ({
|
|
154211
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
154212
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
154213
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
154214
|
+
backyard_name?: (string | undefined) | undefined;
|
|
154215
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
154216
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
154217
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
154218
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
154219
|
+
/** 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. */
|
|
154220
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
154221
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
154222
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
154223
|
+
/** 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. */
|
|
154224
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
154225
|
+
} | undefined) | undefined;
|
|
153911
154226
|
}) & ({
|
|
153912
154227
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
153913
154228
|
code_constraints?: (({
|
|
@@ -154688,6 +155003,10 @@ export type Routes = {
|
|
|
154688
155003
|
custom_metadata: {
|
|
154689
155004
|
[x: string]: string | boolean;
|
|
154690
155005
|
};
|
|
155006
|
+
/** 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. */
|
|
155007
|
+
parent_device_id?: string | undefined;
|
|
155008
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
155009
|
+
child_device_ids?: string[] | undefined;
|
|
154691
155010
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
154692
155011
|
device_provider?: {
|
|
154693
155012
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -165754,6 +166073,23 @@ export type Routes = {
|
|
|
165754
166073
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
165755
166074
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
165756
166075
|
} | undefined) | undefined;
|
|
166076
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
166077
|
+
hayward_omnilogic_metadata?: ({
|
|
166078
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
166079
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
166080
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
166081
|
+
backyard_name?: (string | undefined) | undefined;
|
|
166082
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
166083
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
166084
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
166085
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
166086
|
+
/** 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. */
|
|
166087
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
166088
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
166089
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
166090
|
+
/** 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. */
|
|
166091
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
166092
|
+
} | undefined) | undefined;
|
|
165757
166093
|
}) & ({
|
|
165758
166094
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
165759
166095
|
code_constraints?: (({
|
|
@@ -166534,6 +166870,10 @@ export type Routes = {
|
|
|
166534
166870
|
custom_metadata: {
|
|
166535
166871
|
[x: string]: string | boolean;
|
|
166536
166872
|
};
|
|
166873
|
+
/** 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. */
|
|
166874
|
+
parent_device_id?: string | undefined;
|
|
166875
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
166876
|
+
child_device_ids?: string[] | undefined;
|
|
166537
166877
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
166538
166878
|
device_provider?: {
|
|
166539
166879
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -167517,6 +167857,23 @@ export type Routes = {
|
|
|
167517
167857
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
167518
167858
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
167519
167859
|
} | undefined) | undefined;
|
|
167860
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
167861
|
+
hayward_omnilogic_metadata?: ({
|
|
167862
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
167863
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
167864
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
167865
|
+
backyard_name?: (string | undefined) | undefined;
|
|
167866
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
167867
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
167868
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
167869
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
167870
|
+
/** 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. */
|
|
167871
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
167872
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
167873
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
167874
|
+
/** 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. */
|
|
167875
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
167876
|
+
} | undefined) | undefined;
|
|
167520
167877
|
}) & ({
|
|
167521
167878
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
167522
167879
|
code_constraints?: (({
|
|
@@ -168297,6 +168654,10 @@ export type Routes = {
|
|
|
168297
168654
|
custom_metadata: {
|
|
168298
168655
|
[x: string]: string | boolean;
|
|
168299
168656
|
};
|
|
168657
|
+
/** 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. */
|
|
168658
|
+
parent_device_id?: string | undefined;
|
|
168659
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
168660
|
+
child_device_ids?: string[] | undefined;
|
|
168300
168661
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
168301
168662
|
device_provider?: {
|
|
168302
168663
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|
|
@@ -171636,6 +171997,23 @@ export type Routes = {
|
|
|
171636
171997
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
171637
171998
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
171638
171999
|
} | undefined) | undefined;
|
|
172000
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
172001
|
+
hayward_omnilogic_metadata?: ({
|
|
172002
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
172003
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
172004
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
172005
|
+
backyard_name?: (string | undefined) | undefined;
|
|
172006
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
172007
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
172008
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
172009
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
172010
|
+
/** 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. */
|
|
172011
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
172012
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
172013
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
172014
|
+
/** 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. */
|
|
172015
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
172016
|
+
} | undefined) | undefined;
|
|
171639
172017
|
}) & ({
|
|
171640
172018
|
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
171641
172019
|
code_constraints?: (({
|
|
@@ -172416,6 +172794,10 @@ export type Routes = {
|
|
|
172416
172794
|
custom_metadata: {
|
|
172417
172795
|
[x: string]: string | boolean;
|
|
172418
172796
|
};
|
|
172797
|
+
/** 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. */
|
|
172798
|
+
parent_device_id?: string | undefined;
|
|
172799
|
+
/** IDs of the child devices that belong to this device. Only present when the device has at least one child. */
|
|
172800
|
+
child_device_ids?: string[] | undefined;
|
|
172419
172801
|
/** Provider of the device. Represents the third-party service through which the device is controlled. */
|
|
172420
172802
|
device_provider?: {
|
|
172421
172803
|
/** Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations. */
|