factpulse 0.1.0 → 1.0.0

data/lib/factpulse/models/soumettre_facture_complete_response.rb

@@ -0,0 +1,355 @@
+=begin
+#API REST FactPulse
+
+# API REST pour la facturation électronique en France : Factur-X, AFNOR PDP/PA, signatures électroniques.  ## 🎯 Fonctionnalités principales  ### 📄 Génération de factures Factur-X - **Formats** : XML seul ou PDF/A-3 avec XML embarqué - **Profils** : MINIMUM, BASIC, EN16931, EXTENDED - **Normes** : EN 16931 (directive UE 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Format simplifié** : Génération à partir de SIRET + auto-enrichissement (API Chorus Pro + Recherche Entreprises)  ### ✅ Validation et conformité - **Validation XML** : Schematron (45 à 210+ règles selon profil) - **Validation PDF** : PDF/A-3, métadonnées XMP Factur-X, signatures électroniques - **VeraPDF** : Validation stricte PDF/A (146+ règles ISO 19005-3) - **Traitement asynchrone** : Support Celery pour validations lourdes (VeraPDF)  ### 📡 Intégration AFNOR PDP/PA (XP Z12-013) - **Soumission de flux** : Envoi de factures vers Plateformes de Dématérialisation Partenaires - **Recherche de flux** : Consultation des factures soumises - **Téléchargement** : Récupération des PDF/A-3 avec XML - **Directory Service** : Recherche d'entreprises (SIREN/SIRET) - **Multi-client** : Support de plusieurs configs PDP par utilisateur (stored credentials ou zero-storage)  ### ✍️ Signature électronique PDF - **Standards** : PAdES-B-B, PAdES-B-T (horodatage RFC 3161), PAdES-B-LT (archivage long terme) - **Niveaux eIDAS** : SES (auto-signé), AdES (CA commerciale), QES (PSCO) - **Validation** : Vérification intégrité cryptographique et certificats - **Génération de certificats** : Certificats X.509 auto-signés pour tests  ### 🔄 Traitement asynchrone - **Celery** : Génération, validation et signature asynchrones - **Polling** : Suivi d'état via `/taches/{id_tache}/statut` - **Pas de timeout** : Idéal pour gros fichiers ou validations lourdes  ## 🔒 Authentification  Toutes les requêtes nécessitent un **token JWT** dans le header Authorization : ``` Authorization: Bearer YOUR_JWT_TOKEN ```  ### Comment obtenir un token JWT ?  #### 🔑 Méthode 1 : API `/api/token/` (Recommandée)  **URL :** `https://www.factpulse.fr/api/token/`  Cette méthode est **recommandée** pour l'intégration dans vos applications et workflows CI/CD.  **Prérequis :** Avoir défini un mot de passe sur votre compte  **Pour les utilisateurs inscrits via email/password :** - Vous avez déjà un mot de passe, utilisez-le directement  **Pour les utilisateurs inscrits via OAuth (Google/GitHub) :** - Vous devez d'abord définir un mot de passe sur : https://www.factpulse.fr/accounts/password/set/ - Une fois le mot de passe créé, vous pourrez utiliser l'API  **Exemple de requête :** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\   -H \"Content-Type: application/json\" \\   -d '{     \"username\": \"votre_email@example.com\",     \"password\": \"votre_mot_de_passe\"   }' ```  **Paramètre optionnel `client_uid` :**  Pour sélectionner les credentials d'un client spécifique (PA/PDP, Chorus Pro, certificats de signature), ajoutez `client_uid` :  ```bash curl -X POST https://www.factpulse.fr/api/token/ \\   -H \"Content-Type: application/json\" \\   -d '{     \"username\": \"votre_email@example.com\",     \"password\": \"votre_mot_de_passe\",     \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\"   }' ```  Le `client_uid` sera inclus dans le JWT et permettra à l'API d'utiliser automatiquement : - Les credentials AFNOR/PDP configurés pour ce client - Les credentials Chorus Pro configurés pour ce client - Les certificats de signature électronique configurés pour ce client  **Réponse :** ```json {   \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\",  // Token d'accès (validité: 30 min)   \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\"  // Token de rafraîchissement (validité: 7 jours) } ```  **Avantages :** - ✅ Automatisation complète (CI/CD, scripts) - ✅ Gestion programmatique des tokens - ✅ Support du refresh token pour renouveler automatiquement l'accès - ✅ Intégration facile dans n'importe quel langage/outil  #### 🖥️ Méthode 2 : Génération via Dashboard (Alternative)  **URL :** https://www.factpulse.fr/dashboard/  Cette méthode convient pour des tests rapides ou une utilisation occasionnelle via l'interface graphique.  **Fonctionnement :** - Connectez-vous au dashboard - Utilisez les boutons \"Generate Test Token\" ou \"Generate Production Token\" - Fonctionne pour **tous** les utilisateurs (OAuth et email/password), sans nécessiter de mot de passe  **Types de tokens :** - **Token Test** : Validité 24h, quota 1000 appels/jour (gratuit) - **Token Production** : Validité 7 jours, quota selon votre forfait  **Avantages :** - ✅ Rapide pour tester l'API - ✅ Aucun mot de passe requis - ✅ Interface visuelle simple  **Inconvénients :** - ❌ Nécessite une action manuelle - ❌ Pas de refresh token - ❌ Moins adapté pour l'automatisation  ### 📚 Documentation complète  Pour plus d'informations sur l'authentification et l'utilisation de l'API : https://www.factpulse.fr/documentation-api/     
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.18.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module FactPulse
+  # Réponse complète après soumission automatisée.
+  class SoumettreFactureCompleteResponse < ApiModelBase
+    # La facture a été soumise avec succès
+    attr_accessor :succes
+
+    # Type de destination
+    attr_accessor :destination_type
+
+    attr_accessor :resultat_chorus
+
+    attr_accessor :resultat_afnor
+
+    # Données de la facture enrichie
+    attr_accessor :facture_enrichie
+
+    # Informations sur le PDF généré
+    attr_accessor :pdf_facturx
+
+    attr_accessor :signature
+
+    # PDF Factur-X généré (et signé si demandé) encodé en base64
+    attr_accessor :pdf_base64
+
+    # Message de retour
+    attr_accessor :message
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'succes' => :'succes',
+        :'destination_type' => :'destination_type',
+        :'resultat_chorus' => :'resultat_chorus',
+        :'resultat_afnor' => :'resultat_afnor',
+        :'facture_enrichie' => :'facture_enrichie',
+        :'pdf_facturx' => :'pdf_facturx',
+        :'signature' => :'signature',
+        :'pdf_base64' => :'pdf_base64',
+        :'message' => :'message'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'succes' => :'Boolean',
+        :'destination_type' => :'String',
+        :'resultat_chorus' => :'ResultatChorusPro',
+        :'resultat_afnor' => :'ResultatAFNOR',
+        :'facture_enrichie' => :'FactureEnrichieInfo',
+        :'pdf_facturx' => :'PDFFacturXInfo',
+        :'signature' => :'SignatureInfo',
+        :'pdf_base64' => :'String',
+        :'message' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'resultat_chorus',
+        :'resultat_afnor',
+        :'signature',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::SoumettreFactureCompleteResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::SoumettreFactureCompleteResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'succes')
+        self.succes = attributes[:'succes']
+      else
+        self.succes = nil
+      end
+
+      if attributes.key?(:'destination_type')
+        self.destination_type = attributes[:'destination_type']
+      else
+        self.destination_type = nil
+      end
+
+      if attributes.key?(:'resultat_chorus')
+        self.resultat_chorus = attributes[:'resultat_chorus']
+      end
+
+      if attributes.key?(:'resultat_afnor')
+        self.resultat_afnor = attributes[:'resultat_afnor']
+      end
+
+      if attributes.key?(:'facture_enrichie')
+        self.facture_enrichie = attributes[:'facture_enrichie']
+      else
+        self.facture_enrichie = nil
+      end
+
+      if attributes.key?(:'pdf_facturx')
+        self.pdf_facturx = attributes[:'pdf_facturx']
+      else
+        self.pdf_facturx = nil
+      end
+
+      if attributes.key?(:'signature')
+        self.signature = attributes[:'signature']
+      end
+
+      if attributes.key?(:'pdf_base64')
+        self.pdf_base64 = attributes[:'pdf_base64']
+      else
+        self.pdf_base64 = nil
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      else
+        self.message = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @succes.nil?
+        invalid_properties.push('invalid value for "succes", succes cannot be nil.')
+      end
+
+      if @destination_type.nil?
+        invalid_properties.push('invalid value for "destination_type", destination_type cannot be nil.')
+      end
+
+      if @facture_enrichie.nil?
+        invalid_properties.push('invalid value for "facture_enrichie", facture_enrichie cannot be nil.')
+      end
+
+      if @pdf_facturx.nil?
+        invalid_properties.push('invalid value for "pdf_facturx", pdf_facturx cannot be nil.')
+      end
+
+      if @pdf_base64.nil?
+        invalid_properties.push('invalid value for "pdf_base64", pdf_base64 cannot be nil.')
+      end
+
+      if @message.nil?
+        invalid_properties.push('invalid value for "message", message cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @succes.nil?
+      return false if @destination_type.nil?
+      destination_type_validator = EnumAttributeValidator.new('String', ["chorus_pro", "afnor"])
+      return false unless destination_type_validator.valid?(@destination_type)
+      return false if @facture_enrichie.nil?
+      return false if @pdf_facturx.nil?
+      return false if @pdf_base64.nil?
+      return false if @message.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] succes Value to be assigned
+    def succes=(succes)
+      if succes.nil?
+        fail ArgumentError, 'succes cannot be nil'
+      end
+
+      @succes = succes
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] destination_type Object to be assigned
+    def destination_type=(destination_type)
+      validator = EnumAttributeValidator.new('String', ["chorus_pro", "afnor"])
+      unless validator.valid?(destination_type)
+        fail ArgumentError, "invalid value for \"destination_type\", must be one of #{validator.allowable_values}."
+      end
+      @destination_type = destination_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] facture_enrichie Value to be assigned
+    def facture_enrichie=(facture_enrichie)
+      if facture_enrichie.nil?
+        fail ArgumentError, 'facture_enrichie cannot be nil'
+      end
+
+      @facture_enrichie = facture_enrichie
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pdf_facturx Value to be assigned
+    def pdf_facturx=(pdf_facturx)
+      if pdf_facturx.nil?
+        fail ArgumentError, 'pdf_facturx cannot be nil'
+      end
+
+      @pdf_facturx = pdf_facturx
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pdf_base64 Value to be assigned
+    def pdf_base64=(pdf_base64)
+      if pdf_base64.nil?
+        fail ArgumentError, 'pdf_base64 cannot be nil'
+      end
+
+      @pdf_base64 = pdf_base64
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] message Value to be assigned
+    def message=(message)
+      if message.nil?
+        fail ArgumentError, 'message cannot be nil'
+      end
+
+      @message = message
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          succes == o.succes &&
+          destination_type == o.destination_type &&
+          resultat_chorus == o.resultat_chorus &&
+          resultat_afnor == o.resultat_afnor &&
+          facture_enrichie == o.facture_enrichie &&
+          pdf_facturx == o.pdf_facturx &&
+          signature == o.signature &&
+          pdf_base64 == o.pdf_base64 &&
+          message == o.message
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [succes, destination_type, resultat_chorus, resultat_afnor, facture_enrichie, pdf_facturx, signature, pdf_base64, message].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end