factpulse 2.0.42 → 3.0.1

data/lib/factpulse/models/structure_info.rb

@@ -1,7 +1,7 @@
 =begin
-#API REST FactPulse
+#FactPulse REST API
 
-# API REST pour la facturation électronique en France : Factur-X, AFNOR PDP/PA, signatures électroniques.  ## 🎯 Fonctionnalités principales  ### 📄 Génération de factures Factur-X - **Formats** : XML seul ou PDF/A-3 avec XML embarqué - **Profils** : MINIMUM, BASIC, EN16931, EXTENDED - **Normes** : EN 16931 (directive UE 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Format simplifié** : Génération à partir de SIRET + auto-enrichissement (API Chorus Pro + Recherche Entreprises)  ### ✅ Validation et conformité - **Validation XML** : Schematron (45 à 210+ règles selon profil) - **Validation PDF** : PDF/A-3, métadonnées XMP Factur-X, signatures électroniques - **VeraPDF** : Validation stricte PDF/A (146+ règles ISO 19005-3) - **Traitement asynchrone** : Support Celery pour validations lourdes (VeraPDF)  ### 📡 Intégration AFNOR PDP/PA (XP Z12-013) - **Soumission de flux** : Envoi de factures vers Plateformes de Dématérialisation Partenaires - **Recherche de flux** : Consultation des factures soumises - **Téléchargement** : Récupération des PDF/A-3 avec XML - **Directory Service** : Recherche d'entreprises (SIREN/SIRET) - **Multi-client** : Support de plusieurs configs PDP par utilisateur (stored credentials ou zero-storage)  ### ✍️ Signature électronique PDF - **Standards** : PAdES-B-B, PAdES-B-T (horodatage RFC 3161), PAdES-B-LT (archivage long terme) - **Niveaux eIDAS** : SES (auto-signé), AdES (CA commerciale), QES (PSCO) - **Validation** : Vérification intégrité cryptographique et certificats - **Génération de certificats** : Certificats X.509 auto-signés pour tests  ### 🔄 Traitement asynchrone - **Celery** : Génération, validation et signature asynchrones - **Polling** : Suivi d'état via `/taches/{id_tache}/statut` - **Pas de timeout** : Idéal pour gros fichiers ou validations lourdes  ## 🔒 Authentification  Toutes les requêtes nécessitent un **token JWT** dans le header Authorization : ``` Authorization: Bearer YOUR_JWT_TOKEN ```  ### Comment obtenir un token JWT ?  #### 🔑 Méthode 1 : API `/api/token/` (Recommandée)  **URL :** `https://www.factpulse.fr/api/token/`  Cette méthode est **recommandée** pour l'intégration dans vos applications et workflows CI/CD.  **Prérequis :** Avoir défini un mot de passe sur votre compte  **Pour les utilisateurs inscrits via email/password :** - Vous avez déjà un mot de passe, utilisez-le directement  **Pour les utilisateurs inscrits via OAuth (Google/GitHub) :** - Vous devez d'abord définir un mot de passe sur : https://www.factpulse.fr/accounts/password/set/ - Une fois le mot de passe créé, vous pourrez utiliser l'API  **Exemple de requête :** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\   -H \"Content-Type: application/json\" \\   -d '{     \"username\": \"votre_email@example.com\",     \"password\": \"votre_mot_de_passe\"   }' ```  **Paramètre optionnel `client_uid` :**  Pour sélectionner les credentials d'un client spécifique (PA/PDP, Chorus Pro, certificats de signature), ajoutez `client_uid` :  ```bash curl -X POST https://www.factpulse.fr/api/token/ \\   -H \"Content-Type: application/json\" \\   -d '{     \"username\": \"votre_email@example.com\",     \"password\": \"votre_mot_de_passe\",     \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\"   }' ```  Le `client_uid` sera inclus dans le JWT et permettra à l'API d'utiliser automatiquement : - Les credentials AFNOR/PDP configurés pour ce client - Les credentials Chorus Pro configurés pour ce client - Les certificats de signature électronique configurés pour ce client  **Réponse :** ```json {   \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\",  // Token d'accès (validité: 30 min)   \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\"  // Token de rafraîchissement (validité: 7 jours) } ```  **Avantages :** - ✅ Automatisation complète (CI/CD, scripts) - ✅ Gestion programmatique des tokens - ✅ Support du refresh token pour renouveler automatiquement l'accès - ✅ Intégration facile dans n'importe quel langage/outil  #### 🖥️ Méthode 2 : Génération via Dashboard (Alternative)  **URL :** https://www.factpulse.fr/dashboard/  Cette méthode convient pour des tests rapides ou une utilisation occasionnelle via l'interface graphique.  **Fonctionnement :** - Connectez-vous au dashboard - Utilisez les boutons \"Generate Test Token\" ou \"Generate Production Token\" - Fonctionne pour **tous** les utilisateurs (OAuth et email/password), sans nécessiter de mot de passe  **Types de tokens :** - **Token Test** : Validité 24h, quota 1000 appels/jour (gratuit) - **Token Production** : Validité 7 jours, quota selon votre forfait  **Avantages :** - ✅ Rapide pour tester l'API - ✅ Aucun mot de passe requis - ✅ Interface visuelle simple  **Inconvénients :** - ❌ Nécessite une action manuelle - ❌ Pas de refresh token - ❌ Moins adapté pour l'automatisation  ### 📚 Documentation complète  Pour plus d'informations sur l'authentification et l'utilisation de l'API : https://www.factpulse.fr/documentation-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
 
