factpulse 0.1.0 → 1.0.0

data/docs/ReponseValidationSucces.md

@@ -0,0 +1,18 @@
+# FactPulse::ReponseValidationSucces
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Message confirmant la conformité du XML. |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::ReponseValidationSucces.new(
+  message: null
+)
+```
+

data/docs/ResultatAFNOR.md

@@ -0,0 +1,26 @@
+# FactPulse::ResultatAFNOR
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flow_id** | **String** | Identifiant du flux soumis |  |
+| **tracking_id** | **String** |  | [optional] |
+| **sha256** | **String** | Hash SHA-256 du fichier soumis |  |
+| **flow_syntax** | **String** | Syntaxe du flux |  |
+| **flow_profile** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::ResultatAFNOR.new(
+  flow_id: null,
+  tracking_id: null,
+  sha256: null,
+  flow_syntax: null,
+  flow_profile: null
+)
+```
+

data/docs/ResultatChorusPro.md

@@ -0,0 +1,22 @@
+# FactPulse::ResultatChorusPro
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifiant_facture_cpp** | **Integer** | ID Chorus Pro de la facture soumise |  |
+| **numero_flux_depot** | **String** |  | [optional] |
+| **piece_jointe_id** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::ResultatChorusPro.new(
+  identifiant_facture_cpp: null,
+  numero_flux_depot: null,
+  piece_jointe_id: null
+)
+```
+

data/docs/ResultatValidationPDFAPI.md

@@ -0,0 +1,62 @@
+# FactPulse::ResultatValidationPDFAPI
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **est_conforme** | **Boolean** | True si le PDF est conforme à tous les critères (XML, PDF/A, XMP) |  |
+| **xml_present** | **Boolean** | True si un XML Factur-X est embarqué dans le PDF |  |
+| **xml_conforme** | **Boolean** | True si le XML Factur-X est conforme aux règles Schematron |  |
+| **profil_detecte** | **String** |  | [optional] |
+| **erreurs_xml** | **Array<String>** | Liste des erreurs de validation XML | [optional] |
+| **pdfa_conforme** | **Boolean** | True si le PDF est conforme PDF/A |  |
+| **version_pdfa** | **String** |  | [optional] |
+| **methode_validation_pdfa** | **String** | Méthode utilisée pour la validation PDF/A (metadata ou verapdf) | [optional][default to 'metadata'] |
+| **regles_validees** | **Integer** |  | [optional] |
+| **regles_echouees** | **Integer** |  | [optional] |
+| **erreurs_pdfa** | **Array<String>** | Liste des erreurs de conformité PDF/A | [optional] |
+| **avertissements_pdfa** | **Array<String>** | Liste des avertissements PDF/A | [optional] |
+| **xmp_present** | **Boolean** | True si des métadonnées XMP sont présentes |  |
+| **xmp_conforme_facturx** | **Boolean** | True si les métadonnées XMP contiennent des informations Factur-X |  |
+| **profil_xmp** | **String** |  | [optional] |
+| **version_xmp** | **String** |  | [optional] |
+| **erreurs_xmp** | **Array<String>** | Liste des erreurs de métadonnées XMP | [optional] |
+| **metadonnees_xmp** | **Hash<String, Object>** | Métadonnées XMP extraites du PDF | [optional] |
+| **est_signe** | **Boolean** | True si le PDF contient au moins une signature |  |
+| **nombre_signatures** | **Integer** | Nombre de signatures électroniques trouvées | [optional][default to 0] |
+| **signatures** | [**Array<InformationSignatureAPI>**](InformationSignatureAPI.md) | Liste des signatures trouvées avec leurs informations | [optional] |
+| **erreurs_signatures** | **Array<String>** | Liste des erreurs lors de l'analyse des signatures | [optional] |
+| **message_resume** | **String** | Message résumant le résultat de la validation |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::ResultatValidationPDFAPI.new(
+  est_conforme: null,
+  xml_present: null,
+  xml_conforme: null,
+  profil_detecte: null,
+  erreurs_xml: null,
+  pdfa_conforme: null,
+  version_pdfa: null,
+  methode_validation_pdfa: null,
+  regles_validees: null,
+  regles_echouees: null,
+  erreurs_pdfa: null,
+  avertissements_pdfa: null,
+  xmp_present: null,
+  xmp_conforme_facturx: null,
+  profil_xmp: null,
+  version_xmp: null,
+  erreurs_xmp: null,
+  metadonnees_xmp: null,
+  est_signe: null,
+  nombre_signatures: null,
+  signatures: null,
+  erreurs_signatures: null,
+  message_resume: null
+)
+```
+

data/docs/SantApi.md

