factpulse 0.1.0 → 1.0.0

data/docs/ElectronicSignatureApi.md

@@ -1,339 +0,0 @@
-# FactPulse::ElectronicSignatureApi
-
-All URIs are relative to *https://factpulse.fr*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**generate_test_certificate_api_v1_processing_generate_test_certificate_post**](ElectronicSignatureApi.md#generate_test_certificate_api_v1_processing_generate_test_certificate_post) | **POST** /api/v1/processing/generate-test-certificate | Generate a self-signed X.509 test certificate |
-| [**sign_pdf_api_v1_processing_sign_pdf_post**](ElectronicSignatureApi.md#sign_pdf_api_v1_processing_sign_pdf_post) | **POST** /api/v1/processing/sign-pdf | Sign a PDF with client's certificate (PAdES-B-LT) |
-| [**sign_pdf_async_api_v1_processing_sign_pdf_async_post**](ElectronicSignatureApi.md#sign_pdf_async_api_v1_processing_sign_pdf_async_post) | **POST** /api/v1/processing/sign-pdf-async | Sign a PDF asynchronously (Celery) |
-| [**validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post**](ElectronicSignatureApi.md#validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post) | **POST** /api/v1/processing/validate-pdf-signature | Validate electronic signatures of a PDF |
-
-
-## generate_test_certificate_api_v1_processing_generate_test_certificate_post
-
-> <GenerateCertificateResponse> generate_test_certificate_api_v1_processing_generate_test_certificate_post(generate_certificate_request)
-
-Generate a self-signed X.509 test certificate
-
-Generates a self-signed X.509 certificate for PDF electronic signature testing.      **⚠️ WARNING: TEST certificate only!**      This certificate is:     - ✅ Suitable for testing and development     - ✅ Compatible with PDF signing (PAdES)     - ✅ Compliant with eIDAS **SES** level (Simple Electronic Signature)     - ❌ **NEVER usable in production**     - ❌ **Not recognized** by browsers and PDF readers     - ❌ **No legal value**      ## eIDAS levels      - **SES** (Simple): Self-signed certificate ← Generated by this endpoint     - **AdES** (Advanced): Commercial CA certificate (Let's Encrypt, etc.)     - **QES** (Qualified): Qualified certificate from QTSP (CertEurope, Universign, etc.)      ## Usage      Once generated, the certificate can be:      1. **Saved in Django** (recommended):        - Django Admin > Signing Certificates        - Upload `certificate_pem` and `private_key_pem`      2. **Used directly**:        - Sign a PDF with `/sign-pdf`        - The certificate will be automatically used      ## Example call      ```bash     curl -X POST \"https://factpulse.fr/api/v1/processing/generate-test-certificate\" \\       -H \"Authorization: Bearer eyJ0eXAi...\" \\       -H \"Content-Type: application/json\" \\       -d '{         \"cn\": \"Test Client XYZ\",         \"organization\": \"Client XYZ Ltd\",         \"email\": \"contact@xyz.com\",         \"validity_days\": 365       }'     ```      ## Use cases      - PDF signature testing in development     - Electronic signature POC     - Training and demos     - Automated integration tests      ## Technical compliance      Certificate generated with:     - RSA key 2048 or 4096 bits     - SHA-256 algorithm     - Key Usage extensions: `digitalSignature`, `contentCommitment` (non-repudiation)     - Extended Key Usage extensions: `codeSigning`, `emailProtection`     - Validity: 1 day to 10 years (configurable)     - Format: PEM (certificate and key)     - Optional: PKCS#12 (.p12)
-
-### 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::ElectronicSignatureApi.new
-generate_certificate_request = FactPulse::GenerateCertificateRequest.new # GenerateCertificateRequest | 
-
-begin
-  # Generate a self-signed X.509 test certificate
-  result = api_instance.generate_test_certificate_api_v1_processing_generate_test_certificate_post(generate_certificate_request)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling ElectronicSignatureApi->generate_test_certificate_api_v1_processing_generate_test_certificate_post: #{e}"
-end
-```
-
-#### Using the generate_test_certificate_api_v1_processing_generate_test_certificate_post_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<GenerateCertificateResponse>, Integer, Hash)> generate_test_certificate_api_v1_processing_generate_test_certificate_post_with_http_info(generate_certificate_request)
-
-```ruby
-begin
-  # Generate a self-signed X.509 test certificate
-  data, status_code, headers = api_instance.generate_test_certificate_api_v1_processing_generate_test_certificate_post_with_http_info(generate_certificate_request)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <GenerateCertificateResponse>
-rescue FactPulse::ApiError => e
-  puts "Error when calling ElectronicSignatureApi->generate_test_certificate_api_v1_processing_generate_test_certificate_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **generate_certificate_request** | [**GenerateCertificateRequest**](GenerateCertificateRequest.md) |  |  |
-
-### Return type
-
-[**GenerateCertificateResponse**](GenerateCertificateResponse.md)
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## sign_pdf_api_v1_processing_sign_pdf_post
-
-> Object sign_pdf_api_v1_processing_sign_pdf_post(pdf_file, opts)
-
-Sign a PDF with client's certificate (PAdES-B-LT)
-
-Signs an uploaded PDF with the electronic certificate configured for the client (via client_uid from JWT).      **Supported standards**: PAdES-B-B, PAdES-B-T (timestamping), PAdES-B-LT (long-term archiving).      **eIDAS levels**: SES (self-signed), AdES (commercial CA), QES (PSCO - out of scope).      **Security**: Double authentication X-Internal-Secret + JWT Bearer to retrieve the certificate.      **⚠️ Legal disclaimer**: Generated signatures are electronic seals as defined by     the eIDAS regulation. The level of legal validity depends on the certificate used (SES/AdES/QES).     FactPulse does not provide QES qualified certificates - you must obtain a certificate from     a PSCO (qualified Trust Service Provider) for maximum legal validity.
-
-### 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::ElectronicSignatureApi.new
-pdf_file = File.new('/path/to/some/file') # File | PDF file to sign (will be processed and returned signed in base64)
-opts = {
-  reason: 'reason_example', # String | 
-  location: 'location_example', # String | 
-  contact: 'contact_example', # String | 
-  field_name: 'field_name_example', # String | PDF signature field name
-  use_pades_lt: true, # Boolean | Enable PAdES-B-LT (long-term archiving with embedded validation data). REQUIRES a certificate with OCSP/CRL access.
-  use_timestamp: true # Boolean | Enable RFC 3161 timestamping with FreeTSA (PAdES-B-T)
-}
-
-begin
-  # Sign a PDF with client's certificate (PAdES-B-LT)
-  result = api_instance.sign_pdf_api_v1_processing_sign_pdf_post(pdf_file, opts)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling ElectronicSignatureApi->sign_pdf_api_v1_processing_sign_pdf_post: #{e}"
-end
-```
-
-#### Using the sign_pdf_api_v1_processing_sign_pdf_post_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Object, Integer, Hash)> sign_pdf_api_v1_processing_sign_pdf_post_with_http_info(pdf_file, opts)
-
-```ruby
-begin
-  # Sign a PDF with client's certificate (PAdES-B-LT)
-  data, status_code, headers = api_instance.sign_pdf_api_v1_processing_sign_pdf_post_with_http_info(pdf_file, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Object
-rescue FactPulse::ApiError => e
-  puts "Error when calling ElectronicSignatureApi->sign_pdf_api_v1_processing_sign_pdf_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **pdf_file** | **File** | PDF file to sign (will be processed and returned signed in base64) |  |
-| **reason** | **String** |  | [optional] |
-| **location** | **String** |  | [optional] |
-| **contact** | **String** |  | [optional] |
-| **field_name** | **String** | PDF signature field name | [optional][default to &#39;FactPulseSignature&#39;] |
-| **use_pades_lt** | **Boolean** | Enable PAdES-B-LT (long-term archiving with embedded validation data). REQUIRES a certificate with OCSP/CRL access. | [optional][default to false] |
-| **use_timestamp** | **Boolean** | Enable RFC 3161 timestamping with FreeTSA (PAdES-B-T) | [optional][default to true] |
-
-### Return type
-
-**Object**
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: multipart/form-data
-- **Accept**: application/json
-
-
-## sign_pdf_async_api_v1_processing_sign_pdf_async_post
-
-> Object sign_pdf_async_api_v1_processing_sign_pdf_async_post(pdf_file, opts)
-
-Sign a PDF asynchronously (Celery)
-
-Signs an uploaded PDF asynchronously via a Celery task.      **Difference with /sign-pdf**:     - `/sign-pdf`: Synchronous signature (blocking until completion)     - `/sign-pdf-async`: Asynchronous signature (returns immediately with task_id)      **Async advantages**:     - No timeout for large files     - No blocking of FastAPI worker     - Progress tracking via task_id     - Ideal for batch processing      **Supported standards**: PAdES-B-B, PAdES-B-T (timestamping), PAdES-B-LT (long-term archiving).      **⚠️ Legal disclaimer**: Same as /sign-pdf (see that endpoint's documentation).
-
-### 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::ElectronicSignatureApi.new
-pdf_file = File.new('/path/to/some/file') # File | PDF file to sign (processed asynchronously)
-opts = {
-  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)
-  reason: 'reason_example', # String | 
-  location: 'location_example', # String | 
-  contact: 'contact_example', # String | 
-  field_name: 'field_name_example', # String | PDF signature field name
-  use_pades_lt: true, # Boolean | Enable PAdES-B-LT (long-term archiving with embedded validation data). REQUIRES a certificate with OCSP/CRL access.
-  use_timestamp: true # Boolean | Enable RFC 3161 timestamping with FreeTSA (PAdES-B-T)
-}
-
-begin
-  # Sign a PDF asynchronously (Celery)
-  result = api_instance.sign_pdf_async_api_v1_processing_sign_pdf_async_post(pdf_file, opts)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling ElectronicSignatureApi->sign_pdf_async_api_v1_processing_sign_pdf_async_post: #{e}"
-end
-```
-
-#### Using the sign_pdf_async_api_v1_processing_sign_pdf_async_post_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Object, Integer, Hash)> sign_pdf_async_api_v1_processing_sign_pdf_async_post_with_http_info(pdf_file, opts)
-
-```ruby
-begin
-  # Sign a PDF asynchronously (Celery)
-  data, status_code, headers = api_instance.sign_pdf_async_api_v1_processing_sign_pdf_async_post_with_http_info(pdf_file, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Object
-rescue FactPulse::ApiError => e
-  puts "Error when calling ElectronicSignatureApi->sign_pdf_async_api_v1_processing_sign_pdf_async_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **pdf_file** | **File** | PDF file to sign (processed asynchronously) |  |
-| **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;] |
-| **reason** | **String** |  | [optional] |
-| **location** | **String** |  | [optional] |
-| **contact** | **String** |  | [optional] |
-| **field_name** | **String** | PDF signature field name | [optional][default to &#39;FactPulseSignature&#39;] |
-| **use_pades_lt** | **Boolean** | Enable PAdES-B-LT (long-term archiving with embedded validation data). REQUIRES a certificate with OCSP/CRL access. | [optional][default to false] |
-| **use_timestamp** | **Boolean** | Enable RFC 3161 timestamping with FreeTSA (PAdES-B-T) | [optional][default to true] |
-
-### Return type
-
-**Object**
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: multipart/form-data
-- **Accept**: application/json
-
-
-## validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post
-
-> Object validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post(pdf_file)
-
-Validate electronic signatures of a PDF
-
-Validates electronic signatures present in an uploaded PDF.      **Verifications performed**:     - Presence of signatures     - Document integrity (not modified since signing)     - Certificate validity     - Chain of trust (if available)     - Presence of timestamp (PAdES-B-T)     - Validation data (PAdES-B-LT)      **Supported standards**: PAdES-B-B, PAdES-B-T, PAdES-B-LT, ISO 32000-2.      **⚠️ Note**: This validation is technical (cryptographic integrity). Legal validity     depends on the eIDAS level of the certificate (SES/AdES/QES) and the context of use.
-
-### 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::ElectronicSignatureApi.new
-pdf_file = File.new('/path/to/some/file') # File | PDF file to validate (will be analyzed to detect and validate signatures)
-
-begin
-  # Validate electronic signatures of a PDF
-  result = api_instance.validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post(pdf_file)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling ElectronicSignatureApi->validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post: #{e}"
-end
-```
-
-#### Using the validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Object, Integer, Hash)> validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post_with_http_info(pdf_file)
-
-```ruby
-begin
-  # Validate electronic signatures of a PDF
-  data, status_code, headers = api_instance.validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post_with_http_info(pdf_file)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Object
-rescue FactPulse::ApiError => e
-  puts "Error when calling ElectronicSignatureApi->validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **pdf_file** | **File** | PDF file to validate (will be analyzed to detect and validate signatures) |  |
-
-### Return type
-
-**Object**
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: multipart/form-data
-- **Accept**: application/json
-

data/docs/Encaisseamount.md

@@ -1,15 +0,0 @@
-# FactPulse::Encaisseamount
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::Encaisseamount.new()
-```
-

data/docs/Encaisseamount1.md

@@ -1,15 +0,0 @@
-# FactPulse::Encaisseamount1
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::Encaisseamount1.new()
-```
-

data/docs/EncaisseeRequest.md

@@ -1,40 +0,0 @@
-# FactPulse::EncaisseeRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **invoice_id** | **String** | Identifiant de la facture (BT-1) |  |
-| **invoice_issue_date** | **Date** | Date d'émission de la facture (YYYY-MM-DD) |  |
-| **invoice_buyer_siren** | **String** | SIREN de l'acheteur (destinataire du statut) |  |
-| **invoice_buyer_electronic_address** | **String** | Adresse électronique de l'acheteur (MDT-73) |  |
-| **amount** | [**Amount**](Amount.md) |  |  |
-| **currency** | **String** | Code devise ISO 4217 | [optional][default to 'EUR'] |
-| **sender_siren** | **String** |  | [optional] |
-| **flow_type** | **String** | Type de flux (CustomerInvoiceLC pour facture émise) | [optional][default to 'CustomerInvoiceLC'] |
-| **pdp_flow_service_url** | **String** |  | [optional] |
-| **pdp_token_url** | **String** |  | [optional] |
-| **pdp_client_id** | **String** |  | [optional] |
-| **pdp_client_secret** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::EncaisseeRequest.new(
-  invoice_id: null,
-  invoice_issue_date: null,
-  invoice_buyer_siren: null,
-  invoice_buyer_electronic_address: null,
-  amount: null,
-  currency: null,
-  sender_siren: null,
-  flow_type: null,
-  pdp_flow_service_url: null,
-  pdp_token_url: null,
-  pdp_client_id: null,
-  pdp_client_secret: null
-)
-```
-

data/docs/EnrichedInvoiceInfo.md

@@ -1,32 +0,0 @@
-# FactPulse::EnrichedInvoiceInfo
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **invoice_number** | **String** | Invoice number |  |
-| **supplier_id** | **Integer** |  | [optional] |
-| **recipient_id** | **Integer** |  | [optional] |
-| **supplier_name** | **String** | Supplier name |  |
-| **recipient_name** | **String** | Recipient name |  |
-| **total_net_amount** | **String** | Total net amount (HT) |  |
-| **vat_amount** | **String** | VAT amount |  |
-| **total_gross_amount** | **String** | Total gross amount (TTC) |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::EnrichedInvoiceInfo.new(
-  invoice_number: null,
-  supplier_id: null,
-  recipient_id: null,
-  supplier_name: null,
-  recipient_name: null,
-  total_net_amount: null,
-  vat_amount: null,
-  total_gross_amount: null
-)
-```
-

data/docs/ExtractionInfo.md

@@ -1,24 +0,0 @@
-# FactPulse::ExtractionInfo
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **confidence_score** | **Float** | Score de confiance global (0-1) |  |
-| **fields_extracted** | **Integer** | Nombre de champs extraits |  |
-| **fields_enriched** | **Integer** | Nombre de champs enrichis automatiquement | [optional][default to 0] |
-| **fields_missing** | **Integer** | Nombre de champs manquants | [optional][default to 0] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::ExtractionInfo.new(
-  confidence_score: null,
-  fields_extracted: null,
-  fields_enriched: null,
-  fields_missing: null
-)
-```
-