@vantage-sh/vantage-client 2.3.0 → 2.4.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 +15 -0
- package/dist/index.d.mts +869 -382
- package/dist/index.d.ts +869 -382
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +8 -2
package/README.md
CHANGED
|
@@ -194,6 +194,14 @@ const report = await client.request(
|
|
|
194
194
|
|
|
195
195
|
## Development
|
|
196
196
|
|
|
197
|
+
### Generate the latest API changes
|
|
198
|
+
|
|
199
|
+
To create the checked in generated files, run the following command.
|
|
200
|
+
|
|
201
|
+
```bash
|
|
202
|
+
npm run generate
|
|
203
|
+
```
|
|
204
|
+
|
|
197
205
|
### Building
|
|
198
206
|
|
|
199
207
|
```bash
|
|
@@ -238,6 +246,13 @@ The SDK exports several utility types for advanced use:
|
|
|
238
246
|
| `ResponseBodyForPathAndMethod<P, M>` | Response body type for a path/method |
|
|
239
247
|
| `NoSlashString` | Branded type for safely encoded path segments |
|
|
240
248
|
|
|
249
|
+
## Testing
|
|
250
|
+
|
|
251
|
+
To run the tests, create an `.env.local` file copying the values from `.env.example`. You will need
|
|
252
|
+
* `VANTAGE_API_TOKEN` - API Token with Read / Write access
|
|
253
|
+
* `VANTAGE_WORKSPACE_TOKEN` - Workspace token for a location to create objects
|
|
254
|
+
* `VANTAGE_API_BASE_URL` - Optionally, override the API URL. Default is `api.vantage.sh`
|
|
255
|
+
|
|
241
256
|
## Publishing
|
|
242
257
|
|
|
243
258
|
After building locally and confirming the changes in the Vantage API are reflected in the types in this
|