mailodds 1.0.0

data/lib/mailodds/models/validation_response_suppression_match.rb

@@ -0,0 +1,199 @@
+=begin
+#MailOdds Email Validation API
+
+#MailOdds provides email validation services to help maintain clean email lists  and improve deliverability. The API performs multiple validation checks including  format verification, domain validation, MX record checking, and disposable email detection.  ## Authentication  All API requests require authentication using a Bearer token. Include your API key  in the Authorization header:  ``` Authorization: Bearer YOUR_API_KEY ```  API keys can be created in the MailOdds dashboard.  ## Rate Limits  Rate limits vary by plan: - Free: 10 requests/minute - Starter: 60 requests/minute   - Pro: 300 requests/minute - Business: 1000 requests/minute - Enterprise: Custom limits  ## Response Format  All responses include: - `schema_version`: API schema version (currently \"1.0\") - `request_id`: Unique request identifier for debugging  Error responses include: - `error`: Machine-readable error code - `message`: Human-readable error description 
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mailodds.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Mailodds
+  class ValidationResponseSuppressionMatch < ApiModelBase
+    attr_accessor :matched
+
+    attr_accessor :match_type
+
+    attr_accessor :match_value
+
+    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
+      {
+        :'matched' => :'matched',
+        :'match_type' => :'match_type',
+        :'match_value' => :'match_value'
+      }
+    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
+      {
+        :'matched' => :'Boolean',
+        :'match_type' => :'String',
+        :'match_value' => :'String'
+      }
+    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 `Mailodds::ValidationResponseSuppressionMatch` 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 `Mailodds::ValidationResponseSuppressionMatch`. 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?(:'matched')
+        self.matched = attributes[:'matched']
+      end
+
+      if attributes.key?(:'match_type')
+        self.match_type = attributes[:'match_type']
+      end
+
+      if attributes.key?(:'match_value')
+        self.match_value = attributes[:'match_value']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      match_type_validator = EnumAttributeValidator.new('String', ["email", "domain"])
+      return false unless match_type_validator.valid?(@match_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] match_type Object to be assigned
+    def match_type=(match_type)
+      validator = EnumAttributeValidator.new('String', ["email", "domain"])
+      unless validator.valid?(match_type)
+        fail ArgumentError, "invalid value for \"match_type\", must be one of #{validator.allowable_values}."
+      end
+      @match_type = match_type
+    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 &&
+          matched == o.matched &&
+          match_type == o.match_type &&
+          match_value == o.match_value
+    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
+      [matched, match_type, match_value].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/mailodds/models/validation_result.rb

@@ -0,0 +1,183 @@
+=begin
+#MailOdds Email Validation API
+
+#MailOdds provides email validation services to help maintain clean email lists  and improve deliverability. The API performs multiple validation checks including  format verification, domain validation, MX record checking, and disposable email detection.  ## Authentication  All API requests require authentication using a Bearer token. Include your API key  in the Authorization header:  ``` Authorization: Bearer YOUR_API_KEY ```  API keys can be created in the MailOdds dashboard.  ## Rate Limits  Rate limits vary by plan: - Free: 10 requests/minute - Starter: 60 requests/minute   - Pro: 300 requests/minute - Business: 1000 requests/minute - Enterprise: Custom limits  ## Response Format  All responses include: - `schema_version`: API schema version (currently \"1.0\") - `request_id`: Unique request identifier for debugging  Error responses include: - `error`: Machine-readable error code - `message`: Human-readable error description 
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mailodds.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Mailodds
+  class ValidationResult < ApiModelBase
+    attr_accessor :email
+
+    attr_accessor :status
+
+    attr_accessor :sub_status
+
+    attr_accessor :action
+
+    attr_accessor :processed_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'status' => :'status',
+        :'sub_status' => :'sub_status',
+        :'action' => :'action',
+        :'processed_at' => :'processed_at'
+      }
+    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',
+        :'status' => :'String',
+        :'sub_status' => :'String',
+        :'action' => :'String',
+        :'processed_at' => :'Time'
+      }
+    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 `Mailodds::ValidationResult` 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 `Mailodds::ValidationResult`. 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']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'sub_status')
+        self.sub_status = attributes[:'sub_status']
+      end
+
+      if attributes.key?(:'action')
+        self.action = attributes[:'action']
+      end
+
+      if attributes.key?(:'processed_at')
+        self.processed_at = attributes[:'processed_at']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          email == o.email &&
+          status == o.status &&
+          sub_status == o.sub_status &&
+          action == o.action &&
+          processed_at == o.processed_at
+    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, status, sub_status, action, processed_at].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/mailodds/version.rb

