ElasticEmail 4.0.24 → 4.0.25
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 +23 -5
- data/VERSION +1 -1
- data/docs/CampaignsApi.md +71 -0
- data/docs/CertificateValidationStatus.md +15 -0
- data/docs/DomainData.md +54 -0
- data/docs/DomainDetail.md +52 -0
- data/docs/DomainOwner.md +15 -0
- data/docs/DomainPayload.md +20 -0
- data/docs/DomainUpdatePayload.md +24 -0
- data/docs/DomainsApi.md +583 -0
- data/docs/EmailStatus.md +3 -1
- data/docs/EmailsApi.md +1 -1
- data/docs/MessageCategoryEnum.md +15 -0
- data/docs/TrackingType.md +15 -0
- data/docs/TrackingValidationStatus.md +15 -0
- data/lib/ElasticEmail/api/campaigns_api.rb +62 -1
- data/lib/ElasticEmail/api/contacts_api.rb +1 -1
- data/lib/ElasticEmail/api/domains_api.rb +545 -0
- data/lib/ElasticEmail/api/emails_api.rb +3 -3
- 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 +1 -1
- 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 +1 -1
- 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_client.rb +3 -3
- data/lib/ElasticEmail/api_error.rb +1 -1
- data/lib/ElasticEmail/configuration.rb +1 -11
- data/lib/ElasticEmail/models/access_level.rb +3 -2
- 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 +1 -1
- data/lib/ElasticEmail/models/campaign.rb +1 -1
- data/lib/ElasticEmail/models/campaign_options.rb +1 -1
- 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 -1
- data/lib/ElasticEmail/models/certificate_validation_status.rb +42 -0
- 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 +1 -1
- data/lib/ElasticEmail/models/consent_tracking.rb +1 -1
- data/lib/ElasticEmail/models/contact.rb +1 -1
- data/lib/ElasticEmail/models/contact_activity.rb +1 -1
- data/lib/ElasticEmail/models/contact_payload.rb +1 -1
- 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/domain_data.rb +417 -0
- data/lib/ElasticEmail/models/domain_detail.rb +407 -0
- data/lib/ElasticEmail/models/domain_owner.rb +40 -0
- data/lib/ElasticEmail/models/domain_payload.rb +224 -0
- data/lib/ElasticEmail/models/domain_update_payload.rb +265 -0
- data/lib/ElasticEmail/models/email_content.rb +1 -1
- data/lib/ElasticEmail/models/email_data.rb +1 -1
- data/lib/ElasticEmail/models/email_job_failed_status.rb +1 -1
- data/lib/ElasticEmail/models/email_job_status.rb +1 -1
- data/lib/ElasticEmail/models/email_message_data.rb +1 -1
- data/lib/ElasticEmail/models/email_predicted_validation_status.rb +1 -1
- data/lib/ElasticEmail/models/email_recipient.rb +1 -1
- data/lib/ElasticEmail/models/email_send.rb +1 -1
- data/lib/ElasticEmail/models/email_status.rb +16 -5
- data/lib/ElasticEmail/models/email_transactional_message_data.rb +1 -1
- 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 +1 -1
- data/lib/ElasticEmail/models/inbound_route.rb +1 -1
- 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 -1
- data/lib/ElasticEmail/models/message_attachment.rb +1 -1
- data/lib/ElasticEmail/models/message_category.rb +1 -1
- data/lib/ElasticEmail/models/message_category_enum.rb +55 -0
- data/lib/ElasticEmail/models/new_api_key.rb +1 -1
- data/lib/ElasticEmail/models/new_smtp_credentials.rb +1 -1
- data/lib/ElasticEmail/models/options.rb +1 -1
- data/lib/ElasticEmail/models/recipient_event.rb +1 -1
- data/lib/ElasticEmail/models/segment.rb +1 -1
- data/lib/ElasticEmail/models/segment_payload.rb +1 -1
- data/lib/ElasticEmail/models/smtp_credentials.rb +1 -1
- 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 +1 -1
- data/lib/ElasticEmail/models/sub_account_info.rb +1 -1
- 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 -1
- data/lib/ElasticEmail/models/subaccount_settings_info.rb +1 -1
- data/lib/ElasticEmail/models/subaccount_settings_info_payload.rb +1 -1
- data/lib/ElasticEmail/models/suppression.rb +1 -1
- data/lib/ElasticEmail/models/template.rb +1 -1
- data/lib/ElasticEmail/models/template_payload.rb +1 -1
- data/lib/ElasticEmail/models/template_scope.rb +1 -1
- data/lib/ElasticEmail/models/template_type.rb +3 -2
- data/lib/ElasticEmail/models/tracking_type.rb +44 -0
- data/lib/ElasticEmail/models/tracking_validation_status.rb +42 -0
- 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 +1 -1
- data/lib/ElasticEmail/models/verification_file_result_details.rb +1 -1
- data/lib/ElasticEmail/models/verification_status.rb +1 -1
- data/lib/ElasticEmail/version.rb +2 -2
- data/lib/ElasticEmail.rb +11 -1
- data/spec/api/campaigns_api_spec.rb +13 -1
- data/spec/api/contacts_api_spec.rb +1 -1
- data/spec/api/domains_api_spec.rb +132 -0
- data/spec/api/emails_api_spec.rb +2 -2
- 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 +1 -1
- 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 +1 -1
- 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/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 +1 -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 +30 -0
- 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/domain_data_spec.rb +144 -0
- data/spec/models/domain_detail_spec.rb +138 -0
- data/spec/models/domain_owner_spec.rb +30 -0
- data/spec/models/domain_payload_spec.rb +42 -0
- data/spec/models/domain_update_payload_spec.rb +54 -0
- 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 +7 -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 +30 -0
- 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 +30 -0
- data/spec/models/tracking_validation_status_spec.rb +30 -0
- 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/spec_helper.rb +1 -1
- metadata +120 -80
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Elastic Email REST API
|
|
3
|
+
|
|
4
|
+
#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://app.elasticemail.com/marketing/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>
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 4.0.0
|
|
7
|
+
Contact: support@elasticemail.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.5.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module ElasticEmail
|
|
17
|
+
class MessageCategoryEnum
|
|
18
|
+
UNKNOWN = "Unknown".freeze
|
|
19
|
+
IGNORE = "Ignore".freeze
|
|
20
|
+
SPAM = "Spam".freeze
|
|
21
|
+
BLACK_LISTED = "BlackListed".freeze
|
|
22
|
+
NO_MAILBOX = "NoMailbox".freeze
|
|
23
|
+
GREY_LISTED = "GreyListed".freeze
|
|
24
|
+
THROTTLED = "Throttled".freeze
|
|
25
|
+
TIMEOUT = "Timeout".freeze
|
|
26
|
+
CONNECTION_PROBLEM = "ConnectionProblem".freeze
|
|
27
|
+
SPF_PROBLEM = "SPFProblem".freeze
|
|
28
|
+
ACCOUNT_PROBLEM = "AccountProblem".freeze
|
|
29
|
+
DNS_PROBLEM = "DNSProblem".freeze
|
|
30
|
+
NOT_DELIVERED_CANCELLED = "NotDeliveredCancelled".freeze
|
|
31
|
+
CODE_ERROR = "CodeError".freeze
|
|
32
|
+
MANUAL_CANCEL = "ManualCancel".freeze
|
|
33
|
+
CONNECTION_TERMINATED = "ConnectionTerminated".freeze
|
|
34
|
+
NOT_DELIVERED = "NotDelivered".freeze
|
|
35
|
+
|
|
36
|
+
def self.all_vars
|
|
37
|
+
@all_vars ||= [UNKNOWN, IGNORE, SPAM, BLACK_LISTED, NO_MAILBOX, GREY_LISTED, THROTTLED, TIMEOUT, CONNECTION_PROBLEM, SPF_PROBLEM, ACCOUNT_PROBLEM, DNS_PROBLEM, NOT_DELIVERED_CANCELLED, CODE_ERROR, MANUAL_CANCEL, CONNECTION_TERMINATED, NOT_DELIVERED].freeze
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# Builds the enum from string
|
|
41
|
+
# @param [String] The enum value in the form of the string
|
|
42
|
+
# @return [String] The enum value
|
|
43
|
+
def self.build_from_hash(value)
|
|
44
|
+
new.build_from_hash(value)
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# Builds the enum from string
|
|
48
|
+
# @param [String] The enum value in the form of the string
|
|
49
|
+
# @return [String] The enum value
|
|
50
|
+
def build_from_hash(value)
|
|
51
|
+
return value if MessageCategoryEnum.all_vars.include?(value)
|
|
52
|
+
raise "Invalid ENUM value #{value} for class #MessageCategoryEnum"
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|
|
@@ -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
|
-
Generator version: 7.
|
|
9
|
+
Generator version: 7.5.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -20,9 +20,10 @@ module ElasticEmail
|
|
|
20
20
|
LANDING_PAGE_EDITOR = "LandingPageEditor".freeze
|
|
21
21
|
TEMPLATE_EDITOR = "TemplateEditor".freeze
|
|
22
22
|
FORM_TEMPLATE = "FormTemplate".freeze
|
|
23
|
+
LANDING_PAGE_TEMPLATE = "LandingPageTemplate".freeze
|
|
23
24
|
|
|
24
25
|
def self.all_vars
|
|
25
|
-
@all_vars ||= [RAW_HTML, DRAG_DROP_EDITOR, LANDING_PAGE_EDITOR, TEMPLATE_EDITOR, FORM_TEMPLATE].freeze
|
|
26
|
+
@all_vars ||= [RAW_HTML, DRAG_DROP_EDITOR, LANDING_PAGE_EDITOR, TEMPLATE_EDITOR, FORM_TEMPLATE, LANDING_PAGE_TEMPLATE].freeze
|
|
26
27
|
end
|
|
27
28
|
|
|
28
29
|
# Builds the enum from string
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Elastic Email REST API
|
|
3
|
+
|
|
4
|
+
#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://app.elasticemail.com/marketing/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>
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 4.0.0
|
|
7
|
+
Contact: support@elasticemail.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.5.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module ElasticEmail
|
|
17
|
+
class TrackingType
|
|
18
|
+
NONE = "None".freeze
|
|
19
|
+
DELETE = "Delete".freeze
|
|
20
|
+
HTTP = "Http".freeze
|
|
21
|
+
EXTERNAL_HTTPS = "ExternalHttps".freeze
|
|
22
|
+
INTERNAL_CERT_HTTPS = "InternalCertHttps".freeze
|
|
23
|
+
LETS_ENCRYPT_CERT = "LetsEncryptCert".freeze
|
|
24
|
+
|
|
25
|
+
def self.all_vars
|
|
26
|
+
@all_vars ||= [NONE, DELETE, HTTP, EXTERNAL_HTTPS, INTERNAL_CERT_HTTPS, LETS_ENCRYPT_CERT].freeze
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
# Builds the enum from string
|
|
30
|
+
# @param [String] The enum value in the form of the string
|
|
31
|
+
# @return [String] The enum value
|
|
32
|
+
def self.build_from_hash(value)
|
|
33
|
+
new.build_from_hash(value)
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Builds the enum from string
|
|
37
|
+
# @param [String] The enum value in the form of the string
|
|
38
|
+
# @return [String] The enum value
|
|
39
|
+
def build_from_hash(value)
|
|
40
|
+
return value if TrackingType.all_vars.include?(value)
|
|
41
|
+
raise "Invalid ENUM value #{value} for class #TrackingType"
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Elastic Email REST API
|
|
3
|
+
|
|
4
|
+
#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://app.elasticemail.com/marketing/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>
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 4.0.0
|
|
7
|
+
Contact: support@elasticemail.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.5.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module ElasticEmail
|
|
17
|
+
class TrackingValidationStatus
|
|
18
|
+
VALIDATED = "Validated".freeze
|
|
19
|
+
NOT_VALIDATED = "NotValidated".freeze
|
|
20
|
+
INVALID = "Invalid".freeze
|
|
21
|
+
BROKEN = "Broken".freeze
|
|
22
|
+
|
|
23
|
+
def self.all_vars
|
|
24
|
+
@all_vars ||= [VALIDATED, NOT_VALIDATED, INVALID, BROKEN].freeze
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# Builds the enum from string
|
|
28
|
+
# @param [String] The enum value in the form of the string
|
|
29
|
+
# @return [String] The enum value
|
|
30
|
+
def self.build_from_hash(value)
|
|
31
|
+
new.build_from_hash(value)
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# Builds the enum from string
|
|
35
|
+
# @param [String] The enum value in the form of the string
|
|
36
|
+
# @return [String] The enum value
|
|
37
|
+
def build_from_hash(value)
|
|
38
|
+
return value if TrackingValidationStatus.all_vars.include?(value)
|
|
39
|
+
raise "Invalid ENUM value #{value} for class #TrackingValidationStatus"
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
data/lib/ElasticEmail/version.rb
CHANGED
|
@@ -6,10 +6,10 @@
|
|
|
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
|
-
Generator version: 7.
|
|
9
|
+
Generator version: 7.5.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
module ElasticEmail
|
|
14
|
-
VERSION = '4.0.
|
|
14
|
+
VERSION = '4.0.25'
|
|
15
15
|
end
|
data/lib/ElasticEmail.rb
CHANGED
|
@@ -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
|
-
Generator version: 7.
|
|
9
|
+
Generator version: 7.5.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -28,6 +28,7 @@ require 'ElasticEmail/models/campaign_options'
|
|
|
28
28
|
require 'ElasticEmail/models/campaign_recipient'
|
|
29
29
|
require 'ElasticEmail/models/campaign_status'
|
|
30
30
|
require 'ElasticEmail/models/campaign_template'
|
|
31
|
+
require 'ElasticEmail/models/certificate_validation_status'
|
|
31
32
|
require 'ElasticEmail/models/channel_log_status_summary'
|
|
32
33
|
require 'ElasticEmail/models/compression_format'
|
|
33
34
|
require 'ElasticEmail/models/consent_data'
|
|
@@ -40,6 +41,11 @@ require 'ElasticEmail/models/contact_status'
|
|
|
40
41
|
require 'ElasticEmail/models/contact_update_payload'
|
|
41
42
|
require 'ElasticEmail/models/contacts_list'
|
|
42
43
|
require 'ElasticEmail/models/delivery_optimization_type'
|
|
44
|
+
require 'ElasticEmail/models/domain_data'
|
|
45
|
+
require 'ElasticEmail/models/domain_detail'
|
|
46
|
+
require 'ElasticEmail/models/domain_owner'
|
|
47
|
+
require 'ElasticEmail/models/domain_payload'
|
|
48
|
+
require 'ElasticEmail/models/domain_update_payload'
|
|
43
49
|
require 'ElasticEmail/models/email_content'
|
|
44
50
|
require 'ElasticEmail/models/email_data'
|
|
45
51
|
require 'ElasticEmail/models/email_job_failed_status'
|
|
@@ -74,6 +80,7 @@ require 'ElasticEmail/models/log_status_summary'
|
|
|
74
80
|
require 'ElasticEmail/models/merge_email_payload'
|
|
75
81
|
require 'ElasticEmail/models/message_attachment'
|
|
76
82
|
require 'ElasticEmail/models/message_category'
|
|
83
|
+
require 'ElasticEmail/models/message_category_enum'
|
|
77
84
|
require 'ElasticEmail/models/new_api_key'
|
|
78
85
|
require 'ElasticEmail/models/new_smtp_credentials'
|
|
79
86
|
require 'ElasticEmail/models/options'
|
|
@@ -97,6 +104,8 @@ require 'ElasticEmail/models/template'
|
|
|
97
104
|
require 'ElasticEmail/models/template_payload'
|
|
98
105
|
require 'ElasticEmail/models/template_scope'
|
|
99
106
|
require 'ElasticEmail/models/template_type'
|
|
107
|
+
require 'ElasticEmail/models/tracking_type'
|
|
108
|
+
require 'ElasticEmail/models/tracking_validation_status'
|
|
100
109
|
require 'ElasticEmail/models/transactional_recipient'
|
|
101
110
|
require 'ElasticEmail/models/utm'
|
|
102
111
|
require 'ElasticEmail/models/verification_file_result'
|
|
@@ -106,6 +115,7 @@ require 'ElasticEmail/models/verification_status'
|
|
|
106
115
|
# APIs
|
|
107
116
|
require 'ElasticEmail/api/campaigns_api'
|
|
108
117
|
require 'ElasticEmail/api/contacts_api'
|
|
118
|
+
require 'ElasticEmail/api/domains_api'
|
|
109
119
|
require 'ElasticEmail/api/emails_api'
|
|
110
120
|
require 'ElasticEmail/api/events_api'
|
|
111
121
|
require 'ElasticEmail/api/files_api'
|
|
@@ -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
|
-
Generator version: 7.
|
|
9
|
+
Generator version: 7.5.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -56,6 +56,18 @@ describe 'CampaignsApi' do
|
|
|
56
56
|
end
|
|
57
57
|
end
|
|
58
58
|
|
|
59
|
+
# unit tests for campaigns_by_name_pause_put
|
|
60
|
+
# Pause Campaign
|
|
61
|
+
# Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns
|
|
62
|
+
# @param name Name of Campaign to pause
|
|
63
|
+
# @param [Hash] opts the optional parameters
|
|
64
|
+
# @return [nil]
|
|
65
|
+
describe 'campaigns_by_name_pause_put test' do
|
|
66
|
+
it 'should work' do
|
|
67
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
|
|
59
71
|
# unit tests for campaigns_by_name_put
|
|
60
72
|
# Update Campaign
|
|
61
73
|
# Updates a previously added campaign. Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns
|