ElasticEmail 4.0.11 → 4.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a579af43327bba161d78355869f905865a8734be32fdeca142e918faf7fee346
-  data.tar.gz: c11d317b8d4cfff7253a28e8a77441766e323af98a78ab2744569a6f7682548a
+  metadata.gz: a58798ee4d1c453f1713a4171fe8207e7a5aaff3a879c7982870ca934c762503
+  data.tar.gz: b2a28a1241a40c581431b5e747a68db25dfd33aa4d8ff0b6ab791ba790704c6c
 SHA512:
-  metadata.gz: fa45cae0270fd62f943254ea6621d0cf3c9a8542ea232c1349b2d1a7fc41778ebae11ce5acef6d3810e716afda70f70a7ff4c8d0d6d9bcb7e6e141f98d1fae12
-  data.tar.gz: b05ac0e0f71d82a1191807819c06e0d8a8c648c97a7f95f5840377d0cd8c4e1a199b9286ede41234dc858d6b6cca1966126527a35746937a8002ed702458d437
+  metadata.gz: eb22e089b3abff42280b130d99af7c5cd38a4f8bd1cd3bcb60510d5cb89c6bcfbce250bf838c5433df07d026cf5238d7efcd4ef22d528f427be91eb04e987208
+  data.tar.gz: 4441ad658fba72d4da0c5d387d8b3bfc3cababec2e1d8e51ba860e44ea9c27caf18bb711c32395572d09607702507504c515b83e451cd99f65f0b2136d4a20f8

data/ElasticEmail.gemspec

@@ -3,12 +3,12 @@
 =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 target=\"_blank\" 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 target=\"_blank\" href=\"https://api.elasticemail.com/public/help\">here</a>.    Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
+#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.    The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request.    To start using this API, you will need your Access Token (available <a target=\"_blank\" 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 target=\"_blank\" href=\"https://api.elasticemail.com/public/help\">here</a>.    Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">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
+OpenAPI Generator version: 5.4.0
 
 =end
 
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.email       = ["contact@elasticemail.com"]
   s.homepage    = "https://elasticemail.com"
   s.summary     = "Elastic Email REST API Ruby Gem"
-  s.description = "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 target=\"_blank\" 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 target=\"_blank\" href=\"https://api.elasticemail.com/public/help\">here</a>.    Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>"
+  s.description = "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.    The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request.    To start using this API, you will need your Access Token (available <a target=\"_blank\" 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 target=\"_blank\" href=\"https://api.elasticemail.com/public/help\">here</a>.    Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>"
   s.license     = "Unlicense"
   s.required_ruby_version = ">= 2.4"
 

data/README.md

@@ -6,16 +6,18 @@ This API is based on the REST API architecture, allowing the user to easily mana
 
 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 target=\"_blank\" 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.
+The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request.
 
