mailsafepro 1.0.0

data/lib/mailsafepro/models/email_response.rb

@@ -0,0 +1,454 @@
+=begin
+#Email Validation API — Enterprise-grade Email Verification
+
+#API robusta y segura para validación y verificación de correos electrónicos. Soporta verificación individual y en lote, detección de brechas, y autenticación JWT. Cumple con GDPR y dispone de planes de pago flexibles.  **🔗 Enlaces importantes:** - [Estado del sistema](https://mailsafepro.betteruptime.com) - [Documentación completa](https://email-validation-api-jlra.onrender.com/redoc)  **📧 Contacto:** mailsafepro1@gmail.com
+
+The version of the OpenAPI document: 2.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.18.0
+
+=end
+
+require 'date'
+require 'time'
+
+module MailSafePro
+  # Comprehensive email validation response
+  class EmailResponse < ApiModelBase
+    # Validated email address
+    attr_accessor :email
+
+    # Overall validation result
+    attr_accessor :valid
+
+    # Validation details summary
+    attr_accessor :detail
+
+    attr_accessor :processing_time
+
+    attr_accessor :provider
+
+    attr_accessor :reputation
+
+    attr_accessor :fingerprint
+
+    attr_accessor :quality_score
+
+    attr_accessor :risk_level
+
+    # Improvement suggestions
+    attr_accessor :suggestions
+
+    attr_accessor :smtp
+
+    attr_accessor :dns
+
+    attr_accessor :risk_score
+
+    attr_accessor :validation_tier
+
+    attr_accessor :suggested_action
+
+    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
+      {
+        :'email' => :'email',
+        :'valid' => :'valid',
+        :'detail' => :'detail',
+        :'processing_time' => :'processing_time',
+        :'provider' => :'provider',
+        :'reputation' => :'reputation',
+        :'fingerprint' => :'fingerprint',
+        :'quality_score' => :'quality_score',
+        :'risk_level' => :'risk_level',
+        :'suggestions' => :'suggestions',
+        :'smtp' => :'smtp',
+        :'dns' => :'dns',
+        :'risk_score' => :'risk_score',
+        :'validation_tier' => :'validation_tier',
+        :'suggested_action' => :'suggested_action'
+      }
+    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
+      {
+        :'email' => :'String',
+        :'valid' => :'Boolean',
+        :'detail' => :'String',
+        :'processing_time' => :'Float',
+        :'provider' => :'String',
+        :'reputation' => :'Float',
+        :'fingerprint' => :'String',
+        :'quality_score' => :'Float',
+        :'risk_level' => :'RiskLevelEnum',
+        :'suggestions' => :'Array<String>',
+        :'smtp' => :'SMTPInfo',
+        :'dns' => :'DNSInfo',
+        :'risk_score' => :'Float',
+        :'validation_tier' => :'String',
+        :'suggested_action' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'processing_time',
+        :'provider',
+        :'reputation',
+        :'fingerprint',
+        :'quality_score',
+        :'risk_level',
+        :'smtp',
+        :'dns',
+        :'risk_score',
+        :'validation_tier',
+        :'suggested_action'
+      ])
+    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 `MailSafePro::EmailResponse` 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 `MailSafePro::EmailResponse`. 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?(:'email')
+        self.email = attributes[:'email']
+      else
+        self.email = nil
+      end
+
+      if attributes.key?(:'valid')
+        self.valid = attributes[:'valid']
+      else
+        self.valid = nil
+      end
+
+      if attributes.key?(:'detail')
+        self.detail = attributes[:'detail']
+      else
+        self.detail = ''
+      end
+
+      if attributes.key?(:'processing_time')
+        self.processing_time = attributes[:'processing_time']
+      end
+
+      if attributes.key?(:'provider')
+        self.provider = attributes[:'provider']
+      end
+
+      if attributes.key?(:'reputation')
+        self.reputation = attributes[:'reputation']
+      end
+
+      if attributes.key?(:'fingerprint')
+        self.fingerprint = attributes[:'fingerprint']
+      end
+
+      if attributes.key?(:'quality_score')
+        self.quality_score = attributes[:'quality_score']
+      end
+
+      if attributes.key?(:'risk_level')
+        self.risk_level = attributes[:'risk_level']
+      end
+
+      if attributes.key?(:'suggestions')
+        if (value = attributes[:'suggestions']).is_a?(Array)
+          self.suggestions = value
+        end
+      end
+
+      if attributes.key?(:'smtp')
+        self.smtp = attributes[:'smtp']
+      end
+
+      if attributes.key?(:'dns')
+        self.dns = attributes[:'dns']
+      end
+
+      if attributes.key?(:'risk_score')
+        self.risk_score = attributes[:'risk_score']
+      end
+
+      if attributes.key?(:'validation_tier')
+        self.validation_tier = attributes[:'validation_tier']
+      end
+
+      if attributes.key?(:'suggested_action')
+        self.suggested_action = attributes[:'suggested_action']
+      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 @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      if @email.to_s.length > 254
+        invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 254.')
+      end
+
+      if @email.to_s.length < 5
+        invalid_properties.push('invalid value for "email", the character length must be greater than or equal to 5.')
+      end
+
+      if @valid.nil?
+        invalid_properties.push('invalid value for "valid", valid cannot be nil.')
+      end
+
+      if !@processing_time.nil? && @processing_time < 0.0
+        invalid_properties.push('invalid value for "processing_time", must be greater than or equal to 0.0.')
+      end
+
+      if !@reputation.nil? && @reputation > 1.0
+        invalid_properties.push('invalid value for "reputation", must be smaller than or equal to 1.0.')
+      end
+
+      if !@reputation.nil? && @reputation < 0.0
+        invalid_properties.push('invalid value for "reputation", must be greater than or equal to 0.0.')
+      end
+
+      if !@quality_score.nil? && @quality_score > 1.0
+        invalid_properties.push('invalid value for "quality_score", must be smaller than or equal to 1.0.')
+      end
+
+      if !@quality_score.nil? && @quality_score < 0.0
+        invalid_properties.push('invalid value for "quality_score", must be greater than or equal to 0.0.')
+      end
+
+      if !@risk_score.nil? && @risk_score > 1.0
+        invalid_properties.push('invalid value for "risk_score", must be smaller than or equal to 1.0.')
+      end
+
+      if !@risk_score.nil? && @risk_score < 0.0
+        invalid_properties.push('invalid value for "risk_score", 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 @email.nil?
+      return false if @email.to_s.length > 254
+      return false if @email.to_s.length < 5
+      return false if @valid.nil?
+      return false if !@processing_time.nil? && @processing_time < 0.0
+      return false if !@reputation.nil? && @reputation > 1.0
+      return false if !@reputation.nil? && @reputation < 0.0
+      return false if !@quality_score.nil? && @quality_score > 1.0
+      return false if !@quality_score.nil? && @quality_score < 0.0
+      return false if !@risk_score.nil? && @risk_score > 1.0
+      return false if !@risk_score.nil? && @risk_score < 0.0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      if email.nil?
+        fail ArgumentError, 'email cannot be nil'
+      end
+
+      if email.to_s.length > 254
+        fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 254.'
+      end
+
+      if email.to_s.length < 5
+        fail ArgumentError, 'invalid value for "email", the character length must be greater than or equal to 5.'
+      end
+
+      @email = email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] valid Value to be assigned
+    def valid=(valid)
+      if valid.nil?
+        fail ArgumentError, 'valid cannot be nil'
+      end
+
+      @valid = valid
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] processing_time Value to be assigned
+    def processing_time=(processing_time)
+      if !processing_time.nil? && processing_time < 0.0
+        fail ArgumentError, 'invalid value for "processing_time", must be greater than or equal to 0.0.'
+      end
+
+      @processing_time = processing_time
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reputation Value to be assigned
+    def reputation=(reputation)
+      if !reputation.nil? && reputation > 1.0
+        fail ArgumentError, 'invalid value for "reputation", must be smaller than or equal to 1.0.'
+      end
+
+      if !reputation.nil? && reputation < 0.0
+        fail ArgumentError, 'invalid value for "reputation", must be greater than or equal to 0.0.'
+      end
+
+      @reputation = reputation
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] quality_score Value to be assigned
+    def quality_score=(quality_score)
+      if !quality_score.nil? && quality_score > 1.0
+        fail ArgumentError, 'invalid value for "quality_score", must be smaller than or equal to 1.0.'
+      end
+
+      if !quality_score.nil? && quality_score < 0.0
+        fail ArgumentError, 'invalid value for "quality_score", must be greater than or equal to 0.0.'
+      end
+
+      @quality_score = quality_score
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] risk_score Value to be assigned
+    def risk_score=(risk_score)
+      if !risk_score.nil? && risk_score > 1.0
+        fail ArgumentError, 'invalid value for "risk_score", must be smaller than or equal to 1.0.'
+      end
+
+      if !risk_score.nil? && risk_score < 0.0
+        fail ArgumentError, 'invalid value for "risk_score", must be greater than or equal to 0.0.'
+      end
+
+      @risk_score = risk_score
+    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 &&
+          email == o.email &&
+          valid == o.valid &&
+          detail == o.detail &&
+          processing_time == o.processing_time &&
+          provider == o.provider &&
+          reputation == o.reputation &&
+          fingerprint == o.fingerprint &&
+          quality_score == o.quality_score &&
+          risk_level == o.risk_level &&
+          suggestions == o.suggestions &&
+          smtp == o.smtp &&
+          dns == o.dns &&
+          risk_score == o.risk_score &&
+          validation_tier == o.validation_tier &&
+          suggested_action == o.suggested_action
+    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
+      [email, valid, detail, processing_time, provider, reputation, fingerprint, quality_score, risk_level, suggestions, smtp, dns, risk_score, validation_tier, suggested_action].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/mailsafepro/models/email_validation_request.rb

