Skip to content
Last updated

PERS SDK - v2.3.26 / Exports / BusinessService

Class: BusinessService

Platform-Agnostic Business Service

Contains business logic and operations that work across platforms. No framework dependencies - pure TypeScript business logic.

Focuses only on actual backend capabilities.

Table of contents

Constructors

Methods

Constructors

constructor

• new BusinessService(businessApi): BusinessService

Parameters

NameType
businessApiBusinessApi

Returns

BusinessService

Defined in

business/services/business-service.ts:26

Methods

getActiveBusinesses

▸ getActiveBusinesses(options?): Promise<PaginatedResponseDTO<BusinessDTO>>

Get all active businesses with pagination

Parameters

NameType
options?BusinessFilterOptions

Returns

Promise<PaginatedResponseDTO<BusinessDTO>>

Deprecated

Use getBusinesses({ active: true }) for more control

Defined in

business/services/business-service.ts:32


getBusinessTypes

▸ getBusinessTypes(options?): Promise<PaginatedResponseDTO<BusinessTypeDTO>>

Get all business types with pagination

Parameters

NameType
options?PaginationOptions

Returns

Promise<PaginatedResponseDTO<BusinessTypeDTO>>

Defined in

business/services/business-service.ts:39


getBusinessById

▸ getBusinessById(businessId): Promise<BusinessDTO>

Get business by ID

Parameters

NameType
businessIdstring

Returns

Promise<BusinessDTO>

Defined in

business/services/business-service.ts:46


getBusinessByAccount

▸ getBusinessByAccount(accountAddress): Promise<BusinessDTO>

Get business by account address

Parameters

NameType
accountAddressstring

Returns

Promise<BusinessDTO>

Defined in

business/services/business-service.ts:53


getBusinessesByType

▸ getBusinessesByType(typeId, options?): Promise<PaginatedResponseDTO<BusinessDTO>>

Get businesses by type (server-side filtering) Uses the businessTypeId parameter for efficient server-side filtering.

Parameters

NameType
typeIdstring
options?BusinessFilterOptions

Returns

Promise<PaginatedResponseDTO<BusinessDTO>>

Defined in

business/services/business-service.ts:61


getBusinesses

▸ getBusinesses(options?): Promise<PaginatedResponseDTO<BusinessDTO>>

ADMIN: Get all businesses with filtering and pagination

Parameters

NameTypeDescription
options?BusinessFilterOptionsFilter and pagination options

Returns

Promise<PaginatedResponseDTO<BusinessDTO>>

See

BusinessFilterOptions for available filter options

Defined in

business/services/business-service.ts:79


createBusiness

▸ createBusiness(dto): Promise<BusinessTokenBalancesDTO | BusinessApiKeyDTO>

ADMIN: Create business with full DTO

Parameters

NameType
dtoBusinessCreateRequestDTO

Returns

Promise<BusinessTokenBalancesDTO | BusinessApiKeyDTO>

Defined in

business/services/business-service.ts:86


createBusinessByDisplayName

▸ createBusinessByDisplayName(displayName): Promise<BusinessTokenBalancesDTO | BusinessApiKeyDTO>

ADMIN: Create business by display name

Parameters

NameType
displayNamestring

Returns

Promise<BusinessTokenBalancesDTO | BusinessApiKeyDTO>

Deprecated

Use createBusiness(dto) for full control

Defined in

business/services/business-service.ts:94


updateBusiness

▸ updateBusiness(id, businessData): Promise<BusinessDTO>

ADMIN: Update business

Parameters

NameType
idstring
businessDataBusinessUpdateRequestDTO

Returns

Promise<BusinessDTO>

Defined in

business/services/business-service.ts:101


toggleBusinessStatus

▸ toggleBusinessStatus(id, dto): Promise<BusinessDTO>

ADMIN: Toggle business active status

Parameters

NameType
idstring
dtoBusinessToggleActiveRequestDTO

Returns

Promise<BusinessDTO>

Defined in

business/services/business-service.ts:108