factpulse 0.1.0 → 1.0.0

data/lib/factpulse/models/convert_success_response.rb

@@ -1,360 +0,0 @@
-=begin
-#FactPulse REST API
-
-# REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures.  ## 🎯 Main Features  ### 📄 Factur-X - Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search)  ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules)  ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification  ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212)  ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments)  ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user  ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro  ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete  ## 🔒 Authentication  All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ```  ### How to obtain a JWT token?  #### 🔑 Method 1: `/api/token/` API (Recommended)  **URL:** `https://factpulse.fr/api/token/`  This method is **recommended** for integration in your applications and CI/CD workflows.  **Prerequisites:** Having set a password on your account  **For users registered via email/password:** - You already have a password, use it directly  **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API  **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\   -H \"Content-Type: application/json\" \\   -d '{     \"username\": \"your_email@example.com\",     \"password\": \"your_password\"   }' ```  **Optional `client_uid` parameter:**  To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`:  ```bash curl -X POST https://factpulse.fr/api/token/ \\   -H \"Content-Type: application/json\" \\   -d '{     \"username\": \"your_email@example.com\",     \"password\": \"your_password\",     \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\"   }' ```  The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client  **Response:** ```json {   \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\",  // Access token (validity: 30 min)   \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\"  // Refresh token (validity: 7 days) } ```  **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool  #### 🖥️ Method 2: Dashboard Generation (Alternative)  **URL:** https://factpulse.fr/api/dashboard/  This method is suitable for quick tests or occasional use via the graphical interface.  **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password  **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan  **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface  **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation  ### 📚 Full Documentation  For more information on authentication and API usage: https://factpulse.fr/documentation-api/     
-
-The version of the OpenAPI document: 1.0.0
-Contact: contact@factpulse.fr
-Generated by: https://openapi-generator.tech
-Generator version: 7.20.0-SNAPSHOT
-
-=end
-
-require 'date'
-require 'time'
-
-module FactPulse
-  # Reponse succes de conversion.  Le champ `invoice` contient les donnees de la facture au format FacturXInvoice (cf. facture_electronique.models.FacturXInvoice). Ce modele est le meme que celui utilise pour la generation Factur-X, garantissant une coherence totale.
-  class ConvertSuccessResponse < ApiModelBase
-    # Statut de la conversion
-    attr_accessor :status
-
-    # Identifiant unique de conversion
-    attr_accessor :conversion_id
-
-    attr_accessor :document_type
-
-    # Donnees facture au format FacturXInvoice (cf. models.py)
-    attr_accessor :invoice
-
-    attr_accessor :extraction
-
-    attr_accessor :validation
-
-    attr_accessor :files
-
-    # Temps de traitement en ms
-    attr_accessor :processing_time_ms
-
-    # True si le PDF a ete regenere (source non exploitable)
-    attr_accessor :pdf_regenerated
-
-    attr_accessor :pdf_regenerated_reason
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'status' => :'status',
-        :'conversion_id' => :'conversion_id',
-        :'document_type' => :'document_type',
-        :'invoice' => :'invoice',
-        :'extraction' => :'extraction',
-        :'validation' => :'validation',
-        :'files' => :'files',
-        :'processing_time_ms' => :'processing_time_ms',
-        :'pdf_regenerated' => :'pdf_regenerated',
-        :'pdf_regenerated_reason' => :'pdf_regenerated_reason'
-      }
-    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
-      {
-        :'status' => :'String',
-        :'conversion_id' => :'String',
-        :'document_type' => :'DocumentTypeInfo',
-        :'invoice' => :'Hash<String, Object>',
-        :'extraction' => :'ExtractionInfo',
-        :'validation' => :'ValidationInfo',
-        :'files' => :'FilesInfo',
-        :'processing_time_ms' => :'Integer',
-        :'pdf_regenerated' => :'Boolean',
-        :'pdf_regenerated_reason' => :'String'
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-        :'pdf_regenerated_reason'
-      ])
-    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::ConvertSuccessResponse` 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::ConvertSuccessResponse`. 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?(:'status')
-        self.status = attributes[:'status']
-      else
-        self.status = 'success'
-      end
-
-      if attributes.key?(:'conversion_id')
-        self.conversion_id = attributes[:'conversion_id']
-      else
-        self.conversion_id = nil
-      end
-
-      if attributes.key?(:'document_type')
-        self.document_type = attributes[:'document_type']
-      else
-        self.document_type = nil
-      end
-
-      if attributes.key?(:'invoice')
-        if (value = attributes[:'invoice']).is_a?(Hash)
-          self.invoice = value
-        end
-      else
-        self.invoice = nil
-      end
-
-      if attributes.key?(:'extraction')
-        self.extraction = attributes[:'extraction']
-      else
-        self.extraction = nil
-      end
-
-      if attributes.key?(:'validation')
-        self.validation = attributes[:'validation']
-      else
-        self.validation = nil
-      end
-
-      if attributes.key?(:'files')
-        self.files = attributes[:'files']
-      else
-        self.files = nil
-      end
-
-      if attributes.key?(:'processing_time_ms')
-        self.processing_time_ms = attributes[:'processing_time_ms']
-      else
-        self.processing_time_ms = nil
-      end
-
-      if attributes.key?(:'pdf_regenerated')
-        self.pdf_regenerated = attributes[:'pdf_regenerated']
-      else
-        self.pdf_regenerated = false
-      end
-
-      if attributes.key?(:'pdf_regenerated_reason')
-        self.pdf_regenerated_reason = attributes[:'pdf_regenerated_reason']
-      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 @conversion_id.nil?
-        invalid_properties.push('invalid value for "conversion_id", conversion_id cannot be nil.')
-      end
-
-      if @document_type.nil?
-        invalid_properties.push('invalid value for "document_type", document_type cannot be nil.')
-      end
-
-      if @invoice.nil?
-        invalid_properties.push('invalid value for "invoice", invoice cannot be nil.')
-      end
-
-      if @extraction.nil?
-        invalid_properties.push('invalid value for "extraction", extraction cannot be nil.')
-      end
-
-      if @validation.nil?
-        invalid_properties.push('invalid value for "validation", validation cannot be nil.')
-      end
-
-      if @files.nil?
-        invalid_properties.push('invalid value for "files", files cannot be nil.')
-      end
-
-      if @processing_time_ms.nil?
-        invalid_properties.push('invalid value for "processing_time_ms", processing_time_ms 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 @conversion_id.nil?
-      return false if @document_type.nil?
-      return false if @invoice.nil?
-      return false if @extraction.nil?
-      return false if @validation.nil?
-      return false if @files.nil?
-      return false if @processing_time_ms.nil?
-      true
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] conversion_id Value to be assigned
-    def conversion_id=(conversion_id)
-      if conversion_id.nil?
-        fail ArgumentError, 'conversion_id cannot be nil'
-      end
-
-      @conversion_id = conversion_id
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] document_type Value to be assigned
-    def document_type=(document_type)
-      if document_type.nil?
-        fail ArgumentError, 'document_type cannot be nil'
-      end
-
-      @document_type = document_type
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] invoice Value to be assigned
-    def invoice=(invoice)
-      if invoice.nil?
-        fail ArgumentError, 'invoice cannot be nil'
-      end
-
-      @invoice = invoice
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] extraction Value to be assigned
-    def extraction=(extraction)
-      if extraction.nil?
-        fail ArgumentError, 'extraction cannot be nil'
-      end
-
-      @extraction = extraction
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] validation Value to be assigned
-    def validation=(validation)
-      if validation.nil?
-        fail ArgumentError, 'validation cannot be nil'
-      end
-
-      @validation = validation
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] files Value to be assigned
-    def files=(files)
-      if files.nil?
-        fail ArgumentError, 'files cannot be nil'
-      end
-
-      @files = files
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] processing_time_ms Value to be assigned
-    def processing_time_ms=(processing_time_ms)
-      if processing_time_ms.nil?
-        fail ArgumentError, 'processing_time_ms cannot be nil'
-      end
-
-      @processing_time_ms = processing_time_ms
-    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 &&
-          status == o.status &&
-          conversion_id == o.conversion_id &&
-          document_type == o.document_type &&
-          invoice == o.invoice &&
-          extraction == o.extraction &&
-          validation == o.validation &&
-          files == o.files &&
-          processing_time_ms == o.processing_time_ms &&
-          pdf_regenerated == o.pdf_regenerated &&
-          pdf_regenerated_reason == o.pdf_regenerated_reason
-    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
-      [status, conversion_id, document_type, invoice, extraction, validation, files, processing_time_ms, pdf_regenerated, pdf_regenerated_reason].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