@nestbox-ai/admin 1.0.38 → 1.0.42

package/docs/AddProjectMemberData.md

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

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

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

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

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

@@ -0,0 +1,405 @@
+# AuthApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**authControllerExchangeToken**](#authcontrollerexchangetoken) | **POST** /auth/google/{token} | Exchange token|
+|[**authControllerForgetPassword**](#authcontrollerforgetpassword) | **POST** /auth/forget-password | Forget password initiate|
+|[**authControllerForgetPasswordVerification**](#authcontrollerforgetpasswordverification) | **POST** /auth/forget-password/verification | Forget password verification|
+|[**authControllerLogin**](#authcontrollerlogin) | **POST** /auth/login | Login to the application|
+|[**authControllerOAuthLogin**](#authcontrolleroauthlogin) | **POST** /auth/login/oauth | Login with OAuth apps|
+|[**authControllerResetPassword**](#authcontrollerresetpassword) | **POST** /auth/reset-password | Forget password initiate|
+|[**authControllerSignup**](#authcontrollersignup) | **POST** /auth/signup | Signup in the application|
+
+# **authControllerExchangeToken**
+> object authControllerExchangeToken()
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let token: string; // (default to undefined)
+
+const { status, data } = await apiInstance.authControllerExchangeToken(
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **token** | [**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)
+
+# **authControllerForgetPassword**
+> ForgetPasswordResponseDTO authControllerForgetPassword(forgetPasswordRequestDTO)
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration,
+    ForgetPasswordRequestDTO
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let forgetPasswordRequestDTO: ForgetPasswordRequestDTO; //
+
+const { status, data } = await apiInstance.authControllerForgetPassword(
+    forgetPasswordRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **forgetPasswordRequestDTO** | **ForgetPasswordRequestDTO**|  | |
+
+
+### Return type
+
+**ForgetPasswordResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **authControllerForgetPasswordVerification**
+> ForgetPasswordVerificationResponseDTO authControllerForgetPasswordVerification(forgetPasswordVerificationRequestDTO)
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration,
+    ForgetPasswordVerificationRequestDTO
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let forgetPasswordVerificationRequestDTO: ForgetPasswordVerificationRequestDTO; //
+
+const { status, data } = await apiInstance.authControllerForgetPasswordVerification(
+    forgetPasswordVerificationRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **forgetPasswordVerificationRequestDTO** | **ForgetPasswordVerificationRequestDTO**|  | |
+
+
+### Return type
+
+**ForgetPasswordVerificationResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **authControllerLogin**
+> LoginResponseDTO authControllerLogin(loginRequestDTO)
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration,
+    LoginRequestDTO
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let loginRequestDTO: LoginRequestDTO; //
+
+const { status, data } = await apiInstance.authControllerLogin(
+    loginRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **loginRequestDTO** | **LoginRequestDTO**|  | |
+
+
+### Return type
+
+**LoginResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **authControllerOAuthLogin**
+> LoginResponseDTO authControllerOAuthLogin(oAuthLoginRequestDTO)
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration,
+    OAuthLoginRequestDTO
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let oAuthLoginRequestDTO: OAuthLoginRequestDTO; //
+
+const { status, data } = await apiInstance.authControllerOAuthLogin(
+    oAuthLoginRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **oAuthLoginRequestDTO** | **OAuthLoginRequestDTO**|  | |
+
+
+### Return type
+
+**LoginResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **authControllerResetPassword**
+> BooleanResponseDTO authControllerResetPassword(resetPasswordRequestDTO)
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration,
+    ResetPasswordRequestDTO
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let resetPasswordRequestDTO: ResetPasswordRequestDTO; //
+
+const { status, data } = await apiInstance.authControllerResetPassword(
+    resetPasswordRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **resetPasswordRequestDTO** | **ResetPasswordRequestDTO**|  | |
+
+
+### Return type
+
+**BooleanResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **authControllerSignup**
+> SignupResponseDTO authControllerSignup(signupRequestDTO)
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration,
+    SignupRequestDTO
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let signupRequestDTO: SignupRequestDTO; //
+
+const { status, data } = await apiInstance.authControllerSignup(
+    signupRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **signupRequestDTO** | **SignupRequestDTO**|  | |
+
+
+### Return type
+
+**SignupResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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/BadRequestExceptionResponse.md

@@ -0,0 +1,22 @@
+# BadRequestExceptionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [default to 'Bad Request. Check Input']
+**errors** | **object** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BadRequestExceptionResponse } from '@nestbox-ai/admin';
+
+const instance: BadRequestExceptionResponse = {
+    message,
+    errors,
+};
+```
+
+[[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/BooleanResponseDTO.md

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

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

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

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

@@ -0,0 +1,42 @@
+# CreateMachineAgentDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agentName** | **string** |  | [default to undefined]
+**goal** | **string** |  | [default to undefined]
+**modelBaseId** | **string** |  | [default to undefined]
+**machineName** | **string** |  | [default to undefined]
+**machineInstanceId** | **number** |  | [default to undefined]
+**instanceIP** | **string** |  | [default to undefined]
+**entryFunctionName** | **string** |  | [default to undefined]
+**machineManifestId** | **string** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+**parameters** | **Array<object>** |  | [default to undefined]
+**projectId** | **string** |  | [default to undefined]
+**userId** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateMachineAgentDto } from '@nestbox-ai/admin';
+
+const instance: CreateMachineAgentDto = {
+    agentName,
+    goal,
+    modelBaseId,
+    machineName,
+    machineInstanceId,
+    instanceIP,
+    entryFunctionName,
+    machineManifestId,
+    type,
+    parameters,
+    projectId,
+    userId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)