@@ -58,6 +58,8 @@ Instead, it re-exports from a core set of Seam modules:
5858 - [ Configuring the Axios Client] ( #configuring-the-axios-client )
5959 - [ Using the Axios Client] ( #using-the-axios-client )
6060 - [ Overriding the Client] ( #overriding-the-client )
61+ - [ Alternative endpoint path interface] ( #alternative-endpoint-path-interface )
62+ - [ Enable undocumented API] ( #enable-undocumented-api )
6163 - [ Inspecting the Request] ( #inspecting-the-request )
6264 - [ Receiving Webhooks] ( #receiving-webhooks )
6365- [ Development and Testing] ( #development-and-testing )
@@ -523,6 +525,31 @@ const devices = await seam.client.get<DevicesListResponse>('/devices/list')
523525An Axios compatible client may be provided to create a ` Seam ` instance.
524526This API is used internally and is not directly supported.
525527
528+ #### Alternative endpoint path interface
529+
530+ The ` SeamEndpoints ` class offers an alternative path-based interface to every API endpoint.
531+ Each endpoint is exposed as simple property that returns the corresponding method from ` Seam ` .
532+
533+ ``` ts
534+ import { SeamEndpoints } from ' seam'
535+
536+ const seam = new SeamEndpoints ()
537+ const devices = await seam [' /devices/list' ]()
538+ ```
539+
540+ #### Enable undocumented API
541+
542+ Pass the ` isUndocumentedApiEnabled ` option to allow using the undocumented API.
543+ This API is used internally and is not directly supported.
544+ Do not use the undocumented API in production environments.
545+ Seam is not responsible for any issues you may encounter with the undocumented API.
546+
547+ ``` ts
548+ import { Seam } from ' seam'
549+
550+ const seam = new Seam ({ isUndocumentedApiEnabled: true })
551+ ```
552+
526553#### Inspecting the Request
527554
528555All client methods return an instance of ` SeamHttpRequest ` .
0 commit comments