Package com.vortexsoftware.sdk.types

Class CreateInvitationRequest

java.lang.Object

com.vortexsoftware.sdk.types.CreateInvitationRequest

public class CreateInvitationRequest
extends Object

Request body for creating an invitation via the public API (backend SDK use).

This allows creating invitations programmatically using your API key, without requiring a user JWT token. Useful for server-side invitation creation, such as "People You May Know" flows or admin-initiated invitations.

Example:

 CreateInvitationRequest request = new CreateInvitationRequest(
     "widget-config-123",
     new CreateInvitationTarget("email", "invitee@example.com"),
     new Inviter("user-456", "inviter@example.com", "John Doe", null)
 );
 request.setGroups(Arrays.asList(
     new CreateInvitationGroup("team", "team-789", "Engineering")
 ));
 CreateInvitationResponse response = client.createInvitation(request);
 

Constructor Summary

Constructors

Constructor	Description
CreateInvitationRequest()
CreateInvitationRequest(String widgetConfigurationId, CreateInvitationTarget target, Inviter inviter)

Method Summary

Modifier and Type	Method	Description
List<CreateInvitationGroup>	getGroups()
Inviter	getInviter()
Map<String,Object>	getMetadata()
String	getSource()
CreateInvitationTarget	getTarget()
Map<String,String>	getTemplateVariables()
String	getWidgetConfigurationId()
void	setGroups(List<CreateInvitationGroup> groups)
void	setInviter(Inviter inviter)
void	setMetadata(Map<String,Object> metadata)
void	setSource(String source)
void	setTarget(CreateInvitationTarget target)
void	setTemplateVariables(Map<String,String> templateVariables)
void	setWidgetConfigurationId(String widgetConfigurationId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CreateInvitationRequest

public CreateInvitationRequest()

CreateInvitationRequest

public CreateInvitationRequest(String widgetConfigurationId,
 CreateInvitationTarget target,
 Inviter inviter)

Method Details

getWidgetConfigurationId

public String getWidgetConfigurationId()

setWidgetConfigurationId

public void setWidgetConfigurationId(String widgetConfigurationId)

getTarget

public CreateInvitationTarget getTarget()

setTarget

public void setTarget(CreateInvitationTarget target)

getInviter

public Inviter getInviter()

setInviter

public void setInviter(Inviter inviter)

getGroups

public List<CreateInvitationGroup> getGroups()

setGroups

public void setGroups(List<CreateInvitationGroup> groups)

getSource

public String getSource()

setSource

public void setSource(String source)

getTemplateVariables

public Map<String,String> getTemplateVariables()

setTemplateVariables

public void setTemplateVariables(Map<String,String> templateVariables)

getMetadata

public Map<String,Object> getMetadata()

setMetadata

public void setMetadata(Map<String,Object> metadata)