@@ -14,31 +14,31 @@ require 'date'
 require 'time'
 
 module FactPulse
-  # Informations d'une structure.
+  # Structure information.
   class StructureInfo < ApiModelBase
-    # ID Chorus Pro de la structure
-    attr_accessor :id_structure_cpp
+    # Chorus Pro structure ID
+    attr_accessor :structure_id
 
-    # Identifiant (SIRET, SIREN)
-    attr_accessor :identifiant_structure
+    # Identifier (SIRET, SIREN)
+    attr_accessor :structure_identifier
 
-    # Nom de la structure
-    attr_accessor :designation_structure
+    # Structure name
+    attr_accessor :structure_name
 
-    # Type d'identifiant
-    attr_accessor :type_identifiant_structure
+    # Identifier type
+    attr_accessor :structure_identifier_type
 
-    # Statut (ACTIVE, INACTIVE)
-    attr_accessor :statut
+    # Status (ACTIVE, INACTIVE)
+    attr_accessor :status
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id_structure_cpp' => :'id_structure_cpp',
-        :'identifiant_structure' => :'identifiant_structure',
-        :'designation_structure' => :'designation_structure',
-        :'type_identifiant_structure' => :'type_identifiant_structure',
-        :'statut' => :'statut'
+        :'structure_id' => :'structureId',
+        :'structure_identifier' => :'structureIdentifier',
+        :'structure_name' => :'structureName',
+        :'structure_identifier_type' => :'structureIdentifierType',
+        :'status' => :'status'
       }
     end
 
@@ -55,11 +55,11 @@ module FactPulse
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id_structure_cpp' => :'Integer',
-        :'identifiant_structure' => :'String',
-        :'designation_structure' => :'String',
-        :'type_identifiant_structure' => :'String',
-        :'statut' => :'String'
+        :'structure_id' => :'Integer',
+        :'structure_identifier' => :'String',
+        :'structure_name' => :'String',
+        :'structure_identifier_type' => :'String',
+        :'status' => :'String'
       }
     end
 
@@ -85,34 +85,34 @@ module FactPulse
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'id_structure_cpp')
-        self.id_structure_cpp = attributes[:'id_structure_cpp']
+      if attributes.key?(:'structure_id')
+        self.structure_id = attributes[:'structure_id']
       else
