ElasticEmail 4.0.1 → 4.0.15
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/ElasticEmail.gemspec +3 -3
- data/README.md +14 -9
- data/VERSION +1 -1
- data/docs/ApiKeyPayload.md +2 -2
- data/docs/BodyPart.md +1 -1
- data/docs/Campaign.md +4 -4
- data/docs/CampaignOptions.md +2 -2
- data/docs/CampaignTemplate.md +2 -2
- data/docs/CampaignsApi.md +2 -2
- data/docs/ConsentData.md +1 -1
- data/docs/Contact.md +3 -3
- data/docs/ContactHistory.md +1 -1
- data/docs/ContactPayload.md +2 -2
- data/docs/ContactsApi.md +3 -3
- data/docs/EmailContent.md +4 -2
- data/docs/EmailData.md +2 -2
- data/docs/EmailMessageData.md +3 -3
- data/docs/EmailRecipient.md +1 -1
- data/docs/EmailStatus.md +1 -1
- data/docs/EmailTransactionalMessageData.md +3 -3
- data/docs/EmailsApi.md +3 -3
- data/docs/EmailsPayload.md +2 -2
- data/docs/EventsApi.md +7 -7
- data/docs/FilePayload.md +1 -1
- data/docs/FilesApi.md +1 -1
- data/docs/InboundPayload.md +4 -4
- data/docs/InboundRoute.md +2 -2
- data/docs/InboundRouteApi.md +3 -3
- data/docs/ListPayload.md +2 -2
- data/docs/ListsApi.md +1 -1
- data/docs/MergeEmailPayload.md +3 -3
- data/docs/MessageAttachment.md +4 -4
- data/docs/NewSmtpCredentials.md +1 -1
- data/docs/Options.md +1 -1
- data/docs/RecipientEvent.md +2 -2
- data/docs/SecurityApi.md +4 -4
- data/docs/SegmentPayload.md +2 -2
- data/docs/SegmentsApi.md +2 -2
- data/docs/SmtpCredentials.md +1 -1
- data/docs/SmtpCredentialsPayload.md +1 -1
- data/docs/SortOrderItem.md +2 -2
- data/docs/SplitOptions.md +1 -1
- data/docs/SubAccountInfo.md +2 -2
- data/docs/SubAccountsApi.md +2 -2
- data/docs/SubaccountEmailCreditsPayload.md +1 -1
- data/docs/SubaccountPayload.md +3 -3
- data/docs/SubaccountSettingsInfo.md +1 -1
- data/docs/SubaccountSettingsInfoPayload.md +1 -1
- data/docs/Template.md +2 -2
- data/docs/TemplatePayload.md +2 -2
- data/docs/TemplateScope.md +15 -0
- data/docs/TemplatesApi.md +4 -4
- data/docs/TransactionalRecipient.md +1 -1
- data/docs/VerificationFileResult.md +2 -2
- data/docs/VerificationFileResultDetails.md +2 -2
- data/docs/VerificationsApi.md +80 -9
- data/lib/ElasticEmail/api/campaigns_api.rb +10 -4
- data/lib/ElasticEmail/api/contacts_api.rb +20 -8
- data/lib/ElasticEmail/api/emails_api.rb +14 -5
- data/lib/ElasticEmail/api/events_api.rb +9 -9
- data/lib/ElasticEmail/api/files_api.rb +6 -3
- data/lib/ElasticEmail/api/inbound_route_api.rb +14 -5
- data/lib/ElasticEmail/api/lists_api.rb +18 -6
- data/lib/ElasticEmail/api/security_api.rb +18 -6
- data/lib/ElasticEmail/api/segments_api.rb +10 -4
- data/lib/ElasticEmail/api/statistics_api.rb +2 -2
- data/lib/ElasticEmail/api/sub_accounts_api.rb +14 -5
- data/lib/ElasticEmail/api/suppressions_api.rb +26 -8
- data/lib/ElasticEmail/api/templates_api.rb +12 -6
- data/lib/ElasticEmail/api/verifications_api.rb +73 -9
- data/lib/ElasticEmail/api_client.rb +5 -5
- data/lib/ElasticEmail/api_error.rb +2 -2
- data/lib/ElasticEmail/configuration.rb +4 -3
- data/lib/ElasticEmail/models/access_level.rb +5 -2
- data/lib/ElasticEmail/models/account_status_enum.rb +2 -2
- data/lib/ElasticEmail/models/api_key.rb +2 -2
- data/lib/ElasticEmail/models/api_key_payload.rb +12 -2
- data/lib/ElasticEmail/models/body_content_type.rb +2 -2
- data/lib/ElasticEmail/models/body_part.rb +9 -3
- data/lib/ElasticEmail/models/campaign.rb +14 -5
- data/lib/ElasticEmail/models/campaign_options.rb +4 -4
- data/lib/ElasticEmail/models/campaign_recipient.rb +2 -2
- data/lib/ElasticEmail/models/campaign_status.rb +2 -2
- data/lib/ElasticEmail/models/campaign_template.rb +2 -3
- data/lib/ElasticEmail/models/channel_log_status_summary.rb +2 -2
- data/lib/ElasticEmail/models/compression_format.rb +2 -2
- data/lib/ElasticEmail/models/consent_data.rb +4 -3
- data/lib/ElasticEmail/models/consent_tracking.rb +2 -2
- data/lib/ElasticEmail/models/contact.rb +6 -5
- data/lib/ElasticEmail/models/contact_activity.rb +2 -2
- data/lib/ElasticEmail/models/contact_hist_event_type.rb +2 -2
- data/lib/ElasticEmail/models/contact_history.rb +4 -3
- data/lib/ElasticEmail/models/contact_payload.rb +9 -3
- data/lib/ElasticEmail/models/contact_source.rb +2 -2
- data/lib/ElasticEmail/models/contact_status.rb +2 -2
- data/lib/ElasticEmail/models/contact_update_payload.rb +2 -2
- data/lib/ElasticEmail/models/contacts_list.rb +2 -2
- data/lib/ElasticEmail/models/delivery_optimization_type.rb +2 -2
- data/lib/ElasticEmail/models/email_content.rb +13 -4
- data/lib/ElasticEmail/models/email_data.rb +2 -4
- data/lib/ElasticEmail/models/email_message_data.rb +8 -5
- data/lib/ElasticEmail/models/email_recipient.rb +8 -3
- data/lib/ElasticEmail/models/email_send.rb +2 -2
- data/lib/ElasticEmail/models/email_status.rb +4 -3
- data/lib/ElasticEmail/models/email_transactional_message_data.rb +7 -5
- data/lib/ElasticEmail/models/email_validation_result.rb +2 -2
- data/lib/ElasticEmail/models/email_validation_status.rb +2 -2
- data/lib/ElasticEmail/models/email_view.rb +2 -2
- data/lib/ElasticEmail/models/emails_payload.rb +3 -3
- data/lib/ElasticEmail/models/encoding_type.rb +2 -2
- data/lib/ElasticEmail/models/event_type.rb +2 -2
- data/lib/ElasticEmail/models/events_order_by.rb +2 -2
- data/lib/ElasticEmail/models/export_file_formats.rb +2 -2
- data/lib/ElasticEmail/models/export_link.rb +2 -2
- data/lib/ElasticEmail/models/export_status.rb +2 -2
- data/lib/ElasticEmail/models/file_info.rb +2 -2
- data/lib/ElasticEmail/models/file_payload.rb +7 -2
- data/lib/ElasticEmail/models/file_upload_result.rb +2 -2
- data/lib/ElasticEmail/models/inbound_payload.rb +26 -4
- data/lib/ElasticEmail/models/inbound_route.rb +6 -4
- data/lib/ElasticEmail/models/inbound_route_action_type.rb +2 -2
- data/lib/ElasticEmail/models/inbound_route_filter_type.rb +2 -2
- data/lib/ElasticEmail/models/list_payload.rb +8 -3
- data/lib/ElasticEmail/models/list_update_payload.rb +2 -2
- data/lib/ElasticEmail/models/log_job_status.rb +2 -2
- data/lib/ElasticEmail/models/log_status_summary.rb +2 -2
- data/lib/ElasticEmail/models/merge_email_payload.rb +7 -5
- data/lib/ElasticEmail/models/message_attachment.rb +10 -3
- data/lib/ElasticEmail/models/message_category.rb +2 -2
- data/lib/ElasticEmail/models/new_api_key.rb +2 -2
- data/lib/ElasticEmail/models/new_smtp_credentials.rb +4 -3
- data/lib/ElasticEmail/models/options.rb +4 -3
- data/lib/ElasticEmail/models/recipient_event.rb +6 -4
- data/lib/ElasticEmail/models/segment.rb +2 -2
- data/lib/ElasticEmail/models/segment_payload.rb +12 -2
- data/lib/ElasticEmail/models/smtp_credentials.rb +4 -3
- data/lib/ElasticEmail/models/smtp_credentials_payload.rb +7 -2
- data/lib/ElasticEmail/models/sort_order_item.rb +13 -2
- data/lib/ElasticEmail/models/split_optimization_type.rb +2 -2
- data/lib/ElasticEmail/models/split_options.rb +4 -3
- data/lib/ElasticEmail/models/sub_account_info.rb +4 -4
- data/lib/ElasticEmail/models/subaccount_email_credits_payload.rb +7 -2
- data/lib/ElasticEmail/models/subaccount_email_settings.rb +2 -2
- data/lib/ElasticEmail/models/subaccount_email_settings_payload.rb +2 -2
- data/lib/ElasticEmail/models/subaccount_payload.rb +12 -3
- data/lib/ElasticEmail/models/subaccount_settings_info.rb +2 -3
- data/lib/ElasticEmail/models/subaccount_settings_info_payload.rb +2 -3
- data/lib/ElasticEmail/models/suppression.rb +2 -2
- data/lib/ElasticEmail/models/template.rb +7 -5
- data/lib/ElasticEmail/models/template_payload.rb +10 -4
- data/lib/ElasticEmail/models/template_scope.rb +37 -0
- data/lib/ElasticEmail/models/template_type.rb +2 -2
- data/lib/ElasticEmail/models/transactional_recipient.rb +7 -2
- data/lib/ElasticEmail/models/utm.rb +2 -2
- data/lib/ElasticEmail/models/verification_file_result.rb +4 -4
- data/lib/ElasticEmail/models/verification_file_result_details.rb +4 -4
- data/lib/ElasticEmail/models/verification_status.rb +2 -2
- data/lib/ElasticEmail/version.rb +3 -3
- data/lib/ElasticEmail.rb +3 -3
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/template_scope_spec.rb +28 -0
- data/spec/spec_helper.rb +2 -2
- metadata +92 -86
- data/DIFF +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9f8bc6bc6d849946b76ded2bc32986f3f8be76905c10f6278afa5cc34b10dc3a
|
4
|
+
data.tar.gz: 32721e00ef7f489e8f7e80a174dcad84e9f7eae015d556b634f44bb52e04ceea
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ed03c9372d125b5b40049acac08b4ceb8a141a19521226875fd2df4bec901b4c76a2b1809e0c7811311b29b6c2355c85d57ff16511472cf6f8178003fa93d1c7
|
7
|
+
data.tar.gz: fa82cdaa48e0a46f4ef8bd118202204eb1723a4e4b3fffdd9b799641d4fc11ad4bbe26925997c52d58717e33d1e4730041fd080bc0267b8adf0d8c5c02eae28b
|
data/ElasticEmail.gemspec
CHANGED
@@ -3,12 +3,12 @@
|
|
3
3
|
=begin
|
4
4
|
#Elastic Email REST API
|
5
5
|
|
6
|
-
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. To start using this API, you will need your Access Token (available <a href=\"https://elasticemail.com/account#/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click <a href=\"https://api.elasticemail.com/public/help\">here</a>.
|
6
|
+
#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>
|
7
7
|
|
8
8
|
The version of the OpenAPI document: 4.0.0
|
9
9
|
Contact: support@elasticemail.com
|
10
10
|
Generated by: https://openapi-generator.tech
|
11
|
-
OpenAPI Generator version: 5.0
|
11
|
+
OpenAPI Generator version: 5.3.0
|
12
12
|
|
13
13
|
=end
|
14
14
|
|
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
|
|
23
23
|
s.email = ["contact@elasticemail.com"]
|
24
24
|
s.homepage = "https://elasticemail.com"
|
25
25
|
s.summary = "Elastic Email REST API Ruby Gem"
|
26
|
-
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 href=\"https://elasticemail.com/account#/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click <a href=\"https://api.elasticemail.com/public/help\">here</a>."
|
26
|
+
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>"
|
27
27
|
s.license = "Unlicense"
|
28
28
|
s.required_ruby_version = ">= 2.4"
|
29
29
|
|
data/README.md
CHANGED
@@ -6,14 +6,18 @@ This API is based on the REST API architecture, allowing the user to easily mana
|
|
6
6
|
|
7
7
|
Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.
|
8
8
|
|
9
|
-
|
9
|
+
The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request.
|
10
10
|
|
11
|
-
|
11
|
+
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.
|
12
|
+
|
13
|
+
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).
|
14
|
+
|
15
|
+
Downloadable library clients can be found in our Github repository [here](https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme)
|
12
16
|
|
13
17
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
14
18
|
|
15
19
|
- API version: 4.0.0
|
16
|
-
- Package version: 4.0.
|
20
|
+
- Package version: 4.0.15
|
17
21
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
18
22
|
|
19
23
|
## Installation
|
@@ -29,16 +33,16 @@ gem build ElasticEmail.gemspec
|
|
29
33
|
Then either install the gem locally:
|
30
34
|
|
31
35
|
```shell
|
32
|
-
gem install ./ElasticEmail-4.0.
|
36
|
+
gem install ./ElasticEmail-4.0.15.gem
|
33
37
|
```
|
34
38
|
|
35
|
-
(for development, run `gem install --dev ./ElasticEmail-4.0.
|
39
|
+
(for development, run `gem install --dev ./ElasticEmail-4.0.15.gem` to install the development dependencies)
|
36
40
|
|
37
41
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
38
42
|
|
39
43
|
Finally add this to the Gemfile:
|
40
44
|
|
41
|
-
gem 'ElasticEmail', '~> 4.0.
|
45
|
+
gem 'ElasticEmail', '~> 4.0.15'
|
42
46
|
|
43
47
|
### Install from Git
|
44
48
|
|
@@ -181,8 +185,9 @@ Class | Method | HTTP request | Description
|
|
181
185
|
*ElasticEmail::VerificationsApi* | [**verifications_files_by_id_delete**](docs/VerificationsApi.md#verifications_files_by_id_delete) | **DELETE** /verifications/files/{id} | Delete File Verification Result
|
182
186
|
*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
|
183
187
|
*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
|
184
|
-
*ElasticEmail::VerificationsApi* | [**
|
185
|
-
*ElasticEmail::VerificationsApi* | [**
|
188
|
+
*ElasticEmail::VerificationsApi* | [**verifications_files_by_id_verification_post**](docs/VerificationsApi.md#verifications_files_by_id_verification_post) | **POST** /verifications/files/{id}/verification | Start verification
|
189
|
+
*ElasticEmail::VerificationsApi* | [**verifications_files_post**](docs/VerificationsApi.md#verifications_files_post) | **POST** /verifications/files | Upload File with Emails
|
190
|
+
*ElasticEmail::VerificationsApi* | [**verifications_files_result_get**](docs/VerificationsApi.md#verifications_files_result_get) | **GET** /verifications/files/result | Get Files Verification Results
|
186
191
|
*ElasticEmail::VerificationsApi* | [**verifications_get**](docs/VerificationsApi.md#verifications_get) | **GET** /verifications | Get Emails Verification Results
|
187
192
|
|
188
193
|
|
@@ -265,7 +270,7 @@ Class | Method | HTTP request | Description
|
|
265
270
|
- [ElasticEmail::Suppression](docs/Suppression.md)
|
266
271
|
- [ElasticEmail::Template](docs/Template.md)
|
267
272
|
- [ElasticEmail::TemplatePayload](docs/TemplatePayload.md)
|
268
|
-
- [ElasticEmail::
|
273
|
+
- [ElasticEmail::TemplateScope](docs/TemplateScope.md)
|
269
274
|
- [ElasticEmail::TemplateType](docs/TemplateType.md)
|
270
275
|
- [ElasticEmail::TransactionalRecipient](docs/TransactionalRecipient.md)
|
271
276
|
- [ElasticEmail::Utm](docs/Utm.md)
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
4.0.
|
1
|
+
4.0.15
|
data/docs/ApiKeyPayload.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **name** | **String** | Name of the ApiKey for ease of reference. |
|
8
|
-
| **access_level** | [**Array<AccessLevel>**](AccessLevel.md) | Access level or permission to be assigned to this ApiKey. |
|
7
|
+
| **name** | **String** | Name of the ApiKey for ease of reference. | |
|
8
|
+
| **access_level** | [**Array<AccessLevel>**](AccessLevel.md) | Access level or permission to be assigned to this ApiKey. | |
|
9
9
|
| **expires** | **Time** | Date this ApiKey expires. | [optional] |
|
10
10
|
| **restrict_access_to_ip_range** | **Array<String>** | Which IPs can use this ApiKey | [optional] |
|
11
11
|
| **subaccount** | **String** | Email of the subaccount for which this ApiKey should be created | [optional] |
|
data/docs/BodyPart.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **content_type** | [**BodyContentType**](BodyContentType.md) |
|
7
|
+
| **content_type** | [**BodyContentType**](BodyContentType.md) | | [default to 'HTML'] |
|
8
8
|
| **content** | **String** | Actual content of the body part | [optional] |
|
9
9
|
| **charset** | **String** | Text value of charset encoding for example: iso-8859-1, windows-1251, utf-8, us-ascii, windows-1250 and more… | [optional] |
|
10
10
|
|
data/docs/Campaign.md
CHANGED
@@ -5,10 +5,10 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **content** | [**Array<CampaignTemplate>**](CampaignTemplate.md) | Campaign's email content. Provide multiple items to send an A/X Split Campaign | [optional] |
|
8
|
-
| **name** | **String** | Campaign name |
|
9
|
-
| **status** | [**CampaignStatus**](CampaignStatus.md) |
|
10
|
-
| **recipients** | [**CampaignRecipient**](CampaignRecipient.md) |
|
11
|
-
| **options** | [**CampaignOptions**](CampaignOptions.md) |
|
8
|
+
| **name** | **String** | Campaign name | |
|
9
|
+
| **status** | [**CampaignStatus**](CampaignStatus.md) | | [optional][default to 'Deleted'] |
|
10
|
+
| **recipients** | [**CampaignRecipient**](CampaignRecipient.md) | | |
|
11
|
+
| **options** | [**CampaignOptions**](CampaignOptions.md) | | [optional] |
|
12
12
|
|
13
13
|
## Example
|
14
14
|
|
data/docs/CampaignOptions.md
CHANGED
@@ -4,11 +4,11 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **delivery_optimization** | [**DeliveryOptimizationType**](DeliveryOptimizationType.md) |
|
7
|
+
| **delivery_optimization** | [**DeliveryOptimizationType**](DeliveryOptimizationType.md) | | [optional][default to 'None'] |
|
8
8
|
| **track_opens** | **Boolean** | Should the opens be tracked? If no value has been provided, Account's default setting will be used. | [optional] |
|
9
9
|
| **track_clicks** | **Boolean** | Should the clicks be tracked? If no value has been provided, Account's default setting will be used. | [optional] |
|
10
10
|
| **schedule_for** | **Time** | Date when this Campaign is scheduled to be sent on | [optional] |
|
11
|
-
| **split_options** | [**SplitOptions**](SplitOptions.md) |
|
11
|
+
| **split_options** | [**SplitOptions**](SplitOptions.md) | | [optional] |
|
12
12
|
|
13
13
|
## Example
|
14
14
|
|
data/docs/CampaignTemplate.md
CHANGED
@@ -10,7 +10,7 @@
|
|
10
10
|
| **subject** | **String** | Default subject of email. | [optional] |
|
11
11
|
| **template_name** | **String** | Name of template. | [optional] |
|
12
12
|
| **attach_files** | **Array<String>** | Names of previously uploaded files that should be sent as downloadable attachments | [optional] |
|
13
|
-
| **utm** | [**Utm**](Utm.md) |
|
13
|
+
| **utm** | [**Utm**](Utm.md) | | [optional] |
|
14
14
|
|
15
15
|
## Example
|
16
16
|
|
@@ -23,7 +23,7 @@ instance = ElasticEmail::CampaignTemplate.new(
|
|
23
23
|
reply_to: John Doe <email@domain.com>,
|
24
24
|
subject: Hello!,
|
25
25
|
template_name: Template01,
|
26
|
-
attach_files:
|
26
|
+
attach_files: [ "preuploaded.jpg" ],
|
27
27
|
utm: null
|
28
28
|
)
|
29
29
|
```
|
data/docs/CampaignsApi.md
CHANGED
@@ -175,7 +175,7 @@ end
|
|
175
175
|
|
176
176
|
api_instance = ElasticEmail::CampaignsApi.new
|
177
177
|
name = 'name_example' # String | Name of Campaign to update
|
178
|
-
campaign = ElasticEmail::Campaign.new # Campaign | JSON representation of a campaign
|
178
|
+
campaign = ElasticEmail::Campaign.new({name: 'name_example', recipients: ElasticEmail::CampaignRecipient.new}) # Campaign | JSON representation of a campaign
|
179
179
|
|
180
180
|
begin
|
181
181
|
# Update Campaign
|
@@ -324,7 +324,7 @@ ElasticEmail.configure do |config|
|
|
324
324
|
end
|
325
325
|
|
326
326
|
api_instance = ElasticEmail::CampaignsApi.new
|
327
|
-
campaign = ElasticEmail::Campaign.new # Campaign | JSON representation of a campaign
|
327
|
+
campaign = ElasticEmail::Campaign.new({name: 'name_example', recipients: ElasticEmail::CampaignRecipient.new}) # Campaign | JSON representation of a campaign
|
328
328
|
|
329
329
|
begin
|
330
330
|
# Add Campaign
|
data/docs/ConsentData.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
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] |
|
8
8
|
| **consent_date** | **Time** | Date of consent to send this contact(s) your email. If not provided current date is used for consent. | [optional] |
|
9
|
-
| **consent_tracking** | [**ConsentTracking**](ConsentTracking.md) |
|
9
|
+
| **consent_tracking** | [**ConsentTracking**](ConsentTracking.md) | | [optional][default to 'Unknown'] |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
data/docs/Contact.md
CHANGED
@@ -5,16 +5,16 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **email** | **String** | Proper email address. | [optional] |
|
8
|
-
| **status** | [**ContactStatus**](ContactStatus.md) |
|
8
|
+
| **status** | [**ContactStatus**](ContactStatus.md) | | [optional][default to 'Transactional'] |
|
9
9
|
| **first_name** | **String** | First name. | [optional] |
|
10
10
|
| **last_name** | **String** | Last name. | [optional] |
|
11
11
|
| **custom_fields** | **Hash<String, String>** | A key-value collection of custom contact fields which can be used in the system. | [optional] |
|
12
12
|
| **consent** | [**ConsentData**](ConsentData.md) | | [optional] |
|
13
|
-
| **source** | [**ContactSource**](ContactSource.md) |
|
13
|
+
| **source** | [**ContactSource**](ContactSource.md) | | [optional][default to 'DeliveryApi'] |
|
14
14
|
| **date_added** | **Time** | Date of creation in YYYY-MM-DDThh:ii:ss format | [optional] |
|
15
15
|
| **date_updated** | **Time** | Last change date | [optional] |
|
16
16
|
| **status_change_date** | **Time** | Date of last status change. | [optional] |
|
17
|
-
| **activity** | [**ContactActivity**](ContactActivity.md) |
|
17
|
+
| **activity** | [**ContactActivity**](ContactActivity.md) | | [optional] |
|
18
18
|
|
19
19
|
## Example
|
20
20
|
|
data/docs/ContactHistory.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **event_type** | [**ContactHistEventType**](ContactHistEventType.md) |
|
7
|
+
| **event_type** | [**ContactHistEventType**](ContactHistEventType.md) | | [optional][default to 'Opened'] |
|
8
8
|
| **event_date** | **Time** | Formatted date of event. | [optional] |
|
9
9
|
| **channel_name** | **String** | Name of channel this event occured on | [optional] |
|
10
10
|
| **template_name** | **String** | Name of template this event occured on | [optional] |
|
data/docs/ContactPayload.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **email** | **String** | Proper email address. |
|
8
|
-
| **status** | [**ContactStatus**](ContactStatus.md) |
|
7
|
+
| **email** | **String** | Proper email address. | |
|
8
|
+
| **status** | [**ContactStatus**](ContactStatus.md) | | [optional][default to 'Transactional'] |
|
9
9
|
| **first_name** | **String** | First name. | [optional] |
|
10
10
|
| **last_name** | **String** | Last name. | [optional] |
|
11
11
|
| **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
CHANGED
@@ -509,10 +509,10 @@ end
|
|
509
509
|
|
510
510
|
| Name | Type | Description | Notes |
|
511
511
|
| ---- | ---- | ----------- | ----- |
|
512
|
-
| **file_format** | [**ExportFileFormats**](.md) | Format of the exported file | [optional] |
|
512
|
+
| **file_format** | [**ExportFileFormats**](.md) | Format of the exported file | [optional][default to 'Csv'] |
|
513
513
|
| **rule** | **String** | Query used for filtering. | [optional] |
|
514
514
|
| **emails** | [**Array<String>**](String.md) | Comma delimited list of contact emails | [optional] |
|
515
|
-
| **compression_format** | [**CompressionFormat**](.md) | FileResponse compression format. None or Zip. | [optional] |
|
515
|
+
| **compression_format** | [**CompressionFormat**](.md) | FileResponse compression format. None or Zip. | [optional][default to 'None'] |
|
516
516
|
| **file_name** | **String** | Name of your file including extension. | [optional] |
|
517
517
|
|
518
518
|
### Return type
|
@@ -702,7 +702,7 @@ ElasticEmail.configure do |config|
|
|
702
702
|
end
|
703
703
|
|
704
704
|
api_instance = ElasticEmail::ContactsApi.new
|
705
|
-
contact_payload = [ElasticEmail::ContactPayload.new] # Array<ContactPayload> |
|
705
|
+
contact_payload = [ElasticEmail::ContactPayload.new({email: 'mail@example.com'})] # Array<ContactPayload> |
|
706
706
|
opts = {
|
707
707
|
listnames: ['inner_example'] # Array<String> | Names of lists to which the uploaded contacts should be added to
|
708
708
|
}
|
data/docs/EmailContent.md
CHANGED
@@ -9,12 +9,13 @@
|
|
9
9
|
| **attachments** | [**Array<MessageAttachment>**](MessageAttachment.md) | Attachments provided by sending binary data | [optional] |
|
10
10
|
| **headers** | **Hash<String, String>** | A key-value collection of custom e-mail headers. | [optional] |
|
11
11
|
| **postback** | **String** | Postback header. | [optional] |
|
12
|
+
| **envelope_from** | **String** | E-mail with an optional name to be used as the envelope from address (e.g.: John Doe <email@domain.com>) | [optional] |
|
12
13
|
| **from** | **String** | Your e-mail with an optional name (e.g.: John Doe <email@domain.com>) | [optional] |
|
13
14
|
| **reply_to** | **String** | To what address should the recipients reply to (e.g. John Doe <email@domain.com>) | [optional] |
|
14
15
|
| **subject** | **String** | Default subject of email. | [optional] |
|
15
16
|
| **template_name** | **String** | Name of template. | [optional] |
|
16
17
|
| **attach_files** | **Array<String>** | Names of previously uploaded files that should be sent as downloadable attachments | [optional] |
|
17
|
-
| **utm** | [**Utm**](Utm.md) |
|
18
|
+
| **utm** | [**Utm**](Utm.md) | | [optional] |
|
18
19
|
|
19
20
|
## Example
|
20
21
|
|
@@ -27,11 +28,12 @@ instance = ElasticEmail::EmailContent.new(
|
|
27
28
|
attachments: null,
|
28
29
|
headers: {"city":"New York","age":"34"},
|
29
30
|
postback: null,
|
31
|
+
envelope_from: John Doe <email@domain.com>,
|
30
32
|
from: John Doe <email@domain.com>,
|
31
33
|
reply_to: John Doe <email@domain.com>,
|
32
34
|
subject: Hello!,
|
33
35
|
template_name: Template01,
|
34
|
-
attach_files:
|
36
|
+
attach_files: [ "preuploaded.jpg" ],
|
35
37
|
utm: null
|
36
38
|
)
|
37
39
|
```
|
data/docs/EmailData.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **preview** | [**EmailView**](EmailView.md) |
|
7
|
+
| **preview** | [**EmailView**](EmailView.md) | | [optional] |
|
8
8
|
| **attachments** | [**Array<FileInfo>**](FileInfo.md) | Attachments sent with the email | [optional] |
|
9
|
-
| **status** | [**EmailStatus**](EmailStatus.md) |
|
9
|
+
| **status** | [**EmailStatus**](EmailStatus.md) | | [optional] |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
data/docs/EmailMessageData.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **recipients** | [**Array<EmailRecipient>**](EmailRecipient.md) | List of recipients
|
8
|
-
| **content** | [**EmailContent**](EmailContent.md) |
|
9
|
-
| **options** | [**Options**](Options.md) |
|
7
|
+
| **recipients** | [**Array<EmailRecipient>**](EmailRecipient.md) | List of recipients | |
|
8
|
+
| **content** | [**EmailContent**](EmailContent.md) | | [optional] |
|
9
|
+
| **options** | [**Options**](Options.md) | | [optional] |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
data/docs/EmailRecipient.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **email** | **String** | Proper email address. |
|
7
|
+
| **email** | **String** | Proper email address. | |
|
8
8
|
| **fields** | **Hash<String, String>** | A key-value collection of merge fields which can be used in e-mail body. | [optional] |
|
9
9
|
|
10
10
|
## Example
|
data/docs/EmailStatus.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
| **from** | **String** | Email address this email was sent from. | [optional] |
|
8
8
|
| **to** | **String** | Email address this email was sent to. | [optional] |
|
9
9
|
| **date** | **Time** | Date the email was submitted. | [optional] |
|
10
|
-
| **status** | [**LogJobStatus**](LogJobStatus.md) |
|
10
|
+
| **status** | [**LogJobStatus**](LogJobStatus.md) | | [optional][default to 'All'] |
|
11
11
|
| **status_name** | **String** | Name of email's status | [optional] |
|
12
12
|
| **status_change_date** | **Time** | Date of last status change. | [optional] |
|
13
13
|
| **date_sent** | **Time** | Date when the email was sent | [optional] |
|
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **recipients** | [**TransactionalRecipient**](TransactionalRecipient.md) |
|
8
|
-
| **content** | [**EmailContent**](EmailContent.md) |
|
9
|
-
| **options** | [**Options**](Options.md) |
|
7
|
+
| **recipients** | [**TransactionalRecipient**](TransactionalRecipient.md) | | |
|
8
|
+
| **content** | [**EmailContent**](EmailContent.md) | | [optional] |
|
9
|
+
| **options** | [**Options**](Options.md) | | [optional] |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
data/docs/EmailsApi.md
CHANGED
@@ -103,7 +103,7 @@ ElasticEmail.configure do |config|
|
|
103
103
|
end
|
104
104
|
|
105
105
|
api_instance = ElasticEmail::EmailsApi.new
|
106
|
-
merge_email_payload = ElasticEmail::MergeEmailPayload.new # MergeEmailPayload | Email data
|
106
|
+
merge_email_payload = ElasticEmail::MergeEmailPayload.new({merge_file: ElasticEmail::MessageAttachment.new({binary_content: 'binary_content_example'})}) # MergeEmailPayload | Email data
|
107
107
|
|
108
108
|
begin
|
109
109
|
# Send Bulk Emails CSV
|
@@ -174,7 +174,7 @@ ElasticEmail.configure do |config|
|
|
174
174
|
end
|
175
175
|
|
176
176
|
api_instance = ElasticEmail::EmailsApi.new
|
177
|
-
email_message_data = ElasticEmail::EmailMessageData.new # EmailMessageData | Email data
|
177
|
+
email_message_data = ElasticEmail::EmailMessageData.new({recipients: [ElasticEmail::EmailRecipient.new({email: 'mail@example.com'})]}) # EmailMessageData | Email data
|
178
178
|
|
179
179
|
begin
|
180
180
|
# Send Bulk Emails
|
@@ -245,7 +245,7 @@ ElasticEmail.configure do |config|
|
|
245
245
|
end
|
246
246
|
|
247
247
|
api_instance = ElasticEmail::EmailsApi.new
|
248
|
-
email_transactional_message_data = ElasticEmail::EmailTransactionalMessageData.new # EmailTransactionalMessageData | Email data
|
248
|
+
email_transactional_message_data = ElasticEmail::EmailTransactionalMessageData.new({recipients: ElasticEmail::TransactionalRecipient.new({to: ['to_example']})}) # EmailTransactionalMessageData | Email data
|
249
249
|
|
250
250
|
begin
|
251
251
|
# Send Transactional Email
|
data/docs/EmailsPayload.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **rule** | **String** | SQL-like rule. Sending 'All' as a value loads all resources of the given type. | [optional] |
|
7
|
+
| **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] |
|
8
8
|
| **emails** | **Array<String>** | Comma delimited list of contact emails | [optional] |
|
9
9
|
|
10
10
|
## Example
|
@@ -14,7 +14,7 @@ require 'ElasticEmail'
|
|
14
14
|
|
15
15
|
instance = ElasticEmail::EmailsPayload.new(
|
16
16
|
rule: null,
|
17
|
-
emails:
|
17
|
+
emails: [ "john.doe@sample.com" ]
|
18
18
|
)
|
19
19
|
```
|
20
20
|
|
data/docs/EventsApi.md
CHANGED
@@ -78,7 +78,7 @@ end
|
|
78
78
|
| **transactionid** | **String** | ID number of transaction | |
|
79
79
|
| **from** | **Time** | Starting date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
|
80
80
|
| **to** | **Time** | Ending date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
|
81
|
-
| **order_by** | [**EventsOrderBy**](.md) | | [optional] |
|
81
|
+
| **order_by** | [**EventsOrderBy**](.md) | | [optional][default to 'DateDescending'] |
|
82
82
|
| **limit** | **Integer** | Maximum number of returned items. | [optional] |
|
83
83
|
| **offset** | **Integer** | How many items should be returned ahead. | [optional] |
|
84
84
|
|
@@ -163,8 +163,8 @@ end
|
|
163
163
|
| **event_types** | [**Array<EventType>**](EventType.md) | Types of Events to return | [optional] |
|
164
164
|
| **from** | **Time** | Starting date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
|
165
165
|
| **to** | **Time** | Ending date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
|
166
|
-
| **file_format** | [**ExportFileFormats**](.md) | Format of the exported file | [optional] |
|
167
|
-
| **compression_format** | [**CompressionFormat**](.md) | FileResponse compression format. None or Zip. | [optional] |
|
166
|
+
| **file_format** | [**ExportFileFormats**](.md) | Format of the exported file | [optional][default to 'Csv'] |
|
167
|
+
| **compression_format** | [**CompressionFormat**](.md) | FileResponse compression format. None or Zip. | [optional][default to 'None'] |
|
168
168
|
| **file_name** | **String** | Name of your file including extension. | [optional] |
|
169
169
|
|
170
170
|
### Return type
|
@@ -248,7 +248,7 @@ end
|
|
248
248
|
| **event_types** | [**Array<EventType>**](EventType.md) | Types of Events to return | [optional] |
|
249
249
|
| **from** | **Time** | Starting date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
|
250
250
|
| **to** | **Time** | Ending date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
|
251
|
-
| **order_by** | [**EventsOrderBy**](.md) | | [optional] |
|
251
|
+
| **order_by** | [**EventsOrderBy**](.md) | | [optional][default to 'DateDescending'] |
|
252
252
|
| **limit** | **Integer** | How many items to load. Maximum for this request is 1000 items | [optional] |
|
253
253
|
| **offset** | **Integer** | How many items should be returned ahead. | [optional] |
|
254
254
|
|
@@ -473,8 +473,8 @@ end
|
|
473
473
|
| **event_types** | [**Array<EventType>**](EventType.md) | Types of Events to return | [optional] |
|
474
474
|
| **from** | **Time** | Starting date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
|
475
475
|
| **to** | **Time** | Ending date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
|
476
|
-
| **file_format** | [**ExportFileFormats**](.md) | Format of the exported file | [optional] |
|
477
|
-
| **compression_format** | [**CompressionFormat**](.md) | FileResponse compression format. None or Zip. | [optional] |
|
476
|
+
| **file_format** | [**ExportFileFormats**](.md) | Format of the exported file | [optional][default to 'Csv'] |
|
477
|
+
| **compression_format** | [**CompressionFormat**](.md) | FileResponse compression format. None or Zip. | [optional][default to 'None'] |
|
478
478
|
| **file_name** | **String** | Name of your file including extension. | [optional] |
|
479
479
|
|
480
480
|
### Return type
|
@@ -556,7 +556,7 @@ end
|
|
556
556
|
| **event_types** | [**Array<EventType>**](EventType.md) | Types of Events to return | [optional] |
|
557
557
|
| **from** | **Time** | Starting date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
|
558
558
|
| **to** | **Time** | Ending date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
|
559
|
-
| **order_by** | [**EventsOrderBy**](.md) | | [optional] |
|
559
|
+
| **order_by** | [**EventsOrderBy**](.md) | | [optional][default to 'DateDescending'] |
|
560
560
|
| **limit** | **Integer** | How many items to load. Maximum for this request is 1000 items | [optional] |
|
561
561
|
| **offset** | **Integer** | How many items should be returned ahead. | [optional] |
|
562
562
|
|
data/docs/FilePayload.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **binary_content** | **String** | Content of the file sent as binary data |
|
7
|
+
| **binary_content** | **String** | Content of the file sent as binary data | |
|
8
8
|
| **name** | **String** | Filename | [optional] |
|
9
9
|
| **content_type** | **String** | Type of file's content (e.g. image/jpeg) | [optional] |
|
10
10
|
|
data/docs/FilesApi.md
CHANGED
@@ -320,7 +320,7 @@ ElasticEmail.configure do |config|
|
|
320
320
|
end
|
321
321
|
|
322
322
|
api_instance = ElasticEmail::FilesApi.new
|
323
|
-
file_payload = ElasticEmail::FilePayload.new # FilePayload |
|
323
|
+
file_payload = ElasticEmail::FilePayload.new({binary_content: 'binary_content_example'}) # FilePayload |
|
324
324
|
opts = {
|
325
325
|
expires_after_days: 56 # Integer | After how many days should the file be deleted.
|
326
326
|
}
|
data/docs/InboundPayload.md
CHANGED
@@ -4,10 +4,10 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **filter** | **String** | Filter of the inbound data |
|
8
|
-
| **name** | **String** | Name of this route |
|
9
|
-
| **filter_type** | [**InboundRouteFilterType**](InboundRouteFilterType.md) |
|
10
|
-
| **action_type** | [**InboundRouteActionType**](InboundRouteActionType.md) |
|
7
|
+
| **filter** | **String** | Filter of the inbound data | |
|
8
|
+
| **name** | **String** | Name of this route | |
|
9
|
+
| **filter_type** | [**InboundRouteFilterType**](InboundRouteFilterType.md) | | [default to 'EmailAddress'] |
|
10
|
+
| **action_type** | [**InboundRouteActionType**](InboundRouteActionType.md) | | [default to 'ForwardToEmail'] |
|
11
11
|
| **email_address** | **String** | Email to forward the inbound to | [optional] |
|
12
12
|
| **http_address** | **String** | Address to notify about the inbound | [optional] |
|
13
13
|
|
data/docs/InboundRoute.md
CHANGED
@@ -6,9 +6,9 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **public_id** | **String** | | [optional] |
|
8
8
|
| **name** | **String** | Name of this route | [optional] |
|
9
|
-
| **filter_type** | [**InboundRouteFilterType**](InboundRouteFilterType.md) |
|
9
|
+
| **filter_type** | [**InboundRouteFilterType**](InboundRouteFilterType.md) | | [optional][default to 'EmailAddress'] |
|
10
10
|
| **filter** | **String** | Filter of the inbound data | [optional] |
|
11
|
-
| **action_type** | [**InboundRouteActionType**](InboundRouteActionType.md) |
|
11
|
+
| **action_type** | [**InboundRouteActionType**](InboundRouteActionType.md) | | [optional][default to 'ForwardToEmail'] |
|
12
12
|
| **action_parameter** | **String** | URL address or Email to notify about the inbound | [optional] |
|
13
13
|
| **sort_order** | **Integer** | Place of this route in your routes queue's order | [optional] |
|
14
14
|
|
data/docs/InboundRouteApi.md
CHANGED
@@ -176,7 +176,7 @@ end
|
|
176
176
|
|
177
177
|
api_instance = ElasticEmail::InboundRouteApi.new
|
178
178
|
id = 'id_example' # String |
|
179
|
-
inbound_payload = ElasticEmail::InboundPayload.new # InboundPayload |
|
179
|
+
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 |
|
180
180
|
|
181
181
|
begin
|
182
182
|
# Update Route
|
@@ -316,7 +316,7 @@ ElasticEmail.configure do |config|
|
|
316
316
|
end
|
317
317
|
|
318
318
|
api_instance = ElasticEmail::InboundRouteApi.new
|
319
|
-
sort_order_item = [ElasticEmail::SortOrderItem.new] # Array<SortOrderItem> | Change the ordering of inbound routes for when matching the inbound
|
319
|
+
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
|
320
320
|
|
321
321
|
begin
|
322
322
|
# Update Sorting
|
@@ -387,7 +387,7 @@ ElasticEmail.configure do |config|
|
|
387
387
|
end
|
388
388
|
|
389
389
|
api_instance = ElasticEmail::InboundRouteApi.new
|
390
|
-
inbound_payload = ElasticEmail::InboundPayload.new # InboundPayload |
|
390
|
+
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 |
|
391
391
|
|
392
392
|
begin
|
393
393
|
# Create Route
|
data/docs/ListPayload.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **list_name** | **String** | Name of your list. |
|
7
|
+
| **list_name** | **String** | Name of your list. | |
|
8
8
|
| **allow_unsubscribe** | **Boolean** | True: Allow unsubscribing from this list. Otherwise, false | [optional] |
|
9
|
-
| **emails** | **Array<String>** | Comma delimited list of existing contact emails that should be added to this list | [optional] |
|
9
|
+
| **emails** | **Array<String>** | Comma delimited list of existing contact emails that should be added to this list. Leave empty for all contacts | [optional] |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
data/docs/ListsApi.md
CHANGED
@@ -469,7 +469,7 @@ ElasticEmail.configure do |config|
|
|
469
469
|
end
|
470
470
|
|
471
471
|
api_instance = ElasticEmail::ListsApi.new
|
472
|
-
list_payload = ElasticEmail::ListPayload.new # ListPayload |
|
472
|
+
list_payload = ElasticEmail::ListPayload.new({list_name: 'My List 1'}) # ListPayload |
|
473
473
|
|
474
474
|
begin
|
475
475
|
# Add List
|
data/docs/MergeEmailPayload.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **merge_file** | [**MessageAttachment**](MessageAttachment.md) |
|
8
|
-
| **content** | [**EmailContent**](EmailContent.md) |
|
9
|
-
| **options** | [**Options**](Options.md) |
|
7
|
+
| **merge_file** | [**MessageAttachment**](MessageAttachment.md) | | |
|
8
|
+
| **content** | [**EmailContent**](EmailContent.md) | | [optional] |
|
9
|
+
| **options** | [**Options**](Options.md) | | [optional] |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
data/docs/MessageAttachment.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **binary_content** | **String** |
|
8
|
-
| **name** | **String** |
|
9
|
-
| **content_type** | **String** |
|
7
|
+
| **binary_content** | **String** | File's content as byte array (or a Base64 string) | |
|
8
|
+
| **name** | **String** | Display name of the file | [optional] |
|
9
|
+
| **content_type** | **String** | MIME content type | [optional] |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
@@ -15,7 +15,7 @@ require 'ElasticEmail'
|
|
15
15
|
|
16
16
|
instance = ElasticEmail::MessageAttachment.new(
|
17
17
|
binary_content: null,
|
18
|
-
name:
|
18
|
+
name: null,
|
19
19
|
content_type: null
|
20
20
|
)
|
21
21
|
```
|
data/docs/NewSmtpCredentials.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **token** | **String** | Unique token to be used in the system | [optional] |
|
8
|
-
| **access_level** | [**AccessLevel**](AccessLevel.md) |
|
8
|
+
| **access_level** | [**AccessLevel**](AccessLevel.md) | | [optional][default to 'None'] |
|
9
9
|
| **name** | **String** | Name of the key. | [optional] |
|
10
10
|
| **date_created** | **Time** | Date this SmtpCredential was created. | [optional] |
|
11
11
|
| **last_use** | **Time** | Date this SmtpCredential was last used. | [optional] |
|