OpenPRA Documentation

web-backend

Class: InviteController ​

Defined in: packages/web-backend/src/invite/invite.controller.ts:28

Controller for user invitation management. Exposes endpoints to create, verify, update, fetch and delete invites.

Constructors ​

Constructor ​

new InviteController(inviteService): InviteController

Defined in: packages/web-backend/src/invite/invite.controller.ts:33

Construct the controller with the invite service dependency.

Parameters ​

inviteService ​

InviteService

Service that manages invite persistence and validation.

Returns ​

InviteController

Methods ​

deleteInvite() ​

deleteInvite(id): Promise<boolean>

Defined in: packages/web-backend/src/invite/invite.controller.ts:106

This endpoint will delete invitedUser by id

Parameters ​

id ​

string

The invite id to delete.

Returns ​

Promise<boolean>

true when deleted successfully; false otherwise.

generateInvitationLink(body): Promise<InviteIdDto>

Defined in: packages/web-backend/src/invite/invite.controller.ts:50

This endpoint will generate an invitation id for a user

Parameters ​

body ​

InvitedUserDto

The InvitedUserDto object

Returns ​

Promise<InviteIdDto>

An object containing the generated invite id.

Example ​

json
{
  "firstname": "xyz",
  "lastname": "abc",
  "email": "abcxyz\@gmail.com",
  "username": "xyzabc"
}

getAllInvites() ​

getAllInvites(): Promise<InvitedUserDetailsDto[]>

Defined in: packages/web-backend/src/invite/invite.controller.ts:96

This endpoint will return all the invites that were generated

Returns ​

Promise<InvitedUserDetailsDto[]>

An array of invite details.

getInvite() ​

getInvite(id): Promise<InvitedUserDetailsDto>

Defined in: packages/web-backend/src/invite/invite.controller.ts:116

This endpoint will get invitedUser by id

Parameters ​

id ​

string

The invite id to fetch.

Returns ​

Promise<InvitedUserDetailsDto>

The invited user details when found.

updateInvite() ​

updateInvite(body): Promise<InvitedUserDto>

Defined in: packages/web-backend/src/invite/invite.controller.ts:61

This endpoint will update an invite

Parameters ​

body ​

InvitedUserDetailsDto

InvitedUserDetailsDto object

Returns ​

Promise<InvitedUserDto>

The updated invite payload.

verifyInvitationLink(body): Promise<InvitedUserDto>

Defined in: packages/web-backend/src/invite/invite.controller.ts:78

This public endpoint will check if an invite id is correct and not expired.

Parameters ​

body ​

InviteIdDto

InviteIDDto object

Returns ​

Promise<InvitedUserDto>

  • InvitedUserDto object or throws when invalid/expired.

Example ​

json
{
  "id": "abcde-fghij-klmnon-asdnj"
}