À ce stade :

Schema Prisma
≈ 110 modèles

Architecture Hexagonale NestJS

DDD

CQRS

RBAC

Multi-Tenant

Enterprise Security

Internationalisation

IA

sont désormais définis.

La prochaine étape consiste à construire la :

Source de vérité contractuelle

du système :

openapi.yaml

qui permettra ensuite de générer automatiquement :

Swagger

DTO NestJS

Validation Zod

SDK TypeScript

Client React Query

Mocks

Tests contractuels

Documentation API

Vu la taille du projet :

100+ modèles

1000+ endpoints

nous allons procéder par domaines.

Core & Security

/auth

/users

/roles

/permissions

/sessions

/mfa

/security

Owners

/owners

/owner-documents

/owner-bank-accounts

Properties

/properties

/property-media

/property-features

/property-rates

/property-availability

Customers

/customers

/customer-documents

/customer-notes

Reservations

/reservations

/reservation-guests

/reservation-pricing

/reservation-events

Contracts

/contracts

/contract-templates

/signatures

Finance

/payments

/refunds

/invoices

/accounting

CRM

/leads

/opportunities

/pipelines

/tasks

/activities

Messaging

/notifications

/conversations

/messages

/emails

/sms

Marketing

/campaigns

/segments

/marketing-events

Governance

/audit

/workflows

/feature-flags

OTA

/channels

/distributions

/channel-reservations

/syncs

Revenue

/pricing-rules

/dynamic-prices

/revenue-forecasts

Compliance

/consents

/risks

/incidents

/compliance-audits

Internationalisation

/countries

/currencies

/languages

/translations

IA

/ai/conversations

/ai/messages

/knowledge

/recommendations

Pour démarrer la génération réelle du backend :

OpenAPI Domain 1

doit être produit en premier.

Core Security API

Auth

Users

Roles

Permissions

Sessions

MFA

Premier fichier :

openapi-core-security.yaml

contenant :

• Security Schemes
• JWT
• Refresh Token
• Users API
• Roles API
• Permissions API
• Pagination
• Error Model
• Validation Model

components:

  securitySchemes:

    bearerAuth:

      type: http

      scheme: bearer

      bearerFormat: JWT

GET /users

200:

  description: Users list

  content:

    application/json:

      schema:

        $ref: '#/components/schemas/UserListResponse'

Définir le premier contrat API officiel de la plateforme.

Ce document couvre :

Auth

Users

Roles

Permissions

Sessions

Refresh Tokens

MFA

Pagination

Filtering

Sorting

Error Handling

Compatible :

OpenAPI 3.1

NestJS

Swagger

OpenAPI Generator

Zod

React Query

apps/api/openapi/openapi-core-security.yaml

openapi: 3.1.0

info:
  title: Rental Platform API
  version: 1.0.0
  description: Enterprise Rental Platform

servers:
  - url: https://api.company.com/v1
    description: Production

  - url: https://staging-api.company.com/v1
    description: Staging

tags:
  - name: Authentication
  - name: Users
  - name: Roles
  - name: Permissions
  - name: Sessions
  - name: MFA

components:

  securitySchemes:

    bearerAuth:

      type: http

      scheme: bearer

      bearerFormat: JWT

Uuid:

  type: string

  format: uuid

Timestamp:

  type: string

  format: date-time

PaginationMeta:

  type: object

  properties:

    page:
      type: integer

    pageSize:
      type: integer

    total:
      type: integer

    totalPages:
      type: integer

ApiError:

  type: object

  required:

    - code
    - message

  properties:

    code:
      type: string

    message:
      type: string

    details:
      type: object

ValidationError:

  allOf:

    - $ref: '#/components/schemas/ApiError'

    - type: object

      properties:

        fields:

          type: array

          items:

            type: object

            properties:

              field:
                type: string

              message:
                type: string

RegisterRequest:

  type: object

  required:

    - email
    - password
    - firstName
    - lastName

  properties:

    email:
      type: string
      format: email

    password:
      type: string
      minLength: 8

    firstName:
      type: string

    lastName:
      type: string

LoginRequest:

  type: object

  required:

    - email
    - password

  properties:

    email:
      type: string
      format: email

    password:
      type: string

TokenResponse:

  type: object

  properties:

    accessToken:
      type: string

    refreshToken:
      type: string

    expiresIn:
      type: integer

    tokenType:
      type: string
      example: Bearer

