@rasadov/lumoar-sdk 1.0.1

package/docs/EvidenceBase.md

@@ -0,0 +1,40 @@
+# EvidenceBase
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**control_id** | **string** |  | [default to undefined]
+**expires_at** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [default to undefined]
+**version** | **number** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+**text** | [**EvidenceTextSchema**](EvidenceTextSchema.md) |  | [optional] [default to undefined]
+**files** | [**Array<EvidenceFileSchema>**](EvidenceFileSchema.md) |  | [optional] [default to undefined]
+**tags** | **Array<string>** |  | [optional] [default to undefined]
+**uploaded_by** | [**UserBase**](UserBase.md) |  | [optional] [default to undefined]
+**submitted_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EvidenceBase } from './api';
+
+const instance: EvidenceBase = {
+    id,
+    control_id,
+    expires_at,
+    status,
+    version,
+    type,
+    text,
+    files,
+    tags,
+    uploaded_by,
+    submitted_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/EvidenceFileSchema.md

@@ -0,0 +1,32 @@
+# EvidenceFileSchema
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [default to undefined]
+**evidence_id** | **string** |  | [default to undefined]
+**filename** | **string** |  | [default to undefined]
+**storage_key** | **string** |  | [default to undefined]
+**checksum** | **string** |  | [default to undefined]
+**file_size** | **number** |  | [default to undefined]
+**file_type** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { EvidenceFileSchema } from './api';
+
+const instance: EvidenceFileSchema = {
+    id,
+    evidence_id,
+    filename,
+    storage_key,
+    checksum,
+    file_size,
+    file_type,
+};
+```
+
+[[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/EvidenceTextSchema.md

@@ -0,0 +1,24 @@
+# EvidenceTextSchema
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [default to undefined]
+**evidence_id** | **string** |  | [default to undefined]
+**content** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { EvidenceTextSchema } from './api';
+
+const instance: EvidenceTextSchema = {
+    id,
+    evidence_id,
+    content,
+};
+```
+
+[[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/FileDownload.md

@@ -0,0 +1,26 @@
+# FileDownload
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** |  | [default to undefined]
+**filename** | **string** |  | [optional] [default to undefined]
+**file_size** | **number** |  | [optional] [default to undefined]
+**file_type** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FileDownload } from './api';
+
+const instance: FileDownload = {
+    url,
+    filename,
+    file_size,
+    file_type,
+};
+```
+
+[[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/FrameworkControlsBase.md

@@ -0,0 +1,26 @@
+# FrameworkControlsBase
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**category** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**control_key** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { FrameworkControlsBase } from './api';
+
+const instance: FrameworkControlsBase = {
+    name,
+    category,
+    description,
+    control_key,
+};
+```
+
+[[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/GetControl.md

@@ -0,0 +1,22 @@
+# GetControl
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**control** | [**ControlWithRelationships**](ControlWithRelationships.md) |  | [default to undefined]
+**role** | [**UserRole**](UserRole.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetControl } from './api';
+
+const instance: GetControl = {
+    control,
+    role,
+};
+```
+
+[[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/HTTPValidationError.md

@@ -0,0 +1,20 @@
+# HTTPValidationError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**detail** | [**Array<ValidationError>**](ValidationError.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { HTTPValidationError } from './api';
+
+const instance: HTTPValidationError = {
+    detail,
+};
+```
+
+[[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/InviteToCompany.md

@@ -0,0 +1,24 @@
+# InviteToCompany
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_email** | **string** |  | [default to undefined]
+**company_id** | **string** |  | [default to undefined]
+**role** | [**PermissionType**](PermissionType.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { InviteToCompany } from './api';
+
+const instance: InviteToCompany = {
+    user_email,
+    company_id,
+    role,
+};
+```
+
+[[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/LoginSchema.md

@@ -0,0 +1,25 @@
+# LoginSchema
+
+Login schema for user authentication. Attributes:     - email: EmailStr     - password: SecretStr     - turnstile_token: str
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [default to undefined]
+**password** | **string** |  | [default to undefined]
+**turnstile_token** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { LoginSchema } from './api';
+
+const instance: LoginSchema = {
+    email,
+    password,
+    turnstile_token,
+};
+```
+
+[[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

@@ -0,0 +1,164 @@
+# PaymentsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getCheckoutSessionPaymentsCheckoutGet**](#getcheckoutsessionpaymentscheckoutget) | **GET** /payments/checkout | Get Checkout Session|
+|[**getCustomerManagementSessionPaymentsCustomerManagementGet**](#getcustomermanagementsessionpaymentscustomermanagementget) | **GET** /payments/customer/management | Get Customer Management Session|
+|[**webhookPaymentsWebhookPost**](#webhookpaymentswebhookpost) | **POST** /payments/webhook | Webhook|
+
+# **getCheckoutSessionPaymentsCheckoutGet**
+> ResponseGetCheckoutSessionPaymentsCheckoutGet getCheckoutSessionPaymentsCheckoutGet()
+
+
+### Example
+
+```typescript
+import {
+    PaymentsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PaymentsApi(configuration);
+
+let userId: string; // (default to undefined)
+let companyId: string; // (default to undefined)
+let productId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getCheckoutSessionPaymentsCheckoutGet(
+    userId,
+    companyId,
+    productId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userId** | [**string**] |  | defaults to undefined|
+| **companyId** | [**string**] |  | defaults to undefined|
+| **productId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ResponseGetCheckoutSessionPaymentsCheckoutGet**
+
+### 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)
+
+# **getCustomerManagementSessionPaymentsCustomerManagementGet**
+> ResponseGetCustomerManagementSessionPaymentsCustomerManagementGet getCustomerManagementSessionPaymentsCustomerManagementGet()
+
+
+### Example
+
+```typescript
+import {
+    PaymentsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PaymentsApi(configuration);
+
+let authorization: string; // (optional) (default to undefined)
+let sessionId: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getCustomerManagementSessionPaymentsCustomerManagementGet(
+    authorization,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **authorization** | [**string**] |  | (optional) defaults to undefined|
+| **sessionId** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ResponseGetCustomerManagementSessionPaymentsCustomerManagementGet**
+
+### 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)
+
+# **webhookPaymentsWebhookPost**
+> any webhookPaymentsWebhookPost()
+
+
+### Example
+
+```typescript
+import {
+    PaymentsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PaymentsApi(configuration);
+
+const { status, data } = await apiInstance.webhookPaymentsWebhookPost();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**any**
+
+### 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 |  -  |
+
+[[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/PermissionType.md

@@ -0,0 +1,14 @@
+# PermissionType
+
+
+## Enum
+
+* `Owner` (value: `'owner'`)
+
+* `Admin` (value: `'admin'`)
+
+* `Member` (value: `'member'`)
+
+* `Auditor` (value: `'auditor'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)