Spaces:
Sleeping
Sleeping
| import { | |
| Controller, | |
| Get, | |
| Post, | |
| Put, | |
| Delete, | |
| Param, | |
| Body, | |
| UseGuards, | |
| Request, | |
| ParseIntPipe, | |
| } from '@nestjs/common'; | |
| import { | |
| ApiTags, | |
| ApiBearerAuth, | |
| ApiOperation, | |
| ApiResponse, | |
| ApiParam, | |
| } from '@nestjs/swagger'; | |
| import { JwtAuthGuard } from '../../auth/guards/jwt-auth.guard'; | |
| import { RolesGuard } from '../../auth/guards/roles.guard'; | |
| import { Roles } from '../../../common/decorators/roles.decorator'; | |
| import { RoleName } from '../../auth/entities/role.entity'; | |
| import { IntegrationsService } from '../services/integrations.service'; | |
| import { CreateIntegrationDto, UpdateIntegrationDto } from '../dto/create-integration.dto'; | |
| ('🔌 Integrations') | |
| ('JWT-auth') | |
| ('api/integrations') | |
| (JwtAuthGuard, RolesGuard) | |
| export class IntegrationsController { | |
| constructor(private readonly integrationsService: IntegrationsService) {} | |
| () | |
| (RoleName.ADMIN, RoleName.IT_ADMIN) | |
| ({ | |
| summary: 'Get all API integrations', | |
| description: 'Retrieves complete list of established interconnected APIs integrations configs mapping provider keys. Access rules: ADMIN, IT_ADMIN. Uses table: `api_integrations`.', | |
| }) | |
| ({ status: 200, description: 'Integrations returned' }) | |
| async getAll() { | |
| return this.integrationsService.getAll(); | |
| } | |
| () | |
| (RoleName.IT_ADMIN) | |
| ({ | |
| summary: 'Create a new API integration', | |
| description: 'Registers brand new secret external API connections encrypted in storage structure for integrations like SSO/LMS. Access rules: IT_ADMIN. Uses table: `api_integrations`.', | |
| }) | |
| ({ status: 201, description: 'Integration created' }) | |
| async create(() dto: CreateIntegrationDto, () req) { | |
| const userId = req.user.userId || req.user.id; | |
| return this.integrationsService.create(dto, userId); | |
| } | |
| (':id') | |
| (RoleName.ADMIN, RoleName.IT_ADMIN) | |
| ({ | |
| summary: 'Get a specific integration', | |
| description: 'Queries integration specific detail payload configs. Access rules: ADMIN, IT_ADMIN. Uses table: `api_integrations`.', | |
| }) | |
| ({ name: 'id', type: Number }) | |
| ({ status: 200, description: 'Integration returned' }) | |
| async getById(('id', ParseIntPipe) id: number) { | |
| return this.integrationsService.getById(id); | |
| } | |
| (':id') | |
| (RoleName.IT_ADMIN) | |
| ({ | |
| summary: 'Update an integration', | |
| description: 'Changes values stored to connected integrations structures mappings. Access rules: IT_ADMIN. Uses table: `api_integrations`.', | |
| }) | |
| ({ name: 'id', type: Number }) | |
| ({ status: 200, description: 'Integration updated' }) | |
| async update( | |
| ('id', ParseIntPipe) id: number, | |
| () dto: UpdateIntegrationDto, | |
| () req, | |
| ) { | |
| const userId = req.user.userId || req.user.id; | |
| return this.integrationsService.update(id, dto, userId); | |
| } | |
| (':id') | |
| (RoleName.IT_ADMIN) | |
| ({ | |
| summary: 'Delete an integration', | |
| description: 'Destroy existing integration parameters rendering connected systems unusable instantly. Access rules: IT_ADMIN. Uses table: `api_integrations`.', | |
| }) | |
| ({ name: 'id', type: Number }) | |
| ({ status: 200, description: 'Integration deleted' }) | |
| async delete(('id', ParseIntPipe) id: number) { | |
| return this.integrationsService.delete(id); | |
| } | |
| (':id/test') | |
| (RoleName.IT_ADMIN) | |
| ({ | |
| summary: 'Test integration connection', | |
| description: 'Force dispatching probe payload confirming health status of external platform. Access rules: IT_ADMIN. Uses table: `api_integrations`.', | |
| }) | |
| ({ name: 'id', type: Number }) | |
| ({ status: 200, description: 'Test result returned' }) | |
| async testConnection(('id', ParseIntPipe) id: number) { | |
| return this.integrationsService.testConnection(id); | |
| } | |
| (':id/sync') | |
| (RoleName.IT_ADMIN) | |
| ({ | |
| summary: 'Trigger integration sync', | |
| description: 'Starts external pull data mechanisms manually fetching data streams into storage contexts. Access rules: IT_ADMIN. Uses table: `api_integrations`.', | |
| }) | |
| ({ name: 'id', type: Number }) | |
| ({ status: 200, description: 'Sync triggered' }) | |
| async triggerSync(('id', ParseIntPipe) id: number) { | |
| return this.integrationsService.triggerSync(id); | |
| } | |
| } | |