@seamapi/http 0.26.0 → 0.28.0

package/README.md

@@ -28,10 +28,11 @@ The underlying HTTP client is [Axios].
 
 ## Installation
 
-_This is a low-level package meant for applications and libraries with particular dependency requirements.
-Before using this package, ensure you understand the installation and updating instructions.
-This SDK is entirely contained in the [seam package]. Seam recommends using that package instead
-for simpler dependency management._
+> [!IMPORTANT]
+> This is a low-level package meant for applications and libraries with particular dependency requirements.
+> Before using this package, ensure you understand the installation and updating instructions.
+> This SDK is entirely contained in the [seam package].
+> Seam recommends using that package instead for simpler dependency management.
 
 Add this as a dependency to your project using [npm] with
 
@@ -76,7 +77,8 @@ $ npm install -D @seamapi/types@latest
 
 ### Examples
 
-_These examples assume `SEAM_API_KEY` is set in your environment._
+> [!NOTE]
+> These examples assume `SEAM_API_KEY` is set in your environment.
 
 #### List devices
 
@@ -104,6 +106,7 @@ Authentication may be configured by passing the corresponding
 options directly to the `SeamHttp` constructor,
 or with the more ergonomic static factory methods.
 
+> [!NOTE]
 > Publishable Key authentication is not supported by the constructor
 > and must be configured using `SeamHttp.fromPublishableKey`.
 

package/dist/connect.cjs

@@ -857,7 +857,7 @@ var SeamHttpClientSessions = class _SeamHttpClientSessions {
       path: "/client_sessions/grant_access",
       method: "post",
       body,
-      responseKey: "client_session"
+      responseKey: void 0
     });
   }
   list(body) {
@@ -878,6 +878,93 @@ var SeamHttpClientSessions = class _SeamHttpClientSessions {
   }
 };
 
+// src/lib/seam/connect/routes/access-codes-simulate.ts
+var SeamHttpAccessCodesSimulate = class _SeamHttpAccessCodesSimulate {
+  constructor(apiKeyOrOptions = {}) {
+    const options = parseOptions(apiKeyOrOptions);
+    this.client = "client" in options ? options.client : createClient(options);
+    this.defaults = limitToSeamHttpRequestOptions(options);
+  }
+  static fromClient(client, options = {}) {
+    const constructorOptions = { ...options, client };
+    if (!isSeamHttpOptionsWithClient(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError("Missing client");
+    }
+    return new _SeamHttpAccessCodesSimulate(constructorOptions);
+  }
+  static fromApiKey(apiKey, options = {}) {
+    const constructorOptions = { ...options, apiKey };
+    if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError("Missing apiKey");
+    }
+    return new _SeamHttpAccessCodesSimulate(constructorOptions);
+  }
+  static fromClientSessionToken(clientSessionToken, options = {}) {
+    const constructorOptions = { ...options, clientSessionToken };
+    if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError("Missing clientSessionToken");
+    }
+    return new _SeamHttpAccessCodesSimulate(constructorOptions);
+  }
+  static async fromPublishableKey(publishableKey, userIdentifierKey, options = {}) {
+    warnOnInsecureuserIdentifierKey(userIdentifierKey);
+    const clientOptions = parseOptions({ ...options, publishableKey });
+    if (isSeamHttpOptionsWithClient(clientOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        "The client option cannot be used with SeamHttp.fromPublishableKey"
+      );
+    }
+    const client = createClient(clientOptions);
+    const clientSessions = SeamHttpClientSessions.fromClient(client);
+    const { token } = await clientSessions.getOrCreate({
+      user_identifier_key: userIdentifierKey
+    });
+    return _SeamHttpAccessCodesSimulate.fromClientSessionToken(token, options);
+  }
+  static fromConsoleSessionToken(consoleSessionToken, workspaceId, options = {}) {
+    const constructorOptions = { ...options, consoleSessionToken, workspaceId };
+    if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        "Missing consoleSessionToken or workspaceId"
+      );
+    }
+    return new _SeamHttpAccessCodesSimulate(constructorOptions);
+  }
+  static fromPersonalAccessToken(personalAccessToken, workspaceId, options = {}) {
+    const constructorOptions = { ...options, personalAccessToken, workspaceId };
+    if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        "Missing personalAccessToken or workspaceId"
+      );
+    }
+    return new _SeamHttpAccessCodesSimulate(constructorOptions);
+  }
+  async updateClientSessionToken(clientSessionToken) {
+    const { headers } = this.client.defaults;
+    const authHeaders = getAuthHeadersForClientSessionToken({
+      clientSessionToken
+    });
+    for (const key of Object.keys(authHeaders)) {
+      if (headers[key] == null) {
+        throw new Error(
+          "Cannot update a clientSessionToken on a client created without a clientSessionToken"
+        );
+      }
+    }
+    this.client.defaults.headers = { ...headers, ...authHeaders };
+    const clientSessions = SeamHttpClientSessions.fromClient(this.client);
+    await clientSessions.get();
+  }
+  createUnmanagedAccessCode(body) {
+    return new SeamHttpRequest(this, {
+      path: "/access_codes/simulate/create_unmanaged_access_code",
+      method: "post",
+      body,
+      responseKey: "access_code"
+    });
+  }
+};
+
 // src/lib/seam/connect/routes/access-codes-unmanaged.ts
 var SeamHttpAccessCodesUnmanaged = class _SeamHttpAccessCodesUnmanaged {
   constructor(apiKeyOrOptions = {}) {
@@ -1077,6 +1164,9 @@ var SeamHttpAccessCodes = class _SeamHttpAccessCodes {
   get unmanaged() {
     return SeamHttpAccessCodesUnmanaged.fromClient(this.client, this.defaults);
   }
+  get simulate() {
+    return SeamHttpAccessCodesSimulate.fromClient(this.client, this.defaults);
+  }
   create(body) {
     return new SeamHttpRequest(this, {
       path: "/access_codes/create",
@@ -1521,7 +1611,7 @@ var SeamHttpAcsCredentials = class _SeamHttpAcsCredentials {
       path: "/acs/credentials/assign",
       method: "post",
       body,
-      responseKey: "acs_credential"
+      responseKey: void 0
     });
   }
   create(body) {
@@ -1561,7 +1651,7 @@ var SeamHttpAcsCredentials = class _SeamHttpAcsCredentials {
       path: "/acs/credentials/unassign",
       method: "post",
       body,
-      responseKey: "acs_credential"
+      responseKey: void 0
     });
   }
   update(body) {
@@ -1569,7 +1659,7 @@ var SeamHttpAcsCredentials = class _SeamHttpAcsCredentials {
       path: "/acs/credentials/update",
       method: "post",
       body,
-      responseKey: "acs_credential"
+      responseKey: void 0
     });
   }
 };
@@ -3108,6 +3198,93 @@ var SeamHttpNoiseSensorsNoiseThresholds = class _SeamHttpNoiseSensorsNoiseThresh
   }
 };
 
