@seamapi/types 1.1191.0 → 1.1193.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/seam/connect/models/acs/acs-system.d.ts +45 -0
- package/lib/seam/connect/models/acs/acs-system.js +9 -0
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- 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 +61 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +359 -4
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-system.ts +13 -0
- 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 +73 -0
- package/src/lib/seam/connect/route-types.ts +490 -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?: (({
|
|
@@ -16508,6 +16525,13 @@ export type Routes = {
|
|
|
16508
16525
|
message: string;
|
|
16509
16526
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
16510
16527
|
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
16528
|
+
} | {
|
|
16529
|
+
/** Date and time at which Seam created the warning. */
|
|
16530
|
+
created_at: string;
|
|
16531
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
16532
|
+
message: string;
|
|
16533
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
16534
|
+
warning_code: 'salto_ks_custom_pins_not_supported';
|
|
16511
16535
|
} | {
|
|
16512
16536
|
/** Date and time at which Seam created the warning. */
|
|
16513
16537
|
created_at: string;
|
|
@@ -23464,6 +23488,23 @@ export type Routes = {
|
|
|
23464
23488
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
23465
23489
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
23466
23490
|
} | undefined) | undefined;
|
|
23491
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
23492
|
+
hayward_omnilogic_metadata?: ({
|
|
23493
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
23494
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
23495
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
23496
|
+
backyard_name?: (string | undefined) | undefined;
|
|
23497
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
23498
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
23499
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
23500
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
23501
|
+
/** 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. */
|
|
23502
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
23503
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
23504
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
23505
|
+
/** 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. */
|
|
23506
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
23507
|
+
} | undefined) | undefined;
|
|
23467
23508
|
}) & ({
|
|
23468
23509
|
/** 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
23510
|
code_constraints?: (({
|
|
@@ -41372,6 +41413,13 @@ export type Routes = {
|
|
|
41372
41413
|
message: string;
|
|
41373
41414
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
41374
41415
|
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
41416
|
+
} | {
|
|
41417
|
+
/** Date and time at which Seam created the warning. */
|
|
41418
|
+
created_at: string;
|
|
41419
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
41420
|
+
message: string;
|
|
41421
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
41422
|
+
warning_code: 'salto_ks_custom_pins_not_supported';
|
|
41375
41423
|
} | {
|
|
41376
41424
|
/** Date and time at which Seam created the warning. */
|
|
41377
41425
|
created_at: string;
|
|
@@ -41548,6 +41596,13 @@ export type Routes = {
|
|
|
41548
41596
|
message: string;
|
|
41549
41597
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
41550
41598
|
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
41599
|
+
} | {
|
|
41600
|
+
/** Date and time at which Seam created the warning. */
|
|
41601
|
+
created_at: string;
|
|
41602
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
41603
|
+
message: string;
|
|
41604
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
41605
|
+
warning_code: 'salto_ks_custom_pins_not_supported';
|
|
41551
41606
|
} | {
|
|
41552
41607
|
/** Date and time at which Seam created the warning. */
|
|
41553
41608
|
created_at: string;
|
|
@@ -41720,6 +41775,13 @@ export type Routes = {
|
|
|
41720
41775
|
message: string;
|
|
41721
41776
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
41722
41777
|
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
41778
|
+
} | {
|
|
41779
|
+
/** Date and time at which Seam created the warning. */
|
|
41780
|
+
created_at: string;
|
|
41781
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
41782
|
+
message: string;
|
|
41783
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
41784
|
+
warning_code: 'salto_ks_custom_pins_not_supported';
|
|
41723
41785
|
} | {
|
|
41724
41786
|
/** Date and time at which Seam created the warning. */
|
|
41725
41787
|
created_at: string;
|
|
@@ -48538,7 +48600,7 @@ export type Routes = {
|
|
|
48538
48600
|
/** 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
48601
|
customer_key?: string | undefined;
|
|
48540
48602
|
/** 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;
|
|
48603
|
+
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
48604
|
/** 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
48605
|
provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors' | 'internal_beta') | undefined;
|
|
48544
48606
|
/** 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 +51365,23 @@ export type Routes = {
|
|
|
51303
51365
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
51304
51366
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
51305
51367
|
} | undefined) | undefined;
|
|
51368
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
51369
|
+
hayward_omnilogic_metadata?: ({
|
|
51370
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
51371
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
51372
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
51373
|
+
backyard_name?: (string | undefined) | undefined;
|
|
51374
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
51375
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
51376
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
51377
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
51378
|
+
/** 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. */
|
|
51379
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
51380
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
51381
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
51382
|
+
/** 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. */
|
|
51383
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
51384
|
+
} | undefined) | undefined;
|
|
51306
51385
|
}) & ({
|
|
51307
51386
|
/** 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
51387
|
code_constraints?: (({
|
|
@@ -52262,7 +52341,7 @@ export type Routes = {
|
|
|
52262
52341
|
/** Array of device types for which you want to list devices. */
|
|
52263
52342
|
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
52343
|
/** 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;
|
|
52344
|
+
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
52345
|
/** Array of device IDs for which you want to list devices. */
|
|
52267
52346
|
device_ids?: string[] | undefined;
|
|
52268
52347
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -53121,6 +53200,23 @@ export type Routes = {
|
|
|
53121
53200
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
53122
53201
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
53123
53202
|
} | undefined) | undefined;
|
|
53203
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
53204
|
+
hayward_omnilogic_metadata?: ({
|
|
53205
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
53206
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
53207
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
53208
|
+
backyard_name?: (string | undefined) | undefined;
|
|
53209
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
53210
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
53211
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
53212
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
53213
|
+
/** 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. */
|
|
53214
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
53215
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
53216
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
53217
|
+
/** 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. */
|
|
53218
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
53219
|
+
} | undefined) | undefined;
|
|
53124
53220
|
}) & ({
|
|
53125
53221
|
/** 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
53222
|
code_constraints?: (({
|
|
@@ -54083,7 +54179,7 @@ export type Routes = {
|
|
|
54083
54179
|
jsonResponse: {
|
|
54084
54180
|
device_providers: {
|
|
54085
54181
|
/** 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';
|
|
54182
|
+
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
54183
|
/** Display name for the device provider. */
|
|
54088
54184
|
display_name: string;
|
|
54089
54185
|
/** Image URL for the device provider. */
|
|
@@ -54828,7 +54924,7 @@ export type Routes = {
|
|
|
54828
54924
|
/** Array of device types for which you want to list devices. */
|
|
54829
54925
|
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
54926
|
/** 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;
|
|
54927
|
+
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
54928
|
/** Array of device IDs for which you want to list devices. */
|
|
54833
54929
|
device_ids?: string[] | undefined;
|
|
54834
54930
|
/** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
|
|
@@ -66239,6 +66335,23 @@ export type Routes = {
|
|
|
66239
66335
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
66240
66336
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
66241
66337
|
} | undefined) | undefined;
|
|
66338
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
66339
|
+
hayward_omnilogic_metadata?: ({
|
|
66340
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
66341
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
66342
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
66343
|
+
backyard_name?: (string | undefined) | undefined;
|
|
66344
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
66345
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
66346
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
66347
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
66348
|
+
/** 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. */
|
|
66349
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
66350
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
66351
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
66352
|
+
/** 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. */
|
|
66353
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
66354
|
+
} | undefined) | undefined;
|
|
66242
66355
|
}) & ({
|
|
66243
66356
|
/** 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
66357
|
code_constraints?: (({
|
|
@@ -68005,6 +68118,23 @@ export type Routes = {
|
|
|
68005
68118
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
68006
68119
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
68007
68120
|
} | undefined) | undefined;
|
|
68121
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
68122
|
+
hayward_omnilogic_metadata?: ({
|
|
68123
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
68124
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
68125
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
68126
|
+
backyard_name?: (string | undefined) | undefined;
|
|
68127
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
68128
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
68129
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
68130
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
68131
|
+
/** 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. */
|
|
68132
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
68133
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
68134
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
68135
|
+
/** 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. */
|
|
68136
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
68137
|
+
} | undefined) | undefined;
|
|
68008
68138
|
}) & ({
|
|
68009
68139
|
/** 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
68140
|
code_constraints?: (({
|
|
@@ -69794,6 +69924,23 @@ export type Routes = {
|
|
|
69794
69924
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
69795
69925
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
69796
69926
|
} | undefined) | undefined;
|
|
69927
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
69928
|
+
hayward_omnilogic_metadata?: ({
|
|
69929
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
69930
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
69931
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
69932
|
+
backyard_name?: (string | undefined) | undefined;
|
|
69933
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
69934
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
69935
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
69936
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
69937
|
+
/** 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. */
|
|
69938
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
69939
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
69940
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
69941
|
+
/** 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. */
|
|
69942
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
69943
|
+
} | undefined) | undefined;
|
|
69797
69944
|
}) & ({
|
|
69798
69945
|
/** 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
69946
|
code_constraints?: (({
|
|
@@ -71559,6 +71706,23 @@ export type Routes = {
|
|
|
71559
71706
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
71560
71707
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
71561
71708
|
} | undefined) | undefined;
|
|
71709
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
71710
|
+
hayward_omnilogic_metadata?: ({
|
|
71711
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
71712
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
71713
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
71714
|
+
backyard_name?: (string | undefined) | undefined;
|
|
71715
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
71716
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
71717
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
71718
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
71719
|
+
/** 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. */
|
|
71720
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
71721
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
71722
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
71723
|
+
/** 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. */
|
|
71724
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
71725
|
+
} | undefined) | undefined;
|
|
71562
71726
|
}) & ({
|
|
71563
71727
|
/** 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
71728
|
code_constraints?: (({
|
|
@@ -82339,6 +82503,23 @@ export type Routes = {
|
|
|
82339
82503
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
82340
82504
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
82341
82505
|
} | undefined) | undefined;
|
|
82506
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
82507
|
+
hayward_omnilogic_metadata?: ({
|
|
82508
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
82509
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
82510
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
82511
|
+
backyard_name?: (string | undefined) | undefined;
|
|
82512
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
82513
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
82514
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
82515
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
82516
|
+
/** 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. */
|
|
82517
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
82518
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
82519
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
82520
|
+
/** 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. */
|
|
82521
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
82522
|
+
} | undefined) | undefined;
|
|
82342
82523
|
}) & ({
|
|
82343
82524
|
/** 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
82525
|
code_constraints?: (({
|
|
@@ -84104,6 +84285,23 @@ export type Routes = {
|
|
|
84104
84285
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
84105
84286
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
84106
84287
|
} | undefined) | undefined;
|
|
84288
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
84289
|
+
hayward_omnilogic_metadata?: ({
|
|
84290
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
84291
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
84292
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
84293
|
+
backyard_name?: (string | undefined) | undefined;
|
|
84294
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
84295
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
84296
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
84297
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
84298
|
+
/** 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. */
|
|
84299
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
84300
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
84301
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
84302
|
+
/** 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. */
|
|
84303
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
84304
|
+
} | undefined) | undefined;
|
|
84107
84305
|
}) & ({
|
|
84108
84306
|
/** 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
84307
|
code_constraints?: (({
|
|
@@ -96243,6 +96441,23 @@ export type Routes = {
|
|
|
96243
96441
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
96244
96442
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
96245
96443
|
} | undefined) | undefined;
|
|
96444
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
96445
|
+
hayward_omnilogic_metadata?: ({
|
|
96446
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
96447
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
96448
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
96449
|
+
backyard_name?: (string | undefined) | undefined;
|
|
96450
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
96451
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
96452
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
96453
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
96454
|
+
/** 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. */
|
|
96455
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
96456
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
96457
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
96458
|
+
/** 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. */
|
|
96459
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
96460
|
+
} | undefined) | undefined;
|
|
96246
96461
|
}) & ({
|
|
96247
96462
|
/** 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
96463
|
code_constraints?: (({
|
|
@@ -116175,6 +116390,23 @@ export type Routes = {
|
|
|
116175
116390
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
116176
116391
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
116177
116392
|
} | undefined) | undefined;
|
|
116393
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
116394
|
+
hayward_omnilogic_metadata?: ({
|
|
116395
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
116396
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
116397
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
116398
|
+
backyard_name?: (string | undefined) | undefined;
|
|
116399
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
116400
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
116401
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
116402
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
116403
|
+
/** 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. */
|
|
116404
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
116405
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
116406
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
116407
|
+
/** 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. */
|
|
116408
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
116409
|
+
} | undefined) | undefined;
|
|
116178
116410
|
}) & ({
|
|
116179
116411
|
/** 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
116412
|
code_constraints?: (({
|
|
@@ -117629,6 +117861,13 @@ export type Routes = {
|
|
|
117629
117861
|
message: string;
|
|
117630
117862
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
117631
117863
|
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
117864
|
+
} | {
|
|
117865
|
+
/** Date and time at which Seam created the warning. */
|
|
117866
|
+
created_at: string;
|
|
117867
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
117868
|
+
message: string;
|
|
117869
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
117870
|
+
warning_code: 'salto_ks_custom_pins_not_supported';
|
|
117632
117871
|
} | {
|
|
117633
117872
|
/** Date and time at which Seam created the warning. */
|
|
117634
117873
|
created_at: string;
|
|
@@ -145926,6 +146165,23 @@ export type Routes = {
|
|
|
145926
146165
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
145927
146166
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
145928
146167
|
} | undefined) | undefined;
|
|
146168
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
146169
|
+
hayward_omnilogic_metadata?: ({
|
|
146170
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
146171
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
146172
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
146173
|
+
backyard_name?: (string | undefined) | undefined;
|
|
146174
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
146175
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
146176
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
146177
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
146178
|
+
/** 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. */
|
|
146179
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
146180
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
146181
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
146182
|
+
/** 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. */
|
|
146183
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
146184
|
+
} | undefined) | undefined;
|
|
145929
146185
|
}) & ({
|
|
145930
146186
|
/** 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
146187
|
code_constraints?: (({
|
|
@@ -152203,6 +152459,23 @@ export type Routes = {
|
|
|
152203
152459
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
152204
152460
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
152205
152461
|
} | undefined) | undefined;
|
|
152462
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
152463
|
+
hayward_omnilogic_metadata?: ({
|
|
152464
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
152465
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
152466
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
152467
|
+
backyard_name?: (string | undefined) | undefined;
|
|
152468
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
152469
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
152470
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
152471
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
152472
|
+
/** 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. */
|
|
152473
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
152474
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
152475
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
152476
|
+
/** 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. */
|
|
152477
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
152478
|
+
} | undefined) | undefined;
|
|
152206
152479
|
}) & ({
|
|
152207
152480
|
/** 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
152481
|
code_constraints?: (({
|
|
@@ -153968,6 +154241,23 @@ export type Routes = {
|
|
|
153968
154241
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
153969
154242
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
153970
154243
|
} | undefined) | undefined;
|
|
154244
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
154245
|
+
hayward_omnilogic_metadata?: ({
|
|
154246
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
154247
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
154248
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
154249
|
+
backyard_name?: (string | undefined) | undefined;
|
|
154250
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
154251
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
154252
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
154253
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
154254
|
+
/** 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. */
|
|
154255
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
154256
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
154257
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
154258
|
+
/** 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. */
|
|
154259
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
154260
|
+
} | undefined) | undefined;
|
|
153971
154261
|
}) & ({
|
|
153972
154262
|
/** 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
154263
|
code_constraints?: (({
|
|
@@ -165818,6 +166108,23 @@ export type Routes = {
|
|
|
165818
166108
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
165819
166109
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
165820
166110
|
} | undefined) | undefined;
|
|
166111
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
166112
|
+
hayward_omnilogic_metadata?: ({
|
|
166113
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
166114
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
166115
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
166116
|
+
backyard_name?: (string | undefined) | undefined;
|
|
166117
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
166118
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
166119
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
166120
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
166121
|
+
/** 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. */
|
|
166122
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
166123
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
166124
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
166125
|
+
/** 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. */
|
|
166126
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
166127
|
+
} | undefined) | undefined;
|
|
165821
166128
|
}) & ({
|
|
165822
166129
|
/** 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
166130
|
code_constraints?: (({
|
|
@@ -167585,6 +167892,23 @@ export type Routes = {
|
|
|
167585
167892
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
167586
167893
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
167587
167894
|
} | undefined) | undefined;
|
|
167895
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
167896
|
+
hayward_omnilogic_metadata?: ({
|
|
167897
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
167898
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
167899
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
167900
|
+
backyard_name?: (string | undefined) | undefined;
|
|
167901
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
167902
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
167903
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
167904
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
167905
|
+
/** 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. */
|
|
167906
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
167907
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
167908
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
167909
|
+
/** 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. */
|
|
167910
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
167911
|
+
} | undefined) | undefined;
|
|
167588
167912
|
}) & ({
|
|
167589
167913
|
/** 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
167914
|
code_constraints?: (({
|
|
@@ -168887,6 +169211,13 @@ export type Routes = {
|
|
|
168887
169211
|
message: string;
|
|
168888
169212
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
168889
169213
|
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
169214
|
+
} | {
|
|
169215
|
+
/** Date and time at which Seam created the warning. */
|
|
169216
|
+
created_at: string;
|
|
169217
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
169218
|
+
message: string;
|
|
169219
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
169220
|
+
warning_code: 'salto_ks_custom_pins_not_supported';
|
|
168890
169221
|
} | {
|
|
168891
169222
|
/** Date and time at which Seam created the warning. */
|
|
168892
169223
|
created_at: string;
|
|
@@ -171708,6 +172039,23 @@ export type Routes = {
|
|
|
171708
172039
|
/** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
|
|
171709
172040
|
bonded_member_models?: (string[] | undefined) | undefined;
|
|
171710
172041
|
} | undefined) | undefined;
|
|
172042
|
+
/** Metadata for a Hayward OmniLogic pool controller or body of water. */
|
|
172043
|
+
hayward_omnilogic_metadata?: ({
|
|
172044
|
+
/** ID of the Hayward OmniLogic system (the controller, called an MSP by Hayward) that the device belongs to. */
|
|
172045
|
+
msp_system_id?: (string | undefined) | undefined;
|
|
172046
|
+
/** Name of the system, as set in the Hayward OmniLogic app. */
|
|
172047
|
+
backyard_name?: (string | undefined) | undefined;
|
|
172048
|
+
/** ID of the body of water within its system. Only present on a pool or spa body. */
|
|
172049
|
+
body_of_water_id?: (string | undefined) | undefined;
|
|
172050
|
+
/** Name of the body of water, as set in the Hayward OmniLogic app. Only present on a pool or spa body. */
|
|
172051
|
+
body_of_water_name?: (string | undefined) | undefined;
|
|
172052
|
+
/** 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. */
|
|
172053
|
+
virtual_heater_id?: (string | undefined) | undefined;
|
|
172054
|
+
/** Indicates whether the body of water shares its pump and heater with another body of water in the same system. */
|
|
172055
|
+
is_shared_equipment?: (boolean | undefined) | undefined;
|
|
172056
|
+
/** 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. */
|
|
172057
|
+
shared_equipment_priority?: (('high' | 'low') | undefined) | undefined;
|
|
172058
|
+
} | undefined) | undefined;
|
|
171711
172059
|
}) & ({
|
|
171712
172060
|
/** 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
172061
|
code_constraints?: (({
|
|
@@ -172982,6 +173330,13 @@ export type Routes = {
|
|
|
172982
173330
|
message: string;
|
|
172983
173331
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
172984
173332
|
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
173333
|
+
} | {
|
|
173334
|
+
/** Date and time at which Seam created the warning. */
|
|
173335
|
+
created_at: string;
|
|
173336
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
173337
|
+
message: string;
|
|
173338
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
173339
|
+
warning_code: 'salto_ks_custom_pins_not_supported';
|
|
172985
173340
|
} | {
|
|
172986
173341
|
/** Date and time at which Seam created the warning. */
|
|
172987
173342
|
created_at: string;
|