@@ -0,0 +1,131 @@
+# FactPulse::SantApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**healthcheck_healthcheck_get**](SantApi.md#healthcheck_healthcheck_get) | **GET** /healthcheck | Endpoint de healthcheck pour Docker |
+| [**racine_get**](SantApi.md#racine_get) | **GET** / | Vérifier l'état de l'API |
+
+
+## healthcheck_healthcheck_get
+
+> Object healthcheck_healthcheck_get
+
+Endpoint de healthcheck pour Docker
+
+Endpoint de healthcheck pour Docker et les load balancers.  Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime  Retourne un code 200 si l'API est opérationnelle.
+
+### Examples
+
+```ruby
+require 'time'
+require 'factpulse'
+
+api_instance = FactPulse::SantApi.new
+
+begin
+  # Endpoint de healthcheck pour Docker
+  result = api_instance.healthcheck_healthcheck_get
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling SantApi->healthcheck_healthcheck_get: #{e}"
+end
+```
+
+#### Using the healthcheck_healthcheck_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> healthcheck_healthcheck_get_with_http_info
+
+```ruby
+begin
+  # Endpoint de healthcheck pour Docker
+  data, status_code, headers = api_instance.healthcheck_healthcheck_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue FactPulse::ApiError => e
+  puts "Error when calling SantApi->healthcheck_healthcheck_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## racine_get
+
+> Object racine_get
+
+Vérifier l'état de l'API
+
+Endpoint de health check pour vérifier que l'API répond.  Utile pour : - Monitoring de disponibilité - Tests d'intégration - Load balancers
+
+### Examples
+
+```ruby
+require 'time'
+require 'factpulse'
+
+api_instance = FactPulse::SantApi.new
+
+begin
+  # Vérifier l'état de l'API
+  result = api_instance.racine_get
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling SantApi->racine_get: #{e}"
+end
+```
+
+#### Using the racine_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> racine_get_with_http_info
+
+```ruby
+begin
+  # Vérifier l'état de l'API
+  data, status_code, headers = api_instance.racine_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue FactPulse::ApiError => e
+  puts "Error when calling SantApi->racine_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ServiceStructure.md

@@ -0,0 +1,24 @@
+# FactPulse::ServiceStructure
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id_service** | **Integer** | ID du service |  |
+| **code_service** | **String** | Code du service |  |
+| **libelle_service** | **String** | Libellé du service |  |
+| **est_actif** | **Boolean** | Service actif |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::ServiceStructure.new(
+  id_service: null,
+  code_service: null,
+  libelle_service: null,
+  est_actif: null
+)
+```
+

data/docs/SignatureInfo.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **signed** | **Boolean** | PDF was signed |  |
+| **signe** | **Boolean** | Le PDF a été signé |  |
 | **cn** | **String** |  | [optional] |
 | **expiration** | **String** |  | [optional] |
 
@@ -14,7 +14,7 @@
 require 'factpulse'
 
 instance = FactPulse::SignatureInfo.new(
-  signed: null,
+  signe: null,
   cn: null,
   expiration: null
 )

data/docs/SoumettreFactureCompleteRequest.md

@@ -0,0 +1,26 @@
+# FactPulse::SoumettreFactureCompleteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **donnees_facture** | [**DonneesFactureSimplifiees**](DonneesFactureSimplifiees.md) | Données de la facture au format simplifié (voir exemples) |  |
+| **pdf_source** | **String** | PDF source encodé en base64 (sera transformé en Factur-X) |  |
+| **destination** | [**Destination**](Destination.md) |  |  |
+| **signature** | [**ParametresSignature**](ParametresSignature.md) |  | [optional] |
+| **options** | [**OptionsProcessing**](OptionsProcessing.md) | Options de traitement | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SoumettreFactureCompleteRequest.new(
+  donnees_facture: null,
+  pdf_source: null,
+  destination: null,
+  signature: null,
+  options: null
+)
+```
+

data/docs/SoumettreFactureCompleteResponse.md

@@ -0,0 +1,34 @@
+# FactPulse::SoumettreFactureCompleteResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **succes** | **Boolean** | La facture a été soumise avec succès |  |
+| **destination_type** | **String** | Type de destination |  |
+| **resultat_chorus** | [**ResultatChorusPro**](ResultatChorusPro.md) |  | [optional] |
+| **resultat_afnor** | [**ResultatAFNOR**](ResultatAFNOR.md) |  | [optional] |
+| **facture_enrichie** | [**FactureEnrichieInfo**](FactureEnrichieInfo.md) | Données de la facture enrichie |  |
+| **pdf_facturx** | [**PDFFacturXInfo**](PDFFacturXInfo.md) | Informations sur le PDF généré |  |
+| **signature** | [**SignatureInfo**](SignatureInfo.md) |  | [optional] |
+| **pdf_base64** | **String** | PDF Factur-X généré (et signé si demandé) encodé en base64 |  |
+| **message** | **String** | Message de retour |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SoumettreFactureCompleteResponse.new(
+  succes: null,
+  destination_type: null,
+  resultat_chorus: null,
+  resultat_afnor: null,
+  facture_enrichie: null,
+  pdf_facturx: null,
+  signature: null,
+  pdf_base64: null,
+  message: null
+)
+```
+

data/docs/SoumettreFactureRequest.md

@@ -0,0 +1,46 @@
+# FactPulse::SoumettreFactureRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
+| **numero_facture** | **String** | Numéro de la facture |  |
+| **date_facture** | **String** | Date de facture (format ISO: YYYY-MM-DD) |  |
+| **date_echeance_paiement** | **String** |  | [optional] |
+| **id_structure_cpp** | **Integer** | ID Chorus Pro de la structure destinataire |  |
+| **code_service** | **String** |  | [optional] |
+| **numero_engagement** | **String** |  | [optional] |
+| **montant_ht_total** | [**MontantHtTotal**](MontantHtTotal.md) |  |  |
+| **montant_tva** | [**MontantTva**](MontantTva.md) |  |  |
+| **montant_ttc_total** | [**MontantTtcTotal**](MontantTtcTotal.md) |  |  |
+| **piece_jointe_principale_id** | **Integer** |  | [optional] |
+| **piece_jointe_principale_designation** | **String** |  | [optional] |
+| **commentaire** | **String** |  | [optional] |
+| **numero_bon_commande** | **String** |  | [optional] |
+| **numero_marche** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SoumettreFactureRequest.new(
+  credentials: null,
+  numero_facture: null,
+  date_facture: null,
+  date_echeance_paiement: null,
+  id_structure_cpp: null,
+  code_service: null,
+  numero_engagement: null,
+  montant_ht_total: null,
+  montant_tva: null,
+  montant_ttc_total: null,
+  piece_jointe_principale_id: null,
+  piece_jointe_principale_designation: null,
+  commentaire: null,
+  numero_bon_commande: null,
+  numero_marche: null
+)
+```
+

data/docs/SoumettreFactureResponse.md

@@ -0,0 +1,24 @@
+# FactPulse::SoumettreFactureResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code_retour** | **Integer** | Code retour (0 = succès) |  |
+| **libelle** | **String** | Message de retour |  |
+| **identifiant_facture_cpp** | **Integer** |  | [optional] |
+| **numero_flux_depot** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SoumettreFactureResponse.new(
+  code_retour: null,
+  libelle: null,
+  identifiant_facture_cpp: null,
+  numero_flux_depot: null
+)
+```
+

data/docs/StatutCelery.md

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

data/docs/{InvoiceStatus.md → StatutFacture.md}

@@ -1,11 +1,11 @@
-# FactPulse::InvoiceStatus
+# FactPulse::StatutFacture
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **code** | **String** | Status code (SOUMISE, VALIDEE, REJETEE, SUSPENDUE, MANDATEE, MISE_EN_PAIEMENT, etc.) |  |
-| **label** | **String** | Status label |  |
+| **code** | **String** | Code statut (SOUMISE, VALIDEE, REJETEE, SUSPENDUE, MANDATEE, MISE_EN_PAIEMENT, etc.) |  |
+| **libelle** | **String** | Libellé du statut |  |
 | **date** | **String** |  | [optional] |
 
 ## Example
@@ -13,9 +13,9 @@
 ```ruby
 require 'factpulse'
 
-instance = FactPulse::InvoiceStatus.new(
+instance = FactPulse::StatutFacture.new(
   code: null,
-  label: null,
+  libelle: null,
   date: null
 )
 ```

data/docs/StatutTache.md

@@ -0,0 +1,22 @@
+# FactPulse::StatutTache
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id_tache** | **String** |  |  |
+| **statut** | [**StatutCelery**](StatutCelery.md) | Statut Celery de la tâche (PENDING, STARTED, SUCCESS, FAILURE, RETRY) |  |
+| **resultat** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::StatutTache.new(
+  id_tache: null,
+  statut: null,
+  resultat: null
+)
+```
+

data/docs/StructureInfo.md

@@ -4,11 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **structure_id** | **Integer** | Chorus Pro structure ID |  |
-| **structure_identifier** | **String** | Identifier (SIRET, SIREN) |  |
-| **structure_name** | **String** | Structure name |  |
-| **structure_identifier_type** | **String** | Identifier type |  |
-| **status** | **String** | Status (ACTIVE, INACTIVE) |  |
+| **id_structure_cpp** | **Integer** | ID Chorus Pro de la structure |  |
+| **identifiant_structure** | **String** | Identifiant (SIRET, SIREN) |  |
+| **designation_structure** | **String** | Nom de la structure |  |
+| **type_identifiant_structure** | **String** | Type d'identifiant |  |
+| **statut** | **String** | Statut (ACTIVE, INACTIVE) |  |
 
 ## Example
 
@@ -16,11 +16,11 @@
 require 'factpulse'
 
 instance = FactPulse::StructureInfo.new(
-  structure_id: null,
-  structure_identifier: null,
-  structure_name: null,
-  structure_identifier_type: null,
-  status: null
+  id_structure_cpp: null,
+  identifiant_structure: null,
+  designation_structure: null,
+  type_identifiant_structure: null,
+  statut: null
 )
 ```
 

data/docs/Tauxmanuel.md

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