factpulse 4.1.2 → 4.4.0

data/lib/factpulse/models/invoicedata.rb

@@ -0,0 +1,105 @@
+=begin
+#FactPulse REST API
+
+# REST API for electronic invoicing in France: Factur-X (CII), UBL 2.1, AFNOR PDP/PA, electronic signatures.  ## 🎯 Main Features  ### 📄 Invoice Generation - **Formats**: CII XML, UBL 2.1 XML, or Factur-X PDF/A-3 - **Profiles** (CII/PDF): MINIMUM, BASIC, EN16931, EXTENDED - **UBL**: Always EN16931 compliant - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT), UBL 2.1 (OASIS) - **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.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module FactPulse
+  # Invoice data, in either of the two accepted formats (detected automatically, same rule as /generate-invoice): 1. **Simplified format**: `number` + `lines`, with auto-enrichment. Any field of the complete model may be added on top. 2. **Complete format**: full `FacturXInvoice` structure, recognised by the presence of `invoiceLines`. No auto-enrichment of totals.
+  module Invoicedata
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'FacturXInvoice',
+          :'SimplifiedInvoiceData'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            return find_and_cast_into_type(klass, data)
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.iso8601(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = FactPulse.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

data/lib/factpulse/models/invoicing_framework.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/invoicing_framework_code.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/issuer_role_code.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/key_rotation_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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/key_rotation_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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/lifecycle_event.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 
@@ -26,6 +26,8 @@ module FactPulse
 
     attr_accessor :ack_status
 
+    attr_accessor :flow_direction
+
     attr_accessor :at
 
     attr_accessor :document_id
@@ -47,6 +49,7 @@ module FactPulse
         :'status_code' => :'statusCode',
         :'status_description' => :'statusDescription',
         :'ack_status' => :'ackStatus',
+        :'flow_direction' => :'flowDirection',
         :'at' => :'at',
         :'document_id' => :'documentId',
         :'amount' => :'amount',
@@ -74,6 +77,7 @@ module FactPulse
         :'status_code' => :'String',
         :'status_description' => :'String',
         :'ack_status' => :'String',
+        :'flow_direction' => :'String',
         :'at' => :'String',
         :'document_id' => :'String',
         :'amount' => :'String',
@@ -89,6 +93,7 @@ module FactPulse
       Set.new([
         :'status_description',
         :'ack_status',
+        :'flow_direction',
         :'at',
         :'document_id',
         :'amount',
@@ -135,6 +140,10 @@ module FactPulse
         self.ack_status = attributes[:'ack_status']
       end
 
+      if attributes.key?(:'flow_direction')
+        self.flow_direction = attributes[:'flow_direction']
+      end
+
       if attributes.key?(:'at')
         self.at = attributes[:'at']
       end
@@ -235,6 +244,7 @@ module FactPulse
           status_code == o.status_code &&
           status_description == o.status_description &&
           ack_status == o.ack_status &&
+          flow_direction == o.flow_direction &&
           at == o.at &&
           document_id == o.document_id &&
           amount == o.amount &&
@@ -253,7 +263,7 @@ module FactPulse
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [flow_id, status_code, status_description, ack_status, at, document_id, amount, currency, issuer_siren, issuer_role, reason_code].hash
+      [flow_id, status_code, status_description, ack_status, flow_direction, at, document_id, amount, currency, issuer_siren, issuer_role, reason_code].hash
     end
 
     # Builds the object from hash

data/lib/factpulse/models/lifecycle_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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/line_net_amount.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/line_sub_type.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/line_total_amount.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/location_inner.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/mandatory_note_schema.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/manual_rate.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/manual_vat_rate.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/missing_field.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/operation_nature.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/output_format.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/page_dimensions_schema.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/parse_factur_x_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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/payee.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 
@@ -64,10 +64,10 @@ module FactPulse
         :'payee_id' => :'String',
         :'siret' => :'String',
         :'siren' => :'String',
-        :'electronic_address' => :'ElectronicAddress',
+        :'electronic_address' => :'ElectronicAddressInput',
         :'iban' => :'String',
         :'bic' => :'String',
-        :'global_ids' => :'Array<ElectronicAddress>'
+        :'global_ids' => :'Array<ElectronicAddressInput>'
       }
     end
 

data/lib/factpulse/models/payment_amount_by_rate.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 
@@ -20,11 +20,14 @@ module FactPulse
 
     attr_accessor :amount
 
+    attr_accessor :amount_eur
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'rate' => :'rate',
-        :'amount' => :'amount'
+        :'amount' => :'amount',
+        :'amount_eur' => :'amountEur'
       }
     end
 
@@ -42,13 +45,15 @@ module FactPulse
     def self.openapi_types
       {
         :'rate' => :'Rate',
-        :'amount' => :'Amount1'
+        :'amount' => :'Amount2',
+        :'amount_eur' => :'Amounteur'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'amount_eur'
       ])
     end
 
@@ -79,6 +84,10 @@ module FactPulse
       else
         self.amount = nil
       end
+
+      if attributes.key?(:'amount_eur')
+        self.amount_eur = attributes[:'amount_eur']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -132,7 +141,8 @@ module FactPulse
       return true if self.equal?(o)
       self.class == o.class &&
           rate == o.rate &&
-          amount == o.amount
+          amount == o.amount &&
+          amount_eur == o.amount_eur
     end
 
     # @see the `==` method
@@ -144,7 +154,7 @@ module FactPulse
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [rate, amount].hash
+      [rate, amount, amount_eur].hash
     end
 
     # Builds the object from hash

data/lib/factpulse/models/payment_card.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/payment_means.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/pdf_validation_result_api.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/pdp_config_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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/pdp_config_update_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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/pdp_credentials.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/percentage.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 

data/lib/factpulse/models/postal_address.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.21.0-SNAPSHOT
+Generator version: 7.21.0
 
 =end
 
@@ -33,13 +33,13 @@ module FactPulse
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'postal_code' => :'postalCode',
-        :'line_one' => :'lineOne',
-        :'line_two' => :'lineTwo',
-        :'line_three' => :'lineThree',
+        :'postal_code' => :'postal_code',
+        :'line_one' => :'line_one',
+        :'line_two' => :'line_two',
+        :'line_three' => :'line_three',
         :'city' => :'city',
-        :'country_code' => :'countryCode',
-        :'country_subdivision' => :'countrySubdivision'
+        :'country_code' => :'country_code',
+        :'country_subdivision' => :'country_subdivision'
       }
     end