feat: Merge pull request #20 from seamapi/feat-cli

Author: codetheweb

.gitignore

@@ -104,3 +104,4 @@ dist
 .tern-port
 
 *.generated.*
+cli-binaries

README.md

@@ -1,10 +1,28 @@
-# Javascript / Typescript Seam API Library
+# Javascript / Typescript Seam API Library & CLI
 
 Control locks, lights and other internet of things devices with Seam's simple
 API. Check out [the documentation](./docs/modules.md) or [some examples](./examples).
 
 ## Usage
 
+This package contains both a library and a CLI tool.
+
+### CLI Usage
+
+Install with `yarn global add seamapi` or `npm install -g seamapi`.
+
+Then:
+```bash
+export SEAM_API_KEY=<your api key> # you can also pass this as an argument to the CLI
+
+seam workspaces list
+```
+
+### Library Usage
+
+Install with `yarn add seamapi` or `npm install seamapi -s`.
+
+Then:
 ```ts
 // Replace with
 // const Seam = require("seamapi")

docs/README.md

@@ -1,12 +1,30 @@
 seamapi / [Exports](modules.md)
 
-# Javascript / Typescript Seam API Library
+# Javascript / Typescript Seam API Library & CLI
 
 Control locks, lights and other internet of things devices with Seam's simple
 API. Check out [the documentation](./docs/modules.md) or [some examples](./examples).
 
 ## Usage
 
+This package contains both a library and a CLI tool.
+
+### CLI Usage
+
+Install with `yarn global add seamapi` or `npm install -g seamapi`.
+
+Then:
+```bash
+export SEAM_API_KEY=<your api key> # you can also pass this as an argument to the CLI
+
+seam workspaces list
+```
+
+### Library Usage
+
+Install with `yarn add seamapi` or `npm install seamapi -s`.
+
+Then:
 ```ts
 // Replace with
 // const Seam = require("seamapi")

docs/classes/default.md

