@rasadov/lumoar-sdk 1.0.1

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.
Files changed (73) hide show
  1. package/.openapi-generator/FILES +60 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/api.ts +5133 -0
  5. package/base.ts +86 -0
  6. package/common.ts +150 -0
  7. package/configuration.ts +228 -0
  8. package/dist/api.d.ts +3329 -0
  9. package/dist/api.js +3498 -0
  10. package/dist/base.d.ts +66 -0
  11. package/dist/base.js +60 -0
  12. package/dist/common.d.ts +65 -0
  13. package/dist/common.js +149 -0
  14. package/dist/configuration.d.ts +125 -0
  15. package/dist/configuration.js +124 -0
  16. package/dist/index.d.ts +13 -0
  17. package/dist/index.js +15 -0
  18. package/docs/AuthApi.md +560 -0
  19. package/docs/AuthenticationSuccess.md +25 -0
  20. package/docs/CheckoutSessionResponse.md +22 -0
  21. package/docs/CompanyApi.md +363 -0
  22. package/docs/CompanyCreate.md +44 -0
  23. package/docs/CompanyInDBBase.md +48 -0
  24. package/docs/CompanyUpdate.md +42 -0
  25. package/docs/CompanyWithControls.md +50 -0
  26. package/docs/CompanyWithRoles.md +50 -0
  27. package/docs/ComplianceGoal.md +8 -0
  28. package/docs/ControlStatus.md +18 -0
  29. package/docs/ControlWithEvidences.md +30 -0
  30. package/docs/ControlWithRelationships.md +32 -0
  31. package/docs/ControlsApi.md +124 -0
  32. package/docs/CustomerDoesNotExist.md +20 -0
  33. package/docs/CustomerPortalSession.md +20 -0
  34. package/docs/DefaultApi.md +183 -0
  35. package/docs/Details.md +20 -0
  36. package/docs/EvidenceApi.md +309 -0
  37. package/docs/EvidenceBase.md +40 -0
  38. package/docs/EvidenceFileSchema.md +32 -0
  39. package/docs/EvidenceTextSchema.md +24 -0
  40. package/docs/FileDownload.md +26 -0
  41. package/docs/FrameworkControlsBase.md +26 -0
  42. package/docs/GetControl.md +22 -0
  43. package/docs/HTTPValidationError.md +20 -0
  44. package/docs/InviteToCompany.md +24 -0
  45. package/docs/LoginSchema.md +25 -0
  46. package/docs/PaymentsApi.md +164 -0
  47. package/docs/PermissionType.md +14 -0
  48. package/docs/PoliciesApi.md +302 -0
  49. package/docs/PolicyCreate.md +26 -0
  50. package/docs/PolicyRead.md +32 -0
  51. package/docs/PolicyUpdate.md +24 -0
  52. package/docs/RegisterSchema.md +31 -0
  53. package/docs/RemoveFromCompany.md +22 -0
  54. package/docs/ResponseGetCheckoutSessionPaymentsCheckoutGet.md +24 -0
  55. package/docs/ResponseGetCustomerManagementSessionPaymentsCustomerManagementGet.md +22 -0
  56. package/docs/RolesApi.md +127 -0
  57. package/docs/RolesWithUser.md +22 -0
  58. package/docs/UpdateControlSchema.md +24 -0
  59. package/docs/UpdatePassword.md +22 -0
  60. package/docs/UserApi.md +280 -0
  61. package/docs/UserBase.md +24 -0
  62. package/docs/UserInDBBase.md +30 -0
  63. package/docs/UserPermissionsWithCompany.md +22 -0
  64. package/docs/UserRole.md +20 -0
  65. package/docs/UserUpdate.md +24 -0
  66. package/docs/UserWithRelations.md +28 -0
  67. package/docs/ValidationError.md +24 -0
  68. package/docs/ValidationErrorLocInner.md +18 -0
  69. package/git_push.sh +57 -0
  70. package/index.ts +18 -0
  71. package/openapitools.json +7 -0
  72. package/package.json +33 -0
  73. package/tsconfig.json +14 -0
