factpulse 0.1.0 → 1.0.0

data/docs/AFNORPDPPAFlowServiceApi.md

@@ -1,22 +1,22 @@
 # FactPulse::AFNORPDPPAFlowServiceApi
 
-All URIs are relative to *https://factpulse.fr*
+All URIs are relative to *http://localhost*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get**](AFNORPDPPAFlowServiceApi.md#download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get) | **GET** /api/v1/afnor/flow/v1/flows/{flowId} | Download a flow |
+| [**download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get**](AFNORPDPPAFlowServiceApi.md#download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get) | **GET** /api/v1/afnor/flow/v1/flows/{flowId} | Télécharger un flux |
 | [**flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get**](AFNORPDPPAFlowServiceApi.md#flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get) | **GET** /api/v1/afnor/flow/v1/healthcheck | Healthcheck Flow Service |
-| [**search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post**](AFNORPDPPAFlowServiceApi.md#search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post) | **POST** /api/v1/afnor/flow/v1/flows/search | Search flows |
-| [**submit_flow_proxy_api_v1_afnor_flow_v1_flows_post**](AFNORPDPPAFlowServiceApi.md#submit_flow_proxy_api_v1_afnor_flow_v1_flows_post) | **POST** /api/v1/afnor/flow/v1/flows | Submit an invoicing flow |
+| [**search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post**](AFNORPDPPAFlowServiceApi.md#search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post) | **POST** /api/v1/afnor/flow/v1/flows/search | Rechercher des flux |
+| [**submit_flow_proxy_api_v1_afnor_flow_v1_flows_post**](AFNORPDPPAFlowServiceApi.md#submit_flow_proxy_api_v1_afnor_flow_v1_flows_post) | **POST** /api/v1/afnor/flow/v1/flows | Soumettre un flux de facturation |
 
 
 ## download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get
 
-> <AFNORFlow> download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get(flow_id, opts)
+> Object download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get(flow_id)
 
-Download a flow
+Télécharger un flux
 
-Download a file related to a given flow (AFNOR XP Z12-013 compliant): - Metadata [Default]: provides the flow metadata as JSON - Original: the document initially sent by the emitter - Converted: the document optionally converted by the system - ReadableView: the document optionally generated as readable file
+Télécharger le fichier PDF/A-3 d'un flux de facturation (utilise le client_uid du JWT)
 
 ### Examples
 
@@ -25,14 +25,11 @@ require 'time'
 require 'factpulse'
 
 api_instance = FactPulse::AFNORPDPPAFlowServiceApi.new
-flow_id = 'flow_id_example' # String | AFNOR flow identifier (UUID)
-opts = {
-  doc_type: FactPulse::DocType::METADATA # DocType | Type of file to download: Metadata (default, JSON), Original, Converted, or ReadableView
-}
+flow_id = 'flow_id_example' # String | 
 
 begin
-  # Download a flow
-  result = api_instance.download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get(flow_id, opts)
+  # Télécharger un flux
+  result = api_instance.download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get(flow_id)
   p result
 rescue FactPulse::ApiError => e
   puts "Error when calling AFNORPDPPAFlowServiceApi->download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get: #{e}"
@@ -43,15 +40,15 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<AFNORFlow>, Integer, Hash)> download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get_with_http_info(flow_id, opts)
+> <Array(Object, Integer, Hash)> download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get_with_http_info(flow_id)
 
 ```ruby
 begin
-  # Download a flow
-  data, status_code, headers = api_instance.download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get_with_http_info(flow_id, opts)
+  # Télécharger un flux
+  data, status_code, headers = api_instance.download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get_with_http_info(flow_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <AFNORFlow>
+  p data # => Object
 rescue FactPulse::ApiError => e
   puts "Error when calling AFNORPDPPAFlowServiceApi->download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get_with_http_info: #{e}"
 end
@@ -61,12 +58,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **flow_id** | **String** | AFNOR flow identifier (UUID) |  |
-| **doc_type** | [**DocType**](.md) | Type of file to download: Metadata (default, JSON), Original, Converted, or ReadableView | [optional] |
+| **flow_id** | **String** |  |  |
 
 ### Return type
 
-[**AFNORFlow**](AFNORFlow.md)
+**Object**
 
 ### Authorization
 
@@ -75,7 +71,7 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: application/json, application/pdf, application/xml
+- **Accept**: application/json, application/pdf
 
 
 ## flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get
@@ -84,7 +80,7 @@ No authorization required
 
 Healthcheck Flow Service
 
-Check Flow Service availability (AFNOR XP Z12-013 compliant)
+Vérifier la disponibilité du Flow Service
 
 ### Examples
 
@@ -141,11 +137,11 @@ No authorization required
 
 ## search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post
 
-> <AFNORSearchFlowContent> search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post(afnor_search_flow_params)
+> Object search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post
 
-Search flows
+Rechercher des flux
 
-Search invoicing flows by criteria (AFNOR XP Z12-013 compliant)
+Rechercher des flux de facturation selon des critères (utilise le client_uid du JWT)
 
 ### Examples
 
@@ -154,11 +150,10 @@ require 'time'
 require 'factpulse'
 
 api_instance = FactPulse::AFNORPDPPAFlowServiceApi.new
-afnor_search_flow_params = FactPulse::AFNORSearchFlowParams.new({where: FactPulse::AFNORSearchFlowFilters.new}) # AFNORSearchFlowParams | 
 
 begin
-  # Search flows
-  result = api_instance.search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post(afnor_search_flow_params)
+  # Rechercher des flux
+  result = api_instance.search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post
   p result
 rescue FactPulse::ApiError => e
   puts "Error when calling AFNORPDPPAFlowServiceApi->search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post: #{e}"
@@ -169,15 +164,15 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<AFNORSearchFlowContent>, Integer, Hash)> search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post_with_http_info(afnor_search_flow_params)
+> <Array(Object, Integer, Hash)> search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post_with_http_info
 
 ```ruby
 begin
-  # Search flows
-  data, status_code, headers = api_instance.search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post_with_http_info(afnor_search_flow_params)
+  # Rechercher des flux
+  data, status_code, headers = api_instance.search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <AFNORSearchFlowContent>
+  p data # => Object
 rescue FactPulse::ApiError => e
   puts "Error when calling AFNORPDPPAFlowServiceApi->search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post_with_http_info: #{e}"
 end
@@ -185,13 +180,11 @@ end
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **afnor_search_flow_params** | [**AFNORSearchFlowParams**](AFNORSearchFlowParams.md) |  |  |
+This endpoint does not need any parameter.
 
 ### Return type
 
-[**AFNORSearchFlowContent**](AFNORSearchFlowContent.md)
+**Object**
 
 ### Authorization
 
@@ -199,17 +192,17 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: Not defined
 - **Accept**: application/json
 
 
 ## submit_flow_proxy_api_v1_afnor_flow_v1_flows_post
 
-> Object submit_flow_proxy_api_v1_afnor_flow_v1_flows_post(flow_info, file)
+> Object submit_flow_proxy_api_v1_afnor_flow_v1_flows_post
 
-Submit an invoicing flow
+Soumettre un flux de facturation
 
-Submits an electronic invoice to a Partner Dematerialization Platform (PDP) in compliance with the AFNOR XP Z12-013 standard
+Soumet une facture électronique à une Plateforme de Dématérialisation Partenaire (PDP) conformément à la norme AFNOR XP Z12-013
 
 ### Examples
 
@@ -218,12 +211,10 @@ require 'time'
 require 'factpulse'
 
 api_instance = FactPulse::AFNORPDPPAFlowServiceApi.new
-flow_info = FactPulse::AFNORFlowInfo.new({flow_syntax: FactPulse::AFNORFlowSyntax::CII}) # AFNORFlowInfo | 
-file = File.new('/path/to/some/file') # File | Flow file (PDF/A-3 with embedded XML or XML)
 
 begin
-  # Submit an invoicing flow
-  result = api_instance.submit_flow_proxy_api_v1_afnor_flow_v1_flows_post(flow_info, file)
+  # Soumettre un flux de facturation
+  result = api_instance.submit_flow_proxy_api_v1_afnor_flow_v1_flows_post
   p result
 rescue FactPulse::ApiError => e
   puts "Error when calling AFNORPDPPAFlowServiceApi->submit_flow_proxy_api_v1_afnor_flow_v1_flows_post: #{e}"
@@ -234,12 +225,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> submit_flow_proxy_api_v1_afnor_flow_v1_flows_post_with_http_info(flow_info, file)
+> <Array(Object, Integer, Hash)> submit_flow_proxy_api_v1_afnor_flow_v1_flows_post_with_http_info
 
 ```ruby
 begin
-  # Submit an invoicing flow
-  data, status_code, headers = api_instance.submit_flow_proxy_api_v1_afnor_flow_v1_flows_post_with_http_info(flow_info, file)
+  # Soumettre un flux de facturation
+  data, status_code, headers = api_instance.submit_flow_proxy_api_v1_afnor_flow_v1_flows_post_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
   p data # => Object
@@ -250,10 +241,7 @@ end
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **flow_info** | [**AFNORFlowInfo**](AFNORFlowInfo.md) |  |  |
-| **file** | **File** | Flow file (PDF/A-3 with embedded XML or XML) |  |
+This endpoint does not need any parameter.
 
 ### Return type
 
@@ -265,6 +253,6 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: multipart/form-data
+- **Content-Type**: Not defined
 - **Accept**: application/json
 

data/docs/APIError.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **error_code** | **String** | Alphanumeric code precisely identifying the error |  |
-| **error_message** | **String** | Message describing the error (not intended for end user) |  |
+| **error_code** | **String** | Code alphanumérique identifiant précisément l'erreur |  |
+| **error_message** | **String** | Message décrivant l'erreur (non destiné à l'utilisateur final) |  |
 | **details** | [**Array<ValidationErrorDetail>**](ValidationErrorDetail.md) |  | [optional] |
 
 ## Example

data/docs/AdresseElectronique.md

@@ -0,0 +1,20 @@
+# FactPulse::AdresseElectronique
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifiant** | **String** |  |  |
+| **scheme_id** | [**SchemeID**](SchemeID.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AdresseElectronique.new(
+  identifiant: null,
+  scheme_id: null
+)
+```
+

data/docs/AdressePostale.md

@@ -0,0 +1,26 @@
+# FactPulse::AdressePostale
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code_postal** | **String** |  | [optional] |
+| **ligne_un** | **String** |  | [optional] |
+| **ligne_deux** | **String** |  | [optional] |
+| **nom_ville** | **String** |  | [optional] |
+| **pays_code_iso** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AdressePostale.new(
+  code_postal: null,
+  ligne_un: null,
+  ligne_deux: null,
+  nom_ville: null,
+  pays_code_iso: null
+)
+```
+

data/docs/CadreDeFacturation.md

@@ -0,0 +1,22 @@
+# FactPulse::CadreDeFacturation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code_cadre_facturation** | [**CodeCadreFacturation**](CodeCadreFacturation.md) |  |  |
+| **code_service_valideur** | **String** |  | [optional] |
+| **code_structure_valideur** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::CadreDeFacturation.new(
+  code_cadre_facturation: null,
+  code_service_valideur: null,
+  code_structure_valideur: null
+)
+```
+

data/docs/CategorieTVA.md

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

data/docs/CertificateInfoResponse.md

@@ -5,17 +5,17 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **cn** | **String** | Common Name |  |
-| **organization** | **String** | Organization |  |
-| **country** | **String** | Country code |  |
-| **city** | **String** | City |  |
-| **state** | **String** | State/Province |  |
+| **organisation** | **String** | Organisation |  |
+| **pays** | **String** | Code pays |  |
+| **ville** | **String** | Ville |  |
+| **province** | **String** | Province |  |
 | **email** | **String** |  | [optional] |
-| **subject** | **String** | Full subject (RFC4514) |  |
-| **issuer** | **String** | Issuer (self-signed = same as subject) |  |
-| **serial_number** | **Integer** | Certificate serial number |  |
-| **valid_from** | **String** | Validity start date (ISO 8601) |  |
-| **valid_to** | **String** | Validity end date (ISO 8601) |  |
-| **algorithm** | **String** | Signature algorithm |  |
+| **sujet** | **String** | Sujet complet (RFC4514) |  |
+| **emetteur** | **String** | Émetteur (auto-signé = même que sujet) |  |
+| **numero_serie** | **Integer** | Numéro de série du certificat |  |
+| **valide_du** | **String** | Date de début de validité (ISO 8601) |  |
+| **valide_au** | **String** | Date de fin de validité (ISO 8601) |  |
+| **algorithme** | **String** | Algorithme de signature |  |
 
 ## Example
 
@@ -24,17 +24,17 @@ require 'factpulse'
 
 instance = FactPulse::CertificateInfoResponse.new(
   cn: Test Signature Client XYZ,
-  organization: Client XYZ SARL,
-  country: FR,
-  city: Lyon,
-  state: Rhone-Alpes,
+  organisation: Client XYZ SARL,
+  pays: FR,
+  ville: Lyon,
+  province: Rhône-Alpes,
   email: null,
-  subject: CN=Test Signature Client XYZ,O=Client XYZ SARL,L=Lyon,ST=Rhone-Alpes,C=FR,
-  issuer: CN=Test Signature Client XYZ,O=Client XYZ SARL,L=Lyon,ST=Rhone-Alpes,C=FR,
-  serial_number: 123456789,
-  valid_from: 2025-01-07T12:00:00+00:00,
-  valid_to: 2026-01-07T12:00:00+00:00,
-  algorithm: sha256WithRSAEncryption
+  sujet: CN=Test Signature Client XYZ,O=Client XYZ SARL,L=Lyon,ST=Rhône-Alpes,C=FR,
+  emetteur: CN=Test Signature Client XYZ,O=Client XYZ SARL,L=Lyon,ST=Rhône-Alpes,C=FR,
+  numero_serie: 123456789,
+  valide_du: 2025-01-07T12:00:00+00:00,
+  valide_au: 2026-01-07T12:00:00+00:00,
+  algorithme: sha256WithRSAEncryption
 )
 ```