Documentation / @tenancy-node/admin-api / AdminApi

Interface: AdminApi

Defined in: admin-api/src/admin.ts:41

Properties

context

readonly context: AdminContext

Defined in: admin-api/src/admin.ts:53

Contexto interno (usuarios, auditoría): lo usa el CLI (tenancy admin:user).

---

leads

readonly leads: object

Defined in: admin-api/src/admin.ts:55

Solicitudes de la web comercial (aunque la ruta pública esté apagada).

list

list: (query) => Promise<{ items: Lead[]; page: number; perPage: number; total: number; }>

Parameters

query?

page?

number

perPage?

number

search?

string

status?

"new" | "contacted" | "converted" | "discarded"

Returns

Promise<{ items: Lead[]; page: number; perPage: number; total: number; }>

create()

create(input): Promise<Lead>

Guarda una solicitud y publica lead.created (por ejemplo, desde tu propio formulario).

Parameters

input

NewLead

Returns

Promise<Lead>

---

prefix

readonly prefix: string

Defined in: admin-api/src/admin.ts:51

---

uiPath

readonly uiPath: string | undefined

Defined in: admin-api/src/admin.ts:43

Ruta de la interfaz (/admin) si se sirve.

Methods

handle()

handle(req, res): Promise<boolean>

Defined in: admin-api/src/admin.ts:48

Atiende la petición si su ruta empieza con el prefijo. Devuelve false si no es del panel (así se puede usar como middleware: if (!(await admin.handle(req, res))) next()).

Parameters

req

IncomingMessage

res

ServerResponse

Returns

Promise<boolean>

---

openapi()

openapi(): Record<string, unknown>

Defined in: admin-api/src/admin.ts:50

Documento OpenAPI 3.1 de la API.

Returns

Record<string, unknown>