Type Alias DashboardInviteMailer

send

• send(
      invite: {
          dashboardOrigin: string;
          email: string;
          inviteId: string;
          inviterName?: string;
          workspaceName: string;
      },
  ): Promise<{ ok: true; value: T } | { error: E; ok: false }>

  Parameters

  • invite: {
        dashboardOrigin: string;
        email: string;
        inviteId: string;
        inviterName?: string;
        workspaceName: string;
    }

    • dashboardOrigin: string

      The origin the invitee signs up at, e.g. https://dashboard.example.com.

    • email: string

      The invitee's address.

    • inviteId: string

      The invite's inv_… id, which the sign-up link carries.

    • OptionalinviterName?: string

      Absent when no dashboard user sent the invite.

    • workspaceName: string

      The customer's or bank's name.

  Returns Promise<{ ok: true; value: T } | { error: E; ok: false }>