@seamapi/http 0.30.1 → 0.32.0

package/README.md

@@ -170,7 +170,7 @@ or create a new empty client session.
 
 A Personal Access Token is scoped to a Seam Console user.
 Obtain one from the Seam Console.
-A workspace id must be provided when using this method
+A workspace ID must be provided when using this method
 and all requests will be scoped to that workspace.
 
 ```ts
@@ -192,7 +192,7 @@ const seam = SeamHttp.fromPersonalAccessToken(
 
 A Console Session Token is used by the Seam Console.
 This authentication method is only used by internal Seam applications.
-A workspace id must be provided when using this method
+A workspace ID must be provided when using this method
 and all requests will be scoped to that workspace.
 
 ```ts
@@ -212,53 +212,62 @@ const seam = SeamHttp.fromConsoleSessionToken(
 ### Action Attempts
 
 Some asynchronous operations, e.g., unlocking a door, return an [action attempt].
-Seam tracks the progress of requested operation and updates the action attempt.
+Seam tracks the progress of the requested operation and updates the action attempt
+when it succeeds or fails.
 
 To make working with action attempts more convenient for applications,
-this library provides the `waitForActionAttempt` option.
+this library provides the `waitForActionAttempt` option and enables it by default.
 
-Pass the option per-request,
+When the `waitForActionAttempt` option is enabled, the SDK:
+
+- Polls the action attempt up to the `timeout`
+  at the `pollingInterval` (both in milliseconds).
+- Resolves with a fresh copy of the successful action attempt.
+- Rejects with a `SeamActionAttemptFailedError` if the action attempt is unsuccessful.
+- Rejects with a `SeamActionAttemptTimeoutError` if the action attempt is still pending when the `timeout` is reached.
+- Both errors expose an `actionAttempt` property.
+
+If you already have an action attempt ID
+and want to wait for it to resolve, simply use
 
 ```ts
-await seam.locks.unlockDoor(
-  { device_id },
+await seam.actionAttempts.get({ action_attempt_id })
+```
+
+Or, to get the current state of an action attempt by ID without waiting,
+
+```ts
+await seam.actionAttempts.get(
+  { action_attempt_id },
   {
-    waitForActionAttempt: true,
+    waitForActionAttempt: false,
   },
 )
 ```
 
-or set the default option for the client:
+To disable this behavior, set the default option for the client,
 
 ```ts
 const seam = new SeamHttp({
   apiKey: 'your-api-key',
-  waitForActionAttempt: true,
+  waitForActionAttempt: false,
 })
 
 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
+or the behavior may be configured per-request,
 
 ```ts
-await seam.actionAttempts.get(
-  { action_attempt_id },
+await seam.locks.unlockDoor(
+  { device_id },
   {
-    waitForActionAttempt: true,
+    waitForActionAttempt: false,
   },
 )
 ```
 
-Using the `waitForActionAttempt` option:
-
-- Polls the action attempt up to the `timeout`
-  at the `pollingInterval` (both in milliseconds).
-- Resolves with a fresh copy of the successful action attempt.
-- Rejects with a `SeamActionAttemptFailedError` if the action attempt is unsuccessful.
-- Rejects with a `SeamActionAttemptTimeoutError` if the action attempt is still pending when the `timeout` is reached.
-- Both errors expose an `actionAttempt` property.
+The `pollingInterval` and `timeout` may be configured for the client or per-request, for example
 
 ```ts
 import {
@@ -267,22 +276,19 @@ import {
   isSeamActionAttemptTimeoutError,
 } from '@seamapi/http/connect'
 
-const seam = new SeamHttp('your-api-key')
+const seam = new SeamHttp('your-api-key', {
+  waitForActionAttempt: {
+    pollingInterval: 1000,
+    timeout: 5000,
+  },
+})
 
 const [lock] = await seam.locks.list()
 
 if (lock == null) throw new Error('No locks in this workspace')
 
 try {
-  await seam.locks.unlockDoor(
-    { device_id: lock.device_id },
-    {
-      waitForActionAttempt: {
-        pollingInterval: 1000,
-        timeout: 5000,
-      },
-    },
-  )
+  await seam.locks.unlockDoor({ device_id: lock.device_id })
   console.log('Door unlocked')
 } catch (err: unknown) {
   if (isSeamActionAttemptFailedError(err)) {

package/dist/connect.cjs

@@ -57,7 +57,7 @@ var parseOptions = (apiKeyOrOptions) => {
 var getNormalizedOptions = (apiKeyOrOptions) => {
   const options = typeof apiKeyOrOptions === "string" ? { apiKey: apiKeyOrOptions } : apiKeyOrOptions;
   const requestOptions = {
-    waitForActionAttempt: options.waitForActionAttempt ?? false
+    waitForActionAttempt: options.waitForActionAttempt ?? true
   };
   if (isSeamHttpOptionsWithClient(options)) {
     return {