@seamapi/http 0.9.2 → 0.10.0

package/README.md

@@ -22,11 +22,17 @@ The underlying HTTP client is [Axios].
 
 [Seam]: https://www.seam.co/
 [Seam Docs]: https://docs.seam.co/latest/
+[seamapi]: https://www.npmjs.com/package/seamapi
 [@seamapi/types]: https://github.com/seamapi/types/
 [Axios]: https://axios-http.com/
 
 ## 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 [seamapi] package. Seam recommends using that package instead
+for simpler dependency management._
+
 Add this as a dependency to your project using [npm] with
 
 ```
@@ -35,6 +41,36 @@ $ npm install @seamapi/http
 
 [npm]: https://www.npmjs.com/
 
+### Optional Peer Dependencies for TypeScript
+
+This package has optional peer dependencies for TypeScript users.
+Recent versions of npm will automatically install peer dependencies by default.
+For those users, no additional steps are necessary for full TypeScript support,
+however users should still explicitly install the latest types (see the next section).
+
+Other package managers require peer dependencies to be added manually.
+Refer to any warnings generated by your package manager
+about missing peer dependencies and install them as needed.
+Refer to the next section for keeping the types updated.
+
+#### Keeping up with the latest types
+
+This package depends on [@seamapi/types] for the latest TypeScript types.
+New versions of this SDK are generally not released when new types are published.
+Unless your project frequently runs a blanket `npm update`,
+the types will become outdated with the Seam API over time.
+Thus, users of this package should explicitly install the types with
+
+```
+$ npm install -D @seamapi/types
+```
+
+and update them when consuming new API features with
+
+```
+$ npm install -D @seamapi/http@latest
+```
+
 ## Usage
 
 ```ts

package/dist/connect.cjs

@@ -1097,6 +1097,153 @@ var SeamHttpAcsAccessGroups = class _SeamHttpAcsAccessGroups {
   }
 };
 
