@rasadov/lumoar-sdk 1.0.8 → 1.0.9

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/dist/index.d.ts CHANGED
@@ -11,4 +11,3 @@
11
11
  */
12
12
  export * from "./api";
13
13
  export * from "./configuration";
14
- export * from "./sdk";
package/dist/index.js CHANGED
@@ -13,4 +13,3 @@
13
13
  */
14
14
  export * from "./api";
15
15
  export * from "./configuration";
16
- export * from "./sdk";
package/dist/sdk.d.ts CHANGED
@@ -1,10 +1,12 @@
1
- import { HealthApi, AuthApi, CompanyApi, ControlsApi, AuditLogsApi, EvidenceApi, PaymentsApi, PoliciesApi, RolesApi, UserApi } from './api';
1
+ import { HealthApi, AuthApi, CompanyApi, ControlsApi, AuditLogsApi, EvidenceApi, PaymentsApi, PoliciesApi, RolesApi, ReportsApi, TasksApi, UserApi } from './api';
2
2
  export declare class ApiSDK {
3
3
  private helthApi;
4
4
  private authApi;
5
5
  private companyApi;
6
+ private tasksApi;
6
7
  private controlsApi;
7
8
  private auditLogsApi;
9
+ private reportsApi;
8
10
  private evidenceApi;
9
11
  private paymentsApi;
10
12
  private policiesApi;
@@ -20,11 +22,13 @@ export declare class ApiSDK {
20
22
  helthApi: HealthApi;
21
23
  authApi: AuthApi;
22
24
  companyApi: CompanyApi;
25
+ tasksApi: TasksApi;
23
26
  controlsApi: ControlsApi;
24
27
  auditLogsApi: AuditLogsApi;
25
28
  evidenceApi: EvidenceApi;
26
29
  paymentsApi: PaymentsApi;
27
30
  policiesApi: PoliciesApi;
31
+ reportsApi: ReportsApi;
28
32
  rolesApi: RolesApi;
29
33
  userApi: UserApi;
30
34
  };
package/dist/sdk.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import axios from 'axios';
2
- import { HealthApi, AuthApi, CompanyApi, ControlsApi, AuditLogsApi, EvidenceApi, PaymentsApi, PoliciesApi, RolesApi, UserApi } from './api';
2
+ import { HealthApi, AuthApi, CompanyApi, ControlsApi, AuditLogsApi, EvidenceApi, PaymentsApi, PoliciesApi, RolesApi, ReportsApi, TasksApi, UserApi } from './api';
3
3
  import { Configuration } from './configuration';
4
4
  export class ApiSDK {
5
5
  constructor(basePath) {
@@ -19,11 +19,13 @@ export class ApiSDK {
19
19
  this.helthApi = new HealthApi(config, undefined, this.axiosInstance);
20
20
  this.authApi = new AuthApi(config, undefined, this.axiosInstance);
21
21
  this.companyApi = new CompanyApi(config, undefined, this.axiosInstance);
22
+ this.tasksApi = new TasksApi(config, undefined, this.axiosInstance);
22
23
  this.controlsApi = new ControlsApi(config, undefined, this.axiosInstance);
23
24
  this.auditLogsApi = new AuditLogsApi(config, undefined, this.axiosInstance);
24
25
  this.evidenceApi = new EvidenceApi(config, undefined, this.axiosInstance);
25
26
  this.paymentsApi = new PaymentsApi(config, undefined, this.axiosInstance);
26
27
  this.policiesApi = new PoliciesApi(config, undefined, this.axiosInstance);
28
+ this.reportsApi = new ReportsApi(config, undefined, this.axiosInstance);
27
29
  this.rolesApi = new RolesApi(config, undefined, this.axiosInstance);
28
30
  this.userApi = new UserApi(config, undefined, this.axiosInstance);
29
31
  }
@@ -63,11 +65,13 @@ export class ApiSDK {
63
65
  helthApi: this.helthApi,
64
66
  authApi: this.authApi,
65
67
  companyApi: this.companyApi,
68
+ tasksApi: this.tasksApi,
66
69
  controlsApi: this.controlsApi,
67
70
  auditLogsApi: this.auditLogsApi,
68
71
  evidenceApi: this.evidenceApi,
69
72
  paymentsApi: this.paymentsApi,
70
73
  policiesApi: this.policiesApi,
74
+ reportsApi: this.reportsApi,
71
75
  rolesApi: this.rolesApi,
72
76
  userApi: this.userApi,
73
77
  };
@@ -0,0 +1,28 @@
1
+ # CreateTaskSchema
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **company_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 { CreateTaskSchema } from './api';
18
+
19
+ const instance: CreateTaskSchema = {
20
+ company_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)
@@ -0,0 +1,20 @@
1
+ # DeleteTaskSchema
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { DeleteTaskSchema } from './api';
14
+
15
+ const instance: DeleteTaskSchema = {
16
+ id,
17
+ };
18
+ ```
19
+
20
+ [[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,8 @@
1
+ # DeliveryMethod
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Email` (value: `'email'`)
7
+
8
+ [[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,22 @@
1
+ # PaginationResponseReportBase
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **items** | [**Array<ReportBase>**](ReportBase.md) | | [default to undefined]
9
+ **total** | **number** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { PaginationResponseReportBase } from './api';
15
+
16
+ const instance: PaginationResponseReportBase = {
17
+ items,
18
+ total,
19
+ };
20
+ ```
21
+
22
+ [[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,22 @@
1
+ # PaginationResponseTaskRead
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **items** | [**Array<TaskRead>**](TaskRead.md) | | [default to undefined]
9
+ **total** | **number** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { PaginationResponseTaskRead } from './api';
15
+
16
+ const instance: PaginationResponseTaskRead = {
17
+ items,
18
+ total,
19
+ };
20
+ ```
21
+
22
+ [[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,12 @@
1
+ # ReminderFrequency
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Daily` (value: `'daily'`)
7
+
8
+ * `Weekly` (value: `'weekly'`)
9
+
10
+ * `Custom` (value: `'custom'`)
11
+
12
+ [[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,32 @@
1
+ # ReportBase
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **company_id** | **string** | | [default to undefined]
10
+ **title** | **string** | | [default to undefined]
11
+ **share_expiration** | **string** | | [optional] [default to undefined]
12
+ **status** | **string** | | [default to undefined]
13
+ **created_at** | **string** | | [default to undefined]
14
+ **updated_at** | **string** | | [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { ReportBase } from './api';
20
+
21
+ const instance: ReportBase = {
22
+ id,
23
+ company_id,
24
+ title,
25
+ share_expiration,
26
+ status,
27
+ created_at,
28
+ updated_at,
29
+ };
30
+ ```
31
+
32
+ [[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,20 @@
1
+ # ReportGenerate
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **report_id** | **string** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ReportGenerate } from './api';
14
+
15
+ const instance: ReportGenerate = {
16
+ report_id,
17
+ };
18
+ ```
19
+
20
+ [[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,254 @@
1
+ # ReportsApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**exportReportV1ReportsExportReportIdGet**](#exportreportv1reportsexportreportidget) | **GET** /v1/reports/export/{report_id} | Export Report|
8
+ |[**generateReportV1ReportsGeneratePost**](#generatereportv1reportsgeneratepost) | **POST** /v1/reports/generate | Generate Report|
9
+ |[**getEvidenceV1ReportsEvidenceReportIdEvidenceIdGet**](#getevidencev1reportsevidencereportidevidenceidget) | **GET** /v1/reports/evidence/{report_id}/{evidence_id} | Get Evidence|
10
+ |[**listReportsV1ReportsListCompanyIdGet**](#listreportsv1reportslistcompanyidget) | **GET** /v1/reports/list/{company_id} | List Reports|
11
+
12
+ # **exportReportV1ReportsExportReportIdGet**
13
+ > FileDownload exportReportV1ReportsExportReportIdGet()
14
+
15
+
16
+ ### Example
17
+
18
+ ```typescript
19
+ import {
20
+ ReportsApi,
21
+ Configuration
22
+ } from './api';
23
+
24
+ const configuration = new Configuration();
25
+ const apiInstance = new ReportsApi(configuration);
26
+
27
+ let reportId: string; // (default to undefined)
28
+ let authorization: string; // (optional) (default to undefined)
29
+ let sessionId: string; // (optional) (default to undefined)
30
+
31
+ const { status, data } = await apiInstance.exportReportV1ReportsExportReportIdGet(
32
+ reportId,
33
+ authorization,
34
+ sessionId
35
+ );
36
+ ```
37
+
38
+ ### Parameters
39
+
40
+ |Name | Type | Description | Notes|
41
+ |------------- | ------------- | ------------- | -------------|
42
+ | **reportId** | [**string**] | | defaults to undefined|
43
+ | **authorization** | [**string**] | | (optional) defaults to undefined|
44
+ | **sessionId** | [**string**] | | (optional) defaults to undefined|
45
+
46
+
47
+ ### Return type
48
+
49
+ **FileDownload**
50
+
51
+ ### Authorization
52
+
53
+ No authorization required
54
+
55
+ ### HTTP request headers
56
+
57
+ - **Content-Type**: Not defined
58
+ - **Accept**: application/json
59
+
60
+
61
+ ### HTTP response details
62
+ | Status code | Description | Response headers |
63
+ |-------------|-------------|------------------|
64
+ |**200** | Successful Response | - |
65
+ |**422** | Validation Error | - |
66
+
67
+ [[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)
68
+
69
+ # **generateReportV1ReportsGeneratePost**
70
+ > ReportGenerate generateReportV1ReportsGeneratePost(requestBody)
71
+
72
+
73
+ ### Example
74
+
75
+ ```typescript
76
+ import {
77
+ ReportsApi,
78
+ Configuration
79
+ } from './api';
80
+
81
+ const configuration = new Configuration();
82
+ const apiInstance = new ReportsApi(configuration);
83
+
84
+ let companyId: string; // (default to undefined)
85
+ let reportType: string; // (default to undefined)
86
+ let requestBody: { [key: string]: any; }; //
87
+ let authorization: string; // (optional) (default to undefined)
88
+ let sessionId: string; // (optional) (default to undefined)
89
+
90
+ const { status, data } = await apiInstance.generateReportV1ReportsGeneratePost(
91
+ companyId,
92
+ reportType,
93
+ requestBody,
94
+ authorization,
95
+ sessionId
96
+ );
97
+ ```
98
+
99
+ ### Parameters
100
+
101
+ |Name | Type | Description | Notes|
102
+ |------------- | ------------- | ------------- | -------------|
103
+ | **requestBody** | **{ [key: string]: any; }**| | |
104
+ | **companyId** | [**string**] | | defaults to undefined|
105
+ | **reportType** | [**string**] | | defaults to undefined|
106
+ | **authorization** | [**string**] | | (optional) defaults to undefined|
107
+ | **sessionId** | [**string**] | | (optional) defaults to undefined|
108
+
109
+
110
+ ### Return type
111
+
112
+ **ReportGenerate**
113
+
114
+ ### Authorization
115
+
116
+ No authorization required
117
+
118
+ ### HTTP request headers
119
+
120
+ - **Content-Type**: application/json
121
+ - **Accept**: application/json
122
+
123
+
124
+ ### HTTP response details
125
+ | Status code | Description | Response headers |
126
+ |-------------|-------------|------------------|
127
+ |**202** | Successful Response | - |
128
+ |**422** | Validation Error | - |
129
+
130
+ [[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)
131
+
132
+ # **getEvidenceV1ReportsEvidenceReportIdEvidenceIdGet**
133
+ > Array<FileDownload> getEvidenceV1ReportsEvidenceReportIdEvidenceIdGet()
134
+
135
+
136
+ ### Example
137
+
138
+ ```typescript
139
+ import {
140
+ ReportsApi,
141
+ Configuration
142
+ } from './api';
143
+
144
+ const configuration = new Configuration();
145
+ const apiInstance = new ReportsApi(configuration);
146
+
147
+ let reportId: string; // (default to undefined)
148
+ let evidenceId: string; // (default to undefined)
149
+ let authorization: string; // (optional) (default to undefined)
150
+ let sessionId: string; // (optional) (default to undefined)
151
+
152
+ const { status, data } = await apiInstance.getEvidenceV1ReportsEvidenceReportIdEvidenceIdGet(
153
+ reportId,
154
+ evidenceId,
155
+ authorization,
156
+ sessionId
157
+ );
158
+ ```
159
+
160
+ ### Parameters
161
+
162
+ |Name | Type | Description | Notes|
163
+ |------------- | ------------- | ------------- | -------------|
164
+ | **reportId** | [**string**] | | defaults to undefined|
165
+ | **evidenceId** | [**string**] | | defaults to undefined|
166
+ | **authorization** | [**string**] | | (optional) defaults to undefined|
167
+ | **sessionId** | [**string**] | | (optional) defaults to undefined|
168
+
169
+
170
+ ### Return type
171
+
172
+ **Array<FileDownload>**
173
+
174
+ ### Authorization
175
+
176
+ No authorization required
177
+
178
+ ### HTTP request headers
179
+
180
+ - **Content-Type**: Not defined
181
+ - **Accept**: application/json
182
+
183
+
184
+ ### HTTP response details
185
+ | Status code | Description | Response headers |
186
+ |-------------|-------------|------------------|
187
+ |**200** | Successful Response | - |
188
+ |**422** | Validation Error | - |
189
+
190
+ [[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)
191
+
192
+ # **listReportsV1ReportsListCompanyIdGet**
193
+ > PaginationResponseReportBase listReportsV1ReportsListCompanyIdGet()
194
+
195
+
196
+ ### Example
197
+
198
+ ```typescript
199
+ import {
200
+ ReportsApi,
201
+ Configuration
202
+ } from './api';
203
+
204
+ const configuration = new Configuration();
205
+ const apiInstance = new ReportsApi(configuration);
206
+
207
+ let companyId: string; // (default to undefined)
208
+ let page: number; // (optional) (default to 1)
209
+ let elements: number; // (optional) (default to 10)
210
+ let authorization: string; // (optional) (default to undefined)
211
+ let sessionId: string; // (optional) (default to undefined)
212
+
213
+ const { status, data } = await apiInstance.listReportsV1ReportsListCompanyIdGet(
214
+ companyId,
215
+ page,
216
+ elements,
217
+ authorization,
218
+ sessionId
219
+ );
220
+ ```
221
+
222
+ ### Parameters
223
+
224
+ |Name | Type | Description | Notes|
225
+ |------------- | ------------- | ------------- | -------------|
226
+ | **companyId** | [**string**] | | defaults to undefined|
227
+ | **page** | [**number**] | | (optional) defaults to 1|
228
+ | **elements** | [**number**] | | (optional) defaults to 10|
229
+ | **authorization** | [**string**] | | (optional) defaults to undefined|
230
+ | **sessionId** | [**string**] | | (optional) defaults to undefined|
231
+
232
+
233
+ ### Return type
234
+
235
+ **PaginationResponseReportBase**
236
+
237
+ ### Authorization
238
+
239
+ No authorization required
240
+
241
+ ### HTTP request headers
242
+
243
+ - **Content-Type**: Not defined
244
+ - **Accept**: application/json
245
+
246
+
247
+ ### HTTP response details
248
+ | Status code | Description | Response headers |
249
+ |-------------|-------------|------------------|
250
+ |**200** | Successful Response | - |
251
+ |**422** | Validation Error | - |
252
+
253
+ [[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)
254
+
@@ -0,0 +1,32 @@
1
+ # SchedulerRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **company_id** | **string** | | [default to undefined]
9
+ **control_ids** | **Array&lt;string&gt;** | | [default to undefined]
10
+ **user_ids** | **Array&lt;string&gt;** | | [default to undefined]
11
+ **expected_finish_days** | **number** | | [default to undefined]
12
+ **frequency** | [**ReminderFrequency**](ReminderFrequency.md) | | [optional] [default to undefined]
13
+ **delivery_method** | [**DeliveryMethod**](DeliveryMethod.md) | | [optional] [default to undefined]
14
+ **reminder_offset_days** | **number** | | [optional] [default to 1]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { SchedulerRequest } from './api';
20
+
21
+ const instance: SchedulerRequest = {
22
+ company_id,
23
+ control_ids,
24
+ user_ids,
25
+ expected_finish_days,
26
+ frequency,
27
+ delivery_method,
28
+ reminder_offset_days,
29
+ };
30
+ ```
31
+
32
+ [[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,38 @@
1
+ # TaskRead
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **company_id** | **string** | | [default to undefined]
10
+ **title** | **string** | | [default to undefined]
11
+ **description** | **string** | | [default to undefined]
12
+ **due_date** | **string** | | [default to undefined]
13
+ **assigned_to_id** | **string** | | [default to undefined]
14
+ **created_at** | **string** | | [default to undefined]
15
+ **updated_at** | **string** | | [default to undefined]
16
+ **priority** | **number** | | [default to undefined]
17
+ **status** | **string** | | [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { TaskRead } from './api';
23
+
24
+ const instance: TaskRead = {
25
+ id,
26
+ company_id,
27
+ title,
28
+ description,
29
+ due_date,
30
+ assigned_to_id,
31
+ created_at,
32
+ updated_at,
33
+ priority,
34
+ status,
35
+ };
36
+ ```
37
+
38
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)