@anpdgovbr/shared-types
Version:
Biblioteca central de tipos TypeScript compartilhados para os projetos da ANPD (BETA)
52 lines • 1.43 kB
TypeScript
/**
* @file controladores-filtro.dto.ts
* @module dto
*
* @description
* Define o DTO com filtros opcionais utilizados nas listagens de Controladores.
*
* @remarks
* Cada campo pode ser combinado com `BaseQueryParams` para refinamento de busca na API Quarkus.
*
* @since 0.2.0
*/
import type { TipoControlador } from "../enums/tipo-controlador.enum";
import type { SetorEmpresarial } from "../enums/setor-empresarial.enum";
import type { Esfera } from "../enums/esfera.enum";
import type { Poder } from "../enums/poder.enum";
/**
* Filtros opcionais aceitos pela API para listagem de Controladores.
*
* @public
*/
export interface ControladoresFiltroDto {
/**
* Filtro por nome empresarial ou fantasia (busca parcial).
*/
nome?: string;
/**
* Filtro por CNPJ (busca exata).
*/
cnpj?: string;
/**
* Filtro por tipo de controlador (pessoa jurídica ou natural).
*/
tipo?: TipoControlador;
/**
* Filtro por setor empresarial (público ou privado).
*/
setorEmpresarial?: SetorEmpresarial;
/**
* Filtro por esfera governamental.
*
* @remarks Aplica-se quando `setorEmpresarial` é `PUBLICO`.
*/
esfera?: Esfera;
/**
* Filtro por poder governamental.
*
* @remarks Aplica-se quando `setorEmpresarial` é `PUBLICO`.
*/
poder?: Poder;
}
//# sourceMappingURL=controladores-filtro.dto.d.ts.map