factpulse 2.0.42 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18af34c1a63d2c0885f063733c80e707620ba71f3c66715cf745f755cc75257d
-  data.tar.gz: 5dab848c527564367ae0edf9bc1a2528439e921a88b5b535f7f79293a47a25fe
+  metadata.gz: 478a4ac7a831e89b36ec62bdbe1b56d9c64a65f9ee43ed4bb08c84bc15f319db
+  data.tar.gz: 3d21fcc9fde5390be6826dc2031df27828eb6a78e645c9ff921d247730a905a8
 SHA512:
-  metadata.gz: 2b7c3950599e9594d14ca5381c9fe7a9bdfc5bfdd26e290ba6c41288aebbc346eb32e2b2bd8883401e823eaecf2cb9e71dd14f80ea20ea55656a5f3ed6477df4
-  data.tar.gz: 3d2ca6960f92c593a6b4efce60f4e3286bd7dbc3282f91b1049a8e6987e65dd1afb86e787611ec8c7850eb1cf09b6ffe545c73c0a74be77715dfe9a4981c49c6
+  metadata.gz: e66553231193e8e1228db2c1f0e7405b60f69a9f3fb4cf7e26af314973bb7c023d0f8aaa624cd1cf885c22dc8204adca336108c359f9c3454b88c505c5af744e
+  data.tar.gz: cfc636b0d788d240eb12afca134c22d505cb65e03e98cbe3b177fa64127b476637f9eb1d1a5039430102b182153dc8c525255fb65ea05f7cf829bef3c62a1ba2

data/CHANGELOG.md

@@ -7,7 +7,7 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
-## [2.0.42] - 2025-12-16
+## [3.0.0] - 2025-12-19
 
 ### Added
 - Version initiale du SDK ruby
@@ -24,5 +24,5 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Guide d'authentification JWT
 - Configuration avancée (timeout, proxy, debug)
 
-[Unreleased]: https://github.com/factpulse/sdk-ruby/compare/v2.0.42...HEAD
-[2.0.42]: https://github.com/factpulse/sdk-ruby/releases/tag/v2.0.42
+[Unreleased]: https://github.com/factpulse/sdk-ruby/compare/v3.0.0...HEAD
+[3.0.0]: https://github.com/factpulse/sdk-ruby/releases/tag/v3.0.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    factpulse (2.0.42)
+    factpulse (3.0.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -27,7 +27,7 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    psych (5.3.0)
+    psych (5.3.1)
       date
       stringio
     racc (1.8.1)
@@ -55,7 +55,7 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.13.0)
-    stringio (3.1.9)
+    stringio (3.2.0)
     typhoeus (1.5.0)
       ethon (>= 0.9.0, < 0.16.0)
     unicode-display_width (1.5.0)

data/README.md

@@ -1,14 +1,14 @@
 # FactPulse SDK Ruby
 
-Client Ruby officiel pour l'API FactPulse - Facturation électronique française.
+Official Ruby client for the FactPulse API - French electronic invoicing.
 
-## Fonctionnalités
+## Features
 
-- **Factur-X** : Génération et validation de factures électroniques (profils MINIMUM, BASIC, EN16931, EXTENDED)
-- **Chorus Pro** : Intégration avec la plateforme de facturation publique française
-- **AFNOR PDP/PA** : Soumission de flux conformes à la norme XP Z12-013
-- **Signature électronique** : Signature PDF (PAdES-B-B, PAdES-B-T, PAdES-B-LT)
-- **Client simplifié** : Authentification JWT et polling intégrés via `helpers`
+- **Factur-X**: Generation and validation of electronic invoices (MINIMUM, BASIC, EN16931, EXTENDED profiles)
+- **Chorus Pro**: Integration with the French public sector invoicing platform
+- **AFNOR PDP/PA**: Submission of flows compliant with the XP Z12-013 standard
+- **Electronic signature**: PDF signature (PAdES-B-B, PAdES-B-T, PAdES-B-LT)
+- **Simplified client**: JWT authentication and integrated polling via `helpers`
 
 ## Installation
 
@@ -16,15 +16,15 @@ Client Ruby officiel pour l'API FactPulse - Facturation électronique française
 gem install factpulse
 ```
 
-Ou dans votre Gemfile :
+Or in your Gemfile:
 
 ```ruby
 gem 'factpulse'
 ```
 
-## Démarrage rapide
+## Quick Start
 
-Le module `helpers` offre une API simplifiée avec authentification et polling automatiques :
+The `helpers` module provides a simplified API with automatic authentication and polling:
 
 ```ruby
 require 'factpulse'
