Saltar a contenido

Especificación Técnica: mae_agencias

Esquema: fuerza_ventas
Base de Datos: crm
Tabla Legacy Origen: i283t_agencia_promotor (111 agencias)
Propósito: Células organizacionales y agencias comerciales intermedias para estructurar grupos de venta regionales y líneas de supervisión comercial.


1. Justificación y Mejoras de Arquitectura

  • Estructuración Jerárquica de Ventas: Modela las sucursales o agencias regionales de distribución comercial asociadas a un promotor supervisor responsable.
  • Aislamiento Multi-Tenant (RLS): Integra empresa_id BIGINT NOT NULL con políticas RLS obligatorias para segregar las agencias por tenant.
  • Integridad Referencial Compuesta: Clave única compuesta (empresa_id, id) y FK compuesta hacia mae_promotores (empresa_id, supervisor_responsable_id).
  • Trazabilidad y Auditoría: Auditoría integral (created_at, updated_at, deleted_at, created_by, updated_by) con auditoría integral.

2. Definiciones de Implementación

Table fuerza_ventas.mae_agencias {
    id                          uuid          [pk, default: `gen_random_uuid()`, note: 'Identificador único UUID']
    empresa_id                  bigint        [not null, note: 'Identificador BIGINT de la empresa en core.identidad (RLS)']
    codigo_agencia              varchar(30)   [not null, note: 'Código único de la agencia comercial']
    nombre_agencia              varchar(150)  [not null, note: 'Nombre de la agencia']
    supervisor_responsable_id   uuid          [note: 'Promotor supervisor a cargo']
    direccion                   varchar(255)  [note: 'Dirección física de la agencia']
    telefono                    varchar(50)   [note: 'Teléfono de contacto institucional']

    // Auditoría General
    is_activo                   boolean       [not null, default: `true`, note: 'Estado lógico del registro']
    created_at                  timestamptz   [not null, default: `now()`, note: 'Fecha de creación']
    updated_at                  timestamptz   [not null, default: `now()`, note: 'Fecha de última actualización']
    deleted_at                  timestamptz   [note: 'Fecha de eliminación lógica']
    created_by                  uuid          [note: 'Usuario creador']
    updated_by                  uuid          [note: 'Usuario modificador']

    Indexes {
        (empresa_id, id) [unique, name: 'uq_mae_agencias_empresa_id']
        (empresa_id, codigo_agencia) [unique, name: 'uq_mae_agencias_empresa_codigo']
        (empresa_id, is_activo) [name: 'ix_mae_agencias_empresa_activo']
        (empresa_id, supervisor_responsable_id) [name: 'ix_mae_agencias_empresa_supervisor']
    }
}

Ref: fuerza_ventas.mae_agencias.(empresa_id, supervisor_responsable_id) > fuerza_ventas.mae_promotores.(empresa_id, id)
CREATE TABLE IF NOT EXISTS fuerza_ventas.mae_agencias (
    id UUID NOT NULL DEFAULT gen_random_uuid(),
    empresa_id BIGINT NOT NULL,
    codigo_agencia VARCHAR(30) NOT NULL,
    nombre_agencia VARCHAR(150) NOT NULL,
    supervisor_responsable_id UUID,
    direccion VARCHAR(255),
    telefono VARCHAR(50),

    -- Auditoría General
    is_activo BOOLEAN NOT NULL DEFAULT true,
    created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
    updated_at TIMESTAMPTZ NOT NULL DEFAULT now(),
    deleted_at TIMESTAMPTZ,
    created_by UUID,
    updated_by UUID,

    CONSTRAINT pk_mae_agencias
        PRIMARY KEY (id),

    CONSTRAINT uq_mae_agencias_empresa_id
        UNIQUE (empresa_id, id),

    CONSTRAINT uq_mae_agencias_empresa_codigo
        UNIQUE (empresa_id, codigo_agencia),

    CONSTRAINT fk_mae_agencias_supervisor
        FOREIGN KEY (empresa_id, supervisor_responsable_id)
        REFERENCES fuerza_ventas.mae_promotores (empresa_id, id)
);

