ElasticEmail 4.0.1

data/spec/api/templates_api_spec.rb

@@ -0,0 +1,99 @@
+=begin
+#Elastic Email REST API
+
+#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.    Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.    To start using this API, you will need your Access Token (available <a href=\"https://elasticemail.com/account#/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description.    This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click <a href=\"https://api.elasticemail.com/public/help\">here</a>.
+
+The version of the OpenAPI document: 4.0.0
+Contact: support@elasticemail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ElasticEmail::TemplatesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TemplatesApi' do
+  before do
+    # run before each test
+    @api_instance = ElasticEmail::TemplatesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TemplatesApi' do
+    it 'should create an instance of TemplatesApi' do
+      expect(@api_instance).to be_instance_of(ElasticEmail::TemplatesApi)
+    end
+  end
+
+  # unit tests for templates_by_name_delete
+  # Delete Template
+  # Delete template with the specified name. Required Access Level: ModifyTemplates
+  # @param name Name of template.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'templates_by_name_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for templates_by_name_get
+  # Load Template
+  # Load detailed information of the specified template. Required Access Level: ViewTemplates
+  # @param name Name of template.
+  # @param [Hash] opts the optional parameters
+  # @return [Template]
+  describe 'templates_by_name_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for templates_by_name_put
+  # Update Template
+  # Update existing template, overwriting existing data. Required Access Level: ModifyTemplates
+  # @param name Name of template.
+  # @param template_payload 
+  # @param [Hash] opts the optional parameters
+  # @return [Template]
+  describe 'templates_by_name_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for templates_get
+  # Load Templates
+  # Returns a list of templates for the specified type. Required Access Level: ViewTemplates
+  # @param scope_type Return templates with specified scope only
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<TemplateType>] :template_types Return templates with specified type only
+  # @option opts [Integer] :limit Maximum number of returned items.
+  # @option opts [Integer] :offset How many items should be returned ahead.
+  # @return [Array<Template>]
+  describe 'templates_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for templates_post
+  # Add Template
+  # Add a new Template. Required Access Level: ModifyTemplates
+  # @param template_payload 
+  # @param [Hash] opts the optional parameters
+  # @return [Template]
+  describe 'templates_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/verifications_api_spec.rb

@@ -0,0 +1,145 @@
+=begin
+#Elastic Email REST API
+
+#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.    Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.    To start using this API, you will need your Access Token (available <a href=\"https://elasticemail.com/account#/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description.    This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click <a href=\"https://api.elasticemail.com/public/help\">here</a>.
+
+The version of the OpenAPI document: 4.0.0
+Contact: support@elasticemail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ElasticEmail::VerificationsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'VerificationsApi' do
+  before do
+    # run before each test
+    @api_instance = ElasticEmail::VerificationsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of VerificationsApi' do
+    it 'should create an instance of VerificationsApi' do
+      expect(@api_instance).to be_instance_of(ElasticEmail::VerificationsApi)
+    end
+  end
+
+  # unit tests for verifications_by_email_delete
+  # Delete Email Verification Result
+  # Delete a result with given email if exists. Required Access Level: VerifyEmails
+  # @param email Email address to verification
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'verifications_by_email_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for verifications_by_email_get
+  # Get Email Verification Result
+  # Returns a result of verified email. Required Access Level: ViewEmailVerifications
+  # @param email Email address to view verification result of
+  # @param [Hash] opts the optional parameters
+  # @return [EmailValidationResult]
+  describe 'verifications_by_email_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for verifications_by_email_post
+  # Verify Email
+  # Verify single email address and returns result of verification. Required Access Level: VerifyEmails
+  # @param email Email address to verify
+  # @param [Hash] opts the optional parameters
+  # @return [EmailValidationResult]
+  describe 'verifications_by_email_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for verifications_files_by_id_delete
+  # Delete File Verification Result
+  # Delete Verification Results if they exist. Required Access Level: VerifyEmails
+  # @param id ID of the exported file
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'verifications_files_by_id_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for verifications_files_by_id_result_download_get
+  # Download File Verification Result
+  # Download verification results as a ZIP file. Required Access Level: VerifyEmails
+  # @param id Verification ID to download
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'verifications_files_by_id_result_download_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for verifications_files_by_id_result_get
+  # Get Detailed File Verification Result
+  # Returns status and results (if verified) of file with given ID. Required Access Level: ViewEmailVerifications
+  # @param id ID of the Verification to display status of
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Maximum number of returned email verification results
+  # @option opts [Integer] :offset How many result items should be returned ahead
+  # @return [VerificationFileResultDetails]
+  describe 'verifications_files_by_id_result_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for verifications_files_post
+  # Verify From File
+  # Uploads a CSV file with list of emails to verify. An &#39;email&#39; column is required. Required Access Level: VerifyEmails
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :file 
+  # @return [VerificationFileResult]
+  describe 'verifications_files_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for verifications_files_result_get
+  # Get Simple Files Verification Results
+  # Returns a list of uploaded files, their statuses and results. Required Access Level: ViewEmailVerifications
+  # @param [Hash] opts the optional parameters
+  # @return [Array<VerificationFileResult>]
+  describe 'verifications_files_result_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for verifications_get
+  # Get Emails Verification Results
+  # Returns a results of all verified single emails. Required Access Level: ViewEmailVerifications
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Maximum number of returned items.
+  # @option opts [Integer] :offset How many items should be returned ahead.
+  # @return [Array<EmailValidationResult>]
+  describe 'verifications_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api_client_spec.rb

