@rasadov/lumoar-sdk 1.1.8 → 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 +5 -0
- package/api.ts +461 -0
- package/dist/api.d.ts +338 -0
- package/dist/api.js +235 -0
- package/docs/ControlWithData.md +28 -0
- package/docs/Customer.md +24 -0
- package/docs/CustomerDBBase.md +22 -0
- package/docs/EvidenceApi.md +58 -0
- package/docs/EvidenceWithControl.md +42 -0
- package/docs/PaymentsApi.md +58 -0
- package/docs/ResponseGetSubscriptionV1PaymentsSubscriptionGet.md +30 -0
- package/docs/SubscriptionResponse.md +28 -0
- package/docs/TasksApi.md +58 -0
- 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
|
|
@@ -2535,6 +2614,42 @@ export const PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
2535
2614
|
options: localVarRequestOptions,
|
|
2536
2615
|
};
|
|
2537
2616
|
}),
|
|
2617
|
+
/**
|
|
2618
|
+
*
|
|
2619
|
+
* @summary Get Subscription
|
|
2620
|
+
* @param {string} companyId
|
|
2621
|
+
* @param {string} [authorization]
|
|
2622
|
+
* @param {string} [sessionId]
|
|
2623
|
+
* @param {*} [options] Override http request option.
|
|
2624
|
+
* @throws {RequiredError}
|
|
2625
|
+
*/
|
|
2626
|
+
getSubscriptionV1PaymentsSubscriptionGet: (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 = {}) {
|
|
2627
|
+
// verify required parameter 'companyId' is not null or undefined
|
|
2628
|
+
assertParamExists('getSubscriptionV1PaymentsSubscriptionGet', 'companyId', companyId);
|
|
2629
|
+
const localVarPath = `/v1/payments/subscription`;
|
|
2630
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2631
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2632
|
+
let baseOptions;
|
|
2633
|
+
if (configuration) {
|
|
2634
|
+
baseOptions = configuration.baseOptions;
|
|
2635
|
+
}
|
|
2636
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2637
|
+
const localVarHeaderParameter = {};
|
|
2638
|
+
const localVarQueryParameter = {};
|
|
2639
|
+
if (companyId !== undefined) {
|
|
2640
|
+
localVarQueryParameter['company_id'] = companyId;
|
|
2641
|
+
}
|
|
2642
|
+
if (authorization != null) {
|
|
2643
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
2644
|
+
}
|
|
2645
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2646
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2647
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2648
|
+
return {
|
|
2649
|
+
url: toPathString(localVarUrlObj),
|
|
2650
|
+
options: localVarRequestOptions,
|
|
2651
|
+
};
|
|
2652
|
+
}),
|
|
2538
2653
|
/**
|
|
2539
2654
|
*
|
|
2540
2655
|
* @summary Webhook
|
|
@@ -2605,6 +2720,24 @@ export const PaymentsApiFp = function (configuration) {
|
|
|
2605
2720
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2606
2721
|
});
|
|
2607
2722
|
},
|
|
2723
|
+
/**
|
|
2724
|
+
*
|
|
2725
|
+
* @summary Get Subscription
|
|
2726
|
+
* @param {string} companyId
|
|
2727
|
+
* @param {string} [authorization]
|
|
2728
|
+
* @param {string} [sessionId]
|
|
2729
|
+
* @param {*} [options] Override http request option.
|
|
2730
|
+
* @throws {RequiredError}
|
|
2731
|
+
*/
|
|
2732
|
+
getSubscriptionV1PaymentsSubscriptionGet(companyId, authorization, sessionId, options) {
|
|
2733
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2734
|
+
var _a, _b, _c;
|
|
2735
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSubscriptionV1PaymentsSubscriptionGet(companyId, authorization, sessionId, options);
|
|
2736
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2737
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PaymentsApi.getSubscriptionV1PaymentsSubscriptionGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2738
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2739
|
+
});
|
|
2740
|
+
},
|
|
2608
2741
|
/**
|
|
2609
2742
|
*
|
|
2610
2743
|
* @summary Webhook
|
|
@@ -2653,6 +2786,18 @@ export const PaymentsApiFactory = function (configuration, basePath, axios) {
|
|
|
2653
2786
|
getCustomerManagementSessionV1PaymentsCustomerManagementGet(authorization, sessionId, options) {
|
|
2654
2787
|
return localVarFp.getCustomerManagementSessionV1PaymentsCustomerManagementGet(authorization, sessionId, options).then((request) => request(axios, basePath));
|
|
2655
2788
|
},
|
|
2789
|
+
/**
|
|
2790
|
+
*
|
|
2791
|
+
* @summary Get Subscription
|
|
2792
|
+
* @param {string} companyId
|
|
2793
|
+
* @param {string} [authorization]
|
|
2794
|
+
* @param {string} [sessionId]
|
|
2795
|
+
* @param {*} [options] Override http request option.
|
|
2796
|
+
* @throws {RequiredError}
|
|
2797
|
+
*/
|
|
2798
|
+
getSubscriptionV1PaymentsSubscriptionGet(companyId, authorization, sessionId, options) {
|
|
2799
|
+
return localVarFp.getSubscriptionV1PaymentsSubscriptionGet(companyId, authorization, sessionId, options).then((request) => request(axios, basePath));
|
|
2800
|
+
},
|
|
2656
2801
|
/**
|
|
2657
2802
|
*
|
|
2658
2803
|
* @summary Webhook
|
|
@@ -2697,6 +2842,19 @@ export class PaymentsApi extends BaseAPI {
|
|
|
2697
2842
|
getCustomerManagementSessionV1PaymentsCustomerManagementGet(authorization, sessionId, options) {
|
|
2698
2843
|
return PaymentsApiFp(this.configuration).getCustomerManagementSessionV1PaymentsCustomerManagementGet(authorization, sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
2699
2844
|
}
|
|
2845
|
+
/**
|
|
2846
|
+
*
|
|
2847
|
+
* @summary Get Subscription
|
|
2848
|
+
* @param {string} companyId
|
|
2849
|
+
* @param {string} [authorization]
|
|
2850
|
+
* @param {string} [sessionId]
|
|
2851
|
+
* @param {*} [options] Override http request option.
|
|
2852
|
+
* @throws {RequiredError}
|
|
2853
|
+
* @memberof PaymentsApi
|
|
2854
|
+
*/
|
|
2855
|
+
getSubscriptionV1PaymentsSubscriptionGet(companyId, authorization, sessionId, options) {
|
|
2856
|
+
return PaymentsApiFp(this.configuration).getSubscriptionV1PaymentsSubscriptionGet(companyId, authorization, sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
2857
|
+
}
|
|
2700
2858
|
/**
|
|
2701
2859
|
*
|
|
2702
2860
|
* @summary Webhook
|
|
@@ -3941,6 +4099,40 @@ export const TasksApiAxiosParamCreator = function (configuration) {
|
|
|
3941
4099
|
options: localVarRequestOptions,
|
|
3942
4100
|
};
|
|
3943
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
|
+
}),
|
|
3944
4136
|
/**
|
|
3945
4137
|
*
|
|
3946
4138
|
* @summary List Tasks For Company
|
|
@@ -4235,6 +4427,24 @@ export const TasksApiFp = function (configuration) {
|
|
|
4235
4427
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4236
4428
|
});
|
|
4237
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
|
+
},
|
|
4238
4448
|
/**
|
|
4239
4449
|
*
|
|
4240
4450
|
* @summary List Tasks For Company
|
|
@@ -4374,6 +4584,18 @@ export const TasksApiFactory = function (configuration, basePath, axios) {
|
|
|
4374
4584
|
deleteTaskV1TasksDelete(deleteTaskSchema, authorization, sessionId, options) {
|
|
4375
4585
|
return localVarFp.deleteTaskV1TasksDelete(deleteTaskSchema, authorization, sessionId, options).then((request) => request(axios, basePath));
|
|
4376
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
|
+
},
|
|
4377
4599
|
/**
|
|
4378
4600
|
*
|
|
4379
4601
|
* @summary List Tasks For Company
|
|
@@ -4485,6 +4707,19 @@ export class TasksApi extends BaseAPI {
|
|
|
4485
4707
|
deleteTaskV1TasksDelete(deleteTaskSchema, authorization, sessionId, options) {
|
|
4486
4708
|
return TasksApiFp(this.configuration).deleteTaskV1TasksDelete(deleteTaskSchema, authorization, sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
4487
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
|
+
}
|
|
4488
4723
|
/**
|
|
4489
4724
|
*
|
|
4490
4725
|
* @summary List Tasks For Company
|
|
@@ -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)
|
package/docs/Customer.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Customer
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**customer_id** | **string** | | [default to undefined]
|
|
9
|
+
**name** | **string** | | [default to undefined]
|
|
10
|
+
**email** | **string** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { Customer } from './api';
|
|
16
|
+
|
|
17
|
+
const instance: Customer = {
|
|
18
|
+
customer_id,
|
|
19
|
+
name,
|
|
20
|
+
email,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[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
|
+
# 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)
|
package/docs/PaymentsApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *http://localhost*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getCheckoutSessionV1PaymentsCheckoutGet**](#getcheckoutsessionv1paymentscheckoutget) | **GET** /v1/payments/checkout | Get Checkout Session|
|
|
8
8
|
|[**getCustomerManagementSessionV1PaymentsCustomerManagementGet**](#getcustomermanagementsessionv1paymentscustomermanagementget) | **GET** /v1/payments/customer/management | Get Customer Management Session|
|
|
9
|
+
|[**getSubscriptionV1PaymentsSubscriptionGet**](#getsubscriptionv1paymentssubscriptionget) | **GET** /v1/payments/subscription | Get Subscription|
|
|
9
10
|
|[**webhookV1PaymentsWebhookPost**](#webhookv1paymentswebhookpost) | **POST** /v1/payments/webhook | Webhook|
|
|
10
11
|
|
|
11
12
|
# **getCheckoutSessionV1PaymentsCheckoutGet**
|
|
@@ -114,6 +115,63 @@ No authorization required
|
|
|
114
115
|
- **Accept**: application/json
|
|
115
116
|
|
|
116
117
|
|
|
118
|
+
### HTTP response details
|
|
119
|
+
| Status code | Description | Response headers |
|
|
120
|
+
|-------------|-------------|------------------|
|
|
121
|
+
|**200** | Successful Response | - |
|
|
122
|
+
|**422** | Validation Error | - |
|
|
123
|
+
|
|
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
|
+
|
|
126
|
+
# **getSubscriptionV1PaymentsSubscriptionGet**
|
|
127
|
+
> ResponseGetSubscriptionV1PaymentsSubscriptionGet getSubscriptionV1PaymentsSubscriptionGet()
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
### Example
|
|
131
|
+
|
|
132
|
+
```typescript
|
|
133
|
+
import {
|
|
134
|
+
PaymentsApi,
|
|
135
|
+
Configuration
|
|
136
|
+
} from './api';
|
|
137
|
+
|
|
138
|
+
const configuration = new Configuration();
|
|
139
|
+
const apiInstance = new PaymentsApi(configuration);
|
|
140
|
+
|
|
141
|
+
let companyId: string; // (default to undefined)
|
|
142
|
+
let authorization: string; // (optional) (default to undefined)
|
|
143
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
144
|
+
|
|
145
|
+
const { status, data } = await apiInstance.getSubscriptionV1PaymentsSubscriptionGet(
|
|
146
|
+
companyId,
|
|
147
|
+
authorization,
|
|
148
|
+
sessionId
|
|
149
|
+
);
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Parameters
|
|
153
|
+
|
|
154
|
+
|Name | Type | Description | Notes|
|
|
155
|
+
|------------- | ------------- | ------------- | -------------|
|
|
156
|
+
| **companyId** | [**string**] | | defaults to undefined|
|
|
157
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
158
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
### Return type
|
|
162
|
+
|
|
163
|
+
**ResponseGetSubscriptionV1PaymentsSubscriptionGet**
|
|
164
|
+
|
|
165
|
+
### Authorization
|
|
166
|
+
|
|
167
|
+
No authorization required
|
|
168
|
+
|
|
169
|
+
### HTTP request headers
|
|
170
|
+
|
|
171
|
+
- **Content-Type**: Not defined
|
|
172
|
+
- **Accept**: application/json
|
|
173
|
+
|
|
174
|
+
|
|
117
175
|
### HTTP response details
|
|
118
176
|
| Status code | Description | Response headers |
|
|
119
177
|
|-------------|-------------|------------------|
|
|
@@ -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)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# SubscriptionResponse
|
|
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
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { SubscriptionResponse } from './api';
|
|
18
|
+
|
|
19
|
+
const instance: SubscriptionResponse = {
|
|
20
|
+
subscription_id,
|
|
21
|
+
status,
|
|
22
|
+
product_id,
|
|
23
|
+
customer,
|
|
24
|
+
subscribed_till,
|
|
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)
|