CREATE INDEX IF NOT EXISTS ix_mae_agencias_empresa_activo
    ON fuerza_ventas.mae_agencias (empresa_id, is_activo);

CREATE INDEX IF NOT EXISTS ix_mae_agencias_empresa_supervisor
    ON fuerza_ventas.mae_agencias (empresa_id, supervisor_responsable_id);

COMMENT ON TABLE fuerza_ventas.mae_agencias IS
    'Maestro de Agencias Comerciales: Células organizacionales y agencias comerciales intermedias para estructurar grupos de venta regionales.';

COMMENT ON COLUMN fuerza_ventas.mae_agencias.id IS
    'Identificador único UUID';

COMMENT ON COLUMN fuerza_ventas.mae_agencias.empresa_id IS
    'Identificador UUID de la empresa en core.identidad (RLS)';

COMMENT ON COLUMN fuerza_ventas.mae_agencias.codigo_agencia IS
    'Código único de la agencia comercial';

COMMENT ON COLUMN fuerza_ventas.mae_agencias.nombre_agencia IS
    'Nombre de la agencia';

COMMENT ON COLUMN fuerza_ventas.mae_agencias.supervisor_responsable_id IS
    'Promotor supervisor a cargo';

COMMENT ON COLUMN fuerza_ventas.mae_agencias.direccion IS
    'Dirección física de la agencia';

COMMENT ON COLUMN fuerza_ventas.mae_agencias.telefono IS
    'Teléfono de contacto institucional';

COMMENT ON COLUMN fuerza_ventas.mae_agencias.is_activo IS
    'Estado lógico del registro';

COMMENT ON COLUMN fuerza_ventas.mae_agencias.created_at IS
    'Fecha de creación';

COMMENT ON COLUMN fuerza_ventas.mae_agencias.updated_at IS
    'Fecha de última actualización';

COMMENT ON COLUMN fuerza_ventas.mae_agencias.deleted_at IS
    'Fecha de eliminación lógica';

COMMENT ON COLUMN fuerza_ventas.mae_agencias.created_by IS
    'Usuario creador';

COMMENT ON COLUMN fuerza_ventas.mae_agencias.updated_by IS
    'Usuario modificador';

ALTER TABLE fuerza_ventas.mae_agencias
    ENABLE ROW LEVEL SECURITY;

CREATE POLICY rls_mae_agencias_empresa
    ON fuerza_ventas.mae_agencias
    FOR ALL
    USING (
        empresa_id = current_setting(
            'app.current_empresa_id',
            true
        )::BIGINT
    )
    WITH CHECK (
        empresa_id = current_setting(
            'app.current_empresa_id',
            true
        )::BIGINT
    );
import uuid
from datetime import datetime
from typing import Optional

from sqlalchemy import (
    BigInteger,
    Boolean,
    ForeignKeyConstraint,
    Index,
    String,
    UniqueConstraint,
    text,
)
from sqlalchemy.dialects.postgresql import TIMESTAMPTZ, UUID
from sqlalchemy.orm import Mapped, mapped_column

from app.db.base import Base


