@factpulse/sdk 4.0.3 → 4.1.2

package/docs/AsyncTasksApi.md

@@ -4,7 +4,116 @@ All URIs are relative to *https://factpulse.fr*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**getGenerationTaskStatusApiV1ProcessingTasksTaskIdGenerationStatusGet**](#getgenerationtaskstatusapiv1processingtaskstaskidgenerationstatusget) | **GET** /api/v1/processing/tasks/{task_id}/generation-status | Get typed generation task status|
+|[**getSignatureTaskStatusApiV1ProcessingTasksTaskIdSignatureStatusGet**](#getsignaturetaskstatusapiv1processingtaskstaskidsignaturestatusget) | **GET** /api/v1/processing/tasks/{task_id}/signature-status | Get typed signature task status|
 |[**getTaskStatusApiV1ProcessingTasksTaskIdStatusGet**](#gettaskstatusapiv1processingtaskstaskidstatusget) | **GET** /api/v1/processing/tasks/{task_id}/status | Get task generation status|
+|[**getValidationTaskStatusApiV1ProcessingTasksTaskIdValidationStatusGet**](#getvalidationtaskstatusapiv1processingtaskstaskidvalidationstatusget) | **GET** /api/v1/processing/tasks/{task_id}/validation-status | Get typed validation task status|
+
+# **getGenerationTaskStatusApiV1ProcessingTasksTaskIdGenerationStatusGet**
+> GenerationTaskStatus getGenerationTaskStatusApiV1ProcessingTasksTaskIdGenerationStatusGet()
+
+Typed status endpoint for invoice generation tasks.  Returns a strongly-typed `result` (discriminated on `result.status`): - **SUCCESS**: `GenerationSuccessResult` with `content_b64` / `xml_content` - **ERROR**: `TaskErrorResult` in AFNOR format
+
+### Example
+
+```typescript
+import {
+    AsyncTasksApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AsyncTasksApi(configuration);
+
+let taskId: string; //Celery task ID returned by /generate-invoice (default to undefined)
+
+const { status, data } = await apiInstance.getGenerationTaskStatusApiV1ProcessingTasksTaskIdGenerationStatusGet(
+    taskId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | [**string**] | Celery task ID returned by /generate-invoice | defaults to undefined|
+
+
+### Return type
+
+**GenerationTaskStatus**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**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)
+
+# **getSignatureTaskStatusApiV1ProcessingTasksTaskIdSignatureStatusGet**
+> SignatureTaskStatus getSignatureTaskStatusApiV1ProcessingTasksTaskIdSignatureStatusGet()
+
+Typed status endpoint for PDF signing tasks.  Returns a strongly-typed `result` (discriminated on `result.status`): - **SUCCESS**: `SignatureSuccessResult` with `content_b64`, `signer_cn`, etc. - **ERROR**: `TaskErrorResult` in AFNOR format
+
+### Example
+
+```typescript
+import {
+    AsyncTasksApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AsyncTasksApi(configuration);
+
+let taskId: string; //Celery task ID returned by /sign-pdf-async (default to undefined)
+
+const { status, data } = await apiInstance.getSignatureTaskStatusApiV1ProcessingTasksTaskIdSignatureStatusGet(
+    taskId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | [**string**] | Celery task ID returned by /sign-pdf-async | defaults to undefined|
+
+
+### Return type
+
+**SignatureTaskStatus**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**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)
 
 # **getTaskStatusApiV1ProcessingTasksTaskIdStatusGet**
 > AsyncTaskStatus getTaskStatusApiV1ProcessingTasksTaskIdStatusGet()
@@ -59,3 +168,56 @@ const { status, data } = await apiInstance.getTaskStatusApiV1ProcessingTasksTask
 
 [[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)
 
+# **getValidationTaskStatusApiV1ProcessingTasksTaskIdValidationStatusGet**
+> ValidationTaskStatus getValidationTaskStatusApiV1ProcessingTasksTaskIdValidationStatusGet()
+
+Typed status endpoint for Factur-X PDF validation tasks.  Returns a strongly-typed `result` (discriminated on `result.status`): - **SUCCESS**: `ValidationSuccessTaskResult` with `validation_result` - **ERROR**: `TaskErrorResult` in AFNOR format
+
+### Example
+
+```typescript
+import {
+    AsyncTasksApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AsyncTasksApi(configuration);
+
+let taskId: string; //Celery task ID returned by /validate-pdf (default to undefined)
+
+const { status, data } = await apiInstance.getValidationTaskStatusApiV1ProcessingTasksTaskIdValidationStatusGet(
+    taskId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | [**string**] | Celery task ID returned by /validate-pdf | defaults to undefined|
+
+
+### Return type
+
+**ValidationTaskStatus**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**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)
+

package/docs/ClientManagementApi.md

@@ -33,7 +33,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ClientManagementApi(configuration);
 
-let uid: string; // (default to undefined)
+let uid: string; //Client unique identifier (UUID) (default to undefined)
 
 const { status, data } = await apiInstance.activateClientApiV1ClientsUidActiverPost(
     uid
@@ -44,7 +44,7 @@ const { status, data } = await apiInstance.activateClientApiV1ClientsUidActiverP
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **uid** | [**string**] |  | defaults to undefined|
+| **uid** | [**string**] | Client unique identifier (UUID) | defaults to undefined|
 
 
 ### Return type
@@ -148,7 +148,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ClientManagementApi(configuration);
 
-let uid: string; // (default to undefined)
+let uid: string; //Client unique identifier (UUID) (default to undefined)
 
 const { status, data } = await apiInstance.deactivateClientApiV1ClientsUidDesactiverPost(
     uid
@@ -159,7 +159,7 @@ const { status, data } = await apiInstance.deactivateClientApiV1ClientsUidDesact
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **uid** | [**string**] |  | defaults to undefined|
+| **uid** | [**string**] | Client unique identifier (UUID) | defaults to undefined|
 
 
 ### Return type
@@ -205,7 +205,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ClientManagementApi(configuration);
 
-let uid: string; // (default to undefined)
+let uid: string; //Client unique identifier (UUID) (default to undefined)
 
 const { status, data } = await apiInstance.deleteWebhookSecretApiV1ClientsUidWebhookSecretDelete(
     uid
@@ -216,7 +216,7 @@ const { status, data } = await apiInstance.deleteWebhookSecretApiV1ClientsUidWeb
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **uid** | [**string**] |  | defaults to undefined|
+| **uid** | [**string**] | Client unique identifier (UUID) | defaults to undefined|
 
 
 ### Return type
@@ -262,7 +262,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ClientManagementApi(configuration);
 
-let uid: string; // (default to undefined)
+let uid: string; //Client unique identifier (UUID) (default to undefined)
 
 const { status, data } = await apiInstance.generateWebhookSecretApiV1ClientsUidWebhookSecretGeneratePost(
     uid
@@ -273,7 +273,7 @@ const { status, data } = await apiInstance.generateWebhookSecretApiV1ClientsUidW
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **uid** | [**string**] |  | defaults to undefined|
+| **uid** | [**string**] | Client unique identifier (UUID) | defaults to undefined|
 
 
 ### Return type
@@ -319,7 +319,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ClientManagementApi(configuration);
 
-let uid: string; // (default to undefined)
+let uid: string; //Client unique identifier (UUID) (default to undefined)
 
 const { status, data } = await apiInstance.getClientApiV1ClientsUidGet(
     uid
@@ -330,7 +330,7 @@ const { status, data } = await apiInstance.getClientApiV1ClientsUidGet(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **uid** | [**string**] |  | defaults to undefined|
+| **uid** | [**string**] | Client unique identifier (UUID) | defaults to undefined|
 
 
 ### Return type
@@ -376,7 +376,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ClientManagementApi(configuration);
 
-let uid: string; // (default to undefined)
+let uid: string; //Client unique identifier (UUID) (default to undefined)
 
 const { status, data } = await apiInstance.getPdpConfigApiV1ClientsUidPdpConfigGet(
     uid
@@ -387,7 +387,7 @@ const { status, data } = await apiInstance.getPdpConfigApiV1ClientsUidPdpConfigG
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **uid** | [**string**] |  | defaults to undefined|
+| **uid** | [**string**] | Client unique identifier (UUID) | defaults to undefined|
 
 
 ### Return type
@@ -433,7 +433,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ClientManagementApi(configuration);
 
-let uid: string; // (default to undefined)
+let uid: string; //Client unique identifier (UUID) (default to undefined)
 
 const { status, data } = await apiInstance.getWebhookSecretStatusApiV1ClientsUidWebhookSecretStatusGet(
     uid
@@ -444,7 +444,7 @@ const { status, data } = await apiInstance.getWebhookSecretStatusApiV1ClientsUid
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **uid** | [**string**] |  | defaults to undefined|
+| **uid** | [**string**] | Client unique identifier (UUID) | defaults to undefined|
 
 
 ### Return type
@@ -551,7 +551,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ClientManagementApi(configuration);
 
-let uid: string; // (default to undefined)
+let uid: string; //Client unique identifier (UUID) (default to undefined)
 let keyRotationRequest: KeyRotationRequest; //
 
 const { status, data } = await apiInstance.rotateEncryptionKeyApiV1ClientsUidRotateEncryptionKeyPost(
@@ -565,7 +565,7 @@ const { status, data } = await apiInstance.rotateEncryptionKeyApiV1ClientsUidRot
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **keyRotationRequest** | **KeyRotationRequest**|  | |
-| **uid** | [**string**] |  | defaults to undefined|
+| **uid** | [**string**] | Client unique identifier (UUID) | defaults to undefined|
 
 
 ### Return type
@@ -612,7 +612,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ClientManagementApi(configuration);
 
-let uid: string; // (default to undefined)
+let uid: string; //Client unique identifier (UUID) (default to undefined)
 let clientUpdateRequest: ClientUpdateRequest; //
 
 const { status, data } = await apiInstance.updateClientApiV1ClientsUidPatch(
@@ -626,7 +626,7 @@ const { status, data } = await apiInstance.updateClientApiV1ClientsUidPatch(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **clientUpdateRequest** | **ClientUpdateRequest**|  | |
-| **uid** | [**string**] |  | defaults to undefined|
+| **uid** | [**string**] | Client unique identifier (UUID) | defaults to undefined|
 
 
 ### Return type
@@ -673,7 +673,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ClientManagementApi(configuration);
 
-let uid: string; // (default to undefined)
+let uid: string; //Client unique identifier (UUID) (default to undefined)
 let pDPConfigUpdateRequest: PDPConfigUpdateRequest; //
 let xEncryptionKey: string; //Client encryption key for double encryption mode. Must be a base64-encoded AES-256 key (32 bytes). Required only when accessing resources encrypted with encryption_mode=\'double\'. (optional) (default to undefined)
 
@@ -689,7 +689,7 @@ const { status, data } = await apiInstance.updatePdpConfigApiV1ClientsUidPdpConf
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **pDPConfigUpdateRequest** | **PDPConfigUpdateRequest**|  | |
-| **uid** | [**string**] |  | defaults to undefined|
+| **uid** | [**string**] | Client unique identifier (UUID) | defaults to undefined|
 | **xEncryptionKey** | [**string**] | Client encryption key for double encryption mode. Must be a base64-encoded AES-256 key (32 bytes). Required only when accessing resources encrypted with encryption_mode=\'double\'. | (optional) defaults to undefined|
 
 

package/docs/ConversionErrorResult.md

@@ -0,0 +1,33 @@
+# ConversionErrorResult
+
+Error result specific to conversion tasks.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [optional] [default to StatusEnum_Error]
+**conversion_id** | **string** |  | [optional] [default to undefined]
+**errorCode** | **string** |  | [default to undefined]
+**errorMessage** | **string** |  | [default to undefined]
+**details** | [**Array<AFNORErrorDetail>**](AFNORErrorDetail.md) |  | [optional] [default to undefined]
+**traceback** | **string** |  | [optional] [default to undefined]
+**processing_time_ms** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ConversionErrorResult } from '@factpulse/sdk';
+
+const instance: ConversionErrorResult = {
+    status,
+    conversion_id,
+    errorCode,
+    errorMessage,
+    details,
+    traceback,
+    processing_time_ms,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ConversionExtractionInfo.md

@@ -0,0 +1,23 @@
+# ConversionExtractionInfo
+
+OCR extraction metadata.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**confidence_score** | **number** |  | [default to undefined]
+**ocr_provider** | **string** |  | [optional] [default to 'mistral_ocr']
+
+## Example
+
+```typescript
+import { ConversionExtractionInfo } from '@factpulse/sdk';
+
+const instance: ConversionExtractionInfo = {
+    confidence_score,
+    ocr_provider,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ConversionPendingInputResult.md

@@ -0,0 +1,33 @@
+# ConversionPendingInputResult
+
+Conversion needs user input (missing fields).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [optional] [default to StatusEnum_PendingInput]
+**conversion_id** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**missing_fields** | **Array<string>** |  | [default to undefined]
+**extracted_data** | **{ [key: string]: any; }** |  | [default to undefined]
+**confidence_score** | **number** |  | [default to undefined]
+**processing_time_ms** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ConversionPendingInputResult } from '@factpulse/sdk';
+
+const instance: ConversionPendingInputResult = {
+    status,
+    conversion_id,
+    message,
+    missing_fields,
+    extracted_data,
+    confidence_score,
+    processing_time_ms,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ConversionSuccessTaskResult.md

@@ -0,0 +1,39 @@
+# ConversionSuccessTaskResult
+
+Successful result from task_convert_document.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [optional] [default to StatusEnum_Success]
+**conversion_id** | **string** |  | [default to undefined]
+**document_type_code** | **number** |  | [default to undefined]
+**profile** | **string** |  | [default to undefined]
+**extraction** | [**ConversionExtractionInfo**](ConversionExtractionInfo.md) |  | [default to undefined]
+**processing_time_ms** | **number** |  | [default to undefined]
+**pdf_regenerated** | **boolean** |  | [optional] [default to false]
+**pdf_regenerated_reason** | **string** |  | [optional] [default to undefined]
+**content_b64** | **string** |  | [optional] [default to undefined]
+**xml_content** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ConversionSuccessTaskResult } from '@factpulse/sdk';
+
+const instance: ConversionSuccessTaskResult = {
+    status,
+    conversion_id,
+    document_type_code,
+    profile,
+    extraction,
+    processing_time_ms,
+    pdf_regenerated,
+    pdf_regenerated_reason,
+    content_b64,
+    xml_content,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ConversionTaskStatus.md

@@ -0,0 +1,25 @@
+# ConversionTaskStatus
+
+Typed task status for document conversion.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**taskId** | **string** |  | [default to undefined]
+**status** | [**CeleryStatus**](CeleryStatus.md) |  | [default to undefined]
+**result** | [**ConversionTaskStatusResult**](ConversionTaskStatusResult.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ConversionTaskStatus } from '@factpulse/sdk';
+
+const instance: ConversionTaskStatus = {
+    taskId,
+    status,
+    result,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ConversionTaskStatusResult.md

@@ -0,0 +1,58 @@
+# ConversionTaskStatusResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [optional] [default to StatusEnum_Error]
+**conversion_id** | **string** |  | [default to undefined]
+**document_type_code** | **number** |  | [default to undefined]
+**profile** | **string** |  | [default to undefined]
+**extraction** | [**ConversionExtractionInfo**](ConversionExtractionInfo.md) |  | [default to undefined]
+**processing_time_ms** | **number** |  | [default to undefined]
+**pdf_regenerated** | **boolean** |  | [optional] [default to false]
+**pdf_regenerated_reason** | **string** |  | [optional] [default to undefined]
+**content_b64** | **string** |  | [optional] [default to undefined]
+**xml_content** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [default to undefined]
+**missing_fields** | **Array<string>** |  | [default to undefined]
+**extracted_data** | **{ [key: string]: any; }** |  | [default to undefined]
+**confidence_score** | **number** |  | [default to undefined]
+**validation_errors** | **Array<{ [key: string]: any; }>** |  | [optional] [default to undefined]
+**correction_attempted** | **boolean** |  | [optional] [default to false]
+**errorCode** | **string** |  | [default to undefined]
+**errorMessage** | **string** |  | [default to undefined]
+**details** | [**Array<AFNORErrorDetail>**](AFNORErrorDetail.md) |  | [optional] [default to undefined]
+**traceback** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ConversionTaskStatusResult } from '@factpulse/sdk';
+
+const instance: ConversionTaskStatusResult = {
+    status,
+    conversion_id,
+    document_type_code,
+    profile,
+    extraction,
+    processing_time_ms,
+    pdf_regenerated,
+    pdf_regenerated_reason,
+    content_b64,
+    xml_content,
+    message,
+    missing_fields,
+    extracted_data,
+    confidence_score,
+    validation_errors,
+    correction_attempted,
+    errorCode,
+    errorMessage,
+    details,
+    traceback,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ConversionValidationFailedResult.md

@@ -0,0 +1,37 @@
+# ConversionValidationFailedResult
+
+Conversion extracted data failed Schematron validation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [optional] [default to StatusEnum_ValidationFailed]
+**conversion_id** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**extracted_data** | **{ [key: string]: any; }** |  | [default to undefined]
+**extraction** | [**ConversionExtractionInfo**](ConversionExtractionInfo.md) |  | [optional] [default to undefined]
+**validation_errors** | **Array<{ [key: string]: any; }>** |  | [optional] [default to undefined]
+**profile** | **string** |  | [default to undefined]
+**processing_time_ms** | **number** |  | [default to undefined]
+**correction_attempted** | **boolean** |  | [optional] [default to false]
+
+## Example
+
+```typescript
+import { ConversionValidationFailedResult } from '@factpulse/sdk';
+
+const instance: ConversionValidationFailedResult = {
+    status,
+    conversion_id,
+    message,
+    extracted_data,
+    extraction,
+    validation_errors,
+    profile,
+    processing_time_ms,
+    correction_attempted,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DownloadsApi.md

@@ -23,7 +23,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new DownloadsApi(configuration);
 
-let downloadId: string; // (default to undefined)
+let downloadId: string; //Unique identifier of the temporary file to check (default to undefined)
 
 const { status, data } = await apiInstance.checkFileApiV1DownloadDownloadIdHead(
     downloadId
@@ -34,7 +34,7 @@ const { status, data } = await apiInstance.checkFileApiV1DownloadDownloadIdHead(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **downloadId** | [**string**] |  | defaults to undefined|
+| **downloadId** | [**string**] | Unique identifier of the temporary file to check | defaults to undefined|
 
 
 ### Return type
@@ -78,7 +78,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new DownloadsApi(configuration);
 
-let downloadId: string; // (default to undefined)
+let downloadId: string; //Unique identifier of the temporary file to download (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(
@@ -91,7 +91,7 @@ const { status, data } = await apiInstance.downloadFileApiV1DownloadDownloadIdGe
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **downloadId** | [**string**] |  | defaults to undefined|
+| **downloadId** | [**string**] | Unique identifier of the temporary file to download | defaults to undefined|
 | **deleteAfter** | [**boolean**] | If true, delete the file after download (one-time download) | (optional) defaults to false|