factpulse 3.0.37 → 4.0.1

data/lib/factpulse/models/simplified_cdar_response.rb

@@ -0,0 +1,274 @@
+=begin
+#FactPulse REST API
+
+# REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures.  ## 🎯 Main Features  ### 📄 Factur-X Invoice 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)  ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF)  ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage)  ### ✍️ PDF 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 - **Certificate Generation**: Self-signed X.509 certificates for testing  ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations  ## 🔒 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
+  # Réponse pour les endpoints CDAR simplifiés.
+  class SimplifiedCDARResponse < ApiModelBase
+    # Identifiant du flux AFNOR
+    attr_accessor :flow_id
+
+    # Identifiant du message CDAR généré
+    attr_accessor :document_id
+
+    # Code statut soumis (210 ou 212)
+    attr_accessor :status
+
+    # Identifiant de la facture
+    attr_accessor :invoice_id
+
+    # Message de confirmation
+    attr_accessor :message
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'flow_id' => :'flowId',
+        :'document_id' => :'documentId',
+        :'status' => :'status',
+        :'invoice_id' => :'invoiceId',
+        :'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
+      {
+        :'flow_id' => :'String',
+        :'document_id' => :'String',
+        :'status' => :'String',
+        :'invoice_id' => :'String',
+        :'message' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::SimplifiedCDARResponse` 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::SimplifiedCDARResponse`. 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?(:'flow_id')
+        self.flow_id = attributes[:'flow_id']
+      else
+        self.flow_id = nil
+      end
+
+      if attributes.key?(:'document_id')
+        self.document_id = attributes[:'document_id']
+      else
+        self.document_id = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'invoice_id')
+        self.invoice_id = attributes[:'invoice_id']
+      else
+        self.invoice_id = 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 @flow_id.nil?
+        invalid_properties.push('invalid value for "flow_id", flow_id cannot be nil.')
+      end
+
+      if @document_id.nil?
+        invalid_properties.push('invalid value for "document_id", document_id cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @invoice_id.nil?
+        invalid_properties.push('invalid value for "invoice_id", invoice_id 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 @flow_id.nil?
+      return false if @document_id.nil?
+      return false if @status.nil?
+      return false if @invoice_id.nil?
+      return false if @message.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] flow_id Value to be assigned
+    def flow_id=(flow_id)
+      if flow_id.nil?
+        fail ArgumentError, 'flow_id cannot be nil'
+      end
+
+      @flow_id = flow_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] document_id Value to be assigned
+    def document_id=(document_id)
+      if document_id.nil?
+        fail ArgumentError, 'document_id cannot be nil'
+      end
+
+      @document_id = document_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'status cannot be nil'
+      end
+
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] invoice_id Value to be assigned
+    def invoice_id=(invoice_id)
+      if invoice_id.nil?
+        fail ArgumentError, 'invoice_id cannot be nil'
+      end
+
+      @invoice_id = invoice_id
+    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 &&
+          flow_id == o.flow_id &&
+          document_id == o.document_id &&
+          status == o.status &&
+          invoice_id == o.invoice_id &&
+          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
+      [flow_id, document_id, status, invoice_id, 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

data/lib/factpulse/models/simplified_invoice_data.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: contact@factpulse.fr
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0-SNAPSHOT
+Generator version: 7.20.0-SNAPSHOT
 
 =end
 

data/lib/factpulse/models/status_code_info.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: contact@factpulse.fr
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0-SNAPSHOT
+Generator version: 7.20.0-SNAPSHOT
 
 =end
 

data/lib/factpulse/models/status_codes_response.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: contact@factpulse.fr
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0-SNAPSHOT
+Generator version: 7.20.0-SNAPSHOT
 
 =end
 

data/lib/factpulse/models/structure_info.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: contact@factpulse.fr
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0-SNAPSHOT
+Generator version: 7.20.0-SNAPSHOT
 
 =end
 

data/lib/factpulse/models/structure_parameters.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: contact@factpulse.fr
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0-SNAPSHOT
+Generator version: 7.20.0-SNAPSHOT
 
 =end
 

data/lib/factpulse/models/structure_service.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: contact@factpulse.fr
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0-SNAPSHOT
+Generator version: 7.20.0-SNAPSHOT
 
 =end
 

data/lib/factpulse/models/submission_mode.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: contact@factpulse.fr
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0-SNAPSHOT
+Generator version: 7.20.0-SNAPSHOT
 
 =end
 

data/lib/factpulse/models/submit_aggregated_report_request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: contact@factpulse.fr
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0-SNAPSHOT
+Generator version: 7.20.0-SNAPSHOT
 
 =end
 

data/lib/factpulse/models/submit_cdar_request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: contact@factpulse.fr
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0-SNAPSHOT
+Generator version: 7.20.0-SNAPSHOT
 
 =end
 
@@ -65,6 +65,14 @@ module FactPulse
     # Type de flux AFNOR (CustomerInvoiceLC, SupplierInvoiceLC, etc.)
     attr_accessor :flow_type
 
+    attr_accessor :pdp_flow_service_url
+
+    attr_accessor :pdp_token_url
+
+    attr_accessor :pdp_client_id
+
+    attr_accessor :pdp_client_secret
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -86,7 +94,11 @@ module FactPulse
         :'reason_text' => :'reasonText',
         :'action_code' => :'actionCode',
         :'encaisse_amount' => :'encaisseAmount',
-        :'flow_type' => :'flowType'
+        :'flow_type' => :'flowType',
+        :'pdp_flow_service_url' => :'pdpFlowServiceUrl',
+        :'pdp_token_url' => :'pdpTokenUrl',
+        :'pdp_client_id' => :'pdpClientId',
+        :'pdp_client_secret' => :'pdpClientSecret'
       }
     end
 
