io.rocketbase.commons.dto.appinvite.InviteRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-auth-api Show documentation

There is a newer version: 4.4.1

package io.rocketbase.commons.dto.appinvite;

import io.rocketbase.commons.model.HasFirstAndLastName;
import io.rocketbase.commons.model.HasKeyValue;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;

import javax.annotation.Nullable;
import javax.validation.constraints.Email;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import java.io.Serializable;
import java.util.List;
import java.util.Map;

/**
 * invite a person to create a user. you can predefine it's role etc.
 */
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Schema(description = "invite a person to create a user. you can predefine it's role etc.")
public class InviteRequest implements Serializable, HasFirstAndLastName, HasKeyValue {

    /**
     * name of invitor that will get displayed within email + form
     */
    @NotNull
    @Size(max = 255)
    @Schema(description = "name of invitor that will get displayed within email + form")
    private String invitor;

    /**
     * optional message to add to invited person
     */
    @Size(max = 4000)
    @Nullable
    @Schema(description = "optional message to add to invited person")
    private String message;

    @Nullable
    private String firstName;

    @Nullable
    private String lastName;

    @NotNull
    @Email
    private String email;

    @NotEmpty
    @Singular
    private List roles;

    @Singular
    @Nullable
    private Map keyValues;

    /**
     * optional parameter to overwrite system default
     * 
     * full qualified url to a custom UI that proceed the invite

     * ?inviteId=VALUE will get append
     */
    @Nullable
    @Schema(description = "optional parameter to overwrite system default. full qualified url to a custom UI that proceed the invite ?inviteId=VALUE will get append")
    private String inviteUrl;
}