Skip to content

Documentation / @tenancy-node/core / PlansAdminApi

Interface: PlansAdminApi ​

Defined in: core/src/settings/settings-service.ts:49

Extended by ​

Methods ​

create() ​

create(id, input, options?): Promise<PlanInfo>

Defined in: core/src/settings/settings-service.ts:55

Crea un plan desde el panel (módulos solo del catálogo de código).

Parameters ​

id ​

string

input ​

PlanInput & object

options? ​
by? ​

string | null

Returns ​

Promise<PlanInfo>


describe() ​

describe(): Promise<PlanInfo[]>

Defined in: core/src/settings/settings-service.ts:53

Planes con su origen (config/panel), cambios y archivados. Para el panel.

Returns ​

Promise<PlanInfo[]>


reload() ​

reload(): Promise<void>

Defined in: core/src/settings/settings-service.ts:51

Vuelve a leer de la base los cambios de planes (y la marca).

Returns ​

Promise<void>


remove() ​

remove(id, options?): Promise<"reset" | "archived">

Defined in: core/src/settings/settings-service.ts:66

Plan de la config: borra sus cambios (vuelve a la configuración) → 'reset'. Plan del panel: lo archiva → 'archived' (409 si es el plan por defecto o lo usan tenants).

Parameters ​

id ​

string

options? ​
by? ​

string | null

Returns ​

Promise<"reset" | "archived">


update() ​

update(id, patch, options?): Promise<PlanInfo>

Defined in: core/src/settings/settings-service.ts:61

Cambia un plan (de la config o del panel). Lo que no se pasa queda igual.

Parameters ​

id ​

string

patch ​

PlanInput

options? ​
by? ​

string | null

Returns ​

Promise<PlanInfo>

Publicado bajo la licencia MIT.