Invite

​

Campos

​

Relacionamentos

• Relaciona-se com User (como invitedBy — emissor ou responsável pelo token)
• Relaciona-se com User (como invitedUser — usuário convidado, opcional)
• Relaciona-se com Employee (quando type=EMPLOYEE)
• Relaciona-se com Organization (opcional — apenas convites de organização)
• Relaciona-se com Role (opcional — apenas type=MEMBER)
• Relaciona-se com TransportOperator (opcional — apenas type=DRIVER)

​

Regras de Negócio

• O Invite é baseado em token único, com telefone obrigatório (phoneDdi + phoneNumber) e email opcional.
• Possui data de expiração (expiresAt, padrão 7 dias) — após o vencimento, o token não pode ser aceito.
• Pode ser revogado (revokedAt) ou rejeitado (rejectedAt) enquanto ainda não foi aceito.
• organizationId diferencia convites de organização dos fluxos sem organização:
  • null + type=MEMBER representa convite interno de BKO.
  • preenchido + type=MEMBER representa convite de membro de organização.
  • preenchido + type=DRIVER representa convite de motorista.
• roleId é obrigatório para MEMBER e ausente para EMPLOYEE e DRIVER.
• transportOperatorId é usado em DRIVER para indicar o permissionário do vínculo DriverTransportOperator.
• invitedUserId é preenchido no aceite de MEMBER e DRIVER, quando o User é resolvido por telefone/email ou criado.
• O fluxo de criação de Employee só emite Invite EMPLOYEE quando email e telefone não resolvem um User existente; quando resolvem o mesmo User, o Employee é criado diretamente como ACTIVE.
• O type determina o efeito do aceite:
  • MEMBER -> concede Membership ACTIVE com a roleId do convite. Convites internos usam Role INTERNAL; convites de organização usam Role ENVIRONMENT ou ORGANIZATION.
  • EMPLOYEE -> cria ou resolve o User, liga o User ao Employee e não concede Membership.
  • DRIVER -> garante Driver e ativa o vínculo DriverTransportOperator. O permissionário associado deve ser informado no fluxo de convite ou resolvido pela operação da cooperativa. Não concede Membership.
• Claims de acesso não são gravados no Invite. Eles são derivados pelo Profile a partir do resultado do aceite.
• O Invite não carrega companyId para motorista. Para convites type=DRIVER, o aceite usa organizationId como cooperativa e transportOperatorId como permissionário.
• O modelo não possui campo updatedAt.

​

Enums

​

InviteType

​

InviteStatus (derivado)

​

Example

{
  "inviteId": "0197a804-414d-79a3-a5c0-bb5c52185d23",
  "invitedByUserId": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "invitedUserId": null,
  "organizationId": "0197a7f7-7291-7a43-96db-2c8580b80c5d",
  "roleId": "0197a7f8-15d1-7320-9b60-02497d7a0d61",
  "transportOperatorId": null,
  "type": "MEMBER",
  "token": "invite_8dW2nQ4pL6",
  "email": "mariana.costa@example.com",
  "phoneIso": "BR",
  "phoneDdi": "55",
  "phoneNumber": "11987654321",
  "expiresAt": "2026-07-10T13:30:00.000Z",
  "acceptedAt": null,
  "revokedAt": null,
  "rejectedAt": null,
  "createdBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "updatedBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "createdAt": "2026-07-03T13:30:00.000Z"
}