grexx-api 12.6.12 → 12.6.14
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 +10 -11
- package/dist/generated/core/OpenAPI.js +1 -1
- package/package.json +1 -1
- package/typedoc.json +1 -1
- package/openapi-spec.yaml +0 -4470
package/README.md
CHANGED
|
@@ -10,9 +10,6 @@ This is the TypeScript client for the **Grexx Platform API**, generated from the
|
|
|
10
10
|
- [Usage](#usage)
|
|
11
11
|
- [Initialization](#initialization)
|
|
12
12
|
- [Examples](#examples)
|
|
13
|
-
- [Endpoints](#endpoints)
|
|
14
|
-
- [Development](#development)
|
|
15
|
-
- [License](#license)
|
|
16
13
|
|
|
17
14
|
---
|
|
18
15
|
|
|
@@ -34,15 +31,13 @@ yarn add grexx-api-client
|
|
|
34
31
|
|
|
35
32
|
### Initialization
|
|
36
33
|
|
|
37
|
-
To use the client, initialize
|
|
34
|
+
To use the client, initialize the `OpenAPI` configuration with the base URL of your Grexx platform and any required authentication details.
|
|
38
35
|
|
|
39
36
|
```typescript
|
|
40
|
-
import {
|
|
37
|
+
import { OpenAPI } from 'grexx-api';
|
|
41
38
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
apiKey: 'your-api-key', // Replace with your API key if required
|
|
45
|
-
});
|
|
39
|
+
OpenAPI.BASE = 'https://name.grexx.today/api/v1';
|
|
40
|
+
OpenAPI.TOKEN = 'your-api-key'; // Replace with your API key if required
|
|
46
41
|
```
|
|
47
42
|
|
|
48
43
|
### Examples
|
|
@@ -50,9 +45,11 @@ const client = new GrexxApiClient({
|
|
|
50
45
|
#### Retrieve Case Information
|
|
51
46
|
|
|
52
47
|
```typescript
|
|
48
|
+
import { CaseService } from 'grexx-api';
|
|
49
|
+
|
|
53
50
|
const casePath = 'example-case-id';
|
|
54
51
|
|
|
55
|
-
|
|
52
|
+
CaseService.caseInfo(casePath, { css: true, rootline: false })
|
|
56
53
|
.then(response => {
|
|
57
54
|
console.log('Case Info:', response);
|
|
58
55
|
})
|
|
@@ -64,10 +61,12 @@ client.getCaseInfo(casePath, { css: true, rootline: false })
|
|
|
64
61
|
#### Submit a Task
|
|
65
62
|
|
|
66
63
|
```typescript
|
|
64
|
+
import { CaseService } from 'grexx-api';
|
|
65
|
+
|
|
67
66
|
const taskId = 12345;
|
|
68
67
|
const casePath = 'example-case-id';
|
|
69
68
|
|
|
70
|
-
|
|
69
|
+
CaseService.taskSubmit(taskId, casePath, {
|
|
71
70
|
fields: { fieldName: 'value' },
|
|
72
71
|
autoProgress: true,
|
|
73
72
|
})
|
|
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.OpenAPI = void 0;
|
|
4
4
|
exports.OpenAPI = {
|
|
5
5
|
BASE: 'https://name.grexx.today/api/v1',
|
|
6
|
-
VERSION: '12.6.
|
|
6
|
+
VERSION: '12.6.14',
|
|
7
7
|
WITH_CREDENTIALS: false,
|
|
8
8
|
CREDENTIALS: 'include',
|
|
9
9
|
TOKEN: undefined,
|
package/package.json
CHANGED
package/typedoc.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"$schema": "https://typedoc.org/schema.json",
|
|
3
3
|
"name": "Grexx platform javascript library",
|
|
4
4
|
"entryPoints": ["src/generated/index.ts"],
|
|
5
|
-
"out": "
|
|
5
|
+
"out": "../src/client/grexx-api/docs/",
|
|
6
6
|
"sidebarLinks": {
|
|
7
7
|
"JavaScript Browser API documentation": "/docs/api/js",
|
|
8
8
|
"Exit documentation": "/home"
|