@@ -0,0 +1,226 @@
+=begin
+#Elastic Email REST API
+
+#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.    Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.    To start using this API, you will need your Access Token (available <a href=\"https://elasticemail.com/account#/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description.    This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click <a href=\"https://api.elasticemail.com/public/help\">here</a>.
+
+The version of the OpenAPI document: 4.0.0
+Contact: support@elasticemail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.1
+
+=end
+
+require 'spec_helper'
+
+describe ElasticEmail::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          ElasticEmail.configure { |c| c.host = 'http://example.com' }
+          expect(ElasticEmail::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          ElasticEmail.configure { |c| c.host = 'https://wookiee.com' }
+          expect(ElasticEmail::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          ElasticEmail.configure { |c| c.host = 'hobo.com/v4' }
+          expect(ElasticEmail::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          ElasticEmail.configure { |c| c.base_path = 'v4/dog' }
+          expect(ElasticEmail::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          ElasticEmail.configure { |c| c.base_path = '/v4/dog' }
+          expect(ElasticEmail::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          ElasticEmail.configure { |c| c.base_path = nil }
+          expect(ElasticEmail::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { ElasticEmail::Configuration.new }
+    let(:api_client) { ElasticEmail::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(ElasticEmail::Configuration.default.params_encoding).to eq(nil)
+      expect(config.params_encoding).to eq(nil)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(nil)
+    end
+
+    it 'can be customized' do
+      config.params_encoding = :multi
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(:multi)
+    end
+  end
+
+  describe 'timeout in #build_request' do
+    let(:config) { ElasticEmail::Configuration.new }
+    let(:api_client) { ElasticEmail::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(ElasticEmail::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it 'can be customized' do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe '#deserialize' do
+    it "handles Array<Integer>" do
+      api_client = ElasticEmail::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it 'handles Array<Array<Integer>>' do
+      api_client = ElasticEmail::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it 'handles Hash<String, String>' do
+      api_client = ElasticEmail::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq(:message => 'Hello')
+    end
+  end
+
+  describe "#object_to_hash" do
+    it 'ignores nils and includes empty arrays' do
+      # uncomment below to test object_to_hash for model
+      # api_client = ElasticEmail::ApiClient.new
+      # _model = ElasticEmail::ModelName.new
+      # update the model attribute below
+      # _model.id = 1
+      # update the expected value (hash) below
+      # expected = {id: 1, name: '', tags: []}
+      # expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe '#build_collection_param' do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { ElasticEmail::ApiClient.new }
+
+    it 'works for csv' do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it 'works for ssv' do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it 'works for tsv' do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it 'works for pipes' do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it 'works for multi' do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it 'fails for invalid collection format' do
+      expect { api_client.build_collection_param(param, :INVALID) }.to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe '#json_mime?' do
+    let(:api_client) { ElasticEmail::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe '#select_header_accept' do
+    let(:api_client) { ElasticEmail::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe '#select_header_content_type' do
+    let(:api_client) { ElasticEmail::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe '#sanitize_filename' do
+    let(:api_client) { ElasticEmail::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end