@seamapi/http 0.10.1 → 0.11.0

package/README.md

@@ -261,10 +261,58 @@ try {
 
 [action attempt]: https://docs.seam.co/latest/core-concepts/action-attempts
 
+### Interacting with Multiple Workspaces
+
+Some Seam API endpoints interact with multiple workspaces.
+The `SeamHttpMultiWorkspace` client is not bound to a specific workspace
+and may use those endpoints with an appropriate authentication method.
+
+#### Personal Access Token
+
+A Personal Access Token is scoped to a Seam Console user.
+Obtain one from the Seam Console.
+
+```ts
+// Pass as an option the constructor
+const seam = new SeamHttpMultiWorkspace({
+  personalAccessToken: 'your-personal-access-token',
+})
+
+// Use the factory method
+const seam = SeamHttpMultiWorkspace.fromPersonalAccessToken(
+  'some-console-session-token',
+)
+
+// List workspaces authorized for this Personal Access Token
+const workspaces = await seam.workspaces.list()
+```
+
+#### Console Session Token
+
+A Console Session Token is used by the Seam Console.
+This authentication method is only used by internal Seam applications.
+
+```ts
+// Pass as an option the constructor
+const seam = new SeamHttpMultiWorkspace({
+  consoleSessionToken: 'some-console-session-token',
+})
+
+// Use the factory method
+const seam = SeamHttpMultiWorkspace.fromConsoleSessionToken(
+  'some-console-session-token',
+)
+
+// List workspaces authorized for this Seam Console user
+const workspaces = await seam.workspaces.list()
+```
+
 ### Advanced Usage
 
+#### Additional Options
+
 In addition the various authentication options,
-the constructor takes some additional options that affect behavior.
+the constructor takes some advanced options that affect behavior.
 
 ```ts
 const seam = new SeamHttp({

package/dist/connect.cjs

@@ -515,6 +515,78 @@ var getRequestId = (err) => {
   return requestId;
 };
 
+// src/lib/params-serializer.ts
+var paramsSerializer = (params) => {
+  const searchParams = new URLSearchParams();
+  for (const [name, value] of Object.entries(params)) {
+    if (value == null)
+      continue;
+    if (Array.isArray(value)) {
+      if (value.length === 0)
+        searchParams.set(name, "");
+      if (value.length === 1 && value[0] === "") {
+        throw new UnserializableParamError(
+          name,
+          `is a single element array containing the empty string which is unsupported because it serializes to the empty array`
+        );
+      }
+      for (const v of value) {
+        searchParams.append(name, serialize(name, v));
+      }
+      continue;
+    }
+    searchParams.set(name, serialize(name, value));
+  }
+  searchParams.sort();
+  return searchParams.toString();
+};
+var serialize = (k, v) => {
+  if (typeof v === "string")
+    return v.toString();
+  if (typeof v === "number")
+    return v.toString();
+  if (typeof v === "bigint")
+    return v.toString();
+  if (typeof v === "boolean")
+    return v.toString();
+  throw new UnserializableParamError(k, `is a ${typeof v}`);
+};
+var UnserializableParamError = class extends Error {
+  constructor(name, message) {
+    super(`Could not serialize parameter: '${name}' ${message}`);
+    this.name = this.constructor.name;
+    Error.captureStackTrace(this, this.constructor);
+  }
+};
+
+// src/lib/seam/connect/client.ts
+var createClient = (options) => {
+  const client = axios__default.default.create({
+    paramsSerializer,
+    ...options.axiosOptions
+  });
+  axiosBetterStacktrace__default.default(axios__default.default);
+  axiosRetry__default.default(client, {
+    retries: 2,
+    retryDelay: axiosRetry.exponentialDelay,
+    ...options.axiosRetryOptions
+  });
+  client.interceptors.response.use(void 0, errorInterceptor);
+  return client;
+};
+
+// src/lib/seam/connect/openapi.ts
+var getOpenapiSchema = async (endpoint = defaultEndpoint) => {
+  const client = createClient({
+    axiosOptions: {
+      baseURL: endpoint,
+      headers: sdkHeaders
+    }
+  });
+  const { data } = await client.get("/openapi.json");
+  return data;
+};
+
 // src/lib/seam/connect/resolve-action-attempt.ts
 var resolveActionAttempt = async (actionAttempt, actionAttempts, { timeout = 5e3, pollingInterval = 500 }) => {
   let timeoutRef;
@@ -590,66 +662,6 @@ var SeamActionAttemptTimeoutError = class extends SeamActionAttemptError {
 var isSuccessfulActionAttempt = (actionAttempt) => actionAttempt.status === "success";
 var isFailedActionAttempt = (actionAttempt) => actionAttempt.status === "error";
 
-// src/lib/params-serializer.ts
-var paramsSerializer = (params) => {
-  const searchParams = new URLSearchParams();
-  for (const [name, value] of Object.entries(params)) {
-    if (value == null)
-      continue;
-    if (Array.isArray(value)) {
-      if (value.length === 0)
-        searchParams.set(name, "");
-      if (value.length === 1 && value[0] === "") {
-        throw new UnserializableParamError(
-          name,
-          `is a single element array containing the empty string which is unsupported because it serializes to the empty array`
-        );
-      }
-      for (const v of value) {
-        searchParams.append(name, serialize(name, v));
-      }
-      continue;
-    }
-    searchParams.set(name, serialize(name, value));
-  }
-  searchParams.sort();
-  return searchParams.toString();
-};
-var serialize = (k, v) => {
-  if (typeof v === "string")
-    return v.toString();
-  if (typeof v === "number")
-    return v.toString();
-  if (typeof v === "bigint")
-    return v.toString();
-  if (typeof v === "boolean")
-    return v.toString();
-  throw new UnserializableParamError(k, `is a ${typeof v}`);
-};
-var UnserializableParamError = class extends Error {
-  constructor(name, message) {
-    super(`Could not serialize parameter: '${name}' ${message}`);
-    this.name = this.constructor.name;
-    Error.captureStackTrace(this, this.constructor);
-  }
-};
-
-// src/lib/seam/connect/client.ts
-var createClient = (options) => {
-  const client = axios__default.default.create({
-    paramsSerializer,
-    ...options.axiosOptions
-  });
-  axiosBetterStacktrace__default.default(axios__default.default);
-  axiosRetry__default.default(client, {
-    retries: 2,
-    retryDelay: axiosRetry.exponentialDelay,
-    ...options.axiosRetryOptions
-  });
-  client.interceptors.response.use(void 0, errorInterceptor);
-  return client;
-};
-
 // src/lib/seam/connect/routes/client-sessions.ts
 var SeamHttpClientSessions = class _SeamHttpClientSessions {
   constructor(apiKeyOrOptions = {}) {
@@ -3333,6 +3345,7 @@ exports.SeamHttpWebhooks = SeamHttpWebhooks;
 exports.SeamHttpWorkspaces = SeamHttpWorkspaces;
 exports.UnserializableParamError = UnserializableParamError;
 exports.errorInterceptor = errorInterceptor;
+exports.getOpenapiSchema = getOpenapiSchema;
 exports.isSeamActionAttemptError = isSeamActionAttemptError;
 exports.isSeamActionAttemptFailedError = isSeamActionAttemptFailedError;
 exports.isSeamActionAttemptTimeoutError = isSeamActionAttemptTimeoutError;