ElasticEmail 4.0.1

data/docs/ChannelLogStatusSummary.md

@@ -0,0 +1,44 @@
+# ElasticEmail::ChannelLogStatusSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_name** | **String** | Channel name | [optional] |
+| **recipients** | **Integer** | Number of recipients | [optional] |
+| **email_total** | **Integer** | Number of emails | [optional] |
+| **sms_total** | **Integer** | Number of SMS | [optional] |
+| **delivered** | **Integer** | Number of delivered messages | [optional] |
+| **bounced** | **Integer** | Number of bounced messages | [optional] |
+| **in_progress** | **Integer** | Number of messages in progress | [optional] |
+| **opened** | **Integer** | Number of opened messages | [optional] |
+| **clicked** | **Integer** | Number of clicked messages | [optional] |
+| **unsubscribed** | **Integer** | Number of unsubscribed messages | [optional] |
+| **complaints** | **Integer** | Number of complaint messages | [optional] |
+| **inbound** | **Integer** | Number of inbound messages | [optional] |
+| **manual_cancel** | **Integer** | Number of manually cancelled messages | [optional] |
+| **not_delivered** | **Integer** | Number of messages flagged with 'Not Delivered' | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::ChannelLogStatusSummary.new(
+  channel_name: null,
+  recipients: 1234,
+  email_total: 1234,
+  sms_total: 12,
+  delivered: 1000,
+  bounced: 1000,
+  in_progress: 1234,
+  opened: 1000,
+  clicked: 1000,
+  unsubscribed: 1000,
+  complaints: 1000,
+  inbound: 1000,
+  manual_cancel: 1000,
+  not_delivered: 0
+)
+```
+

data/docs/CompressionFormat.md

@@ -0,0 +1,15 @@
+# ElasticEmail::CompressionFormat
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::CompressionFormat.new()
+```
+

data/docs/ConsentData.md

@@ -0,0 +1,22 @@
+# ElasticEmail::ConsentData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **consent_ip** | **String** | IP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent. | [optional] |
+| **consent_date** | **Time** | Date of consent to send this contact(s) your email. If not provided current date is used for consent. | [optional] |
+| **consent_tracking** | [**ConsentTracking**](ConsentTracking.md) | Does the contant consent to have their tracking data stored. | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::ConsentData.new(
+  consent_ip: 192.168.0.1,
+  consent_date: null,
+  consent_tracking: null
+)
+```
+

data/docs/ConsentTracking.md

@@ -0,0 +1,15 @@
+# ElasticEmail::ConsentTracking
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::ConsentTracking.new()
+```
+

data/docs/Contact.md

@@ -0,0 +1,38 @@
+# ElasticEmail::Contact
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Proper email address. | [optional] |
+| **status** | [**ContactStatus**](ContactStatus.md) | Status of the given resource | [optional] |
+| **first_name** | **String** | First name. | [optional] |
+| **last_name** | **String** | Last name. | [optional] |
+| **custom_fields** | **Hash<String, String>** | A key-value collection of custom contact fields which can be used in the system. | [optional] |
+| **consent** | [**ConsentData**](ConsentData.md) |  | [optional] |
+| **source** | [**ContactSource**](ContactSource.md) | From where was this contact added | [optional] |
+| **date_added** | **Time** | Date of creation in YYYY-MM-DDThh:ii:ss format | [optional] |
+| **date_updated** | **Time** | Last change date | [optional] |
+| **status_change_date** | **Time** | Date of last status change. | [optional] |
+| **activity** | [**ContactActivity**](ContactActivity.md) | Contact's email statistics and activity | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::Contact.new(
+  email: mail@example.com,
+  status: null,
+  first_name: Fred,
+  last_name: Flintstone,
+  custom_fields: {"city":"New York","age":"34"},
+  consent: null,
+  source: null,
+  date_added: null,
+  date_updated: null,
+  status_change_date: null,
+  activity: null
+)
+```
+

data/docs/ContactActivity.md

@@ -0,0 +1,38 @@
+# ElasticEmail::ContactActivity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total_sent** | **Integer** | Total emails sent. | [optional] |
+| **total_opened** | **Integer** | Total emails opened. | [optional] |
+| **total_clicked** | **Integer** | Total emails clicked | [optional] |
+| **total_failed** | **Integer** | Total emails failed. | [optional] |
+| **last_sent** | **Time** | Last date when an email was sent to this contact | [optional] |
+| **last_opened** | **Time** | Date this contact last opened an email | [optional] |
+| **last_clicked** | **Time** | Date this contact last clicked an email | [optional] |
+| **last_failed** | **Time** | Last date when an email sent to this contact bounced | [optional] |
+| **last_ip** | **String** | IP from which this contact opened or clicked their email last time | [optional] |
+| **error_code** | **Integer** | Last RFC Error code if any occurred | [optional] |
+| **friendly_error_message** | **String** | Last RFC error message if any occurred | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::ContactActivity.new(
+  total_sent: 1000,
+  total_opened: 1000,
+  total_clicked: 1000,
+  total_failed: 1000,
+  last_sent: null,
+  last_opened: null,
+  last_clicked: null,
+  last_failed: null,
+  last_ip: null,
+  error_code: null,
+  friendly_error_message: null
+)
+```
+

