factpulse 2.0.42 → 3.0.1

data/lib/factpulse/models/incoming_invoice.rb

@@ -0,0 +1,522 @@
+=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://www.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://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API  **Request example:** ```bash curl -X POST https://www.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://www.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://www.factpulse.fr/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://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
+  # Invoice received from a supplier via PDP/PA.  This model contains essential metadata extracted from incoming invoices, regardless of their source format (CII, UBL, Factur-X).  Amounts are Decimal in Python but will be serialized as strings in JSON to preserve monetary precision.
+  class IncomingInvoice < ApiModelBase
+    attr_accessor :flow_id
+
+    # Invoice source format
+    attr_accessor :source_format
+
+    # Invoice number issued by the supplier (BT-1)
+    attr_accessor :supplier_reference
+
+    # Document type (BT-3)
+    attr_accessor :document_type
+
+    # Invoice issuer (SellerTradeParty)
+    attr_accessor :supplier
+
+    # Recipient name / your company (BT-44)
+    attr_accessor :billing_site_name
+
+    attr_accessor :billing_site_siret
+
+    # Invoice date (BT-2) - YYYY-MM-DD
+    attr_accessor :issue_date
+
+    attr_accessor :due_date
+
+    # ISO currency code (BT-5)
+    attr_accessor :currency
+
+    # Total net amount (BT-109)
+    attr_accessor :net_amount
+
+    # Total VAT amount (BT-110)
+    attr_accessor :vat_amount
+
+    # Total gross amount (BT-112)
+    attr_accessor :gross_amount
+
+    attr_accessor :purchase_order_number
+
+    attr_accessor :contract_reference
+
+    attr_accessor :invoice_subject
+
+    attr_accessor :document_base64
+
+    attr_accessor :document_content_type
+
+    attr_accessor :document_filename
+
+    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
+      {
+        :'flow_id' => :'flowId',
+        :'source_format' => :'sourceFormat',
+        :'supplier_reference' => :'supplierReference',
+        :'document_type' => :'documentType',
+        :'supplier' => :'supplier',
+        :'billing_site_name' => :'billingSiteName',
+        :'billing_site_siret' => :'billingSiteSiret',
+        :'issue_date' => :'issueDate',
+        :'due_date' => :'dueDate',
+        :'currency' => :'currency',
+        :'net_amount' => :'netAmount',
+        :'vat_amount' => :'vatAmount',
+        :'gross_amount' => :'grossAmount',
+        :'purchase_order_number' => :'purchaseOrderNumber',
+        :'contract_reference' => :'contractReference',
+        :'invoice_subject' => :'invoiceSubject',
+        :'document_base64' => :'documentBase64',
+        :'document_content_type' => :'documentContentType',
+        :'document_filename' => :'documentFilename'
+      }
+    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',
+        :'source_format' => :'InvoiceFormat',
+        :'supplier_reference' => :'String',
+        :'document_type' => :'DocumentType',
+        :'supplier' => :'IncomingSupplier',
+        :'billing_site_name' => :'String',
+        :'billing_site_siret' => :'String',
+        :'issue_date' => :'String',
+        :'due_date' => :'String',
+        :'currency' => :'String',
+        :'net_amount' => :'String',
+        :'vat_amount' => :'String',
+        :'gross_amount' => :'String',
+        :'purchase_order_number' => :'String',
+        :'contract_reference' => :'String',
+        :'invoice_subject' => :'String',
+        :'document_base64' => :'String',
+        :'document_content_type' => :'String',
+        :'document_filename' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'flow_id',
+        :'billing_site_siret',
+        :'due_date',
+        :'purchase_order_number',
+        :'contract_reference',
+        :'invoice_subject',
+        :'document_base64',
+        :'document_content_type',
+        :'document_filename'
+      ])
+    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::IncomingInvoice` 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::IncomingInvoice`. 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']
+      end
+
+      if attributes.key?(:'source_format')
+        self.source_format = attributes[:'source_format']
+      else
+        self.source_format = nil
+      end
+
+      if attributes.key?(:'supplier_reference')
+        self.supplier_reference = attributes[:'supplier_reference']
+      else
+        self.supplier_reference = nil
+      end
+
+      if attributes.key?(:'document_type')
+        self.document_type = attributes[:'document_type']
+      end
+
+      if attributes.key?(:'supplier')
+        self.supplier = attributes[:'supplier']
+      else
+        self.supplier = nil
+      end
+
+      if attributes.key?(:'billing_site_name')
+        self.billing_site_name = attributes[:'billing_site_name']
+      else
+        self.billing_site_name = nil
+      end
+
+      if attributes.key?(:'billing_site_siret')
+        self.billing_site_siret = attributes[:'billing_site_siret']
+      end
+
+      if attributes.key?(:'issue_date')
+        self.issue_date = attributes[:'issue_date']
+      else
+        self.issue_date = nil
+      end
+
+      if attributes.key?(:'due_date')
+        self.due_date = attributes[:'due_date']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = 'EUR'
+      end
+
+      if attributes.key?(:'net_amount')
+        self.net_amount = attributes[:'net_amount']
+      else
+        self.net_amount = nil
+      end
+
+      if attributes.key?(:'vat_amount')
+        self.vat_amount = attributes[:'vat_amount']
+      else
+        self.vat_amount = nil
+      end
+
+      if attributes.key?(:'gross_amount')
+        self.gross_amount = attributes[:'gross_amount']
+      else
+        self.gross_amount = nil
+      end
+
+      if attributes.key?(:'purchase_order_number')
+        self.purchase_order_number = attributes[:'purchase_order_number']
+      end
+
+      if attributes.key?(:'contract_reference')
+        self.contract_reference = attributes[:'contract_reference']
+      end
+
+      if attributes.key?(:'invoice_subject')
+        self.invoice_subject = attributes[:'invoice_subject']
+      end
+
+      if attributes.key?(:'document_base64')
+        self.document_base64 = attributes[:'document_base64']
+      end
+
+      if attributes.key?(:'document_content_type')
+        self.document_content_type = attributes[:'document_content_type']
+      end
+
+      if attributes.key?(:'document_filename')
+        self.document_filename = attributes[:'document_filename']
+      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 @source_format.nil?
+        invalid_properties.push('invalid value for "source_format", source_format cannot be nil.')
+      end
+
+      if @supplier_reference.nil?
+        invalid_properties.push('invalid value for "supplier_reference", supplier_reference cannot be nil.')
+      end
+
+      if @supplier.nil?
+        invalid_properties.push('invalid value for "supplier", supplier cannot be nil.')
+      end
+
+      if @billing_site_name.nil?
+        invalid_properties.push('invalid value for "billing_site_name", billing_site_name cannot be nil.')
+      end
+
+      if @issue_date.nil?
+        invalid_properties.push('invalid value for "issue_date", issue_date cannot be nil.')
+      end
+
+      if @net_amount.nil?
+        invalid_properties.push('invalid value for "net_amount", net_amount cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/)
+      if @net_amount !~ pattern
+        invalid_properties.push("invalid value for \"net_amount\", must conform to the pattern #{pattern}.")
+      end
+
+      if @vat_amount.nil?
+        invalid_properties.push('invalid value for "vat_amount", vat_amount cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/)
+      if @vat_amount !~ pattern
+        invalid_properties.push("invalid value for \"vat_amount\", must conform to the pattern #{pattern}.")
+      end
+
+      if @gross_amount.nil?
+        invalid_properties.push('invalid value for "gross_amount", gross_amount cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/)
+      if @gross_amount !~ pattern
+        invalid_properties.push("invalid value for \"gross_amount\", must conform to the pattern #{pattern}.")
+      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 @source_format.nil?
+      return false if @supplier_reference.nil?
+      return false if @supplier.nil?
+      return false if @billing_site_name.nil?
+      return false if @issue_date.nil?
+      return false if @net_amount.nil?
+      return false if @net_amount !~ Regexp.new(/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/)
+      return false if @vat_amount.nil?
+      return false if @vat_amount !~ Regexp.new(/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/)
+      return false if @gross_amount.nil?
+      return false if @gross_amount !~ Regexp.new(/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] source_format Value to be assigned
+    def source_format=(source_format)
+      if source_format.nil?
+        fail ArgumentError, 'source_format cannot be nil'
+      end
+
+      @source_format = source_format
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] supplier_reference Value to be assigned
+    def supplier_reference=(supplier_reference)
+      if supplier_reference.nil?
+        fail ArgumentError, 'supplier_reference cannot be nil'
+      end
+
+      @supplier_reference = supplier_reference
+    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] billing_site_name Value to be assigned
+    def billing_site_name=(billing_site_name)
+      if billing_site_name.nil?
+        fail ArgumentError, 'billing_site_name cannot be nil'
+      end
+
+      @billing_site_name = billing_site_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] issue_date Value to be assigned
+    def issue_date=(issue_date)
+      if issue_date.nil?
+        fail ArgumentError, 'issue_date cannot be nil'
+      end
+
+      @issue_date = issue_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] net_amount Value to be assigned
+    def net_amount=(net_amount)
+      if net_amount.nil?
+        fail ArgumentError, 'net_amount cannot be nil'
+      end
+
+      pattern = Regexp.new(/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/)
+      if net_amount !~ pattern
+        fail ArgumentError, "invalid value for \"net_amount\", must conform to the pattern #{pattern}."
+      end
+
+      @net_amount = net_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] vat_amount Value to be assigned
+    def vat_amount=(vat_amount)
+      if vat_amount.nil?
+        fail ArgumentError, 'vat_amount cannot be nil'
+      end
+
+      pattern = Regexp.new(/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/)
+      if vat_amount !~ pattern
+        fail ArgumentError, "invalid value for \"vat_amount\", must conform to the pattern #{pattern}."
+      end
+
+      @vat_amount = vat_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] gross_amount Value to be assigned
+    def gross_amount=(gross_amount)
+      if gross_amount.nil?
+        fail ArgumentError, 'gross_amount cannot be nil'
+      end
+
+      pattern = Regexp.new(/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/)
+      if gross_amount !~ pattern
+        fail ArgumentError, "invalid value for \"gross_amount\", must conform to the pattern #{pattern}."
+      end
+
+      @gross_amount = gross_amount
+    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 &&
+          source_format == o.source_format &&
+          supplier_reference == o.supplier_reference &&
+          document_type == o.document_type &&
+          supplier == o.supplier &&
+          billing_site_name == o.billing_site_name &&
+          billing_site_siret == o.billing_site_siret &&
+          issue_date == o.issue_date &&
+          due_date == o.due_date &&
+          currency == o.currency &&
+          net_amount == o.net_amount &&
+          vat_amount == o.vat_amount &&
+          gross_amount == o.gross_amount &&
+          purchase_order_number == o.purchase_order_number &&
+          contract_reference == o.contract_reference &&
+          invoice_subject == o.invoice_subject &&
+          document_base64 == o.document_base64 &&
+          document_content_type == o.document_content_type &&
+          document_filename == o.document_filename
+    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, source_format, supplier_reference, document_type, supplier, billing_site_name, billing_site_siret, issue_date, due_date, currency, net_amount, vat_amount, gross_amount, purchase_order_number, contract_reference, invoice_subject, document_base64, document_content_type, document_filename].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