ElasticEmail 4.0.1

data/docs/BodyContentType.md

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

data/docs/BodyPart.md

@@ -0,0 +1,22 @@
+# ElasticEmail::BodyPart
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content_type** | [**BodyContentType**](BodyContentType.md) | Type of the body part | [optional] |
+| **content** | **String** | Actual content of the body part | [optional] |
+| **charset** | **String** | Text value of charset encoding for example: iso-8859-1, windows-1251, utf-8, us-ascii, windows-1250 and more… | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::BodyPart.new(
+  content_type: null,
+  content: null,
+  charset: null
+)
+```
+

data/docs/Campaign.md

@@ -0,0 +1,26 @@
+# ElasticEmail::Campaign
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | [**Array<CampaignTemplate>**](CampaignTemplate.md) | Campaign's email content. Provide multiple items to send an A/X Split Campaign | [optional] |
+| **name** | **String** | Campaign name | [optional] |
+| **status** | [**CampaignStatus**](CampaignStatus.md) | Campaign status | [optional] |
+| **recipients** | [**CampaignRecipient**](CampaignRecipient.md) | Recipients this campaign should be sent to | [optional] |
+| **options** | [**CampaignOptions**](CampaignOptions.md) | Campaign sending options | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::Campaign.new(
+  content: null,
+  name: null,
+  status: null,
+  recipients: null,
+  options: null
+)
+```
+

data/docs/CampaignOptions.md

@@ -0,0 +1,26 @@
+# ElasticEmail::CampaignOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **delivery_optimization** | [**DeliveryOptimizationType**](DeliveryOptimizationType.md) | How to order email delivery - by recipients' engagement score or by the time they open the most of the emails that were sent to them | [optional] |
+| **track_opens** | **Boolean** | Should the opens be tracked? If no value has been provided, Account's default setting will be used. | [optional] |
+| **track_clicks** | **Boolean** | Should the clicks be tracked? If no value has been provided, Account's default setting will be used. | [optional] |
+| **schedule_for** | **Time** | Date when this Campaign is scheduled to be sent on | [optional] |
+| **split_options** | [**SplitOptions**](SplitOptions.md) | Optional options for A/X split campaigns. Will be ignored if only one template content was provided | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::CampaignOptions.new(
+  delivery_optimization: null,
+  track_opens: true,
+  track_clicks: true,
+  schedule_for: null,
+  split_options: null
+)
+```
+

data/docs/CampaignRecipient.md

@@ -0,0 +1,20 @@
+# ElasticEmail::CampaignRecipient
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **list_names** | **Array<String>** | Names of lists from your Account to read recipients from | [optional] |
+| **segment_names** | **Array<String>** | Names of segments from your Account to read recipients from | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::CampaignRecipient.new(
+  list_names: null,
+  segment_names: null
+)
+```
+

data/docs/CampaignStatus.md

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

data/docs/CampaignTemplate.md

