factpulse 4.0.3 → 4.3.0

data/docs/ConversionTaskStatusResult.md

@@ -0,0 +1,85 @@
+# FactPulse::ConversionTaskStatusResult
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'factpulse'
+
+FactPulse::ConversionTaskStatusResult.openapi_one_of
+# =>
+# [
+#   :'ConversionErrorResult',
+#   :'ConversionPendingInputResult',
+#   :'ConversionSuccessTaskResult',
+#   :'ConversionValidationFailedResult'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'factpulse'
+
+FactPulse::ConversionTaskStatusResult.openapi_discriminator_name
+# => :'status'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'factpulse'
+
+FactPulse::ConversionTaskStatusResult.openapi_discriminator_mapping
+# =>
+# {
+#   :'ERROR' => :'ConversionErrorResult',
+#   :'PENDING_INPUT' => :'ConversionPendingInputResult',
+#   :'SUCCESS' => :'ConversionSuccessTaskResult',
+#   :'VALIDATION_FAILED' => :'ConversionValidationFailedResult'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'factpulse'
+
+FactPulse::ConversionTaskStatusResult.build(data)
+# => #<ConversionErrorResult:0x00007fdd4aab02a0>
+
+FactPulse::ConversionTaskStatusResult.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ConversionErrorResult`
+- `ConversionPendingInputResult`
+- `ConversionSuccessTaskResult`
+- `ConversionValidationFailedResult`
+- `nil` (if no type matches)
+

data/docs/ConversionValidationFailedResult.md

@@ -0,0 +1,34 @@
+# FactPulse::ConversionValidationFailedResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional][default to 'VALIDATION_FAILED'] |
+| **conversion_id** | **String** |  |  |
+| **message** | **String** |  |  |
+| **extracted_data** | **Hash<String, Object>** |  |  |
+| **extraction** | [**ConversionExtractionInfo**](ConversionExtractionInfo.md) |  | [optional] |
+| **validation_errors** | **Array<Hash<String, Object>>** |  | [optional] |
+| **profile** | **String** |  |  |
+| **processing_time_ms** | **Integer** |  |  |
+| **correction_attempted** | **Boolean** |  | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::ConversionValidationFailedResult.new(
+  status: null,
+  conversion_id: null,
+  message: null,
+  extracted_data: null,
+  extraction: null,
+  validation_errors: null,
+  profile: null,
+  processing_time_ms: null,
+  correction_attempted: null
+)
+```
+

data/docs/DownloadsApi.md

@@ -33,7 +33,7 @@ FactPulse.configure do |config|
 end
 
 api_instance = FactPulse::DownloadsApi.new
-download_id = 'download_id_example' # String | 
+download_id = 'download_id_example' # String | Unique identifier of the temporary file to check
 
 begin
   # Check if a file exists
@@ -66,7 +66,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **download_id** | **String** |  |  |
+| **download_id** | **String** | Unique identifier of the temporary file to check |  |
 
 ### Return type
 
@@ -107,7 +107,7 @@ FactPulse.configure do |config|
 end
 
 api_instance = FactPulse::DownloadsApi.new
-download_id = 'download_id_example' # String | 
+download_id = 'download_id_example' # String | Unique identifier of the temporary file to download
 opts = {
   delete_after: true # Boolean | If true, delete the file after download (one-time download)
 }
@@ -143,7 +143,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **download_id** | **String** |  |  |
+| **download_id** | **String** | Unique identifier of the temporary file to download |  |
 | **delete_after** | **Boolean** | If true, delete the file after download (one-time download) | [optional][default to false] |
 
 ### Return type

