Namespaces
membership
Methods and types of the `membership` namespace (`client.membership` / `bot.membership`).
Interfaces
AddRemoveRoleData
Properties
GetLastSeenData
Properties
GetLastSeenResponse
Properties
| Property | Type |
|---|---|
results | LastSeenResult[] |
GetProjectMembershipParams
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
limit? | number | PaginationParams.limit |
nameSearch? | string | null | - |
page? | number | PaginationParams.page |
sort? | Record<string, -1 | 1> | SortParams.sort |
GetWorkspaceMembershipParams
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
isBillable? | boolean | - |
limit? | number | PaginationParams.limit |
nameSearch? | string | null | - |
page? | number | PaginationParams.page |
sort? | Record<string, -1 | 1> | SortParams.sort |
LastSeenResult
Properties
| Property | Type |
|---|---|
lastSeen | string | null |
resourceId | string |
resourceType | "project" | "workspace" |
userId | string |
PaginationParams
Extended by
Properties
SortParams
Extended by
Properties
Type Aliases
MembershipResponse
type MembershipResponse = Membership;MentionableUserResponse
type MentionableUserResponse = Mentionable;PaginatedMembershipResponse
type PaginatedMembershipResponse = MembershipReport;Functions
default()
function default(client): {
addRole: Promise<Membership>;
deleteMembership: Promise<void>;
getMyMemberships: Promise<Membership[]>;
getProjectLastSeen: Promise<GetLastSeenResponse>;
getProjectMemberships: Promise<MembershipReport>;
getProjectMentionableUsers: Promise<Mentionable[]>;
getWorkspaceLastSeen: Promise<GetLastSeenResponse>;
getWorkspaceMemberships: Promise<MembershipReport>;
leaveResource: Promise<void>;
removeRole: Promise<Membership>;
};Defines membership-related methods for the NuramaClient.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | default | The NuramaClient instance. |
Returns
An object containing the membership-related methods.
| Name | Type | Description |
|---|---|---|
addRole() | (data) => Promise<Membership> | Adds a role to an existing membership record. Requires permission to add roles. |
deleteMembership() | (membershipId) => Promise<void> | Deletes a specific membership record by its ID. Requires specific permissions to delete others' memberships. |
getMyMemberships() | () => Promise<Membership[]> | Retrieves the membership records for the currently authenticated user. |
getProjectLastSeen() | (projectId, data) => Promise<GetLastSeenResponse> | Retrieves resource-specific last seen timestamps for multiple users in a project. Requires permission to get project members. |
getProjectMemberships() | (projectId, params?) => Promise<MembershipReport> | Retrieves memberships associated with a specific project. Requires permission based on user's role in the project/workspace. |
getProjectMentionableUsers() | (projectId, visibility) => Promise<Mentionable[]> | Retrieves a list of users mentionable within a project based on visibility. Requires permission to get mentionable users. |
getWorkspaceLastSeen() | (workspaceId, data) => Promise<GetLastSeenResponse> | Retrieves resource-specific last seen timestamps for multiple users in a workspace. Requires permission to get workspace members. |
getWorkspaceMemberships() | (workspaceId, params?) => Promise<MembershipReport> | Retrieves memberships associated with a specific workspace. Requires permission to get workspace members. |
leaveResource() | (resourceId) => Promise<void> | Allows the authenticated user to leave a resource (delete their own membership). Cannot be used to remove ownership roles. |
removeRole() | (data) => Promise<Membership> | Removes a role from an existing membership record. Requires permission to remove roles. Cannot remove ownership roles. |