PERS SDK - v2.3.26 / Exports / BusinessMembershipService
Business Membership Service
Platform-agnostic service for managing business memberships. Provides business logic layer on top of the API client with convenience methods and role-based utilities.
Example
const service = new BusinessMembershipService(membershipApi);
// Get members with admin permissions
const admins = await service.getMembersByRole('business-123', MembershipRole.ADMIN);
// Check permissions
const canManage = service.canManageMembers(MembershipRole.ADMIN); // trueVersion
2.0.0
- getMembers
- getMembersByRole
- getMembersWithMinRole
- getMemberByUserId
- getMemberCountsByRole
- addMember
- updateMemberRole
- removeMember
- promoteMember
- demoteMember
- canViewMembers
- canManageMembers
- canEditContent
- canDeleteBusiness
- getPermissions
- canAssignRole
• new BusinessMembershipService(membershipApi): BusinessMembershipService
| Name | Type |
|---|---|
membershipApi | BusinessMembershipApi |
business/services/business-membership-service.ts:31
▸ getMembers(businessId, options?): Promise<PaginatedResponseDTO<BusinessMembershipDTO>>
Get all members of a business with pagination
| Name | Type | Description |
|---|---|---|
businessId | string | The business UUID |
options? | GetBusinessMembersOptions | Pagination and include options |
Promise<PaginatedResponseDTO<BusinessMembershipDTO>>
Paginated response with business memberships
Example
// Get members with user data for display
const members = await service.getMembers('biz-123', { include: ['user'] });
members.data.forEach(m => console.log(m.included?.user?.email));business/services/business-membership-service.ts:51
▸ getMembersByRole(businessId, role, options?): Promise<PaginatedResponseDTO<BusinessMembershipDTO>>
Get members filtered by role (client-side filtering)
| Name | Type |
|---|---|
businessId | string |
role | MembershipRole |
options? | PaginationOptions |
Promise<PaginatedResponseDTO<BusinessMembershipDTO>>
Deprecated
Consider server-side role filtering for better performance
business/services/business-membership-service.ts:59
▸ getMembersWithMinRole(businessId, minRole): Promise<BusinessMembershipDTO[]>
Get members with at least a minimum role level
Uses the role hierarchy: OWNER > ADMIN > EDITOR > VIEWER
| Name | Type | Description |
|---|---|---|
businessId | string | The business UUID |
minRole | MembershipRole | The minimum role level |
Promise<BusinessMembershipDTO[]>
Array of memberships with role >= minRole
Example
// Get all members who can manage content (EDITOR and above)
const editors = await service.getMembersWithMinRole('biz-123', MembershipRole.EDITOR);business/services/business-membership-service.ts:91
▸ getMemberByUserId(businessId, userId): Promise<undefined | BusinessMembershipDTO>
Get a specific member by user ID
| Name | Type | Description |
|---|---|---|
businessId | string | The business UUID |
userId | string | The user UUID to find |
Promise<undefined | BusinessMembershipDTO>
The membership if found, undefined otherwise
business/services/business-membership-service.ts:106
▸ getMemberCountsByRole(businessId): Promise<Record<MembershipRole, number>>
Count members by role
| Name | Type | Description |
|---|---|---|
businessId | string | The business UUID |
Promise<Record<MembershipRole, number>>
Object with count per role
Example
const counts = await service.getMemberCountsByRole('biz-123');
// { OWNER: 1, ADMIN: 2, EDITOR: 5, VIEWER: 10 }business/services/business-membership-service.ts:126
▸ addMember(businessId, userId, role?): Promise<BusinessMembershipDTO>
Add a new member to a business
| Name | Type | Default value | Description |
|---|---|---|---|
businessId | string | undefined | The business UUID |
userId | string | undefined | The user UUID to add |
role | MembershipRole | MembershipRole.VIEWER | The role to assign (defaults to VIEWER) |
Promise<BusinessMembershipDTO>
The created membership
business/services/business-membership-service.ts:159
▸ updateMemberRole(businessId, userId, newRole): Promise<BusinessMembershipDTO>
Update a member's role
| Name | Type | Description |
|---|---|---|
businessId | string | The business UUID |
userId | string | The user UUID to update |
newRole | MembershipRole | The new role to assign |
Promise<BusinessMembershipDTO>
The updated membership
business/services/business-membership-service.ts:175
▸ removeMember(businessId, userId): Promise<{ success: boolean }>
Remove a member from a business
| Name | Type | Description |
|---|---|---|
businessId | string | The business UUID |
userId | string | The user UUID to remove |
Promise<{ success: boolean }>
Success confirmation
business/services/business-membership-service.ts:190
▸ promoteMember(businessId, userId, targetRole): Promise<BusinessMembershipDTO>
Promote a member to a higher role
| Name | Type | Description |
|---|---|---|
businessId | string | The business UUID |
userId | string | The user UUID to promote |
targetRole | MembershipRole | The target role (must be higher than current) |
Promise<BusinessMembershipDTO>
The updated membership
Throws
Error if target role is not higher than current
business/services/business-membership-service.ts:206
▸ demoteMember(businessId, userId, targetRole): Promise<BusinessMembershipDTO>
Demote a member to a lower role
Note: Cannot demote the last OWNER
| Name | Type | Description |
|---|---|---|
businessId | string | The business UUID |
userId | string | The user UUID to demote |
targetRole | MembershipRole | The target role (must be lower than current) |
Promise<BusinessMembershipDTO>
The updated membership
Throws
Error if target role is not lower than current
business/services/business-membership-service.ts:236
▸ canViewMembers(role): boolean
Check if a role can view members (any member)
| Name | Type |
|---|---|
role | null | MembershipRole |
boolean
business/services/business-membership-service.ts:262
▸ canManageMembers(role): boolean
Check if a role can manage members (ADMIN or higher)
| Name | Type |
|---|---|
role | null | MembershipRole |
boolean
business/services/business-membership-service.ts:269
▸ canEditContent(role): boolean
Check if a role can edit content (EDITOR or higher)
| Name | Type |
|---|---|
role | null | MembershipRole |
boolean
business/services/business-membership-service.ts:276
▸ canDeleteBusiness(role): boolean
Check if a role can delete the business (OWNER only)
| Name | Type |
|---|---|
role | null | MembershipRole |
boolean
business/services/business-membership-service.ts:283
▸ getPermissions(role): Object
Get permissions object for a role
Useful for UI components to conditionally render based on permissions.
| Name | Type | Description |
|---|---|---|
role | null | MembershipRole | The membership role (or null if not a member) |
Object
Object with boolean permission flags
| Name | Type |
|---|---|
canViewMembers | boolean |
canManageMembers | boolean |
canEditContent | boolean |
canDeleteBusiness | boolean |
Example
const perms = service.getPermissions(MembershipRole.EDITOR);
// { canViewMembers: true, canManageMembers: false, canEditContent: true, canDeleteBusiness: false }
if (perms.canManageMembers) {
showAddMemberButton();
}business/services/business-membership-service.ts:305
▸ canAssignRole(assignerRole, targetRole): boolean
Check if a role can assign another role
Rule: Can only assign roles up to your own level (ADMIN cannot create OWNER, but OWNER can create anything)
| Name | Type | Description |
|---|---|---|
assignerRole | MembershipRole | The role of the user assigning |
targetRole | MembershipRole | The role being assigned |
boolean
true if the assigner can assign the target role