factpulse 0.1.0

data/lib/factpulse/models/factur_x_invoice.rb

@@ -0,0 +1,580 @@
+=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
+  # Data model for an invoice to be converted to Factur-X.
+  class FacturXInvoice < ApiModelBase
+    attr_accessor :invoice_number
+
+    attr_accessor :payment_due_date
+
+    attr_accessor :invoice_date
+
+    attr_accessor :submission_mode
+
+    attr_accessor :recipient
+
+    attr_accessor :supplier
+
+    attr_accessor :invoicing_framework
+
+    attr_accessor :references
+
+    attr_accessor :totals
+
+    attr_accessor :invoice_lines
+
+    attr_accessor :vat_lines
+
+    attr_accessor :notes
+
+    attr_accessor :comment
+
+    attr_accessor :current_user_id
+
+    attr_accessor :supplementary_attachments
+
+    attr_accessor :payee
+
+    attr_accessor :delivery_party
+
+    attr_accessor :tax_representative
+
+    attr_accessor :delivery_date
+
+    attr_accessor :billing_period_start
+
+    attr_accessor :billing_period_end
+
+    attr_accessor :payment_reference
+
+    attr_accessor :creditor_reference_id
+
+    attr_accessor :direct_debit_mandate_id
+
+    attr_accessor :debtor_iban
+
+    attr_accessor :payment_terms
+
+    attr_accessor :allowances_charges
+
+    attr_accessor :additional_documents
+
+    attr_accessor :buyer_accounting_reference
+
+    attr_accessor :payment_card
+
+    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
+      {
+        :'invoice_number' => :'invoice_number',
+        :'payment_due_date' => :'payment_due_date',
+        :'invoice_date' => :'invoice_date',
+        :'submission_mode' => :'submission_mode',
+        :'recipient' => :'recipient',
+        :'supplier' => :'supplier',
+        :'invoicing_framework' => :'invoicing_framework',
+        :'references' => :'references',
+        :'totals' => :'totals',
+        :'invoice_lines' => :'invoice_lines',
+        :'vat_lines' => :'vat_lines',
+        :'notes' => :'notes',
+        :'comment' => :'comment',
+        :'current_user_id' => :'current_user_id',
+        :'supplementary_attachments' => :'supplementary_attachments',
+        :'payee' => :'payee',
+        :'delivery_party' => :'delivery_party',
+        :'tax_representative' => :'tax_representative',
+        :'delivery_date' => :'delivery_date',
+        :'billing_period_start' => :'billing_period_start',
+        :'billing_period_end' => :'billing_period_end',
+        :'payment_reference' => :'payment_reference',
+        :'creditor_reference_id' => :'creditor_reference_id',
+        :'direct_debit_mandate_id' => :'direct_debit_mandate_id',
+        :'debtor_iban' => :'debtor_iban',
+        :'payment_terms' => :'payment_terms',
+        :'allowances_charges' => :'allowances_charges',
+        :'additional_documents' => :'additional_documents',
+        :'buyer_accounting_reference' => :'buyer_accounting_reference',
+        :'payment_card' => :'payment_card'
+      }
+    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
+      {
+        :'invoice_number' => :'String',
+        :'payment_due_date' => :'String',
+        :'invoice_date' => :'String',
+        :'submission_mode' => :'SubmissionMode',
+        :'recipient' => :'Recipient',
+        :'supplier' => :'Supplier',
+        :'invoicing_framework' => :'InvoicingFramework',
+        :'references' => :'InvoiceReferences',
+        :'totals' => :'InvoiceTotals',
+        :'invoice_lines' => :'Array<InvoiceLine>',
+        :'vat_lines' => :'Array<VATLine>',
+        :'notes' => :'Array<InvoiceNote>',
+        :'comment' => :'String',
+        :'current_user_id' => :'Integer',
+        :'supplementary_attachments' => :'Array<SupplementaryAttachment>',
+        :'payee' => :'Payee',
+        :'delivery_party' => :'DeliveryParty',
+        :'tax_representative' => :'TaxRepresentative',
+        :'delivery_date' => :'String',
+        :'billing_period_start' => :'String',
+        :'billing_period_end' => :'String',
+        :'payment_reference' => :'String',
+        :'creditor_reference_id' => :'String',
+        :'direct_debit_mandate_id' => :'String',
+        :'debtor_iban' => :'String',
+        :'payment_terms' => :'String',
+        :'allowances_charges' => :'Array<AllowanceCharge>',
+        :'additional_documents' => :'Array<AdditionalDocument>',
+        :'buyer_accounting_reference' => :'String',
+        :'payment_card' => :'PaymentCard'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'comment',
+        :'current_user_id',
+        :'supplementary_attachments',
+        :'payee',
+        :'delivery_party',
+        :'tax_representative',
+        :'delivery_date',
+        :'billing_period_start',
+        :'billing_period_end',
+        :'payment_reference',
+        :'creditor_reference_id',
+        :'direct_debit_mandate_id',
+        :'debtor_iban',
+        :'payment_terms',
+        :'allowances_charges',
+        :'additional_documents',
+        :'buyer_accounting_reference',
+        :'payment_card'
+      ])
+    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::FacturXInvoice` 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::FacturXInvoice`. 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?(:'invoice_number')
+        self.invoice_number = attributes[:'invoice_number']
+      else
+        self.invoice_number = nil
+      end
+
+      if attributes.key?(:'payment_due_date')
+        self.payment_due_date = attributes[:'payment_due_date']
+      else
+        self.payment_due_date = nil
+      end
+
+      if attributes.key?(:'invoice_date')
+        self.invoice_date = attributes[:'invoice_date']
+      end
+
+      if attributes.key?(:'submission_mode')
+        self.submission_mode = attributes[:'submission_mode']
+      end
+
+      if attributes.key?(:'recipient')
+        self.recipient = attributes[:'recipient']
+      else
+        self.recipient = nil
+      end
+
+      if attributes.key?(:'supplier')
+        self.supplier = attributes[:'supplier']
+      else
+        self.supplier = nil
+      end
+
+      if attributes.key?(:'invoicing_framework')
+        self.invoicing_framework = attributes[:'invoicing_framework']
+      else
+        self.invoicing_framework = nil
+      end
+
+      if attributes.key?(:'references')
+        self.references = attributes[:'references']
+      else
+        self.references = nil
+      end
+
+      if attributes.key?(:'totals')
+        self.totals = attributes[:'totals']
+      else
+        self.totals = nil
+      end
+
+      if attributes.key?(:'invoice_lines')
+        if (value = attributes[:'invoice_lines']).is_a?(Array)
+          self.invoice_lines = value
+        end
+      end
+
+      if attributes.key?(:'vat_lines')
+        if (value = attributes[:'vat_lines']).is_a?(Array)
+          self.vat_lines = value
+        end
+      end
+
+      if attributes.key?(:'notes')
+        if (value = attributes[:'notes']).is_a?(Array)
+          self.notes = value
+        end
+      end
+
+      if attributes.key?(:'comment')
+        self.comment = attributes[:'comment']
+      end
+
+      if attributes.key?(:'current_user_id')
+        self.current_user_id = attributes[:'current_user_id']
+      end
+
+      if attributes.key?(:'supplementary_attachments')
+        if (value = attributes[:'supplementary_attachments']).is_a?(Array)
+          self.supplementary_attachments = value
+        end
+      end
+
+      if attributes.key?(:'payee')
+        self.payee = attributes[:'payee']
+      end
+
+      if attributes.key?(:'delivery_party')
+        self.delivery_party = attributes[:'delivery_party']
+      end
+
+      if attributes.key?(:'tax_representative')
+        self.tax_representative = attributes[:'tax_representative']
+      end
+
+      if attributes.key?(:'delivery_date')
+        self.delivery_date = attributes[:'delivery_date']
+      end
+
+      if attributes.key?(:'billing_period_start')
+        self.billing_period_start = attributes[:'billing_period_start']
+      end
+
+      if attributes.key?(:'billing_period_end')
+        self.billing_period_end = attributes[:'billing_period_end']
+      end
+
+      if attributes.key?(:'payment_reference')
+        self.payment_reference = attributes[:'payment_reference']
+      end
+
+      if attributes.key?(:'creditor_reference_id')
+        self.creditor_reference_id = attributes[:'creditor_reference_id']
+      end
+
+      if attributes.key?(:'direct_debit_mandate_id')
+        self.direct_debit_mandate_id = attributes[:'direct_debit_mandate_id']
+      end
+
+      if attributes.key?(:'debtor_iban')
+        self.debtor_iban = attributes[:'debtor_iban']
+      end
+
+      if attributes.key?(:'payment_terms')
+        self.payment_terms = attributes[:'payment_terms']
+      end
+
+      if attributes.key?(:'allowances_charges')
+        if (value = attributes[:'allowances_charges']).is_a?(Array)
+          self.allowances_charges = value
+        end
+      end
+
+      if attributes.key?(:'additional_documents')
+        if (value = attributes[:'additional_documents']).is_a?(Array)
+          self.additional_documents = value
+        end
+      end
+
+      if attributes.key?(:'buyer_accounting_reference')
+        self.buyer_accounting_reference = attributes[:'buyer_accounting_reference']
+      end
+
+      if attributes.key?(:'payment_card')
+        self.payment_card = attributes[:'payment_card']
+      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 @invoice_number.nil?
+        invalid_properties.push('invalid value for "invoice_number", invoice_number cannot be nil.')
+      end
+
+      if @payment_due_date.nil?
+        invalid_properties.push('invalid value for "payment_due_date", payment_due_date cannot be nil.')
+      end
+
+      if @recipient.nil?
+        invalid_properties.push('invalid value for "recipient", recipient cannot be nil.')
+      end
+
+      if @supplier.nil?
+        invalid_properties.push('invalid value for "supplier", supplier cannot be nil.')
+      end
+
+      if @invoicing_framework.nil?
+        invalid_properties.push('invalid value for "invoicing_framework", invoicing_framework cannot be nil.')
+      end
+
+      if @references.nil?
+        invalid_properties.push('invalid value for "references", references cannot be nil.')
+      end
+
+      if @totals.nil?
+        invalid_properties.push('invalid value for "totals", totals 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 @invoice_number.nil?
+      return false if @payment_due_date.nil?
+      return false if @recipient.nil?
+      return false if @supplier.nil?
+      return false if @invoicing_framework.nil?
+      return false if @references.nil?
+      return false if @totals.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] invoice_number Value to be assigned
+    def invoice_number=(invoice_number)
+      if invoice_number.nil?
+        fail ArgumentError, 'invoice_number cannot be nil'
+      end
+
+      @invoice_number = invoice_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] payment_due_date Value to be assigned
+    def payment_due_date=(payment_due_date)
+      if payment_due_date.nil?
+        fail ArgumentError, 'payment_due_date cannot be nil'
+      end
+
+      @payment_due_date = payment_due_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] recipient Value to be assigned
+    def recipient=(recipient)
+      if recipient.nil?
+        fail ArgumentError, 'recipient cannot be nil'
+      end
+
+      @recipient = recipient
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] supplier Value to be assigned
+    def supplier=(supplier)
+      if supplier.nil?
+        fail ArgumentError, 'supplier cannot be nil'
+      end
+
+      @supplier = supplier
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] invoicing_framework Value to be assigned
+    def invoicing_framework=(invoicing_framework)
+      if invoicing_framework.nil?
+        fail ArgumentError, 'invoicing_framework cannot be nil'
+      end
+
+      @invoicing_framework = invoicing_framework
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] references Value to be assigned
+    def references=(references)
+      if references.nil?
+        fail ArgumentError, 'references cannot be nil'
+      end
+
+      @references = references
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] totals Value to be assigned
+    def totals=(totals)
+      if totals.nil?
+        fail ArgumentError, 'totals cannot be nil'
+      end
+
+      @totals = totals
+    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 &&
+          invoice_number == o.invoice_number &&
+          payment_due_date == o.payment_due_date &&
+          invoice_date == o.invoice_date &&
+          submission_mode == o.submission_mode &&
+          recipient == o.recipient &&
+          supplier == o.supplier &&
+          invoicing_framework == o.invoicing_framework &&
+          references == o.references &&
+          totals == o.totals &&
+          invoice_lines == o.invoice_lines &&
+          vat_lines == o.vat_lines &&
+          notes == o.notes &&
+          comment == o.comment &&
+          current_user_id == o.current_user_id &&
+          supplementary_attachments == o.supplementary_attachments &&
+          payee == o.payee &&
+          delivery_party == o.delivery_party &&
+          tax_representative == o.tax_representative &&
+          delivery_date == o.delivery_date &&
+          billing_period_start == o.billing_period_start &&
+          billing_period_end == o.billing_period_end &&
+          payment_reference == o.payment_reference &&
+          creditor_reference_id == o.creditor_reference_id &&
+          direct_debit_mandate_id == o.direct_debit_mandate_id &&
+          debtor_iban == o.debtor_iban &&
+          payment_terms == o.payment_terms &&
+          allowances_charges == o.allowances_charges &&
+          additional_documents == o.additional_documents &&
+          buyer_accounting_reference == o.buyer_accounting_reference &&
+          payment_card == o.payment_card
+    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
+      [invoice_number, payment_due_date, invoice_date, submission_mode, recipient, supplier, invoicing_framework, references, totals, invoice_lines, vat_lines, notes, comment, current_user_id, supplementary_attachments, payee, delivery_party, tax_representative, delivery_date, billing_period_start, billing_period_end, payment_reference, creditor_reference_id, direct_debit_mandate_id, debtor_iban, payment_terms, allowances_charges, additional_documents, buyer_accounting_reference, payment_card].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