+// src/lib/seam/connect/routes/acs-credential-pools.ts
+var SeamHttpAcsCredentialPools = class _SeamHttpAcsCredentialPools {
+  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 _SeamHttpAcsCredentialPools(constructorOptions);
+  }
+  static fromApiKey(apiKey, options = {}) {
+    const constructorOptions = { ...options, apiKey };
+    if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError("Missing apiKey");
+    }
+    return new _SeamHttpAcsCredentialPools(constructorOptions);
+  }
+  static fromClientSessionToken(clientSessionToken, options = {}) {
+    const constructorOptions = { ...options, clientSessionToken };
+    if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError("Missing clientSessionToken");
+    }
+    return new _SeamHttpAcsCredentialPools(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 _SeamHttpAcsCredentialPools.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 _SeamHttpAcsCredentialPools(constructorOptions);
+  }
+  static fromPersonalAccessToken(personalAccessToken, workspaceId, options = {}) {
+    const constructorOptions = { ...options, personalAccessToken, workspaceId };
+    if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        "Missing personalAccessToken or workspaceId"
+      );
+    }
+    return new _SeamHttpAcsCredentialPools(constructorOptions);
+  }
+  async list(body) {
+    const { data } = await this.client.request({
+      url: "/acs/credential_pools/list",
+      method: "post",
+      data: body
+    });
+    return data.acs_credential_pools;
+  }
+};
+
+// src/lib/seam/connect/routes/acs-credential-provisioning-automations.ts
+var SeamHttpAcsCredentialProvisioningAutomations = class _SeamHttpAcsCredentialProvisioningAutomations {
+  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 _SeamHttpAcsCredentialProvisioningAutomations(constructorOptions);
+  }
+  static fromApiKey(apiKey, options = {}) {
+    const constructorOptions = { ...options, apiKey };
+    if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError("Missing apiKey");
+    }
+    return new _SeamHttpAcsCredentialProvisioningAutomations(constructorOptions);
+  }
+  static fromClientSessionToken(clientSessionToken, options = {}) {
+    const constructorOptions = { ...options, clientSessionToken };
+    if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError("Missing clientSessionToken");
+    }
+    return new _SeamHttpAcsCredentialProvisioningAutomations(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 _SeamHttpAcsCredentialProvisioningAutomations.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 _SeamHttpAcsCredentialProvisioningAutomations(constructorOptions);
+  }
+  static fromPersonalAccessToken(personalAccessToken, workspaceId, options = {}) {
+    const constructorOptions = { ...options, personalAccessToken, workspaceId };
+    if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        "Missing personalAccessToken or workspaceId"
+      );
+    }
+    return new _SeamHttpAcsCredentialProvisioningAutomations(constructorOptions);
+  }
+  async launch(body) {
+    const { data } = await this.client.request(
+      {
+        url: "/acs/credential_provisioning_automations/launch",
+        method: "post",
+        data: body
+      }
+    );
+    return data.acs_credential_provisioning_automation;
+  }
+};
+
 // src/lib/seam/connect/routes/acs-credentials.ts
 var SeamHttpAcsCredentials = class _SeamHttpAcsCredentials {
   constructor(apiKeyOrOptions = {}) {
@@ -1159,11 +1306,12 @@ var SeamHttpAcsCredentials = class _SeamHttpAcsCredentials {
     return new _SeamHttpAcsCredentials(constructorOptions);
   }
   async assign(body) {
-    await this.client.request({
+    const { data } = await this.client.request({
       url: "/acs/credentials/assign",
       method: "post",
       data: body
     });
+    return data.acs_credential;
   }
   async create(body) {
     const { data } = await this.client.request({
@@ -1197,11 +1345,99 @@ var SeamHttpAcsCredentials = class _SeamHttpAcsCredentials {
     return data.acs_credentials;
   }
   async unassign(body) {
-    await this.client.request({
+    const { data } = await this.client.request({
       url: "/acs/credentials/unassign",
       method: "post",
       data: body
     });
+    return data.acs_credential;
+  }
+  async update(body) {
+    const { data } = await this.client.request({
+      url: "/acs/credentials/update",
+      method: "post",
+      data: body
+    });
+    return data.acs_credential;
+  }
+};
+
+// src/lib/seam/connect/routes/acs-entrances.ts
+var SeamHttpAcsEntrances = class _SeamHttpAcsEntrances {
+  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 _SeamHttpAcsEntrances(constructorOptions);
+  }
+  static fromApiKey(apiKey, options = {}) {
+    const constructorOptions = { ...options, apiKey };
+    if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError("Missing apiKey");
+    }
+    return new _SeamHttpAcsEntrances(constructorOptions);
+  }
+  static fromClientSessionToken(clientSessionToken, options = {}) {
+    const constructorOptions = { ...options, clientSessionToken };
+    if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError("Missing clientSessionToken");
+    }
+    return new _SeamHttpAcsEntrances(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 _SeamHttpAcsEntrances.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 _SeamHttpAcsEntrances(constructorOptions);
+  }
+  static fromPersonalAccessToken(personalAccessToken, workspaceId, options = {}) {
+    const constructorOptions = { ...options, personalAccessToken, workspaceId };
+    if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        "Missing personalAccessToken or workspaceId"
+      );
+    }
+    return new _SeamHttpAcsEntrances(constructorOptions);
+  }
+  async get(body) {
+    const { data } = await this.client.request({
+      url: "/acs/entrances/get",
+      method: "post",
+      data: body
+    });
+    return data.acs_entrance;
+  }
+  async list(body) {
+    const { data } = await this.client.request({
+      url: "/acs/entrances/list",
+      method: "post",
+      data: body
+    });
+    return data.acs_entrances;
   }
 };
 
@@ -1477,9 +1713,21 @@ var SeamHttpAcs = class _SeamHttpAcs {
   get accessGroups() {
     return SeamHttpAcsAccessGroups.fromClient(this.client, this.defaults);
   }
+  get credentialPools() {
+    return SeamHttpAcsCredentialPools.fromClient(this.client, this.defaults);
+  }
+  get credentialProvisioningAutomations() {
+    return SeamHttpAcsCredentialProvisioningAutomations.fromClient(
+      this.client,
+      this.defaults
+    );
+  }
   get credentials() {
     return SeamHttpAcsCredentials.fromClient(this.client, this.defaults);
   }
+  get entrances() {
+    return SeamHttpAcsEntrances.fromClient(this.client, this.defaults);
+  }
   get systems() {
     return SeamHttpAcsSystems.fromClient(this.client, this.defaults);
   }
@@ -2653,6 +2901,14 @@ var SeamHttpUserIdentities = class _SeamHttpUserIdentities {
       data: body
     });
   }
+  async list(params) {
+    const { data } = await this.client.request({
+      url: "/user_identities/list",
+      method: "get",
+      params
+    });
+    return data.user_identities;
+  }
   async listAccessibleDevices(body) {
     const { data } = await this.client.request({
       url: "/user_identities/list_accessible_devices",
@@ -2840,6 +3096,14 @@ var SeamHttpWorkspaces = class _SeamHttpWorkspaces {
     }
     return new _SeamHttpWorkspaces(constructorOptions);
   }
+  async create(body) {
+    const { data } = await this.client.request({
+      url: "/workspaces/create",
+      method: "post",
+      data: body
+    });
+    return data.workspace;
+  }
   async get(params) {
     const { data } = await this.client.request({
       url: "/workspaces/get",
@@ -3019,7 +3283,10 @@ exports.SeamHttpAccessCodes = SeamHttpAccessCodes;
 exports.SeamHttpAccessCodesUnmanaged = SeamHttpAccessCodesUnmanaged;
 exports.SeamHttpAcs = SeamHttpAcs;
 exports.SeamHttpAcsAccessGroups = SeamHttpAcsAccessGroups;
+exports.SeamHttpAcsCredentialPools = SeamHttpAcsCredentialPools;
+exports.SeamHttpAcsCredentialProvisioningAutomations = SeamHttpAcsCredentialProvisioningAutomations;
 exports.SeamHttpAcsCredentials = SeamHttpAcsCredentials;
+exports.SeamHttpAcsEntrances = SeamHttpAcsEntrances;
 exports.SeamHttpAcsSystems = SeamHttpAcsSystems;
 exports.SeamHttpAcsUsers = SeamHttpAcsUsers;
 exports.SeamHttpActionAttempts = SeamHttpActionAttempts;