@nestbox-ai/admin 1.0.39 → 1.0.47

package/docs/MachineInstancesApi.md

@@ -0,0 +1,361 @@
+# MachineInstancesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**machineInstancesControllerCreateMachineInstance**](#machineinstancescontrollercreatemachineinstance) | **POST** /projects/{projectId}/instances | Create Machine Instance|
+|[**machineInstancesControllerDeleteMachineInstance**](#machineinstancescontrollerdeletemachineinstance) | **DELETE** /projects/{projectId}/instances | Delete machine instances by ids|
+|[**machineInstancesControllerGetInstanceRunningStatus**](#machineinstancescontrollergetinstancerunningstatus) | **GET** /projects/{projectId}/instances/status | Retrieve running status of instances|
+|[**machineInstancesControllerGetMachineInstanceById**](#machineinstancescontrollergetmachineinstancebyid) | **GET** /projects/{projectId}/instances/machine/{machineId} | Retrieve running status of instances|
+|[**machineInstancesControllerGetMachineInstanceByUserId**](#machineinstancescontrollergetmachineinstancebyuserid) | **GET** /projects/{projectId}/instances | Retrieve all machine instances with count|
+|[**machineInstancesControllerUpdateRunningStatus**](#machineinstancescontrollerupdaterunningstatus) | **PUT** /projects/{projectId}/instances/status | Update Machine Instance Running Status|
+
+# **machineInstancesControllerCreateMachineInstance**
+> object machineInstancesControllerCreateMachineInstance()
+
+
+### Example
+
+```typescript
+import {
+    MachineInstancesApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new MachineInstancesApi(configuration);
+
+let projectId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.machineInstancesControllerCreateMachineInstance(
+    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)
+
+# **machineInstancesControllerDeleteMachineInstance**
+> object machineInstancesControllerDeleteMachineInstance()
+
+
+### Example
+
+```typescript
+import {
+    MachineInstancesApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new MachineInstancesApi(configuration);
+
+let projectId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.machineInstancesControllerDeleteMachineInstance(
+    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)
+
+# **machineInstancesControllerGetInstanceRunningStatus**
+> object machineInstancesControllerGetInstanceRunningStatus()
+
+
+### Example
+
+```typescript
+import {
+    MachineInstancesApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new MachineInstancesApi(configuration);
+
+let projectId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.machineInstancesControllerGetInstanceRunningStatus(
+    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)
+
+# **machineInstancesControllerGetMachineInstanceById**
+> object machineInstancesControllerGetMachineInstanceById()
+
+
+### Example
+
+```typescript
+import {
+    MachineInstancesApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new MachineInstancesApi(configuration);
+
+let projectId: string; // (default to undefined)
+let machineId: string; // (default to undefined)
+let page: number; // (default to undefined)
+let limit: number; // (default to undefined)
+
+const { status, data } = await apiInstance.machineInstancesControllerGetMachineInstanceById(
+    projectId,
+    machineId,
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | [**string**] |  | defaults to undefined|
+| **machineId** | [**string**] |  | defaults to undefined|
+| **page** | [**number**] |  | defaults to undefined|
+| **limit** | [**number**] |  | 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)
+
+# **machineInstancesControllerGetMachineInstanceByUserId**
+> object machineInstancesControllerGetMachineInstanceByUserId()
+
+
+### Example
+
+```typescript
+import {
+    MachineInstancesApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new MachineInstancesApi(configuration);
+
+let projectId: string; // (default to undefined)
+let page: number; // (default to undefined)
+let limit: number; // (default to undefined)
+
+const { status, data } = await apiInstance.machineInstancesControllerGetMachineInstanceByUserId(
+    projectId,
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | [**string**] |  | defaults to undefined|
+| **page** | [**number**] |  | defaults to undefined|
+| **limit** | [**number**] |  | 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)
+
+# **machineInstancesControllerUpdateRunningStatus**
+> object machineInstancesControllerUpdateRunningStatus(body)
+
+
+### Example
+
+```typescript
+import {
+    MachineInstancesApi,
+    Configuration
+} from '@nestbox-ai/admin';
+
+const configuration = new Configuration();
+const apiInstance = new MachineInstancesApi(configuration);
+
+let projectId: string; // (default to undefined)
+let body: object; //
+
+const { status, data } = await apiInstance.machineInstancesControllerUpdateRunningStatus(
+    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/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)