@@ -0,0 +1,15 @@
+=begin
+#MailOdds Email Validation API
+
+#MailOdds provides email validation services to help maintain clean email lists  and improve deliverability. The API performs multiple validation checks including  format verification, domain validation, MX record checking, and disposable email detection.  ## Authentication  All API requests require authentication using a Bearer token. Include your API key  in the Authorization header:  ``` Authorization: Bearer YOUR_API_KEY ```  API keys can be created in the MailOdds dashboard.  ## Rate Limits  Rate limits vary by plan: - Free: 10 requests/minute - Starter: 60 requests/minute   - Pro: 300 requests/minute - Business: 1000 requests/minute - Enterprise: Custom limits  ## Response Format  All responses include: - `schema_version`: API schema version (currently \"1.0\") - `request_id`: Unique request identifier for debugging  Error responses include: - `error`: Machine-readable error code - `message`: Human-readable error description 
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mailodds.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+module Mailodds
+  VERSION = '1.0.0'
+end

data/lib/mailodds.rb

@@ -0,0 +1,96 @@
+=begin
+#MailOdds Email Validation API
+
+#MailOdds provides email validation services to help maintain clean email lists  and improve deliverability. The API performs multiple validation checks including  format verification, domain validation, MX record checking, and disposable email detection.  ## Authentication  All API requests require authentication using a Bearer token. Include your API key  in the Authorization header:  ``` Authorization: Bearer YOUR_API_KEY ```  API keys can be created in the MailOdds dashboard.  ## Rate Limits  Rate limits vary by plan: - Free: 10 requests/minute - Starter: 60 requests/minute   - Pro: 300 requests/minute - Business: 1000 requests/minute - Enterprise: Custom limits  ## Response Format  All responses include: - `schema_version`: API schema version (currently \"1.0\") - `request_id`: Unique request identifier for debugging  Error responses include: - `error`: Machine-readable error code - `message`: Human-readable error description 
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mailodds.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+# Common files
+require 'mailodds/api_client'
+require 'mailodds/api_error'
+require 'mailodds/api_model_base'
+require 'mailodds/version'
+require 'mailodds/configuration'
+
+# Models
+require 'mailodds/models/add_policy_rule201_response'
+require 'mailodds/models/add_suppression_request'
+require 'mailodds/models/add_suppression_request_entries_inner'
+require 'mailodds/models/add_suppression_response'
+require 'mailodds/models/check_suppression_request'
+require 'mailodds/models/create_job_from_s3_request'
+require 'mailodds/models/create_job_request'
+require 'mailodds/models/create_policy_from_preset_request'
+require 'mailodds/models/create_policy_request'
+require 'mailodds/models/delete_job200_response'
+require 'mailodds/models/delete_policy200_response'
+require 'mailodds/models/delete_policy_rule200_response'
+require 'mailodds/models/error_response'
+require 'mailodds/models/get_presigned_upload_request'
+require 'mailodds/models/health_check200_response'
+require 'mailodds/models/job'
+require 'mailodds/models/job_list_response'
+require 'mailodds/models/job_response'
+require 'mailodds/models/job_summary'
+require 'mailodds/models/pagination'
+require 'mailodds/models/policy'
+require 'mailodds/models/policy_list_response'
+require 'mailodds/models/policy_list_response_limits'
+require 'mailodds/models/policy_presets_response'
+require 'mailodds/models/policy_presets_response_presets_inner'
+require 'mailodds/models/policy_response'
+require 'mailodds/models/policy_rule'
+require 'mailodds/models/policy_rule_action'
+require 'mailodds/models/policy_test_response'
+require 'mailodds/models/presigned_upload_response'
+require 'mailodds/models/presigned_upload_response_upload'
+require 'mailodds/models/remove_suppression200_response'
+require 'mailodds/models/remove_suppression_request'
+require 'mailodds/models/results_response'
+require 'mailodds/models/suppression_check_response'
+require 'mailodds/models/suppression_entry'
+require 'mailodds/models/suppression_list_response'
+require 'mailodds/models/suppression_stats_response'
+require 'mailodds/models/suppression_stats_response_by_type'
+require 'mailodds/models/telemetry_summary'
+require 'mailodds/models/telemetry_summary_rates'
+require 'mailodds/models/telemetry_summary_top_domains_inner'
+require 'mailodds/models/telemetry_summary_top_reasons_inner'
+require 'mailodds/models/telemetry_summary_totals'
+require 'mailodds/models/test_policy_request'
+require 'mailodds/models/test_policy_request_test_result'
+require 'mailodds/models/update_policy_request'
+require 'mailodds/models/validate_request'
+require 'mailodds/models/validation_response'
+require 'mailodds/models/validation_response_suppression_match'
+require 'mailodds/models/validation_result'
+
+# APIs
+require 'mailodds/api/bulk_validation_api'
+require 'mailodds/api/email_validation_api'
+require 'mailodds/api/suppression_lists_api'
+require 'mailodds/api/system_api'
+require 'mailodds/api/validation_policies_api'
+
+module Mailodds
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Mailodds.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/mailodds.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "mailodds/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mailodds"
+  s.version     = Mailodds::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["MailOdds"]
+  s.email       = ["support@mailodds.com"]
+  s.homepage    = "https://mailodds.com"
+  s.summary     = "Official Ruby client for the MailOdds Email Validation API"
+  s.description = "Ruby SDK for the MailOdds Email Validation API. Validate emails with format checks, domain validation, MX records, SMTP verification, and disposable email detection."
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.7"
+  s.metadata    = {
+    "source_code_uri" => "https://github.com/mailodds/ruby-sdk",
+    "documentation_uri" => "https://mailodds.com/docs",
+    "homepage_uri" => "https://mailodds.com"
+  }
+
+  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

