factpulse 0.1.0

data/lib/factpulse/models/afnor_create_routing_code_body.rb

@@ -0,0 +1,412 @@
+=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
+  class AFNORCreateRoutingCodeBody < ApiModelBase
+    attr_accessor :facility_nature
+
+    # Routing identifier od a routing code.
+    attr_accessor :routing_identifier
+
+    # SIRET Number
+    attr_accessor :siret
+
+    # Routing Identifier type.
+    attr_accessor :routing_identifier_type
+
+    # Name of the directory line routing code. This attribute is only returned if the directory line is defined at the SIREN / SIRET / Routing code mesh.
+    attr_accessor :routing_code_name
+
+    # Indicates whether the public structure requires a legal commitment number. This attribute is only returned if the directory line is defined for a public structure at the SIREN / SIRET or SIREN / SIRET / Routing code level.
+    attr_accessor :manages_legal_commitment_code
+
+    attr_accessor :administrative_status
+
+    attr_accessor :address
+
+    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
+      {
+        :'facility_nature' => :'facilityNature',
+        :'routing_identifier' => :'routingIdentifier',
+        :'siret' => :'siret',
+        :'routing_identifier_type' => :'routingIdentifierType',
+        :'routing_code_name' => :'routingCodeName',
+        :'manages_legal_commitment_code' => :'managesLegalCommitmentCode',
+        :'administrative_status' => :'administrativeStatus',
+        :'address' => :'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
+      {
+        :'facility_nature' => :'AFNORFacilityNature',
+        :'routing_identifier' => :'String',
+        :'siret' => :'String',
+        :'routing_identifier_type' => :'String',
+        :'routing_code_name' => :'String',
+        :'manages_legal_commitment_code' => :'Boolean',
+        :'administrative_status' => :'AFNORRoutingCodeAdministrativeStatus',
+        :'address' => :'AFNORAddressEdit'
+      }
+    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::AFNORCreateRoutingCodeBody` 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::AFNORCreateRoutingCodeBody`. 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?(:'facility_nature')
+        self.facility_nature = attributes[:'facility_nature']
+      else
+        self.facility_nature = nil
+      end
+
+      if attributes.key?(:'routing_identifier')
+        self.routing_identifier = attributes[:'routing_identifier']
+      else
+        self.routing_identifier = nil
+      end
+
+      if attributes.key?(:'siret')
+        self.siret = attributes[:'siret']
+      else
+        self.siret = nil
+      end
+
+      if attributes.key?(:'routing_identifier_type')
+        self.routing_identifier_type = attributes[:'routing_identifier_type']
+      end
+
+      if attributes.key?(:'routing_code_name')
+        self.routing_code_name = attributes[:'routing_code_name']
+      else
+        self.routing_code_name = nil
+      end
+
+      if attributes.key?(:'manages_legal_commitment_code')
+        self.manages_legal_commitment_code = attributes[:'manages_legal_commitment_code']
+      end
+
+      if attributes.key?(:'administrative_status')
+        self.administrative_status = attributes[:'administrative_status']
+      else
+        self.administrative_status = nil
+      end
+
+      if attributes.key?(:'address')
+        self.address = attributes[:'address']
+      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 @facility_nature.nil?
+        invalid_properties.push('invalid value for "facility_nature", facility_nature cannot be nil.')
+      end
+
+      if @routing_identifier.nil?
+        invalid_properties.push('invalid value for "routing_identifier", routing_identifier cannot be nil.')
+      end
+
+      if @routing_identifier.to_s.length > 100
+        invalid_properties.push('invalid value for "routing_identifier", the character length must be smaller than or equal to 100.')
+      end
+
+      pattern = Regexp.new(/^(?!\s+$)[\-_\/a-zA-Z0-9]{1,100}$/)
+      if @routing_identifier !~ pattern
+        invalid_properties.push("invalid value for \"routing_identifier\", must conform to the pattern #{pattern}.")
+      end
+
+      if @siret.nil?
+        invalid_properties.push('invalid value for "siret", siret cannot be nil.')
+      end
+
+      if @siret.to_s.length > 14
+        invalid_properties.push('invalid value for "siret", the character length must be smaller than or equal to 14.')
+      end
+
+      pattern = Regexp.new(/^([0-9]{14})$/)
+      if @siret !~ pattern
+        invalid_properties.push("invalid value for \"siret\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@routing_identifier_type.nil? && @routing_identifier_type.to_s.length > 4
+        invalid_properties.push('invalid value for "routing_identifier_type", the character length must be smaller than or equal to 4.')
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if !@routing_identifier_type.nil? && @routing_identifier_type !~ pattern
+        invalid_properties.push("invalid value for \"routing_identifier_type\", must conform to the pattern #{pattern}.")
+      end
+
+      if @routing_code_name.nil?
+        invalid_properties.push('invalid value for "routing_code_name", routing_code_name cannot be nil.')
+      end
+
+      if @routing_code_name.to_s.length > 100
+        invalid_properties.push('invalid value for "routing_code_name", the character length must be smaller than or equal to 100.')
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if @routing_code_name !~ pattern
+        invalid_properties.push("invalid value for \"routing_code_name\", must conform to the pattern #{pattern}.")
+      end
+
+      if @administrative_status.nil?
+        invalid_properties.push('invalid value for "administrative_status", administrative_status 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 @facility_nature.nil?
+      return false if @routing_identifier.nil?
+      return false if @routing_identifier.to_s.length > 100
+      return false if @routing_identifier !~ Regexp.new(/^(?!\s+$)[\-_\/a-zA-Z0-9]{1,100}$/)
+      return false if @siret.nil?
+      return false if @siret.to_s.length > 14
+      return false if @siret !~ Regexp.new(/^([0-9]{14})$/)
+      return false if !@routing_identifier_type.nil? && @routing_identifier_type.to_s.length > 4
+      return false if !@routing_identifier_type.nil? && @routing_identifier_type !~ Regexp.new(/^(?!\s*$).+/)
+      return false if @routing_code_name.nil?
+      return false if @routing_code_name.to_s.length > 100
+      return false if @routing_code_name !~ Regexp.new(/^(?!\s*$).+/)
+      return false if @administrative_status.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] facility_nature Value to be assigned
+    def facility_nature=(facility_nature)
+      if facility_nature.nil?
+        fail ArgumentError, 'facility_nature cannot be nil'
+      end
+
+      @facility_nature = facility_nature
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] routing_identifier Value to be assigned
+    def routing_identifier=(routing_identifier)
+      if routing_identifier.nil?
+        fail ArgumentError, 'routing_identifier cannot be nil'
+      end
+
+      if routing_identifier.to_s.length > 100
+        fail ArgumentError, 'invalid value for "routing_identifier", the character length must be smaller than or equal to 100.'
+      end
+
+      pattern = Regexp.new(/^(?!\s+$)[\-_\/a-zA-Z0-9]{1,100}$/)
+      if routing_identifier !~ pattern
+        fail ArgumentError, "invalid value for \"routing_identifier\", must conform to the pattern #{pattern}."
+      end
+
+      @routing_identifier = routing_identifier
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] siret Value to be assigned
+    def siret=(siret)
+      if siret.nil?
+        fail ArgumentError, 'siret cannot be nil'
+      end
+
+      if siret.to_s.length > 14
+        fail ArgumentError, 'invalid value for "siret", the character length must be smaller than or equal to 14.'
+      end
+
+      pattern = Regexp.new(/^([0-9]{14})$/)
+      if siret !~ pattern
+        fail ArgumentError, "invalid value for \"siret\", must conform to the pattern #{pattern}."
+      end
+
+      @siret = siret
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] routing_identifier_type Value to be assigned
+    def routing_identifier_type=(routing_identifier_type)
+      if routing_identifier_type.nil?
+        fail ArgumentError, 'routing_identifier_type cannot be nil'
+      end
+
+      if routing_identifier_type.to_s.length > 4
+        fail ArgumentError, 'invalid value for "routing_identifier_type", the character length must be smaller than or equal to 4.'
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if routing_identifier_type !~ pattern
+        fail ArgumentError, "invalid value for \"routing_identifier_type\", must conform to the pattern #{pattern}."
+      end
+
+      @routing_identifier_type = routing_identifier_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] routing_code_name Value to be assigned
+    def routing_code_name=(routing_code_name)
+      if routing_code_name.nil?
+        fail ArgumentError, 'routing_code_name cannot be nil'
+      end
+
+      if routing_code_name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "routing_code_name", the character length must be smaller than or equal to 100.'
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if routing_code_name !~ pattern
+        fail ArgumentError, "invalid value for \"routing_code_name\", must conform to the pattern #{pattern}."
+      end
+
+      @routing_code_name = routing_code_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] administrative_status Value to be assigned
+    def administrative_status=(administrative_status)
+      if administrative_status.nil?
+        fail ArgumentError, 'administrative_status cannot be nil'
+      end
+
+      @administrative_status = administrative_status
+    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 &&
+          facility_nature == o.facility_nature &&
+          routing_identifier == o.routing_identifier &&
+          siret == o.siret &&
+          routing_identifier_type == o.routing_identifier_type &&
+          routing_code_name == o.routing_code_name &&
+          manages_legal_commitment_code == o.manages_legal_commitment_code &&
+          administrative_status == o.administrative_status &&
+          address == o.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
+      [facility_nature, routing_identifier, siret, routing_identifier_type, routing_code_name, manages_legal_commitment_code, administrative_status, 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/afnor_credentials.rb

@@ -0,0 +1,169 @@
+=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
+  # Optional AFNOR PDP credentials.  **MODE 1 - JWT retrieval (recommended):** Do not provide this `credentials` field in the payload. PDP credentials will be automatically retrieved via client_uid from JWT (0-trust).  **MODE 2 - Credentials in payload (zero-storage):** Provide all required fields below. Useful for tests or third-party integrations.
+  class AFNORCredentials < ApiModelBase
+    attr_accessor :client_id
+
+    attr_accessor :client_secret
+
+    attr_accessor :flow_service_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'client_id' => :'clientId',
+        :'client_secret' => :'clientSecret',
+        :'flow_service_url' => :'flowServiceUrl'
+      }
+    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
+      {
+        :'client_id' => :'String',
+        :'client_secret' => :'String',
+        :'flow_service_url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'client_id',
+        :'client_secret',
+        :'flow_service_url'
+      ])
+    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::AFNORCredentials` 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::AFNORCredentials`. 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?(:'client_id')
+        self.client_id = attributes[:'client_id']
+      end
+
+      if attributes.key?(:'client_secret')
+        self.client_secret = attributes[:'client_secret']
+      end
+
+      if attributes.key?(:'flow_service_url')
+        self.flow_service_url = attributes[:'flow_service_url']
+      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 &&
+          client_id == o.client_id &&
+          client_secret == o.client_secret &&
+          flow_service_url == o.flow_service_url
+    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
+      [client_id, client_secret, flow_service_url].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