diff --git a/README.md b/README.md index de1e3c6..fcabf3a 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,11 @@ #### Enumeration Members -| Enumeration Member | Value | -| :------ | :------ | -| `boost` | `2` | -| `off` | `0` | -| `vacation` | `1` | +| Enumeration Member | Value | Defined in | +| ------ | ------ | ------ | +| `boost` | `2` | [src/types.ts:15](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L15) | +| `off` | `0` | [src/types.ts:13](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L13) | +| `vacation` | `1` | [src/types.ts:14](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L14) | *** @@ -18,14 +18,14 @@ #### Enumeration Members -| Enumeration Member | Value | -| :------ | :------ | -| `cft` | `0` | -| `cft1` | `4` | -| `cft2` | `5` | -| `eco` | `1` | -| `fro` | `2` | -| `stop` | `3` | +| Enumeration Member | Value | Defined in | +| ------ | ------ | ------ | +| `cft` | `0` | [src/types.ts:4](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L4) | +| `cft1` | `4` | [src/types.ts:8](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L8) | +| `cft2` | `5` | [src/types.ts:9](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L9) | +| `eco` | `1` | [src/types.ts:5](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L5) | +| `fro` | `2` | [src/types.ts:6](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L6) | +| `stop` | `3` | [src/types.ts:7](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L7) | *** @@ -33,10 +33,10 @@ #### Enumeration Members -| Enumeration Member | Value | -| :------ | :------ | -| `off` | `0` | -| `on` | `1` | +| Enumeration Member | Value | Defined in | +| ------ | ------ | ------ | +| `off` | `0` | [src/types.ts:19](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L19) | +| `on` | `1` | [src/types.ts:20](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L20) | ## Classes @@ -57,7 +57,7 @@ new default(config: { ###### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `config` | `object` | | `config.logger`? | [`Logger`](README.md#logger) | | `config.settingManager`? | [`SettingManager`](README.md#settingmanager) | @@ -67,9 +67,9 @@ new default(config: { [`default`](README.md#default) -###### Source +###### Defined in -[src/lib/HeatzyAPI.ts:66](https://github.com/OlivierZal/heatzy-api/blob/6febc1d92fa9deaa2996a11f15d2e0eed9cb8029/src/lib/HeatzyAPI.ts#L66) +[src/lib/HeatzyAPI.ts:66](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L66) #### Methods @@ -82,16 +82,16 @@ applyLogin(data?: LoginCredentials): Promise ###### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `data`? | [`LoginCredentials`](README.md#logincredentials) | ###### Returns `Promise`\<`boolean`\> -###### Source +###### Defined in -[src/lib/HeatzyAPI.ts:120](https://github.com/OlivierZal/heatzy-api/blob/6febc1d92fa9deaa2996a11f15d2e0eed9cb8029/src/lib/HeatzyAPI.ts#L120) +[src/lib/HeatzyAPI.ts:120](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L120) ##### bindings() @@ -107,13 +107,13 @@ bindings(): Promise<{ `data`: [`Bindings`](README.md#bindings-1); \}\> -| Member | Type | -| :------ | :------ | -| `data` | [`Bindings`](README.md#bindings-1) | +| Name | Type | Defined in | +| ------ | ------ | ------ | +| `data` | [`Bindings`](README.md#bindings-1) | [src/lib/HeatzyAPI.ts:135](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L135) | -###### Source +###### Defined in -[src/lib/HeatzyAPI.ts:135](https://github.com/OlivierZal/heatzy-api/blob/6febc1d92fa9deaa2996a11f15d2e0eed9cb8029/src/lib/HeatzyAPI.ts#L135) +[src/lib/HeatzyAPI.ts:135](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L135) ##### control() @@ -126,7 +126,7 @@ control(id: string, postData: DevicePostDataAny): Promise<{ ###### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `id` | `string` | | `postData` | [`DevicePostDataAny`](README.md#devicepostdataany) | @@ -136,13 +136,13 @@ control(id: string, postData: DevicePostDataAny): Promise<{ `data`: [`Data`](README.md#data); \}\> -| Member | Type | -| :------ | :------ | -| `data` | [`Data`](README.md#data) | +| Name | Type | Defined in | +| ------ | ------ | ------ | +| `data` | [`Data`](README.md#data) | [src/lib/HeatzyAPI.ts:142](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L142) | -###### Source +###### Defined in -[src/lib/HeatzyAPI.ts:139](https://github.com/OlivierZal/heatzy-api/blob/6febc1d92fa9deaa2996a11f15d2e0eed9cb8029/src/lib/HeatzyAPI.ts#L139) +[src/lib/HeatzyAPI.ts:139](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L139) ##### deviceData() @@ -155,7 +155,7 @@ deviceData(id: string): Promise<{ ###### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `id` | `string` | ###### Returns @@ -164,13 +164,13 @@ deviceData(id: string): Promise<{ `data`: [`DeviceData`](README.md#devicedata-1); \}\> -| Member | Type | -| :------ | :------ | -| `data` | [`DeviceData`](README.md#devicedata-1) | +| Name | Type | Defined in | +| ------ | ------ | ------ | +| `data` | [`DeviceData`](README.md#devicedata-1) | [src/lib/HeatzyAPI.ts:146](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L146) | -###### Source +###### Defined in -[src/lib/HeatzyAPI.ts:146](https://github.com/OlivierZal/heatzy-api/blob/6febc1d92fa9deaa2996a11f15d2e0eed9cb8029/src/lib/HeatzyAPI.ts#L146) +[src/lib/HeatzyAPI.ts:146](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L146) ##### login() @@ -183,7 +183,7 @@ login(__namedParameters: LoginPostData): Promise<{ ###### Parameters | Parameter | Type | -| :------ | :------ | +| ------ | ------ | | `__namedParameters` | [`LoginPostData`](README.md#loginpostdata) | ###### Returns @@ -192,13 +192,13 @@ login(__namedParameters: LoginPostData): Promise<{ `data`: [`LoginData`](README.md#logindata); \}\> -| Member | Type | -| :------ | :------ | -| `data` | [`LoginData`](README.md#logindata) | +| Name | Type | Defined in | +| ------ | ------ | ------ | +| `data` | [`LoginData`](README.md#logindata) | [src/lib/HeatzyAPI.ts:153](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L153) | -###### Source +###### Defined in -[src/lib/HeatzyAPI.ts:150](https://github.com/OlivierZal/heatzy-api/blob/6febc1d92fa9deaa2996a11f15d2e0eed9cb8029/src/lib/HeatzyAPI.ts#L150) +[src/lib/HeatzyAPI.ts:150](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L150) ## Interfaces @@ -206,12 +206,12 @@ login(__namedParameters: LoginPostData): Promise<{ #### Properties -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `expireAt?` | `readonly` | `null` \| `number` | -| `password?` | `readonly` | `null` \| `string` | -| `token?` | `readonly` | `null` \| `string` | -| `username?` | `readonly` | `null` \| `string` | +| Property | Modifier | Type | Defined in | +| ------ | ------ | ------ | ------ | +| `expireAt?` | `readonly` | `null` \| `number` | [src/lib/HeatzyAPI.ts:25](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L25) | +| `password?` | `readonly` | `null` \| `string` | [src/lib/HeatzyAPI.ts:26](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L26) | +| `token?` | `readonly` | `null` \| `string` | [src/lib/HeatzyAPI.ts:27](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L27) | +| `username?` | `readonly` | `null` \| `string` | [src/lib/HeatzyAPI.ts:28](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L28) | *** @@ -219,15 +219,15 @@ login(__namedParameters: LoginPostData): Promise<{ #### Properties -| Property | Type | -| :------ | :------ | -| `cft_tempH?` | `number` | -| `cft_tempL?` | `number` | -| `derog_mode?` | [`DerogMode`](README.md#derogmode) | -| `derog_time?` | `number` | -| `lock_switch?` | [`Switch`](README.md#switch) | -| `mode?` | [`Mode`](README.md#mode) | -| `timer_switch?` | [`Switch`](README.md#switch) | +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `cft_tempH?` | `number` | [src/types.ts:59](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L59) | +| `cft_tempL?` | `number` | [src/types.ts:60](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L60) | +| `derog_mode?` | [`DerogMode`](README.md#derogmode) | [src/types.ts:61](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L61) | +| `derog_time?` | `number` | [src/types.ts:62](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L62) | +| `lock_switch?` | [`Switch`](README.md#switch) | [src/types.ts:63](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L63) | +| `mode?` | [`Mode`](README.md#mode) | [src/types.ts:64](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L64) | +| `timer_switch?` | [`Switch`](README.md#switch) | [src/types.ts:65](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L65) | *** @@ -235,9 +235,9 @@ login(__namedParameters: LoginPostData): Promise<{ #### Properties -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `devices` | `readonly` | readonly \{ `dev_alias`: `string`; `did`: `string`; `product_key`: `string`; `product_name`: `string`; \}[] | +| Property | Modifier | Type | Defined in | +| ------ | ------ | ------ | ------ | +| `devices` | `readonly` | readonly \{ `dev_alias`: `string`; `did`: `string`; `product_key`: `string`; `product_name`: `string`; \}[] | [src/types.ts:46](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L46) | *** @@ -245,9 +245,9 @@ login(__namedParameters: LoginPostData): Promise<{ #### Properties -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `attr` | `readonly` | `never` | +| Property | Modifier | Type | Defined in | +| ------ | ------ | ------ | ------ | +| `attr` | `readonly` | `never` | [src/types.ts:75](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L75) | *** @@ -255,9 +255,9 @@ login(__namedParameters: LoginPostData): Promise<{ #### Properties -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `attrs` | `readonly` | [`BaseAttrs`](README.md#baseattrs) | +| Property | Modifier | Type | Defined in | +| ------ | ------ | ------ | ------ | +| `attrs` | `readonly` | [`BaseAttrs`](README.md#baseattrs) | [src/types.ts:69](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L69) | *** @@ -265,10 +265,10 @@ login(__namedParameters: LoginPostData): Promise<{ #### Properties -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `detail_message` | `readonly` | `null` \| `string` | -| `error_message` | `readonly` | `null` \| `string` | +| Property | Modifier | Type | Defined in | +| ------ | ------ | ------ | ------ | +| `detail_message` | `readonly` | `null` \| `string` | [src/types.ts:26](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L26) | +| `error_message` | `readonly` | `null` \| `string` | [src/types.ts:27](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L27) | *** @@ -276,9 +276,9 @@ login(__namedParameters: LoginPostData): Promise<{ #### Properties -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `raw` | `readonly` | [`1`, `1`, [`Mode`](README.md#mode)] | +| Property | Modifier | Type | Defined in | +| ------ | ------ | ------ | ------ | +| `raw` | `readonly` | [`1`, `1`, [`Mode`](README.md#mode)] | [src/types.ts:55](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L55) | *** @@ -286,10 +286,10 @@ login(__namedParameters: LoginPostData): Promise<{ #### Properties -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `error` | `readonly` | (...`data`: `any`[]) => `void`(`message`?: `any`, ...`optionalParams`: `any`[]) => `void` | -| `log` | `readonly` | (...`data`: `any`[]) => `void`(`message`?: `any`, ...`optionalParams`: `any`[]) => `void` | +| Property | Modifier | Type | Defined in | +| ------ | ------ | ------ | ------ | +| `error` | `readonly` | (...`data`: `any`[]) => `void`(`message`?: `any`, ...`optionalParams`: `any`[]) => `void` | [src/lib/HeatzyAPI.ts:32](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L32) | +| `log` | `readonly` | (...`data`: `any`[]) => `void`(`message`?: `any`, ...`optionalParams`: `any`[]) => `void` | [src/lib/HeatzyAPI.ts:33](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L33) | *** @@ -297,10 +297,10 @@ login(__namedParameters: LoginPostData): Promise<{ #### Properties -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `password` | `readonly` | `string` | -| `username` | `readonly` | `string` | +| Property | Modifier | Type | Defined in | +| ------ | ------ | ------ | ------ | +| `password` | `readonly` | `string` | [src/types.ts:31](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L31) | +| `username` | `readonly` | `string` | [src/types.ts:32](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L32) | *** @@ -308,10 +308,10 @@ login(__namedParameters: LoginPostData): Promise<{ #### Properties -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `expire_at` | `readonly` | `number` | -| `token` | `readonly` | `string` | +| Property | Modifier | Type | Defined in | +| ------ | ------ | ------ | ------ | +| `expire_at` | `readonly` | `number` | [src/types.ts:41](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L41) | +| `token` | `readonly` | `string` | [src/types.ts:42](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L42) | *** @@ -319,10 +319,10 @@ login(__namedParameters: LoginPostData): Promise<{ #### Properties -| Property | Modifier | Type | -| :------ | :------ | :------ | -| `password` | `readonly` | `string` | -| `username` | `readonly` | `string` | +| Property | Modifier | Type | Defined in | +| ------ | ------ | ------ | ------ | +| `password` | `readonly` | `string` | [src/types.ts:36](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L36) | +| `username` | `readonly` | `string` | [src/types.ts:37](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L37) | *** @@ -330,10 +330,10 @@ login(__namedParameters: LoginPostData): Promise<{ #### Properties -| Property | Type | -| :------ | :------ | -| `get` | \<`K`\>(`key`: `K`) => `undefined` \| `null` \| [`APISettings`](README.md#apisettings)\[`K`\] | -| `set` | \<`K`\>(`key`: `K`, `value`: [`APISettings`](README.md#apisettings)\[`K`\]) => `void` | +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `get` | \<`K`\>(`key`: `K`) => `undefined` \| `null` \| [`APISettings`](README.md#apisettings)\[`K`\] | [src/lib/HeatzyAPI.ts:37](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L37) | +| `set` | \<`K`\>(`key`: `K`, `value`: [`APISettings`](README.md#apisettings)\[`K`\]) => `void` | [src/lib/HeatzyAPI.ts:40](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/lib/HeatzyAPI.ts#L40) | ## Type Aliases @@ -343,9 +343,9 @@ login(__namedParameters: LoginPostData): Promise<{ type Data: Record; ``` -#### Source +#### Defined in -[src/types.ts:23](https://github.com/OlivierZal/heatzy-api/blob/6febc1d92fa9deaa2996a11f15d2e0eed9cb8029/src/types.ts#L23) +[src/types.ts:23](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L23) *** @@ -355,9 +355,9 @@ type Data: Record; type DevicePostDataAny: DevicePostData | FirstGenDevicePostData; ``` -#### Source +#### Defined in -[src/types.ts:72](https://github.com/OlivierZal/heatzy-api/blob/6febc1d92fa9deaa2996a11f15d2e0eed9cb8029/src/types.ts#L72) +[src/types.ts:72](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L72) ## Variables @@ -367,6 +367,6 @@ type DevicePostDataAny: DevicePostData | FirstGenDevicePostData; const NUMBER_1: 1 = 1; ``` -#### Source +#### Defined in -[src/types.ts:1](https://github.com/OlivierZal/heatzy-api/blob/6febc1d92fa9deaa2996a11f15d2e0eed9cb8029/src/types.ts#L1) +[src/types.ts:1](https://github.com/OlivierZal/heatzy-api/blob/77300e31c27b54afa928262b4d821c2753ce13e1/src/types.ts#L1) diff --git a/package-lock.json b/package-lock.json index 931cf2e..ef9a126 100644 --- a/package-lock.json +++ b/package-lock.json @@ -30,7 +30,7 @@ "prettier": "^3.3.2", "typedoc": "^0.26.3", "typedoc-plugin-markdown": "^4.1.1", - "typescript": "^5.5.2", + "typescript": "^5.5.3", "typescript-eslint": "^8.0.0-alpha.38" } }, @@ -3965,9 +3965,9 @@ } }, "node_modules/typescript": { - "version": "5.5.2", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.2.tgz", - "integrity": "sha512-NcRtPEOsPFFWjobJEtfihkLCZCXZt/os3zf8nTxjVH3RvTSxjrCamJpbExGvYOF+tFHc3pA65qpdwPbzjohhew==", + "version": "5.5.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.3.tgz", + "integrity": "sha512-/hreyEujaB0w76zKo6717l3L0o/qEUtRgdvUBvlkhoWeOVMjMuHNHk0BRBzikzuGDqNmPQbg5ifMEqsHLiIUcQ==", "dev": true, "bin": { "tsc": "bin/tsc", diff --git a/package.json b/package.json index 764ee04..35fb16a 100644 --- a/package.json +++ b/package.json @@ -56,7 +56,7 @@ "prettier": "^3.3.2", "typedoc": "^0.26.3", "typedoc-plugin-markdown": "^4.1.1", - "typescript": "^5.5.2", + "typescript": "^5.5.3", "typescript-eslint": "^8.0.0-alpha.38" }, "dependencies": {