Documentation / @tenancy-node/core / PlansApi

Interface: PlansApi

Defined in: core/src/tenancy.ts:207

Extends

• PlansAdminApi

Properties

defaultPlan

readonly defaultPlan: string | null

Defined in: core/src/tenancy.ts:211

Methods

assign()

assign(tenant, plan, overrides?): Promise<Tenant>

Defined in: core/src/tenancy.ts:216

Cambia el plan de un tenant y, si se pasan, sus módulos sueltos y límites propios (reemplazan los anteriores). Publica tenant.plan_changed.

Parameters

tenant

TenantRef

plan

string | null

overrides?

TenantFeatureOverrides | null

Returns

Promise<Tenant>

---

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>

Inherited from

PlansAdminApi.create

---

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[]>

Inherited from

PlansAdminApi.describe

---

get()

get(id): PublicPlan | undefined

Defined in: core/src/tenancy.ts:210

Parameters

id

string

Returns

PublicPlan | undefined

---

list()

list(options?): PublicPlan[]

Defined in: core/src/tenancy.ts:209

Planes en el orden de la configuración.

Parameters

options?

publicOnly?

boolean

Returns

PublicPlan[]

---

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>

Inherited from

PlansAdminApi.reload

---

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">

Inherited from

PlansAdminApi.remove

---

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>

Inherited from

PlansAdminApi.update