ElasticEmail 4.0.1

data/docs/ContactsList.md

@@ -0,0 +1,24 @@
+# ElasticEmail::ContactsList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **list_name** | **String** | Name of your list. | [optional] |
+| **public_list_id** | **String** | ID code of list. Please note that this is different from the listid field. | [optional] |
+| **date_added** | **Time** | Date of creation in YYYY-MM-DDThh:ii:ss format | [optional] |
+| **allow_unsubscribe** | **Boolean** | True: Allow unsubscribing from this list. Otherwise, false | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::ContactsList.new(
+  list_name: My List 1,
+  public_list_id: E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F,
+  date_added: null,
+  allow_unsubscribe: false
+)
+```
+

data/docs/DeliveryOptimizationType.md

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

data/docs/EmailContent.md

@@ -0,0 +1,38 @@
+# ElasticEmail::EmailContent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**Array<BodyPart>**](BodyPart.md) | List of e-mail body parts, with user-provided MIME types (text/html, text/plain etc) | [optional] |
+| **merge** | **Hash<String, String>** | A key-value collection of custom merge fields, shared between recipients. Should be used in e-mail body like so: {firstname}, {lastname} etc. | [optional] |
+| **attachments** | [**Array<MessageAttachment>**](MessageAttachment.md) | Attachments provided by sending binary data | [optional] |
+| **headers** | **Hash<String, String>** | A key-value collection of custom e-mail headers. | [optional] |
+| **postback** | **String** | Postback header. | [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::EmailContent.new(
+  body: null,
+  merge: {"city":"New York","age":"34"},
+  attachments: null,
+  headers: {"city":"New York","age":"34"},
+  postback: null,
+  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/EmailData.md

@@ -0,0 +1,22 @@
+# ElasticEmail::EmailData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **preview** | [**EmailView**](EmailView.md) | Email details | [optional] |
+| **attachments** | [**Array<FileInfo>**](FileInfo.md) | Attachments sent with the email | [optional] |
+| **status** | [**EmailStatus**](EmailStatus.md) | Status of the given resource | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::EmailData.new(
+  preview: null,
+  attachments: null,
+  status: null
+)
+```
+

data/docs/EmailMessageData.md

@@ -0,0 +1,22 @@
+# ElasticEmail::EmailMessageData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recipients** | [**Array<EmailRecipient>**](EmailRecipient.md) | List of recipients (visible to others) | [optional] |
+| **content** | [**EmailContent**](EmailContent.md) | Proper e-mail content | [optional] |
+| **options** | [**Options**](Options.md) | E-mail configuration | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::EmailMessageData.new(
+  recipients: null,
+  content: null,
+  options: null
+)
+```
+

data/docs/EmailRecipient.md

@@ -0,0 +1,20 @@
+# ElasticEmail::EmailRecipient
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Proper email address. | [optional] |
+| **fields** | **Hash<String, String>** | A key-value collection of merge fields which can be used in e-mail body. | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::EmailRecipient.new(
+  email: mail@example.com,
+  fields: {"city":"New York","age":"34"}
+)
+```
+

data/docs/EmailSend.md

