factpulse 3.0.5 → 3.0.7

data/lib/factpulse/models/supplier.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.18.0-SNAPSHOT
+Generator version: 7.19.0-SNAPSHOT
 
 =end
 
@@ -14,18 +14,24 @@ require 'date'
 require 'time'
 
 module FactPulse
-  # Information about the supplier who issues the invoice.
+  # Information about the supplier / seller (BG-4).
   class Supplier < ApiModelBase
     attr_accessor :electronic_address
 
     attr_accessor :supplier_id
 
+    attr_accessor :private_id
+
     attr_accessor :supplier_bank_account_code
 
     attr_accessor :supplier_service_id
 
     attr_accessor :name
 
+    attr_accessor :trading_business_name
+
+    attr_accessor :legal_description
+
     attr_accessor :siren
 
     attr_accessor :siret
@@ -34,21 +40,39 @@ module FactPulse
 
     attr_accessor :iban
 
+    attr_accessor :bic
+
+    attr_accessor :bank_account_name
+
+    attr_accessor :proprietary_id
+
     attr_accessor :postal_address
 
+    attr_accessor :contact
+
+    attr_accessor :global_ids
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'electronic_address' => :'electronic_address',
         :'supplier_id' => :'supplier_id',
+        :'private_id' => :'private_id',
         :'supplier_bank_account_code' => :'supplier_bank_account_code',
         :'supplier_service_id' => :'supplier_service_id',
         :'name' => :'name',
+        :'trading_business_name' => :'trading_business_name',
+        :'legal_description' => :'legal_description',
         :'siren' => :'siren',
         :'siret' => :'siret',
         :'vat_number' => :'vat_number',
         :'iban' => :'iban',
-        :'postal_address' => :'postal_address'
+        :'bic' => :'bic',
+        :'bank_account_name' => :'bank_account_name',
+        :'proprietary_id' => :'proprietaryId',
+        :'postal_address' => :'postal_address',
+        :'contact' => :'contact',
+        :'global_ids' => :'global_ids'
       }
     end
 
@@ -67,14 +91,22 @@ module FactPulse
       {
         :'electronic_address' => :'ElectronicAddress',
         :'supplier_id' => :'Integer',
+        :'private_id' => :'String',
         :'supplier_bank_account_code' => :'Integer',
         :'supplier_service_id' => :'Integer',
         :'name' => :'String',
+        :'trading_business_name' => :'String',
+        :'legal_description' => :'String',
         :'siren' => :'String',
         :'siret' => :'String',
         :'vat_number' => :'String',
         :'iban' => :'String',
-        :'postal_address' => :'PostalAddress'
+        :'bic' => :'String',
+        :'bank_account_name' => :'String',
+        :'proprietary_id' => :'String',
+        :'postal_address' => :'PostalAddress',
+        :'contact' => :'Contact',
+        :'global_ids' => :'Array<ElectronicAddress>'
       }
     end
 
@@ -82,14 +114,22 @@ module FactPulse
     def self.openapi_nullable
       Set.new([
         :'electronic_address',
+        :'private_id',
         :'supplier_bank_account_code',
         :'supplier_service_id',
         :'name',
+        :'trading_business_name',
+        :'legal_description',
         :'siren',
         :'siret',
         :'vat_number',
         :'iban',
-        :'postal_address'
+        :'bic',
+        :'bank_account_name',
+        :'proprietary_id',
+        :'postal_address',
+        :'contact',
+        :'global_ids'
       ])
     end
 
@@ -121,6 +161,10 @@ module FactPulse
         self.supplier_id = nil
       end
 
+      if attributes.key?(:'private_id')
+        self.private_id = attributes[:'private_id']
+      end
+
       if attributes.key?(:'supplier_bank_account_code')
         self.supplier_bank_account_code = attributes[:'supplier_bank_account_code']
       end
@@ -133,6 +177,14 @@ module FactPulse
         self.name = attributes[:'name']
       end
 
+      if attributes.key?(:'trading_business_name')
+        self.trading_business_name = attributes[:'trading_business_name']
+      end
+
+      if attributes.key?(:'legal_description')
+        self.legal_description = attributes[:'legal_description']
+      end
+
       if attributes.key?(:'siren')
         self.siren = attributes[:'siren']
       end
@@ -149,9 +201,31 @@ module FactPulse
         self.iban = attributes[:'iban']
       end
 
+      if attributes.key?(:'bic')
+        self.bic = attributes[:'bic']
+      end
+
+      if attributes.key?(:'bank_account_name')
+        self.bank_account_name = attributes[:'bank_account_name']
+      end
+
+      if attributes.key?(:'proprietary_id')
+        self.proprietary_id = attributes[:'proprietary_id']
+      end
+
       if attributes.key?(:'postal_address')
         self.postal_address = attributes[:'postal_address']
       end
+
+      if attributes.key?(:'contact')
+        self.contact = attributes[:'contact']
+      end
+
+      if attributes.key?(:'global_ids')
+        if (value = attributes[:'global_ids']).is_a?(Array)
+          self.global_ids = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -191,14 +265,22 @@ module FactPulse
       self.class == o.class &&
           electronic_address == o.electronic_address &&
           supplier_id == o.supplier_id &&
+          private_id == o.private_id &&
           supplier_bank_account_code == o.supplier_bank_account_code &&
           supplier_service_id == o.supplier_service_id &&
           name == o.name &&
