Class Invitations

constructor

• new Invitations(auth: Auth, apiBaseUrl: string): Invitations

  Parameters

  • auth: Auth
  • apiBaseUrl: string

  Returns Invitations

endpoint

endpointSingleton

checkInvitation

• checkInvitation(invitationCard: InvitationCard): Promise<InvitationCard>

  Check the validity of an invitation token

  Parameters

  • invitationCard: InvitationCard

    The invitation card with token and origin

  Returns Promise<InvitationCard>

  Promise with the invitation data if valid

  Example

  vgsdk.invitations.checkInvitation({
      token: 'abc123',
      email: 'user@example.com',
      origin: 'http://localhost:8080'
    })
      .then(invitation => console.log(invitation))
      .catch(error => console.error(error));
  Copy

completeRegistration

• completeRegistration(registration: InvitationCompleteRegistration): Promise<any>

  Complete the registration process for a user with an invitation token

  Parameters

  • registration: InvitationCompleteRegistration

    Object containing invitation token and password details

  Returns Promise<any>

  Promise with the registration result

  Example

  vgsdk.invitations.completeRegistration({
      invitation_token: '92131fa4fc98fe6e12a5a35129f167f12ec1eabd6279928b5c42a9aa7a49cab9',
      password: 'securePassword123',
      password_confirm: 'securePassword123'
    })
      .then(result => console.log(result))
      .catch(error => console.error(error));
  Copy

generateInvitationLink

• generateInvitationLink(
      invitationRequest: InvitationRequest,
  ): Promise<InvitationCard>

  Generate an invitation link for a specific email and role

  Parameters

  • invitationRequest: InvitationRequest

    Object containing email and role for the invitee

  Returns Promise<InvitationCard>

  Promise with the invitation data including the URL and token

  Example

  vgsdk.invitations.generateInvitationLink({
      email: 'verifgood@gmail.com',
      role: 'ROLE_ADMIN'
    })
      .then(invitation => console.log(invitation))
      .catch(error => console.error(error));
  Copy

regenerateInvitationLink

• regenerateInvitationLink(
      id: number,
  ): Promise<{ invitation_link: string; receiver_email: string }>

  Regenerate an invitation link for an existing invitation

  Parameters

  • id: number

    The ID of the invitation to regenerate

  Returns Promise<{ invitation_link: string; receiver_email: string }>

  Promise with the regenerated invitation link and receiver email

  Example

  vgsdk.invitations.regenerateInvitationLink('123')
      .then(result => console.log(result))
      .catch(error => console.error(error));
  Copy