factpulse 0.1.0 → 1.0.0

data/docs/FacturXConversionApi.md

@@ -1,319 +0,0 @@
-# FactPulse::FacturXConversionApi
-
-All URIs are relative to *https://factpulse.fr*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**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 |
-| [**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 |
-
-
-## convert_document_async_api_v1_convert_async_post
-
-> Object convert_document_async_api_v1_convert_async_post(file, opts)
-
-Convert a document to Factur-X (async mode)
-
-Launch an asynchronous conversion via Celery.  ## Workflow  1. **Upload**: Document is sent as multipart/form-data 2. **Celery Task**: Task is queued for processing 3. **Callback**: Webhook notification on completion  ## Possible responses  - **202**: Task accepted, processing - **400**: Invalid file
-
-### 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
-file = File.new('/path/to/some/file') # File | Document to convert (PDF, DOCX, XLSX, JPG, PNG)
-opts = {
-  output: 'output_example', # String | Output format: pdf, xml, both
-  callback_url: 'callback_url_example', # String | 
-  webhook_mode: 'webhook_mode_example' # String | Content delivery mode: 'inline' (base64 in webhook) or 'download_url' (temporary URL, 1h TTL)
-}
-
-begin
-  # Convert a document to Factur-X (async mode)
-  result = api_instance.convert_document_async_api_v1_convert_async_post(file, opts)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXConversionApi->convert_document_async_api_v1_convert_async_post: #{e}"
-end
-```
-
-#### Using the convert_document_async_api_v1_convert_async_post_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Object, Integer, Hash)> convert_document_async_api_v1_convert_async_post_with_http_info(file, opts)
-
-```ruby
-begin
-  # Convert a document to Factur-X (async mode)
-  data, status_code, headers = api_instance.convert_document_async_api_v1_convert_async_post_with_http_info(file, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Object
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXConversionApi->convert_document_async_api_v1_convert_async_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **file** | **File** | Document to convert (PDF, DOCX, XLSX, JPG, PNG) |  |
-| **output** | **String** | Output format: pdf, xml, both | [optional][default to &#39;pdf&#39;] |
-| **callback_url** | **String** |  | [optional] |
-| **webhook_mode** | **String** | Content delivery mode: &#39;inline&#39; (base64 in webhook) or &#39;download_url&#39; (temporary URL, 1h TTL) | [optional][default to &#39;inline&#39;] |
-
-### Return type
-
-**Object**
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: multipart/form-data
-- **Accept**: application/json
-
-
-## download_file_api_v1_convert_conversion_id_download_filename_get
-
-> Object download_file_api_v1_convert_conversion_id_download_filename_get(conversion_id, filename)
-
-Download a generated file
-
-Download the generated Factur-X PDF or XML file.  ## Available files  - `facturx.pdf`: PDF/A-3 with embedded XML - `facturx.xml`: XML CII only (Cross Industry Invoice)  Files are available for 24 hours after generation.
-
-### 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
-conversion_id = 'conversion_id_example' # String | Conversion ID returned by POST /convert (UUID format)
-filename = 'filename_example' # String | File to download: 'facturx.pdf' or 'facturx.xml'
-
-begin
-  # Download a generated file
-  result = api_instance.download_file_api_v1_convert_conversion_id_download_filename_get(conversion_id, filename)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXConversionApi->download_file_api_v1_convert_conversion_id_download_filename_get: #{e}"
-end
-```
-
-#### Using the download_file_api_v1_convert_conversion_id_download_filename_get_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Object, Integer, Hash)> download_file_api_v1_convert_conversion_id_download_filename_get_with_http_info(conversion_id, filename)
-
-```ruby
-begin
-  # Download a generated file
-  data, status_code, headers = api_instance.download_file_api_v1_convert_conversion_id_download_filename_get_with_http_info(conversion_id, filename)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Object
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXConversionApi->download_file_api_v1_convert_conversion_id_download_filename_get_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **conversion_id** | **String** | Conversion ID returned by POST /convert (UUID format) |  |
-| **filename** | **String** | File to download: &#39;facturx.pdf&#39; or &#39;facturx.xml&#39; |  |
-
-### Return type
-
-**Object**
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_conversion_status_api_v1_convert_conversion_id_status_get
-
-> Hash&lt;String, Object&gt; get_conversion_status_api_v1_convert_conversion_id_status_get(conversion_id)
-
-Check conversion status
-
-Returns the current status of an asynchronous conversion.
-
-### 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
-conversion_id = 'conversion_id_example' # String | Conversion ID returned by POST /convert (UUID format)
-
-begin
-  # Check conversion status
-  result = api_instance.get_conversion_status_api_v1_convert_conversion_id_status_get(conversion_id)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXConversionApi->get_conversion_status_api_v1_convert_conversion_id_status_get: #{e}"
-end
-```
-
-#### Using the get_conversion_status_api_v1_convert_conversion_id_status_get_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_conversion_status_api_v1_convert_conversion_id_status_get_with_http_info(conversion_id)
-
-```ruby
-begin
-  # Check conversion status
-  data, status_code, headers = api_instance.get_conversion_status_api_v1_convert_conversion_id_status_get_with_http_info(conversion_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXConversionApi->get_conversion_status_api_v1_convert_conversion_id_status_get_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **conversion_id** | **String** | Conversion ID returned by POST /convert (UUID format) |  |
-
-### Return type
-
-**Hash&lt;String, Object&gt;**
-
-### 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)
-
-Resume a conversion with corrections
-
-Resume a conversion after completing missing data or correcting errors.  The OCR extraction is preserved, data is updated with corrections, then a new Schematron validation is performed.
-
-### 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
-conversion_id = 'conversion_id_example' # String | Conversion ID returned by POST /convert (UUID format)
-convert_resume_request = FactPulse::ConvertResumeRequest.new # ConvertResumeRequest | 
-
-begin
-  # Resume a conversion with corrections
-  result = api_instance.resume_conversion_api_v1_convert_conversion_id_resume_post(conversion_id, convert_resume_request)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXConversionApi->resume_conversion_api_v1_convert_conversion_id_resume_post: #{e}"
-end
-```
-
-#### Using the resume_conversion_api_v1_convert_conversion_id_resume_post_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ConvertSuccessResponse>, Integer, Hash)> resume_conversion_api_v1_convert_conversion_id_resume_post_with_http_info(conversion_id, convert_resume_request)
-
-```ruby
-begin
-  # Resume a conversion with corrections
-  data, status_code, headers = api_instance.resume_conversion_api_v1_convert_conversion_id_resume_post_with_http_info(conversion_id, convert_resume_request)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ConvertSuccessResponse>
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXConversionApi->resume_conversion_api_v1_convert_conversion_id_resume_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **conversion_id** | **String** | Conversion ID returned by POST /convert (UUID format) |  |
-| **convert_resume_request** | [**ConvertResumeRequest**](ConvertResumeRequest.md) |  |  |
-
-### Return type
-
-[**ConvertSuccessResponse**](ConvertSuccessResponse.md)
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-

data/docs/FacturXGenerationApi.md

@@ -1,254 +0,0 @@
-# FactPulse::FacturXGenerationApi
-
-All URIs are relative to *https://factpulse.fr*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**generate_invoice_api_v1_processing_generate_invoice_post**](FacturXGenerationApi.md#generate_invoice_api_v1_processing_generate_invoice_post) | **POST** /api/v1/processing/generate-invoice | Generate a Factur-X invoice |
-| [**submit_complete_invoice_api_v1_processing_invoices_submit_complete_post**](FacturXGenerationApi.md#submit_complete_invoice_api_v1_processing_invoices_submit_complete_post) | **POST** /api/v1/processing/invoices/submit-complete | Submit a complete invoice (generation + signature + submission) |
-| [**submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post**](FacturXGenerationApi.md#submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post) | **POST** /api/v1/processing/invoices/submit-complete-async | Submit a complete invoice (asynchronous with Celery) |
-
-
-## generate_invoice_api_v1_processing_generate_invoice_post
-
-> <TaskResponse> generate_invoice_api_v1_processing_generate_invoice_post(invoice_data, opts)
-
-Generate a Factur-X invoice
-
-Generates an electronic invoice in Factur-X format compliant with European standards.  ## Applied Standards  - **Factur-X** (France): FNFE-MPE standard (Forum National de la Facture Électronique) - **ZUGFeRD** (Germany): German format compatible with Factur-X - **EN 16931**: European semantic standard for electronic invoicing - **ISO 19005-3** (PDF/A-3): Long-term electronic archiving - **Cross Industry Invoice (CII)**: UN/CEFACT XML syntax  ## 🆕 New: Simplified format with auto-enrichment (P0.1)  You can now create an invoice by providing only: - An invoice number - A supplier SIRET + **IBAN** (required) - A recipient SIRET - Invoice lines (description, quantity, net price)  **Simplified format example**: ```json {   \"number\": \"FACT-2025-001\",   \"supplier\": {     \"siret\": \"92019522900017\",     \"iban\": \"FR7630001007941234567890185\"   },   \"recipient\": {\"siret\": \"35600000000048\"},   \"lines\": [     {\"description\": \"Service\", \"quantity\": 10, \"unitPrice\": 100.00, \"vatRate\": 20.0}   ] } ```  **⚠️ Required fields (simplified format)**: - `number`: Unique invoice number - `supplier.siret`: Supplier's SIRET (14 digits) - `supplier.iban`: Bank account IBAN (no public API to retrieve it) - `recipient.siret`: Recipient's SIRET - `lines[]`: At least one invoice line  **What happens automatically with `auto_enrich=True`**: - ✅ Name enrichment from Chorus Pro API - ✅ Address enrichment from Business Search API (free, public) - ✅ Automatic intra-EU VAT calculation (FR + key + SIREN) - ✅ Chorus Pro ID retrieval for electronic invoicing - ✅ Net/VAT/Gross totals calculation - ✅ Date generation (today + 30-day due date) - ✅ Multi-rate VAT handling  **Supported identifiers**: - SIRET (14 digits): Specific establishment ⭐ Recommended - SIREN (9 digits): Company (auto-selection of headquarters) - Special types: UE_HORS_FRANCE, RIDET, TAHITI, etc.  ## Checks performed during generation  ### 1. Data validation (Pydantic) - Data types (amounts as Decimal, ISO 8601 dates) - Formats (14-digit SIRET, 9-digit SIREN, IBAN) - Required fields per profile - Amount consistency (Net + VAT = Gross)  ### 2. CII-compliant XML generation - Serialization according to Cross Industry Invoice XSD schema - Correct UN/CEFACT namespaces - Hierarchical structure respected - UTF-8 encoding without BOM  ### 3. Schematron validation - Business rules for selected profile (MINIMUM, BASIC, EN16931, EXTENDED) - Element cardinality (required, optional, repeatable) - Calculation rules (totals, VAT, discounts) - European EN 16931 compliance  ### 4. PDF/A-3 conversion (if output_format='pdf') - Source PDF conversion to PDF/A-3 via Ghostscript - Factur-X XML embedding in PDF - Compliant XMP metadata - ICC sRGB color profile - Removal of forbidden elements (JavaScript, forms)  ## How it works  1. **Submission**: Invoice is queued in Celery for asynchronous processing 2. **Immediate return**: You receive a `task_id` (HTTP 202 Accepted) 3. **Tracking**: Use the `/tasks/{task_id}/status` endpoint to track progress  ## Webhook notification (recommended)  Instead of polling, you can receive a webhook notification when the task completes:  ``` callback_url=https://your-server.com/webhook ```  The webhook will POST a JSON payload with: - `event_type`: `generation.completed` or `generation.failed` - `data.task_id`: The Celery task ID - `data.content_b64` or `data.xml_content`: The generated content - `X-Webhook-Signature` header for HMAC verification  See `/docs/WEBHOOKS.md` for full documentation.  ## Output formats  - **xml**: Generates only Factur-X XML (recommended for testing) - **pdf**: Generates PDF/A-3 with embedded XML (requires `source_pdf`)  ## Factur-X profiles  - **MINIMUM**: Minimal data (simplified invoice) - **BASIC**: Basic information (SMEs) - **EN16931**: European standard (recommended, compliant with directive 2014/55/EU) - **EXTENDED**: All available data (large accounts)  ## What you get  After successful processing (status `completed`): - **XML only**: Base64-encoded Factur-X compliant XML file - **PDF/A-3**: PDF with embedded XML, ready for sending/archiving - **Metadata**: Profile, Factur-X version, file size - **Validation**: Schematron compliance confirmation  ## Validation  Data is automatically validated according to detected format. On error, a 422 status is returned with invalid field details.
-
-### 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::FacturXGenerationApi.new
-invoice_data = 'invoice_data_example' # String | Invoice data in JSON format.              Two formats accepted:             1. **Classic format**: Complete FacturXInvoice structure (all fields)             2. **Simplified format** (🆕 P0.1): Minimal structure with auto-enrichment              Format is detected automatically!             
-opts = {
-  profile: FactPulse::APIProfile::MINIMUM, # APIProfile | Factur-X profile: MINIMUM, BASIC, EN16931 or EXTENDED.
-  output_format: FactPulse::OutputFormat::XML, # OutputFormat | Output format: 'xml' (XML only) or 'pdf' (Factur-X PDF with embedded XML).
-  auto_enrich: true, # Boolean | 🆕 Enable auto-enrichment from SIRET/SIREN (simplified format only)
-  source_pdf: File.new('/path/to/some/file'), # File | 
-  callback_url: 'callback_url_example', # String | 
-  webhook_mode: 'webhook_mode_example', # String | Webhook content delivery: 'inline' (base64 in payload) or 'download_url' (temporary URL, 1h TTL)
-  skip_br_fr: true # Boolean | 
-}
-
-begin
-  # Generate a Factur-X invoice
-  result = api_instance.generate_invoice_api_v1_processing_generate_invoice_post(invoice_data, opts)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXGenerationApi->generate_invoice_api_v1_processing_generate_invoice_post: #{e}"
-end
-```
-
-#### Using the generate_invoice_api_v1_processing_generate_invoice_post_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<TaskResponse>, Integer, Hash)> generate_invoice_api_v1_processing_generate_invoice_post_with_http_info(invoice_data, opts)
-
-```ruby
-begin
-  # Generate a Factur-X invoice
-  data, status_code, headers = api_instance.generate_invoice_api_v1_processing_generate_invoice_post_with_http_info(invoice_data, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <TaskResponse>
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXGenerationApi->generate_invoice_api_v1_processing_generate_invoice_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **invoice_data** | **String** | Invoice data in JSON format.              Two formats accepted:             1. **Classic format**: Complete FacturXInvoice structure (all fields)             2. **Simplified format** (🆕 P0.1): Minimal structure with auto-enrichment              Format is detected automatically!              |  |
-| **profile** | [**APIProfile**](APIProfile.md) | Factur-X profile: MINIMUM, BASIC, EN16931 or EXTENDED. | [optional] |
-| **output_format** | [**OutputFormat**](OutputFormat.md) | Output format: &#39;xml&#39; (XML only) or &#39;pdf&#39; (Factur-X PDF with embedded XML). | [optional] |
-| **auto_enrich** | **Boolean** | 🆕 Enable auto-enrichment from SIRET/SIREN (simplified format only) | [optional][default to true] |
-| **source_pdf** | **File** |  | [optional] |
-| **callback_url** | **String** |  | [optional] |
-| **webhook_mode** | **String** | Webhook content delivery: &#39;inline&#39; (base64 in payload) or &#39;download_url&#39; (temporary URL, 1h TTL) | [optional][default to &#39;inline&#39;] |
-| **skip_br_fr** | **Boolean** |  | [optional] |
-
-### Return type
-
-[**TaskResponse**](TaskResponse.md)
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: multipart/form-data
-- **Accept**: application/json
-
-
-## submit_complete_invoice_api_v1_processing_invoices_submit_complete_post
-
-> <SubmitCompleteInvoiceResponse> submit_complete_invoice_api_v1_processing_invoices_submit_complete_post(submit_complete_invoice_request)
-
-Submit a complete invoice (generation + signature + submission)
-
-Unified endpoint to submit a complete invoice to different destinations.     **Facture prête pour Flux 2** - Génère une facture Factur-X complète avec signature optionnelle et soumission vers Chorus Pro ou PDP AFNOR.      **Automated workflow:**     1. **Auto-enrichment** (optional): retrieves data via public APIs and Chorus Pro/AFNOR     2. **Factur-X PDF generation**: creates a PDF/A-3 with embedded XML     3. **Electronic signature** (optional): signs the PDF with a certificate     4. **Submission**: sends to the chosen destination (Chorus Pro or AFNOR PDP)      **Supported destinations:**     - **Chorus Pro**: French B2G platform (invoices to public sector)     - **AFNOR PDP**: Partner Dematerialization Platforms      **Destination credentials - 2 modes available:**      **Mode 1 - Retrieval via JWT (recommended):**     - Credentials are retrieved automatically via the JWT `client_uid`     - Do not provide the `credentials` field in `destination`     - Zero-trust architecture: no secrets in the payload     - Example: `\"destination\": {\"type\": \"chorus_pro\"}`      **Mode 2 - Credentials in the payload:**     - Provide credentials directly in the payload     - Useful for tests or third-party integrations     - Example: `\"destination\": {\"type\": \"chorus_pro\", \"credentials\": {...}}`       **Electronic signature (optional) - 2 modes available:**      **Mode 1 - Stored certificate (recommended):**     - Certificate is retrieved automatically via the JWT `client_uid`     - No key to provide in the payload     - PAdES-B-LT signature with timestamp (eIDAS compliant)     - Example: `\"signature\": {\"reason\": \"Factur-X compliance\"}`      **Mode 2 - Keys in the payload (for tests):**     - Provide `key_pem` and `cert_pem` directly     - PEM format accepted: raw or base64     - Useful for tests or special cases without stored certificate     - Example: `\"signature\": {\"key_pem\": \"-----BEGIN...\", \"cert_pem\": \"-----BEGIN...\"}`      If `key_pem` and `cert_pem` are provided → Mode 2     Otherwise → Mode 1 (certificate retrieved via `client_uid`)
-
-### 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::FacturXGenerationApi.new
-submit_complete_invoice_request = FactPulse::SubmitCompleteInvoiceRequest.new({invoice_data: FactPulse::SimplifiedInvoiceData.new({number: 'number_example', supplier: { key: 3.56}, recipient: { key: 3.56}, lines: [{ key: 3.56}]}), source_pdf: 'source_pdf_example', destination: FactPulse::AFNORDestination.new}) # SubmitCompleteInvoiceRequest | 
-
-begin
-  # Submit a complete invoice (generation + signature + submission)
-  result = api_instance.submit_complete_invoice_api_v1_processing_invoices_submit_complete_post(submit_complete_invoice_request)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXGenerationApi->submit_complete_invoice_api_v1_processing_invoices_submit_complete_post: #{e}"
-end
-```
-
-#### Using the submit_complete_invoice_api_v1_processing_invoices_submit_complete_post_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<SubmitCompleteInvoiceResponse>, Integer, Hash)> submit_complete_invoice_api_v1_processing_invoices_submit_complete_post_with_http_info(submit_complete_invoice_request)
-
-```ruby
-begin
-  # Submit a complete invoice (generation + signature + submission)
-  data, status_code, headers = api_instance.submit_complete_invoice_api_v1_processing_invoices_submit_complete_post_with_http_info(submit_complete_invoice_request)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <SubmitCompleteInvoiceResponse>
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXGenerationApi->submit_complete_invoice_api_v1_processing_invoices_submit_complete_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **submit_complete_invoice_request** | [**SubmitCompleteInvoiceRequest**](SubmitCompleteInvoiceRequest.md) |  |  |
-
-### Return type
-
-[**SubmitCompleteInvoiceResponse**](SubmitCompleteInvoiceResponse.md)
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post
-
-> <TaskResponse> submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post(submit_complete_invoice_request, opts)
-
-Submit a complete invoice (asynchronous with Celery)
-
-Asynchronous version of the `/invoices/submit-complete` endpoint using Celery for background processing.     **Facture prête pour Flux 2** - Génère une facture Factur-X complète de manière asynchrone.      **Automated workflow (same as synchronous version):**     1. **Auto-enrichment** (optional): retrieves data via public APIs and Chorus Pro/AFNOR     2. **Factur-X PDF generation**: creates a PDF/A-3 with embedded XML     3. **Electronic signature** (optional): signs the PDF with a certificate     4. **Submission**: sends to the chosen destination (Chorus Pro or AFNOR PDP)      **Supported destinations:**     - **Chorus Pro**: French B2G platform (invoices to public sector)     - **AFNOR PDP**: Partner Dematerialization Platforms      **Differences with synchronous version:**     - ✅ **Non-blocking**: Returns immediately with a `task_id` (HTTP 202 Accepted)     - ✅ **Background processing**: Invoice is processed by a Celery worker     - ✅ **Progress tracking**: Use `/tasks/{task_id}/status` to track status     - ✅ **Ideal for high volumes**: Allows processing many invoices in parallel      **How to use:**     1. **Submission**: Call this endpoint with your invoice data     2. **Immediate return**: You receive a `task_id` (e.g., \"abc123-def456\")     3. **Tracking**: Call `/tasks/{task_id}/status` to check progress     4. **Result**: When `status = \"SUCCESS\"`, the `result` field contains the complete response      **Webhook notification (recommended):**      Instead of polling, add `?callback_url=https://your-server.com/webhook` to receive automatic notification:     - `event_type`: `submission.completed`, `submission.failed`, or `submission.partial`     - `data.submission_result`: Complete submission result     - `X-Webhook-Signature` header for HMAC verification      **Credentials and signature**: Same modes as the synchronous version (JWT or payload).
-
-### 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::FacturXGenerationApi.new
-submit_complete_invoice_request = FactPulse::SubmitCompleteInvoiceRequest.new({invoice_data: FactPulse::SimplifiedInvoiceData.new({number: 'number_example', supplier: { key: 3.56}, recipient: { key: 3.56}, lines: [{ key: 3.56}]}), source_pdf: 'source_pdf_example', destination: FactPulse::AFNORDestination.new}) # SubmitCompleteInvoiceRequest | 
-opts = {
-  callback_url: 'callback_url_example', # String | Webhook URL for async notification when submission completes.
-  webhook_mode: 'webhook_mode_example' # String | Webhook content delivery: 'inline' (base64 in payload) or 'download_url' (temporary URL, 1h TTL)
-}
-
-begin
-  # Submit a complete invoice (asynchronous with Celery)
-  result = api_instance.submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post(submit_complete_invoice_request, opts)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXGenerationApi->submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post: #{e}"
-end
-```
-
-#### Using the submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<TaskResponse>, Integer, Hash)> submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post_with_http_info(submit_complete_invoice_request, opts)
-
-```ruby
-begin
-  # Submit a complete invoice (asynchronous with Celery)
-  data, status_code, headers = api_instance.submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post_with_http_info(submit_complete_invoice_request, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <TaskResponse>
-rescue FactPulse::ApiError => e
-  puts "Error when calling FacturXGenerationApi->submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **submit_complete_invoice_request** | [**SubmitCompleteInvoiceRequest**](SubmitCompleteInvoiceRequest.md) |  |  |
-| **callback_url** | **String** | Webhook URL for async notification when submission completes. | [optional] |
-| **webhook_mode** | **String** | Webhook content delivery: &#39;inline&#39; (base64 in payload) or &#39;download_url&#39; (temporary URL, 1h TTL) | [optional][default to &#39;inline&#39;] |
-
-### Return type
-
-[**TaskResponse**](TaskResponse.md)
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-

data/docs/FacturXInvoice.md

@@ -1,76 +0,0 @@
-# FactPulse::FacturXInvoice
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **invoice_number** | **String** |  |  |
-| **payment_due_date** | **String** |  |  |
-| **invoice_date** | **String** |  | [optional] |
-| **submission_mode** | [**SubmissionMode**](SubmissionMode.md) |  | [optional] |
-| **recipient** | [**Recipient**](Recipient.md) |  |  |
-| **supplier** | [**Supplier**](Supplier.md) |  |  |
-| **invoicing_framework** | [**InvoicingFramework**](InvoicingFramework.md) |  |  |
-| **references** | [**InvoiceReferences**](InvoiceReferences.md) |  |  |
-| **totals** | [**InvoiceTotals**](InvoiceTotals.md) |  |  |
-| **invoice_lines** | [**Array<InvoiceLine>**](InvoiceLine.md) |  | [optional] |
-| **vat_lines** | [**Array<VATLine>**](VATLine.md) |  | [optional] |
-| **notes** | [**Array<InvoiceNote>**](InvoiceNote.md) |  | [optional] |
-| **comment** | **String** |  | [optional] |
-| **current_user_id** | **Integer** |  | [optional] |
-| **supplementary_attachments** | [**Array<SupplementaryAttachment>**](SupplementaryAttachment.md) |  | [optional] |
-| **payee** | [**Payee**](Payee.md) |  | [optional] |
-| **delivery_party** | [**DeliveryParty**](DeliveryParty.md) |  | [optional] |
-| **tax_representative** | [**TaxRepresentative**](TaxRepresentative.md) |  | [optional] |
-| **delivery_date** | **String** |  | [optional] |
-| **billing_period_start** | **String** |  | [optional] |
-| **billing_period_end** | **String** |  | [optional] |
-| **payment_reference** | **String** |  | [optional] |
-| **creditor_reference_id** | **String** |  | [optional] |
-| **direct_debit_mandate_id** | **String** |  | [optional] |
-| **debtor_iban** | **String** |  | [optional] |
-| **payment_terms** | **String** |  | [optional] |
-| **allowances_charges** | [**Array<AllowanceCharge>**](AllowanceCharge.md) |  | [optional] |
-| **additional_documents** | [**Array<AdditionalDocument>**](AdditionalDocument.md) |  | [optional] |
-| **buyer_accounting_reference** | **String** |  | [optional] |
-| **payment_card** | [**PaymentCard**](PaymentCard.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::FacturXInvoice.new(
-  invoice_number: null,
-  payment_due_date: null,
-  invoice_date: null,
-  submission_mode: null,
-  recipient: null,
-  supplier: null,
-  invoicing_framework: null,
-  references: null,
-  totals: null,
-  invoice_lines: null,
-  vat_lines: null,
-  notes: null,
-  comment: null,
-  current_user_id: null,
-  supplementary_attachments: null,
-  payee: null,
-  delivery_party: null,
-  tax_representative: null,
-  delivery_date: null,
-  billing_period_start: null,
-  billing_period_end: null,
-  payment_reference: null,
-  creditor_reference_id: null,
-  direct_debit_mandate_id: null,
-  debtor_iban: null,
-  payment_terms: null,
-  allowances_charges: null,
-  additional_documents: null,
-  buyer_accounting_reference: null,
-  payment_card: null
-)
-```
-