+          trading_business_name == o.trading_business_name &&
+          legal_description == o.legal_description &&
           siren == o.siren &&
           siret == o.siret &&
           vat_number == o.vat_number &&
           iban == o.iban &&
-          postal_address == o.postal_address
+          bic == o.bic &&
+          bank_account_name == o.bank_account_name &&
+          proprietary_id == o.proprietary_id &&
+          postal_address == o.postal_address &&
+          contact == o.contact &&
+          global_ids == o.global_ids
     end
 
     # @see the `==` method
@@ -210,7 +292,7 @@ module FactPulse
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [electronic_address, supplier_id, supplier_bank_account_code, supplier_service_id, name, siren, siret, vat_number, iban, postal_address].hash
+      [electronic_address, supplier_id, private_id, supplier_bank_account_code, supplier_service_id, name, trading_business_name, legal_description, siren, siret, vat_number, iban, bic, bank_account_name, proprietary_id, postal_address, contact, global_ids].hash
     end
 
     # Builds the object from hash

data/lib/factpulse/models/task_response.rb

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

data/lib/factpulse/models/tax_representative.rb

@@ -0,0 +1,220 @@
+=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.19.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module FactPulse
+  # Seller tax representative (BG-11).  The tax representative is required when the seller is not established in the country where VAT is due.
+  class TaxRepresentative < ApiModelBase
+    # Tax representative name (BT-62).
+    attr_accessor :name
+
+    # Tax representative VAT identifier (BT-63).
+    attr_accessor :vat_number
+
+    # Tax representative postal address (BG-12).
+    attr_accessor :postal_address
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'vat_number' => :'vat_number',
+        :'postal_address' => :'postal_address'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'vat_number' => :'String',
+        :'postal_address' => :'PostalAddress'
+      }
+    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::TaxRepresentative` 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::TaxRepresentative`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'vat_number')
+        self.vat_number = attributes[:'vat_number']
+      else
+        self.vat_number = nil
+      end
+
+      if attributes.key?(:'postal_address')
+        self.postal_address = attributes[:'postal_address']
+      else
+        self.postal_address = 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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @vat_number.nil?
+        invalid_properties.push('invalid value for "vat_number", vat_number cannot be nil.')
+      end
+
+      if @postal_address.nil?
+        invalid_properties.push('invalid value for "postal_address", postal_address 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 @name.nil?
+      return false if @vat_number.nil?
+      return false if @postal_address.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] vat_number Value to be assigned
+    def vat_number=(vat_number)
+      if vat_number.nil?
+        fail ArgumentError, 'vat_number cannot be nil'
+      end
+
+      @vat_number = vat_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] postal_address Value to be assigned
+    def postal_address=(postal_address)
+      if postal_address.nil?
+        fail ArgumentError, 'postal_address cannot be nil'
+      end
+
+      @postal_address = postal_address
+    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 &&
+          name == o.name &&
+          vat_number == o.vat_number &&
+          postal_address == o.postal_address
+    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
+      [name, vat_number, postal_address].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/taxable_amount.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.18.0-SNAPSHOT
+Generator version: 7.19.0-SNAPSHOT
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module FactPulse
-  # Taxable amount (base) for this VAT line. (Accepte number, string ou integer)
+  # VAT category taxable amount (BT-116). Can be negative for correction invoices.
   module TaxableAmount
     class << self
       # List of class defined in anyOf (OpenAPI v3)

data/lib/factpulse/models/total_gross_amount.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.18.0-SNAPSHOT
+Generator version: 7.19.0-SNAPSHOT
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module FactPulse
-  # Total gross amount (including tax). (Accepte number, string ou integer)
+  # Invoice total amount with VAT (BT-112). Can be negative for correction invoices.
   module TotalGrossAmount
     class << self
       # List of class defined in anyOf (OpenAPI v3)

data/lib/factpulse/models/total_net_amount.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.18.0-SNAPSHOT
+Generator version: 7.19.0-SNAPSHOT
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module FactPulse
-  # Total net amount (before tax). (Accepte number, string ou integer)
+  # Invoice total amount without VAT (BT-109). Can be negative for correction invoices.
   module TotalNetAmount
     class << self
       # List of class defined in anyOf (OpenAPI v3)

data/lib/factpulse/models/total_vat_amount.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.18.0-SNAPSHOT
+Generator version: 7.19.0-SNAPSHOT
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module FactPulse
-  # Total VAT amount. (Accepte number, string ou integer)
+  # Invoice total VAT amount (BT-110). Can be negative for correction invoices.
   module TotalVATAmount
     class << self
       # List of class defined in anyOf (OpenAPI v3)

data/lib/factpulse/models/unit_net_price.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.18.0-SNAPSHOT
+Generator version: 7.19.0-SNAPSHOT
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module FactPulse
-  # Unit net price (before tax).
+  # Item net price after line discount (BT-146).
   module UnitNetPrice
     class << self
       # List of class defined in anyOf (OpenAPI v3)

data/lib/factpulse/models/unit_of_measure.rb

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

data/lib/factpulse/models/validation_error.rb

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

data/lib/factpulse/models/validation_error_detail.rb

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

data/lib/factpulse/models/validation_error_loc_inner.rb

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

data/lib/factpulse/models/validation_error_response.rb

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