@nestbox-ai/admin 1.0.38 → 1.0.42

package/docs/MembersApi.md

@@ -0,0 +1,204 @@
+# MembersApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**membersControllerAddTeamMemberToProject**](#memberscontrolleraddteammembertoproject) | **POST** /projects/{projectId}/members | Add a team member|
+|[**membersControllerGetAllTeamMembersOfProject**](#memberscontrollergetallteammembersofproject) | **GET** /projects/{projectId}/members | Retrieve all team members|
+|[**membersControllerUpdateTeamMemberRole**](#memberscontrollerupdateteammemberrole) | **PATCH** /projects/{projectId}/members/{memberId} | Update team member details|
+
+# **membersControllerAddTeamMemberToProject**
+> AddProjectMemberResponseDTO membersControllerAddTeamMemberToProject(addProjectMemberDto)
+
+
+### Example
+
+```typescript
+import {
+    MembersApi,
+    Configuration,
+    AddProjectMemberDto
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new MembersApi(configuration);
+
+let projectId: string; // (default to undefined)
+let addProjectMemberDto: AddProjectMemberDto; //
+
+const { status, data } = await apiInstance.membersControllerAddTeamMemberToProject(
+    projectId,
+    addProjectMemberDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **addProjectMemberDto** | **AddProjectMemberDto**|  | |
+| **projectId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**AddProjectMemberResponseDTO**
+
+### 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)
+
+# **membersControllerGetAllTeamMembersOfProject**
+> GetAllProjectMemberResponseDto membersControllerGetAllTeamMembersOfProject()
+
+
+### Example
+
+```typescript
+import {
+    MembersApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new MembersApi(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)
+let teamMemberStatus: Array<string>; // (optional) (default to undefined)
+let roleIds: Array<number>; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.membersControllerGetAllTeamMembersOfProject(
+    projectId,
+    page,
+    limit,
+    column,
+    direction,
+    teamMemberStatus,
+    roleIds
+);
+```
+
+### 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|
+| **teamMemberStatus** | **Array&lt;string&gt;** |  | (optional) defaults to undefined|
+| **roleIds** | **Array&lt;number&gt;** |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetAllProjectMemberResponseDto**
+
+### 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)
+
+# **membersControllerUpdateTeamMemberRole**
+> AddProjectMemberResponseDTO membersControllerUpdateTeamMemberRole(updateTeamMemberRequestDTO)
+
+
+### Example
+
+```typescript
+import {
+    MembersApi,
+    Configuration,
+    UpdateTeamMemberRequestDTO
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new MembersApi(configuration);
+
+let projectId: string; // (default to undefined)
+let memberId: string; // (default to undefined)
+let updateTeamMemberRequestDTO: UpdateTeamMemberRequestDTO; //
+
+const { status, data } = await apiInstance.membersControllerUpdateTeamMemberRole(
+    projectId,
+    memberId,
+    updateTeamMemberRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateTeamMemberRequestDTO** | **UpdateTeamMemberRequestDTO**|  | |
+| **projectId** | [**string**] |  | defaults to undefined|
+| **memberId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**AddProjectMemberResponseDTO**
+
+### 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/MessageResponseDTO.md

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

@@ -0,0 +1,169 @@
+# MiscellaneousApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**miscellaneousControllerGetData**](#miscellaneouscontrollergetdata) | **GET** /projects/machine/images | Get machine id matching instances.|
+|[**miscellaneousControllerGetMachineInstanceByImageId**](#miscellaneouscontrollergetmachineinstancebyimageid) | **GET** /projects/{projectId}/allMachineInstance | Get machine id matching instances.|
+|[**miscellaneousControllerUpdateTeamMemberStatus**](#miscellaneouscontrollerupdateteammemberstatus) | **PATCH** /projects/member/join | Join project|
+
+# **miscellaneousControllerGetData**
+> object miscellaneousControllerGetData()
+
+
+### Example
+
+```typescript
+import {
+    MiscellaneousApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new MiscellaneousApi(configuration);
+
+const { status, data } = await apiInstance.miscellaneousControllerGetData();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### 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)
+
+# **miscellaneousControllerGetMachineInstanceByImageId**
+> object miscellaneousControllerGetMachineInstanceByImageId()
+
+
+### Example
+
+```typescript
+import {
+    MiscellaneousApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new MiscellaneousApi(configuration);
+
+let projectId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.miscellaneousControllerGetMachineInstanceByImageId(
+    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)
+
+# **miscellaneousControllerUpdateTeamMemberStatus**
+> AddProjectMemberResponseDTO miscellaneousControllerUpdateTeamMemberStatus(updateTeamMemberStatusRequestDTO)
+
+
+### Example
+
+```typescript
+import {
+    MiscellaneousApi,
+    Configuration,
+    UpdateTeamMemberStatusRequestDTO
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new MiscellaneousApi(configuration);
+
+let updateTeamMemberStatusRequestDTO: UpdateTeamMemberStatusRequestDTO; //
+
+const { status, data } = await apiInstance.miscellaneousControllerUpdateTeamMemberStatus(
+    updateTeamMemberStatusRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateTeamMemberStatusRequestDTO** | **UpdateTeamMemberStatusRequestDTO**|  | |
+
+
+### Return type
+
+**AddProjectMemberResponseDTO**
+
+### 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/NotFoundExceptionResponse.md

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

@@ -0,0 +1,122 @@
+# NotificationsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**notificationsControllerGetLastFiveNotifications**](#notificationscontrollergetlastfivenotifications) | **GET** /projects/{projectId}/notifications | Retrieve last notifications|
+|[**notificationsControllerMarkNotificationsAsRead**](#notificationscontrollermarknotificationsasread) | **PUT** /projects/{projectId}/notifications/status | Mark notification as read|
+
+# **notificationsControllerGetLastFiveNotifications**
+> object notificationsControllerGetLastFiveNotifications()
+
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+let projectId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.notificationsControllerGetLastFiveNotifications(
+    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)
+
+# **notificationsControllerMarkNotificationsAsRead**
+> object notificationsControllerMarkNotificationsAsRead(body)
+
+
+### Example
+
+```typescript
+import {
+    NotificationsApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationsApi(configuration);
+
+let projectId: string; // (default to undefined)
+let body: object; //
+
+const { status, data } = await apiInstance.notificationsControllerMarkNotificationsAsRead(
+    projectId,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+| **projectId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**object**
+
+### 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/OAuthLoginRequestDTO.md

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

@@ -0,0 +1,28 @@
+# PermissionsDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [default to undefined]
+**read** | **boolean** |  | [default to undefined]
+**write** | **boolean** |  | [default to undefined]
+**update** | **boolean** |  | [default to undefined]
+**_delete** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PermissionsDTO } from '@nestbox-ai/admin';
+
+const instance: PermissionsDTO = {
+    id,
+    read,
+    write,
+    update,
+    _delete,
+};
+```
+
+[[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/ProjectResponseModel.md

@@ -0,0 +1,30 @@
+# ProjectResponseModel
+
+
+## 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 { ProjectResponseModel } from '@nestbox-ai/admin';
+
+const instance: ProjectResponseModel = {
+    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)