@rasadov/lumoar-sdk 1.0.6 → 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.
@@ -18,6 +18,7 @@ docs/CompanyUpdate.md
18
18
  docs/CompanyWithControls.md
19
19
  docs/CompanyWithRoles.md
20
20
  docs/ComplianceGoal.md
21
+ docs/ControlBase.md
21
22
  docs/ControlStatus.md
22
23
  docs/ControlWithEvidences.md
23
24
  docs/ControlWithRelationships.md
package/README.md ADDED
@@ -0,0 +1,25 @@
1
+ # Lumoar SDK
2
+
3
+ ## Installation
4
+
5
+ ```bash
6
+ npm install @rasadov/lumoar-sdk
7
+ ```
8
+
9
+ ## Usage
10
+
11
+ ```typescript
12
+ import { ApiSDK } from '@rasadov/lumoar-sdk';
13
+
14
+ const api = new ApiSDK();
15
+ api.getCompaniesV1CompanyListGet();
16
+ ```
17
+
18
+ ## Generate SDK
19
+
20
+ ```bash
21
+ openapi-generator-cli generate -i http://localhost:8000/openapi.json -g typescript-axios -o .
22
+ ```
23
+
24
+ ## License
25
+ ISC
package/api.ts CHANGED
@@ -93,19 +93,19 @@ export interface AuditLogSchema {
93
93
  * @type {string}
94
94
  * @memberof AuditLogSchema
95
95
  */
96
- 'entity_name': string;
96
+ 'timestamp': string;
97
97
  /**
98
98
  *
99
- * @type {string}
99
+ * @type {{ [key: string]: any; }}
100
100
  * @memberof AuditLogSchema
101
101
  */
102
- 'timestamp': string;
102
+ 'details': { [key: string]: any; } | null;
103
103
  /**
104
104
  *
105
- * @type {{ [key: string]: any; }}
105
+ * @type {UserBase}
106
106
  * @memberof AuditLogSchema
107
107
  */
108
- 'details': { [key: string]: any; } | null;
108
+ 'user': UserBase;
109
109
  }
110
110
 
111
111
 
