@seamapi/http 1.35.1 → 1.36.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/dist/connect.cjs +1303 -0
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +187 -1
- package/lib/seam/connect/routes/index.d.ts +1 -0
- package/lib/seam/connect/routes/index.js +1 -0
- package/lib/seam/connect/routes/index.js.map +1 -1
- package/lib/seam/connect/routes/seam-http-endpoints.d.ts +224 -0
- package/lib/seam/connect/routes/seam-http-endpoints.js +1310 -0
- package/lib/seam/connect/routes/seam-http-endpoints.js.map +1 -0
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/routes/index.ts +1 -0
- package/src/lib/seam/connect/routes/seam-http-endpoints.ts +1942 -0
- package/src/lib/version.ts +1 -1
package/README.md
CHANGED
|
@@ -512,6 +512,18 @@ const devices = await seam.client.get<DevicesListResponse>('/devices/list')
|
|
|
512
512
|
An Axios compatible client may be provided to create a `SeamHttp` instance.
|
|
513
513
|
This API is used internally and is not directly supported.
|
|
514
514
|
|
|
515
|
+
#### Alternative endpoint path interface
|
|
516
|
+
|
|
517
|
+
The `SeamHttpEndpoints` class offers an alternative path-based interface to every API endpoint.
|
|
518
|
+
Each endpoint is exposed as simple property that returns the corresponding method from `SeamHttp`.
|
|
519
|
+
|
|
520
|
+
```ts
|
|
521
|
+
import { SeamHttpEndpoints } from '@seamapi/http/connect'
|
|
522
|
+
|
|
523
|
+
const seam = new SeamHttpEndpoints()
|
|
524
|
+
const devices = await seam['/devices/list']()
|
|
525
|
+
```
|
|
526
|
+
|
|
515
527
|
#### Inspecting the Request
|
|
516
528
|
|
|
517
529
|
All client methods return an instance of `SeamHttpRequest`.
|