data/spec/api/bulk_validation_api_spec.rb

@@ -0,0 +1,151 @@
+=begin
+#MailOdds Email Validation API
+
+#MailOdds provides email validation services to help maintain clean email lists  and improve deliverability. The API performs multiple validation checks including  format verification, domain validation, MX record checking, and disposable email detection.  ## Authentication  All API requests require authentication using a Bearer token. Include your API key  in the Authorization header:  ``` Authorization: Bearer YOUR_API_KEY ```  API keys can be created in the MailOdds dashboard.  ## Rate Limits  Rate limits vary by plan: - Free: 10 requests/minute - Starter: 60 requests/minute   - Pro: 300 requests/minute - Business: 1000 requests/minute - Enterprise: Custom limits  ## Response Format  All responses include: - `schema_version`: API schema version (currently \"1.0\") - `request_id`: Unique request identifier for debugging  Error responses include: - `error`: Machine-readable error code - `message`: Human-readable error description 
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mailodds.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Mailodds::BulkValidationApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'BulkValidationApi' do
+  before do
+    # run before each test
+    @api_instance = Mailodds::BulkValidationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of BulkValidationApi' do
+    it 'should create an instance of BulkValidationApi' do
+      expect(@api_instance).to be_instance_of(Mailodds::BulkValidationApi)
+    end
+  end
+
+  # unit tests for cancel_job
+  # Cancel a job
+  # Cancel a pending or processing job. Partial results are preserved.
+  # @param job_id 
+  # @param [Hash] opts the optional parameters
+  # @return [JobResponse]
+  describe 'cancel_job test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_job
+  # Create bulk validation job (JSON)
+  # Create a new bulk validation job by submitting a JSON array of emails.
+  # @param create_job_request 
+  # @param [Hash] opts the optional parameters
+  # @return [JobResponse]
+  describe 'create_job test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_job_from_s3
+  # Create job from S3 upload
+  # Create a validation job from a file previously uploaded to S3.
+  # @param create_job_from_s3_request 
+  # @param [Hash] opts the optional parameters
+  # @return [JobResponse]
+  describe 'create_job_from_s3 test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_job_upload
+  # Create bulk validation job (file upload)
+  # Create a new bulk validation job by uploading a CSV, Excel, or TXT file.
+  # @param file CSV, Excel (.xlsx, .xls), ODS, or TXT file
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :dedup Remove duplicate emails
+  # @option opts [String] :metadata JSON metadata for the job
+  # @return [JobResponse]
+  describe 'create_job_upload test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_job
+  # Delete a job
+  # Permanently delete a completed or cancelled job and its results.
+  # @param job_id 
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteJob200Response]
+  describe 'delete_job test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_job
+  # Get job status
+  # Get the status and details of a specific validation job.
+  # @param job_id 
+  # @param [Hash] opts the optional parameters
+  # @return [JobResponse]
+  describe 'get_job test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_job_results
+  # Get job results
+  # Download validation results in JSON, CSV, or NDJSON format.
+  # @param job_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :format 
+  # @option opts [String] :filter 
+  # @option opts [Integer] :page 
+  # @option opts [Integer] :per_page 
+  # @return [ResultsResponse]
+  describe 'get_job_results test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_presigned_upload
+  # Get S3 presigned upload URL
+  # Get a presigned URL for uploading large files (>10MB) directly to S3.
+  # @param get_presigned_upload_request 
+  # @param [Hash] opts the optional parameters
+  # @return [PresignedUploadResponse]
+  describe 'get_presigned_upload test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_jobs
+  # List validation jobs
+  # List all validation jobs for the authenticated account.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page 
+  # @option opts [Integer] :per_page 
+  # @option opts [String] :status 
+  # @return [JobListResponse]
+  describe 'list_jobs test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end