@rasadov/lumoar-sdk 1.1.9 → 1.2.0
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 +7 -2
- package/api.ts +523 -295
- package/dist/api.d.ts +422 -279
- package/dist/api.js +156 -0
- package/docs/CompanyApi.md +4 -4
- package/docs/CompanyComplianceInDB.md +42 -0
- package/docs/CompanyCreate.md +0 -14
- package/docs/CompanyUpdate.md +0 -14
- package/docs/CompanyWithControls.md +0 -16
- package/docs/CompanyWithRoles.md +0 -16
- package/docs/ControlWithData.md +28 -0
- package/docs/ControlWithRelationships.md +1 -1
- package/docs/CustomerDBBase.md +22 -0
- package/docs/EvidenceApi.md +58 -0
- package/docs/EvidenceWithControl.md +42 -0
- package/docs/PaginationResponseCompanyInDBBase.md +1 -1
- package/docs/PaymentsApi.md +2 -2
- package/docs/ResponseGetSubscriptionV1PaymentsSubscriptionGet.md +30 -0
- package/docs/SrcDomainsOrganizationSchemasCompanyCompanyInDBBase.md +32 -0
- package/docs/SrcSharedSchemasCompanyCompanyInDBBase.md +34 -0
- package/docs/SubscriptionResponse.md +1 -1
- package/docs/TaskRead.md +2 -0
- package/docs/TaskWithUser.md +2 -0
- package/docs/TasksApi.md +58 -0
- package/docs/UserPermissionsWithCompany.md +1 -1
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -1735,6 +1735,42 @@ export const EvidenceApiAxiosParamCreator = function (configuration) {
|
|
|
1735
1735
|
options: localVarRequestOptions,
|
|
1736
1736
|
};
|
|
1737
1737
|
}),
|
|
1738
|
+
/**
|
|
1739
|
+
*
|
|
1740
|
+
* @summary Get Evidence
|
|
1741
|
+
* @param {string} evidenceId
|
|
1742
|
+
* @param {string} [authorization]
|
|
1743
|
+
* @param {string} [sessionId]
|
|
1744
|
+
* @param {*} [options] Override http request option.
|
|
1745
|
+
* @throws {RequiredError}
|
|
1746
|
+
*/
|
|
1747
|
+
getEvidenceV1EvidenceGetGet: (evidenceId_1, authorization_1, sessionId_1, ...args_1) => __awaiter(this, [evidenceId_1, authorization_1, sessionId_1, ...args_1], void 0, function* (evidenceId, authorization, sessionId, options = {}) {
|
|
1748
|
+
// verify required parameter 'evidenceId' is not null or undefined
|
|
1749
|
+
assertParamExists('getEvidenceV1EvidenceGetGet', 'evidenceId', evidenceId);
|
|
1750
|
+
const localVarPath = `/v1/evidence/get`;
|
|
1751
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1752
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1753
|
+
let baseOptions;
|
|
1754
|
+
if (configuration) {
|
|
1755
|
+
baseOptions = configuration.baseOptions;
|
|
1756
|
+
}
|
|
1757
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1758
|
+
const localVarHeaderParameter = {};
|
|
1759
|
+
const localVarQueryParameter = {};
|
|
1760
|
+
if (evidenceId !== undefined) {
|
|
1761
|
+
localVarQueryParameter['evidence_id'] = evidenceId;
|
|
1762
|
+
}
|
|
1763
|
+
if (authorization != null) {
|
|
1764
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
1765
|
+
}
|
|
1766
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1767
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1768
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1769
|
+
return {
|
|
1770
|
+
url: toPathString(localVarUrlObj),
|
|
1771
|
+
options: localVarRequestOptions,
|
|
1772
|
+
};
|
|
1773
|
+
}),
|
|
1738
1774
|
/**
|
|
1739
1775
|
*
|
|
1740
1776
|
* @summary List Company Evidence
|
|
@@ -1918,6 +1954,24 @@ export const EvidenceApiFp = function (configuration) {
|
|
|
1918
1954
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1919
1955
|
});
|
|
1920
1956
|
},
|
|
1957
|
+
/**
|
|
1958
|
+
*
|
|
1959
|
+
* @summary Get Evidence
|
|
1960
|
+
* @param {string} evidenceId
|
|
1961
|
+
* @param {string} [authorization]
|
|
1962
|
+
* @param {string} [sessionId]
|
|
1963
|
+
* @param {*} [options] Override http request option.
|
|
1964
|
+
* @throws {RequiredError}
|
|
1965
|
+
*/
|
|
1966
|
+
getEvidenceV1EvidenceGetGet(evidenceId, authorization, sessionId, options) {
|
|
1967
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1968
|
+
var _a, _b, _c;
|
|
1969
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getEvidenceV1EvidenceGetGet(evidenceId, authorization, sessionId, options);
|
|
1970
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1971
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EvidenceApi.getEvidenceV1EvidenceGetGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1972
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1973
|
+
});
|
|
1974
|
+
},
|
|
1921
1975
|
/**
|
|
1922
1976
|
*
|
|
1923
1977
|
* @summary List Company Evidence
|
|
@@ -2009,6 +2063,18 @@ export const EvidenceApiFactory = function (configuration, basePath, axios) {
|
|
|
2009
2063
|
getEvidenceFilesV1EvidenceFileEvidenceFileIdGet(evidenceFileId, authorization, sessionId, options) {
|
|
2010
2064
|
return localVarFp.getEvidenceFilesV1EvidenceFileEvidenceFileIdGet(evidenceFileId, authorization, sessionId, options).then((request) => request(axios, basePath));
|
|
2011
2065
|
},
|
|
2066
|
+
/**
|
|
2067
|
+
*
|
|
2068
|
+
* @summary Get Evidence
|
|
2069
|
+
* @param {string} evidenceId
|
|
2070
|
+
* @param {string} [authorization]
|
|
2071
|
+
* @param {string} [sessionId]
|
|
2072
|
+
* @param {*} [options] Override http request option.
|
|
2073
|
+
* @throws {RequiredError}
|
|
2074
|
+
*/
|
|
2075
|
+
getEvidenceV1EvidenceGetGet(evidenceId, authorization, sessionId, options) {
|
|
2076
|
+
return localVarFp.getEvidenceV1EvidenceGetGet(evidenceId, authorization, sessionId, options).then((request) => request(axios, basePath));
|
|
2077
|
+
},
|
|
2012
2078
|
/**
|
|
2013
2079
|
*
|
|
2014
2080
|
* @summary List Company Evidence
|
|
@@ -2084,6 +2150,19 @@ export class EvidenceApi extends BaseAPI {
|
|
|
2084
2150
|
getEvidenceFilesV1EvidenceFileEvidenceFileIdGet(evidenceFileId, authorization, sessionId, options) {
|
|
2085
2151
|
return EvidenceApiFp(this.configuration).getEvidenceFilesV1EvidenceFileEvidenceFileIdGet(evidenceFileId, authorization, sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
2086
2152
|
}
|
|
2153
|
+
/**
|
|
2154
|
+
*
|
|
2155
|
+
* @summary Get Evidence
|
|
2156
|
+
* @param {string} evidenceId
|
|
2157
|
+
* @param {string} [authorization]
|
|
2158
|
+
* @param {string} [sessionId]
|
|
2159
|
+
* @param {*} [options] Override http request option.
|
|
2160
|
+
* @throws {RequiredError}
|
|
2161
|
+
* @memberof EvidenceApi
|
|
2162
|
+
*/
|
|
2163
|
+
getEvidenceV1EvidenceGetGet(evidenceId, authorization, sessionId, options) {
|
|
2164
|
+
return EvidenceApiFp(this.configuration).getEvidenceV1EvidenceGetGet(evidenceId, authorization, sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
2165
|
+
}
|
|
2087
2166
|
/**
|
|
2088
2167
|
*
|
|
2089
2168
|
* @summary List Company Evidence
|
|
@@ -4020,6 +4099,40 @@ export const TasksApiAxiosParamCreator = function (configuration) {
|
|
|
4020
4099
|
options: localVarRequestOptions,
|
|
4021
4100
|
};
|
|
4022
4101
|
}),
|
|
4102
|
+
/**
|
|
4103
|
+
*
|
|
4104
|
+
* @summary Get Task
|
|
4105
|
+
* @param {string} taskId
|
|
4106
|
+
* @param {string} [authorization]
|
|
4107
|
+
* @param {string} [sessionId]
|
|
4108
|
+
* @param {*} [options] Override http request option.
|
|
4109
|
+
* @throws {RequiredError}
|
|
4110
|
+
*/
|
|
4111
|
+
getTaskV1TasksGetTaskIdGet: (taskId_1, authorization_1, sessionId_1, ...args_1) => __awaiter(this, [taskId_1, authorization_1, sessionId_1, ...args_1], void 0, function* (taskId, authorization, sessionId, options = {}) {
|
|
4112
|
+
// verify required parameter 'taskId' is not null or undefined
|
|
4113
|
+
assertParamExists('getTaskV1TasksGetTaskIdGet', 'taskId', taskId);
|
|
4114
|
+
const localVarPath = `/v1/tasks/get/{task_id}`
|
|
4115
|
+
.replace(`{${"task_id"}}`, encodeURIComponent(String(taskId)));
|
|
4116
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4117
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4118
|
+
let baseOptions;
|
|
4119
|
+
if (configuration) {
|
|
4120
|
+
baseOptions = configuration.baseOptions;
|
|
4121
|
+
}
|
|
4122
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
4123
|
+
const localVarHeaderParameter = {};
|
|
4124
|
+
const localVarQueryParameter = {};
|
|
4125
|
+
if (authorization != null) {
|
|
4126
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
4127
|
+
}
|
|
4128
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4129
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4130
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
4131
|
+
return {
|
|
4132
|
+
url: toPathString(localVarUrlObj),
|
|
4133
|
+
options: localVarRequestOptions,
|
|
4134
|
+
};
|
|
4135
|
+
}),
|
|
4023
4136
|
/**
|
|
4024
4137
|
*
|
|
4025
4138
|
* @summary List Tasks For Company
|
|
@@ -4314,6 +4427,24 @@ export const TasksApiFp = function (configuration) {
|
|
|
4314
4427
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4315
4428
|
});
|
|
4316
4429
|
},
|
|
4430
|
+
/**
|
|
4431
|
+
*
|
|
4432
|
+
* @summary Get Task
|
|
4433
|
+
* @param {string} taskId
|
|
4434
|
+
* @param {string} [authorization]
|
|
4435
|
+
* @param {string} [sessionId]
|
|
4436
|
+
* @param {*} [options] Override http request option.
|
|
4437
|
+
* @throws {RequiredError}
|
|
4438
|
+
*/
|
|
4439
|
+
getTaskV1TasksGetTaskIdGet(taskId, authorization, sessionId, options) {
|
|
4440
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4441
|
+
var _a, _b, _c;
|
|
4442
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getTaskV1TasksGetTaskIdGet(taskId, authorization, sessionId, options);
|
|
4443
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
4444
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['TasksApi.getTaskV1TasksGetTaskIdGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
4445
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4446
|
+
});
|
|
4447
|
+
},
|
|
4317
4448
|
/**
|
|
4318
4449
|
*
|
|
4319
4450
|
* @summary List Tasks For Company
|
|
@@ -4453,6 +4584,18 @@ export const TasksApiFactory = function (configuration, basePath, axios) {
|
|
|
4453
4584
|
deleteTaskV1TasksDelete(deleteTaskSchema, authorization, sessionId, options) {
|
|
4454
4585
|
return localVarFp.deleteTaskV1TasksDelete(deleteTaskSchema, authorization, sessionId, options).then((request) => request(axios, basePath));
|
|
4455
4586
|
},
|
|
4587
|
+
/**
|
|
4588
|
+
*
|
|
4589
|
+
* @summary Get Task
|
|
4590
|
+
* @param {string} taskId
|
|
4591
|
+
* @param {string} [authorization]
|
|
4592
|
+
* @param {string} [sessionId]
|
|
4593
|
+
* @param {*} [options] Override http request option.
|
|
4594
|
+
* @throws {RequiredError}
|
|
4595
|
+
*/
|
|
4596
|
+
getTaskV1TasksGetTaskIdGet(taskId, authorization, sessionId, options) {
|
|
4597
|
+
return localVarFp.getTaskV1TasksGetTaskIdGet(taskId, authorization, sessionId, options).then((request) => request(axios, basePath));
|
|
4598
|
+
},
|
|
4456
4599
|
/**
|
|
4457
4600
|
*
|
|
4458
4601
|
* @summary List Tasks For Company
|
|
@@ -4564,6 +4707,19 @@ export class TasksApi extends BaseAPI {
|
|
|
4564
4707
|
deleteTaskV1TasksDelete(deleteTaskSchema, authorization, sessionId, options) {
|
|
4565
4708
|
return TasksApiFp(this.configuration).deleteTaskV1TasksDelete(deleteTaskSchema, authorization, sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
4566
4709
|
}
|
|
4710
|
+
/**
|
|
4711
|
+
*
|
|
4712
|
+
* @summary Get Task
|
|
4713
|
+
* @param {string} taskId
|
|
4714
|
+
* @param {string} [authorization]
|
|
4715
|
+
* @param {string} [sessionId]
|
|
4716
|
+
* @param {*} [options] Override http request option.
|
|
4717
|
+
* @throws {RequiredError}
|
|
4718
|
+
* @memberof TasksApi
|
|
4719
|
+
*/
|
|
4720
|
+
getTaskV1TasksGetTaskIdGet(taskId, authorization, sessionId, options) {
|
|
4721
|
+
return TasksApiFp(this.configuration).getTaskV1TasksGetTaskIdGet(taskId, authorization, sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
4722
|
+
}
|
|
4567
4723
|
/**
|
|
4568
4724
|
*
|
|
4569
4725
|
* @summary List Tasks For Company
|
package/docs/CompanyApi.md
CHANGED
|
@@ -11,7 +11,7 @@ All URIs are relative to *http://localhost*
|
|
|
11
11
|
|[**updateCompanyV1CompanyUpdatePatch**](#updatecompanyv1companyupdatepatch) | **PATCH** /v1/company/update | Update Company|
|
|
12
12
|
|
|
13
13
|
# **createCompanyV1CompanyCreatePost**
|
|
14
|
-
>
|
|
14
|
+
> SrcDomainsOrganizationSchemasCompanyCompanyInDBBase createCompanyV1CompanyCreatePost(companyCreate)
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
### Example
|
|
@@ -48,7 +48,7 @@ const { status, data } = await apiInstance.createCompanyV1CompanyCreatePost(
|
|
|
48
48
|
|
|
49
49
|
### Return type
|
|
50
50
|
|
|
51
|
-
**
|
|
51
|
+
**SrcDomainsOrganizationSchemasCompanyCompanyInDBBase**
|
|
52
52
|
|
|
53
53
|
### Authorization
|
|
54
54
|
|
|
@@ -243,7 +243,7 @@ No authorization required
|
|
|
243
243
|
[[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)
|
|
244
244
|
|
|
245
245
|
# **updateCompanyV1CompanyUpdatePatch**
|
|
246
|
-
>
|
|
246
|
+
> SrcDomainsOrganizationSchemasCompanyCompanyInDBBase updateCompanyV1CompanyUpdatePatch(companyUpdate)
|
|
247
247
|
|
|
248
248
|
|
|
249
249
|
### Example
|
|
@@ -280,7 +280,7 @@ const { status, data } = await apiInstance.updateCompanyV1CompanyUpdatePatch(
|
|
|
280
280
|
|
|
281
281
|
### Return type
|
|
282
282
|
|
|
283
|
-
**
|
|
283
|
+
**SrcDomainsOrganizationSchemasCompanyCompanyInDBBase**
|
|
284
284
|
|
|
285
285
|
### Authorization
|
|
286
286
|
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# CompanyComplianceInDB
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**framework** | [**ComplianceGoal**](ComplianceGoal.md) | | [default to undefined]
|
|
9
|
+
**target_audit_date** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**total_controls** | **number** | | [optional] [default to 0]
|
|
11
|
+
**completed_controls** | **number** | | [optional] [default to 0]
|
|
12
|
+
**in_progress_controls** | **number** | | [optional] [default to 0]
|
|
13
|
+
**not_started_controls** | **number** | | [optional] [default to 0]
|
|
14
|
+
**failed_controls** | **number** | | [optional] [default to 0]
|
|
15
|
+
**skipped_controls** | **number** | | [optional] [default to 0]
|
|
16
|
+
**pending_review_controls** | **number** | | [optional] [default to 0]
|
|
17
|
+
**id** | **number** | | [default to undefined]
|
|
18
|
+
**company_id** | **string** | | [default to undefined]
|
|
19
|
+
**updated_at** | **string** | | [default to undefined]
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import { CompanyComplianceInDB } from './api';
|
|
25
|
+
|
|
26
|
+
const instance: CompanyComplianceInDB = {
|
|
27
|
+
framework,
|
|
28
|
+
target_audit_date,
|
|
29
|
+
total_controls,
|
|
30
|
+
completed_controls,
|
|
31
|
+
in_progress_controls,
|
|
32
|
+
not_started_controls,
|
|
33
|
+
failed_controls,
|
|
34
|
+
skipped_controls,
|
|
35
|
+
pending_review_controls,
|
|
36
|
+
id,
|
|
37
|
+
company_id,
|
|
38
|
+
updated_at,
|
|
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/CompanyCreate.md
CHANGED
|
@@ -9,15 +9,8 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**industry** | **string** | | [default to undefined]
|
|
10
10
|
**employee_count** | **number** | | [default to undefined]
|
|
11
11
|
**domain** | **string** | | [default to undefined]
|
|
12
|
-
**tools_used** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
13
|
-
**plan** | **string** | | [optional] [default to undefined]
|
|
14
12
|
**status** | **string** | | [optional] [default to undefined]
|
|
15
13
|
**compliance_goal** | [**ComplianceGoal**](ComplianceGoal.md) | | [optional] [default to undefined]
|
|
16
|
-
**readiness_score** | **number** | | [optional] [default to undefined]
|
|
17
|
-
**audit_due_date** | **string** | | [optional] [default to undefined]
|
|
18
|
-
**is_audit_mode** | **boolean** | | [optional] [default to false]
|
|
19
|
-
**timezone** | **string** | | [optional] [default to 'UTC']
|
|
20
|
-
**logo_url** | **string** | | [optional] [default to undefined]
|
|
21
14
|
|
|
22
15
|
## Example
|
|
23
16
|
|
|
@@ -29,15 +22,8 @@ const instance: CompanyCreate = {
|
|
|
29
22
|
industry,
|
|
30
23
|
employee_count,
|
|
31
24
|
domain,
|
|
32
|
-
tools_used,
|
|
33
|
-
plan,
|
|
34
25
|
status,
|
|
35
26
|
compliance_goal,
|
|
36
|
-
readiness_score,
|
|
37
|
-
audit_due_date,
|
|
38
|
-
is_audit_mode,
|
|
39
|
-
timezone,
|
|
40
|
-
logo_url,
|
|
41
27
|
};
|
|
42
28
|
```
|
|
43
29
|
|
package/docs/CompanyUpdate.md
CHANGED
|
@@ -10,13 +10,6 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**industry** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**employee_count** | **number** | | [optional] [default to undefined]
|
|
12
12
|
**domain** | **string** | | [optional] [default to undefined]
|
|
13
|
-
**tools_used** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
14
|
-
**compliance_goal** | [**ComplianceGoal**](ComplianceGoal.md) | | [optional] [default to undefined]
|
|
15
|
-
**readiness_score** | **number** | | [optional] [default to undefined]
|
|
16
|
-
**audit_due_date** | **string** | | [optional] [default to undefined]
|
|
17
|
-
**is_audit_mode** | **boolean** | | [optional] [default to undefined]
|
|
18
|
-
**timezone** | **string** | | [optional] [default to undefined]
|
|
19
|
-
**logo_url** | **string** | | [optional] [default to undefined]
|
|
20
13
|
|
|
21
14
|
## Example
|
|
22
15
|
|
|
@@ -29,13 +22,6 @@ const instance: CompanyUpdate = {
|
|
|
29
22
|
industry,
|
|
30
23
|
employee_count,
|
|
31
24
|
domain,
|
|
32
|
-
tools_used,
|
|
33
|
-
compliance_goal,
|
|
34
|
-
readiness_score,
|
|
35
|
-
audit_due_date,
|
|
36
|
-
is_audit_mode,
|
|
37
|
-
timezone,
|
|
38
|
-
logo_url,
|
|
39
25
|
};
|
|
40
26
|
```
|
|
41
27
|
|
|
@@ -9,15 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**industry** | **string** | | [default to undefined]
|
|
10
10
|
**employee_count** | **number** | | [default to undefined]
|
|
11
11
|
**domain** | **string** | | [default to undefined]
|
|
12
|
-
**tools_used** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
13
|
-
**plan** | **string** | | [optional] [default to undefined]
|
|
14
12
|
**status** | **string** | | [optional] [default to undefined]
|
|
15
|
-
**compliance_goal** | [**ComplianceGoal**](ComplianceGoal.md) | | [optional] [default to undefined]
|
|
16
|
-
**readiness_score** | **number** | | [optional] [default to undefined]
|
|
17
|
-
**audit_due_date** | **string** | | [optional] [default to undefined]
|
|
18
|
-
**is_audit_mode** | **boolean** | | [optional] [default to false]
|
|
19
|
-
**timezone** | **string** | | [optional] [default to 'UTC']
|
|
20
|
-
**logo_url** | **string** | | [optional] [default to undefined]
|
|
21
13
|
**id** | **string** | | [default to undefined]
|
|
22
14
|
**updated_at** | **string** | | [default to undefined]
|
|
23
15
|
**controls** | [**Array<ControlWithEvidences>**](ControlWithEvidences.md) | | [default to undefined]
|
|
@@ -32,15 +24,7 @@ const instance: CompanyWithControls = {
|
|
|
32
24
|
industry,
|
|
33
25
|
employee_count,
|
|
34
26
|
domain,
|
|
35
|
-
tools_used,
|
|
36
|
-
plan,
|
|
37
27
|
status,
|
|
38
|
-
compliance_goal,
|
|
39
|
-
readiness_score,
|
|
40
|
-
audit_due_date,
|
|
41
|
-
is_audit_mode,
|
|
42
|
-
timezone,
|
|
43
|
-
logo_url,
|
|
44
28
|
id,
|
|
45
29
|
updated_at,
|
|
46
30
|
controls,
|
package/docs/CompanyWithRoles.md
CHANGED
|
@@ -9,15 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**industry** | **string** | | [default to undefined]
|
|
10
10
|
**employee_count** | **number** | | [default to undefined]
|
|
11
11
|
**domain** | **string** | | [default to undefined]
|
|
12
|
-
**tools_used** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
13
|
-
**plan** | **string** | | [optional] [default to undefined]
|
|
14
12
|
**status** | **string** | | [optional] [default to undefined]
|
|
15
|
-
**compliance_goal** | [**ComplianceGoal**](ComplianceGoal.md) | | [optional] [default to undefined]
|
|
16
|
-
**readiness_score** | **number** | | [optional] [default to undefined]
|
|
17
|
-
**audit_due_date** | **string** | | [optional] [default to undefined]
|
|
18
|
-
**is_audit_mode** | **boolean** | | [optional] [default to false]
|
|
19
|
-
**timezone** | **string** | | [optional] [default to 'UTC']
|
|
20
|
-
**logo_url** | **string** | | [optional] [default to undefined]
|
|
21
13
|
**id** | **string** | | [default to undefined]
|
|
22
14
|
**updated_at** | **string** | | [default to undefined]
|
|
23
15
|
**permissions** | [**Array<RolesWithUser>**](RolesWithUser.md) | | [default to undefined]
|
|
@@ -32,15 +24,7 @@ const instance: CompanyWithRoles = {
|
|
|
32
24
|
industry,
|
|
33
25
|
employee_count,
|
|
34
26
|
domain,
|
|
35
|
-
tools_used,
|
|
36
|
-
plan,
|
|
37
27
|
status,
|
|
38
|
-
compliance_goal,
|
|
39
|
-
readiness_score,
|
|
40
|
-
audit_due_date,
|
|
41
|
-
is_audit_mode,
|
|
42
|
-
timezone,
|
|
43
|
-
logo_url,
|
|
44
28
|
id,
|
|
45
29
|
updated_at,
|
|
46
30
|
permissions,
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# ControlWithData
|
|
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
|
+
**data** | [**FrameworkControlsBase**](FrameworkControlsBase.md) | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { ControlWithData } from './api';
|
|
18
|
+
|
|
19
|
+
const instance: ControlWithData = {
|
|
20
|
+
id,
|
|
21
|
+
status,
|
|
22
|
+
note,
|
|
23
|
+
updated_at,
|
|
24
|
+
data,
|
|
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)
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**note** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**updated_at** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**data** | [**FrameworkControlsBase**](FrameworkControlsBase.md) | | [default to undefined]
|
|
13
|
-
**company** | [**
|
|
13
|
+
**company** | [**SrcSharedSchemasCompanyCompanyInDBBase**](SrcSharedSchemasCompanyCompanyInDBBase.md) | | [default to undefined]
|
|
14
14
|
**evidences** | [**Array<EvidenceBase>**](EvidenceBase.md) | | [optional] [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# CustomerDBBase
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**billing_name** | **string** | | [default to undefined]
|
|
9
|
+
**billing_email** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { CustomerDBBase } from './api';
|
|
15
|
+
|
|
16
|
+
const instance: CustomerDBBase = {
|
|
17
|
+
billing_name,
|
|
18
|
+
billing_email,
|
|
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/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)
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**items** | [**Array<
|
|
8
|
+
**items** | [**Array<SrcDomainsOrganizationSchemasCompanyCompanyInDBBase>**](SrcDomainsOrganizationSchemasCompanyCompanyInDBBase.md) | | [default to undefined]
|
|
9
9
|
**total** | **number** | | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
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)
|