-        self.id_structure_cpp = nil
+        self.structure_id = nil
       end
 
-      if attributes.key?(:'identifiant_structure')
-        self.identifiant_structure = attributes[:'identifiant_structure']
+      if attributes.key?(:'structure_identifier')
+        self.structure_identifier = attributes[:'structure_identifier']
       else
-        self.identifiant_structure = nil
+        self.structure_identifier = nil
       end
 
-      if attributes.key?(:'designation_structure')
-        self.designation_structure = attributes[:'designation_structure']
+      if attributes.key?(:'structure_name')
+        self.structure_name = attributes[:'structure_name']
       else
-        self.designation_structure = nil
+        self.structure_name = nil
       end
 
-      if attributes.key?(:'type_identifiant_structure')
-        self.type_identifiant_structure = attributes[:'type_identifiant_structure']
+      if attributes.key?(:'structure_identifier_type')
+        self.structure_identifier_type = attributes[:'structure_identifier_type']
       else
-        self.type_identifiant_structure = nil
+        self.structure_identifier_type = nil
       end
 
-      if attributes.key?(:'statut')
-        self.statut = attributes[:'statut']
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
       else
-        self.statut = nil
+        self.status = nil
       end
     end
 
@@ -121,24 +121,24 @@ module FactPulse
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @id_structure_cpp.nil?
-        invalid_properties.push('invalid value for "id_structure_cpp", id_structure_cpp cannot be nil.')
+      if @structure_id.nil?
+        invalid_properties.push('invalid value for "structure_id", structure_id cannot be nil.')
       end
 
-      if @identifiant_structure.nil?
-        invalid_properties.push('invalid value for "identifiant_structure", identifiant_structure cannot be nil.')
+      if @structure_identifier.nil?
+        invalid_properties.push('invalid value for "structure_identifier", structure_identifier cannot be nil.')
       end
 
-      if @designation_structure.nil?
-        invalid_properties.push('invalid value for "designation_structure", designation_structure cannot be nil.')
+      if @structure_name.nil?
+        invalid_properties.push('invalid value for "structure_name", structure_name cannot be nil.')
       end
 
-      if @type_identifiant_structure.nil?
-        invalid_properties.push('invalid value for "type_identifiant_structure", type_identifiant_structure cannot be nil.')
+      if @structure_identifier_type.nil?
+        invalid_properties.push('invalid value for "structure_identifier_type", structure_identifier_type cannot be nil.')
       end
 
-      if @statut.nil?
-        invalid_properties.push('invalid value for "statut", statut cannot be nil.')
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
       end
 
       invalid_properties
@@ -148,62 +148,62 @@ module FactPulse
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @id_structure_cpp.nil?
-      return false if @identifiant_structure.nil?
-      return false if @designation_structure.nil?
-      return false if @type_identifiant_structure.nil?
-      return false if @statut.nil?
+      return false if @structure_id.nil?
+      return false if @structure_identifier.nil?
+      return false if @structure_name.nil?
+      return false if @structure_identifier_type.nil?
+      return false if @status.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] id_structure_cpp Value to be assigned
-    def id_structure_cpp=(id_structure_cpp)
-      if id_structure_cpp.nil?
-        fail ArgumentError, 'id_structure_cpp cannot be nil'
+    # @param [Object] structure_id Value to be assigned
+    def structure_id=(structure_id)
+      if structure_id.nil?
+        fail ArgumentError, 'structure_id cannot be nil'
       end
 
-      @id_structure_cpp = id_structure_cpp
+      @structure_id = structure_id
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] identifiant_structure Value to be assigned
-    def identifiant_structure=(identifiant_structure)
-      if identifiant_structure.nil?
-        fail ArgumentError, 'identifiant_structure cannot be nil'
+    # @param [Object] structure_identifier Value to be assigned
+    def structure_identifier=(structure_identifier)
+      if structure_identifier.nil?
+        fail ArgumentError, 'structure_identifier cannot be nil'
       end
 
