ElasticEmail 4.0.27 → 4.0.29
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 +1 -1
- data/README.md +21 -9
- data/VERSION +1 -1
- data/docs/CampaignOptions.md +3 -1
- data/docs/CampaignTemplate.md +2 -2
- data/docs/CampaignsApi.md +73 -0
- data/docs/DKIMRecord.md +26 -0
- data/docs/DomainData.md +7 -1
- data/docs/DomainDetail.md +7 -1
- data/docs/EmailContent.md +2 -2
- data/docs/MessageAttachment.md +2 -2
- data/docs/SecurityApi.md +4 -4
- data/docs/SubAccountsApi.md +73 -1
- data/docs/Webhook.md +42 -0
- data/docs/WebhookApi.md +372 -0
- data/docs/WebhookCreatePayload.md +34 -0
- data/docs/WebhookUpdatePayload.md +36 -0
- data/lib/ElasticEmail/api/campaigns_api.rb +69 -1
- data/lib/ElasticEmail/api/contacts_api.rb +1 -1
- data/lib/ElasticEmail/api/domains_api.rb +1 -1
- data/lib/ElasticEmail/api/emails_api.rb +1 -1
- data/lib/ElasticEmail/api/events_api.rb +1 -1
- data/lib/ElasticEmail/api/files_api.rb +1 -1
- data/lib/ElasticEmail/api/inbound_route_api.rb +1 -1
- data/lib/ElasticEmail/api/lists_api.rb +1 -1
- data/lib/ElasticEmail/api/security_api.rb +5 -5
- data/lib/ElasticEmail/api/segments_api.rb +1 -1
- data/lib/ElasticEmail/api/statistics_api.rb +1 -1
- data/lib/ElasticEmail/api/sub_accounts_api.rb +66 -3
- data/lib/ElasticEmail/api/suppressions_api.rb +1 -1
- data/lib/ElasticEmail/api/templates_api.rb +1 -1
- data/lib/ElasticEmail/api/verifications_api.rb +1 -1
- data/lib/ElasticEmail/api/webhook_api.rb +351 -0
- data/lib/ElasticEmail/api_client.rb +8 -9
- data/lib/ElasticEmail/api_error.rb +1 -1
- data/lib/ElasticEmail/configuration.rb +1 -1
- 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 +10 -4
- data/lib/ElasticEmail/models/api_key_payload.rb +30 -4
- data/lib/ElasticEmail/models/body_content_type.rb +1 -1
- data/lib/ElasticEmail/models/body_part.rb +20 -4
- data/lib/ElasticEmail/models/campaign.rb +30 -4
- data/lib/ElasticEmail/models/campaign_options.rb +25 -8
- data/lib/ElasticEmail/models/campaign_recipient.rb +10 -4
- data/lib/ElasticEmail/models/campaign_status.rb +1 -1
- data/lib/ElasticEmail/models/campaign_template.rb +21 -5
- data/lib/ElasticEmail/models/certificate_validation_status.rb +3 -2
- data/lib/ElasticEmail/models/channel_log_status_summary.rb +10 -4
- data/lib/ElasticEmail/models/compression_format.rb +1 -1
- data/lib/ElasticEmail/models/consent_data.rb +10 -4
- data/lib/ElasticEmail/models/consent_tracking.rb +1 -1
- data/lib/ElasticEmail/models/contact.rb +10 -4
- data/lib/ElasticEmail/models/contact_activity.rb +10 -4
- data/lib/ElasticEmail/models/contact_payload.rb +20 -4
- 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 +10 -4
- data/lib/ElasticEmail/models/contacts_list.rb +10 -4
- data/lib/ElasticEmail/models/delivery_optimization_type.rb +1 -1
- data/lib/ElasticEmail/models/dkim_record.rb +258 -0
- data/lib/ElasticEmail/models/domain_data.rb +42 -8
- data/lib/ElasticEmail/models/domain_detail.rb +42 -8
- data/lib/ElasticEmail/models/domain_owner.rb +1 -1
- data/lib/ElasticEmail/models/domain_payload.rb +10 -4
- data/lib/ElasticEmail/models/domain_update_payload.rb +10 -4
- data/lib/ElasticEmail/models/email_content.rb +21 -5
- data/lib/ElasticEmail/models/email_data.rb +10 -4
- data/lib/ElasticEmail/models/email_job_failed_status.rb +10 -4
- data/lib/ElasticEmail/models/email_job_status.rb +10 -4
- data/lib/ElasticEmail/models/email_message_data.rb +30 -4
- data/lib/ElasticEmail/models/email_predicted_validation_status.rb +1 -1
- data/lib/ElasticEmail/models/email_recipient.rb +20 -4
- data/lib/ElasticEmail/models/email_send.rb +10 -4
- data/lib/ElasticEmail/models/email_status.rb +10 -4
- data/lib/ElasticEmail/models/email_transactional_message_data.rb +30 -4
- data/lib/ElasticEmail/models/email_validation_result.rb +10 -4
- data/lib/ElasticEmail/models/email_validation_status.rb +1 -1
- data/lib/ElasticEmail/models/email_view.rb +10 -4
- data/lib/ElasticEmail/models/emails_payload.rb +10 -4
- data/lib/ElasticEmail/models/encoding_type.rb +1 -1
- data/lib/ElasticEmail/models/event_type.rb +6 -3
- 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 +10 -4
- data/lib/ElasticEmail/models/export_status.rb +1 -1
- data/lib/ElasticEmail/models/file_info.rb +10 -4
- data/lib/ElasticEmail/models/file_payload.rb +20 -4
- data/lib/ElasticEmail/models/file_upload_result.rb +10 -4
- data/lib/ElasticEmail/models/inbound_payload.rb +50 -4
- data/lib/ElasticEmail/models/inbound_route.rb +10 -4
- 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 +20 -4
- data/lib/ElasticEmail/models/list_update_payload.rb +10 -4
- data/lib/ElasticEmail/models/log_job_status.rb +1 -1
- data/lib/ElasticEmail/models/log_status_summary.rb +10 -4
- data/lib/ElasticEmail/models/merge_email_payload.rb +30 -4
- data/lib/ElasticEmail/models/message_attachment.rb +31 -5
- data/lib/ElasticEmail/models/message_category.rb +1 -1
- data/lib/ElasticEmail/models/message_category_enum.rb +1 -1
- data/lib/ElasticEmail/models/new_api_key.rb +10 -4
- data/lib/ElasticEmail/models/new_smtp_credentials.rb +10 -4
- data/lib/ElasticEmail/models/options.rb +10 -4
- data/lib/ElasticEmail/models/recipient_event.rb +10 -4
- data/lib/ElasticEmail/models/segment.rb +10 -4
- data/lib/ElasticEmail/models/segment_payload.rb +30 -4
- data/lib/ElasticEmail/models/smtp_credentials.rb +10 -4
- data/lib/ElasticEmail/models/smtp_credentials_payload.rb +20 -4
- data/lib/ElasticEmail/models/sort_order_item.rb +30 -4
- data/lib/ElasticEmail/models/split_optimization_type.rb +1 -1
- data/lib/ElasticEmail/models/split_options.rb +10 -4
- data/lib/ElasticEmail/models/sub_account_info.rb +10 -4
- data/lib/ElasticEmail/models/subaccount_email_credits_payload.rb +20 -4
- data/lib/ElasticEmail/models/subaccount_email_settings.rb +10 -4
- data/lib/ElasticEmail/models/subaccount_email_settings_payload.rb +10 -4
- data/lib/ElasticEmail/models/subaccount_payload.rb +30 -4
- data/lib/ElasticEmail/models/subaccount_settings_info.rb +10 -4
- data/lib/ElasticEmail/models/subaccount_settings_info_payload.rb +10 -4
- data/lib/ElasticEmail/models/suppression.rb +10 -4
- data/lib/ElasticEmail/models/template.rb +10 -4
- data/lib/ElasticEmail/models/template_payload.rb +20 -4
- data/lib/ElasticEmail/models/template_scope.rb +1 -1
- data/lib/ElasticEmail/models/template_type.rb +1 -1
- data/lib/ElasticEmail/models/tracking_type.rb +1 -1
- data/lib/ElasticEmail/models/tracking_validation_status.rb +1 -1
- data/lib/ElasticEmail/models/transactional_recipient.rb +20 -4
- data/lib/ElasticEmail/models/utm.rb +10 -4
- data/lib/ElasticEmail/models/verification_file_result.rb +10 -4
- data/lib/ElasticEmail/models/verification_file_result_details.rb +10 -4
- data/lib/ElasticEmail/models/verification_status.rb +1 -1
- data/lib/ElasticEmail/models/webhook.rb +336 -0
- data/lib/ElasticEmail/models/webhook_create_payload.rb +329 -0
- data/lib/ElasticEmail/models/webhook_update_payload.rb +312 -0
- data/lib/ElasticEmail/version.rb +2 -2
- data/lib/ElasticEmail.rb +6 -1
- data/spec/api/campaigns_api_spec.rb +14 -1
- data/spec/api/contacts_api_spec.rb +1 -1
- data/spec/api/domains_api_spec.rb +1 -1
- data/spec/api/emails_api_spec.rb +1 -1
- data/spec/api/events_api_spec.rb +1 -1
- data/spec/api/files_api_spec.rb +1 -1
- data/spec/api/inbound_route_api_spec.rb +1 -1
- data/spec/api/lists_api_spec.rb +1 -1
- data/spec/api/security_api_spec.rb +3 -3
- data/spec/api/segments_api_spec.rb +1 -1
- data/spec/api/statistics_api_spec.rb +1 -1
- data/spec/api/sub_accounts_api_spec.rb +14 -2
- data/spec/api/suppressions_api_spec.rb +1 -1
- data/spec/api/templates_api_spec.rb +1 -1
- data/spec/api/verifications_api_spec.rb +1 -1
- data/spec/api/webhook_api_spec.rb +97 -0
- data/spec/models/access_level_spec.rb +1 -1
- data/spec/models/account_status_enum_spec.rb +1 -1
- data/spec/models/api_key_payload_spec.rb +1 -1
- data/spec/models/api_key_spec.rb +1 -1
- data/spec/models/body_content_type_spec.rb +1 -1
- data/spec/models/body_part_spec.rb +1 -1
- data/spec/models/campaign_options_spec.rb +7 -1
- data/spec/models/campaign_recipient_spec.rb +1 -1
- data/spec/models/campaign_spec.rb +1 -1
- data/spec/models/campaign_status_spec.rb +1 -1
- data/spec/models/campaign_template_spec.rb +1 -1
- data/spec/models/certificate_validation_status_spec.rb +1 -1
- data/spec/models/channel_log_status_summary_spec.rb +1 -1
- data/spec/models/compression_format_spec.rb +1 -1
- data/spec/models/consent_data_spec.rb +1 -1
- data/spec/models/consent_tracking_spec.rb +1 -1
- data/spec/models/contact_activity_spec.rb +1 -1
- data/spec/models/contact_payload_spec.rb +1 -1
- data/spec/models/contact_source_spec.rb +1 -1
- data/spec/models/contact_spec.rb +1 -1
- data/spec/models/contact_status_spec.rb +1 -1
- data/spec/models/contact_update_payload_spec.rb +1 -1
- data/spec/models/contacts_list_spec.rb +1 -1
- data/spec/models/delivery_optimization_type_spec.rb +1 -1
- data/spec/models/dkim_record_spec.rb +60 -0
- data/spec/models/domain_data_spec.rb +19 -1
- data/spec/models/domain_detail_spec.rb +19 -1
- data/spec/models/domain_owner_spec.rb +1 -1
- data/spec/models/domain_payload_spec.rb +1 -1
- data/spec/models/domain_update_payload_spec.rb +1 -1
- data/spec/models/email_content_spec.rb +1 -1
- data/spec/models/email_data_spec.rb +1 -1
- data/spec/models/email_job_failed_status_spec.rb +1 -1
- data/spec/models/email_job_status_spec.rb +1 -1
- data/spec/models/email_message_data_spec.rb +1 -1
- data/spec/models/email_predicted_validation_status_spec.rb +1 -1
- data/spec/models/email_recipient_spec.rb +1 -1
- data/spec/models/email_send_spec.rb +1 -1
- data/spec/models/email_status_spec.rb +1 -1
- data/spec/models/email_transactional_message_data_spec.rb +1 -1
- data/spec/models/email_validation_result_spec.rb +1 -1
- data/spec/models/email_validation_status_spec.rb +1 -1
- data/spec/models/email_view_spec.rb +1 -1
- data/spec/models/emails_payload_spec.rb +1 -1
- data/spec/models/encoding_type_spec.rb +1 -1
- data/spec/models/event_type_spec.rb +1 -1
- data/spec/models/events_order_by_spec.rb +1 -1
- data/spec/models/export_file_formats_spec.rb +1 -1
- data/spec/models/export_link_spec.rb +1 -1
- data/spec/models/export_status_spec.rb +1 -1
- data/spec/models/file_info_spec.rb +1 -1
- data/spec/models/file_payload_spec.rb +1 -1
- data/spec/models/file_upload_result_spec.rb +1 -1
- data/spec/models/inbound_payload_spec.rb +1 -1
- data/spec/models/inbound_route_action_type_spec.rb +1 -1
- data/spec/models/inbound_route_filter_type_spec.rb +1 -1
- data/spec/models/inbound_route_spec.rb +1 -1
- data/spec/models/list_payload_spec.rb +1 -1
- data/spec/models/list_update_payload_spec.rb +1 -1
- data/spec/models/log_job_status_spec.rb +1 -1
- data/spec/models/log_status_summary_spec.rb +1 -1
- data/spec/models/merge_email_payload_spec.rb +1 -1
- data/spec/models/message_attachment_spec.rb +1 -1
- data/spec/models/message_category_enum_spec.rb +1 -1
- data/spec/models/message_category_spec.rb +1 -1
- data/spec/models/new_api_key_spec.rb +1 -1
- data/spec/models/new_smtp_credentials_spec.rb +1 -1
- data/spec/models/options_spec.rb +1 -1
- data/spec/models/recipient_event_spec.rb +1 -1
- data/spec/models/segment_payload_spec.rb +1 -1
- data/spec/models/segment_spec.rb +1 -1
- data/spec/models/smtp_credentials_payload_spec.rb +1 -1
- data/spec/models/smtp_credentials_spec.rb +1 -1
- data/spec/models/sort_order_item_spec.rb +1 -1
- data/spec/models/split_optimization_type_spec.rb +1 -1
- data/spec/models/split_options_spec.rb +1 -1
- data/spec/models/sub_account_info_spec.rb +1 -1
- data/spec/models/subaccount_email_credits_payload_spec.rb +1 -1
- data/spec/models/subaccount_email_settings_payload_spec.rb +1 -1
- data/spec/models/subaccount_email_settings_spec.rb +1 -1
- data/spec/models/subaccount_payload_spec.rb +1 -1
- data/spec/models/subaccount_settings_info_payload_spec.rb +1 -1
- data/spec/models/subaccount_settings_info_spec.rb +1 -1
- data/spec/models/suppression_spec.rb +1 -1
- data/spec/models/template_payload_spec.rb +1 -1
- data/spec/models/template_scope_spec.rb +1 -1
- data/spec/models/template_spec.rb +1 -1
- data/spec/models/template_type_spec.rb +1 -1
- data/spec/models/tracking_type_spec.rb +1 -1
- data/spec/models/tracking_validation_status_spec.rb +1 -1
- data/spec/models/transactional_recipient_spec.rb +1 -1
- data/spec/models/utm_spec.rb +1 -1
- data/spec/models/verification_file_result_details_spec.rb +1 -1
- data/spec/models/verification_file_result_spec.rb +1 -1
- data/spec/models/verification_status_spec.rb +1 -1
- data/spec/models/webhook_create_payload_spec.rb +84 -0
- data/spec/models/webhook_spec.rb +108 -0
- data/spec/models/webhook_update_payload_spec.rb +90 -0
- data/spec/spec_helper.rb +1 -1
- metadata +109 -89
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 59705a70ea428595c16c3ef845e70eedc79052b11e390376fc15f6e2656a9998
|
|
4
|
+
data.tar.gz: fc78dceec1fa757ca56ce642233b64f3d39c9320fea82d0c96fb95f04589b8bd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 896859eac4d297d086b72556c9557fe1587910a7a53dc32fc4a62f76abc79a68c78e4904dc730067b46456255f8146a3234a2bf9da3c467db1512c661107d339
|
|
7
|
+
data.tar.gz: 0467c882f5050392dfd711a307cdd47550e3611d2d47a45fd62f3f3280942e1f0861aa705e4ec2306c44bc64da933b5561149783e2c18d6575200528b76730ef
|
data/ElasticEmail.gemspec
CHANGED
data/README.md
CHANGED
|
@@ -15,8 +15,8 @@ Downloadable library clients can be found in our Github repository <a target='_b
|
|
|
15
15
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
16
16
|
|
|
17
17
|
- API version: 4.0.0
|
|
18
|
-
- Package version: 4.0.
|
|
19
|
-
- Generator version: 7.
|
|
18
|
+
- Package version: 4.0.29
|
|
19
|
+
- Generator version: 7.14.0
|
|
20
20
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
21
21
|
|
|
22
22
|
## Installation
|
|
@@ -32,16 +32,16 @@ gem build ElasticEmail.gemspec
|
|
|
32
32
|
Then either install the gem locally:
|
|
33
33
|
|
|
34
34
|
```shell
|
|
35
|
-
gem install ./ElasticEmail-4.0.
|
|
35
|
+
gem install ./ElasticEmail-4.0.29.gem
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
(for development, run `gem install --dev ./ElasticEmail-4.0.
|
|
38
|
+
(for development, run `gem install --dev ./ElasticEmail-4.0.29.gem` to install the development dependencies)
|
|
39
39
|
|
|
40
40
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
41
41
|
|
|
42
42
|
Finally add this to the Gemfile:
|
|
43
43
|
|
|
44
|
-
gem 'ElasticEmail', '~> 4.0.
|
|
44
|
+
gem 'ElasticEmail', '~> 4.0.29'
|
|
45
45
|
|
|
46
46
|
### Install from Git
|
|
47
47
|
|
|
@@ -74,13 +74,14 @@ ElasticEmail.configure do |config|
|
|
|
74
74
|
end
|
|
75
75
|
|
|
76
76
|
api_instance = ElasticEmail::CampaignsApi.new
|
|
77
|
-
name = 'name_example' # String |
|
|
77
|
+
name = 'name_example' # String |
|
|
78
|
+
contact_email = 'contact_email_example' # String |
|
|
78
79
|
|
|
79
80
|
begin
|
|
80
|
-
#
|
|
81
|
-
api_instance.
|
|
81
|
+
#Trigger Automation for Contact
|
|
82
|
+
api_instance.campaigns_automation_by_name_trigger_post(name, contact_email)
|
|
82
83
|
rescue ElasticEmail::ApiError => e
|
|
83
|
-
puts "Exception when calling CampaignsApi->
|
|
84
|
+
puts "Exception when calling CampaignsApi->campaigns_automation_by_name_trigger_post: #{e}"
|
|
84
85
|
end
|
|
85
86
|
|
|
86
87
|
```
|
|
@@ -91,6 +92,7 @@ All URIs are relative to *https://api.elasticemail.com/v4*
|
|
|
91
92
|
|
|
92
93
|
Class | Method | HTTP request | Description
|
|
93
94
|
------------ | ------------- | ------------- | -------------
|
|
95
|
+
*ElasticEmail::CampaignsApi* | [**campaigns_automation_by_name_trigger_post**](docs/CampaignsApi.md#campaigns_automation_by_name_trigger_post) | **POST** /campaigns/automation/{name}/trigger | Trigger Automation for Contact
|
|
94
96
|
*ElasticEmail::CampaignsApi* | [**campaigns_by_name_delete**](docs/CampaignsApi.md#campaigns_by_name_delete) | **DELETE** /campaigns/{name} | Delete Campaign
|
|
95
97
|
*ElasticEmail::CampaignsApi* | [**campaigns_by_name_get**](docs/CampaignsApi.md#campaigns_by_name_get) | **GET** /campaigns/{name} | Load Campaign
|
|
96
98
|
*ElasticEmail::CampaignsApi* | [**campaigns_by_name_pause_put**](docs/CampaignsApi.md#campaigns_by_name_pause_put) | **PUT** /campaigns/{name}/pause | Pause Campaign
|
|
@@ -165,6 +167,7 @@ Class | Method | HTTP request | Description
|
|
|
165
167
|
*ElasticEmail::StatisticsApi* | [**statistics_channels_by_name_get**](docs/StatisticsApi.md#statistics_channels_by_name_get) | **GET** /statistics/channels/{name} | Load Channel Stats
|
|
166
168
|
*ElasticEmail::StatisticsApi* | [**statistics_channels_get**](docs/StatisticsApi.md#statistics_channels_get) | **GET** /statistics/channels | Load Channels Stats
|
|
167
169
|
*ElasticEmail::StatisticsApi* | [**statistics_get**](docs/StatisticsApi.md#statistics_get) | **GET** /statistics | Load Statistics
|
|
170
|
+
*ElasticEmail::SubAccountsApi* | [**subaccounts_by_email_apikey_get**](docs/SubAccountsApi.md#subaccounts_by_email_apikey_get) | **GET** /subaccounts/{email}/apikey | Get SubAccount ApiKey
|
|
168
171
|
*ElasticEmail::SubAccountsApi* | [**subaccounts_by_email_credits_patch**](docs/SubAccountsApi.md#subaccounts_by_email_credits_patch) | **PATCH** /subaccounts/{email}/credits | Add, Subtract Email Credits
|
|
169
172
|
*ElasticEmail::SubAccountsApi* | [**subaccounts_by_email_delete**](docs/SubAccountsApi.md#subaccounts_by_email_delete) | **DELETE** /subaccounts/{email} | Delete SubAccount
|
|
170
173
|
*ElasticEmail::SubAccountsApi* | [**subaccounts_by_email_get**](docs/SubAccountsApi.md#subaccounts_by_email_get) | **GET** /subaccounts/{email} | Load SubAccount
|
|
@@ -198,6 +201,11 @@ Class | Method | HTTP request | Description
|
|
|
198
201
|
*ElasticEmail::VerificationsApi* | [**verifications_files_post**](docs/VerificationsApi.md#verifications_files_post) | **POST** /verifications/files | Upload File with Emails
|
|
199
202
|
*ElasticEmail::VerificationsApi* | [**verifications_files_result_get**](docs/VerificationsApi.md#verifications_files_result_get) | **GET** /verifications/files/result | Get Files Verification Results
|
|
200
203
|
*ElasticEmail::VerificationsApi* | [**verifications_get**](docs/VerificationsApi.md#verifications_get) | **GET** /verifications | Get Emails Verification Results
|
|
204
|
+
*ElasticEmail::WebhookApi* | [**webhook_by_publicid_delete**](docs/WebhookApi.md#webhook_by_publicid_delete) | **DELETE** /webhook/{publicid} | Delete Webhook
|
|
205
|
+
*ElasticEmail::WebhookApi* | [**webhook_by_publicid_get**](docs/WebhookApi.md#webhook_by_publicid_get) | **GET** /webhook/{publicid} | Load Webhook
|
|
206
|
+
*ElasticEmail::WebhookApi* | [**webhook_by_publicid_put**](docs/WebhookApi.md#webhook_by_publicid_put) | **PUT** /webhook/{publicid} | Update Webhook
|
|
207
|
+
*ElasticEmail::WebhookApi* | [**webhook_get**](docs/WebhookApi.md#webhook_get) | **GET** /webhook | Load Webhooks
|
|
208
|
+
*ElasticEmail::WebhookApi* | [**webhook_post**](docs/WebhookApi.md#webhook_post) | **POST** /webhook | Add Webhook
|
|
201
209
|
|
|
202
210
|
|
|
203
211
|
## Documentation for Models
|
|
@@ -225,6 +233,7 @@ Class | Method | HTTP request | Description
|
|
|
225
233
|
- [ElasticEmail::ContactStatus](docs/ContactStatus.md)
|
|
226
234
|
- [ElasticEmail::ContactUpdatePayload](docs/ContactUpdatePayload.md)
|
|
227
235
|
- [ElasticEmail::ContactsList](docs/ContactsList.md)
|
|
236
|
+
- [ElasticEmail::DKIMRecord](docs/DKIMRecord.md)
|
|
228
237
|
- [ElasticEmail::DeliveryOptimizationType](docs/DeliveryOptimizationType.md)
|
|
229
238
|
- [ElasticEmail::DomainData](docs/DomainData.md)
|
|
230
239
|
- [ElasticEmail::DomainDetail](docs/DomainDetail.md)
|
|
@@ -296,6 +305,9 @@ Class | Method | HTTP request | Description
|
|
|
296
305
|
- [ElasticEmail::VerificationFileResult](docs/VerificationFileResult.md)
|
|
297
306
|
- [ElasticEmail::VerificationFileResultDetails](docs/VerificationFileResultDetails.md)
|
|
298
307
|
- [ElasticEmail::VerificationStatus](docs/VerificationStatus.md)
|
|
308
|
+
- [ElasticEmail::Webhook](docs/Webhook.md)
|
|
309
|
+
- [ElasticEmail::WebhookCreatePayload](docs/WebhookCreatePayload.md)
|
|
310
|
+
- [ElasticEmail::WebhookUpdatePayload](docs/WebhookUpdatePayload.md)
|
|
299
311
|
|
|
300
312
|
|
|
301
313
|
## Documentation for Authorization
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
4.0.
|
|
1
|
+
4.0.29
|
data/docs/CampaignOptions.md
CHANGED
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
| **trigger_frequency** | **Float** | How often (in minutes) to send the campaign | [optional] |
|
|
12
12
|
| **trigger_count** | **Integer** | How many times send the campaign | [optional] |
|
|
13
13
|
| **split_options** | [**SplitOptions**](SplitOptions.md) | | [optional] |
|
|
14
|
+
| **send_at_local_time** | **Boolean** | Send email at local time of contact. | [optional] |
|
|
14
15
|
|
|
15
16
|
## Example
|
|
16
17
|
|
|
@@ -24,7 +25,8 @@ instance = ElasticEmail::CampaignOptions.new(
|
|
|
24
25
|
schedule_for: null,
|
|
25
26
|
trigger_frequency: null,
|
|
26
27
|
trigger_count: null,
|
|
27
|
-
split_options: null
|
|
28
|
+
split_options: null,
|
|
29
|
+
send_at_local_time: null
|
|
28
30
|
)
|
|
29
31
|
```
|
|
30
32
|
|
data/docs/CampaignTemplate.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **poolname** | **String** | Name of your custom IP Pool to be used in the sending process | [optional] |
|
|
8
8
|
| **from** | **String** | Your e-mail with an optional name (e.g.: John Doe <email@domain.com>) | |
|
|
9
|
-
| **reply_to** | **String** | To what
|
|
9
|
+
| **reply_to** | **String** | To what addresses should the recipients reply to (e.g. John Doe <email@domain.com>) | [optional] |
|
|
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] |
|
|
@@ -20,7 +20,7 @@ require 'ElasticEmail'
|
|
|
20
20
|
instance = ElasticEmail::CampaignTemplate.new(
|
|
21
21
|
poolname: My Custom Pool,
|
|
22
22
|
from: John Doe <email@domain.com>,
|
|
23
|
-
reply_to: John Doe <email@domain.com>,
|
|
23
|
+
reply_to: John Doe <email@domain.com>,John Doe2 <email2@domain.com>,
|
|
24
24
|
subject: Hello!,
|
|
25
25
|
template_name: Template01,
|
|
26
26
|
attach_files: ["preuploaded.jpg"],
|
data/docs/CampaignsApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.elasticemail.com/v4*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**campaigns_automation_by_name_trigger_post**](CampaignsApi.md#campaigns_automation_by_name_trigger_post) | **POST** /campaigns/automation/{name}/trigger | Trigger Automation for Contact |
|
|
7
8
|
| [**campaigns_by_name_delete**](CampaignsApi.md#campaigns_by_name_delete) | **DELETE** /campaigns/{name} | Delete Campaign |
|
|
8
9
|
| [**campaigns_by_name_get**](CampaignsApi.md#campaigns_by_name_get) | **GET** /campaigns/{name} | Load Campaign |
|
|
9
10
|
| [**campaigns_by_name_pause_put**](CampaignsApi.md#campaigns_by_name_pause_put) | **PUT** /campaigns/{name}/pause | Pause Campaign |
|
|
@@ -12,6 +13,78 @@ All URIs are relative to *https://api.elasticemail.com/v4*
|
|
|
12
13
|
| [**campaigns_post**](CampaignsApi.md#campaigns_post) | **POST** /campaigns | Add Campaign |
|
|
13
14
|
|
|
14
15
|
|
|
16
|
+
## campaigns_automation_by_name_trigger_post
|
|
17
|
+
|
|
18
|
+
> campaigns_automation_by_name_trigger_post(name, contact_email)
|
|
19
|
+
|
|
20
|
+
Trigger Automation for Contact
|
|
21
|
+
|
|
22
|
+
Manually trigger an Automation for a contact. Required Access Level: ModifyAutomations
|
|
23
|
+
|
|
24
|
+
### Examples
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
require 'time'
|
|
28
|
+
require 'ElasticEmail'
|
|
29
|
+
# setup authorization
|
|
30
|
+
ElasticEmail.configure do |config|
|
|
31
|
+
# Configure API key authorization: apikey
|
|
32
|
+
config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
|
|
33
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
34
|
+
# config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
api_instance = ElasticEmail::CampaignsApi.new
|
|
38
|
+
name = 'name_example' # String |
|
|
39
|
+
contact_email = 'contact_email_example' # String |
|
|
40
|
+
|
|
41
|
+
begin
|
|
42
|
+
# Trigger Automation for Contact
|
|
43
|
+
api_instance.campaigns_automation_by_name_trigger_post(name, contact_email)
|
|
44
|
+
rescue ElasticEmail::ApiError => e
|
|
45
|
+
puts "Error when calling CampaignsApi->campaigns_automation_by_name_trigger_post: #{e}"
|
|
46
|
+
end
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
#### Using the campaigns_automation_by_name_trigger_post_with_http_info variant
|
|
50
|
+
|
|
51
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
52
|
+
|
|
53
|
+
> <Array(nil, Integer, Hash)> campaigns_automation_by_name_trigger_post_with_http_info(name, contact_email)
|
|
54
|
+
|
|
55
|
+
```ruby
|
|
56
|
+
begin
|
|
57
|
+
# Trigger Automation for Contact
|
|
58
|
+
data, status_code, headers = api_instance.campaigns_automation_by_name_trigger_post_with_http_info(name, contact_email)
|
|
59
|
+
p status_code # => 2xx
|
|
60
|
+
p headers # => { ... }
|
|
61
|
+
p data # => nil
|
|
62
|
+
rescue ElasticEmail::ApiError => e
|
|
63
|
+
puts "Error when calling CampaignsApi->campaigns_automation_by_name_trigger_post_with_http_info: #{e}"
|
|
64
|
+
end
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
| Name | Type | Description | Notes |
|
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
|
71
|
+
| **name** | **String** | | |
|
|
72
|
+
| **contact_email** | **String** | | |
|
|
73
|
+
|
|
74
|
+
### Return type
|
|
75
|
+
|
|
76
|
+
nil (empty response body)
|
|
77
|
+
|
|
78
|
+
### Authorization
|
|
79
|
+
|
|
80
|
+
[apikey](../README.md#apikey)
|
|
81
|
+
|
|
82
|
+
### HTTP request headers
|
|
83
|
+
|
|
84
|
+
- **Content-Type**: Not defined
|
|
85
|
+
- **Accept**: Not defined
|
|
86
|
+
|
|
87
|
+
|
|
15
88
|
## campaigns_by_name_delete
|
|
16
89
|
|
|
17
90
|
> campaigns_by_name_delete(name)
|
data/docs/DKIMRecord.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ElasticEmail::DKIMRecord
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **selector** | **String** | | [optional] |
|
|
8
|
+
| **public_key** | **String** | | [optional] |
|
|
9
|
+
| **host_name** | **String** | | [optional] |
|
|
10
|
+
| **record_value** | **String** | | [optional] |
|
|
11
|
+
| **domain** | **String** | Name of selected domain. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ElasticEmail'
|
|
17
|
+
|
|
18
|
+
instance = ElasticEmail::DKIMRecord.new(
|
|
19
|
+
selector: null,
|
|
20
|
+
public_key: null,
|
|
21
|
+
host_name: null,
|
|
22
|
+
record_value: null,
|
|
23
|
+
domain: example.com
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/DomainData.md
CHANGED
|
@@ -16,13 +16,16 @@
|
|
|
16
16
|
| **type** | [**TrackingType**](TrackingType.md) | | [optional][default to 'None'] |
|
|
17
17
|
| **tracking_status** | [**TrackingValidationStatus**](TrackingValidationStatus.md) | | [optional][default to 'Validated'] |
|
|
18
18
|
| **certificate_status** | [**CertificateValidationStatus**](CertificateValidationStatus.md) | | [optional][default to 'ErrorOccured'] |
|
|
19
|
+
| **certificate_expiry_date** | **Time** | | [optional] |
|
|
19
20
|
| **certificate_validation_error** | **String** | | [optional] |
|
|
20
21
|
| **tracking_type_user_request** | [**TrackingType**](TrackingType.md) | | [optional][default to 'None'] |
|
|
21
22
|
| **verp** | **Boolean** | | [optional] |
|
|
22
23
|
| **custom_bounces_domain** | **String** | | [optional] |
|
|
23
24
|
| **is_custom_bounces_domain_default** | **Boolean** | | [optional] |
|
|
25
|
+
| **was_ever_verified** | **Boolean** | | [optional] |
|
|
24
26
|
| **is_marked_for_deletion** | **Boolean** | | [optional] |
|
|
25
27
|
| **ownership** | [**DomainOwner**](DomainOwner.md) | | [optional][default to 'Current'] |
|
|
28
|
+
| **dkim_record** | [**DKIMRecord**](DKIMRecord.md) | | [optional] |
|
|
26
29
|
|
|
27
30
|
## Example
|
|
28
31
|
|
|
@@ -42,13 +45,16 @@ instance = ElasticEmail::DomainData.new(
|
|
|
42
45
|
type: null,
|
|
43
46
|
tracking_status: null,
|
|
44
47
|
certificate_status: null,
|
|
48
|
+
certificate_expiry_date: null,
|
|
45
49
|
certificate_validation_error: null,
|
|
46
50
|
tracking_type_user_request: null,
|
|
47
51
|
verp: null,
|
|
48
52
|
custom_bounces_domain: null,
|
|
49
53
|
is_custom_bounces_domain_default: null,
|
|
54
|
+
was_ever_verified: null,
|
|
50
55
|
is_marked_for_deletion: null,
|
|
51
|
-
ownership: null
|
|
56
|
+
ownership: null,
|
|
57
|
+
dkim_record: null
|
|
52
58
|
)
|
|
53
59
|
```
|
|
54
60
|
|
data/docs/DomainDetail.md
CHANGED
|
@@ -15,13 +15,16 @@
|
|
|
15
15
|
| **type** | [**TrackingType**](TrackingType.md) | | [optional][default to 'None'] |
|
|
16
16
|
| **tracking_status** | [**TrackingValidationStatus**](TrackingValidationStatus.md) | | [optional][default to 'Validated'] |
|
|
17
17
|
| **certificate_status** | [**CertificateValidationStatus**](CertificateValidationStatus.md) | | [optional][default to 'ErrorOccured'] |
|
|
18
|
+
| **certificate_expiry_date** | **Time** | | [optional] |
|
|
18
19
|
| **certificate_validation_error** | **String** | | [optional] |
|
|
19
20
|
| **tracking_type_user_request** | [**TrackingType**](TrackingType.md) | | [optional][default to 'None'] |
|
|
20
21
|
| **verp** | **Boolean** | | [optional] |
|
|
21
22
|
| **custom_bounces_domain** | **String** | | [optional] |
|
|
22
23
|
| **is_custom_bounces_domain_default** | **Boolean** | | [optional] |
|
|
24
|
+
| **was_ever_verified** | **Boolean** | | [optional] |
|
|
23
25
|
| **is_marked_for_deletion** | **Boolean** | | [optional] |
|
|
24
26
|
| **ownership** | [**DomainOwner**](DomainOwner.md) | | [optional][default to 'Current'] |
|
|
27
|
+
| **dkim_record** | [**DKIMRecord**](DKIMRecord.md) | | [optional] |
|
|
25
28
|
|
|
26
29
|
## Example
|
|
27
30
|
|
|
@@ -40,13 +43,16 @@ instance = ElasticEmail::DomainDetail.new(
|
|
|
40
43
|
type: null,
|
|
41
44
|
tracking_status: null,
|
|
42
45
|
certificate_status: null,
|
|
46
|
+
certificate_expiry_date: null,
|
|
43
47
|
certificate_validation_error: null,
|
|
44
48
|
tracking_type_user_request: null,
|
|
45
49
|
verp: null,
|
|
46
50
|
custom_bounces_domain: null,
|
|
47
51
|
is_custom_bounces_domain_default: null,
|
|
52
|
+
was_ever_verified: null,
|
|
48
53
|
is_marked_for_deletion: null,
|
|
49
|
-
ownership: null
|
|
54
|
+
ownership: null,
|
|
55
|
+
dkim_record: null
|
|
50
56
|
)
|
|
51
57
|
```
|
|
52
58
|
|
data/docs/EmailContent.md
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
| **postback** | **String** | Postback header. | [optional] |
|
|
12
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] |
|
|
13
13
|
| **from** | **String** | Your e-mail with an optional name (e.g.: John Doe <email@domain.com>) | |
|
|
14
|
-
| **reply_to** | **String** | To what
|
|
14
|
+
| **reply_to** | **String** | To what addresses should the recipients reply to (e.g. John Doe <email@domain.com>) | [optional] |
|
|
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] |
|
|
@@ -30,7 +30,7 @@ instance = ElasticEmail::EmailContent.new(
|
|
|
30
30
|
postback: null,
|
|
31
31
|
envelope_from: John Doe <email@domain.com>,
|
|
32
32
|
from: John Doe <email@domain.com>,
|
|
33
|
-
reply_to: John Doe <email@domain.com>,
|
|
33
|
+
reply_to: John Doe <email@domain.com>,John Doe2 <email2@domain.com>,
|
|
34
34
|
subject: Hello!,
|
|
35
35
|
template_name: Template01,
|
|
36
36
|
attach_files: ["preuploaded.jpg"],
|
data/docs/MessageAttachment.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **binary_content** | **String** | File's content as byte array (or a Base64 string) | |
|
|
8
8
|
| **name** | **String** | Display name of the file | |
|
|
9
9
|
| **content_type** | **String** | MIME content type | [optional] |
|
|
10
|
-
| **size** | **Integer** | Size of
|
|
10
|
+
| **size** | **Integer** | Size of the attachement in B | [optional] |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -18,7 +18,7 @@ instance = ElasticEmail::MessageAttachment.new(
|
|
|
18
18
|
binary_content: null,
|
|
19
19
|
name: null,
|
|
20
20
|
content_type: null,
|
|
21
|
-
size:
|
|
21
|
+
size: null
|
|
22
22
|
)
|
|
23
23
|
```
|
|
24
24
|
|
data/docs/SecurityApi.md
CHANGED
|
@@ -114,7 +114,7 @@ end
|
|
|
114
114
|
api_instance = ElasticEmail::SecurityApi.new
|
|
115
115
|
name = 'name_example' # String | Name of the ApiKey
|
|
116
116
|
opts = {
|
|
117
|
-
subaccount: 'subaccount_example' # String | Email of the subaccount of which ApiKey should be loaded
|
|
117
|
+
subaccount: 'subaccount_example' # String | Email of the subaccount of which ApiKey should be loaded. The default API key created for the subaccount has a 48-hour expiration period.
|
|
118
118
|
}
|
|
119
119
|
|
|
120
120
|
begin
|
|
@@ -149,7 +149,7 @@ end
|
|
|
149
149
|
| Name | Type | Description | Notes |
|
|
150
150
|
| ---- | ---- | ----------- | ----- |
|
|
151
151
|
| **name** | **String** | Name of the ApiKey | |
|
|
152
|
-
| **subaccount** | **String** | Email of the subaccount of which ApiKey should be loaded | [optional] |
|
|
152
|
+
| **subaccount** | **String** | Email of the subaccount of which ApiKey should be loaded. The default API key created for the subaccount has a 48-hour expiration period. | [optional] |
|
|
153
153
|
|
|
154
154
|
### Return type
|
|
155
155
|
|
|
@@ -261,7 +261,7 @@ end
|
|
|
261
261
|
|
|
262
262
|
api_instance = ElasticEmail::SecurityApi.new
|
|
263
263
|
opts = {
|
|
264
|
-
subaccount: 'subaccount_example' # String | Email of the subaccount of which ApiKeys should be loaded
|
|
264
|
+
subaccount: 'subaccount_example' # String | Email of the subaccount of which ApiKeys should be loaded. The default API key created for the subaccount has a 48-hour expiration period.
|
|
265
265
|
}
|
|
266
266
|
|
|
267
267
|
begin
|
|
@@ -295,7 +295,7 @@ end
|
|
|
295
295
|
|
|
296
296
|
| Name | Type | Description | Notes |
|
|
297
297
|
| ---- | ---- | ----------- | ----- |
|
|
298
|
-
| **subaccount** | **String** | Email of the subaccount of which ApiKeys should be loaded | [optional] |
|
|
298
|
+
| **subaccount** | **String** | Email of the subaccount of which ApiKeys should be loaded. The default API key created for the subaccount has a 48-hour expiration period. | [optional] |
|
|
299
299
|
|
|
300
300
|
### Return type
|
|
301
301
|
|
data/docs/SubAccountsApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.elasticemail.com/v4*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**subaccounts_by_email_apikey_get**](SubAccountsApi.md#subaccounts_by_email_apikey_get) | **GET** /subaccounts/{email}/apikey | Get SubAccount ApiKey |
|
|
7
8
|
| [**subaccounts_by_email_credits_patch**](SubAccountsApi.md#subaccounts_by_email_credits_patch) | **PATCH** /subaccounts/{email}/credits | Add, Subtract Email Credits |
|
|
8
9
|
| [**subaccounts_by_email_delete**](SubAccountsApi.md#subaccounts_by_email_delete) | **DELETE** /subaccounts/{email} | Delete SubAccount |
|
|
9
10
|
| [**subaccounts_by_email_get**](SubAccountsApi.md#subaccounts_by_email_get) | **GET** /subaccounts/{email} | Load SubAccount |
|
|
@@ -12,6 +13,77 @@ All URIs are relative to *https://api.elasticemail.com/v4*
|
|
|
12
13
|
| [**subaccounts_post**](SubAccountsApi.md#subaccounts_post) | **POST** /subaccounts | Add SubAccount |
|
|
13
14
|
|
|
14
15
|
|
|
16
|
+
## subaccounts_by_email_apikey_get
|
|
17
|
+
|
|
18
|
+
> String subaccounts_by_email_apikey_get(email)
|
|
19
|
+
|
|
20
|
+
Get SubAccount ApiKey
|
|
21
|
+
|
|
22
|
+
Returns API key token for the specified SubAccount. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
|
|
23
|
+
|
|
24
|
+
### Examples
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
require 'time'
|
|
28
|
+
require 'ElasticEmail'
|
|
29
|
+
# setup authorization
|
|
30
|
+
ElasticEmail.configure do |config|
|
|
31
|
+
# Configure API key authorization: apikey
|
|
32
|
+
config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
|
|
33
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
34
|
+
# config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
api_instance = ElasticEmail::SubAccountsApi.new
|
|
38
|
+
email = 'mail@example.com' # String | Email address of Sub-Account
|
|
39
|
+
|
|
40
|
+
begin
|
|
41
|
+
# Get SubAccount ApiKey
|
|
42
|
+
result = api_instance.subaccounts_by_email_apikey_get(email)
|
|
43
|
+
p result
|
|
44
|
+
rescue ElasticEmail::ApiError => e
|
|
45
|
+
puts "Error when calling SubAccountsApi->subaccounts_by_email_apikey_get: #{e}"
|
|
46
|
+
end
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
#### Using the subaccounts_by_email_apikey_get_with_http_info variant
|
|
50
|
+
|
|
51
|
+
This returns an Array which contains the response data, status code and headers.
|
|
52
|
+
|
|
53
|
+
> <Array(String, Integer, Hash)> subaccounts_by_email_apikey_get_with_http_info(email)
|
|
54
|
+
|
|
55
|
+
```ruby
|
|
56
|
+
begin
|
|
57
|
+
# Get SubAccount ApiKey
|
|
58
|
+
data, status_code, headers = api_instance.subaccounts_by_email_apikey_get_with_http_info(email)
|
|
59
|
+
p status_code # => 2xx
|
|
60
|
+
p headers # => { ... }
|
|
61
|
+
p data # => String
|
|
62
|
+
rescue ElasticEmail::ApiError => e
|
|
63
|
+
puts "Error when calling SubAccountsApi->subaccounts_by_email_apikey_get_with_http_info: #{e}"
|
|
64
|
+
end
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
| Name | Type | Description | Notes |
|
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
|
71
|
+
| **email** | **String** | Email address of Sub-Account | |
|
|
72
|
+
|
|
73
|
+
### Return type
|
|
74
|
+
|
|
75
|
+
**String**
|
|
76
|
+
|
|
77
|
+
### Authorization
|
|
78
|
+
|
|
79
|
+
[apikey](../README.md#apikey)
|
|
80
|
+
|
|
81
|
+
### HTTP request headers
|
|
82
|
+
|
|
83
|
+
- **Content-Type**: Not defined
|
|
84
|
+
- **Accept**: application/json
|
|
85
|
+
|
|
86
|
+
|
|
15
87
|
## subaccounts_by_email_credits_patch
|
|
16
88
|
|
|
17
89
|
> subaccounts_by_email_credits_patch(email, subaccount_email_credits_payload)
|
|
@@ -379,7 +451,7 @@ end
|
|
|
379
451
|
|
|
380
452
|
Add SubAccount
|
|
381
453
|
|
|
382
|
-
Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the 'subaccount' parameter. Required Access Level: ModifySubAccounts
|
|
454
|
+
Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the 'subaccount' parameter. The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts
|
|
383
455
|
|
|
384
456
|
### Examples
|
|
385
457
|
|
data/docs/Webhook.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# ElasticEmail::Webhook
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **webhook_id** | **String** | Public webhook ID | [optional] |
|
|
8
|
+
| **name** | **String** | Filename | [optional] |
|
|
9
|
+
| **date_created** | **Time** | Creation date. | [optional] |
|
|
10
|
+
| **date_updated** | **Time** | Last change date | [optional] |
|
|
11
|
+
| **url** | **String** | URL of notification. | [optional] |
|
|
12
|
+
| **notify_once_per_email** | **Boolean** | | [optional] |
|
|
13
|
+
| **notification_for_sent** | **Boolean** | | [optional] |
|
|
14
|
+
| **notification_for_opened** | **Boolean** | | [optional] |
|
|
15
|
+
| **notification_for_clicked** | **Boolean** | | [optional] |
|
|
16
|
+
| **notification_for_unsubscribed** | **Boolean** | | [optional] |
|
|
17
|
+
| **notification_for_abuse_report** | **Boolean** | | [optional] |
|
|
18
|
+
| **notification_for_error** | **Boolean** | | [optional] |
|
|
19
|
+
| **is_enabled** | **Boolean** | | [optional] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'ElasticEmail'
|
|
25
|
+
|
|
26
|
+
instance = ElasticEmail::Webhook.new(
|
|
27
|
+
webhook_id: null,
|
|
28
|
+
name: attachment.txt,
|
|
29
|
+
date_created: null,
|
|
30
|
+
date_updated: null,
|
|
31
|
+
url: http://address.for.notification.com,
|
|
32
|
+
notify_once_per_email: null,
|
|
33
|
+
notification_for_sent: null,
|
|
34
|
+
notification_for_opened: null,
|
|
35
|
+
notification_for_clicked: null,
|
|
36
|
+
notification_for_unsubscribed: null,
|
|
37
|
+
notification_for_abuse_report: null,
|
|
38
|
+
notification_for_error: null,
|
|
39
|
+
is_enabled: null
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|