Modèles de Champs (FieldTemplateApi)

Le module FieldTemplateApi permet de gérer les modèles de champs réutilisables pour vos services multi-service. Les modèles définissent la structure et les contraintes de validation des données collectées lors de la création de rendez-vous.

Accès : client.multiService.fieldTemplate

Méthodes

`list`

Liste tous les modèles de champs de l’application.

Exemple


const response = await client.multiService.fieldTemplate.list({
  appId: "app_id",
  apiKey: "user_api_key"
});
 
// Afficher les modèles disponibles
response.data.forEach(template => {
  console.log(`${template.label} (${template.type})`);
});

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API de l’utilisateur

Réponse


{
  "success": true,
  "data": [
    {
      "id": "template_123",
      "appId": "app_id",
      "ref": "quantity",
      "label": "Quantité",
      "description": "Nombre d'unités souhaitées",
      "type": "NUMBER",
      "min": 1,
      "max": 100,
      "required": true,
      "multiplier": true,
      "useSelect": false,
      "options": [],
      "createdAt": "2024-01-15T10:00:00.000Z",
      "updatedAt": "2024-01-15T10:00:00.000Z"
    }
  ]
}

`create`

Crée un nouveau modèle de champ.

Exemple


// Créer un modèle de type SELECT avec options
const response = await client.multiService.fieldTemplate.create({
  appId: "app_id",
  apiKey: "user_api_key",
  ref: "delivery_zone",
  label: "Zone de livraison",
  description: "Sélectionnez votre zone",
  type: "SELECT",
  required: true,
  options: [
    {
      label: "Zone 1 - Centre",
      value: "zone_1",
      price: 1000
    },
    {
      label: "Zone 2 - Périphérie",
      value: "zone_2",
      price: 2000
    }
  ]
});
 
console.log(`Modèle créé: ${response.data.id}`);


// Créer un modèle de type NUMBER avec contraintes
const response = await client.multiService.fieldTemplate.create({
  appId: "app_id",
  apiKey: "user_api_key",
  ref: "quantity",
  label: "Quantité",
  type: "NUMBER",
  min: 1,
  max: 50,
  required: true,
  multiplier: true // Le prix sera multiplié par cette valeur
});

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API de l’utilisateur
`label`	string	Oui	Libellé du champ
`type`	string	Oui	Type de champ (voir tableau ci-dessous)
`ref`	string	Non	Référence unique pour identifier le champ
`description`	string	Non	Description du champ
`min`	number	Non	Valeur minimale (pour NUMBER)
`max`	number	Non	Valeur maximale (pour NUMBER)
`minLength`	number	Non	Longueur minimale (pour TEXT)
`maxLength`	number	Non	Longueur maximale (pour TEXT)
`regex`	string	Non	Expression régulière de validation
`required`	boolean	Non	Champ obligatoire (défaut: false)
`multiplier`	boolean	Non	Utiliser comme multiplicateur de prix
`useSelect`	boolean	Non	Afficher comme liste déroulante
`options`	array	Non	Options pour SELECT/MULTIPLE_SELECT

Structure d’une option :

Champ	Type	Requis	Description
`label`	string	Oui	Libellé de l’option
`value`	string	Oui	Valeur de l’option
`description`	string	Non	Description
`price`	number	Non	Supplément de prix

Réponse


{
  "success": true,
  "data": {
    "id": "template_789",
    "appId": "app_id",
    "ref": "delivery_zone",
    "label": "Zone de livraison",
    "description": "Sélectionnez votre zone",
    "type": "SELECT",
    "required": true,
    "multiplier": false,
    "useSelect": false,
    "options": [
      {
        "id": "opt_1",
        "templateId": "template_789",
        "label": "Zone 1 - Centre",
        "value": "zone_1",
        "price": 1000
      },
      {
        "id": "opt_2",
        "templateId": "template_789",
        "label": "Zone 2 - Périphérie",
        "value": "zone_2",
        "price": 2000
      }
    ],
    "createdAt": "2024-01-20T14:30:00.000Z",
    "updatedAt": "2024-01-20T14:30:00.000Z"
  }
}

`update`

Met à jour un modèle de champ existant.

Exemple


const response = await client.multiService.fieldTemplate.update({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "template_789",
  label: "Zone de livraison (mise à jour)",
  options: [
    { label: "Zone 1 - Centre-ville", value: "zone_1", price: 1500 },
    { label: "Zone 2 - Banlieue", value: "zone_2", price: 2500 },
    { label: "Zone 3 - Éloignée", value: "zone_3", price: 4000 }
  ]
});
 
console.log(`Modèle mis à jour: ${response.data.label}`);

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 modèle
`label`	string	Non	Nouveau libellé
`type`	string	Non	Nouveau type
`ref`	string	Non	Nouvelle référence
`description`	string	Non	Nouvelle description
`min`	number	Non	Nouvelle valeur min
`max`	number	Non	Nouvelle valeur max
`minLength`	number	Non	Nouvelle longueur min
`maxLength`	number	Non	Nouvelle longueur max
`regex`	string	Non	Nouvelle regex
`required`	boolean	Non	Nouveau statut obligatoire
`multiplier`	boolean	Non	Nouveau statut multiplicateur
`useSelect`	boolean	Non	Nouveau mode sélection
`options`	array	Non	Nouvelles options (remplace les existantes)

Réponse


{
  "success": true,
  "data": {
    "id": "template_789",
    "label": "Zone de livraison (mise à jour)",
    "options": [
      { "id": "opt_1", "label": "Zone 1 - Centre-ville", "value": "zone_1", "price": 1500 },
      { "id": "opt_2", "label": "Zone 2 - Banlieue", "value": "zone_2", "price": 2500 },
      { "id": "opt_3", "label": "Zone 3 - Éloignée", "value": "zone_3", "price": 4000 }
    ],
    "updatedAt": "2024-01-21T09:00:00.000Z"
  }
}

`delete`

Supprime un modèle de champ.

Exemple


const response = await client.multiService.fieldTemplate.delete({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "template_789"
});
 
if (response.data.deleted) {
  console.log("Modèle 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 du modèle

Réponse


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

La suppression d’un modèle ne supprime pas les champs des services qui l’utilisent.

Types de champs

Type	Description	Options de validation
`TEXT`	Texte libre	`minLength`, `maxLength`, `regex`
`NUMBER`	Valeur numérique	`min`, `max`
`SELECT`	Liste à choix unique	`options`
`MULTIPLE_SELECT`	Liste à choix multiples	`options`
`EMAIL`	Adresse email	Validation email intégrée
`PHONE`	Numéro de téléphone	Validation téléphone intégrée
`DATE`	Date	-
`ADDRESS`	Adresse postale	-

Multiplicateur de prix

Lorsque multiplier: true, la valeur du champ multiplie le prix de base du service :


Prix total = Prix de base × Valeur du champ multiplicateur + Somme des suppléments d'options

Gestion des erreurs

Code erreur	Description
`template-not-found`	Le modèle n’existe pas ou n’appartient pas à l’application
`not-authorized`	La clé API n’a pas les droits nécessaires
`invalid-request`	Paramètres manquants ou invalides