Type Alias CurrentUserTeamsApi

type CurrentUserTeamsApi = {
    create(name: string): Promise<{ team: TeamSummary }>;
    createJoinLink(
        teamId: string,
        email: string,
        options?: { ttlSeconds?: number },
    ): Promise<
        { createdAt: string; expiresAt: string; id: string; link: string },
    >;
    delete(teamId: string): Promise<{ deleted: true }>;
    demote(teamId: string, userId: string): Promise<{ updated: true }>;
    inspectJoinLink(code: string): Promise<TeamJoinLinkInspection>;
    join(code: string): Promise<{ team: TeamSummary }>;
    leave(teamId: string): Promise<{ left: true }>;
    list(): Promise<{ teams: TeamSummary[] }>;
    listJoinLinks(teamId: string): Promise<{ links: TeamJoinLink[] }>;
    listMembers(teamId: string): Promise<{ members: TeamMemberSummary[] }>;
    promote(teamId: string, userId: string): Promise<{ updated: true }>;
    removeMember(teamId: string, userId: string): Promise<{ removed: true }>;
    rename(teamId: string, name: string): Promise<{ team: TeamSummary }>;
    revokeJoinLink(
        teamId: string,
        joinLinkId: string,
    ): Promise<{ revoked: true }>;
    updateApplicationRoles(
        teamId: string,
        userId: string,
        changes: TeamApplicationRoleChanges,
    ): Promise<{ updated: true }>;
    validateJoinLink(code: string): Promise<TeamJoinLinkValidation>;
}

Index

Methods

create createJoinLink delete demote inspectJoinLink join leave list listJoinLinks listMembers promote removeMember rename revokeJoinLink updateApplicationRoles validateJoinLink

Methods

create

create(name: string): Promise<{ team: TeamSummary }>
Creates a named Team and makes the current linked user its first admin. Linked users may belong to at most 25 Teams.
Parameters
- name: string
Returns Promise<{ team: TeamSummary }>
- Defined in server.d.ts:388

createJoinLink

createJoinLink(
    teamId: string,
    email: string,
    options?: { ttlSeconds?: number },
): Promise<
    { createdAt: string; expiresAt: string; id: string; link: string },
>
Creates an email-bound Join link and returns it without sending any message. The default lifetime is 86400 seconds; accepted integer lifetimes are 300 through 604800 seconds.
Parameters
- teamId: string
- email: string
- Optionaloptions: { ttlSeconds?: number }
Returns Promise<{ createdAt: string; expiresAt: string; id: string; link: string }>
- Defined in server.d.ts:396

delete

delete(teamId: string): Promise<{ deleted: true }>
Deletes a Team only when the caller is its sole remaining admin member.
Parameters
- teamId: string
Returns Promise<{ deleted: true }>
- Defined in server.d.ts:416

demote

demote(teamId: string, userId: string): Promise<{ updated: true }>
Demotes an admin only when another committed Team admin remains.
Parameters
- teamId: string
- userId: string
Returns Promise<{ updated: true }>
- Defined in server.d.ts:410

inspectJoinLink

inspectJoinLink(code: string): Promise<TeamJoinLinkInspection>
Safely inspects a Join link without authentication or consumption.
Parameters
- code: string
Returns Promise<TeamJoinLinkInspection>
- Defined in server.d.ts:402

join

join(code: string): Promise<{ team: TeamSummary }>
Redeems a current matching Join link atomically. New memberships are ordinary members with no application roles.
Parameters
- code: string
Returns Promise<{ team: TeamSummary }>
- Defined in server.d.ts:406

leave

leave(teamId: string): Promise<{ left: true }>
Leaves an explicitly identified Team only while the caller is an ordinary member.
Parameters
- teamId: string
Returns Promise<{ left: true }>
- Defined in server.d.ts:414

list

list(): Promise<{ teams: TeamSummary[] }>
Returns Promise<{ teams: TeamSummary[] }>
- Defined in server.d.ts:386

listJoinLinks

listJoinLinks(teamId: string): Promise<{ links: TeamJoinLink[] }>
Lists active Join-link management metadata without recovering a capability.
Parameters
- teamId: string
Returns Promise<{ links: TeamJoinLink[] }>
- Defined in server.d.ts:398

listMembers

listMembers(teamId: string): Promise<{ members: TeamMemberSummary[] }>
Lists a bounded safe membership directory for one Team the caller currently administers.
Parameters
- teamId: string
Returns Promise<{ members: TeamMemberSummary[] }>
- Defined in server.d.ts:392

promote

promote(teamId: string, userId: string): Promise<{ updated: true }>
Promotes an ordinary member in an explicitly identified Team the caller currently administers.
Parameters
- teamId: string
- userId: string
Returns Promise<{ updated: true }>
- Defined in server.d.ts:408

removeMember

removeMember(teamId: string, userId: string): Promise<{ removed: true }>
Removes another Team member; callers leave through leave().
Parameters
- teamId: string
- userId: string
Returns Promise<{ removed: true }>
- Defined in server.d.ts:412

rename

rename(teamId: string, name: string): Promise<{ team: TeamSummary }>
Renames an explicitly identified Team administered by the current user.
Parameters
- teamId: string
- name: string
Returns Promise<{ team: TeamSummary }>
- Defined in server.d.ts:390

revokeJoinLink

revokeJoinLink(teamId: string, joinLinkId: string): Promise<{ revoked: true }>
Idempotently revokes an unused Join link scoped to one administered Team.
Parameters
- teamId: string
- joinLinkId: string
Returns Promise<{ revoked: true }>
- Defined in server.d.ts:400

updateApplicationRoles

updateApplicationRoles(
    teamId: string,
    userId: string,
    changes: TeamApplicationRoleChanges,
): Promise<{ updated: true }>
Atomically adds and removes declared application roles for a member of one administered Team.
Parameters
- teamId: string
- userId: string
- changes: TeamApplicationRoleChanges
Returns Promise<{ updated: true }>
- Defined in server.d.ts:394

validateJoinLink

validateJoinLink(code: string): Promise<TeamJoinLinkValidation>
Checks whether the current linked user's attached emails match an active Join link without consuming it.
Parameters
- code: string
Returns Promise<TeamJoinLinkValidation>
- Defined in server.d.ts:404

Type Alias CurrentUserTeamsApi

Index

Methods

Methods

create

Parameters

Returns Promise<{ team: TeamSummary }>

createJoinLink

Parameters

Returns Promise<{ createdAt: string; expiresAt: string; id: string; link: string }>

delete

Parameters

Returns Promise<{ deleted: true }>

demote

Parameters

Returns Promise<{ updated: true }>

inspectJoinLink

Parameters

Returns Promise<TeamJoinLinkInspection>

join

Parameters

Returns Promise<{ team: TeamSummary }>

leave

Parameters

Returns Promise<{ left: true }>

list

Returns Promise<{ teams: TeamSummary[] }>

listJoinLinks

Parameters

Returns Promise<{ links: TeamJoinLink[] }>

listMembers

Parameters

Returns Promise<{ members: TeamMemberSummary[] }>

promote

Parameters

Returns Promise<{ updated: true }>

removeMember

Parameters

Returns Promise<{ removed: true }>

rename

Parameters

Returns Promise<{ team: TeamSummary }>

revokeJoinLink

Parameters

Returns Promise<{ revoked: true }>

updateApplicationRoles

Parameters

Returns Promise<{ updated: true }>

validateJoinLink

Parameters

Returns Promise<TeamJoinLinkValidation>

Settings

On This Page