API de Convites

Este módulo da API gerencia o envio e a gestão de convites gerais no sistema Finvy, permitindo que usuários convidem outros para a plataforma ou para funcionalidades específicas.

Objeto Convite

Atributo	Tipo	Descrição
id	string	O ID único do convite (UUID).
email	string	O e-mail do convidado.
status	string	O status do convite (pending, accepted, expired).
created_at	string	A data e hora em que o convite foi criado.
expires_at	string	A data e hora em que o convite expira.
invited_by_user_id	string	O ID do usuário que enviou o convite.
metadata	object	Dados adicionais associados ao convite (ex: organization_id, period_id).

Endpoints

• Enviar Convite: Envia um novo convite para um endereço de e-mail.
  • POST /api/invitations
  • Corpo da Requisição: {"email": "convidado@example.com", "role": "member", "metadata": { ... }}
  • Resposta: Objeto Convite criado.
• Listar Convites: Retorna uma lista de convites enviados pelo usuário autenticado.
  • GET /api/invitations
  • Resposta: Array de objetos Convite.
• Revogar Convite: Revoga um convite pendente.
  • DELETE /api/invitations/{id}
  • Resposta: 204 No Content.

Códigos de Status HTTP

• 200 OK: Requisição bem-sucedida (GET).
• 201 Created: Convite enviado com sucesso (POST).
• 204 No Content: Convite revogado com sucesso (DELETE).
• 400 Bad Request: Dados da requisição inválidos.
• 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
• 403 Forbidden: Usuário não tem permissão.
• 404 Not Found: Convite não encontrado.
• 409 Conflict: Convite já existe ou e-mail já registrado.
• 500 Internal Server Error: Erro interno do servidor.