Rendez-vous (MultiServiceAppointment)

Le module MultiServiceAppointmentModule gère la prise de rendez-vous pour les services. Il permet de créer, lister et gérer le cycle de vie des rendez-vous.

Accès : client.app.multiService.appointment

Statuts de rendez-vous

Statut	Description
`PENDING`	Rendez-vous créé, en attente de confirmation
`CONFIRMED`	Rendez-vous confirmé par l’entreprise
`IN_PROGRESS`	Rendez-vous en cours
`COMPLETED`	Rendez-vous terminé
`CANCELLED`	Rendez-vous annulé

Méthodes

`create`

Crée un nouveau rendez-vous.

Exemple


const response = await client.app.multiService.appointment.create({
  appId: "app_id",
  apiKey: "user_api_key",
  serviceId: "service_id",
  customerId: "customer_id",
  date: new Date("2025-01-15T10:00:00Z"),
  totalPrice: 5000,
  commune: "Cocody",
  filledFields: {
    "type_coupe": "degrade",
    "commentaires": "Coupe courte sur les côtés"
  },
  agentId: "agent_id", // Optionnel
});

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API de l’utilisateur
`serviceId`	string	Oui	ID du service réservé
`date`	Date/string	Oui	Date et heure du rendez-vous (ISO 8601)
`totalPrice`	integer	Oui	Prix total calculé (en plus petite unité)
`commune`	string	Oui	Commune/Localisation du rendez-vous
`filledFields`	object	Oui	Réponses aux champs du service (clé-valeur)
`agentId`	string	Non	ID de l’agent assigné
`customerId`	string	Oui	ID du client

Le companyId est automatiquement déterminé à partir du service sélectionné.

Si un agentId est fourni, l’agent doit appartenir à la même entreprise que le service.

Réponse


{
  "success": true,
  "data": {
    "id": "appointment_id",
    "appId": "app_id",
    "companyId": "company_id",
    "serviceId": "service_id",
    "agentId": "agent_id",
    "customerId": "customer_id",
    "filledFields": {
      "type_coupe": "degrade",
      "commentaires": "Coupe courte sur les côtés"
    },
    "totalPrice": 5000,
    "date": "2025-01-15T10:00:00.000Z",
    "commune": "Cocody",
    "status": "PENDING",
    "createdAt": "2025-01-10T14:30:00.000Z",
    "updatedAt": "2025-01-10T14:30:00.000Z"
  }
}

Erreurs possibles :


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


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

`list`

Liste les rendez-vous avec filtres optionnels.

Exemple


// Lister tous les rendez-vous
const all = await client.app.multiService.appointment.list({
  appId: "app_id",
  apiKey: "user_api_key"
});
 
// Filtrer par statut
const pending = await client.app.multiService.appointment.list({
  appId: "app_id",
  apiKey: "user_api_key",
  status: "PENDING"
});
 
// Filtrer par service
const byService = await client.app.multiService.appointment.list({
  appId: "app_id",
  apiKey: "user_api_key",
  serviceId: "service_id"
});
 
// Combiner les filtres
const filtered = await client.app.multiService.appointment.list({
  appId: "app_id",
  apiKey: "user_api_key",
  companyId: "company_id",
  serviceId: "service_id",
  status: "CONFIRMED"
});

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API de l’utilisateur
`companyId`	string	Non	Filtrer par entreprise
`serviceId`	string	Non	Filtrer par service
`status`	AppointmentStatus	Non	Filtrer par statut

Les rendez-vous sont triés par date décroissante (les plus récents en premier).

Réponse


{
  "success": true,
  "data": [
    {
      "id": "appointment_id",
      "appId": "app_id",
      "companyId": "company_id",
      "serviceId": "service_id",
      "agentId": "agent_id",
      "customerId": null,
      "filledFields": { "type_coupe": "classique" },
      "totalPrice": 3500,
      "date": "2025-01-20T14:00:00.000Z",
      "commune": "Plateau",
      "status": "CONFIRMED",
      "createdAt": "2025-01-10T09:00:00.000Z",
      "updatedAt": "2025-01-10T10:30:00.000Z",
      "service": {
        "id": "service_id",
        "name": "Coupe Homme"
      },
      "agent": {
        "id": "agent_id",
        "fullname": "Alice Kouassi"
      }
    }
  ]
}

`get`

Récupère les détails d’un rendez-vous spécifique.

