diff --git a/docs/classes/default.md b/docs/classes/default.md index 4367b731..c77cbb0f 100644 --- a/docs/classes/default.md +++ b/docs/classes/default.md @@ -70,7 +70,7 @@ Routes.accessCodes #### Defined in -[src/routes.ts:190](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L190) +[src/routes.ts:198](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L198) ___ @@ -90,7 +90,7 @@ Routes.actionAttempts #### Defined in -[src/routes.ts:262](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L262) +[src/routes.ts:270](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L270) ___ @@ -122,7 +122,7 @@ Routes.connectWebviews #### Defined in -[src/routes.ts:164](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L164) +[src/routes.ts:172](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L172) ___ @@ -143,7 +143,7 @@ Routes.connectedAccounts #### Defined in -[src/routes.ts:241](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L241) +[src/routes.ts:249](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L249) ___ @@ -155,8 +155,9 @@ ___ | Name | Type | | :------ | :------ | -| `get` | (`deviceId`: `string`) => `Promise`<[`Device`](../interfaces/Device.md)<`unknown`, [`DeviceType`](../modules.md#devicetype)\>\> | -| `list` | (`connectedAccountId?`: `string`) => `Promise`<[`Device`](../interfaces/Device.md)<`unknown`, [`DeviceType`](../modules.md#devicetype)\>[]\> | +| `get` | (`deviceId`: `string`) => `Promise`<[`Device`](../interfaces/Device.md)<[`CommonDeviceProperties`](../modules.md#commondeviceproperties), [`DeviceType`](../modules.md#devicetype)\>\> | +| `list` | (`connectedAccountId?`: `string`) => `Promise`<[`Device`](../interfaces/Device.md)<[`CommonDeviceProperties`](../modules.md#commondeviceproperties), [`DeviceType`](../modules.md#devicetype)\>[]\> | +| `update` | (`params`: [`DeviceUpdateRequest`](../modules.md#deviceupdaterequest)) => `Promise`<{ `ok`: ``true`` }\> | #### Inherited from @@ -164,7 +165,7 @@ Routes.devices #### Defined in -[src/routes.ts:145](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L145) +[src/routes.ts:147](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L147) ___ @@ -187,7 +188,7 @@ Routes.locks #### Defined in -[src/routes.ts:110](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L110) +[src/routes.ts:112](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L112) ___ @@ -209,7 +210,7 @@ Routes.workspaces #### Defined in -[src/routes.ts:94](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L94) +[src/routes.ts:96](https://github.com/seamapi/seamapi-javascript/blob/main/src/routes.ts#L96) ## Methods diff --git a/docs/interfaces/AccessCodeBase.md b/docs/interfaces/AccessCodeBase.md index eb54236e..b1900b05 100644 --- a/docs/interfaces/AccessCodeBase.md +++ b/docs/interfaces/AccessCodeBase.md @@ -26,7 +26,7 @@ #### Defined in -[src/types/models.ts:124](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L124) +[src/types/models.ts:128](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L128) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[src/types/models.ts:126](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L126) +[src/types/models.ts:130](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L130) ___ @@ -46,4 +46,4 @@ ___ #### Defined in -[src/types/models.ts:125](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L125) +[src/types/models.ts:129](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L129) diff --git a/docs/interfaces/AccessCodesListResponse.md b/docs/interfaces/AccessCodesListResponse.md index acf23965..bcc95896 100644 --- a/docs/interfaces/AccessCodesListResponse.md +++ b/docs/interfaces/AccessCodesListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:57](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L57) +[src/types/route-responses.ts:58](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L58) diff --git a/docs/interfaces/ActionAttemptCreateResponse.md b/docs/interfaces/ActionAttemptCreateResponse.md index a413708b..345402ea 100644 --- a/docs/interfaces/ActionAttemptCreateResponse.md +++ b/docs/interfaces/ActionAttemptCreateResponse.md @@ -22,4 +22,4 @@ #### Defined in -[src/types/route-responses.ts:73](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L73) +[src/types/route-responses.ts:74](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L74) diff --git a/docs/interfaces/ActionAttemptGetResponse.md b/docs/interfaces/ActionAttemptGetResponse.md index 3def222a..b4c929f1 100644 --- a/docs/interfaces/ActionAttemptGetResponse.md +++ b/docs/interfaces/ActionAttemptGetResponse.md @@ -22,4 +22,4 @@ #### Defined in -[src/types/route-responses.ts:77](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L77) +[src/types/route-responses.ts:78](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L78) diff --git a/docs/interfaces/ActionAttemptResultTypeMap.md b/docs/interfaces/ActionAttemptResultTypeMap.md index 4fad8c57..9daa0dbd 100644 --- a/docs/interfaces/ActionAttemptResultTypeMap.md +++ b/docs/interfaces/ActionAttemptResultTypeMap.md @@ -35,7 +35,7 @@ Record.CREATE\_ACCESS\_CODE #### Defined in -[src/types/models.ts:92](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L92) +[src/types/models.ts:96](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L96) ___ diff --git a/docs/interfaces/ActionAttemptWithError.md b/docs/interfaces/ActionAttemptWithError.md index 49249125..25d8be9a 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:66](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L66) +[src/types/models.ts:70](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L70) ___ @@ -50,7 +50,7 @@ ActionAttemptBase.action\_type #### Defined in -[src/types/models.ts:67](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L67) +[src/types/models.ts:71](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L71) ___ @@ -71,7 +71,7 @@ ActionAttemptBase.error #### Defined in -[src/types/models.ts:84](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L84) +[src/types/models.ts:88](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L88) ___ @@ -85,7 +85,7 @@ ActionAttemptBase.result #### Defined in -[src/types/models.ts:83](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L83) +[src/types/models.ts:87](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L87) ___ @@ -99,4 +99,4 @@ ActionAttemptBase.status #### Defined in -[src/types/models.ts:82](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L82) +[src/types/models.ts:86](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L86) diff --git a/docs/interfaces/ConnectWebview.md b/docs/interfaces/ConnectWebview.md index 45983806..1627a002 100644 --- a/docs/interfaces/ConnectWebview.md +++ b/docs/interfaces/ConnectWebview.md @@ -28,7 +28,7 @@ #### Defined in -[src/types/models.ts:112](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L112) +[src/types/models.ts:116](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L116) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[src/types/models.ts:111](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L111) +[src/types/models.ts:115](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L115) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[src/types/models.ts:114](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L114) +[src/types/models.ts:118](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L118) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[src/types/models.ts:113](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L113) +[src/types/models.ts:117](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L117) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[src/types/models.ts:108](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L108) +[src/types/models.ts:112](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L112) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[src/types/models.ts:118](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L118) +[src/types/models.ts:122](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L122) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[src/types/models.ts:115](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L115) +[src/types/models.ts:119](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L119) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[src/types/models.ts:119](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L119) +[src/types/models.ts:123](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L123) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[src/types/models.ts:110](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L110) +[src/types/models.ts:114](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L114) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[src/types/models.ts:116](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L116) +[src/types/models.ts:120](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L120) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[src/types/models.ts:117](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L117) +[src/types/models.ts:121](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L121) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[src/types/models.ts:120](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L120) +[src/types/models.ts:124](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L124) ___ @@ -148,4 +148,4 @@ ___ #### Defined in -[src/types/models.ts:109](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L109) +[src/types/models.ts:113](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L113) diff --git a/docs/interfaces/ConnectWebviewCreateResponse.md b/docs/interfaces/ConnectWebviewCreateResponse.md index 6dfcf1bf..3c6d66f2 100644 --- a/docs/interfaces/ConnectWebviewCreateResponse.md +++ b/docs/interfaces/ConnectWebviewCreateResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:50](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L50) +[src/types/route-responses.ts:51](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L51) diff --git a/docs/interfaces/ConnectWebviewGetResponse.md b/docs/interfaces/ConnectWebviewGetResponse.md index a387334e..0a8a18a1 100644 --- a/docs/interfaces/ConnectWebviewGetResponse.md +++ b/docs/interfaces/ConnectWebviewGetResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:47](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L47) +[src/types/route-responses.ts:48](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L48) diff --git a/docs/interfaces/ConnectWebviewsListResponse.md b/docs/interfaces/ConnectWebviewsListResponse.md index 893dcc7d..6a28a9a4 100644 --- a/docs/interfaces/ConnectWebviewsListResponse.md +++ b/docs/interfaces/ConnectWebviewsListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:44](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L44) +[src/types/route-responses.ts:45](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L45) diff --git a/docs/interfaces/ConnectedAccount.md b/docs/interfaces/ConnectedAccount.md index b6d04f3d..9dbc3b51 100644 --- a/docs/interfaces/ConnectedAccount.md +++ b/docs/interfaces/ConnectedAccount.md @@ -19,7 +19,7 @@ #### Defined in -[src/types/models.ts:149](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L149) +[src/types/models.ts:153](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L153) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[src/types/models.ts:146](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L146) +[src/types/models.ts:150](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L150) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[src/types/models.ts:147](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L147) +[src/types/models.ts:151](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L151) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[src/types/models.ts:148](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L148) +[src/types/models.ts:152](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L152) diff --git a/docs/interfaces/ConnectedAccountsGetResponse.md b/docs/interfaces/ConnectedAccountsGetResponse.md index d965fe44..89d25c96 100644 --- a/docs/interfaces/ConnectedAccountsGetResponse.md +++ b/docs/interfaces/ConnectedAccountsGetResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:65](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L65) +[src/types/route-responses.ts:66](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L66) diff --git a/docs/interfaces/ConnectedAccountsListResponse.md b/docs/interfaces/ConnectedAccountsListResponse.md index f587c238..626aeb13 100644 --- a/docs/interfaces/ConnectedAccountsListResponse.md +++ b/docs/interfaces/ConnectedAccountsListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:62](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L62) +[src/types/route-responses.ts:63](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L63) diff --git a/docs/interfaces/Device.md b/docs/interfaces/Device.md index 886ee4e7..635b379d 100644 --- a/docs/interfaces/Device.md +++ b/docs/interfaces/Device.md @@ -6,7 +6,7 @@ | Name | Type | | :------ | :------ | -| `Properties` | `Properties` | +| `Properties` | extends [`CommonDeviceProperties`](../modules.md#commondeviceproperties) | | `Type` | [`DeviceType`](../modules.md#devicetype) | ## Table of contents @@ -30,7 +30,7 @@ #### Defined in -[src/types/models.ts:31](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L31) +[src/types/models.ts:38](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L38) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[src/types/models.ts:30](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L30) +[src/types/models.ts:37](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L37) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[src/types/models.ts:32](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L32) +[src/types/models.ts:39](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L39) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[src/types/models.ts:25](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L25) +[src/types/models.ts:32](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L32) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[src/types/models.ts:29](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L29) +[src/types/models.ts:36](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L36) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[src/types/models.ts:28](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L28) +[src/types/models.ts:35](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L35) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[src/types/models.ts:27](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L27) +[src/types/models.ts:34](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L34) ___ @@ -100,4 +100,4 @@ ___ #### Defined in -[src/types/models.ts:26](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L26) +[src/types/models.ts:33](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L33) diff --git a/docs/interfaces/DeviceGetResponse.md b/docs/interfaces/DeviceGetResponse.md index 6d8f7ccb..94f2a5a1 100644 --- a/docs/interfaces/DeviceGetResponse.md +++ b/docs/interfaces/DeviceGetResponse.md @@ -12,8 +12,8 @@ ### device -• **device**: [`Device`](Device.md)<`unknown`, [`DeviceType`](../modules.md#devicetype)\> +• **device**: [`Device`](Device.md)<[`CommonDeviceProperties`](../modules.md#commondeviceproperties), [`DeviceType`](../modules.md#devicetype)\> #### Defined in -[src/types/route-responses.ts:39](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L39) +[src/types/route-responses.ts:40](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L40) diff --git a/docs/interfaces/DevicesListResponse.md b/docs/interfaces/DevicesListResponse.md index 01f5abd4..169e9595 100644 --- a/docs/interfaces/DevicesListResponse.md +++ b/docs/interfaces/DevicesListResponse.md @@ -12,8 +12,8 @@ ### devices -• **devices**: [`Device`](Device.md)<`unknown`, [`DeviceType`](../modules.md#devicetype)\>[] +• **devices**: [`Device`](Device.md)<[`CommonDeviceProperties`](../modules.md#commondeviceproperties), [`DeviceType`](../modules.md#devicetype)\>[] #### Defined in -[src/types/route-responses.ts:36](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L36) +[src/types/route-responses.ts:37](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L37) diff --git a/docs/interfaces/LockGetResponse.md b/docs/interfaces/LockGetResponse.md index f8d5f9b6..14964e36 100644 --- a/docs/interfaces/LockGetResponse.md +++ b/docs/interfaces/LockGetResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:31](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L31) +[src/types/route-responses.ts:32](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L32) diff --git a/docs/interfaces/LockProperties.md b/docs/interfaces/LockProperties.md index 7b7fb077..13210ca5 100644 --- a/docs/interfaces/LockProperties.md +++ b/docs/interfaces/LockProperties.md @@ -2,12 +2,17 @@ # Interface: LockProperties +## Hierarchy + +- [`CommonDeviceProperties`](../modules.md#commondeviceproperties) + + ↳ **`LockProperties`** + ## Table of contents ### Properties - [august\_metadata](LockProperties.md#august_metadata) -- [battery\_level](LockProperties.md#battery_level) - [door\_open](LockProperties.md#door_open) - [locked](LockProperties.md#locked) - [name](LockProperties.md#name) @@ -31,17 +36,7 @@ #### Defined in -[src/types/models.ts:47](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L47) - -___ - -### battery\_level - -• `Optional` **battery\_level**: `number` - -#### Defined in - -[src/types/models.ts:39](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L39) +[src/types/models.ts:51](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L51) ___ @@ -51,7 +46,7 @@ ___ #### Defined in -[src/types/models.ts:40](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L40) +[src/types/models.ts:44](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L44) ___ @@ -61,7 +56,7 @@ ___ #### Defined in -[src/types/models.ts:37](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L37) +[src/types/models.ts:43](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L43) ___ @@ -69,9 +64,13 @@ ___ • **name**: `string` +#### Inherited from + +CommonDeviceProperties.name + #### Defined in -[src/types/models.ts:36](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L36) +[src/types/models.ts:25](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L25) ___ @@ -79,9 +78,13 @@ ___ • **online**: `boolean` +#### Inherited from + +CommonDeviceProperties.online + #### Defined in -[src/types/models.ts:38](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L38) +[src/types/models.ts:26](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L26) ___ @@ -98,7 +101,7 @@ ___ #### Defined in -[src/types/models.ts:42](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L42) +[src/types/models.ts:46](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L46) ___ @@ -108,4 +111,4 @@ ___ #### Defined in -[src/types/models.ts:53](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L53) +[src/types/models.ts:57](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L57) diff --git a/docs/interfaces/LocksListResponse.md b/docs/interfaces/LocksListResponse.md index b69f7e96..d82297c5 100644 --- a/docs/interfaces/LocksListResponse.md +++ b/docs/interfaces/LocksListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:27](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L27) +[src/types/route-responses.ts:28](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L28) diff --git a/docs/interfaces/OngoingAccessCode.md b/docs/interfaces/OngoingAccessCode.md index 4d36bb32..6d7591ce 100644 --- a/docs/interfaces/OngoingAccessCode.md +++ b/docs/interfaces/OngoingAccessCode.md @@ -31,7 +31,7 @@ #### Defined in -[src/types/models.ts:124](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L124) +[src/types/models.ts:128](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L128) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[src/types/models.ts:126](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L126) +[src/types/models.ts:130](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L130) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[src/types/models.ts:131](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L131) +[src/types/models.ts:135](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L135) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -[src/types/models.ts:125](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L125) +[src/types/models.ts:129](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L129) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -[src/types/models.ts:132](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L132) +[src/types/models.ts:136](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L136) ___ @@ -89,4 +89,4 @@ ___ #### Defined in -[src/types/models.ts:130](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L130) +[src/types/models.ts:134](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L134) diff --git a/docs/interfaces/PendingActionAttempt.md b/docs/interfaces/PendingActionAttempt.md index f5b1cc73..7bd2a169 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:66](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L66) +[src/types/models.ts:70](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L70) ___ @@ -50,7 +50,7 @@ ActionAttemptBase.action\_type #### Defined in -[src/types/models.ts:67](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L67) +[src/types/models.ts:71](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L71) ___ @@ -64,7 +64,7 @@ ActionAttemptBase.error #### Defined in -[src/types/models.ts:77](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L77) +[src/types/models.ts:81](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L81) ___ @@ -78,7 +78,7 @@ ActionAttemptBase.result #### Defined in -[src/types/models.ts:76](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L76) +[src/types/models.ts:80](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L80) ___ @@ -92,4 +92,4 @@ ActionAttemptBase.status #### Defined in -[src/types/models.ts:75](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L75) +[src/types/models.ts:79](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L79) diff --git a/docs/interfaces/SuccessfulActionAttempt.md b/docs/interfaces/SuccessfulActionAttempt.md index 4ba4f169..1a2f92f0 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:66](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L66) +[src/types/models.ts:70](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L70) ___ @@ -50,7 +50,7 @@ ActionAttemptBase.action\_type #### Defined in -[src/types/models.ts:67](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L67) +[src/types/models.ts:71](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L71) ___ @@ -64,7 +64,7 @@ ActionAttemptBase.error #### Defined in -[src/types/models.ts:98](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L98) +[src/types/models.ts:102](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L102) ___ @@ -78,7 +78,7 @@ ActionAttemptBase.result #### Defined in -[src/types/models.ts:99](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L99) +[src/types/models.ts:103](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L103) ___ @@ -92,4 +92,4 @@ ActionAttemptBase.status #### Defined in -[src/types/models.ts:97](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L97) +[src/types/models.ts:101](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L101) diff --git a/docs/interfaces/TimeBoundAccessCode.md b/docs/interfaces/TimeBoundAccessCode.md index 9a625354..ba5d3107 100644 --- a/docs/interfaces/TimeBoundAccessCode.md +++ b/docs/interfaces/TimeBoundAccessCode.md @@ -33,7 +33,7 @@ #### Defined in -[src/types/models.ts:124](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L124) +[src/types/models.ts:128](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L128) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[src/types/models.ts:126](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L126) +[src/types/models.ts:130](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L130) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[src/types/models.ts:137](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L137) +[src/types/models.ts:141](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L141) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[src/types/models.ts:140](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L140) +[src/types/models.ts:144](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L144) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[src/types/models.ts:125](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L125) +[src/types/models.ts:129](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L129) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -[src/types/models.ts:139](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L139) +[src/types/models.ts:143](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L143) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -[src/types/models.ts:138](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L138) +[src/types/models.ts:142](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L142) ___ @@ -111,4 +111,4 @@ ___ #### Defined in -[src/types/models.ts:136](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L136) +[src/types/models.ts:140](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L140) diff --git a/docs/interfaces/WorkspaceGetResponse.md b/docs/interfaces/WorkspaceGetResponse.md index 30fc2415..807efab4 100644 --- a/docs/interfaces/WorkspaceGetResponse.md +++ b/docs/interfaces/WorkspaceGetResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:17](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L17) +[src/types/route-responses.ts:18](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L18) diff --git a/docs/interfaces/WorkspaceResetSandboxResponse.md b/docs/interfaces/WorkspaceResetSandboxResponse.md index 4320e3cb..8f6399a3 100644 --- a/docs/interfaces/WorkspaceResetSandboxResponse.md +++ b/docs/interfaces/WorkspaceResetSandboxResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:22](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L22) +[src/types/route-responses.ts:23](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L23) diff --git a/docs/interfaces/WorkspacesListResponse.md b/docs/interfaces/WorkspacesListResponse.md index 7e385237..fcfa82be 100644 --- a/docs/interfaces/WorkspacesListResponse.md +++ b/docs/interfaces/WorkspacesListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:14](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L14) +[src/types/route-responses.ts:15](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-responses.ts#L15) diff --git a/docs/modules.md b/docs/modules.md index d5595d0a..15c6d27f 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -60,7 +60,9 @@ - [ActionAttempt](modules.md#actionattempt) - [ActionType](modules.md#actiontype) - [AnyDevice](modules.md#anydevice) +- [CommonDeviceProperties](modules.md#commondeviceproperties) - [DeviceType](modules.md#devicetype) +- [DeviceUpdateRequest](modules.md#deviceupdaterequest) - [LockDevice](modules.md#lockdevice) - [LockDeviceType](modules.md#lockdevicetype) - [NoiseDetectionDeviceType](modules.md#noisedetectiondevicetype) @@ -90,7 +92,7 @@ ___ #### Defined in -[src/types/models.ts:143](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L143) +[src/types/models.ts:147](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L147) ___ @@ -143,7 +145,7 @@ ___ #### Defined in -[src/types/models.ts:102](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L102) +[src/types/models.ts:106](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L106) ___ @@ -153,7 +155,7 @@ ___ #### Defined in -[src/types/models.ts:59](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L59) +[src/types/models.ts:63](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L63) ___ @@ -163,7 +165,24 @@ ___ #### Defined in -[src/types/models.ts:56](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L56) +[src/types/models.ts:60](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L60) + +___ + +### CommonDeviceProperties + +Ƭ **CommonDeviceProperties**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `online` | `boolean` | + +#### Defined in + +[src/types/models.ts:24](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L24) ___ @@ -177,13 +196,32 @@ ___ ___ +### DeviceUpdateRequest + +Ƭ **DeviceUpdateRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `device_id` | `string` | +| `location?` | `object` | +| `name?` | `string` | +| `properties?` | `Partial`<[`CommonDeviceProperties`](modules.md#commondeviceproperties)\> | + +#### Defined in + +[src/types/route-requests.ts:30](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/route-requests.ts#L30) + +___ + ### LockDevice Ƭ **LockDevice**: [`Device`](interfaces/Device.md)<[`LockProperties`](interfaces/LockProperties.md), [`LockDeviceType`](modules.md#lockdevicetype)\> #### Defined in -[src/types/models.ts:57](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L57) +[src/types/models.ts:61](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/models.ts#L61) ___ diff --git a/src/routes.ts b/src/routes.ts index f83bf210..2a787811 100644 --- a/src/routes.ts +++ b/src/routes.ts @@ -15,6 +15,7 @@ import { AccessCodeCreateScheduledRequest, AccessCodeCreateOngoingRequest, ConnectWebviewCreateRequest, + DeviceUpdateRequest, } from "./types/route-requests" import { SeamActionAttemptError } from "./lib/api-error" import { @@ -159,6 +160,12 @@ export abstract class Routes { device_id: deviceId, }, }), + update: (params: DeviceUpdateRequest) => + this.makeRequest({ + url: "/devices/update", + method: "PATCH", + data: params, + }), } public readonly connectWebviews = { diff --git a/src/types/models.ts b/src/types/models.ts index af9b6bd3..6c7a631e 100644 --- a/src/types/models.ts +++ b/src/types/models.ts @@ -21,7 +21,14 @@ export enum Provider { SMARTTHINGS = "smartthings", } -export interface Device { +export type CommonDeviceProperties = { + name: string + online: boolean +} +export interface Device< + Properties extends CommonDeviceProperties, + Type = DeviceType +> { device_id: string workspace_id: string properties: Properties @@ -32,11 +39,8 @@ export interface Device { created_at: string } -export interface LockProperties { - name: string +export interface LockProperties extends CommonDeviceProperties { locked: boolean - online: boolean - battery_level?: number door_open?: boolean schlage_metadata?: { diff --git a/src/types/route-requests.ts b/src/types/route-requests.ts index 79768017..4e269cd9 100644 --- a/src/types/route-requests.ts +++ b/src/types/route-requests.ts @@ -1,4 +1,4 @@ -import { Provider } from "./models" +import { CommonDeviceProperties, Provider } from "./models" export interface ConnectWebviewCreateRequest { accepted_providers: Provider[] @@ -26,3 +26,10 @@ export type AccessCodeDeleteRequest = { device_id?: string access_code_id: string } + +export type DeviceUpdateRequest = { + device_id: string + properties?: Partial + name?: string + location?: object +} diff --git a/src/types/route-responses.ts b/src/types/route-responses.ts index a0d94783..6e3a59ac 100644 --- a/src/types/route-responses.ts +++ b/src/types/route-responses.ts @@ -7,6 +7,7 @@ import { Workspace, ConnectedAccount, ActionType, + CommonDeviceProperties, } from "./models" // Workspaces @@ -33,10 +34,10 @@ export interface LockGetResponse { // Devices export interface DevicesListResponse { - devices: Device[] + devices: Device[] } export interface DeviceGetResponse { - device: Device + device: Device } // Connect Webview