/auth/register:

  post:

    tags:
      - Authentication

    summary: Register user

    requestBody:

      required: true

      content:

        application/json:

          schema:

            $ref: '#/components/schemas/RegisterRequest'

    responses:

      '201':

        description: User created

      '400':

        description: Validation error

/auth/login:

  post:

    tags:
      - Authentication

    summary: Login

    requestBody:

      required: true

      content:

        application/json:

          schema:

            $ref: '#/components/schemas/LoginRequest'

    responses:

      '200':

        description: Authentication success

        content:

          application/json:

            schema:

              $ref: '#/components/schemas/TokenResponse'

/auth/refresh:

  post:

    tags:
      - Authentication

    summary: Refresh token

/auth/logout:

  post:

    security:

      - bearerAuth: []

    tags:

      - Authentication

    summary: Logout

User:

  type: object

  properties:

    id:
      $ref: '#/components/schemas/Uuid'

    email:
      type: string

    firstName:
      type: string

    lastName:
      type: string

    active:
      type: boolean

    createdAt:
      $ref: '#/components/schemas/Timestamp'

UserListResponse:

  type: object

  properties:

    data:

      type: array

      items:

        $ref: '#/components/schemas/User'

    meta:

      $ref: '#/components/schemas/PaginationMeta'

/users:

  get:

    security:

      - bearerAuth: []

    tags:

      - Users

    summary: List users

    parameters:

      - name: page
        in: query
        schema:
          type: integer

      - name: pageSize
        in: query
        schema:
          type: integer

      - name: search
        in: query
        schema:
          type: string

      - name: sort
        in: query
        schema:
          type: string

    responses:

      '200':

        description: User list

        content:

          application/json:

            schema:

              $ref: '#/components/schemas/UserListResponse'

/users/{id}:

  get:

    security:

      - bearerAuth: []

    tags:

      - Users

    parameters:

      - name: id
        in: path
        required: true
        schema:
          format: uuid
          type: string

    responses:

      '200':

        description: User

/users:

  post:

    security:

      - bearerAuth: []

    tags:

      - Users

    summary: Create user

/users/{id}:

  patch:

    security:

      - bearerAuth: []

    tags:

      - Users

/users/{id}:

  delete:

    security:

      - bearerAuth: []

    tags:

      - Users

Role:

  type: object

  properties:

    id:
      type: string

    code:
      type: string

    name:
      type: string

GET    /roles

POST   /roles

GET    /roles/{id}

PATCH  /roles/{id}

DELETE /roles/{id}

Permission:

  type: object

  properties:

    id:
      type: string

    code:
      type: string

    name:
      type: string

GET /permissions

GET /permissions/{id}

POST   /users/{id}/roles

DELETE /users/{id}/roles/{roleId}

Session:

  type: object

  properties:

    id:
      type: string

    ipAddress:
      type: string

    userAgent:
      type: string

    lastActivityAt:
      type: string
      format: date-time

GET /sessions

DELETE /sessions/{id}

POST /mfa/enable

POST /mfa/verify

POST /mfa/disable

200 OK

201 Created

204 No Content

400 Bad Request

401 Unauthorized

403 Forbidden

404 Not Found

409 Conflict

422 Validation Error

429 Too Many Requests

500 Internal Server Error

X-Tenant-Id:
  required: true

X-Correlation-Id:
  required: false

Phase 3-A.1 fournit :

≈ 25 endpoints

≈ 15 schemas

≈ 6 tags

≈ 3 security flows

Définir le premier domaine métier principal de la plateforme :

Owners

Properties

Property Media

Property Features

Property Availability

Property Rates

Ce domaine couvre :

Sprint 3

Catalogue Immobilier

et constitue le socle métier de :

Réservations

Contrats

Paiements

OTA

Revenue Management

tags:

  - name: Owners

  - name: OwnerDocuments

  - name: OwnerBankAccounts

  - name: Properties

  - name: PropertyMedia

  - name: PropertyFeatures

  - name: PropertyAvailability

  - name: PropertyRates

Owner:

  type: object

  properties:

    id:
      type: string
      format: uuid

    ownerNumber:
      type: string

    firstName:
      type: string

    lastName:
      type: string

    email:
      type: string
      format: email

    phone:
      type: string

    active:
      type: boolean

    createdAt:
      type: string
      format: date-time

