From 6c373c86d0116297cca7675c29e0d9d9a991d019 Mon Sep 17 00:00:00 2001 From: Evan Sosenko Date: Tue, 30 May 2023 20:45:02 -0700 Subject: [PATCH 1/2] Add deviceModels.list --- docs/classes/Seam.md | 41 ++++++-- .../AccessCodeCreateMultipleResponse.md | 2 +- docs/interfaces/AccessCodeCreateResponse.md | 4 +- docs/interfaces/AccessCodeGetResponse.md | 2 +- docs/interfaces/AccessCodesListResponse.md | 2 +- .../interfaces/ActionAttemptCreateResponse.md | 2 +- docs/interfaces/ActionAttemptGetResponse.md | 2 +- docs/interfaces/ClientSessionResponse.md | 2 +- .../ConnectWebviewCreateResponse.md | 2 +- docs/interfaces/ConnectWebviewGetResponse.md | 2 +- .../interfaces/ConnectWebviewsListResponse.md | 2 +- .../ConnectedAccountsGetResponse.md | 2 +- .../ConnectedAccountsListResponse.md | 2 +- docs/interfaces/DeviceGetResponse.md | 2 +- docs/interfaces/DeviceModel.md | 96 +++++++++++++++++++ .../interfaces/DeviceProvidersListResponse.md | 2 +- docs/interfaces/DevicesListResponse.md | 2 +- docs/interfaces/EventsListResponse.md | 2 +- docs/interfaces/LockGetResponse.md | 2 +- docs/interfaces/LocksListResponse.md | 2 +- .../UnmanagedAccessCodesGetResponse.md | 2 +- .../UnmanagedAccessCodesListResponse.md | 2 +- .../interfaces/UnmanagedDeviceListResponse.md | 2 +- docs/interfaces/WebhookGetResponse.md | 2 +- docs/interfaces/WebhookListResponse.md | 2 +- docs/interfaces/WorkspaceGetResponse.md | 2 +- .../WorkspaceResetSandboxResponse.md | 2 +- docs/interfaces/WorkspacesListResponse.md | 2 +- docs/modules.md | 40 +++++++- src/seam-connect/routes.ts | 10 ++ src/types/models.ts | 11 +++ src/types/route-requests.ts | 7 ++ src/types/route-responses.ts | 5 + 33 files changed, 226 insertions(+), 38 deletions(-) create mode 100644 docs/interfaces/DeviceModel.md diff --git a/docs/classes/Seam.md b/docs/classes/Seam.md index 5f0f7c67..c98ed424 100644 --- a/docs/classes/Seam.md +++ b/docs/classes/Seam.md @@ -21,6 +21,7 @@ - [client](Seam.md#client) - [connectWebviews](Seam.md#connectwebviews) - [connectedAccounts](Seam.md#connectedaccounts) +- [deviceModels](Seam.md#devicemodels) - [devices](Seam.md#devices) - [events](Seam.md#events) - [locks](Seam.md#locks) @@ -82,7 +83,7 @@ Routes.accessCodes #### Defined in -[src/seam-connect/routes.ts:280](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L280) +[src/seam-connect/routes.ts:282](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L282) ___ @@ -102,7 +103,7 @@ Routes.actionAttempts #### Defined in -[src/seam-connect/routes.ts:402](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L402) +[src/seam-connect/routes.ts:404](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L404) ___ @@ -135,7 +136,7 @@ Routes.connectWebviews #### Defined in -[src/seam-connect/routes.ts:248](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L248) +[src/seam-connect/routes.ts:250](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L250) ___ @@ -157,7 +158,27 @@ Routes.connectedAccounts #### Defined in -[src/seam-connect/routes.ts:377](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L377) +[src/seam-connect/routes.ts:379](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L379) + +___ + +### deviceModels + +• `Readonly` **deviceModels**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `list` | (`params?`: [`DeviceModelsListRequest`](../modules.md#devicemodelslistrequest)) => `Promise`<[`DeviceModel`](../interfaces/DeviceModel.md)[]\> | + +#### Inherited from + +Routes.deviceModels + +#### Defined in + +[src/seam-connect/routes.ts:470](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L470) ___ @@ -184,7 +205,7 @@ Routes.devices #### Defined in -[src/seam-connect/routes.ts:189](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L189) +[src/seam-connect/routes.ts:191](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L191) ___ @@ -204,7 +225,7 @@ Routes.events #### Defined in -[src/seam-connect/routes.ts:236](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L236) +[src/seam-connect/routes.ts:238](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L238) ___ @@ -227,7 +248,7 @@ Routes.locks #### Defined in -[src/seam-connect/routes.ts:154](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L154) +[src/seam-connect/routes.ts:156](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L156) ___ @@ -250,7 +271,7 @@ Routes.noiseThresholds #### Defined in -[src/seam-connect/routes.ts:412](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L412) +[src/seam-connect/routes.ts:414](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L414) ___ @@ -273,7 +294,7 @@ Routes.webhooks #### Defined in -[src/seam-connect/routes.ts:443](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L443) +[src/seam-connect/routes.ts:445](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L445) ___ @@ -295,7 +316,7 @@ Routes.workspaces #### Defined in -[src/seam-connect/routes.ts:138](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L138) +[src/seam-connect/routes.ts:140](https://github.com/seamapi/javascript/blob/main/src/seam-connect/routes.ts#L140) ## Methods diff --git a/docs/interfaces/AccessCodeCreateMultipleResponse.md b/docs/interfaces/AccessCodeCreateMultipleResponse.md index 0707faa7..990f7e6e 100644 --- a/docs/interfaces/AccessCodeCreateMultipleResponse.md +++ b/docs/interfaces/AccessCodeCreateMultipleResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:86](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L86) +[src/types/route-responses.ts:87](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L87) diff --git a/docs/interfaces/AccessCodeCreateResponse.md b/docs/interfaces/AccessCodeCreateResponse.md index a19663ae..17176219 100644 --- a/docs/interfaces/AccessCodeCreateResponse.md +++ b/docs/interfaces/AccessCodeCreateResponse.md @@ -29,7 +29,7 @@ #### Defined in -[src/types/route-responses.ts:79](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L79) +[src/types/route-responses.ts:80](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L80) ___ @@ -43,4 +43,4 @@ ___ #### Defined in -[src/types/route-responses.ts:123](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L123) +[src/types/route-responses.ts:124](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L124) diff --git a/docs/interfaces/AccessCodeGetResponse.md b/docs/interfaces/AccessCodeGetResponse.md index 3015bbb0..c10969eb 100644 --- a/docs/interfaces/AccessCodeGetResponse.md +++ b/docs/interfaces/AccessCodeGetResponse.md @@ -22,4 +22,4 @@ #### Defined in -[src/types/route-responses.ts:79](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L79) +[src/types/route-responses.ts:80](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L80) diff --git a/docs/interfaces/AccessCodesListResponse.md b/docs/interfaces/AccessCodesListResponse.md index a6a0f9fa..15117753 100644 --- a/docs/interfaces/AccessCodesListResponse.md +++ b/docs/interfaces/AccessCodesListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:76](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L76) +[src/types/route-responses.ts:77](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L77) diff --git a/docs/interfaces/ActionAttemptCreateResponse.md b/docs/interfaces/ActionAttemptCreateResponse.md index 30811438..abe8a5a9 100644 --- a/docs/interfaces/ActionAttemptCreateResponse.md +++ b/docs/interfaces/ActionAttemptCreateResponse.md @@ -22,4 +22,4 @@ #### Defined in -[src/types/route-responses.ts:119](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L119) +[src/types/route-responses.ts:120](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L120) diff --git a/docs/interfaces/ActionAttemptGetResponse.md b/docs/interfaces/ActionAttemptGetResponse.md index feb4d33f..f1373510 100644 --- a/docs/interfaces/ActionAttemptGetResponse.md +++ b/docs/interfaces/ActionAttemptGetResponse.md @@ -28,4 +28,4 @@ #### Defined in -[src/types/route-responses.ts:123](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L123) +[src/types/route-responses.ts:124](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L124) diff --git a/docs/interfaces/ClientSessionResponse.md b/docs/interfaces/ClientSessionResponse.md index 33e395ee..1f8899aa 100644 --- a/docs/interfaces/ClientSessionResponse.md +++ b/docs/interfaces/ClientSessionResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:132](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L132) +[src/types/route-responses.ts:133](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L133) diff --git a/docs/interfaces/ConnectWebviewCreateResponse.md b/docs/interfaces/ConnectWebviewCreateResponse.md index aace7b98..1e5c92ed 100644 --- a/docs/interfaces/ConnectWebviewCreateResponse.md +++ b/docs/interfaces/ConnectWebviewCreateResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:68](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L68) +[src/types/route-responses.ts:69](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L69) diff --git a/docs/interfaces/ConnectWebviewGetResponse.md b/docs/interfaces/ConnectWebviewGetResponse.md index d624eb0c..798e3e52 100644 --- a/docs/interfaces/ConnectWebviewGetResponse.md +++ b/docs/interfaces/ConnectWebviewGetResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:65](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L65) +[src/types/route-responses.ts:66](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L66) diff --git a/docs/interfaces/ConnectWebviewsListResponse.md b/docs/interfaces/ConnectWebviewsListResponse.md index 6f044d0f..f672d1ef 100644 --- a/docs/interfaces/ConnectWebviewsListResponse.md +++ b/docs/interfaces/ConnectWebviewsListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:62](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L62) +[src/types/route-responses.ts:63](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L63) diff --git a/docs/interfaces/ConnectedAccountsGetResponse.md b/docs/interfaces/ConnectedAccountsGetResponse.md index 4f540c33..e580635c 100644 --- a/docs/interfaces/ConnectedAccountsGetResponse.md +++ b/docs/interfaces/ConnectedAccountsGetResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:102](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L102) +[src/types/route-responses.ts:103](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L103) diff --git a/docs/interfaces/ConnectedAccountsListResponse.md b/docs/interfaces/ConnectedAccountsListResponse.md index eccf0c32..d1ca6612 100644 --- a/docs/interfaces/ConnectedAccountsListResponse.md +++ b/docs/interfaces/ConnectedAccountsListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:99](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L99) +[src/types/route-responses.ts:100](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L100) diff --git a/docs/interfaces/DeviceGetResponse.md b/docs/interfaces/DeviceGetResponse.md index b7e2d530..fdf00614 100644 --- a/docs/interfaces/DeviceGetResponse.md +++ b/docs/interfaces/DeviceGetResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:47](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L47) +[src/types/route-responses.ts:48](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L48) diff --git a/docs/interfaces/DeviceModel.md b/docs/interfaces/DeviceModel.md new file mode 100644 index 00000000..9c662cde --- /dev/null +++ b/docs/interfaces/DeviceModel.md @@ -0,0 +1,96 @@ +[seamapi](../README.md) / [Exports](../modules.md) / DeviceModel + +# Interface: DeviceModel + +## Table of contents + +### Properties + +- [brand](DeviceModel.md#brand) +- [connection\_type](DeviceModel.md#connection_type) +- [icon\_url](DeviceModel.md#icon_url) +- [main\_category](DeviceModel.md#main_category) +- [manufacturer\_model\_id](DeviceModel.md#manufacturer_model_id) +- [model\_name](DeviceModel.md#model_name) +- [seam\_device\_model\_page\_url](DeviceModel.md#seam_device_model_page_url) +- [support\_level](DeviceModel.md#support_level) + +## Properties + +### brand + +• **brand**: `string` + +#### Defined in + +[src/types/models.ts:364](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L364) + +___ + +### connection\_type + +• **connection\_type**: ``"unknown"`` \| ``"wifi"`` \| ``"zwave"`` \| ``"zigbee"`` + +#### Defined in + +[src/types/models.ts:362](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L362) + +___ + +### icon\_url + +• **icon\_url**: `string` + +#### Defined in + +[src/types/models.ts:365](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L365) + +___ + +### main\_category + +• **main\_category**: `string` + +#### Defined in + +[src/types/models.ts:359](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L359) + +___ + +### manufacturer\_model\_id + +• **manufacturer\_model\_id**: `string` + +#### Defined in + +[src/types/models.ts:361](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L361) + +___ + +### model\_name + +• **model\_name**: `string` + +#### Defined in + +[src/types/models.ts:360](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L360) + +___ + +### seam\_device\_model\_page\_url + +• **seam\_device\_model\_page\_url**: `string` + +#### Defined in + +[src/types/models.ts:366](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L366) + +___ + +### support\_level + +• **support\_level**: ``"live"`` \| ``"beta"`` \| ``"unsupported"`` + +#### Defined in + +[src/types/models.ts:363](https://github.com/seamapi/javascript/blob/main/src/types/models.ts#L363) diff --git a/docs/interfaces/DeviceProvidersListResponse.md b/docs/interfaces/DeviceProvidersListResponse.md index 1618293f..5347740e 100644 --- a/docs/interfaces/DeviceProvidersListResponse.md +++ b/docs/interfaces/DeviceProvidersListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:57](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L57) +[src/types/route-responses.ts:58](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L58) diff --git a/docs/interfaces/DevicesListResponse.md b/docs/interfaces/DevicesListResponse.md index df5609c5..12f2442b 100644 --- a/docs/interfaces/DevicesListResponse.md +++ b/docs/interfaces/DevicesListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:44](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L44) +[src/types/route-responses.ts:45](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L45) diff --git a/docs/interfaces/EventsListResponse.md b/docs/interfaces/EventsListResponse.md index 70fd4018..71f092f6 100644 --- a/docs/interfaces/EventsListResponse.md +++ b/docs/interfaces/EventsListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:128](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L128) +[src/types/route-responses.ts:129](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L129) diff --git a/docs/interfaces/LockGetResponse.md b/docs/interfaces/LockGetResponse.md index 60c8ac49..bdb425eb 100644 --- a/docs/interfaces/LockGetResponse.md +++ b/docs/interfaces/LockGetResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:39](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L39) +[src/types/route-responses.ts:40](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L40) diff --git a/docs/interfaces/LocksListResponse.md b/docs/interfaces/LocksListResponse.md index a1832e68..6e04f917 100644 --- a/docs/interfaces/LocksListResponse.md +++ b/docs/interfaces/LocksListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:35](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L35) +[src/types/route-responses.ts:36](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L36) diff --git a/docs/interfaces/UnmanagedAccessCodesGetResponse.md b/docs/interfaces/UnmanagedAccessCodesGetResponse.md index 2eb69a47..09b8ce74 100644 --- a/docs/interfaces/UnmanagedAccessCodesGetResponse.md +++ b/docs/interfaces/UnmanagedAccessCodesGetResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:94](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L94) +[src/types/route-responses.ts:95](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L95) diff --git a/docs/interfaces/UnmanagedAccessCodesListResponse.md b/docs/interfaces/UnmanagedAccessCodesListResponse.md index 037eac2e..9e7b1db2 100644 --- a/docs/interfaces/UnmanagedAccessCodesListResponse.md +++ b/docs/interfaces/UnmanagedAccessCodesListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:91](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L91) +[src/types/route-responses.ts:92](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L92) diff --git a/docs/interfaces/UnmanagedDeviceListResponse.md b/docs/interfaces/UnmanagedDeviceListResponse.md index 14bd1a17..bca3681c 100644 --- a/docs/interfaces/UnmanagedDeviceListResponse.md +++ b/docs/interfaces/UnmanagedDeviceListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:52](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L52) +[src/types/route-responses.ts:53](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L53) diff --git a/docs/interfaces/WebhookGetResponse.md b/docs/interfaces/WebhookGetResponse.md index 3d476c3d..37d43645 100644 --- a/docs/interfaces/WebhookGetResponse.md +++ b/docs/interfaces/WebhookGetResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:111](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L111) +[src/types/route-responses.ts:112](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L112) diff --git a/docs/interfaces/WebhookListResponse.md b/docs/interfaces/WebhookListResponse.md index 619f1e42..b4584a55 100644 --- a/docs/interfaces/WebhookListResponse.md +++ b/docs/interfaces/WebhookListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:107](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L107) +[src/types/route-responses.ts:108](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L108) diff --git a/docs/interfaces/WorkspaceGetResponse.md b/docs/interfaces/WorkspaceGetResponse.md index be29e1b1..978e7ee9 100644 --- a/docs/interfaces/WorkspaceGetResponse.md +++ b/docs/interfaces/WorkspaceGetResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:25](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L25) +[src/types/route-responses.ts:26](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L26) diff --git a/docs/interfaces/WorkspaceResetSandboxResponse.md b/docs/interfaces/WorkspaceResetSandboxResponse.md index 11db3d15..07ac184a 100644 --- a/docs/interfaces/WorkspaceResetSandboxResponse.md +++ b/docs/interfaces/WorkspaceResetSandboxResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:30](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L30) +[src/types/route-responses.ts:31](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L31) diff --git a/docs/interfaces/WorkspacesListResponse.md b/docs/interfaces/WorkspacesListResponse.md index d813ab10..02860321 100644 --- a/docs/interfaces/WorkspacesListResponse.md +++ b/docs/interfaces/WorkspacesListResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/route-responses.ts:22](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L22) +[src/types/route-responses.ts:23](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L23) diff --git a/docs/modules.md b/docs/modules.md index 5965ffd7..a88b8876 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -54,6 +54,7 @@ - [ConnectedAccountsListResponse](interfaces/ConnectedAccountsListResponse.md) - [Device](interfaces/Device.md) - [DeviceGetResponse](interfaces/DeviceGetResponse.md) +- [DeviceModel](interfaces/DeviceModel.md) - [DeviceProvider](interfaces/DeviceProvider.md) - [DeviceProvidersListRequest](interfaces/DeviceProvidersListRequest.md) - [DeviceProvidersListResponse](interfaces/DeviceProvidersListResponse.md) @@ -114,6 +115,8 @@ - [DeviceDeleteRequest](modules.md#devicedeleterequest) - [DeviceGetRequest](modules.md#devicegetrequest) - [DeviceLocation](modules.md#devicelocation) +- [DeviceModelsListRequest](modules.md#devicemodelslistrequest) +- [DeviceModelsListResponse](modules.md#devicemodelslistresponse) - [DeviceType](modules.md#devicetype) - [DeviceUpdateRequest](modules.md#deviceupdaterequest) - [Event](modules.md#event) @@ -435,6 +438,41 @@ ___ ___ +### DeviceModelsListRequest + +Ƭ **DeviceModelsListRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `brand?` | `string` | +| `main_category?` | `string` | +| `support_level?` | `string` | +| `text_search?` | `string` | + +#### Defined in + +[src/types/route-requests.ts:212](https://github.com/seamapi/javascript/blob/main/src/types/route-requests.ts#L212) + +___ + +### DeviceModelsListResponse + +Ƭ **DeviceModelsListResponse**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `device_models` | [`DeviceModel`](interfaces/DeviceModel.md)[] | + +#### Defined in + +[src/types/route-responses.ts:140](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L140) + +___ + ### DeviceType Ƭ **DeviceType**: [`LockDeviceType`](modules.md#lockdevicetype) \| [`NoiseDetectionDeviceType`](modules.md#noisedetectiondevicetype) @@ -593,7 +631,7 @@ ___ #### Defined in -[src/types/route-responses.ts:135](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L135) +[src/types/route-responses.ts:136](https://github.com/seamapi/javascript/blob/main/src/types/route-responses.ts#L136) ___ diff --git a/src/seam-connect/routes.ts b/src/seam-connect/routes.ts index d5d12ac5..a9a03383 100644 --- a/src/seam-connect/routes.ts +++ b/src/seam-connect/routes.ts @@ -43,6 +43,7 @@ import { NoiseThresholdsCreateRequest, NoiseThresholdsUpdateRequest, UnmanagedAccessCodeConvertToManagedRequest, + DeviceModelsListRequest, } from "../types/route-requests" import { AccessCodeCreateMultipleResponse, @@ -71,6 +72,7 @@ import { WorkspaceResetSandboxResponse, WorkspacesListResponse, NoiseThresholdsListResponse, + DeviceModelsListResponse, } from "../types/route-responses" export abstract class Routes { @@ -464,4 +466,12 @@ export abstract class Routes { params, }), } + + public readonly deviceModels = { + list: (params?: DeviceModelsListRequest) => + this.makeRequestAndFormat("device_models", { + url: "/device_models/list", + params, + }), + } } diff --git a/src/types/models.ts b/src/types/models.ts index ab91c8b1..443450cb 100644 --- a/src/types/models.ts +++ b/src/types/models.ts @@ -354,3 +354,14 @@ export type NoiseThresholds = { */ noise_threshold_nrs?: number } + +export interface DeviceModel { + main_category: string + model_name: string + manufacturer_model_id: string + connection_type: "wifi" | "zwave" | "zigbee" | "unknown" + support_level: "live" | "beta" | "unsupported" + brand: string + icon_url: string + seam_device_model_page_url: string +} diff --git a/src/types/route-requests.ts b/src/types/route-requests.ts index d60ec188..2c2da789 100644 --- a/src/types/route-requests.ts +++ b/src/types/route-requests.ts @@ -208,3 +208,10 @@ export type NoiseThresholdsDeleteRequest = { device_id: string noise_threshold_id: string } + +export type DeviceModelsListRequest = { + main_category?: string + support_level?: string + brand?: string + text_search?: string +} diff --git a/src/types/route-responses.ts b/src/types/route-responses.ts index 2e75b782..ee78d5d4 100644 --- a/src/types/route-responses.ts +++ b/src/types/route-responses.ts @@ -15,6 +15,7 @@ import { Webhook, Workspace, NoiseThresholds, + DeviceModel, } from "./models" // Workspaces @@ -135,3 +136,7 @@ export interface ClientSessionResponse { export type NoiseThresholdsListResponse = { noise_thresholds: NoiseThresholds[] } + +export type DeviceModelsListResponse = { + device_models: DeviceModel[] +} From 8ab78cd33880e3589161c6f4d78f3017d3221bf3 Mon Sep 17 00:00:00 2001 From: Evan Sosenko Date: Wed, 31 May 2023 15:30:02 -0700 Subject: [PATCH 2/2] Fix path to device_models --- src/seam-connect/routes.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/seam-connect/routes.ts b/src/seam-connect/routes.ts index a9a03383..5f00a82b 100644 --- a/src/seam-connect/routes.ts +++ b/src/seam-connect/routes.ts @@ -470,7 +470,7 @@ export abstract class Routes { public readonly deviceModels = { list: (params?: DeviceModelsListRequest) => this.makeRequestAndFormat("device_models", { - url: "/device_models/list", + url: "/internal/device_models/list", params, }), }