seam 1.80.0 → 1.82.0

package/README.md

@@ -49,7 +49,7 @@ Instead, it re-exports from a core set of Seam modules:
     - [Iterate over all pages](#iterate-over-all-pages)
     - [Iterate over all resources](#iterate-over-all-resources)
     - [Return all resources across all pages as an array](#return-all-resources-across-all-pages-as-an-array)
-  - [Interacting with Multiple Workspaces](#interacting-with-multiple-workspaces)
+  - [Requests without a Workspace in scope](#requests-without-a-workspace-in-scope)
     - [Personal Access Token](#personal-access-token-1)
     - [Console Session Token](#console-session-token-1)
   - [Advanced Usage](#advanced-usage)
@@ -58,6 +58,8 @@ Instead, it re-exports from a core set of Seam modules:
     - [Configuring the Axios Client](#configuring-the-axios-client)
     - [Using the Axios Client](#using-the-axios-client)
     - [Overriding the Client](#overriding-the-client)
+    - [Alternative endpoint path interface](#alternative-endpoint-path-interface)
+    - [Enable undocumented API](#enable-undocumented-api)
     - [Inspecting the Request](#inspecting-the-request)
   - [Receiving Webhooks](#receiving-webhooks)
 - [Development and Testing](#development-and-testing)
@@ -408,10 +410,10 @@ const pages = seam.createPaginator(
 const devices = await pages.flattenToArray()
 ```
 
-### Interacting with Multiple Workspaces
+### Requests without a Workspace in scope
 
-Some Seam API endpoints interact with multiple workspaces.
-The `SeamMultiWorkspace` client is not bound to a specific workspace
+Some Seam API endpoints do not require a workspace in scope.
+The `SeamWithoutWorkspace` client is not bound to a specific workspace
 and may use those endpoints with an appropriate authentication method.
 
 #### Personal Access Token
@@ -421,15 +423,15 @@ Obtain one from the Seam Console.
 
 ```ts
 // Set the `SEAM_PERSONAL_ACCESS_TOKEN` environment variable
-const seam = new SeamMultiWorkspace()
+const seam = new SeamWithoutWorkspace()
 
 // Pass as an option to the constructor
-const seam = new SeamMultiWorkspace({
+const seam = new SeamWithoutWorkspace({
   personalAccessToken: 'your-personal-access-token',
 })
 
 // Use the factory method
-const seam = SeamMultiWorkspace.fromPersonalAccessToken(
+const seam = SeamWithoutWorkspace.fromPersonalAccessToken(
   'some-console-session-token',
 )
 
@@ -444,12 +446,12 @@ This authentication method is only used by internal Seam applications.
 
 ```ts
 // Pass as an option to the constructor
-const seam = new SeamMultiWorkspace({
+const seam = new SeamWithoutWorkspace({
   consoleSessionToken: 'some-console-session-token',
 })
 
 // Use the factory method
-const seam = SeamMultiWorkspace.fromConsoleSessionToken(
+const seam = SeamWithoutWorkspace.fromConsoleSessionToken(
   'some-console-session-token',
 )
 
@@ -523,6 +525,31 @@ const devices = await seam.client.get<DevicesListResponse>('/devices/list')
 An Axios compatible client may be provided to create a `Seam` instance.
 This API is used internally and is not directly supported.
 
+#### Alternative endpoint path interface
+
+The `SeamEndpoints` class offers an alternative path-based interface to every API endpoint.
+Each endpoint is exposed as simple property that returns the corresponding method from `Seam`.
+
+```ts
+import { SeamEndpoints } from 'seam'
+
+const seam = new SeamEndpoints()
+const devices = await seam['/devices/list']()
+```
+
+#### Enable undocumented API
+
+Pass the `isUndocumentedApiEnabled` option to allow using the undocumented API.
+This API is used internally and is not directly supported.
+Do not use the undocumented API in production environments.
+Seam is not responsible for any issues you may encounter with the undocumented API.
+
+```ts
+import { Seam } from 'seam'
+
+const seam = new Seam({ isUndocumentedApiEnabled: true })
+```
+
 #### Inspecting the Request
 
 All client methods return an instance of `SeamHttpRequest`.

package/dist/index.cjs

@@ -1,22 +1,30 @@
 'use strict';
 
-var connect = require('@seamapi/http/connect');
+var http = require('@seamapi/http');
 var webhook = require('@seamapi/webhook');
 
 
 
 Object.defineProperty(exports, "Seam", {
   enumerable: true,
-  get: function () { return connect.SeamHttp; }
+  get: function () { return http.SeamHttp; }
+});
+Object.defineProperty(exports, "SeamEndpoints", {
+  enumerable: true,
+  get: function () { return http.SeamHttpEndpoints; }
 });
 Object.defineProperty(exports, "SeamMultiWorkspace", {
   enumerable: true,
-  get: function () { return connect.SeamHttpMultiWorkspace; }
+  get: function () { return http.SeamHttpMultiWorkspace; }
+});
+Object.defineProperty(exports, "SeamWithoutWorkspace", {
+  enumerable: true,
+  get: function () { return http.SeamHttpWithoutWorkspace; }
 });
-Object.keys(connect).forEach(function (k) {
+Object.keys(http).forEach(function (k) {
   if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
     enumerable: true,
-    get: function () { return connect[k]; }
+    get: function () { return http[k]; }
   });
 });
 Object.keys(webhook).forEach(function (k) {

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-export * from '@seamapi/http/connect';
-export { SeamHttp as Seam, SeamHttpMultiWorkspace as SeamMultiWorkspace, SeamHttpMultiWorkspaceOptions as SeamMultiWorkspaceOptions, SeamHttpOptions as SeamOptions } from '@seamapi/http/connect';
-export * from '@seamapi/types/connect';
+export * from '@seamapi/http';
+export { SeamHttp as Seam, SeamHttpEndpoints as SeamEndpoints, SeamHttpMultiWorkspace as SeamMultiWorkspace, SeamHttpWithoutWorkspaceOptions as SeamMultiWorkspaceOptions, SeamHttpOptions as SeamOptions, SeamHttpWithoutWorkspace as SeamWithoutWorkspace, SeamHttpWithoutWorkspace as SeamWithoutWorkspaceOptions } from '@seamapi/http';
+export * from '@seamapi/types';
 export * from '@seamapi/webhook';

package/index.d.ts

@@ -1,6 +1,6 @@
-import { SeamHttp as Seam, SeamHttpMultiWorkspace as SeamMultiWorkspace, type SeamHttpMultiWorkspaceOptions as SeamMultiWorkspaceOptions, type SeamHttpOptions as SeamOptions } from '@seamapi/http/connect';
-export * from '@seamapi/http/connect';
-export type * from '@seamapi/types/connect';
+import { SeamHttp as Seam, SeamHttpEndpoints as SeamEndpoints, SeamHttpMultiWorkspace as SeamMultiWorkspace, type SeamHttpOptions as SeamOptions, SeamHttpWithoutWorkspace as SeamWithoutWorkspace, type SeamHttpWithoutWorkspace as SeamWithoutWorkspaceOptions, type SeamHttpWithoutWorkspaceOptions as SeamMultiWorkspaceOptions } from '@seamapi/http';
+export * from '@seamapi/http';
+export type * from '@seamapi/types';
 export * from '@seamapi/webhook';
-export { Seam, SeamMultiWorkspace };
-export type { SeamMultiWorkspaceOptions, SeamOptions };
+export { Seam, SeamEndpoints, SeamMultiWorkspace, SeamWithoutWorkspace };
+export type { SeamMultiWorkspaceOptions, SeamOptions, SeamWithoutWorkspaceOptions, };

package/index.js

@@ -1,5 +1,5 @@
-import { SeamHttp as Seam, SeamHttpMultiWorkspace as SeamMultiWorkspace, } from '@seamapi/http/connect';
-export * from '@seamapi/http/connect';
+import { SeamHttp as Seam, SeamHttpEndpoints as SeamEndpoints, SeamHttpMultiWorkspace as SeamMultiWorkspace, SeamHttpWithoutWorkspace as SeamWithoutWorkspace, } from '@seamapi/http';
+export * from '@seamapi/http';
 export * from '@seamapi/webhook';
-export { Seam, SeamMultiWorkspace };
+export { Seam, SeamEndpoints, SeamMultiWorkspace, SeamWithoutWorkspace };
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,IAAI,IAAI,EAChB,sBAAsB,IAAI,kBAAkB,GAG7C,MAAM,uBAAuB,CAAA;AAE9B,cAAc,uBAAuB,CAAA;AAErC,cAAc,kBAAkB,CAAA;AAChC,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,IAAI,IAAI,EAChB,iBAAiB,IAAI,aAAa,EAClC,sBAAsB,IAAI,kBAAkB,EAE5C,wBAAwB,IAAI,oBAAoB,GAGjD,MAAM,eAAe,CAAA;AAEtB,cAAc,eAAe,CAAA;AAE7B,cAAc,kBAAkB,CAAA;AAChC,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "seam",
-  "version": "1.80.0",
+  "version": "1.82.0",
   "description": "JavaScript SDK for the Seam API written in TypeScript.",
   "type": "module",
   "main": "index.js",
@@ -65,8 +65,8 @@
     "npm": ">= 9.0.0"
   },
   "dependencies": {
-    "@seamapi/http": "1.35.1",
-    "@seamapi/types": "1.420.2",
+    "@seamapi/http": "1.45.0",
+    "@seamapi/types": "1.441.1",
     "@seamapi/webhook": "1.1.1",
     "zod": "^3.21.4"
   },

package/src/index.ts

@@ -1,12 +1,19 @@
 import {
   SeamHttp as Seam,
+  SeamHttpEndpoints as SeamEndpoints,
   SeamHttpMultiWorkspace as SeamMultiWorkspace,
-  type SeamHttpMultiWorkspaceOptions as SeamMultiWorkspaceOptions,
   type SeamHttpOptions as SeamOptions,
-} from '@seamapi/http/connect'
+  SeamHttpWithoutWorkspace as SeamWithoutWorkspace,
+  type SeamHttpWithoutWorkspace as SeamWithoutWorkspaceOptions,
+  type SeamHttpWithoutWorkspaceOptions as SeamMultiWorkspaceOptions,
+} from '@seamapi/http'
 
-export * from '@seamapi/http/connect'
-export type * from '@seamapi/types/connect'
+export * from '@seamapi/http'
+export type * from '@seamapi/types'
 export * from '@seamapi/webhook'
-export { Seam, SeamMultiWorkspace }
-export type { SeamMultiWorkspaceOptions, SeamOptions }
+export { Seam, SeamEndpoints, SeamMultiWorkspace, SeamWithoutWorkspace }
+export type {
+  SeamMultiWorkspaceOptions,
+  SeamOptions,
+  SeamWithoutWorkspaceOptions,
+}