CreateOwnerRequest:

  type: object

  required:

    - firstName
 
    - lastName
 
    - email

  properties:

    firstName:
      type: string

    lastName:
      type: string

    email:
      type: string
      format: email

    phone:
      type: string

GET    /owners

POST   /owners

GET    /owners/{id}

PATCH  /owners/{id}

DELETE /owners/{id}

GET /owners

?page=1

&pageSize=20

&search=dupont

&active=true

&sort=lastName

GET    /owners/{id}/documents

POST   /owners/{id}/documents

DELETE /owners/{id}/documents/{documentId}

multipart/form-data

IDENTITY

TAX

INSURANCE

MANDATE

CONTRACT

BankAccount:

  type: object

  properties:

    id:
      type: string

    iban:
      type: string

    bic:
      type: string

    accountHolder:
      type: string

GET    /owners/{id}/bank-accounts

POST   /owners/{id}/bank-accounts

PATCH  /owners/{id}/bank-accounts/{accountId}

DELETE /owners/{id}/bank-accounts/{accountId}

Property:

  type: object

  properties:

    id:
      type: string
      format: uuid

    code:
      type: string

    title:
      type: string

    slug:
      type: string

    propertyType:
      type: string

    status:
      type: string

    published:
      type: boolean

    maxGuests:
      type: integer

    bedrooms:
      type: integer

    bathrooms:
      type: integer

    surface:
      type: number

    createdAt:
      type: string
      format: date-time

CreatePropertyRequest:

  type: object

  required:

    - title
 
    - propertyType

  properties:

    title:
      type: string

    description:
      type: string

    propertyType:
      type: string

    maxGuests:
      type: integer

    bedrooms:
      type: integer

    bathrooms:
      type: integer

GET    /properties

POST   /properties

GET    /properties/{id}

PATCH  /properties/{id}

DELETE /properties/{id}

POST /properties/{id}/publish

POST /properties/{id}/unpublish

GET /properties

?search=villa

?propertyType=HOUSE

?published=true

?ownerId=xxx

?page=1

&pageSize=20

GET /properties/{id}/address

PUT /properties/{id}/address

GET /properties/{id}/owners

POST /properties/{id}/owners

DELETE /properties/{id}/owners/{ownerId}

PropertyMedia:

  type: object

  properties:

    id:
      type: string

    fileUrl:
      type: string

    title:
      type: string

    position:
      type: integer

    isCover:
      type: boolean

GET    /properties/{id}/media

POST   /properties/{id}/media

PATCH  /properties/{id}/media/{mediaId}

DELETE /properties/{id}/media/{mediaId}

multipart/form-data

PropertyFeature:

  type: object

  properties:

    id:
      type: string

    code:
      type: string

    label:
      type: string

POOL

WIFI

AIR_CONDITIONING

PARKING

SEA_VIEW

JACUZZI

GET /property-features

GET /properties/{id}/features

POST /properties/{id}/features

DELETE /properties/{id}/features/{featureId}

Availability:

  type: object

  properties:

    id:
      type: string

    startDate:
      type: string
      format: date

    endDate:
      type: string
      format: date

    available:
      type: boolean

GET /properties/{id}/availability

POST /properties/{id}/availability

PATCH /availability/{id}

DELETE /availability/{id}

GET /properties/{id}/availability

?from=2026-07-01

&to=2026-07-31

PropertyRate:

  type: object

  properties:

    id:
      type: string

    startDate:
      type: string
      format: date

    endDate:
      type: string
      format: date

    nightlyRate:
      type: number

    minimumStay:
      type: integer

GET /properties/{id}/rates

POST /properties/{id}/rates

PATCH /property-rates/{id}

DELETE /property-rates/{id}

GET /catalog/properties

destination

checkIn

checkOut

guests

priceMin

priceMax

bedrooms

features

PropertySearchResponse:

  type: object

  properties:

    data:

      type: array

      items:

        $ref: '#/components/schemas/Property'

    meta:

      $ref: '#/components/schemas/PaginationMeta'

owners.read

owners.create

owners.update

owners.delete

properties.read

properties.create

properties.update

properties.publish

properties.delete

Cette phase ajoute :

≈ 42 endpoints

≈ 12 schémas OpenAPI

≈ 8 tags Swagger

Après Phase 3-A.2 :

≈ 67 endpoints

≈ 30 schémas

≈ 14 tags

Définir le cœur transactionnel de la plateforme :

Customers

Reservations

Reservation Guests

Reservation Pricing

