Package org.openapitools.client.model

Class InvitationData

java.lang.Object

org.openapitools.client.model.InvitationData

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-03-29T12:34:27.506198300-05:00[America/Chicago]",
           comments="Generator version: 7.4.0")
public class InvitationData
extends Object

InvitationData

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InvitationData.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_APP_URL
static String	SERIALIZED_NAME_EMAIL
static String	SERIALIZED_NAME_ORGANIZATION_ID
static String	SERIALIZED_NAME_REDIRECT_URI
static String	SERIALIZED_NAME_USER_ROLE

Constructor Summary

Constructors

Constructor	Description
InvitationData()

Method Summary

Modifier and Type	Method	Description
InvitationData	appUrl(String appUrl)
InvitationData	email(String email)
boolean	equals(Object o)
static InvitationData	fromJson(String jsonString)	Create an instance of InvitationData given an JSON string
@NotNull String	getAppUrl()	The url of the app that the user will be directed to in order to set their password.
@NotNull String	getEmail()	The email of the user to invite.
@NotNull @Valid UUID	getOrganizationId()	The id of the organization to invite the user to.
@NotNull String	getRedirectUri()	The url that the user will be redirected to after setting their password.
@NotNull Integer	getUserRole()	The role the user will have in the organization.
int	hashCode()
InvitationData	organizationId(UUID organizationId)
InvitationData	redirectUri(String redirectUri)
void	setAppUrl(String appUrl)
void	setEmail(String email)
void	setOrganizationId(UUID organizationId)
void	setRedirectUri(String redirectUri)
void	setUserRole(Integer userRole)
String	toJson()	Convert an instance of InvitationData to an JSON string
String	toString()
InvitationData	userRole(Integer userRole)
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_APP_URL

public static final String SERIALIZED_NAME_APP_URL

See Also:

Constant Field Values

SERIALIZED_NAME_EMAIL

public static final String SERIALIZED_NAME_EMAIL

See Also:

Constant Field Values

SERIALIZED_NAME_ORGANIZATION_ID

public static final String SERIALIZED_NAME_ORGANIZATION_ID

See Also:

Constant Field Values

SERIALIZED_NAME_REDIRECT_URI

public static final String SERIALIZED_NAME_REDIRECT_URI

See Also:

Constant Field Values

SERIALIZED_NAME_USER_ROLE

public static final String SERIALIZED_NAME_USER_ROLE

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

InvitationData

public InvitationData()

Method Detail

appUrl

public InvitationData appUrl(String appUrl)

getAppUrl

@Nonnull
@NotNull
public @NotNull String getAppUrl()

The url of the app that the user will be directed to in order to set their password. Usually admin.trieve.ai, but may differ for local dev or self-hosted setups.

Returns:

appUrl

setAppUrl

public void setAppUrl(String appUrl)

email

public InvitationData email(String email)

getEmail

@Nonnull
@NotNull
public @NotNull String getEmail()

The email of the user to invite. Must be a valid email as they will be sent an email to register.

Returns:

email

setEmail

public void setEmail(String email)

organizationId

public InvitationData organizationId(UUID organizationId)

getOrganizationId

@Nonnull
@NotNull
@Valid
public @NotNull @Valid UUID getOrganizationId()

The id of the organization to invite the user to.

Returns:

organizationId

setOrganizationId

public void setOrganizationId(UUID organizationId)

redirectUri

public InvitationData redirectUri(String redirectUri)

getRedirectUri

@Nonnull
@NotNull
public @NotNull String getRedirectUri()

The url that the user will be redirected to after setting their password.

Returns:

redirectUri

setRedirectUri

public void setRedirectUri(String redirectUri)

userRole

public InvitationData userRole(Integer userRole)

getUserRole

@Nonnull
@NotNull
public @NotNull Integer getUserRole()

The role the user will have in the organization. 0 = User, 1 = Admin, 2 = Owner.

Returns:

userRole

setUserRole

public void setUserRole(Integer userRole)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to InvitationData

fromJson

public static InvitationData fromJson(String jsonString)
                               throws IOException

Create an instance of InvitationData given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of InvitationData

Throws:

IOException - if the JSON string is invalid with respect to InvitationData

toJson

public String toJson()

Convert an instance of InvitationData to an JSON string

Returns:

JSON string