factpulse 4.0.2 → 4.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed5220794155d6c2396f8f0d804472921e343e24de4da8a14e39e4635ab3140c
-  data.tar.gz: 4e967d6bd2992759be3e9c26e35f78832fb033c84b676166507ecf434d857b7a
+  metadata.gz: 188cc4d264d3d423f55d00dad79f071578f143fe43f66a3758d7131d3d18daec
+  data.tar.gz: fb638e4b1c3223d98b42a30ee953b52d3e745503c245041f4f7d7c5c07ab3bb3
 SHA512:
-  metadata.gz: 24aee2a48d55854a1695d7e4602f05ae00da5f31e567657b3c168610299ee4640594c448e6c4f8f99a87da7308c98e2345bd02e4e9ca7c348afaa345bc717acc
-  data.tar.gz: 1c3ece1e7befab53f5998e15a469064262e9e6aceabe3a7012c4fa478a46309ad9cfb9c966f04141b881c2d43b020d468ebea1d8f5eff412c1cfdcccbcddc6fa
+  metadata.gz: d6a4d89f719dc3119b8cb29434e9887813a1a6f3fbfcb1488ef7da72544720026d5f61621f40d1b96afa76f64e97da6d20e9f4db8be74f69e271abf76a455746
+  data.tar.gz: d3eea42907d09ae0657731478130059c0cc512d765f469cee4f3b67230a5d96f5391daeb3301916d323cb4f09b546363d3634b2b7e724e0fec726e263610bd2d

data/CHANGELOG.md

@@ -7,11 +7,11 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
-## [4.0.2] - 2026-01-24
+## [4.1.2] - 2026-02-24
 
 ### Fixed
-- Meilleures conformité validation/génération erportings
+- api complétude
 
 
-[Unreleased]: https://github.com/factpulse/sdk-ruby/compare/v4.0.2...HEAD
-[4.0.2]: https://github.com/factpulse/sdk-ruby/releases/tag/v4.0.2
+[Unreleased]: https://github.com/factpulse/sdk-ruby/compare/v4.1.2...HEAD
+[4.1.2]: https://github.com/factpulse/sdk-ruby/releases/tag/v4.1.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    factpulse (4.0.2)
+    factpulse (4.1.2)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -18,7 +18,7 @@ GEM
     jaro_winkler (1.5.6)
     method_source (1.1.0)
     parallel (1.27.0)
-    parser (3.3.10.1)
+    parser (3.3.10.2)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -45,7 +45,7 @@ GEM
     rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.6)
+    rspec-support (3.13.7)
     rubocop (0.66.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)

data/README.md