@@ -0,0 +1,124 @@
1
+ # ControlsApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getControlV1ControlsControlIdGet**](#getcontrolv1controlscontrolidget) | **GET** /v1/controls/{control_id} | Get Control|
8
+ |[**updateControlV1ControlsUpdatePatch**](#updatecontrolv1controlsupdatepatch) | **PATCH** /v1/controls/update | Update Control|
9
+
10
+ # **getControlV1ControlsControlIdGet**
11
+ > GetControl getControlV1ControlsControlIdGet()
12
+
13
+
14
+ ### Example
15
+
16
+ ```typescript
17
+ import {
18
+ ControlsApi,
19
+ Configuration
20
+ } from './api';
21
+
22
+ const configuration = new Configuration();
23
+ const apiInstance = new ControlsApi(configuration);
24
+
25
+ let controlId: string; // (default to undefined)
26
+ let authorization: string; // (optional) (default to undefined)
27
+ let sessionId: string; // (optional) (default to undefined)
28
+
29
+ const { status, data } = await apiInstance.getControlV1ControlsControlIdGet(
30
+ controlId,
31
+ authorization,
32
+ sessionId
33
+ );
34
+ ```
35
+
36
+ ### Parameters
37
+
38
+ |Name | Type | Description | Notes|
39
+ |------------- | ------------- | ------------- | -------------|
40
+ | **controlId** | [**string**] | | defaults to undefined|
41
+ | **authorization** | [**string**] | | (optional) defaults to undefined|
42
+ | **sessionId** | [**string**] | | (optional) defaults to undefined|
43
+
44
+
45
+ ### Return type
46
+
47
+ **GetControl**
48
+
49
+ ### Authorization
50
+
51
+ No authorization required
52
+
53
+ ### HTTP request headers
54
+
55
+ - **Content-Type**: Not defined
56
+ - **Accept**: application/json
57
+
58
+
59
+ ### HTTP response details
60
+ | Status code | Description | Response headers |
61
+ |-------------|-------------|------------------|
62
+ |**200** | Successful Response | - |
63
+ |**422** | Validation Error | - |
64
+
65
+ [[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)
66
+
67
+ # **updateControlV1ControlsUpdatePatch**
68
+ > GetControl updateControlV1ControlsUpdatePatch(updateControlSchema)
69
+
70
+
71
+ ### Example
72
+
73
+ ```typescript
74
+ import {
75
+ ControlsApi,
76
+ Configuration,
77
+ UpdateControlSchema
78
+ } from './api';
79
+
80
+ const configuration = new Configuration();
81
+ const apiInstance = new ControlsApi(configuration);
82
+
83
+ let updateControlSchema: UpdateControlSchema; //
84
+ let authorization: string; // (optional) (default to undefined)
85
+ let sessionId: string; // (optional) (default to undefined)
86
+
87
+ const { status, data } = await apiInstance.updateControlV1ControlsUpdatePatch(
88
+ updateControlSchema,
89
+ authorization,
90
+ sessionId
91
+ );
92
+ ```
93
+
94
+ ### Parameters
95
+
96
+ |Name | Type | Description | Notes|
97
+ |------------- | ------------- | ------------- | -------------|
98
+ | **updateControlSchema** | **UpdateControlSchema**| | |
99
+ | **authorization** | [**string**] | | (optional) defaults to undefined|
100
+ | **sessionId** | [**string**] | | (optional) defaults to undefined|
101
+
102
+
103
+ ### Return type
104
+
105
+ **GetControl**
106
+
107
+ ### Authorization
108
+
109
+ No authorization required
110
+
111
+ ### HTTP request headers
112
+
113
+ - **Content-Type**: application/json
114
+ - **Accept**: application/json
115
+
116
+
117
+ ### HTTP response details
118
+ | Status code | Description | Response headers |
119
+ |-------------|-------------|------------------|
120
+ |**200** | Successful Response | - |
121
+ |**422** | Validation Error | - |
122
+
123
+ [[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)
124
+
@@ -0,0 +1,20 @@
1
+ # CustomerDoesNotExist
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **message** | **string** | | [optional] [default to 'You don\'t have any active subscriptions']
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { CustomerDoesNotExist } from './api';
14
+
15
+ const instance: CustomerDoesNotExist = {
16
+ message,
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,20 @@
1
+ # CustomerPortalSession
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **link** | **string** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { CustomerPortalSession } from './api';
14
+
15
+ const instance: CustomerPortalSession = {
16
+ link,
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,183 @@
1
+ # DefaultApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getDbHealthHealthDbGet**](#getdbhealthhealthdbget) | **GET** /health/db | Get Db Health|
8
+ |[**getHealthHealthGet**](#gethealthhealthget) | **GET** /health | Get Health|
9
+ |[**getListmonkHealthHealthListmonkGet**](#getlistmonkhealthhealthlistmonkget) | **GET** /health/listmonk | Get Listmonk Health|
10
+ |[**getRedisHealthHealthRedisGet**](#getredishealthhealthredisget) | **GET** /health/redis | Get Redis Health|
11
+
12
+ # **getDbHealthHealthDbGet**
13
+ > any getDbHealthHealthDbGet()
14
+
15
+
16
+ ### Example
17
+
18
+ ```typescript
19
+ import {
20
+ DefaultApi,
21
+ Configuration
22
+ } from './api';
23
+
24
+ const configuration = new Configuration();
25
+ const apiInstance = new DefaultApi(configuration);
26
+
27
+ const { status, data } = await apiInstance.getDbHealthHealthDbGet();
28
+ ```
29
+
30
+ ### Parameters
31
+ This endpoint does not have any parameters.
32
+
33
+
34
+ ### Return type
35
+
36
+ **any**
37
+
38
+ ### Authorization
39
+
40
+ No authorization required
41
+
42
+ ### HTTP request headers
43
+
44
+ - **Content-Type**: Not defined
45
+ - **Accept**: application/json
46
+
47
+
48
+ ### HTTP response details
49
+ | Status code | Description | Response headers |
50
+ |-------------|-------------|------------------|
51
+ |**200** | Successful Response | - |
52
+
53
+ [[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)
54
+
55
+ # **getHealthHealthGet**
56
+ > any getHealthHealthGet()
57
+
58
+
59
+ ### Example
60
+
61
+ ```typescript
62
+ import {
63
+ DefaultApi,
64
+ Configuration
65
+ } from './api';
66
+
67
+ const configuration = new Configuration();
68
+ const apiInstance = new DefaultApi(configuration);
69
+
70
+ const { status, data } = await apiInstance.getHealthHealthGet();
71
+ ```
72
+
73
+ ### Parameters
74
+ This endpoint does not have any parameters.
75
+
76
+
77
+ ### Return type
78
+
79
+ **any**
80
+
81
+ ### Authorization
82
+
83
+ No authorization required
84
+
85
+ ### HTTP request headers
86
+
87
+ - **Content-Type**: Not defined
88
+ - **Accept**: application/json
89
+
90
+
91
+ ### HTTP response details
92
+ | Status code | Description | Response headers |
93
+ |-------------|-------------|------------------|
94
+ |**200** | Successful Response | - |
95
+
96
+ [[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)
97
+
98
+ # **getListmonkHealthHealthListmonkGet**
99
+ > any getListmonkHealthHealthListmonkGet()
100
+
101
+
102
+ ### Example
103
+
104
+ ```typescript
105
+ import {
106
+ DefaultApi,
107
+ Configuration
108
+ } from './api';
109
+
110
+ const configuration = new Configuration();
111
+ const apiInstance = new DefaultApi(configuration);
112
+
113
+ const { status, data } = await apiInstance.getListmonkHealthHealthListmonkGet();
114
+ ```
115
+
116
+ ### Parameters
117
+ This endpoint does not have any parameters.
118
+
119
+
120
+ ### Return type
121
+
122
+ **any**
123
+
124
+ ### Authorization
125
+
126
+ No authorization required
127
+
128
+ ### HTTP request headers
129
+
130
+ - **Content-Type**: Not defined
131
+ - **Accept**: application/json
132
+
133
+
134
+ ### HTTP response details
135
+ | Status code | Description | Response headers |
136
+ |-------------|-------------|------------------|
137
+ |**200** | Successful Response | - |
138
+
139
+ [[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)
140
+
141
+ # **getRedisHealthHealthRedisGet**
142
+ > any getRedisHealthHealthRedisGet()
143
+
144
+
145
+ ### Example
146
+
147
+ ```typescript
148
+ import {
149
+ DefaultApi,
150
+ Configuration
151
+ } from './api';
152
+
153
+ const configuration = new Configuration();
154
+ const apiInstance = new DefaultApi(configuration);
155
+
156
+ const { status, data } = await apiInstance.getRedisHealthHealthRedisGet();
157
+ ```
158
+
159
+ ### Parameters
160
+ This endpoint does not have any parameters.
161
+
162
+
163
+ ### Return type
164
+
165
+ **any**
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
+
177
+ ### HTTP response details
178
+ | Status code | Description | Response headers |
179
+ |-------------|-------------|------------------|
180
+ |**200** | Successful Response | - |
181
+
182
+ [[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)
183
+
@@ -0,0 +1,20 @@
1
+ # Details
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **details** | **string** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { Details } from './api';
14
+
15
+ const instance: Details = {
16
+ details,
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,309 @@
1
+ # EvidenceApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**deleteEvidenceV1EvidenceDeleteDelete**](#deleteevidencev1evidencedeletedelete) | **DELETE** /v1/evidence/delete | Delete Evidence|
8
+ |[**getEvidenceFilesV1EvidenceFileEvidenceIdGet**](#getevidencefilesv1evidencefileevidenceidget) | **GET** /v1/evidence/file/{evidence_id} | Get Evidence Files|
9
+ |[**listCompanyEvidenceV1EvidenceCompanyCompanyIdGet**](#listcompanyevidencev1evidencecompanycompanyidget) | **GET** /v1/evidence/company/{company_id} | List Company Evidence|
10
+ |[**updateEvidenceV1EvidenceUpdatePut**](#updateevidencev1evidenceupdateput) | **PUT** /v1/evidence/update | Update Evidence|
11
+ |[**uploadEvidenceV1EvidenceUploadPost**](#uploadevidencev1evidenceuploadpost) | **POST** /v1/evidence/upload | Upload Evidence|
12
+
13
+ # **deleteEvidenceV1EvidenceDeleteDelete**
14
+ > deleteEvidenceV1EvidenceDeleteDelete()
15
+
16
+
17
+ ### Example
18
+
19
+ ```typescript
20
+ import {
21
+ EvidenceApi,
22
+ Configuration
23
+ } from './api';
24
+
25
+ const configuration = new Configuration();
26
+ const apiInstance = new EvidenceApi(configuration);
27
+
28
+ let evidenceId: string; // (default to undefined)
29
+ let authorization: string; // (optional) (default to undefined)
30
+ let sessionId: string; // (optional) (default to undefined)
31
+
32
+ const { status, data } = await apiInstance.deleteEvidenceV1EvidenceDeleteDelete(
33
+ evidenceId,
34
+ authorization,
35
+ sessionId
36
+ );
37
+ ```
38
+
39
+ ### Parameters
40
+
41
+ |Name | Type | Description | Notes|
42
+ |------------- | ------------- | ------------- | -------------|
43
+ | **evidenceId** | [**string**] | | defaults to undefined|
44
+ | **authorization** | [**string**] | | (optional) defaults to undefined|
45
+ | **sessionId** | [**string**] | | (optional) defaults to undefined|
46
+
47
+
48
+ ### Return type
49
+
50
+ void (empty response body)
51
+
52
+ ### Authorization
53
+
54
+ No authorization required
55
+
56
+ ### HTTP request headers
57
+
58
+ - **Content-Type**: application/x-www-form-urlencoded
59
+ - **Accept**: application/json
60
+
61
+
62
+ ### HTTP response details
63
+ | Status code | Description | Response headers |
64
+ |-------------|-------------|------------------|
65
+ |**204** | Successful Response | - |
66
+ |**422** | Validation Error | - |
67
+
68
+ [[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)
69
+
70
+ # **getEvidenceFilesV1EvidenceFileEvidenceIdGet**
71
+ > Array<FileDownload> getEvidenceFilesV1EvidenceFileEvidenceIdGet()
72
+
73
+
74
+ ### Example
75
+
76
+ ```typescript
77
+ import {
78
+ EvidenceApi,
79
+ Configuration
80
+ } from './api';
81
+
82
+ const configuration = new Configuration();
83
+ const apiInstance = new EvidenceApi(configuration);
84
+
85
+ let evidenceId: string; // (default to undefined)
86
+ let authorization: string; // (optional) (default to undefined)
87
+ let sessionId: string; // (optional) (default to undefined)
88
+
89
+ const { status, data } = await apiInstance.getEvidenceFilesV1EvidenceFileEvidenceIdGet(
90
+ evidenceId,
91
+ authorization,
92
+ sessionId
93
+ );
94
+ ```
95
+
96
+ ### Parameters
97
+
98
+ |Name | Type | Description | Notes|
99
+ |------------- | ------------- | ------------- | -------------|
100
+ | **evidenceId** | [**string**] | | defaults to undefined|
101
+ | **authorization** | [**string**] | | (optional) defaults to undefined|
102
+ | **sessionId** | [**string**] | | (optional) defaults to undefined|
103
+
104
+
105
+ ### Return type
106
+
107
+ **Array<FileDownload>**
108
+
109
+ ### Authorization
110
+
111
+ No authorization required
112
+
113
+ ### HTTP request headers
114
+
115
+ - **Content-Type**: Not defined
116
+ - **Accept**: application/json
117
+
118
+
119
+ ### HTTP response details
120
+ | Status code | Description | Response headers |
121
+ |-------------|-------------|------------------|
122
+ |**200** | Successful Response | - |
123
+ |**422** | Validation Error | - |
124
+
125
+ [[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)
126
+
127
+ # **listCompanyEvidenceV1EvidenceCompanyCompanyIdGet**
128
+ > Array<EvidenceBase> listCompanyEvidenceV1EvidenceCompanyCompanyIdGet()
129
+
130
+
131
+ ### Example
132
+
133
+ ```typescript
134
+ import {
135
+ EvidenceApi,
136
+ Configuration
137
+ } from './api';
138
+
139
+ const configuration = new Configuration();
140
+ const apiInstance = new EvidenceApi(configuration);
141
+
142
+ let companyId: string; // (default to undefined)
143
+ let authorization: string; // (optional) (default to undefined)
144
+ let sessionId: string; // (optional) (default to undefined)
145
+
146
+ const { status, data } = await apiInstance.listCompanyEvidenceV1EvidenceCompanyCompanyIdGet(
147
+ companyId,
148
+ authorization,
149
+ sessionId
150
+ );
151
+ ```
152
+
153
+ ### Parameters
154
+
155
+ |Name | Type | Description | Notes|
156
+ |------------- | ------------- | ------------- | -------------|
157
+ | **companyId** | [**string**] | | defaults to undefined|
158
+ | **authorization** | [**string**] | | (optional) defaults to undefined|
159
+ | **sessionId** | [**string**] | | (optional) defaults to undefined|
160
+
161
+
162
+ ### Return type
163
+
164
+ **Array<EvidenceBase>**
165
+
166
+ ### Authorization
167
+
168
+ No authorization required
169
+
170
+ ### HTTP request headers
171
+
172
+ - **Content-Type**: Not defined
173
+ - **Accept**: application/json
174
+
175
+
176
+ ### HTTP response details
177
+ | Status code | Description | Response headers |
178
+ |-------------|-------------|------------------|
179
+ |**200** | Successful Response | - |
180
+ |**422** | Validation Error | - |
181
+
182
+ [[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)
183
+
184
+ # **updateEvidenceV1EvidenceUpdatePut**
185
+ > EvidenceBase updateEvidenceV1EvidenceUpdatePut()
186
+
187
+
188
+ ### Example
189
+
190
+ ```typescript
191
+ import {
192
+ EvidenceApi,
193
+ Configuration
194
+ } from './api';
195
+
196
+ const configuration = new Configuration();
197
+ const apiInstance = new EvidenceApi(configuration);
198
+
199
+ let evidenceId: string; // (default to undefined)
200
+ let text: string; // (default to undefined)
201
+ let authorization: string; // (optional) (default to undefined)
202
+ let sessionId: string; // (optional) (default to undefined)
203
+
204
+ const { status, data } = await apiInstance.updateEvidenceV1EvidenceUpdatePut(
205
+ evidenceId,
206
+ text,
207
+ authorization,
208
+ sessionId
209
+ );
210
+ ```
211
+
212
+ ### Parameters
213
+
214
+ |Name | Type | Description | Notes|
215
+ |------------- | ------------- | ------------- | -------------|
216
+ | **evidenceId** | [**string**] | | defaults to undefined|
217
+ | **text** | [**string**] | | defaults to undefined|
218
+ | **authorization** | [**string**] | | (optional) defaults to undefined|
219
+ | **sessionId** | [**string**] | | (optional) defaults to undefined|
220
+
221
+
222
+ ### Return type
223
+
224
+ **EvidenceBase**
225
+
226
+ ### Authorization
227
+
228
+ No authorization required
229
+
230
+ ### HTTP request headers
231
+
232
+ - **Content-Type**: application/x-www-form-urlencoded
233
+ - **Accept**: application/json
234
+
235
+
236
+ ### HTTP response details
237
+ | Status code | Description | Response headers |
238
+ |-------------|-------------|------------------|
239
+ |**200** | Successful Response | - |
240
+ |**422** | Validation Error | - |
241
+
242
+ [[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)
243
+
244
+ # **uploadEvidenceV1EvidenceUploadPost**
245
+ > EvidenceBase uploadEvidenceV1EvidenceUploadPost()
246
+
247
+
248
+ ### Example
249
+
250
+ ```typescript
251
+ import {
252
+ EvidenceApi,
253
+ Configuration
254
+ } from './api';
255
+
256
+ const configuration = new Configuration();
257
+ const apiInstance = new EvidenceApi(configuration);
258
+
259
+ let companyId: string; // (default to undefined)
260
+ let controlId: string; // (default to undefined)
261
+ let file: File; // (default to undefined)
262
+ let text: string; // (default to undefined)
263
+ let authorization: string; // (optional) (default to undefined)
264
+ let sessionId: string; // (optional) (default to undefined)
265
+
266
+ const { status, data } = await apiInstance.uploadEvidenceV1EvidenceUploadPost(
267
+ companyId,
268
+ controlId,
269
+ file,
270
+ text,
271
+ authorization,
272
+ sessionId
273
+ );
274
+ ```
275
+
276
+ ### Parameters
277
+
278
+ |Name | Type | Description | Notes|
279
+ |------------- | ------------- | ------------- | -------------|
280
+ | **companyId** | [**string**] | | defaults to undefined|
281
+ | **controlId** | [**string**] | | defaults to undefined|
282
+ | **file** | [**File**] | | defaults to undefined|
283
+ | **text** | [**string**] | | defaults to undefined|
284
+ | **authorization** | [**string**] | | (optional) defaults to undefined|
285
+ | **sessionId** | [**string**] | | (optional) defaults to undefined|
286
+
287
+
288
+ ### Return type
289
+
290
+ **EvidenceBase**
291
+
292
+ ### Authorization
293
+
294
+ No authorization required
295
+
296
+ ### HTTP request headers
297
+
298
+ - **Content-Type**: application/x-www-form-urlencoded
299
+ - **Accept**: application/json
300
+
301
+
302
+ ### HTTP response details
303
+ | Status code | Description | Response headers |
304
+ |-------------|-------------|------------------|
305
+ |**200** | Successful Response | - |
306
+ |**422** | Validation Error | - |
307
+
308
+ [[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)
309
+