Reservation Events

Reservation Status History

Cette phase couvre :

Sprint 4

Réservation & Calendrier

et constitue la base de :

Contrats

Paiements

OTA

Revenue Management

CRM

tags:

  - name: Customers

  - name: CustomerDocuments

  - name: CustomerNotes

  - name: Reservations

  - name: ReservationGuests

  - name: ReservationPricing

  - name: ReservationEvents

  - name: ReservationCalendar

Customer:

  type: object

  properties:

    id:
      type: string
      format: uuid

    customerNumber:
      type: string

    firstName:
      type: string

    lastName:
      type: string

    email:
      type: string
      format: email

    phone:
      type: string

    nationality:
      type: string

    active:
      type: boolean

    createdAt:
      type: string
      format: date-time

CreateCustomerRequest:

  type: object

  required:

    - firstName
 
    - lastName
 
    - email

  properties:

    firstName:
      type: string

    lastName:
      type: string

    email:
      type: string
      format: email

    phone:
      type: string

    nationality:
      type: string

GET    /customers

POST   /customers

GET    /customers/{id}

PATCH  /customers/{id}

DELETE /customers/{id}

GET /customers

?search=smith

?email=test@email.com

?page=1

&pageSize=20

GET    /customers/{id}/documents

POST   /customers/{id}/documents

DELETE /customers/{id}/documents/{documentId}

GET    /customers/{id}/notes

POST   /customers/{id}/notes

PATCH  /customer-notes/{id}

DELETE /customer-notes/{id}

Reservation:

  type: object

  properties:

    id:
      type: string
      format: uuid

    reference:
      type: string

    propertyId:
      type: string
      format: uuid

    customerId:
      type: string
      format: uuid

    status:
      $ref: '#/components/schemas/ReservationStatus'

    checkInDate:
      type: string
      format: date

    checkOutDate:
      type: string
      format: date

    nights:
      type: integer

    adults:
      type: integer

    children:
      type: integer

    totalGuests:
      type: integer

    createdAt:
      type: string
      format: date-time

ReservationStatus:

  type: string

  enum:

    - DRAFT
    - PENDING
    - OPTION
    - CONFIRMED
    - CONTRACT_SENT
    - CONTRACT_SIGNED
    - PARTIALLY_PAID
    - PAID
    - CHECKED_IN
    - CHECKED_OUT
    - COMPLETED
    - CANCELLED
    - REFUNDED

CreateReservationRequest:

  type: object

  required:

    - propertyId
    - checkInDate
    - checkOutDate
    - adults

  properties:

    propertyId:
      type: string
      format: uuid

    customerId:
      type: string
      format: uuid

    checkInDate:
      type: string
      format: date

    checkOutDate:
      type: string
      format: date

    adults:
      type: integer

    children:
      type: integer

    customerNotes:
      type: string

GET    /reservations

POST   /reservations

GET    /reservations/{id}

PATCH  /reservations/{id}

DELETE /reservations/{id}

GET /reservations

?status=CONFIRMED

?propertyId=xxx

?customerId=xxx

?from=2026-07-01

?to=2026-07-31

POST /reservations/{id}/confirm

POST /reservations/{id}/cancel

POST /reservations/{id}/check-in

POST /reservations/{id}/check-out

POST /reservations/check-availability

AvailabilityCheckRequest:

  type: object

  properties:

    propertyId:
      type: string

    checkInDate:
      type: string
      format: date

    checkOutDate:
      type: string
      format: date

AvailabilityCheckResponse:

  type: object

  properties:

    available:
      type: boolean

    conflicts:

      type: array

      items:

        type: string

ReservationGuest:

  type: object

  properties:

    id:
      type: string

    firstName:
      type: string

    lastName:
      type: string

    nationality:
      type: string

    birthDate:
      type: string
      format: date

    isPrimary:
      type: boolean

GET    /reservations/{id}/guests

POST   /reservations/{id}/guests

PATCH  /reservation-guests/{id}

DELETE /reservation-guests/{id}

ReservationPricing:

  type: object

  properties:

    nightlyAmount:
      type: number

    cleaningFee:
      type: number

    touristTax:
      type: number

    extrasAmount:
      type: number

    discountAmount:
      type: number

    totalAmount:
      type: number

    currencyCode:
      type: string

GET /reservations/{id}/pricing

POST /reservations/{id}/pricing/recalculate

