ecoledirecte-api-types/v3/responses/global/mailbox.ts

If you need a EcoleDirecte client for JavaScript, this isn't the right place! This way: [ecoledirecte.js](https://github.com/a2br/ecoledirecte.js).

import { failureRes } from "..";
import { role } from "../login/accounts";

export type mailboxRes = mailboxResSuccess | failureRes;

export type mailboxResSuccess = {
	code: 200;
	token: string;
	host: string;
	data: mailboxResData;
};

export type mailboxResData = {
	classeurs: Array<unknown>;
	messages: {
		received: Array<mailboxResMessage>;
		sent: Array<mailboxResMessage>;
		archived: Array<mailboxResMessage>;
	};
	parametrage: {
		isActif: boolean;
		canParentsLireMessagesEnfants: boolean;
		destAdmin: boolean;
		destEleve: boolean;
		destFamille: boolean;
		destProf: boolean;
		destEspTravail: boolean;
		disabledNotification: boolean;
		notificationEmailEtablissement: boolean;
		choixMailNotification: number;
		autreMailNotification: string;
		mailPro: string;
		mailPerso: string;
		messagerieApiVersion: "v3" | string;
		blackListProfActive: boolean;
		estEnBlackList: boolean;
		afficherToutesLesClasses: boolean;
	};
	pagination: {
		messagesRecusCount: number;
		messagesEnvoyesCount: number;
		messagesArchivesCount: number;
		messagesRecusNotReadCount: number;
	};
};

export type mailboxResMessage = {
	id: number;
	mtype: "received" | "sent";
	read: boolean;
	idDossier: number;
	idClasseur: number;
	transferred: boolean;
	answered: boolean;
	to_cc_cci: "to" | "cc" | "cci";
	subject: string;
	/** Very probably always empty */
	content: string;
	date: string;
	to: Array<{
		civilite: string;
		fonctionPersonnel: string;
		id: number;
		name: string;
		nom: string;
		particule: string;
		prenom: string;
		read: boolean;
		role: role;
		to_cc_cci: "to" | "cc" | "cci";
	}>;
	files: Array<{
		id: number;
		libelle: string;
		date: string;
		type: string;
		signatureDemandee: boolean;
		signature: unknown; // {}
	}>;
	from: {
		name: string;
		nom: string;
		prenom: string;
		particule: string;
		civilite: string;
		role: role;
		listeRoute: boolean;
		id: number;
		read: boolean;
		fonctionPersonnel: string;
	};
};

export type messageResSuccess = {
	code: 200;
	token: string;
	host: string;
	data: {
		id: number;
		mtype: "send" | string;
		read: boolean;
		idDossier: number;
		idClasseur: number;
		transferred: boolean;
		answered: boolean;
		to_cc_cci: "" | "to" | "cc" | "cci";
		subject: string;
		/** BASE64 */
		content: string;
		date: string; // "2020-07-17 10:10:40";
		to: Array<{
			name: string;
			nom: string;
			prenom: string;
			particule: string;
			civilite: string;
			role: role;
			id: number;
			read: boolean;
			to_cc_cci: "to" | "cc" | "cci";
			fonctionPersonnel: string;
		}>;

		files: Array<{
			id: number;
			libelle: string;
			date: string; // "2020-07-17";
			type: "PIECE_JOINTE" | string;
			signatureDemandee: boolean;
			signature: unknown;
		}>;
		from: {
			name: string;
			nom: string;
			prenom: string;
			particule: string;
			civilite: string;
			role: role;
			listeRouge: boolean;
			id: number;
			read: boolean;
			fonctionPersonnel: string;
		};
	};
};