data/docs/FacturXConversionApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://factpulse.fr*
 | [**convert_document_async_api_v1_convert_async_post**](FacturXConversionApi.md#convert_document_async_api_v1_convert_async_post) | **POST** /api/v1/convert/async | Convert a document to Factur-X (async mode) |
 | [**download_file_api_v1_convert_conversion_id_download_filename_get**](FacturXConversionApi.md#download_file_api_v1_convert_conversion_id_download_filename_get) | **GET** /api/v1/convert/{conversion_id}/download/{filename} | Download a generated file |
 | [**get_conversion_status_api_v1_convert_conversion_id_status_get**](FacturXConversionApi.md#get_conversion_status_api_v1_convert_conversion_id_status_get) | **GET** /api/v1/convert/{conversion_id}/status | Check conversion status |
+| [**get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get**](FacturXConversionApi.md#get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get) | **GET** /api/v1/convert/tasks/{task_id}/conversion-status | Get typed conversion task status |
 | [**resume_conversion_api_v1_convert_conversion_id_resume_post**](FacturXConversionApi.md#resume_conversion_api_v1_convert_conversion_id_resume_post) | **POST** /api/v1/convert/{conversion_id}/resume | Resume a conversion with corrections |
 | [**resume_conversion_async_api_v1_convert_conversion_id_resume_async_post**](FacturXConversionApi.md#resume_conversion_async_api_v1_convert_conversion_id_resume_async_post) | **POST** /api/v1/convert/{conversion_id}/resume/async | Resume a conversion asynchronously |
 
@@ -243,6 +244,80 @@ end
 - **Accept**: application/json
 
 
+## get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get
+
+> <ConversionTaskStatus> get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get(task_id)
+
+Get typed conversion task status
+
+Typed status endpoint for document conversion tasks.  Returns a strongly-typed `result` discriminated on `result.status`: - **SUCCESS**: `ConversionSuccessTaskResult` - **PENDING_INPUT**: `ConversionPendingInputResult` (missing fields) - **VALIDATION_FAILED**: `ConversionValidationFailedResult` - **ERROR**: `ConversionErrorResult`
+
+### Examples
+
+```ruby
+require 'time'
+require 'factpulse'
+# setup authorization
+FactPulse.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: HTTPBearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = FactPulse::FacturXConversionApi.new
+task_id = 'task_id_example' # String | Celery task ID returned by POST /convert
+
+begin
+  # Get typed conversion task status
+  result = api_instance.get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get(task_id)
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling FacturXConversionApi->get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get: #{e}"
+end
+```
+
+#### Using the get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversionTaskStatus>, Integer, Hash)> get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get_with_http_info(task_id)
+
+```ruby
+begin
+  # Get typed conversion task status
+  data, status_code, headers = api_instance.get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get_with_http_info(task_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversionTaskStatus>
+rescue FactPulse::ApiError => e
+  puts "Error when calling FacturXConversionApi->get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_id** | **String** | Celery task ID returned by POST /convert |  |
+
+### Return type
+
+[**ConversionTaskStatus**](ConversionTaskStatus.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## resume_conversion_api_v1_convert_conversion_id_resume_post
 
 > <ConvertSuccessResponse> resume_conversion_api_v1_convert_conversion_id_resume_post(conversion_id, convert_resume_request)

data/docs/FacturXInvoice.md

@@ -10,7 +10,7 @@
 | **submission_mode** | [**SubmissionMode**](SubmissionMode.md) |  | [optional] |
 | **recipient** | [**Recipient**](Recipient.md) |  |  |
 | **supplier** | [**Supplier**](Supplier.md) |  |  |
-| **invoicing_framework** | [**InvoicingFramework**](InvoicingFramework.md) |  |  |
+| **invoicing_framework** | [**InvoicingFramework**](InvoicingFramework.md) |  | [optional] |
 | **references** | [**InvoiceReferences**](InvoiceReferences.md) |  |  |
 | **totals** | [**InvoiceTotals**](InvoiceTotals.md) |  |  |
 | **invoice_lines** | [**Array<InvoiceLine>**](InvoiceLine.md) |  | [optional] |

data/docs/FacturXPDFXMLVerificationApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://factpulse.fr*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**get_verification_status_api_v1_verification_verify_async_task_id_status_get**](FacturXPDFXMLVerificationApi.md#get_verification_status_api_v1_verification_verify_async_task_id_status_get) | **GET** /api/v1/verification/verify-async/{task_id}/status | Get status of an asynchronous verification |
+| [**get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get**](FacturXPDFXMLVerificationApi.md#get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get) | **GET** /api/v1/verification/verify-async/{task_id}/typed-status | Get typed status of an asynchronous verification |
 | [**verify_pdf_async_api_v1_verification_verify_async_post**](FacturXPDFXMLVerificationApi.md#verify_pdf_async_api_v1_verification_verify_async_post) | **POST** /api/v1/verification/verify-async | Verify PDF/XML Factur-X compliance (asynchronous) |
 | [**verify_pdf_sync_api_v1_verification_verify_post**](FacturXPDFXMLVerificationApi.md#verify_pdf_sync_api_v1_verification_verify_post) | **POST** /api/v1/verification/verify | Verify PDF/XML Factur-X compliance (synchronous) |
 
@@ -83,6 +84,80 @@ end
 - **Accept**: application/json
 
 
+## get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get
+
+> <VerificationTypedTaskStatus> get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get(task_id)
+
+Get typed status of an asynchronous verification
+
+Typed status endpoint for async verification tasks.  Returns a strongly-typed `result` (discriminated on `result.status`): - **SUCCESS**: `VerificationSuccessTaskResult` with `verification_result` - **ERROR**: `TaskErrorResult` in AFNOR format
+
+### Examples
+
+```ruby
+require 'time'
+require 'factpulse'
+# setup authorization
+FactPulse.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: HTTPBearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = FactPulse::FacturXPDFXMLVerificationApi.new
+task_id = 'task_id_example' # String | Celery task ID returned by /verify-async endpoint
+
+begin
+  # Get typed status of an asynchronous verification
+  result = api_instance.get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get(task_id)
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling FacturXPDFXMLVerificationApi->get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get: #{e}"
+end
+```
+
+#### Using the get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerificationTypedTaskStatus>, Integer, Hash)> get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get_with_http_info(task_id)
+
+```ruby
+begin
+  # Get typed status of an asynchronous verification
+  data, status_code, headers = api_instance.get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get_with_http_info(task_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerificationTypedTaskStatus>
+rescue FactPulse::ApiError => e
+  puts "Error when calling FacturXPDFXMLVerificationApi->get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_id** | **String** | Celery task ID returned by /verify-async endpoint |  |
+
+### Return type
+
+[**VerificationTypedTaskStatus**](VerificationTypedTaskStatus.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## verify_pdf_async_api_v1_verification_verify_async_post
 
 > <TaskResponse> verify_pdf_async_api_v1_verification_verify_async_post(pdf_file, opts)

data/docs/FacturXValidationApi.md

@@ -6,7 +6,6 @@ All URIs are relative to *https://factpulse.fr*
 | ------ | ------------ | ----------- |
 | [**validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post**](FacturXValidationApi.md#validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post) | **POST** /api/v1/processing/validate-facturx-pdf | Validate a complete Factur-X PDF |
 | [**validate_facturx_pdf_async_api_v1_processing_validate_facturx_async_post**](FacturXValidationApi.md#validate_facturx_pdf_async_api_v1_processing_validate_facturx_async_post) | **POST** /api/v1/processing/validate-facturx-async | Validate a Factur-X PDF (asynchronous with polling) |
-| [**validate_xml_api_v1_processing_validate_xml_post**](FacturXValidationApi.md#validate_xml_api_v1_processing_validate_xml_post) | **POST** /api/v1/processing/validate-xml | Validate an existing Factur-X XML |
 
 
 ## validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post
@@ -174,83 +173,3 @@ end
 - **Content-Type**: multipart/form-data
 - **Accept**: application/json
 
-
-## validate_xml_api_v1_processing_validate_xml_post
-
-> <ValidationSuccessResponse> validate_xml_api_v1_processing_validate_xml_post(xml_file, opts)
-
-Validate an existing Factur-X XML
-
-Validates a Factur-X XML file against Schematron business rules according to EN 16931 standard.  ## Applied Standard  **Schematron ISO/IEC 19757-3**: Business rules validation language for XML - Semantic validation (beyond XSD syntax) - European EN 16931 business rules - French-specific Factur-X rules - Arithmetic calculations and data consistency  ## Profiles and validated rules  ### MINIMUM (45 rules) - Unique invoice identifier - Dates (issue, due date) - Party identifiers (SIRET/SIREN) - Total gross amount  ### BASIC (102 rules) - All MINIMUM rules - Detailed invoice lines - Basic VAT calculations - Payment methods - References (order, contract)  ### EN16931 (178 rules) - All BASIC rules - **European rules (BR-xx)**: 81 business rules - **French rules (FR-xx)**: 12 France-specific rules - **Advanced calculations (CR-xx)**: 32 calculation rules - **Standardized codes (CL-xx)**: 52 code lists  ### EXTENDED (210+ rules) - All EN16931 rules - Logistics information - Advanced accounting data - Multiple external references  ## Checks performed  ### 1. Syntax validation - Correct XML parsing (UTF-8, well-formed) - UN/CEFACT namespaces present - Hierarchical structure respected  ### 2. Business rules (BR-xx) Examples: - `BR-1`: Invoice total must equal sum of line totals + document-level amounts - `BR-CO-10`: Sum of VAT base amounts must equal invoice net total - `BR-16`: Invoice currency code must be in ISO 4217 list  ### 3. French rules (FR-xx) Examples: - `FR-1`: Supplier SIRET must have 14 digits - `FR-2`: Customer SIRET must have 14 digits (if present) - `FR-5`: Intra-EU VAT number must be in format FRxx999999999  ### 4. Calculation rules (CR-xx) - Net + VAT = Gross amounts - Sum of lines = Document total - Discounts and surcharges correctly applied - Compliant rounding (2 decimals for amounts)  ### 5. Standardized codes (CL-xx) - ISO 3166-1 alpha-2 country codes - ISO 4217 currency codes - UN/ECE Rec 20 measurement units - VAT codes (types, categories, exemptions) - SchemeID for identifiers (0002=SIREN, 0009=SIRET, etc.)  ## Validation process  1. **XSLT loading**: Schematron file converted to XSLT (Saxon-HE) 2. **Transformation**: Rules applied to XML 3. **Results analysis**: Extraction of errors (`failed-assert`) and warnings (`successful-report`) 4. **Report**: Structured list of non-conformities  ## Responses  **200 OK**: Compliant XML ```json {   \"message\": \"XML is compliant with EN16931 profile\" } ```  **400 Bad Request**: Non-compliant XML ```json {   \"detail\": [     \"[BR-1] Invoice total (120.00) does not match calculated sum (100.00 + 20.00)\",     \"[FR-1] Supplier SIRET must contain exactly 14 digits\"   ] } ```  ## Use cases  - **Pre-validation**: Verify XML before PDF/A integration - **Debugging**: Precisely identify generation errors - **Testing**: Validate test or example XMLs - **Compliance**: Ensure European and French rules are met - **Development**: Quick testing without PDF generation  ## Processing time  - MINIMUM profile: ~0.5 second - EN16931 profile: ~1-2 seconds - EXTENDED profile: ~2-3 seconds
-
-### Examples
-
-```ruby
-require 'time'
-require 'factpulse'
-# setup authorization
-FactPulse.configure do |config|
-  # Configure API key authorization: APIKeyHeader
-  config.api_key['X-API-Key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['X-API-Key'] = 'Bearer'
-
-  # Configure Bearer authorization: HTTPBearer
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = FactPulse::FacturXValidationApi.new
-xml_file = File.new('/path/to/some/file') # File | Factur-X XML file to validate (.xml format).
-opts = {
-  profile: FactPulse::APIProfile::MINIMUM, # APIProfile | Validation profile (MINIMUM, BASIC, EN16931, EXTENDED).
-  skip_br_fr: true # Boolean | 
-}
-
-begin
-  # Validate an existing Factur-X XML
-  result = api_instance.validate_xml_api_v1_processing_validate_xml_post(xml_file, opts)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXValidationApi->validate_xml_api_v1_processing_validate_xml_post: #{e}"
-end
-```
-
-#### Using the validate_xml_api_v1_processing_validate_xml_post_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ValidationSuccessResponse>, Integer, Hash)> validate_xml_api_v1_processing_validate_xml_post_with_http_info(xml_file, opts)
-
-```ruby
-begin
-  # Validate an existing Factur-X XML
-  data, status_code, headers = api_instance.validate_xml_api_v1_processing_validate_xml_post_with_http_info(xml_file, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ValidationSuccessResponse>
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXValidationApi->validate_xml_api_v1_processing_validate_xml_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **xml_file** | **File** | Factur-X XML file to validate (.xml format). |  |
-| **profile** | [**APIProfile**](APIProfile.md) | Validation profile (MINIMUM, BASIC, EN16931, EXTENDED). | [optional] |
-| **skip_br_fr** | **Boolean** |  | [optional] |
-
-### Return type
-
-[**ValidationSuccessResponse**](ValidationSuccessResponse.md)
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: multipart/form-data
-- **Accept**: application/json
-

data/docs/FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md

@@ -0,0 +1,24 @@
+# FactPulse::FactureElectroniqueRestApiSchemasCdarValidationErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | Champ concerné |  |
+| **message** | **String** | Message d'erreur |  |
+| **rule** | **String** |  | [optional] |
+| **severity** | **String** | Sévérité (error/warning) | [optional][default to 'error'] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.new(
+  field: null,
+  message: null,
+  rule: null,
+  severity: null
+)
+```
+

data/docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md

@@ -0,0 +1,26 @@
+# FactPulse::FactureElectroniqueRestApiSchemasProcessingChorusProCredentials
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **piste_client_id** | **String** |  | [optional] |
+| **piste_client_secret** | **String** |  | [optional] |
+| **chorus_login** | **String** |  | [optional] |
+| **chorus_password** | **String** |  | [optional] |
+| **sandbox_mode** | **Boolean** | [MODE 2] Use sandbox mode (default: True) | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.new(
+  piste_client_id: null,
+  piste_client_secret: null,
+  chorus_login: null,
+  chorus_password: null,
+  sandbox_mode: null
+)
+```
+

data/docs/Flux6InvoiceLifecycleCDARApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://factpulse.fr*
 | ------ | ------------ | ----------- |
 | [**generate_cdar_api_v1_cdar_generate_post**](Flux6InvoiceLifecycleCDARApi.md#generate_cdar_api_v1_cdar_generate_post) | **POST** /api/v1/cdar/generate | Generate a CDAR message |
 | [**get_action_codes_api_v1_cdar_action_codes_get**](Flux6InvoiceLifecycleCDARApi.md#get_action_codes_api_v1_cdar_action_codes_get) | **GET** /api/v1/cdar/action-codes | List of CDAR action codes |
+| [**get_lifecycle_api_v1_cdar_lifecycle_get**](Flux6InvoiceLifecycleCDARApi.md#get_lifecycle_api_v1_cdar_lifecycle_get) | **GET** /api/v1/cdar/lifecycle | [Simplified] Get lifecycle events for invoices |
 | [**get_reason_codes_api_v1_cdar_reason_codes_get**](Flux6InvoiceLifecycleCDARApi.md#get_reason_codes_api_v1_cdar_reason_codes_get) | **GET** /api/v1/cdar/reason-codes | List of CDAR reason codes |
 | [**get_status_codes_api_v1_cdar_status_codes_get**](Flux6InvoiceLifecycleCDARApi.md#get_status_codes_api_v1_cdar_status_codes_get) | **GET** /api/v1/cdar/status-codes | List of CDAR status codes |
 | [**submit_cdar_api_v1_cdar_submit_post**](Flux6InvoiceLifecycleCDARApi.md#submit_cdar_api_v1_cdar_submit_post) | **POST** /api/v1/cdar/submit | Generate and submit a CDAR message |
@@ -151,6 +152,87 @@ No authorization required
 - **Accept**: application/json
 
 
+## get_lifecycle_api_v1_cdar_lifecycle_get
+
+> <LifecycleResponse> get_lifecycle_api_v1_cdar_lifecycle_get(opts)
+
+[Simplified] Get lifecycle events for invoices
+
+Returns lifecycle events (CDAR) grouped by invoice reference.  **How it works (AFNOR XP Z12-013 compliant):** 1. Searches lifecycle flows on the PDP by flowType + flowDirection + date range 2. Downloads and parses each CDAR XML to extract the invoice reference 3. Groups events by invoice, sorted chronologically  **Parameters:** - `days`: Number of days to look back (default: 7) - `invoiceId`: Optional filter on a specific invoice reference  **Authentication:** JWT Bearer (recommended) or PDP credentials as query parameters.
+
+### Examples
+
+```ruby
+require 'time'
+require 'factpulse'
+# setup authorization
+FactPulse.configure do |config|
+  # Configure Bearer authorization: HTTPBearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = FactPulse::Flux6InvoiceLifecycleCDARApi.new
+opts = {
+  days: 56, # Integer | Number of days to look back
+  invoice_id: 'invoice_id_example', # String | Filter by invoice reference
+  pdp_flow_service_url: 'pdp_flow_service_url_example', # String | PDP Flow Service URL
+  pdp_token_url: 'pdp_token_url_example', # String | PDP OAuth token URL
+  pdp_client_id: 'pdp_client_id_example', # String | PDP Client ID
+  pdp_client_secret: 'pdp_client_secret_example' # String | PDP Client Secret
+}
+
+begin
+  # [Simplified] Get lifecycle events for invoices
+  result = api_instance.get_lifecycle_api_v1_cdar_lifecycle_get(opts)
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling Flux6InvoiceLifecycleCDARApi->get_lifecycle_api_v1_cdar_lifecycle_get: #{e}"
+end
+```
+
+#### Using the get_lifecycle_api_v1_cdar_lifecycle_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LifecycleResponse>, Integer, Hash)> get_lifecycle_api_v1_cdar_lifecycle_get_with_http_info(opts)
+
+```ruby
+begin
+  # [Simplified] Get lifecycle events for invoices
+  data, status_code, headers = api_instance.get_lifecycle_api_v1_cdar_lifecycle_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LifecycleResponse>
+rescue FactPulse::ApiError => e
+  puts "Error when calling Flux6InvoiceLifecycleCDARApi->get_lifecycle_api_v1_cdar_lifecycle_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **days** | **Integer** | Number of days to look back | [optional][default to 7] |
+| **invoice_id** | **String** | Filter by invoice reference | [optional] |
+| **pdp_flow_service_url** | **String** | PDP Flow Service URL | [optional] |
+| **pdp_token_url** | **String** | PDP OAuth token URL | [optional] |
+| **pdp_client_id** | **String** | PDP Client ID | [optional] |
+| **pdp_client_secret** | **String** | PDP Client Secret | [optional] |
+
+### Return type
+
+[**LifecycleResponse**](LifecycleResponse.md)
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_reason_codes_api_v1_cdar_reason_codes_get
 
 > <ReasonCodesResponse> get_reason_codes_api_v1_cdar_reason_codes_get

data/docs/GenerationSuccessResult.md

@@ -0,0 +1,24 @@
+# FactPulse::GenerationSuccessResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional][default to 'SUCCESS'] |
+| **content_b64** | **String** |  | [optional] |
+| **xml_content** | **String** |  | [optional] |
+| **filename** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::GenerationSuccessResult.new(
+  status: null,
+  content_b64: null,
+  xml_content: null,
+  filename: null
+)
+```
+

data/docs/GenerationTaskStatus.md

@@ -0,0 +1,22 @@
+# FactPulse::GenerationTaskStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_id** | **String** |  |  |
+| **status** | [**CeleryStatus**](CeleryStatus.md) |  |  |
+| **result** | [**GenerationTaskStatusResult**](GenerationTaskStatusResult.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::GenerationTaskStatus.new(
+  task_id: null,
+  status: null,
+  result: null
+)
+```
+