@@ -62,7 +62,7 @@ Routes.constructor
 | :------ | :------ |
 | `create` | (`params`: [`AccessCodeCreateRequest`](../modules.md#accesscodecreaterequest)) => `Promise`<[`AccessCode`](../interfaces/AccessCode.md)\> |
 | `delete` | (`params`: [`AccessCodeDeleteRequest`](../modules.md#accesscodedeleterequest)) => `Promise`<[`Workspace`](../interfaces/Workspace.md) \| [`Workspace`](../interfaces/Workspace.md)[] \| [`Device`](../interfaces/Device.md)<[`LockProperties`](../interfaces/LockProperties.md), `any`\> \| [`Device`](../interfaces/Device.md)<[`LockProperties`](../interfaces/LockProperties.md), `any`\>[] \| [`ActionAttempt`](../modules.md#actionattempt)<`any`\> \| [`AccessCode`](../interfaces/AccessCode.md) \| [`AccessCode`](../interfaces/AccessCode.md)[] \| [`Device`](../interfaces/Device.md)<`any`, `any`\> \| [`Device`](../interfaces/Device.md)<`any`, `any`\>[] \| [`ConnectWebview`](../interfaces/ConnectWebview.md) \| [`ConnectWebview`](../interfaces/ConnectWebview.md)[] \| [`ConnectedAccount`](../interfaces/ConnectedAccount.md) \| [`ConnectedAccount`](../interfaces/ConnectedAccount.md)[]\> |
-| `list` | (`params`: { `device_id?`: `string`  }) => `Promise`<[`AccessCode`](../interfaces/AccessCode.md)[]\> |
+| `list` | (`params`: { `device_id`: `string`  }) => `Promise`<[`AccessCode`](../interfaces/AccessCode.md)[]\> |
 
 #### Inherited from
 

docs/enums/Provider.md

@@ -0,0 +1,63 @@
+[seamapi](../README.md) / [Exports](../modules.md) / Provider
+
+# Enumeration: Provider
+
+## Table of contents
+
+### Enumeration members
+
+- [AUGUST](Provider.md#august)
+- [NOISEAWARE](Provider.md#noiseaware)
+- [SCHLAGE](Provider.md#schlage)
+- [SMARTTHINGS](Provider.md#smartthings)
+- [YALE](Provider.md#yale)
+
+## Enumeration members
+
+### AUGUST
+
+• **AUGUST** = `"august"`
+
+#### Defined in
+
+[src/types/models.ts:13](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L13)
+
+___
+
+### NOISEAWARE
+
+• **NOISEAWARE** = `"noiseaware"`
+
+#### Defined in
+
+[src/types/models.ts:16](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L16)
+
+___
+
+### SCHLAGE
+
+• **SCHLAGE** = `"schlage"`
+
+#### Defined in
+
+[src/types/models.ts:14](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L14)
+
+___
+
+### SMARTTHINGS
+
+• **SMARTTHINGS** = `"smartthings"`
+
+#### Defined in
+
+[src/types/models.ts:17](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L17)
+
+___
+
+### YALE
+
+• **YALE** = `"yale"`
+
+#### Defined in
+
+[src/types/models.ts:15](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L15)

docs/interfaces/AccessCode.md

@@ -21,7 +21,7 @@
 
 #### Defined in
 
-[src/types/models.ts:111](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L111)
+[src/types/models.ts:112](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L112)
 
 ___
 
@@ -31,7 +31,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:112](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L112)
+[src/types/models.ts:113](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L113)
 
 ___
 
@@ -41,7 +41,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:115](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L115)
+[src/types/models.ts:116](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L116)
 
 ___
 
@@ -51,7 +51,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:113](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L113)
+[src/types/models.ts:114](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L114)
 
 ___
 
@@ -61,7 +61,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:116](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L116)
+[src/types/models.ts:117](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L117)
 
 ___
 
@@ -71,4 +71,4 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:114](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L114)
+[src/types/models.ts:115](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L115)

docs/interfaces/ActionAttemptResultTypeMap.md

@@ -25,7 +25,7 @@
 
 #### Defined in
 
-[src/types/models.ts:145](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L145)
+[src/types/models.ts:146](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L146)
 
 ___
 
@@ -35,7 +35,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:146](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L146)
+[src/types/models.ts:147](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L147)
 
 ___
 
@@ -45,7 +45,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:143](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L143)
+[src/types/models.ts:144](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L144)
 
 ___
 
@@ -55,4 +55,4 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:144](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L144)
+[src/types/models.ts:145](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L145)

docs/interfaces/ActionAttemptWithError.md

@@ -36,7 +36,7 @@ ActionAttemptBase.action\_attempt\_id
 
 #### Defined in
 
-[src/types/models.ts:58](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L58)
+[src/types/models.ts:59](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L59)
 
 ___
 
@@ -50,7 +50,7 @@ ActionAttemptBase.action\_type
 
 #### Defined in
 
-[src/types/models.ts:59](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L59)
+[src/types/models.ts:60](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L60)
 
 ___
 
@@ -71,7 +71,7 @@ ActionAttemptBase.error
 
 #### Defined in
 
-[src/types/models.ts:76](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L76)
+[src/types/models.ts:77](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L77)
 
 ___
 
@@ -85,7 +85,7 @@ ActionAttemptBase.result
 
 #### Defined in
 
-[src/types/models.ts:75](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L75)
+[src/types/models.ts:76](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L76)
 
 ___
 
@@ -99,4 +99,4 @@ ActionAttemptBase.status
 
 #### Defined in
 
-[src/types/models.ts:74](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L74)
+[src/types/models.ts:75](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L75)

docs/interfaces/ConnectWebview.md

@@ -28,17 +28,17 @@
 
 #### Defined in
 
-[src/types/models.ts:99](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L99)
+[src/types/models.ts:100](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L100)
 
 ___
 
 ### accepted\_providers
 
-• **accepted\_providers**: [`Provider`](../modules.md#provider)[]
+• **accepted\_providers**: [`Provider`](../enums/Provider.md)[]
 
 #### Defined in
 
-[src/types/models.ts:98](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L98)
+[src/types/models.ts:99](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L99)
 
 ___
 
@@ -48,7 +48,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:101](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L101)
+[src/types/models.ts:102](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L102)
 
 ___
 
@@ -58,7 +58,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:100](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L100)
+[src/types/models.ts:101](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L101)
 
 ___
 
@@ -68,7 +68,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:95](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L95)
+[src/types/models.ts:96](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L96)
 
 ___
 
@@ -78,7 +78,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:105](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L105)
+[src/types/models.ts:106](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L106)
 
 ___
 
@@ -88,7 +88,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:102](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L102)
+[src/types/models.ts:103](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L103)
 
 ___
 
@@ -98,7 +98,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:106](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L106)
+[src/types/models.ts:107](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L107)
 
 ___
 
@@ -108,7 +108,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:97](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L97)
+[src/types/models.ts:98](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L98)
 
 ___
 
@@ -118,7 +118,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:103](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L103)
+[src/types/models.ts:104](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L104)
 
 ___
 
@@ -128,7 +128,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:104](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L104)
+[src/types/models.ts:105](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L105)
 
 ___
 
@@ -138,7 +138,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:107](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L107)
+[src/types/models.ts:108](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L108)
 
 ___
 
@@ -148,4 +148,4 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:96](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L96)
+[src/types/models.ts:97](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L97)

docs/interfaces/ConnectWebviewCreateRequest.md

@@ -12,7 +12,7 @@
 
 ### accepted\_providers
 
-• **accepted\_providers**: [`Provider`](../modules.md#provider)[]
+• **accepted\_providers**: [`Provider`](../enums/Provider.md)[]
 
 #### Defined in