add readme

This commit is contained in:
2025-05-26 08:48:34 -03:00
parent b2314a003f
commit 002705864b
2 changed files with 20 additions and 6 deletions

View File

@@ -1,3 +1,5 @@
# Compras
### Relacionamentos
Toda compra feita é relacionada com a empresa responsável, que é definida como o `tenant` da compra. Essa relação é estabelecida com base no CNPJ presente na compra.
@@ -10,3 +12,20 @@ O gestor responsável pela ação também é relacionado à compra.
{"id": "10", "sk": "related_ids#org", "org_id": "100"}
{"id": "10", "sk": "related_ids#user", "user_id": "123"}
```
# Matrículas
### Eventos agendados
### Proteção contra duplicação
### Política de cancelamento
Apenas matrículas com `metadata#cancel_policy` podem ser canceladas.
```json
{"id": "9omWNKymwU5U4aeun6mWzZ", "sk": "0"}
{"id": "9omWNKymwU5U4aeun6mWzZ", "sk": "metadata#cancel_policy"}
```
### Relacionamentos

View File

@@ -1,6 +1,6 @@
from datetime import timedelta
from enum import Enum
from typing import Literal, TypedDict
from typing import TypedDict
from uuid import uuid4
from layercake.dateutils import now, ttl
@@ -23,11 +23,6 @@ class Author(TypedDict):
class Vacancy(TypedDict): ...
class Rel(TypedDict):
id: str
scope: Literal['ORG', 'USER', 'ENROLLMENT']
class LifecycleEvents(str, Enum):
"""Lifecycle events related to scheduling actions."""