@s-corp-biz/biz-entity-api 1.6.0-development.3 → 1.6.0-development.4
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 +48 -0
- package/package.json +14 -2
package/README.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# @s-corp-biz/biz-entity-api
|
|
2
|
+
|
|
3
|
+
TypeScript API client for the S-Corp Biz Entity API. Auto-generated from OpenAPI specifications.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @s-corp-biz/biz-entity-api
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { Configuration, CompanyApi, PersonalApi } from '@s-corp-biz/biz-entity-api';
|
|
15
|
+
|
|
16
|
+
// Configure the API client
|
|
17
|
+
const config = new Configuration({
|
|
18
|
+
basePath: 'https://api.your-domain.com',
|
|
19
|
+
accessToken: 'your-auth-token'
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
// Use the API
|
|
23
|
+
const companyApi = new CompanyApi(config);
|
|
24
|
+
const companies = await companyApi.getCompanies();
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Features
|
|
28
|
+
|
|
29
|
+
- ✅ Full TypeScript type definitions
|
|
30
|
+
- ✅ Auto-generated from OpenAPI/Swagger specs
|
|
31
|
+
- ✅ Axios-based HTTP client
|
|
32
|
+
- ✅ Supports all API endpoints
|
|
33
|
+
|
|
34
|
+
## API Documentation
|
|
35
|
+
|
|
36
|
+
For full API documentation, visit your API's Swagger UI at `/swagger`
|
|
37
|
+
|
|
38
|
+
## Development
|
|
39
|
+
|
|
40
|
+
This package is auto-generated and published via CI/CD. Do not manually edit the generated files.
|
|
41
|
+
|
|
42
|
+
## License
|
|
43
|
+
|
|
44
|
+
ISC
|
|
45
|
+
|
|
46
|
+
## Support
|
|
47
|
+
|
|
48
|
+
For issues or questions, please open an issue on [GitHub](https://github.com/s-corp-biz/biz-entity-api/issues).
|
package/package.json
CHANGED
|
@@ -1,7 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@s-corp-biz/biz-entity-api",
|
|
3
|
-
"version": "1.6.0-development.
|
|
3
|
+
"version": "1.6.0-development.4",
|
|
4
4
|
"description": "TypeScript API client for S-Corp Biz Entity API",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"typescript",
|
|
7
|
+
"api-client",
|
|
8
|
+
"s-corp",
|
|
9
|
+
"business",
|
|
10
|
+
"tax",
|
|
11
|
+
"accounting",
|
|
12
|
+
"openapi",
|
|
13
|
+
"swagger",
|
|
14
|
+
"axios"
|
|
15
|
+
],
|
|
5
16
|
"main": "lib/index.js",
|
|
6
17
|
"types": "lib/index.d.ts",
|
|
7
18
|
"publishConfig": {
|
|
@@ -32,7 +43,8 @@
|
|
|
32
43
|
"axios": "^1.2.0"
|
|
33
44
|
},
|
|
34
45
|
"files": [
|
|
35
|
-
"lib/**/*"
|
|
46
|
+
"lib/**/*",
|
|
47
|
+
"README.md"
|
|
36
48
|
],
|
|
37
49
|
"release": {
|
|
38
50
|
"branches": [
|