class MaeAgencias(Base):
    """
    Maestro de Agencias Comerciales.

    Células organizacionales y agencias comerciales intermedias para estructurar
    grupos de venta regionales y líneas de supervisión.

    Legacy:
        i283t_agencia_promotor
    """

    __tablename__ = "mae_agencias"

    __table_args__ = (
        UniqueConstraint(
            "empresa_id",
            "id",
            name="uq_mae_agencias_empresa_id",
        ),
        UniqueConstraint(
            "empresa_id",
            "codigo_agencia",
            name="uq_mae_agencias_empresa_codigo",
        ),
        ForeignKeyConstraint(
            ["empresa_id", "supervisor_responsable_id"],
            ["fuerza_ventas.mae_promotores.empresa_id", "fuerza_ventas.mae_promotores.id"],
            name="fk_mae_agencias_supervisor",
        ),
        Index(
            "ix_mae_agencias_empresa_activo",
            "empresa_id",
            "is_activo",
        ),
        Index(
            "ix_mae_agencias_empresa_supervisor",
            "empresa_id",
            "supervisor_responsable_id",
        ),
        {
            "schema": "fuerza_ventas",
            "comment": "Maestro de Agencias Comerciales",
        },
    )

    id: Mapped[uuid.UUID] = mapped_column(
        UUID(as_uuid=True),
        primary_key=True,
        server_default=text("gen_random_uuid()"),
        comment="Identificador único UUID",
    )

    empresa_id: Mapped[int] = mapped_column(
        BigInteger,
        nullable=False,
        comment="Identificador UUID de la empresa en core.identidad (RLS)",
    )

    codigo_agencia: Mapped[str] = mapped_column(
        String(30),
        nullable=False,
        comment="Código único de la agencia comercial",
    )

    nombre_agencia: Mapped[str] = mapped_column(
        String(150),
        nullable=False,
        comment="Nombre de la agencia",
    )

    supervisor_responsable_id: Mapped[Optional[uuid.UUID]] = mapped_column(
        UUID(as_uuid=True),
        nullable=True,
        comment="Promotor supervisor a cargo",
    )

    direccion: Mapped[Optional[str]] = mapped_column(
        String(255),
        nullable=True,
        comment="Dirección física de la agencia",
    )

    telefono: Mapped[Optional[str]] = mapped_column(
        String(50),
        nullable=True,
        comment="Teléfono de contacto institucional",
    )

    is_activo: Mapped[bool] = mapped_column(
        Boolean,
        nullable=False,
        server_default=text("true"),
        comment="Estado lógico del registro",
    )

    created_at: Mapped[datetime] = mapped_column(
        TIMESTAMPTZ,
        nullable=False,
        server_default=text("now()"),
        comment="Fecha de creación",
    )

    updated_at: Mapped[datetime] = mapped_column(
        TIMESTAMPTZ,
        nullable=False,
        server_default=text("now()"),
        comment="Fecha de última actualización",
    )

    deleted_at: Mapped[Optional[datetime]] = mapped_column(
        TIMESTAMPTZ,
        nullable=True,
        comment="Fecha de eliminación lógica",
    )

    created_by: Mapped[Optional[uuid.UUID]] = mapped_column(
        UUID(as_uuid=True),
        nullable=True,
        comment="Usuario creador",
    )

    updated_by: Mapped[Optional[uuid.UUID]] = mapped_column(
        UUID(as_uuid=True),
        nullable=True,
        comment="Usuario modificador",
    )
"""create mae_agencias

Revision ID: mae_0003
Revises: mae_0002
Create Date: 2026-09-09
"""

from typing import Sequence, Union

from alembic import op
import sqlalchemy as sa
from sqlalchemy.dialects import postgresql


# revision identifiers, used by Alembic.
revision: str = "mae_0003"
down_revision: Union[str, Sequence[str], None] = "mae_0002"
branch_labels: Union[str, Sequence[str], None] = None
depends_on: Union[str, Sequence[str], None] = None


