Usage example for readme

README.md

@@ -2,6 +2,44 @@
 
 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
+
+```ts
+import Seam from seamapi
+
+const seam = new Seam()
+// Seam will automatically use the SEAM_API_KEY environment variable if you
+// don't provide an api_key to `new Seam()`
+
+const someLock = await seam.locks.list().devices[0]
+const someLockId = someLock.device_id
+
+await seam.locks.lockDoor(someLockId)
+const { device: someLockedLock } = await seam.locks.get(someLockId)
+// someLockedLock.properties.locked === true
+
+await seam.locks.unlockDoor(someLockId)
+
+await seam.accessCodes.create(someLockId, { name: "Some Access Code", code: "1234" })
+
+const accessCodeList = await seam.accessCodes.list(someLockId)
+console.log(accessCodeList)
+/*
+{
+    access_codes: [
+      {
+        access_code_id: "some-access-code-1",
+        name: "Some Access Code",
+        code: "1234",
+        type: "ongoing",
+        created_at: "2022-02-01T12:57:40.843Z",
+      },
+    ],
+  }
+*/
+```
+
 ## In Progress
 
 This library is in progress!

docs/README.md

@@ -4,6 +4,43 @@ seamapi / [Exports](modules.md)
 
 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
+
+```ts
+import Seam from seamapi
+
+const seam = new Seam()
+// Seam will automatically use the SEAM_API_KEY environment variable if you
+// don't provide an api_key to `new Seam()`
+
+const someLock = await seam.locks.list().devices[0]
+const someLockId = someLock.device_id
+
+await seam.locks.lockDoor(someLockId)
+const { device: someLockedLock } = await seam.locks.get(someLockId)
+// someLockedLock.properties.locked === true
+
+await seam.locks.unlockDoor(someLockId)
+
+await seam.accessCodes.create(someLockId, { name: "Some Access Code", code: "1234" })
+
+const accessCodeList = await seam.accessCodes.list(someLockId)
+console.log(accessCodeList)
+/*
+{
+    access_codes: [
+      {
+        access_code_id: "some-access-code-1",
+        name: "Some Access Code",
+        code: "1234",
+        type: "ongoing",
+        created_at: "2022-02-01T12:57:40.843Z",
+      },
+    ],
+  }
+*/
+```
+
 ## In Progress
 
 This library is in progress!

docs/interfaces/AccessCode.md

@@ -20,7 +20,7 @@
 
 #### Defined in
 
-[src/types/models.ts:67](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L67)
+[src/types/models.ts:68](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L68)
 
 ___
 
@@ -30,7 +30,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:63](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L63)
+[src/types/models.ts:64](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L64)
 
 ___
 
@@ -40,7 +40,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:66](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L66)
+[src/types/models.ts:67](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L67)
 
 ___
 
@@ -50,7 +50,7 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:64](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L64)
+[src/types/models.ts:65](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L65)
 
 ___
 
@@ -60,4 +60,4 @@ ___
 
 #### Defined in
 
-[src/types/models.ts:65](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L65)
+[src/types/models.ts:66](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L66)

docs/interfaces/ConnectWebview.md

@@ -16,6 +16,7 @@
 - [device\_selection\_mode](ConnectWebview.md#device_selection_mode)
 - [login\_successful](ConnectWebview.md#login_successful)
 - [status](ConnectWebview.md#status)
+- [url](ConnectWebview.md#url)
 - [workspace\_id](ConnectWebview.md#workspace_id)
 
 ## Properties
@@ -120,6 +121,16 @@ ___
 
 ___
 
+### url
+
+• **url**: `string`
+
+#### Defined in
+
+[src/types/models.ts:60](https://github.com/hello-seam/seamapi-javascript/blob/main/src/types/models.ts#L60)
+
+___
+
 ### workspace\_id
 
 • **workspace\_id**: `string`

src/types/models.ts

@@ -57,6 +57,7 @@ export interface ConnectWebview {
   login_successful: boolean
   status: "pending" | "authorized"
   connected_account_id: null | string
+  url: string
 }
 
 export interface AccessCode {