ElasticEmail 4.0.13 → 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 +1 -1
- data/README.md +4 -4
- 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/SubaccountPayload.md +1 -1
- data/docs/SubaccountSettingsInfo.md +1 -1
- data/docs/SubaccountSettingsInfoPayload.md +1 -1
- 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 +9 -3
- data/lib/ElasticEmail/api/contacts_api.rb +19 -7
- data/lib/ElasticEmail/api/emails_api.rb +13 -4
- data/lib/ElasticEmail/api/events_api.rb +8 -8
- data/lib/ElasticEmail/api/files_api.rb +5 -2
- data/lib/ElasticEmail/api/inbound_route_api.rb +13 -4
- data/lib/ElasticEmail/api/lists_api.rb +17 -5
- data/lib/ElasticEmail/api/security_api.rb +17 -5
- data/lib/ElasticEmail/api/segments_api.rb +9 -3
- data/lib/ElasticEmail/api/statistics_api.rb +1 -1
- data/lib/ElasticEmail/api/sub_accounts_api.rb +13 -4
- data/lib/ElasticEmail/api/suppressions_api.rb +25 -7
- data/lib/ElasticEmail/api/templates_api.rb +9 -3
- data/lib/ElasticEmail/api/verifications_api.rb +5 -2
- data/lib/ElasticEmail/api_client.rb +4 -4
- data/lib/ElasticEmail/api_error.rb +1 -1
- data/lib/ElasticEmail/configuration.rb +3 -2
- data/lib/ElasticEmail/models/access_level.rb +1 -1
- data/lib/ElasticEmail/models/account_status_enum.rb +1 -1
- data/lib/ElasticEmail/models/api_key.rb +1 -1
- data/lib/ElasticEmail/models/api_key_payload.rb +1 -1
- data/lib/ElasticEmail/models/body_content_type.rb +1 -1
- data/lib/ElasticEmail/models/body_part.rb +3 -2
- data/lib/ElasticEmail/models/campaign.rb +3 -4
- data/lib/ElasticEmail/models/campaign_options.rb +3 -3
- data/lib/ElasticEmail/models/campaign_recipient.rb +1 -1
- data/lib/ElasticEmail/models/campaign_status.rb +1 -1
- data/lib/ElasticEmail/models/campaign_template.rb +1 -2
- data/lib/ElasticEmail/models/channel_log_status_summary.rb +1 -1
- data/lib/ElasticEmail/models/compression_format.rb +1 -1
- data/lib/ElasticEmail/models/consent_data.rb +3 -2
- data/lib/ElasticEmail/models/consent_tracking.rb +1 -1
- data/lib/ElasticEmail/models/contact.rb +5 -4
- data/lib/ElasticEmail/models/contact_activity.rb +1 -1
- data/lib/ElasticEmail/models/contact_hist_event_type.rb +1 -1
- data/lib/ElasticEmail/models/contact_history.rb +3 -2
- data/lib/ElasticEmail/models/contact_payload.rb +3 -2
- data/lib/ElasticEmail/models/contact_source.rb +1 -1
- data/lib/ElasticEmail/models/contact_status.rb +1 -1
- data/lib/ElasticEmail/models/contact_update_payload.rb +1 -1
- data/lib/ElasticEmail/models/contacts_list.rb +1 -1
- data/lib/ElasticEmail/models/delivery_optimization_type.rb +1 -1
- data/lib/ElasticEmail/models/email_content.rb +1 -2
- data/lib/ElasticEmail/models/email_data.rb +1 -3
- data/lib/ElasticEmail/models/email_message_data.rb +2 -4
- data/lib/ElasticEmail/models/email_recipient.rb +2 -2
- data/lib/ElasticEmail/models/email_send.rb +1 -1
- data/lib/ElasticEmail/models/email_status.rb +3 -2
- data/lib/ElasticEmail/models/email_transactional_message_data.rb +1 -4
- data/lib/ElasticEmail/models/email_validation_result.rb +1 -1
- data/lib/ElasticEmail/models/email_validation_status.rb +1 -1
- data/lib/ElasticEmail/models/email_view.rb +1 -1
- data/lib/ElasticEmail/models/emails_payload.rb +1 -1
- data/lib/ElasticEmail/models/encoding_type.rb +1 -1
- data/lib/ElasticEmail/models/event_type.rb +1 -1
- data/lib/ElasticEmail/models/events_order_by.rb +1 -1
- data/lib/ElasticEmail/models/export_file_formats.rb +1 -1
- data/lib/ElasticEmail/models/export_link.rb +1 -1
- data/lib/ElasticEmail/models/export_status.rb +1 -1
- data/lib/ElasticEmail/models/file_info.rb +1 -1
- data/lib/ElasticEmail/models/file_payload.rb +1 -1
- data/lib/ElasticEmail/models/file_upload_result.rb +1 -1
- data/lib/ElasticEmail/models/inbound_payload.rb +5 -3
- data/lib/ElasticEmail/models/inbound_route.rb +5 -3
- data/lib/ElasticEmail/models/inbound_route_action_type.rb +1 -1
- data/lib/ElasticEmail/models/inbound_route_filter_type.rb +1 -1
- data/lib/ElasticEmail/models/list_payload.rb +1 -1
- data/lib/ElasticEmail/models/list_update_payload.rb +1 -1
- data/lib/ElasticEmail/models/log_job_status.rb +1 -1
- data/lib/ElasticEmail/models/log_status_summary.rb +1 -1
- data/lib/ElasticEmail/models/merge_email_payload.rb +1 -4
- data/lib/ElasticEmail/models/message_attachment.rb +1 -1
- data/lib/ElasticEmail/models/message_category.rb +1 -1
- data/lib/ElasticEmail/models/new_api_key.rb +1 -1
- data/lib/ElasticEmail/models/new_smtp_credentials.rb +3 -2
- data/lib/ElasticEmail/models/options.rb +3 -2
- data/lib/ElasticEmail/models/recipient_event.rb +5 -3
- data/lib/ElasticEmail/models/segment.rb +1 -1
- data/lib/ElasticEmail/models/segment_payload.rb +1 -1
- data/lib/ElasticEmail/models/smtp_credentials.rb +3 -2
- data/lib/ElasticEmail/models/smtp_credentials_payload.rb +1 -1
- data/lib/ElasticEmail/models/sort_order_item.rb +1 -1
- data/lib/ElasticEmail/models/split_optimization_type.rb +1 -1
- data/lib/ElasticEmail/models/split_options.rb +3 -2
- data/lib/ElasticEmail/models/sub_account_info.rb +3 -3
- data/lib/ElasticEmail/models/subaccount_email_credits_payload.rb +1 -1
- data/lib/ElasticEmail/models/subaccount_email_settings.rb +1 -1
- data/lib/ElasticEmail/models/subaccount_email_settings_payload.rb +1 -1
- data/lib/ElasticEmail/models/subaccount_payload.rb +1 -2
- data/lib/ElasticEmail/models/subaccount_settings_info.rb +1 -2
- data/lib/ElasticEmail/models/subaccount_settings_info_payload.rb +1 -2
- data/lib/ElasticEmail/models/suppression.rb +1 -1
- data/lib/ElasticEmail/models/template.rb +5 -3
- data/lib/ElasticEmail/models/template_payload.rb +3 -2
- data/lib/ElasticEmail/models/template_scope.rb +1 -1
- data/lib/ElasticEmail/models/template_type.rb +1 -1
- data/lib/ElasticEmail/models/transactional_recipient.rb +1 -1
- data/lib/ElasticEmail/models/utm.rb +1 -1
- data/lib/ElasticEmail/models/verification_file_result.rb +3 -3
- data/lib/ElasticEmail/models/verification_file_result_details.rb +3 -3
- data/lib/ElasticEmail/models/verification_status.rb +1 -1
- data/lib/ElasticEmail/version.rb +2 -2
- data/lib/ElasticEmail.rb +1 -1
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +2 -2
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
data/README.md
CHANGED
@@ -17,7 +17,7 @@ Downloadable library clients can be found in our Github repository [here](https:
|
|
17
17
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
18
18
|
|
19
19
|
- API version: 4.0.0
|
20
|
-
- Package version: 4.0.
|
20
|
+
- Package version: 4.0.15
|
21
21
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
22
22
|
|
23
23
|
## Installation
|
@@ -33,16 +33,16 @@ gem build ElasticEmail.gemspec
|
|
33
33
|
Then either install the gem locally:
|
34
34
|
|
35
35
|
```shell
|
36
|
-
gem install ./ElasticEmail-4.0.
|
36
|
+
gem install ./ElasticEmail-4.0.15.gem
|
37
37
|
```
|
38
38
|
|
39
|
-
(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)
|
40
40
|
|
41
41
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
42
42
|
|
43
43
|
Finally add this to the Gemfile:
|
44
44
|
|
45
|
-
gem 'ElasticEmail', '~> 4.0.
|
45
|
+
gem 'ElasticEmail', '~> 4.0.15'
|
46
46
|
|
47
47
|
### Install from Git
|
48
48
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
4.0.
|
1
|
+
4.0.15
|
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
|
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/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
|
|
data/docs/TemplatePayload.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
| **name** | **String** | Template name | |
|
8
8
|
| **subject** | **String** | Default subject of email. | [optional] |
|
9
9
|
| **body** | [**Array<BodyPart>**](BodyPart.md) | Email content of this template | [optional] |
|
10
|
-
| **template_scope** | [**TemplateScope**](TemplateScope.md) |
|
10
|
+
| **template_scope** | [**TemplateScope**](TemplateScope.md) | | [optional][default to 'Personal'] |
|
11
11
|
|
12
12
|
## Example
|
13
13
|
|
@@ -6,8 +6,8 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **verification_id** | **String** | Identifier of this verification result | [optional] |
|
8
8
|
| **filename** | **String** | Origin file name | [optional] |
|
9
|
-
| **verification_status** | [**VerificationStatus**](VerificationStatus.md) |
|
10
|
-
| **file_upload_result** | [**FileUploadResult**](FileUploadResult.md) |
|
9
|
+
| **verification_status** | [**VerificationStatus**](VerificationStatus.md) | | [optional][default to 'Processing'] |
|
10
|
+
| **file_upload_result** | [**FileUploadResult**](FileUploadResult.md) | | [optional] |
|
11
11
|
| **date_added** | **Time** | Date of creation in YYYY-MM-DDThh:ii:ss format | [optional] |
|
12
12
|
| **source** | **String** | Origin file extension | [optional] |
|
13
13
|
|
@@ -7,8 +7,8 @@
|
|
7
7
|
| **verification_result** | [**Array<EmailValidationResult>**](EmailValidationResult.md) | Verification result's details | [optional] |
|
8
8
|
| **verification_id** | **String** | Identifier of this verification result | [optional] |
|
9
9
|
| **filename** | **String** | Origin file name | [optional] |
|
10
|
-
| **verification_status** | [**VerificationStatus**](VerificationStatus.md) |
|
11
|
-
| **file_upload_result** | [**FileUploadResult**](FileUploadResult.md) |
|
10
|
+
| **verification_status** | [**VerificationStatus**](VerificationStatus.md) | | [optional][default to 'Processing'] |
|
11
|
+
| **file_upload_result** | [**FileUploadResult**](FileUploadResult.md) | | [optional] |
|
12
12
|
| **date_added** | **Time** | Date of creation in YYYY-MM-DDThh:ii:ss format | [optional] |
|
13
13
|
| **source** | **String** | Origin file extension | [optional] |
|
14
14
|
|
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: 4.0.0
|
7
7
|
Contact: support@elasticemail.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.3.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -183,7 +183,10 @@ module ElasticEmail
|
|
183
183
|
# HTTP header 'Accept' (if needed)
|
184
184
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
185
185
|
# HTTP header 'Content-Type'
|
186
|
-
|
186
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
187
|
+
if !content_type.nil?
|
188
|
+
header_params['Content-Type'] = content_type
|
189
|
+
end
|
187
190
|
|
188
191
|
# form parameters
|
189
192
|
form_params = opts[:form_params] || {}
|
@@ -314,7 +317,10 @@ module ElasticEmail
|
|
314
317
|
# HTTP header 'Accept' (if needed)
|
315
318
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
316
319
|
# HTTP header 'Content-Type'
|
317
|
-
|
320
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
321
|
+
if !content_type.nil?
|
322
|
+
header_params['Content-Type'] = content_type
|
323
|
+
end
|
318
324
|
|
319
325
|
# form parameters
|
320
326
|
form_params = opts[:form_params] || {}
|
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: 4.0.0
|
7
7
|
Contact: support@elasticemail.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.3.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -252,7 +252,10 @@ module ElasticEmail
|
|
252
252
|
# HTTP header 'Accept' (if needed)
|
253
253
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
254
254
|
# HTTP header 'Content-Type'
|
255
|
-
|
255
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
256
|
+
if !content_type.nil?
|
257
|
+
header_params['Content-Type'] = content_type
|
258
|
+
end
|
256
259
|
|
257
260
|
# form parameters
|
258
261
|
form_params = opts[:form_params] || {}
|
@@ -315,7 +318,10 @@ module ElasticEmail
|
|
315
318
|
# header parameters
|
316
319
|
header_params = opts[:header_params] || {}
|
317
320
|
# HTTP header 'Content-Type'
|
318
|
-
|
321
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
322
|
+
if !content_type.nil?
|
323
|
+
header_params['Content-Type'] = content_type
|
324
|
+
end
|
319
325
|
|
320
326
|
# form parameters
|
321
327
|
form_params = opts[:form_params] || {}
|
@@ -412,10 +418,10 @@ module ElasticEmail
|
|
412
418
|
# Export Contacts
|
413
419
|
# Request an Export of specified Contacts. Required Access Level: Export
|
414
420
|
# @param [Hash] opts the optional parameters
|
415
|
-
# @option opts [ExportFileFormats] :file_format Format of the exported file
|
421
|
+
# @option opts [ExportFileFormats] :file_format Format of the exported file (default to 'Csv')
|
416
422
|
# @option opts [String] :rule Query used for filtering.
|
417
423
|
# @option opts [Array<String>] :emails Comma delimited list of contact emails
|
418
|
-
# @option opts [CompressionFormat] :compression_format FileResponse compression format. None or Zip.
|
424
|
+
# @option opts [CompressionFormat] :compression_format FileResponse compression format. None or Zip. (default to 'None')
|
419
425
|
# @option opts [String] :file_name Name of your file including extension.
|
420
426
|
# @return [ExportLink]
|
421
427
|
def contacts_export_post(opts = {})
|
@@ -578,7 +584,10 @@ module ElasticEmail
|
|
578
584
|
# header parameters
|
579
585
|
header_params = opts[:header_params] || {}
|
580
586
|
# HTTP header 'Content-Type'
|
581
|
-
|
587
|
+
content_type = @api_client.select_header_content_type(['multipart/form-data'])
|
588
|
+
if !content_type.nil?
|
589
|
+
header_params['Content-Type'] = content_type
|
590
|
+
end
|
582
591
|
|
583
592
|
# form parameters
|
584
593
|
form_params = opts[:form_params] || {}
|
@@ -647,7 +656,10 @@ module ElasticEmail
|
|
647
656
|
# HTTP header 'Accept' (if needed)
|
648
657
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
649
658
|
# HTTP header 'Content-Type'
|
650
|
-
|
659
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
660
|
+
if !content_type.nil?
|
661
|
+
header_params['Content-Type'] = content_type
|
662
|
+
end
|
651
663
|
|
652
664
|
# form parameters
|
653
665
|
form_params = opts[:form_params] || {}
|