mailsafepro 1.0.0

data/lib/mailsafepro/models/webhook_response.rb

@@ -0,0 +1,185 @@
+=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
+  # Respuesta genérica para el webhook.
+  class WebhookResponse < ApiModelBase
+    attr_accessor :status
+
+    attr_accessor :event_id
+
+    attr_accessor :message
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'status' => :'status',
+        :'event_id' => :'event_id',
+        :'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
+      {
+        :'status' => :'String',
+        :'event_id' => :'String',
+        :'message' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'event_id',
+        :'message'
+      ])
+    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::WebhookResponse` 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::WebhookResponse`. 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?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'event_id')
+        self.event_id = attributes[:'event_id']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      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 @status.nil?
+        invalid_properties.push('invalid value for "status", 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 @status.nil?
+      true
+    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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          status == o.status &&
+          event_id == o.event_id &&
+          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
+      [status, event_id, 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/mailsafepro/models/webhook_update.rb

@@ -0,0 +1,204 @@
+=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
+  class WebhookUpdate < ApiModelBase
+    attr_accessor :url
+
+    attr_accessor :events
+
+    attr_accessor :status
+
+    attr_accessor :description
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'url' => :'url',
+        :'events' => :'events',
+        :'status' => :'status',
+        :'description' => :'description'
+      }
+    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
+      {
+        :'url' => :'String',
+        :'events' => :'Array<String>',
+        :'status' => :'String',
+        :'description' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'url',
+        :'events',
+        :'status',
+        :'description'
+      ])
+    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::WebhookUpdate` 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::WebhookUpdate`. 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?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'events')
+        if (value = attributes[:'events']).is_a?(Array)
+          self.events = value
+        end
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      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 !@url.nil? && @url.to_s.length > 2083
+        invalid_properties.push('invalid value for "url", the character length must be smaller than or equal to 2083.')
+      end
+
+      if !@url.nil? && @url.to_s.length < 1
+        invalid_properties.push('invalid value for "url", the character length must be greater than or equal to 1.')
+      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 !@url.nil? && @url.to_s.length > 2083
+      return false if !@url.nil? && @url.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] url Value to be assigned
+    def url=(url)
+      if !url.nil? && url.to_s.length > 2083
+        fail ArgumentError, 'invalid value for "url", the character length must be smaller than or equal to 2083.'
+      end
+
+      if !url.nil? && url.to_s.length < 1
+        fail ArgumentError, 'invalid value for "url", the character length must be greater than or equal to 1.'
+      end
+
+      @url = url
+    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 &&
+          url == o.url &&
+          events == o.events &&
+          status == o.status &&
+          description == o.description
+    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
+      [url, events, status, description].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/version.rb

@@ -0,0 +1,15 @@
+=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
+
+module MailSafePro
+  VERSION = '1.0.0'
+end

data/lib/mailsafepro.rb

@@ -0,0 +1,88 @@
+=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
+
+# Common files
+require 'mailsafepro/api_client'
+require 'mailsafepro/api_error'
+require 'mailsafepro/api_model_base'
+require 'mailsafepro/version'
+require 'mailsafepro/configuration'
+
+# Models
+require 'mailsafepro/models/api_key_create_request'
+require 'mailsafepro/models/api_key_list_response'
+require 'mailsafepro/models/api_key_meta'
+require 'mailsafepro/models/batch_email_response'
+require 'mailsafepro/models/batch_validation_request'
+require 'mailsafepro/models/body_change_plan_billing_billing_change_plan_post'
+require 'mailsafepro/models/checkout_request'
+require 'mailsafepro/models/checkout_session_response'
+require 'mailsafepro/models/dns_info'
+require 'mailsafepro/models/dns_record_dkim'
+require 'mailsafepro/models/dns_record_dmarc'
+require 'mailsafepro/models/dns_record_spf'
+require 'mailsafepro/models/email_response'
+require 'mailsafepro/models/email_validation_request'
+require 'mailsafepro/models/http_validation_error'
+require 'mailsafepro/models/job_create_request'
+require 'mailsafepro/models/job_create_response'
+require 'mailsafepro/models/job_result_entry'
+require 'mailsafepro/models/job_results_page'
+require 'mailsafepro/models/job_status_response'
+require 'mailsafepro/models/key_rotation_request'
+require 'mailsafepro/models/plan_enum'
+require 'mailsafepro/models/priority_enum'
+require 'mailsafepro/models/register_endpoint'
+require 'mailsafepro/models/response_test_notification_billing_billing_test_notification_post_value'
+require 'mailsafepro/models/risk_level_enum'
+require 'mailsafepro/models/rotate_secret'
+require 'mailsafepro/models/smtp_info'
+require 'mailsafepro/models/subscription_response'
+require 'mailsafepro/models/user_login'
+require 'mailsafepro/models/user_register'
+require 'mailsafepro/models/validation_error'
+require 'mailsafepro/models/validation_error_loc_inner'
+require 'mailsafepro/models/webhook_create'
+require 'mailsafepro/models/webhook_response'
+require 'mailsafepro/models/webhook_update'
+
+# APIs
+require 'mailsafepro/api/api_keys_api'
+require 'mailsafepro/api/authentication_api'
+require 'mailsafepro/api/billing_api'
+require 'mailsafepro/api/default_api'
+require 'mailsafepro/api/developer_tools_api'
+require 'mailsafepro/api/email_validation_api'
+require 'mailsafepro/api/health_api'
+require 'mailsafepro/api/jobs_api'
+require 'mailsafepro/api/logs_api'
+require 'mailsafepro/api/validation_api'
+require 'mailsafepro/api/webhooks_api'
+require 'mailsafepro/api/webhooks_management_api'
+
+module MailSafePro
+  class << self
+    # Customize default settings for the SDK using block.
+    #   MailSafePro.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/mailsafepro.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=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
+
+$:.push File.expand_path("../lib", __FILE__)
+require "mailsafepro/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mailsafepro"
+  s.version     = MailSafePro::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["MailSafePro"]
+  s.email       = ["support@mailsafepro.com"]
+  s.homepage    = "https://github.com/mailsafepro/mailsafepro-ruby"
+  s.summary     = "Ruby SDK for MailSafePro Email Validation API"
+  s.description = "Ruby SDK for MailSafePro Email Validation API. Robust and secure email validation and verification with batch processing, breach detection, and JWT authentication. GDPR compliant."
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.7"
+  s.metadata    = {}
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end