@@ -0,0 +1,20 @@
+# ElasticEmail::EmailSend
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** | ID number of transaction | [optional] |
+| **message_id** | **String** | Unique identifier for this email. | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::EmailSend.new(
+  transaction_id: TransactionID,
+  message_id: -HHGPM_9RPhSMiaJq_ab4g3
+)
+```
+

data/docs/EmailStatus.md

@@ -0,0 +1,40 @@
+# ElasticEmail::EmailStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | **String** | Email address this email was sent from. | [optional] |
+| **to** | **String** | Email address this email was sent to. | [optional] |
+| **date** | **Time** | Date the email was submitted. | [optional] |
+| **status** | [**LogJobStatus**](LogJobStatus.md) | Value of email's status | [optional] |
+| **status_name** | **String** | Name of email's status | [optional] |
+| **status_change_date** | **Time** | Date of last status change. | [optional] |
+| **date_sent** | **Time** | Date when the email was sent | [optional] |
+| **date_opened** | **Time** | Date when the email changed the status to 'opened' | [optional] |
+| **date_clicked** | **Time** | Date when the email changed the status to 'clicked' | [optional] |
+| **error_message** | **String** | Detailed error or bounced message. | [optional] |
+| **transaction_id** | **String** | ID number of transaction | [optional] |
+| **envelope_from** | **String** | Envelope from address | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::EmailStatus.new(
+  from: null,
+  to: null,
+  date: null,
+  status: null,
+  status_name: null,
+  status_change_date: null,
+  date_sent: null,
+  date_opened: null,
+  date_clicked: null,
+  error_message: null,
+  transaction_id: TransactionID,
+  envelope_from: null
+)
+```
+

data/docs/EmailTransactionalMessageData.md

@@ -0,0 +1,22 @@
+# ElasticEmail::EmailTransactionalMessageData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recipients** | [**TransactionalRecipient**](TransactionalRecipient.md) | List of transactional recipients | [optional] |
+| **content** | [**EmailContent**](EmailContent.md) | Proper e-mail content | [optional] |
+| **options** | [**Options**](Options.md) | E-mail configuration | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::EmailTransactionalMessageData.new(
+  recipients: null,
+  content: null,
+  options: null
+)
+```
+

data/docs/EmailValidationResult.md

@@ -0,0 +1,34 @@
+# ElasticEmail::EmailValidationResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **String** | Local part of an email | [optional] |
+| **domain** | **String** | Name of selected domain. | [optional] |
+| **email** | **String** | Full email address that was verified | [optional] |
+| **suggested_spelling** | **String** | Suggested spelling if a possible mistake was found | [optional] |
+| **disposable** | **Boolean** | Does the email have a temporary domain | [optional] |
+| **role** | **Boolean** | Is an email a role email (e.g. info@, noreply@ etc.) | [optional] |
+| **reason** | **String** | All detected issues | [optional] |
+| **date_added** | **Time** | Date of creation in YYYY-MM-DDThh:ii:ss format | [optional] |
+| **result** | [**EmailValidationStatus**](EmailValidationStatus.md) |  | [optional][default to 'None'] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::EmailValidationResult.new(
+  account: null,
+  domain: example.com,
+  email: null,
+  suggested_spelling: null,
+  disposable: null,
+  role: null,
+  reason: null,
+  date_added: null,
+  result: null
+)
+```
+

data/docs/EmailValidationStatus.md

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

data/docs/EmailView.md

