@easyedu/js-lsm-api 1.62.0 → 1.63.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/.openapi-generator/FILES +4 -0
- package/README.md +15 -2
- package/dist/apis/DispatchApi.d.ts +44 -0
- package/dist/apis/DispatchApi.js +104 -0
- package/dist/apis/PlayerApi.d.ts +183 -0
- package/dist/apis/PlayerApi.js +454 -0
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.js +2 -0
- package/dist/esm/apis/DispatchApi.d.ts +44 -0
- package/dist/esm/apis/DispatchApi.js +100 -0
- package/dist/esm/apis/PlayerApi.d.ts +183 -0
- package/dist/esm/apis/PlayerApi.js +450 -0
- package/dist/esm/apis/index.d.ts +2 -0
- package/dist/esm/apis/index.js +2 -0
- package/docs/DispatchApi.md +134 -0
- package/docs/PlayerApi.md +760 -0
- package/package.json +1 -1
- package/src/apis/DispatchApi.ts +106 -0
- package/src/apis/PlayerApi.ts +559 -0
- package/src/apis/index.ts +2 -0
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
# DispatchApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**getDispatchRollup**](DispatchApi.md#getdispatchrollup) | **GET** /dispatch/sessions/{dispatchPackageId}/rollup | Get dispatch package rollup data |
|
|
8
|
+
| [**postDispatchLaunch**](DispatchApi.md#postdispatchlaunch) | **POST** /dispatch/launch | Launch a dispatch package |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## getDispatchRollup
|
|
13
|
+
|
|
14
|
+
> getDispatchRollup(dispatchPackageId)
|
|
15
|
+
|
|
16
|
+
Get dispatch package rollup data
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
import {
|
|
22
|
+
Configuration,
|
|
23
|
+
DispatchApi,
|
|
24
|
+
} from '@easyedu/js-lsm-api';
|
|
25
|
+
import type { GetDispatchRollupRequest } from '@easyedu/js-lsm-api';
|
|
26
|
+
|
|
27
|
+
async function example() {
|
|
28
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
29
|
+
const api = new DispatchApi();
|
|
30
|
+
|
|
31
|
+
const body = {
|
|
32
|
+
// string
|
|
33
|
+
dispatchPackageId: dispatchPackageId_example,
|
|
34
|
+
} satisfies GetDispatchRollupRequest;
|
|
35
|
+
|
|
36
|
+
try {
|
|
37
|
+
const data = await api.getDispatchRollup(body);
|
|
38
|
+
console.log(data);
|
|
39
|
+
} catch (error) {
|
|
40
|
+
console.error(error);
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
// Run the test
|
|
45
|
+
example().catch(console.error);
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Parameters
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
| Name | Type | Description | Notes |
|
|
52
|
+
|------------- | ------------- | ------------- | -------------|
|
|
53
|
+
| **dispatchPackageId** | `string` | | [Defaults to `undefined`] |
|
|
54
|
+
|
|
55
|
+
### Return type
|
|
56
|
+
|
|
57
|
+
`void` (Empty response body)
|
|
58
|
+
|
|
59
|
+
### Authorization
|
|
60
|
+
|
|
61
|
+
No authorization required
|
|
62
|
+
|
|
63
|
+
### HTTP request headers
|
|
64
|
+
|
|
65
|
+
- **Content-Type**: Not defined
|
|
66
|
+
- **Accept**: Not defined
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
### HTTP response details
|
|
70
|
+
| Status code | Description | Response headers |
|
|
71
|
+
|-------------|-------------|------------------|
|
|
72
|
+
| **200** | Dispatch rollup data | - |
|
|
73
|
+
| **401** | Dispatch token required | - |
|
|
74
|
+
|
|
75
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
## postDispatchLaunch
|
|
79
|
+
|
|
80
|
+
> postDispatchLaunch()
|
|
81
|
+
|
|
82
|
+
Launch a dispatch package
|
|
83
|
+
|
|
84
|
+
### Example
|
|
85
|
+
|
|
86
|
+
```ts
|
|
87
|
+
import {
|
|
88
|
+
Configuration,
|
|
89
|
+
DispatchApi,
|
|
90
|
+
} from '@easyedu/js-lsm-api';
|
|
91
|
+
import type { PostDispatchLaunchRequest } from '@easyedu/js-lsm-api';
|
|
92
|
+
|
|
93
|
+
async function example() {
|
|
94
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
95
|
+
const api = new DispatchApi();
|
|
96
|
+
|
|
97
|
+
try {
|
|
98
|
+
const data = await api.postDispatchLaunch();
|
|
99
|
+
console.log(data);
|
|
100
|
+
} catch (error) {
|
|
101
|
+
console.error(error);
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
// Run the test
|
|
106
|
+
example().catch(console.error);
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### Parameters
|
|
110
|
+
|
|
111
|
+
This endpoint does not need any parameter.
|
|
112
|
+
|
|
113
|
+
### Return type
|
|
114
|
+
|
|
115
|
+
`void` (Empty response body)
|
|
116
|
+
|
|
117
|
+
### Authorization
|
|
118
|
+
|
|
119
|
+
No authorization required
|
|
120
|
+
|
|
121
|
+
### HTTP request headers
|
|
122
|
+
|
|
123
|
+
- **Content-Type**: Not defined
|
|
124
|
+
- **Accept**: Not defined
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
### HTTP response details
|
|
128
|
+
| Status code | Description | Response headers |
|
|
129
|
+
|-------------|-------------|------------------|
|
|
130
|
+
| **200** | Dispatch launch response | - |
|
|
131
|
+
| **400** | Invalid launch request | - |
|
|
132
|
+
|
|
133
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
134
|
+
|