@rasadov/lumoar-sdk 1.0.5 → 1.0.7
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 +5 -1
- package/README.md +25 -0
- package/api.ts +146 -151
- package/dist/api.d.ts +144 -101
- package/dist/api.js +21 -109
- package/docs/AuditLogSchema.md +32 -0
- package/docs/AuditLogsApi.md +6 -6
- package/docs/CompanyApi.md +6 -67
- package/docs/ControlBase.md +26 -0
- package/docs/ControlWithEvidences.md +2 -2
- package/docs/ControlWithRelationships.md +2 -2
- package/docs/ControlsApi.md +2 -2
- package/docs/PaginationResponseAuditLogSchema.md +22 -0
- package/docs/PaginationResponseCompanyInDBBase.md +22 -0
- package/docs/PaginationResponsePolicyRead.md +22 -0
- package/docs/PoliciesApi.md +2 -2
- package/docs/UpdateControlSchema.md +1 -1
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -93,8 +93,8 @@ export const AuditLogsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
*
|
|
94
94
|
* @summary List Audit Logs
|
|
95
95
|
* @param {string} companyId
|
|
96
|
-
* @param {number} page
|
|
97
|
-
* @param {number} elements
|
|
96
|
+
* @param {number} [page]
|
|
97
|
+
* @param {number} [elements]
|
|
98
98
|
* @param {AuditLogEntity | null} [entityType]
|
|
99
99
|
* @param {AuditLogAction | null} [action]
|
|
100
100
|
* @param {string | null} [startDate]
|
|
@@ -107,10 +107,6 @@ export const AuditLogsApiAxiosParamCreator = function (configuration) {
|
|
|
107
107
|
listAuditLogsV1AuditLogsListGet: (companyId_1, page_1, elements_1, entityType_1, action_1, startDate_1, endDate_1, authorization_1, sessionId_1, ...args_1) => __awaiter(this, [companyId_1, page_1, elements_1, entityType_1, action_1, startDate_1, endDate_1, authorization_1, sessionId_1, ...args_1], void 0, function* (companyId, page, elements, entityType, action, startDate, endDate, authorization, sessionId, options = {}) {
|
|
108
108
|
// verify required parameter 'companyId' is not null or undefined
|
|
109
109
|
assertParamExists('listAuditLogsV1AuditLogsListGet', 'companyId', companyId);
|
|
110
|
-
// verify required parameter 'page' is not null or undefined
|
|
111
|
-
assertParamExists('listAuditLogsV1AuditLogsListGet', 'page', page);
|
|
112
|
-
// verify required parameter 'elements' is not null or undefined
|
|
113
|
-
assertParamExists('listAuditLogsV1AuditLogsListGet', 'elements', elements);
|
|
114
110
|
const localVarPath = `/v1/audit-logs/list`;
|
|
115
111
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
116
112
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -170,8 +166,8 @@ export const AuditLogsApiFp = function (configuration) {
|
|
|
170
166
|
*
|
|
171
167
|
* @summary List Audit Logs
|
|
172
168
|
* @param {string} companyId
|
|
173
|
-
* @param {number} page
|
|
174
|
-
* @param {number} elements
|
|
169
|
+
* @param {number} [page]
|
|
170
|
+
* @param {number} [elements]
|
|
175
171
|
* @param {AuditLogEntity | null} [entityType]
|
|
176
172
|
* @param {AuditLogAction | null} [action]
|
|
177
173
|
* @param {string | null} [startDate]
|
|
@@ -203,8 +199,8 @@ export const AuditLogsApiFactory = function (configuration, basePath, axios) {
|
|
|
203
199
|
*
|
|
204
200
|
* @summary List Audit Logs
|
|
205
201
|
* @param {string} companyId
|
|
206
|
-
* @param {number} page
|
|
207
|
-
* @param {number} elements
|
|
202
|
+
* @param {number} [page]
|
|
203
|
+
* @param {number} [elements]
|
|
208
204
|
* @param {AuditLogEntity | null} [entityType]
|
|
209
205
|
* @param {AuditLogAction | null} [action]
|
|
210
206
|
* @param {string | null} [startDate]
|
|
@@ -230,8 +226,8 @@ export class AuditLogsApi extends BaseAPI {
|
|
|
230
226
|
*
|
|
231
227
|
* @summary List Audit Logs
|
|
232
228
|
* @param {string} companyId
|
|
233
|
-
* @param {number} page
|
|
234
|
-
* @param {number} elements
|
|
229
|
+
* @param {number} [page]
|
|
230
|
+
* @param {number} [elements]
|
|
235
231
|
* @param {AuditLogEntity | null} [entityType]
|
|
236
232
|
* @param {AuditLogAction | null} [action]
|
|
237
233
|
* @param {string | null} [startDate]
|
|
@@ -1123,16 +1119,16 @@ export const CompanyApiAxiosParamCreator = function (configuration) {
|
|
|
1123
1119
|
}),
|
|
1124
1120
|
/**
|
|
1125
1121
|
*
|
|
1126
|
-
* @summary Get Controls
|
|
1122
|
+
* @summary Get Company With Controls
|
|
1127
1123
|
* @param {string} companyId
|
|
1128
1124
|
* @param {string} [authorization]
|
|
1129
1125
|
* @param {string} [sessionId]
|
|
1130
1126
|
* @param {*} [options] Override http request option.
|
|
1131
1127
|
* @throws {RequiredError}
|
|
1132
1128
|
*/
|
|
1133
|
-
|
|
1129
|
+
getCompanyWithControlsV1CompanyControlsCompanyIdGet: (companyId_1, authorization_1, sessionId_1, ...args_1) => __awaiter(this, [companyId_1, authorization_1, sessionId_1, ...args_1], void 0, function* (companyId, authorization, sessionId, options = {}) {
|
|
1134
1130
|
// verify required parameter 'companyId' is not null or undefined
|
|
1135
|
-
assertParamExists('
|
|
1131
|
+
assertParamExists('getCompanyWithControlsV1CompanyControlsCompanyIdGet', 'companyId', companyId);
|
|
1136
1132
|
const localVarPath = `/v1/company/controls/{company_id}`
|
|
1137
1133
|
.replace(`{${"company_id"}}`, encodeURIComponent(String(companyId)));
|
|
1138
1134
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -1155,44 +1151,6 @@ export const CompanyApiAxiosParamCreator = function (configuration) {
|
|
|
1155
1151
|
options: localVarRequestOptions,
|
|
1156
1152
|
};
|
|
1157
1153
|
}),
|
|
1158
|
-
/**
|
|
1159
|
-
*
|
|
1160
|
-
* @summary Get Policies
|
|
1161
|
-
* @param {number} [page]
|
|
1162
|
-
* @param {number} [elements]
|
|
1163
|
-
* @param {string} [authorization]
|
|
1164
|
-
* @param {string} [sessionId]
|
|
1165
|
-
* @param {*} [options] Override http request option.
|
|
1166
|
-
* @throws {RequiredError}
|
|
1167
|
-
*/
|
|
1168
|
-
getPoliciesV1CompanyPoliciesGet: (page_1, elements_1, authorization_1, sessionId_1, ...args_1) => __awaiter(this, [page_1, elements_1, authorization_1, sessionId_1, ...args_1], void 0, function* (page, elements, authorization, sessionId, options = {}) {
|
|
1169
|
-
const localVarPath = `/v1/company/policies`;
|
|
1170
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1171
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1172
|
-
let baseOptions;
|
|
1173
|
-
if (configuration) {
|
|
1174
|
-
baseOptions = configuration.baseOptions;
|
|
1175
|
-
}
|
|
1176
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1177
|
-
const localVarHeaderParameter = {};
|
|
1178
|
-
const localVarQueryParameter = {};
|
|
1179
|
-
if (page !== undefined) {
|
|
1180
|
-
localVarQueryParameter['page'] = page;
|
|
1181
|
-
}
|
|
1182
|
-
if (elements !== undefined) {
|
|
1183
|
-
localVarQueryParameter['elements'] = elements;
|
|
1184
|
-
}
|
|
1185
|
-
if (authorization != null) {
|
|
1186
|
-
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
1187
|
-
}
|
|
1188
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1189
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1190
|
-
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1191
|
-
return {
|
|
1192
|
-
url: toPathString(localVarUrlObj),
|
|
1193
|
-
options: localVarRequestOptions,
|
|
1194
|
-
};
|
|
1195
|
-
}),
|
|
1196
1154
|
/**
|
|
1197
1155
|
*
|
|
1198
1156
|
* @summary Update Company
|
|
@@ -1294,38 +1252,19 @@ export const CompanyApiFp = function (configuration) {
|
|
|
1294
1252
|
},
|
|
1295
1253
|
/**
|
|
1296
1254
|
*
|
|
1297
|
-
* @summary Get Controls
|
|
1255
|
+
* @summary Get Company With Controls
|
|
1298
1256
|
* @param {string} companyId
|
|
1299
1257
|
* @param {string} [authorization]
|
|
1300
1258
|
* @param {string} [sessionId]
|
|
1301
1259
|
* @param {*} [options] Override http request option.
|
|
1302
1260
|
* @throws {RequiredError}
|
|
1303
1261
|
*/
|
|
1304
|
-
|
|
1305
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
1306
|
-
var _a, _b, _c;
|
|
1307
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getControlsV1CompanyControlsCompanyIdGet(companyId, authorization, sessionId, options);
|
|
1308
|
-
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1309
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CompanyApi.getControlsV1CompanyControlsCompanyIdGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1310
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1311
|
-
});
|
|
1312
|
-
},
|
|
1313
|
-
/**
|
|
1314
|
-
*
|
|
1315
|
-
* @summary Get Policies
|
|
1316
|
-
* @param {number} [page]
|
|
1317
|
-
* @param {number} [elements]
|
|
1318
|
-
* @param {string} [authorization]
|
|
1319
|
-
* @param {string} [sessionId]
|
|
1320
|
-
* @param {*} [options] Override http request option.
|
|
1321
|
-
* @throws {RequiredError}
|
|
1322
|
-
*/
|
|
1323
|
-
getPoliciesV1CompanyPoliciesGet(page, elements, authorization, sessionId, options) {
|
|
1262
|
+
getCompanyWithControlsV1CompanyControlsCompanyIdGet(companyId, authorization, sessionId, options) {
|
|
1324
1263
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1325
1264
|
var _a, _b, _c;
|
|
1326
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1265
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getCompanyWithControlsV1CompanyControlsCompanyIdGet(companyId, authorization, sessionId, options);
|
|
1327
1266
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1328
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CompanyApi.
|
|
1267
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CompanyApi.getCompanyWithControlsV1CompanyControlsCompanyIdGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1329
1268
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1330
1269
|
});
|
|
1331
1270
|
},
|
|
@@ -1395,28 +1334,15 @@ export const CompanyApiFactory = function (configuration, basePath, axios) {
|
|
|
1395
1334
|
},
|
|
1396
1335
|
/**
|
|
1397
1336
|
*
|
|
1398
|
-
* @summary Get Controls
|
|
1337
|
+
* @summary Get Company With Controls
|
|
1399
1338
|
* @param {string} companyId
|
|
1400
1339
|
* @param {string} [authorization]
|
|
1401
1340
|
* @param {string} [sessionId]
|
|
1402
1341
|
* @param {*} [options] Override http request option.
|
|
1403
1342
|
* @throws {RequiredError}
|
|
1404
1343
|
*/
|
|
1405
|
-
|
|
1406
|
-
return localVarFp.
|
|
1407
|
-
},
|
|
1408
|
-
/**
|
|
1409
|
-
*
|
|
1410
|
-
* @summary Get Policies
|
|
1411
|
-
* @param {number} [page]
|
|
1412
|
-
* @param {number} [elements]
|
|
1413
|
-
* @param {string} [authorization]
|
|
1414
|
-
* @param {string} [sessionId]
|
|
1415
|
-
* @param {*} [options] Override http request option.
|
|
1416
|
-
* @throws {RequiredError}
|
|
1417
|
-
*/
|
|
1418
|
-
getPoliciesV1CompanyPoliciesGet(page, elements, authorization, sessionId, options) {
|
|
1419
|
-
return localVarFp.getPoliciesV1CompanyPoliciesGet(page, elements, authorization, sessionId, options).then((request) => request(axios, basePath));
|
|
1344
|
+
getCompanyWithControlsV1CompanyControlsCompanyIdGet(companyId, authorization, sessionId, options) {
|
|
1345
|
+
return localVarFp.getCompanyWithControlsV1CompanyControlsCompanyIdGet(companyId, authorization, sessionId, options).then((request) => request(axios, basePath));
|
|
1420
1346
|
},
|
|
1421
1347
|
/**
|
|
1422
1348
|
*
|
|
@@ -1481,7 +1407,7 @@ export class CompanyApi extends BaseAPI {
|
|
|
1481
1407
|
}
|
|
1482
1408
|
/**
|
|
1483
1409
|
*
|
|
1484
|
-
* @summary Get Controls
|
|
1410
|
+
* @summary Get Company With Controls
|
|
1485
1411
|
* @param {string} companyId
|
|
1486
1412
|
* @param {string} [authorization]
|
|
1487
1413
|
* @param {string} [sessionId]
|
|
@@ -1489,22 +1415,8 @@ export class CompanyApi extends BaseAPI {
|
|
|
1489
1415
|
* @throws {RequiredError}
|
|
1490
1416
|
* @memberof CompanyApi
|
|
1491
1417
|
*/
|
|
1492
|
-
|
|
1493
|
-
return CompanyApiFp(this.configuration).
|
|
1494
|
-
}
|
|
1495
|
-
/**
|
|
1496
|
-
*
|
|
1497
|
-
* @summary Get Policies
|
|
1498
|
-
* @param {number} [page]
|
|
1499
|
-
* @param {number} [elements]
|
|
1500
|
-
* @param {string} [authorization]
|
|
1501
|
-
* @param {string} [sessionId]
|
|
1502
|
-
* @param {*} [options] Override http request option.
|
|
1503
|
-
* @throws {RequiredError}
|
|
1504
|
-
* @memberof CompanyApi
|
|
1505
|
-
*/
|
|
1506
|
-
getPoliciesV1CompanyPoliciesGet(page, elements, authorization, sessionId, options) {
|
|
1507
|
-
return CompanyApiFp(this.configuration).getPoliciesV1CompanyPoliciesGet(page, elements, authorization, sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
1418
|
+
getCompanyWithControlsV1CompanyControlsCompanyIdGet(companyId, authorization, sessionId, options) {
|
|
1419
|
+
return CompanyApiFp(this.configuration).getCompanyWithControlsV1CompanyControlsCompanyIdGet(companyId, authorization, sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
1508
1420
|
}
|
|
1509
1421
|
/**
|
|
1510
1422
|
*
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# AuditLogSchema
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**company_id** | **string** | | [default to undefined]
|
|
9
|
+
**action** | [**AuditLogAction**](AuditLogAction.md) | | [default to undefined]
|
|
10
|
+
**entity_type** | [**AuditLogEntity**](AuditLogEntity.md) | | [default to undefined]
|
|
11
|
+
**entity_id** | **string** | | [default to undefined]
|
|
12
|
+
**timestamp** | **string** | | [default to undefined]
|
|
13
|
+
**details** | **{ [key: string]: any; }** | | [default to undefined]
|
|
14
|
+
**user** | [**UserBase**](UserBase.md) | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { AuditLogSchema } from './api';
|
|
20
|
+
|
|
21
|
+
const instance: AuditLogSchema = {
|
|
22
|
+
company_id,
|
|
23
|
+
action,
|
|
24
|
+
entity_type,
|
|
25
|
+
entity_id,
|
|
26
|
+
timestamp,
|
|
27
|
+
details,
|
|
28
|
+
user,
|
|
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)
|
package/docs/AuditLogsApi.md
CHANGED
|
@@ -7,7 +7,7 @@ All URIs are relative to *http://localhost*
|
|
|
7
7
|
|[**listAuditLogsV1AuditLogsListGet**](#listauditlogsv1auditlogslistget) | **GET** /v1/audit-logs/list | List Audit Logs|
|
|
8
8
|
|
|
9
9
|
# **listAuditLogsV1AuditLogsListGet**
|
|
10
|
-
>
|
|
10
|
+
> PaginationResponseAuditLogSchema listAuditLogsV1AuditLogsListGet()
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
### Example
|
|
@@ -22,8 +22,8 @@ const configuration = new Configuration();
|
|
|
22
22
|
const apiInstance = new AuditLogsApi(configuration);
|
|
23
23
|
|
|
24
24
|
let companyId: string; // (default to undefined)
|
|
25
|
-
let page: number; // (default to
|
|
26
|
-
let elements: number; // (default to
|
|
25
|
+
let page: number; // (optional) (default to 1)
|
|
26
|
+
let elements: number; // (optional) (default to 10)
|
|
27
27
|
let entityType: AuditLogEntity; // (optional) (default to undefined)
|
|
28
28
|
let action: AuditLogAction; // (optional) (default to undefined)
|
|
29
29
|
let startDate: string; // (optional) (default to undefined)
|
|
@@ -49,8 +49,8 @@ const { status, data } = await apiInstance.listAuditLogsV1AuditLogsListGet(
|
|
|
49
49
|
|Name | Type | Description | Notes|
|
|
50
50
|
|------------- | ------------- | ------------- | -------------|
|
|
51
51
|
| **companyId** | [**string**] | | defaults to undefined|
|
|
52
|
-
| **page** | [**number**] | | defaults to
|
|
53
|
-
| **elements** | [**number**] | | defaults to
|
|
52
|
+
| **page** | [**number**] | | (optional) defaults to 1|
|
|
53
|
+
| **elements** | [**number**] | | (optional) defaults to 10|
|
|
54
54
|
| **entityType** | **AuditLogEntity** | | (optional) defaults to undefined|
|
|
55
55
|
| **action** | **AuditLogAction** | | (optional) defaults to undefined|
|
|
56
56
|
| **startDate** | [**string**] | | (optional) defaults to undefined|
|
|
@@ -61,7 +61,7 @@ const { status, data } = await apiInstance.listAuditLogsV1AuditLogsListGet(
|
|
|
61
61
|
|
|
62
62
|
### Return type
|
|
63
63
|
|
|
64
|
-
**
|
|
64
|
+
**PaginationResponseAuditLogSchema**
|
|
65
65
|
|
|
66
66
|
### Authorization
|
|
67
67
|
|
package/docs/CompanyApi.md
CHANGED
|
@@ -7,8 +7,7 @@ All URIs are relative to *http://localhost*
|
|
|
7
7
|
|[**createCompanyV1CompanyCreatePost**](#createcompanyv1companycreatepost) | **POST** /v1/company/create | Create Company|
|
|
8
8
|
|[**getCompaniesV1CompanyListGet**](#getcompaniesv1companylistget) | **GET** /v1/company/list | Get Companies|
|
|
9
9
|
|[**getCompanyV1CompanyGetCompanyIdGet**](#getcompanyv1companygetcompanyidget) | **GET** /v1/company/get/{company_id} | Get Company|
|
|
10
|
-
|[**
|
|
11
|
-
|[**getPoliciesV1CompanyPoliciesGet**](#getpoliciesv1companypoliciesget) | **GET** /v1/company/policies | Get Policies|
|
|
10
|
+
|[**getCompanyWithControlsV1CompanyControlsCompanyIdGet**](#getcompanywithcontrolsv1companycontrolscompanyidget) | **GET** /v1/company/controls/{company_id} | Get Company With Controls|
|
|
12
11
|
|[**updateCompanyV1CompanyUpdatePatch**](#updatecompanyv1companyupdatepatch) | **PATCH** /v1/company/update | Update Company|
|
|
13
12
|
|
|
14
13
|
# **createCompanyV1CompanyCreatePost**
|
|
@@ -70,7 +69,7 @@ No authorization required
|
|
|
70
69
|
[[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
70
|
|
|
72
71
|
# **getCompaniesV1CompanyListGet**
|
|
73
|
-
>
|
|
72
|
+
> PaginationResponseCompanyInDBBase getCompaniesV1CompanyListGet()
|
|
74
73
|
|
|
75
74
|
|
|
76
75
|
### Example
|
|
@@ -109,7 +108,7 @@ const { status, data } = await apiInstance.getCompaniesV1CompanyListGet(
|
|
|
109
108
|
|
|
110
109
|
### Return type
|
|
111
110
|
|
|
112
|
-
**
|
|
111
|
+
**PaginationResponseCompanyInDBBase**
|
|
113
112
|
|
|
114
113
|
### Authorization
|
|
115
114
|
|
|
@@ -186,8 +185,8 @@ No authorization required
|
|
|
186
185
|
|
|
187
186
|
[[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)
|
|
188
187
|
|
|
189
|
-
# **
|
|
190
|
-
> CompanyWithControls
|
|
188
|
+
# **getCompanyWithControlsV1CompanyControlsCompanyIdGet**
|
|
189
|
+
> CompanyWithControls getCompanyWithControlsV1CompanyControlsCompanyIdGet()
|
|
191
190
|
|
|
192
191
|
|
|
193
192
|
### Example
|
|
@@ -205,7 +204,7 @@ let companyId: string; // (default to undefined)
|
|
|
205
204
|
let authorization: string; // (optional) (default to undefined)
|
|
206
205
|
let sessionId: string; // (optional) (default to undefined)
|
|
207
206
|
|
|
208
|
-
const { status, data } = await apiInstance.
|
|
207
|
+
const { status, data } = await apiInstance.getCompanyWithControlsV1CompanyControlsCompanyIdGet(
|
|
209
208
|
companyId,
|
|
210
209
|
authorization,
|
|
211
210
|
sessionId
|
|
@@ -235,66 +234,6 @@ No authorization required
|
|
|
235
234
|
- **Accept**: application/json
|
|
236
235
|
|
|
237
236
|
|
|
238
|
-
### HTTP response details
|
|
239
|
-
| Status code | Description | Response headers |
|
|
240
|
-
|-------------|-------------|------------------|
|
|
241
|
-
|**200** | Successful Response | - |
|
|
242
|
-
|**422** | Validation Error | - |
|
|
243
|
-
|
|
244
|
-
[[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)
|
|
245
|
-
|
|
246
|
-
# **getPoliciesV1CompanyPoliciesGet**
|
|
247
|
-
> Array<PolicyRead> getPoliciesV1CompanyPoliciesGet()
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
### Example
|
|
251
|
-
|
|
252
|
-
```typescript
|
|
253
|
-
import {
|
|
254
|
-
CompanyApi,
|
|
255
|
-
Configuration
|
|
256
|
-
} from './api';
|
|
257
|
-
|
|
258
|
-
const configuration = new Configuration();
|
|
259
|
-
const apiInstance = new CompanyApi(configuration);
|
|
260
|
-
|
|
261
|
-
let page: number; // (optional) (default to 1)
|
|
262
|
-
let elements: number; // (optional) (default to 10)
|
|
263
|
-
let authorization: string; // (optional) (default to undefined)
|
|
264
|
-
let sessionId: string; // (optional) (default to undefined)
|
|
265
|
-
|
|
266
|
-
const { status, data } = await apiInstance.getPoliciesV1CompanyPoliciesGet(
|
|
267
|
-
page,
|
|
268
|
-
elements,
|
|
269
|
-
authorization,
|
|
270
|
-
sessionId
|
|
271
|
-
);
|
|
272
|
-
```
|
|
273
|
-
|
|
274
|
-
### Parameters
|
|
275
|
-
|
|
276
|
-
|Name | Type | Description | Notes|
|
|
277
|
-
|------------- | ------------- | ------------- | -------------|
|
|
278
|
-
| **page** | [**number**] | | (optional) defaults to 1|
|
|
279
|
-
| **elements** | [**number**] | | (optional) defaults to 10|
|
|
280
|
-
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
281
|
-
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
### Return type
|
|
285
|
-
|
|
286
|
-
**Array<PolicyRead>**
|
|
287
|
-
|
|
288
|
-
### Authorization
|
|
289
|
-
|
|
290
|
-
No authorization required
|
|
291
|
-
|
|
292
|
-
### HTTP request headers
|
|
293
|
-
|
|
294
|
-
- **Content-Type**: Not defined
|
|
295
|
-
- **Accept**: application/json
|
|
296
|
-
|
|
297
|
-
|
|
298
237
|
### HTTP response details
|
|
299
238
|
| Status code | Description | Response headers |
|
|
300
239
|
|-------------|-------------|------------------|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ControlBase
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**status** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**note** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**updated_at** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ControlBase } from './api';
|
|
17
|
+
|
|
18
|
+
const instance: ControlBase = {
|
|
19
|
+
id,
|
|
20
|
+
status,
|
|
21
|
+
note,
|
|
22
|
+
updated_at,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
|
-
**framework_control** | [**FrameworkControlsBase**](FrameworkControlsBase.md) | | [default to undefined]
|
|
10
9
|
**status** | **string** | | [optional] [default to undefined]
|
|
11
10
|
**note** | **string** | | [optional] [default to undefined]
|
|
12
11
|
**updated_at** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**data** | [**FrameworkControlsBase**](FrameworkControlsBase.md) | | [default to undefined]
|
|
13
13
|
**evidences** | [**Array<EvidenceBase>**](EvidenceBase.md) | | [optional] [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
@@ -19,10 +19,10 @@ import { ControlWithEvidences } from './api';
|
|
|
19
19
|
|
|
20
20
|
const instance: ControlWithEvidences = {
|
|
21
21
|
id,
|
|
22
|
-
framework_control,
|
|
23
22
|
status,
|
|
24
23
|
note,
|
|
25
24
|
updated_at,
|
|
25
|
+
data,
|
|
26
26
|
evidences,
|
|
27
27
|
};
|
|
28
28
|
```
|
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
|
-
**framework_control** | [**FrameworkControlsBase**](FrameworkControlsBase.md) | | [default to undefined]
|
|
10
9
|
**status** | **string** | | [optional] [default to undefined]
|
|
11
10
|
**note** | **string** | | [optional] [default to undefined]
|
|
12
11
|
**updated_at** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**data** | [**FrameworkControlsBase**](FrameworkControlsBase.md) | | [default to undefined]
|
|
13
13
|
**company** | [**CompanyInDBBase**](CompanyInDBBase.md) | | [default to undefined]
|
|
14
14
|
**evidences** | [**Array<EvidenceBase>**](EvidenceBase.md) | | [optional] [default to undefined]
|
|
15
15
|
|
|
@@ -20,10 +20,10 @@ import { ControlWithRelationships } from './api';
|
|
|
20
20
|
|
|
21
21
|
const instance: ControlWithRelationships = {
|
|
22
22
|
id,
|
|
23
|
-
framework_control,
|
|
24
23
|
status,
|
|
25
24
|
note,
|
|
26
25
|
updated_at,
|
|
26
|
+
data,
|
|
27
27
|
company,
|
|
28
28
|
evidences,
|
|
29
29
|
};
|
package/docs/ControlsApi.md
CHANGED
|
@@ -65,7 +65,7 @@ No authorization required
|
|
|
65
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
66
|
|
|
67
67
|
# **updateControlV1ControlsUpdatePatch**
|
|
68
|
-
>
|
|
68
|
+
> ControlBase updateControlV1ControlsUpdatePatch(updateControlSchema)
|
|
69
69
|
|
|
70
70
|
|
|
71
71
|
### Example
|
|
@@ -102,7 +102,7 @@ const { status, data } = await apiInstance.updateControlV1ControlsUpdatePatch(
|
|
|
102
102
|
|
|
103
103
|
### Return type
|
|
104
104
|
|
|
105
|
-
**
|
|
105
|
+
**ControlBase**
|
|
106
106
|
|
|
107
107
|
### Authorization
|
|
108
108
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PaginationResponseAuditLogSchema
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**items** | [**Array<AuditLogSchema>**](AuditLogSchema.md) | | [default to undefined]
|
|
9
|
+
**total** | **number** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PaginationResponseAuditLogSchema } from './api';
|
|
15
|
+
|
|
16
|
+
const instance: PaginationResponseAuditLogSchema = {
|
|
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
|
+
# PaginationResponseCompanyInDBBase
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**items** | [**Array<CompanyInDBBase>**](CompanyInDBBase.md) | | [default to undefined]
|
|
9
|
+
**total** | **number** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PaginationResponseCompanyInDBBase } from './api';
|
|
15
|
+
|
|
16
|
+
const instance: PaginationResponseCompanyInDBBase = {
|
|
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
|
+
# PaginationResponsePolicyRead
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**items** | [**Array<PolicyRead>**](PolicyRead.md) | | [default to undefined]
|
|
9
|
+
**total** | **number** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PaginationResponsePolicyRead } from './api';
|
|
15
|
+
|
|
16
|
+
const instance: PaginationResponsePolicyRead = {
|
|
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)
|
package/docs/PoliciesApi.md
CHANGED
|
@@ -126,7 +126,7 @@ No authorization required
|
|
|
126
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
127
|
|
|
128
128
|
# **getCompanyPoliciesV1PoliciesCompanyCompanyIdGet**
|
|
129
|
-
>
|
|
129
|
+
> PaginationResponsePolicyRead getCompanyPoliciesV1PoliciesCompanyCompanyIdGet()
|
|
130
130
|
|
|
131
131
|
|
|
132
132
|
### Example
|
|
@@ -168,7 +168,7 @@ const { status, data } = await apiInstance.getCompanyPoliciesV1PoliciesCompanyCo
|
|
|
168
168
|
|
|
169
169
|
### Return type
|
|
170
170
|
|
|
171
|
-
**
|
|
171
|
+
**PaginationResponsePolicyRead**
|
|
172
172
|
|
|
173
173
|
### Authorization
|
|
174
174
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
|
-
**status** | [**ControlStatus**](ControlStatus.md) | | [
|
|
9
|
+
**status** | [**ControlStatus**](ControlStatus.md) | | [default to undefined]
|
|
10
10
|
**note** | **string** | | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|