Skip to content
Last updated

PERS SDK - v2.3.26 / Exports / TenantService

Class: TenantService

Platform-Agnostic Tenant Service

Contains tenant business logic and operations that work across platforms. No framework dependencies - pure TypeScript business logic. Matches framework TenantApiService capabilities exactly.

Table of contents

Constructors

Methods

Constructors

constructor

new TenantService(tenantApi): TenantService

Parameters

NameType
tenantApiTenantApi

Returns

TenantService

Defined in

tenant/services/tenant-service.ts:21

Methods

getRemoteTenant

getRemoteTenant(): Promise<TenantDTO>

Get full tenant information (Admin JWT required)

Returns

Promise<TenantDTO>

Defined in

tenant/services/tenant-service.ts:30


getRemoteTenantPublic

getRemoteTenantPublic(): Promise<TenantPublicDTO>

PUBLIC: Get tenant public information (API key only)

Returns

Promise<TenantPublicDTO>

Defined in

tenant/services/tenant-service.ts:37


getRemoteLoginToken

getRemoteLoginToken(): Promise<string>

PUBLIC: Get remote login token

Returns

Promise<string>

Defined in

tenant/services/tenant-service.ts:44


getRemoteClientConfig

getRemoteClientConfig(): Promise<TenantClientConfigDTO>

PUBLIC: Get remote client configuration

Returns

Promise<TenantClientConfigDTO>

Defined in

tenant/services/tenant-service.ts:51


getCurrentAdmin

getCurrentAdmin(): Promise<AdminDTO>

ADMIN: Get current admin info (tenant admin authentication required)

Returns

Promise<AdminDTO>

Defined in

tenant/services/tenant-service.ts:62


updateRemoteTenant

updateRemoteTenant(tenantData): Promise<TenantDTO>

ADMIN: Update tenant information Returns full TenantDTO including sensitive config

Parameters

NameType
tenantDataTenantUpdateRequestDTO

Returns

Promise<TenantDTO>

Defined in

tenant/services/tenant-service.ts:70


getAdmins

getAdmins(options?): Promise<PaginatedResponseDTO<AdminDTO>>

ADMIN: Get all tenant admins with pagination

Parameters

NameTypeDescription
options?PaginationOptionsPagination options

Returns

Promise<PaginatedResponseDTO<AdminDTO>>

Defined in

tenant/services/tenant-service.ts:78


postAdmin

postAdmin(adminData): Promise<AdminDTO>

ADMIN: Create new admin ✅ FIXED: Renamed to match framework postAdmin method

Parameters

NameType
adminDataAdminCreateRequestDTO

Returns

Promise<AdminDTO>

Defined in

tenant/services/tenant-service.ts:86


putAdmin

putAdmin(adminId, adminData): Promise<AdminDTO>

ADMIN: Update admin (toggle tenant association) ✅ FIXED: Renamed to match framework putAdmin method

Parameters

NameType
adminIdstring
adminDataAdminCreateRequestDTO

Returns

Promise<AdminDTO>

Defined in

tenant/services/tenant-service.ts:94