import { ConsentsInformation } from './UserConsents';

/**
 * This type represent the data needed to make a get user API request
 */
export type GetUserRequest = {
    /**
     * The user username
     */
    username?: string
};

/**
 * This type represent the model for a user
 */
export type UserDetails = {
    /**
     * The user id
     */
    authorId: string;
    /**
     * The user email
     */
    email: string;
    /**
     * The user full name
     */
    fullName: string;
    /**
     * Mark if the email si verified
     */
    verified: boolean;
};

/**
 * This type represent the response of a get current user API request
 */
export type GetCurrentUserResponse = {
    /**
     * The current user details
     */
    userDetails: UserDetails;
    /**
     * The current user information about consents
     */
    consents: ConsentsInformation;
};

/**
 * This type represent the data needed to make a list user by space API request
 */
export type ListUserBySpaceRequest = {};

/**
 * This type represent the model of a user by space
 */
export type UserBySpace = {
    /**
     * The unique user id
     */
    userId: string;
    /**
     * The user username
     */
    username: string;
    /**
     * The user full name
     */
    fullName: string;
    /**
     * The user email
     */
    email: string;
    /**
     * The user list of assigned profile ids
     */
    profileIds: string[];
    /**
     * Mark if the user verified the email
     */
    emailVerified: boolean;
    /**
     * The user avatar
     */
    avatar?: string;
};

/**
 * This type represent the response of a list user by space API response
 */
export type ListUserBySpaceResponse = UserBySpace[];

/**
 * This type represent the data needed to make a verify email API request
 */
export type VerifyEmailRequest = {
    /**
     * The verification token to verify the email
     */
    token: string;
};

/**
 * This type represent the response of a verify email API request
 */
export type VerifyEmailResponse = boolean;

/**
 * This type represent the data needed to make a remove user API request
 */
export interface RemoveUserRequest { }

/**
 * This type represent the response of a remove user API request
 */
export type RemoveUserResponse = boolean;

/**
 * This type represent the data needed to make a request email verification API request
 */
export type RequestEmailVerificationRequest = {};

/**
 * This type represent the response of a request email verification API request
 */
export type RequestEmailVerificationResponse = boolean;