From ad3b1562749b779d4d5758abe53a245d6525d370 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 2 Jan 2025 10:28:31 +0100 Subject: [PATCH] Code maintenance: lint, format and build code, generate docs (#805) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- README.md | 2604 ++++++++++++++++++++++++++--------------------------- 1 file changed, 1291 insertions(+), 1313 deletions(-) diff --git a/README.md b/README.md index 552554e..bbe56e0 100644 --- a/README.md +++ b/README.md @@ -1,175 +1,197 @@ -# MELCloud API for Node.js - v17.6.4 +# MELCloud API for Node.js - v17.7.0 ## Enumerations ### DeviceType +Defined in: [src/enums.ts:1](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L1) + #### Enumeration Members -| Enumeration Member | Value | Defined in | -| ------------------ | ----- | -------------------------------------------------------------------------------------------------------------------------- | -| `Ata` | `0` | [src/enums.ts:2](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L2) | -| `Atw` | `1` | [src/enums.ts:3](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L3) | -| `Erv` | `3` | [src/enums.ts:4](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L4) | +| Enumeration Member | Value | Defined in | +| ---------------------- | ----- | -------------------------------------------------------------------------------------------------------------------------- | +| `Ata` | `0` | [src/enums.ts:2](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L2) | +| `Atw` | `1` | [src/enums.ts:3](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L3) | +| `Erv` | `3` | [src/enums.ts:4](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L4) | --- ### FanSpeed +Defined in: [src/enums.ts:7](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L7) + #### Enumeration Members -| Enumeration Member | Value | Defined in | -| ------------------ | ----- | ---------------------------------------------------------------------------------------------------------------------------- | -| `auto` | `0` | [src/enums.ts:8](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L8) | -| `fast` | `4` | [src/enums.ts:9](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L9) | -| `moderate` | `3` | [src/enums.ts:10](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L10) | -| `silent` | `255` | [src/enums.ts:11](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L11) | -| `slow` | `2` | [src/enums.ts:12](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L12) | -| `very_fast` | `5` | [src/enums.ts:13](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L13) | -| `very_slow` | `1` | [src/enums.ts:14](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L14) | +| Enumeration Member | Value | Defined in | +| ---------------------------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------- | +| `auto` | `0` | [src/enums.ts:8](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L8) | +| `fast` | `4` | [src/enums.ts:9](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L9) | +| `moderate` | `3` | [src/enums.ts:10](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L10) | +| `silent` | `255` | [src/enums.ts:11](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L11) | +| `slow` | `2` | [src/enums.ts:12](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L12) | +| `very_fast` | `5` | [src/enums.ts:13](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L13) | +| `very_slow` | `1` | [src/enums.ts:14](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L14) | --- ### Horizontal +Defined in: [src/enums.ts:17](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L17) + #### Enumeration Members -| Enumeration Member | Value | Defined in | -| ------------------ | ----- | ---------------------------------------------------------------------------------------------------------------------------- | -| `auto` | `0` | [src/enums.ts:18](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L18) | -| `center` | `3` | [src/enums.ts:19](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L19) | -| `center_left` | `2` | [src/enums.ts:20](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L20) | -| `center_right` | `4` | [src/enums.ts:21](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L21) | -| `leftwards` | `1` | [src/enums.ts:22](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L22) | -| `rightwards` | `5` | [src/enums.ts:23](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L23) | -| `swing` | `12` | [src/enums.ts:24](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L24) | -| `wide` | `8` | [src/enums.ts:25](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L25) | +| Enumeration Member | Value | Defined in | +| ---------------------------------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------- | +| `auto` | `0` | [src/enums.ts:18](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L18) | +| `center` | `3` | [src/enums.ts:19](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L19) | +| `center_left` | `2` | [src/enums.ts:20](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L20) | +| `center_right` | `4` | [src/enums.ts:21](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L21) | +| `leftwards` | `1` | [src/enums.ts:22](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L22) | +| `rightwards` | `5` | [src/enums.ts:23](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L23) | +| `swing` | `12` | [src/enums.ts:24](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L24) | +| `wide` | `8` | [src/enums.ts:25](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L25) | --- ### LabelType +Defined in: [src/enums.ts:28](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L28) + #### Enumeration Members -| Enumeration Member | Value | Defined in | -| ------------------ | ----- | ---------------------------------------------------------------------------------------------------------------------------- | -| `day_of_week` | `4` | [src/enums.ts:29](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L29) | -| `month` | `2` | [src/enums.ts:30](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L30) | -| `month_of_year` | `3` | [src/enums.ts:31](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L31) | -| `raw` | `1` | [src/enums.ts:32](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L32) | -| `time` | `0` | [src/enums.ts:33](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L33) | +| Enumeration Member | Value | Defined in | +| ------------------------------------------ | ----- | ---------------------------------------------------------------------------------------------------------------------------- | +| `day_of_week` | `4` | [src/enums.ts:29](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L29) | +| `month` | `2` | [src/enums.ts:30](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L30) | +| `month_of_year` | `3` | [src/enums.ts:31](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L31) | +| `raw` | `1` | [src/enums.ts:32](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L32) | +| `time` | `0` | [src/enums.ts:33](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L33) | --- ### Language +Defined in: [src/enums.ts:36](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L36) + #### Enumeration Members -| Enumeration Member | Value | Defined in | -| ------------------ | ----- | ---------------------------------------------------------------------------------------------------------------------------- | -| `bg` | `1` | [src/enums.ts:37](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L37) | -| `cs` | `2` | [src/enums.ts:38](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L38) | -| `da` | `3` | [src/enums.ts:39](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L39) | -| `de` | `4` | [src/enums.ts:40](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L40) | -| `el` | `22` | [src/enums.ts:41](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L41) | -| `en` | `0` | [src/enums.ts:42](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L42) | -| `es` | `6` | [src/enums.ts:43](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L43) | -| `et` | `5` | [src/enums.ts:44](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L44) | -| `fi` | `17` | [src/enums.ts:45](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L45) | -| `fr` | `7` | [src/enums.ts:46](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L46) | -| `hr` | `23` | [src/enums.ts:47](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L47) | -| `hu` | `11` | [src/enums.ts:48](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L48) | -| `hy` | `8` | [src/enums.ts:49](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L49) | -| `it` | `19` | [src/enums.ts:50](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L50) | -| `lt` | `10` | [src/enums.ts:51](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L51) | -| `lv` | `9` | [src/enums.ts:52](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L52) | -| `nl` | `12` | [src/enums.ts:53](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L53) | -| `no` | `13` | [src/enums.ts:54](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L54) | -| `pl` | `14` | [src/enums.ts:55](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L55) | -| `pt` | `15` | [src/enums.ts:56](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L56) | -| `ro` | `24` | [src/enums.ts:57](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L57) | -| `ru` | `16` | [src/enums.ts:58](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L58) | -| `sl` | `25` | [src/enums.ts:59](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L59) | -| `sq` | `26` | [src/enums.ts:60](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L60) | -| `sv` | `18` | [src/enums.ts:61](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L61) | -| `tr` | `21` | [src/enums.ts:62](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L62) | -| `uk` | `20` | [src/enums.ts:63](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L63) | +| Enumeration Member | Value | Defined in | +| -------------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------- | +| `bg` | `1` | [src/enums.ts:37](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L37) | +| `cs` | `2` | [src/enums.ts:38](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L38) | +| `da` | `3` | [src/enums.ts:39](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L39) | +| `de` | `4` | [src/enums.ts:40](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L40) | +| `el` | `22` | [src/enums.ts:41](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L41) | +| `en` | `0` | [src/enums.ts:42](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L42) | +| `es` | `6` | [src/enums.ts:43](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L43) | +| `et` | `5` | [src/enums.ts:44](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L44) | +| `fi` | `17` | [src/enums.ts:45](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L45) | +| `fr` | `7` | [src/enums.ts:46](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L46) | +| `hr` | `23` | [src/enums.ts:47](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L47) | +| `hu` | `11` | [src/enums.ts:48](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L48) | +| `hy` | `8` | [src/enums.ts:49](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L49) | +| `it` | `19` | [src/enums.ts:50](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L50) | +| `lt` | `10` | [src/enums.ts:51](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L51) | +| `lv` | `9` | [src/enums.ts:52](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L52) | +| `nl` | `12` | [src/enums.ts:53](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L53) | +| `no` | `13` | [src/enums.ts:54](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L54) | +| `pl` | `14` | [src/enums.ts:55](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L55) | +| `pt` | `15` | [src/enums.ts:56](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L56) | +| `ro` | `24` | [src/enums.ts:57](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L57) | +| `ru` | `16` | [src/enums.ts:58](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L58) | +| `sl` | `25` | [src/enums.ts:59](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L59) | +| `sq` | `26` | [src/enums.ts:60](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L60) | +| `sv` | `18` | [src/enums.ts:61](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L61) | +| `tr` | `21` | [src/enums.ts:62](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L62) | +| `uk` | `20` | [src/enums.ts:63](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L63) | --- ### OperationMode +Defined in: [src/enums.ts:66](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L66) + #### Enumeration Members -| Enumeration Member | Value | Defined in | -| ------------------ | ----- | ---------------------------------------------------------------------------------------------------------------------------- | -| `auto` | `8` | [src/enums.ts:67](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L67) | -| `cool` | `3` | [src/enums.ts:68](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L68) | -| `dry` | `2` | [src/enums.ts:69](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L69) | -| `fan` | `7` | [src/enums.ts:70](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L70) | -| `heat` | `1` | [src/enums.ts:71](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L71) | +| Enumeration Member | Value | Defined in | +| -------------------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------- | +| `auto` | `8` | [src/enums.ts:67](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L67) | +| `cool` | `3` | [src/enums.ts:68](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L68) | +| `dry` | `2` | [src/enums.ts:69](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L69) | +| `fan` | `7` | [src/enums.ts:70](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L70) | +| `heat` | `1` | [src/enums.ts:71](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L71) | --- ### OperationModeState +Defined in: [src/enums.ts:74](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L74) + #### Enumeration Members -| Enumeration Member | Value | Defined in | -| ------------------ | ----- | ---------------------------------------------------------------------------------------------------------------------------- | -| `cooling` | `3` | [src/enums.ts:75](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L75) | -| `defrost` | `5` | [src/enums.ts:76](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L76) | -| `dhw` | `1` | [src/enums.ts:77](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L77) | -| `heating` | `2` | [src/enums.ts:78](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L78) | -| `idle` | `0` | [src/enums.ts:79](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L79) | -| `legionella` | `6` | [src/enums.ts:80](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L80) | +| Enumeration Member | Value | Defined in | +| ------------------------------------ | ----- | ---------------------------------------------------------------------------------------------------------------------------- | +| `cooling` | `3` | [src/enums.ts:75](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L75) | +| `defrost` | `5` | [src/enums.ts:76](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L76) | +| `dhw` | `1` | [src/enums.ts:77](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L77) | +| `heating` | `2` | [src/enums.ts:78](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L78) | +| `idle` | `0` | [src/enums.ts:79](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L79) | +| `legionella` | `6` | [src/enums.ts:80](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L80) | --- ### OperationModeZone +Defined in: [src/enums.ts:83](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L83) + #### Enumeration Members -| Enumeration Member | Value | Defined in | -| ------------------ | ----- | ---------------------------------------------------------------------------------------------------------------------------- | -| `curve` | `2` | [src/enums.ts:84](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L84) | -| `flow` | `1` | [src/enums.ts:85](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L85) | -| `flow_cool` | `4` | [src/enums.ts:86](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L86) | -| `room` | `0` | [src/enums.ts:87](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L87) | -| `room_cool` | `3` | [src/enums.ts:88](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L88) | +| Enumeration Member | Value | Defined in | +| ---------------------------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------- | +| `curve` | `2` | [src/enums.ts:84](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L84) | +| `flow` | `1` | [src/enums.ts:85](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L85) | +| `flow_cool` | `4` | [src/enums.ts:86](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L86) | +| `room` | `0` | [src/enums.ts:87](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L87) | +| `room_cool` | `3` | [src/enums.ts:88](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L88) | --- ### VentilationMode +Defined in: [src/enums.ts:91](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L91) + #### Enumeration Members -| Enumeration Member | Value | Defined in | -| ------------------ | ----- | ---------------------------------------------------------------------------------------------------------------------------- | -| `auto` | `2` | [src/enums.ts:92](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L92) | -| `bypass` | `1` | [src/enums.ts:93](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L93) | -| `recovery` | `0` | [src/enums.ts:94](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L94) | +| Enumeration Member | Value | Defined in | +| -------------------------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------- | +| `auto` | `2` | [src/enums.ts:92](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L92) | +| `bypass` | `1` | [src/enums.ts:93](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L93) | +| `recovery` | `0` | [src/enums.ts:94](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L94) | --- ### Vertical +Defined in: [src/enums.ts:97](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L97) + #### Enumeration Members -| Enumeration Member | Value | Defined in | -| ------------------ | ----- | ------------------------------------------------------------------------------------------------------------------------------ | -| `auto` | `0` | [src/enums.ts:98](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L98) | -| `downwards` | `5` | [src/enums.ts:99](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L99) | -| `mid_high` | `2` | [src/enums.ts:100](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L100) | -| `mid_low` | `4` | [src/enums.ts:101](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L101) | -| `middle` | `3` | [src/enums.ts:102](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L102) | -| `swing` | `7` | [src/enums.ts:103](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L103) | -| `upwards` | `1` | [src/enums.ts:104](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/enums.ts#L104) | +| Enumeration Member | Value | Defined in | +| ---------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------ | +| `auto` | `0` | [src/enums.ts:98](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L98) | +| `downwards` | `5` | [src/enums.ts:99](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L99) | +| `mid_high` | `2` | [src/enums.ts:100](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L100) | +| `mid_low` | `4` | [src/enums.ts:101](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L101) | +| `middle` | `3` | [src/enums.ts:102](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L102) | +| `swing` | `7` | [src/enums.ts:103](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L103) | +| `upwards` | `1` | [src/enums.ts:104](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/enums.ts#L104) | ## Classes ### AreaModel\ +Defined in: [src/models/area.ts:15](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/area.ts#L15) + #### Extends - `BaseModel` @@ -186,12 +208,12 @@ #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ------------ | ---------- | ------------------ | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `buildingId` | `readonly` | `number` | - | [src/models/area.ts:27](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/area.ts#L27) | -| `floorId` | `readonly` | `null` \| `number` | - | [src/models/area.ts:29](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/area.ts#L29) | -| `id` | `readonly` | `number` | [`IAreaModel`](README.md#iareamodel).`id` `BaseModel.id` | [src/models/base.ts:4](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/base.ts#L4) | -| `name` | `readonly` | `string` | [`IAreaModel`](README.md#iareamodel).`name` `BaseModel.name` | [src/models/base.ts:6](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/base.ts#L6) | +| Property | Modifier | Type | Inherited from | Defined in | +| ------------------------------------ | ---------- | ------------------ | -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `buildingId` | `readonly` | `number` | - | [src/models/area.ts:27](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/area.ts#L27) | +| `floorId` | `readonly` | `null` \| `number` | - | [src/models/area.ts:29](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/area.ts#L29) | +| `id` | `readonly` | `number` | [`IAreaModel`](README.md#iareamodel).[`id`](README.md#id-9) `BaseModel.id` | [src/models/base.ts:4](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/base.ts#L4) | +| `name` | `readonly` | `string` | [`IAreaModel`](README.md#iareamodel).[`name`](README.md#name-8) `BaseModel.name` | [src/models/base.ts:6](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/base.ts#L6) | #### Accessors @@ -203,17 +225,15 @@ get building(): undefined | IBuildingModel ``` +Defined in: [src/models/area.ts:42](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/area.ts#L42) + ###### Returns `undefined` \| [`IBuildingModel`](README.md#ibuildingmodel) ###### Implementation of -[`IAreaModel`](README.md#iareamodel).`building` - -###### Defined in - -[src/models/area.ts:42](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/area.ts#L42) +[`IAreaModel`](README.md#iareamodel).[`building`](README.md#building-4) ##### deviceIds @@ -223,17 +243,15 @@ get building(): undefined | IBuildingModel get deviceIds(): number[] ``` +Defined in: [src/models/area.ts:46](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/area.ts#L46) + ###### Returns `number`[] ###### Implementation of -[`IAreaModel`](README.md#iareamodel).`deviceIds` - -###### Defined in - -[src/models/area.ts:46](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/area.ts#L46) +[`IAreaModel`](README.md#iareamodel).[`deviceIds`](README.md#deviceids-6) ##### devices @@ -243,17 +261,15 @@ get deviceIds(): number[] get devices(): IDeviceModelAny[] ``` +Defined in: [src/models/area.ts:50](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/area.ts#L50) + ###### Returns [`IDeviceModelAny`](README.md#idevicemodelany)[] ###### Implementation of -[`IAreaModel`](README.md#iareamodel).`devices` - -###### Defined in - -[src/models/area.ts:50](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/area.ts#L50) +[`IAreaModel`](README.md#iareamodel).[`devices`](README.md#devices-5) ##### floor @@ -263,17 +279,15 @@ get devices(): IDeviceModelAny[] get floor(): undefined | null | IFloorModel ``` +Defined in: [src/models/area.ts:54](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/area.ts#L54) + ###### Returns `undefined` \| `null` \| [`IFloorModel`](README.md#ifloormodel) ###### Implementation of -[`IAreaModel`](README.md#iareamodel).`floor` - -###### Defined in - -[src/models/area.ts:54](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/area.ts#L54) +[`IAreaModel`](README.md#iareamodel).[`floor`](README.md#floor-2) #### Methods @@ -283,20 +297,20 @@ get floor(): undefined | null | IFloorModel static getAll(): IAreaModel[] ``` +Defined in: [src/models/area.ts:60](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/area.ts#L60) + ###### Returns [`IAreaModel`](README.md#iareamodel)[] -###### Defined in - -[src/models/area.ts:60](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/area.ts#L60) - ##### getByBuildingId() ```ts static getByBuildingId(id: number): IAreaModel[] ``` +Defined in: [src/models/area.ts:64](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/area.ts#L64) + ###### Parameters | Parameter | Type | @@ -307,16 +321,14 @@ static getByBuildingId(id: number): IAreaModel[] [`IAreaModel`](README.md#iareamodel)[] -###### Defined in - -[src/models/area.ts:64](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/area.ts#L64) - ##### getByFloorId() ```ts static getByFloorId(id: number): IAreaModel[] ``` +Defined in: [src/models/area.ts:68](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/area.ts#L68) + ###### Parameters | Parameter | Type | @@ -327,16 +339,14 @@ static getByFloorId(id: number): IAreaModel[] [`IAreaModel`](README.md#iareamodel)[] -###### Defined in - -[src/models/area.ts:68](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/area.ts#L68) - ##### getById() ```ts static getById(id: number): undefined | IAreaModel ``` +Defined in: [src/models/area.ts:72](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/area.ts#L72) + ###### Parameters | Parameter | Type | @@ -347,16 +357,14 @@ static getById(id: number): undefined | IAreaModel `undefined` \| [`IAreaModel`](README.md#iareamodel) -###### Defined in - -[src/models/area.ts:72](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/area.ts#L72) - ##### getByName() ```ts static getByName(name: string): undefined | IAreaModel ``` +Defined in: [src/models/area.ts:76](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/area.ts#L76) + ###### Parameters | Parameter | Type | @@ -367,10 +375,6 @@ static getByName(name: string): undefined | IAreaModel `undefined` \| [`IAreaModel`](README.md#iareamodel) -###### Defined in - -[src/models/area.ts:76](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/area.ts#L76) - ##### setModels() ```ts @@ -381,6 +385,8 @@ static setModels(__namedParameters: { }): void ``` +Defined in: [src/models/area.ts:80](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/area.ts#L80) + ###### Parameters | Parameter | Type | @@ -394,16 +400,14 @@ static setModels(__namedParameters: { `void` -###### Defined in - -[src/models/area.ts:80](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/area.ts#L80) - ##### sync() ```ts static sync(areas: AreaDataAny[]): void ``` +Defined in: [src/models/area.ts:94](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/area.ts#L94) + ###### Parameters | Parameter | Type | @@ -414,14 +418,12 @@ static sync(areas: AreaDataAny[]): void `void` -###### Defined in - -[src/models/area.ts:94](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/area.ts#L94) - --- ### BuildingModel +Defined in: [src/models/building.ts:15](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/building.ts#L15) + #### Extends - `BaseModel` @@ -432,12 +434,12 @@ static sync(areas: AreaDataAny[]): void #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ---------- | ---------- | ---------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | `readonly` | [`ZoneSettings`](README.md#zonesettings) | - | [src/models/building.ts:24](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/building.ts#L24) | -| `id` | `readonly` | `number` | [`IBuildingModel`](README.md#ibuildingmodel).`id` `BaseModel.id` | [src/models/base.ts:4](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/base.ts#L4) | -| `location` | `readonly` | `number` | - | [src/models/building.ts:26](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/building.ts#L26) | -| `name` | `readonly` | `string` | [`IBuildingModel`](README.md#ibuildingmodel).`name` `BaseModel.name` | [src/models/base.ts:6](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/base.ts#L6) | +| Property | Modifier | Type | Inherited from | Defined in | +| -------------------------------- | ---------- | ---------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| `data` | `readonly` | [`ZoneSettings`](README.md#zonesettings) | - | [src/models/building.ts:24](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/building.ts#L24) | +| `id` | `readonly` | `number` | [`IBuildingModel`](README.md#ibuildingmodel).[`id`](README.md#id-11) `BaseModel.id` | [src/models/base.ts:4](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/base.ts#L4) | +| `location` | `readonly` | `number` | - | [src/models/building.ts:26](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/building.ts#L26) | +| `name` | `readonly` | `string` | [`IBuildingModel`](README.md#ibuildingmodel).[`name`](README.md#name-10) `BaseModel.name` | [src/models/base.ts:6](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/base.ts#L6) | #### Accessors @@ -449,17 +451,15 @@ static sync(areas: AreaDataAny[]): void get areaIds(): number[] ``` +Defined in: [src/models/building.ts:39](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/building.ts#L39) + ###### Returns `number`[] ###### Implementation of -[`IBuildingModel`](README.md#ibuildingmodel).`areaIds` - -###### Defined in - -[src/models/building.ts:39](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/building.ts#L39) +[`IBuildingModel`](README.md#ibuildingmodel).[`areaIds`](README.md#areaids-4) ##### areas @@ -469,17 +469,15 @@ get areaIds(): number[] get areas(): IAreaModel[] ``` +Defined in: [src/models/building.ts:43](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/building.ts#L43) + ###### Returns [`IAreaModel`](README.md#iareamodel)[] ###### Implementation of -[`IBuildingModel`](README.md#ibuildingmodel).`areas` - -###### Defined in - -[src/models/building.ts:43](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/building.ts#L43) +[`IBuildingModel`](README.md#ibuildingmodel).[`areas`](README.md#areas-4) ##### deviceIds @@ -489,17 +487,15 @@ get areas(): IAreaModel[] get deviceIds(): number[] ``` +Defined in: [src/models/building.ts:47](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/building.ts#L47) + ###### Returns `number`[] ###### Implementation of -[`IBuildingModel`](README.md#ibuildingmodel).`deviceIds` - -###### Defined in - -[src/models/building.ts:47](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/building.ts#L47) +[`IBuildingModel`](README.md#ibuildingmodel).[`deviceIds`](README.md#deviceids-7) ##### devices @@ -509,17 +505,15 @@ get deviceIds(): number[] get devices(): IDeviceModelAny[] ``` +Defined in: [src/models/building.ts:51](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/building.ts#L51) + ###### Returns [`IDeviceModelAny`](README.md#idevicemodelany)[] ###### Implementation of -[`IBuildingModel`](README.md#ibuildingmodel).`devices` - -###### Defined in - -[src/models/building.ts:51](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/building.ts#L51) +[`IBuildingModel`](README.md#ibuildingmodel).[`devices`](README.md#devices-7) ##### floorIds @@ -529,17 +523,15 @@ get devices(): IDeviceModelAny[] get floorIds(): number[] ``` +Defined in: [src/models/building.ts:55](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/building.ts#L55) + ###### Returns `number`[] ###### Implementation of -[`IBuildingModel`](README.md#ibuildingmodel).`floorIds` - -###### Defined in - -[src/models/building.ts:55](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/building.ts#L55) +[`IBuildingModel`](README.md#ibuildingmodel).[`floorIds`](README.md#floorids-3) ##### floors @@ -549,17 +541,15 @@ get floorIds(): number[] get floors(): IFloorModel[] ``` +Defined in: [src/models/building.ts:59](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/building.ts#L59) + ###### Returns [`IFloorModel`](README.md#ifloormodel)[] ###### Implementation of -[`IBuildingModel`](README.md#ibuildingmodel).`floors` - -###### Defined in - -[src/models/building.ts:59](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/building.ts#L59) +[`IBuildingModel`](README.md#ibuildingmodel).[`floors`](README.md#floors-3) #### Methods @@ -569,20 +559,20 @@ get floors(): IFloorModel[] static getAll(): IBuildingModel[] ``` +Defined in: [src/models/building.ts:63](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/building.ts#L63) + ###### Returns [`IBuildingModel`](README.md#ibuildingmodel)[] -###### Defined in - -[src/models/building.ts:63](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/building.ts#L63) - ##### getById() ```ts static getById(id: number): undefined | IBuildingModel ``` +Defined in: [src/models/building.ts:67](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/building.ts#L67) + ###### Parameters | Parameter | Type | @@ -593,16 +583,14 @@ static getById(id: number): undefined | IBuildingModel `undefined` \| [`IBuildingModel`](README.md#ibuildingmodel) -###### Defined in - -[src/models/building.ts:67](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/building.ts#L67) - ##### getByName() ```ts static getByName(name: string): undefined | IBuildingModel ``` +Defined in: [src/models/building.ts:71](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/building.ts#L71) + ###### Parameters | Parameter | Type | @@ -613,10 +601,6 @@ static getByName(name: string): undefined | IBuildingModel `undefined` \| [`IBuildingModel`](README.md#ibuildingmodel) -###### Defined in - -[src/models/building.ts:71](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/building.ts#L71) - ##### setModels() ```ts @@ -627,6 +611,8 @@ static setModels(__namedParameters: { }): void ``` +Defined in: [src/models/building.ts:75](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/building.ts#L75) + ###### Parameters | Parameter | Type | @@ -640,16 +626,14 @@ static setModels(__namedParameters: { `void` -###### Defined in - -[src/models/building.ts:75](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/building.ts#L75) - ##### sync() ```ts static sync(buildings: BuildingData[]): void ``` +Defined in: [src/models/building.ts:89](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/building.ts#L89) + ###### Parameters | Parameter | Type | @@ -660,14 +644,12 @@ static sync(buildings: BuildingData[]): void `void` -###### Defined in - -[src/models/building.ts:89](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/building.ts#L89) - --- ### DeviceModel\ +Defined in: [src/models/device.ts:20](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L20) + #### Extends - `BaseModel` @@ -690,6 +672,8 @@ static sync(buildings: BuildingData[]): void protected new DeviceModel(__namedParameters: ListDevice): DeviceModel ``` +Defined in: [src/models/device.ts:42](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L42) + ###### Parameters | Parameter | Type | @@ -702,22 +686,20 @@ protected new DeviceModel(__namedParameters: ListDevice): DeviceModel ###### Overrides -`BaseModel.constructor` - -###### Defined in - -[src/models/device.ts:42](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L42) +```ts +BaseModel.constructor +``` #### Properties -| Property | Modifier | Type | Default value | Inherited from | Defined in | -| ------------ | ---------- | ------------------ | ------------- | ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `areaId` | `readonly` | `null` \| `number` | `null` | - | [src/models/device.ts:32](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L32) | -| `buildingId` | `readonly` | `number` | `undefined` | - | [src/models/device.ts:34](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L34) | -| `floorId` | `readonly` | `null` \| `number` | `null` | - | [src/models/device.ts:36](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L36) | -| `id` | `readonly` | `number` | `undefined` | [`IDeviceModel`](README.md#idevicemodelt).`id` `BaseModel.id` | [src/models/base.ts:4](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/base.ts#L4) | -| `name` | `readonly` | `string` | `undefined` | [`IDeviceModel`](README.md#idevicemodelt).`name` `BaseModel.name` | [src/models/base.ts:6](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/base.ts#L6) | -| `type` | `readonly` | `T` | `undefined` | - | [src/models/device.ts:38](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L38) | +| Property | Modifier | Type | Default value | Inherited from | Defined in | +| -------------------------------------- | ---------- | ------------------ | ------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `areaId` | `readonly` | `null` \| `number` | `null` | - | [src/models/device.ts:32](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L32) | +| `buildingId` | `readonly` | `number` | `undefined` | - | [src/models/device.ts:34](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L34) | +| `floorId` | `readonly` | `null` \| `number` | `null` | - | [src/models/device.ts:36](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L36) | +| `id` | `readonly` | `number` | `undefined` | [`IDeviceModel`](README.md#idevicemodelt).[`id`](README.md#id-13) `BaseModel.id` | [src/models/base.ts:4](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/base.ts#L4) | +| `name` | `readonly` | `string` | `undefined` | [`IDeviceModel`](README.md#idevicemodelt).[`name`](README.md#name-12) `BaseModel.name` | [src/models/base.ts:6](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/base.ts#L6) | +| `type` | `readonly` | `T` | `undefined` | - | [src/models/device.ts:38](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L38) | #### Accessors @@ -729,17 +711,15 @@ protected new DeviceModel(__namedParameters: ListDevice): DeviceModel get area(): undefined | null | IAreaModel ``` +Defined in: [src/models/device.ts:60](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L60) + ###### Returns `undefined` \| `null` \| [`IAreaModel`](README.md#iareamodel) ###### Implementation of -[`IDeviceModel`](README.md#idevicemodelt).`area` - -###### Defined in - -[src/models/device.ts:60](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L60) +[`IDeviceModel`](README.md#idevicemodelt).[`area`](README.md#area-1) ##### building @@ -749,17 +729,15 @@ get area(): undefined | null | IAreaModel get building(): undefined | BuildingModel ``` +Defined in: [src/models/device.ts:66](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L66) + ###### Returns `undefined` \| [`BuildingModel`](README.md#buildingmodel) ###### Implementation of -[`IDeviceModel`](README.md#idevicemodelt).`building` - -###### Defined in - -[src/models/device.ts:66](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L66) +[`IDeviceModel`](README.md#idevicemodelt).[`building`](README.md#building-5) ##### data @@ -769,17 +747,15 @@ get building(): undefined | BuildingModel get data(): ListDeviceData ``` +Defined in: [src/models/device.ts:70](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L70) + ###### Returns [`ListDeviceData`](README.md#listdevicedatat)\<`T`\> ###### Implementation of -[`IDeviceModel`](README.md#idevicemodelt).`data` - -###### Defined in - -[src/models/device.ts:70](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L70) +[`IDeviceModel`](README.md#idevicemodelt).[`data`](README.md#data-6) ##### floor @@ -789,17 +765,15 @@ get data(): ListDeviceData get floor(): undefined | null | IFloorModel ``` +Defined in: [src/models/device.ts:74](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L74) + ###### Returns `undefined` \| `null` \| [`IFloorModel`](README.md#ifloormodel) ###### Implementation of -[`IDeviceModel`](README.md#idevicemodelt).`floor` - -###### Defined in - -[src/models/device.ts:74](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L74) +[`IDeviceModel`](README.md#idevicemodelt).[`floor`](README.md#floor-3) #### Methods @@ -809,6 +783,8 @@ get floor(): undefined | null | IFloorModel update(data: Partial>): void ``` +Defined in: [src/models/device.ts:135](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L135) + ###### Parameters | Parameter | Type | @@ -821,11 +797,7 @@ update(data: Partial>): void ###### Implementation of -[`IDeviceModel`](README.md#idevicemodelt).`update` - -###### Defined in - -[src/models/device.ts:135](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L135) +[`IDeviceModel`](README.md#idevicemodelt).[`update`](README.md#update-1) ##### getAll() @@ -833,20 +805,20 @@ update(data: Partial>): void static getAll(): IDeviceModelAny[] ``` +Defined in: [src/models/device.ts:80](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L80) + ###### Returns [`IDeviceModelAny`](README.md#idevicemodelany)[] -###### Defined in - -[src/models/device.ts:80](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L80) - ##### getByAreaId() ```ts static getByAreaId(id: number): IDeviceModelAny[] ``` +Defined in: [src/models/device.ts:84](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L84) + ###### Parameters | Parameter | Type | @@ -857,16 +829,14 @@ static getByAreaId(id: number): IDeviceModelAny[] [`IDeviceModelAny`](README.md#idevicemodelany)[] -###### Defined in - -[src/models/device.ts:84](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L84) - ##### getByBuildingId() ```ts static getByBuildingId(id: number): IDeviceModelAny[] ``` +Defined in: [src/models/device.ts:88](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L88) + ###### Parameters | Parameter | Type | @@ -877,16 +847,14 @@ static getByBuildingId(id: number): IDeviceModelAny[] [`IDeviceModelAny`](README.md#idevicemodelany)[] -###### Defined in - -[src/models/device.ts:88](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L88) - ##### getByFloorId() ```ts static getByFloorId(id: number): IDeviceModelAny[] ``` +Defined in: [src/models/device.ts:92](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L92) + ###### Parameters | Parameter | Type | @@ -897,16 +865,14 @@ static getByFloorId(id: number): IDeviceModelAny[] [`IDeviceModelAny`](README.md#idevicemodelany)[] -###### Defined in - -[src/models/device.ts:92](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L92) - ##### getById() ```ts static getById(id: number): undefined | IDeviceModelAny ``` +Defined in: [src/models/device.ts:96](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L96) + ###### Parameters | Parameter | Type | @@ -917,16 +883,14 @@ static getById(id: number): undefined | IDeviceModelAny `undefined` \| [`IDeviceModelAny`](README.md#idevicemodelany) -###### Defined in - -[src/models/device.ts:96](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L96) - ##### getByName() ```ts static getByName(name: string): undefined | IDeviceModelAny ``` +Defined in: [src/models/device.ts:100](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L100) + ###### Parameters | Parameter | Type | @@ -937,16 +901,14 @@ static getByName(name: string): undefined | IDeviceModelAny `undefined` \| [`IDeviceModelAny`](README.md#idevicemodelany) -###### Defined in - -[src/models/device.ts:100](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L100) - ##### getByType() ```ts static getByType(type: U): IDeviceModel[] ``` +Defined in: [src/models/device.ts:104](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L104) + ###### Type Parameters | Type Parameter | @@ -963,10 +925,6 @@ static getByType(type: U): IDeviceModel[] [`IDeviceModel`](README.md#idevicemodelt)\<`U`\>[] -###### Defined in - -[src/models/device.ts:104](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L104) - ##### setModels() ```ts @@ -977,6 +935,8 @@ static setModels(__namedParameters: { }): void ``` +Defined in: [src/models/device.ts:111](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L111) + ###### Parameters | Parameter | Type | @@ -990,16 +950,14 @@ static setModels(__namedParameters: { `void` -###### Defined in - -[src/models/device.ts:111](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L111) - ##### sync() ```ts static sync(devices: readonly ListDeviceAny[]): void ``` +Defined in: [src/models/device.ts:125](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/device.ts#L125) + ###### Parameters | Parameter | Type | @@ -1010,14 +968,12 @@ static sync(devices: readonly ListDeviceAny[]): void `void` -###### Defined in - -[src/models/device.ts:125](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/device.ts#L125) - --- ### FacadeManager +Defined in: [src/facades/manager.ts:23](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/manager.ts#L23) + #### Implements - [`IFacadeManager`](README.md#ifacademanager) @@ -1030,6 +986,8 @@ static sync(devices: readonly ListDeviceAny[]): void new FacadeManager(api: IAPI): FacadeManager ``` +Defined in: [src/facades/manager.ts:28](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/manager.ts#L28) + ###### Parameters | Parameter | Type | @@ -1040,10 +998,6 @@ new FacadeManager(api: IAPI): FacadeManager [`FacadeManager`](README.md#facademanager) -###### Defined in - -[src/facades/manager.ts:28](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/manager.ts#L28) - #### Methods ##### get() @@ -1054,6 +1008,8 @@ new FacadeManager(api: IAPI): FacadeManager get(instance: IDeviceModel): IDeviceFacade ``` +Defined in: [src/facades/manager.ts:32](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/manager.ts#L32) + ###### Type Parameters | Type Parameter | @@ -1072,11 +1028,7 @@ get(instance: IDeviceModel): IDeviceFacade ###### Implementation of -[`IFacadeManager`](README.md#ifacademanager).`get` - -###### Defined in - -[src/facades/manager.ts:32](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/manager.ts#L32) +[`IFacadeManager`](README.md#ifacademanager).[`get`](README.md#get-1) ###### Call Signature @@ -1086,6 +1038,8 @@ get(instance: | IAreaModel): ISuperDeviceFacade ``` +Defined in: [src/facades/manager.ts:33](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/manager.ts#L33) + ###### Parameters | Parameter | Type | @@ -1098,11 +1052,9 @@ get(instance: ###### Implementation of -`IFacadeManager.get` - -###### Defined in - -[src/facades/manager.ts:33](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/manager.ts#L33) +```ts +IFacadeManager.get +``` ###### Call Signature @@ -1110,6 +1062,8 @@ get(instance: get(instance: IBuildingModel): IBuildingFacade ``` +Defined in: [src/facades/manager.ts:34](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/manager.ts#L34) + ###### Parameters | Parameter | Type | @@ -1122,11 +1076,9 @@ get(instance: IBuildingModel): IBuildingFacade ###### Implementation of -`IFacadeManager.get` - -###### Defined in - -[src/facades/manager.ts:34](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/manager.ts#L34) +```ts +IFacadeManager.get +``` ###### Call Signature @@ -1134,6 +1086,8 @@ get(instance: IBuildingModel): IBuildingFacade get(instance: IDeviceModelAny): IDeviceFacadeAny ``` +Defined in: [src/facades/manager.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/manager.ts#L35) + ###### Parameters | Parameter | Type | @@ -1146,11 +1100,9 @@ get(instance: IDeviceModelAny): IDeviceFacadeAny ###### Implementation of -`IFacadeManager.get` - -###### Defined in - -[src/facades/manager.ts:35](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/manager.ts#L35) +```ts +IFacadeManager.get +``` ###### Call Signature @@ -1158,6 +1110,8 @@ get(instance: IDeviceModelAny): IDeviceFacadeAny get(instance: IModel): IFacade ``` +Defined in: [src/facades/manager.ts:36](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/manager.ts#L36) + ###### Parameters | Parameter | Type | @@ -1170,11 +1124,9 @@ get(instance: IModel): IFacade ###### Implementation of -`IFacadeManager.get` - -###### Defined in - -[src/facades/manager.ts:36](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/manager.ts#L36) +```ts +IFacadeManager.get +``` ###### Call Signature @@ -1182,17 +1134,17 @@ get(instance: IModel): IFacade get(): null ``` +Defined in: [src/facades/manager.ts:37](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/manager.ts#L37) + ###### Returns `null` ###### Implementation of -`IFacadeManager.get` - -###### Defined in - -[src/facades/manager.ts:37](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/manager.ts#L37) +```ts +IFacadeManager.get +``` ###### Call Signature @@ -1200,6 +1152,8 @@ get(): null get(instance?: IDeviceModel): null | IDeviceFacade ``` +Defined in: [src/facades/manager.ts:38](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/manager.ts#L38) + ###### Type Parameters | Type Parameter | @@ -1218,11 +1172,9 @@ get(instance?: IDeviceModel): null | IDeviceFacade ###### Implementation of -`IFacadeManager.get` - -###### Defined in - -[src/facades/manager.ts:38](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/manager.ts#L38) +```ts +IFacadeManager.get +``` ###### Call Signature @@ -1232,6 +1184,8 @@ get(instance?: | IAreaModel): null | ISuperDeviceFacade ``` +Defined in: [src/facades/manager.ts:41](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/manager.ts#L41) + ###### Parameters | Parameter | Type | @@ -1244,11 +1198,9 @@ get(instance?: ###### Implementation of -`IFacadeManager.get` - -###### Defined in - -[src/facades/manager.ts:41](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/manager.ts#L41) +```ts +IFacadeManager.get +``` ###### Call Signature @@ -1256,6 +1208,8 @@ get(instance?: get(instance?: IBuildingModel): null | IBuildingFacade ``` +Defined in: [src/facades/manager.ts:42](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/manager.ts#L42) + ###### Parameters | Parameter | Type | @@ -1268,11 +1222,9 @@ get(instance?: IBuildingModel): null | IBuildingFacade ###### Implementation of -`IFacadeManager.get` - -###### Defined in - -[src/facades/manager.ts:42](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/manager.ts#L42) +```ts +IFacadeManager.get +``` ###### Call Signature @@ -1280,6 +1232,8 @@ get(instance?: IBuildingModel): null | IBuildingFacade get(instance?: IDeviceModelAny): null | IDeviceFacadeAny ``` +Defined in: [src/facades/manager.ts:43](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/manager.ts#L43) + ###### Parameters | Parameter | Type | @@ -1292,16 +1246,16 @@ get(instance?: IDeviceModelAny): null | IDeviceFacadeAny ###### Implementation of -`IFacadeManager.get` - -###### Defined in - -[src/facades/manager.ts:43](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/manager.ts#L43) +```ts +IFacadeManager.get +``` --- ### FloorModel +Defined in: [src/models/floor.ts:15](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/floor.ts#L15) + #### Extends - `BaseModel` @@ -1312,11 +1266,11 @@ get(instance?: IDeviceModelAny): null | IDeviceFacadeAny #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ------------ | ---------- | -------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `buildingId` | `readonly` | `number` | - | [src/models/floor.ts:24](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/floor.ts#L24) | -| `id` | `readonly` | `number` | [`IFloorModel`](README.md#ifloormodel).`id` `BaseModel.id` | [src/models/base.ts:4](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/base.ts#L4) | -| `name` | `readonly` | `string` | [`IFloorModel`](README.md#ifloormodel).`name` `BaseModel.name` | [src/models/base.ts:6](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/base.ts#L6) | +| Property | Modifier | Type | Inherited from | Defined in | +| -------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `buildingId` | `readonly` | `number` | - | [src/models/floor.ts:24](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/floor.ts#L24) | +| `id` | `readonly` | `number` | [`IFloorModel`](README.md#ifloormodel).[`id`](README.md#id-15) `BaseModel.id` | [src/models/base.ts:4](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/base.ts#L4) | +| `name` | `readonly` | `string` | [`IFloorModel`](README.md#ifloormodel).[`name`](README.md#name-14) `BaseModel.name` | [src/models/base.ts:6](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/base.ts#L6) | #### Accessors @@ -1328,17 +1282,15 @@ get(instance?: IDeviceModelAny): null | IDeviceFacadeAny get areaIds(): number[] ``` +Defined in: [src/models/floor.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/floor.ts#L35) + ###### Returns `number`[] ###### Implementation of -[`IFloorModel`](README.md#ifloormodel).`areaIds` - -###### Defined in - -[src/models/floor.ts:35](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/floor.ts#L35) +[`IFloorModel`](README.md#ifloormodel).[`areaIds`](README.md#areaids-5) ##### areas @@ -1348,17 +1300,15 @@ get areaIds(): number[] get areas(): IAreaModel[] ``` +Defined in: [src/models/floor.ts:39](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/floor.ts#L39) + ###### Returns [`IAreaModel`](README.md#iareamodel)[] ###### Implementation of -[`IFloorModel`](README.md#ifloormodel).`areas` - -###### Defined in - -[src/models/floor.ts:39](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/floor.ts#L39) +[`IFloorModel`](README.md#ifloormodel).[`areas`](README.md#areas-5) ##### building @@ -1368,17 +1318,15 @@ get areas(): IAreaModel[] get building(): undefined | IBuildingModel ``` +Defined in: [src/models/floor.ts:43](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/floor.ts#L43) + ###### Returns `undefined` \| [`IBuildingModel`](README.md#ibuildingmodel) ###### Implementation of -[`IFloorModel`](README.md#ifloormodel).`building` - -###### Defined in - -[src/models/floor.ts:43](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/floor.ts#L43) +[`IFloorModel`](README.md#ifloormodel).[`building`](README.md#building-6) ##### deviceIds @@ -1388,17 +1336,15 @@ get building(): undefined | IBuildingModel get deviceIds(): number[] ``` +Defined in: [src/models/floor.ts:47](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/floor.ts#L47) + ###### Returns `number`[] ###### Implementation of -[`IFloorModel`](README.md#ifloormodel).`deviceIds` - -###### Defined in - -[src/models/floor.ts:47](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/floor.ts#L47) +[`IFloorModel`](README.md#ifloormodel).[`deviceIds`](README.md#deviceids-8) ##### devices @@ -1408,17 +1354,15 @@ get deviceIds(): number[] get devices(): IDeviceModelAny[] ``` +Defined in: [src/models/floor.ts:51](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/floor.ts#L51) + ###### Returns [`IDeviceModelAny`](README.md#idevicemodelany)[] ###### Implementation of -[`IFloorModel`](README.md#ifloormodel).`devices` - -###### Defined in - -[src/models/floor.ts:51](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/floor.ts#L51) +[`IFloorModel`](README.md#ifloormodel).[`devices`](README.md#devices-10) #### Methods @@ -1428,20 +1372,20 @@ get devices(): IDeviceModelAny[] static getAll(): IFloorModel[] ``` +Defined in: [src/models/floor.ts:55](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/floor.ts#L55) + ###### Returns [`IFloorModel`](README.md#ifloormodel)[] -###### Defined in - -[src/models/floor.ts:55](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/floor.ts#L55) - ##### getByBuildingId() ```ts static getByBuildingId(id: number): IFloorModel[] ``` +Defined in: [src/models/floor.ts:59](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/floor.ts#L59) + ###### Parameters | Parameter | Type | @@ -1452,16 +1396,14 @@ static getByBuildingId(id: number): IFloorModel[] [`IFloorModel`](README.md#ifloormodel)[] -###### Defined in - -[src/models/floor.ts:59](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/floor.ts#L59) - ##### getById() ```ts static getById(id: number): undefined | IFloorModel ``` +Defined in: [src/models/floor.ts:63](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/floor.ts#L63) + ###### Parameters | Parameter | Type | @@ -1472,16 +1414,14 @@ static getById(id: number): undefined | IFloorModel `undefined` \| [`IFloorModel`](README.md#ifloormodel) -###### Defined in - -[src/models/floor.ts:63](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/floor.ts#L63) - ##### getByName() ```ts static getByName(name: string): undefined | IFloorModel ``` +Defined in: [src/models/floor.ts:67](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/floor.ts#L67) + ###### Parameters | Parameter | Type | @@ -1492,10 +1432,6 @@ static getByName(name: string): undefined | IFloorModel `undefined` \| [`IFloorModel`](README.md#ifloormodel) -###### Defined in - -[src/models/floor.ts:67](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/floor.ts#L67) - ##### setModels() ```ts @@ -1506,6 +1442,8 @@ static setModels(__namedParameters: { }): void ``` +Defined in: [src/models/floor.ts:71](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/floor.ts#L71) + ###### Parameters | Parameter | Type | @@ -1519,16 +1457,14 @@ static setModels(__namedParameters: { `void` -###### Defined in - -[src/models/floor.ts:71](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/floor.ts#L71) - ##### sync() ```ts static sync(floors: FloorData[]): void ``` +Defined in: [src/models/floor.ts:85](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/floor.ts#L85) + ###### Parameters | Parameter | Type | @@ -1539,24 +1475,22 @@ static sync(floors: FloorData[]): void `void` -###### Defined in - -[src/models/floor.ts:85](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/floor.ts#L85) - --- ### MELCloudAPI +Defined in: [src/services/api.ts:147](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L147) + #### Implements - [`IAPI`](README.md#iapi) #### Properties -| Property | Modifier | Type | Defined in | -| ----------------- | ---------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `onSync?` | `readonly` | [`OnSyncFunction`](README.md#onsyncfunction) | [src/services/api.ts:148](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L148) | -| `settingManager?` | `readonly` | [`SettingManager`](README.md#settingmanager) | [src/services/api.ts:150](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L150) | +| Property | Modifier | Type | Defined in | +| --------------------------------------------- | ---------- | ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `onSync?` | `readonly` | [`OnSyncFunction`](README.md#onsyncfunction) | [src/services/api.ts:148](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L148) | +| `settingManager?` | `readonly` | [`SettingManager`](README.md#settingmanager-2) | [src/services/api.ts:150](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L150) | #### Methods @@ -1566,6 +1500,8 @@ static sync(floors: FloorData[]): void authenticate(data?: LoginCredentials): Promise ``` +Defined in: [src/services/api.ts:232](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L232) + ###### Parameters | Parameter | Type | @@ -1578,11 +1514,7 @@ authenticate(data?: LoginCredentials): Promise ###### Implementation of -[`IAPI`](README.md#iapi).`authenticate` - -###### Defined in - -[src/services/api.ts:232](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L232) +[`IAPI`](README.md#iapi).[`authenticate`](README.md#authenticate-1) ##### clearSync() @@ -1590,17 +1522,15 @@ authenticate(data?: LoginCredentials): Promise clearSync(): void ``` +Defined in: [src/services/api.ts:246](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L246) + ###### Returns `void` ###### Implementation of -[`IAPI`](README.md#iapi).`clearSync` - -###### Defined in - -[src/services/api.ts:246](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L246) +[`IAPI`](README.md#iapi).[`clearSync`](README.md#clearsync-1) ##### energy() @@ -1612,6 +1542,8 @@ energy(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:253](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L253) + ###### Parameters | Parameter | Type | @@ -1627,11 +1559,7 @@ energy(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`energy` - -###### Defined in - -[src/services/api.ts:253](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L253) +[`IAPI`](README.md#iapi).[`energy`](README.md#energy-1) ##### errorLog() @@ -1639,6 +1567,8 @@ energy(__namedParameters: { errorLog(query: ErrorLogQuery, deviceIds: number[]): Promise ``` +Defined in: [src/services/api.ts:261](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L261) + ###### Parameters | Parameter | Type | @@ -1652,11 +1582,7 @@ errorLog(query: ErrorLogQuery, deviceIds: number[]): Promise ###### Implementation of -[`IAPI`](README.md#iapi).`errorLog` - -###### Defined in - -[src/services/api.ts:261](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L261) +[`IAPI`](README.md#iapi).[`errorLog`](README.md#errorlog-2) ##### errors() @@ -1669,6 +1595,8 @@ errors(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:293](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L293) + ###### Parameters | Parameter | Type | @@ -1685,11 +1613,7 @@ errors(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`errors` - -###### Defined in - -[src/services/api.ts:293](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L293) +[`IAPI`](README.md#iapi).[`errors`](README.md#errors-2) ##### fetch() @@ -1697,17 +1621,15 @@ errors(__namedParameters: { fetch(): Promise ``` +Defined in: [src/services/api.ts:221](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L221) + ###### Returns `Promise`\<[`Building`](README.md#building-3)[]\> ###### Implementation of -[`IAPI`](README.md#iapi).`fetch` - -###### Defined in - -[src/services/api.ts:221](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L221) +[`IAPI`](README.md#iapi).[`fetch`](README.md#fetch-1) ##### frostProtection() @@ -1719,6 +1641,8 @@ frostProtection(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:301](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L301) + ###### Parameters | Parameter | Type | @@ -1734,11 +1658,7 @@ frostProtection(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`frostProtection` - -###### Defined in - -[src/services/api.ts:301](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L301) +[`IAPI`](README.md#iapi).[`frostProtection`](README.md#frostprotection-1) ##### group() @@ -1750,6 +1670,8 @@ group(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:311](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L311) + ###### Parameters | Parameter | Type | @@ -1765,11 +1687,7 @@ group(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`group` - -###### Defined in - -[src/services/api.ts:311](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L311) +[`IAPI`](README.md#iapi).[`group`](README.md#group-1) ##### holidayMode() @@ -1781,6 +1699,8 @@ holidayMode(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:319](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L319) + ###### Parameters | Parameter | Type | @@ -1796,11 +1716,7 @@ holidayMode(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`holidayMode` - -###### Defined in - -[src/services/api.ts:319](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L319) +[`IAPI`](README.md#iapi).[`holidayMode`](README.md#holidaymode-1) ##### hourlyTemperatures() @@ -1815,6 +1731,8 @@ hourlyTemperatures(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:329](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L329) + ###### Parameters | Parameter | Type | @@ -1832,11 +1750,7 @@ hourlyTemperatures(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`hourlyTemperatures` - -###### Defined in - -[src/services/api.ts:329](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L329) +[`IAPI`](README.md#iapi).[`hourlyTemperatures`](README.md#hourlytemperatures-1) ##### internalTemperatures() @@ -1848,6 +1762,8 @@ internalTemperatures(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:337](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L337) + ###### Parameters | Parameter | Type | @@ -1863,11 +1779,7 @@ internalTemperatures(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`internalTemperatures` - -###### Defined in - -[src/services/api.ts:337](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L337) +[`IAPI`](README.md#iapi).[`internalTemperatures`](README.md#internaltemperatures-1) ##### list() @@ -1877,6 +1789,8 @@ list(): Promise<{ }> ``` +Defined in: [src/services/api.ts:345](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L345) + ###### Returns `Promise`\<\{ @@ -1885,11 +1799,7 @@ list(): Promise<{ ###### Implementation of -[`IAPI`](README.md#iapi).`list` - -###### Defined in - -[src/services/api.ts:345](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L345) +[`IAPI`](README.md#iapi).[`list`](README.md#list-1) ##### login() @@ -1901,6 +1811,8 @@ login(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:349](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L349) + ###### Parameters | Parameter | Type | @@ -1916,11 +1828,7 @@ login(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`login` - -###### Defined in - -[src/services/api.ts:349](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L349) +[`IAPI`](README.md#iapi).[`login`](README.md#login-1) ##### operationModes() @@ -1932,6 +1840,8 @@ operationModes(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:357](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L357) + ###### Parameters | Parameter | Type | @@ -1947,11 +1857,7 @@ operationModes(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`operationModes` - -###### Defined in - -[src/services/api.ts:357](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L357) +[`IAPI`](README.md#iapi).[`operationModes`](README.md#operationmodes-1) ##### setFrostProtection() @@ -1964,6 +1870,8 @@ setFrostProtection(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:365](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L365) + ###### Parameters | Parameter | Type | @@ -1980,11 +1888,7 @@ setFrostProtection(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`setFrostProtection` - -###### Defined in - -[src/services/api.ts:365](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L365) +[`IAPI`](README.md#iapi).[`setFrostProtection`](README.md#setfrostprotection-1) ##### setGroup() @@ -1997,6 +1901,8 @@ setGroup(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:373](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L373) + ###### Parameters | Parameter | Type | @@ -2013,11 +1919,7 @@ setGroup(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`setGroup` - -###### Defined in - -[src/services/api.ts:373](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L373) +[`IAPI`](README.md#iapi).[`setGroup`](README.md#setgroup-1) ##### setHolidayMode() @@ -2030,6 +1932,8 @@ setHolidayMode(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:381](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L381) + ###### Parameters | Parameter | Type | @@ -2046,11 +1950,7 @@ setHolidayMode(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`setHolidayMode` - -###### Defined in - -[src/services/api.ts:381](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L381) +[`IAPI`](README.md#iapi).[`setHolidayMode`](README.md#setholidaymode-1) ##### setLanguage() @@ -2064,6 +1964,8 @@ setLanguage(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:389](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L389) + ###### Parameters | Parameter | Type | @@ -2080,11 +1982,7 @@ setLanguage(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`setLanguage` - -###### Defined in - -[src/services/api.ts:389](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L389) +[`IAPI`](README.md#iapi).[`setLanguage`](README.md#setlanguage-1) ##### setPower() @@ -2096,6 +1994,8 @@ setPower(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:397](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L397) + ###### Parameters | Parameter | Type | @@ -2111,11 +2011,7 @@ setPower(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`setPower` - -###### Defined in - -[src/services/api.ts:397](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L397) +[`IAPI`](README.md#iapi).[`setPower`](README.md#setpower-1) ##### setValues() @@ -2128,6 +2024,8 @@ setValues(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:405](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L405) + ###### Type Parameters | Type Parameter | @@ -2150,11 +2048,7 @@ setValues(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`setValues` - -###### Defined in - -[src/services/api.ts:405](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L405) +[`IAPI`](README.md#iapi).[`setValues`](README.md#setvalues-1) ##### signal() @@ -2169,6 +2063,8 @@ signal(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:415](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L415) + ###### Parameters | Parameter | Type | @@ -2186,11 +2082,7 @@ signal(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`signal` - -###### Defined in - -[src/services/api.ts:415](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L415) +[`IAPI`](README.md#iapi).[`signal`](README.md#signal-1) ##### temperatures() @@ -2202,6 +2094,8 @@ temperatures(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:423](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L423) + ###### Parameters | Parameter | Type | @@ -2217,11 +2111,7 @@ temperatures(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`temperatures` - -###### Defined in - -[src/services/api.ts:423](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L423) +[`IAPI`](README.md#iapi).[`temperatures`](README.md#temperatures-1) ##### tiles() @@ -2235,6 +2125,8 @@ tiles(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:431](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L431) + ###### Parameters | Parameter | Type | @@ -2250,11 +2142,9 @@ tiles(__namedParameters: { ###### Implementation of -`IAPI.tiles` - -###### Defined in - -[src/services/api.ts:431](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L431) +```ts +IAPI.tiles +``` ###### Call Signature @@ -2266,6 +2156,8 @@ tiles(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:437](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L437) + ###### Type Parameters | Type Parameter | @@ -2287,11 +2179,9 @@ tiles(__namedParameters: { ###### Implementation of -`IAPI.tiles` - -###### Defined in - -[src/services/api.ts:437](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L437) +```ts +IAPI.tiles +``` ##### updateLanguage() @@ -2299,6 +2189,8 @@ tiles(__namedParameters: { updateLanguage(language: string): Promise ``` +Defined in: [src/services/api.ts:451](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L451) + ###### Parameters | Parameter | Type | @@ -2311,11 +2203,7 @@ updateLanguage(language: string): Promise ###### Implementation of -[`IAPI`](README.md#iapi).`updateLanguage` - -###### Defined in - -[src/services/api.ts:451](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L451) +[`IAPI`](README.md#iapi).[`updateLanguage`](README.md#updatelanguage-1) ##### values() @@ -2327,6 +2215,8 @@ values(__namedParameters: { }> ``` +Defined in: [src/services/api.ts:462](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L462) + ###### Parameters | Parameter | Type | @@ -2342,11 +2232,7 @@ values(__namedParameters: { ###### Implementation of -[`IAPI`](README.md#iapi).`values` - -###### Defined in - -[src/services/api.ts:462](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L462) +[`IAPI`](README.md#iapi).[`values`](README.md#values-1) ##### create() @@ -2354,6 +2240,8 @@ values(__namedParameters: { static create(config?: APIConfig): Promise ``` +Defined in: [src/services/api.ts:214](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/api.ts#L214) + ###### Parameters | Parameter | Type | @@ -2364,49 +2252,51 @@ static create(config?: APIConfig): Promise `Promise`\<[`MELCloudAPI`](README.md#melcloudapi)\> -###### Defined in - -[src/services/api.ts:214](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/api.ts#L214) - ## Interfaces ### APIConfig +Defined in: [src/services/interfaces.ts:55](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L55) + #### Extends - `Partial`\<[`LoginCredentials`](README.md#logincredentials)\> #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ------------------- | ---------- | -------------------------------------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `autoSyncInterval?` | `public` | `null` \| `number` | - | [src/services/interfaces.ts:56](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L56) | -| `language?` | `public` | `string` | - | [src/services/interfaces.ts:57](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L57) | -| `logger?` | `public` | [`Logger`](README.md#logger) | - | [src/services/interfaces.ts:58](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L58) | -| `onSync?` | `public` | [`OnSyncFunction`](README.md#onsyncfunction) | - | [src/services/interfaces.ts:59](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L59) | -| `password?` | `readonly` | `string` | `Partial.password` | [src/types/common.ts:162](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L162) | -| `settingManager?` | `public` | [`SettingManager`](README.md#settingmanager) | - | [src/services/interfaces.ts:60](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L60) | -| `shouldVerifySSL?` | `public` | `boolean` | - | [src/services/interfaces.ts:61](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L61) | -| `timezone?` | `public` | `string` | - | [src/services/interfaces.ts:62](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L62) | -| `username?` | `readonly` | `string` | `Partial.username` | [src/types/common.ts:163](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L163) | +| Property | Modifier | Type | Inherited from | Defined in | +| ------------------------------------------------- | ---------- | ---------------------------------------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `autoSyncInterval?` | `public` | `null` \| `number` | - | [src/services/interfaces.ts:56](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L56) | +| `language?` | `public` | `string` | - | [src/services/interfaces.ts:57](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L57) | +| `logger?` | `public` | [`Logger`](README.md#logger-1) | - | [src/services/interfaces.ts:58](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L58) | +| `onSync?` | `public` | [`OnSyncFunction`](README.md#onsyncfunction) | - | [src/services/interfaces.ts:59](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L59) | +| `password?` | `readonly` | `string` | `Partial.password` | [src/types/common.ts:162](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L162) | +| `settingManager?` | `public` | [`SettingManager`](README.md#settingmanager-2) | - | [src/services/interfaces.ts:60](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L60) | +| `shouldVerifySSL?` | `public` | `boolean` | - | [src/services/interfaces.ts:61](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L61) | +| `timezone?` | `public` | `string` | - | [src/services/interfaces.ts:62](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L62) | +| `username?` | `readonly` | `string` | `Partial.username` | [src/types/common.ts:163](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L163) | --- ### APISettings +Defined in: [src/services/interfaces.ts:38](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L38) + #### Properties -| Property | Type | Defined in | -| ------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contextKey?` | `null` \| `string` | [src/services/interfaces.ts:39](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L39) | -| `expiry?` | `null` \| `string` | [src/services/interfaces.ts:40](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L40) | -| `password?` | `null` \| `string` | [src/services/interfaces.ts:41](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L41) | -| `username?` | `null` \| `string` | [src/services/interfaces.ts:42](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L42) | +| Property | Type | Defined in | +| ------------------------------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `contextKey?` | `null` \| `string` | [src/services/interfaces.ts:39](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L39) | +| `expiry?` | `null` \| `string` | [src/services/interfaces.ts:40](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L40) | +| `password?` | `null` \| `string` | [src/services/interfaces.ts:41](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L41) | +| `username?` | `null` \| `string` | [src/services/interfaces.ts:42](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L42) | --- ### AreaData\ +Defined in: [src/types/common.ts:28](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L28) + #### Extends - [`FloorData`](README.md#floordata) @@ -2419,75 +2309,83 @@ static create(config?: APIConfig): Promise #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ------------ | ---------- | -------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `BuildingId` | `readonly` | `number` | [`FloorData`](README.md#floordata).`BuildingId` | [src/types/common.ts:80](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L80) | -| `FloorId` | `readonly` | `T` | - | [src/types/common.ts:29](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L29) | -| `ID` | `readonly` | `number` | [`FloorData`](README.md#floordata).`ID` | [src/types/common.ts:81](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L81) | -| `Name` | `readonly` | `string` | [`FloorData`](README.md#floordata).`Name` | [src/types/common.ts:82](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L82) | +| Property | Modifier | Type | Inherited from | Defined in | +| -------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `BuildingId` | `readonly` | `number` | [`FloorData`](README.md#floordata).[`BuildingId`](README.md#buildingid-4) | [src/types/common.ts:80](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L80) | +| `FloorId` | `readonly` | `T` | - | [src/types/common.ts:29](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L29) | +| `ID` | `readonly` | `number` | [`FloorData`](README.md#floordata).[`ID`](README.md#id-7) | [src/types/common.ts:81](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L81) | +| `Name` | `readonly` | `string` | [`FloorData`](README.md#floordata).[`Name`](README.md#name-7) | [src/types/common.ts:82](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L82) | --- ### BaseDevicePostData +Defined in: [src/types/bases.ts:4](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L4) + #### Properties -| Property | Modifier | Type | Defined in | -| ---------------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `DeviceID` | `readonly` | `number` | [src/types/bases.ts:5](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L5) | -| `EffectiveFlags` | `readonly` | `number` | [src/types/bases.ts:6](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L6) | +| Property | Modifier | Type | Defined in | +| -------------------------------------------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `DeviceID` | `readonly` | `number` | [src/types/bases.ts:5](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L5) | +| `EffectiveFlags` | `readonly` | `number` | [src/types/bases.ts:6](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L6) | --- ### BaseGetDeviceData +Defined in: [src/types/bases.ts:9](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L9) + #### Extends - `BaseSetDeviceData` #### Properties -| Property | Modifier | Type | Overrides | Inherited from | Defined in | -| ------------------- | ---------- | --------- | ---------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `EffectiveFlags` | `readonly` | `0` | `BaseSetDeviceData.EffectiveFlags` | - | [src/types/bases.ts:10](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L10) | -| `LastCommunication` | `readonly` | `string` | - | `BaseSetDeviceData.LastCommunication` | [src/types/bases.ts:39](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L39) | -| `NextCommunication` | `readonly` | `string` | - | `BaseSetDeviceData.NextCommunication` | [src/types/bases.ts:40](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L40) | -| `Offline` | `readonly` | `boolean` | - | `BaseSetDeviceData.Offline` | [src/types/bases.ts:31](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L31) | -| `Power` | `readonly` | `boolean` | - | `BaseSetDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L35) | +| Property | Modifier | Type | Overrides | Inherited from | Defined in | +| -------------------------------------------------- | ---------- | --------- | ---------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `EffectiveFlags` | `readonly` | `0` | `BaseSetDeviceData.EffectiveFlags` | - | [src/types/bases.ts:10](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L10) | +| `LastCommunication` | `readonly` | `string` | - | `BaseSetDeviceData.LastCommunication` | [src/types/bases.ts:39](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L39) | +| `NextCommunication` | `readonly` | `string` | - | `BaseSetDeviceData.NextCommunication` | [src/types/bases.ts:40](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L40) | +| `Offline` | `readonly` | `boolean` | - | `BaseSetDeviceData.Offline` | [src/types/bases.ts:31](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L31) | +| `Power` | `readonly` | `boolean` | - | `BaseSetDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L35) | --- ### Building +Defined in: [src/types/common.ts:32](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L32) + #### Extends - [`BuildingData`](README.md#buildingdata) #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `FPDefined` | `readonly` | `boolean` | [`BuildingData`](README.md#buildingdata).`FPDefined` | [src/types/common.ts:86](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L86) | -| `FPEnabled` | `readonly` | `boolean` | [`BuildingData`](README.md#buildingdata).`FPEnabled` | [src/types/common.ts:87](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L87) | -| `FPMaxTemperature` | `readonly` | `number` | [`BuildingData`](README.md#buildingdata).`FPMaxTemperature` | [src/types/common.ts:88](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L88) | -| `FPMinTemperature` | `readonly` | `number` | [`BuildingData`](README.md#buildingdata).`FPMinTemperature` | [src/types/common.ts:89](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L89) | -| `HMDefined` | `readonly` | `boolean` | [`BuildingData`](README.md#buildingdata).`HMDefined` | [src/types/common.ts:123](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L123) | -| `HMEnabled` | `readonly` | `boolean` | [`BuildingData`](README.md#buildingdata).`HMEnabled` | [src/types/common.ts:124](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L124) | -| `HMEndDate` | `readonly` | `null` \| `string` | [`BuildingData`](README.md#buildingdata).`HMEndDate` | [src/types/common.ts:125](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L125) | -| `HMStartDate` | `readonly` | `null` \| `string` | [`BuildingData`](README.md#buildingdata).`HMStartDate` | [src/types/common.ts:126](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L126) | -| `ID` | `readonly` | `number` | [`BuildingData`](README.md#buildingdata).`ID` | [src/types/common.ts:48](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L48) | -| `Location` | `readonly` | `number` | [`BuildingData`](README.md#buildingdata).`Location` | [src/types/common.ts:49](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L49) | -| `Name` | `readonly` | `string` | [`BuildingData`](README.md#buildingdata).`Name` | [src/types/common.ts:50](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L50) | -| `Structure` | `readonly` | \{ `Areas`: readonly [`AreaData`](README.md#areadatat)\<`null`\> & \{ `Devices`: readonly [`ListDeviceAny`](README.md#listdeviceany)[]; \}[]; `Devices`: readonly [`ListDeviceAny`](README.md#listdeviceany)[]; `Floors`: readonly [`FloorData`](README.md#floordata) & \{ `Areas`: readonly [`AreaData`](README.md#areadatat)\<`number`\> & \{ `Devices`: readonly [`ListDeviceAny`](README.md#listdeviceany)[]; \}[]; `Devices`: readonly [`ListDeviceAny`](README.md#listdeviceany)[]; \}[]; \} | - | [src/types/common.ts:33](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L33) | -| `Structure.Areas` | `readonly` | readonly [`AreaData`](README.md#areadatat)\<`null`\> & \{ `Devices`: readonly [`ListDeviceAny`](README.md#listdeviceany)[]; \}[] | - | [src/types/common.ts:34](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L34) | -| `Structure.Devices` | `readonly` | readonly [`ListDeviceAny`](README.md#listdeviceany)[] | - | [src/types/common.ts:37](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L37) | -| `Structure.Floors` | `readonly` | readonly [`FloorData`](README.md#floordata) & \{ `Areas`: readonly [`AreaData`](README.md#areadatat)\<`number`\> & \{ `Devices`: readonly [`ListDeviceAny`](README.md#listdeviceany)[]; \}[]; `Devices`: readonly [`ListDeviceAny`](README.md#listdeviceany)[]; \}[] | - | [src/types/common.ts:38](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L38) | -| `TimeZone` | `readonly` | `number` | [`BuildingData`](README.md#buildingdata).`TimeZone` | [src/types/common.ts:135](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L135) | +| Property | Modifier | Type | Inherited from | Defined in | +| ------------------------------------------------ | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `FPDefined` | `readonly` | `boolean` | [`BuildingData`](README.md#buildingdata).[`FPDefined`](README.md#fpdefined-1) | [src/types/common.ts:86](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L86) | +| `FPEnabled` | `readonly` | `boolean` | [`BuildingData`](README.md#buildingdata).[`FPEnabled`](README.md#fpenabled-1) | [src/types/common.ts:87](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L87) | +| `FPMaxTemperature` | `readonly` | `number` | [`BuildingData`](README.md#buildingdata).[`FPMaxTemperature`](README.md#fpmaxtemperature-1) | [src/types/common.ts:88](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L88) | +| `FPMinTemperature` | `readonly` | `number` | [`BuildingData`](README.md#buildingdata).[`FPMinTemperature`](README.md#fpmintemperature-1) | [src/types/common.ts:89](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L89) | +| `HMDefined` | `readonly` | `boolean` | [`BuildingData`](README.md#buildingdata).[`HMDefined`](README.md#hmdefined-1) | [src/types/common.ts:123](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L123) | +| `HMEnabled` | `readonly` | `boolean` | [`BuildingData`](README.md#buildingdata).[`HMEnabled`](README.md#hmenabled-1) | [src/types/common.ts:124](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L124) | +| `HMEndDate` | `readonly` | `null` \| `string` | [`BuildingData`](README.md#buildingdata).[`HMEndDate`](README.md#hmenddate-1) | [src/types/common.ts:125](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L125) | +| `HMStartDate` | `readonly` | `null` \| `string` | [`BuildingData`](README.md#buildingdata).[`HMStartDate`](README.md#hmstartdate-1) | [src/types/common.ts:126](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L126) | +| `ID` | `readonly` | `number` | [`BuildingData`](README.md#buildingdata).[`ID`](README.md#id-6) | [src/types/common.ts:48](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L48) | +| `Location` | `readonly` | `number` | [`BuildingData`](README.md#buildingdata).[`Location`](README.md#location-2) | [src/types/common.ts:49](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L49) | +| `Name` | `readonly` | `string` | [`BuildingData`](README.md#buildingdata).[`Name`](README.md#name-6) | [src/types/common.ts:50](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L50) | +| `Structure` | `readonly` | \{ `Areas`: readonly [`AreaData`](README.md#areadatat)\<`null`\> & \{ `Devices`: readonly [`ListDeviceAny`](README.md#listdeviceany)[]; \}[]; `Devices`: readonly [`ListDeviceAny`](README.md#listdeviceany)[]; `Floors`: readonly [`FloorData`](README.md#floordata) & \{ `Areas`: readonly [`AreaData`](README.md#areadatat)\<`number`\> & \{ `Devices`: readonly [`ListDeviceAny`](README.md#listdeviceany)[]; \}[]; `Devices`: readonly [`ListDeviceAny`](README.md#listdeviceany)[]; \}[]; \} | - | [src/types/common.ts:33](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L33) | +| `Structure.Areas` | `readonly` | readonly [`AreaData`](README.md#areadatat)\<`null`\> & \{ `Devices`: readonly [`ListDeviceAny`](README.md#listdeviceany)[]; \}[] | - | [src/types/common.ts:34](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L34) | +| `Structure.Devices` | `readonly` | readonly [`ListDeviceAny`](README.md#listdeviceany)[] | - | [src/types/common.ts:37](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L37) | +| `Structure.Floors` | `readonly` | readonly [`FloorData`](README.md#floordata) & \{ `Areas`: readonly [`AreaData`](README.md#areadatat)\<`number`\> & \{ `Devices`: readonly [`ListDeviceAny`](README.md#listdeviceany)[]; \}[]; `Devices`: readonly [`ListDeviceAny`](README.md#listdeviceany)[]; \}[] | - | [src/types/common.ts:38](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L38) | +| `TimeZone` | `readonly` | `number` | [`BuildingData`](README.md#buildingdata).[`TimeZone`](README.md#timezone-2) | [src/types/common.ts:135](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L135) | --- ### BuildingData +Defined in: [src/types/common.ts:47](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L47) + #### Extends - [`ZoneSettings`](README.md#zonesettings) @@ -2498,480 +2396,536 @@ static create(config?: APIConfig): Promise #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ------------------ | ---------- | ------------------ | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `FPDefined` | `readonly` | `boolean` | [`ZoneSettings`](README.md#zonesettings).`FPDefined` | [src/types/common.ts:86](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L86) | -| `FPEnabled` | `readonly` | `boolean` | [`ZoneSettings`](README.md#zonesettings).`FPEnabled` | [src/types/common.ts:87](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L87) | -| `FPMaxTemperature` | `readonly` | `number` | [`ZoneSettings`](README.md#zonesettings).`FPMaxTemperature` | [src/types/common.ts:88](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L88) | -| `FPMinTemperature` | `readonly` | `number` | [`ZoneSettings`](README.md#zonesettings).`FPMinTemperature` | [src/types/common.ts:89](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L89) | -| `HMDefined` | `readonly` | `boolean` | [`ZoneSettings`](README.md#zonesettings).`HMDefined` | [src/types/common.ts:123](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L123) | -| `HMEnabled` | `readonly` | `boolean` | [`ZoneSettings`](README.md#zonesettings).`HMEnabled` | [src/types/common.ts:124](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L124) | -| `HMEndDate` | `readonly` | `null` \| `string` | [`ZoneSettings`](README.md#zonesettings).`HMEndDate` | [src/types/common.ts:125](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L125) | -| `HMStartDate` | `readonly` | `null` \| `string` | [`ZoneSettings`](README.md#zonesettings).`HMStartDate` | [src/types/common.ts:126](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L126) | -| `ID` | `readonly` | `number` | - | [src/types/common.ts:48](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L48) | -| `Location` | `readonly` | `number` | - | [src/types/common.ts:49](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L49) | -| `Name` | `readonly` | `string` | - | [src/types/common.ts:50](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L50) | -| `TimeZone` | `readonly` | `number` | [`ZoneSettings`](README.md#zonesettings).`TimeZone` | [src/types/common.ts:135](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L135) | +| Property | Modifier | Type | Inherited from | Defined in | +| -------------------------------------------------- | ---------- | ------------------ | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `FPDefined` | `readonly` | `boolean` | [`ZoneSettings`](README.md#zonesettings).[`FPDefined`](README.md#fpdefined-3) | [src/types/common.ts:86](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L86) | +| `FPEnabled` | `readonly` | `boolean` | [`ZoneSettings`](README.md#zonesettings).[`FPEnabled`](README.md#fpenabled-3) | [src/types/common.ts:87](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L87) | +| `FPMaxTemperature` | `readonly` | `number` | [`ZoneSettings`](README.md#zonesettings).[`FPMaxTemperature`](README.md#fpmaxtemperature-3) | [src/types/common.ts:88](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L88) | +| `FPMinTemperature` | `readonly` | `number` | [`ZoneSettings`](README.md#zonesettings).[`FPMinTemperature`](README.md#fpmintemperature-3) | [src/types/common.ts:89](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L89) | +| `HMDefined` | `readonly` | `boolean` | [`ZoneSettings`](README.md#zonesettings).[`HMDefined`](README.md#hmdefined-3) | [src/types/common.ts:123](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L123) | +| `HMEnabled` | `readonly` | `boolean` | [`ZoneSettings`](README.md#zonesettings).[`HMEnabled`](README.md#hmenabled-3) | [src/types/common.ts:124](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L124) | +| `HMEndDate` | `readonly` | `null` \| `string` | [`ZoneSettings`](README.md#zonesettings).[`HMEndDate`](README.md#hmenddate-3) | [src/types/common.ts:125](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L125) | +| `HMStartDate` | `readonly` | `null` \| `string` | [`ZoneSettings`](README.md#zonesettings).[`HMStartDate`](README.md#hmstartdate-3) | [src/types/common.ts:126](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L126) | +| `ID` | `readonly` | `number` | - | [src/types/common.ts:48](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L48) | +| `Location` | `readonly` | `number` | - | [src/types/common.ts:49](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L49) | +| `Name` | `readonly` | `string` | - | [src/types/common.ts:50](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L50) | +| `TimeZone` | `readonly` | `number` | [`ZoneSettings`](README.md#zonesettings).[`TimeZone`](README.md#timezone-5) | [src/types/common.ts:135](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L135) | --- ### EnergyDataAta +Defined in: [src/types/ata.ts:17](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L17) + #### Properties -| Property | Modifier | Type | Defined in | -| ---------------------------- | ---------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `Auto` | `readonly` | readonly `number`[] | [src/types/ata.ts:18](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L18) | -| `Cooling` | `readonly` | readonly `number`[] | [src/types/ata.ts:19](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L19) | -| `Dry` | `readonly` | readonly `number`[] | [src/types/ata.ts:20](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L20) | -| `Fan` | `readonly` | readonly `number`[] | [src/types/ata.ts:21](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L21) | -| `Heating` | `readonly` | readonly `number`[] | [src/types/ata.ts:22](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L22) | -| `Other` | `readonly` | readonly `number`[] | [src/types/ata.ts:23](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L23) | -| `TotalAutoConsumed` | `readonly` | `number` | [src/types/ata.ts:24](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L24) | -| `TotalCoolingConsumed` | `readonly` | `number` | [src/types/ata.ts:25](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L25) | -| `TotalDryConsumed` | `readonly` | `number` | [src/types/ata.ts:26](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L26) | -| `TotalFanConsumed` | `readonly` | `number` | [src/types/ata.ts:27](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L27) | -| `TotalHeatingConsumed` | `readonly` | `number` | [src/types/ata.ts:28](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L28) | -| `TotalOtherConsumed` | `readonly` | `number` | [src/types/ata.ts:29](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L29) | -| `UsageDisclaimerPercentages` | `readonly` | `string` | [src/types/ata.ts:30](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L30) | +| Property | Modifier | Type | Defined in | +| -------------------------------------------------------------------- | ---------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `Auto` | `readonly` | readonly `number`[] | [src/types/ata.ts:18](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L18) | +| `Cooling` | `readonly` | readonly `number`[] | [src/types/ata.ts:19](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L19) | +| `Dry` | `readonly` | readonly `number`[] | [src/types/ata.ts:20](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L20) | +| `Fan` | `readonly` | readonly `number`[] | [src/types/ata.ts:21](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L21) | +| `Heating` | `readonly` | readonly `number`[] | [src/types/ata.ts:22](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L22) | +| `Other` | `readonly` | readonly `number`[] | [src/types/ata.ts:23](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L23) | +| `TotalAutoConsumed` | `readonly` | `number` | [src/types/ata.ts:24](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L24) | +| `TotalCoolingConsumed` | `readonly` | `number` | [src/types/ata.ts:25](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L25) | +| `TotalDryConsumed` | `readonly` | `number` | [src/types/ata.ts:26](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L26) | +| `TotalFanConsumed` | `readonly` | `number` | [src/types/ata.ts:27](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L27) | +| `TotalHeatingConsumed` | `readonly` | `number` | [src/types/ata.ts:28](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L28) | +| `TotalOtherConsumed` | `readonly` | `number` | [src/types/ata.ts:29](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L29) | +| `UsageDisclaimerPercentages` | `readonly` | `string` | [src/types/ata.ts:30](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L30) | --- ### EnergyDataAtw +Defined in: [src/types/atw.ts:15](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L15) + #### Properties -| Property | Modifier | Type | Defined in | -| ----------------------- | ---------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `CoP` | `readonly` | readonly `number`[] | [src/types/atw.ts:16](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L16) | -| `TotalCoolingConsumed` | `readonly` | `number` | [src/types/atw.ts:17](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L17) | -| `TotalCoolingProduced` | `readonly` | `number` | [src/types/atw.ts:18](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L18) | -| `TotalHeatingConsumed` | `readonly` | `number` | [src/types/atw.ts:19](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L19) | -| `TotalHeatingProduced` | `readonly` | `number` | [src/types/atw.ts:20](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L20) | -| `TotalHotWaterConsumed` | `readonly` | `number` | [src/types/atw.ts:21](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L21) | -| `TotalHotWaterProduced` | `readonly` | `number` | [src/types/atw.ts:22](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L22) | +| Property | Modifier | Type | Defined in | +| ---------------------------------------------------------- | ---------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `CoP` | `readonly` | readonly `number`[] | [src/types/atw.ts:16](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L16) | +| `TotalCoolingConsumed` | `readonly` | `number` | [src/types/atw.ts:17](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L17) | +| `TotalCoolingProduced` | `readonly` | `number` | [src/types/atw.ts:18](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L18) | +| `TotalHeatingConsumed` | `readonly` | `number` | [src/types/atw.ts:19](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L19) | +| `TotalHeatingProduced` | `readonly` | `number` | [src/types/atw.ts:20](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L20) | +| `TotalHotWaterConsumed` | `readonly` | `number` | [src/types/atw.ts:21](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L21) | +| `TotalHotWaterProduced` | `readonly` | `number` | [src/types/atw.ts:22](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L22) | --- ### EnergyPostData +Defined in: [src/types/common.ts:53](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L53) + #### Properties -| Property | Modifier | Type | Defined in | -| ---------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `DeviceID` | `readonly` | `number` | [src/types/common.ts:54](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L54) | -| `FromDate` | `readonly` | `string` | [src/types/common.ts:55](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L55) | -| `ToDate` | `readonly` | `string` | [src/types/common.ts:56](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L56) | +| Property | Modifier | Type | Defined in | +| ---------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `DeviceID` | `readonly` | `number` | [src/types/common.ts:54](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L54) | +| `FromDate` | `readonly` | `string` | [src/types/common.ts:55](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L55) | +| `ToDate` | `readonly` | `string` | [src/types/common.ts:56](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L56) | --- ### ErrorDetails +Defined in: [src/services/interfaces.ts:65](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L65) + #### Properties -| Property | Modifier | Type | Defined in | -| -------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `date` | `readonly` | `string` | [src/services/interfaces.ts:66](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L66) | -| `device` | `readonly` | `string` | [src/services/interfaces.ts:67](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L67) | -| `error` | `readonly` | `string` | [src/services/interfaces.ts:68](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L68) | +| Property | Modifier | Type | Defined in | +| ---------------------------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `date` | `readonly` | `string` | [src/services/interfaces.ts:66](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L66) | +| `device` | `readonly` | `string` | [src/services/interfaces.ts:67](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L67) | +| `error` | `readonly` | `string` | [src/services/interfaces.ts:68](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L68) | --- ### ErrorLog +Defined in: [src/services/interfaces.ts:71](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L71) + #### Properties -| Property | Modifier | Type | Defined in | -| --------------- | ---------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `errors` | `readonly` | [`ErrorDetails`](README.md#errordetails)[] | [src/services/interfaces.ts:72](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L72) | -| `fromDateHuman` | `readonly` | `string` | [src/services/interfaces.ts:73](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L73) | -| `nextFromDate` | `readonly` | `string` | [src/services/interfaces.ts:74](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L74) | -| `nextToDate` | `readonly` | `string` | [src/services/interfaces.ts:75](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L75) | +| Property | Modifier | Type | Defined in | +| ------------------------------------------ | ---------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `errors` | `readonly` | [`ErrorDetails`](README.md#errordetails)[] | [src/services/interfaces.ts:72](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L72) | +| `fromDateHuman` | `readonly` | `string` | [src/services/interfaces.ts:73](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L73) | +| `nextFromDate` | `readonly` | `string` | [src/services/interfaces.ts:74](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L74) | +| `nextToDate` | `readonly` | `string` | [src/services/interfaces.ts:75](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L75) | --- ### ErrorLogData +Defined in: [src/types/common.ts:59](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L59) + #### Properties -| Property | Modifier | Type | Defined in | -| -------------- | ---------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `DeviceId` | `readonly` | `number` | [src/types/common.ts:60](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L60) | -| `EndDate` | `readonly` | `string` | [src/types/common.ts:61](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L61) | -| `ErrorMessage` | `readonly` | `null` \| `string` | [src/types/common.ts:62](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L62) | -| `StartDate` | `readonly` | `string` | [src/types/common.ts:63](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L63) | +| Property | Modifier | Type | Defined in | +| ---------------------------------------- | ---------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `DeviceId` | `readonly` | `number` | [src/types/common.ts:60](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L60) | +| `EndDate` | `readonly` | `string` | [src/types/common.ts:61](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L61) | +| `ErrorMessage` | `readonly` | `null` \| `string` | [src/types/common.ts:62](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L62) | +| `StartDate` | `readonly` | `string` | [src/types/common.ts:63](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L63) | --- ### ErrorLogPostData +Defined in: [src/types/common.ts:66](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L66) + #### Properties -| Property | Modifier | Type | Defined in | -| ----------- | ---------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `DeviceIDs` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:67](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L67) | -| `Duration?` | `readonly` | `number` | [src/types/common.ts:71](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L71) | -| `FromDate?` | `readonly` | `string` | [src/types/common.ts:68](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L68) | -| `ToDate?` | `readonly` | `string` | [src/types/common.ts:69](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L69) | +| Property | Modifier | Type | Defined in | +| ------------------------------------ | ---------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `DeviceIDs` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:67](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L67) | +| `Duration?` | `readonly` | `number` | [src/types/common.ts:71](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L71) | +| `FromDate?` | `readonly` | `string` | [src/types/common.ts:68](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L68) | +| `ToDate?` | `readonly` | `string` | [src/types/common.ts:69](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L69) | --- ### ErrorLogQuery +Defined in: [src/services/interfaces.ts:78](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L78) + #### Properties -| Property | Type | Defined in | -| --------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `from?` | `string` | [src/services/interfaces.ts:79](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L79) | -| `limit?` | `string` | [src/services/interfaces.ts:80](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L80) | -| `offset?` | `string` | [src/services/interfaces.ts:81](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L81) | -| `to?` | `string` | [src/services/interfaces.ts:82](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L82) | +| Property | Type | Defined in | +| ----------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `from?` | `string` | [src/services/interfaces.ts:79](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L79) | +| `limit?` | `string` | [src/services/interfaces.ts:80](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L80) | +| `offset?` | `string` | [src/services/interfaces.ts:81](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L81) | +| `to?` | `string` | [src/services/interfaces.ts:82](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L82) | --- ### FailureData +Defined in: [src/types/common.ts:74](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L74) + #### Properties -| Property | Modifier | Type | Defined in | -| ----------------- | ---------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `AttributeErrors` | `readonly` | `Record`\<`string`, readonly `string`[]\> | [src/types/common.ts:75](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L75) | -| `Success` | `readonly` | `false` | [src/types/common.ts:76](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L76) | +| Property | Modifier | Type | Defined in | +| ---------------------------------------------- | ---------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `AttributeErrors` | `readonly` | `Record`\<`string`, readonly `string`[]\> | [src/types/common.ts:75](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L75) | +| `Success` | `readonly` | `false` | [src/types/common.ts:76](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L76) | --- ### FloorData +Defined in: [src/types/common.ts:79](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L79) + #### Extended by - [`AreaData`](README.md#areadatat) #### Properties -| Property | Modifier | Type | Defined in | -| ------------ | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `BuildingId` | `readonly` | `number` | [src/types/common.ts:80](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L80) | -| `ID` | `readonly` | `number` | [src/types/common.ts:81](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L81) | -| `Name` | `readonly` | `string` | [src/types/common.ts:82](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L82) | +| Property | Modifier | Type | Defined in | +| -------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `BuildingId` | `readonly` | `number` | [src/types/common.ts:80](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L80) | +| `ID` | `readonly` | `number` | [src/types/common.ts:81](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L81) | +| `Name` | `readonly` | `string` | [src/types/common.ts:82](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L82) | --- ### FrostProtectionData +Defined in: [src/types/common.ts:85](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L85) + #### Extended by - [`ZoneSettings`](README.md#zonesettings) #### Properties -| Property | Modifier | Type | Defined in | -| ------------------ | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `FPDefined` | `readonly` | `boolean` | [src/types/common.ts:86](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L86) | -| `FPEnabled` | `readonly` | `boolean` | [src/types/common.ts:87](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L87) | -| `FPMaxTemperature` | `readonly` | `number` | [src/types/common.ts:88](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L88) | -| `FPMinTemperature` | `readonly` | `number` | [src/types/common.ts:89](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L89) | +| Property | Modifier | Type | Defined in | +| -------------------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `FPDefined` | `readonly` | `boolean` | [src/types/common.ts:86](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L86) | +| `FPEnabled` | `readonly` | `boolean` | [src/types/common.ts:87](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L87) | +| `FPMaxTemperature` | `readonly` | `number` | [src/types/common.ts:88](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L88) | +| `FPMinTemperature` | `readonly` | `number` | [src/types/common.ts:89](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L89) | --- ### FrostProtectionLocation +Defined in: [src/types/common.ts:92](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L92) + #### Extended by - [`FrostProtectionPostData`](README.md#frostprotectionpostdata) #### Properties -| Property | Modifier | Type | Defined in | -| -------------- | ---------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `AreaIds?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:93](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L93) | -| `BuildingIds?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:94](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L94) | -| `DeviceIds?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:95](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L95) | -| `FloorIds?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:96](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L96) | +| Property | Modifier | Type | Defined in | +| --------------------------------------- | ---------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `AreaIds?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:93](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L93) | +| `BuildingIds?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:94](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L94) | +| `DeviceIds?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:95](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L95) | +| `FloorIds?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:96](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L96) | --- ### FrostProtectionPostData +Defined in: [src/types/common.ts:99](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L99) + #### Extends - [`FrostProtectionLocation`](README.md#frostprotectionlocation) #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| -------------------- | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `AreaIds?` | `readonly` | `number` \| readonly `number`[] | [`FrostProtectionLocation`](README.md#frostprotectionlocation).`AreaIds` | [src/types/common.ts:93](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L93) | -| `BuildingIds?` | `readonly` | `number` \| readonly `number`[] | [`FrostProtectionLocation`](README.md#frostprotectionlocation).`BuildingIds` | [src/types/common.ts:94](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L94) | -| `DeviceIds?` | `readonly` | `number` \| readonly `number`[] | [`FrostProtectionLocation`](README.md#frostprotectionlocation).`DeviceIds` | [src/types/common.ts:95](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L95) | -| `Enabled` | `readonly` | `boolean` | - | [src/types/common.ts:100](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L100) | -| `FloorIds?` | `readonly` | `number` \| readonly `number`[] | [`FrostProtectionLocation`](README.md#frostprotectionlocation).`FloorIds` | [src/types/common.ts:96](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L96) | -| `MaximumTemperature` | `readonly` | `number` | - | [src/types/common.ts:101](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L101) | -| `MinimumTemperature` | `readonly` | `number` | - | [src/types/common.ts:102](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L102) | +| Property | Modifier | Type | Inherited from | Defined in | +| ---------------------------------------------------- | ---------- | ------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `AreaIds?` | `readonly` | `number` \| readonly `number`[] | [`FrostProtectionLocation`](README.md#frostprotectionlocation).[`AreaIds`](README.md#areaids-2) | [src/types/common.ts:93](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L93) | +| `BuildingIds?` | `readonly` | `number` \| readonly `number`[] | [`FrostProtectionLocation`](README.md#frostprotectionlocation).[`BuildingIds`](README.md#buildingids) | [src/types/common.ts:94](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L94) | +| `DeviceIds?` | `readonly` | `number` \| readonly `number`[] | [`FrostProtectionLocation`](README.md#frostprotectionlocation).[`DeviceIds`](README.md#deviceids-4) | [src/types/common.ts:95](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L95) | +| `Enabled` | `readonly` | `boolean` | - | [src/types/common.ts:100](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L100) | +| `FloorIds?` | `readonly` | `number` \| readonly `number`[] | [`FrostProtectionLocation`](README.md#frostprotectionlocation).[`FloorIds`](README.md#floorids-1) | [src/types/common.ts:96](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L96) | +| `MaximumTemperature` | `readonly` | `number` | - | [src/types/common.ts:101](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L101) | +| `MinimumTemperature` | `readonly` | `number` | - | [src/types/common.ts:102](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L102) | --- ### FrostProtectionQuery +Defined in: [src/facades/interfaces.ts:27](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L27) + #### Properties -| Property | Type | Defined in | -| ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `enabled?` | `boolean` | [src/facades/interfaces.ts:30](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L30) | -| `max` | `number` | [src/facades/interfaces.ts:28](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L28) | -| `min` | `number` | [src/facades/interfaces.ts:29](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L29) | +| Property | Type | Defined in | +| --------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `enabled?` | `boolean` | [src/facades/interfaces.ts:30](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L30) | +| `max` | `number` | [src/facades/interfaces.ts:28](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L28) | +| `min` | `number` | [src/facades/interfaces.ts:29](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L29) | --- ### GetDeviceDataParams +Defined in: [src/types/common.ts:105](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L105) + #### Properties -| Property | Modifier | Type | Defined in | -| ------------ | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `buildingId` | `readonly` | `number` | [src/types/common.ts:106](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L106) | -| `id` | `readonly` | `number` | [src/types/common.ts:107](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L107) | +| Property | Modifier | Type | Defined in | +| -------------------------------------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `buildingId` | `readonly` | `number` | [src/types/common.ts:106](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L106) | +| `id` | `readonly` | `number` | [src/types/common.ts:107](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L107) | --- ### GetGroupData +Defined in: [src/types/ata.ts:33](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L33) + #### Properties | Property | Modifier | Type | Defined in | | -------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | `readonly` | \{ `Group`: \{ `Specification`: `Required`\<[`GetGroupPostData`](README.md#getgrouppostdata)\>; `State`: `Required`\<[`GroupState`](README.md#groupstate)\>; \}; \} | [src/types/ata.ts:34](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L34) | -| `Data.Group` | `readonly` | \{ `Specification`: `Required`\<[`GetGroupPostData`](README.md#getgrouppostdata)\>; `State`: `Required`\<[`GroupState`](README.md#groupstate)\>; \} | [src/types/ata.ts:35](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L35) | -| `Data.Group.Specification` | `readonly` | `Required`\<[`GetGroupPostData`](README.md#getgrouppostdata)\> | [src/types/ata.ts:36](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L36) | -| `Data.Group.State` | `readonly` | `Required`\<[`GroupState`](README.md#groupstate)\> | [src/types/ata.ts:37](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L37) | +| `Data` | `readonly` | \{ `Group`: \{ `Specification`: `Required`\<[`GetGroupPostData`](README.md#getgrouppostdata)\>; `State`: `Required`\<[`GroupState`](README.md#groupstate)\>; \}; \} | [src/types/ata.ts:34](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L34) | +| `Data.Group` | `readonly` | \{ `Specification`: `Required`\<[`GetGroupPostData`](README.md#getgrouppostdata)\>; `State`: `Required`\<[`GroupState`](README.md#groupstate)\>; \} | [src/types/ata.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L35) | +| `Data.Group.Specification` | `readonly` | `Required`\<[`GetGroupPostData`](README.md#getgrouppostdata)\> | [src/types/ata.ts:36](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L36) | +| `Data.Group.State` | `readonly` | `Required`\<[`GroupState`](README.md#groupstate)\> | [src/types/ata.ts:37](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L37) | --- ### GetGroupPostData +Defined in: [src/types/ata.ts:42](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L42) + #### Properties -| Property | Modifier | Type | Defined in | -| ------------- | ---------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `AreaID?` | `readonly` | `null` \| `number` | [src/types/ata.ts:43](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L43) | -| `BuildingID?` | `readonly` | `null` \| `number` | [src/types/ata.ts:44](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L44) | -| `FloorID?` | `readonly` | `null` \| `number` | [src/types/ata.ts:45](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L45) | +| Property | Modifier | Type | Defined in | +| --------------------------------------- | ---------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `AreaID?` | `readonly` | `null` \| `number` | [src/types/ata.ts:43](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L43) | +| `BuildingID?` | `readonly` | `null` \| `number` | [src/types/ata.ts:44](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L44) | +| `FloorID?` | `readonly` | `null` \| `number` | [src/types/ata.ts:45](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L45) | --- ### GroupState +Defined in: [src/types/ata.ts:48](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L48) + #### Properties -| Property | Modifier | Type | Defined in | -| -------------------------- | ---------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `FanSpeed?` | `readonly` | `null` \| `auto` \| `fast` \| `moderate` \| `slow` \| `very_fast` \| `very_slow` | [src/types/ata.ts:49](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L49) | -| `OperationMode?` | `readonly` | `null` \| [`OperationMode`](README.md#operationmode) | [src/types/ata.ts:50](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L50) | -| `Power?` | `readonly` | `null` \| `boolean` | [src/types/ata.ts:51](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L51) | -| `SetTemperature?` | `readonly` | `null` \| `number` | [src/types/ata.ts:52](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L52) | -| `VaneHorizontalDirection?` | `readonly` | `null` \| [`Horizontal`](README.md#horizontal) | [src/types/ata.ts:53](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L53) | -| `VaneHorizontalSwing?` | `readonly` | `null` \| `boolean` | [src/types/ata.ts:54](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L54) | -| `VaneVerticalDirection?` | `readonly` | `null` \| [`Vertical`](README.md#vertical) | [src/types/ata.ts:55](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L55) | -| `VaneVerticalSwing?` | `readonly` | `null` \| `boolean` | [src/types/ata.ts:56](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L56) | +| Property | Modifier | Type | Defined in | +| --------------------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `FanSpeed?` | `readonly` | \| `null` \| [`auto`](README.md#auto) \| [`fast`](README.md#fast) \| [`moderate`](README.md#moderate) \| [`slow`](README.md#slow) \| [`very_fast`](README.md#very_fast) \| [`very_slow`](README.md#very_slow) | [src/types/ata.ts:49](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L49) | +| `OperationMode?` | `readonly` | `null` \| [`OperationMode`](README.md#operationmode) | [src/types/ata.ts:50](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L50) | +| `Power?` | `readonly` | `null` \| `boolean` | [src/types/ata.ts:51](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L51) | +| `SetTemperature?` | `readonly` | `null` \| `number` | [src/types/ata.ts:52](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L52) | +| `VaneHorizontalDirection?` | `readonly` | `null` \| [`Horizontal`](README.md#horizontal) | [src/types/ata.ts:53](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L53) | +| `VaneHorizontalSwing?` | `readonly` | `null` \| `boolean` | [src/types/ata.ts:54](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L54) | +| `VaneVerticalDirection?` | `readonly` | `null` \| [`Vertical`](README.md#vertical) | [src/types/ata.ts:55](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L55) | +| `VaneVerticalSwing?` | `readonly` | `null` \| `boolean` | [src/types/ata.ts:56](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L56) | --- ### HMTimeZone +Defined in: [src/types/common.ts:110](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L110) + #### Extends - [`HolidayModeLocation`](README.md#holidaymodelocation) #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ------------ | ---------- | ------------------------------- | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `Areas?` | `readonly` | `number` \| readonly `number`[] | [`HolidayModeLocation`](README.md#holidaymodelocation).`Areas` | [src/types/common.ts:139](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L139) | -| `Buildings?` | `readonly` | `number` \| readonly `number`[] | [`HolidayModeLocation`](README.md#holidaymodelocation).`Buildings` | [src/types/common.ts:140](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L140) | -| `Devices?` | `readonly` | `number` \| readonly `number`[] | [`HolidayModeLocation`](README.md#holidaymodelocation).`Devices` | [src/types/common.ts:141](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L141) | -| `Floors?` | `readonly` | `number` \| readonly `number`[] | [`HolidayModeLocation`](README.md#holidaymodelocation).`Floors` | [src/types/common.ts:142](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L142) | -| `TimeZone?` | `readonly` | `number` | - | [src/types/common.ts:111](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L111) | +| Property | Modifier | Type | Inherited from | Defined in | +| ----------------------------------- | ---------- | ------------------------------- | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `Areas?` | `readonly` | `number` \| readonly `number`[] | [`HolidayModeLocation`](README.md#holidaymodelocation).[`Areas`](README.md#areas-3) | [src/types/common.ts:139](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L139) | +| `Buildings?` | `readonly` | `number` \| readonly `number`[] | [`HolidayModeLocation`](README.md#holidaymodelocation).[`Buildings`](README.md#buildings-1) | [src/types/common.ts:140](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L140) | +| `Devices?` | `readonly` | `number` \| readonly `number`[] | [`HolidayModeLocation`](README.md#holidaymodelocation).[`Devices`](README.md#devices-4) | [src/types/common.ts:141](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L141) | +| `Floors?` | `readonly` | `number` \| readonly `number`[] | [`HolidayModeLocation`](README.md#holidaymodelocation).[`Floors`](README.md#floors-2) | [src/types/common.ts:142](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L142) | +| `TimeZone?` | `readonly` | `number` | - | [src/types/common.ts:111](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L111) | --- ### HolidayModeData +Defined in: [src/types/common.ts:114](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L114) + #### Properties -| Property | Modifier | Type | Defined in | -| ------------------ | ---------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `EndDate` | `readonly` | \{ `Day`: `number`; `Hour`: `number`; `Minute`: `number`; `Month`: `number`; `Second`: `number`; `Year`: `number`; \} | [src/types/common.ts:115](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L115) | -| `EndDate.Day` | `readonly` | `number` | [src/types/common.ts:116](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L116) | -| `EndDate.Hour` | `readonly` | `number` | [src/types/common.ts:117](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L117) | -| `EndDate.Minute` | `readonly` | `number` | [src/types/common.ts:118](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L118) | -| `EndDate.Month` | `readonly` | `number` | [src/types/common.ts:119](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L119) | -| `EndDate.Second` | `readonly` | `number` | [src/types/common.ts:120](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L120) | -| `EndDate.Year` | `readonly` | `number` | [src/types/common.ts:121](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L121) | -| `HMDefined` | `readonly` | `boolean` | [src/types/common.ts:123](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L123) | -| `HMEnabled` | `readonly` | `boolean` | [src/types/common.ts:124](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L124) | -| `HMEndDate` | `readonly` | `null` \| `string` | [src/types/common.ts:125](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L125) | -| `HMStartDate` | `readonly` | `null` \| `string` | [src/types/common.ts:126](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L126) | -| `StartDate` | `readonly` | \{ `Day`: `number`; `Hour`: `number`; `Minute`: `number`; `Month`: `number`; `Second`: `number`; `Year`: `number`; \} | [src/types/common.ts:127](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L127) | -| `StartDate.Day` | `readonly` | `number` | [src/types/common.ts:128](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L128) | -| `StartDate.Hour` | `readonly` | `number` | [src/types/common.ts:129](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L129) | -| `StartDate.Minute` | `readonly` | `number` | [src/types/common.ts:130](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L130) | -| `StartDate.Month` | `readonly` | `number` | [src/types/common.ts:131](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L131) | -| `StartDate.Second` | `readonly` | `number` | [src/types/common.ts:132](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L132) | -| `StartDate.Year` | `readonly` | `number` | [src/types/common.ts:133](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L133) | -| `TimeZone` | `readonly` | `number` | [src/types/common.ts:135](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L135) | +| Property | Modifier | Type | Defined in | +| ---------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `EndDate` | `readonly` | \{ `Day`: `number`; `Hour`: `number`; `Minute`: `number`; `Month`: `number`; `Second`: `number`; `Year`: `number`; \} | [src/types/common.ts:115](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L115) | +| `EndDate.Day` | `readonly` | `number` | [src/types/common.ts:116](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L116) | +| `EndDate.Hour` | `readonly` | `number` | [src/types/common.ts:117](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L117) | +| `EndDate.Minute` | `readonly` | `number` | [src/types/common.ts:118](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L118) | +| `EndDate.Month` | `readonly` | `number` | [src/types/common.ts:119](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L119) | +| `EndDate.Second` | `readonly` | `number` | [src/types/common.ts:120](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L120) | +| `EndDate.Year` | `readonly` | `number` | [src/types/common.ts:121](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L121) | +| `HMDefined` | `readonly` | `boolean` | [src/types/common.ts:123](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L123) | +| `HMEnabled` | `readonly` | `boolean` | [src/types/common.ts:124](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L124) | +| `HMEndDate` | `readonly` | `null` \| `string` | [src/types/common.ts:125](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L125) | +| `HMStartDate` | `readonly` | `null` \| `string` | [src/types/common.ts:126](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L126) | +| `StartDate` | `readonly` | \{ `Day`: `number`; `Hour`: `number`; `Minute`: `number`; `Month`: `number`; `Second`: `number`; `Year`: `number`; \} | [src/types/common.ts:127](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L127) | +| `StartDate.Day` | `readonly` | `number` | [src/types/common.ts:128](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L128) | +| `StartDate.Hour` | `readonly` | `number` | [src/types/common.ts:129](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L129) | +| `StartDate.Minute` | `readonly` | `number` | [src/types/common.ts:130](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L130) | +| `StartDate.Month` | `readonly` | `number` | [src/types/common.ts:131](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L131) | +| `StartDate.Second` | `readonly` | `number` | [src/types/common.ts:132](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L132) | +| `StartDate.Year` | `readonly` | `number` | [src/types/common.ts:133](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L133) | +| `TimeZone` | `readonly` | `number` | [src/types/common.ts:135](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L135) | --- ### HolidayModeLocation +Defined in: [src/types/common.ts:138](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L138) + #### Extended by - [`HMTimeZone`](README.md#hmtimezone) #### Properties -| Property | Modifier | Type | Defined in | -| ------------ | ---------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `Areas?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:139](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L139) | -| `Buildings?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:140](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L140) | -| `Devices?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:141](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L141) | -| `Floors?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:142](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L142) | +| Property | Modifier | Type | Defined in | +| ------------------------------------- | ---------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `Areas?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:139](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L139) | +| `Buildings?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:140](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L140) | +| `Devices?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:141](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L141) | +| `Floors?` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:142](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L142) | --- ### HolidayModePostData +Defined in: [src/types/common.ts:145](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L145) + #### Properties -| Property | Modifier | Type | Defined in | -| ------------- | ---------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `Enabled` | `readonly` | `boolean` | [src/types/common.ts:146](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L146) | -| `EndDate` | `readonly` | [`DateTimeComponents`](README.md#datetimecomponents) | [src/types/common.ts:147](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L147) | -| `HMTimeZones` | `readonly` | readonly [`HMTimeZone`](README.md#hmtimezone)[] | [src/types/common.ts:148](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L148) | -| `StartDate` | `readonly` | [`DateTimeComponents`](README.md#datetimecomponents) | [src/types/common.ts:149](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L149) | +| Property | Modifier | Type | Defined in | +| -------------------------------------- | ---------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `Enabled` | `readonly` | `boolean` | [src/types/common.ts:146](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L146) | +| `EndDate` | `readonly` | [`DateTimeComponents`](README.md#datetimecomponents) | [src/types/common.ts:147](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L147) | +| `HMTimeZones` | `readonly` | readonly [`HMTimeZone`](README.md#hmtimezone)[] | [src/types/common.ts:148](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L148) | +| `StartDate` | `readonly` | [`DateTimeComponents`](README.md#datetimecomponents) | [src/types/common.ts:149](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L149) | --- ### HolidayModeQuery +Defined in: [src/facades/interfaces.ts:33](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L33) + #### Properties -| Property | Type | Defined in | -| -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `from?` | `string` | [src/facades/interfaces.ts:34](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L34) | -| `to?` | `string` | [src/facades/interfaces.ts:35](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L35) | +| Property | Type | Defined in | +| --------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `from?` | `string` | [src/facades/interfaces.ts:34](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L34) | +| `to?` | `string` | [src/facades/interfaces.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L35) | --- ### IAPI +Defined in: [src/services/interfaces.ts:85](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L85) + #### Properties -| Property | Type | Defined in | -| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `authenticate` | (`data`?: [`LoginCredentials`](README.md#logincredentials)) => `Promise`\<`boolean`\> | [src/services/interfaces.ts:87](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L87) | -| `clearSync` | () => `void` | [src/services/interfaces.ts:88](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L88) | -| `energy` | (`__namedParameters`: \{ `postData`: [`EnergyPostData`](README.md#energypostdata); \}) => `Promise`\<\{ `data`: [`EnergyData`](README.md#energydatat)\<[`DeviceType`](README.md#devicetype)\>; \}\> | [src/services/interfaces.ts:172](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L172) | -| `errorLog` | (`query`: [`ErrorLogQuery`](README.md#errorlogquery), `deviceIds`: `number`[]) => `Promise`\<[`ErrorLog`](README.md#errorlog-1)\> | [src/services/interfaces.ts:89](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L89) | -| `errors` | (`__namedParameters`: \{ `postData`: [`ErrorLogPostData`](README.md#errorlogpostdata); \}) => `Promise`\<\{ `data`: \| [`FailureData`](README.md#failuredata) \| [`ErrorLogData`](README.md#errorlogdata)[]; \}\> | [src/services/interfaces.ts:93](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L93) | -| `fetch` | () => `Promise`\<[`Building`](README.md#building-3)[]\> | [src/services/interfaces.ts:90](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L90) | -| `frostProtection` | (`__namedParameters`: \{ `params`: [`SettingsParams`](README.md#settingsparams); \}) => `Promise`\<\{ `data`: [`FrostProtectionData`](README.md#frostprotectiondata); \}\> | [src/services/interfaces.ts:98](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L98) | -| `group` | (`__namedParameters`: \{ `postData`: [`GetGroupPostData`](README.md#getgrouppostdata); \}) => `Promise`\<\{ `data`: [`GetGroupData`](README.md#getgroupdata); \}\> | [src/services/interfaces.ts:178](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L178) | -| `holidayMode` | (`__namedParameters`: \{ `params`: [`SettingsParams`](README.md#settingsparams); \}) => `Promise`\<\{ `data`: [`HolidayModeData`](README.md#holidaymodedata); \}\> | [src/services/interfaces.ts:103](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L103) | -| `hourlyTemperatures` | (`__namedParameters`: \{ `postData`: \{ `device`: `number`; `hour`: `HourNumbers`; \}; \}) => `Promise`\<\{ `data`: [`ReportData`](README.md#reportdata); \}\> | [src/services/interfaces.ts:189](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L189) | -| `internalTemperatures` | (`__namedParameters`: \{ `postData`: [`ReportPostData`](README.md#reportpostdata); \}) => `Promise`\<\{ `data`: [`ReportData`](README.md#reportdata); \}\> | [src/services/interfaces.ts:194](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L194) | -| `list` | () => `Promise`\<\{ `data`: [`Building`](README.md#building-3)[]; \}\> | [src/services/interfaces.ts:108](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L108) | -| `login` | (`__namedParameters`: \{ `postData`: [`LoginPostData`](README.md#loginpostdata); \}) => `Promise`\<\{ `data`: [`LoginData`](README.md#logindata); \}\> | [src/services/interfaces.ts:109](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L109) | -| `onSync?` | [`OnSyncFunction`](README.md#onsyncfunction) | [src/services/interfaces.ts:86](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L86) | -| `operationModes` | (`__namedParameters`: \{ `postData`: [`ReportPostData`](README.md#reportpostdata); \}) => `Promise`\<\{ `data`: [`OperationModeLogData`](README.md#operationmodelogdata); \}\> | [src/services/interfaces.ts:114](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L114) | -| `setFrostProtection` | (`__namedParameters`: \{ `postData`: [`FrostProtectionPostData`](README.md#frostprotectionpostdata); \}) => `Promise`\<\{ `data`: \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata); \}\> | [src/services/interfaces.ts:119](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L119) | -| `setGroup` | (`__namedParameters`: \{ `postData`: [`SetGroupPostData`](README.md#setgrouppostdata); \}) => `Promise`\<\{ `data`: \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata); \}\> | [src/services/interfaces.ts:183](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L183) | -| `setHolidayMode` | (`__namedParameters`: \{ `postData`: [`HolidayModePostData`](README.md#holidaymodepostdata); \}) => `Promise`\<\{ `data`: \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata); \}\> | [src/services/interfaces.ts:124](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L124) | -| `setLanguage` | (`__namedParameters`: \{ `postData`: \{ `language`: [`Language`](README.md#language); \}; \}) => `Promise`\<\{ `data`: `boolean`; \}\> | [src/services/interfaces.ts:129](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L129) | -| `setPower` | (`__namedParameters`: \{ `postData`: [`SetPowerPostData`](README.md#setpowerpostdata); \}) => `Promise`\<\{ `data`: `boolean`; \}\> | [src/services/interfaces.ts:134](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L134) | -| `setValues` | \<`T`\>(`__namedParameters`: \{ `postData`: [`SetDevicePostData`](README.md#setdevicepostdatat)\<`T`\>; `type`: `T`; \}) => `Promise`\<\{ `data`: [`SetDeviceData`](README.md#setdevicedatat)\<`T`\>; \}\> | [src/services/interfaces.ts:139](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L139) | -| `signal` | (`__namedParameters`: \{ `postData`: \{ `devices`: `number` \| `number`[]; `hour`: `HourNumbers`; \}; \}) => `Promise`\<\{ `data`: [`ReportData`](README.md#reportdata); \}\> | [src/services/interfaces.ts:146](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L146) | -| `temperatures` | (`__namedParameters`: \{ `postData`: [`TemperatureLogPostData`](README.md#temperaturelogpostdata); \}) => `Promise`\<\{ `data`: [`ReportData`](README.md#reportdata); \}\> | [src/services/interfaces.ts:151](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L151) | -| `tiles` | (`__namedParameters`: \{ `postData`: [`TilesPostData`](README.md#tilespostdatat)\<`null`\>; \}) => `Promise`\<\{ `data`: [`TilesData`](README.md#tilesdatat)\<`null`\>; \}\> & \<`T`\>(`__namedParameters`: \{ `postData`: [`TilesPostData`](README.md#tilespostdatat)\<`T`\>; \}) => `Promise`\<\{ `data`: [`TilesData`](README.md#tilesdatat)\<`T`\>; \}\> | [src/services/interfaces.ts:156](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L156) | -| `updateLanguage` | (`language`: `string`) => `Promise`\<`void`\> | [src/services/interfaces.ts:91](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L91) | -| `values` | (`__namedParameters`: \{ `params`: [`GetDeviceDataParams`](README.md#getdevicedataparams); \}) => `Promise`\<\{ `data`: [`GetDeviceData`](README.md#getdevicedatat)\<[`DeviceType`](README.md#devicetype)\>; \}\> | [src/services/interfaces.ts:166](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L166) | +| Property | Type | Defined in | +| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `authenticate` | (`data`?: [`LoginCredentials`](README.md#logincredentials)) => `Promise`\<`boolean`\> | [src/services/interfaces.ts:87](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L87) | +| `clearSync` | () => `void` | [src/services/interfaces.ts:88](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L88) | +| `energy` | (`__namedParameters`: \{ `postData`: [`EnergyPostData`](README.md#energypostdata); \}) => `Promise`\<\{ `data`: [`EnergyData`](README.md#energydatat)\<[`DeviceType`](README.md#devicetype)\>; \}\> | [src/services/interfaces.ts:172](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L172) | +| `errorLog` | (`query`: [`ErrorLogQuery`](README.md#errorlogquery), `deviceIds`: `number`[]) => `Promise`\<[`ErrorLog`](README.md#errorlog-1)\> | [src/services/interfaces.ts:89](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L89) | +| `errors` | (`__namedParameters`: \{ `postData`: [`ErrorLogPostData`](README.md#errorlogpostdata); \}) => `Promise`\<\{ `data`: \| [`FailureData`](README.md#failuredata) \| [`ErrorLogData`](README.md#errorlogdata)[]; \}\> | [src/services/interfaces.ts:93](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L93) | +| `fetch` | () => `Promise`\<[`Building`](README.md#building-3)[]\> | [src/services/interfaces.ts:90](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L90) | +| `frostProtection` | (`__namedParameters`: \{ `params`: [`SettingsParams`](README.md#settingsparams); \}) => `Promise`\<\{ `data`: [`FrostProtectionData`](README.md#frostprotectiondata); \}\> | [src/services/interfaces.ts:98](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L98) | +| `group` | (`__namedParameters`: \{ `postData`: [`GetGroupPostData`](README.md#getgrouppostdata); \}) => `Promise`\<\{ `data`: [`GetGroupData`](README.md#getgroupdata); \}\> | [src/services/interfaces.ts:178](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L178) | +| `holidayMode` | (`__namedParameters`: \{ `params`: [`SettingsParams`](README.md#settingsparams); \}) => `Promise`\<\{ `data`: [`HolidayModeData`](README.md#holidaymodedata); \}\> | [src/services/interfaces.ts:103](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L103) | +| `hourlyTemperatures` | (`__namedParameters`: \{ `postData`: \{ `device`: `number`; `hour`: `HourNumbers`; \}; \}) => `Promise`\<\{ `data`: [`ReportData`](README.md#reportdata); \}\> | [src/services/interfaces.ts:189](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L189) | +| `internalTemperatures` | (`__namedParameters`: \{ `postData`: [`ReportPostData`](README.md#reportpostdata); \}) => `Promise`\<\{ `data`: [`ReportData`](README.md#reportdata); \}\> | [src/services/interfaces.ts:194](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L194) | +| `list` | () => `Promise`\<\{ `data`: [`Building`](README.md#building-3)[]; \}\> | [src/services/interfaces.ts:108](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L108) | +| `login` | (`__namedParameters`: \{ `postData`: [`LoginPostData`](README.md#loginpostdata); \}) => `Promise`\<\{ `data`: [`LoginData`](README.md#logindata); \}\> | [src/services/interfaces.ts:109](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L109) | +| `onSync?` | [`OnSyncFunction`](README.md#onsyncfunction) | [src/services/interfaces.ts:86](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L86) | +| `operationModes` | (`__namedParameters`: \{ `postData`: [`ReportPostData`](README.md#reportpostdata); \}) => `Promise`\<\{ `data`: [`OperationModeLogData`](README.md#operationmodelogdata); \}\> | [src/services/interfaces.ts:114](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L114) | +| `setFrostProtection` | (`__namedParameters`: \{ `postData`: [`FrostProtectionPostData`](README.md#frostprotectionpostdata); \}) => `Promise`\<\{ `data`: \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata); \}\> | [src/services/interfaces.ts:119](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L119) | +| `setGroup` | (`__namedParameters`: \{ `postData`: [`SetGroupPostData`](README.md#setgrouppostdata); \}) => `Promise`\<\{ `data`: \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata); \}\> | [src/services/interfaces.ts:183](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L183) | +| `setHolidayMode` | (`__namedParameters`: \{ `postData`: [`HolidayModePostData`](README.md#holidaymodepostdata); \}) => `Promise`\<\{ `data`: \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata); \}\> | [src/services/interfaces.ts:124](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L124) | +| `setLanguage` | (`__namedParameters`: \{ `postData`: \{ `language`: [`Language`](README.md#language); \}; \}) => `Promise`\<\{ `data`: `boolean`; \}\> | [src/services/interfaces.ts:129](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L129) | +| `setPower` | (`__namedParameters`: \{ `postData`: [`SetPowerPostData`](README.md#setpowerpostdata); \}) => `Promise`\<\{ `data`: `boolean`; \}\> | [src/services/interfaces.ts:134](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L134) | +| `setValues` | \<`T`\>(`__namedParameters`: \{ `postData`: [`SetDevicePostData`](README.md#setdevicepostdatat)\<`T`\>; `type`: `T`; \}) => `Promise`\<\{ `data`: [`SetDeviceData`](README.md#setdevicedatat)\<`T`\>; \}\> | [src/services/interfaces.ts:139](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L139) | +| `signal` | (`__namedParameters`: \{ `postData`: \{ `devices`: `number` \| `number`[]; `hour`: `HourNumbers`; \}; \}) => `Promise`\<\{ `data`: [`ReportData`](README.md#reportdata); \}\> | [src/services/interfaces.ts:146](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L146) | +| `temperatures` | (`__namedParameters`: \{ `postData`: [`TemperatureLogPostData`](README.md#temperaturelogpostdata); \}) => `Promise`\<\{ `data`: [`ReportData`](README.md#reportdata); \}\> | [src/services/interfaces.ts:151](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L151) | +| `tiles` | (`__namedParameters`: \{ `postData`: [`TilesPostData`](README.md#tilespostdatat)\<`null`\>; \}) => `Promise`\<\{ `data`: [`TilesData`](README.md#tilesdatat)\<`null`\>; \}\> & \<`T`\>(`__namedParameters`: \{ `postData`: [`TilesPostData`](README.md#tilespostdatat)\<`T`\>; \}) => `Promise`\<\{ `data`: [`TilesData`](README.md#tilesdatat)\<`T`\>; \}\> | [src/services/interfaces.ts:156](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L156) | +| `updateLanguage` | (`language`: `string`) => `Promise`\<`void`\> | [src/services/interfaces.ts:91](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L91) | +| `values` | (`__namedParameters`: \{ `params`: [`GetDeviceDataParams`](README.md#getdevicedataparams); \}) => `Promise`\<\{ `data`: [`GetDeviceData`](README.md#getdevicedatat)\<[`DeviceType`](README.md#devicetype)\>; \}\> | [src/services/interfaces.ts:166](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L166) | --- ### IAreaModel +Defined in: [src/models/interfaces.ts:24](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L24) + #### Extends - `ISubFloorModel`.`ISuperDeviceModel` #### Properties -| Property | Type | Inherited from | Defined in | -| ------------ | ------------------------------------------------ | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `building?` | [`IBuildingModel`](README.md#ibuildingmodel) | `ISubFloorModel.building` | [src/models/interfaces.ts:6](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L6) | -| `buildingId` | `number` | `ISubFloorModel.buildingId` | [src/models/interfaces.ts:5](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L5) | -| `deviceIds` | `number`[] | `ISuperDeviceModel.deviceIds` | [src/models/interfaces.ts:20](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L20) | -| `devices` | [`IDeviceModelAny`](README.md#idevicemodelany)[] | `ISuperDeviceModel.devices` | [src/models/interfaces.ts:21](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L21) | -| `floor?` | `null` \| [`IFloorModel`](README.md#ifloormodel) | `ISubFloorModel.floor` | [src/models/interfaces.ts:11](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L11) | -| `floorId` | `null` \| `number` | `ISubFloorModel.floorId` | [src/models/interfaces.ts:10](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L10) | -| `id` | `number` | `ISubFloorModel.id` | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L52) | -| `name` | `string` | `ISubFloorModel.name` | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L53) | +| Property | Type | Inherited from | Defined in | +| -------------------------------------- | ------------------------------------------------ | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `building?` | [`IBuildingModel`](README.md#ibuildingmodel) | `ISubFloorModel.building` | [src/models/interfaces.ts:6](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L6) | +| `buildingId` | `number` | `ISubFloorModel.buildingId` | [src/models/interfaces.ts:5](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L5) | +| `deviceIds` | `number`[] | `ISuperDeviceModel.deviceIds` | [src/models/interfaces.ts:20](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L20) | +| `devices` | [`IDeviceModelAny`](README.md#idevicemodelany)[] | `ISuperDeviceModel.devices` | [src/models/interfaces.ts:21](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L21) | +| `floor?` | `null` \| [`IFloorModel`](README.md#ifloormodel) | `ISubFloorModel.floor` | [src/models/interfaces.ts:11](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L11) | +| `floorId` | `null` \| `number` | `ISubFloorModel.floorId` | [src/models/interfaces.ts:10](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L10) | +| `id` | `number` | `ISubFloorModel.id` | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L52) | +| `name` | `string` | `ISubFloorModel.name` | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L53) | --- ### IBuildingFacade +Defined in: [src/facades/interfaces.ts:38](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L38) + #### Extends - `IBaseBuildingModel`.[`ISuperDeviceFacade`](README.md#isuperdevicefacade) #### Properties -| Property | Type | Inherited from | Defined in | -| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [`ZoneSettings`](README.md#zonesettings) | `IBaseBuildingModel.data` | [src/models/interfaces.ts:27](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L27) | -| `devices` | [`IDeviceModelAny`](README.md#idevicemodelany)[] | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).`devices` | [src/facades/interfaces.ts:63](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L63) | -| `errors` | (`query`: [`ErrorLogQuery`](README.md#errorlogquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`ErrorLog`](README.md#errorlog-1)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).`errors` | [src/facades/interfaces.ts:64](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L64) | -| `fetch` | () => `Promise`\<[`ZoneSettings`](README.md#zonesettings)\> | - | [src/facades/interfaces.ts:41](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L41) | -| `frostProtection` | () => `Promise`\<[`FrostProtectionData`](README.md#frostprotectiondata)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).`frostProtection` | [src/facades/interfaces.ts:65](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L65) | -| `group` | () => `Promise`\<[`GroupState`](README.md#groupstate)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).`group` | [src/facades/interfaces.ts:85](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L85) | -| `holidayMode` | () => `Promise`\<[`HolidayModeData`](README.md#holidaymodedata)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).`holidayMode` | [src/facades/interfaces.ts:66](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L66) | -| `id` | `number` | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).`id` | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L52) | -| `name` | `string` | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).`name` | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L53) | -| `onSync` | (`params`?: \{ `type`: [`DeviceType`](README.md#devicetype); \}) => `Promise`\<`void`\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).`onSync` | [src/facades/interfaces.ts:67](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L67) | -| `setFrostProtection` | (`query`: [`FrostProtectionQuery`](README.md#frostprotectionquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).`setFrostProtection` | [src/facades/interfaces.ts:68](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L68) | -| `setGroup` | (`state`: [`GroupState`](README.md#groupstate)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).`setGroup` | [src/facades/interfaces.ts:86](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L86) | -| `setHolidayMode` | (`query`: [`HolidayModeQuery`](README.md#holidaymodequery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).`setHolidayMode` | [src/facades/interfaces.ts:71](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L71) | -| `setPower` | (`value`?: `boolean`) => `Promise`\<`boolean`\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).`setPower` | [src/facades/interfaces.ts:74](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L74) | -| `signal` | (`hour`?: `HourNumbers`) => `Promise`\<[`ReportChartLineOptions`](README.md#reportchartlineoptions)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).`signal` | [src/facades/interfaces.ts:75](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L75) | -| `tiles` | (`select`?: `false`) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`null`\>\> & \<`T`\>(`select`: [`IDeviceModel`](README.md#idevicemodelt)\<`T`\>) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`T`\>\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).`tiles` | [src/facades/interfaces.ts:76](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L76) | +| Property | Type | Inherited from | Defined in | +| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `data` | [`ZoneSettings`](README.md#zonesettings) | `IBaseBuildingModel.data` | [src/models/interfaces.ts:27](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L27) | +| `devices` | [`IDeviceModelAny`](README.md#idevicemodelany)[] | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).[`devices`](README.md#devices-11) | [src/facades/interfaces.ts:63](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L63) | +| `errors` | (`query`: [`ErrorLogQuery`](README.md#errorlogquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`ErrorLog`](README.md#errorlog-1)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).[`errors`](README.md#errors-6) | [src/facades/interfaces.ts:64](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L64) | +| `fetch` | () => `Promise`\<[`ZoneSettings`](README.md#zonesettings)\> | - | [src/facades/interfaces.ts:41](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L41) | +| `frostProtection` | () => `Promise`\<[`FrostProtectionData`](README.md#frostprotectiondata)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).[`frostProtection`](README.md#frostprotection-5) | [src/facades/interfaces.ts:65](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L65) | +| `group` | () => `Promise`\<[`GroupState`](README.md#groupstate)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).[`group`](README.md#group-3) | [src/facades/interfaces.ts:85](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L85) | +| `holidayMode` | () => `Promise`\<[`HolidayModeData`](README.md#holidaymodedata)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).[`holidayMode`](README.md#holidaymode-5) | [src/facades/interfaces.ts:66](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L66) | +| `id` | `number` | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).[`id`](README.md#id-17) | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L52) | +| `name` | `string` | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).[`name`](README.md#name-16) | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L53) | +| `onSync` | (`params`?: \{ `type`: [`DeviceType`](README.md#devicetype); \}) => `Promise`\<`void`\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).[`onSync`](README.md#onsync-6) | [src/facades/interfaces.ts:67](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L67) | +| `setFrostProtection` | (`query`: [`FrostProtectionQuery`](README.md#frostprotectionquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).[`setFrostProtection`](README.md#setfrostprotection-5) | [src/facades/interfaces.ts:68](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L68) | +| `setGroup` | (`state`: [`GroupState`](README.md#groupstate)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).[`setGroup`](README.md#setgroup-3) | [src/facades/interfaces.ts:86](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L86) | +| `setHolidayMode` | (`query`: [`HolidayModeQuery`](README.md#holidaymodequery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).[`setHolidayMode`](README.md#setholidaymode-5) | [src/facades/interfaces.ts:71](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L71) | +| `setPower` | (`value`?: `boolean`) => `Promise`\<`boolean`\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).[`setPower`](README.md#setpower-5) | [src/facades/interfaces.ts:74](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L74) | +| `signal` | (`hour`?: `HourNumbers`) => `Promise`\<[`ReportChartLineOptions`](README.md#reportchartlineoptions)\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).[`signal`](README.md#signal-5) | [src/facades/interfaces.ts:75](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L75) | +| `tiles` | (`select`?: `false`) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`null`\>\> & \<`T`\>(`select`: [`IDeviceModel`](README.md#idevicemodelt)\<`T`\>) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`T`\>\> | [`ISuperDeviceFacade`](README.md#isuperdevicefacade).[`tiles`](README.md#tiles-5) | [src/facades/interfaces.ts:76](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L76) | --- ### IBuildingModel +Defined in: [src/models/interfaces.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L35) + #### Extends - `IBaseBuildingModel`.`ISuperAreaModel` #### Properties -| Property | Type | Inherited from | Defined in | -| ----------- | ------------------------------------------------ | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `areaIds` | `number`[] | `ISuperAreaModel.areaIds` | [src/models/interfaces.ts:15](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L15) | -| `areas` | [`IAreaModel`](README.md#iareamodel)[] | `ISuperAreaModel.areas` | [src/models/interfaces.ts:16](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L16) | -| `data` | [`ZoneSettings`](README.md#zonesettings) | `IBaseBuildingModel.data` | [src/models/interfaces.ts:27](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L27) | -| `deviceIds` | `number`[] | `ISuperAreaModel.deviceIds` | [src/models/interfaces.ts:20](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L20) | -| `devices` | [`IDeviceModelAny`](README.md#idevicemodelany)[] | `ISuperAreaModel.devices` | [src/models/interfaces.ts:21](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L21) | -| `floorIds` | `number`[] | - | [src/models/interfaces.ts:36](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L36) | -| `floors` | [`IFloorModel`](README.md#ifloormodel)[] | - | [src/models/interfaces.ts:37](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L37) | -| `id` | `number` | `ISuperAreaModel.id` | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L52) | -| `location` | `number` | - | [src/models/interfaces.ts:38](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L38) | -| `name` | `string` | `ISuperAreaModel.name` | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L53) | +| Property | Type | Inherited from | Defined in | +| ------------------------------------ | ------------------------------------------------ | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `areaIds` | `number`[] | `ISuperAreaModel.areaIds` | [src/models/interfaces.ts:15](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L15) | +| `areas` | [`IAreaModel`](README.md#iareamodel)[] | `ISuperAreaModel.areas` | [src/models/interfaces.ts:16](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L16) | +| `data` | [`ZoneSettings`](README.md#zonesettings) | `IBaseBuildingModel.data` | [src/models/interfaces.ts:27](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L27) | +| `deviceIds` | `number`[] | `ISuperAreaModel.deviceIds` | [src/models/interfaces.ts:20](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L20) | +| `devices` | [`IDeviceModelAny`](README.md#idevicemodelany)[] | `ISuperAreaModel.devices` | [src/models/interfaces.ts:21](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L21) | +| `floorIds` | `number`[] | - | [src/models/interfaces.ts:36](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L36) | +| `floors` | [`IFloorModel`](README.md#ifloormodel)[] | - | [src/models/interfaces.ts:37](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L37) | +| `id` | `number` | `ISuperAreaModel.id` | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L52) | +| `location` | `number` | - | [src/models/interfaces.ts:38](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L38) | +| `name` | `string` | `ISuperAreaModel.name` | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L53) | --- ### IDeviceFacade\ +Defined in: [src/facades/interfaces.ts:44](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L44) + #### Extends - `IBaseDeviceModel`\<`T`\>.[`IFacade`](README.md#ifacade) @@ -2984,36 +2938,38 @@ static create(config?: APIConfig): Promise #### Properties -| Property | Type | Overrides | Inherited from | Defined in | -| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [`ListDeviceData`](README.md#listdevicedatat)\<`T`\> | - | `IBaseDeviceModel.data` | [src/models/interfaces.ts:31](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L31) | -| `devices` | [`IDeviceModelAny`](README.md#idevicemodelany)[] | - | [`IFacade`](README.md#ifacade).`devices` | [src/facades/interfaces.ts:63](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L63) | -| `energy` | (`query`: [`ReportQuery`](README.md#reportquery)) => `Promise`\<[`EnergyData`](README.md#energydatat)\<`T`\>\> | - | - | [src/facades/interfaces.ts:56](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L56) | -| `errors` | (`query`: [`ErrorLogQuery`](README.md#errorlogquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`ErrorLog`](README.md#errorlog-1)\> | - | [`IFacade`](README.md#ifacade).`errors` | [src/facades/interfaces.ts:64](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L64) | -| `fetch` | () => `Promise`\<[`ListDeviceData`](README.md#listdevicedatat)\<`T`\>\> | - | - | [src/facades/interfaces.ts:48](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L48) | -| `flags` | `Record`\, `number`\> | - | - | [src/facades/interfaces.ts:47](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L47) | -| `frostProtection` | () => `Promise`\<[`FrostProtectionData`](README.md#frostprotectiondata)\> | - | [`IFacade`](README.md#ifacade).`frostProtection` | [src/facades/interfaces.ts:65](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L65) | -| `holidayMode` | () => `Promise`\<[`HolidayModeData`](README.md#holidaymodedata)\> | - | [`IFacade`](README.md#ifacade).`holidayMode` | [src/facades/interfaces.ts:66](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L66) | -| `hourlyTemperatures` | (`hour`?: `HourNumbers`) => `Promise`\<[`ReportChartLineOptions`](README.md#reportchartlineoptions)\> | - | - | [src/facades/interfaces.ts:58](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L58) | -| `id` | `number` | - | [`IFacade`](README.md#ifacade).`id` | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L52) | -| `internalTemperatures` | (`query`: [`ReportQuery`](README.md#reportquery)) => `Promise`\<[`ReportChartLineOptions`](README.md#reportchartlineoptions)\> | - | - | [src/facades/interfaces.ts:59](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L59) | -| `name` | `string` | - | [`IFacade`](README.md#ifacade).`name` | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L53) | -| `onSync` | (`params`?: \{ `type`: [`DeviceType`](README.md#devicetype); \}) => `Promise`\<`void`\> | - | [`IFacade`](README.md#ifacade).`onSync` | [src/facades/interfaces.ts:67](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L67) | -| `operationModes` | (`query`: [`ReportQuery`](README.md#reportquery)) => `Promise`\<[`ReportChartPieOptions`](README.md#reportchartpieoptions)\> | - | - | [src/facades/interfaces.ts:49](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L49) | -| `setFrostProtection` | (`query`: [`FrostProtectionQuery`](README.md#frostprotectionquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | - | [`IFacade`](README.md#ifacade).`setFrostProtection` | [src/facades/interfaces.ts:68](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L68) | -| `setHolidayMode` | (`query`: [`HolidayModeQuery`](README.md#holidaymodequery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | - | [`IFacade`](README.md#ifacade).`setHolidayMode` | [src/facades/interfaces.ts:71](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L71) | -| `setPower` | (`value`?: `boolean`) => `Promise`\<`boolean`\> | - | [`IFacade`](README.md#ifacade).`setPower` | [src/facades/interfaces.ts:74](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L74) | -| `setValues` | (`data`: [`UpdateDeviceData`](README.md#updatedevicedatat)\<`T`\>) => `Promise`\<[`SetDeviceData`](README.md#setdevicedatat)\<`T`\>\> | - | - | [src/facades/interfaces.ts:50](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L50) | -| `signal` | (`hour`?: `HourNumbers`) => `Promise`\<[`ReportChartLineOptions`](README.md#reportchartlineoptions)\> | - | [`IFacade`](README.md#ifacade).`signal` | [src/facades/interfaces.ts:75](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L75) | -| `temperatures` | (`query`: [`ReportQuery`](README.md#reportquery)) => `Promise`\<[`ReportChartLineOptions`](README.md#reportchartlineoptions)\> | - | - | [src/facades/interfaces.ts:51](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L51) | -| `tiles` | (`select`: `true` \| [`IDeviceModel`](README.md#idevicemodelt)\<`T`\>) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`T`\>\> & (`select`?: `false`) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`null`\>\> | [`IFacade`](README.md#ifacade).`tiles` | - | [src/facades/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L52) | -| `type` | `T` | - | `IBaseDeviceModel.type` | [src/models/interfaces.ts:32](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L32) | -| `values` | () => `Promise`\<[`GetDeviceData`](README.md#getdevicedatat)\<`T`\>\> | - | - | [src/facades/interfaces.ts:54](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L54) | +| Property | Type | Overrides | Inherited from | Defined in | +| ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `data` | [`ListDeviceData`](README.md#listdevicedatat)\<`T`\> | - | `IBaseDeviceModel.data` | [src/models/interfaces.ts:31](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L31) | +| `devices` | [`IDeviceModelAny`](README.md#idevicemodelany)[] | - | [`IFacade`](README.md#ifacade).[`devices`](README.md#devices-9) | [src/facades/interfaces.ts:63](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L63) | +| `energy` | (`query`: [`ReportQuery`](README.md#reportquery)) => `Promise`\<[`EnergyData`](README.md#energydatat)\<`T`\>\> | - | - | [src/facades/interfaces.ts:56](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L56) | +| `errors` | (`query`: [`ErrorLogQuery`](README.md#errorlogquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`ErrorLog`](README.md#errorlog-1)\> | - | [`IFacade`](README.md#ifacade).[`errors`](README.md#errors-5) | [src/facades/interfaces.ts:64](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L64) | +| `fetch` | () => `Promise`\<[`ListDeviceData`](README.md#listdevicedatat)\<`T`\>\> | - | - | [src/facades/interfaces.ts:48](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L48) | +| `flags` | `Record`\, `number`\> | - | - | [src/facades/interfaces.ts:47](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L47) | +| `frostProtection` | () => `Promise`\<[`FrostProtectionData`](README.md#frostprotectiondata)\> | - | [`IFacade`](README.md#ifacade).[`frostProtection`](README.md#frostprotection-4) | [src/facades/interfaces.ts:65](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L65) | +| `holidayMode` | () => `Promise`\<[`HolidayModeData`](README.md#holidaymodedata)\> | - | [`IFacade`](README.md#ifacade).[`holidayMode`](README.md#holidaymode-4) | [src/facades/interfaces.ts:66](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L66) | +| `hourlyTemperatures` | (`hour`?: `HourNumbers`) => `Promise`\<[`ReportChartLineOptions`](README.md#reportchartlineoptions)\> | - | - | [src/facades/interfaces.ts:58](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L58) | +| `id` | `number` | - | [`IFacade`](README.md#ifacade).[`id`](README.md#id-14) | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L52) | +| `internalTemperatures` | (`query`: [`ReportQuery`](README.md#reportquery)) => `Promise`\<[`ReportChartLineOptions`](README.md#reportchartlineoptions)\> | - | - | [src/facades/interfaces.ts:59](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L59) | +| `name` | `string` | - | [`IFacade`](README.md#ifacade).[`name`](README.md#name-13) | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L53) | +| `onSync` | (`params`?: \{ `type`: [`DeviceType`](README.md#devicetype); \}) => `Promise`\<`void`\> | - | [`IFacade`](README.md#ifacade).[`onSync`](README.md#onsync-5) | [src/facades/interfaces.ts:67](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L67) | +| `operationModes` | (`query`: [`ReportQuery`](README.md#reportquery)) => `Promise`\<[`ReportChartPieOptions`](README.md#reportchartpieoptions)\> | - | - | [src/facades/interfaces.ts:49](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L49) | +| `setFrostProtection` | (`query`: [`FrostProtectionQuery`](README.md#frostprotectionquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | - | [`IFacade`](README.md#ifacade).[`setFrostProtection`](README.md#setfrostprotection-4) | [src/facades/interfaces.ts:68](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L68) | +| `setHolidayMode` | (`query`: [`HolidayModeQuery`](README.md#holidaymodequery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | - | [`IFacade`](README.md#ifacade).[`setHolidayMode`](README.md#setholidaymode-4) | [src/facades/interfaces.ts:71](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L71) | +| `setPower` | (`value`?: `boolean`) => `Promise`\<`boolean`\> | - | [`IFacade`](README.md#ifacade).[`setPower`](README.md#setpower-4) | [src/facades/interfaces.ts:74](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L74) | +| `setValues` | (`data`: [`UpdateDeviceData`](README.md#updatedevicedatat)\<`T`\>) => `Promise`\<[`SetDeviceData`](README.md#setdevicedatat)\<`T`\>\> | - | - | [src/facades/interfaces.ts:50](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L50) | +| `signal` | (`hour`?: `HourNumbers`) => `Promise`\<[`ReportChartLineOptions`](README.md#reportchartlineoptions)\> | - | [`IFacade`](README.md#ifacade).[`signal`](README.md#signal-4) | [src/facades/interfaces.ts:75](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L75) | +| `temperatures` | (`query`: [`ReportQuery`](README.md#reportquery)) => `Promise`\<[`ReportChartLineOptions`](README.md#reportchartlineoptions)\> | - | - | [src/facades/interfaces.ts:51](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L51) | +| `tiles` | (`select`: `true` \| [`IDeviceModel`](README.md#idevicemodelt)\<`T`\>) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`T`\>\> & (`select`?: `false`) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`null`\>\> | [`IFacade`](README.md#ifacade).[`tiles`](README.md#tiles-4) | - | [src/facades/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L52) | +| `type` | `T` | - | `IBaseDeviceModel.type` | [src/models/interfaces.ts:32](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L32) | +| `values` | () => `Promise`\<[`GetDeviceData`](README.md#getdevicedatat)\<`T`\>\> | - | - | [src/facades/interfaces.ts:54](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L54) | --- ### IDeviceModel\ +Defined in: [src/models/interfaces.ts:41](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L41) + #### Extends - `IBaseDeviceModel`\<`T`\>.`ISubFloorModel` @@ -3026,24 +2982,26 @@ static create(config?: APIConfig): Promise #### Properties -| Property | Type | Inherited from | Defined in | -| ------------ | ------------------------------------------------------------------------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `area?` | `null` \| [`IAreaModel`](README.md#iareamodel) | - | [src/models/interfaces.ts:45](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L45) | -| `areaId` | `null` \| `number` | - | [src/models/interfaces.ts:44](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L44) | -| `building?` | [`IBuildingModel`](README.md#ibuildingmodel) | `ISubFloorModel.building` | [src/models/interfaces.ts:6](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L6) | -| `buildingId` | `number` | `ISubFloorModel.buildingId` | [src/models/interfaces.ts:5](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L5) | -| `data` | [`ListDeviceData`](README.md#listdevicedatat)\<`T`\> | `IBaseDeviceModel.data` | [src/models/interfaces.ts:31](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L31) | -| `floor?` | `null` \| [`IFloorModel`](README.md#ifloormodel) | `ISubFloorModel.floor` | [src/models/interfaces.ts:11](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L11) | -| `floorId` | `null` \| `number` | `ISubFloorModel.floorId` | [src/models/interfaces.ts:10](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L10) | -| `id` | `number` | `ISubFloorModel.id` | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L52) | -| `name` | `string` | `ISubFloorModel.name` | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L53) | -| `type` | `T` | `IBaseDeviceModel.type` | [src/models/interfaces.ts:32](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L32) | -| `update` | (`data`: `Partial`\<[`ListDeviceData`](README.md#listdevicedatat)\<`T`\>\>) => `void` | - | [src/models/interfaces.ts:46](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L46) | +| Property | Type | Inherited from | Defined in | +| -------------------------------------- | ------------------------------------------------------------------------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `area?` | `null` \| [`IAreaModel`](README.md#iareamodel) | - | [src/models/interfaces.ts:45](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L45) | +| `areaId` | `null` \| `number` | - | [src/models/interfaces.ts:44](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L44) | +| `building?` | [`IBuildingModel`](README.md#ibuildingmodel) | `ISubFloorModel.building` | [src/models/interfaces.ts:6](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L6) | +| `buildingId` | `number` | `ISubFloorModel.buildingId` | [src/models/interfaces.ts:5](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L5) | +| `data` | [`ListDeviceData`](README.md#listdevicedatat)\<`T`\> | `IBaseDeviceModel.data` | [src/models/interfaces.ts:31](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L31) | +| `floor?` | `null` \| [`IFloorModel`](README.md#ifloormodel) | `ISubFloorModel.floor` | [src/models/interfaces.ts:11](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L11) | +| `floorId` | `null` \| `number` | `ISubFloorModel.floorId` | [src/models/interfaces.ts:10](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L10) | +| `id` | `number` | `ISubFloorModel.id` | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L52) | +| `name` | `string` | `ISubFloorModel.name` | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L53) | +| `type` | `T` | `IBaseDeviceModel.type` | [src/models/interfaces.ts:32](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L32) | +| `update` | (`data`: `Partial`\<[`ListDeviceData`](README.md#listdevicedatat)\<`T`\>\>) => `void` | - | [src/models/interfaces.ts:46](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L46) | --- ### IFacade +Defined in: [src/facades/interfaces.ts:62](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L62) + #### Extends - [`IModel`](README.md#imodel) @@ -3055,71 +3013,79 @@ static create(config?: APIConfig): Promise #### Properties -| Property | Type | Inherited from | Defined in | -| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `devices` | [`IDeviceModelAny`](README.md#idevicemodelany)[] | - | [src/facades/interfaces.ts:63](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L63) | -| `errors` | (`query`: [`ErrorLogQuery`](README.md#errorlogquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`ErrorLog`](README.md#errorlog-1)\> | - | [src/facades/interfaces.ts:64](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L64) | -| `frostProtection` | () => `Promise`\<[`FrostProtectionData`](README.md#frostprotectiondata)\> | - | [src/facades/interfaces.ts:65](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L65) | -| `holidayMode` | () => `Promise`\<[`HolidayModeData`](README.md#holidaymodedata)\> | - | [src/facades/interfaces.ts:66](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L66) | -| `id` | `number` | [`IModel`](README.md#imodel).`id` | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L52) | -| `name` | `string` | [`IModel`](README.md#imodel).`name` | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L53) | -| `onSync` | (`params`?: \{ `type`: [`DeviceType`](README.md#devicetype); \}) => `Promise`\<`void`\> | - | [src/facades/interfaces.ts:67](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L67) | -| `setFrostProtection` | (`query`: [`FrostProtectionQuery`](README.md#frostprotectionquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | - | [src/facades/interfaces.ts:68](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L68) | -| `setHolidayMode` | (`query`: [`HolidayModeQuery`](README.md#holidaymodequery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | - | [src/facades/interfaces.ts:71](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L71) | -| `setPower` | (`value`?: `boolean`) => `Promise`\<`boolean`\> | - | [src/facades/interfaces.ts:74](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L74) | -| `signal` | (`hour`?: `HourNumbers`) => `Promise`\<[`ReportChartLineOptions`](README.md#reportchartlineoptions)\> | - | [src/facades/interfaces.ts:75](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L75) | -| `tiles` | (`select`?: `false`) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`null`\>\> & \<`T`\>(`select`: [`IDeviceModel`](README.md#idevicemodelt)\<`T`\>) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`T`\>\> | - | [src/facades/interfaces.ts:76](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L76) | +| Property | Type | Inherited from | Defined in | +| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `devices` | [`IDeviceModelAny`](README.md#idevicemodelany)[] | - | [src/facades/interfaces.ts:63](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L63) | +| `errors` | (`query`: [`ErrorLogQuery`](README.md#errorlogquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`ErrorLog`](README.md#errorlog-1)\> | - | [src/facades/interfaces.ts:64](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L64) | +| `frostProtection` | () => `Promise`\<[`FrostProtectionData`](README.md#frostprotectiondata)\> | - | [src/facades/interfaces.ts:65](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L65) | +| `holidayMode` | () => `Promise`\<[`HolidayModeData`](README.md#holidaymodedata)\> | - | [src/facades/interfaces.ts:66](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L66) | +| `id` | `number` | [`IModel`](README.md#imodel).[`id`](README.md#id-16) | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L52) | +| `name` | `string` | [`IModel`](README.md#imodel).[`name`](README.md#name-15) | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L53) | +| `onSync` | (`params`?: \{ `type`: [`DeviceType`](README.md#devicetype); \}) => `Promise`\<`void`\> | - | [src/facades/interfaces.ts:67](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L67) | +| `setFrostProtection` | (`query`: [`FrostProtectionQuery`](README.md#frostprotectionquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | - | [src/facades/interfaces.ts:68](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L68) | +| `setHolidayMode` | (`query`: [`HolidayModeQuery`](README.md#holidaymodequery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | - | [src/facades/interfaces.ts:71](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L71) | +| `setPower` | (`value`?: `boolean`) => `Promise`\<`boolean`\> | - | [src/facades/interfaces.ts:74](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L74) | +| `signal` | (`hour`?: `HourNumbers`) => `Promise`\<[`ReportChartLineOptions`](README.md#reportchartlineoptions)\> | - | [src/facades/interfaces.ts:75](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L75) | +| `tiles` | (`select`?: `false`) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`null`\>\> & \<`T`\>(`select`: [`IDeviceModel`](README.md#idevicemodelt)\<`T`\>) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`T`\>\> | - | [src/facades/interfaces.ts:76](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L76) | --- ### IFacadeManager +Defined in: [src/facades/interfaces.ts:80](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L80) + #### Properties -| Property | Type | Defined in | -| -------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `get` | (`instance`?: [`IModel`](README.md#imodel)) => `null` \| [`IFacade`](README.md#ifacade) | [src/facades/interfaces.ts:81](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L81) | +| Property | Type | Defined in | +| ------------------------ | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `get` | (`instance`?: [`IModel`](README.md#imodel)) => `null` \| [`IFacade`](README.md#ifacade) | [src/facades/interfaces.ts:81](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L81) | --- ### IFloorModel +Defined in: [src/models/interfaces.ts:49](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L49) + #### Extends - `ISubBuildingModel`.`ISuperAreaModel` #### Properties -| Property | Type | Inherited from | Defined in | -| ------------ | ------------------------------------------------ | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `areaIds` | `number`[] | `ISuperAreaModel.areaIds` | [src/models/interfaces.ts:15](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L15) | -| `areas` | [`IAreaModel`](README.md#iareamodel)[] | `ISuperAreaModel.areas` | [src/models/interfaces.ts:16](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L16) | -| `building?` | [`IBuildingModel`](README.md#ibuildingmodel) | `ISubBuildingModel.building` | [src/models/interfaces.ts:6](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L6) | -| `buildingId` | `number` | `ISubBuildingModel.buildingId` | [src/models/interfaces.ts:5](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L5) | -| `deviceIds` | `number`[] | `ISuperAreaModel.deviceIds` | [src/models/interfaces.ts:20](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L20) | -| `devices` | [`IDeviceModelAny`](README.md#idevicemodelany)[] | `ISuperAreaModel.devices` | [src/models/interfaces.ts:21](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L21) | -| `id` | `number` | `ISubBuildingModel.id` | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L52) | -| `name` | `string` | `ISubBuildingModel.name` | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L53) | +| Property | Type | Inherited from | Defined in | +| -------------------------------------- | ------------------------------------------------ | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `areaIds` | `number`[] | `ISuperAreaModel.areaIds` | [src/models/interfaces.ts:15](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L15) | +| `areas` | [`IAreaModel`](README.md#iareamodel)[] | `ISuperAreaModel.areas` | [src/models/interfaces.ts:16](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L16) | +| `building?` | [`IBuildingModel`](README.md#ibuildingmodel) | `ISubBuildingModel.building` | [src/models/interfaces.ts:6](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L6) | +| `buildingId` | `number` | `ISubBuildingModel.buildingId` | [src/models/interfaces.ts:5](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L5) | +| `deviceIds` | `number`[] | `ISuperAreaModel.deviceIds` | [src/models/interfaces.ts:20](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L20) | +| `devices` | [`IDeviceModelAny`](README.md#idevicemodelany)[] | `ISuperAreaModel.devices` | [src/models/interfaces.ts:21](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L21) | +| `id` | `number` | `ISubBuildingModel.id` | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L52) | +| `name` | `string` | `ISubBuildingModel.name` | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L53) | --- ### IModel +Defined in: [src/models/interfaces.ts:51](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L51) + #### Extended by - [`IFacade`](README.md#ifacade) #### Properties -| Property | Type | Defined in | -| -------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | `number` | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L52) | -| `name` | `string` | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L53) | +| Property | Type | Defined in | +| --------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | `number` | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L52) | +| `name` | `string` | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L53) | --- ### ISuperDeviceFacade +Defined in: [src/facades/interfaces.ts:84](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L84) + #### Extends - [`IFacade`](README.md#ifacade) @@ -3130,27 +3096,29 @@ static create(config?: APIConfig): Promise #### Properties -| Property | Type | Inherited from | Defined in | -| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `devices` | [`IDeviceModelAny`](README.md#idevicemodelany)[] | [`IFacade`](README.md#ifacade).`devices` | [src/facades/interfaces.ts:63](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L63) | -| `errors` | (`query`: [`ErrorLogQuery`](README.md#errorlogquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`ErrorLog`](README.md#errorlog-1)\> | [`IFacade`](README.md#ifacade).`errors` | [src/facades/interfaces.ts:64](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L64) | -| `frostProtection` | () => `Promise`\<[`FrostProtectionData`](README.md#frostprotectiondata)\> | [`IFacade`](README.md#ifacade).`frostProtection` | [src/facades/interfaces.ts:65](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L65) | -| `group` | () => `Promise`\<[`GroupState`](README.md#groupstate)\> | - | [src/facades/interfaces.ts:85](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L85) | -| `holidayMode` | () => `Promise`\<[`HolidayModeData`](README.md#holidaymodedata)\> | [`IFacade`](README.md#ifacade).`holidayMode` | [src/facades/interfaces.ts:66](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L66) | -| `id` | `number` | [`IFacade`](README.md#ifacade).`id` | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L52) | -| `name` | `string` | [`IFacade`](README.md#ifacade).`name` | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L53) | -| `onSync` | (`params`?: \{ `type`: [`DeviceType`](README.md#devicetype); \}) => `Promise`\<`void`\> | [`IFacade`](README.md#ifacade).`onSync` | [src/facades/interfaces.ts:67](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L67) | -| `setFrostProtection` | (`query`: [`FrostProtectionQuery`](README.md#frostprotectionquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | [`IFacade`](README.md#ifacade).`setFrostProtection` | [src/facades/interfaces.ts:68](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L68) | -| `setGroup` | (`state`: [`GroupState`](README.md#groupstate)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | - | [src/facades/interfaces.ts:86](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L86) | -| `setHolidayMode` | (`query`: [`HolidayModeQuery`](README.md#holidaymodequery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | [`IFacade`](README.md#ifacade).`setHolidayMode` | [src/facades/interfaces.ts:71](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L71) | -| `setPower` | (`value`?: `boolean`) => `Promise`\<`boolean`\> | [`IFacade`](README.md#ifacade).`setPower` | [src/facades/interfaces.ts:74](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L74) | -| `signal` | (`hour`?: `HourNumbers`) => `Promise`\<[`ReportChartLineOptions`](README.md#reportchartlineoptions)\> | [`IFacade`](README.md#ifacade).`signal` | [src/facades/interfaces.ts:75](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L75) | -| `tiles` | (`select`?: `false`) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`null`\>\> & \<`T`\>(`select`: [`IDeviceModel`](README.md#idevicemodelt)\<`T`\>) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`T`\>\> | [`IFacade`](README.md#ifacade).`tiles` | [src/facades/interfaces.ts:76](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L76) | +| Property | Type | Inherited from | Defined in | +| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `devices` | [`IDeviceModelAny`](README.md#idevicemodelany)[] | [`IFacade`](README.md#ifacade).[`devices`](README.md#devices-9) | [src/facades/interfaces.ts:63](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L63) | +| `errors` | (`query`: [`ErrorLogQuery`](README.md#errorlogquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`ErrorLog`](README.md#errorlog-1)\> | [`IFacade`](README.md#ifacade).[`errors`](README.md#errors-5) | [src/facades/interfaces.ts:64](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L64) | +| `frostProtection` | () => `Promise`\<[`FrostProtectionData`](README.md#frostprotectiondata)\> | [`IFacade`](README.md#ifacade).[`frostProtection`](README.md#frostprotection-4) | [src/facades/interfaces.ts:65](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L65) | +| `group` | () => `Promise`\<[`GroupState`](README.md#groupstate)\> | - | [src/facades/interfaces.ts:85](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L85) | +| `holidayMode` | () => `Promise`\<[`HolidayModeData`](README.md#holidaymodedata)\> | [`IFacade`](README.md#ifacade).[`holidayMode`](README.md#holidaymode-4) | [src/facades/interfaces.ts:66](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L66) | +| `id` | `number` | [`IFacade`](README.md#ifacade).[`id`](README.md#id-14) | [src/models/interfaces.ts:52](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L52) | +| `name` | `string` | [`IFacade`](README.md#ifacade).[`name`](README.md#name-13) | [src/models/interfaces.ts:53](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L53) | +| `onSync` | (`params`?: \{ `type`: [`DeviceType`](README.md#devicetype); \}) => `Promise`\<`void`\> | [`IFacade`](README.md#ifacade).[`onSync`](README.md#onsync-5) | [src/facades/interfaces.ts:67](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L67) | +| `setFrostProtection` | (`query`: [`FrostProtectionQuery`](README.md#frostprotectionquery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | [`IFacade`](README.md#ifacade).[`setFrostProtection`](README.md#setfrostprotection-4) | [src/facades/interfaces.ts:68](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L68) | +| `setGroup` | (`state`: [`GroupState`](README.md#groupstate)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | - | [src/facades/interfaces.ts:86](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L86) | +| `setHolidayMode` | (`query`: [`HolidayModeQuery`](README.md#holidaymodequery)) => `Promise`\< \| [`FailureData`](README.md#failuredata) \| [`SuccessData`](README.md#successdata)\> | [`IFacade`](README.md#ifacade).[`setHolidayMode`](README.md#setholidaymode-4) | [src/facades/interfaces.ts:71](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L71) | +| `setPower` | (`value`?: `boolean`) => `Promise`\<`boolean`\> | [`IFacade`](README.md#ifacade).[`setPower`](README.md#setpower-4) | [src/facades/interfaces.ts:74](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L74) | +| `signal` | (`hour`?: `HourNumbers`) => `Promise`\<[`ReportChartLineOptions`](README.md#reportchartlineoptions)\> | [`IFacade`](README.md#ifacade).[`signal`](README.md#signal-4) | [src/facades/interfaces.ts:75](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L75) | +| `tiles` | (`select`?: `false`) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`null`\>\> & \<`T`\>(`select`: [`IDeviceModel`](README.md#idevicemodelt)\<`T`\>) => `Promise`\<[`TilesData`](README.md#tilesdatat)\<`T`\>\> | [`IFacade`](README.md#ifacade).[`tiles`](README.md#tiles-4) | [src/facades/interfaces.ts:76](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L76) | --- ### ListDevice\ +Defined in: [src/types/common.ts:157](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L157) + #### Extends - `BaseListDevice` @@ -3163,492 +3131,542 @@ static create(config?: APIConfig): Promise #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ------------ | ---------- | ---------------------------------------------------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `AreaID` | `readonly` | `null` \| `number` | `BaseListDevice.AreaID` | [src/types/bases.ts:14](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L14) | -| `BuildingID` | `readonly` | `number` | `BaseListDevice.BuildingID` | [src/types/bases.ts:15](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L15) | -| `Device` | `readonly` | [`ListDeviceData`](README.md#listdevicedatat)\<`T`\> | - | [src/types/common.ts:158](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L158) | -| `DeviceID` | `readonly` | `number` | `BaseListDevice.DeviceID` | [src/types/bases.ts:16](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L16) | -| `DeviceName` | `readonly` | `string` | `BaseListDevice.DeviceName` | [src/types/bases.ts:17](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L17) | -| `FloorID` | `readonly` | `null` \| `number` | `BaseListDevice.FloorID` | [src/types/bases.ts:18](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L18) | -| `Type` | `readonly` | [`DeviceType`](README.md#devicetype) | `BaseListDevice.Type` | [src/types/bases.ts:19](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L19) | +| Property | Modifier | Type | Inherited from | Defined in | +| --------------------------------------- | ---------- | ---------------------------------------------------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `AreaID` | `readonly` | `null` \| `number` | `BaseListDevice.AreaID` | [src/types/bases.ts:14](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L14) | +| `BuildingID` | `readonly` | `number` | `BaseListDevice.BuildingID` | [src/types/bases.ts:15](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L15) | +| `Device` | `readonly` | [`ListDeviceData`](README.md#listdevicedatat)\<`T`\> | - | [src/types/common.ts:158](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L158) | +| `DeviceID` | `readonly` | `number` | `BaseListDevice.DeviceID` | [src/types/bases.ts:16](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L16) | +| `DeviceName` | `readonly` | `string` | `BaseListDevice.DeviceName` | [src/types/bases.ts:17](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L17) | +| `FloorID` | `readonly` | `null` \| `number` | `BaseListDevice.FloorID` | [src/types/bases.ts:18](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L18) | +| `Type` | `readonly` | [`DeviceType`](README.md#devicetype) | `BaseListDevice.Type` | [src/types/bases.ts:19](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L19) | --- ### ListDeviceDataAta +Defined in: [src/types/ata.ts:59](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L59) + #### Extends -- `BaseListDeviceData`.`Omit`\<[`GetDeviceData`](README.md#getdevicedatat)\<`DeviceType.Ata`\>, +- `BaseListDeviceData`.`Omit`\<[`GetDeviceData`](README.md#getdevicedatat)\<[`Ata`](README.md#ata)\>, \| [`KeyofSetDeviceDataAtaNotInList`](README.md#keyofsetdevicedataatanotinlist) \| keyof `DeviceDataNotInList`\>.[`SetDeviceDataAtaInList`](README.md#setdevicedataatainlist) #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ------------------------- | ---------- | ------------------------------------------ | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `ActualFanSpeed` | `readonly` | `number` | - | [src/types/ata.ts:66](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L66) | -| `DeviceType` | `readonly` | `Ata` | `Omit.DeviceType` | [src/types/ata.ts:80](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L80) | -| `EffectiveFlags` | `readonly` | `0` | `BaseListDeviceData.EffectiveFlags` | [src/types/bases.ts:10](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L10) | -| `FanSpeed` | `readonly` | [`FanSpeed`](README.md#fanspeed) | [`SetDeviceDataAtaInList`](README.md#setdevicedataatainlist).`FanSpeed` | [src/types/ata.ts:86](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L86) | -| `HasAutomaticFanSpeed` | `readonly` | `boolean` | - | [src/types/ata.ts:67](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L67) | -| `MaxTempAutomatic` | `readonly` | `number` | - | [src/types/ata.ts:68](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L68) | -| `MaxTempCoolDry` | `readonly` | `number` | - | [src/types/ata.ts:69](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L69) | -| `MaxTempHeat` | `readonly` | `number` | - | [src/types/ata.ts:70](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L70) | -| `MinTempAutomatic` | `readonly` | `number` | - | [src/types/ata.ts:71](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L71) | -| `MinTempCoolDry` | `readonly` | `number` | - | [src/types/ata.ts:72](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L72) | -| `MinTempHeat` | `readonly` | `number` | - | [src/types/ata.ts:73](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L73) | -| `NumberOfFanSpeeds` | `readonly` | `number` | `Omit.NumberOfFanSpeeds` | [src/types/ata.ts:81](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L81) | -| `Offline` | `readonly` | `boolean` | `BaseListDeviceData.Offline` | [src/types/bases.ts:31](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L31) | -| `OperationMode` | `readonly` | [`OperationMode`](README.md#operationmode) | `Omit.OperationMode` | [src/types/ata.ts:97](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L97) | -| `OutdoorTemperature` | `readonly` | `number` | - | [src/types/ata.ts:74](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L74) | -| `Power` | `readonly` | `boolean` | `BaseListDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L35) | -| `RoomTemperature` | `readonly` | `number` | `Omit.RoomTemperature` | [src/types/ata.ts:82](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L82) | -| `SetTemperature` | `readonly` | `number` | `Omit.SetTemperature` | [src/types/ata.ts:99](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L99) | -| `VaneHorizontalDirection` | `readonly` | [`Horizontal`](README.md#horizontal) | [`SetDeviceDataAtaInList`](README.md#setdevicedataatainlist).`VaneHorizontalDirection` | [src/types/ata.ts:87](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L87) | -| `VaneVerticalDirection` | `readonly` | [`Vertical`](README.md#vertical) | [`SetDeviceDataAtaInList`](README.md#setdevicedataatainlist).`VaneVerticalDirection` | [src/types/ata.ts:88](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L88) | -| `WifiSignalStrength` | `readonly` | `number` | `BaseListDeviceData.WifiSignalStrength` | [src/types/bases.ts:24](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L24) | +| Property | Modifier | Type | Inherited from | Defined in | +| ---------------------------------------------------------------- | ---------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `ActualFanSpeed` | `readonly` | `number` | - | [src/types/ata.ts:66](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L66) | +| `DeviceType` | `readonly` | [`Ata`](README.md#ata) | `Omit.DeviceType` | [src/types/ata.ts:80](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L80) | +| `EffectiveFlags` | `readonly` | `0` | `BaseListDeviceData.EffectiveFlags` | [src/types/bases.ts:10](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L10) | +| `FanSpeed` | `readonly` | [`FanSpeed`](README.md#fanspeed) | [`SetDeviceDataAtaInList`](README.md#setdevicedataatainlist).[`FanSpeed`](README.md#fanspeed-3) | [src/types/ata.ts:86](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L86) | +| `HasAutomaticFanSpeed` | `readonly` | `boolean` | - | [src/types/ata.ts:67](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L67) | +| `MaxTempAutomatic` | `readonly` | `number` | - | [src/types/ata.ts:68](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L68) | +| `MaxTempCoolDry` | `readonly` | `number` | - | [src/types/ata.ts:69](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L69) | +| `MaxTempHeat` | `readonly` | `number` | - | [src/types/ata.ts:70](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L70) | +| `MinTempAutomatic` | `readonly` | `number` | - | [src/types/ata.ts:71](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L71) | +| `MinTempCoolDry` | `readonly` | `number` | - | [src/types/ata.ts:72](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L72) | +| `MinTempHeat` | `readonly` | `number` | - | [src/types/ata.ts:73](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L73) | +| `NumberOfFanSpeeds` | `readonly` | `number` | `Omit.NumberOfFanSpeeds` | [src/types/ata.ts:81](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L81) | +| `Offline` | `readonly` | `boolean` | `BaseListDeviceData.Offline` | [src/types/bases.ts:31](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L31) | +| `OperationMode` | `readonly` | [`OperationMode`](README.md#operationmode) | `Omit.OperationMode` | [src/types/ata.ts:97](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L97) | +| `OutdoorTemperature` | `readonly` | `number` | - | [src/types/ata.ts:74](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L74) | +| `Power` | `readonly` | `boolean` | `BaseListDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L35) | +| `RoomTemperature` | `readonly` | `number` | `Omit.RoomTemperature` | [src/types/ata.ts:82](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L82) | +| `SetTemperature` | `readonly` | `number` | `Omit.SetTemperature` | [src/types/ata.ts:99](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L99) | +| `VaneHorizontalDirection` | `readonly` | [`Horizontal`](README.md#horizontal) | [`SetDeviceDataAtaInList`](README.md#setdevicedataatainlist).[`VaneHorizontalDirection`](README.md#vanehorizontaldirection-2) | [src/types/ata.ts:87](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L87) | +| `VaneVerticalDirection` | `readonly` | [`Vertical`](README.md#vertical) | [`SetDeviceDataAtaInList`](README.md#setdevicedataatainlist).[`VaneVerticalDirection`](README.md#vaneverticaldirection-2) | [src/types/ata.ts:88](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L88) | +| `WifiSignalStrength` | `readonly` | `number` | `BaseListDeviceData.WifiSignalStrength` | [src/types/bases.ts:24](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L24) | --- ### ListDeviceDataAtw +Defined in: [src/types/atw.ts:25](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L25) + #### Extends -- `BaseListDeviceData`.`Omit`\<[`GetDeviceData`](README.md#getdevicedatat)\<`DeviceType.Atw`\>, keyof `DeviceDataNotInList`\> +- `BaseListDeviceData`.`Omit`\<[`GetDeviceData`](README.md#getdevicedatat)\<[`Atw`](README.md#atw)\>, keyof `DeviceDataNotInList`\> #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ------------------------------ | ---------- | ---------------------------------------------------- | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `BoosterHeater1Status` | `readonly` | `boolean` | - | [src/types/atw.ts:28](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L28) | -| `BoosterHeater2PlusStatus` | `readonly` | `boolean` | - | [src/types/atw.ts:29](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L29) | -| `BoosterHeater2Status` | `readonly` | `boolean` | - | [src/types/atw.ts:30](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L30) | -| `CanCool` | `readonly` | `boolean` | - | [src/types/atw.ts:31](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L31) | -| `CondensingTemperature` | `readonly` | `number` | - | [src/types/atw.ts:32](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L32) | -| `CurrentEnergyConsumed` | `readonly` | `number` | - | [src/types/atw.ts:33](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L33) | -| `CurrentEnergyProduced` | `readonly` | `number` | - | [src/types/atw.ts:34](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L34) | -| `DefrostMode` | `readonly` | `number` | - | [src/types/atw.ts:35](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L35) | -| `DeviceType` | `readonly` | `Atw` | `Omit.DeviceType` | [src/types/atw.ts:65](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L65) | -| `EcoHotWater` | `readonly` | `boolean` | - | [src/types/atw.ts:36](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L36) | -| `EffectiveFlags` | `readonly` | `0` | `BaseListDeviceData.EffectiveFlags` | [src/types/bases.ts:10](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L10) | -| `FlowTemperature` | `readonly` | `number` | - | [src/types/atw.ts:37](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L37) | -| `FlowTemperatureZone1` | `readonly` | `number` | - | [src/types/atw.ts:38](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L38) | -| `FlowTemperatureZone2` | `readonly` | `number` | - | [src/types/atw.ts:39](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L39) | -| `ForcedHotWaterMode` | `readonly` | `boolean` | `Omit.ForcedHotWaterMode` | [src/types/atw.ts:94](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L94) | -| `HasZone2` | `readonly` | `boolean` | - | [src/types/atw.ts:40](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L40) | -| `HeatPumpFrequency` | `readonly` | `number` | - | [src/types/atw.ts:41](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L41) | -| `IdleZone1` | `readonly` | `boolean` | `Omit.IdleZone1` | [src/types/atw.ts:66](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L66) | -| `IdleZone2` | `readonly` | `boolean` | `Omit.IdleZone2` | [src/types/atw.ts:67](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L67) | -| `ImmersionHeaterStatus` | `readonly` | `boolean` | - | [src/types/atw.ts:42](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L42) | -| `LastLegionellaActivationTime` | `readonly` | `string` | - | [src/types/atw.ts:43](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L43) | -| `MaxTankTemperature` | `readonly` | `number` | - | [src/types/atw.ts:44](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L44) | -| `MixingTankWaterTemperature` | `readonly` | `number` | - | [src/types/atw.ts:45](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L45) | -| `Offline` | `readonly` | `boolean` | `BaseListDeviceData.Offline` | [src/types/bases.ts:31](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L31) | -| `OperationMode` | `readonly` | [`OperationModeState`](README.md#operationmodestate) | `Omit.OperationMode` | [src/types/atw.ts:68](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L68) | -| `OperationModeZone1` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | `Omit.OperationModeZone1` | [src/types/atw.ts:58](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L58) | -| `OperationModeZone2` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | `Omit.OperationModeZone2` | [src/types/atw.ts:59](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L59) | -| `OutdoorTemperature` | `readonly` | `number` | `Omit.OutdoorTemperature` | [src/types/atw.ts:69](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L69) | -| `Power` | `readonly` | `boolean` | `BaseListDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L35) | -| `ProhibitCoolingZone1` | `readonly` | `boolean` | `Omit.ProhibitCoolingZone1` | [src/types/atw.ts:70](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L70) | -| `ProhibitCoolingZone2` | `readonly` | `boolean` | `Omit.ProhibitCoolingZone2` | [src/types/atw.ts:71](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L71) | -| `ProhibitHeatingZone1` | `readonly` | `boolean` | `Omit.ProhibitHeatingZone1` | [src/types/atw.ts:72](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L72) | -| `ProhibitHeatingZone2` | `readonly` | `boolean` | `Omit.ProhibitHeatingZone2` | [src/types/atw.ts:73](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L73) | -| `ProhibitHotWater` | `readonly` | `boolean` | `Omit.ProhibitHotWater` | [src/types/atw.ts:74](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L74) | -| `ReturnTemperature` | `readonly` | `number` | - | [src/types/atw.ts:46](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L46) | -| `ReturnTemperatureZone1` | `readonly` | `number` | - | [src/types/atw.ts:47](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L47) | -| `ReturnTemperatureZone2` | `readonly` | `number` | - | [src/types/atw.ts:48](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L48) | -| `RoomTemperatureZone1` | `readonly` | `number` | `Omit.RoomTemperatureZone1` | [src/types/atw.ts:75](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L75) | -| `RoomTemperatureZone2` | `readonly` | `number` | `Omit.RoomTemperatureZone2` | [src/types/atw.ts:76](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L76) | -| `SetCoolFlowTemperatureZone1` | `readonly` | `number` | `Omit.SetCoolFlowTemperatureZone1` | [src/types/atw.ts:81](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L81) | -| `SetCoolFlowTemperatureZone2` | `readonly` | `number` | `Omit.SetCoolFlowTemperatureZone2` | [src/types/atw.ts:82](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L82) | -| `SetHeatFlowTemperatureZone1` | `readonly` | `number` | `Omit.SetHeatFlowTemperatureZone1` | [src/types/atw.ts:83](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L83) | -| `SetHeatFlowTemperatureZone2` | `readonly` | `number` | `Omit.SetHeatFlowTemperatureZone2` | [src/types/atw.ts:84](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L84) | -| `SetTankWaterTemperature` | `readonly` | `number` | `Omit.SetTankWaterTemperature` | [src/types/atw.ts:85](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L85) | -| `SetTemperatureZone1` | `readonly` | `number` | `Omit.SetTemperatureZone1` | [src/types/atw.ts:86](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L86) | -| `SetTemperatureZone2` | `readonly` | `number` | `Omit.SetTemperatureZone2` | [src/types/atw.ts:87](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L87) | -| `TankWaterTemperature` | `readonly` | `number` | `Omit.TankWaterTemperature` | [src/types/atw.ts:77](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L77) | -| `TargetHCTemperatureZone1` | `readonly` | `number` | - | [src/types/atw.ts:49](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L49) | -| `TargetHCTemperatureZone2` | `readonly` | `number` | - | [src/types/atw.ts:50](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L50) | -| `WifiSignalStrength` | `readonly` | `number` | `BaseListDeviceData.WifiSignalStrength` | [src/types/bases.ts:24](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L24) | -| `Zone1InCoolMode` | `readonly` | `boolean` | - | [src/types/atw.ts:51](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L51) | -| `Zone1InHeatMode` | `readonly` | `boolean` | - | [src/types/atw.ts:52](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L52) | -| `Zone2InCoolMode` | `readonly` | `boolean` | - | [src/types/atw.ts:53](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L53) | -| `Zone2InHeatMode` | `readonly` | `boolean` | - | [src/types/atw.ts:54](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L54) | +| Property | Modifier | Type | Inherited from | Defined in | +| ------------------------------------------------------------------------ | ---------- | ---------------------------------------------------- | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `BoosterHeater1Status` | `readonly` | `boolean` | - | [src/types/atw.ts:28](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L28) | +| `BoosterHeater2PlusStatus` | `readonly` | `boolean` | - | [src/types/atw.ts:29](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L29) | +| `BoosterHeater2Status` | `readonly` | `boolean` | - | [src/types/atw.ts:30](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L30) | +| `CanCool` | `readonly` | `boolean` | - | [src/types/atw.ts:31](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L31) | +| `CondensingTemperature` | `readonly` | `number` | - | [src/types/atw.ts:32](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L32) | +| `CurrentEnergyConsumed` | `readonly` | `number` | - | [src/types/atw.ts:33](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L33) | +| `CurrentEnergyProduced` | `readonly` | `number` | - | [src/types/atw.ts:34](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L34) | +| `DefrostMode` | `readonly` | `number` | - | [src/types/atw.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L35) | +| `DeviceType` | `readonly` | [`Atw`](README.md#atw) | `Omit.DeviceType` | [src/types/atw.ts:65](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L65) | +| `EcoHotWater` | `readonly` | `boolean` | - | [src/types/atw.ts:36](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L36) | +| `EffectiveFlags` | `readonly` | `0` | `BaseListDeviceData.EffectiveFlags` | [src/types/bases.ts:10](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L10) | +| `FlowTemperature` | `readonly` | `number` | - | [src/types/atw.ts:37](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L37) | +| `FlowTemperatureZone1` | `readonly` | `number` | - | [src/types/atw.ts:38](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L38) | +| `FlowTemperatureZone2` | `readonly` | `number` | - | [src/types/atw.ts:39](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L39) | +| `ForcedHotWaterMode` | `readonly` | `boolean` | `Omit.ForcedHotWaterMode` | [src/types/atw.ts:94](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L94) | +| `HasZone2` | `readonly` | `boolean` | - | [src/types/atw.ts:40](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L40) | +| `HeatPumpFrequency` | `readonly` | `number` | - | [src/types/atw.ts:41](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L41) | +| `IdleZone1` | `readonly` | `boolean` | `Omit.IdleZone1` | [src/types/atw.ts:66](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L66) | +| `IdleZone2` | `readonly` | `boolean` | `Omit.IdleZone2` | [src/types/atw.ts:67](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L67) | +| `ImmersionHeaterStatus` | `readonly` | `boolean` | - | [src/types/atw.ts:42](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L42) | +| `LastLegionellaActivationTime` | `readonly` | `string` | - | [src/types/atw.ts:43](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L43) | +| `MaxTankTemperature` | `readonly` | `number` | - | [src/types/atw.ts:44](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L44) | +| `MixingTankWaterTemperature` | `readonly` | `number` | - | [src/types/atw.ts:45](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L45) | +| `Offline` | `readonly` | `boolean` | `BaseListDeviceData.Offline` | [src/types/bases.ts:31](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L31) | +| `OperationMode` | `readonly` | [`OperationModeState`](README.md#operationmodestate) | `Omit.OperationMode` | [src/types/atw.ts:68](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L68) | +| `OperationModeZone1` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | `Omit.OperationModeZone1` | [src/types/atw.ts:58](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L58) | +| `OperationModeZone2` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | `Omit.OperationModeZone2` | [src/types/atw.ts:59](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L59) | +| `OutdoorTemperature` | `readonly` | `number` | `Omit.OutdoorTemperature` | [src/types/atw.ts:69](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L69) | +| `Power` | `readonly` | `boolean` | `BaseListDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L35) | +| `ProhibitCoolingZone1` | `readonly` | `boolean` | `Omit.ProhibitCoolingZone1` | [src/types/atw.ts:70](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L70) | +| `ProhibitCoolingZone2` | `readonly` | `boolean` | `Omit.ProhibitCoolingZone2` | [src/types/atw.ts:71](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L71) | +| `ProhibitHeatingZone1` | `readonly` | `boolean` | `Omit.ProhibitHeatingZone1` | [src/types/atw.ts:72](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L72) | +| `ProhibitHeatingZone2` | `readonly` | `boolean` | `Omit.ProhibitHeatingZone2` | [src/types/atw.ts:73](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L73) | +| `ProhibitHotWater` | `readonly` | `boolean` | `Omit.ProhibitHotWater` | [src/types/atw.ts:74](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L74) | +| `ReturnTemperature` | `readonly` | `number` | - | [src/types/atw.ts:46](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L46) | +| `ReturnTemperatureZone1` | `readonly` | `number` | - | [src/types/atw.ts:47](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L47) | +| `ReturnTemperatureZone2` | `readonly` | `number` | - | [src/types/atw.ts:48](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L48) | +| `RoomTemperatureZone1` | `readonly` | `number` | `Omit.RoomTemperatureZone1` | [src/types/atw.ts:75](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L75) | +| `RoomTemperatureZone2` | `readonly` | `number` | `Omit.RoomTemperatureZone2` | [src/types/atw.ts:76](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L76) | +| `SetCoolFlowTemperatureZone1` | `readonly` | `number` | `Omit.SetCoolFlowTemperatureZone1` | [src/types/atw.ts:81](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L81) | +| `SetCoolFlowTemperatureZone2` | `readonly` | `number` | `Omit.SetCoolFlowTemperatureZone2` | [src/types/atw.ts:82](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L82) | +| `SetHeatFlowTemperatureZone1` | `readonly` | `number` | `Omit.SetHeatFlowTemperatureZone1` | [src/types/atw.ts:83](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L83) | +| `SetHeatFlowTemperatureZone2` | `readonly` | `number` | `Omit.SetHeatFlowTemperatureZone2` | [src/types/atw.ts:84](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L84) | +| `SetTankWaterTemperature` | `readonly` | `number` | `Omit.SetTankWaterTemperature` | [src/types/atw.ts:85](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L85) | +| `SetTemperatureZone1` | `readonly` | `number` | `Omit.SetTemperatureZone1` | [src/types/atw.ts:86](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L86) | +| `SetTemperatureZone2` | `readonly` | `number` | `Omit.SetTemperatureZone2` | [src/types/atw.ts:87](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L87) | +| `TankWaterTemperature` | `readonly` | `number` | `Omit.TankWaterTemperature` | [src/types/atw.ts:77](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L77) | +| `TargetHCTemperatureZone1` | `readonly` | `number` | - | [src/types/atw.ts:49](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L49) | +| `TargetHCTemperatureZone2` | `readonly` | `number` | - | [src/types/atw.ts:50](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L50) | +| `WifiSignalStrength` | `readonly` | `number` | `BaseListDeviceData.WifiSignalStrength` | [src/types/bases.ts:24](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L24) | +| `Zone1InCoolMode` | `readonly` | `boolean` | - | [src/types/atw.ts:51](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L51) | +| `Zone1InHeatMode` | `readonly` | `boolean` | - | [src/types/atw.ts:52](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L52) | +| `Zone2InCoolMode` | `readonly` | `boolean` | - | [src/types/atw.ts:53](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L53) | +| `Zone2InHeatMode` | `readonly` | `boolean` | - | [src/types/atw.ts:54](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L54) | --- ### ListDeviceDataErv +Defined in: [src/types/erv.ts:11](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L11) + #### Extends -- `BaseListDeviceData`.`Omit`\<[`GetDeviceData`](README.md#getdevicedatat)\<`DeviceType.Erv`\>, keyof `DeviceDataNotInList`\> +- `BaseListDeviceData`.`Omit`\<[`GetDeviceData`](README.md#getdevicedatat)\<[`Erv`](README.md#erv)\>, keyof `DeviceDataNotInList`\> #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ---------------------- | ---------- | ---------------------------------------------------------------------- | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `DeviceType` | `readonly` | `Erv` | `Omit.DeviceType` | [src/types/erv.ts:23](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L23) | -| `EffectiveFlags` | `readonly` | `0` | `BaseListDeviceData.EffectiveFlags` | [src/types/bases.ts:10](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L10) | -| `HasAutomaticFanSpeed` | `readonly` | `boolean` | - | [src/types/erv.ts:14](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L14) | -| `HasCO2Sensor` | `readonly` | `boolean` | - | [src/types/erv.ts:15](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L15) | -| `HasPM25Sensor` | `readonly` | `boolean` | - | [src/types/erv.ts:16](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L16) | -| `NumberOfFanSpeeds` | `readonly` | `number` | `Omit.NumberOfFanSpeeds` | [src/types/erv.ts:24](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L24) | -| `Offline` | `readonly` | `boolean` | `BaseListDeviceData.Offline` | [src/types/bases.ts:31](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L31) | -| `OutdoorTemperature` | `readonly` | `number` | `Omit.OutdoorTemperature` | [src/types/erv.ts:25](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L25) | -| `PM25Level` | `readonly` | `number` | - | [src/types/erv.ts:17](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L17) | -| `Power` | `readonly` | `boolean` | `BaseListDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L35) | -| `RoomCO2Level` | `readonly` | `number` | `Omit.RoomCO2Level` | [src/types/erv.ts:26](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L26) | -| `RoomTemperature` | `readonly` | `number` | `Omit.RoomTemperature` | [src/types/erv.ts:27](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L27) | -| `SetFanSpeed` | `readonly` | `auto` \| `fast` \| `moderate` \| `slow` \| `very_fast` \| `very_slow` | `Omit.SetFanSpeed` | [src/types/erv.ts:31](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L31) | -| `VentilationMode` | `readonly` | [`VentilationMode`](README.md#ventilationmode) | `Omit.VentilationMode` | [src/types/erv.ts:32](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L32) | -| `WifiSignalStrength` | `readonly` | `number` | `BaseListDeviceData.WifiSignalStrength` | [src/types/bases.ts:24](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L24) | +| Property | Modifier | Type | Inherited from | Defined in | +| ---------------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `DeviceType` | `readonly` | [`Erv`](README.md#erv) | `Omit.DeviceType` | [src/types/erv.ts:23](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L23) | +| `EffectiveFlags` | `readonly` | `0` | `BaseListDeviceData.EffectiveFlags` | [src/types/bases.ts:10](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L10) | +| `HasAutomaticFanSpeed` | `readonly` | `boolean` | - | [src/types/erv.ts:14](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L14) | +| `HasCO2Sensor` | `readonly` | `boolean` | - | [src/types/erv.ts:15](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L15) | +| `HasPM25Sensor` | `readonly` | `boolean` | - | [src/types/erv.ts:16](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L16) | +| `NumberOfFanSpeeds` | `readonly` | `number` | `Omit.NumberOfFanSpeeds` | [src/types/erv.ts:24](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L24) | +| `Offline` | `readonly` | `boolean` | `BaseListDeviceData.Offline` | [src/types/bases.ts:31](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L31) | +| `OutdoorTemperature` | `readonly` | `number` | `Omit.OutdoorTemperature` | [src/types/erv.ts:25](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L25) | +| `PM25Level` | `readonly` | `number` | - | [src/types/erv.ts:17](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L17) | +| `Power` | `readonly` | `boolean` | `BaseListDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L35) | +| `RoomCO2Level` | `readonly` | `number` | `Omit.RoomCO2Level` | [src/types/erv.ts:26](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L26) | +| `RoomTemperature` | `readonly` | `number` | `Omit.RoomTemperature` | [src/types/erv.ts:27](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L27) | +| `SetFanSpeed` | `readonly` | \| [`auto`](README.md#auto) \| [`fast`](README.md#fast) \| [`moderate`](README.md#moderate) \| [`slow`](README.md#slow) \| [`very_fast`](README.md#very_fast) \| [`very_slow`](README.md#very_slow) | `Omit.SetFanSpeed` | [src/types/erv.ts:31](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L31) | +| `VentilationMode` | `readonly` | [`VentilationMode`](README.md#ventilationmode) | `Omit.VentilationMode` | [src/types/erv.ts:32](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L32) | +| `WifiSignalStrength` | `readonly` | `number` | `BaseListDeviceData.WifiSignalStrength` | [src/types/bases.ts:24](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L24) | --- ### Logger +Defined in: [src/services/interfaces.ts:201](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L201) + #### Properties -| Property | Type | Defined in | -| -------- | ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `error` | (`message`?: `any`, ...`optionalParams`: `any`[]) => `void` | [src/services/interfaces.ts:202](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L202) | -| `log` | (`message`?: `any`, ...`optionalParams`: `any`[]) => `void` | [src/services/interfaces.ts:203](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L203) | +| Property | Type | Defined in | +| ---------------------------- | ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `error` | (`message`?: `any`, ...`optionalParams`: `any`[]) => `void` | [src/services/interfaces.ts:202](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L202) | +| `log` | (`message`?: `any`, ...`optionalParams`: `any`[]) => `void` | [src/services/interfaces.ts:203](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L203) | --- ### LoginCredentials +Defined in: [src/types/common.ts:161](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L161) + #### Properties -| Property | Modifier | Type | Defined in | -| ---------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `password` | `readonly` | `string` | [src/types/common.ts:162](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L162) | -| `username` | `readonly` | `string` | [src/types/common.ts:163](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L163) | +| Property | Modifier | Type | Defined in | +| ---------------------------------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `password` | `readonly` | `string` | [src/types/common.ts:162](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L162) | +| `username` | `readonly` | `string` | [src/types/common.ts:163](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L163) | --- ### LoginData +Defined in: [src/types/common.ts:166](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L166) + #### Properties -| Property | Modifier | Type | Defined in | -| ----------- | ---------- | -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `LoginData` | `readonly` | \| `null` \| \{ `ContextKey`: `string`; `Expiry`: `string`; \} | [src/types/common.ts:167](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L167) | +| Property | Modifier | Type | Defined in | +| ------------------------------------ | ---------- | -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `LoginData` | `readonly` | \| `null` \| \{ `ContextKey`: `string`; `Expiry`: `string`; \} | [src/types/common.ts:167](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L167) | --- ### LoginPostData +Defined in: [src/types/common.ts:173](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L173) + #### Properties -| Property | Modifier | Type | Defined in | -| ------------ | ---------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `AppVersion` | `readonly` | `string` | [src/types/common.ts:174](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L174) | -| `Email` | `readonly` | `string` | [src/types/common.ts:175](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L175) | -| `Language?` | `readonly` | `number` | [src/types/common.ts:177](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L177) | -| `Password` | `readonly` | `string` | [src/types/common.ts:176](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L176) | -| `Persist?` | `readonly` | `boolean` | [src/types/common.ts:178](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L178) | +| Property | Modifier | Type | Defined in | +| ------------------------------------ | ---------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `AppVersion` | `readonly` | `string` | [src/types/common.ts:174](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L174) | +| `Email` | `readonly` | `string` | [src/types/common.ts:175](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L175) | +| `Language?` | `readonly` | `number` | [src/types/common.ts:177](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L177) | +| `Password` | `readonly` | `string` | [src/types/common.ts:176](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L176) | +| `Persist?` | `readonly` | `boolean` | [src/types/common.ts:178](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L178) | --- ### OperationModeZoneDataAtw +Defined in: [src/types/atw.ts:57](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L57) + #### Extended by - [`UpdateDeviceDataAtw`](README.md#updatedevicedataatw) #### Properties -| Property | Modifier | Type | Defined in | -| --------------------- | ---------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `OperationModeZone1?` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | [src/types/atw.ts:58](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L58) | -| `OperationModeZone2?` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | [src/types/atw.ts:59](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L59) | +| Property | Modifier | Type | Defined in | +| ------------------------------------------------------- | ---------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `OperationModeZone1?` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | [src/types/atw.ts:58](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L58) | +| `OperationModeZone2?` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | [src/types/atw.ts:59](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L59) | --- ### ReportChartLineOptions +Defined in: [src/facades/interfaces.ts:89](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L89) + #### Extends - `ReportChartOptions` #### Properties -| Property | Type | Inherited from | Defined in | -| -------- | --------------------------------------------------------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `from` | `string` | `ReportChartOptions.from` | [src/facades/interfaces.ts:98](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L98) | -| `labels` | `string`[] | `ReportChartOptions.labels` | [src/facades/interfaces.ts:99](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L99) | -| `series` | \{ `data`: (`null` \| `number`)[]; `name`: `string`; \}[] | - | [src/facades/interfaces.ts:90](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L90) | -| `to` | `string` | `ReportChartOptions.to` | [src/facades/interfaces.ts:100](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L100) | -| `unit` | `string` | - | [src/facades/interfaces.ts:94](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L94) | +| Property | Type | Inherited from | Defined in | +| ---------------------------- | --------------------------------------------------------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `from` | `string` | `ReportChartOptions.from` | [src/facades/interfaces.ts:98](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L98) | +| `labels` | `string`[] | `ReportChartOptions.labels` | [src/facades/interfaces.ts:99](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L99) | +| `series` | \{ `data`: (`null` \| `number`)[]; `name`: `string`; \}[] | - | [src/facades/interfaces.ts:90](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L90) | +| `to` | `string` | `ReportChartOptions.to` | [src/facades/interfaces.ts:100](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L100) | +| `unit` | `string` | - | [src/facades/interfaces.ts:94](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L94) | --- ### ReportChartPieOptions +Defined in: [src/facades/interfaces.ts:103](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L103) + #### Extends - `ReportChartOptions` #### Properties -| Property | Type | Inherited from | Defined in | -| -------- | ---------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `from` | `string` | `ReportChartOptions.from` | [src/facades/interfaces.ts:98](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L98) | -| `labels` | `string`[] | `ReportChartOptions.labels` | [src/facades/interfaces.ts:99](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L99) | -| `series` | `number`[] | - | [src/facades/interfaces.ts:104](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L104) | -| `to` | `string` | `ReportChartOptions.to` | [src/facades/interfaces.ts:100](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L100) | +| Property | Type | Inherited from | Defined in | +| ------------------------------ | ---------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `from` | `string` | `ReportChartOptions.from` | [src/facades/interfaces.ts:98](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L98) | +| `labels` | `string`[] | `ReportChartOptions.labels` | [src/facades/interfaces.ts:99](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L99) | +| `series` | `number`[] | - | [src/facades/interfaces.ts:104](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L104) | +| `to` | `string` | `ReportChartOptions.to` | [src/facades/interfaces.ts:100](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L100) | --- ### ReportData +Defined in: [src/types/common.ts:181](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L181) + #### Properties -| Property | Modifier | Type | Defined in | -| ----------- | ---------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | `readonly` | readonly readonly (`null` \| `number`)[][] | [src/types/common.ts:182](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L182) | -| `FromDate` | `readonly` | `string` | [src/types/common.ts:183](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L183) | -| `Labels` | `readonly` | readonly `string`[] | [src/types/common.ts:184](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L184) | -| `LabelType` | `readonly` | [`LabelType`](README.md#labeltype) | [src/types/common.ts:185](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L185) | -| `Points` | `readonly` | `number` | [src/types/common.ts:186](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L186) | -| `Series` | `readonly` | `number` | [src/types/common.ts:187](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L187) | -| `ToDate` | `readonly` | `string` | [src/types/common.ts:188](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L188) | +| Property | Modifier | Type | Defined in | +| ------------------------------------ | ---------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `Data` | `readonly` | readonly readonly (`null` \| `number`)[][] | [src/types/common.ts:182](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L182) | +| `FromDate` | `readonly` | `string` | [src/types/common.ts:183](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L183) | +| `Labels` | `readonly` | readonly `string`[] | [src/types/common.ts:184](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L184) | +| `LabelType` | `readonly` | [`LabelType`](README.md#labeltype) | [src/types/common.ts:185](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L185) | +| `Points` | `readonly` | `number` | [src/types/common.ts:186](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L186) | +| `Series` | `readonly` | `number` | [src/types/common.ts:187](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L187) | +| `ToDate` | `readonly` | `string` | [src/types/common.ts:188](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L188) | --- ### ReportPostData +Defined in: [src/types/common.ts:191](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L191) + #### Extended by - [`TemperatureLogPostData`](README.md#temperaturelogpostdata) #### Properties -| Property | Modifier | Type | Defined in | -| ----------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `DeviceID` | `readonly` | `number` | [src/types/common.ts:192](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L192) | -| `Duration?` | `readonly` | `number` | [src/types/common.ts:195](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L195) | -| `FromDate` | `readonly` | `string` | [src/types/common.ts:193](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L193) | -| `ToDate` | `readonly` | `string` | [src/types/common.ts:194](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L194) | +| Property | Modifier | Type | Defined in | +| ----------------------------------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `DeviceID` | `readonly` | `number` | [src/types/common.ts:192](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L192) | +| `Duration?` | `readonly` | `number` | [src/types/common.ts:195](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L195) | +| `FromDate` | `readonly` | `string` | [src/types/common.ts:193](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L193) | +| `ToDate` | `readonly` | `string` | [src/types/common.ts:194](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L194) | --- ### ReportQuery +Defined in: [src/facades/interfaces.ts:107](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L107) + #### Properties -| Property | Type | Defined in | -| -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `from?` | `string` | [src/facades/interfaces.ts:108](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L108) | -| `to?` | `string` | [src/facades/interfaces.ts:109](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L109) | +| Property | Type | Defined in | +| --------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `from?` | `string` | [src/facades/interfaces.ts:108](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L108) | +| `to?` | `string` | [src/facades/interfaces.ts:109](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L109) | --- ### SetDeviceDataAta +Defined in: [src/types/ata.ts:77](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L77) + #### Extends - `BaseSetDeviceData`.`Required`\<[`UpdateDeviceDataAta`](README.md#updatedevicedataata)\> #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ------------------- | ---------- | ---------------------------------------------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `DeviceType` | `readonly` | `Ata` | - | [src/types/ata.ts:80](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L80) | -| `EffectiveFlags` | `readonly` | `number` | `BaseSetDeviceData.EffectiveFlags` | [src/types/bases.ts:30](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L30) | -| `LastCommunication` | `readonly` | `string` | `BaseSetDeviceData.LastCommunication` | [src/types/bases.ts:39](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L39) | -| `NextCommunication` | `readonly` | `string` | `BaseSetDeviceData.NextCommunication` | [src/types/bases.ts:40](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L40) | -| `NumberOfFanSpeeds` | `readonly` | `number` | - | [src/types/ata.ts:81](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L81) | -| `Offline` | `readonly` | `boolean` | `BaseSetDeviceData.Offline` | [src/types/bases.ts:31](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L31) | -| `OperationMode` | `readonly` | [`OperationMode`](README.md#operationmode) | `Required.OperationMode` | [src/types/ata.ts:97](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L97) | -| `Power` | `readonly` | `boolean` | `BaseSetDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L35) | -| `RoomTemperature` | `readonly` | `number` | - | [src/types/ata.ts:82](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L82) | -| `SetFanSpeed` | `readonly` | `auto` \| `fast` \| `moderate` \| `slow` \| `very_fast` \| `very_slow` | `Required.SetFanSpeed` | [src/types/ata.ts:98](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L98) | -| `SetTemperature` | `readonly` | `number` | `Required.SetTemperature` | [src/types/ata.ts:99](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L99) | -| `VaneHorizontal` | `readonly` | [`Horizontal`](README.md#horizontal) | `Required.VaneHorizontal` | [src/types/ata.ts:100](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L100) | -| `VaneVertical` | `readonly` | [`Vertical`](README.md#vertical) | `Required.VaneVertical` | [src/types/ata.ts:101](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L101) | +| Property | Modifier | Type | Inherited from | Defined in | +| ---------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `DeviceType` | `readonly` | [`Ata`](README.md#ata) | - | [src/types/ata.ts:80](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L80) | +| `EffectiveFlags` | `readonly` | `number` | `BaseSetDeviceData.EffectiveFlags` | [src/types/bases.ts:30](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L30) | +| `LastCommunication` | `readonly` | `string` | `BaseSetDeviceData.LastCommunication` | [src/types/bases.ts:39](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L39) | +| `NextCommunication` | `readonly` | `string` | `BaseSetDeviceData.NextCommunication` | [src/types/bases.ts:40](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L40) | +| `NumberOfFanSpeeds` | `readonly` | `number` | - | [src/types/ata.ts:81](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L81) | +| `Offline` | `readonly` | `boolean` | `BaseSetDeviceData.Offline` | [src/types/bases.ts:31](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L31) | +| `OperationMode` | `readonly` | [`OperationMode`](README.md#operationmode) | `Required.OperationMode` | [src/types/ata.ts:97](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L97) | +| `Power` | `readonly` | `boolean` | `BaseSetDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L35) | +| `RoomTemperature` | `readonly` | `number` | - | [src/types/ata.ts:82](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L82) | +| `SetFanSpeed` | `readonly` | \| [`auto`](README.md#auto) \| [`fast`](README.md#fast) \| [`moderate`](README.md#moderate) \| [`slow`](README.md#slow) \| [`very_fast`](README.md#very_fast) \| [`very_slow`](README.md#very_slow) | `Required.SetFanSpeed` | [src/types/ata.ts:98](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L98) | +| `SetTemperature` | `readonly` | `number` | `Required.SetTemperature` | [src/types/ata.ts:99](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L99) | +| `VaneHorizontal` | `readonly` | [`Horizontal`](README.md#horizontal) | `Required.VaneHorizontal` | [src/types/ata.ts:100](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L100) | +| `VaneVertical` | `readonly` | [`Vertical`](README.md#vertical) | `Required.VaneVertical` | [src/types/ata.ts:101](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L101) | --- ### SetDeviceDataAtaInList +Defined in: [src/types/ata.ts:85](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L85) + #### Extended by - [`ListDeviceDataAta`](README.md#listdevicedataata) #### Properties -| Property | Modifier | Type | Defined in | -| ------------------------- | ---------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `FanSpeed` | `readonly` | [`FanSpeed`](README.md#fanspeed) | [src/types/ata.ts:86](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L86) | -| `VaneHorizontalDirection` | `readonly` | [`Horizontal`](README.md#horizontal) | [src/types/ata.ts:87](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L87) | -| `VaneVerticalDirection` | `readonly` | [`Vertical`](README.md#vertical) | [src/types/ata.ts:88](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L88) | +| Property | Modifier | Type | Defined in | +| ---------------------------------------------------------------- | ---------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `FanSpeed` | `readonly` | [`FanSpeed`](README.md#fanspeed) | [src/types/ata.ts:86](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L86) | +| `VaneHorizontalDirection` | `readonly` | [`Horizontal`](README.md#horizontal) | [src/types/ata.ts:87](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L87) | +| `VaneVerticalDirection` | `readonly` | [`Vertical`](README.md#vertical) | [src/types/ata.ts:88](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L88) | --- ### SetDeviceDataAtw +Defined in: [src/types/atw.ts:62](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L62) + #### Extends - `BaseSetDeviceData`.`Required`\<[`UpdateDeviceDataAtw`](README.md#updatedevicedataatw)\> #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ----------------------------- | ---------- | ---------------------------------------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `DeviceType` | `readonly` | `Atw` | - | [src/types/atw.ts:65](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L65) | -| `EffectiveFlags` | `readonly` | `number` | `BaseSetDeviceData.EffectiveFlags` | [src/types/bases.ts:30](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L30) | -| `ForcedHotWaterMode` | `readonly` | `boolean` | `Required.ForcedHotWaterMode` | [src/types/atw.ts:94](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L94) | -| `IdleZone1` | `readonly` | `boolean` | - | [src/types/atw.ts:66](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L66) | -| `IdleZone2` | `readonly` | `boolean` | - | [src/types/atw.ts:67](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L67) | -| `LastCommunication` | `readonly` | `string` | `BaseSetDeviceData.LastCommunication` | [src/types/bases.ts:39](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L39) | -| `NextCommunication` | `readonly` | `string` | `BaseSetDeviceData.NextCommunication` | [src/types/bases.ts:40](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L40) | -| `Offline` | `readonly` | `boolean` | `BaseSetDeviceData.Offline` | [src/types/bases.ts:31](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L31) | -| `OperationMode` | `readonly` | [`OperationModeState`](README.md#operationmodestate) | - | [src/types/atw.ts:68](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L68) | -| `OperationModeZone1` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | `Required.OperationModeZone1` | [src/types/atw.ts:58](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L58) | -| `OperationModeZone2` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | `Required.OperationModeZone2` | [src/types/atw.ts:59](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L59) | -| `OutdoorTemperature` | `readonly` | `number` | - | [src/types/atw.ts:69](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L69) | -| `Power` | `readonly` | `boolean` | `BaseSetDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L35) | -| `ProhibitCoolingZone1` | `readonly` | `boolean` | - | [src/types/atw.ts:70](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L70) | -| `ProhibitCoolingZone2` | `readonly` | `boolean` | - | [src/types/atw.ts:71](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L71) | -| `ProhibitHeatingZone1` | `readonly` | `boolean` | - | [src/types/atw.ts:72](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L72) | -| `ProhibitHeatingZone2` | `readonly` | `boolean` | - | [src/types/atw.ts:73](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L73) | -| `ProhibitHotWater` | `readonly` | `boolean` | - | [src/types/atw.ts:74](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L74) | -| `RoomTemperatureZone1` | `readonly` | `number` | - | [src/types/atw.ts:75](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L75) | -| `RoomTemperatureZone2` | `readonly` | `number` | - | [src/types/atw.ts:76](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L76) | -| `SetCoolFlowTemperatureZone1` | `readonly` | `number` | `Required.SetCoolFlowTemperatureZone1` | [src/types/atw.ts:81](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L81) | -| `SetCoolFlowTemperatureZone2` | `readonly` | `number` | `Required.SetCoolFlowTemperatureZone2` | [src/types/atw.ts:82](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L82) | -| `SetHeatFlowTemperatureZone1` | `readonly` | `number` | `Required.SetHeatFlowTemperatureZone1` | [src/types/atw.ts:83](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L83) | -| `SetHeatFlowTemperatureZone2` | `readonly` | `number` | `Required.SetHeatFlowTemperatureZone2` | [src/types/atw.ts:84](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L84) | -| `SetTankWaterTemperature` | `readonly` | `number` | `Required.SetTankWaterTemperature` | [src/types/atw.ts:85](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L85) | -| `SetTemperatureZone1` | `readonly` | `number` | `Required.SetTemperatureZone1` | [src/types/atw.ts:86](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L86) | -| `SetTemperatureZone2` | `readonly` | `number` | `Required.SetTemperatureZone2` | [src/types/atw.ts:87](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L87) | -| `TankWaterTemperature` | `readonly` | `number` | - | [src/types/atw.ts:77](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L77) | +| Property | Modifier | Type | Inherited from | Defined in | +| ------------------------------------------------------------------------ | ---------- | ---------------------------------------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `DeviceType` | `readonly` | [`Atw`](README.md#atw) | - | [src/types/atw.ts:65](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L65) | +| `EffectiveFlags` | `readonly` | `number` | `BaseSetDeviceData.EffectiveFlags` | [src/types/bases.ts:30](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L30) | +| `ForcedHotWaterMode` | `readonly` | `boolean` | `Required.ForcedHotWaterMode` | [src/types/atw.ts:94](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L94) | +| `IdleZone1` | `readonly` | `boolean` | - | [src/types/atw.ts:66](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L66) | +| `IdleZone2` | `readonly` | `boolean` | - | [src/types/atw.ts:67](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L67) | +| `LastCommunication` | `readonly` | `string` | `BaseSetDeviceData.LastCommunication` | [src/types/bases.ts:39](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L39) | +| `NextCommunication` | `readonly` | `string` | `BaseSetDeviceData.NextCommunication` | [src/types/bases.ts:40](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L40) | +| `Offline` | `readonly` | `boolean` | `BaseSetDeviceData.Offline` | [src/types/bases.ts:31](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L31) | +| `OperationMode` | `readonly` | [`OperationModeState`](README.md#operationmodestate) | - | [src/types/atw.ts:68](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L68) | +| `OperationModeZone1` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | `Required.OperationModeZone1` | [src/types/atw.ts:58](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L58) | +| `OperationModeZone2` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | `Required.OperationModeZone2` | [src/types/atw.ts:59](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L59) | +| `OutdoorTemperature` | `readonly` | `number` | - | [src/types/atw.ts:69](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L69) | +| `Power` | `readonly` | `boolean` | `BaseSetDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L35) | +| `ProhibitCoolingZone1` | `readonly` | `boolean` | - | [src/types/atw.ts:70](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L70) | +| `ProhibitCoolingZone2` | `readonly` | `boolean` | - | [src/types/atw.ts:71](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L71) | +| `ProhibitHeatingZone1` | `readonly` | `boolean` | - | [src/types/atw.ts:72](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L72) | +| `ProhibitHeatingZone2` | `readonly` | `boolean` | - | [src/types/atw.ts:73](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L73) | +| `ProhibitHotWater` | `readonly` | `boolean` | - | [src/types/atw.ts:74](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L74) | +| `RoomTemperatureZone1` | `readonly` | `number` | - | [src/types/atw.ts:75](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L75) | +| `RoomTemperatureZone2` | `readonly` | `number` | - | [src/types/atw.ts:76](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L76) | +| `SetCoolFlowTemperatureZone1` | `readonly` | `number` | `Required.SetCoolFlowTemperatureZone1` | [src/types/atw.ts:81](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L81) | +| `SetCoolFlowTemperatureZone2` | `readonly` | `number` | `Required.SetCoolFlowTemperatureZone2` | [src/types/atw.ts:82](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L82) | +| `SetHeatFlowTemperatureZone1` | `readonly` | `number` | `Required.SetHeatFlowTemperatureZone1` | [src/types/atw.ts:83](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L83) | +| `SetHeatFlowTemperatureZone2` | `readonly` | `number` | `Required.SetHeatFlowTemperatureZone2` | [src/types/atw.ts:84](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L84) | +| `SetTankWaterTemperature` | `readonly` | `number` | `Required.SetTankWaterTemperature` | [src/types/atw.ts:85](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L85) | +| `SetTemperatureZone1` | `readonly` | `number` | `Required.SetTemperatureZone1` | [src/types/atw.ts:86](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L86) | +| `SetTemperatureZone2` | `readonly` | `number` | `Required.SetTemperatureZone2` | [src/types/atw.ts:87](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L87) | +| `TankWaterTemperature` | `readonly` | `number` | - | [src/types/atw.ts:77](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L77) | --- ### SetDeviceDataErv +Defined in: [src/types/erv.ts:20](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L20) + #### Extends - `BaseSetDeviceData`.`Required`\<[`UpdateDeviceDataErv`](README.md#updatedevicedataerv)\> #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| -------------------- | ---------- | ---------------------------------------------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `DeviceType` | `readonly` | `Erv` | - | [src/types/erv.ts:23](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L23) | -| `EffectiveFlags` | `readonly` | `number` | `BaseSetDeviceData.EffectiveFlags` | [src/types/bases.ts:30](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L30) | -| `LastCommunication` | `readonly` | `string` | `BaseSetDeviceData.LastCommunication` | [src/types/bases.ts:39](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L39) | -| `NextCommunication` | `readonly` | `string` | `BaseSetDeviceData.NextCommunication` | [src/types/bases.ts:40](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L40) | -| `NumberOfFanSpeeds` | `readonly` | `number` | - | [src/types/erv.ts:24](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L24) | -| `Offline` | `readonly` | `boolean` | `BaseSetDeviceData.Offline` | [src/types/bases.ts:31](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L31) | -| `OutdoorTemperature` | `readonly` | `number` | - | [src/types/erv.ts:25](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L25) | -| `Power` | `readonly` | `boolean` | `BaseSetDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L35) | -| `RoomCO2Level` | `readonly` | `number` | - | [src/types/erv.ts:26](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L26) | -| `RoomTemperature` | `readonly` | `number` | - | [src/types/erv.ts:27](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L27) | -| `SetFanSpeed` | `readonly` | `auto` \| `fast` \| `moderate` \| `slow` \| `very_fast` \| `very_slow` | `Required.SetFanSpeed` | [src/types/erv.ts:31](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L31) | -| `VentilationMode` | `readonly` | [`VentilationMode`](README.md#ventilationmode) | `Required.VentilationMode` | [src/types/erv.ts:32](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L32) | +| Property | Modifier | Type | Inherited from | Defined in | +| ------------------------------------------------------ | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `DeviceType` | `readonly` | [`Erv`](README.md#erv) | - | [src/types/erv.ts:23](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L23) | +| `EffectiveFlags` | `readonly` | `number` | `BaseSetDeviceData.EffectiveFlags` | [src/types/bases.ts:30](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L30) | +| `LastCommunication` | `readonly` | `string` | `BaseSetDeviceData.LastCommunication` | [src/types/bases.ts:39](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L39) | +| `NextCommunication` | `readonly` | `string` | `BaseSetDeviceData.NextCommunication` | [src/types/bases.ts:40](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L40) | +| `NumberOfFanSpeeds` | `readonly` | `number` | - | [src/types/erv.ts:24](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L24) | +| `Offline` | `readonly` | `boolean` | `BaseSetDeviceData.Offline` | [src/types/bases.ts:31](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L31) | +| `OutdoorTemperature` | `readonly` | `number` | - | [src/types/erv.ts:25](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L25) | +| `Power` | `readonly` | `boolean` | `BaseSetDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L35) | +| `RoomCO2Level` | `readonly` | `number` | - | [src/types/erv.ts:26](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L26) | +| `RoomTemperature` | `readonly` | `number` | - | [src/types/erv.ts:27](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L27) | +| `SetFanSpeed` | `readonly` | \| [`auto`](README.md#auto) \| [`fast`](README.md#fast) \| [`moderate`](README.md#moderate) \| [`slow`](README.md#slow) \| [`very_fast`](README.md#very_fast) \| [`very_slow`](README.md#very_slow) | `Required.SetFanSpeed` | [src/types/erv.ts:31](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L31) | +| `VentilationMode` | `readonly` | [`VentilationMode`](README.md#ventilationmode) | `Required.VentilationMode` | [src/types/erv.ts:32](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L32) | --- ### SetGroupPostData +Defined in: [src/types/ata.ts:91](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L91) + #### Properties -| Property | Modifier | Type | Defined in | -| --------------- | ---------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `Specification` | `readonly` | [`GetGroupPostData`](README.md#getgrouppostdata) | [src/types/ata.ts:92](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L92) | -| `State` | `readonly` | [`GroupState`](README.md#groupstate) | [src/types/ata.ts:93](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L93) | +| Property | Modifier | Type | Defined in | +| ------------------------------------------ | ---------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `Specification` | `readonly` | [`GetGroupPostData`](README.md#getgrouppostdata) | [src/types/ata.ts:92](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L92) | +| `State` | `readonly` | [`GroupState`](README.md#groupstate) | [src/types/ata.ts:93](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L93) | --- ### SetPowerPostData +Defined in: [src/types/common.ts:198](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L198) + #### Properties -| Property | Modifier | Type | Defined in | -| ----------- | ---------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `DeviceIds` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:199](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L199) | -| `Power` | `readonly` | `boolean` | [src/types/common.ts:200](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L200) | +| Property | Modifier | Type | Defined in | +| ------------------------------------ | ---------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `DeviceIds` | `readonly` | `number` \| readonly `number`[] | [src/types/common.ts:199](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L199) | +| `Power` | `readonly` | `boolean` | [src/types/common.ts:200](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L200) | --- ### SettingManager +Defined in: [src/services/interfaces.ts:206](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L206) + #### Properties -| Property | Type | Defined in | -| -------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `get` | \<`T`\>(`key`: `T`) => [`APISettings`](README.md#apisettings)\[`T`\] | [src/services/interfaces.ts:207](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L207) | -| `set` | \<`T`\>(`key`: `T`, `value`: [`APISettings`](README.md#apisettings)\[`T`\]) => `void` | [src/services/interfaces.ts:208](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L208) | +| Property | Type | Defined in | +| ------------------------ | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `get` | \<`T`\>(`key`: `T`) => [`APISettings`](README.md#apisettings)\[`T`\] | [src/services/interfaces.ts:207](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L207) | +| `set` | \<`T`\>(`key`: `T`, `value`: [`APISettings`](README.md#apisettings)\[`T`\]) => `void` | [src/services/interfaces.ts:208](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L208) | --- ### SettingsParams +Defined in: [src/types/common.ts:203](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L203) + #### Properties -| Property | Modifier | Type | Defined in | -| ----------- | ---------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | `readonly` | `number` | [src/types/common.ts:204](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L204) | -| `tableName` | `readonly` | `"Area"` \| `"Building"` \| `"DeviceLocation"` \| `"Floor"` | [src/types/common.ts:205](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L205) | +| Property | Modifier | Type | Defined in | +| ---------------------------------- | ---------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | `readonly` | `number` | [src/types/common.ts:204](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L204) | +| `tableName` | `readonly` | `"Area"` \| `"Building"` \| `"DeviceLocation"` \| `"Floor"` | [src/types/common.ts:205](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L205) | --- ### SuccessData +Defined in: [src/types/common.ts:208](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L208) + #### Properties -| Property | Modifier | Type | Defined in | -| ----------------- | ---------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `AttributeErrors` | `readonly` | `null` | [src/types/common.ts:209](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L209) | -| `Success` | `readonly` | `true` | [src/types/common.ts:210](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L210) | +| Property | Modifier | Type | Defined in | +| ------------------------------------------------ | ---------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `AttributeErrors` | `readonly` | `null` | [src/types/common.ts:209](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L209) | +| `Success` | `readonly` | `true` | [src/types/common.ts:210](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L210) | --- ### TemperatureDataAtw +Defined in: [src/types/atw.ts:80](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L80) + #### Extended by - [`UpdateDeviceDataAtw`](README.md#updatedevicedataatw) #### Properties -| Property | Modifier | Type | Defined in | -| ------------------------------ | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `SetCoolFlowTemperatureZone1?` | `readonly` | `number` | [src/types/atw.ts:81](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L81) | -| `SetCoolFlowTemperatureZone2?` | `readonly` | `number` | [src/types/atw.ts:82](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L82) | -| `SetHeatFlowTemperatureZone1?` | `readonly` | `number` | [src/types/atw.ts:83](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L83) | -| `SetHeatFlowTemperatureZone2?` | `readonly` | `number` | [src/types/atw.ts:84](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L84) | -| `SetTankWaterTemperature?` | `readonly` | `number` | [src/types/atw.ts:85](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L85) | -| `SetTemperatureZone1?` | `readonly` | `number` | [src/types/atw.ts:86](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L86) | -| `SetTemperatureZone2?` | `readonly` | `number` | [src/types/atw.ts:87](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L87) | +| Property | Modifier | Type | Defined in | +| ------------------------------------------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `SetCoolFlowTemperatureZone1?` | `readonly` | `number` | [src/types/atw.ts:81](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L81) | +| `SetCoolFlowTemperatureZone2?` | `readonly` | `number` | [src/types/atw.ts:82](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L82) | +| `SetHeatFlowTemperatureZone1?` | `readonly` | `number` | [src/types/atw.ts:83](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L83) | +| `SetHeatFlowTemperatureZone2?` | `readonly` | `number` | [src/types/atw.ts:84](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L84) | +| `SetTankWaterTemperature?` | `readonly` | `number` | [src/types/atw.ts:85](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L85) | +| `SetTemperatureZone1?` | `readonly` | `number` | [src/types/atw.ts:86](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L86) | +| `SetTemperatureZone2?` | `readonly` | `number` | [src/types/atw.ts:87](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L87) | --- ### TemperatureLogPostData +Defined in: [src/types/common.ts:213](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L213) + #### Extends - [`ReportPostData`](README.md#reportpostdata) #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ----------- | ---------- | -------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `DeviceID` | `readonly` | `number` | [`ReportPostData`](README.md#reportpostdata).`DeviceID` | [src/types/common.ts:192](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L192) | -| `Duration?` | `readonly` | `number` | [`ReportPostData`](README.md#reportpostdata).`Duration` | [src/types/common.ts:195](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L195) | -| `FromDate` | `readonly` | `string` | [`ReportPostData`](README.md#reportpostdata).`FromDate` | [src/types/common.ts:193](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L193) | -| `Location?` | `readonly` | `number` | - | [src/types/common.ts:214](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L214) | -| `ToDate` | `readonly` | `string` | [`ReportPostData`](README.md#reportpostdata).`ToDate` | [src/types/common.ts:194](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L194) | +| Property | Modifier | Type | Inherited from | Defined in | +| ----------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `DeviceID` | `readonly` | `number` | [`ReportPostData`](README.md#reportpostdata).[`DeviceID`](README.md#deviceid-4) | [src/types/common.ts:192](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L192) | +| `Duration?` | `readonly` | `number` | [`ReportPostData`](README.md#reportpostdata).[`Duration`](README.md#duration-1) | [src/types/common.ts:195](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L195) | +| `FromDate` | `readonly` | `string` | [`ReportPostData`](README.md#reportpostdata).[`FromDate`](README.md#fromdate-3) | [src/types/common.ts:193](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L193) | +| `Location?` | `readonly` | `number` | - | [src/types/common.ts:214](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L214) | +| `ToDate` | `readonly` | `string` | [`ReportPostData`](README.md#reportpostdata).[`ToDate`](README.md#todate-3) | [src/types/common.ts:194](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L194) | --- ### TilesData\ +Defined in: [src/types/common.ts:217](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L217) + #### Type Parameters | Type Parameter | @@ -3657,74 +3675,82 @@ static create(config?: APIConfig): Promise #### Properties -| Property | Modifier | Type | Defined in | -| ---------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `SelectedDevice` | `readonly` | `T` _extends_ [`DeviceType`](README.md#devicetype) ? [`GetDeviceData`](README.md#getdevicedatat)\<`T`\<`T`\>\> : `null` | [src/types/common.ts:218](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L218) | -| `Tiles` | `readonly` | readonly \{ `Device`: `number`; `Offline`: `boolean`; `Power`: `boolean`; `RoomTemperature`: `number`; `RoomTemperature2`: `number`; `TankWaterTemperature`: `number`; \}[] | [src/types/common.ts:219](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L219) | +| Property | Modifier | Type | Defined in | +| -------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `SelectedDevice` | `readonly` | `T` _extends_ [`DeviceType`](README.md#devicetype) ? [`GetDeviceData`](README.md#getdevicedatat)\<`T`\<`T`\>\> : `null` | [src/types/common.ts:218](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L218) | +| `Tiles` | `readonly` | readonly \{ `Device`: `number`; `Offline`: `boolean`; `Power`: `boolean`; `RoomTemperature`: `number`; `RoomTemperature2`: `number`; `TankWaterTemperature`: `number`; \}[] | [src/types/common.ts:219](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L219) | --- ### UpdateDeviceDataAta +Defined in: [src/types/ata.ts:96](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L96) + #### Extends - `BaseUpdateDeviceData` #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ----------------- | ---------- | ---------------------------------------------------------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `OperationMode?` | `readonly` | [`OperationMode`](README.md#operationmode) | - | [src/types/ata.ts:97](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L97) | -| `Power?` | `readonly` | `boolean` | `BaseUpdateDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L35) | -| `SetFanSpeed?` | `readonly` | `auto` \| `fast` \| `moderate` \| `slow` \| `very_fast` \| `very_slow` | - | [src/types/ata.ts:98](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L98) | -| `SetTemperature?` | `readonly` | `number` | - | [src/types/ata.ts:99](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L99) | -| `VaneHorizontal?` | `readonly` | [`Horizontal`](README.md#horizontal) | - | [src/types/ata.ts:100](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L100) | -| `VaneVertical?` | `readonly` | [`Vertical`](README.md#vertical) | - | [src/types/ata.ts:101](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L101) | +| Property | Modifier | Type | Inherited from | Defined in | +| ----------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `OperationMode?` | `readonly` | [`OperationMode`](README.md#operationmode) | - | [src/types/ata.ts:97](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L97) | +| `Power?` | `readonly` | `boolean` | `BaseUpdateDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L35) | +| `SetFanSpeed?` | `readonly` | \| [`auto`](README.md#auto) \| [`fast`](README.md#fast) \| [`moderate`](README.md#moderate) \| [`slow`](README.md#slow) \| [`very_fast`](README.md#very_fast) \| [`very_slow`](README.md#very_slow) | - | [src/types/ata.ts:98](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L98) | +| `SetTemperature?` | `readonly` | `number` | - | [src/types/ata.ts:99](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L99) | +| `VaneHorizontal?` | `readonly` | [`Horizontal`](README.md#horizontal) | - | [src/types/ata.ts:100](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L100) | +| `VaneVertical?` | `readonly` | [`Vertical`](README.md#vertical) | - | [src/types/ata.ts:101](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L101) | --- ### UpdateDeviceDataAtw +Defined in: [src/types/atw.ts:90](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L90) + #### Extends - `BaseUpdateDeviceData`.[`OperationModeZoneDataAtw`](README.md#operationmodezonedataatw).[`TemperatureDataAtw`](README.md#temperaturedataatw) #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ------------------------------ | ---------- | -------------------------------------------------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `ForcedHotWaterMode?` | `readonly` | `boolean` | - | [src/types/atw.ts:94](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L94) | -| `OperationModeZone1?` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | [`OperationModeZoneDataAtw`](README.md#operationmodezonedataatw).`OperationModeZone1` | [src/types/atw.ts:58](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L58) | -| `OperationModeZone2?` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | [`OperationModeZoneDataAtw`](README.md#operationmodezonedataatw).`OperationModeZone2` | [src/types/atw.ts:59](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L59) | -| `Power?` | `readonly` | `boolean` | `BaseUpdateDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L35) | -| `SetCoolFlowTemperatureZone1?` | `readonly` | `number` | [`TemperatureDataAtw`](README.md#temperaturedataatw).`SetCoolFlowTemperatureZone1` | [src/types/atw.ts:81](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L81) | -| `SetCoolFlowTemperatureZone2?` | `readonly` | `number` | [`TemperatureDataAtw`](README.md#temperaturedataatw).`SetCoolFlowTemperatureZone2` | [src/types/atw.ts:82](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L82) | -| `SetHeatFlowTemperatureZone1?` | `readonly` | `number` | [`TemperatureDataAtw`](README.md#temperaturedataatw).`SetHeatFlowTemperatureZone1` | [src/types/atw.ts:83](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L83) | -| `SetHeatFlowTemperatureZone2?` | `readonly` | `number` | [`TemperatureDataAtw`](README.md#temperaturedataatw).`SetHeatFlowTemperatureZone2` | [src/types/atw.ts:84](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L84) | -| `SetTankWaterTemperature?` | `readonly` | `number` | [`TemperatureDataAtw`](README.md#temperaturedataatw).`SetTankWaterTemperature` | [src/types/atw.ts:85](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L85) | -| `SetTemperatureZone1?` | `readonly` | `number` | [`TemperatureDataAtw`](README.md#temperaturedataatw).`SetTemperatureZone1` | [src/types/atw.ts:86](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L86) | -| `SetTemperatureZone2?` | `readonly` | `number` | [`TemperatureDataAtw`](README.md#temperaturedataatw).`SetTemperatureZone2` | [src/types/atw.ts:87](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L87) | +| Property | Modifier | Type | Inherited from | Defined in | +| ------------------------------------------------------------------------- | ---------- | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `ForcedHotWaterMode?` | `readonly` | `boolean` | - | [src/types/atw.ts:94](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L94) | +| `OperationModeZone1?` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | [`OperationModeZoneDataAtw`](README.md#operationmodezonedataatw).[`OperationModeZone1`](README.md#operationmodezone1-1) | [src/types/atw.ts:58](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L58) | +| `OperationModeZone2?` | `readonly` | [`OperationModeZone`](README.md#operationmodezone) | [`OperationModeZoneDataAtw`](README.md#operationmodezonedataatw).[`OperationModeZone2`](README.md#operationmodezone2-1) | [src/types/atw.ts:59](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L59) | +| `Power?` | `readonly` | `boolean` | `BaseUpdateDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L35) | +| `SetCoolFlowTemperatureZone1?` | `readonly` | `number` | [`TemperatureDataAtw`](README.md#temperaturedataatw).[`SetCoolFlowTemperatureZone1`](README.md#setcoolflowtemperaturezone1-2) | [src/types/atw.ts:81](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L81) | +| `SetCoolFlowTemperatureZone2?` | `readonly` | `number` | [`TemperatureDataAtw`](README.md#temperaturedataatw).[`SetCoolFlowTemperatureZone2`](README.md#setcoolflowtemperaturezone2-2) | [src/types/atw.ts:82](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L82) | +| `SetHeatFlowTemperatureZone1?` | `readonly` | `number` | [`TemperatureDataAtw`](README.md#temperaturedataatw).[`SetHeatFlowTemperatureZone1`](README.md#setheatflowtemperaturezone1-2) | [src/types/atw.ts:83](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L83) | +| `SetHeatFlowTemperatureZone2?` | `readonly` | `number` | [`TemperatureDataAtw`](README.md#temperaturedataatw).[`SetHeatFlowTemperatureZone2`](README.md#setheatflowtemperaturezone2-2) | [src/types/atw.ts:84](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L84) | +| `SetTankWaterTemperature?` | `readonly` | `number` | [`TemperatureDataAtw`](README.md#temperaturedataatw).[`SetTankWaterTemperature`](README.md#settankwatertemperature-2) | [src/types/atw.ts:85](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L85) | +| `SetTemperatureZone1?` | `readonly` | `number` | [`TemperatureDataAtw`](README.md#temperaturedataatw).[`SetTemperatureZone1`](README.md#settemperaturezone1-2) | [src/types/atw.ts:86](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L86) | +| `SetTemperatureZone2?` | `readonly` | `number` | [`TemperatureDataAtw`](README.md#temperaturedataatw).[`SetTemperatureZone2`](README.md#settemperaturezone2-2) | [src/types/atw.ts:87](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L87) | --- ### UpdateDeviceDataErv +Defined in: [src/types/erv.ts:30](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L30) + #### Extends - `BaseUpdateDeviceData` #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ------------------ | ---------- | ---------------------------------------------------------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `Power?` | `readonly` | `boolean` | `BaseUpdateDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/bases.ts#L35) | -| `SetFanSpeed?` | `readonly` | `auto` \| `fast` \| `moderate` \| `slow` \| `very_fast` \| `very_slow` | - | [src/types/erv.ts:31](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L31) | -| `VentilationMode?` | `readonly` | [`VentilationMode`](README.md#ventilationmode) | - | [src/types/erv.ts:32](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/erv.ts#L32) | +| Property | Modifier | Type | Inherited from | Defined in | +| ------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `Power?` | `readonly` | `boolean` | `BaseUpdateDeviceData.Power` | [src/types/bases.ts:35](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/bases.ts#L35) | +| `SetFanSpeed?` | `readonly` | \| [`auto`](README.md#auto) \| [`fast`](README.md#fast) \| [`moderate`](README.md#moderate) \| [`slow`](README.md#slow) \| [`very_fast`](README.md#very_fast) \| [`very_slow`](README.md#very_slow) | - | [src/types/erv.ts:31](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L31) | +| `VentilationMode?` | `readonly` | [`VentilationMode`](README.md#ventilationmode) | - | [src/types/erv.ts:32](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/erv.ts#L32) | --- ### ZoneSettings +Defined in: [src/types/common.ts:229](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L229) + #### Extends - [`FrostProtectionData`](README.md#frostprotectiondata).`Omit`\<[`HolidayModeData`](README.md#holidaymodedata), `"EndDate"` \| `"StartDate"`\> @@ -3735,17 +3761,17 @@ static create(config?: APIConfig): Promise #### Properties -| Property | Modifier | Type | Inherited from | Defined in | -| ------------------ | ---------- | ------------------ | ------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `FPDefined` | `readonly` | `boolean` | [`FrostProtectionData`](README.md#frostprotectiondata).`FPDefined` | [src/types/common.ts:86](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L86) | -| `FPEnabled` | `readonly` | `boolean` | [`FrostProtectionData`](README.md#frostprotectiondata).`FPEnabled` | [src/types/common.ts:87](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L87) | -| `FPMaxTemperature` | `readonly` | `number` | [`FrostProtectionData`](README.md#frostprotectiondata).`FPMaxTemperature` | [src/types/common.ts:88](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L88) | -| `FPMinTemperature` | `readonly` | `number` | [`FrostProtectionData`](README.md#frostprotectiondata).`FPMinTemperature` | [src/types/common.ts:89](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L89) | -| `HMDefined` | `readonly` | `boolean` | `Omit.HMDefined` | [src/types/common.ts:123](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L123) | -| `HMEnabled` | `readonly` | `boolean` | `Omit.HMEnabled` | [src/types/common.ts:124](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L124) | -| `HMEndDate` | `readonly` | `null` \| `string` | `Omit.HMEndDate` | [src/types/common.ts:125](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L125) | -| `HMStartDate` | `readonly` | `null` \| `string` | `Omit.HMStartDate` | [src/types/common.ts:126](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L126) | -| `TimeZone` | `readonly` | `number` | `Omit.TimeZone` | [src/types/common.ts:135](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L135) | +| Property | Modifier | Type | Inherited from | Defined in | +| -------------------------------------------------- | ---------- | ------------------ | --------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `FPDefined` | `readonly` | `boolean` | [`FrostProtectionData`](README.md#frostprotectiondata).[`FPDefined`](README.md#fpdefined-2) | [src/types/common.ts:86](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L86) | +| `FPEnabled` | `readonly` | `boolean` | [`FrostProtectionData`](README.md#frostprotectiondata).[`FPEnabled`](README.md#fpenabled-2) | [src/types/common.ts:87](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L87) | +| `FPMaxTemperature` | `readonly` | `number` | [`FrostProtectionData`](README.md#frostprotectiondata).[`FPMaxTemperature`](README.md#fpmaxtemperature-2) | [src/types/common.ts:88](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L88) | +| `FPMinTemperature` | `readonly` | `number` | [`FrostProtectionData`](README.md#frostprotectiondata).[`FPMinTemperature`](README.md#fpmintemperature-2) | [src/types/common.ts:89](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L89) | +| `HMDefined` | `readonly` | `boolean` | `Omit.HMDefined` | [src/types/common.ts:123](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L123) | +| `HMEnabled` | `readonly` | `boolean` | `Omit.HMEnabled` | [src/types/common.ts:124](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L124) | +| `HMEndDate` | `readonly` | `null` \| `string` | `Omit.HMEndDate` | [src/types/common.ts:125](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L125) | +| `HMStartDate` | `readonly` | `null` \| `string` | `Omit.HMStartDate` | [src/types/common.ts:126](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L126) | +| `TimeZone` | `readonly` | `number` | `Omit.TimeZone` | [src/types/common.ts:135](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L135) | ## Type Aliases @@ -3755,9 +3781,7 @@ static create(config?: APIConfig): Promise type AreaDataAny = AreaData | AreaData ``` -#### Defined in - -[src/types/common.ts:233](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L233) +Defined in: [src/types/common.ts:233](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L233) --- @@ -3774,9 +3798,7 @@ type DateTimeComponents = { } | null ``` -#### Defined in - -[src/types/common.ts:235](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L235) +Defined in: [src/types/common.ts:235](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L235) --- @@ -3784,21 +3806,19 @@ type DateTimeComponents = { ```ts type EnergyData = - T extends DeviceType.Ata ? EnergyDataAta - : T extends DeviceType.Atw ? EnergyDataAtw + T extends Ata ? EnergyDataAta + : T extends Atw ? EnergyDataAtw : never ``` +Defined in: [src/types/common.ts:244](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L244) + #### Type Parameters | Type Parameter | | -------------------------------------------------- | | `T` _extends_ [`DeviceType`](README.md#devicetype) | -#### Defined in - -[src/types/common.ts:244](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L244) - --- ### GetDeviceData\ @@ -3807,45 +3827,36 @@ type EnergyData = type GetDeviceData = BaseGetDeviceData & SetDeviceData ``` +Defined in: [src/types/common.ts:249](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L249) + #### Type Parameters | Type Parameter | | -------------------------------------------------- | | `T` _extends_ [`DeviceType`](README.md#devicetype) | -#### Defined in - -[src/types/common.ts:249](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L249) - --- ### IDeviceFacadeAny ```ts type IDeviceFacadeAny = - | IDeviceFacade - | IDeviceFacade - | IDeviceFacade + | IDeviceFacade + | IDeviceFacade + | IDeviceFacade ``` -#### Defined in - -[src/facades/interfaces.ts:112](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/facades/interfaces.ts#L112) +Defined in: [src/facades/interfaces.ts:112](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/facades/interfaces.ts#L112) --- ### IDeviceModelAny ```ts -type IDeviceModelAny = - | IDeviceModel - | IDeviceModel - | IDeviceModel +type IDeviceModelAny = IDeviceModel | IDeviceModel | IDeviceModel ``` -#### Defined in - -[src/models/interfaces.ts:56](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/models/interfaces.ts#L56) +Defined in: [src/models/interfaces.ts:56](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/models/interfaces.ts#L56) --- @@ -3858,24 +3869,17 @@ type KeyofSetDeviceDataAtaNotInList = | 'VaneVertical' ``` -#### Defined in - -[src/types/ata.ts:104](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/ata.ts#L104) +Defined in: [src/types/ata.ts:104](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/ata.ts#L104) --- ### ListDeviceAny ```ts -type ListDeviceAny = - | ListDevice - | ListDevice - | ListDevice +type ListDeviceAny = ListDevice | ListDevice | ListDevice ``` -#### Defined in - -[src/types/common.ts:252](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L252) +Defined in: [src/types/common.ts:252](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L252) --- @@ -3883,36 +3887,32 @@ type ListDeviceAny = ```ts type ListDeviceData = - T extends DeviceType.Ata ? ListDeviceDataAta - : T extends DeviceType.Atw ? ListDeviceDataAtw - : T extends DeviceType.Erv ? ListDeviceDataErv + T extends Ata ? ListDeviceDataAta + : T extends Atw ? ListDeviceDataAtw + : T extends Erv ? ListDeviceDataErv : never ``` +Defined in: [src/types/common.ts:257](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L257) + #### Type Parameters | Type Parameter | | -------------------------------------------------- | | `T` _extends_ [`DeviceType`](README.md#devicetype) | -#### Defined in - -[src/types/common.ts:257](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L257) - --- ### ListDeviceDataAny ```ts type ListDeviceDataAny = - | ListDeviceData - | ListDeviceData - | ListDeviceData + | ListDeviceData + | ListDeviceData + | ListDeviceData ``` -#### Defined in - -[src/types/common.ts:263](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L263) +Defined in: [src/types/common.ts:263](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L263) --- @@ -3925,6 +3925,8 @@ type OnSyncFunction = (params?: { }) => Promise ``` +Defined in: [src/services/interfaces.ts:211](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/services/interfaces.ts#L211) + #### Parameters | Parameter | Type | @@ -3937,10 +3939,6 @@ type OnSyncFunction = (params?: { `Promise`\<`void`\> -#### Defined in - -[src/services/interfaces.ts:211](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/services/interfaces.ts#L211) - --- ### OperationModeLogData @@ -3952,16 +3950,14 @@ type OperationModeLogData = { }[] ``` +Defined in: [src/types/common.ts:268](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L268) + #### Type declaration | Name | Type | Defined in | | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `Key` | `string` | [src/types/common.ts:269](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L269) | -| `Value` | `number` | [src/types/common.ts:270](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L270) | - -#### Defined in - -[src/types/common.ts:268](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L268) +| `Key` | `string` | [src/types/common.ts:269](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L269) | +| `Value` | `number` | [src/types/common.ts:270](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L270) | --- @@ -3969,22 +3965,20 @@ type OperationModeLogData = { ```ts type SetDeviceData = - T extends DeviceType.Ata ? SetDeviceDataAta - : T extends DeviceType.Atw ? SetDeviceDataAtw - : T extends DeviceType.Erv ? SetDeviceDataErv + T extends Ata ? SetDeviceDataAta + : T extends Atw ? SetDeviceDataAtw + : T extends Erv ? SetDeviceDataErv : never ``` +Defined in: [src/types/common.ts:273](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L273) + #### Type Parameters | Type Parameter | | -------------------------------------------------- | | `T` _extends_ [`DeviceType`](README.md#devicetype) | -#### Defined in - -[src/types/common.ts:273](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L273) - --- ### SetDevicePostData\ @@ -3993,16 +3987,14 @@ type SetDeviceData = type SetDevicePostData = BaseDevicePostData & Required> ``` +Defined in: [src/types/common.ts:279](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L279) + #### Type Parameters | Type Parameter | | -------------------------------------------------- | | `T` _extends_ [`DeviceType`](README.md#devicetype) | -#### Defined in - -[src/types/common.ts:279](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L279) - --- ### TilesPostData\ @@ -4022,11 +4014,13 @@ type TilesPostData = } ``` +Defined in: [src/types/common.ts:282](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L282) + #### Type declaration | Name | Type | Defined in | | ----------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `DeviceIDs` | `number` \| readonly `number`[] | [src/types/common.ts:283](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L283) | +| `DeviceIDs` | `number` \| readonly `number`[] | [src/types/common.ts:283](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L283) | #### Type Parameters @@ -4034,32 +4028,26 @@ type TilesPostData = | ------------------------------------------------------------ | | `T` _extends_ [`DeviceType`](README.md#devicetype) \| `null` | -#### Defined in - -[src/types/common.ts:282](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L282) - --- ### UpdateDeviceData\ ```ts type UpdateDeviceData = - T extends DeviceType.Ata ? UpdateDeviceDataAta - : T extends DeviceType.Atw ? UpdateDeviceDataAtw - : T extends DeviceType.Erv ? UpdateDeviceDataErv + T extends Ata ? UpdateDeviceDataAta + : T extends Atw ? UpdateDeviceDataAtw + : T extends Erv ? UpdateDeviceDataErv : never ``` +Defined in: [src/types/common.ts:288](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/common.ts#L288) + #### Type Parameters | Type Parameter | | -------------------------------------------------- | | `T` _extends_ [`DeviceType`](README.md#devicetype) | -#### Defined in - -[src/types/common.ts:288](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/common.ts#L288) - --- ### ZoneAtw @@ -4068,9 +4056,7 @@ type UpdateDeviceData = type ZoneAtw = 'Zone1' | 'Zone2' ``` -#### Defined in - -[src/types/atw.ts:97](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/types/atw.ts#L97) +Defined in: [src/types/atw.ts:97](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/types/atw.ts#L97) ## Functions @@ -4083,6 +4069,8 @@ function fetchDevices( ): (...args: unknown[]) => Promise ``` +Defined in: [src/decorators/fetch-devices.ts:5](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/decorators/fetch-devices.ts#L5) + #### Type Parameters | Type Parameter | @@ -4110,10 +4098,6 @@ function fetchDevices( `Promise`\<`T`\> -#### Defined in - -[src/decorators/fetch-devices.ts:5](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/decorators/fetch-devices.ts#L5) - --- ### syncDevices() @@ -4127,6 +4111,8 @@ function syncDevices(__namedParameters: { ) => (...args: unknown[]) => Promise ``` +Defined in: [src/decorators/sync-devices.ts:14](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/decorators/sync-devices.ts#L14) + #### Type Parameters | Type Parameter | @@ -4166,10 +4152,6 @@ function syncDevices(__namedParameters: { `Promise`\<`U`\> -#### Defined in - -[src/decorators/sync-devices.ts:14](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/decorators/sync-devices.ts#L14) - --- ### updateDevice() @@ -4181,6 +4163,8 @@ function updateDevice( ): (...args: unknown[]) => Promise ``` +Defined in: [src/decorators/update-devices.ts:82](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/decorators/update-devices.ts#L82) + #### Type Parameters | Type Parameter | @@ -4209,10 +4193,6 @@ function updateDevice( `Promise`\<`U`\> -#### Defined in - -[src/decorators/update-devices.ts:82](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/decorators/update-devices.ts#L82) - --- ### updateDevices() @@ -4226,6 +4206,8 @@ function updateDevices(__namedParameters: { ) => (...args: unknown[]) => Promise ``` +Defined in: [src/decorators/update-devices.ts:24](https://github.com/OlivierZal/melcloud-api/blob/89c6803d0dfa5a80bf25adf5afca749d2dd555f3/src/decorators/update-devices.ts#L24) + #### Type Parameters | Type Parameter | @@ -4263,7 +4245,3 @@ function updateDevices(__namedParameters: { ###### Returns `Promise`\<`T`\> - -#### Defined in - -[src/decorators/update-devices.ts:24](https://github.com/OlivierZal/melcloud-api/blob/21d72e2af1c0abc665659ff46c7a3d1a314ad14d/src/decorators/update-devices.ts#L24)