From 303baf8c65103fd64de13233a066fe718799c712 Mon Sep 17 00:00:00 2001 From: Max Isom Date: Thu, 23 Feb 2023 15:25:12 -0800 Subject: [PATCH 1/2] Bump seamapi-types --- package.json | 2 +- yarn.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 61509d99..e60af419 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "ora": "5.4.1", "p-retry": "4.6.1", "prompts": "2.4.2", - "seamapi-types": "^1.13.1", + "seamapi-types": "^1.14.0", "svix": "0.54.2", "typed-emitter": "2.1.0", "yargs": "17.3.1" diff --git a/yarn.lock b/yarn.lock index 3a1720c8..a72980b0 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5343,10 +5343,10 @@ safe-stable-stringify@^2.3.1: resolved "https://registry.yarnpkg.com/safer-buffer/-/safer-buffer-2.1.2.tgz#44fa161b0187b9549dd84bb91802f9bd8385cd6a" integrity sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg== -seamapi-types@^1.13.1: - version "1.13.1" - resolved "https://registry.yarnpkg.com/seamapi-types/-/seamapi-types-1.13.1.tgz#3fa9ba274b292488a2f1b8bf0644277f313941d6" - integrity sha512-OZKLrSlQKBWdDzQeFUZR3QTRNABZv2hN/BF7VDwEk7+zKZ5T31hEvAfgkgVZjTEoavXNlh6cqBeZepncq5SjPQ== +seamapi-types@^1.14.0: + version "1.14.0" + resolved "https://registry.yarnpkg.com/seamapi-types/-/seamapi-types-1.14.0.tgz#da9d8345977578845d5696887a98625779cda22e" + integrity sha512-DE0TRrZWc8zArkw3n6zzU+0Rz8p+2KWgJaFbD9DiEqqNrQdRkUR4SH6HpLzNVxrK3srt6fuIdn5PMqyDfDYSgw== semantic-release@^20.1.0: version "20.1.0" From ecfff0c683b60233181c0db61eb26f866099cc0d Mon Sep 17 00:00:00 2001 From: Max Isom Date: Thu, 23 Feb 2023 15:35:58 -0800 Subject: [PATCH 2/2] Add type for battery level --- docs/interfaces/AccessCodeBase.md | 16 +++---- docs/interfaces/ActionAttemptResultTypeMap.md | 4 +- docs/interfaces/ActionAttemptWithError.md | 10 ++--- docs/interfaces/ConnectWebview.md | 30 ++++++------- docs/interfaces/ConnectedAccount.md | 12 ++--- docs/interfaces/Device.md | 20 ++++----- docs/interfaces/LockProperties.md | 44 ++++++++++++++----- docs/interfaces/OngoingAccessCode.md | 22 +++++----- docs/interfaces/PendingActionAttempt.md | 10 ++--- docs/interfaces/SuccessfulActionAttempt.md | 10 ++--- docs/interfaces/TimeBoundAccessCode.md | 26 +++++------ docs/interfaces/UserIdentifier.md | 2 +- docs/interfaces/Webhook.md | 8 ++-- docs/modules.md | 28 +++++++++--- src/types/models.ts | 6 +++ 15 files changed, 145 insertions(+), 103 deletions(-) diff --git a/docs/interfaces/AccessCodeBase.md b/docs/interfaces/AccessCodeBase.md index 87256969..504e3c6c 100644 --- a/docs/interfaces/AccessCodeBase.md +++ b/docs/interfaces/AccessCodeBase.md @@ -31,7 +31,7 @@ #### Defined in -[src/types/models.ts:179](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L179) +[src/types/models.ts:185](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L185) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[src/types/models.ts:182](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L182) +[src/types/models.ts:188](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L188) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[src/types/models.ts:183](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L183) +[src/types/models.ts:189](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L189) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[src/types/models.ts:180](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L180) +[src/types/models.ts:186](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L186) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[src/types/models.ts:185](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L185) +[src/types/models.ts:191](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L191) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[src/types/models.ts:184](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L184) +[src/types/models.ts:190](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L190) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -[src/types/models.ts:181](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L181) +[src/types/models.ts:187](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L187) ___ @@ -101,4 +101,4 @@ ___ #### Defined in -[src/types/models.ts:186](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L186) +[src/types/models.ts:192](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L192) diff --git a/docs/interfaces/ActionAttemptResultTypeMap.md b/docs/interfaces/ActionAttemptResultTypeMap.md index f27b746d..f97c5580 100644 --- a/docs/interfaces/ActionAttemptResultTypeMap.md +++ b/docs/interfaces/ActionAttemptResultTypeMap.md @@ -36,7 +36,7 @@ Record.CREATE\_ACCESS\_CODE #### Defined in -[src/types/models.ts:144](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L144) +[src/types/models.ts:150](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L150) ___ @@ -86,4 +86,4 @@ Record.UPDATE\_ACCESS\_CODE #### Defined in -[src/types/models.ts:145](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L145) +[src/types/models.ts:151](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L151) diff --git a/docs/interfaces/ActionAttemptWithError.md b/docs/interfaces/ActionAttemptWithError.md index 2233fc80..47024eb0 100644 --- a/docs/interfaces/ActionAttemptWithError.md +++ b/docs/interfaces/ActionAttemptWithError.md @@ -36,7 +36,7 @@ ActionAttemptBase.action\_attempt\_id #### Defined in -[src/types/models.ts:118](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L118) +[src/types/models.ts:124](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L124) ___ @@ -50,7 +50,7 @@ ActionAttemptBase.action\_type #### Defined in -[src/types/models.ts:119](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L119) +[src/types/models.ts:125](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L125) ___ @@ -71,7 +71,7 @@ ActionAttemptBase.error #### Defined in -[src/types/models.ts:136](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L136) +[src/types/models.ts:142](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L142) ___ @@ -85,7 +85,7 @@ ActionAttemptBase.result #### Defined in -[src/types/models.ts:135](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L135) +[src/types/models.ts:141](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L141) ___ @@ -99,4 +99,4 @@ ActionAttemptBase.status #### Defined in -[src/types/models.ts:134](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L134) +[src/types/models.ts:140](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L140) diff --git a/docs/interfaces/ConnectWebview.md b/docs/interfaces/ConnectWebview.md index 7db1b533..42e04e74 100644 --- a/docs/interfaces/ConnectWebview.md +++ b/docs/interfaces/ConnectWebview.md @@ -30,7 +30,7 @@ #### Defined in -[src/types/models.ts:165](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L165) +[src/types/models.ts:171](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L171) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[src/types/models.ts:164](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L164) +[src/types/models.ts:170](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L170) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[src/types/models.ts:167](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L167) +[src/types/models.ts:173](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L173) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[src/types/models.ts:166](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L166) +[src/types/models.ts:172](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L172) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[src/types/models.ts:175](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L175) +[src/types/models.ts:181](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L181) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[src/types/models.ts:161](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L161) +[src/types/models.ts:167](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L167) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[src/types/models.ts:171](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L171) +[src/types/models.ts:177](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L177) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[src/types/models.ts:168](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L168) +[src/types/models.ts:174](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L174) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[src/types/models.ts:173](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L173) +[src/types/models.ts:179](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L179) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[src/types/models.ts:172](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L172) +[src/types/models.ts:178](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L178) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[src/types/models.ts:163](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L163) +[src/types/models.ts:169](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L169) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[src/types/models.ts:169](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L169) +[src/types/models.ts:175](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L175) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[src/types/models.ts:170](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L170) +[src/types/models.ts:176](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L176) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[src/types/models.ts:174](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L174) +[src/types/models.ts:180](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L180) ___ @@ -170,4 +170,4 @@ ___ #### Defined in -[src/types/models.ts:162](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L162) +[src/types/models.ts:168](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L168) diff --git a/docs/interfaces/ConnectedAccount.md b/docs/interfaces/ConnectedAccount.md index 4913c2e5..8d53bf2d 100644 --- a/docs/interfaces/ConnectedAccount.md +++ b/docs/interfaces/ConnectedAccount.md @@ -21,7 +21,7 @@ #### Defined in -[src/types/models.ts:213](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L213) +[src/types/models.ts:219](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L219) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[src/types/models.ts:210](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L210) +[src/types/models.ts:216](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L216) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[src/types/models.ts:211](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L211) +[src/types/models.ts:217](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L217) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[src/types/models.ts:214](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L214) +[src/types/models.ts:220](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L220) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[src/types/models.ts:212](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L212) +[src/types/models.ts:218](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L218) ___ @@ -71,4 +71,4 @@ ___ #### Defined in -[src/types/models.ts:215](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L215) +[src/types/models.ts:221](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L221) diff --git a/docs/interfaces/Device.md b/docs/interfaces/Device.md index 3340e541..bc217c27 100644 --- a/docs/interfaces/Device.md +++ b/docs/interfaces/Device.md @@ -32,7 +32,7 @@ #### Defined in -[src/types/models.ts:75](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L75) +[src/types/models.ts:81](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L81) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[src/types/models.ts:74](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L74) +[src/types/models.ts:80](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L80) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[src/types/models.ts:78](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L78) +[src/types/models.ts:84](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L84) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[src/types/models.ts:69](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L69) +[src/types/models.ts:75](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L75) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[src/types/models.ts:73](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L73) +[src/types/models.ts:79](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L79) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[src/types/models.ts:76](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L76) +[src/types/models.ts:82](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L82) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[src/types/models.ts:72](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L72) +[src/types/models.ts:78](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L78) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[src/types/models.ts:71](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L71) +[src/types/models.ts:77](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L77) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[src/types/models.ts:77](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L77) +[src/types/models.ts:83](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L83) ___ @@ -122,4 +122,4 @@ ___ #### Defined in -[src/types/models.ts:70](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L70) +[src/types/models.ts:76](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L76) diff --git a/docs/interfaces/LockProperties.md b/docs/interfaces/LockProperties.md index e2f18296..6bc3921e 100644 --- a/docs/interfaces/LockProperties.md +++ b/docs/interfaces/LockProperties.md @@ -13,6 +13,7 @@ ### Properties - [august\_metadata](LockProperties.md#august_metadata) +- [battery](LockProperties.md#battery) - [battery\_level](LockProperties.md#battery_level) - [door\_open](LockProperties.md#door_open) - [has\_direct\_power](LockProperties.md#has_direct_power) @@ -42,7 +43,28 @@ #### Defined in -[src/types/models.ts:96](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L96) +[src/types/models.ts:102](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L102) + +___ + +### battery + +• `Optional` **battery**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `level` | `number` | +| `status` | [`BatteryStatus`](../modules.md#batterystatus) | + +#### Inherited from + +CommonDeviceProperties.battery + +#### Defined in + +[src/types/models.ts:66](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L66) ___ @@ -52,7 +74,7 @@ ___ #### Defined in -[src/types/models.ts:84](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L84) +[src/types/models.ts:90](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L90) ___ @@ -62,7 +84,7 @@ ___ #### Defined in -[src/types/models.ts:83](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L83) +[src/types/models.ts:89](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L89) ___ @@ -72,7 +94,7 @@ ___ #### Defined in -[src/types/models.ts:85](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L85) +[src/types/models.ts:91](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L91) ___ @@ -82,7 +104,7 @@ ___ #### Defined in -[src/types/models.ts:82](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L82) +[src/types/models.ts:88](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L88) ___ @@ -92,7 +114,7 @@ ___ #### Defined in -[src/types/models.ts:86](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L86) +[src/types/models.ts:92](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L92) ___ @@ -106,7 +128,7 @@ CommonDeviceProperties.name #### Defined in -[src/types/models.ts:62](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L62) +[src/types/models.ts:64](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L64) ___ @@ -120,7 +142,7 @@ CommonDeviceProperties.online #### Defined in -[src/types/models.ts:63](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L63) +[src/types/models.ts:65](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L65) ___ @@ -139,7 +161,7 @@ ___ #### Defined in -[src/types/models.ts:89](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L89) +[src/types/models.ts:95](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L95) ___ @@ -149,7 +171,7 @@ ___ #### Defined in -[src/types/models.ts:104](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L104) +[src/types/models.ts:110](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L110) ___ @@ -159,4 +181,4 @@ ___ #### Defined in -[src/types/models.ts:87](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L87) +[src/types/models.ts:93](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L93) diff --git a/docs/interfaces/OngoingAccessCode.md b/docs/interfaces/OngoingAccessCode.md index d18aab34..185262b0 100644 --- a/docs/interfaces/OngoingAccessCode.md +++ b/docs/interfaces/OngoingAccessCode.md @@ -36,7 +36,7 @@ #### Defined in -[src/types/models.ts:179](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L179) +[src/types/models.ts:185](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L185) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[src/types/models.ts:182](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L182) +[src/types/models.ts:188](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L188) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[src/types/models.ts:183](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L183) +[src/types/models.ts:189](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L189) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[src/types/models.ts:191](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L191) +[src/types/models.ts:197](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L197) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[src/types/models.ts:180](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L180) +[src/types/models.ts:186](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L186) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[src/types/models.ts:185](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L185) +[src/types/models.ts:191](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L191) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[src/types/models.ts:184](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L184) +[src/types/models.ts:190](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L190) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[src/types/models.ts:181](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L181) +[src/types/models.ts:187](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L187) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[src/types/models.ts:192](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L192) +[src/types/models.ts:198](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L198) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[src/types/models.ts:190](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L190) +[src/types/models.ts:196](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L196) ___ @@ -164,4 +164,4 @@ ___ #### Defined in -[src/types/models.ts:186](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L186) +[src/types/models.ts:192](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L192) diff --git a/docs/interfaces/PendingActionAttempt.md b/docs/interfaces/PendingActionAttempt.md index c620ea5d..3748e5dc 100644 --- a/docs/interfaces/PendingActionAttempt.md +++ b/docs/interfaces/PendingActionAttempt.md @@ -36,7 +36,7 @@ ActionAttemptBase.action\_attempt\_id #### Defined in -[src/types/models.ts:118](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L118) +[src/types/models.ts:124](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L124) ___ @@ -50,7 +50,7 @@ ActionAttemptBase.action\_type #### Defined in -[src/types/models.ts:119](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L119) +[src/types/models.ts:125](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L125) ___ @@ -64,7 +64,7 @@ ActionAttemptBase.error #### Defined in -[src/types/models.ts:129](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L129) +[src/types/models.ts:135](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L135) ___ @@ -78,7 +78,7 @@ ActionAttemptBase.result #### Defined in -[src/types/models.ts:128](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L128) +[src/types/models.ts:134](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L134) ___ @@ -92,4 +92,4 @@ ActionAttemptBase.status #### Defined in -[src/types/models.ts:127](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L127) +[src/types/models.ts:133](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L133) diff --git a/docs/interfaces/SuccessfulActionAttempt.md b/docs/interfaces/SuccessfulActionAttempt.md index d8a2a30d..20bbf502 100644 --- a/docs/interfaces/SuccessfulActionAttempt.md +++ b/docs/interfaces/SuccessfulActionAttempt.md @@ -36,7 +36,7 @@ ActionAttemptBase.action\_attempt\_id #### Defined in -[src/types/models.ts:118](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L118) +[src/types/models.ts:124](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L124) ___ @@ -50,7 +50,7 @@ ActionAttemptBase.action\_type #### Defined in -[src/types/models.ts:119](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L119) +[src/types/models.ts:125](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L125) ___ @@ -64,7 +64,7 @@ ActionAttemptBase.error #### Defined in -[src/types/models.ts:151](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L151) +[src/types/models.ts:157](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L157) ___ @@ -78,7 +78,7 @@ ActionAttemptBase.result #### Defined in -[src/types/models.ts:152](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L152) +[src/types/models.ts:158](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L158) ___ @@ -92,4 +92,4 @@ ActionAttemptBase.status #### Defined in -[src/types/models.ts:150](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L150) +[src/types/models.ts:156](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L156) diff --git a/docs/interfaces/TimeBoundAccessCode.md b/docs/interfaces/TimeBoundAccessCode.md index f1650e2e..517b47c2 100644 --- a/docs/interfaces/TimeBoundAccessCode.md +++ b/docs/interfaces/TimeBoundAccessCode.md @@ -38,7 +38,7 @@ #### Defined in -[src/types/models.ts:179](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L179) +[src/types/models.ts:185](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L185) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[src/types/models.ts:182](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L182) +[src/types/models.ts:188](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L188) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[src/types/models.ts:183](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L183) +[src/types/models.ts:189](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L189) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[src/types/models.ts:197](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L197) +[src/types/models.ts:203](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L203) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[src/types/models.ts:180](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L180) +[src/types/models.ts:186](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L186) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[src/types/models.ts:200](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L200) +[src/types/models.ts:206](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L206) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[src/types/models.ts:185](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L185) +[src/types/models.ts:191](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L191) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[src/types/models.ts:184](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L184) +[src/types/models.ts:190](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L190) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[src/types/models.ts:181](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L181) +[src/types/models.ts:187](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L187) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[src/types/models.ts:199](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L199) +[src/types/models.ts:205](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L205) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[src/types/models.ts:198](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L198) +[src/types/models.ts:204](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L204) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[src/types/models.ts:196](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L196) +[src/types/models.ts:202](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L202) ___ @@ -186,4 +186,4 @@ ___ #### Defined in -[src/types/models.ts:186](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L186) +[src/types/models.ts:192](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L192) diff --git a/docs/interfaces/UserIdentifier.md b/docs/interfaces/UserIdentifier.md index c143a9e8..daa64581 100644 --- a/docs/interfaces/UserIdentifier.md +++ b/docs/interfaces/UserIdentifier.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/models.ts:206](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L206) +[src/types/models.ts:212](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L212) diff --git a/docs/interfaces/Webhook.md b/docs/interfaces/Webhook.md index 9dbb2689..04000f32 100644 --- a/docs/interfaces/Webhook.md +++ b/docs/interfaces/Webhook.md @@ -19,7 +19,7 @@ #### Defined in -[src/types/models.ts:221](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L221) +[src/types/models.ts:227](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L227) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[src/types/models.ts:222](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L222) +[src/types/models.ts:228](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L228) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[src/types/models.ts:220](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L220) +[src/types/models.ts:226](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L226) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[src/types/models.ts:219](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L219) +[src/types/models.ts:225](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L225) diff --git a/docs/modules.md b/docs/modules.md index 0f1f3811..b2d3e1b4 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -94,6 +94,7 @@ - [ActionAttempt](modules.md#actionattempt) - [ActionType](modules.md#actiontype) - [AnyDevice](modules.md#anydevice) +- [BatteryStatus](modules.md#batterystatus) - [CommonDeviceProperties](modules.md#commondeviceproperties) - [DeviceDeleteRequest](modules.md#devicedeleterequest) - [DeviceGetRequest](modules.md#devicegetrequest) @@ -150,7 +151,7 @@ ___ #### Defined in -[src/types/models.ts:203](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L203) +[src/types/models.ts:209](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L209) ___ @@ -269,7 +270,7 @@ ___ #### Defined in -[src/types/models.ts:155](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L155) +[src/types/models.ts:161](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L161) ___ @@ -279,7 +280,7 @@ ___ #### Defined in -[src/types/models.ts:110](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L110) +[src/types/models.ts:116](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L116) ___ @@ -289,7 +290,17 @@ ___ #### Defined in -[src/types/models.ts:107](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L107) +[src/types/models.ts:113](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L113) + +___ + +### BatteryStatus + +Ƭ **BatteryStatus**: ``"low"`` \| ``"good"`` \| ``"full"`` + +#### Defined in + +[src/types/models.ts:61](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L61) ___ @@ -301,12 +312,15 @@ ___ | Name | Type | | :------ | :------ | +| `battery?` | `Object` | +| `battery.level` | `number` | +| `battery.status` | [`BatteryStatus`](modules.md#batterystatus) | | `name` | `string` | | `online` | `boolean` | #### Defined in -[src/types/models.ts:61](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L61) +[src/types/models.ts:63](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L63) ___ @@ -371,7 +385,7 @@ ___ #### Defined in -[src/types/models.ts:235](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L235) +[src/types/models.ts:241](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L241) ___ @@ -381,7 +395,7 @@ ___ #### Defined in -[src/types/models.ts:108](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L108) +[src/types/models.ts:114](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L114) ___ diff --git a/src/types/models.ts b/src/types/models.ts index e4e9a361..c1d11b25 100644 --- a/src/types/models.ts +++ b/src/types/models.ts @@ -58,9 +58,15 @@ export interface SeamWarning { message: string } +export type BatteryStatus = "low" | "good" | "full" + export type CommonDeviceProperties = { name: string online: boolean + battery?: { + level: number + status: BatteryStatus + } } export interface Device< Properties extends CommonDeviceProperties,