Invitations
Workspace API / models/Invitations
models/Invitations
Interfaces
OrganizationInvitation
Defined in: models/Invitations.ts:8
Properties
invitation_id
invitation_id:
string
Defined in: models/Invitations.ts:9
organization_id
organization_id:
string
Defined in: models/Invitations.ts:10
organization_name?
optionalorganization_name:string
Defined in: models/Invitations.ts:11
email
email:
string
Defined in: models/Invitations.ts:12
token
token:
string
Defined in: models/Invitations.ts:13
system_role_id
system_role_id:
string|null
Defined in: models/Invitations.ts:14
custom_role_id
custom_role_id:
string|null
Defined in: models/Invitations.ts:15
role_type
role_type:
InvitationRoleType
Defined in: models/Invitations.ts:16
role_name
role_name:
string
Defined in: models/Invitations.ts:17
invited_by
invited_by:
string|null
Defined in: models/Invitations.ts:18
expires_at
expires_at:
Date
Defined in: models/Invitations.ts:19
accepted_at
accepted_at:
Date|null
Defined in: models/Invitations.ts:20
revoked_at
revoked_at:
Date|null
Defined in: models/Invitations.ts:21
created_at
created_at:
Date
Defined in: models/Invitations.ts:22
CreateInvitationData
Defined in: models/Invitations.ts:25
Properties
organizationId
organizationId:
string
Defined in: models/Invitations.ts:26
email
email:
string
Defined in: models/Invitations.ts:27
roleType
roleType:
InvitationRoleType
Defined in: models/Invitations.ts:28
roleId
roleId:
string
Defined in: models/Invitations.ts:29
invitedBy
invitedBy:
string|null
Defined in: models/Invitations.ts:30
Type Aliases
InvitationRoleType
InvitationRoleType =
"system"|"custom"
Defined in: models/Invitations.ts:6
Functions
createInvitation()
createInvitation(
data,log):Promise<OrganizationInvitation>
Defined in: models/Invitations.ts:51
Create a new organization invitation
Parameters
data
log
Logger = logger
Returns
Promise<OrganizationInvitation>
findInvitationByToken()
findInvitationByToken(
token,log):Promise<OrganizationInvitation|null>
Defined in: models/Invitations.ts:97
Find invitation by token
Parameters
token
string
log
Logger = logger
Returns
Promise<OrganizationInvitation | null>
findInvitationByEmail()
findInvitationByEmail(
log):Promise<OrganizationInvitation|null>
Defined in: models/Invitations.ts:130
Find pending invitation by email
Parameters
email
string
log
Logger = logger
Returns
Promise<OrganizationInvitation | null>
getPendingInvitationsByEmail()
getPendingInvitationsByEmail(
Promise<OrganizationInvitation[]>
Defined in: models/Invitations.ts:165
Get all pending invitations by email
Parameters
email
string
Returns
Promise<OrganizationInvitation[]>
findInvitationById()
findInvitationById(
invitationId,log):Promise<OrganizationInvitation|null>
Defined in: models/Invitations.ts:197
Find invitation by ID
Parameters
invitationId
string
log
Logger = logger
Returns
Promise<OrganizationInvitation | null>
acceptInvitation()
acceptInvitation(
invitationId,client?,log?):Promise<void>
Defined in: models/Invitations.ts:228
Mark invitation as accepted
Parameters
invitationId
string
client?
any
log?
Logger = logger
Returns
Promise<void>
declineInvitation()
declineInvitation(
invitationId,log):Promise<void>
Defined in: models/Invitations.ts:259
Decline invitation (mark as revoked/declined) We treat decline same as revoke for now, or we could add a declined_at column. For now, let's just use revoked_at or maybe we don't strictly need it if we just ignore it. But user might want it gone. Let's assume revoke for now.
Parameters
invitationId
string
log
Logger = logger
Returns
Promise<void>
revokeInvitation()
revokeInvitation(
invitationId,log):Promise<void>
Defined in: models/Invitations.ts:278
Revoke an invitation
Parameters
invitationId
string
log
Logger = logger
Returns
Promise<void>
getOrganizationInvitations()
getOrganizationInvitations(
organizationId):Promise<OrganizationInvitation[]>
Defined in: models/Invitations.ts:297
Get all invitations for an organization
Parameters
organizationId
string
Returns
Promise<OrganizationInvitation[]>