Skip to content

Commit 7f7f6eb

Browse files
committed
ci: Generate code
1 parent 80e4088 commit 7f7f6eb

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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')
523525
An Axios compatible client may be provided to create a `Seam` instance.
524526
This 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

528555
All client methods return an instance of `SeamHttpRequest`.

0 commit comments

Comments
 (0)