factpulse 2.0.42 → 3.0.0

data/lib/factpulse/models/submit_complete_invoice_response.rb

@@ -0,0 +1,355 @@
+=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
+  # Complete response after automated submission.
+  class SubmitCompleteInvoiceResponse < ApiModelBase
+    # Invoice was successfully submitted
+    attr_accessor :success
+
+    # Destination type
+    attr_accessor :destination_type
+
+    attr_accessor :chorus_result
+
+    attr_accessor :afnor_result
+
+    # Enriched invoice data
+    attr_accessor :enriched_invoice
+
+    # Generated PDF information
+    attr_accessor :facturx_pdf
+
+    attr_accessor :signature
+
+    # Generated Factur-X PDF (and signed if requested) base64-encoded
+    attr_accessor :pdf_base64
+
+    # Return message
+    attr_accessor :message
+
+    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
+      {
+        :'success' => :'success',
+        :'destination_type' => :'destinationType',
+        :'chorus_result' => :'chorusResult',
+        :'afnor_result' => :'afnorResult',
+        :'enriched_invoice' => :'enrichedInvoice',
+        :'facturx_pdf' => :'facturxPdf',
+        :'signature' => :'signature',
+        :'pdf_base64' => :'pdfBase64',
+        :'message' => :'message'
+      }
+    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
+      {
+        :'success' => :'Boolean',
+        :'destination_type' => :'String',
+        :'chorus_result' => :'ChorusProResult',
+        :'afnor_result' => :'AFNORResult',
+        :'enriched_invoice' => :'EnrichedInvoiceInfo',
+        :'facturx_pdf' => :'FacturXPDFInfo',
+        :'signature' => :'SignatureInfo',
+        :'pdf_base64' => :'String',
+        :'message' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'chorus_result',
+        :'afnor_result',
+        :'signature',
+      ])
+    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::SubmitCompleteInvoiceResponse` 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::SubmitCompleteInvoiceResponse`. 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?(:'success')
+        self.success = attributes[:'success']
+      else
+        self.success = nil
+      end
+
+      if attributes.key?(:'destination_type')
+        self.destination_type = attributes[:'destination_type']
+      else
+        self.destination_type = nil
+      end
+
+      if attributes.key?(:'chorus_result')
+        self.chorus_result = attributes[:'chorus_result']
+      end
+
+      if attributes.key?(:'afnor_result')
+        self.afnor_result = attributes[:'afnor_result']
+      end
+
+      if attributes.key?(:'enriched_invoice')
+        self.enriched_invoice = attributes[:'enriched_invoice']
+      else
+        self.enriched_invoice = nil
+      end
+
+      if attributes.key?(:'facturx_pdf')
+        self.facturx_pdf = attributes[:'facturx_pdf']
+      else
+        self.facturx_pdf = nil
+      end
+
+      if attributes.key?(:'signature')
+        self.signature = attributes[:'signature']
+      end
+
+      if attributes.key?(:'pdf_base64')
+        self.pdf_base64 = attributes[:'pdf_base64']
+      else
+        self.pdf_base64 = nil
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      else
+        self.message = 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 @success.nil?
+        invalid_properties.push('invalid value for "success", success cannot be nil.')
+      end
+
+      if @destination_type.nil?
+        invalid_properties.push('invalid value for "destination_type", destination_type cannot be nil.')
+      end
+
+      if @enriched_invoice.nil?
+        invalid_properties.push('invalid value for "enriched_invoice", enriched_invoice cannot be nil.')
+      end
+
+      if @facturx_pdf.nil?
+        invalid_properties.push('invalid value for "facturx_pdf", facturx_pdf cannot be nil.')
+      end
+
+      if @pdf_base64.nil?
+        invalid_properties.push('invalid value for "pdf_base64", pdf_base64 cannot be nil.')
+      end
+
+      if @message.nil?
+        invalid_properties.push('invalid value for "message", message 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 @success.nil?
+      return false if @destination_type.nil?
+      destination_type_validator = EnumAttributeValidator.new('String', ["chorus_pro", "afnor"])
+      return false unless destination_type_validator.valid?(@destination_type)
+      return false if @enriched_invoice.nil?
+      return false if @facturx_pdf.nil?
+      return false if @pdf_base64.nil?
+      return false if @message.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] success Value to be assigned
+    def success=(success)
+      if success.nil?
+        fail ArgumentError, 'success cannot be nil'
+      end
+
+      @success = success
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] destination_type Object to be assigned
+    def destination_type=(destination_type)
+      validator = EnumAttributeValidator.new('String', ["chorus_pro", "afnor"])
+      unless validator.valid?(destination_type)
+        fail ArgumentError, "invalid value for \"destination_type\", must be one of #{validator.allowable_values}."
+      end
+      @destination_type = destination_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] enriched_invoice Value to be assigned
+    def enriched_invoice=(enriched_invoice)
+      if enriched_invoice.nil?
+        fail ArgumentError, 'enriched_invoice cannot be nil'
+      end
+
+      @enriched_invoice = enriched_invoice
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] facturx_pdf Value to be assigned
+    def facturx_pdf=(facturx_pdf)
+      if facturx_pdf.nil?
+        fail ArgumentError, 'facturx_pdf cannot be nil'
+      end
+
+      @facturx_pdf = facturx_pdf
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pdf_base64 Value to be assigned
+    def pdf_base64=(pdf_base64)
+      if pdf_base64.nil?
+        fail ArgumentError, 'pdf_base64 cannot be nil'
+      end
+
+      @pdf_base64 = pdf_base64
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] message Value to be assigned
+    def message=(message)
+      if message.nil?
+        fail ArgumentError, 'message cannot be nil'
+      end
+
+      @message = message
+    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 &&
+          success == o.success &&
+          destination_type == o.destination_type &&
+          chorus_result == o.chorus_result &&
+          afnor_result == o.afnor_result &&
+          enriched_invoice == o.enriched_invoice &&
+          facturx_pdf == o.facturx_pdf &&
+          signature == o.signature &&
+          pdf_base64 == o.pdf_base64 &&
+          message == o.message
+    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
+      [success, destination_type, chorus_result, afnor_result, enriched_invoice, facturx_pdf, signature, pdf_base64, message].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/submit_flow_request.rb