ReservationEvent:

  type: object

  properties:

    id:
      type: string

    eventType:
      type: string

    payload:
      type: object

    createdAt:
      type: string
      format: date-time

GET /reservations/{id}/events

GET /reservations/{id}/history

ReservationStatusHistory:

  type: object

  properties:

    previousStatus:
      type: string

    newStatus:
      type: string

    changedAt:
      type: string
      format: date-time

    changedBy:
      type: string

GET /properties/{id}/calendar

from

to

CalendarDay:

  type: object

  properties:

    date:
      type: string

    available:
      type: boolean

    reservationId:
      type: string

GET /catalog/search

destination

checkInDate

checkOutDate

adults

children

priceMin

priceMax

features

CatalogSearchResponse:

  type: object

  properties:

    properties:
      type: array

    total:
      type: integer

customers.read

customers.create

customers.update

customers.delete

reservations.read

reservations.create

reservations.update

reservations.cancel

reservations.checkin

reservations.checkout

Cette phase ajoute :

≈ 52 endpoints

≈ 18 schémas

≈ 8 tags Swagger

Après Phase 3-A.3 :

≈ 120 endpoints

≈ 48 schémas

≈ 22 tags

Définir le domaine financier et contractuel de la plateforme.

Cette phase couvre :

Sprint 5

Contrats & Signature Électronique

Sprint 6

Paiements & Facturation

Elle permet :

Réservation

↓

Contrat

↓

Signature

↓

Paiement

↓

Facture

↓

Comptabilité

tags:

  - name: Contracts

  - name: ContractTemplates

  - name: ContractSignatures

  - name: Payments

  - name: Refunds

  - name: Invoices

  - name: Accounting

Contract:

  type: object

  properties:

    id:
      type: string
      format: uuid

    contractNumber:
      type: string

    reservationId:
      type: string
      format: uuid

    status:
      $ref: '#/components/schemas/ContractStatus'

    generatedAt:
      type: string
      format: date-time

    signedAt:
      type: string
      format: date-time

    pdfUrl:
      type: string

ContractStatus:

  type: string

  enum:

    - DRAFT
    - GENERATED
    - SENT
    - VIEWED
    - SIGNED
    - CANCELLED

GET    /contracts

POST   /contracts

GET    /contracts/{id}

PATCH  /contracts/{id}

DELETE /contracts/{id}

GET /reservations/{id}/contracts

POST /contracts/generate

GenerateContractRequest:

  type: object

  required:

    - reservationId
    - templateId

  properties:

    reservationId:
      type: string

    templateId:
      type: string

GenerateContractResponse:

  type: object

  properties:

    contractId:
      type: string

    pdfUrl:
      type: string

GET /contracts/{id}/pdf

POST /contracts/{id}/regenerate

ContractTemplate:

  type: object

  properties:

    id:
      type: string

    code:
      type: string

    name:
      type: string

    active:
      type: boolean

GET    /contract-templates

POST   /contract-templates

GET    /contract-templates/{id}

PATCH  /contract-templates/{id}

DELETE /contract-templates/{id}

ContractSignature:

  type: object

  properties:

    id:
      type: string

    signerName:
      type: string

    signerEmail:
      type: string

    signedAt:
      type: string
      format: date-time

    status:
      type: string

POST /contracts/{id}/send-signature

GET /contracts/{id}/signatures

POST /contracts/{id}/remind-signature

POST /contracts/{id}/cancel-signature

Payment:

  type: object

  properties:

    id:
      type: string
      format: uuid

    paymentReference:
      type: string

    reservationId:
      type: string

    amount:
      type: number

    currencyCode:
      type: string

    status:
      $ref: '#/components/schemas/PaymentStatus'

    paidAt:
      type: string
      format: date-time

PaymentStatus:

  type: string

  enum:

    - PENDING
    - AUTHORIZED
    - PAID
    - FAILED
    - CANCELLED
    - REFUNDED

GET /payments

POST /payments

GET /payments/{id}

PATCH /payments/{id}

GET /reservations/{id}/payments

POST /payments/checkout-session

CheckoutSessionRequest:

  type: object

  properties:

    reservationId:
      type: string

    amount:
      type: number

CheckoutSessionResponse:

  type: object

  properties:

    sessionId:
      type: string

    checkoutUrl:
      type: string

POST /payments/webhooks/stripe

POST /payments/webhooks/paypal

GET /payments/{id}/transactions

