Skip to content
Last updated

PERS SDK - v2.3.26 / Exports / BusinessMembershipService

Class: 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); // true

Version

2.0.0

Table of contents

Constructors

Methods

Constructors

constructor

• new BusinessMembershipService(membershipApi): BusinessMembershipService

Parameters

NameType
membershipApiBusinessMembershipApi

Returns

BusinessMembershipService

Defined in

business/services/business-membership-service.ts:31

Methods

getMembers

▸ getMembers(businessId, options?): Promise<PaginatedResponseDTO<BusinessMembershipDTO>>

Get all members of a business with pagination

Parameters

NameTypeDescription
businessIdstringThe business UUID
options?GetBusinessMembersOptionsPagination and include options

Returns

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));

Defined in

business/services/business-membership-service.ts:51


getMembersByRole

▸ getMembersByRole(businessId, role, options?): Promise<PaginatedResponseDTO<BusinessMembershipDTO>>

Get members filtered by role (client-side filtering)

Parameters

NameType
businessIdstring
roleMembershipRole
options?PaginationOptions

Returns

Promise<PaginatedResponseDTO<BusinessMembershipDTO>>

Deprecated

Consider server-side role filtering for better performance

Defined in

business/services/business-membership-service.ts:59


getMembersWithMinRole

▸ getMembersWithMinRole(businessId, minRole): Promise<BusinessMembershipDTO[]>

Get members with at least a minimum role level

Uses the role hierarchy: OWNER > ADMIN > EDITOR > VIEWER

Parameters

NameTypeDescription
businessIdstringThe business UUID
minRoleMembershipRoleThe minimum role level

Returns

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);

Defined in

business/services/business-membership-service.ts:91


getMemberByUserId

▸ getMemberByUserId(businessId, userId): Promise<undefined | BusinessMembershipDTO>

Get a specific member by user ID

Parameters

NameTypeDescription
businessIdstringThe business UUID
userIdstringThe user UUID to find

Returns

Promise<undefined | BusinessMembershipDTO>

The membership if found, undefined otherwise

Defined in

business/services/business-membership-service.ts:106


getMemberCountsByRole

▸ getMemberCountsByRole(businessId): Promise<Record<MembershipRole, number>>

Count members by role

Parameters

NameTypeDescription
businessIdstringThe business UUID

Returns

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 }

Defined in

business/services/business-membership-service.ts:126


addMember

▸ addMember(businessId, userId, role?): Promise<BusinessMembershipDTO>

Add a new member to a business

Parameters

NameTypeDefault valueDescription
businessIdstringundefinedThe business UUID
userIdstringundefinedThe user UUID to add
roleMembershipRoleMembershipRole.VIEWERThe role to assign (defaults to VIEWER)

Returns

Promise<BusinessMembershipDTO>

The created membership

Defined in

business/services/business-membership-service.ts:159


updateMemberRole

▸ updateMemberRole(businessId, userId, newRole): Promise<BusinessMembershipDTO>

Update a member's role

Parameters

NameTypeDescription
businessIdstringThe business UUID
userIdstringThe user UUID to update
newRoleMembershipRoleThe new role to assign

Returns

Promise<BusinessMembershipDTO>

The updated membership

Defined in

business/services/business-membership-service.ts:175


removeMember

▸ removeMember(businessId, userId): Promise<{ success: boolean }>

Remove a member from a business

Parameters

NameTypeDescription
businessIdstringThe business UUID
userIdstringThe user UUID to remove

Returns

Promise<{ success: boolean }>

Success confirmation

Defined in

business/services/business-membership-service.ts:190


promoteMember

▸ promoteMember(businessId, userId, targetRole): Promise<BusinessMembershipDTO>

Promote a member to a higher role

Parameters

NameTypeDescription
businessIdstringThe business UUID
userIdstringThe user UUID to promote
targetRoleMembershipRoleThe target role (must be higher than current)

Returns

Promise<BusinessMembershipDTO>

The updated membership

Throws

Error if target role is not higher than current

Defined in

business/services/business-membership-service.ts:206


demoteMember

▸ demoteMember(businessId, userId, targetRole): Promise<BusinessMembershipDTO>

Demote a member to a lower role

Note: Cannot demote the last OWNER

Parameters

NameTypeDescription
businessIdstringThe business UUID
userIdstringThe user UUID to demote
targetRoleMembershipRoleThe target role (must be lower than current)

Returns

Promise<BusinessMembershipDTO>

The updated membership

Throws

Error if target role is not lower than current

Defined in

business/services/business-membership-service.ts:236


canViewMembers

▸ canViewMembers(role): boolean

Check if a role can view members (any member)

Parameters

NameType
rolenull | MembershipRole

Returns

boolean

Defined in

business/services/business-membership-service.ts:262


canManageMembers

▸ canManageMembers(role): boolean

Check if a role can manage members (ADMIN or higher)

Parameters

NameType
rolenull | MembershipRole

Returns

boolean

Defined in

business/services/business-membership-service.ts:269


canEditContent

▸ canEditContent(role): boolean

Check if a role can edit content (EDITOR or higher)

Parameters

NameType
rolenull | MembershipRole

Returns

boolean

Defined in

business/services/business-membership-service.ts:276


canDeleteBusiness

▸ canDeleteBusiness(role): boolean

Check if a role can delete the business (OWNER only)

Parameters

NameType
rolenull | MembershipRole

Returns

boolean

Defined in

business/services/business-membership-service.ts:283


getPermissions

▸ getPermissions(role): Object

Get permissions object for a role

Useful for UI components to conditionally render based on permissions.

Parameters

NameTypeDescription
rolenull | MembershipRoleThe membership role (or null if not a member)

Returns

Object

Object with boolean permission flags

NameType
canViewMembersboolean
canManageMembersboolean
canEditContentboolean
canDeleteBusinessboolean

Example

const perms = service.getPermissions(MembershipRole.EDITOR);
// { canViewMembers: true, canManageMembers: false, canEditContent: true, canDeleteBusiness: false }

if (perms.canManageMembers) {
  showAddMemberButton();
}

Defined in

business/services/business-membership-service.ts:305


canAssignRole

▸ 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)

Parameters

NameTypeDescription
assignerRoleMembershipRoleThe role of the user assigning
targetRoleMembershipRoleThe role being assigned

Returns

boolean

true if the assigner can assign the target role

Defined in

business/services/business-membership-service.ts:329