Package com.vortexsoftware.sdk.types

package com.vortexsoftware.sdk.types
  • Classes
    Class
    Description
    AcceptInvitationRequest
    Request payload for accepting invitations Supports both new User format (preferred) and legacy target format (deprecated)
    AcceptUser
    User data for accepting invitations Required fields: At least one of email or phone must be provided Optional fields: - email: User's email address - phone: User's phone number - name: User's display name Example:
    CreateInvitationGroup
    Group information for creating invitations.
    CreateInvitationRequest
    Request body for creating an invitation via the public API (backend SDK use).
    CreateInvitationResponse
    Response from creating an invitation.
    CreateInvitationTarget
    Target for creating an invitation.
    Group
    Represents a group for JWT generation (input).
    Identifier
    Represents an identifier for a user (email, sms, etc.) Used for JWT generation.
    InvitationAcceptance
    Represents an accepted invitation
    InvitationGroup
    Represents a group associated with an invitation.
    InvitationResponse
    Response wrapper for invitation API calls that return multiple invitations
    InvitationResult
    Complete invitation result as returned by the Vortex API
    InvitationTarget
    Represents the target of an invitation (email, SMS, etc.)
    Inviter
    Information about the user creating the invitation (the inviter).
    JWTPayload
    JWT payload for Vortex token generation Supports both new simplified format (userEmail, userIsAutojoinAdmin) and legacy format (identifiers, groups, role) for backward compatibility.
    User
    User data for JWT generation Required fields: - id: User's unique identifier in your system - email: User's email address Optional fields: - name: User's display name (max 200 characters) - avatarUrl: User's avatar URL (must be HTTPS, max 2000 characters) - adminScopes: List of admin scopes (e.g., ["autojoin"]) Example: