factpulse 2.0.42 → 3.0.0

data/lib/factpulse/models/verification_success_response.rb

@@ -0,0 +1,343 @@
+=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
+  # Successful verification response with unified data.
+  class VerificationSuccessResponse < ApiModelBase
+    # True if no critical discrepancy
+    attr_accessor :is_compliant
+
+    # Compliance score (0-100%)
+    attr_accessor :compliance_score
+
+    # Number of verified fields
+    attr_accessor :verified_fields_count
+
+    # Number of compliant fields
+    attr_accessor :compliant_fields_count
+
+    # True if PDF contains Factur-X XML
+    attr_accessor :is_facturx
+
+    attr_accessor :facturx_profile
+
+    # List of verified fields with values, statuses and PDF coordinates
+    attr_accessor :fields
+
+    # Mandatory notes (PMT, PMD, AAB) with PDF location
+    attr_accessor :mandatory_notes
+
+    # Dimensions of each PDF page (width, height)
+    attr_accessor :page_dimensions
+
+    # Non-blocking warnings
+    attr_accessor :warnings
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'is_compliant' => :'isCompliant',
+        :'compliance_score' => :'complianceScore',
+        :'verified_fields_count' => :'verifiedFieldsCount',
+        :'compliant_fields_count' => :'compliantFieldsCount',
+        :'is_facturx' => :'isFacturx',
+        :'facturx_profile' => :'facturxProfile',
+        :'fields' => :'fields',
+        :'mandatory_notes' => :'mandatoryNotes',
+        :'page_dimensions' => :'pageDimensions',
+        :'warnings' => :'warnings'
+      }
+    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
+      {
+        :'is_compliant' => :'Boolean',
+        :'compliance_score' => :'Float',
+        :'verified_fields_count' => :'Integer',
+        :'compliant_fields_count' => :'Integer',
+        :'is_facturx' => :'Boolean',
+        :'facturx_profile' => :'String',
+        :'fields' => :'Array<VerifiedFieldSchema>',
+        :'mandatory_notes' => :'Array<MandatoryNoteSchema>',
+        :'page_dimensions' => :'Array<PageDimensionsSchema>',
+        :'warnings' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'facturx_profile',
+      ])
+    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::VerificationSuccessResponse` 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::VerificationSuccessResponse`. 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?(:'is_compliant')
+        self.is_compliant = attributes[:'is_compliant']
+      else
+        self.is_compliant = nil
+      end
+
+      if attributes.key?(:'compliance_score')
+        self.compliance_score = attributes[:'compliance_score']
+      else
+        self.compliance_score = nil
+      end
+
+      if attributes.key?(:'verified_fields_count')
+        self.verified_fields_count = attributes[:'verified_fields_count']
+      else
+        self.verified_fields_count = 0
+      end
+
+      if attributes.key?(:'compliant_fields_count')
+        self.compliant_fields_count = attributes[:'compliant_fields_count']
+      else
+        self.compliant_fields_count = 0
+      end
+
+      if attributes.key?(:'is_facturx')
+        self.is_facturx = attributes[:'is_facturx']
+      else
+        self.is_facturx = false
+      end
+
+      if attributes.key?(:'facturx_profile')
+        self.facturx_profile = attributes[:'facturx_profile']
+      end
+
+      if attributes.key?(:'fields')
+        if (value = attributes[:'fields']).is_a?(Array)
+          self.fields = value
+        end
+      end
+
+      if attributes.key?(:'mandatory_notes')
+        if (value = attributes[:'mandatory_notes']).is_a?(Array)
+          self.mandatory_notes = value
+        end
+      end
+
+      if attributes.key?(:'page_dimensions')
+        if (value = attributes[:'page_dimensions']).is_a?(Array)
+          self.page_dimensions = value
+        end
+      end
+
+      if attributes.key?(:'warnings')
+        if (value = attributes[:'warnings']).is_a?(Array)
+          self.warnings = value
+        end
+      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 @is_compliant.nil?
+        invalid_properties.push('invalid value for "is_compliant", is_compliant cannot be nil.')
+      end
+
+      if @compliance_score.nil?
+        invalid_properties.push('invalid value for "compliance_score", compliance_score cannot be nil.')
+      end
+
+      if @compliance_score > 100.0
+        invalid_properties.push('invalid value for "compliance_score", must be smaller than or equal to 100.0.')
+      end
+
+      if @compliance_score < 0.0
+        invalid_properties.push('invalid value for "compliance_score", must be greater than or equal to 0.0.')
+      end
+
+      if !@verified_fields_count.nil? && @verified_fields_count < 0
+        invalid_properties.push('invalid value for "verified_fields_count", must be greater than or equal to 0.')
+      end
+
+      if !@compliant_fields_count.nil? && @compliant_fields_count < 0
+        invalid_properties.push('invalid value for "compliant_fields_count", must be greater than or equal to 0.')
+      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 @is_compliant.nil?
+      return false if @compliance_score.nil?
+      return false if @compliance_score > 100.0
+      return false if @compliance_score < 0.0
+      return false if !@verified_fields_count.nil? && @verified_fields_count < 0
+      return false if !@compliant_fields_count.nil? && @compliant_fields_count < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] is_compliant Value to be assigned
+    def is_compliant=(is_compliant)
+      if is_compliant.nil?
+        fail ArgumentError, 'is_compliant cannot be nil'
+      end
+
+      @is_compliant = is_compliant
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] compliance_score Value to be assigned
+    def compliance_score=(compliance_score)
+      if compliance_score.nil?
+        fail ArgumentError, 'compliance_score cannot be nil'
+      end
+
+      if compliance_score > 100.0
+        fail ArgumentError, 'invalid value for "compliance_score", must be smaller than or equal to 100.0.'
+      end
+
+      if compliance_score < 0.0
+        fail ArgumentError, 'invalid value for "compliance_score", must be greater than or equal to 0.0.'
+      end
+
+      @compliance_score = compliance_score
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] verified_fields_count Value to be assigned
+    def verified_fields_count=(verified_fields_count)
+      if verified_fields_count.nil?
+        fail ArgumentError, 'verified_fields_count cannot be nil'
+      end
+
+      if verified_fields_count < 0
+        fail ArgumentError, 'invalid value for "verified_fields_count", must be greater than or equal to 0.'
+      end
+
+      @verified_fields_count = verified_fields_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] compliant_fields_count Value to be assigned
+    def compliant_fields_count=(compliant_fields_count)
+      if compliant_fields_count.nil?
+        fail ArgumentError, 'compliant_fields_count cannot be nil'
+      end
+
+      if compliant_fields_count < 0
+        fail ArgumentError, 'invalid value for "compliant_fields_count", must be greater than or equal to 0.'
+      end
+
+      @compliant_fields_count = compliant_fields_count
+    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 &&
+          is_compliant == o.is_compliant &&
+          compliance_score == o.compliance_score &&
+          verified_fields_count == o.verified_fields_count &&
+          compliant_fields_count == o.compliant_fields_count &&
+          is_facturx == o.is_facturx &&
+          facturx_profile == o.facturx_profile &&
+          fields == o.fields &&
+          mandatory_notes == o.mandatory_notes &&
+          page_dimensions == o.page_dimensions &&
+          warnings == o.warnings
+    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
+      [is_compliant, compliance_score, verified_fields_count, compliant_fields_count, is_facturx, facturx_profile, fields, mandatory_notes, page_dimensions, warnings].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/verified_field_schema.rb