@@ -121,7 +133,11 @@ module FactPulse
         :'reason_text' => :'String',
         :'action_code' => :'String',
         :'encaisse_amount' => :'Encaisseamount',
-        :'flow_type' => :'String'
+        :'flow_type' => :'String',
+        :'pdp_flow_service_url' => :'String',
+        :'pdp_token_url' => :'String',
+        :'pdp_client_id' => :'String',
+        :'pdp_client_secret' => :'String'
       }
     end
 
@@ -136,6 +152,10 @@ module FactPulse
         :'reason_text',
         :'action_code',
         :'encaisse_amount',
+        :'pdp_flow_service_url',
+        :'pdp_token_url',
+        :'pdp_client_id',
+        :'pdp_client_secret'
       ])
     end
 
@@ -252,6 +272,22 @@ module FactPulse
       else
         self.flow_type = 'CustomerInvoiceLC'
       end
+
+      if attributes.key?(:'pdp_flow_service_url')
+        self.pdp_flow_service_url = attributes[:'pdp_flow_service_url']
+      end
+
+      if attributes.key?(:'pdp_token_url')
+        self.pdp_token_url = attributes[:'pdp_token_url']
+      end
+
+      if attributes.key?(:'pdp_client_id')
+        self.pdp_client_id = attributes[:'pdp_client_id']
+      end
+
+      if attributes.key?(:'pdp_client_secret')
+        self.pdp_client_secret = attributes[:'pdp_client_secret']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -367,7 +403,11 @@ module FactPulse
           reason_text == o.reason_text &&
           action_code == o.action_code &&
           encaisse_amount == o.encaisse_amount &&
-          flow_type == o.flow_type
+          flow_type == o.flow_type &&
+          pdp_flow_service_url == o.pdp_flow_service_url &&
+          pdp_token_url == o.pdp_token_url &&
+          pdp_client_id == o.pdp_client_id &&
+          pdp_client_secret == o.pdp_client_secret
     end
 
     # @see the `==` method