@@ -0,0 +1,252 @@
+=begin
+#Email Validation API — Enterprise-grade Email Verification
+
+#API robusta y segura para validación y verificación de correos electrónicos. Soporta verificación individual y en lote, detección de brechas, y autenticación JWT. Cumple con GDPR y dispone de planes de pago flexibles.  **🔗 Enlaces importantes:** - [Estado del sistema](https://mailsafepro.betteruptime.com) - [Documentación completa](https://email-validation-api-jlra.onrender.com/redoc)  **📧 Contacto:** mailsafepro1@gmail.com
+
+The version of the OpenAPI document: 2.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.18.0
+
+=end
+
+require 'date'
+require 'time'
+
+module MailSafePro
+  # Request model for single email validation
+  class EmailValidationRequest < ApiModelBase
+    # Email address to validate (RFC 5321 compliant)
+    attr_accessor :email
+
+    # Enable SMTP mailbox verification
+    attr_accessor :check_smtp
+
+    # Include raw DNS records
+    attr_accessor :include_raw_dns
+
+    # Enable testing mode (allows special TLDs like .test, .example, etc.)
+    attr_accessor :testing_mode
+
+    # Validation priority level
+    attr_accessor :priority
+
+    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
+      {
+        :'email' => :'email',
+        :'check_smtp' => :'check_smtp',
+        :'include_raw_dns' => :'include_raw_dns',
+        :'testing_mode' => :'testing_mode',
+        :'priority' => :'priority'
+      }
+    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
+      {
+        :'email' => :'String',
+        :'check_smtp' => :'Boolean',
+        :'include_raw_dns' => :'Boolean',
+        :'testing_mode' => :'Boolean',
+        :'priority' => :'PriorityEnum'
+      }
+    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 `MailSafePro::EmailValidationRequest` 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 `MailSafePro::EmailValidationRequest`. 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?(:'email')
+        self.email = attributes[:'email']
+      else
+        self.email = nil
+      end
+
+      if attributes.key?(:'check_smtp')
+        self.check_smtp = attributes[:'check_smtp']
+      else
+        self.check_smtp = false
+      end
+
+      if attributes.key?(:'include_raw_dns')
+        self.include_raw_dns = attributes[:'include_raw_dns']
+      else
+        self.include_raw_dns = false
+      end
+
+      if attributes.key?(:'testing_mode')
+        self.testing_mode = attributes[:'testing_mode']
+      else
+        self.testing_mode = false
+      end
+
+      if attributes.key?(:'priority')
+        self.priority = attributes[:'priority']
+      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 @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      if @email.to_s.length > 320
+        invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 320.')
+      end
+
+      if @email.to_s.length < 3
+        invalid_properties.push('invalid value for "email", the character length must be greater than or equal to 3.')
+      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 @email.nil?
+      return false if @email.to_s.length > 320
+      return false if @email.to_s.length < 3
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      if email.nil?
+        fail ArgumentError, 'email cannot be nil'
+      end
+
+      if email.to_s.length > 320
+        fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 320.'
+      end
+
+      if email.to_s.length < 3
+        fail ArgumentError, 'invalid value for "email", the character length must be greater than or equal to 3.'
+      end
+
+      @email = email
+    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 &&
+          email == o.email &&
+          check_smtp == o.check_smtp &&
+          include_raw_dns == o.include_raw_dns &&
+          testing_mode == o.testing_mode &&
+          priority == o.priority
+    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
+      [email, check_smtp, include_raw_dns, testing_mode, priority].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