@nestbox-ai/admin 1.0.39 → 1.0.47

package/docs/EvaluationTestApi.md

@@ -0,0 +1,299 @@
+# EvaluationTestApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**evaluationTestControllerAddEvaluationTest**](#evaluationtestcontrolleraddevaluationtest) | **POST** /projects/{projectId}/evaluation-tests | Add new evaluation test.|
+|[**evaluationTestControllerDeleteEvaluation**](#evaluationtestcontrollerdeleteevaluation) | **DELETE** /projects/{projectId}/evaluation-tests/{testId} | Delete evaluation|
+|[**evaluationTestControllerExecuteEvaluation**](#evaluationtestcontrollerexecuteevaluation) | **PUT** /projects/{projectId}/evaluation-tests/{testId}/execute | Execute evaluation test.|
+|[**evaluationTestControllerGetEvaluationTest**](#evaluationtestcontrollergetevaluationtest) | **GET** /projects/{projectId}/evaluation-tests/{modelId} | Fetch evaluation test.|
+|[**evaluationTestControllerUpdateEvaluation**](#evaluationtestcontrollerupdateevaluation) | **PUT** /projects/{projectId}/evaluation-tests/{testId} | Update evaluation test|
+
+# **evaluationTestControllerAddEvaluationTest**
+> object evaluationTestControllerAddEvaluationTest()
+
+
+### Example
+
+```typescript
+import {
+    EvaluationTestApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new EvaluationTestApi(configuration);
+
+let projectId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.evaluationTestControllerAddEvaluationTest(
+    projectId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[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)
+
+# **evaluationTestControllerDeleteEvaluation**
+> object evaluationTestControllerDeleteEvaluation()
+
+
+### Example
+
+```typescript
+import {
+    EvaluationTestApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new EvaluationTestApi(configuration);
+
+let projectId: string; // (default to undefined)
+let testId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.evaluationTestControllerDeleteEvaluation(
+    projectId,
+    testId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | [**string**] |  | defaults to undefined|
+| **testId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[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)
+
+# **evaluationTestControllerExecuteEvaluation**
+> object evaluationTestControllerExecuteEvaluation()
+
+
+### Example
+
+```typescript
+import {
+    EvaluationTestApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new EvaluationTestApi(configuration);
+
+let projectId: string; // (default to undefined)
+let testId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.evaluationTestControllerExecuteEvaluation(
+    projectId,
+    testId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | [**string**] |  | defaults to undefined|
+| **testId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[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)
+
+# **evaluationTestControllerGetEvaluationTest**
+> object evaluationTestControllerGetEvaluationTest()
+
+
+### Example
+
+```typescript
+import {
+    EvaluationTestApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new EvaluationTestApi(configuration);
+
+let projectId: string; // (default to undefined)
+let modelId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.evaluationTestControllerGetEvaluationTest(
+    projectId,
+    modelId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | [**string**] |  | defaults to undefined|
+| **modelId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[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)
+
+# **evaluationTestControllerUpdateEvaluation**
+> object evaluationTestControllerUpdateEvaluation()
+
+
+### Example
+
+```typescript
+import {
+    EvaluationTestApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new EvaluationTestApi(configuration);
+
+let projectId: string; // (default to undefined)
+let testId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.evaluationTestControllerUpdateEvaluation(
+    projectId,
+    testId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | [**string**] |  | defaults to undefined|
+| **testId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[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/FatalErrorExceptionResponse.md

@@ -0,0 +1,20 @@
+# FatalErrorExceptionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [default to 'Something Went Wrong']
+
+## Example
+
+```typescript
+import { FatalErrorExceptionResponse } from '@nestbox-ai/admin';
+
+const instance: FatalErrorExceptionResponse = {
+    message,
+};
+```
+
+[[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/ForbiddenExceptionResponse.md

@@ -0,0 +1,20 @@
+# ForbiddenExceptionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [default to 'Access Not Allowed']
+
+## Example
+
+```typescript
+import { ForbiddenExceptionResponse } from '@nestbox-ai/admin';
+
+const instance: ForbiddenExceptionResponse = {
+    message,
+};
+```
+
+[[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/ForgetPasswordRequestDTO.md

@@ -0,0 +1,20 @@
+# ForgetPasswordRequestDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ForgetPasswordRequestDTO } from '@nestbox-ai/admin';
+
+const instance: ForgetPasswordRequestDTO = {
+    email,
+};
+```
+
+[[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/ForgetPasswordResponseDTO.md

@@ -0,0 +1,20 @@
+# ForgetPasswordResponseDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ForgetPasswordResponseDTO } from '@nestbox-ai/admin';
+
+const instance: ForgetPasswordResponseDTO = {
+    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/ForgetPasswordVerificationRequestDTO.md

@@ -0,0 +1,20 @@
+# ForgetPasswordVerificationRequestDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ForgetPasswordVerificationRequestDTO } from '@nestbox-ai/admin';
+
+const instance: ForgetPasswordVerificationRequestDTO = {
+    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/ForgetPasswordVerificationResponseDTO.md

@@ -0,0 +1,20 @@
+# ForgetPasswordVerificationResponseDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ForgetPasswordVerificationResponseDTO } from '@nestbox-ai/admin';
+
+const instance: ForgetPasswordVerificationResponseDTO = {
+    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/GetAllProjectDto.md

@@ -0,0 +1,22 @@
+# GetAllProjectDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**roles** | [**Array<GetAllRoleDTO>**](GetAllRoleDTO.md) |  | [default to undefined]
+**totalCount** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetAllProjectDto } from '@nestbox-ai/admin';
+
+const instance: GetAllProjectDto = {
+    roles,
+    totalCount,
+};
+```
+
+[[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/GetAllProjectMemberResponse.md

@@ -0,0 +1,22 @@
+# GetAllProjectMemberResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**teamMembers** | [**Array<TeamMemberDto>**](TeamMemberDto.md) |  | [default to undefined]
+**totalCount** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetAllProjectMemberResponse } from '@nestbox-ai/admin';
+
+const instance: GetAllProjectMemberResponse = {
+    teamMembers,
+    totalCount,
+};
+```
+
+[[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/GetAllProjectMemberResponseDto.md

@@ -0,0 +1,20 @@
+# GetAllProjectMemberResponseDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**GetAllProjectMemberResponse**](GetAllProjectMemberResponse.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetAllProjectMemberResponseDto } from '@nestbox-ai/admin';
+
+const instance: GetAllProjectMemberResponseDto = {
+    data,
+};
+```
+
+[[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/GetAllProjectRoleResponseDto.md

@@ -0,0 +1,20 @@
+# GetAllProjectRoleResponseDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**GetAllProjectDto**](GetAllProjectDto.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetAllProjectRoleResponseDto } from '@nestbox-ai/admin';
+
+const instance: GetAllProjectRoleResponseDto = {
+    data,
+};
+```
+
+[[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/GetAllProjectsResponseDTO.md

@@ -0,0 +1,20 @@
+# GetAllProjectsResponseDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**AllProjectResponseModel**](AllProjectResponseModel.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetAllProjectsResponseDTO } from '@nestbox-ai/admin';
+
+const instance: GetAllProjectsResponseDTO = {
+    data,
+};
+```
+
+[[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/GetAllRoleDTO.md

@@ -0,0 +1,32 @@
+# GetAllRoleDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**projectId** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+**deletedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetAllRoleDTO } from '@nestbox-ai/admin';
+
+const instance: GetAllRoleDTO = {
+    id,
+    name,
+    description,
+    projectId,
+    createdAt,
+    updatedAt,
+    deletedAt,
+};
+```
+
+[[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/GetProjectByIDResponseDTO.md

@@ -0,0 +1,20 @@
+# GetProjectByIDResponseDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**ProjectResponseModel**](ProjectResponseModel.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetProjectByIDResponseDTO } from '@nestbox-ai/admin';
+
+const instance: GetProjectByIDResponseDTO = {
+    data,
+};
+```
+
+[[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/GetProjectRoleByIdResponseDto.md

@@ -0,0 +1,20 @@
+# GetProjectRoleByIdResponseDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**GetRoleDTO**](GetRoleDTO.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetProjectRoleByIdResponseDto } from '@nestbox-ai/admin';
+
+const instance: GetProjectRoleByIdResponseDto = {
+    data,
+};
+```
+
+[[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/GetRoleDTO.md

@@ -0,0 +1,26 @@
+# GetRoleDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**resources** | [**Array<ResourceDTO>**](ResourceDTO.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetRoleDTO } from '@nestbox-ai/admin';
+
+const instance: GetRoleDTO = {
+    id,
+    name,
+    description,
+    resources,
+};
+```
+
+[[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/GetUserProjectRoleByRoleIdResponseDto.md

@@ -0,0 +1,20 @@
+# GetUserProjectRoleByRoleIdResponseDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**GetRoleDTO**](GetRoleDTO.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetUserProjectRoleByRoleIdResponseDto } from '@nestbox-ai/admin';
+
+const instance: GetUserProjectRoleByRoleIdResponseDto = {
+    data,
+};
+```
+
+[[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/LoginRequestDTO.md

@@ -0,0 +1,22 @@
+# LoginRequestDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** | Email | [default to undefined]
+**password** | **string** | Password | [default to undefined]
+
+## Example
+
+```typescript
+import { LoginRequestDTO } from '@nestbox-ai/admin';
+
+const instance: LoginRequestDTO = {
+    email,
+    password,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)