Exemple


const response = await client.app.multiService.appointment.get({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "appointment_id"
});
 
if (response.success) {
  const apt = response.data;
  console.log(`Rendez-vous: ${apt.service.name}`);
  console.log(`Date: ${apt.date}`);
  console.log(`Statut: ${apt.status}`);
  console.log(`Agent: ${apt.agent?.fullname ?? 'Non assigné'}`);
}

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 du rendez-vous
`companyId`	string	Non	ID de l’entreprise (pour validation)

Réponse


{
  "success": true,
  "data": {
    "id": "appointment_id",
    "appId": "app_id",
    "companyId": "company_id",
    "serviceId": "service_id",
    "agentId": "agent_id",
    "customerId": "customer_id",
    "filledFields": {
      "type_coupe": "degrade",
      "commentaires": "Dégradé bas"
    },
    "totalPrice": 4500,
    "date": "2025-01-15T10:00:00.000Z",
    "commune": "Cocody",
    "status": "CONFIRMED",
    "createdAt": "2025-01-10T14:30:00.000Z",
    "updatedAt": "2025-01-11T09:00:00.000Z",
    "service": {
      "id": "service_id",
      "name": "Coupe Homme"
    },
    "agent": {
      "id": "agent_id",
      "fullname": "Alice Kouassi"
    }
  }
}

Erreur possible :


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

`updateStatus`

Met à jour le statut d’un rendez-vous. C’est la seule façon de modifier un rendez-vous après sa création.

Exemple


// Confirmer un rendez-vous
const confirmed = await client.app.multiService.appointment.updateStatus({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "appointment_id",
  status: "CONFIRMED"
});
 
// Marquer comme en cours
const inProgress = await client.app.multiService.appointment.updateStatus({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "appointment_id",
  status: "IN_PROGRESS"
});
 
// Terminer le rendez-vous
const completed = await client.app.multiService.appointment.updateStatus({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "appointment_id",
  status: "COMPLETED"
});
 
// Annuler un rendez-vous
const cancelled = await client.app.multiService.appointment.updateStatus({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "appointment_id",
  status: "CANCELLED"
});

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 du rendez-vous
`status`	AppointmentStatus	Oui	Nouveau statut
`companyId`	string	Non	ID de l’entreprise (pour vérification)

Valeurs de statut :

PENDING : En attente
CONFIRMED : Confirmé
IN_PROGRESS : En cours
COMPLETED : Terminé
CANCELLED : Annulé

Réponse


{
  "success": true,
  "data": {
    "id": "appointment_id",
    "appId": "app_id",
    "companyId": "company_id",
    "serviceId": "service_id",
    "agentId": "agent_id",
    "customerId": "customer_id",
    "filledFields": { ... },
    "totalPrice": 4500,
    "date": "2025-01-15T10:00:00.000Z",
    "commune": "Cocody",
    "status": "CONFIRMED",
    "createdAt": "2025-01-10T14:30:00.000Z",
    "updatedAt": "2025-01-11T09:00:00.000Z"
  }
}

Erreur possible :


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

Flux de travail typique

Création du rendez-vous

Le client crée un rendez-vous avec le statut initial PENDING.

Confirmation

L’entreprise confirme le rendez-vous → statut CONFIRMED.

Début de la prestation

L’agent commence le service → statut IN_PROGRESS.

Fin de la prestation

Le service est terminé → statut COMPLETED.


// Exemple de flux complet
async function appointmentWorkflow(appointmentId: string) {
  const params = { appId: "app_id", apiKey: "api_key", id: appointmentId };
 
  // 1. Confirmer
  await client.app.multiService.appointment.updateStatus({
    ...params,
    status: "CONFIRMED"
  });
 
  // 2. Démarrer
  await client.app.multiService.appointment.updateStatus({
    ...params,
    status: "IN_PROGRESS"
  });
 
  // 3. Terminer
  await client.app.multiService.appointment.updateStatus({
    ...params,
    status: "COMPLETED"
  });
}

Gestion des erreurs

Code erreur	Description
`appointment-not-found`	Le rendez-vous n’existe pas ou n’appartient pas à l’entreprise
`service-not-found`	Le service spécifié n’existe pas
`agent-not-found`	L’agent spécifié n’existe pas ou n’appartient pas à l’entreprise
`not-authorized`	La clé API n’a pas les droits nécessaires