Agents (MultiServiceAgent)

Le module MultiServiceAgentModule permet de gérer le personnel (agents) qui effectue les services. Les agents peuvent être associés à plusieurs services et sont affectés aux rendez-vous.

Accès : client.app.multiService.agent

Méthodes

`create`

Crée un nouvel agent.

Exemple


const response = await client.app.multiService.agent.create({
  appId: "app_id",
  apiKey: "user_api_key",
  fullname: "Alice Kouassi",
  email: "alice@salon.com",
  telephone: "+2250505050505",
  bio: "Coiffeuse professionnelle avec 5 ans d'expérience",
  photo: "https://example.com/alice.jpg",
  photoId: "photo_file_id",
  companyId: "company_id", // Optionnel
  serviceIds: ["service_id_1", "service_id_2"],
  isActive: true
});

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API de l’utilisateur
`fullname`	string	Oui	Nom complet de l’agent (min 1 caractère)
`companyId`	string	Non	ID de l’entreprise (utilise l’entreprise par défaut si non fourni)
`email`	string	Non	Email de l’agent (format email valide)
`telephone`	string	Non	Numéro de téléphone
`bio`	string	Non	Biographie/description de l’agent
`photo`	string	Non	URL de la photo
`photoId`	string	Non	ID du fichier photo (pour le suivi/suppression)
`serviceIds`	string[]	Non	Liste des IDs de services que l’agent peut effectuer (défaut: [])
`isActive`	boolean	Non	Agent actif (défaut: true)

Si companyId n’est pas fourni, l’agent sera créé dans l’entreprise par défaut de l’application.

Tous les serviceIds fournis doivent exister et appartenir à la même entreprise que l’agent.

Réponse


{
  "success": true,
  "data": {
    "id": "agent_id",
    "appId": "app_id",
    "companyId": "company_id",
    "fullname": "Alice Kouassi",
    "email": "alice@salon.com",
    "telephone": "+2250505050505",
    "bio": "Coiffeuse professionnelle avec 5 ans d'expérience",
    "photo": "https://example.com/alice.jpg",
    "isActive": true,
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z",
    "services": [
      { "id": "service_id_1", "name": "Coupe Homme" },
      { "id": "service_id_2", "name": "Coupe Femme" }
    ]
  }
}

`list`

Liste les agents avec filtres optionnels.

Exemple


// Lister tous les agents
const all = await client.app.multiService.agent.list({
  appId: "app_id",
  apiKey: "user_api_key"
});
 
// Filtrer par service
const byService = await client.app.multiService.agent.list({
  appId: "app_id",
  apiKey: "user_api_key",
  serviceId: "service_id"
});
 
// Filtrer par statut actif
const activeOnly = await client.app.multiService.agent.list({
  appId: "app_id",
  apiKey: "user_api_key",
  isActive: true
});
 
// Combiner les filtres
const filtered = await client.app.multiService.agent.list({
  appId: "app_id",
  apiKey: "user_api_key",
  serviceId: "service_id",
  isActive: true
});

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API de l’utilisateur
`serviceId`	string	Non	Filtrer par compétence de service
`isActive`	boolean	Non	Filtrer par statut actif

Les agents sont triés par date de création décroissante.

Réponse


{
  "success": true,
  "data": [
    {
      "id": "agent_id",
      "appId": "app_id",
      "companyId": "company_id",
      "fullname": "Alice Kouassi",
      "email": "alice@salon.com",
      "telephone": "+2250505050505",
      "bio": "Coiffeuse professionnelle",
      "photo": "https://example.com/alice.jpg",
      "isActive": true,
      "createdAt": "2024-01-15T10:00:00.000Z",
      "updatedAt": "2024-01-15T10:00:00.000Z",
      "company": {
        "id": "company_id",
        "name": "Salon Belle Coiffure"
      },
      "services": [
        { "id": "service_id_1", "name": "Coupe Homme" },
        { "id": "service_id_2", "name": "Coupe Femme" }
      ]
    }
  ]
}

`get`

Récupère les détails d’un agent.

Exemple


const response = await client.app.multiService.agent.get({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "agent_id"
});
 
