# châtaigne

## Docs

- [Charge](https://docs.chataigne.ai/api-reference/charge/introduction.md): Introduction to Charge
- [Check address validity and delivery options for chatbot](https://docs.chataigne.ai/api-reference/chatbot/check-address.md)
- [Introduction](https://docs.chataigne.ai/api-reference/conversations/introduction.md): Conversation regroups all the informations about an exchange between a customer and a location including the chatbot memory.
- [Create a new customer](https://docs.chataigne.ai/api-reference/customers/create-a-new-customer.md): Creates a new customer in the system with the provided information
- [Delete a customer](https://docs.chataigne.ai/api-reference/customers/delete-a-customer.md): Deletes a customer from the system
- [Update a customer](https://docs.chataigne.ai/api-reference/customers/update-a-customer.md): Updates an existing customer with the provided information
- [Delivery](https://docs.chataigne.ai/api-reference/delivery/introduction.md): Introduction to the Delivery
- [Discount](https://docs.chataigne.ai/api-reference/discount/introduction.md): Introduction to the Discount
- [Introduction](https://docs.chataigne.ai/api-reference/introduction.md): Documentation complète de l'API REST de châtaigne
- [Create a new restaurant location](https://docs.chataigne.ai/api-reference/locations/create-a-new-restaurant-location.md): Creates a new restaurant location and assigns the current user as owner
- [Update a restaurant location](https://docs.chataigne.ai/api-reference/locations/update-a-restaurant-location.md): Updates basic information for an existing restaurant location
- [Update location settings](https://docs.chataigne.ai/api-reference/locations/update-location-settings.md): Updates general settings for a specific restaurant location
- [Update payment settings](https://docs.chataigne.ai/api-reference/locations/update-payment-settings.md): Updates payment settings for a specific restaurant location
- [Register an assistant message](https://docs.chataigne.ai/api-reference/messages/register-an-assistant-message.md): Registers a new message from the assistant in the conversation
- [Send a platform message](https://docs.chataigne.ai/api-reference/messages/send-a-platform-message.md): Sends a new message through the platform (WhatsApp)
- [Create a new order draft](https://docs.chataigne.ai/api-reference/order-drafts/create-a-new-order-draft.md)
- [Creating an order draft](https://docs.chataigne.ai/api-reference/order-drafts/create-order-draft.md): Create an order draft
- [Introduction](https://docs.chataigne.ai/api-reference/order-drafts/introduction.md): Introduction to the Order Drafts
- [When the order draft is ready for payment](https://docs.chataigne.ai/api-reference/order-drafts/order-draft-ready.md): When the order draft is ready for payment
- [Payment handling](https://docs.chataigne.ai/api-reference/order-drafts/payment-handling.md): Handling payment methods
- [Register an order draft](https://docs.chataigne.ai/api-reference/order-drafts/register-an-order-draft.md): Converts an order draft into a confirmed order. This endpoint does not process payment and should only be use when the payment is handled by the store.
- [Update and validate an order draft](https://docs.chataigne.ai/api-reference/order-drafts/update-and-validate-an-order-draft.md): Updates an order draft and returns validation results
- [Updating and checking an order draft](https://docs.chataigne.ai/api-reference/order-drafts/update-order-draft.md): Update an order draft
- [Create a new order](https://docs.chataigne.ai/api-reference/orders/create-a-new-order.md): Creates a new order. An existing customer can be linked to the order by providing a customerId to the order.
- [Introduction](https://docs.chataigne.ai/api-reference/orders/introduction.md): Introduction to the Orders API
- [Update order status](https://docs.chataigne.ai/api-reference/orders/update-order-status.md): Updates an order status and emits order updated events.
- [Create a new payment method](https://docs.chataigne.ai/api-reference/payment-methods/create-a-new-payment-method.md): Creates a new payment method for a customer
- [Delete a payment method](https://docs.chataigne.ai/api-reference/payment-methods/delete-a-payment-method.md): Removes a payment method from the system
- [Get URL for registering a payment method](https://docs.chataigne.ai/api-reference/payment/get-url-for-registering-a-payment-method.md): Creates a Stripe session URL for registering a new payment method
- [Payment](https://docs.chataigne.ai/api-reference/payment/introduction.md): Introduction to the Payment
- [Project updates](https://docs.chataigne.ai/changelog/changelog.md): New features, bug fixes, and improvements
- [Changelog](https://docs.chataigne.ai/changelog/chatbot/changelog.md): All the changes made to the chatbot grouped by project
- [Fee split algorithm](https://docs.chataigne.ai/changelog/chatbot/changelog/fee-split-algorithm.md)
- [Framework structure](https://docs.chataigne.ai/chatbot/clerk-framework-structure.md): Architecture and structural components of the Clerk framework
- [Available Commands](https://docs.chataigne.ai/chatbot/commands.md): Special commands available for debugging and testing the chatbot integration
- [The context manager](https://docs.chataigne.ai/chatbot/context-manager.md): How Clerk manages conversation context and maintains state across interactions
- [Development Routes](https://docs.chataigne.ai/chatbot/development-routes.md)
- [FastAPI](https://docs.chataigne.ai/chatbot/fastapi-overview.md): FastAPI integration and web API endpoints for the Clerk chatbot system
- [Queue System Developer Guide](https://docs.chataigne.ai/chatbot/features/queue-system.md): Implementing queue-aware chatbot logic with dual message/event queues
- [Translation](https://docs.chataigne.ai/chatbot/features/translation.md)
- [Getting started](https://docs.chataigne.ai/chatbot/getting-started.md): Quick intro to LeClerk, how it works, and where to find everything in the chatbot docs.
- [Leclerk architecture](https://docs.chataigne.ai/chatbot/leclerk-architecture.md): Implementing queue-aware chatbot logic with dual message/event queues
- [Multi location management](https://docs.chataigne.ai/chatbot/multi-location-management.md)
- [Nexus Client](https://docs.chataigne.ai/chatbot/nexus.md): HTTP client for sending messages and data to the server
- [Memory](https://docs.chataigne.ai/chatbot/old/memory.md)
- [Message processing](https://docs.chataigne.ai/chatbot/old/message-processing.md)
- [Product Restrictions](https://docs.chataigne.ai/chatbot/old/product-restrictions.md): Understanding and implementing product availability restrictions in your chatbot
- [Order Draft](https://docs.chataigne.ai/chatbot/order-draft.md): Description of your new file.
- [Langfuse Service](https://docs.chataigne.ai/chatbot/services/langfuse.md): Conversation tracing and observability service using Langfuse SDK
- [Linear Service](https://docs.chataigne.ai/chatbot/services/linear.md): GraphQL client for Linear issue tracking integration
- [Notifications Service](https://docs.chataigne.ai/chatbot/services/notifications.md): Multi-channel notification service for alerts and issue reporting
- [Tools Reference](https://docs.chataigne.ai/chatbot/tools-reference.md): Complete reference guide for all 21 tools available in the Leclerk system
- [All Tools Overview](https://docs.chataigne.ai/chatbot/tools/all-tools.md): Comprehensive guide to the Leclerk tool system
- [Check Address Tool](https://docs.chataigne.ai/chatbot/tools/check-address.md): Address validation and location selection for delivery orders
- [Customer Management Tools](https://docs.chataigne.ai/chatbot/tools/customer-management.md): Tools for managing customer information, preferences, and feedback
- [Menu Lookup Tool](https://docs.chataigne.ai/chatbot/tools/menu-lookup.md): Comprehensive menu search and browsing capabilities
- [Scheduled Messages System](https://docs.chataigne.ai/chatbot/tools/scheduled-messages.md): WhatsApp message scheduling and management tools
- [Update order draft](https://docs.chataigne.ai/chatbot/tools/update-order-draft.md)
- [Address Models](https://docs.chataigne.ai/chatbot/types/address.md): Address and location-related data models for location services, delivery settings, and geographical coordinates
- [Business Organization](https://docs.chataigne.ai/chatbot/types/business-organization.md)
- [Catalog Models](https://docs.chataigne.ai/chatbot/types/catalog.md): Product catalog and menu-related data models for managing products, SKUs, categories, options, and deals
- [Chatbot Models](https://docs.chataigne.ai/chatbot/types/chatbot.md): Chatbot-specific data models for conversations, messages, flows, and AI assistant interactions
- [Address](https://docs.chataigne.ai/chatbot/types/common/address.md)
- [Price](https://docs.chataigne.ai/chatbot/types/common/price.md)
- [Assistant Message](https://docs.chataigne.ai/chatbot/types/conversation/assistant-message.md)
- [Introduction](https://docs.chataigne.ai/chatbot/types/conversation/introduction.md)
- [Customer](https://docs.chataigne.ai/chatbot/types/customer.md)
- [Customer Models](https://docs.chataigne.ai/chatbot/types/customers.md): Customer-related data models for managing customer information, profiles, and memory
- [Delivery Models](https://docs.chataigne.ai/chatbot/types/delivery.md): Delivery-related data models for managing third-party delivery services, courier information, and delivery tracking
- [Event Models](https://docs.chataigne.ai/chatbot/types/events.md): Event-related data models for handling system events, webhooks, and notifications from the Nexus platform
- [Last Message](https://docs.chataigne.ai/chatbot/types/last-message.md)
- [Catalog](https://docs.chataigne.ai/chatbot/types/location/catalog.md)
- [Location](https://docs.chataigne.ai/chatbot/types/location/introduction.md)
- [Applied Discount](https://docs.chataigne.ai/chatbot/types/order-draft/applied-discount.md)
- [Order Draft](https://docs.chataigne.ai/chatbot/types/order-draft/introduction.md)
- [Order Draft Item](https://docs.chataigne.ai/chatbot/types/order-draft/order-draft-item.md)
- [Delivery](https://docs.chataigne.ai/chatbot/types/order/delivery.md)
- [Order](https://docs.chataigne.ai/chatbot/types/order/introduction.md)
- [Order Items](https://docs.chataigne.ai/chatbot/types/order/order-items.md)
- [Payment](https://docs.chataigne.ai/chatbot/types/order/payment.md)
- [Order Models](https://docs.chataigne.ai/chatbot/types/orders.md): Order and order draft data models for managing customer orders, order items, and order lifecycle
- [Organization Models](https://docs.chataigne.ai/chatbot/types/organization.md): Organization and location-related data models for managing business entities, locations, and integrations
- [Payment Method](https://docs.chataigne.ai/chatbot/types/payment-method.md)
- [Payment Models](https://docs.chataigne.ai/chatbot/types/payments.md): Payment-related data models for managing payment processing, payment methods, and payment status tracking
- [Pricing Models](https://docs.chataigne.ai/chatbot/types/pricing.md): Pricing and discount-related data models for managing prices, discounts, charges, and promotional offers
- [Time Models](https://docs.chataigne.ai/chatbot/types/time.md): Time and schedule-related data models for managing opening hours, schedules, and time-based operations
- [Validation Models](https://docs.chataigne.ai/chatbot/types/validation.md): Order validation and revalidation data models for ensuring order accuracy and handling order changes
- [Event Webhook](https://docs.chataigne.ai/chatbot/webhooks/event-webhook.md): This endpoint is called by the server whenever an event of importance for the chatbot is received.
- [Message Webhook](https://docs.chataigne.ai/chatbot/webhooks/message-webhook.md): This endpoint is called by the server whenever a new message is received in a conversation where the chatbot is activated.
- [Marketing Campaigns Implementation](https://docs.chataigne.ai/features/marketing/whatsapp-marketing-technical.md): Technical documentation for the WhatsApp marketing campaigns feature
- [Campagnes Marketing WhatsApp](https://docs.chataigne.ai/features/marketing/whatsapp-marketing-user.md): Guide complet pour créer et gérer des campagnes marketing WhatsApp
- [Integrations](https://docs.chataigne.ai/integrations/general.md): Overview of all available integrations in the system
- [Welcome](https://docs.chataigne.ai/introduction.md): Welcome to châtaigne's official documentation !
- [Whatsapp flow state machine](https://docs.chataigne.ai/server/whatsapp/whatsapp-flow-state-machine.md)
- [Composants UI](https://docs.chataigne.ai/working-with-the-frontend/composants-ui.md): Guidelines pour l'organisation et le développement des composants UI
- [Custom hooks](https://docs.chataigne.ai/working-with-the-frontend/custom-hooks.md): Création et utilisation des hooks custom pour la logique métier avec TanStack Query et React Hook Form
- [Gestion d'état](https://docs.chataigne.ai/working-with-the-frontend/gestion-etat.md): TypeScript et gestion d'état hybride pour une architecture type-safe
- [Overview](https://docs.chataigne.ai/working-with-the-frontend/overview.md): Vue d'ensemble de l'architecture frontend de Châtaigne
- [Structure du projet](https://docs.chataigne.ai/working-with-the-frontend/structure-du-projet.md): Organisation et architecture du frontend Next.js avec une approche feature-based
- [Validation avec Zod](https://docs.chataigne.ai/working-with-the-frontend/validation-avec-zod.md): Comment utiliser Zod pour valider les formulaires avec React Hook Form
- [Documenting](https://docs.chataigne.ai/working-with-the-server/application-layer/documenting.md): Guidelines for documenting use cases
- [Error Handling](https://docs.chataigne.ai/working-with-the-server/application-layer/error-handling.md): Error handling strategies and best practices
- [Unit Testing](https://docs.chataigne.ai/working-with-the-server/application-layer/unit-testing.md): Guidelines for unit testing use cases
- [Use Cases](https://docs.chataigne.ai/working-with-the-server/application-layer/use-cases.md): Overview of use cases
- [Builders Domaines](https://docs.chataigne.ai/working-with-the-server/domain-layer/builders-domaine.md): Builders Domaines
- [Documentation des entités](https://docs.chataigne.ai/working-with-the-server/domain-layer/documentation-des-entites.md): Documentation des entités du domaine
- [Entités Domaines](https://docs.chataigne.ai/working-with-the-server/domain-layer/entites-domaines.md): Entités de domaines
- [Gestion d'erreur](https://docs.chataigne.ai/working-with-the-server/domain-layer/gestion-erreur.md): Gestion des erreurs dans le Domain Layer
- [Introduction](https://docs.chataigne.ai/working-with-the-server/domain-layer/introduction.md): Introduction au Domain Layer
- [Tests Domaine](https://docs.chataigne.ai/working-with-the-server/domain-layer/tests-domaine.md): Tests des Entités du Domaine
- [Documentation des Adapteurs](https://docs.chataigne.ai/working-with-the-server/infrastructure-layer/adapters/documentation-des-adapteurs.md): Documentation des Adapteurs
- [Introduction](https://docs.chataigne.ai/working-with-the-server/infrastructure-layer/adapters/introduction.md): Introduction aux adapters
- [Prisma Adapters](https://docs.chataigne.ai/working-with-the-server/infrastructure-layer/adapters/prisma-adapters.md): Adapters Prisma
- [Test des Adapteurs](https://docs.chataigne.ai/working-with-the-server/infrastructure-layer/adapters/test-des-adapteurs.md): Test des Adapteurs
- [Repositories](https://docs.chataigne.ai/working-with-the-server/infrastructure-layer/repositories.md): Repositories
- [Designing Interfaces](https://docs.chataigne.ai/working-with-the-server/infrastructure-layer/services/client/designing-interfaces.md): Designing interfaces for external services
- [Documentation des Clients](https://docs.chataigne.ai/working-with-the-server/infrastructure-layer/services/client/documentation-des-clients.md): Documentation des clients dans l'infrastructure
- [Gestion des Erreurs des Clients](https://docs.chataigne.ai/working-with-the-server/infrastructure-layer/services/client/gestion-des-erreurs-des-clients.md): Gestion des erreurs des clients dans l'infrastructure
- [Introduction](https://docs.chataigne.ai/working-with-the-server/infrastructure-layer/services/client/introduction.md): Introduction aux clients
- [Organisation des Clients](https://docs.chataigne.ai/working-with-the-server/infrastructure-layer/services/client/organisation-des-clients.md): Organisation des clients dans l'infrastructure
- [Tests des Clients](https://docs.chataigne.ai/working-with-the-server/infrastructure-layer/services/client/tests-des-clients.md): Tests des clients dans l'infrastructure
- [Création des adapteurs](https://docs.chataigne.ai/working-with-the-server/infrastructure-layer/services/creation-des-adapteurs.md): Création des adapteurs
- [Définition des types externes](https://docs.chataigne.ai/working-with-the-server/infrastructure-layer/services/definition-des-types-externe.md): Définition des types externes
- [Introduction](https://docs.chataigne.ai/working-with-the-server/infrastructure-layer/services/introduction.md): Introduction à la couche des services
- [Logging](https://docs.chataigne.ai/working-with-the-server/logging.md): Configuration et bonnes pratiques pour le logging de l'application
- [Overview](https://docs.chataigne.ai/working-with-the-server/overview.md): Vue d'ensemble de l'architecture de Châtaigne
- [Structure du projet](https://docs.chataigne.ai/working-with-the-server/structure-du-projet.md): Organisation et architecture du projet Châtaigne

## OpenAPI Specs

- [openapi](https://docs.chataigne.ai/openapi.json)