@seamapi/types 1.1191.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 +71 -10
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +53 -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 +40 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +310 -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/openapi.ts +48 -0
- package/src/lib/seam/connect/route-types.ts +434 -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?: (({
|
|
@@ -23464,6 +23481,23 @@ export type Routes = {
|
|
|
23464
23481
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
23465
23482
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
23466
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;
|
|
23467
23501
|
}) & ({
|
|
23468
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. */
|
|
23469
23503
|
code_constraints?: (({
|
|
@@ -48538,7 +48572,7 @@ export type Routes = {
|
|
|
48538
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. */
|
|
48539
48573
|
customer_key?: string | undefined;
|
|
48540
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. */
|
|
48541
|
-
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;
|
|
48542
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. */
|
|
48543
48577
|
provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors' | 'internal_beta') | undefined;
|
|
48544
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. */
|
|
@@ -51303,6 +51337,23 @@ export type Routes = {
|
|
|
51303
51337
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
51304
51338
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
51305
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;
|
|
51306
51357
|
}) & ({
|
|
51307
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. */
|
|
51308
51359
|
code_constraints?: (({
|
|
@@ -52262,7 +52313,7 @@ export type Routes = {
|
|
|
52262
52313
|
/** Array of device types for which you want to list devices. */
|
|
52263
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;
|
|
52264
52315
|
/** Manufacturer for which you want to list devices. */
|
|
52265
|
-
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;
|
|
52266
52317
|
/** Array of device IDs for which you want to list devices. */
|
|
52267
52318
|
device_ids?: string[] | undefined;
|
|
52268
52319
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -53121,6 +53172,23 @@ export type Routes = {
|
|
|
53121
53172
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
53122
53173
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
53123
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;
|
|
53124
53192
|
}) & ({
|
|
53125
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. */
|
|
53126
53194
|
code_constraints?: (({
|
|
@@ -54083,7 +54151,7 @@ export type Routes = {
|
|
|
54083
54151
|
jsonResponse: {
|
|
54084
54152
|
device_providers: {
|
|
54085
54153
|
/** Name of the device provider. */
|
|
54086
|
-
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';
|
|
54087
54155
|
/** Display name for the device provider. */
|
|
54088
54156
|
display_name: string;
|
|
54089
54157
|
/** Image URL for the device provider. */
|
|
@@ -54828,7 +54896,7 @@ export type Routes = {
|
|
|
54828
54896
|
/** Array of device types for which you want to list devices. */
|
|
54829
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;
|
|
54830
54898
|
/** Manufacturer for which you want to list devices. */
|
|
54831
|
-
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;
|
|
54832
54900
|
/** Array of device IDs for which you want to list devices. */
|
|
54833
54901
|
device_ids?: string[] | undefined;
|
|
54834
54902
|
/** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
|
|
@@ -66239,6 +66307,23 @@ export type Routes = {
|
|
|
66239
66307
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
66240
66308
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
66241
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;
|
|
66242
66327
|
}) & ({
|
|
66243
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. */
|
|
66244
66329
|
code_constraints?: (({
|
|
@@ -68005,6 +68090,23 @@ export type Routes = {
|
|
|
68005
68090
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
68006
68091
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
68007
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;
|
|
68008
68110
|
}) & ({
|
|
68009
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. */
|
|
68010
68112
|
code_constraints?: (({
|
|
@@ -69794,6 +69896,23 @@ export type Routes = {
|
|
|
69794
69896
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
69795
69897
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
69796
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;
|
|
69797
69916
|
}) & ({
|
|
69798
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. */
|
|
69799
69918
|
code_constraints?: (({
|
|
@@ -71559,6 +71678,23 @@ export type Routes = {
|
|
|
71559
71678
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
71560
71679
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
71561
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;
|
|
71562
71698
|
}) & ({
|
|
71563
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. */
|
|
71564
71700
|
code_constraints?: (({
|
|
@@ -82339,6 +82475,23 @@ export type Routes = {
|
|
|
82339
82475
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
82340
82476
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
82341
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;
|
|
82342
82495
|
}) & ({
|
|
82343
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. */
|
|
82344
82497
|
code_constraints?: (({
|
|
@@ -84104,6 +84257,23 @@ export type Routes = {
|
|
|
84104
84257
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
84105
84258
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
84106
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;
|
|
84107
84277
|
}) & ({
|
|
84108
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. */
|
|
84109
84279
|
code_constraints?: (({
|
|
@@ -96243,6 +96413,23 @@ export type Routes = {
|
|
|
96243
96413
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
96244
96414
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
96245
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;
|
|
96246
96433
|
}) & ({
|
|
96247
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. */
|
|
96248
96435
|
code_constraints?: (({
|
|
@@ -116175,6 +116362,23 @@ export type Routes = {
|
|
|
116175
116362
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
116176
116363
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
116177
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;
|
|
116178
116382
|
}) & ({
|
|
116179
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. */
|
|
116180
116384
|
code_constraints?: (({
|
|
@@ -145926,6 +146130,23 @@ export type Routes = {
|
|
|
145926
146130
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
145927
146131
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
145928
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;
|
|
145929
146150
|
}) & ({
|
|
145930
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. */
|
|
145931
146152
|
code_constraints?: (({
|
|
@@ -152203,6 +152424,23 @@ export type Routes = {
|
|
|
152203
152424
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
152204
152425
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
152205
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;
|
|
152206
152444
|
}) & ({
|
|
152207
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. */
|
|
152208
152446
|
code_constraints?: (({
|
|
@@ -153968,6 +154206,23 @@ export type Routes = {
|
|
|
153968
154206
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
153969
154207
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
153970
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;
|
|
153971
154226
|
}) & ({
|
|
153972
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. */
|
|
153973
154228
|
code_constraints?: (({
|
|
@@ -165818,6 +166073,23 @@ export type Routes = {
|
|
|
165818
166073
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
165819
166074
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
165820
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;
|
|
165821
166093
|
}) & ({
|
|
165822
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. */
|
|
165823
166095
|
code_constraints?: (({
|
|
@@ -167585,6 +167857,23 @@ export type Routes = {
|
|
|
167585
167857
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
167586
167858
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
167587
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;
|
|
167588
167877
|
}) & ({
|
|
167589
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. */
|
|
167590
167879
|
code_constraints?: (({
|
|
@@ -171708,6 +171997,23 @@ export type Routes = {
|
|
|
171708
171997
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
171709
171998
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
171710
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;
|
|
171711
172017
|
}) & ({
|
|
171712
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. */
|
|
171713
172019
|
code_constraints?: (({
|
package/package.json
CHANGED
|
@@ -1492,6 +1492,56 @@ export const device_metadata = z
|
|
|
1492
1492
|
---
|
|
1493
1493
|
Metadata for a Sonos speaker.
|
|
1494
1494
|
`),
|
|
1495
|
+
hayward_omnilogic_metadata: z
|
|
1496
|
+
.object({
|
|
1497
|
+
msp_system_id: z
|
|
1498
|
+
.string()
|
|
1499
|
+
.optional()
|
|
1500
|
+
.describe(
|
|
1501
|
+
'ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to.',
|
|
1502
|
+
),
|
|
1503
|
+
backyard_name: z
|
|
1504
|
+
.string()
|
|
1505
|
+
.optional()
|
|
1506
|
+
.describe('Name of the system, as set in the Hayward OmniLogic app.'),
|
|
1507
|
+
body_of_water_id: z
|
|
1508
|
+
.string()
|
|
1509
|
+
.optional()
|
|
1510
|
+
.describe(
|
|
1511
|
+
'ID of the body of water within its system. Only present on a pool or spa body.',
|
|
1512
|
+
),
|
|
1513
|
+
body_of_water_name: z
|
|
1514
|
+
.string()
|
|
1515
|
+
.optional()
|
|
1516
|
+
.describe(
|
|
1517
|
+
'Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body.',
|
|
1518
|
+
),
|
|
1519
|
+
virtual_heater_id: z
|
|
1520
|
+
.string()
|
|
1521
|
+
.optional()
|
|
1522
|
+
.describe(
|
|
1523
|
+
'ID of the virtual heater that carries the set point and heating request for the body of water. Only present on a pool or spa body.',
|
|
1524
|
+
),
|
|
1525
|
+
is_shared_equipment: z
|
|
1526
|
+
.boolean()
|
|
1527
|
+
.optional()
|
|
1528
|
+
.describe(
|
|
1529
|
+
'Indicates whether the body of water shares its pump and heater with another body of water in the same system.',
|
|
1530
|
+
),
|
|
1531
|
+
shared_equipment_priority: z
|
|
1532
|
+
.enum(['high', 'low'])
|
|
1533
|
+
.optional()
|
|
1534
|
+
.describe(
|
|
1535
|
+
'Priority of the body of water when it shares equipment. The `high` priority body, usually the spa, takes the shared heater when both request heat.',
|
|
1536
|
+
),
|
|
1537
|
+
})
|
|
1538
|
+
.partial()
|
|
1539
|
+
.optional().describe(`
|
|
1540
|
+
---
|
|
1541
|
+
undocumented: Unreleased.
|
|
1542
|
+
---
|
|
1543
|
+
Metadata for a Hayward OmniLogic pool controller or body of water.
|
|
1544
|
+
`),
|
|
1495
1545
|
})
|
|
1496
1546
|
.partial().describe(`
|
|
1497
1547
|
---
|