@@ -0,0 +1,238 @@
+=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
+  # Request to submit an invoice to a PDP/PA via AFNOR.
+  class SubmitFlowRequest < ApiModelBase
+    # Flow name (e.g., 'Invoice 2025-001')
+    attr_accessor :flow_name
+
+    # Flow syntax (CII for Factur-X)
+    attr_accessor :flow_syntax
+
+    attr_accessor :flow_profile
+
+    attr_accessor :tracking_id
+
+    attr_accessor :request_id
+
+    attr_accessor :pdp_credentials
+
+    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
+      {
+        :'flow_name' => :'flow_name',
+        :'flow_syntax' => :'flow_syntax',
+        :'flow_profile' => :'flow_profile',
+        :'tracking_id' => :'tracking_id',
+        :'request_id' => :'request_id',
+        :'pdp_credentials' => :'pdp_credentials'
+      }
+    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
+      {
+        :'flow_name' => :'String',
+        :'flow_syntax' => :'FlowSyntax',
+        :'flow_profile' => :'FlowProfile',
+        :'tracking_id' => :'String',
+        :'request_id' => :'String',
+        :'pdp_credentials' => :'PDPCredentials'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'flow_profile',
+        :'tracking_id',
+        :'request_id',
+        :'pdp_credentials'
+      ])
+    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::SubmitFlowRequest` 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::SubmitFlowRequest`. 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?(:'flow_name')
+        self.flow_name = attributes[:'flow_name']
+      else
+        self.flow_name = nil
+      end
+
+      if attributes.key?(:'flow_syntax')
+        self.flow_syntax = attributes[:'flow_syntax']
+      end
+
+      if attributes.key?(:'flow_profile')
+        self.flow_profile = attributes[:'flow_profile']
+      end
+
+      if attributes.key?(:'tracking_id')
+        self.tracking_id = attributes[:'tracking_id']
+      end
+
+      if attributes.key?(:'request_id')
+        self.request_id = attributes[:'request_id']
+      end
+
+      if attributes.key?(:'pdp_credentials')
+        self.pdp_credentials = attributes[:'pdp_credentials']
+      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 @flow_name.nil?
+        invalid_properties.push('invalid value for "flow_name", flow_name 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 @flow_name.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] flow_name Value to be assigned
+    def flow_name=(flow_name)
+      if flow_name.nil?
+        fail ArgumentError, 'flow_name cannot be nil'
+      end
+
+      @flow_name = flow_name
+    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 &&
+          flow_name == o.flow_name &&
+          flow_syntax == o.flow_syntax &&
+          flow_profile == o.flow_profile &&
+          tracking_id == o.tracking_id &&
+          request_id == o.request_id &&
+          pdp_credentials == o.pdp_credentials
+    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
+      [flow_name, flow_syntax, flow_profile, tracking_id, request_id, pdp_credentials].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