@rasadov/lumoar-sdk 1.1.9 → 1.1.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 +4 -1
- package/api.ts +332 -16
- package/dist/api.d.ts +252 -17
- package/dist/api.js +156 -0
- package/docs/ControlWithData.md +28 -0
- package/docs/CustomerDBBase.md +22 -0
- package/docs/EvidenceApi.md +58 -0
- package/docs/EvidenceWithControl.md +42 -0
- package/docs/PaymentsApi.md +2 -2
- package/docs/ResponseGetSubscriptionV1PaymentsSubscriptionGet.md +30 -0
- package/docs/SubscriptionResponse.md +1 -1
- package/docs/TasksApi.md +58 -0
- package/package.json +1 -1
package/docs/EvidenceApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *http://localhost*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**deleteEvidenceV1EvidenceDeleteDelete**](#deleteevidencev1evidencedeletedelete) | **DELETE** /v1/evidence/delete | Delete Evidence|
|
|
8
8
|
|[**getEvidenceFilesV1EvidenceFileEvidenceFileIdGet**](#getevidencefilesv1evidencefileevidencefileidget) | **GET** /v1/evidence/file/{evidence_file_id} | Get Evidence Files|
|
|
9
|
+
|[**getEvidenceV1EvidenceGetGet**](#getevidencev1evidencegetget) | **GET** /v1/evidence/get | Get Evidence|
|
|
9
10
|
|[**listCompanyEvidenceV1EvidenceCompanyCompanyIdGet**](#listcompanyevidencev1evidencecompanycompanyidget) | **GET** /v1/evidence/company/{company_id} | List Company Evidence|
|
|
10
11
|
|[**updateEvidenceV1EvidenceUpdatePut**](#updateevidencev1evidenceupdateput) | **PUT** /v1/evidence/update | Update Evidence|
|
|
11
12
|
|[**uploadEvidenceV1EvidenceUploadPost**](#uploadevidencev1evidenceuploadpost) | **POST** /v1/evidence/upload | Upload Evidence|
|
|
@@ -116,6 +117,63 @@ No authorization required
|
|
|
116
117
|
- **Accept**: application/json
|
|
117
118
|
|
|
118
119
|
|
|
120
|
+
### HTTP response details
|
|
121
|
+
| Status code | Description | Response headers |
|
|
122
|
+
|-------------|-------------|------------------|
|
|
123
|
+
|**200** | Successful Response | - |
|
|
124
|
+
|**422** | Validation Error | - |
|
|
125
|
+
|
|
126
|
+
[[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)
|
|
127
|
+
|
|
128
|
+
# **getEvidenceV1EvidenceGetGet**
|
|
129
|
+
> EvidenceWithControl getEvidenceV1EvidenceGetGet()
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
### Example
|
|
133
|
+
|
|
134
|
+
```typescript
|
|
135
|
+
import {
|
|
136
|
+
EvidenceApi,
|
|
137
|
+
Configuration
|
|
138
|
+
} from './api';
|
|
139
|
+
|
|
140
|
+
const configuration = new Configuration();
|
|
141
|
+
const apiInstance = new EvidenceApi(configuration);
|
|
142
|
+
|
|
143
|
+
let evidenceId: string; // (default to undefined)
|
|
144
|
+
let authorization: string; // (optional) (default to undefined)
|
|
145
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
146
|
+
|
|
147
|
+
const { status, data } = await apiInstance.getEvidenceV1EvidenceGetGet(
|
|
148
|
+
evidenceId,
|
|
149
|
+
authorization,
|
|
150
|
+
sessionId
|
|
151
|
+
);
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### Parameters
|
|
155
|
+
|
|
156
|
+
|Name | Type | Description | Notes|
|
|
157
|
+
|------------- | ------------- | ------------- | -------------|
|
|
158
|
+
| **evidenceId** | [**string**] | | defaults to undefined|
|
|
159
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
160
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
### Return type
|
|
164
|
+
|
|
165
|
+
**EvidenceWithControl**
|
|
166
|
+
|
|
167
|
+
### Authorization
|
|
168
|
+
|
|
169
|
+
No authorization required
|
|
170
|
+
|
|
171
|
+
### HTTP request headers
|
|
172
|
+
|
|
173
|
+
- **Content-Type**: Not defined
|
|
174
|
+
- **Accept**: application/json
|
|
175
|
+
|
|
176
|
+
|
|
119
177
|
### HTTP response details
|
|
120
178
|
| Status code | Description | Response headers |
|
|
121
179
|
|-------------|-------------|------------------|
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# EvidenceWithControl
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**control_id** | **string** | | [default to undefined]
|
|
10
|
+
**expires_at** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**status** | **string** | | [default to undefined]
|
|
12
|
+
**version** | **number** | | [default to undefined]
|
|
13
|
+
**evidence_type** | **string** | | [default to undefined]
|
|
14
|
+
**text** | [**EvidenceTextSchema**](EvidenceTextSchema.md) | | [optional] [default to undefined]
|
|
15
|
+
**files** | [**Array<EvidenceFileSchema>**](EvidenceFileSchema.md) | | [optional] [default to undefined]
|
|
16
|
+
**tags** | **Array<string>** | | [optional] [default to undefined]
|
|
17
|
+
**uploaded_by** | [**UserBase**](UserBase.md) | | [optional] [default to undefined]
|
|
18
|
+
**submitted_at** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**control** | [**ControlWithData**](ControlWithData.md) | | [default to undefined]
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import { EvidenceWithControl } from './api';
|
|
25
|
+
|
|
26
|
+
const instance: EvidenceWithControl = {
|
|
27
|
+
id,
|
|
28
|
+
control_id,
|
|
29
|
+
expires_at,
|
|
30
|
+
status,
|
|
31
|
+
version,
|
|
32
|
+
evidence_type,
|
|
33
|
+
text,
|
|
34
|
+
files,
|
|
35
|
+
tags,
|
|
36
|
+
uploaded_by,
|
|
37
|
+
submitted_at,
|
|
38
|
+
control,
|
|
39
|
+
};
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[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/PaymentsApi.md
CHANGED
|
@@ -124,7 +124,7 @@ No authorization required
|
|
|
124
124
|
[[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)
|
|
125
125
|
|
|
126
126
|
# **getSubscriptionV1PaymentsSubscriptionGet**
|
|
127
|
-
>
|
|
127
|
+
> ResponseGetSubscriptionV1PaymentsSubscriptionGet getSubscriptionV1PaymentsSubscriptionGet()
|
|
128
128
|
|
|
129
129
|
|
|
130
130
|
### Example
|
|
@@ -160,7 +160,7 @@ const { status, data } = await apiInstance.getSubscriptionV1PaymentsSubscription
|
|
|
160
160
|
|
|
161
161
|
### Return type
|
|
162
162
|
|
|
163
|
-
**
|
|
163
|
+
**ResponseGetSubscriptionV1PaymentsSubscriptionGet**
|
|
164
164
|
|
|
165
165
|
### Authorization
|
|
166
166
|
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# ResponseGetSubscriptionV1PaymentsSubscriptionGet
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**subscription_id** | **string** | | [default to undefined]
|
|
9
|
+
**status** | **string** | | [default to undefined]
|
|
10
|
+
**product_id** | **string** | | [default to undefined]
|
|
11
|
+
**customer** | [**CustomerDBBase**](CustomerDBBase.md) | | [default to undefined]
|
|
12
|
+
**subscribed_till** | **string** | | [default to undefined]
|
|
13
|
+
**details** | **string** | | [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { ResponseGetSubscriptionV1PaymentsSubscriptionGet } from './api';
|
|
19
|
+
|
|
20
|
+
const instance: ResponseGetSubscriptionV1PaymentsSubscriptionGet = {
|
|
21
|
+
subscription_id,
|
|
22
|
+
status,
|
|
23
|
+
product_id,
|
|
24
|
+
customer,
|
|
25
|
+
subscribed_till,
|
|
26
|
+
details,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**subscription_id** | **string** | | [default to undefined]
|
|
9
9
|
**status** | **string** | | [default to undefined]
|
|
10
10
|
**product_id** | **string** | | [default to undefined]
|
|
11
|
-
**customer** | [**
|
|
11
|
+
**customer** | [**CustomerDBBase**](CustomerDBBase.md) | | [default to undefined]
|
|
12
12
|
**subscribed_till** | **string** | | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
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
|
+
|[**getTaskV1TasksGetTaskIdGet**](#gettaskv1tasksgettaskidget) | **GET** /v1/tasks/get/{task_id} | Get Task|
|
|
9
10
|
|[**listTasksForCompanyV1TasksCompanyGet**](#listtasksforcompanyv1taskscompanyget) | **GET** /v1/tasks/company | List Tasks For Company|
|
|
10
11
|
|[**listTasksForUserV1TasksUserGet**](#listtasksforuserv1tasksuserget) | **GET** /v1/tasks/user | List Tasks For User|
|
|
11
12
|
|[**requestTaskSchedulingV1TasksSchedulePost**](#requesttaskschedulingv1tasksschedulepost) | **POST** /v1/tasks/schedule | Request Task Scheduling|
|
|
@@ -120,6 +121,63 @@ No authorization required
|
|
|
120
121
|
- **Accept**: application/json
|
|
121
122
|
|
|
122
123
|
|
|
124
|
+
### HTTP response details
|
|
125
|
+
| Status code | Description | Response headers |
|
|
126
|
+
|-------------|-------------|------------------|
|
|
127
|
+
|**200** | 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
|
+
# **getTaskV1TasksGetTaskIdGet**
|
|
133
|
+
> TaskWithUser getTaskV1TasksGetTaskIdGet()
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
### Example
|
|
137
|
+
|
|
138
|
+
```typescript
|
|
139
|
+
import {
|
|
140
|
+
TasksApi,
|
|
141
|
+
Configuration
|
|
142
|
+
} from './api';
|
|
143
|
+
|
|
144
|
+
const configuration = new Configuration();
|
|
145
|
+
const apiInstance = new TasksApi(configuration);
|
|
146
|
+
|
|
147
|
+
let taskId: string; // (default to undefined)
|
|
148
|
+
let authorization: string; // (optional) (default to undefined)
|
|
149
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
150
|
+
|
|
151
|
+
const { status, data } = await apiInstance.getTaskV1TasksGetTaskIdGet(
|
|
152
|
+
taskId,
|
|
153
|
+
authorization,
|
|
154
|
+
sessionId
|
|
155
|
+
);
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Parameters
|
|
159
|
+
|
|
160
|
+
|Name | Type | Description | Notes|
|
|
161
|
+
|------------- | ------------- | ------------- | -------------|
|
|
162
|
+
| **taskId** | [**string**] | | defaults to undefined|
|
|
163
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
164
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
### Return type
|
|
168
|
+
|
|
169
|
+
**TaskWithUser**
|
|
170
|
+
|
|
171
|
+
### Authorization
|
|
172
|
+
|
|
173
|
+
No authorization required
|
|
174
|
+
|
|
175
|
+
### HTTP request headers
|
|
176
|
+
|
|
177
|
+
- **Content-Type**: Not defined
|
|
178
|
+
- **Accept**: application/json
|
|
179
|
+
|
|
180
|
+
|
|
123
181
|
### HTTP response details
|
|
124
182
|
| Status code | Description | Response headers |
|
|
125
183
|
|-------------|-------------|------------------|
|