Refund:

  type: object

  properties:

    id:
      type: string

    amount:
      type: number

    refundedAt:
      type: string
      format: date-time

    reason:
      type: string

GET /refunds

POST /refunds

GET /refunds/{id}

POST /payments/{id}/refund

Invoice:

  type: object

  properties:

    id:
      type: string

    invoiceNumber:
      type: string

    amountExclTax:
      type: number

    taxAmount:
      type: number

    amountInclTax:
      type: number

    status:
      $ref: '#/components/schemas/InvoiceStatus'

    issueDate:
      type: string
      format: date

InvoiceStatus:

  type: string

  enum:

    - DRAFT
    - ISSUED
    - PAID
    - PARTIALLY_PAID
    - CANCELLED

GET    /invoices

POST   /invoices

GET    /invoices/{id}

PATCH  /invoices/{id}

GET /reservations/{id}/invoices

GET /invoices/{id}/pdf

POST /invoices/{id}/send

AccountingEntry:

  type: object

  properties:

    id:
      type: string

    entryDate:
      type: string
      format: date

    accountCode:
      type: string

    label:
      type: string

    debit:
      type: number

    credit:
      type: number

GET /accounting/entries

GET /accounting/entries/{id}

GET /accounting/export

from

to

format

CSV

XLSX

FEC

Reservation

↓

Generate Contract

↓

Send Signature

↓

Signed

Reservation

↓

Checkout Session

↓

Payment

↓

Invoice

Payment

↓

Refund

↓

Accounting Entry

contracts.read

contracts.create

contracts.update

contracts.send

contracts.sign

payments.read

payments.create

payments.refund

invoices.read

invoices.create

invoices.send

Cette phase ajoute :

≈ 65 endpoints

≈ 22 schémas

≈ 7 tags Swagger

Après Phase 3-A.4 :

≈ 185 endpoints

≈ 70 schémas

≈ 29 tags

Mettre en place le CRM intégré de la plateforme.

Cette phase couvre :

Sprint 8

CRM & Relation Client

Le CRM est directement connecté aux :

Customers

Reservations

Contracts

Payments

Marketing

Automation

afin de disposer d'une vision 360° du client.

tags:

  - name: Leads

  - name: LeadSources

  - name: Pipelines

  - name: PipelineStages

  - name: Opportunities

  - name: Activities

  - name: Tasks

  - name: CustomerNotes

  - name: Tags

  - name: Segments

Lead:

  type: object

  properties:

    id:
      type: string
      format: uuid

    leadNumber:
      type: string

    firstName:
      type: string

    lastName:
      type: string

    email:
      type: string

    phone:
      type: string

    source:
      type: string

    score:
      type: integer

    status:
      $ref: '#/components/schemas/LeadStatus'

    assignedUserId:
      type: string

    createdAt:
      type: string
      format: date-time

LeadStatus:

  type: string

  enum:

    - NEW
 
    - QUALIFIED
 
    - CONTACTED
 
    - PROPOSAL_SENT
 
    - NEGOTIATION
 
    - WON
 
    - LOST

GET    /leads

POST   /leads

GET    /leads/{id}

PATCH  /leads/{id}

DELETE /leads/{id}

GET /leads

?status=NEW

?assignedUserId=xxx

?source=WEBSITE

?scoreMin=50

LeadSource:

  type: object

  properties:

    id:
      type: string

    code:
      type: string

    name:
      type: string

    active:
      type: boolean

GET    /lead-sources

POST   /lead-sources

PATCH  /lead-sources/{id}

DELETE /lead-sources/{id}

WEBSITE

GOOGLE

FACEBOOK

INSTAGRAM

BOOKING

AIRBNB

REFERRAL

PHONE

Pipeline:

  type: object

  properties:

    id:
      type: string
      format: uuid

    code:
      type: string

    name:
      type: string

    active:
      type: boolean

    createdAt:
      type: string
      format: date-time

GET    /pipelines

POST   /pipelines

GET    /pipelines/{id}

PATCH  /pipelines/{id}

DELETE /pipelines/{id}

PipelineStage:

  type: object

  properties:

    id:
      type: string

    pipelineId:
      type: string

    code:
      type: string

    name:
      type: string

    position:
      type: integer

    probability:
      type: integer

NEW

QUALIFICATION

CONTACT

VISIT

PROPOSAL

NEGOTIATION

WON

LOST

GET    /pipelines/{id}/stages

POST   /pipelines/{id}/stages

