@rasadov/lumoar-sdk 1.0.1

package/docs/CompanyApi.md

@@ -0,0 +1,363 @@
+# CompanyApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createCompanyV1CompanyCreatePost**](#createcompanyv1companycreatepost) | **POST** /v1/company/create | Create Company|
+|[**getCompaniesV1CompanyListGet**](#getcompaniesv1companylistget) | **GET** /v1/company/list | Get Companies|
+|[**getCompanyV1CompanyGetCompanyIdGet**](#getcompanyv1companygetcompanyidget) | **GET** /v1/company/get/{company_id} | Get Company|
+|[**getControlsV1CompanyControlsCompanyIdGet**](#getcontrolsv1companycontrolscompanyidget) | **GET** /v1/company/controls/{company_id} | Get Controls|
+|[**getPoliciesV1CompanyPoliciesGet**](#getpoliciesv1companypoliciesget) | **GET** /v1/company/policies | Get Policies|
+|[**updateCompanyV1CompanyUpdatePatch**](#updatecompanyv1companyupdatepatch) | **PATCH** /v1/company/update | Update Company|
+
+# **createCompanyV1CompanyCreatePost**
+> CompanyInDBBase createCompanyV1CompanyCreatePost(companyCreate)
+
+
+### Example
+
+```typescript
+import {
+    CompanyApi,
+    Configuration,
+    CompanyCreate
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CompanyApi(configuration);
+
+let companyCreate: CompanyCreate; //
+let authorization: string; // (optional) (default to undefined)
+let sessionId: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.createCompanyV1CompanyCreatePost(
+    companyCreate,
+    authorization,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **companyCreate** | **CompanyCreate**|  | |
+| **authorization** | [**string**] |  | (optional) defaults to undefined|
+| **sessionId** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**CompanyInDBBase**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **getCompaniesV1CompanyListGet**
+> Array<CompanyInDBBase> getCompaniesV1CompanyListGet()
+
+
+### Example
+
+```typescript
+import {
+    CompanyApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CompanyApi(configuration);
+
+let page: number; // (optional) (default to 1)
+let limit: number; // (optional) (default to 10)
+let authorization: string; // (optional) (default to undefined)
+let sessionId: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getCompaniesV1CompanyListGet(
+    page,
+    limit,
+    authorization,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to 1|
+| **limit** | [**number**] |  | (optional) defaults to 10|
+| **authorization** | [**string**] |  | (optional) defaults to undefined|
+| **sessionId** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<CompanyInDBBase>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **getCompanyV1CompanyGetCompanyIdGet**
+> CompanyWithRoles getCompanyV1CompanyGetCompanyIdGet()
+
+
+### Example
+
+```typescript
+import {
+    CompanyApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CompanyApi(configuration);
+
+let companyId: string; // (default to undefined)
+let authorization: string; // (optional) (default to undefined)
+let sessionId: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getCompanyV1CompanyGetCompanyIdGet(
+    companyId,
+    authorization,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **companyId** | [**string**] |  | defaults to undefined|
+| **authorization** | [**string**] |  | (optional) defaults to undefined|
+| **sessionId** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**CompanyWithRoles**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **getControlsV1CompanyControlsCompanyIdGet**
+> CompanyWithControls getControlsV1CompanyControlsCompanyIdGet()
+
+
+### Example
+
+```typescript
+import {
+    CompanyApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CompanyApi(configuration);
+
+let companyId: string; // (default to undefined)
+let authorization: string; // (optional) (default to undefined)
+let sessionId: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getControlsV1CompanyControlsCompanyIdGet(
+    companyId,
+    authorization,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **companyId** | [**string**] |  | defaults to undefined|
+| **authorization** | [**string**] |  | (optional) defaults to undefined|
+| **sessionId** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**CompanyWithControls**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **getPoliciesV1CompanyPoliciesGet**
+> Array<PolicyRead> getPoliciesV1CompanyPoliciesGet()
+
+
+### Example
+
+```typescript
+import {
+    CompanyApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CompanyApi(configuration);
+
+let page: number; // (optional) (default to 1)
+let limit: number; // (optional) (default to 10)
+let authorization: string; // (optional) (default to undefined)
+let sessionId: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getPoliciesV1CompanyPoliciesGet(
+    page,
+    limit,
+    authorization,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | (optional) defaults to 1|
+| **limit** | [**number**] |  | (optional) defaults to 10|
+| **authorization** | [**string**] |  | (optional) defaults to undefined|
+| **sessionId** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<PolicyRead>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **updateCompanyV1CompanyUpdatePatch**
+> CompanyInDBBase updateCompanyV1CompanyUpdatePatch(companyUpdate)
+
+
+### Example
+
+```typescript
+import {
+    CompanyApi,
+    Configuration,
+    CompanyUpdate
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CompanyApi(configuration);
+
+let companyUpdate: CompanyUpdate; //
+let authorization: string; // (optional) (default to undefined)
+let sessionId: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.updateCompanyV1CompanyUpdatePatch(
+    companyUpdate,
+    authorization,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **companyUpdate** | **CompanyUpdate**|  | |
+| **authorization** | [**string**] |  | (optional) defaults to undefined|
+| **sessionId** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**CompanyInDBBase**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+

package/docs/CompanyCreate.md

@@ -0,0 +1,44 @@
+# CompanyCreate
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**industry** | **string** |  | [default to undefined]
+**employee_count** | **number** |  | [default to undefined]
+**domain** | **string** |  | [default to undefined]
+**tools_used** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+**plan** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**compliance_goal** | [**ComplianceGoal**](ComplianceGoal.md) |  | [optional] [default to undefined]
+**readiness_score** | **number** |  | [optional] [default to undefined]
+**audit_due_date** | **string** |  | [optional] [default to undefined]
+**is_audit_mode** | **boolean** |  | [optional] [default to false]
+**timezone** | **string** |  | [optional] [default to 'UTC']
+**logo_url** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CompanyCreate } from './api';
+
+const instance: CompanyCreate = {
+    name,
+    industry,
+    employee_count,
+    domain,
+    tools_used,
+    plan,
+    status,
+    compliance_goal,
+    readiness_score,
+    audit_due_date,
+    is_audit_mode,
+    timezone,
+    logo_url,
+};
+```
+
+[[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/CompanyInDBBase.md

@@ -0,0 +1,48 @@
+# CompanyInDBBase
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**industry** | **string** |  | [default to undefined]
+**employee_count** | **number** |  | [default to undefined]
+**domain** | **string** |  | [default to undefined]
+**tools_used** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+**plan** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**compliance_goal** | [**ComplianceGoal**](ComplianceGoal.md) |  | [optional] [default to undefined]
+**readiness_score** | **number** |  | [optional] [default to undefined]
+**audit_due_date** | **string** |  | [optional] [default to undefined]
+**is_audit_mode** | **boolean** |  | [optional] [default to false]
+**timezone** | **string** |  | [optional] [default to 'UTC']
+**logo_url** | **string** |  | [optional] [default to undefined]
+**id** | **string** |  | [default to undefined]
+**updated_at** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CompanyInDBBase } from './api';
+
+const instance: CompanyInDBBase = {
+    name,
+    industry,
+    employee_count,
+    domain,
+    tools_used,
+    plan,
+    status,
+    compliance_goal,
+    readiness_score,
+    audit_due_date,
+    is_audit_mode,
+    timezone,
+    logo_url,
+    id,
+    updated_at,
+};
+```
+
+[[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/CompanyUpdate.md

@@ -0,0 +1,42 @@
+# CompanyUpdate
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**industry** | **string** |  | [optional] [default to undefined]
+**employee_count** | **number** |  | [optional] [default to undefined]
+**domain** | **string** |  | [optional] [default to undefined]
+**tools_used** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+**compliance_goal** | [**ComplianceGoal**](ComplianceGoal.md) |  | [optional] [default to undefined]
+**readiness_score** | **number** |  | [optional] [default to undefined]
+**audit_due_date** | **string** |  | [optional] [default to undefined]
+**is_audit_mode** | **boolean** |  | [optional] [default to undefined]
+**timezone** | **string** |  | [optional] [default to undefined]
+**logo_url** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CompanyUpdate } from './api';
+
+const instance: CompanyUpdate = {
+    id,
+    name,
+    industry,
+    employee_count,
+    domain,
+    tools_used,
+    compliance_goal,
+    readiness_score,
+    audit_due_date,
+    is_audit_mode,
+    timezone,
+    logo_url,
+};
+```
+
+[[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/CompanyWithControls.md

@@ -0,0 +1,50 @@
+# CompanyWithControls
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**industry** | **string** |  | [default to undefined]
+**employee_count** | **number** |  | [default to undefined]
+**domain** | **string** |  | [default to undefined]
+**tools_used** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+**plan** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**compliance_goal** | [**ComplianceGoal**](ComplianceGoal.md) |  | [optional] [default to undefined]
+**readiness_score** | **number** |  | [optional] [default to undefined]
+**audit_due_date** | **string** |  | [optional] [default to undefined]
+**is_audit_mode** | **boolean** |  | [optional] [default to false]
+**timezone** | **string** |  | [optional] [default to 'UTC']
+**logo_url** | **string** |  | [optional] [default to undefined]
+**id** | **string** |  | [default to undefined]
+**updated_at** | **string** |  | [default to undefined]
+**controls** | [**Array<ControlWithEvidences>**](ControlWithEvidences.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CompanyWithControls } from './api';
+
+const instance: CompanyWithControls = {
+    name,
+    industry,
+    employee_count,
+    domain,
+    tools_used,
+    plan,
+    status,
+    compliance_goal,
+    readiness_score,
+    audit_due_date,
+    is_audit_mode,
+    timezone,
+    logo_url,
+    id,
+    updated_at,
+    controls,
+};
+```
+
+[[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/CompanyWithRoles.md

@@ -0,0 +1,50 @@
+# CompanyWithRoles
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**industry** | **string** |  | [default to undefined]
+**employee_count** | **number** |  | [default to undefined]
+**domain** | **string** |  | [default to undefined]
+**tools_used** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+**plan** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**compliance_goal** | [**ComplianceGoal**](ComplianceGoal.md) |  | [optional] [default to undefined]
+**readiness_score** | **number** |  | [optional] [default to undefined]
+**audit_due_date** | **string** |  | [optional] [default to undefined]
+**is_audit_mode** | **boolean** |  | [optional] [default to false]
+**timezone** | **string** |  | [optional] [default to 'UTC']
+**logo_url** | **string** |  | [optional] [default to undefined]
+**id** | **string** |  | [default to undefined]
+**updated_at** | **string** |  | [default to undefined]
+**permissions** | [**Array<RolesWithUser>**](RolesWithUser.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CompanyWithRoles } from './api';
+
+const instance: CompanyWithRoles = {
+    name,
+    industry,
+    employee_count,
+    domain,
+    tools_used,
+    plan,
+    status,
+    compliance_goal,
+    readiness_score,
+    audit_due_date,
+    is_audit_mode,
+    timezone,
+    logo_url,
+    id,
+    updated_at,
+    permissions,
+};
+```
+
+[[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/ComplianceGoal.md

@@ -0,0 +1,8 @@
+# ComplianceGoal
+
+
+## Enum
+
+* `Soc2` (value: `'SOC2'`)
+
+[[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/ControlStatus.md

@@ -0,0 +1,18 @@
+# ControlStatus
+
+
+## Enum
+
+* `NotStarted` (value: `'not_started'`)
+
+* `InProgress` (value: `'in_progress'`)
+
+* `Completed` (value: `'completed'`)
+
+* `Failed` (value: `'failed'`)
+
+* `Skipped` (value: `'skipped'`)
+
+* `PendingReview` (value: `'pending_review'`)
+
+[[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/ControlWithEvidences.md

@@ -0,0 +1,30 @@
+# ControlWithEvidences
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**framework_control** | [**FrameworkControlsBase**](FrameworkControlsBase.md) |  | [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**note** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+**evidences** | [**Array<EvidenceBase>**](EvidenceBase.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ControlWithEvidences } from './api';
+
+const instance: ControlWithEvidences = {
+    id,
+    framework_control,
+    status,
+    note,
+    updated_at,
+    evidences,
+};
+```
+
+[[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/ControlWithRelationships.md

@@ -0,0 +1,32 @@
+# ControlWithRelationships
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**framework_control** | [**FrameworkControlsBase**](FrameworkControlsBase.md) |  | [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**note** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+**company** | [**CompanyInDBBase**](CompanyInDBBase.md) |  | [default to undefined]
+**evidences** | [**Array<EvidenceBase>**](EvidenceBase.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ControlWithRelationships } from './api';
+
+const instance: ControlWithRelationships = {
+    id,
+    framework_control,
+    status,
+    note,
+    updated_at,
+    company,
+    evidences,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)