Avis (ReviewApi)

Le module ReviewApi gère les avis clients sur les produits, agents et rendez-vous. Supporte les types STORE_PRODUCT, MULTI_SERVICE_AGENT et MULTI_SERVICE_APPOINTMENT.

Accès : client.review

Méthodes

`submit`

Permet à un client de soumettre un avis.

Exemple


const response = await client.review.submit({
  appId: "app_id",
  appApiKey: "app_api_key",
  customerApiKey: "+2250700000000",
  type: "STORE_PRODUCT",
  rating: 4,
  title: "Très bon produit",
  comment: "Qualité excellente",
  productId: "product_id"
});

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`appApiKey`	string	Oui	Clé API de l’app
`customerApiKey`	string	Oui	Téléphone du client
`type`	string	Oui	Type d’avis
`rating`	number	Oui	Note (1-5)
`title`	string	Non	Titre
`comment`	string	Non	Commentaire
`images`	string[]	Non	URLs des images
`productId`	string	Non	ID du produit
`agentId`	string	Non	ID de l’agent
`appointmentId`	string	Non	ID du rendez-vous

Réponse


{
  "success": true,
  "data": {
    "id": "review_id",
    "type": "STORE_PRODUCT",
    "rating": 4,
    "isVerified": false,
    "createdAt": "2024-01-01T00:00:00.000Z"
  }
}

`list`

Liste les avis avec filtres et pagination (admin).

Exemple


const response = await client.review.list({
  appId: "app_id",
  apiKey: "user_api_key",
  type: "STORE_PRODUCT",
  isVerified: true,
  page: 1,
  limit: 20
});

`listPublic`

Liste les avis vérifiés (public).

Exemple


const response = await client.review.listPublic({
  appId: "app_id",
  type: "STORE_PRODUCT",
  productId: "product_id",
  limit: 10
});

`getById`

Récupère un avis par son ID.

Exemple


const response = await client.review.getById({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "review_id"
});

`update`

Modifie un avis.

Exemple


const response = await client.review.update({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "review_id",
  title: "Titre modifié",
  rating: 5
});

`delete`

Supprime un avis.

Exemple


const response = await client.review.delete({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "review_id"
});

`verify`

Approuve ou refuse un avis.

Exemple


const response = await client.review.verify({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "review_id",
  isVerified: true
});