ElasticEmail 4.0.13 → 4.0.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/ElasticEmail.gemspec +3 -3
- data/README.md +6 -8
- data/VERSION +1 -1
- data/docs/BodyPart.md +1 -1
- data/docs/Campaign.md +3 -3
- data/docs/CampaignOptions.md +2 -2
- data/docs/CampaignTemplate.md +1 -1
- data/docs/ConsentData.md +1 -1
- data/docs/Contact.md +3 -3
- data/docs/ContactHistory.md +1 -1
- data/docs/ContactPayload.md +1 -1
- data/docs/ContactsApi.md +2 -2
- data/docs/EmailContent.md +1 -1
- data/docs/EmailData.md +2 -2
- data/docs/EmailMessageData.md +3 -3
- data/docs/EmailStatus.md +1 -1
- data/docs/EmailTransactionalMessageData.md +3 -3
- data/docs/EventsApi.md +7 -7
- data/docs/InboundPayload.md +2 -2
- data/docs/InboundRoute.md +2 -2
- data/docs/MergeEmailPayload.md +3 -3
- data/docs/NewSmtpCredentials.md +1 -1
- data/docs/Options.md +1 -1
- data/docs/RecipientEvent.md +2 -2
- data/docs/SmtpCredentials.md +1 -1
- data/docs/SplitOptions.md +1 -1
- data/docs/SubAccountInfo.md +2 -2
- data/docs/SubaccountEmailSettings.md +3 -1
- data/docs/SubaccountEmailSettingsPayload.md +3 -1
- data/docs/SubaccountPayload.md +1 -1
- data/docs/SubaccountSettingsInfo.md +1 -1
- data/docs/SubaccountSettingsInfoPayload.md +1 -1
- data/docs/SuppressionsApi.md +12 -12
- data/docs/Template.md +2 -2
- data/docs/TemplatePayload.md +1 -1
- data/docs/VerificationFileResult.md +2 -2
- data/docs/VerificationFileResultDetails.md +2 -2
- data/lib/ElasticEmail/api/campaigns_api.rb +10 -4
- data/lib/ElasticEmail/api/contacts_api.rb +22 -10
- data/lib/ElasticEmail/api/emails_api.rb +14 -5
- data/lib/ElasticEmail/api/events_api.rb +16 -16
- 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 +50 -32
- data/lib/ElasticEmail/api/templates_api.rb +10 -4
- data/lib/ElasticEmail/api/verifications_api.rb +6 -3
- data/lib/ElasticEmail/api_client.rb +8 -6
- data/lib/ElasticEmail/api_error.rb +2 -2
- data/lib/ElasticEmail/configuration.rb +6 -4
- data/lib/ElasticEmail/models/access_level.rb +6 -2
- data/lib/ElasticEmail/models/account_status_enum.rb +2 -2
- data/lib/ElasticEmail/models/api_key.rb +3 -2
- data/lib/ElasticEmail/models/api_key_payload.rb +3 -2
- data/lib/ElasticEmail/models/body_content_type.rb +2 -2
- data/lib/ElasticEmail/models/body_part.rb +5 -3
- data/lib/ElasticEmail/models/campaign.rb +5 -5
- data/lib/ElasticEmail/models/campaign_options.rb +5 -4
- data/lib/ElasticEmail/models/campaign_recipient.rb +3 -2
- data/lib/ElasticEmail/models/campaign_status.rb +2 -2
- data/lib/ElasticEmail/models/campaign_template.rb +3 -3
- data/lib/ElasticEmail/models/channel_log_status_summary.rb +3 -2
- data/lib/ElasticEmail/models/compression_format.rb +2 -2
- data/lib/ElasticEmail/models/consent_data.rb +5 -3
- data/lib/ElasticEmail/models/consent_tracking.rb +2 -2
- data/lib/ElasticEmail/models/contact.rb +7 -5
- data/lib/ElasticEmail/models/contact_activity.rb +3 -2
- data/lib/ElasticEmail/models/contact_hist_event_type.rb +2 -2
- data/lib/ElasticEmail/models/contact_history.rb +5 -3
- data/lib/ElasticEmail/models/contact_payload.rb +5 -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 +3 -2
- data/lib/ElasticEmail/models/contacts_list.rb +3 -2
- data/lib/ElasticEmail/models/delivery_optimization_type.rb +2 -2
- data/lib/ElasticEmail/models/email_content.rb +3 -3
- data/lib/ElasticEmail/models/email_data.rb +3 -4
- data/lib/ElasticEmail/models/email_message_data.rb +4 -5
- data/lib/ElasticEmail/models/email_recipient.rb +4 -3
- data/lib/ElasticEmail/models/email_send.rb +3 -2
- data/lib/ElasticEmail/models/email_status.rb +5 -3
- data/lib/ElasticEmail/models/email_transactional_message_data.rb +3 -5
- data/lib/ElasticEmail/models/email_validation_result.rb +3 -2
- data/lib/ElasticEmail/models/email_validation_status.rb +2 -2
- data/lib/ElasticEmail/models/email_view.rb +3 -2
- data/lib/ElasticEmail/models/emails_payload.rb +3 -2
- 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 +3 -2
- data/lib/ElasticEmail/models/export_status.rb +2 -2
- data/lib/ElasticEmail/models/file_info.rb +3 -2
- data/lib/ElasticEmail/models/file_payload.rb +3 -2
- data/lib/ElasticEmail/models/file_upload_result.rb +3 -2
- data/lib/ElasticEmail/models/inbound_payload.rb +7 -4
- data/lib/ElasticEmail/models/inbound_route.rb +7 -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 +3 -2
- data/lib/ElasticEmail/models/list_update_payload.rb +3 -2
- data/lib/ElasticEmail/models/log_job_status.rb +2 -2
- data/lib/ElasticEmail/models/log_status_summary.rb +3 -2
- data/lib/ElasticEmail/models/merge_email_payload.rb +3 -5
- data/lib/ElasticEmail/models/message_attachment.rb +3 -2
- data/lib/ElasticEmail/models/message_category.rb +2 -2
- data/lib/ElasticEmail/models/new_api_key.rb +3 -2
- data/lib/ElasticEmail/models/new_smtp_credentials.rb +5 -3
- data/lib/ElasticEmail/models/options.rb +5 -3
- data/lib/ElasticEmail/models/recipient_event.rb +7 -4
- data/lib/ElasticEmail/models/segment.rb +3 -2
- data/lib/ElasticEmail/models/segment_payload.rb +3 -2
- data/lib/ElasticEmail/models/smtp_credentials.rb +5 -3
- data/lib/ElasticEmail/models/smtp_credentials_payload.rb +3 -2
- data/lib/ElasticEmail/models/sort_order_item.rb +3 -2
- data/lib/ElasticEmail/models/split_optimization_type.rb +2 -2
- data/lib/ElasticEmail/models/split_options.rb +5 -3
- data/lib/ElasticEmail/models/sub_account_info.rb +5 -4
- data/lib/ElasticEmail/models/subaccount_email_credits_payload.rb +3 -2
- data/lib/ElasticEmail/models/subaccount_email_settings.rb +17 -6
- data/lib/ElasticEmail/models/subaccount_email_settings_payload.rb +17 -6
- data/lib/ElasticEmail/models/subaccount_payload.rb +3 -3
- data/lib/ElasticEmail/models/subaccount_settings_info.rb +3 -3
- data/lib/ElasticEmail/models/subaccount_settings_info_payload.rb +3 -3
- data/lib/ElasticEmail/models/suppression.rb +3 -2
- data/lib/ElasticEmail/models/template.rb +7 -4
- data/lib/ElasticEmail/models/template_payload.rb +5 -3
- data/lib/ElasticEmail/models/template_scope.rb +2 -2
- data/lib/ElasticEmail/models/template_type.rb +2 -2
- data/lib/ElasticEmail/models/transactional_recipient.rb +3 -2
- data/lib/ElasticEmail/models/utm.rb +3 -2
- data/lib/ElasticEmail/models/verification_file_result.rb +5 -4
- data/lib/ElasticEmail/models/verification_file_result_details.rb +5 -4
- data/lib/ElasticEmail/models/verification_status.rb +2 -2
- data/lib/ElasticEmail/version.rb +3 -3
- data/lib/ElasticEmail.rb +2 -2
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +7 -13
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8e58826fb260e70b44f080043b2f3a94e64c5a7bd816a4de1711e956ae449f32
|
|
4
|
+
data.tar.gz: b091adbae493380578863d0cebc2ad9d900b689add1e2f09f41cd570bcc08883
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 35d8267f43fd49658b33e3a71132abdccd7583f43627595f6f6341b59124ee62ed5d5dadbbfea1478b76f566a4bced418f892ff68ec47fd6212835f3b13eccdd
|
|
7
|
+
data.tar.gz: 9645d8c637404bf84f3740738689047f58e36ae663c7b9fa71d32fe5ecf9881d7717c6ff40497c43714e1d8311bbce77efc842952619072557f1bc080489d6a2
|
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. 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.
|
|
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. 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:
|
|
11
|
+
OpenAPI Generator version: 6.0.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.
|
|
26
|
+
s.description = "The C# library for the 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. To start using this API, you will need your Access Token. Remember to keep it safe."
|
|
27
27
|
s.license = "Unlicense"
|
|
28
28
|
s.required_ruby_version = ">= 2.4"
|
|
29
29
|
|
data/README.md
CHANGED
|
@@ -10,14 +10,12 @@ The API has a limit of 20 concurrent connections and a hard timeout of 600 secon
|
|
|
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
12
|
|
|
13
|
-
|
|
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)
|
|
13
|
+
Downloadable library clients can be found in our Github repository [here](https://github.com/ElasticEmail/elasticemail-ruby)
|
|
16
14
|
|
|
17
15
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
18
16
|
|
|
19
17
|
- API version: 4.0.0
|
|
20
|
-
- Package version: 4.0.
|
|
18
|
+
- Package version: 4.0.20
|
|
21
19
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
22
20
|
|
|
23
21
|
## Installation
|
|
@@ -33,16 +31,16 @@ gem build ElasticEmail.gemspec
|
|
|
33
31
|
Then either install the gem locally:
|
|
34
32
|
|
|
35
33
|
```shell
|
|
36
|
-
gem install ./ElasticEmail-4.0.
|
|
34
|
+
gem install ./ElasticEmail-4.0.20.gem
|
|
37
35
|
```
|
|
38
36
|
|
|
39
|
-
(for development, run `gem install --dev ./ElasticEmail-4.0.
|
|
37
|
+
(for development, run `gem install --dev ./ElasticEmail-4.0.20.gem` to install the development dependencies)
|
|
40
38
|
|
|
41
39
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
42
40
|
|
|
43
41
|
Finally add this to the Gemfile:
|
|
44
42
|
|
|
45
|
-
gem 'ElasticEmail', '~> 4.0.
|
|
43
|
+
gem 'ElasticEmail', '~> 4.0.20'
|
|
46
44
|
|
|
47
45
|
### Install from Git
|
|
48
46
|
|
|
@@ -86,7 +84,7 @@ end
|
|
|
86
84
|
|
|
87
85
|
```
|
|
88
86
|
|
|
89
|
-
|
|
87
|
+
|
|
90
88
|
|
|
91
89
|
All URIs are relative to *https://api.elasticemail.com/v4*
|
|
92
90
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
4.0.
|
|
1
|
+
4.0.20
|
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
|
@@ -6,9 +6,9 @@
|
|
|
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
8
|
| **name** | **String** | Campaign name | |
|
|
9
|
-
| **status** | [**CampaignStatus**](CampaignStatus.md) |
|
|
10
|
-
| **recipients** | [**CampaignRecipient**](CampaignRecipient.md) |
|
|
11
|
-
| **options** | [**CampaignOptions**](CampaignOptions.md) |
|
|
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
|
|
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
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **email** | **String** | Proper email address. | |
|
|
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. 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
|
data/docs/EmailContent.md
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
| **subject** | **String** | Default subject of email. | [optional] |
|
|
16
16
|
| **template_name** | **String** | Name of template. | [optional] |
|
|
17
17
|
| **attach_files** | **Array<String>** | Names of previously uploaded files that should be sent as downloadable attachments | [optional] |
|
|
18
|
-
| **utm** | [**Utm**](Utm.md) |
|
|
18
|
+
| **utm** | [**Utm**](Utm.md) | | [optional] |
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
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/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/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/InboundPayload.md
CHANGED
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **filter** | **String** | Filter of the inbound data | |
|
|
8
8
|
| **name** | **String** | Name of this route | |
|
|
9
|
-
| **filter_type** | [**InboundRouteFilterType**](InboundRouteFilterType.md) |
|
|
10
|
-
| **action_type** | [**InboundRouteActionType**](InboundRouteActionType.md) |
|
|
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/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/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] |
|
data/docs/Options.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **time_offset** | **Integer** | By how long should an e-mail be delayed (in minutes). Maximum is 35 days. | [optional] |
|
|
8
8
|
| **pool_name** | **String** | Name of your custom IP Pool to be used in the sending process | [optional] |
|
|
9
9
|
| **channel_name** | **String** | Name of selected channel. | [optional] |
|
|
10
|
-
| **encoding** | [**EncodingType**](EncodingType.md) |
|
|
10
|
+
| **encoding** | [**EncodingType**](EncodingType.md) | | [optional][default to 'UserProvided'] |
|
|
11
11
|
| **track_opens** | **Boolean** | Should the opens be tracked? If no value has been provided, Account's default setting will be used. | [optional] |
|
|
12
12
|
| **track_clicks** | **Boolean** | Should the clicks be tracked? If no value has been provided, Account's default setting will be used. | [optional] |
|
|
13
13
|
|
data/docs/RecipientEvent.md
CHANGED
|
@@ -9,10 +9,10 @@
|
|
|
9
9
|
| **from_email** | **String** | Default From: email address. | [optional] |
|
|
10
10
|
| **to** | **String** | Ending date for search in YYYY-MM-DDThh:mm:ss format. | [optional] |
|
|
11
11
|
| **subject** | **String** | Default subject of email. | [optional] |
|
|
12
|
-
| **event_type** | [**EventType**](EventType.md) |
|
|
12
|
+
| **event_type** | [**EventType**](EventType.md) | | [optional][default to 'Submission'] |
|
|
13
13
|
| **event_date** | **Time** | Creation date | [optional] |
|
|
14
14
|
| **channel_name** | **String** | Name of selected channel. | [optional] |
|
|
15
|
-
| **message_category** | [**MessageCategory**](MessageCategory.md) |
|
|
15
|
+
| **message_category** | [**MessageCategory**](MessageCategory.md) | | [optional][default to 'Unknown'] |
|
|
16
16
|
| **next_try_on** | **Time** | Date of next try | [optional] |
|
|
17
17
|
| **message** | **String** | Content of message, HTML encoded | [optional] |
|
|
18
18
|
| **ip_address** | **String** | IP which this email was sent through | [optional] |
|
data/docs/SmtpCredentials.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **access_level** | [**AccessLevel**](AccessLevel.md) |
|
|
7
|
+
| **access_level** | [**AccessLevel**](AccessLevel.md) | | [optional][default to 'None'] |
|
|
8
8
|
| **name** | **String** | Name of the key. | [optional] |
|
|
9
9
|
| **date_created** | **Time** | Date this SmtpCredential was created. | [optional] |
|
|
10
10
|
| **last_use** | **Time** | Date this SmtpCredential was last used. | [optional] |
|
data/docs/SplitOptions.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **optimize_for** | [**SplitOptimizationType**](SplitOptimizationType.md) |
|
|
7
|
+
| **optimize_for** | [**SplitOptimizationType**](SplitOptimizationType.md) | | [optional][default to 'Opens'] |
|
|
8
8
|
| **optimize_period_minutes** | **Integer** | For how long should the results be measured until determining the winner template (content) | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
data/docs/SubAccountInfo.md
CHANGED
|
@@ -6,12 +6,12 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **public_account_id** | **String** | Public key for limited access to your Account such as contact/add so you can use it safely on public websites. | [optional] |
|
|
8
8
|
| **email** | **String** | Proper email address. | [optional] |
|
|
9
|
-
| **settings** | [**SubaccountSettingsInfo**](SubaccountSettingsInfo.md) |
|
|
9
|
+
| **settings** | [**SubaccountSettingsInfo**](SubaccountSettingsInfo.md) | | [optional] |
|
|
10
10
|
| **last_activity** | **Time** | Date of last activity on Account | [optional] |
|
|
11
11
|
| **email_credits** | **Integer** | Amount of email credits | [optional] |
|
|
12
12
|
| **total_emails_sent** | **Integer** | Amount of emails sent from this Account | [optional] |
|
|
13
13
|
| **reputation** | **Float** | Numeric reputation | [optional] |
|
|
14
|
-
| **status** | [**AccountStatusEnum**](AccountStatusEnum.md) |
|
|
14
|
+
| **status** | [**AccountStatusEnum**](AccountStatusEnum.md) | | [optional][default to 'Disabled'] |
|
|
15
15
|
| **contacts_count** | **Integer** | How many contacts this SubAccount has stored | [optional] |
|
|
16
16
|
|
|
17
17
|
## Example
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
| **max_contacts** | **Integer** | Maximum number of contacts the Account can have. 0 means that parent account's limit is used. | [optional] |
|
|
12
12
|
| **enable_private_ip_purchase** | **Boolean** | Can the SubAccount purchase Private IP for themselves | [optional] |
|
|
13
13
|
| **pool_name** | **String** | Name of your custom IP Pool to be used in the sending process | [optional] |
|
|
14
|
+
| **valid_sender_domain_only** | **Boolean** | | [optional] |
|
|
14
15
|
|
|
15
16
|
## Example
|
|
16
17
|
|
|
@@ -24,7 +25,8 @@ instance = ElasticEmail::SubaccountEmailSettings.new(
|
|
|
24
25
|
daily_send_limit: 100000,
|
|
25
26
|
max_contacts: null,
|
|
26
27
|
enable_private_ip_purchase: null,
|
|
27
|
-
pool_name: My Custom Pool
|
|
28
|
+
pool_name: My Custom Pool,
|
|
29
|
+
valid_sender_domain_only: null
|
|
28
30
|
)
|
|
29
31
|
```
|
|
30
32
|
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
| **max_contacts** | **Integer** | Maximum number of contacts the Account can have. 0 means that parent account's limit is used. | [optional] |
|
|
11
11
|
| **enable_private_ip_purchase** | **Boolean** | Can the SubAccount purchase Private IP for themselves | [optional] |
|
|
12
12
|
| **pool_name** | **String** | Name of your custom IP Pool to be used in the sending process | [optional] |
|
|
13
|
+
| **valid_sender_domain_only** | **Boolean** | | [optional] |
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -22,7 +23,8 @@ instance = ElasticEmail::SubaccountEmailSettingsPayload.new(
|
|
|
22
23
|
daily_send_limit: 100000,
|
|
23
24
|
max_contacts: null,
|
|
24
25
|
enable_private_ip_purchase: null,
|
|
25
|
-
pool_name: My Custom Pool
|
|
26
|
+
pool_name: My Custom Pool,
|
|
27
|
+
valid_sender_domain_only: null
|
|
26
28
|
)
|
|
27
29
|
```
|
|
28
30
|
|
data/docs/SubaccountPayload.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **email** | **String** | Proper email address. | |
|
|
8
8
|
| **password** | **String** | Current password. | |
|
|
9
9
|
| **send_activation** | **Boolean** | True, if you want to send activation email to this Account to confirm the creation of a new SubAccount. Otherwise, false (SubAccount will immediately be Active). | [optional] |
|
|
10
|
-
| **settings** | [**SubaccountSettingsInfoPayload**](SubaccountSettingsInfoPayload.md) |
|
|
10
|
+
| **settings** | [**SubaccountSettingsInfoPayload**](SubaccountSettingsInfoPayload.md) | | [optional] |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **email** | [**SubaccountEmailSettings**](SubaccountEmailSettings.md) |
|
|
7
|
+
| **email** | [**SubaccountEmailSettings**](SubaccountEmailSettings.md) | | [optional] |
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **email** | [**SubaccountEmailSettingsPayload**](SubaccountEmailSettingsPayload.md) |
|
|
7
|
+
| **email** | [**SubaccountEmailSettingsPayload**](SubaccountEmailSettingsPayload.md) | | [optional] |
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
data/docs/SuppressionsApi.md
CHANGED
|
@@ -24,7 +24,7 @@ All URIs are relative to *https://api.elasticemail.com/v4*
|
|
|
24
24
|
|
|
25
25
|
Get Bounce List
|
|
26
26
|
|
|
27
|
-
Retrieve your list of bounced emails. Required Access Level: ViewContacts
|
|
27
|
+
Retrieve your list of bounced emails. Required Access Level: ViewContacts, ViewSuppressions
|
|
28
28
|
|
|
29
29
|
### Examples
|
|
30
30
|
|
|
@@ -101,7 +101,7 @@ end
|
|
|
101
101
|
|
|
102
102
|
Add Bounces Async
|
|
103
103
|
|
|
104
|
-
Add Bounced. Required Access Level: ModifyContacts
|
|
104
|
+
Add Bounced. Required Access Level: ModifyContacts, ModifySuppressions
|
|
105
105
|
|
|
106
106
|
### Examples
|
|
107
107
|
|
|
@@ -173,7 +173,7 @@ nil (empty response body)
|
|
|
173
173
|
|
|
174
174
|
Add Bounces
|
|
175
175
|
|
|
176
|
-
Add Bounced. Required Access Level: ModifyContacts
|
|
176
|
+
Add Bounced. Required Access Level: ModifyContacts, ModifySuppressions
|
|
177
177
|
|
|
178
178
|
### Examples
|
|
179
179
|
|
|
@@ -244,7 +244,7 @@ end
|
|
|
244
244
|
|
|
245
245
|
Delete Suppression
|
|
246
246
|
|
|
247
|
-
Delete Suppression. Required Access Level: ViewContacts
|
|
247
|
+
Delete Suppression. Required Access Level: ViewContacts, ViewSuppressions
|
|
248
248
|
|
|
249
249
|
### Examples
|
|
250
250
|
|
|
@@ -314,7 +314,7 @@ nil (empty response body)
|
|
|
314
314
|
|
|
315
315
|
Get Suppression
|
|
316
316
|
|
|
317
|
-
Retrieve your suppression. Required Access Level: ViewContacts
|
|
317
|
+
Retrieve your suppression. Required Access Level: ViewContacts, ViewSuppressions
|
|
318
318
|
|
|
319
319
|
### Examples
|
|
320
320
|
|
|
@@ -385,7 +385,7 @@ end
|
|
|
385
385
|
|
|
386
386
|
Get Complaints List
|
|
387
387
|
|
|
388
|
-
Retrieve your list of complaints. Required Access Level: ViewContacts
|
|
388
|
+
Retrieve your list of complaints. Required Access Level: ViewContacts, ViewSuppressions
|
|
389
389
|
|
|
390
390
|
### Examples
|
|
391
391
|
|
|
@@ -462,7 +462,7 @@ end
|
|
|
462
462
|
|
|
463
463
|
Add Complaints Async
|
|
464
464
|
|
|
465
|
-
Add Complaints. Required Access Level: ModifyContacts
|
|
465
|
+
Add Complaints. Required Access Level: ModifyContacts, ModifySuppressions
|
|
466
466
|
|
|
467
467
|
### Examples
|
|
468
468
|
|
|
@@ -534,7 +534,7 @@ nil (empty response body)
|
|
|
534
534
|
|
|
535
535
|
Add Complaints
|
|
536
536
|
|
|
537
|
-
Add Complaints. Required Access Level: ModifyContacts
|
|
537
|
+
Add Complaints. Required Access Level: ModifyContacts, ModifySuppressions
|
|
538
538
|
|
|
539
539
|
### Examples
|
|
540
540
|
|
|
@@ -605,7 +605,7 @@ end
|
|
|
605
605
|
|
|
606
606
|
Get Suppressions
|
|
607
607
|
|
|
608
|
-
Retrieve your suppressions. Required Access Level: ViewContacts
|
|
608
|
+
Retrieve your suppressions. Required Access Level: ViewContacts, ViewSuppressions
|
|
609
609
|
|
|
610
610
|
### Examples
|
|
611
611
|
|
|
@@ -680,7 +680,7 @@ end
|
|
|
680
680
|
|
|
681
681
|
Get Unsubscribes List
|
|
682
682
|
|
|
683
|
-
Retrieve your list of unsubscribes. Required Access Level: ViewContacts
|
|
683
|
+
Retrieve your list of unsubscribes. Required Access Level: ViewContacts, ViewSuppressions
|
|
684
684
|
|
|
685
685
|
### Examples
|
|
686
686
|
|
|
@@ -757,7 +757,7 @@ end
|
|
|
757
757
|
|
|
758
758
|
Add Unsubscribes Async
|
|
759
759
|
|
|
760
|
-
Add Unsubscribes. Required Access Level: ModifyContacts
|
|
760
|
+
Add Unsubscribes. Required Access Level: ModifyContacts, ModifySuppressions
|
|
761
761
|
|
|
762
762
|
### Examples
|
|
763
763
|
|
|
@@ -829,7 +829,7 @@ nil (empty response body)
|
|
|
829
829
|
|
|
830
830
|
Add Unsubscribes
|
|
831
831
|
|
|
832
|
-
Add Unsubscribes. Required Access Level: ModifyContacts
|
|
832
|
+
Add Unsubscribes. Required Access Level: ModifyContacts, ModifySuppressions
|
|
833
833
|
|
|
834
834
|
### Examples
|
|
835
835
|
|
data/docs/Template.md
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **template_type** | [**TemplateType**](TemplateType.md) |
|
|
7
|
+
| **template_type** | [**TemplateType**](TemplateType.md) | | [optional][default to 'RawHTML'] |
|
|
8
8
|
| **name** | **String** | Template name | [optional] |
|
|
9
9
|
| **date_added** | **Time** | Date of creation in YYYY-MM-DDThh:ii:ss format | [optional] |
|
|
10
10
|
| **subject** | **String** | Default subject of email. | [optional] |
|
|
11
11
|
| **body** | [**Array<BodyPart>**](BodyPart.md) | Email content of this template | [optional] |
|
|
12
|
-
| **template_scope** | [**TemplateScope**](TemplateScope.md) |
|
|
12
|
+
| **template_scope** | [**TemplateScope**](TemplateScope.md) | | [optional][default to 'Personal'] |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|