@factpulse/sdk 3.0.9 → 3.0.13

package/docs/DocumentConversionApi.md

@@ -1,75 +1,14 @@
 # DocumentConversionApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://factpulse.fr*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**convertDocumentApiV1ConvertPost**](#convertdocumentapiv1convertpost) | **POST** /api/v1/convert | Convertir un document en Factur-X|
 |[**convertDocumentAsyncApiV1ConvertAsyncPost**](#convertdocumentasyncapiv1convertasyncpost) | **POST** /api/v1/convert/async | Convertir un document en Factur-X (mode asynchrone)|
 |[**downloadFileApiV1ConvertConversionIdDownloadFilenameGet**](#downloadfileapiv1convertconversioniddownloadfilenameget) | **GET** /api/v1/convert/{conversion_id}/download/{filename} | Télécharger un fichier généré|
 |[**getConversionStatusApiV1ConvertConversionIdStatusGet**](#getconversionstatusapiv1convertconversionidstatusget) | **GET** /api/v1/convert/{conversion_id}/status | Vérifier le statut d\'une conversion|
 |[**resumeConversionApiV1ConvertConversionIdResumePost**](#resumeconversionapiv1convertconversionidresumepost) | **POST** /api/v1/convert/{conversion_id}/resume | Reprendre une conversion avec corrections|
 
-# **convertDocumentApiV1ConvertPost**
-> ConvertSuccessResponse convertDocumentApiV1ConvertPost()
-
-Convertit un document (PDF, DOCX, XLSX, image) en Factur-X conforme.  ## Workflow  1. **Upload** : Le document est envoyé en multipart/form-data 2. **Extraction OCR + Classification** : Mistral OCR extrait les données et classifie le document en un seul appel 3. **Enrichissement** : Les données sont enrichies via SIRENE (SIRET → raison sociale) 4. **Validation** : Les règles Schematron sont appliquées 5. **Génération** : Le Factur-X PDF/A-3 est généré  ## Réponses possibles  - **200** : Conversion réussie, fichiers disponibles - **202** : Données manquantes, complétion requise - **422** : Validation échouée, corrections nécessaires - **400** : Fichier invalide - **429** : Quota dépassé
-
-### Example
-
-```typescript
-import {
-    DocumentConversionApi,
-    Configuration
-} from '@factpulse/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new DocumentConversionApi(configuration);
-
-let file: File; //Document à convertir (PDF, DOCX, XLSX, JPG, PNG) (default to undefined)
-let output: string; //Format de sortie: pdf, xml, both (optional) (default to 'pdf')
-let callbackUrl: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.convertDocumentApiV1ConvertPost(
-    file,
-    output,
-    callbackUrl
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **file** | [**File**] | Document à convertir (PDF, DOCX, XLSX, JPG, PNG) | defaults to undefined|
-| **output** | [**string**] | Format de sortie: pdf, xml, both | (optional) defaults to 'pdf'|
-| **callbackUrl** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**ConvertSuccessResponse**
-
-### Authorization
-
-[HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful Response |  -  |
-|**202** | Données manquantes |  -  |
-|**422** | Validation échouée |  -  |
-|**400** | Fichier invalide |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
 # **convertDocumentAsyncApiV1ConvertAsyncPost**
 > any convertDocumentAsyncApiV1ConvertAsyncPost()
 
@@ -89,11 +28,13 @@ const apiInstance = new DocumentConversionApi(configuration);
 let file: File; //Document à convertir (PDF, DOCX, XLSX, JPG, PNG) (default to undefined)
 let output: string; //Format de sortie: pdf, xml, both (optional) (default to 'pdf')
 let callbackUrl: string; // (optional) (default to undefined)
+let webhookMode: string; //Mode de livraison du contenu: \\\'inline\\\' (base64 dans webhook) ou \\\'download_url\\\' (URL temporaire 1h) (optional) (default to 'inline')
 
 const { status, data } = await apiInstance.convertDocumentAsyncApiV1ConvertAsyncPost(
     file,
     output,
-    callbackUrl
+    callbackUrl,
+    webhookMode
 );
 ```
 
@@ -104,6 +45,7 @@ const { status, data } = await apiInstance.convertDocumentAsyncApiV1ConvertAsync
 | **file** | [**File**] | Document à convertir (PDF, DOCX, XLSX, JPG, PNG) | defaults to undefined|
 | **output** | [**string**] | Format de sortie: pdf, xml, both | (optional) defaults to 'pdf'|
 | **callbackUrl** | [**string**] |  | (optional) defaults to undefined|
+| **webhookMode** | [**string**] | Mode de livraison du contenu: \\\'inline\\\' (base64 dans webhook) ou \\\'download_url\\\' (URL temporaire 1h) | (optional) defaults to 'inline'|
 
 
 ### Return type
@@ -127,6 +69,7 @@ const { status, data } = await apiInstance.convertDocumentAsyncApiV1ConvertAsync
 |**202** | Tâche acceptée |  -  |
 |**400** | Fichier invalide |  -  |
 |**422** | Validation Error |  -  |
+|**401** | Authentication required - Invalid or missing JWT token |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
@@ -146,8 +89,8 @@ import {
 const configuration = new Configuration();
 const apiInstance = new DocumentConversionApi(configuration);
 
-let conversionId: string; // (default to undefined)
-let filename: string; // (default to undefined)
+let conversionId: string; //Conversion ID returned by POST /convert (UUID format) (default to undefined)
+let filename: string; //File to download: \'facturx.pdf\' or \'facturx.xml\' (default to undefined)
 
 const { status, data } = await apiInstance.downloadFileApiV1ConvertConversionIdDownloadFilenameGet(
     conversionId,
@@ -159,8 +102,8 @@ const { status, data } = await apiInstance.downloadFileApiV1ConvertConversionIdD
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **conversionId** | [**string**] |  | defaults to undefined|
-| **filename** | [**string**] |  | defaults to undefined|
+| **conversionId** | [**string**] | Conversion ID returned by POST /convert (UUID format) | defaults to undefined|
+| **filename** | [**string**] | File to download: \'facturx.pdf\' or \'facturx.xml\' | defaults to undefined|
 
 
 ### Return type
@@ -183,6 +126,7 @@ const { status, data } = await apiInstance.downloadFileApiV1ConvertConversionIdD
 |**200** | Fichier téléchargé |  -  |
 |**404** | Fichier non trouvé ou expiré |  -  |
 |**422** | Validation Error |  -  |
+|**401** | Authentication required - Invalid or missing JWT token |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
@@ -202,7 +146,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new DocumentConversionApi(configuration);
 
-let conversionId: string; // (default to undefined)
+let conversionId: string; //Conversion ID returned by POST /convert (UUID format) (default to undefined)
 
 const { status, data } = await apiInstance.getConversionStatusApiV1ConvertConversionIdStatusGet(
     conversionId
@@ -213,7 +157,7 @@ const { status, data } = await apiInstance.getConversionStatusApiV1ConvertConver
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **conversionId** | [**string**] |  | defaults to undefined|
+| **conversionId** | [**string**] | Conversion ID returned by POST /convert (UUID format) | defaults to undefined|
 
 
 ### Return type
@@ -235,6 +179,7 @@ const { status, data } = await apiInstance.getConversionStatusApiV1ConvertConver
 |-------------|-------------|------------------|
 |**200** | Successful Response |  -  |
 |**422** | Validation Error |  -  |
+|**401** | Authentication required - Invalid or missing JWT token |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
@@ -255,7 +200,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new DocumentConversionApi(configuration);
 
-let conversionId: string; // (default to undefined)
+let conversionId: string; //Conversion ID returned by POST /convert (UUID format) (default to undefined)
 let convertResumeRequest: ConvertResumeRequest; //
 
 const { status, data } = await apiInstance.resumeConversionApiV1ConvertConversionIdResumePost(
@@ -269,7 +214,7 @@ const { status, data } = await apiInstance.resumeConversionApiV1ConvertConversio
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **convertResumeRequest** | **ConvertResumeRequest**|  | |
-| **conversionId** | [**string**] |  | defaults to undefined|
+| **conversionId** | [**string**] | Conversion ID returned by POST /convert (UUID format) | defaults to undefined|
 
 
 ### Return type
@@ -292,6 +237,7 @@ const { status, data } = await apiInstance.resumeConversionApiV1ConvertConversio
 |**200** | Successful Response |  -  |
 |**404** | Conversion non trouvée ou expirée |  -  |
 |**422** | Validation toujours en échec |  -  |
+|**401** | Authentication required - Invalid or missing JWT token |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 

package/docs/DownloadsApi.md

@@ -0,0 +1,237 @@
+# DownloadsApi
+
+All URIs are relative to *https://factpulse.fr*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**checkFileApiV1DownloadDownloadIdHead**](#checkfileapiv1downloaddownloadidhead) | **HEAD** /api/v1/download/{download_id} | Check if a file exists|
+|[**checkFileApiV1DownloadDownloadIdHead_0**](#checkfileapiv1downloaddownloadidhead_0) | **HEAD** /api/v1/download/{download_id} | Check if a file exists|
+|[**downloadFileApiV1DownloadDownloadIdGet**](#downloadfileapiv1downloaddownloadidget) | **GET** /api/v1/download/{download_id} | Download a temporary file|
+|[**downloadFileApiV1DownloadDownloadIdGet_0**](#downloadfileapiv1downloaddownloadidget_0) | **GET** /api/v1/download/{download_id} | Download a temporary file|
+
+# **checkFileApiV1DownloadDownloadIdHead**
+> any checkFileApiV1DownloadDownloadIdHead()
+
+Check if a temporary file exists and get its metadata without downloading.  Useful for: - Verifying a download URL is still valid - Getting file size before downloading - Checking expiration time  **Security**: Requires authentication, only file owner can check.
+
+### Example
+
+```typescript
+import {
+    DownloadsApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DownloadsApi(configuration);
+
+let downloadId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.checkFileApiV1DownloadDownloadIdHead(
+    downloadId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **downloadId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**any**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | File exists |  -  |
+|**401** | Authentication required |  -  |
+|**403** | Access denied |  -  |
+|**404** | File not found or expired |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **checkFileApiV1DownloadDownloadIdHead_0**
+> any checkFileApiV1DownloadDownloadIdHead_0()
+
+Check if a temporary file exists and get its metadata without downloading.  Useful for: - Verifying a download URL is still valid - Getting file size before downloading - Checking expiration time  **Security**: Requires authentication, only file owner can check.
+
+### Example
+
+```typescript
+import {
+    DownloadsApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DownloadsApi(configuration);
+
+let downloadId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.checkFileApiV1DownloadDownloadIdHead_0(
+    downloadId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **downloadId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**any**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | File exists |  -  |
+|**401** | Authentication required |  -  |
+|**403** | Access denied |  -  |
+|**404** | File not found or expired |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **downloadFileApiV1DownloadDownloadIdGet**
+> any downloadFileApiV1DownloadDownloadIdGet()
+
+Download a file stored temporarily after asynchronous processing.  **Usage**: - This URL is provided in webhook notifications when using `webhook_mode: \"download_url\"` - Files are automatically deleted after 1 hour - Each file can only be downloaded until it expires  **Security**: - Requires a valid JWT token - Only the user who initiated the task can download the file
+
+### Example
+
+```typescript
+import {
+    DownloadsApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DownloadsApi(configuration);
+
+let downloadId: string; // (default to undefined)
+let deleteAfter: boolean; //If true, delete the file after download (one-time download) (optional) (default to false)
+
+const { status, data } = await apiInstance.downloadFileApiV1DownloadDownloadIdGet(
+    downloadId,
+    deleteAfter
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **downloadId** | [**string**] |  | defaults to undefined|
+| **deleteAfter** | [**boolean**] | If true, delete the file after download (one-time download) | (optional) defaults to false|
+
+
+### Return type
+
+**any**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, application/pdf, application/xml, application/octet-stream
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | File content |  -  |
+|**401** | Authentication required |  -  |
+|**403** | Access denied - file belongs to another user |  -  |
+|**404** | File not found or expired |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **downloadFileApiV1DownloadDownloadIdGet_0**
+> any downloadFileApiV1DownloadDownloadIdGet_0()
+
+Download a file stored temporarily after asynchronous processing.  **Usage**: - This URL is provided in webhook notifications when using `webhook_mode: \"download_url\"` - Files are automatically deleted after 1 hour - Each file can only be downloaded until it expires  **Security**: - Requires a valid JWT token - Only the user who initiated the task can download the file
+
+### Example
+
+```typescript
+import {
+    DownloadsApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DownloadsApi(configuration);
+
+let downloadId: string; // (default to undefined)
+let deleteAfter: boolean; //If true, delete the file after download (one-time download) (optional) (default to false)
+
+const { status, data } = await apiInstance.downloadFileApiV1DownloadDownloadIdGet_0(
+    downloadId,
+    deleteAfter
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **downloadId** | [**string**] |  | defaults to undefined|
+| **deleteAfter** | [**boolean**] | If true, delete the file after download (one-time download) | (optional) defaults to false|
+
+
+### Return type
+
+**any**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, application/pdf, application/xml, application/octet-stream
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | File content |  -  |
+|**401** | Authentication required |  -  |
+|**403** | Access denied - file belongs to another user |  -  |
+|**404** | File not found or expired |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+