@@ -32,177 +32,177 @@ require 'factpulse/helpers'
 
 include Factpulse::Helpers
 
-# Créer le client
+# Create the client
 client = FactPulseClient.new(
-  'votre_email@example.com',
-  'votre_mot_de_passe'
+  'your_email@example.com',
+  'your_password'
 )
 
-# Construire la facture avec les helpers
-facture_data = {
-  numeroFacture: 'FAC-2025-001',
-  dateFacture: '2025-01-15',
-  fournisseur: fournisseur(
-    'Mon Entreprise SAS',
+# Build the invoice with helpers
+invoice_data = {
+  number: 'INV-2025-001',
+  date: '2025-01-15',
+  supplier: supplier(
+    'My Company SAS',
     '12345678901234',
-    '123 Rue Example',
+    '123 Example Street',
     '75001',
     'Paris'
   ),
-  destinataire: destinataire(
+  recipient: recipient(
     'Client SARL',
     '98765432109876',
-    '456 Avenue Test',
+    '456 Test Avenue',
     '69001',
     'Lyon'
   ),
-  montantTotal: montant_total(1000.00, 200.00, 1200.00, 1200.00),
-  lignesDePoste: [
-    ligne_de_poste(1, 'Prestation de conseil', 10, 100.00, 1000.00)
+  total_amount: total_amount(1000.00, 200.00, 1200.00, 1200.00),
+  lines: [
+    invoice_line(1, 'Consulting services', 10, 100.00, 1000.00)
   ],
-  lignesDeTva: [
-    ligne_de_tva(1000.00, 200.00)
+  vat_lines: [
+    vat_line(1000.00, 200.00)
   ]
 }
 
-# Générer le PDF Factur-X
-pdf_bytes = client.generer_facturx(facture_data, 'facture_source.pdf', 'EN16931')
+# Generate the Factur-X PDF
+pdf_bytes = client.generate_facturx(invoice_data, 'source_invoice.pdf', 'EN16931')
 
-File.binwrite('facture_facturx.pdf', pdf_bytes)
+File.binwrite('invoice_facturx.pdf', pdf_bytes)
 ```
 
-## Helpers disponibles (module Factpulse::Helpers)
+## Available Helpers (Factpulse::Helpers module)
 
-### montant(value)
+### amount(value)
 
-Convertit une valeur en string formaté pour les montants monétaires.
+Converts a value to a formatted string for monetary amounts.
 
 ```ruby
 include Factpulse::Helpers
 
-montant(1234.5)      # "1234.50"
-montant('1234.56')   # "1234.56"
-montant(nil)         # "0.00"
+amount(1234.5)      # "1234.50"
+amount('1234.56')   # "1234.56"
+amount(nil)         # "0.00"
 ```
 
-### montant_total(ht, tva, ttc, a_payer, ...)
+### total_amount(excluding_tax, vat, including_tax, due, ...)
 
-Crée un objet MontantTotal complet.
+Creates a complete TotalAmount object.
 
 ```ruby
-total = montant_total(
-  1000.00,        # ht
-  200.00,         # tva
-  1200.00,        # ttc
-  1200.00,        # a_payer
-  50.00,          # remise_ttc (optionnel)
-  'Fidélité',     # motif_remise (optionnel)
-  100.00          # acompte (optionnel)
+total = total_amount(
+  1000.00,                  # excluding_tax
+  200.00,                   # vat
+  1200.00,                  # including_tax
+  1200.00,                  # due
+  50.00,                    # discount_including_tax (optional)
+  'Loyalty discount',       # discount_reason (optional)
+  100.00                    # prepayment (optional)
 )
 ```
 
-### ligne_de_poste(numero, denomination, quantite, montant_unitaire_ht, montant_total_ligne_ht, ...)
+### invoice_line(number, description, quantity, unit_price, line_total, ...)
 
-Crée une ligne de facturation.
+Creates an invoice line.
 
 ```ruby
-ligne = ligne_de_poste(
+line = invoice_line(
   1,
-  'Prestation de conseil',
+  'Consulting services',
   5,
   200.00,
-  1000.00,  # montant_total_ligne_ht requis
-  'S',      # categorie_tva: S, Z, E, AE, K
-  'HEURE',  # unite: FORFAIT, PIECE, HEURE, JOUR...
+  1000.00,  # line_total required
+  'S',      # vat_category: S, Z, E, AE, K
+  'HOUR',   # unit: FIXED, PIECE, HOUR, DAY...
   {
-    taux_tva: 'TVA20',        # Ou taux_tva_manuel: '20.00'
+    vat_rate: 'VAT20',        # Or manual_vat_rate: '20.00'
     reference: 'REF-001'
   }
 )
 ```
 
-### ligne_de_tva(montant_base_ht, montant_tva, ...)
+### vat_line(base_excluding_tax, vat_amount, ...)
 
-Crée une ligne de ventilation TVA.
+Creates a VAT breakdown line.
 
 ```ruby
-tva = ligne_de_tva(
-  1000.00,    # montant_base_ht
-  200.00,     # montant_tva
-  'S',        # categorie: S, Z, E, AE, K
-  { taux: 'TVA20' }  # Ou taux_manuel: '20.00'
+vat = vat_line(
+  1000.00,    # base_excluding_tax
+  200.00,     # vat_amount
+  'S',        # category: S, Z, E, AE, K
+  { rate: 'VAT20' }  # Or manual_rate: '20.00'
 )
 ```
 
-### adresse_postale(ligne1, code_postal, ville, ...)
+### postal_address(line1, postal_code, city, ...)
 
-Crée une adresse postale structurée.
+Creates a structured postal address.
 
 ```ruby
-adresse = adresse_postale(
-  '123 Rue de la République',
+address = postal_address(
+  '123 Republic Street',
   '75001',
   'Paris',
-  'FR',           # pays (défaut: 'FR')
-  'Bâtiment A'    # ligne2 (optionnel)
+  'FR',           # country (default: 'FR')
+  'Building A'    # line2 (optional)
 )
 ```
 
-### fournisseur(nom, siret, adresse_ligne1, code_postal, ville, options)
+### supplier(name, siret, address_line1, postal_code, city, options)
 
-Crée un fournisseur complet avec calcul automatique du SIREN et TVA intra.
+Creates a complete supplier with automatic calculation of SIREN and intra-community VAT.
 
 ```ruby
-f = fournisseur(
-  'Ma Société SAS',
+s = supplier(
+  'My Company SAS',
   '12345678901234',
-  '123 Rue Example',
+  '123 Example Street',
   '75001',
   'Paris',
   { iban: 'FR7630006000011234567890189' }
 )
-# SIREN et TVA intracommunautaire calculés automatiquement
+# SIREN and intra-community VAT automatically calculated
 ```
 
-### destinataire(nom, siret, adresse_ligne1, code_postal, ville, options)
+### recipient(name, siret, address_line1, postal_code, city, options)
 
-Crée un destinataire (client) avec calcul automatique du SIREN.
+Creates a recipient (customer) with automatic calculation of SIREN.
 
 ```ruby
-d = destinataire(
+r = recipient(
   'Client SARL',
   '98765432109876',
-  '456 Avenue Test',
+  '456 Test Avenue',
   '69001',
   'Lyon'
 )
 ```
 
-## Mode Zero-Trust (Chorus Pro / AFNOR)
+## Zero-Trust Mode (Chorus Pro / AFNOR)
 
-Pour passer vos propres credentials sans stockage côté serveur :
+To pass your own credentials without server-side storage:
 
 ```ruby
 include Factpulse::Helpers
 
 chorus_creds = ChorusProCredentials.new(
-  'votre_client_id',
-  'votre_client_secret',
-  'votre_login',
-  'votre_password',
+  'your_client_id',
+  'your_client_secret',
+  'your_login',
+  'your_password',
   true  # sandbox
 )
 
 afnor_creds = AFNORCredentials.new(
   'https://api.pdp.fr/flow/v1',
   'https://auth.pdp.fr/oauth/token',
-  'votre_client_id',
-  'votre_client_secret'
+  'your_client_id',
+  'your_client_secret'
 )
 
 client = FactPulseClient.new(
-  'votre_email@example.com',
-  'votre_mot_de_passe',
+  'your_email@example.com',
+  'your_password',
   nil,  # api_url
   nil,  # client_uid
   chorus_creds,
@@ -210,11 +210,11 @@ client = FactPulseClient.new(
 )
 ```
 
-## Ressources
+## Resources
 
-- **Documentation API** : https://factpulse.fr/api/facturation/documentation
-- **Support** : contact@factpulse.fr
+- **API Documentation**: https://factpulse.fr/api/facturation/documentation
+- **Support**: contact@factpulse.fr
 
-## Licence
+## License
 
 MIT License - Copyright (c) 2025 FactPulse

data/docs/{CredentialsAFNOR.md → AFNORCredentials.md}

@@ -1,4 +1,4 @@
-# FactPulse::CredentialsAFNOR
+# FactPulse::AFNORCredentials
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'factpulse'
 
-instance = FactPulse::CredentialsAFNOR.new(
+instance = FactPulse::AFNORCredentials.new(
   client_id: null,
   client_secret: null,
   flow_service_url: null

data/docs/{DestinationAFNOR.md → AFNORDestination.md}

@@ -1,12 +1,12 @@
-# FactPulse::DestinationAFNOR
+# FactPulse::AFNORDestination
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  | [optional][default to 'afnor'] |
-| **credentials** | [**CredentialsAFNOR**](CredentialsAFNOR.md) |  | [optional] |
-| **flow_syntax** | **String** | Syntaxe du flux à envoyer | [optional][default to 'Factur-X'] |
+| **credentials** | [**AFNORCredentials**](AFNORCredentials.md) |  | [optional] |
+| **flow_syntax** | **String** | Flow syntax to send | [optional][default to 'Factur-X'] |
 | **tracking_id** | **String** |  | [optional] |
 
 ## Example
@@ -14,7 +14,7 @@
 ```ruby
 require 'factpulse'
 
-instance = FactPulse::DestinationAFNOR.new(
+instance = FactPulse::AFNORDestination.new(
   type: null,
   credentials: null,
   flow_syntax: null,

data/docs/AFNORHealthCheckResponse.md

@@ -0,0 +1,22 @@
+# FactPulse::AFNORHealthCheckResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flow_service_ok** | **Boolean** | Flow Service API status |  |
+| **directory_service_ok** | **Boolean** | Directory Service API status |  |
+| **message** | **String** | Descriptive status message |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORHealthCheckResponse.new(
+  flow_service_ok: null,
+  directory_service_ok: null,
+  message: null
+)
+```
+

data/docs/AFNORPDPPAApi.md

@@ -4,18 +4,18 @@ All URIs are relative to *http://localhost*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**get_afnor_credentials_api_v1_afnor_credentials_get**](AFNORPDPPAApi.md#get_afnor_credentials_api_v1_afnor_credentials_get) | **GET** /api/v1/afnor/credentials | Récupérer les credentials AFNOR stockés |
-| [**get_flux_entrant_api_v1_afnor_flux_entrants_flow_id_get**](AFNORPDPPAApi.md#get_flux_entrant_api_v1_afnor_flux_entrants_flow_id_get) | **GET** /api/v1/afnor/flux-entrants/{flow_id} | Récupérer et extraire une facture entrante |
-| [**oauth_token_proxy_api_v1_afnor_oauth_token_post**](AFNORPDPPAApi.md#oauth_token_proxy_api_v1_afnor_oauth_token_post) | **POST** /api/v1/afnor/oauth/token | Endpoint OAuth2 pour authentification AFNOR |
+| [**get_afnor_credentials_api_v1_afnor_credentials_get**](AFNORPDPPAApi.md#get_afnor_credentials_api_v1_afnor_credentials_get) | **GET** /api/v1/afnor/credentials | Retrieve stored AFNOR credentials |
+| [**get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get**](AFNORPDPPAApi.md#get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get) | **GET** /api/v1/afnor/incoming-flows/{flow_id} | Retrieve and extract an incoming invoice |
+| [**oauth_token_proxy_api_v1_afnor_oauth_token_post**](AFNORPDPPAApi.md#oauth_token_proxy_api_v1_afnor_oauth_token_post) | **POST** /api/v1/afnor/oauth/token | OAuth2 endpoint for AFNOR authentication |
 
 
 ## get_afnor_credentials_api_v1_afnor_credentials_get
 
 > Object get_afnor_credentials_api_v1_afnor_credentials_get
 
-Récupérer les credentials AFNOR stockés
+Retrieve stored AFNOR credentials
 
-Récupère les credentials AFNOR/PDP stockés pour le client_uid du JWT. Cet endpoint est utilisé par le SDK en mode 'stored' pour récupérer les credentials avant de faire l'OAuth AFNOR lui-même.
+Retrieves stored AFNOR/PDP credentials for the JWT's client_uid. This endpoint is used by the SDK in 'stored' mode to retrieve credentials before performing AFNOR OAuth itself.
 
 ### Examples
 
@@ -31,7 +31,7 @@ end
 api_instance = FactPulse::AFNORPDPPAApi.new
 
 begin
-  # Récupérer les credentials AFNOR stockés
+  # Retrieve stored AFNOR credentials
   result = api_instance.get_afnor_credentials_api_v1_afnor_credentials_get
   p result
 rescue FactPulse::ApiError => e
@@ -47,7 +47,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Récupérer les credentials AFNOR stockés
+  # Retrieve stored AFNOR credentials
   data, status_code, headers = api_instance.get_afnor_credentials_api_v1_afnor_credentials_get_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
@@ -75,13 +75,13 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
-## get_flux_entrant_api_v1_afnor_flux_entrants_flow_id_get
+## get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get
 
-> <FactureEntrante> get_flux_entrant_api_v1_afnor_flux_entrants_flow_id_get(flow_id, opts)
+> <IncomingInvoice> get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get(flow_id, opts)
 
-Récupérer et extraire une facture entrante
+Retrieve and extract an incoming invoice
 
-Télécharge un flux entrant depuis la PDP AFNOR et extrait les métadonnées de la facture vers un format JSON unifié. Supporte les formats Factur-X, CII et UBL.
+Downloads an incoming flow from the AFNOR PDP and extracts invoice metadata into a unified JSON format. Supports Factur-X, CII, and UBL formats.
 
 ### Examples
 
@@ -101,29 +101,29 @@ opts = {
 }
 
 begin
-  # Récupérer et extraire une facture entrante
-  result = api_instance.get_flux_entrant_api_v1_afnor_flux_entrants_flow_id_get(flow_id, opts)
+  # Retrieve and extract an incoming invoice
+  result = api_instance.get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get(flow_id, opts)
   p result
 rescue FactPulse::ApiError => e
-  puts "Error when calling AFNORPDPPAApi->get_flux_entrant_api_v1_afnor_flux_entrants_flow_id_get: #{e}"
+  puts "Error when calling AFNORPDPPAApi->get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get: #{e}"
 end
 ```
 
-#### Using the get_flux_entrant_api_v1_afnor_flux_entrants_flow_id_get_with_http_info variant
+#### Using the get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<FactureEntrante>, Integer, Hash)> get_flux_entrant_api_v1_afnor_flux_entrants_flow_id_get_with_http_info(flow_id, opts)
+> <Array(<IncomingInvoice>, Integer, Hash)> get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get_with_http_info(flow_id, opts)
 
 ```ruby
 begin
-  # Récupérer et extraire une facture entrante
-  data, status_code, headers = api_instance.get_flux_entrant_api_v1_afnor_flux_entrants_flow_id_get_with_http_info(flow_id, opts)
+  # Retrieve and extract an incoming invoice
+  data, status_code, headers = api_instance.get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get_with_http_info(flow_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <FactureEntrante>
+  p data # => <IncomingInvoice>
 rescue FactPulse::ApiError => e
-  puts "Error when calling AFNORPDPPAApi->get_flux_entrant_api_v1_afnor_flux_entrants_flow_id_get_with_http_info: #{e}"
+  puts "Error when calling AFNORPDPPAApi->get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get_with_http_info: #{e}"
 end
 ```
 
@@ -136,7 +136,7 @@ end
 
 ### Return type
 
-[**FactureEntrante**](FactureEntrante.md)
+[**IncomingInvoice**](IncomingInvoice.md)
 
 ### Authorization
 
@@ -152,9 +152,9 @@ end
 
 > Object oauth_token_proxy_api_v1_afnor_oauth_token_post
 
-Endpoint OAuth2 pour authentification AFNOR
+OAuth2 endpoint for AFNOR authentication
 
-Endpoint proxy OAuth2 pour obtenir un token d'accès AFNOR. Fait proxy vers le mock AFNOR (sandbox) ou la vraie PDP selon MOCK_AFNOR_BASE_URL. Cet endpoint est public (pas d'auth Django requise) car il est appelé par le SDK AFNOR.
+OAuth2 proxy endpoint to obtain an AFNOR access token. Proxies to AFNOR mock (sandbox) or real PDP depending on MOCK_AFNOR_BASE_URL. This endpoint is public (no Django auth required) as it is called by the AFNOR SDK.
 
 ### Examples
 
@@ -165,7 +165,7 @@ require 'factpulse'
 api_instance = FactPulse::AFNORPDPPAApi.new
 
 begin
-  # Endpoint OAuth2 pour authentification AFNOR
+  # OAuth2 endpoint for AFNOR authentication
   result = api_instance.oauth_token_proxy_api_v1_afnor_oauth_token_post
   p result
 rescue FactPulse::ApiError => e
@@ -181,7 +181,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Endpoint OAuth2 pour authentification AFNOR
+  # OAuth2 endpoint for AFNOR authentication
   data, status_code, headers = api_instance.oauth_token_proxy_api_v1_afnor_oauth_token_post_with_http_info
   p status_code # => 2xx
   p headers # => { ... }