+// src/lib/seam/connect/routes/noise-sensors-simulate.ts
+var SeamHttpNoiseSensorsSimulate = class _SeamHttpNoiseSensorsSimulate {
+  constructor(apiKeyOrOptions = {}) {
+    const options = parseOptions(apiKeyOrOptions);
+    this.client = "client" in options ? options.client : createClient(options);
+    this.defaults = limitToSeamHttpRequestOptions(options);
+  }
+  static fromClient(client, options = {}) {
+    const constructorOptions = { ...options, client };
+    if (!isSeamHttpOptionsWithClient(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError("Missing client");
+    }
+    return new _SeamHttpNoiseSensorsSimulate(constructorOptions);
+  }
+  static fromApiKey(apiKey, options = {}) {
+    const constructorOptions = { ...options, apiKey };
+    if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError("Missing apiKey");
+    }
+    return new _SeamHttpNoiseSensorsSimulate(constructorOptions);
+  }
+  static fromClientSessionToken(clientSessionToken, options = {}) {
+    const constructorOptions = { ...options, clientSessionToken };
+    if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError("Missing clientSessionToken");
+    }
+    return new _SeamHttpNoiseSensorsSimulate(constructorOptions);
+  }
+  static async fromPublishableKey(publishableKey, userIdentifierKey, options = {}) {
+    warnOnInsecureuserIdentifierKey(userIdentifierKey);
+    const clientOptions = parseOptions({ ...options, publishableKey });
+    if (isSeamHttpOptionsWithClient(clientOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        "The client option cannot be used with SeamHttp.fromPublishableKey"
+      );
+    }
+    const client = createClient(clientOptions);
+    const clientSessions = SeamHttpClientSessions.fromClient(client);
+    const { token } = await clientSessions.getOrCreate({
+      user_identifier_key: userIdentifierKey
+    });
+    return _SeamHttpNoiseSensorsSimulate.fromClientSessionToken(token, options);
+  }
+  static fromConsoleSessionToken(consoleSessionToken, workspaceId, options = {}) {
+    const constructorOptions = { ...options, consoleSessionToken, workspaceId };
+    if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        "Missing consoleSessionToken or workspaceId"
+      );
+    }
+    return new _SeamHttpNoiseSensorsSimulate(constructorOptions);
+  }
+  static fromPersonalAccessToken(personalAccessToken, workspaceId, options = {}) {
+    const constructorOptions = { ...options, personalAccessToken, workspaceId };
+    if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        "Missing personalAccessToken or workspaceId"
+      );
+    }
+    return new _SeamHttpNoiseSensorsSimulate(constructorOptions);
+  }
+  async updateClientSessionToken(clientSessionToken) {
+    const { headers } = this.client.defaults;
+    const authHeaders = getAuthHeadersForClientSessionToken({
+      clientSessionToken
+    });
+    for (const key of Object.keys(authHeaders)) {
+      if (headers[key] == null) {
+        throw new Error(
+          "Cannot update a clientSessionToken on a client created without a clientSessionToken"
+        );
+      }
+    }
+    this.client.defaults.headers = { ...headers, ...authHeaders };
+    const clientSessions = SeamHttpClientSessions.fromClient(this.client);
+    await clientSessions.get();
+  }
+  triggerNoiseThreshold(body) {
+    return new SeamHttpRequest(this, {
+      path: "/noise_sensors/simulate/trigger_noise_threshold",
+      method: "post",
+      body,
+      responseKey: void 0
+    });
+  }
+};
+
 // src/lib/seam/connect/routes/noise-sensors.ts
 var SeamHttpNoiseSensors = class _SeamHttpNoiseSensors {
   constructor(apiKeyOrOptions = {}) {
@@ -3191,6 +3368,9 @@ var SeamHttpNoiseSensors = class _SeamHttpNoiseSensors {
       this.defaults
     );
   }
+  get simulate() {
+    return SeamHttpNoiseSensorsSimulate.fromClient(this.client, this.defaults);
+  }
 };
 
 // src/lib/seam/connect/routes/phones-simulate.ts
