factpulse 0.1.0 → 1.0.0

data/lib/factpulse/models/invoice_line.rb

@@ -1,593 +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
-  # Represents an invoice line item (BG-25).
-  class InvoiceLine < ApiModelBase
-    # Invoice line identifier (BT-126).
-    attr_accessor :line_number
-
-    attr_accessor :line_note
-
-    attr_accessor :parent_line_id
-
-    attr_accessor :line_sub_type
-
-    attr_accessor :reference
-
-    attr_accessor :buyer_assigned_id
-
-    attr_accessor :product_global_id
-
-    attr_accessor :product_global_id_scheme
-
-    # Item name (BT-153).
-    attr_accessor :item_name
-
-    attr_accessor :item_description
-
-    attr_accessor :origin_country
-
-    attr_accessor :characteristics
-
-    attr_accessor :classifications
-
-    attr_accessor :quantity
-
-    # Invoiced quantity unit of measure code (BT-130).
-    attr_accessor :unit
-
-    attr_accessor :gross_unit_price
-
-    attr_accessor :unit_net_price
-
-    attr_accessor :price_basis_quantity
-
-    attr_accessor :price_basis_unit
-
-    attr_accessor :price_allowance_amount
-
-    attr_accessor :line_net_amount
-
-    attr_accessor :allowance_amount
-
-    attr_accessor :allowance_reason_code
-
-    attr_accessor :allowance_reason
-
-    attr_accessor :allowances_charges
-
-    attr_accessor :vat_rate
-
-    attr_accessor :manual_vat_rate
-
-    attr_accessor :vat_category
-
-    attr_accessor :period_start_date
-
-    attr_accessor :period_end_date
-
-    attr_accessor :purchase_order_line_ref
-
-    attr_accessor :accounting_account
-
-    attr_accessor :additional_documents
-
-    attr_accessor :line_notes
-
-    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
-      {
-        :'line_number' => :'line_number',
-        :'line_note' => :'line_note',
-        :'parent_line_id' => :'parent_line_id',
-        :'line_sub_type' => :'line_sub_type',
-        :'reference' => :'reference',
-        :'buyer_assigned_id' => :'buyer_assigned_id',
-        :'product_global_id' => :'product_global_id',
-        :'product_global_id_scheme' => :'product_global_id_scheme',
-        :'item_name' => :'item_name',
-        :'item_description' => :'item_description',
-        :'origin_country' => :'origin_country',
-        :'characteristics' => :'characteristics',
-        :'classifications' => :'classifications',
-        :'quantity' => :'quantity',
-        :'unit' => :'unit',
-        :'gross_unit_price' => :'gross_unit_price',
-        :'unit_net_price' => :'unit_net_price',
-        :'price_basis_quantity' => :'price_basis_quantity',
-        :'price_basis_unit' => :'price_basis_unit',
-        :'price_allowance_amount' => :'price_allowance_amount',
-        :'line_net_amount' => :'lineNetAmount',
-        :'allowance_amount' => :'allowanceAmount',
-        :'allowance_reason_code' => :'allowanceReasonCode',
-        :'allowance_reason' => :'allowanceReason',
-        :'allowances_charges' => :'allowances_charges',
-        :'vat_rate' => :'vat_rate',
-        :'manual_vat_rate' => :'manual_vat_rate',
-        :'vat_category' => :'vat_category',
-        :'period_start_date' => :'period_start_date',
-        :'period_end_date' => :'period_end_date',
-        :'purchase_order_line_ref' => :'purchase_order_line_ref',
-        :'accounting_account' => :'accounting_account',
-        :'additional_documents' => :'additional_documents',
-        :'line_notes' => :'line_notes'
-      }
-    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
-      {
-        :'line_number' => :'Integer',
-        :'line_note' => :'String',
-        :'parent_line_id' => :'String',
-        :'line_sub_type' => :'LineSubType',
-        :'reference' => :'String',
-        :'buyer_assigned_id' => :'String',
-        :'product_global_id' => :'String',
-        :'product_global_id_scheme' => :'String',
-        :'item_name' => :'String',
-        :'item_description' => :'String',
-        :'origin_country' => :'String',
-        :'characteristics' => :'Array<ProductCharacteristic>',
-        :'classifications' => :'Array<ProductClassification>',
-        :'quantity' => :'Quantity',
-        :'unit' => :'UnitOfMeasure',
-        :'gross_unit_price' => :'GrossUnitPrice',
-        :'unit_net_price' => :'UnitNetPrice',
-        :'price_basis_quantity' => :'PriceBasisQuantity',
-        :'price_basis_unit' => :'String',
-        :'price_allowance_amount' => :'PriceAllowanceAmount',
-        :'line_net_amount' => :'LineNetAmount',
-        :'allowance_amount' => :'InvoiceLineAllowanceAmount',
-        :'allowance_reason_code' => :'AllowanceReasonCode',
-        :'allowance_reason' => :'String',
-        :'allowances_charges' => :'Array<AllowanceCharge>',
-        :'vat_rate' => :'String',
-        :'manual_vat_rate' => :'ManualVatRate',
-        :'vat_category' => :'VATCategory',
-        :'period_start_date' => :'String',
-        :'period_end_date' => :'String',
-        :'purchase_order_line_ref' => :'String',
-        :'accounting_account' => :'String',
-        :'additional_documents' => :'Array<AdditionalDocument>',
-        :'line_notes' => :'Array<InvoiceNote>'
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-        :'line_note',
-        :'parent_line_id',
-        :'line_sub_type',
-        :'reference',
-        :'buyer_assigned_id',
-        :'product_global_id',
-        :'product_global_id_scheme',
-        :'item_description',
-        :'origin_country',
-        :'characteristics',
-        :'classifications',
-        :'gross_unit_price',
-        :'price_basis_quantity',
-        :'price_basis_unit',
-        :'price_allowance_amount',
-        :'line_net_amount',
-        :'allowance_amount',
-        :'allowance_reason_code',
-        :'allowance_reason',
-        :'allowances_charges',
-        :'vat_rate',
-        :'vat_category',
-        :'period_start_date',
-        :'period_end_date',
-        :'purchase_order_line_ref',
-        :'accounting_account',
-        :'additional_documents',
-        :'line_notes'
-      ])
-    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::InvoiceLine` 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::InvoiceLine`. 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?(:'line_number')
-        self.line_number = attributes[:'line_number']
-      else
-        self.line_number = nil
-      end
-
-      if attributes.key?(:'line_note')
-        self.line_note = attributes[:'line_note']
-      end
-
-      if attributes.key?(:'parent_line_id')
-        self.parent_line_id = attributes[:'parent_line_id']
-      end
-
-      if attributes.key?(:'line_sub_type')
-        self.line_sub_type = attributes[:'line_sub_type']
-      end
-
-      if attributes.key?(:'reference')
-        self.reference = attributes[:'reference']
-      end
-
-      if attributes.key?(:'buyer_assigned_id')
-        self.buyer_assigned_id = attributes[:'buyer_assigned_id']
-      end
-
-      if attributes.key?(:'product_global_id')
-        self.product_global_id = attributes[:'product_global_id']
-      end
-
-      if attributes.key?(:'product_global_id_scheme')
-        self.product_global_id_scheme = attributes[:'product_global_id_scheme']
-      end
-
-      if attributes.key?(:'item_name')
-        self.item_name = attributes[:'item_name']
-      else
-        self.item_name = nil
-      end
-
-      if attributes.key?(:'item_description')
-        self.item_description = attributes[:'item_description']
-      end
-
-      if attributes.key?(:'origin_country')
-        self.origin_country = attributes[:'origin_country']
-      end
-
-      if attributes.key?(:'characteristics')
-        if (value = attributes[:'characteristics']).is_a?(Array)
-          self.characteristics = value
-        end
-      end
-
-      if attributes.key?(:'classifications')
-        if (value = attributes[:'classifications']).is_a?(Array)
-          self.classifications = value
-        end
-      end
-
-      if attributes.key?(:'quantity')
-        self.quantity = attributes[:'quantity']
-      else
-        self.quantity = nil
-      end
-
-      if attributes.key?(:'unit')
-        self.unit = attributes[:'unit']
-      else
-        self.unit = nil
-      end
-
-      if attributes.key?(:'gross_unit_price')
-        self.gross_unit_price = attributes[:'gross_unit_price']
-      end
-
-      if attributes.key?(:'unit_net_price')
-        self.unit_net_price = attributes[:'unit_net_price']
-      else
-        self.unit_net_price = nil
-      end
-
-      if attributes.key?(:'price_basis_quantity')
-        self.price_basis_quantity = attributes[:'price_basis_quantity']
-      end
-
-      if attributes.key?(:'price_basis_unit')
-        self.price_basis_unit = attributes[:'price_basis_unit']
-      end
-
-      if attributes.key?(:'price_allowance_amount')
-        self.price_allowance_amount = attributes[:'price_allowance_amount']
-      end
-
-      if attributes.key?(:'line_net_amount')
-        self.line_net_amount = attributes[:'line_net_amount']
-      end
-
-      if attributes.key?(:'allowance_amount')
-        self.allowance_amount = attributes[:'allowance_amount']
-      end
-
-      if attributes.key?(:'allowance_reason_code')
-        self.allowance_reason_code = attributes[:'allowance_reason_code']
-      end
-
-      if attributes.key?(:'allowance_reason')
-        self.allowance_reason = attributes[:'allowance_reason']
-      end
-
-      if attributes.key?(:'allowances_charges')
-        if (value = attributes[:'allowances_charges']).is_a?(Array)
-          self.allowances_charges = value
-        end
-      end
-
-      if attributes.key?(:'vat_rate')
-        self.vat_rate = attributes[:'vat_rate']
-      end
-
-      if attributes.key?(:'manual_vat_rate')
-        self.manual_vat_rate = attributes[:'manual_vat_rate']
-      end
-
-      if attributes.key?(:'vat_category')
-        self.vat_category = attributes[:'vat_category']
-      end
-
-      if attributes.key?(:'period_start_date')
-        self.period_start_date = attributes[:'period_start_date']
-      end
-
-      if attributes.key?(:'period_end_date')
-        self.period_end_date = attributes[:'period_end_date']
-      end
-
-      if attributes.key?(:'purchase_order_line_ref')
-        self.purchase_order_line_ref = attributes[:'purchase_order_line_ref']
-      end
-
-      if attributes.key?(:'accounting_account')
-        self.accounting_account = attributes[:'accounting_account']
-      end
-
-      if attributes.key?(:'additional_documents')
-        if (value = attributes[:'additional_documents']).is_a?(Array)
-          self.additional_documents = value
-        end
-      end
-
-      if attributes.key?(:'line_notes')
-        if (value = attributes[:'line_notes']).is_a?(Array)
-          self.line_notes = value
-        end
-      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 @line_number.nil?
-        invalid_properties.push('invalid value for "line_number", line_number cannot be nil.')
-      end
-
-      if @item_name.nil?
-        invalid_properties.push('invalid value for "item_name", item_name cannot be nil.')
-      end
-
-      if @quantity.nil?
-        invalid_properties.push('invalid value for "quantity", quantity cannot be nil.')
-      end
-
-      if @unit.nil?
-        invalid_properties.push('invalid value for "unit", unit cannot be nil.')
-      end
-
-      if @unit_net_price.nil?
-        invalid_properties.push('invalid value for "unit_net_price", unit_net_price 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 @line_number.nil?
-      return false if @item_name.nil?
-      return false if @quantity.nil?
-      return false if @unit.nil?
-      return false if @unit_net_price.nil?
-      true
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] line_number Value to be assigned
-    def line_number=(line_number)
-      if line_number.nil?
-        fail ArgumentError, 'line_number cannot be nil'
-      end
-
-      @line_number = line_number
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] item_name Value to be assigned
-    def item_name=(item_name)
-      if item_name.nil?
-        fail ArgumentError, 'item_name cannot be nil'
-      end
-
-      @item_name = item_name
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] quantity Value to be assigned
-    def quantity=(quantity)
-      if quantity.nil?
-        fail ArgumentError, 'quantity cannot be nil'
-      end
-
-      @quantity = quantity
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] unit Value to be assigned
-    def unit=(unit)
-      if unit.nil?
-        fail ArgumentError, 'unit cannot be nil'
-      end
-
-      @unit = unit
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] unit_net_price Value to be assigned
-    def unit_net_price=(unit_net_price)
-      if unit_net_price.nil?
-        fail ArgumentError, 'unit_net_price cannot be nil'
-      end
-
-      @unit_net_price = unit_net_price
-    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 &&
-          line_number == o.line_number &&
-          line_note == o.line_note &&
-          parent_line_id == o.parent_line_id &&
-          line_sub_type == o.line_sub_type &&
-          reference == o.reference &&
-          buyer_assigned_id == o.buyer_assigned_id &&
-          product_global_id == o.product_global_id &&
-          product_global_id_scheme == o.product_global_id_scheme &&
-          item_name == o.item_name &&
-          item_description == o.item_description &&
-          origin_country == o.origin_country &&
-          characteristics == o.characteristics &&
-          classifications == o.classifications &&
-          quantity == o.quantity &&
-          unit == o.unit &&
-          gross_unit_price == o.gross_unit_price &&
-          unit_net_price == o.unit_net_price &&
-          price_basis_quantity == o.price_basis_quantity &&
-          price_basis_unit == o.price_basis_unit &&
-          price_allowance_amount == o.price_allowance_amount &&
-          line_net_amount == o.line_net_amount &&
-          allowance_amount == o.allowance_amount &&
-          allowance_reason_code == o.allowance_reason_code &&
-          allowance_reason == o.allowance_reason &&
-          allowances_charges == o.allowances_charges &&
-          vat_rate == o.vat_rate &&
-          manual_vat_rate == o.manual_vat_rate &&
-          vat_category == o.vat_category &&
-          period_start_date == o.period_start_date &&
-          period_end_date == o.period_end_date &&
-          purchase_order_line_ref == o.purchase_order_line_ref &&
-          accounting_account == o.accounting_account &&
-          additional_documents == o.additional_documents &&
-          line_notes == o.line_notes
-    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
-      [line_number, line_note, parent_line_id, line_sub_type, reference, buyer_assigned_id, product_global_id, product_global_id_scheme, item_name, item_description, origin_country, characteristics, classifications, quantity, unit, gross_unit_price, unit_net_price, price_basis_quantity, price_basis_unit, price_allowance_amount, line_net_amount, allowance_amount, allowance_reason_code, allowance_reason, allowances_charges, vat_rate, manual_vat_rate, vat_category, period_start_date, period_end_date, purchase_order_line_ref, accounting_account, additional_documents, line_notes].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