@@ -0,0 +1,334 @@
+=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
+  # A verified field with all its information (extraction + compliance + location).
+  class VerifiedFieldSchema < ApiModelBase
+    # EN16931 Business Term (e.g., BT-1)
+    attr_accessor :business_term
+
+    # Field label (e.g., Invoice Number)
+    attr_accessor :label
+
+    attr_accessor :pdf_value
+
+    attr_accessor :xml_value
+
+    # Compliance status
+    attr_accessor :status
+
+    attr_accessor :message
+
+    # Confidence score (0-1)
+    attr_accessor :confidence
+
+    # Extraction source
+    attr_accessor :source
+
+    attr_accessor :bbox
+
+    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
+      {
+        :'business_term' => :'businessTerm',
+        :'label' => :'label',
+        :'pdf_value' => :'pdfValue',
+        :'xml_value' => :'xmlValue',
+        :'status' => :'status',
+        :'message' => :'message',
+        :'confidence' => :'confidence',
+        :'source' => :'source',
+        :'bbox' => :'bbox'
+      }
+    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
+      {
+        :'business_term' => :'String',
+        :'label' => :'String',
+        :'pdf_value' => :'String',
+        :'xml_value' => :'String',
+        :'status' => :'FieldStatus',
+        :'message' => :'String',
+        :'confidence' => :'Float',
+        :'source' => :'String',
+        :'bbox' => :'BoundingBoxSchema'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'pdf_value',
+        :'xml_value',
+        :'message',
+        :'bbox'
+      ])
+    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::VerifiedFieldSchema` 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::VerifiedFieldSchema`. 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?(:'business_term')
+        self.business_term = attributes[:'business_term']
+      else
+        self.business_term = nil
+      end
+
+      if attributes.key?(:'label')
+        self.label = attributes[:'label']
+      else
+        self.label = nil
+      end
+
+      if attributes.key?(:'pdf_value')
+        self.pdf_value = attributes[:'pdf_value']
+      end
+
+      if attributes.key?(:'xml_value')
+        self.xml_value = attributes[:'xml_value']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'confidence')
+        self.confidence = attributes[:'confidence']
+      else
+        self.confidence = 1.0
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      else
+        self.source = 'native_pdf'
+      end
+
+      if attributes.key?(:'bbox')
+        self.bbox = attributes[:'bbox']
+      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 @business_term.nil?
+        invalid_properties.push('invalid value for "business_term", business_term cannot be nil.')
+      end
+
+      if @label.nil?
+        invalid_properties.push('invalid value for "label", label cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if !@confidence.nil? && @confidence > 1.0
+        invalid_properties.push('invalid value for "confidence", must be smaller than or equal to 1.0.')
+      end
+
+      if !@confidence.nil? && @confidence < 0.0
+        invalid_properties.push('invalid value for "confidence", must be greater than or equal to 0.0.')
+      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 @business_term.nil?
+      return false if @label.nil?
+      return false if @status.nil?
+      return false if !@confidence.nil? && @confidence > 1.0
+      return false if !@confidence.nil? && @confidence < 0.0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] business_term Value to be assigned
+    def business_term=(business_term)
+      if business_term.nil?
+        fail ArgumentError, 'business_term cannot be nil'
+      end
+
+      @business_term = business_term
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] label Value to be assigned
+    def label=(label)
+      if label.nil?
+        fail ArgumentError, 'label cannot be nil'
+      end
+
+      @label = label
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'status cannot be nil'
+      end
+
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] confidence Value to be assigned
+    def confidence=(confidence)
+      if confidence.nil?
+        fail ArgumentError, 'confidence cannot be nil'
+      end
+
+      if confidence > 1.0
+        fail ArgumentError, 'invalid value for "confidence", must be smaller than or equal to 1.0.'
+      end
+
+      if confidence < 0.0
+        fail ArgumentError, 'invalid value for "confidence", must be greater than or equal to 0.0.'
+      end
+
+      @confidence = confidence
+    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 &&
+          business_term == o.business_term &&
+          label == o.label &&
+          pdf_value == o.pdf_value &&
+          xml_value == o.xml_value &&
+          status == o.status &&
+          message == o.message &&
+          confidence == o.confidence &&
+          source == o.source &&
+          bbox == o.bbox
+    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
+      [business_term, label, pdf_value, xml_value, status, message, confidence, source, bbox].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