-      @identifiant_structure = identifiant_structure
+      @structure_identifier = structure_identifier
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] designation_structure Value to be assigned
-    def designation_structure=(designation_structure)
-      if designation_structure.nil?
-        fail ArgumentError, 'designation_structure cannot be nil'
+    # @param [Object] structure_name Value to be assigned
+    def structure_name=(structure_name)
+      if structure_name.nil?
+        fail ArgumentError, 'structure_name cannot be nil'
       end
 
-      @designation_structure = designation_structure
+      @structure_name = structure_name
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] type_identifiant_structure Value to be assigned
-    def type_identifiant_structure=(type_identifiant_structure)
-      if type_identifiant_structure.nil?
-        fail ArgumentError, 'type_identifiant_structure cannot be nil'
+    # @param [Object] structure_identifier_type Value to be assigned
+    def structure_identifier_type=(structure_identifier_type)
+      if structure_identifier_type.nil?
+        fail ArgumentError, 'structure_identifier_type cannot be nil'
       end
 
-      @type_identifiant_structure = type_identifiant_structure
+      @structure_identifier_type = structure_identifier_type
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] statut Value to be assigned
-    def statut=(statut)
-      if statut.nil?
-        fail ArgumentError, 'statut cannot be nil'
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'status cannot be nil'
       end
 
-      @statut = statut
+      @status = status
     end
 
     # Checks equality by comparing each attribute.
@@ -211,11 +211,11 @@ module FactPulse
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id_structure_cpp == o.id_structure_cpp &&
-          identifiant_structure == o.identifiant_structure &&
-          designation_structure == o.designation_structure &&
-          type_identifiant_structure == o.type_identifiant_structure &&
-          statut == o.statut
+          structure_id == o.structure_id &&
+          structure_identifier == o.structure_identifier &&
+          structure_name == o.structure_name &&
+          structure_identifier_type == o.structure_identifier_type &&
+          status == o.status
     end
 
     # @see the `==` method
@@ -227,7 +227,7 @@ module FactPulse
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id_structure_cpp, identifiant_structure, designation_structure, type_identifiant_structure, statut].hash
+      [structure_id, structure_identifier, structure_name, structure_identifier_type, status].hash
     end
 
     # Builds the object from hash

data/lib/factpulse/models/structure_parameters.rb

@@ -0,0 +1,175 @@
+=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
+  # Mandatory structure parameters.
+  class StructureParameters < ApiModelBase
+    # Service code is mandatory
+    attr_accessor :service_code_required
+
+    # Engagement number is mandatory
+    attr_accessor :engagement_number_required
+
+    # EJ or service code management enabled
+    attr_accessor :engagement_or_service_management
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'service_code_required' => :'serviceCodeRequired',
+        :'engagement_number_required' => :'engagementNumberRequired',
+        :'engagement_or_service_management' => :'engagementOrServiceManagement'
+      }
+    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
+      {
+        :'service_code_required' => :'Boolean',
+        :'engagement_number_required' => :'Boolean',
+        :'engagement_or_service_management' => :'Boolean'
+      }
+    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::StructureParameters` 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::StructureParameters`. 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?(:'service_code_required')
+        self.service_code_required = attributes[:'service_code_required']
+      else
+        self.service_code_required = false
+      end
+
+      if attributes.key?(:'engagement_number_required')
+        self.engagement_number_required = attributes[:'engagement_number_required']
+      else
+        self.engagement_number_required = false
+      end
+
+      if attributes.key?(:'engagement_or_service_management')
+        self.engagement_or_service_management = attributes[:'engagement_or_service_management']
+      else
+        self.engagement_or_service_management = false
+      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
+      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'
+      true
+    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 &&
+          service_code_required == o.service_code_required &&
+          engagement_number_required == o.engagement_number_required &&
+          engagement_or_service_management == o.engagement_or_service_management
+    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
+      [service_code_required, engagement_number_required, engagement_or_service_management].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