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

Class: Leads

Defined in: admin-api/src/leads.ts:94

Solicitudes de demo (tenancy_leads). Sin FK al tenant: sobreviven a su borrado.

Constructors

Constructor

new Leads(central): Leads

Defined in: admin-api/src/leads.ts:95

Parameters

central

CentralAccess

Returns

Leads

Methods

countByStatus()

countByStatus(): Promise<Record<"new" | "contacted" | "converted" | "discarded", number>>

Defined in: admin-api/src/leads.ts:177

Returns

Promise<Record<"new" | "contacted" | "converted" | "discarded", number>>

---

create()

create(input): Promise<Lead>

Defined in: admin-api/src/leads.ts:97

Parameters

input

NewLead

Returns

Promise<Lead>

---

delete()

delete(id): Promise<boolean>

Defined in: admin-api/src/leads.ts:169

Parameters

id

number

Returns

Promise<boolean>

---

find()

find(id): Promise<Lead | undefined>

Defined in: admin-api/src/leads.ts:123

Parameters

id

number

Returns

Promise<Lead | undefined>

---

list()

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

Defined in: admin-api/src/leads.ts:132

Parameters

query?

page?

number

perPage?

number

search?

string

status?

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

Returns

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

---

update()

update(id, changes): Promise<Lead | undefined>

Defined in: admin-api/src/leads.ts:160

Parameters

id

number

changes

LeadChanges

Returns

Promise<Lead | undefined>