@@ -379,7 +419,7 @@ module FactPulse
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [document_id, business_process, type_code, sender_siren, sender_role, sender_name, sender_email, recipients, invoice_id, invoice_issue_date, invoice_type_code, invoice_seller_siren, invoice_buyer_siren, status, reason_code, reason_text, action_code, encaisse_amount, flow_type].hash
+      [document_id, business_process, type_code, sender_siren, sender_role, sender_name, sender_email, recipients, invoice_id, invoice_issue_date, invoice_type_code, invoice_seller_siren, invoice_buyer_siren, status, reason_code, reason_text, action_code, encaisse_amount, flow_type, pdp_flow_service_url, pdp_token_url, pdp_client_id, pdp_client_secret].hash
     end
 
     # Builds the object from hash

data/lib/factpulse/models/submit_cdar_response.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: contact@factpulse.fr
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0-SNAPSHOT
+Generator version: 7.20.0-SNAPSHOT
 
 =end
 

data/lib/factpulse/models/submit_cdarxml_request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: contact@factpulse.fr
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0-SNAPSHOT
+Generator version: 7.20.0-SNAPSHOT
 
 =end
 
@@ -24,12 +24,24 @@ module FactPulse
 
     attr_accessor :filename
 
+    attr_accessor :pdp_flow_service_url
+
+    attr_accessor :pdp_token_url
+
+    attr_accessor :pdp_client_id
+
+    attr_accessor :pdp_client_secret
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'xml' => :'xml',
         :'flow_type' => :'flowType',
-        :'filename' => :'filename'
+        :'filename' => :'filename',
+        :'pdp_flow_service_url' => :'pdpFlowServiceUrl',
+        :'pdp_token_url' => :'pdpTokenUrl',
+        :'pdp_client_id' => :'pdpClientId',
+        :'pdp_client_secret' => :'pdpClientSecret'
       }
     end
 
@@ -48,14 +60,22 @@ module FactPulse
       {
         :'xml' => :'String',
         :'flow_type' => :'String',
-        :'filename' => :'String'
+        :'filename' => :'String',
+        :'pdp_flow_service_url' => :'String',
+        :'pdp_token_url' => :'String',
+        :'pdp_client_id' => :'String',
+        :'pdp_client_secret' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'filename'
+        :'filename',
+        :'pdp_flow_service_url',
+        :'pdp_token_url',
+        :'pdp_client_id',
+        :'pdp_client_secret'
       ])
     end
 
@@ -90,6 +110,22 @@ module FactPulse
       if attributes.key?(:'filename')
         self.filename = attributes[:'filename']
       end
+
+      if attributes.key?(:'pdp_flow_service_url')
+        self.pdp_flow_service_url = attributes[:'pdp_flow_service_url']
+      end
+
+      if attributes.key?(:'pdp_token_url')
+        self.pdp_token_url = attributes[:'pdp_token_url']
+      end
+
+      if attributes.key?(:'pdp_client_id')
+        self.pdp_client_id = attributes[:'pdp_client_id']
+      end
+
+      if attributes.key?(:'pdp_client_secret')
+        self.pdp_client_secret = attributes[:'pdp_client_secret']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -129,7 +165,11 @@ module FactPulse
       self.class == o.class &&
           xml == o.xml &&
           flow_type == o.flow_type &&
-          filename == o.filename
+          filename == o.filename &&
+          pdp_flow_service_url == o.pdp_flow_service_url &&
+          pdp_token_url == o.pdp_token_url &&
+          pdp_client_id == o.pdp_client_id &&
+          pdp_client_secret == o.pdp_client_secret
     end
 
     # @see the `==` method
@@ -141,7 +181,7 @@ module FactPulse
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [xml, flow_type, filename].hash
+      [xml, flow_type, filename, pdp_flow_service_url, pdp_token_url, pdp_client_id, pdp_client_secret].hash
     end
 
     # Builds the object from hash

data/lib/factpulse/models/submit_complete_invoice_request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: contact@factpulse.fr
 Generated by: https://openapi-generator.tech
-Generator version: 7.19.0-SNAPSHOT
+Generator version: 7.20.0-SNAPSHOT
 
 =end