data/docs/ContactHistEventType.md

@@ -0,0 +1,15 @@
+# ElasticEmail::ContactHistEventType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::ContactHistEventType.new()
+```
+

data/docs/ContactHistory.md

@@ -0,0 +1,30 @@
+# ElasticEmail::ContactHistory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_type** | [**ContactHistEventType**](ContactHistEventType.md) | Type of event occured on this Contact. | [optional] |
+| **event_date** | **Time** | Formatted date of event. | [optional] |
+| **channel_name** | **String** | Name of channel this event occured on | [optional] |
+| **template_name** | **String** | Name of template this event occured on | [optional] |
+| **ip_address** | **String** | IP Address of the event. | [optional] |
+| **country** | **String** | Country of the event. | [optional] |
+| **data** | **String** | Additional information about the event | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::ContactHistory.new(
+  event_type: null,
+  event_date: null,
+  channel_name: null,
+  template_name: null,
+  ip_address: null,
+  country: null,
+  data: null
+)
+```
+

data/docs/ContactPayload.md

@@ -0,0 +1,28 @@
+# ElasticEmail::ContactPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Proper email address. | [optional] |
+| **status** | [**ContactStatus**](ContactStatus.md) | Status of the given resource | [optional] |
+| **first_name** | **String** | First name. | [optional] |
+| **last_name** | **String** | Last name. | [optional] |
+| **custom_fields** | **Hash<String, String>** | A key-value collection of custom contact fields which can be used in the system. Only already existing custom fields will be saved. | [optional] |
+| **consent** | [**ConsentData**](ConsentData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::ContactPayload.new(
+  email: mail@example.com,
+  status: null,
+  first_name: Fred,
+  last_name: Flintstone,
+  custom_fields: {"city":"New York","age":"34"},
+  consent: null
+)
+```
+

data/docs/ContactSource.md

@@ -0,0 +1,15 @@
+# ElasticEmail::ContactSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::ContactSource.new()
+```
+

data/docs/ContactStatus.md

@@ -0,0 +1,15 @@
+# ElasticEmail::ContactStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::ContactStatus.new()
+```
+

data/docs/ContactUpdatePayload.md

@@ -0,0 +1,22 @@
+# ElasticEmail::ContactUpdatePayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** | First name. | [optional] |
+| **last_name** | **String** | Last name. | [optional] |
+| **custom_fields** | **Hash<String, String>** | A key-value collection of custom contact fields which can be used in the system. | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::ContactUpdatePayload.new(
+  first_name: Fred,
+  last_name: Flintstone,
+  custom_fields: {"city":"New York","age":"34"}
+)
+```
+

data/docs/ContactsApi.md

@@ -0,0 +1,756 @@
+# ElasticEmail::ContactsApi
+
+All URIs are relative to *https://api.elasticemail.com/v4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**contacts_by_email_delete**](ContactsApi.md#contacts_by_email_delete) | **DELETE** /contacts/{email} | Delete Contact |
+| [**contacts_by_email_get**](ContactsApi.md#contacts_by_email_get) | **GET** /contacts/{email} | Load Contact |
+| [**contacts_by_email_history_get**](ContactsApi.md#contacts_by_email_history_get) | **GET** /contacts/{email}/history | Load History |
+| [**contacts_by_email_put**](ContactsApi.md#contacts_by_email_put) | **PUT** /contacts/{email} | Update Contact |
+| [**contacts_delete_post**](ContactsApi.md#contacts_delete_post) | **POST** /contacts/delete | Delete Contacts Bulk |
+| [**contacts_export_by_id_status_get**](ContactsApi.md#contacts_export_by_id_status_get) | **GET** /contacts/export/{id}/status | Check Export Status |
+| [**contacts_export_post**](ContactsApi.md#contacts_export_post) | **POST** /contacts/export | Export Contacts |
+| [**contacts_get**](ContactsApi.md#contacts_get) | **GET** /contacts | Load Contacts |
+| [**contacts_import_post**](ContactsApi.md#contacts_import_post) | **POST** /contacts/import | Upload Contacts |
+| [**contacts_post**](ContactsApi.md#contacts_post) | **POST** /contacts | Add Contact |
+
+
+## contacts_by_email_delete
+
+> contacts_by_email_delete(email)
+
+Delete Contact
+
+Deletes the provided contact. Required Access Level: ModifyContacts
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apikey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::ContactsApi.new
+email = 'mail@example.com' # String | Proper email address.
+
+begin
+  # Delete Contact
+  api_instance.contacts_by_email_delete(email)
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_by_email_delete: #{e}"
+end
+```
+
+#### Using the contacts_by_email_delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> contacts_by_email_delete_with_http_info(email)
+
+```ruby
+begin
+  # Delete Contact
+  data, status_code, headers = api_instance.contacts_by_email_delete_with_http_info(email)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_by_email_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Proper email address. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## contacts_by_email_get
+
+> <Contact> contacts_by_email_get(email)
+
+Load Contact
+
+Load detailed contact information for specified email. Required Access Level: ViewContacts
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apikey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::ContactsApi.new
+email = 'mail@example.com' # String | Proper email address.
+
+begin
+  # Load Contact
+  result = api_instance.contacts_by_email_get(email)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_by_email_get: #{e}"
+end
+```
+
+#### Using the contacts_by_email_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Contact>, Integer, Hash)> contacts_by_email_get_with_http_info(email)
+
+```ruby
+begin
+  # Load Contact
+  data, status_code, headers = api_instance.contacts_by_email_get_with_http_info(email)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Contact>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_by_email_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Proper email address. |  |
+
+### Return type
+
+[**Contact**](Contact.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## contacts_by_email_history_get
+
+> <Array<ContactHistory>> contacts_by_email_history_get(email, opts)
+
+Load History
+
+Returns detailed history of specified Contact. Required Access Level: ViewContacts
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apikey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::ContactsApi.new
+email = 'mail@example.com' # String | Proper email address.
+opts = {
+  limit: 100, # Integer | Maximum number of returned items.
+  offset: 20 # Integer | How many items should be returned ahead.
+}
+
+begin
+  # Load History
+  result = api_instance.contacts_by_email_history_get(email, opts)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_by_email_history_get: #{e}"
+end
+```
+
+#### Using the contacts_by_email_history_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ContactHistory>>, Integer, Hash)> contacts_by_email_history_get_with_http_info(email, opts)
+
+```ruby
+begin
+  # Load History
+  data, status_code, headers = api_instance.contacts_by_email_history_get_with_http_info(email, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ContactHistory>>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_by_email_history_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Proper email address. |  |
+| **limit** | **Integer** | Maximum number of returned items. | [optional] |
+| **offset** | **Integer** | How many items should be returned ahead. | [optional] |
+
+### Return type
+
+[**Array&lt;ContactHistory&gt;**](ContactHistory.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## contacts_by_email_put
+
+> <Contact> contacts_by_email_put(email, contact_update_payload)
+
+Update Contact
+
+Update selected contact. Omitted contact's fields will not be changed. Required Access Level: ModifyContacts
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apikey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::ContactsApi.new
+email = 'mail@example.com' # String | Proper email address.
+contact_update_payload = ElasticEmail::ContactUpdatePayload.new # ContactUpdatePayload | 
+
+begin
+  # Update Contact
+  result = api_instance.contacts_by_email_put(email, contact_update_payload)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_by_email_put: #{e}"
+end
+```
+
+#### Using the contacts_by_email_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Contact>, Integer, Hash)> contacts_by_email_put_with_http_info(email, contact_update_payload)
+
+```ruby
+begin
+  # Update Contact
+  data, status_code, headers = api_instance.contacts_by_email_put_with_http_info(email, contact_update_payload)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Contact>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_by_email_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Proper email address. |  |
+| **contact_update_payload** | [**ContactUpdatePayload**](ContactUpdatePayload.md) |  |  |
+
+### Return type
+
+[**Contact**](Contact.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## contacts_delete_post
+
+> contacts_delete_post(emails_payload)
+
+Delete Contacts Bulk
+
+Deletes provided contacts in bulk. Required Access Level: ModifyContacts
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apikey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::ContactsApi.new
+emails_payload = ElasticEmail::EmailsPayload.new # EmailsPayload | Provide either rule or a list of emails, not both.
+
+begin
+  # Delete Contacts Bulk
+  api_instance.contacts_delete_post(emails_payload)
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_delete_post: #{e}"
+end
+```
+
+#### Using the contacts_delete_post_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> contacts_delete_post_with_http_info(emails_payload)
+
+```ruby
+begin
+  # Delete Contacts Bulk
+  data, status_code, headers = api_instance.contacts_delete_post_with_http_info(emails_payload)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_delete_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **emails_payload** | [**EmailsPayload**](EmailsPayload.md) | Provide either rule or a list of emails, not both. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## contacts_export_by_id_status_get
+
+> <ExportStatus> contacts_export_by_id_status_get(id)
+
+Check Export Status
+
+Check the current status of the export. Required Access Level: Export
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apikey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::ContactsApi.new
+id = 'E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F' # String | ID of the exported file
+
+begin
+  # Check Export Status
+  result = api_instance.contacts_export_by_id_status_get(id)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_export_by_id_status_get: #{e}"
+end
+```
+
+#### Using the contacts_export_by_id_status_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExportStatus>, Integer, Hash)> contacts_export_by_id_status_get_with_http_info(id)
+
+```ruby
+begin
+  # Check Export Status
+  data, status_code, headers = api_instance.contacts_export_by_id_status_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExportStatus>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_export_by_id_status_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | ID of the exported file |  |
+
+### Return type
+
+[**ExportStatus**](ExportStatus.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## contacts_export_post
+
+> <ExportLink> contacts_export_post(opts)
+
+Export Contacts
+
+Request an Export of specified Contacts. Required Access Level: Export
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apikey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::ContactsApi.new
+opts = {
+  file_format: ElasticEmail::ExportFileFormats::CSV, # ExportFileFormats | Format of the exported file
+  rule: 'Status%20=%20Engaged', # String | Query used for filtering.
+  emails: ['inner_example'], # Array<String> | Comma delimited list of contact emails
+  compression_format: ElasticEmail::CompressionFormat::NONE, # CompressionFormat | FileResponse compression format. None or Zip.
+  file_name: 'filename.txt' # String | Name of your file including extension.
+}
+
+begin
+  # Export Contacts
+  result = api_instance.contacts_export_post(opts)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_export_post: #{e}"
+end
+```
+
+#### Using the contacts_export_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExportLink>, Integer, Hash)> contacts_export_post_with_http_info(opts)
+
+```ruby
+begin
+  # Export Contacts
+  data, status_code, headers = api_instance.contacts_export_post_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExportLink>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_export_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_format** | [**ExportFileFormats**](.md) | Format of the exported file | [optional] |
+| **rule** | **String** | Query used for filtering. | [optional] |
+| **emails** | [**Array&lt;String&gt;**](String.md) | Comma delimited list of contact emails | [optional] |
+| **compression_format** | [**CompressionFormat**](.md) | FileResponse compression format. None or Zip. | [optional] |
+| **file_name** | **String** | Name of your file including extension. | [optional] |
+
+### Return type
+
+[**ExportLink**](ExportLink.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## contacts_get
+
+> <Array<Contact>> contacts_get(opts)
+
+Load Contacts
+
+Returns a list of contacts. Required Access Level: ViewContacts
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apikey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::ContactsApi.new
+opts = {
+  limit: 100, # Integer | Maximum number of returned items.
+  offset: 20 # Integer | How many items should be returned ahead.
+}
+
+begin
+  # Load Contacts
+  result = api_instance.contacts_get(opts)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_get: #{e}"
+end
+```
+
+#### Using the contacts_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Contact>>, Integer, Hash)> contacts_get_with_http_info(opts)
+
+```ruby
+begin
+  # Load Contacts
+  data, status_code, headers = api_instance.contacts_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Contact>>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Maximum number of returned items. | [optional] |
+| **offset** | **Integer** | How many items should be returned ahead. | [optional] |
+
+### Return type
+
+[**Array&lt;Contact&gt;**](Contact.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## contacts_import_post
+
+> contacts_import_post(opts)
+
+Upload Contacts
+
+Upload contacts from a file. Required Access Level: ModifyContacts
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apikey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::ContactsApi.new
+opts = {
+  list_name: 'list_name_example', # String | Name of an existing list to add these contacts to
+  encoding_name: 'encoding_name_example', # String | In what encoding the file is uploaded
+  file: File.new('/path/to/some/file') # File | 
+}
+
+begin
+  # Upload Contacts
+  api_instance.contacts_import_post(opts)
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_import_post: #{e}"
+end
+```
+
+#### Using the contacts_import_post_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> contacts_import_post_with_http_info(opts)
+
+```ruby
+begin
+  # Upload Contacts
+  data, status_code, headers = api_instance.contacts_import_post_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_import_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **list_name** | **String** | Name of an existing list to add these contacts to | [optional] |
+| **encoding_name** | **String** | In what encoding the file is uploaded | [optional] |
+| **file** | **File** |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: Not defined
+
+
+## contacts_post
+
+> <Array<Contact>> contacts_post(contact_payload, opts)
+
+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
+
+### Examples
+
+```ruby
+require 'time'
+require 'ElasticEmail'
+# setup authorization
+ElasticEmail.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apikey'] = 'Bearer'
+end
+
+api_instance = ElasticEmail::ContactsApi.new
+contact_payload = [ElasticEmail::ContactPayload.new] # Array<ContactPayload> | 
+opts = {
+  listnames: ['inner_example'] # Array<String> | Names of lists to which the uploaded contacts should be added to
+}
+
+begin
+  # Add Contact
+  result = api_instance.contacts_post(contact_payload, opts)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_post: #{e}"
+end
+```
+
+#### Using the contacts_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Contact>>, Integer, Hash)> contacts_post_with_http_info(contact_payload, opts)
+
+```ruby
+begin
+  # Add Contact
+  data, status_code, headers = api_instance.contacts_post_with_http_info(contact_payload, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Contact>>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling ContactsApi->contacts_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_payload** | [**Array&lt;ContactPayload&gt;**](ContactPayload.md) |  |  |
+| **listnames** | [**Array&lt;String&gt;**](String.md) | Names of lists to which the uploaded contacts should be added to | [optional] |
+
+### Return type
+
+[**Array&lt;Contact&gt;**](Contact.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+