def upgrade() -> None:

    op.create_table(
        "mae_agencias",

        sa.Column(
            "id",
            postgresql.UUID(as_uuid=True),
            nullable=False,
            server_default=sa.text("gen_random_uuid()"),
            comment="Identificador único UUID",
        ),

        sa.Column(
            "empresa_id",
            sa.BigInteger(),
            nullable=False,
            comment="Identificador UUID de la empresa en core.identidad (RLS)",
        ),

        sa.Column(
            "codigo_agencia",
            sa.String(length=30),
            nullable=False,
            comment="Código único de la agencia comercial",
        ),

        sa.Column(
            "nombre_agencia",
            sa.String(length=150),
            nullable=False,
            comment="Nombre de la agencia",
        ),

        sa.Column(
            "supervisor_responsable_id",
            postgresql.UUID(as_uuid=True),
            nullable=True,
            comment="Promotor supervisor a cargo",
        ),

        sa.Column(
            "direccion",
            sa.String(length=255),
            nullable=True,
            comment="Dirección física de la agencia",
        ),

        sa.Column(
            "telefono",
            sa.String(length=50),
            nullable=True,
            comment="Teléfono de contacto institucional",
        ),

        # Auditoría General
        sa.Column(
            "is_activo",
            sa.Boolean(),
            nullable=False,
            server_default=sa.text("true"),
            comment="Estado lógico del registro",
        ),

        sa.Column(
            "created_at",
            sa.TIMESTAMP(timezone=True),
            nullable=False,
            server_default=sa.text("now()"),
            comment="Fecha de creación",
        ),

        sa.Column(
            "updated_at",
            sa.TIMESTAMP(timezone=True),
            nullable=False,
            server_default=sa.text("now()"),
            comment="Fecha de última actualización",
        ),

        sa.Column(
            "deleted_at",
            sa.TIMESTAMP(timezone=True),
            nullable=True,
            comment="Fecha de eliminación lógica",
        ),

        sa.Column(
            "created_by",
            postgresql.UUID(as_uuid=True),
            nullable=True,
            comment="Usuario creador",
        ),

        sa.Column(
            "updated_by",
            postgresql.UUID(as_uuid=True),
            nullable=True,
            comment="Usuario modificador",
        ),

        sa.PrimaryKeyConstraint(
            "id",
            name="pk_mae_agencias",
        ),

        sa.UniqueConstraint(
            "empresa_id",
            "id",
            name="uq_mae_agencias_empresa_id",
        ),

        sa.UniqueConstraint(
            "empresa_id",
            "codigo_agencia",
            name="uq_mae_agencias_empresa_codigo",
        ),

        sa.ForeignKeyConstraint(
            ["empresa_id", "supervisor_responsable_id"],
            ["fuerza_ventas.mae_promotores.empresa_id", "fuerza_ventas.mae_promotores.id"],
            name="fk_mae_agencias_supervisor",
        ),

        comment="Maestro de Agencias Comerciales",
        schema="fuerza_ventas",
    )

    op.create_index(
        "ix_mae_agencias_empresa_activo",
        "mae_agencias",
        ["empresa_id", "is_activo"],
        unique=False,
        schema="fuerza_ventas",
    )

    op.create_index(
        "ix_mae_agencias_empresa_supervisor",
        "mae_agencias",
        ["empresa_id", "supervisor_responsable_id"],
        unique=False,
        schema="fuerza_ventas",
    )

    op.execute(
        """
        ALTER TABLE fuerza_ventas.mae_agencias
        ENABLE ROW LEVEL SECURITY;
        """
    )

    op.execute(
        """
        CREATE POLICY rls_mae_agencias_empresa
        ON fuerza_ventas.mae_agencias
        FOR ALL
        USING (
            empresa_id = current_setting(
                'app.current_empresa_id',
                true
            )::BIGINT
        )
        WITH CHECK (
            empresa_id = current_setting(
                'app.current_empresa_id',
                true
            )::BIGINT
        );
        """
    )


def downgrade() -> None:

    op.execute(
        """
        DROP POLICY IF EXISTS rls_mae_agencias_empresa
        ON fuerza_ventas.mae_agencias;
        """
    )

    op.execute(
        """
        ALTER TABLE fuerza_ventas.mae_agencias
        DISABLE ROW LEVEL SECURITY;
        """
    )

    op.drop_index(
        "ix_mae_agencias_empresa_supervisor",
        table_name="mae_agencias",
        schema="fuerza_ventas",
    )

    op.drop_index(
        "ix_mae_agencias_empresa_activo",
        table_name="mae_agencias",
        schema="fuerza_ventas",
    )

    op.drop_table(
        "mae_agencias",
        schema="fuerza_ventas",
    )