Merge pull request #36 from seamapi/doc-wait-with-get

docs: Document how to wait on an action_attempt_id
seamapi · Dec 24, 2023 · b6e5763 · b6e5763
2 parents 8bf6300 + 49ffbc1
commit b6e5763
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -211,6 +211,18 @@ const seam = new SeamHttp({
 await seam.locks.unlockDoor({ device_id })
 ```
 
+If you have already have an action attempt id
+and want to wait for it to resolve, simply use
+
+```ts
+await seam.actionAttempts.get(
+  { action_attempt_id },
+  {
+    waitForActionAttempt: true,
+  },
+)
+```
+
 Using the `waitForActionAttempt` option:
 
 - Polls the action attempt up to the `timeout`