@rasadov/lumoar-sdk 1.2.8 → 1.3.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 +2 -0
- package/api.ts +328 -64
- package/dist/api.d.ts +239 -59
- package/dist/api.js +206 -38
- package/docs/ReportBase.md +8 -0
- package/docs/ReportGenerate.md +2 -0
- package/docs/ReportsApi.md +59 -0
- package/docs/RolesApi.md +6 -0
- package/docs/SchedulerResponse.md +23 -0
- package/docs/TaskStatusResponse.md +29 -0
- package/docs/TasksApi.md +61 -2
- package/package.json +1 -1
package/docs/RolesApi.md
CHANGED
|
@@ -140,11 +140,13 @@ const configuration = new Configuration();
|
|
|
140
140
|
const apiInstance = new RolesApi(configuration);
|
|
141
141
|
|
|
142
142
|
let inviteToCompany: InviteToCompany; //
|
|
143
|
+
let companyId: string; // (optional) (default to undefined)
|
|
143
144
|
let authorization: string; // (optional) (default to undefined)
|
|
144
145
|
let sessionId: string; // (optional) (default to undefined)
|
|
145
146
|
|
|
146
147
|
const { status, data } = await apiInstance.inviteV1RolesInvitesPost(
|
|
147
148
|
inviteToCompany,
|
|
149
|
+
companyId,
|
|
148
150
|
authorization,
|
|
149
151
|
sessionId
|
|
150
152
|
);
|
|
@@ -155,6 +157,7 @@ const { status, data } = await apiInstance.inviteV1RolesInvitesPost(
|
|
|
155
157
|
|Name | Type | Description | Notes|
|
|
156
158
|
|------------- | ------------- | ------------- | -------------|
|
|
157
159
|
| **inviteToCompany** | **InviteToCompany**| | |
|
|
160
|
+
| **companyId** | [**string**] | | (optional) defaults to undefined|
|
|
158
161
|
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
159
162
|
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
160
163
|
|
|
@@ -198,11 +201,13 @@ const configuration = new Configuration();
|
|
|
198
201
|
const apiInstance = new RolesApi(configuration);
|
|
199
202
|
|
|
200
203
|
let removeFromCompany: RemoveFromCompany; //
|
|
204
|
+
let companyId: string; // (optional) (default to undefined)
|
|
201
205
|
let authorization: string; // (optional) (default to undefined)
|
|
202
206
|
let sessionId: string; // (optional) (default to undefined)
|
|
203
207
|
|
|
204
208
|
const { status, data } = await apiInstance.removePeopleV1RolesInvitesDelete(
|
|
205
209
|
removeFromCompany,
|
|
210
|
+
companyId,
|
|
206
211
|
authorization,
|
|
207
212
|
sessionId
|
|
208
213
|
);
|
|
@@ -213,6 +218,7 @@ const { status, data } = await apiInstance.removePeopleV1RolesInvitesDelete(
|
|
|
213
218
|
|Name | Type | Description | Notes|
|
|
214
219
|
|------------- | ------------- | ------------- | -------------|
|
|
215
220
|
| **removeFromCompany** | **RemoveFromCompany**| | |
|
|
221
|
+
| **companyId** | [**string**] | | (optional) defaults to undefined|
|
|
216
222
|
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
217
223
|
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
218
224
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# SchedulerResponse
|
|
2
|
+
|
|
3
|
+
Response schema for task scheduler request
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**task_id** | **string** | | [default to undefined]
|
|
10
|
+
**details** | **string** | | [optional] [default to 'Task scheduler has been successfully started']
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { SchedulerResponse } from './api';
|
|
16
|
+
|
|
17
|
+
const instance: SchedulerResponse = {
|
|
18
|
+
task_id,
|
|
19
|
+
details,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# TaskStatusResponse
|
|
2
|
+
|
|
3
|
+
Response schema for checking Celery task status
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**task_id** | **string** | | [default to undefined]
|
|
10
|
+
**status** | **string** | | [default to undefined]
|
|
11
|
+
**result** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
12
|
+
**error** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**progress** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { TaskStatusResponse } from './api';
|
|
19
|
+
|
|
20
|
+
const instance: TaskStatusResponse = {
|
|
21
|
+
task_id,
|
|
22
|
+
status,
|
|
23
|
+
result,
|
|
24
|
+
error,
|
|
25
|
+
progress,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/TasksApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *http://localhost*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**createTaskV1TasksPost**](#createtaskv1taskspost) | **POST** /v1/tasks/ | Create Task|
|
|
8
8
|
|[**deleteTaskV1TasksDelete**](#deletetaskv1tasksdelete) | **DELETE** /v1/tasks/ | Delete Task|
|
|
9
|
+
|[**getTaskSchedulerStatusV1TasksScheduleTaskIdStatusGet**](#gettaskschedulerstatusv1tasksscheduletaskidstatusget) | **GET** /v1/tasks/schedule/{task_id}/status | Get Task Scheduler Status|
|
|
9
10
|
|[**getTaskV1TasksGetTaskIdGet**](#gettaskv1tasksgettaskidget) | **GET** /v1/tasks/get/{task_id} | Get Task|
|
|
10
11
|
|[**listTasksForCompanyV1TasksCompanyGet**](#listtasksforcompanyv1taskscompanyget) | **GET** /v1/tasks/company | List Tasks For Company|
|
|
11
12
|
|[**listTasksForUserV1TasksUserGet**](#listtasksforuserv1tasksuserget) | **GET** /v1/tasks/user | List Tasks For User|
|
|
@@ -121,6 +122,64 @@ No authorization required
|
|
|
121
122
|
- **Accept**: application/json
|
|
122
123
|
|
|
123
124
|
|
|
125
|
+
### HTTP response details
|
|
126
|
+
| Status code | Description | Response headers |
|
|
127
|
+
|-------------|-------------|------------------|
|
|
128
|
+
|**200** | Successful Response | - |
|
|
129
|
+
|**422** | Validation Error | - |
|
|
130
|
+
|
|
131
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
132
|
+
|
|
133
|
+
# **getTaskSchedulerStatusV1TasksScheduleTaskIdStatusGet**
|
|
134
|
+
> TaskStatusResponse getTaskSchedulerStatusV1TasksScheduleTaskIdStatusGet()
|
|
135
|
+
|
|
136
|
+
Check the status of a task scheduler background job
|
|
137
|
+
|
|
138
|
+
### Example
|
|
139
|
+
|
|
140
|
+
```typescript
|
|
141
|
+
import {
|
|
142
|
+
TasksApi,
|
|
143
|
+
Configuration
|
|
144
|
+
} from './api';
|
|
145
|
+
|
|
146
|
+
const configuration = new Configuration();
|
|
147
|
+
const apiInstance = new TasksApi(configuration);
|
|
148
|
+
|
|
149
|
+
let taskId: string; // (default to undefined)
|
|
150
|
+
let authorization: string; // (optional) (default to undefined)
|
|
151
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
152
|
+
|
|
153
|
+
const { status, data } = await apiInstance.getTaskSchedulerStatusV1TasksScheduleTaskIdStatusGet(
|
|
154
|
+
taskId,
|
|
155
|
+
authorization,
|
|
156
|
+
sessionId
|
|
157
|
+
);
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### Parameters
|
|
161
|
+
|
|
162
|
+
|Name | Type | Description | Notes|
|
|
163
|
+
|------------- | ------------- | ------------- | -------------|
|
|
164
|
+
| **taskId** | [**string**] | | defaults to undefined|
|
|
165
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
166
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
### Return type
|
|
170
|
+
|
|
171
|
+
**TaskStatusResponse**
|
|
172
|
+
|
|
173
|
+
### Authorization
|
|
174
|
+
|
|
175
|
+
No authorization required
|
|
176
|
+
|
|
177
|
+
### HTTP request headers
|
|
178
|
+
|
|
179
|
+
- **Content-Type**: Not defined
|
|
180
|
+
- **Accept**: application/json
|
|
181
|
+
|
|
182
|
+
|
|
124
183
|
### HTTP response details
|
|
125
184
|
| Status code | Description | Response headers |
|
|
126
185
|
|-------------|-------------|------------------|
|
|
@@ -349,7 +408,7 @@ No authorization required
|
|
|
349
408
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
350
409
|
|
|
351
410
|
# **requestTaskSchedulingV1TasksSchedulePost**
|
|
352
|
-
>
|
|
411
|
+
> SchedulerResponse requestTaskSchedulingV1TasksSchedulePost(schedulerRequest)
|
|
353
412
|
|
|
354
413
|
|
|
355
414
|
### Example
|
|
@@ -386,7 +445,7 @@ const { status, data } = await apiInstance.requestTaskSchedulingV1TasksScheduleP
|
|
|
386
445
|
|
|
387
446
|
### Return type
|
|
388
447
|
|
|
389
|
-
**
|
|
448
|
+
**SchedulerResponse**
|
|
390
449
|
|
|
391
450
|
### Authorization
|
|
392
451
|
|