ElasticEmail 4.0.1

data/lib/ElasticEmail/models/verification_status.rb

@@ -0,0 +1,40 @@
+=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 'date'
+require 'time'
+
+module ElasticEmail
+  class VerificationStatus
+    PROCESSING = "Processing".freeze
+    READY = "Ready".freeze
+    EXPIRED = "Expired".freeze
+    VERIFIED = "Verified".freeze
+    ERROR = "Error".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = VerificationStatus.constants.select { |c| VerificationStatus::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #VerificationStatus" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/ElasticEmail/version.rb

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

data/spec/api/campaigns_api_spec.rb

@@ -0,0 +1,98 @@
+=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::CampaignsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CampaignsApi' do
+  before do
+    # run before each test
+    @api_instance = ElasticEmail::CampaignsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CampaignsApi' do
+    it 'should create an instance of CampaignsApi' do
+      expect(@api_instance).to be_instance_of(ElasticEmail::CampaignsApi)
+    end
+  end
+
+  # unit tests for campaigns_by_name_delete
+  # Delete Campaign
+  # Delete the specific campaign.  This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns
+  # @param name Name of Campaign to delete
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'campaigns_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 campaigns_by_name_get
+  # Load Campaign
+  # Returns the specified campaign details. Required Access Level: ViewCampaigns
+  # @param name Name of Campaign to get
+  # @param [Hash] opts the optional parameters
+  # @return [Campaign]
+  describe 'campaigns_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 campaigns_by_name_put
+  # Update Campaign
+  # Updates a previously added campaign.  Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns
+  # @param name Name of Campaign to update
+  # @param campaign JSON representation of a campaign
+  # @param [Hash] opts the optional parameters
+  # @return [Campaign]
+  describe 'campaigns_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 campaigns_get
+  # Load Campaigns
+  # Returns a list all of your campaigns. Limited to 1000 results. Required Access Level: ViewCampaigns
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :search Text fragment used for searching in Campaign name (using the &#39;contains&#39; rule)
+  # @option opts [Integer] :offset How many items should be returned ahead.
+  # @option opts [Integer] :limit Maximum number of returned items.
+  # @return [Array<Campaign>]
+  describe 'campaigns_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 campaigns_post
+  # Add Campaign
+  # Add a campaign for processing. Required Access Level: ModifyCampaigns
+  # @param campaign JSON representation of a campaign
+  # @param [Hash] opts the optional parameters
+  # @return [Campaign]
+  describe 'campaigns_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/contacts_api_spec.rb

@@ -0,0 +1,166 @@
+=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::ContactsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ContactsApi' do
+  before do
+    # run before each test
+    @api_instance = ElasticEmail::ContactsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ContactsApi' do
+    it 'should create an instance of ContactsApi' do
+      expect(@api_instance).to be_instance_of(ElasticEmail::ContactsApi)
+    end
+  end
+
+  # unit tests for contacts_by_email_delete
+  # Delete Contact
+  # Deletes the provided contact. Required Access Level: ModifyContacts
+  # @param email Proper email address.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'contacts_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 contacts_by_email_get
+  # Load Contact
+  # Load detailed contact information for specified email. Required Access Level: ViewContacts
+  # @param email Proper email address.
+  # @param [Hash] opts the optional parameters
+  # @return [Contact]
+  describe 'contacts_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 contacts_by_email_history_get
+  # Load History
+  # Returns detailed history of specified Contact. Required Access Level: ViewContacts
+  # @param email Proper email address.
+  # @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<ContactHistory>]
+  describe 'contacts_by_email_history_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 contacts_by_email_put
+  # Update Contact
+  # Update selected contact. Omitted contact&#39;s fields will not be changed. Required Access Level: ModifyContacts
+  # @param email Proper email address.
+  # @param contact_update_payload 
+  # @param [Hash] opts the optional parameters
+  # @return [Contact]
+  describe 'contacts_by_email_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 contacts_delete_post
+  # Delete Contacts Bulk
+  # Deletes provided contacts in bulk. Required Access Level: ModifyContacts
+  # @param emails_payload Provide either rule or a list of emails, not both.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'contacts_delete_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 contacts_export_by_id_status_get
+  # Check Export Status
+  # Check the current status of the export. Required Access Level: Export
+  # @param id ID of the exported file
+  # @param [Hash] opts the optional parameters
+  # @return [ExportStatus]
+  describe 'contacts_export_by_id_status_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 contacts_export_post
+  # Export Contacts
+  # Request an Export of specified Contacts. Required Access Level: Export
+  # @param [Hash] opts the optional parameters
+  # @option opts [ExportFileFormats] :file_format Format of the exported file
+  # @option opts [String] :rule Query used for filtering.
+  # @option opts [Array<String>] :emails Comma delimited list of contact emails
+  # @option opts [CompressionFormat] :compression_format FileResponse compression format. None or Zip.
+  # @option opts [String] :file_name Name of your file including extension.
+  # @return [ExportLink]
+  describe 'contacts_export_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 contacts_get
+  # Load Contacts
+  # Returns a list of contacts. Required Access Level: ViewContacts
+  # @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<Contact>]
+  describe 'contacts_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 contacts_import_post
+  # Upload Contacts
+  # Upload contacts from a file. Required Access Level: ModifyContacts
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :list_name Name of an existing list to add these contacts to
+  # @option opts [String] :encoding_name In what encoding the file is uploaded
+  # @option opts [File] :file 
+  # @return [nil]
+  describe 'contacts_import_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 contacts_post
+  # Add Contact
+  # Add new Contacts to your Lists. Up to 1000 can be added (for more please refer to the import request). Required Access Level: ModifyContacts
+  # @param contact_payload 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :listnames Names of lists to which the uploaded contacts should be added to
+  # @return [Array<Contact>]
+  describe 'contacts_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/emails_api_spec.rb

@@ -0,0 +1,83 @@
+=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::EmailsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'EmailsApi' do
+  before do
+    # run before each test
+    @api_instance = ElasticEmail::EmailsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EmailsApi' do
+    it 'should create an instance of EmailsApi' do
+      expect(@api_instance).to be_instance_of(ElasticEmail::EmailsApi)
+    end
+  end
+
+  # unit tests for emails_by_msgid_view_get
+  # View Email
+  # Returns email details for viewing or rendering. Required Access Level: None
+  # @param msgid Message identifier
+  # @param [Hash] opts the optional parameters
+  # @return [EmailData]
+  describe 'emails_by_msgid_view_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 emails_mergefile_post
+  # Send Bulk Emails CSV
+  # Send bulk merge email. Required Access Level: SendHttp
+  # @param merge_email_payload Email data
+  # @param [Hash] opts the optional parameters
+  # @return [EmailSend]
+  describe 'emails_mergefile_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 emails_post
+  # Send Bulk Emails
+  # Send bulk merge email. Required Access Level: SendHttp
+  # @param email_message_data Email data
+  # @param [Hash] opts the optional parameters
+  # @return [EmailSend]
+  describe 'emails_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 emails_transactional_post
+  # Send Transactional Email
+  # Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp
+  # @param email_transactional_message_data Email data
+  # @param [Hash] opts the optional parameters
+  # @return [EmailSend]
+  describe 'emails_transactional_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/events_api_spec.rb

@@ -0,0 +1,146 @@
+=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::EventsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'EventsApi' do
+  before do
+    # run before each test
+    @api_instance = ElasticEmail::EventsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EventsApi' do
+    it 'should create an instance of EventsApi' do
+      expect(@api_instance).to be_instance_of(ElasticEmail::EventsApi)
+    end
+  end
+
+  # unit tests for events_by_transactionid_get
+  # Load Email Events
+  # Returns a log of delivery events for the specific transaction ID. Required Access Level: ViewReports
+  # @param transactionid ID number of transaction
+  # @param [Hash] opts the optional parameters
+  # @option opts [Time] :from Starting date for search in YYYY-MM-DDThh:mm:ss format.
+  # @option opts [Time] :to Ending date for search in YYYY-MM-DDThh:mm:ss format.
+  # @option opts [EventsOrderBy] :order_by 
+  # @option opts [Integer] :limit Maximum number of returned items.
+  # @option opts [Integer] :offset How many items should be returned ahead.
+  # @return [Array<RecipientEvent>]
+  describe 'events_by_transactionid_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 events_channels_by_name_export_post
+  # Export Channel Events
+  # Export delivery events log information to the specified file format. Required Access Level: Export
+  # @param name Name of selected channel.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<EventType>] :event_types Types of Events to return
+  # @option opts [Time] :from Starting date for search in YYYY-MM-DDThh:mm:ss format.
+  # @option opts [Time] :to Ending date for search in YYYY-MM-DDThh:mm:ss format.
+  # @option opts [ExportFileFormats] :file_format Format of the exported file
+  # @option opts [CompressionFormat] :compression_format FileResponse compression format. None or Zip.
+  # @option opts [String] :file_name Name of your file including extension.
+  # @return [ExportLink]
+  describe 'events_channels_by_name_export_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 events_channels_by_name_get
+  # Load Channel Events
+  # Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports
+  # @param name Name of selected channel.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<EventType>] :event_types Types of Events to return
+  # @option opts [Time] :from Starting date for search in YYYY-MM-DDThh:mm:ss format.
+  # @option opts [Time] :to Ending date for search in YYYY-MM-DDThh:mm:ss format.
+  # @option opts [EventsOrderBy] :order_by 
+  # @option opts [Integer] :limit How many items to load. Maximum for this request is 1000 items
+  # @option opts [Integer] :offset How many items should be returned ahead.
+  # @return [Array<RecipientEvent>]
+  describe 'events_channels_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 events_channels_export_by_id_status_get
+  # Check Channel Export Status
+  # Check the current status of the channel export. Required Access Level: Export
+  # @param id ID of the exported file
+  # @param [Hash] opts the optional parameters
+  # @return [ExportStatus]
+  describe 'events_channels_export_by_id_status_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 events_export_by_id_status_get
+  # Check Export Status
+  # Check the current status of the export. Required Access Level: Export
+  # @param id ID of the exported file
+  # @param [Hash] opts the optional parameters
+  # @return [ExportStatus]
+  describe 'events_export_by_id_status_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 events_export_post
+  # Export Events
+  # Export delivery events log information to the specified file format. Required Access Level: Export
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<EventType>] :event_types Types of Events to return
+  # @option opts [Time] :from Starting date for search in YYYY-MM-DDThh:mm:ss format.
+  # @option opts [Time] :to Ending date for search in YYYY-MM-DDThh:mm:ss format.
+  # @option opts [ExportFileFormats] :file_format Format of the exported file
+  # @option opts [CompressionFormat] :compression_format FileResponse compression format. None or Zip.
+  # @option opts [String] :file_name Name of your file including extension.
+  # @return [ExportLink]
+  describe 'events_export_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 events_get
+  # Load Events
+  # Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<EventType>] :event_types Types of Events to return
+  # @option opts [Time] :from Starting date for search in YYYY-MM-DDThh:mm:ss format.
+  # @option opts [Time] :to Ending date for search in YYYY-MM-DDThh:mm:ss format.
+  # @option opts [EventsOrderBy] :order_by 
+  # @option opts [Integer] :limit How many items to load. Maximum for this request is 1000 items
+  # @option opts [Integer] :offset How many items should be returned ahead.
+  # @return [Array<RecipientEvent>]
+  describe 'events_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end