@@ -0,0 +1,22 @@
+# ElasticEmail::EmailView
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** | Body (HTML, otherwise plain text) of email | [optional] |
+| **subject** | **String** | Default subject of email. | [optional] |
+| **from** | **String** | From email address | [optional] |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::EmailView.new(
+  body: null,
+  subject: Hello!,
+  from: null
+)
+```
+

data/docs/EmailsApi.md

@@ -0,0 +1,295 @@
+# ElasticEmail::EmailsApi
+
+All URIs are relative to *https://api.elasticemail.com/v4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**emails_by_msgid_view_get**](EmailsApi.md#emails_by_msgid_view_get) | **GET** /emails/{msgid}/view | View Email |
+| [**emails_mergefile_post**](EmailsApi.md#emails_mergefile_post) | **POST** /emails/mergefile | Send Bulk Emails CSV |
+| [**emails_post**](EmailsApi.md#emails_post) | **POST** /emails | Send Bulk Emails |
+| [**emails_transactional_post**](EmailsApi.md#emails_transactional_post) | **POST** /emails/transactional | Send Transactional Email |
+
+
+## emails_by_msgid_view_get
+
+> <EmailData> emails_by_msgid_view_get(msgid)
+
+View Email
+
+Returns email details for viewing or rendering. Required Access Level: None
+
+### 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::EmailsApi.new
+msgid = 'msgid_example' # String | Message identifier
+
+begin
+  # View Email
+  result = api_instance.emails_by_msgid_view_get(msgid)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling EmailsApi->emails_by_msgid_view_get: #{e}"
+end
+```
+
+#### Using the emails_by_msgid_view_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailData>, Integer, Hash)> emails_by_msgid_view_get_with_http_info(msgid)
+
+```ruby
+begin
+  # View Email
+  data, status_code, headers = api_instance.emails_by_msgid_view_get_with_http_info(msgid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailData>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling EmailsApi->emails_by_msgid_view_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **msgid** | **String** | Message identifier |  |
+
+### Return type
+
+[**EmailData**](EmailData.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## emails_mergefile_post
+
+> <EmailSend> emails_mergefile_post(merge_email_payload)
+
+Send Bulk Emails CSV
+
+Send bulk merge email. Required Access Level: SendHttp
+
+### 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::EmailsApi.new
+merge_email_payload = ElasticEmail::MergeEmailPayload.new # MergeEmailPayload | Email data
+
+begin
+  # Send Bulk Emails CSV
+  result = api_instance.emails_mergefile_post(merge_email_payload)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling EmailsApi->emails_mergefile_post: #{e}"
+end
+```
+
+#### Using the emails_mergefile_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailSend>, Integer, Hash)> emails_mergefile_post_with_http_info(merge_email_payload)
+
+```ruby
+begin
+  # Send Bulk Emails CSV
+  data, status_code, headers = api_instance.emails_mergefile_post_with_http_info(merge_email_payload)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailSend>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling EmailsApi->emails_mergefile_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merge_email_payload** | [**MergeEmailPayload**](MergeEmailPayload.md) | Email data |  |
+
+### Return type
+
+[**EmailSend**](EmailSend.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## emails_post
+
+> <EmailSend> emails_post(email_message_data)
+
+Send Bulk Emails
+
+Send bulk merge email. Required Access Level: SendHttp
+
+### 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::EmailsApi.new
+email_message_data = ElasticEmail::EmailMessageData.new # EmailMessageData | Email data
+
+begin
+  # Send Bulk Emails
+  result = api_instance.emails_post(email_message_data)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling EmailsApi->emails_post: #{e}"
+end
+```
+
+#### Using the emails_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailSend>, Integer, Hash)> emails_post_with_http_info(email_message_data)
+
+```ruby
+begin
+  # Send Bulk Emails
+  data, status_code, headers = api_instance.emails_post_with_http_info(email_message_data)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailSend>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling EmailsApi->emails_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_message_data** | [**EmailMessageData**](EmailMessageData.md) | Email data |  |
+
+### Return type
+
+[**EmailSend**](EmailSend.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## emails_transactional_post
+
+> <EmailSend> emails_transactional_post(email_transactional_message_data)
+
+Send Transactional Email
+
+Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp
+
+### 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::EmailsApi.new
+email_transactional_message_data = ElasticEmail::EmailTransactionalMessageData.new # EmailTransactionalMessageData | Email data
+
+begin
+  # Send Transactional Email
+  result = api_instance.emails_transactional_post(email_transactional_message_data)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling EmailsApi->emails_transactional_post: #{e}"
+end
+```
+
+#### Using the emails_transactional_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailSend>, Integer, Hash)> emails_transactional_post_with_http_info(email_transactional_message_data)
+
+```ruby
+begin
+  # Send Transactional Email
+  data, status_code, headers = api_instance.emails_transactional_post_with_http_info(email_transactional_message_data)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailSend>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling EmailsApi->emails_transactional_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_transactional_message_data** | [**EmailTransactionalMessageData**](EmailTransactionalMessageData.md) | Email data |  |
+
+### Return type
+
+[**EmailSend**](EmailSend.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+