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


final response = await client.multiService.fieldTemplate.list(
  ListFieldTemplatesParams(
    appId: 'app_id',
    apiKey: 'user_api_key',
  ),
);
 
// Afficher les modèles disponibles
for (final template in response.data) {
  print('${template.label} (${template.type.name})');
}

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
final response = await client.multiService.fieldTemplate.create(
  CreateFieldTemplateParams(
    appId: 'app_id',
    apiKey: 'user_api_key',
    ref: 'delivery_zone',
    label: 'Zone de livraison',
    description: 'Sélectionnez votre zone',
    type: FieldType.select,
    required: true,
    options: [
      FieldOptionInput(
        label: 'Zone 1 - Centre',
        value: 'zone_1',
        price: 1000,
      ),
      FieldOptionInput(
        label: 'Zone 2 - Périphérie',
        value: 'zone_2',
        price: 2000,
      ),
    ],
  ),
);
 
print('Modèle créé: ${response.data.id}');


// Créer un modèle de type NUMBER avec contraintes
final response = await client.multiService.fieldTemplate.create(
  CreateFieldTemplateParams(
    appId: 'app_id',
    apiKey: 'user_api_key',
    ref: 'quantity',
    label: 'Quantité',
    type: FieldType.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`	FieldType	Oui	Type de champ
`ref`	String?	Non	Référence unique
`description`	String?	Non	Description du champ
`min`	num?	Non	Valeur minimale (pour NUMBER)
`max`	num?	Non	Valeur maximale (pour NUMBER)
`minLength`	num?	Non	Longueur minimale (pour TEXT)
`maxLength`	num?	Non	Longueur maximale (pour TEXT)
`regex`	String?	Non	Expression régulière
`required`	bool?	Non	Champ obligatoire
`multiplier`	bool?	Non	Multiplicateur de prix
`useSelect`	bool?	Non	Mode sélection
`options`	List<FieldOptionInput>?	Non	Options

Réponse


{
  "success": true,
  "data": {
    "id": "template_789",
    "appId": "app_id",
    "ref": "delivery_zone",
    "label": "Zone de livraison",
    "type": "SELECT",
    "required": true,
    "options": [
      { "id": "opt_1", "label": "Zone 1 - Centre", "value": "zone_1", "price": 1000 },
      { "id": "opt_2", "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


final response = await client.multiService.fieldTemplate.update(
  UpdateFieldTemplateParams(
    appId: 'app_id',
    apiKey: 'user_api_key',
    id: 'template_789',
    label: 'Zone de livraison (mise à jour)',
    options: [
      FieldOptionInput(label: 'Zone 1 - Centre-ville', value: 'zone_1', price: 1500),
      FieldOptionInput(label: 'Zone 2 - Banlieue', value: 'zone_2', price: 2500),
      FieldOptionInput(label: 'Zone 3 - Éloignée', value: 'zone_3', price: 4000),
    ],
  ),
);
 
print('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`	FieldType?	Non	Nouveau type
`ref`	String?	Non	Nouvelle référence
`description`	String?	Non	Nouvelle description
`min`	num?	Non	Nouvelle valeur min
`max`	num?	Non	Nouvelle valeur max
`minLength`	num?	Non	Nouvelle longueur min
`maxLength`	num?	Non	Nouvelle longueur max
`regex`	String?	Non	Nouvelle regex
`required`	bool?	Non	Nouveau statut obligatoire
`multiplier`	bool?	Non	Nouveau statut multiplicateur
`useSelect`	bool?	Non	Nouveau mode sélection
`options`	List<FieldOptionInput>?	Non	Nouvelles options

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


final response = await client.multiService.fieldTemplate.delete(
  DeleteFieldTemplateParams(
    appId: 'app_id',
    apiKey: 'user_api_key',
    id: 'template_789',
  ),
);
 
print('Modèle supprimé');

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

Enum	Valeur JSON	Description
`FieldType.text`	`TEXT`	Texte libre
`FieldType.number`	`NUMBER`	Valeur numérique
`FieldType.select`	`SELECT`	Liste à choix unique
`FieldType.multipleSelect`	`MULTIPLE_SELECT`	Liste à choix multiples
`FieldType.email`	`EMAIL`	Adresse email
`FieldType.phone`	`PHONE`	Numéro de téléphone
`FieldType.date`	`DATE`	Date
`FieldType.address`	`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