@hewnventures/levrops-sdk 1.1.0 → 1.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 +59 -0
- package/package.json +3 -2
package/README.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# @hewnventures/levrops-sdk
|
|
2
|
+
|
|
3
|
+
TypeScript SDK for the LevrOps Public API. Generated from OpenAPI specifications.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @hewnventures/levrops-sdk
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { OpenAPI } from '@hewnventures/levrops-sdk';
|
|
15
|
+
import { AuthService, CrmService, EditorialService, InsightsService, KpIsService, TasksService } from '@hewnventures/levrops-sdk';
|
|
16
|
+
|
|
17
|
+
// Configure the API base URL
|
|
18
|
+
OpenAPI.BASE = 'https://api.levrops.com';
|
|
19
|
+
|
|
20
|
+
// Set your access token
|
|
21
|
+
OpenAPI.TOKEN = process.env.LEVROPS_ACCESS_TOKEN;
|
|
22
|
+
|
|
23
|
+
// Use the services
|
|
24
|
+
const tokenResponse = await AuthService.authLogin({
|
|
25
|
+
requestBody: {
|
|
26
|
+
email: 'user@example.com',
|
|
27
|
+
password: 'password123'
|
|
28
|
+
}
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
const contacts = await CrmService.contactList();
|
|
32
|
+
const textArtifacts = await InsightsService.textArtifactList();
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Services
|
|
36
|
+
|
|
37
|
+
- **AuthService** - Authentication, authorization, and session management
|
|
38
|
+
- **CrmService** - Contact, identity, and membership management
|
|
39
|
+
- **EditorialService** - Editorial planning, content, and campaign endpoints
|
|
40
|
+
- **InsightsService** - Reflective writing artifacts and advisor insight sessions
|
|
41
|
+
- **KpIsService** - Analytics KPI definitions and readings
|
|
42
|
+
- **TasksService** - Operational task templates and instances
|
|
43
|
+
|
|
44
|
+
## Generated Types
|
|
45
|
+
|
|
46
|
+
All request/response types are fully typed based on the OpenAPI schema. Import models from the package:
|
|
47
|
+
|
|
48
|
+
```typescript
|
|
49
|
+
import type { Contact, TextArtifact, InsightSession } from '@hewnventures/levrops-sdk';
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Versioning
|
|
53
|
+
|
|
54
|
+
This SDK follows semantic versioning and matches the LevrOps API contract version. See the [levrops-contracts repository](https://github.com/jackmckracken/levrops-contracts) for contract specifications and change history.
|
|
55
|
+
|
|
56
|
+
## License
|
|
57
|
+
|
|
58
|
+
MIT
|
|
59
|
+
|
package/package.json
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hewnventures/levrops-sdk",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.2",
|
|
4
4
|
"description": "TypeScript SDK for the LevrOps API.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
8
|
-
"url": "https://github.com/
|
|
8
|
+
"url": "https://github.com/jackmckracken/levrops-contracts.git",
|
|
9
9
|
"directory": "clients/ts"
|
|
10
10
|
},
|
|
11
|
+
"homepage": "https://github.com/jackmckracken/levrops-contracts#readme",
|
|
11
12
|
"main": "dist/index.js",
|
|
12
13
|
"module": "dist/index.mjs",
|
|
13
14
|
"types": "dist/index.d.ts",
|