PERS SDK - v2.3.26 / Exports / 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.
- getActiveBusinesses
- getBusinessTypes
- getBusinessById
- getBusinessByAccount
- getBusinessesByType
- getBusinesses
- createBusiness
- createBusinessByDisplayName
- updateBusiness
- toggleBusinessStatus
• new BusinessService(businessApi): BusinessService
| Name | Type |
|---|---|
businessApi | BusinessApi |
business/services/business-service.ts:26
▸ getActiveBusinesses(options?): Promise<PaginatedResponseDTO<BusinessDTO>>
Get all active businesses with pagination
| Name | Type |
|---|---|
options? | BusinessFilterOptions |
Promise<PaginatedResponseDTO<BusinessDTO>>
Deprecated
Use getBusinesses({ active: true }) for more control
business/services/business-service.ts:32
▸ getBusinessTypes(options?): Promise<PaginatedResponseDTO<BusinessTypeDTO>>
Get all business types with pagination
| Name | Type |
|---|---|
options? | PaginationOptions |
Promise<PaginatedResponseDTO<BusinessTypeDTO>>
business/services/business-service.ts:39
▸ getBusinessById(businessId): Promise<BusinessDTO>
Get business by ID
| Name | Type |
|---|---|
businessId | string |
Promise<BusinessDTO>
business/services/business-service.ts:46
▸ getBusinessByAccount(accountAddress): Promise<BusinessDTO>
Get business by account address
| Name | Type |
|---|---|
accountAddress | string |
Promise<BusinessDTO>
business/services/business-service.ts:53
▸ getBusinessesByType(typeId, options?): Promise<PaginatedResponseDTO<BusinessDTO>>
Get businesses by type (server-side filtering) Uses the businessTypeId parameter for efficient server-side filtering.
| Name | Type |
|---|---|
typeId | string |
options? | BusinessFilterOptions |
Promise<PaginatedResponseDTO<BusinessDTO>>
business/services/business-service.ts:61
▸ getBusinesses(options?): Promise<PaginatedResponseDTO<BusinessDTO>>
ADMIN: Get all businesses with filtering and pagination
| Name | Type | Description |
|---|---|---|
options? | BusinessFilterOptions | Filter and pagination options |
Promise<PaginatedResponseDTO<BusinessDTO>>
See
BusinessFilterOptions for available filter options
business/services/business-service.ts:79
▸ createBusiness(dto): Promise<BusinessTokenBalancesDTO | BusinessApiKeyDTO>
ADMIN: Create business with full DTO
| Name | Type |
|---|---|
dto | BusinessCreateRequestDTO |
Promise<BusinessTokenBalancesDTO | BusinessApiKeyDTO>
business/services/business-service.ts:86
▸ createBusinessByDisplayName(displayName): Promise<BusinessTokenBalancesDTO | BusinessApiKeyDTO>
ADMIN: Create business by display name
| Name | Type |
|---|---|
displayName | string |
Promise<BusinessTokenBalancesDTO | BusinessApiKeyDTO>
Deprecated
Use createBusiness(dto) for full control
business/services/business-service.ts:94
▸ updateBusiness(id, businessData): Promise<BusinessDTO>
ADMIN: Update business
| Name | Type |
|---|---|
id | string |
businessData | BusinessUpdateRequestDTO |
Promise<BusinessDTO>
business/services/business-service.ts:101
▸ toggleBusinessStatus(id, dto): Promise<BusinessDTO>
ADMIN: Toggle business active status
| Name | Type |
|---|---|
id | string |
dto | BusinessToggleActiveRequestDTO |
Promise<BusinessDTO>