@@ -43,11 +43,13 @@ result = client.post('processing/invoices/submit-complete-async',
   invoiceData: {
     number: 'INV-2025-001',
     supplier: {
+      name: 'ACME Corporation',
       siret: '12345678901234',
       iban: 'FR7630001007941234567890185',
       routing_address: '12345678901234'
     },
     recipient: {
+      name: 'Client Company SA',
       siret: '98765432109876',
       routing_address: '98765432109876'
     },
@@ -198,6 +200,16 @@ rescue FactPulse::Error => e
 end
 ```
 
+## Available Helpers
+
+The SDK provides the following helper classes:
+
+- `FactPulse::Client`: Main HTTP client with auto-auth and polling
+- `FactPulse::Error`: Base exception class
+- `FactPulse::AuthError`: Authentication failure
+- `FactPulse::ValidationError`: Validation errors with details
+- `FactPulse::PollingTimeout`: Task polling timeout
+
 ## Resources
 
 - **API Documentation**: https://factpulse.fr/api/facturation/documentation

data/docs/AFNORErrorDetail.md

@@ -0,0 +1,26 @@
+# FactPulse::AFNORErrorDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **level** | **String** |  |  |
+| **item** | **String** |  |  |
+| **reason** | **String** |  |  |
+| **source** | **String** |  | [optional] |
+| **code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORErrorDetail.new(
+  level: null,
+  item: null,
+  reason: null,
+  source: null,
+  code: null
+)
+```
+

data/docs/AFNORPDPPAApi.md

@@ -23,6 +23,11 @@ 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
@@ -30,7 +35,8 @@ end
 api_instance = FactPulse::AFNORPDPPAApi.new
 flow_id = 'flow_id_example' # String | AFNOR flow ID (UUID format)
 opts = {
-  include_document: true # Boolean | Include base64-encoded document in response
+  include_document: true, # Boolean | Include base64-encoded document in response
+  x_encryption_key: 'x_encryption_key_example' # 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'.
 }
 
 begin
@@ -66,6 +72,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **flow_id** | **String** | AFNOR flow ID (UUID format) |  |
 | **include_document** | **Boolean** | Include base64-encoded document in response | [optional][default to false] |
+| **x_encryption_key** | **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] |
 
 ### Return type
 
@@ -73,7 +80,7 @@ end
 
 ### Authorization
 
-[HTTPBearer](../README.md#HTTPBearer)
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
 
 ### HTTP request headers
 

data/docs/AsyncTasksApi.md

@@ -4,7 +4,158 @@ All URIs are relative to *https://factpulse.fr*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**get_generation_task_status_api_v1_processing_tasks_task_id_generation_status_get**](AsyncTasksApi.md#get_generation_task_status_api_v1_processing_tasks_task_id_generation_status_get) | **GET** /api/v1/processing/tasks/{task_id}/generation-status | Get typed generation task status |
+| [**get_signature_task_status_api_v1_processing_tasks_task_id_signature_status_get**](AsyncTasksApi.md#get_signature_task_status_api_v1_processing_tasks_task_id_signature_status_get) | **GET** /api/v1/processing/tasks/{task_id}/signature-status | Get typed signature task status |
 | [**get_task_status_api_v1_processing_tasks_task_id_status_get**](AsyncTasksApi.md#get_task_status_api_v1_processing_tasks_task_id_status_get) | **GET** /api/v1/processing/tasks/{task_id}/status | Get task generation status |
+| [**get_validation_task_status_api_v1_processing_tasks_task_id_validation_status_get**](AsyncTasksApi.md#get_validation_task_status_api_v1_processing_tasks_task_id_validation_status_get) | **GET** /api/v1/processing/tasks/{task_id}/validation-status | Get typed validation task status |
+
+
+## get_generation_task_status_api_v1_processing_tasks_task_id_generation_status_get
+
+> <GenerationTaskStatus> get_generation_task_status_api_v1_processing_tasks_task_id_generation_status_get(task_id)
+
+Get typed generation task status
+
+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
+
+### 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::AsyncTasksApi.new
+task_id = 'task_id_example' # String | Celery task ID returned by /generate-invoice
+
+begin
+  # Get typed generation task status
+  result = api_instance.get_generation_task_status_api_v1_processing_tasks_task_id_generation_status_get(task_id)
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling AsyncTasksApi->get_generation_task_status_api_v1_processing_tasks_task_id_generation_status_get: #{e}"
+end
+```
+
+#### Using the get_generation_task_status_api_v1_processing_tasks_task_id_generation_status_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GenerationTaskStatus>, Integer, Hash)> get_generation_task_status_api_v1_processing_tasks_task_id_generation_status_get_with_http_info(task_id)
+
+```ruby
+begin
+  # Get typed generation task status
+  data, status_code, headers = api_instance.get_generation_task_status_api_v1_processing_tasks_task_id_generation_status_get_with_http_info(task_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GenerationTaskStatus>
+rescue FactPulse::ApiError => e
+  puts "Error when calling AsyncTasksApi->get_generation_task_status_api_v1_processing_tasks_task_id_generation_status_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_id** | **String** | Celery task ID returned by /generate-invoice |  |
+
+### Return type
+
+[**GenerationTaskStatus**](GenerationTaskStatus.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_signature_task_status_api_v1_processing_tasks_task_id_signature_status_get
+
+> <SignatureTaskStatus> get_signature_task_status_api_v1_processing_tasks_task_id_signature_status_get(task_id)
+
+Get typed signature task status
+
+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
+
+### 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::AsyncTasksApi.new
+task_id = 'task_id_example' # String | Celery task ID returned by /sign-pdf-async
+
+begin
+  # Get typed signature task status
+  result = api_instance.get_signature_task_status_api_v1_processing_tasks_task_id_signature_status_get(task_id)
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling AsyncTasksApi->get_signature_task_status_api_v1_processing_tasks_task_id_signature_status_get: #{e}"
+end
+```
+
+#### Using the get_signature_task_status_api_v1_processing_tasks_task_id_signature_status_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SignatureTaskStatus>, Integer, Hash)> get_signature_task_status_api_v1_processing_tasks_task_id_signature_status_get_with_http_info(task_id)
+
+```ruby
+begin
+  # Get typed signature task status
+  data, status_code, headers = api_instance.get_signature_task_status_api_v1_processing_tasks_task_id_signature_status_get_with_http_info(task_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SignatureTaskStatus>
+rescue FactPulse::ApiError => e
+  puts "Error when calling AsyncTasksApi->get_signature_task_status_api_v1_processing_tasks_task_id_signature_status_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_id** | **String** | Celery task ID returned by /sign-pdf-async |  |
+
+### Return type
+
+[**SignatureTaskStatus**](SignatureTaskStatus.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
 ## get_task_status_api_v1_processing_tasks_task_id_status_get
@@ -22,6 +173,11 @@ 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
@@ -68,7 +224,81 @@ end
 
 ### Authorization
 
-[HTTPBearer](../README.md#HTTPBearer)
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_validation_task_status_api_v1_processing_tasks_task_id_validation_status_get
+
+> <ValidationTaskStatus> get_validation_task_status_api_v1_processing_tasks_task_id_validation_status_get(task_id)
+
+Get typed validation task status
+
+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
+
+### 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::AsyncTasksApi.new
+task_id = 'task_id_example' # String | Celery task ID returned by /validate-pdf
+
+begin
+  # Get typed validation task status
+  result = api_instance.get_validation_task_status_api_v1_processing_tasks_task_id_validation_status_get(task_id)
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling AsyncTasksApi->get_validation_task_status_api_v1_processing_tasks_task_id_validation_status_get: #{e}"
+end
+```
+
+#### Using the get_validation_task_status_api_v1_processing_tasks_task_id_validation_status_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ValidationTaskStatus>, Integer, Hash)> get_validation_task_status_api_v1_processing_tasks_task_id_validation_status_get_with_http_info(task_id)
+
+```ruby
+begin
+  # Get typed validation task status
+  data, status_code, headers = api_instance.get_validation_task_status_api_v1_processing_tasks_task_id_validation_status_get_with_http_info(task_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ValidationTaskStatus>
+rescue FactPulse::ApiError => e
+  puts "Error when calling AsyncTasksApi->get_validation_task_status_api_v1_processing_tasks_task_id_validation_status_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_id** | **String** | Celery task ID returned by /validate-pdf |  |
+
+### Return type
+
+[**ValidationTaskStatus**](ValidationTaskStatus.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
 
 ### HTTP request headers