@rasadov/lumoar-sdk 1.0.8 → 1.0.10
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 +13 -0
- package/api.ts +1366 -64
- package/dist/api.d.ts +849 -20
- package/dist/api.js +995 -63
- package/dist/sdk.d.ts +5 -1
- package/dist/sdk.js +5 -1
- package/docs/CreateTaskSchema.md +28 -0
- package/docs/DeleteTaskSchema.md +20 -0
- package/docs/DeliveryMethod.md +8 -0
- package/docs/PaginationResponseReportBase.md +22 -0
- package/docs/PaginationResponseTaskRead.md +22 -0
- package/docs/ReminderFrequency.md +12 -0
- package/docs/ReportBase.md +32 -0
- package/docs/ReportGenerate.md +20 -0
- package/docs/ReportsApi.md +254 -0
- package/docs/SchedulerRequest.md +32 -0
- package/docs/TaskRead.md +38 -0
- package/docs/TasksApi.md +371 -0
- package/docs/UpdateTaskSchema.md +28 -0
- package/package.json +1 -1
- package/sdk.ts +8 -0
package/docs/TasksApi.md
ADDED
|
@@ -0,0 +1,371 @@
|
|
|
1
|
+
# TasksApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**createTaskV1TasksPost**](#createtaskv1taskspost) | **POST** /v1/tasks/ | Create Task|
|
|
8
|
+
|[**deleteTaskV1TasksDelete**](#deletetaskv1tasksdelete) | **DELETE** /v1/tasks/ | Delete Task|
|
|
9
|
+
|[**listTasksForCompanyV1TasksCompanyGet**](#listtasksforcompanyv1taskscompanyget) | **GET** /v1/tasks/company | List Tasks For Company|
|
|
10
|
+
|[**listTasksForUserV1TasksUserGet**](#listtasksforuserv1tasksuserget) | **GET** /v1/tasks/user | List Tasks For User|
|
|
11
|
+
|[**requestTaskSchedulingV1TasksSchedulePost**](#requesttaskschedulingv1tasksschedulepost) | **POST** /v1/tasks/schedule | Request Task Scheduling|
|
|
12
|
+
|[**updateTaskV1TasksPut**](#updatetaskv1tasksput) | **PUT** /v1/tasks/ | Update Task|
|
|
13
|
+
|
|
14
|
+
# **createTaskV1TasksPost**
|
|
15
|
+
> TaskRead createTaskV1TasksPost(createTaskSchema)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import {
|
|
22
|
+
TasksApi,
|
|
23
|
+
Configuration,
|
|
24
|
+
CreateTaskSchema
|
|
25
|
+
} from './api';
|
|
26
|
+
|
|
27
|
+
const configuration = new Configuration();
|
|
28
|
+
const apiInstance = new TasksApi(configuration);
|
|
29
|
+
|
|
30
|
+
let createTaskSchema: CreateTaskSchema; //
|
|
31
|
+
let authorization: string; // (optional) (default to undefined)
|
|
32
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
33
|
+
|
|
34
|
+
const { status, data } = await apiInstance.createTaskV1TasksPost(
|
|
35
|
+
createTaskSchema,
|
|
36
|
+
authorization,
|
|
37
|
+
sessionId
|
|
38
|
+
);
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Parameters
|
|
42
|
+
|
|
43
|
+
|Name | Type | Description | Notes|
|
|
44
|
+
|------------- | ------------- | ------------- | -------------|
|
|
45
|
+
| **createTaskSchema** | **CreateTaskSchema**| | |
|
|
46
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
47
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
### Return type
|
|
51
|
+
|
|
52
|
+
**TaskRead**
|
|
53
|
+
|
|
54
|
+
### Authorization
|
|
55
|
+
|
|
56
|
+
No authorization required
|
|
57
|
+
|
|
58
|
+
### HTTP request headers
|
|
59
|
+
|
|
60
|
+
- **Content-Type**: application/json
|
|
61
|
+
- **Accept**: application/json
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
### HTTP response details
|
|
65
|
+
| Status code | Description | Response headers |
|
|
66
|
+
|-------------|-------------|------------------|
|
|
67
|
+
|**200** | Successful Response | - |
|
|
68
|
+
|**422** | Validation Error | - |
|
|
69
|
+
|
|
70
|
+
[[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)
|
|
71
|
+
|
|
72
|
+
# **deleteTaskV1TasksDelete**
|
|
73
|
+
> Details deleteTaskV1TasksDelete(deleteTaskSchema)
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
### Example
|
|
77
|
+
|
|
78
|
+
```typescript
|
|
79
|
+
import {
|
|
80
|
+
TasksApi,
|
|
81
|
+
Configuration,
|
|
82
|
+
DeleteTaskSchema
|
|
83
|
+
} from './api';
|
|
84
|
+
|
|
85
|
+
const configuration = new Configuration();
|
|
86
|
+
const apiInstance = new TasksApi(configuration);
|
|
87
|
+
|
|
88
|
+
let deleteTaskSchema: DeleteTaskSchema; //
|
|
89
|
+
let authorization: string; // (optional) (default to undefined)
|
|
90
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
91
|
+
|
|
92
|
+
const { status, data } = await apiInstance.deleteTaskV1TasksDelete(
|
|
93
|
+
deleteTaskSchema,
|
|
94
|
+
authorization,
|
|
95
|
+
sessionId
|
|
96
|
+
);
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Parameters
|
|
100
|
+
|
|
101
|
+
|Name | Type | Description | Notes|
|
|
102
|
+
|------------- | ------------- | ------------- | -------------|
|
|
103
|
+
| **deleteTaskSchema** | **DeleteTaskSchema**| | |
|
|
104
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
105
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
### Return type
|
|
109
|
+
|
|
110
|
+
**Details**
|
|
111
|
+
|
|
112
|
+
### Authorization
|
|
113
|
+
|
|
114
|
+
No authorization required
|
|
115
|
+
|
|
116
|
+
### HTTP request headers
|
|
117
|
+
|
|
118
|
+
- **Content-Type**: application/json
|
|
119
|
+
- **Accept**: application/json
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
### HTTP response details
|
|
123
|
+
| Status code | Description | Response headers |
|
|
124
|
+
|-------------|-------------|------------------|
|
|
125
|
+
|**200** | Successful Response | - |
|
|
126
|
+
|**422** | Validation Error | - |
|
|
127
|
+
|
|
128
|
+
[[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)
|
|
129
|
+
|
|
130
|
+
# **listTasksForCompanyV1TasksCompanyGet**
|
|
131
|
+
> PaginationResponseTaskRead listTasksForCompanyV1TasksCompanyGet()
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
### Example
|
|
135
|
+
|
|
136
|
+
```typescript
|
|
137
|
+
import {
|
|
138
|
+
TasksApi,
|
|
139
|
+
Configuration
|
|
140
|
+
} from './api';
|
|
141
|
+
|
|
142
|
+
const configuration = new Configuration();
|
|
143
|
+
const apiInstance = new TasksApi(configuration);
|
|
144
|
+
|
|
145
|
+
let companyId: string; // (default to undefined)
|
|
146
|
+
let page: number; // (optional) (default to 1)
|
|
147
|
+
let elements: number; // (optional) (default to 20)
|
|
148
|
+
let authorization: string; // (optional) (default to undefined)
|
|
149
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
150
|
+
|
|
151
|
+
const { status, data } = await apiInstance.listTasksForCompanyV1TasksCompanyGet(
|
|
152
|
+
companyId,
|
|
153
|
+
page,
|
|
154
|
+
elements,
|
|
155
|
+
authorization,
|
|
156
|
+
sessionId
|
|
157
|
+
);
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### Parameters
|
|
161
|
+
|
|
162
|
+
|Name | Type | Description | Notes|
|
|
163
|
+
|------------- | ------------- | ------------- | -------------|
|
|
164
|
+
| **companyId** | [**string**] | | defaults to undefined|
|
|
165
|
+
| **page** | [**number**] | | (optional) defaults to 1|
|
|
166
|
+
| **elements** | [**number**] | | (optional) defaults to 20|
|
|
167
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
168
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
### Return type
|
|
172
|
+
|
|
173
|
+
**PaginationResponseTaskRead**
|
|
174
|
+
|
|
175
|
+
### Authorization
|
|
176
|
+
|
|
177
|
+
No authorization required
|
|
178
|
+
|
|
179
|
+
### HTTP request headers
|
|
180
|
+
|
|
181
|
+
- **Content-Type**: Not defined
|
|
182
|
+
- **Accept**: application/json
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
### HTTP response details
|
|
186
|
+
| Status code | Description | Response headers |
|
|
187
|
+
|-------------|-------------|------------------|
|
|
188
|
+
|**200** | Successful Response | - |
|
|
189
|
+
|**422** | Validation Error | - |
|
|
190
|
+
|
|
191
|
+
[[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)
|
|
192
|
+
|
|
193
|
+
# **listTasksForUserV1TasksUserGet**
|
|
194
|
+
> PaginationResponseTaskRead listTasksForUserV1TasksUserGet()
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
### Example
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
import {
|
|
201
|
+
TasksApi,
|
|
202
|
+
Configuration
|
|
203
|
+
} from './api';
|
|
204
|
+
|
|
205
|
+
const configuration = new Configuration();
|
|
206
|
+
const apiInstance = new TasksApi(configuration);
|
|
207
|
+
|
|
208
|
+
let companyId: string; // (default to undefined)
|
|
209
|
+
let page: number; // (optional) (default to 1)
|
|
210
|
+
let elements: number; // (optional) (default to 20)
|
|
211
|
+
let authorization: string; // (optional) (default to undefined)
|
|
212
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
213
|
+
|
|
214
|
+
const { status, data } = await apiInstance.listTasksForUserV1TasksUserGet(
|
|
215
|
+
companyId,
|
|
216
|
+
page,
|
|
217
|
+
elements,
|
|
218
|
+
authorization,
|
|
219
|
+
sessionId
|
|
220
|
+
);
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### Parameters
|
|
224
|
+
|
|
225
|
+
|Name | Type | Description | Notes|
|
|
226
|
+
|------------- | ------------- | ------------- | -------------|
|
|
227
|
+
| **companyId** | [**string**] | | defaults to undefined|
|
|
228
|
+
| **page** | [**number**] | | (optional) defaults to 1|
|
|
229
|
+
| **elements** | [**number**] | | (optional) defaults to 20|
|
|
230
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
231
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
### Return type
|
|
235
|
+
|
|
236
|
+
**PaginationResponseTaskRead**
|
|
237
|
+
|
|
238
|
+
### Authorization
|
|
239
|
+
|
|
240
|
+
No authorization required
|
|
241
|
+
|
|
242
|
+
### HTTP request headers
|
|
243
|
+
|
|
244
|
+
- **Content-Type**: Not defined
|
|
245
|
+
- **Accept**: application/json
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
### HTTP response details
|
|
249
|
+
| Status code | Description | Response headers |
|
|
250
|
+
|-------------|-------------|------------------|
|
|
251
|
+
|**200** | Successful Response | - |
|
|
252
|
+
|**422** | Validation Error | - |
|
|
253
|
+
|
|
254
|
+
[[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)
|
|
255
|
+
|
|
256
|
+
# **requestTaskSchedulingV1TasksSchedulePost**
|
|
257
|
+
> Details requestTaskSchedulingV1TasksSchedulePost(schedulerRequest)
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
### Example
|
|
261
|
+
|
|
262
|
+
```typescript
|
|
263
|
+
import {
|
|
264
|
+
TasksApi,
|
|
265
|
+
Configuration,
|
|
266
|
+
SchedulerRequest
|
|
267
|
+
} from './api';
|
|
268
|
+
|
|
269
|
+
const configuration = new Configuration();
|
|
270
|
+
const apiInstance = new TasksApi(configuration);
|
|
271
|
+
|
|
272
|
+
let schedulerRequest: SchedulerRequest; //
|
|
273
|
+
let authorization: string; // (optional) (default to undefined)
|
|
274
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
275
|
+
|
|
276
|
+
const { status, data } = await apiInstance.requestTaskSchedulingV1TasksSchedulePost(
|
|
277
|
+
schedulerRequest,
|
|
278
|
+
authorization,
|
|
279
|
+
sessionId
|
|
280
|
+
);
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
### Parameters
|
|
284
|
+
|
|
285
|
+
|Name | Type | Description | Notes|
|
|
286
|
+
|------------- | ------------- | ------------- | -------------|
|
|
287
|
+
| **schedulerRequest** | **SchedulerRequest**| | |
|
|
288
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
289
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
### Return type
|
|
293
|
+
|
|
294
|
+
**Details**
|
|
295
|
+
|
|
296
|
+
### Authorization
|
|
297
|
+
|
|
298
|
+
No authorization required
|
|
299
|
+
|
|
300
|
+
### HTTP request headers
|
|
301
|
+
|
|
302
|
+
- **Content-Type**: application/json
|
|
303
|
+
- **Accept**: application/json
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
### HTTP response details
|
|
307
|
+
| Status code | Description | Response headers |
|
|
308
|
+
|-------------|-------------|------------------|
|
|
309
|
+
|**202** | Successful Response | - |
|
|
310
|
+
|**422** | Validation Error | - |
|
|
311
|
+
|
|
312
|
+
[[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)
|
|
313
|
+
|
|
314
|
+
# **updateTaskV1TasksPut**
|
|
315
|
+
> TaskRead updateTaskV1TasksPut(updateTaskSchema)
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
### Example
|
|
319
|
+
|
|
320
|
+
```typescript
|
|
321
|
+
import {
|
|
322
|
+
TasksApi,
|
|
323
|
+
Configuration,
|
|
324
|
+
UpdateTaskSchema
|
|
325
|
+
} from './api';
|
|
326
|
+
|
|
327
|
+
const configuration = new Configuration();
|
|
328
|
+
const apiInstance = new TasksApi(configuration);
|
|
329
|
+
|
|
330
|
+
let updateTaskSchema: UpdateTaskSchema; //
|
|
331
|
+
let authorization: string; // (optional) (default to undefined)
|
|
332
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
333
|
+
|
|
334
|
+
const { status, data } = await apiInstance.updateTaskV1TasksPut(
|
|
335
|
+
updateTaskSchema,
|
|
336
|
+
authorization,
|
|
337
|
+
sessionId
|
|
338
|
+
);
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### Parameters
|
|
342
|
+
|
|
343
|
+
|Name | Type | Description | Notes|
|
|
344
|
+
|------------- | ------------- | ------------- | -------------|
|
|
345
|
+
| **updateTaskSchema** | **UpdateTaskSchema**| | |
|
|
346
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
347
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
### Return type
|
|
351
|
+
|
|
352
|
+
**TaskRead**
|
|
353
|
+
|
|
354
|
+
### Authorization
|
|
355
|
+
|
|
356
|
+
No authorization required
|
|
357
|
+
|
|
358
|
+
### HTTP request headers
|
|
359
|
+
|
|
360
|
+
- **Content-Type**: application/json
|
|
361
|
+
- **Accept**: application/json
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
### HTTP response details
|
|
365
|
+
| Status code | Description | Response headers |
|
|
366
|
+
|-------------|-------------|------------------|
|
|
367
|
+
|**200** | Successful Response | - |
|
|
368
|
+
|**422** | Validation Error | - |
|
|
369
|
+
|
|
370
|
+
[[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)
|
|
371
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# UpdateTaskSchema
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**title** | **string** | | [default to undefined]
|
|
10
|
+
**description** | **string** | | [default to undefined]
|
|
11
|
+
**due_date** | **string** | | [default to undefined]
|
|
12
|
+
**assigned_to_id** | **string** | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { UpdateTaskSchema } from './api';
|
|
18
|
+
|
|
19
|
+
const instance: UpdateTaskSchema = {
|
|
20
|
+
id,
|
|
21
|
+
title,
|
|
22
|
+
description,
|
|
23
|
+
due_date,
|
|
24
|
+
assigned_to_id,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[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/package.json
CHANGED
package/sdk.ts
CHANGED
|
@@ -9,6 +9,8 @@ import {
|
|
|
9
9
|
PaymentsApi,
|
|
10
10
|
PoliciesApi,
|
|
11
11
|
RolesApi,
|
|
12
|
+
ReportsApi,
|
|
13
|
+
TasksApi,
|
|
12
14
|
UserApi
|
|
13
15
|
} from './api';
|
|
14
16
|
import { Configuration } from './configuration';
|
|
@@ -17,8 +19,10 @@ export class ApiSDK {
|
|
|
17
19
|
private helthApi: HealthApi;
|
|
18
20
|
private authApi: AuthApi;
|
|
19
21
|
private companyApi: CompanyApi;
|
|
22
|
+
private tasksApi: TasksApi;
|
|
20
23
|
private controlsApi: ControlsApi;
|
|
21
24
|
private auditLogsApi: AuditLogsApi;
|
|
25
|
+
private reportsApi: ReportsApi;
|
|
22
26
|
private evidenceApi: EvidenceApi;
|
|
23
27
|
private paymentsApi: PaymentsApi;
|
|
24
28
|
private policiesApi: PoliciesApi;
|
|
@@ -44,11 +48,13 @@ export class ApiSDK {
|
|
|
44
48
|
this.helthApi = new HealthApi(config, undefined, this.axiosInstance);
|
|
45
49
|
this.authApi = new AuthApi(config, undefined, this.axiosInstance);
|
|
46
50
|
this.companyApi = new CompanyApi(config, undefined, this.axiosInstance);
|
|
51
|
+
this.tasksApi = new TasksApi(config, undefined, this.axiosInstance);
|
|
47
52
|
this.controlsApi = new ControlsApi(config, undefined, this.axiosInstance);
|
|
48
53
|
this.auditLogsApi = new AuditLogsApi(config, undefined, this.axiosInstance);
|
|
49
54
|
this.evidenceApi = new EvidenceApi(config, undefined, this.axiosInstance);
|
|
50
55
|
this.paymentsApi = new PaymentsApi(config, undefined, this.axiosInstance);
|
|
51
56
|
this.policiesApi = new PoliciesApi(config, undefined, this.axiosInstance);
|
|
57
|
+
this.reportsApi = new ReportsApi(config, undefined, this.axiosInstance);
|
|
52
58
|
this.rolesApi = new RolesApi(config, undefined, this.axiosInstance);
|
|
53
59
|
this.userApi = new UserApi(config, undefined, this.axiosInstance);
|
|
54
60
|
}
|
|
@@ -90,11 +96,13 @@ export class ApiSDK {
|
|
|
90
96
|
helthApi: this.helthApi,
|
|
91
97
|
authApi: this.authApi,
|
|
92
98
|
companyApi: this.companyApi,
|
|
99
|
+
tasksApi: this.tasksApi,
|
|
93
100
|
controlsApi: this.controlsApi,
|
|
94
101
|
auditLogsApi: this.auditLogsApi,
|
|
95
102
|
evidenceApi: this.evidenceApi,
|
|
96
103
|
paymentsApi: this.paymentsApi,
|
|
97
104
|
policiesApi: this.policiesApi,
|
|
105
|
+
reportsApi: this.reportsApi,
|
|
98
106
|
rolesApi: this.rolesApi,
|
|
99
107
|
userApi: this.userApi,
|
|
100
108
|
};
|