@rasadov/lumoar-sdk 1.2.0 → 1.2.2
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 +2 -3
- package/api.ts +198 -158
- package/dist/api.d.ts +158 -152
- package/dist/api.js +84 -15
- package/docs/AuthenticationSuccess.md +2 -2
- package/docs/CompanyApi.md +4 -4
- package/docs/CompanyInDBBase.md +2 -16
- package/docs/CompanyWithControls.md +2 -0
- package/docs/CompanyWithRoles.md +2 -0
- package/docs/ControlWithRelationships.md +1 -1
- package/docs/PaginationResponseCompanyInDBBase.md +1 -1
- package/docs/UserApi.md +61 -7
- package/docs/UserAuth.md +26 -0
- package/docs/UserPermissionsWithCompany.md +1 -1
- package/package.json +1 -1
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
|
+
> CompanyInDBBase 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
|
+
**CompanyInDBBase**
|
|
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
|
+
> CompanyInDBBase 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
|
+
**CompanyInDBBase**
|
|
284
284
|
|
|
285
285
|
### Authorization
|
|
286
286
|
|
package/docs/CompanyInDBBase.md
CHANGED
|
@@ -9,17 +9,10 @@ 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]
|
|
15
|
+
**compliance** | [**CompanyComplianceInDB**](CompanyComplianceInDB.md) | | [optional] [default to undefined]
|
|
23
16
|
|
|
24
17
|
## Example
|
|
25
18
|
|
|
@@ -31,17 +24,10 @@ const instance: CompanyInDBBase = {
|
|
|
31
24
|
industry,
|
|
32
25
|
employee_count,
|
|
33
26
|
domain,
|
|
34
|
-
tools_used,
|
|
35
|
-
plan,
|
|
36
27
|
status,
|
|
37
|
-
compliance_goal,
|
|
38
|
-
readiness_score,
|
|
39
|
-
audit_due_date,
|
|
40
|
-
is_audit_mode,
|
|
41
|
-
timezone,
|
|
42
|
-
logo_url,
|
|
43
28
|
id,
|
|
44
29
|
updated_at,
|
|
30
|
+
compliance,
|
|
45
31
|
};
|
|
46
32
|
```
|
|
47
33
|
|
|
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**status** | **string** | | [optional] [default to undefined]
|
|
13
13
|
**id** | **string** | | [default to undefined]
|
|
14
14
|
**updated_at** | **string** | | [default to undefined]
|
|
15
|
+
**compliance** | [**CompanyComplianceInDB**](CompanyComplianceInDB.md) | | [optional] [default to undefined]
|
|
15
16
|
**controls** | [**Array<ControlWithEvidences>**](ControlWithEvidences.md) | | [default to undefined]
|
|
16
17
|
|
|
17
18
|
## Example
|
|
@@ -27,6 +28,7 @@ const instance: CompanyWithControls = {
|
|
|
27
28
|
status,
|
|
28
29
|
id,
|
|
29
30
|
updated_at,
|
|
31
|
+
compliance,
|
|
30
32
|
controls,
|
|
31
33
|
};
|
|
32
34
|
```
|
package/docs/CompanyWithRoles.md
CHANGED
|
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**status** | **string** | | [optional] [default to undefined]
|
|
13
13
|
**id** | **string** | | [default to undefined]
|
|
14
14
|
**updated_at** | **string** | | [default to undefined]
|
|
15
|
+
**compliance** | [**CompanyComplianceInDB**](CompanyComplianceInDB.md) | | [optional] [default to undefined]
|
|
15
16
|
**permissions** | [**Array<RolesWithUser>**](RolesWithUser.md) | | [default to undefined]
|
|
16
17
|
|
|
17
18
|
## Example
|
|
@@ -27,6 +28,7 @@ const instance: CompanyWithRoles = {
|
|
|
27
28
|
status,
|
|
28
29
|
id,
|
|
29
30
|
updated_at,
|
|
31
|
+
compliance,
|
|
30
32
|
permissions,
|
|
31
33
|
};
|
|
32
34
|
```
|
|
@@ -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** | [**CompanyInDBBase**](CompanyInDBBase.md) | | [default to undefined]
|
|
14
14
|
**evidences** | [**Array<EvidenceBase>**](EvidenceBase.md) | | [optional] [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**items** | [**Array<
|
|
8
|
+
**items** | [**Array<CompanyInDBBase>**](CompanyInDBBase.md) | | [default to undefined]
|
|
9
9
|
**total** | **number** | | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
package/docs/UserApi.md
CHANGED
|
@@ -9,6 +9,7 @@ All URIs are relative to *http://localhost*
|
|
|
9
9
|
|[**forgotPasswordV1UserForgotPasswordPost**](#forgotpasswordv1userforgotpasswordpost) | **POST** /v1/user/forgot-password | Forgot Password|
|
|
10
10
|
|[**getUserDashV1UserMeDashGet**](#getuserdashv1usermedashget) | **GET** /v1/user/me/dash | Get User Dash|
|
|
11
11
|
|[**getUserV1UserMeGet**](#getuserv1usermeget) | **GET** /v1/user/me | Get User|
|
|
12
|
+
|[**resendOtpByEmailV1UserResendOtpEmailPost**](#resendotpbyemailv1userresendotpemailpost) | **POST** /v1/user/resend-otp/{email} | Resend Otp By Email|
|
|
12
13
|
|[**resendOtpV1UserResendOtpPost**](#resendotpv1userresendotppost) | **POST** /v1/user/resend-otp | Resend Otp|
|
|
13
14
|
|[**resetPasswordV1UserResetPasswordPost**](#resetpasswordv1userresetpasswordpost) | **POST** /v1/user/reset-password | Reset Password|
|
|
14
15
|
|[**sendVerificationEmailV1UserSendVerificationEmailPost**](#sendverificationemailv1usersendverificationemailpost) | **POST** /v1/user/send-verification-email | Send Verification Email|
|
|
@@ -267,6 +268,57 @@ No authorization required
|
|
|
267
268
|
- **Accept**: application/json
|
|
268
269
|
|
|
269
270
|
|
|
271
|
+
### HTTP response details
|
|
272
|
+
| Status code | Description | Response headers |
|
|
273
|
+
|-------------|-------------|------------------|
|
|
274
|
+
|**200** | Successful Response | - |
|
|
275
|
+
|**422** | Validation Error | - |
|
|
276
|
+
|
|
277
|
+
[[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)
|
|
278
|
+
|
|
279
|
+
# **resendOtpByEmailV1UserResendOtpEmailPost**
|
|
280
|
+
> Details resendOtpByEmailV1UserResendOtpEmailPost()
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
### Example
|
|
284
|
+
|
|
285
|
+
```typescript
|
|
286
|
+
import {
|
|
287
|
+
UserApi,
|
|
288
|
+
Configuration
|
|
289
|
+
} from './api';
|
|
290
|
+
|
|
291
|
+
const configuration = new Configuration();
|
|
292
|
+
const apiInstance = new UserApi(configuration);
|
|
293
|
+
|
|
294
|
+
let email: string; // (default to undefined)
|
|
295
|
+
|
|
296
|
+
const { status, data } = await apiInstance.resendOtpByEmailV1UserResendOtpEmailPost(
|
|
297
|
+
email
|
|
298
|
+
);
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### Parameters
|
|
302
|
+
|
|
303
|
+
|Name | Type | Description | Notes|
|
|
304
|
+
|------------- | ------------- | ------------- | -------------|
|
|
305
|
+
| **email** | [**string**] | | defaults to undefined|
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
### Return type
|
|
309
|
+
|
|
310
|
+
**Details**
|
|
311
|
+
|
|
312
|
+
### Authorization
|
|
313
|
+
|
|
314
|
+
No authorization required
|
|
315
|
+
|
|
316
|
+
### HTTP request headers
|
|
317
|
+
|
|
318
|
+
- **Content-Type**: Not defined
|
|
319
|
+
- **Accept**: application/json
|
|
320
|
+
|
|
321
|
+
|
|
270
322
|
### HTTP response details
|
|
271
323
|
| Status code | Description | Response headers |
|
|
272
324
|
|-------------|-------------|------------------|
|
|
@@ -276,7 +328,7 @@ No authorization required
|
|
|
276
328
|
[[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)
|
|
277
329
|
|
|
278
330
|
# **resendOtpV1UserResendOtpPost**
|
|
279
|
-
> Details resendOtpV1UserResendOtpPost(
|
|
331
|
+
> Details resendOtpV1UserResendOtpPost()
|
|
280
332
|
|
|
281
333
|
|
|
282
334
|
### Example
|
|
@@ -284,17 +336,18 @@ No authorization required
|
|
|
284
336
|
```typescript
|
|
285
337
|
import {
|
|
286
338
|
UserApi,
|
|
287
|
-
Configuration
|
|
288
|
-
ResendOTPSchema
|
|
339
|
+
Configuration
|
|
289
340
|
} from './api';
|
|
290
341
|
|
|
291
342
|
const configuration = new Configuration();
|
|
292
343
|
const apiInstance = new UserApi(configuration);
|
|
293
344
|
|
|
294
|
-
let
|
|
345
|
+
let authorization: string; // (optional) (default to undefined)
|
|
346
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
295
347
|
|
|
296
348
|
const { status, data } = await apiInstance.resendOtpV1UserResendOtpPost(
|
|
297
|
-
|
|
349
|
+
authorization,
|
|
350
|
+
sessionId
|
|
298
351
|
);
|
|
299
352
|
```
|
|
300
353
|
|
|
@@ -302,7 +355,8 @@ const { status, data } = await apiInstance.resendOtpV1UserResendOtpPost(
|
|
|
302
355
|
|
|
303
356
|
|Name | Type | Description | Notes|
|
|
304
357
|
|------------- | ------------- | ------------- | -------------|
|
|
305
|
-
| **
|
|
358
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
359
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
306
360
|
|
|
307
361
|
|
|
308
362
|
### Return type
|
|
@@ -315,7 +369,7 @@ No authorization required
|
|
|
315
369
|
|
|
316
370
|
### HTTP request headers
|
|
317
371
|
|
|
318
|
-
- **Content-Type**:
|
|
372
|
+
- **Content-Type**: Not defined
|
|
319
373
|
- **Accept**: application/json
|
|
320
374
|
|
|
321
375
|
|
package/docs/UserAuth.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UserAuth
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | | [default to undefined]
|
|
9
|
+
**email** | **string** | | [default to undefined]
|
|
10
|
+
**role** | **string** | | [default to undefined]
|
|
11
|
+
**email_confirmed** | **boolean** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { UserAuth } from './api';
|
|
17
|
+
|
|
18
|
+
const instance: UserAuth = {
|
|
19
|
+
name,
|
|
20
|
+
email,
|
|
21
|
+
role,
|
|
22
|
+
email_confirmed,
|
|
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,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**role** | **string** | | [default to undefined]
|
|
9
|
-
**company** | [**
|
|
9
|
+
**company** | [**CompanyInDBBase**](CompanyInDBBase.md) | | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|