@@ -0,0 +1,30 @@
+# ElasticEmail::CampaignTemplate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **poolname** | **String** | Name of your custom IP Pool to be used in the sending process | [optional] |
+| **from** | **String** | Your e-mail with an optional name (e.g.: John Doe <email@domain.com>) | [optional] |
+| **reply_to** | **String** | To what address should the recipients reply to (e.g. John Doe <email@domain.com>) | [optional] |
+| **subject** | **String** | Default subject of email. | [optional] |
+| **template_name** | **String** | Name of template. | [optional] |
+| **attach_files** | **Array<String>** | Names of previously uploaded files that should be sent as downloadable attachments | [optional] |
+| **utm** | [**Utm**](Utm.md) | Utm marketing data to be attached to every link in this e-mail. | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::CampaignTemplate.new(
+  poolname: My Custom Pool,
+  from: John Doe <email@domain.com>,
+  reply_to: John Doe <email@domain.com>,
+  subject: Hello!,
+  template_name: Template01,
+  attach_files: null,
+  utm: null
+)
+```
+

data/docs/CampaignsApi.md

@@ -0,0 +1,374 @@
+# ElasticEmail::CampaignsApi
+
+All URIs are relative to *https://api.elasticemail.com/v4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**campaigns_by_name_delete**](CampaignsApi.md#campaigns_by_name_delete) | **DELETE** /campaigns/{name} | Delete Campaign |
+| [**campaigns_by_name_get**](CampaignsApi.md#campaigns_by_name_get) | **GET** /campaigns/{name} | Load Campaign |
+| [**campaigns_by_name_put**](CampaignsApi.md#campaigns_by_name_put) | **PUT** /campaigns/{name} | Update Campaign |
+| [**campaigns_get**](CampaignsApi.md#campaigns_get) | **GET** /campaigns | Load Campaigns |
+| [**campaigns_post**](CampaignsApi.md#campaigns_post) | **POST** /campaigns | Add Campaign |
+
+
+## campaigns_by_name_delete
+
+> campaigns_by_name_delete(name)
+
+Delete Campaign
+
+Delete the specific campaign.  This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns
+
+### 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::CampaignsApi.new
+name = 'name_example' # String | Name of Campaign to delete
+
+begin
+  # Delete Campaign
+  api_instance.campaigns_by_name_delete(name)
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling CampaignsApi->campaigns_by_name_delete: #{e}"
+end
+```
+
+#### Using the campaigns_by_name_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)> campaigns_by_name_delete_with_http_info(name)
+
+```ruby
+begin
+  # Delete Campaign
+  data, status_code, headers = api_instance.campaigns_by_name_delete_with_http_info(name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling CampaignsApi->campaigns_by_name_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of Campaign to delete |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## campaigns_by_name_get
+
+> <Campaign> campaigns_by_name_get(name)
+
+Load Campaign
+
+Returns the specified campaign details. Required Access Level: ViewCampaigns
+
+### 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::CampaignsApi.new
+name = 'name_example' # String | Name of Campaign to get
+
+begin
+  # Load Campaign
+  result = api_instance.campaigns_by_name_get(name)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling CampaignsApi->campaigns_by_name_get: #{e}"
+end
+```
+
+#### Using the campaigns_by_name_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Campaign>, Integer, Hash)> campaigns_by_name_get_with_http_info(name)
+
+```ruby
+begin
+  # Load Campaign
+  data, status_code, headers = api_instance.campaigns_by_name_get_with_http_info(name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Campaign>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling CampaignsApi->campaigns_by_name_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of Campaign to get |  |
+
+### Return type
+
+[**Campaign**](Campaign.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## campaigns_by_name_put
+
+> <Campaign> campaigns_by_name_put(name, campaign)
+
+Update Campaign
+
+Updates a previously added campaign.  Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns
+
+### 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::CampaignsApi.new
+name = 'name_example' # String | Name of Campaign to update
+campaign = ElasticEmail::Campaign.new # Campaign | JSON representation of a campaign
+
+begin
+  # Update Campaign
+  result = api_instance.campaigns_by_name_put(name, campaign)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling CampaignsApi->campaigns_by_name_put: #{e}"
+end
+```
+
+#### Using the campaigns_by_name_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Campaign>, Integer, Hash)> campaigns_by_name_put_with_http_info(name, campaign)
+
+```ruby
+begin
+  # Update Campaign
+  data, status_code, headers = api_instance.campaigns_by_name_put_with_http_info(name, campaign)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Campaign>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling CampaignsApi->campaigns_by_name_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of Campaign to update |  |
+| **campaign** | [**Campaign**](Campaign.md) | JSON representation of a campaign |  |
+
+### Return type
+
+[**Campaign**](Campaign.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## campaigns_get
+
+> <Array<Campaign>> campaigns_get(opts)
+
+Load Campaigns
+
+Returns a list all of your campaigns. Limited to 1000 results. Required Access Level: ViewCampaigns
+
+### 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::CampaignsApi.new
+opts = {
+  search: 'search_example', # String | Text fragment used for searching in Campaign name (using the 'contains' rule)
+  offset: 20, # Integer | How many items should be returned ahead.
+  limit: 100 # Integer | Maximum number of returned items.
+}
+
+begin
+  # Load Campaigns
+  result = api_instance.campaigns_get(opts)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling CampaignsApi->campaigns_get: #{e}"
+end
+```
+
+#### Using the campaigns_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Campaign>>, Integer, Hash)> campaigns_get_with_http_info(opts)
+
+```ruby
+begin
+  # Load Campaigns
+  data, status_code, headers = api_instance.campaigns_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Campaign>>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling CampaignsApi->campaigns_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **search** | **String** | Text fragment used for searching in Campaign name (using the &#39;contains&#39; rule) | [optional] |
+| **offset** | **Integer** | How many items should be returned ahead. | [optional] |
+| **limit** | **Integer** | Maximum number of returned items. | [optional] |
+
+### Return type
+
+[**Array&lt;Campaign&gt;**](Campaign.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## campaigns_post
+
+> <Campaign> campaigns_post(campaign)
+
+Add Campaign
+
+Add a campaign for processing. Required Access Level: ModifyCampaigns
+
+### 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::CampaignsApi.new
+campaign = ElasticEmail::Campaign.new # Campaign | JSON representation of a campaign
+
+begin
+  # Add Campaign
+  result = api_instance.campaigns_post(campaign)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling CampaignsApi->campaigns_post: #{e}"
+end
+```
+
+#### Using the campaigns_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Campaign>, Integer, Hash)> campaigns_post_with_http_info(campaign)
+
+```ruby
+begin
+  # Add Campaign
+  data, status_code, headers = api_instance.campaigns_post_with_http_info(campaign)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Campaign>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling CampaignsApi->campaigns_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **campaign** | [**Campaign**](Campaign.md) | JSON representation of a campaign |  |
+
+### Return type
+
+[**Campaign**](Campaign.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+