@@ -645,6 +645,37 @@ export const ComplianceGoal = {
645
645
  export type ComplianceGoal = typeof ComplianceGoal[keyof typeof ComplianceGoal];
646
646
 
647
647
 
648
+ /**
649
+ *
650
+ * @export
651
+ * @interface ControlBase
652
+ */
653
+ export interface ControlBase {
654
+ /**
655
+ *
656
+ * @type {string}
657
+ * @memberof ControlBase
658
+ */
659
+ 'id': string;
660
+ /**
661
+ *
662
+ * @type {string}
663
+ * @memberof ControlBase
664
+ */
665
+ 'status'?: string | null;
666
+ /**
667
+ *
668
+ * @type {string}
669
+ * @memberof ControlBase
670
+ */
671
+ 'note'?: string | null;
672
+ /**
673
+ *
674
+ * @type {string}
675
+ * @memberof ControlBase
676
+ */
677
+ 'updated_at'?: string | null;
678
+ }
648
679
  /**
649
680
  *
650
681
  * @export
@@ -675,12 +706,6 @@ export interface ControlWithEvidences {
675
706
  * @memberof ControlWithEvidences
676
707
  */
677
708
  'id': string;
678
- /**
679
- *
680
- * @type {FrameworkControlsBase}
681
- * @memberof ControlWithEvidences
682
- */
683
- 'framework_control': FrameworkControlsBase;
684
709
  /**
685
710
  *
686
711
  * @type {string}
@@ -699,6 +724,12 @@ export interface ControlWithEvidences {
699
724
  * @memberof ControlWithEvidences
700
725
  */
701
726
  'updated_at'?: string | null;
727
+ /**
728
+ *
729
+ * @type {FrameworkControlsBase}
730
+ * @memberof ControlWithEvidences
731
+ */
732
+ 'data': FrameworkControlsBase;
702
733
  /**
703
734
  *
704
735
  * @type {Array<EvidenceBase>}
@@ -718,12 +749,6 @@ export interface ControlWithRelationships {
718
749
  * @memberof ControlWithRelationships
719
750
  */
720
751
  'id': string;
721
- /**
722
- *
723
- * @type {FrameworkControlsBase}
724
- * @memberof ControlWithRelationships
725
- */
726
- 'framework_control': FrameworkControlsBase;
727
752
  /**
728
753
  *
729
754
  * @type {string}
@@ -742,6 +767,12 @@ export interface ControlWithRelationships {
742
767
  * @memberof ControlWithRelationships
743
768
  */
744
769
  'updated_at'?: string | null;
770
+ /**
771
+ *
772
+ * @type {FrameworkControlsBase}
773
+ * @memberof ControlWithRelationships
774
+ */
775
+ 'data': FrameworkControlsBase;
745
776
  /**
746
777
  *
747
778
  * @type {CompanyInDBBase}
@@ -1384,7 +1415,7 @@ export interface UpdateControlSchema {
1384
1415
  * @type {ControlStatus}
1385
1416
  * @memberof UpdateControlSchema
1386
1417
  */
1387
- 'status'?: ControlStatus | null;
1418
+ 'status': ControlStatus;
1388
1419
  /**
1389
1420
  *
1390
1421
  * @type {string}
@@ -3155,7 +3186,7 @@ export const ControlsApiFp = function(configuration?: Configuration) {
3155
3186
  * @param {*} [options] Override http request option.
3156
3187
  * @throws {RequiredError}
3157
3188
  */
3158
- async updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetControl>> {
3189
+ async updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ControlBase>> {
3159
3190
  const localVarAxiosArgs = await localVarAxiosParamCreator.updateControlV1ControlsUpdatePatch(updateControlSchema, authorization, sessionId, options);
3160
3191
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3161
3192
  const localVarOperationServerBasePath = operationServerMap['ControlsApi.updateControlV1ControlsUpdatePatch']?.[localVarOperationServerIndex]?.url;
@@ -3192,7 +3223,7 @@ export const ControlsApiFactory = function (configuration?: Configuration, baseP
3192
3223
  * @param {*} [options] Override http request option.
3193
3224
  * @throws {RequiredError}
3194
3225
  */
3195
- updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetControl> {
3226
+ updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<ControlBase> {
3196
3227
  return localVarFp.updateControlV1ControlsUpdatePatch(updateControlSchema, authorization, sessionId, options).then((request) => request(axios, basePath));
3197
3228
  },
3198
3229
  };
package/dist/api.d.ts CHANGED
@@ -70,12 +70,6 @@ export interface AuditLogSchema {
70
70
  * @memberof AuditLogSchema
71
71
  */
72
72
  'entity_id': string;
73
- /**
74
- *
75
- * @type {string}
76
- * @memberof AuditLogSchema
77
- */
78
- 'entity_name': string;
79
73
  /**
80
74
  *
81
75
  * @type {string}
@@ -90,6 +84,12 @@ export interface AuditLogSchema {
90
84
  'details': {
91
85
  [key: string]: any;
92
86
  } | null;
87
+ /**
88
+ *
89
+ * @type {UserBase}
90
+ * @memberof AuditLogSchema
91
+ */
92
+ 'user': UserBase;
93
93
  }
94
94
  /**
95
95
  * Authentication success response schema. Attributes: - access_token: str - token_type: str - user_id: str - role: str
@@ -624,6 +624,37 @@ export declare const ComplianceGoal: {
624
624
  readonly Soc2: "SOC2";
625
625
  };
626
626
  export type ComplianceGoal = typeof ComplianceGoal[keyof typeof ComplianceGoal];
627
+ /**
628
+ *
629
+ * @export
630
+ * @interface ControlBase
631
+ */
632
+ export interface ControlBase {
633
+ /**
634
+ *
635
+ * @type {string}
636
+ * @memberof ControlBase
637
+ */
638
+ 'id': string;
639
+ /**
640
+ *
641
+ * @type {string}
642
+ * @memberof ControlBase
643
+ */
644
+ 'status'?: string | null;
645
+ /**
646
+ *
647
+ * @type {string}
648
+ * @memberof ControlBase
649
+ */
650
+ 'note'?: string | null;
651
+ /**
652
+ *
653
+ * @type {string}
654
+ * @memberof ControlBase
655
+ */
656
+ 'updated_at'?: string | null;
657
+ }
627
658
  /**
628
659
  *
629
660
  * @export
@@ -650,12 +681,6 @@ export interface ControlWithEvidences {
650
681
  * @memberof ControlWithEvidences
651
682
  */
652
683
  'id': string;
653
- /**
654
- *
655
- * @type {FrameworkControlsBase}
656
- * @memberof ControlWithEvidences
657
- */
658
- 'framework_control': FrameworkControlsBase;
659
684
  /**
660
685
  *
661
686
  * @type {string}
@@ -674,6 +699,12 @@ export interface ControlWithEvidences {
674
699
  * @memberof ControlWithEvidences
675
700
  */
676
701
  'updated_at'?: string | null;
702
+ /**
703
+ *
704
+ * @type {FrameworkControlsBase}
705
+ * @memberof ControlWithEvidences
706
+ */
707
+ 'data': FrameworkControlsBase;
677
708
  /**
678
709
  *
679
710
  * @type {Array<EvidenceBase>}
@@ -693,12 +724,6 @@ export interface ControlWithRelationships {
693
724
  * @memberof ControlWithRelationships
694
725
  */
695
726
  'id': string;
696
- /**
697
- *
698
- * @type {FrameworkControlsBase}
699
- * @memberof ControlWithRelationships
700
- */
701
- 'framework_control': FrameworkControlsBase;
702
727
  /**
703
728
  *
704
729
  * @type {string}
@@ -717,6 +742,12 @@ export interface ControlWithRelationships {
717
742
  * @memberof ControlWithRelationships
718
743
  */
719
744
  'updated_at'?: string | null;
745
+ /**
746
+ *
747
+ * @type {FrameworkControlsBase}
748
+ * @memberof ControlWithRelationships
749
+ */
750
+ 'data': FrameworkControlsBase;
720
751
  /**
721
752
  *
722
753
  * @type {CompanyInDBBase}
@@ -1358,7 +1389,7 @@ export interface UpdateControlSchema {
1358
1389
  * @type {ControlStatus}
1359
1390
  * @memberof UpdateControlSchema
1360
1391
  */
1361
- 'status'?: ControlStatus | null;
1392
+ 'status': ControlStatus;
1362
1393
  /**
1363
1394
  *
1364
1395
  * @type {string}
@@ -2361,7 +2392,7 @@ export declare const ControlsApiFp: (configuration?: Configuration) => {
2361
2392
  * @param {*} [options] Override http request option.
2362
2393
  * @throws {RequiredError}
2363
2394
  */
2364
- updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetControl>>;
2395
+ updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ControlBase>>;
2365
2396
  };
2366
2397
  /**
2367
2398
  * ControlsApi - factory interface
@@ -2387,7 +2418,7 @@ export declare const ControlsApiFactory: (configuration?: Configuration, basePat
2387
2418
  * @param {*} [options] Override http request option.
2388
2419
  * @throws {RequiredError}
2389
2420
  */
2390
- updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetControl>;
2421
+ updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<ControlBase>;
2391
2422
  };
2392
2423
  /**
2393
2424
  * ControlsApi - object-oriented interface
@@ -2417,7 +2448,7 @@ export declare class ControlsApi extends BaseAPI {
2417
2448
  * @throws {RequiredError}
2418
2449
  * @memberof ControlsApi
2419
2450
  */
2420
- updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetControl, any, {}>>;
2451
+ updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ControlBase, any, {}>>;
2421
2452
  }
2422
2453
  /**
2423
2454
  * EvidenceApi - axios parameter creator
@@ -9,9 +9,9 @@ Name | Type | Description | Notes
9
9
  **action** | [**AuditLogAction**](AuditLogAction.md) | | [default to undefined]
10
10
  **entity_type** | [**AuditLogEntity**](AuditLogEntity.md) | | [default to undefined]
11
11
  **entity_id** | **string** | | [default to undefined]
12
- **entity_name** | **string** | | [default to undefined]
13
12
  **timestamp** | **string** | | [default to undefined]
14
13
  **details** | **{ [key: string]: any; }** | | [default to undefined]
14
+ **user** | [**UserBase**](UserBase.md) | | [default to undefined]
15
15
 
16
16
  ## Example
17
17
 
@@ -23,9 +23,9 @@ const instance: AuditLogSchema = {
23
23
  action,
24
24
  entity_type,
25
25
  entity_id,
26
- entity_name,
27
26
  timestamp,
28
27
  details,
28
+ user,
29
29
  };
30
30
  ```
31
31
 
@@ -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&lt;EvidenceBase&gt;**](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&lt;EvidenceBase&gt;**](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
  };
@@ -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
- > GetControl updateControlV1ControlsUpdatePatch(updateControlSchema)
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
- **GetControl**
105
+ **ControlBase**
106
106
 
107
107
  ### Authorization
108
108
 
@@ -6,7 +6,7 @@
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **id** | **string** | | [default to undefined]
9
- **status** | [**ControlStatus**](ControlStatus.md) | | [optional] [default to undefined]
9
+ **status** | [**ControlStatus**](ControlStatus.md) | | [default to undefined]
10
10
  **note** | **string** | | [optional] [default to undefined]
11
11
 
12
12
  ## Example
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "openapi-generator-cli": "^1.0.0"
5
5
  },
6
6
  "name": "@rasadov/lumoar-sdk",
7
- "version": "1.0.6",
7
+ "version": "1.0.7",
8
8
  "description": "Lumoar API SDK",
9
9
  "main": "dist/index.js",
10
10
  "directories": {