factpulse 3.0.10 → 3.0.13

data/lib/factpulse/models/afnor_address_put.rb

@@ -0,0 +1,435 @@
+=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://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.19.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module FactPulse
+  # Wrapper for postal addresses
+  class AFNORAddressPut < ApiModelBase
+    # Corresponds to the address of the recipient structure having defined the directory line(s).
+    attr_accessor :ligne_adresse1
+
+    # Corresponds to the address of the recipient structure having defined the directory line(s).
+    attr_accessor :ligne_adresse2
+
+    # Corresponds to the address of the recipient structure having defined the directory line(s).
+    attr_accessor :ligne_adresse3
+
+    # Service postal code
+    attr_accessor :postal_code
+
+    # Subdivision of the country
+    attr_accessor :country_subdivision
+
+    # Corresponds to the municipality of the recipient structure having defined the directory line(s).
+    attr_accessor :locality
+
+    # Corresponds to the country code of the recipient structure
+    attr_accessor :code_pays
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ligne_adresse1' => :'ligneAdresse1',
+        :'ligne_adresse2' => :'ligneAdresse2',
+        :'ligne_adresse3' => :'ligneAdresse3',
+        :'postal_code' => :'postalCode',
+        :'country_subdivision' => :'countrySubdivision',
+        :'locality' => :'locality',
+        :'code_pays' => :'codePays'
+      }
+    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
+      {
+        :'ligne_adresse1' => :'String',
+        :'ligne_adresse2' => :'String',
+        :'ligne_adresse3' => :'String',
+        :'postal_code' => :'String',
+        :'country_subdivision' => :'String',
+        :'locality' => :'String',
+        :'code_pays' => :'String'
+      }
+    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::AFNORAddressPut` 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::AFNORAddressPut`. 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?(:'ligne_adresse1')
+        self.ligne_adresse1 = attributes[:'ligne_adresse1']
+      else
+        self.ligne_adresse1 = nil
+      end
+
+      if attributes.key?(:'ligne_adresse2')
+        self.ligne_adresse2 = attributes[:'ligne_adresse2']
+      else
+        self.ligne_adresse2 = nil
+      end
+
+      if attributes.key?(:'ligne_adresse3')
+        self.ligne_adresse3 = attributes[:'ligne_adresse3']
+      else
+        self.ligne_adresse3 = nil
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      else
+        self.postal_code = nil
+      end
+
+      if attributes.key?(:'country_subdivision')
+        self.country_subdivision = attributes[:'country_subdivision']
+      else
+        self.country_subdivision = nil
+      end
+
+      if attributes.key?(:'locality')
+        self.locality = attributes[:'locality']
+      else
+        self.locality = nil
+      end
+
+      if attributes.key?(:'code_pays')
+        self.code_pays = attributes[:'code_pays']
+      else
+        self.code_pays = 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 @ligne_adresse1.nil?
+        invalid_properties.push('invalid value for "ligne_adresse1", ligne_adresse1 cannot be nil.')
+      end
+
+      if @ligne_adresse1.to_s.length > 200
+        invalid_properties.push('invalid value for "ligne_adresse1", the character length must be smaller than or equal to 200.')
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if @ligne_adresse1 !~ pattern
+        invalid_properties.push("invalid value for \"ligne_adresse1\", must conform to the pattern #{pattern}.")
+      end
+
+      if @ligne_adresse2.nil?
+        invalid_properties.push('invalid value for "ligne_adresse2", ligne_adresse2 cannot be nil.')
+      end
+
+      if @ligne_adresse2.to_s.length > 255
+        invalid_properties.push('invalid value for "ligne_adresse2", the character length must be smaller than or equal to 255.')
+      end
+
+      if @ligne_adresse3.nil?
+        invalid_properties.push('invalid value for "ligne_adresse3", ligne_adresse3 cannot be nil.')
+      end
+
+      if @ligne_adresse3.to_s.length > 255
+        invalid_properties.push('invalid value for "ligne_adresse3", the character length must be smaller than or equal to 255.')
+      end
+
+      if @postal_code.nil?
+        invalid_properties.push('invalid value for "postal_code", postal_code cannot be nil.')
+      end
+
+      if @postal_code.to_s.length > 5
+        invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 5.')
+      end
+
+      pattern = Regexp.new(/[0-9]*/)
+      if @postal_code !~ pattern
+        invalid_properties.push("invalid value for \"postal_code\", must conform to the pattern #{pattern}.")
+      end
+
+      if @country_subdivision.nil?
+        invalid_properties.push('invalid value for "country_subdivision", country_subdivision cannot be nil.')
+      end
+
+      if @country_subdivision.to_s.length > 255
+        invalid_properties.push('invalid value for "country_subdivision", the character length must be smaller than or equal to 255.')
+      end
+
+      if @locality.nil?
+        invalid_properties.push('invalid value for "locality", locality cannot be nil.')
+      end
+
+      if @locality.to_s.length > 100
+        invalid_properties.push('invalid value for "locality", the character length must be smaller than or equal to 100.')
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if @locality !~ pattern
+        invalid_properties.push("invalid value for \"locality\", must conform to the pattern #{pattern}.")
+      end
+
+      if @code_pays.nil?
+        invalid_properties.push('invalid value for "code_pays", code_pays cannot be nil.')
+      end
+
+      if @code_pays.to_s.length > 2
+        invalid_properties.push('invalid value for "code_pays", the character length must be smaller than or equal to 2.')
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if @code_pays !~ pattern
+        invalid_properties.push("invalid value for \"code_pays\", 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 @ligne_adresse1.nil?
+      return false if @ligne_adresse1.to_s.length > 200
+      return false if @ligne_adresse1 !~ Regexp.new(/^(?!\s*$).+/)
+      return false if @ligne_adresse2.nil?
+      return false if @ligne_adresse2.to_s.length > 255
+      return false if @ligne_adresse3.nil?
+      return false if @ligne_adresse3.to_s.length > 255
+      return false if @postal_code.nil?
+      return false if @postal_code.to_s.length > 5
+      return false if @postal_code !~ Regexp.new(/[0-9]*/)
+      return false if @country_subdivision.nil?
+      return false if @country_subdivision.to_s.length > 255
+      return false if @locality.nil?
+      return false if @locality.to_s.length > 100
+      return false if @locality !~ Regexp.new(/^(?!\s*$).+/)
+      return false if @code_pays.nil?
+      return false if @code_pays.to_s.length > 2
+      return false if @code_pays !~ Regexp.new(/^(?!\s*$).+/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ligne_adresse1 Value to be assigned
+    def ligne_adresse1=(ligne_adresse1)
+      if ligne_adresse1.nil?
+        fail ArgumentError, 'ligne_adresse1 cannot be nil'
+      end
+
+      if ligne_adresse1.to_s.length > 200
+        fail ArgumentError, 'invalid value for "ligne_adresse1", the character length must be smaller than or equal to 200.'
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if ligne_adresse1 !~ pattern
+        fail ArgumentError, "invalid value for \"ligne_adresse1\", must conform to the pattern #{pattern}."
+      end
+
+      @ligne_adresse1 = ligne_adresse1
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ligne_adresse2 Value to be assigned
+    def ligne_adresse2=(ligne_adresse2)
+      if ligne_adresse2.nil?
+        fail ArgumentError, 'ligne_adresse2 cannot be nil'
+      end
+
+      if ligne_adresse2.to_s.length > 255
+        fail ArgumentError, 'invalid value for "ligne_adresse2", the character length must be smaller than or equal to 255.'
+      end
+
+      @ligne_adresse2 = ligne_adresse2
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ligne_adresse3 Value to be assigned
+    def ligne_adresse3=(ligne_adresse3)
+      if ligne_adresse3.nil?
+        fail ArgumentError, 'ligne_adresse3 cannot be nil'
+      end
+
+      if ligne_adresse3.to_s.length > 255
+        fail ArgumentError, 'invalid value for "ligne_adresse3", the character length must be smaller than or equal to 255.'
+      end
+
+      @ligne_adresse3 = ligne_adresse3
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] postal_code Value to be assigned
+    def postal_code=(postal_code)
+      if postal_code.nil?
+        fail ArgumentError, 'postal_code cannot be nil'
+      end
+
+      if postal_code.to_s.length > 5
+        fail ArgumentError, 'invalid value for "postal_code", the character length must be smaller than or equal to 5.'
+      end
+
+      pattern = Regexp.new(/[0-9]*/)
+      if postal_code !~ pattern
+        fail ArgumentError, "invalid value for \"postal_code\", must conform to the pattern #{pattern}."
+      end
+
+      @postal_code = postal_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country_subdivision Value to be assigned
+    def country_subdivision=(country_subdivision)
+      if country_subdivision.nil?
+        fail ArgumentError, 'country_subdivision cannot be nil'
+      end
+
+      if country_subdivision.to_s.length > 255
+        fail ArgumentError, 'invalid value for "country_subdivision", the character length must be smaller than or equal to 255.'
+      end
+
+      @country_subdivision = country_subdivision
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] locality Value to be assigned
+    def locality=(locality)
+      if locality.nil?
+        fail ArgumentError, 'locality cannot be nil'
+      end
+
+      if locality.to_s.length > 100
+        fail ArgumentError, 'invalid value for "locality", the character length must be smaller than or equal to 100.'
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if locality !~ pattern
+        fail ArgumentError, "invalid value for \"locality\", must conform to the pattern #{pattern}."
+      end
+
+      @locality = locality
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] code_pays Value to be assigned
+    def code_pays=(code_pays)
+      if code_pays.nil?
+        fail ArgumentError, 'code_pays cannot be nil'
+      end
+
+      if code_pays.to_s.length > 2
+        fail ArgumentError, 'invalid value for "code_pays", the character length must be smaller than or equal to 2.'
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if code_pays !~ pattern
+        fail ArgumentError, "invalid value for \"code_pays\", must conform to the pattern #{pattern}."
+      end
+
+      @code_pays = code_pays
+    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 &&
+          ligne_adresse1 == o.ligne_adresse1 &&
+          ligne_adresse2 == o.ligne_adresse2 &&
+          ligne_adresse3 == o.ligne_adresse3 &&
+          postal_code == o.postal_code &&
+          country_subdivision == o.country_subdivision &&
+          locality == o.locality &&
+          code_pays == o.code_pays
+    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
+      [ligne_adresse1, ligne_adresse2, ligne_adresse3, postal_code, country_subdivision, locality, code_pays].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