@seamapi/http 1.35.1 → 1.37.0

package/README.md

@@ -512,6 +512,31 @@ const devices = await seam.client.get<DevicesListResponse>('/devices/list')
 An Axios compatible client may be provided to create a `SeamHttp` instance.
 This API is used internally and is not directly supported.
 
+#### Alternative endpoint path interface
+
+The `SeamHttpEndpoints` class offers an alternative path-based interface to every API endpoint.
+Each endpoint is exposed as simple property that returns the corresponding method from `SeamHttp`.
+
+```ts
+import { SeamHttpEndpoints } from '@seamapi/http/connect'
+
+const seam = new SeamHttpEndpoints()
+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 { SeamHttp } from '@seamapi/http/connect'
+
+const seam = new SeamHttp({ isUndocumentedApiEnabled: true })
+```
+
 #### Inspecting the Request
 
 All client methods return an instance of `SeamHttpRequest`.