@air/api-rest 0.1.1 → 0.1.2
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 +34 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# @air/api-rest
|
|
2
|
+
|
|
3
|
+
Typed REST client for the [Air API SDK](https://github.com/AirLabsTeam/air-api-sdk).
|
|
4
|
+
|
|
5
|
+
This package provides the resource classes (boards, assets, tags, custom fields, uploads, imports, roles) and their TypeScript types. It builds on `@air/api-core` for HTTP transport.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
Most users should install `@air/api-sdk` instead, which includes this package:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @air/api-sdk
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
If you only need the REST resource layer:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install @air/api-rest
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## What's included
|
|
22
|
+
|
|
23
|
+
- Resource classes: `BoardsResource`, `AssetsResource`, `TagsResource`, `CustomFieldsResource`, `UploadsResource`, `ImportsResource`, `RolesResource`
|
|
24
|
+
- Full TypeScript types for all API request/response shapes
|
|
25
|
+
- `AirApi` client class that composes all resources
|
|
26
|
+
|
|
27
|
+
## Documentation
|
|
28
|
+
|
|
29
|
+
- [Air Developer Docs](https://developer.air.inc/) — API reference and guides
|
|
30
|
+
- [GitHub Repository](https://github.com/AirLabsTeam/air-api-sdk) — source code and examples
|
|
31
|
+
|
|
32
|
+
## License
|
|
33
|
+
|
|
34
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@air/api-rest",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Typed REST client for Air API",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"clean": "rm -rf dist tsconfig.tsbuildinfo"
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@air/api-core": "0.1.
|
|
32
|
+
"@air/api-core": "0.1.2"
|
|
33
33
|
},
|
|
34
34
|
"engines": {
|
|
35
35
|
"node": ">=18"
|
|
@@ -42,5 +42,5 @@
|
|
|
42
42
|
"url": "https://github.com/AirLabsTeam/air-api-sdk.git",
|
|
43
43
|
"directory": "packages/rest"
|
|
44
44
|
},
|
|
45
|
-
"license": "
|
|
45
|
+
"license": "MIT"
|
|
46
46
|
}
|