@factpulse/sdk 2.0.9 → 2.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +22 -10
- package/CHANGELOG.md +3 -3
- package/README.md +118 -75
- package/api/sant-api.ts +61 -0
- package/dist/api/sant-api.d.ts +28 -0
- package/dist/api/sant-api.js +59 -0
- package/dist/esm/api/sant-api.d.ts +28 -0
- package/dist/esm/api/sant-api.js +59 -0
- package/dist/esm/models/{facture-enrichie-info-output.d.ts → facture-enrichie-info.d.ts} +1 -1
- package/dist/esm/models/index.d.ts +11 -5
- package/dist/esm/models/index.js +11 -5
- package/dist/esm/models/ligne-de-poste-montant-remise-ht.d.ts +16 -0
- package/dist/esm/models/ligne-de-poste-taux-tva-manuel.d.ts +16 -0
- package/dist/esm/models/ligne-de-poste.d.ts +6 -12
- package/dist/esm/models/ligne-de-tva.d.ts +6 -12
- package/dist/esm/models/{montant-ht-total1.d.ts → montant-apayer.d.ts} +2 -2
- package/dist/esm/models/montant-base-ht.d.ts +16 -0
- package/dist/esm/models/montant-ht-total.d.ts +3 -0
- package/dist/esm/models/montant-remise-globale-ttc.d.ts +16 -0
- package/dist/esm/models/montant-remise-globale-ttc.js +14 -0
- package/dist/esm/models/{montant-tva1.d.ts → montant-total-acompte.d.ts} +2 -2
- package/dist/esm/models/montant-total-acompte.js +14 -0
- package/dist/esm/models/montant-total-ligne-ht.d.ts +16 -0
- package/dist/esm/models/montant-total-ligne-ht.js +14 -0
- package/dist/esm/models/montant-total.d.ts +12 -24
- package/dist/esm/models/montant-ttc-total.d.ts +3 -0
- package/dist/esm/models/montant-tva-ligne.d.ts +16 -0
- package/dist/esm/models/montant-tva-ligne.js +14 -0
- package/dist/esm/models/montant-tva-total.d.ts +16 -0
- package/dist/esm/models/montant-tva-total.js +14 -0
- package/dist/esm/models/montant-tva.d.ts +3 -0
- package/dist/esm/models/soumettre-facture-complete-response.d.ts +2 -2
- package/dist/esm/models/soumettre-facture-request.d.ts +6 -6
- package/dist/esm/models/tauxmanuel.d.ts +16 -0
- package/dist/esm/models/tauxmanuel.js +14 -0
- package/dist/models/{facture-enrichie-info-output.d.ts → facture-enrichie-info.d.ts} +1 -1
- package/dist/models/index.d.ts +11 -5
- package/dist/models/index.js +11 -5
- package/dist/models/ligne-de-poste-montant-remise-ht.d.ts +16 -0
- package/dist/models/ligne-de-poste-taux-tva-manuel.d.ts +16 -0
- package/dist/models/ligne-de-poste.d.ts +6 -12
- package/dist/models/ligne-de-tva.d.ts +6 -12
- package/dist/{esm/models/montant-ttc-total1.d.ts → models/montant-apayer.d.ts} +2 -2
- package/dist/models/montant-base-ht.d.ts +16 -0
- package/dist/models/montant-ht-total.d.ts +3 -0
- package/dist/models/montant-remise-globale-ttc.d.ts +16 -0
- package/dist/models/montant-remise-globale-ttc.js +15 -0
- package/dist/models/{montant-ht-total1.d.ts → montant-total-acompte.d.ts} +2 -2
- package/dist/models/montant-total-acompte.js +15 -0
- package/dist/models/montant-total-ligne-ht.d.ts +16 -0
- package/dist/models/montant-total-ligne-ht.js +15 -0
- package/dist/models/montant-total.d.ts +12 -24
- package/dist/models/montant-ttc-total.d.ts +3 -0
- package/dist/models/montant-tva-ligne.d.ts +16 -0
- package/dist/models/montant-tva-ligne.js +15 -0
- package/dist/models/montant-tva-total.d.ts +16 -0
- package/dist/models/montant-tva-total.js +15 -0
- package/dist/models/montant-tva.d.ts +3 -0
- package/dist/models/soumettre-facture-complete-response.d.ts +2 -2
- package/dist/models/soumettre-facture-request.d.ts +6 -6
- package/dist/models/tauxmanuel.d.ts +16 -0
- package/dist/models/tauxmanuel.js +15 -0
- package/docs/{FactureEnrichieInfoOutput.md → FactureEnrichieInfo.md} +3 -3
- package/docs/LigneDePoste.md +3 -3
- package/docs/LigneDePosteMontantRemiseHt.md +19 -0
- package/docs/LigneDePosteTauxTvaManuel.md +19 -0
- package/docs/LigneDeTVA.md +3 -3
- package/docs/{MontantHtTotal1.md → MontantAPayer.md} +4 -4
- package/docs/MontantBaseHt.md +19 -0
- package/docs/MontantHtTotal.md +1 -0
- package/docs/MontantRemiseGlobaleTtc.md +19 -0
- package/docs/MontantTotal.md +6 -6
- package/docs/MontantTotalAcompte.md +19 -0
- package/docs/MontantTotalLigneHt.md +19 -0
- package/docs/MontantTtcTotal.md +1 -0
- package/docs/MontantTva.md +1 -0
- package/docs/MontantTvaLigne.md +19 -0
- package/docs/{MontantTva1.md → MontantTvaTotal.md} +4 -4
- package/docs/SantApi.md +45 -0
- package/docs/SoumettreFactureCompleteResponse.md +1 -1
- package/docs/SoumettreFactureRequest.md +3 -3
- package/docs/{MontantTtcTotal1.md → Tauxmanuel.md} +4 -4
- package/models/{facture-enrichie-info-output.ts → facture-enrichie-info.ts} +1 -1
- package/models/index.ts +11 -5
- package/models/ligne-de-poste-montant-remise-ht.ts +22 -0
- package/models/ligne-de-poste-taux-tva-manuel.ts +22 -0
- package/models/ligne-de-poste.ts +12 -12
- package/models/ligne-de-tva.ts +12 -12
- package/models/{montant-ht-total1.ts → montant-apayer.ts} +2 -2
- package/models/montant-base-ht.ts +22 -0
- package/models/montant-ht-total.ts +3 -0
- package/models/montant-remise-globale-ttc.ts +22 -0
- package/models/{montant-ttc-total1.ts → montant-total-acompte.ts} +2 -2
- package/models/montant-total-ligne-ht.ts +22 -0
- package/models/montant-total.ts +24 -24
- package/models/montant-ttc-total.ts +3 -0
- package/models/montant-tva-ligne.ts +22 -0
- package/models/{montant-tva1.ts → montant-tva-total.ts} +2 -2
- package/models/montant-tva.ts +3 -0
- package/models/soumettre-facture-complete-response.ts +2 -2
- package/models/soumettre-facture-request.ts +6 -6
- package/models/tauxmanuel.ts +22 -0
- package/package.json +1 -1
- package/dist/esm/models/facture-enrichie-info-input.d.ts +0 -27
- package/dist/models/facture-enrichie-info-input.d.ts +0 -27
- package/dist/models/montant-ttc-total1.d.ts +0 -16
- package/dist/models/montant-tva1.d.ts +0 -16
- package/docs/FactureEnrichieInfoInput.md +0 -35
- package/models/facture-enrichie-info-input.ts +0 -39
- /package/dist/esm/models/{facture-enrichie-info-input.js → facture-enrichie-info.js} +0 -0
- /package/dist/esm/models/{facture-enrichie-info-output.js → ligne-de-poste-montant-remise-ht.js} +0 -0
- /package/dist/esm/models/{montant-ht-total1.js → ligne-de-poste-taux-tva-manuel.js} +0 -0
- /package/dist/esm/models/{montant-ttc-total1.js → montant-apayer.js} +0 -0
- /package/dist/esm/models/{montant-tva1.js → montant-base-ht.js} +0 -0
- /package/dist/models/{facture-enrichie-info-input.js → facture-enrichie-info.js} +0 -0
- /package/dist/models/{facture-enrichie-info-output.js → ligne-de-poste-montant-remise-ht.js} +0 -0
- /package/dist/models/{montant-ht-total1.js → ligne-de-poste-taux-tva-manuel.js} +0 -0
- /package/dist/models/{montant-ttc-total1.js → montant-apayer.js} +0 -0
- /package/dist/models/{montant-tva1.js → montant-base-ht.js} +0 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -47,8 +47,7 @@ docs/Destination.md
|
|
|
47
47
|
docs/DestinationAFNOR.md
|
|
48
48
|
docs/DestinationChorusPro.md
|
|
49
49
|
docs/DonneesFactureSimplifiees.md
|
|
50
|
-
docs/
|
|
51
|
-
docs/FactureEnrichieInfoOutput.md
|
|
50
|
+
docs/FactureEnrichieInfo.md
|
|
52
51
|
docs/FactureFacturX.md
|
|
53
52
|
docs/FormatSortie.md
|
|
54
53
|
docs/Fournisseur.md
|
|
@@ -57,16 +56,22 @@ docs/GenerateCertificateResponse.md
|
|
|
57
56
|
docs/HTTPValidationError.md
|
|
58
57
|
docs/InformationSignatureAPI.md
|
|
59
58
|
docs/LigneDePoste.md
|
|
59
|
+
docs/LigneDePosteMontantRemiseHt.md
|
|
60
|
+
docs/LigneDePosteTauxTvaManuel.md
|
|
60
61
|
docs/LigneDeTVA.md
|
|
61
62
|
docs/ModeDepot.md
|
|
62
63
|
docs/ModePaiement.md
|
|
64
|
+
docs/MontantAPayer.md
|
|
65
|
+
docs/MontantBaseHt.md
|
|
63
66
|
docs/MontantHtTotal.md
|
|
64
|
-
docs/
|
|
67
|
+
docs/MontantRemiseGlobaleTtc.md
|
|
65
68
|
docs/MontantTotal.md
|
|
69
|
+
docs/MontantTotalAcompte.md
|
|
70
|
+
docs/MontantTotalLigneHt.md
|
|
66
71
|
docs/MontantTtcTotal.md
|
|
67
|
-
docs/MontantTtcTotal1.md
|
|
68
72
|
docs/MontantTva.md
|
|
69
|
-
docs/
|
|
73
|
+
docs/MontantTvaLigne.md
|
|
74
|
+
docs/MontantTvaTotal.md
|
|
70
75
|
docs/MontantUnitaireHt.md
|
|
71
76
|
docs/Note.md
|
|
72
77
|
docs/ObtenirIdChorusProRequest.md
|
|
@@ -101,6 +106,7 @@ docs/StatutCelery.md
|
|
|
101
106
|
docs/StatutFacture.md
|
|
102
107
|
docs/StatutTache.md
|
|
103
108
|
docs/StructureInfo.md
|
|
109
|
+
docs/Tauxmanuel.md
|
|
104
110
|
docs/TraitementFactureApi.md
|
|
105
111
|
docs/TypeFacture.md
|
|
106
112
|
docs/TypeTVA.md
|
|
@@ -141,8 +147,7 @@ models/destination-afnor.ts
|
|
|
141
147
|
models/destination-chorus-pro.ts
|
|
142
148
|
models/destination.ts
|
|
143
149
|
models/donnees-facture-simplifiees.ts
|
|
144
|
-
models/facture-enrichie-info
|
|
145
|
-
models/facture-enrichie-info-output.ts
|
|
150
|
+
models/facture-enrichie-info.ts
|
|
146
151
|
models/facture-factur-x.ts
|
|
147
152
|
models/format-sortie.ts
|
|
148
153
|
models/fournisseur.ts
|
|
@@ -151,17 +156,23 @@ models/generate-certificate-response.ts
|
|
|
151
156
|
models/httpvalidation-error.ts
|
|
152
157
|
models/index.ts
|
|
153
158
|
models/information-signature-api.ts
|
|
159
|
+
models/ligne-de-poste-montant-remise-ht.ts
|
|
160
|
+
models/ligne-de-poste-taux-tva-manuel.ts
|
|
154
161
|
models/ligne-de-poste.ts
|
|
155
162
|
models/ligne-de-tva.ts
|
|
156
163
|
models/mode-depot.ts
|
|
157
164
|
models/mode-paiement.ts
|
|
165
|
+
models/montant-apayer.ts
|
|
166
|
+
models/montant-base-ht.ts
|
|
158
167
|
models/montant-ht-total.ts
|
|
159
|
-
models/montant-
|
|
168
|
+
models/montant-remise-globale-ttc.ts
|
|
169
|
+
models/montant-total-acompte.ts
|
|
170
|
+
models/montant-total-ligne-ht.ts
|
|
160
171
|
models/montant-total.ts
|
|
161
172
|
models/montant-ttc-total.ts
|
|
162
|
-
models/montant-
|
|
173
|
+
models/montant-tva-ligne.ts
|
|
174
|
+
models/montant-tva-total.ts
|
|
163
175
|
models/montant-tva.ts
|
|
164
|
-
models/montant-tva1.ts
|
|
165
176
|
models/montant-unitaire-ht.ts
|
|
166
177
|
models/note.ts
|
|
167
178
|
models/obtenir-id-chorus-pro-request.ts
|
|
@@ -195,6 +206,7 @@ models/statut-celery.ts
|
|
|
195
206
|
models/statut-facture.ts
|
|
196
207
|
models/statut-tache.ts
|
|
197
208
|
models/structure-info.ts
|
|
209
|
+
models/tauxmanuel.ts
|
|
198
210
|
models/type-facture.ts
|
|
199
211
|
models/type-tva.ts
|
|
200
212
|
models/unite.ts
|
package/CHANGELOG.md
CHANGED
|
@@ -7,7 +7,7 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
-
## [2.0.
|
|
10
|
+
## [2.0.11] - 2025-11-26
|
|
11
11
|
|
|
12
12
|
### Added
|
|
13
13
|
- Version initiale du SDK typescript
|
|
@@ -24,5 +24,5 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
|
|
|
24
24
|
- Guide d'authentification JWT
|
|
25
25
|
- Configuration avancée (timeout, proxy, debug)
|
|
26
26
|
|
|
27
|
-
[Unreleased]: https://github.com/factpulse/sdk-typescript/compare/v2.0.
|
|
28
|
-
[2.0.
|
|
27
|
+
[Unreleased]: https://github.com/factpulse/sdk-typescript/compare/v2.0.11...HEAD
|
|
28
|
+
[2.0.11]: https://github.com/factpulse/sdk-typescript/releases/tag/v2.0.11
|
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@ Client TypeScript/JavaScript officiel pour l'API FactPulse - Facturation électr
|
|
|
8
8
|
- **Chorus Pro** : Intégration avec la plateforme de facturation publique française
|
|
9
9
|
- **AFNOR PDP/PA** : Soumission de flux conformes à la norme XP Z12-013
|
|
10
10
|
- **Signature électronique** : Signature PDF (PAdES-B-B, PAdES-B-T, PAdES-B-LT)
|
|
11
|
-
- **
|
|
11
|
+
- **Client simplifié** : Authentification JWT et polling intégrés via `helpers`
|
|
12
12
|
- **TypeScript** : Support complet avec types générés automatiquement
|
|
13
13
|
|
|
14
14
|
## 🚀 Installation
|
|
@@ -21,121 +21,164 @@ yarn add @factpulse/sdk
|
|
|
21
21
|
|
|
22
22
|
## 📖 Démarrage rapide
|
|
23
23
|
|
|
24
|
-
###
|
|
24
|
+
### Méthode recommandée : Client simplifié avec helpers
|
|
25
|
+
|
|
26
|
+
Le module `helpers` offre une API simplifiée avec authentification et polling automatiques :
|
|
25
27
|
|
|
26
28
|
```typescript
|
|
27
|
-
import {
|
|
29
|
+
import { FactPulseClient } from '@factpulse/sdk/helpers';
|
|
30
|
+
import * as fs from 'fs';
|
|
28
31
|
|
|
29
|
-
//
|
|
30
|
-
const
|
|
31
|
-
|
|
32
|
-
|
|
32
|
+
// Créer le client (authentification automatique)
|
|
33
|
+
const client = new FactPulseClient({
|
|
34
|
+
email: 'votre_email@example.com',
|
|
35
|
+
password: 'votre_mot_de_passe'
|
|
33
36
|
});
|
|
34
37
|
|
|
35
|
-
const api = new TraitementFactureApi(config);
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
### 2. Générer une facture Factur-X
|
|
39
|
-
|
|
40
|
-
```typescript
|
|
41
38
|
// Données de la facture
|
|
42
39
|
const factureData = {
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
montantTotalHt: "1000.00",
|
|
46
|
-
montantTotalTtc: "1200.00",
|
|
40
|
+
numero_facture: 'FAC-2025-001',
|
|
41
|
+
date_facture: '2025-01-15',
|
|
47
42
|
fournisseur: {
|
|
48
|
-
nom:
|
|
49
|
-
siret:
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
43
|
+
nom: 'Mon Entreprise SAS',
|
|
44
|
+
siret: '12345678901234',
|
|
45
|
+
adresse_postale: {
|
|
46
|
+
ligne_un: '123 Rue Example',
|
|
47
|
+
code_postal: '75001',
|
|
48
|
+
nom_ville: 'Paris',
|
|
49
|
+
pays_code_iso: 'FR'
|
|
55
50
|
}
|
|
56
51
|
},
|
|
57
52
|
destinataire: {
|
|
58
|
-
nom:
|
|
59
|
-
siret:
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
53
|
+
nom: 'Client SARL',
|
|
54
|
+
siret: '98765432109876',
|
|
55
|
+
adresse_postale: {
|
|
56
|
+
ligne_un: '456 Avenue Test',
|
|
57
|
+
code_postal: '69001',
|
|
58
|
+
nom_ville: 'Lyon',
|
|
59
|
+
pays_code_iso: 'FR'
|
|
65
60
|
}
|
|
66
61
|
},
|
|
67
|
-
|
|
62
|
+
montant_total: {
|
|
63
|
+
montant_ht_total: '1000.00',
|
|
64
|
+
montant_tva: '200.00',
|
|
65
|
+
montant_ttc_total: '1200.00',
|
|
66
|
+
montant_a_payer: '1200.00'
|
|
67
|
+
},
|
|
68
|
+
lignes_de_poste: [{
|
|
68
69
|
numero: 1,
|
|
69
|
-
denomination:
|
|
70
|
-
quantite:
|
|
71
|
-
|
|
72
|
-
|
|
70
|
+
denomination: 'Prestation de conseil',
|
|
71
|
+
quantite: '10.00',
|
|
72
|
+
unite: 'PIECE',
|
|
73
|
+
montant_unitaire_ht: '100.00'
|
|
73
74
|
}]
|
|
74
75
|
};
|
|
75
76
|
|
|
76
|
-
//
|
|
77
|
-
const
|
|
78
|
-
JSON.stringify(factureData),
|
|
79
|
-
'EN16931',
|
|
80
|
-
'pdf'
|
|
81
|
-
);
|
|
82
|
-
|
|
83
|
-
// Sauvegarder le fichier
|
|
84
|
-
const fs = require('fs');
|
|
85
|
-
fs.writeFileSync('facture.pdf', Buffer.from(response.data));
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
### 3. Soumettre une facture complète (Chorus Pro / AFNOR PDP)
|
|
77
|
+
// Lire le PDF source
|
|
78
|
+
const pdfSource = fs.readFileSync('facture_source.pdf');
|
|
89
79
|
|
|
90
|
-
|
|
91
|
-
const
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
}
|
|
99
|
-
}
|
|
100
|
-
});
|
|
80
|
+
// Générer le PDF Factur-X (polling automatique)
|
|
81
|
+
const pdfBytes = await client.genererFacturx(
|
|
82
|
+
factureData,
|
|
83
|
+
pdfSource,
|
|
84
|
+
'EN16931', // profil
|
|
85
|
+
'pdf', // format
|
|
86
|
+
true // sync (attend le résultat)
|
|
87
|
+
);
|
|
101
88
|
|
|
102
|
-
|
|
89
|
+
// Sauvegarder
|
|
90
|
+
fs.writeFileSync('facture_facturx.pdf', pdfBytes);
|
|
103
91
|
```
|
|
104
92
|
|
|
105
|
-
|
|
93
|
+
### Méthode alternative : SDK brut
|
|
106
94
|
|
|
107
|
-
|
|
95
|
+
Pour un contrôle total, utilisez le SDK généré directement :
|
|
108
96
|
|
|
109
97
|
```typescript
|
|
98
|
+
import { Configuration, TraitementFactureApi } from '@factpulse/sdk';
|
|
110
99
|
import axios from 'axios';
|
|
111
100
|
|
|
112
|
-
|
|
101
|
+
// 1. Obtenir le token JWT
|
|
102
|
+
const tokenResponse = await axios.post('https://factpulse.fr/api/token/', {
|
|
113
103
|
username: 'votre_email@example.com',
|
|
114
104
|
password: 'votre_mot_de_passe'
|
|
115
105
|
});
|
|
106
|
+
const token = tokenResponse.data.access;
|
|
107
|
+
|
|
108
|
+
// 2. Configurer le client
|
|
109
|
+
const config = new Configuration({
|
|
110
|
+
basePath: 'https://factpulse.fr/api/facturation',
|
|
111
|
+
accessToken: token
|
|
112
|
+
});
|
|
113
|
+
|
|
114
|
+
// 3. Appeler l'API
|
|
115
|
+
const api = new TraitementFactureApi(config);
|
|
116
|
+
const response = await api.genererFactureApiV1TraitementGenererFacturePost(
|
|
117
|
+
JSON.stringify(factureData),
|
|
118
|
+
'EN16931',
|
|
119
|
+
'pdf',
|
|
120
|
+
new Blob([pdfSource])
|
|
121
|
+
);
|
|
116
122
|
|
|
117
|
-
|
|
123
|
+
// 4. Polling manuel pour récupérer le résultat
|
|
124
|
+
const taskId = response.data.id_tache;
|
|
125
|
+
// ... (implémenter le polling)
|
|
118
126
|
```
|
|
119
127
|
|
|
120
|
-
|
|
128
|
+
## 🔧 Avantages des helpers
|
|
129
|
+
|
|
130
|
+
| Fonctionnalité | SDK brut | helpers |
|
|
131
|
+
|----------------|----------|---------|
|
|
132
|
+
| Authentification | Manuelle | Automatique |
|
|
133
|
+
| Refresh token | Manuel | Automatique |
|
|
134
|
+
| Polling tâches async | Manuel | Automatique (backoff) |
|
|
135
|
+
| Retry sur 401 | Manuel | Automatique |
|
|
136
|
+
| Types TypeScript | ✓ | ✓ |
|
|
137
|
+
|
|
138
|
+
## 🔑 Options d'authentification
|
|
139
|
+
|
|
140
|
+
### Client UID (multi-clients)
|
|
121
141
|
|
|
122
|
-
Si vous gérez plusieurs clients
|
|
142
|
+
Si vous gérez plusieurs clients :
|
|
123
143
|
|
|
124
144
|
```typescript
|
|
125
|
-
const
|
|
126
|
-
|
|
145
|
+
const client = new FactPulseClient({
|
|
146
|
+
email: 'votre_email@example.com',
|
|
127
147
|
password: 'votre_mot_de_passe',
|
|
128
|
-
|
|
148
|
+
clientUid: 'identifiant_client' // UID du client cible
|
|
129
149
|
});
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Configuration avancée
|
|
130
153
|
|
|
131
|
-
|
|
154
|
+
```typescript
|
|
155
|
+
const client = new FactPulseClient({
|
|
156
|
+
email: 'votre_email@example.com',
|
|
157
|
+
password: 'votre_mot_de_passe',
|
|
158
|
+
apiUrl: 'https://factpulse.fr', // URL personnalisée
|
|
159
|
+
pollingInterval: 2000, // Intervalle de polling initial (ms)
|
|
160
|
+
pollingTimeout: 120000, // Timeout de polling (ms)
|
|
161
|
+
maxRetries: 2 // Tentatives en cas de 401
|
|
162
|
+
});
|
|
132
163
|
```
|
|
133
164
|
|
|
134
|
-
|
|
165
|
+
## 💡 Formats de montants acceptés
|
|
135
166
|
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
167
|
+
L'API accepte plusieurs formats pour les montants :
|
|
168
|
+
|
|
169
|
+
```typescript
|
|
170
|
+
// String (recommandé pour la précision)
|
|
171
|
+
const montant = "1234.56";
|
|
172
|
+
|
|
173
|
+
// Number
|
|
174
|
+
const montant = 1234.56;
|
|
175
|
+
|
|
176
|
+
// Integer
|
|
177
|
+
const montant = 1234;
|
|
178
|
+
|
|
179
|
+
// Helper de formatage
|
|
180
|
+
const montantFormate = FactPulseClient.formatMontant(1234.5); // "1234.50"
|
|
181
|
+
```
|
|
139
182
|
|
|
140
183
|
## 📚 Ressources
|
|
141
184
|
|
package/api/sant-api.ts
CHANGED
|
@@ -26,6 +26,36 @@ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
|
|
|
26
26
|
*/
|
|
27
27
|
export const SantApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
28
28
|
return {
|
|
29
|
+
/**
|
|
30
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
31
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
32
|
+
* @param {*} [options] Override http request option.
|
|
33
|
+
* @throws {RequiredError}
|
|
34
|
+
*/
|
|
35
|
+
healthcheckHealthcheckGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
36
|
+
const localVarPath = `/healthcheck`;
|
|
37
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
38
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
39
|
+
let baseOptions;
|
|
40
|
+
if (configuration) {
|
|
41
|
+
baseOptions = configuration.baseOptions;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
45
|
+
const localVarHeaderParameter = {} as any;
|
|
46
|
+
const localVarQueryParameter = {} as any;
|
|
47
|
+
|
|
48
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
49
|
+
|
|
50
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
52
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
53
|
+
|
|
54
|
+
return {
|
|
55
|
+
url: toPathString(localVarUrlObj),
|
|
56
|
+
options: localVarRequestOptions,
|
|
57
|
+
};
|
|
58
|
+
},
|
|
29
59
|
/**
|
|
30
60
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
31
61
|
* @summary Vérifier l\'état de l\'API
|
|
@@ -65,6 +95,18 @@ export const SantApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
65
95
|
export const SantApiFp = function(configuration?: Configuration) {
|
|
66
96
|
const localVarAxiosParamCreator = SantApiAxiosParamCreator(configuration)
|
|
67
97
|
return {
|
|
98
|
+
/**
|
|
99
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
100
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
101
|
+
* @param {*} [options] Override http request option.
|
|
102
|
+
* @throws {RequiredError}
|
|
103
|
+
*/
|
|
104
|
+
async healthcheckHealthcheckGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
|
|
105
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.healthcheckHealthcheckGet(options);
|
|
106
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
107
|
+
const localVarOperationServerBasePath = operationServerMap['SantApi.healthcheckHealthcheckGet']?.[localVarOperationServerIndex]?.url;
|
|
108
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
109
|
+
},
|
|
68
110
|
/**
|
|
69
111
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
70
112
|
* @summary Vérifier l\'état de l\'API
|
|
@@ -86,6 +128,15 @@ export const SantApiFp = function(configuration?: Configuration) {
|
|
|
86
128
|
export const SantApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
87
129
|
const localVarFp = SantApiFp(configuration)
|
|
88
130
|
return {
|
|
131
|
+
/**
|
|
132
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
133
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
healthcheckHealthcheckGet(options?: RawAxiosRequestConfig): AxiosPromise<any> {
|
|
138
|
+
return localVarFp.healthcheckHealthcheckGet(options).then((request) => request(axios, basePath));
|
|
139
|
+
},
|
|
89
140
|
/**
|
|
90
141
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
91
142
|
* @summary Vérifier l\'état de l\'API
|
|
@@ -102,6 +153,16 @@ export const SantApiFactory = function (configuration?: Configuration, basePath?
|
|
|
102
153
|
* SantApi - object-oriented interface
|
|
103
154
|
*/
|
|
104
155
|
export class SantApi extends BaseAPI {
|
|
156
|
+
/**
|
|
157
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
158
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
159
|
+
* @param {*} [options] Override http request option.
|
|
160
|
+
* @throws {RequiredError}
|
|
161
|
+
*/
|
|
162
|
+
public healthcheckHealthcheckGet(options?: RawAxiosRequestConfig) {
|
|
163
|
+
return SantApiFp(this.configuration).healthcheckHealthcheckGet(options).then((request) => request(this.axios, this.basePath));
|
|
164
|
+
}
|
|
165
|
+
|
|
105
166
|
/**
|
|
106
167
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
107
168
|
* @summary Vérifier l\'état de l\'API
|
package/dist/api/sant-api.d.ts
CHANGED
|
@@ -16,6 +16,13 @@ import { type RequestArgs, BaseAPI } from '../base';
|
|
|
16
16
|
* SantApi - axios parameter creator
|
|
17
17
|
*/
|
|
18
18
|
export declare const SantApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
19
|
+
/**
|
|
20
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
21
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
22
|
+
* @param {*} [options] Override http request option.
|
|
23
|
+
* @throws {RequiredError}
|
|
24
|
+
*/
|
|
25
|
+
healthcheckHealthcheckGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19
26
|
/**
|
|
20
27
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
21
28
|
* @summary Vérifier l\'état de l\'API
|
|
@@ -28,6 +35,13 @@ export declare const SantApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
28
35
|
* SantApi - functional programming interface
|
|
29
36
|
*/
|
|
30
37
|
export declare const SantApiFp: (configuration?: Configuration) => {
|
|
38
|
+
/**
|
|
39
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
40
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
healthcheckHealthcheckGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
31
45
|
/**
|
|
32
46
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
33
47
|
* @summary Vérifier l\'état de l\'API
|
|
@@ -40,6 +54,13 @@ export declare const SantApiFp: (configuration?: Configuration) => {
|
|
|
40
54
|
* SantApi - factory interface
|
|
41
55
|
*/
|
|
42
56
|
export declare const SantApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
57
|
+
/**
|
|
58
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
59
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
60
|
+
* @param {*} [options] Override http request option.
|
|
61
|
+
* @throws {RequiredError}
|
|
62
|
+
*/
|
|
63
|
+
healthcheckHealthcheckGet(options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
43
64
|
/**
|
|
44
65
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
45
66
|
* @summary Vérifier l\'état de l\'API
|
|
@@ -52,6 +73,13 @@ export declare const SantApiFactory: (configuration?: Configuration, basePath?:
|
|
|
52
73
|
* SantApi - object-oriented interface
|
|
53
74
|
*/
|
|
54
75
|
export declare class SantApi extends BaseAPI {
|
|
76
|
+
/**
|
|
77
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
78
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
79
|
+
* @param {*} [options] Override http request option.
|
|
80
|
+
* @throws {RequiredError}
|
|
81
|
+
*/
|
|
82
|
+
healthcheckHealthcheckGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
55
83
|
/**
|
|
56
84
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
57
85
|
* @summary Vérifier l\'état de l\'API
|
package/dist/api/sant-api.js
CHANGED
|
@@ -34,6 +34,32 @@ const base_1 = require("../base");
|
|
|
34
34
|
*/
|
|
35
35
|
const SantApiAxiosParamCreator = function (configuration) {
|
|
36
36
|
return {
|
|
37
|
+
/**
|
|
38
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
39
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
40
|
+
* @param {*} [options] Override http request option.
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
healthcheckHealthcheckGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
44
|
+
const localVarPath = `/healthcheck`;
|
|
45
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
46
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
47
|
+
let baseOptions;
|
|
48
|
+
if (configuration) {
|
|
49
|
+
baseOptions = configuration.baseOptions;
|
|
50
|
+
}
|
|
51
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
52
|
+
const localVarHeaderParameter = {};
|
|
53
|
+
const localVarQueryParameter = {};
|
|
54
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
55
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
56
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
57
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
58
|
+
return {
|
|
59
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
60
|
+
options: localVarRequestOptions,
|
|
61
|
+
};
|
|
62
|
+
}),
|
|
37
63
|
/**
|
|
38
64
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
39
65
|
* @summary Vérifier l\'état de l\'API
|
|
@@ -69,6 +95,21 @@ exports.SantApiAxiosParamCreator = SantApiAxiosParamCreator;
|
|
|
69
95
|
const SantApiFp = function (configuration) {
|
|
70
96
|
const localVarAxiosParamCreator = (0, exports.SantApiAxiosParamCreator)(configuration);
|
|
71
97
|
return {
|
|
98
|
+
/**
|
|
99
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
100
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
101
|
+
* @param {*} [options] Override http request option.
|
|
102
|
+
* @throws {RequiredError}
|
|
103
|
+
*/
|
|
104
|
+
healthcheckHealthcheckGet(options) {
|
|
105
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
106
|
+
var _a, _b, _c;
|
|
107
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.healthcheckHealthcheckGet(options);
|
|
108
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
109
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['SantApi.healthcheckHealthcheckGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
110
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
111
|
+
});
|
|
112
|
+
},
|
|
72
113
|
/**
|
|
73
114
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
74
115
|
* @summary Vérifier l\'état de l\'API
|
|
@@ -93,6 +134,15 @@ exports.SantApiFp = SantApiFp;
|
|
|
93
134
|
const SantApiFactory = function (configuration, basePath, axios) {
|
|
94
135
|
const localVarFp = (0, exports.SantApiFp)(configuration);
|
|
95
136
|
return {
|
|
137
|
+
/**
|
|
138
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
139
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
140
|
+
* @param {*} [options] Override http request option.
|
|
141
|
+
* @throws {RequiredError}
|
|
142
|
+
*/
|
|
143
|
+
healthcheckHealthcheckGet(options) {
|
|
144
|
+
return localVarFp.healthcheckHealthcheckGet(options).then((request) => request(axios, basePath));
|
|
145
|
+
},
|
|
96
146
|
/**
|
|
97
147
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
98
148
|
* @summary Vérifier l\'état de l\'API
|
|
@@ -109,6 +159,15 @@ exports.SantApiFactory = SantApiFactory;
|
|
|
109
159
|
* SantApi - object-oriented interface
|
|
110
160
|
*/
|
|
111
161
|
class SantApi extends base_1.BaseAPI {
|
|
162
|
+
/**
|
|
163
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
164
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
165
|
+
* @param {*} [options] Override http request option.
|
|
166
|
+
* @throws {RequiredError}
|
|
167
|
+
*/
|
|
168
|
+
healthcheckHealthcheckGet(options) {
|
|
169
|
+
return (0, exports.SantApiFp)(this.configuration).healthcheckHealthcheckGet(options).then((request) => request(this.axios, this.basePath));
|
|
170
|
+
}
|
|
112
171
|
/**
|
|
113
172
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
114
173
|
* @summary Vérifier l\'état de l\'API
|
|
@@ -16,6 +16,13 @@ import { type RequestArgs, BaseAPI } from '../base';
|
|
|
16
16
|
* SantApi - axios parameter creator
|
|
17
17
|
*/
|
|
18
18
|
export declare const SantApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
19
|
+
/**
|
|
20
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
21
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
22
|
+
* @param {*} [options] Override http request option.
|
|
23
|
+
* @throws {RequiredError}
|
|
24
|
+
*/
|
|
25
|
+
healthcheckHealthcheckGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19
26
|
/**
|
|
20
27
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
21
28
|
* @summary Vérifier l\'état de l\'API
|
|
@@ -28,6 +35,13 @@ export declare const SantApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
28
35
|
* SantApi - functional programming interface
|
|
29
36
|
*/
|
|
30
37
|
export declare const SantApiFp: (configuration?: Configuration) => {
|
|
38
|
+
/**
|
|
39
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
40
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
healthcheckHealthcheckGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
31
45
|
/**
|
|
32
46
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
33
47
|
* @summary Vérifier l\'état de l\'API
|
|
@@ -40,6 +54,13 @@ export declare const SantApiFp: (configuration?: Configuration) => {
|
|
|
40
54
|
* SantApi - factory interface
|
|
41
55
|
*/
|
|
42
56
|
export declare const SantApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
57
|
+
/**
|
|
58
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
59
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
60
|
+
* @param {*} [options] Override http request option.
|
|
61
|
+
* @throws {RequiredError}
|
|
62
|
+
*/
|
|
63
|
+
healthcheckHealthcheckGet(options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
43
64
|
/**
|
|
44
65
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
45
66
|
* @summary Vérifier l\'état de l\'API
|
|
@@ -52,6 +73,13 @@ export declare const SantApiFactory: (configuration?: Configuration, basePath?:
|
|
|
52
73
|
* SantApi - object-oriented interface
|
|
53
74
|
*/
|
|
54
75
|
export declare class SantApi extends BaseAPI {
|
|
76
|
+
/**
|
|
77
|
+
* Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l\'API est opérationnelle.
|
|
78
|
+
* @summary Endpoint de healthcheck pour Docker
|
|
79
|
+
* @param {*} [options] Override http request option.
|
|
80
|
+
* @throws {RequiredError}
|
|
81
|
+
*/
|
|
82
|
+
healthcheckHealthcheckGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
55
83
|
/**
|
|
56
84
|
* Endpoint de health check pour vérifier que l\'API répond. Utile pour : - Monitoring de disponibilité - Tests d\'intégration - Load balancers
|
|
57
85
|
* @summary Vérifier l\'état de l\'API
|