@gyramais/mcp-server 0.1.0

package/spec/openapi-external.json

@@ -0,0 +1,1007 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "GYRA+ API - MCP Server",
+    "description": "API da Gyra+ para analise de credito. Spec curada para uso com agentes AI via MCP.",
+    "version": "1.0",
+    "contact": {}
+  },
+  "servers": [],
+  "paths": {
+    "/auth/authenticate": {
+      "post": {
+        "operationId": "AuthController_generateAccessToken",
+        "parameters": [
+          {
+            "name": "gyra-client-secret",
+            "in": "header",
+            "description": "Client Secret da integracao. Obtido no painel Toolbox em Configuracoes > Integracao.",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "gyra-client-id",
+            "in": "header",
+            "description": "Client ID da integracao. Obtido no painel Toolbox em Configuracoes > Integracao.",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Objeto com accessToken (JWT) e expiresIn (tempo em segundos)."
+          }
+        },
+        "tags": [
+          "auth"
+        ],
+        "summary": "Gerar token de acesso JWT",
+        "description": "Autentica via client credentials (client-id e client-secret) e retorna um JWT.\n\nEste e o primeiro passo para usar a API. O token retornado deve ser enviado\nno header Authorization de todas as requisicoes subsequentes.\n\nNOTA: No MCP server, a autenticacao e automatica — este tool e exposto apenas\npara uso manual ou debug. O server gerencia o token internamente."
+      }
+    },
+    "/integration/credential": {
+      "post": {
+        "operationId": "CredentialController_create",
+        "parameters": [],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Credencial criada com id, nome, tipo e status."
+          }
+        },
+        "tags": [
+          "integration/credential"
+        ],
+        "security": [
+          {
+            "authorization": []
+          }
+        ],
+        "summary": "Criar credencial de integracao",
+        "description": "Cria uma credencial para integracao com servicos externos (Serasa, SCR, etc.).\n\nCredenciais sao necessarias para que o Gyra+ consulte fontes de dados externas\ndurante a geracao de relatorios. O tipo de integracao determina quais dados\nserao consultados.\n\nRequer permissao can-manage-settings."
+      },
+      "get": {
+        "operationId": "CredentialController_findAll",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "Array de credenciais com id, nome, tipo e integrationType."
+          }
+        },
+        "tags": [
+          "integration/credential"
+        ],
+        "security": [
+          {
+            "authorization": []
+          }
+        ],
+        "summary": "Listar credenciais de integracao",
+        "description": "Lista todas as credenciais de integracao da organizacao.\nRetorna os metadados das credenciais (sem senhas expostas)."
+      }
+    },
+    "/integration/credential/{id}": {
+      "get": {
+        "operationId": "CredentialController_findOne",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            },
+            "description": "ID da credencial."
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Credencial com id, nome, tipo, integrationType e metadados."
+          }
+        },
+        "tags": [
+          "integration/credential"
+        ],
+        "security": [
+          {
+            "authorization": []
+          }
+        ],
+        "summary": "Consultar credencial por ID",
+        "description": "Retorna detalhes de uma credencial de integracao especifica."
+      },
+      "put": {
+        "operationId": "CredentialController_update",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            },
+            "description": "ID da credencial a atualizar."
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/EditDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Credencial atualizada."
+          }
+        },
+        "tags": [
+          "integration/credential"
+        ],
+        "security": [
+          {
+            "authorization": []
+          }
+        ],
+        "summary": "Atualizar credencial de integracao",
+        "description": "Atualiza uma credencial de integracao existente.\nPode alterar nome, tipo ou as credenciais de acesso (username/password)."
+      },
+      "delete": {
+        "operationId": "CredentialController_delete",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            },
+            "description": "ID da credencial a remover."
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Confirmacao de remocao."
+          }
+        },
+        "tags": [
+          "integration/credential"
+        ],
+        "security": [
+          {
+            "authorization": []
+          }
+        ],
+        "summary": "Deletar credencial de integracao",
+        "description": "Remove uma credencial de integracao. Relatorios futuros que dependam\ndesta integracao podem falhar se nao houver outra credencial configurada."
+      }
+    },
+    "/webhook": {
+      "post": {
+        "operationId": "WebhookController_create",
+        "parameters": [],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateWebhookDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Webhook criado com id, type, url e organizationId."
+          }
+        },
+        "tags": [
+          "webhook"
+        ],
+        "summary": "Criar webhook para notificacoes",
+        "description": "Registra uma URL de webhook para receber notificacoes em tempo real.\n\nTipos de webhook disponiveis:\n- REPORT: notificado quando um relatorio muda de status (PENDING → APPROVED/DENIED/ALERT)\n- REPORT_FINISHED: notificado quando o processamento do relatorio finaliza\n- REPORT_STATUS: notificado em cada mudanca de status intermediaria\n- CREDIT_POLICY: notificado quando a politica de credito e avaliada\n- OPTIN: notificado quando um opt-in e processado\n\nO webhook recebe um POST na URL configurada com o payload do evento.\nSe apiKey for informada, sera enviada no header api-key da requisicao.\n\nRECOMENDADO: Sempre configure um webhook ao criar relatorios. Evita\na necessidade de polling com get_report."
+      }
+    },
+    "/webhook/findBy": {
+      "get": {
+        "operationId": "WebhookController_find",
+        "parameters": [
+          {
+            "name": "webhookId",
+            "required": false,
+            "in": "query",
+            "description": "ID do webhook especifico (opcional). Sem este parametro, retorna todos.",
+            "example": "664b63037707171ba58cf311",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Webhook(s) com id, type, url, apiKey e organizationId."
+          }
+        },
+        "tags": [
+          "webhook"
+        ],
+        "summary": "Consultar webhooks cadastrados",
+        "description": "Busca webhooks cadastrados na organizacao.\n\nSe webhookId for informado, retorna o webhook especifico.\nCaso contrario, retorna todos os webhooks da organizacao autenticada."
+      }
+    },
+    "/webhook/{id}": {
+      "delete": {
+        "operationId": "WebhookController_delete",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "description": "ID do webhook a remover.",
+            "example": "664b63037707171ba58cf311",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Confirmacao de remocao."
+          }
+        },
+        "tags": [
+          "webhook"
+        ],
+        "summary": "Deletar webhook",
+        "description": "Remove um webhook cadastrado. A URL deixa de receber notificacoes imediatamente."
+      }
+    },
+    "/report/section/{id}": {
+      "get": {
+        "operationId": "SectionController_get",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            },
+            "description": "ID da secao (ObjectId). Disponivel no array sections[] do relatorio."
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Secao completa com dados detalhados, status de finalizacao e metadados."
+          }
+        },
+        "tags": [
+          "report"
+        ],
+        "security": [
+          {
+            "authorization": []
+          }
+        ],
+        "summary": "Consultar secao por ID",
+        "description": "Retorna os dados detalhados de uma secao especifica de um relatorio.\n\nCada relatorio e composto por varias secoes que contem dados de diferentes fontes:\n- Informacoes basicas (CNPJ/CPF, endereco, socios, QSA)\n- Processos judiciais\n- Protestos em cartorio\n- Dividas Pefin/Refin (Serasa)\n- Dados SCR (Banco Central)\n- PEP e sancoes internacionais\n- Resultado da politica de credito\n\nUse get_report para obter a lista de secoes e seus IDs."
+      }
+    },
+    "/report": {
+      "post": {
+        "operationId": "ReportController_create",
+        "parameters": [],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateReportDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Objeto do relatorio com id, status (PENDING), document, type e createdAt."
+          }
+        },
+        "tags": [
+          "report"
+        ],
+        "security": [
+          {
+            "authorization": []
+          }
+        ],
+        "summary": "Criar relatorio de analise de credito",
+        "description": "Cria um novo relatorio de analise de credito para um CPF ou CNPJ.\n\nO processamento e ASSINCRONO: voce recebe o reportId imediatamente com status PENDING.\nPara saber quando o relatorio ficou pronto:\n  1. Configure um webhook (create_webhook) para receber notificacao automatica\n  2. Ou consulte periodicamente com get_report ate o status mudar\n\nStatus possiveis: PENDING → APPROVED, DENIED ou ALERT.\nO tipo de relatorio (SIMPLES, ESSENCIAL, COMPLETO, COMPLETO+) e determinado\npela politica de credito (policyId) utilizada.\n\nUse list_policies para obter os policyIds disponiveis na organizacao."
+      }
+    },
+    "/report/list": {
+      "get": {
+        "operationId": "ReportController_list",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "Array de relatorios com metadados (sem secoes detalhadas)."
+          }
+        },
+        "tags": [
+          "report"
+        ],
+        "security": [
+          {
+            "authorization": []
+          }
+        ],
+        "summary": "Listar relatorios da organizacao",
+        "description": "Lista relatorios com filtros opcionais. Retorna relatorios da organizacao\nautenticada. Analistas de credito veem apenas os proprios relatorios.\n\nSuporta paginacao e filtros por status, documento, periodo etc."
+      }
+    },
+    "/report/count": {
+      "get": {
+        "operationId": "ReportController_count",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "Objeto com count (numero de relatorios)."
+          }
+        },
+        "tags": [
+          "report"
+        ],
+        "security": [
+          {
+            "authorization": []
+          }
+        ],
+        "summary": "Contar relatorios",
+        "description": "Retorna a contagem de relatorios que correspondem aos filtros aplicados.\nUtil para dashboards e analytics sem carregar os dados completos."
+      }
+    },
+    "/report/export/{id}": {
+      "get": {
+        "operationId": "ReportController_export",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            },
+            "description": "ID do relatorio a exportar."
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "HTTP 202 Accepted. O arquivo sera processado em background."
+          }
+        },
+        "tags": [
+          "report"
+        ],
+        "security": [
+          {
+            "authorization": []
+          }
+        ],
+        "summary": "Exportar relatorio",
+        "description": "Exporta um relatorio em formato PDF ou Excel.\n\nA exportacao e processada de forma assincrona (retorna HTTP 202 Accepted).\nO arquivo sera enviado por email ou disponibilizado para download."
+      }
+    },
+    "/report/{id}": {
+      "get": {
+        "operationId": "ReportController_get",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            },
+            "description": "ID do relatorio (ObjectId). Retornado pelo create_report."
+          },
+          {
+            "name": "details",
+            "required": false,
+            "in": "query",
+            "description": "Defina como \"false\" para omitir detalhes das secoes. Util para verificar status rapidamente.",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Relatorio completo com secoes, decisao e metadados."
+          }
+        },
+        "tags": [
+          "report"
+        ],
+        "security": [
+          {
+            "authorization": []
+          }
+        ],
+        "summary": "Consultar relatorio por ID",
+        "description": "Retorna o relatorio completo com secoes, decisao da politica e score.\n\nSe o relatorio esta em processamento, o status sera PENDING.\nQuando pronto, o objeto retornado contem:\n- status: APPROVED, DENIED ou ALERT\n- policyResult: decisao automatica com regras avaliadas\n- sections[]: array de secoes (BASIC_INFORMATION, PROCESSES, PROTESTS, SCR, etc.)\n- commentary: analise do analista (se houver)\n\nUse details=false para obter apenas metadados sem o conteudo das secoes."
+      }
+    },
+    "/report/{id}/section/{sectionType}": {
+      "get": {
+        "operationId": "ReportController_getReportSection",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            },
+            "description": "ID do relatorio."
+          },
+          {
+            "name": "sectionType",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            },
+            "description": "Tipo da secao (ex: BASIC_INFORMATION, PROCESSES, SCR, CREDIT_POLICY)."
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Secao com dados detalhados do tipo solicitado."
+          }
+        },
+        "tags": [
+          "report"
+        ],
+        "security": [
+          {
+            "authorization": []
+          }
+        ],
+        "summary": "Consultar secao especifica do relatorio",
+        "description": "Retorna uma secao especifica de um relatorio pelo tipo.\n\nTipos de secao disponiveis:\n- BASIC_INFORMATION: dados cadastrais, endereco, socios\n- PROCESSES: processos judiciais\n- PROTESTS: protestos em cartorio\n- PEFIN_REFIN: dividas Pefin/Refin (Serasa)\n- SCR: dados do Sistema de Informacoes de Credito do Banco Central\n- PEP_SANCTIONS: Pessoa Politicamente Exposta e sancoes\n- CREDIT_POLICY: resultado da avaliacao da politica de credito"
+      }
+    },
+    "/report/analyze": {
+      "post": {
+        "operationId": "ReportController_analyze",
+        "parameters": [],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/AnalyzeDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Relatorio atualizado com a analise registrada."
+          }
+        },
+        "tags": [
+          "report"
+        ],
+        "security": [
+          {
+            "authorization": []
+          }
+        ],
+        "summary": "Analisar/aprovar relatorio",
+        "description": "Registra a analise de um relatorio por um analista de credito.\n\nDefine o status de aprovacao, comentarios do analista e decisao manual.\nUsado quando a decisao automatica da politica precisa de revisao humana."
+      }
+    },
+    "/report/re-analyze": {
+      "post": {
+        "operationId": "ReportController_reAnalyze",
+        "parameters": [],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/AnalyzeDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Relatorio atualizado com a nova analise."
+          }
+        },
+        "tags": [
+          "report"
+        ],
+        "security": [
+          {
+            "authorization": []
+          }
+        ],
+        "summary": "Re-analisar relatorio",
+        "description": "Re-analisa um relatorio previamente analisado. Verifica se o usuario\ntem permissao para editar relatorios com base na politica de credito configurada.\n\nUtil quando dados adicionais foram obtidos ou a decisao precisa ser revisada."
+      }
+    },
+    "/credit-policy/policy": {
+      "get": {
+        "operationId": "PolicyController_find",
+        "parameters": [
+          {
+            "name": "enabled",
+            "required": false,
+            "in": "query",
+            "description": "Filtrar por politicas ativas. \"true\" ou \"false\" (como string).",
+            "schema": {
+              "type": "boolean"
+            }
+          },
+          {
+            "name": "protected",
+            "required": false,
+            "in": "query",
+            "description": "Incluir politicas protegidas do sistema. \"true\" ou \"false\" (como string).",
+            "schema": {
+              "type": "boolean"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Array de politicas com id, name, enabled, documentType, grupos de regras e configuracoes."
+          }
+        },
+        "tags": [
+          "credit-policy/policy"
+        ],
+        "security": [
+          {
+            "authorization": []
+          }
+        ],
+        "summary": "Listar politicas de credito",
+        "description": "Lista as politicas de credito da organizacao.\n\nCada politica define:\n- Quais fontes de dados consultar (Serasa, SCR, etc.)\n- Regras de aprovacao automatica (score, limites, restricoes)\n- Tipo de relatorio gerado (SIMPLES, ESSENCIAL, COMPLETO, COMPLETO+)\n- Grupos de regras com pesos e thresholds\n\nO policyId retornado e necessario para criar relatorios (create_report).\n\nFiltros opcionais:\n- enabled: true para ver apenas politicas ativas\n- protected: true para incluir politicas protegidas (padrao do sistema)"
+      }
+    },
+    "/credit-policy/policy/all/{id}": {
+      "put": {
+        "operationId": "PolicyController_saveBatchPolicy",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            },
+            "description": "ID da politica a salvar."
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SaveBatchPolicyDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Politica atualizada com todas as regras e configuracoes."
+          }
+        },
+        "tags": [
+          "credit-policy/policy"
+        ],
+        "summary": "Salvar politica de credito completa",
+        "description": "Salva uma politica de credito inteira com todas as regras, grupos, scores e riscos.\n\nEsta e uma operacao de batch — envia a politica completa (grupos de regras,\nconfiguracoes de score, niveis de risco, integracao) numa unica requisicao.\n\nRequer permissao can-manage-credit-policy.\n\nCUIDADO: Esta operacao sobrescreve TODA a politica. Sempre busque a politica\natual com list_policies antes de modificar."
+      }
+    },
+    "/insight": {
+      "post": {
+        "operationId": "InsightController_generateInsight",
+        "parameters": [],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/GenerateInsightDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Insight gerado com analise, pontos de atencao e recomendacoes."
+          }
+        },
+        "tags": [
+          "insight"
+        ],
+        "summary": "Gerar insight com IA para secao do relatorio",
+        "description": "Gera uma analise automatica com IA para uma secao especifica de um relatorio.\n\nA IA analisa os dados da secao e produz um resumo interpretativo com\npontos de atencao e recomendacoes. O insight e salvo como comentario\nna secao do relatorio.\n\nRequisitos:\n- A secao deve estar finalizada (processamento completo)\n- A organizacao deve ter plano que suporte IA (nao disponivel em planos Trial ou Basic)\n\nUse get_report para obter os IDs das secoes disponiveis."
+      }
+    },
+    "/insight/review": {
+      "post": {
+        "operationId": "InsightController_reviewInsight",
+        "parameters": [],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ReviewInsightDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Insight atualizado com a avaliacao registrada."
+          }
+        },
+        "tags": [
+          "insight"
+        ],
+        "summary": "Avaliar insight gerado pela IA",
+        "description": "Submete uma avaliacao (review) para um insight gerado pela IA.\n\nPermite que analistas avaliem a qualidade e relevancia do insight automatico,\ncontribuindo para melhoria continua do modelo."
+      }
+    }
+  },
+  "components": {
+    "securitySchemes": {
+      "authorization": {
+        "scheme": "Bearer",
+        "bearerFormat": "JWT",
+        "type": "apiKey",
+        "name": "authorization",
+        "description": "Enter JWT token",
+        "in": "header"
+      }
+    },
+    "schemas": {
+      "CreateDto": {
+        "type": "object",
+        "properties": {}
+      },
+      "EditDto": {
+        "type": "object",
+        "properties": {}
+      },
+      "CreateWebhookDto": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "$ref": "#/components/schemas/WebhookTypeEnum"
+          },
+          "url": {
+            "type": "string",
+            "description": "The URL for the webhook",
+            "example": "https://webhook-test.com/a0a7aadb8de3e"
+          },
+          "apiKey": {
+            "type": "string",
+            "description": "API Key para uma requisição autenticada (será enviado como `api-key` em headers)",
+            "example": "xxx-xxx-xxx"
+          }
+        },
+        "required": [
+          "type",
+          "url",
+          "apiKey"
+        ]
+      },
+      "WebhookTypeEnum": {
+        "type": "string",
+        "description": "Type Webhook",
+        "enum": [
+          "REPORT",
+          "OPTIN",
+          "CREDIT_POLICY",
+          "REPORT_STATUS",
+          "REPORT_FINISHED",
+          "OPERATION"
+        ]
+      },
+      "CreateReportDto": {
+        "type": "object",
+        "properties": {
+          "policyId": {
+            "type": "string"
+          },
+          "document": {
+            "type": "string"
+          },
+          "type": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "policyId",
+          "document",
+          "type"
+        ]
+      },
+      "SaveBatchPolicyDto": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "userId": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "scoreEnabled": {
+            "type": "boolean"
+          },
+          "useResultToReport": {
+            "type": "boolean"
+          },
+          "integrationGroupName": {
+            "type": "string"
+          },
+          "documentType": {
+            "type": "string"
+          },
+          "policyRuleGroups": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SaveBatchGroupDto"
+            }
+          },
+          "risks": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SaveBatchRiskDto"
+            }
+          },
+          "integrationGroup": {
+            "$ref": "#/components/schemas/SaveBatchIntegrationGroup"
+          },
+          "productTypeId": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "id",
+          "userId",
+          "name",
+          "scoreEnabled",
+          "useResultToReport",
+          "integrationGroupName",
+          "documentType",
+          "policyRuleGroups",
+          "risks",
+          "integrationGroup",
+          "productTypeId"
+        ]
+      },
+      "SaveBatchGroupDto": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "userId": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "scoreApproved": {
+            "type": "number"
+          },
+          "scoreAlert": {
+            "type": "number"
+          },
+          "scoreDenied": {
+            "type": "number"
+          },
+          "policyId": {
+            "type": "string"
+          },
+          "policyRuleSettingJoins": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SaveBatchRuleSettingJoinDto"
+            }
+          }
+        },
+        "required": [
+          "id",
+          "userId",
+          "name",
+          "scoreApproved",
+          "scoreAlert",
+          "scoreDenied",
+          "policyId",
+          "policyRuleSettingJoins"
+        ]
+      },
+      "SaveBatchRuleSettingJoinDto": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "statusToApply": {
+            "type": "string"
+          },
+          "errorStatusToApply": {
+            "type": "string"
+          },
+          "operationType": {
+            "type": "string"
+          },
+          "policyRuleSettings": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SaveBatchRuleSettingDto"
+            }
+          }
+        },
+        "required": [
+          "id",
+          "statusToApply",
+          "errorStatusToApply",
+          "operationType",
+          "policyRuleSettings"
+        ]
+      },
+      "SaveBatchRuleSettingDto": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "params": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ParamsSettingDto"
+            }
+          },
+          "typeRuleId": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "id",
+          "params",
+          "typeRuleId"
+        ]
+      },
+      "ParamsSettingDto": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string"
+          },
+          "value": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "key",
+          "value"
+        ]
+      },
+      "SaveBatchRiskDto": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "from": {
+            "type": "number"
+          },
+          "to": {
+            "type": "number"
+          },
+          "statusToApply": {
+            "type": "string"
+          },
+          "removed": {
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "id",
+          "name",
+          "from",
+          "to",
+          "statusToApply",
+          "removed"
+        ]
+      },
+      "SaveBatchIntegrationGroup": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "bureauId": {
+            "type": "string"
+          },
+          "bureauType": {
+            "type": "string"
+          },
+          "hasSCR": {
+            "type": "boolean"
+          },
+          "scrMonths": {
+            "type": "number"
+          },
+          "externalIntegrationEnabled": {
+            "type": "boolean"
+          },
+          "externalIntegrationIds": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "balanceRuleEnabled": {
+            "type": "boolean"
+          },
+          "postPolicyActionsEnabled": {
+            "type": "boolean"
+          },
+          "periodFormula": {
+            "type": "string"
+          },
+          "interestFormula": {
+            "type": "string"
+          },
+          "amountFormula": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "name"
+        ]
+      },
+      "GenerateInsightDto": {
+        "type": "object",
+        "properties": {}
+      },
+      "ReviewInsightDto": {
+        "type": "object",
+        "properties": {}
+      }
+    }
+  }
+}