@rasadov/lumoar-sdk 1.0.4 → 1.0.6

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.
@@ -0,0 +1,32 @@
1
+ # AuditLogSchema
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **company_id** | **string** | | [default to undefined]
9
+ **action** | [**AuditLogAction**](AuditLogAction.md) | | [default to undefined]
10
+ **entity_type** | [**AuditLogEntity**](AuditLogEntity.md) | | [default to undefined]
11
+ **entity_id** | **string** | | [default to undefined]
12
+ **entity_name** | **string** | | [default to undefined]
13
+ **timestamp** | **string** | | [default to undefined]
14
+ **details** | **{ [key: string]: any; }** | | [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { AuditLogSchema } from './api';
20
+
21
+ const instance: AuditLogSchema = {
22
+ company_id,
23
+ action,
24
+ entity_type,
25
+ entity_id,
26
+ entity_name,
27
+ timestamp,
28
+ details,
29
+ };
30
+ ```
31
+
32
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -7,7 +7,7 @@ All URIs are relative to *http://localhost*
7
7
  |[**listAuditLogsV1AuditLogsListGet**](#listauditlogsv1auditlogslistget) | **GET** /v1/audit-logs/list | List Audit Logs|
8
8
 
9
9
  # **listAuditLogsV1AuditLogsListGet**
10
- > Array<AuditLogResponse> listAuditLogsV1AuditLogsListGet()
10
+ > PaginationResponseAuditLogSchema listAuditLogsV1AuditLogsListGet()
11
11
 
12
12
 
13
13
  ### Example
@@ -22,8 +22,8 @@ const configuration = new Configuration();
22
22
  const apiInstance = new AuditLogsApi(configuration);
23
23
 
24
24
  let companyId: string; // (default to undefined)
25
- let page: number; // (default to undefined)
26
- let elements: number; // (default to undefined)
25
+ let page: number; // (optional) (default to 1)
26
+ let elements: number; // (optional) (default to 10)
27
27
  let entityType: AuditLogEntity; // (optional) (default to undefined)
28
28
  let action: AuditLogAction; // (optional) (default to undefined)
29
29
  let startDate: string; // (optional) (default to undefined)
@@ -49,8 +49,8 @@ const { status, data } = await apiInstance.listAuditLogsV1AuditLogsListGet(
49
49
  |Name | Type | Description | Notes|
50
50
  |------------- | ------------- | ------------- | -------------|
51
51
  | **companyId** | [**string**] | | defaults to undefined|
52
- | **page** | [**number**] | | defaults to undefined|
53
- | **elements** | [**number**] | | defaults to undefined|
52
+ | **page** | [**number**] | | (optional) defaults to 1|
53
+ | **elements** | [**number**] | | (optional) defaults to 10|
54
54
  | **entityType** | **AuditLogEntity** | | (optional) defaults to undefined|
55
55
  | **action** | **AuditLogAction** | | (optional) defaults to undefined|
56
56
  | **startDate** | [**string**] | | (optional) defaults to undefined|
@@ -61,7 +61,7 @@ const { status, data } = await apiInstance.listAuditLogsV1AuditLogsListGet(
61
61
 
62
62
  ### Return type
63
63
 
64
- **Array<AuditLogResponse>**
64
+ **PaginationResponseAuditLogSchema**
65
65
 
66
66
  ### Authorization
67
67
 
@@ -7,8 +7,7 @@ All URIs are relative to *http://localhost*
7
7
  |[**createCompanyV1CompanyCreatePost**](#createcompanyv1companycreatepost) | **POST** /v1/company/create | Create Company|
8
8
  |[**getCompaniesV1CompanyListGet**](#getcompaniesv1companylistget) | **GET** /v1/company/list | Get Companies|
9
9
  |[**getCompanyV1CompanyGetCompanyIdGet**](#getcompanyv1companygetcompanyidget) | **GET** /v1/company/get/{company_id} | Get Company|
10
- |[**getControlsV1CompanyControlsCompanyIdGet**](#getcontrolsv1companycontrolscompanyidget) | **GET** /v1/company/controls/{company_id} | Get Controls|
11
- |[**getPoliciesV1CompanyPoliciesGet**](#getpoliciesv1companypoliciesget) | **GET** /v1/company/policies | Get Policies|
10
+ |[**getCompanyWithControlsV1CompanyControlsCompanyIdGet**](#getcompanywithcontrolsv1companycontrolscompanyidget) | **GET** /v1/company/controls/{company_id} | Get Company With Controls|
12
11
  |[**updateCompanyV1CompanyUpdatePatch**](#updatecompanyv1companyupdatepatch) | **PATCH** /v1/company/update | Update Company|
13
12
 
14
13
  # **createCompanyV1CompanyCreatePost**
@@ -70,7 +69,7 @@ No authorization required
70
69
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
71
70
 
72
71
  # **getCompaniesV1CompanyListGet**
73
- > Array<CompanyInDBBase> getCompaniesV1CompanyListGet()
72
+ > PaginationResponseCompanyInDBBase getCompaniesV1CompanyListGet()
74
73
 
75
74
 
76
75
  ### Example
@@ -109,7 +108,7 @@ const { status, data } = await apiInstance.getCompaniesV1CompanyListGet(
109
108
 
110
109
  ### Return type
111
110
 
112
- **Array<CompanyInDBBase>**
111
+ **PaginationResponseCompanyInDBBase**
113
112
 
114
113
  ### Authorization
115
114
 
@@ -186,8 +185,8 @@ No authorization required
186
185
 
187
186
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
188
187
 
189
- # **getControlsV1CompanyControlsCompanyIdGet**
190
- > CompanyWithControls getControlsV1CompanyControlsCompanyIdGet()
188
+ # **getCompanyWithControlsV1CompanyControlsCompanyIdGet**
189
+ > CompanyWithControls getCompanyWithControlsV1CompanyControlsCompanyIdGet()
191
190
 
192
191
 
193
192
  ### Example
@@ -205,7 +204,7 @@ let companyId: string; // (default to undefined)
205
204
  let authorization: string; // (optional) (default to undefined)
206
205
  let sessionId: string; // (optional) (default to undefined)
207
206
 
208
- const { status, data } = await apiInstance.getControlsV1CompanyControlsCompanyIdGet(
207
+ const { status, data } = await apiInstance.getCompanyWithControlsV1CompanyControlsCompanyIdGet(
209
208
  companyId,
210
209
  authorization,
211
210
  sessionId
@@ -235,66 +234,6 @@ No authorization required
235
234
  - **Accept**: application/json
236
235
 
237
236
 
238
- ### HTTP response details
239
- | Status code | Description | Response headers |
240
- |-------------|-------------|------------------|
241
- |**200** | Successful Response | - |
242
- |**422** | Validation Error | - |
243
-
244
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
245
-
246
- # **getPoliciesV1CompanyPoliciesGet**
247
- > Array<PolicyRead> getPoliciesV1CompanyPoliciesGet()
248
-
249
-
250
- ### Example
251
-
252
- ```typescript
253
- import {
254
- CompanyApi,
255
- Configuration
256
- } from './api';
257
-
258
- const configuration = new Configuration();
259
- const apiInstance = new CompanyApi(configuration);
260
-
261
- let page: number; // (optional) (default to 1)
262
- let elements: number; // (optional) (default to 10)
263
- let authorization: string; // (optional) (default to undefined)
264
- let sessionId: string; // (optional) (default to undefined)
265
-
266
- const { status, data } = await apiInstance.getPoliciesV1CompanyPoliciesGet(
267
- page,
268
- elements,
269
- authorization,
270
- sessionId
271
- );
272
- ```
273
-
274
- ### Parameters
275
-
276
- |Name | Type | Description | Notes|
277
- |------------- | ------------- | ------------- | -------------|
278
- | **page** | [**number**] | | (optional) defaults to 1|
279
- | **elements** | [**number**] | | (optional) defaults to 10|
280
- | **authorization** | [**string**] | | (optional) defaults to undefined|
281
- | **sessionId** | [**string**] | | (optional) defaults to undefined|
282
-
283
-
284
- ### Return type
285
-
286
- **Array<PolicyRead>**
287
-
288
- ### Authorization
289
-
290
- No authorization required
291
-
292
- ### HTTP request headers
293
-
294
- - **Content-Type**: Not defined
295
- - **Accept**: application/json
296
-
297
-
298
237
  ### HTTP response details
299
238
  | Status code | Description | Response headers |
300
239
  |-------------|-------------|------------------|
@@ -0,0 +1,22 @@
1
+ # PaginationResponseAuditLogSchema
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **items** | [**Array&lt;AuditLogSchema&gt;**](AuditLogSchema.md) | | [default to undefined]
9
+ **total** | **number** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { PaginationResponseAuditLogSchema } from './api';
15
+
16
+ const instance: PaginationResponseAuditLogSchema = {
17
+ items,
18
+ total,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # PaginationResponseCompanyInDBBase
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **items** | [**Array&lt;CompanyInDBBase&gt;**](CompanyInDBBase.md) | | [default to undefined]
9
+ **total** | **number** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { PaginationResponseCompanyInDBBase } from './api';
15
+
16
+ const instance: PaginationResponseCompanyInDBBase = {
17
+ items,
18
+ total,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # PaginationResponsePolicyRead
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **items** | [**Array&lt;PolicyRead&gt;**](PolicyRead.md) | | [default to undefined]
9
+ **total** | **number** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { PaginationResponsePolicyRead } from './api';
15
+
16
+ const instance: PaginationResponsePolicyRead = {
17
+ items,
18
+ total,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -126,7 +126,7 @@ No authorization required
126
126
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
127
127
 
128
128
  # **getCompanyPoliciesV1PoliciesCompanyCompanyIdGet**
129
- > Array<PolicyRead> getCompanyPoliciesV1PoliciesCompanyCompanyIdGet()
129
+ > PaginationResponsePolicyRead getCompanyPoliciesV1PoliciesCompanyCompanyIdGet()
130
130
 
131
131
 
132
132
  ### Example
@@ -168,7 +168,7 @@ const { status, data } = await apiInstance.getCompanyPoliciesV1PoliciesCompanyCo
168
168
 
169
169
  ### Return type
170
170
 
171
- **Array<PolicyRead>**
171
+ **PaginationResponsePolicyRead**
172
172
 
173
173
  ### Authorization
174
174
 
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.4",
7
+ "version": "1.0.6",
8
8
  "description": "Lumoar API SDK",
9
9
  "main": "dist/index.js",
10
10
  "directories": {
package/sdk.ts CHANGED
@@ -1,9 +1,10 @@
1
1
  import axios, { AxiosInstance, AxiosResponse } from 'axios';
2
2
  import {
3
- HealthApi,
3
+ HealthApi,
4
4
  AuthApi,
5
5
  CompanyApi,
6
6
  ControlsApi,
7
+ AuditLogsApi,
7
8
  EvidenceApi,
8
9
  PaymentsApi,
9
10
  PoliciesApi,
@@ -17,6 +18,7 @@ export class ApiSDK {
17
18
  private authApi: AuthApi;
18
19
  private companyApi: CompanyApi;
19
20
  private controlsApi: ControlsApi;
21
+ private auditLogsApi: AuditLogsApi;
20
22
  private evidenceApi: EvidenceApi;
21
23
  private paymentsApi: PaymentsApi;
22
24
  private policiesApi: PoliciesApi;
@@ -43,6 +45,7 @@ export class ApiSDK {
43
45
  this.authApi = new AuthApi(config, undefined, this.axiosInstance);
44
46
  this.companyApi = new CompanyApi(config, undefined, this.axiosInstance);
45
47
  this.controlsApi = new ControlsApi(config, undefined, this.axiosInstance);
48
+ this.auditLogsApi = new AuditLogsApi(config, undefined, this.axiosInstance);
46
49
  this.evidenceApi = new EvidenceApi(config, undefined, this.axiosInstance);
47
50
  this.paymentsApi = new PaymentsApi(config, undefined, this.axiosInstance);
48
51
  this.policiesApi = new PoliciesApi(config, undefined, this.axiosInstance);
@@ -88,6 +91,7 @@ export class ApiSDK {
88
91
  authApi: this.authApi,
89
92
  companyApi: this.companyApi,
90
93
  controlsApi: this.controlsApi,
94
+ auditLogsApi: this.auditLogsApi,
91
95
  evidenceApi: this.evidenceApi,
92
96
  paymentsApi: this.paymentsApi,
93
97
  policiesApi: this.policiesApi,