@nestbox-ai/admin 1.0.39 → 1.0.47

package/docs/QueriesAndDocumentationsApi.md

@@ -0,0 +1,125 @@
+# QueriesAndDocumentationsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**queriesAndDocControllerFetchSwaggerJSON**](#queriesanddoccontrollerfetchswaggerjson) | **GET** /projects/{projectId}/{fieldName}/{modelId}/swagger | Fetch Swagger JSON|
+|[**queriesAndDocControllerRunQuery**](#queriesanddoccontrollerrunquery) | **POST** /projects/{projectId}/queries | Run Query|
+
+# **queriesAndDocControllerFetchSwaggerJSON**
+> object queriesAndDocControllerFetchSwaggerJSON()
+
+
+### Example
+
+```typescript
+import {
+    QueriesAndDocumentationsApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new QueriesAndDocumentationsApi(configuration);
+
+let modelId: string; // (default to undefined)
+let projectId: string; // (default to undefined)
+let fieldName: string; // (default to undefined)
+
+const { status, data } = await apiInstance.queriesAndDocControllerFetchSwaggerJSON(
+    modelId,
+    projectId,
+    fieldName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **modelId** | [**string**] |  | defaults to undefined|
+| **projectId** | [**string**] |  | defaults to undefined|
+| **fieldName** | [**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)
+
+# **queriesAndDocControllerRunQuery**
+> CreateWebhookDto queriesAndDocControllerRunQuery()
+
+
+### Example
+
+```typescript
+import {
+    QueriesAndDocumentationsApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new QueriesAndDocumentationsApi(configuration);
+
+let projectId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.queriesAndDocControllerRunQuery(
+    projectId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**CreateWebhookDto**
+
+### 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/ResetPasswordRequestDTO.md

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

package/docs/ResourceDTO.md

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

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

@@ -0,0 +1,372 @@
+# RolesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**rolesControllerCreateProjectRole**](#rolescontrollercreateprojectrole) | **POST** /projects/{projectId}/roles | Create a new role|
+|[**rolesControllerDeleteProjectRole**](#rolescontrollerdeleteprojectrole) | **DELETE** /projects/{projectId}/roles/{roleId} | Delete Project Role|
+|[**rolesControllerGetAllProjectRoles**](#rolescontrollergetallprojectroles) | **GET** /projects/{projectId}/roles | Retrieve all roles|
+|[**rolesControllerGetProjectRoleById**](#rolescontrollergetprojectrolebyid) | **GET** /projects/{projectId}/roles/{roleId} | Retrieve a role by ID|
+|[**rolesControllerGetUserProjectRole**](#rolescontrollergetuserprojectrole) | **GET** /projects/{id}/members/role | Retrieve the role of a specific member|
+|[**rolesControllerUpdateProjectRoleById**](#rolescontrollerupdateprojectrolebyid) | **PATCH** /projects/{projectId}/roles/{roleId} | Update a role|
+
+# **rolesControllerCreateProjectRole**
+> CreateProjectRoleResponseDto rolesControllerCreateProjectRole(createRoleDto)
+
+
+### Example
+
+```typescript
+import {
+    RolesApi,
+    Configuration,
+    CreateRoleDto
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new RolesApi(configuration);
+
+let projectId: string; // (default to undefined)
+let createRoleDto: CreateRoleDto; //
+
+const { status, data } = await apiInstance.rolesControllerCreateProjectRole(
+    projectId,
+    createRoleDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createRoleDto** | **CreateRoleDto**|  | |
+| **projectId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**CreateProjectRoleResponseDto**
+
+### 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)
+
+# **rolesControllerDeleteProjectRole**
+> DeleteProjectRoleByIdResponseDto rolesControllerDeleteProjectRole()
+
+
+### Example
+
+```typescript
+import {
+    RolesApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new RolesApi(configuration);
+
+let projectId: string; // (default to undefined)
+let roleId: number; // (default to undefined)
+
+const { status, data } = await apiInstance.rolesControllerDeleteProjectRole(
+    projectId,
+    roleId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | [**string**] |  | defaults to undefined|
+| **roleId** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+**DeleteProjectRoleByIdResponseDto**
+
+### 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)
+
+# **rolesControllerGetAllProjectRoles**
+> GetAllProjectRoleResponseDto rolesControllerGetAllProjectRoles()
+
+
+### Example
+
+```typescript
+import {
+    RolesApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new RolesApi(configuration);
+
+let projectId: string; // (default to undefined)
+let page: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+let column: string; // (optional) (default to undefined)
+let direction: 'ASC' | 'DESC'; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.rolesControllerGetAllProjectRoles(
+    projectId,
+    page,
+    limit,
+    column,
+    direction
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | [**string**] |  | defaults to undefined|
+| **page** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+| **column** | [**string**] |  | (optional) defaults to undefined|
+| **direction** | [**&#39;ASC&#39; | &#39;DESC&#39;**]**Array<&#39;ASC&#39; &#124; &#39;DESC&#39;>** |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetAllProjectRoleResponseDto**
+
+### 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)
+
+# **rolesControllerGetProjectRoleById**
+> GetProjectRoleByIdResponseDto rolesControllerGetProjectRoleById()
+
+
+### Example
+
+```typescript
+import {
+    RolesApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new RolesApi(configuration);
+
+let projectId: string; // (default to undefined)
+let roleId: number; // (default to undefined)
+
+const { status, data } = await apiInstance.rolesControllerGetProjectRoleById(
+    projectId,
+    roleId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | [**string**] |  | defaults to undefined|
+| **roleId** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+**GetProjectRoleByIdResponseDto**
+
+### 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)
+
+# **rolesControllerGetUserProjectRole**
+> GetUserProjectRoleByRoleIdResponseDto rolesControllerGetUserProjectRole()
+
+
+### Example
+
+```typescript
+import {
+    RolesApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new RolesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.rolesControllerGetUserProjectRole(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**GetUserProjectRoleByRoleIdResponseDto**
+
+### 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)
+
+# **rolesControllerUpdateProjectRoleById**
+> UpdateProjectRoleResponseDto rolesControllerUpdateProjectRoleById(updateRoleByIdDto)
+
+
+### Example
+
+```typescript
+import {
+    RolesApi,
+    Configuration,
+    UpdateRoleByIdDto
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new RolesApi(configuration);
+
+let projectId: string; // (default to undefined)
+let roleId: number; // (default to undefined)
+let updateRoleByIdDto: UpdateRoleByIdDto; //
+
+const { status, data } = await apiInstance.rolesControllerUpdateProjectRoleById(
+    projectId,
+    roleId,
+    updateRoleByIdDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateRoleByIdDto** | **UpdateRoleByIdDto**|  | |
+| **projectId** | [**string**] |  | defaults to undefined|
+| **roleId** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+**UpdateProjectRoleResponseDto**
+
+### 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/SignupRequestDTO.md

@@ -0,0 +1,36 @@
+# SignupRequestDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**firstName** | **string** |  | [default to undefined]
+**lastName** | **string** |  | [default to undefined]
+**phone** | **string** |  | [default to undefined]
+**providerId** | **string** |  | [optional] [default to undefined]
+**providerType** | **string** |  | [optional] [default to undefined]
+**image** | **string** |  | [optional] [default to undefined]
+**profilePictureUrl** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SignupRequestDTO } from '@nestbox-ai/admin';
+
+const instance: SignupRequestDTO = {
+    email,
+    password,
+    firstName,
+    lastName,
+    phone,
+    providerId,
+    providerType,
+    image,
+    profilePictureUrl,
+};
+```
+
+[[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/SignupResponseDTO.md

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

@@ -0,0 +1,26 @@
+# SimilaritySearchQueryDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | **string** |  | [default to undefined]
+**params** | **object** |  | [default to undefined]
+**filter** | **object** |  | [default to undefined]
+**include** | **Array<string>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SimilaritySearchQueryDTO } from '@nestbox-ai/admin';
+
+const instance: SimilaritySearchQueryDTO = {
+    query,
+    params,
+    filter,
+    include,
+};
+```
+
+[[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/TeamMemberDto.md

@@ -0,0 +1,26 @@
+# TeamMemberDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [default to undefined]
+**status** | **string** |  | [default to undefined]
+**user** | [**UserDto**](UserDto.md) |  | [default to undefined]
+**role** | [**RoleDto**](RoleDto.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { TeamMemberDto } from '@nestbox-ai/admin';
+
+const instance: TeamMemberDto = {
+    id,
+    status,
+    user,
+    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/UnauthorizedExceptionResponse.md

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