-This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click <a target=\"_blank\" href=\"https://api.elasticemail.com/public/help\">here</a>.
+To start using this API, you will need your Access Token (available [here](https://elasticemail.com/account#/settings/new/manage-api)). Remember to keep it safe. Required access levels are listed in the given request’s description.
 
-Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
+This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click [here](https://api.elasticemail.com/public/help).
+
+Downloadable library clients can be found in our Github repository [here](https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme)
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 4.0.0
-- Package version: 4.0.11
+- Package version: 4.0.16
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -31,16 +33,16 @@ gem build ElasticEmail.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ElasticEmail-4.0.11.gem
+gem install ./ElasticEmail-4.0.16.gem
 ```
 
-(for development, run `gem install --dev ./ElasticEmail-4.0.11.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ElasticEmail-4.0.16.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ElasticEmail', '~> 4.0.11'
+    gem 'ElasticEmail', '~> 4.0.16'
 
 ### Install from Git
 
@@ -183,8 +185,9 @@ Class | Method | HTTP request | Description
 *ElasticEmail::VerificationsApi* | [**verifications_files_by_id_delete**](docs/VerificationsApi.md#verifications_files_by_id_delete) | **DELETE** /verifications/files/{id} | Delete File Verification Result
 *ElasticEmail::VerificationsApi* | [**verifications_files_by_id_result_download_get**](docs/VerificationsApi.md#verifications_files_by_id_result_download_get) | **GET** /verifications/files/{id}/result/download | Download File Verification Result
 *ElasticEmail::VerificationsApi* | [**verifications_files_by_id_result_get**](docs/VerificationsApi.md#verifications_files_by_id_result_get) | **GET** /verifications/files/{id}/result | Get Detailed File Verification Result
-*ElasticEmail::VerificationsApi* | [**verifications_files_post**](docs/VerificationsApi.md#verifications_files_post) | **POST** /verifications/files | Verify From File
-*ElasticEmail::VerificationsApi* | [**verifications_files_result_get**](docs/VerificationsApi.md#verifications_files_result_get) | **GET** /verifications/files/result | Get Simple Files Verification Results
+*ElasticEmail::VerificationsApi* | [**verifications_files_by_id_verification_post**](docs/VerificationsApi.md#verifications_files_by_id_verification_post) | **POST** /verifications/files/{id}/verification | Start verification
+*ElasticEmail::VerificationsApi* | [**verifications_files_post**](docs/VerificationsApi.md#verifications_files_post) | **POST** /verifications/files | Upload File with Emails
+*ElasticEmail::VerificationsApi* | [**verifications_files_result_get**](docs/VerificationsApi.md#verifications_files_result_get) | **GET** /verifications/files/result | Get Files Verification Results
 *ElasticEmail::VerificationsApi* | [**verifications_get**](docs/VerificationsApi.md#verifications_get) | **GET** /verifications | Get Emails Verification Results
 
 

data/VERSION

@@ -1 +1 @@
-4.0.11
+4.0.16

data/docs/ApiKeyPayload.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Name of the ApiKey for ease of reference. | [optional] |
-| **access_level** | [**Array<AccessLevel>**](AccessLevel.md) | Access level or permission to be assigned to this ApiKey. | [optional] |
+| **name** | **String** | Name of the ApiKey for ease of reference. |  |
+| **access_level** | [**Array<AccessLevel>**](AccessLevel.md) | Access level or permission to be assigned to this ApiKey. |  |
 | **expires** | **Time** | Date this ApiKey expires. | [optional] |
 | **restrict_access_to_ip_range** | **Array<String>** | Which IPs can use this ApiKey | [optional] |
 | **subaccount** | **String** | Email of the subaccount for which this ApiKey should be created | [optional] |

data/docs/BodyPart.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **content_type** | [**BodyContentType**](BodyContentType.md) | Type of the body part | [optional] |
+| **content_type** | [**BodyContentType**](BodyContentType.md) |  | [default to 'HTML'] |
 | **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] |
 

data/docs/Campaign.md

@@ -5,10 +5,10 @@
 | 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] |
+| **name** | **String** | Campaign name |  |
+| **status** | [**CampaignStatus**](CampaignStatus.md) |  | [optional][default to 'Deleted'] |
+| **recipients** | [**CampaignRecipient**](CampaignRecipient.md) |  |  |
+| **options** | [**CampaignOptions**](CampaignOptions.md) |  | [optional] |
 
 ## Example
 

data/docs/CampaignOptions.md

@@ -4,11 +4,11 @@
 
 | 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] |
+| **delivery_optimization** | [**DeliveryOptimizationType**](DeliveryOptimizationType.md) |  | [optional][default to 'None'] |
 | **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] |
+| **split_options** | [**SplitOptions**](SplitOptions.md) |  | [optional] |
 
 ## Example
 

data/docs/CampaignTemplate.md

@@ -10,7 +10,7 @@
 | **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] |
+| **utm** | [**Utm**](Utm.md) |  | [optional] |
 
 ## Example
 
@@ -23,7 +23,7 @@ instance = ElasticEmail::CampaignTemplate.new(
   reply_to: John Doe <email@domain.com>,
   subject: Hello!,
   template_name: Template01,
-  attach_files: null,
+  attach_files: [ "preuploaded.jpg" ],
   utm: null
 )
 ```

data/docs/CampaignsApi.md

@@ -175,7 +175,7 @@ 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
+campaign = ElasticEmail::Campaign.new({name: 'name_example', recipients: ElasticEmail::CampaignRecipient.new}) # Campaign | JSON representation of a campaign
 
 begin
   # Update Campaign
@@ -324,7 +324,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::CampaignsApi.new
-campaign = ElasticEmail::Campaign.new # Campaign | JSON representation of a campaign
+campaign = ElasticEmail::Campaign.new({name: 'name_example', recipients: ElasticEmail::CampaignRecipient.new}) # Campaign | JSON representation of a campaign
 
 begin
   # Add Campaign

data/docs/ConsentData.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **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] |
+| **consent_tracking** | [**ConsentTracking**](ConsentTracking.md) |  | [optional][default to 'Unknown'] |
 
 ## Example
 

data/docs/Contact.md

@@ -5,16 +5,16 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **email** | **String** | Proper email address. | [optional] |
-| **status** | [**ContactStatus**](ContactStatus.md) | Status of the given resource | [optional] |
+| **status** | [**ContactStatus**](ContactStatus.md) |  | [optional][default to 'Transactional'] |
 | **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] |
+| **source** | [**ContactSource**](ContactSource.md) |  | [optional][default to 'DeliveryApi'] |
 | **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] |
+| **activity** | [**ContactActivity**](ContactActivity.md) |  | [optional] |
 
 ## Example
 

data/docs/ContactHistory.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **event_type** | [**ContactHistEventType**](ContactHistEventType.md) | Type of event occured on this Contact. | [optional] |
+| **event_type** | [**ContactHistEventType**](ContactHistEventType.md) |  | [optional][default to 'Opened'] |
 | **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] |

data/docs/ContactPayload.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **email** | **String** | Proper email address. | [optional] |
-| **status** | [**ContactStatus**](ContactStatus.md) | Status of the given resource | [optional] |
+| **email** | **String** | Proper email address. |  |
+| **status** | [**ContactStatus**](ContactStatus.md) |  | [optional][default to 'Transactional'] |
 | **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] |

data/docs/ContactsApi.md

@@ -509,10 +509,10 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **file_format** | [**ExportFileFormats**](.md) | Format of the exported file | [optional] |
+| **file_format** | [**ExportFileFormats**](.md) | Format of the exported file | [optional][default to 'Csv'] |
 | **rule** | **String** | Query used for filtering. | [optional] |
 | **emails** | [**Array<String>**](String.md) | Comma delimited list of contact emails | [optional] |
-| **compression_format** | [**CompressionFormat**](.md) | FileResponse compression format. None or Zip. | [optional] |
+| **compression_format** | [**CompressionFormat**](.md) | FileResponse compression format. None or Zip. | [optional][default to 'None'] |
 | **file_name** | **String** | Name of your file including extension. | [optional] |
 
 ### Return type
@@ -702,7 +702,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::ContactsApi.new
-contact_payload = [ElasticEmail::ContactPayload.new] # Array<ContactPayload> | 
+contact_payload = [ElasticEmail::ContactPayload.new({email: 'mail@example.com'})] # Array<ContactPayload> | 
 opts = {
   listnames: ['inner_example'] # Array<String> | Names of lists to which the uploaded contacts should be added to
 }

data/docs/EmailContent.md

@@ -15,7 +15,7 @@
 | **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] |
+| **utm** | [**Utm**](Utm.md) |  | [optional] |
 
 ## Example
 
@@ -33,7 +33,7 @@ instance = ElasticEmail::EmailContent.new(
   reply_to: John Doe <email@domain.com>,
   subject: Hello!,
   template_name: Template01,
-  attach_files: null,
+  attach_files: [ "preuploaded.jpg" ],
   utm: null
 )
 ```

data/docs/EmailData.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **preview** | [**EmailView**](EmailView.md) | Email details | [optional] |
+| **preview** | [**EmailView**](EmailView.md) |  | [optional] |
 | **attachments** | [**Array<FileInfo>**](FileInfo.md) | Attachments sent with the email | [optional] |
-| **status** | [**EmailStatus**](EmailStatus.md) | Status of the given resource | [optional] |
+| **status** | [**EmailStatus**](EmailStatus.md) |  | [optional] |
 
 ## Example
 

data/docs/EmailMessageData.md

@@ -4,9 +4,9 @@
 
 | 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] |
+| **recipients** | [**Array<EmailRecipient>**](EmailRecipient.md) | List of recipients |  |
+| **content** | [**EmailContent**](EmailContent.md) |  | [optional] |
+| **options** | [**Options**](Options.md) |  | [optional] |
 
 ## Example
 

data/docs/EmailRecipient.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **email** | **String** | Proper email address. | [optional] |
+| **email** | **String** | Proper email address. |  |
 | **fields** | **Hash<String, String>** | A key-value collection of merge fields which can be used in e-mail body. | [optional] |
 
 ## Example

data/docs/EmailStatus.md

@@ -7,7 +7,7 @@
 | **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** | [**LogJobStatus**](LogJobStatus.md) |  | [optional][default to 'All'] |
 | **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] |

data/docs/EmailTransactionalMessageData.md

@@ -4,9 +4,9 @@
 
 | 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] |
+| **recipients** | [**TransactionalRecipient**](TransactionalRecipient.md) |  |  |
+| **content** | [**EmailContent**](EmailContent.md) |  | [optional] |
+| **options** | [**Options**](Options.md) |  | [optional] |
 
 ## Example
 

data/docs/EmailsApi.md

@@ -103,7 +103,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::EmailsApi.new
-merge_email_payload = ElasticEmail::MergeEmailPayload.new # MergeEmailPayload | Email data
+merge_email_payload = ElasticEmail::MergeEmailPayload.new({merge_file: ElasticEmail::MessageAttachment.new({binary_content: 'binary_content_example'})}) # MergeEmailPayload | Email data
 
 begin
   # Send Bulk Emails CSV
@@ -174,7 +174,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::EmailsApi.new
-email_message_data = ElasticEmail::EmailMessageData.new # EmailMessageData | Email data
+email_message_data = ElasticEmail::EmailMessageData.new({recipients: [ElasticEmail::EmailRecipient.new({email: 'mail@example.com'})]}) # EmailMessageData | Email data
 
 begin
   # Send Bulk Emails
@@ -245,7 +245,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::EmailsApi.new
-email_transactional_message_data = ElasticEmail::EmailTransactionalMessageData.new # EmailTransactionalMessageData | Email data
+email_transactional_message_data = ElasticEmail::EmailTransactionalMessageData.new({recipients: ElasticEmail::TransactionalRecipient.new({to: ['to_example']})}) # EmailTransactionalMessageData | Email data
 
 begin
   # Send Transactional Email

data/docs/EmailsPayload.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **rule** | **String** | SQL-like rule. Sending 'All' as a value loads all resources of the given type. | [optional] |
+| **rule** | **String** | SQL-like rule. Sending 'All' as a value loads all resources of the given type. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules | [optional] |
 | **emails** | **Array<String>** | Comma delimited list of contact emails | [optional] |
 
 ## Example
@@ -14,7 +14,7 @@ require 'ElasticEmail'
 
 instance = ElasticEmail::EmailsPayload.new(
   rule: null,
-  emails: null
+  emails: [ "john.doe@sample.com" ]
 )
 ```
 

data/docs/EventsApi.md

@@ -78,7 +78,7 @@ end
 | **transactionid** | **String** | ID number of transaction |  |
 | **from** | **Time** | Starting date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
 | **to** | **Time** | Ending date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
-| **order_by** | [**EventsOrderBy**](.md) |  | [optional] |
+| **order_by** | [**EventsOrderBy**](.md) |  | [optional][default to 'DateDescending'] |
 | **limit** | **Integer** | Maximum number of returned items. | [optional] |
 | **offset** | **Integer** | How many items should be returned ahead. | [optional] |
 
@@ -163,8 +163,8 @@ end
 | **event_types** | [**Array<EventType>**](EventType.md) | Types of Events to return | [optional] |
 | **from** | **Time** | Starting date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
 | **to** | **Time** | Ending date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
-| **file_format** | [**ExportFileFormats**](.md) | Format of the exported file | [optional] |
-| **compression_format** | [**CompressionFormat**](.md) | FileResponse compression format. None or Zip. | [optional] |
+| **file_format** | [**ExportFileFormats**](.md) | Format of the exported file | [optional][default to 'Csv'] |
+| **compression_format** | [**CompressionFormat**](.md) | FileResponse compression format. None or Zip. | [optional][default to 'None'] |
 | **file_name** | **String** | Name of your file including extension. | [optional] |
 
 ### Return type
@@ -248,7 +248,7 @@ end
 | **event_types** | [**Array<EventType>**](EventType.md) | Types of Events to return | [optional] |
 | **from** | **Time** | Starting date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
 | **to** | **Time** | Ending date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
-| **order_by** | [**EventsOrderBy**](.md) |  | [optional] |
+| **order_by** | [**EventsOrderBy**](.md) |  | [optional][default to 'DateDescending'] |
 | **limit** | **Integer** | How many items to load. Maximum for this request is 1000 items | [optional] |
 | **offset** | **Integer** | How many items should be returned ahead. | [optional] |
 
@@ -473,8 +473,8 @@ end
 | **event_types** | [**Array<EventType>**](EventType.md) | Types of Events to return | [optional] |
 | **from** | **Time** | Starting date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
 | **to** | **Time** | Ending date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
-| **file_format** | [**ExportFileFormats**](.md) | Format of the exported file | [optional] |
-| **compression_format** | [**CompressionFormat**](.md) | FileResponse compression format. None or Zip. | [optional] |
+| **file_format** | [**ExportFileFormats**](.md) | Format of the exported file | [optional][default to 'Csv'] |
+| **compression_format** | [**CompressionFormat**](.md) | FileResponse compression format. None or Zip. | [optional][default to 'None'] |
 | **file_name** | **String** | Name of your file including extension. | [optional] |
 
 ### Return type
@@ -556,7 +556,7 @@ end
 | **event_types** | [**Array<EventType>**](EventType.md) | Types of Events to return | [optional] |
 | **from** | **Time** | Starting date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
 | **to** | **Time** | Ending date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
-| **order_by** | [**EventsOrderBy**](.md) |  | [optional] |
+| **order_by** | [**EventsOrderBy**](.md) |  | [optional][default to 'DateDescending'] |
 | **limit** | **Integer** | How many items to load. Maximum for this request is 1000 items | [optional] |
 | **offset** | **Integer** | How many items should be returned ahead. | [optional] |
 

data/docs/FilePayload.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **binary_content** | **String** | Content of the file sent as binary data | [optional] |
+| **binary_content** | **String** | Content of the file sent as binary data |  |
 | **name** | **String** | Filename | [optional] |
 | **content_type** | **String** | Type of file's content (e.g. image/jpeg) | [optional] |
 

data/docs/FilesApi.md

@@ -320,7 +320,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::FilesApi.new
-file_payload = ElasticEmail::FilePayload.new # FilePayload | 
+file_payload = ElasticEmail::FilePayload.new({binary_content: 'binary_content_example'}) # FilePayload | 
 opts = {
   expires_after_days: 56 # Integer | After how many days should the file be deleted.
 }

data/docs/InboundPayload.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **filter** | **String** | Filter of the inbound data | [optional] |
-| **name** | **String** | Name of this route | [optional] |
-| **filter_type** | [**InboundRouteFilterType**](InboundRouteFilterType.md) | Type of the filter | [optional] |
-| **action_type** | [**InboundRouteActionType**](InboundRouteActionType.md) | Type of action to take | [optional] |
+| **filter** | **String** | Filter of the inbound data |  |
+| **name** | **String** | Name of this route |  |
+| **filter_type** | [**InboundRouteFilterType**](InboundRouteFilterType.md) |  | [default to 'EmailAddress'] |
+| **action_type** | [**InboundRouteActionType**](InboundRouteActionType.md) |  | [default to 'ForwardToEmail'] |
 | **email_address** | **String** | Email to forward the inbound to | [optional] |
 | **http_address** | **String** | Address to notify about the inbound | [optional] |
 

data/docs/InboundRoute.md

@@ -6,9 +6,9 @@
 | ---- | ---- | ----------- | ----- |
 | **public_id** | **String** |  | [optional] |
 | **name** | **String** | Name of this route | [optional] |
-| **filter_type** | [**InboundRouteFilterType**](InboundRouteFilterType.md) | Type of the filter | [optional] |
+| **filter_type** | [**InboundRouteFilterType**](InboundRouteFilterType.md) |  | [optional][default to 'EmailAddress'] |
 | **filter** | **String** | Filter of the inbound data | [optional] |
-| **action_type** | [**InboundRouteActionType**](InboundRouteActionType.md) | Type of action to take | [optional] |
+| **action_type** | [**InboundRouteActionType**](InboundRouteActionType.md) |  | [optional][default to 'ForwardToEmail'] |
 | **action_parameter** | **String** | URL address or Email to notify about the inbound | [optional] |
 | **sort_order** | **Integer** | Place of this route in your routes queue's order | [optional] |
 

data/docs/InboundRouteApi.md

@@ -176,7 +176,7 @@ end
 
 api_instance = ElasticEmail::InboundRouteApi.new
 id = 'id_example' # String | 
-inbound_payload = ElasticEmail::InboundPayload.new # InboundPayload | 
+inbound_payload = ElasticEmail::InboundPayload.new({filter: 'filter_example', name: 'name_example', filter_type: ElasticEmail::InboundRouteFilterType::EMAIL_ADDRESS, action_type: ElasticEmail::InboundRouteActionType::FORWARD_TO_EMAIL}) # InboundPayload | 
 
 begin
   # Update Route
@@ -316,7 +316,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::InboundRouteApi.new
-sort_order_item = [ElasticEmail::SortOrderItem.new] # Array<SortOrderItem> | Change the ordering of inbound routes for when matching the inbound
+sort_order_item = [ElasticEmail::SortOrderItem.new({public_inbound_id: 'public_inbound_id_example', sort_order: 37})] # Array<SortOrderItem> | Change the ordering of inbound routes for when matching the inbound
 
 begin
   # Update Sorting
@@ -387,7 +387,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::InboundRouteApi.new
-inbound_payload = ElasticEmail::InboundPayload.new # InboundPayload | 
+inbound_payload = ElasticEmail::InboundPayload.new({filter: 'filter_example', name: 'name_example', filter_type: ElasticEmail::InboundRouteFilterType::EMAIL_ADDRESS, action_type: ElasticEmail::InboundRouteActionType::FORWARD_TO_EMAIL}) # InboundPayload | 
 
 begin
   # Create Route

data/docs/ListPayload.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **list_name** | **String** | Name of your list. | [optional] |
+| **list_name** | **String** | Name of your list. |  |
 | **allow_unsubscribe** | **Boolean** | True: Allow unsubscribing from this list. Otherwise, false | [optional] |
-| **emails** | **Array<String>** | Comma delimited list of existing contact emails that should be added to this list | [optional] |
+| **emails** | **Array<String>** | Comma delimited list of existing contact emails that should be added to this list. Leave empty for all contacts | [optional] |
 
 ## Example
 

data/docs/ListsApi.md

@@ -469,7 +469,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::ListsApi.new
-list_payload = ElasticEmail::ListPayload.new # ListPayload | 
+list_payload = ElasticEmail::ListPayload.new({list_name: 'My List 1'}) # ListPayload | 
 
 begin
   # Add List

data/docs/MergeEmailPayload.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **merge_file** | [**MessageAttachment**](MessageAttachment.md) | CSV file containing recipients with optional merge fields | [optional] |
-| **content** | [**EmailContent**](EmailContent.md) | Proper e-mail content | [optional] |
-| **options** | [**Options**](Options.md) | E-mail configuration | [optional] |
+| **merge_file** | [**MessageAttachment**](MessageAttachment.md) |  |  |
+| **content** | [**EmailContent**](EmailContent.md) |  | [optional] |
+| **options** | [**Options**](Options.md) |  | [optional] |
 
 ## Example
 

data/docs/MessageAttachment.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **binary_content** | **String** |  | [optional] |
-| **name** | **String** | Filename | [optional] |
-| **content_type** | **String** |  | [optional] |
+| **binary_content** | **String** | File's content as byte array (or a Base64 string) |  |
+| **name** | **String** | Display name of the file | [optional] |
+| **content_type** | **String** | MIME content type | [optional] |
 
 ## Example
 
@@ -15,7 +15,7 @@ require 'ElasticEmail'
 
 instance = ElasticEmail::MessageAttachment.new(
   binary_content: null,
-  name: attachment.txt,
+  name: null,
   content_type: null
 )
 ```

data/docs/NewSmtpCredentials.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **token** | **String** | Unique token to be used in the system | [optional] |
-| **access_level** | [**AccessLevel**](AccessLevel.md) | Access level of this Smtp Credential. | [optional] |
+| **access_level** | [**AccessLevel**](AccessLevel.md) |  | [optional][default to 'None'] |
 | **name** | **String** | Name of the key. | [optional] |
 | **date_created** | **Time** | Date this SmtpCredential was created. | [optional] |
 | **last_use** | **Time** | Date this SmtpCredential was last used. | [optional] |

data/docs/Options.md

@@ -7,7 +7,7 @@
 | **time_offset** | **Integer** | By how long should an e-mail be delayed (in minutes). Maximum is 35 days. | [optional] |
 | **pool_name** | **String** | Name of your custom IP Pool to be used in the sending process | [optional] |
 | **channel_name** | **String** | Name of selected channel. | [optional] |
-| **encoding** | [**EncodingType**](EncodingType.md) | 0 for None, 1 for Raw7Bit, 2 for Raw8Bit, 3 for QuotedPrintable, 4 for Base64 (Default), 5 for Uue note that you can also provide the text version such as \"Raw7Bit\" for value 1. NOTE: Base64 or QuotedPrintable is recommended if you are validating your domain(s) with DKIM. | [optional] |
+| **encoding** | [**EncodingType**](EncodingType.md) |  | [optional][default to 'UserProvided'] |
 | **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] |