if (response.success) {
  const agent = response.data;
  console.log(`Agent: ${agent.fullname}`);
  console.log(`Services: ${agent.services.map(s => s.name).join(', ')}`);
}

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API de l’utilisateur
`id`	string	Oui	ID de l’agent
`companyId`	string	Non	ID de l’entreprise (pour validation)

Réponse


{
  "success": true,
  "data": {
    "id": "agent_id",
    "appId": "app_id",
    "companyId": "company_id",
    "fullname": "Alice Kouassi",
    "email": "alice@salon.com",
    "telephone": "+2250505050505",
    "bio": "Coiffeuse professionnelle avec 5 ans d'expérience",
    "photo": "https://example.com/alice.jpg",
    "isActive": true,
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z",
    "services": [
      { "id": "service_id_1", "name": "Coupe Homme" },
      { "id": "service_id_2", "name": "Coupe Femme" }
    ]
  }
}

Erreur possible :


{
  "success": false,
  "error": "agent-not-found"
}

`update`

Met à jour les informations d’un agent.

Exemple


// Mise à jour du profil
const response = await client.app.multiService.agent.update({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "agent_id",
  fullname: "Alice K.",
  bio: "Spécialiste coloration et coupe"
});
 
// Désactiver un agent
const response2 = await client.app.multiService.agent.update({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "agent_id",
  isActive: false
});
 
// Mettre à jour les services assignés
const response3 = await client.app.multiService.agent.update({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "agent_id",
  serviceIds: ["service_id_1", "service_id_3", "service_id_4"]
});

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API de l’utilisateur
`id`	string	Oui	ID de l’agent
`companyId`	string	Non	ID de l’entreprise (pour validation)
`fullname`	string	Non	Nouveau nom
`email`	string	Non	Nouvel email
`telephone`	string	Non	Nouveau téléphone
`bio`	string	Non	Nouvelle biographie
`photo`	string	Non	Nouvelle URL de photo
`photoId`	string	Non	Nouvel ID du fichier photo
`serviceIds`	string[]	Non	Nouvelle liste de services
`isActive`	boolean	Non	Nouveau statut actif

Si serviceIds est fourni, la liste des services sera entièrement remplacée (pas une fusion).

Réponse


{
  "success": true,
  "data": {
    "id": "agent_id",
    "appId": "app_id",
    "companyId": "company_id",
    "fullname": "Alice K.",
    "email": "alice@salon.com",
    "telephone": "+2250505050505",
    "bio": "Spécialiste coloration et coupe",
    "photo": "https://example.com/alice.jpg",
    "isActive": true,
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-20T14:30:00.000Z",
    "services": [...]
  }
}

`delete`

Supprime un agent.

Exemple


const response = await client.app.multiService.agent.delete({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "agent_id"
});
 
if (response.success) {
  console.log("Agent supprimé avec succès");
}

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API de l’utilisateur
`id`	string	Oui	ID de l’agent
`companyId`	string	Non	ID de l’entreprise

Lors de la suppression d’un agent, tous les rendez-vous qui lui étaient assignés auront leur champ agentId mis à null. Les rendez-vous ne sont pas supprimés.

Réponse


{
  "success": true,
  "data": true
}

Erreur possible :


{
  "success": false,
  "error": "agent-not-found"
}

Exemples d’utilisation

Créer un agent avec tous les services


// Récupérer tous les services de l'entreprise
const services = await client.app.multiService.service.list({
  appId: "app_id",
  apiKey: "user_api_key"
});
 
// Créer un agent polyvalent
const agent = await client.app.multiService.agent.create({
  appId: "app_id",
  apiKey: "user_api_key",
  fullname: "Jean Dupont",
  serviceIds: services.data.map(s => s.id)
});

Trouver des agents disponibles pour un service


// Agents actifs pour un service spécifique
const agents = await client.app.multiService.agent.list({
  appId: "app_id",
  apiKey: "user_api_key",
  serviceId: "service_id",
  isActive: true
});
 
console.log(`${agents.data.length} agent(s) disponible(s)`);

Gestion des erreurs

Code erreur	Description
`agent-not-found`	L’agent n’existe pas ou n’appartient pas à l’entreprise
`not-authorized`	La clé API n’a pas les droits nécessaires
`app-not-found`	L’application n’existe pas