@@ -3904,7 +4084,7 @@ var SeamHttpUserIdentities = class _SeamHttpUserIdentities {
       path: "/user_identities/list_accessible_devices",
       method: "post",
       body,
-      responseKey: "accessible_devices"
+      responseKey: "devices"
     });
   }
   listAcsSystems(body) {
@@ -4169,12 +4349,13 @@ var SeamHttpWorkspaces = class _SeamHttpWorkspaces {
       responseKey: "workspaces"
     });
   }
-  resetSandbox(body) {
+  resetSandbox(body, options = {}) {
     return new SeamHttpRequest(this, {
       path: "/workspaces/reset_sandbox",
       method: "post",
       body,
-      responseKey: void 0
+      responseKey: "action_attempt",
+      options
     });
   }
 };
@@ -4355,6 +4536,7 @@ exports.SeamActionAttemptFailedError = SeamActionAttemptFailedError;
 exports.SeamActionAttemptTimeoutError = SeamActionAttemptTimeoutError;
 exports.SeamHttp = SeamHttp;
 exports.SeamHttpAccessCodes = SeamHttpAccessCodes;
+exports.SeamHttpAccessCodesSimulate = SeamHttpAccessCodesSimulate;
 exports.SeamHttpAccessCodesUnmanaged = SeamHttpAccessCodesUnmanaged;
 exports.SeamHttpAcs = SeamHttpAcs;
 exports.SeamHttpAcsAccessGroups = SeamHttpAcsAccessGroups;
@@ -4382,6 +4564,7 @@ exports.SeamHttpMultiWorkspaceInvalidOptionsError = SeamHttpMultiWorkspaceInvali
 exports.SeamHttpNetworks = SeamHttpNetworks;
 exports.SeamHttpNoiseSensors = SeamHttpNoiseSensors;
 exports.SeamHttpNoiseSensorsNoiseThresholds = SeamHttpNoiseSensorsNoiseThresholds;
+exports.SeamHttpNoiseSensorsSimulate = SeamHttpNoiseSensorsSimulate;
 exports.SeamHttpPhones = SeamHttpPhones;
 exports.SeamHttpPhonesSimulate = SeamHttpPhonesSimulate;
 exports.SeamHttpRequest = SeamHttpRequest;