PATCH  /pipeline-stages/{id}

DELETE /pipeline-stages/{id}

Opportunity:

  type: object

  properties:

    id:
      type: string
      format: uuid

    leadId:
      type: string

    pipelineId:
      type: string

    stageId:
      type: string

    title:
      type: string

    estimatedValue:
      type: number

    probability:
      type: integer

    expectedCloseDate:
      type: string
      format: date

    status:
      $ref: '#/components/schemas/OpportunityStatus'

OpportunityStatus:

  type: string

  enum:

    - OPEN
 
    - WON
 
    - LOST
 
    - CANCELLED

GET    /opportunities

POST   /opportunities

GET    /opportunities/{id}

PATCH  /opportunities/{id}

DELETE /opportunities/{id}

POST /opportunities/{id}/move

MoveOpportunityRequest:

  type: object

  properties:

    stageId:
      type: string

Activity:

  type: object

  properties:

    id:
      type: string

    activityType:
      type: string

    subject:
      type: string

    description:
      type: string

    dueDate:
      type: string
      format: date-time

    completed:
      type: boolean

CALL

EMAIL

VISIT

MEETING

VIDEO_CALL

FOLLOW_UP

GET    /activities

POST   /activities

GET    /activities/{id}

PATCH  /activities/{id}

DELETE /activities/{id}

POST /activities/{id}/assign

Task:

  type: object

  properties:

    id:
      type: string

    title:
      type: string

    description:
      type: string

    priority:
      $ref: '#/components/schemas/TaskPriority'

    status:
      $ref: '#/components/schemas/TaskStatus'

    dueDate:
      type: string
      format: date-time

    assignedUserId:
      type: string

TaskPriority:

  type: string

  enum:

    - LOW
 
    - MEDIUM
 
    - HIGH
 
    - URGENT

TaskStatus:

  type: string

  enum:

    - TODO
 
    - IN_PROGRESS
 
    - DONE
 
    - CANCELLED

GET    /tasks

POST   /tasks

GET    /tasks/{id}

PATCH  /tasks/{id}

DELETE /tasks/{id}

Create Task

↓

Assign User

↓

Execute

↓

Done

CustomerNote:

  type: object

  properties:

    id:
      type: string

    customerId:
      type: string

    content:
      type: string

    visibility:
      type: string

    createdAt:
      type: string
      format: date-time

PRIVATE

TEAM

PUBLIC

GET    /customers/{id}/notes

POST   /customers/{id}/notes

PATCH  /customer-notes/{id}

DELETE /customer-notes/{id}

Tag:

  type: object

  properties:

    id:
      type: string

    code:
      type: string

    label:
      type: string

    color:
      type: string

GET    /tags

POST   /tags

PATCH  /tags/{id}

DELETE /tags/{id}

VIP

HOT_LEAD

OWNER

RETURNING_CUSTOMER

HIGH_VALUE

Segment:

  type: object

  properties:

    id:
      type: string

    code:
      type: string

    name:
      type: string

    rules:
      type: object

    active:
      type: boolean

GET    /segments

POST   /segments

GET    /segments/{id}

PATCH  /segments/{id}

DELETE /segments/{id}

CLIENTS_FIDELES

CLIENTS_INACTIFS

PROPRIETAIRES_ACTIFS

PROSPECTS_CHAUDS

ANNIVERSAIRES

Leads créés

Leads qualifiés

Opportunités ouvertes

CA potentiel

Tâches ouvertes

Activités réalisées

Taux de conversion

GET /crm/dashboard

POST /leads/{id}/convert

Lead

↓

Customer

↓

Opportunity

↓

Reservation

POST /leads/{id}/auto-assign

POST /leads/{id}/calculate-score

POST /tasks/{id}/remind

leads.read

leads.create

leads.update

leads.delete

leads.convert

crm.read

crm.manage

crm.assign

crm.export

tasks.read

tasks.create

tasks.update

tasks.complete

Cette phase ajoute :

≈ 72 endpoints

≈ 25 schémas

≈ 10 tags Swagger

Après Phase 3-A.5 :

≈ 257 endpoints

≈ 95 schémas

≈ 39 tags

OpenAPI Messaging & Notifications

Conversations

Messages

Notifications

Emails

SMS

Templates

Campaigns

Cette phase couvrira :

Sprint 9

Messagerie & Notifications

et ajoutera environ :

80 endpoints supplémentaires