import { UserProfileIds } from './UserPermission';

/**
 * This interface represent the model of a user invite
 */
export interface UserInvite {
    /**
     * marks the invite as accepted
     */
    accepted: boolean;
    /**
     * invite's guid
     */
    guid: string;
    /**
     * the reserved user privileges
     */
    profileIds: UserProfileIds[];
    /**
     * The space id of the invite
     */
    spaceId: string;
    /**
     * The expiration epoch time of the invite
     */
    timeToLive: number;
    /**
     * The invited user email
     */
    userEmail: string;
}

/**
 * This interface represent the data needed to make an accept user invite API request
 */
export interface AcceptRequest {
    /**
     * The invite guid
     */
    guid: string;
    /**
     * The email related to the invite
     */
    email: string;
}

/**
 * This interface represent the data needed to make an user invite to a space API request
 */
export interface InviteUserToSpaceRequest {
    /**
     * The email of the user to invite
     */
    email: string;
    /**
     * The profiles to assign to the invited user
     */
    profileIds: UserProfileIds[];
}

/**
 * This interface represent the data needed to make a get invite API request
 */
export interface GetRequest {
    /**
     * THe invite guid
     */
    guid: string;
}

/**
 * This type represent the response of a list invite for space API request
 */
export type ListForSpaceResponse = Array<UserInvite>;

/**
 * This type represent the response of a list invite for user API request
 */
export type ListForUserResponse = Array<UserInvite>;

/**
 * This type represent the data needed to make a revoke invite API request
 */
export interface RevokeRequest {
    guid: string;
}