ElasticEmail 4.0.23 → 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 +2 -1
- data/README.md +28 -4
- data/VERSION +1 -1
- data/docs/CampaignOptions.md +4 -0
- data/docs/CampaignTemplate.md +2 -2
- 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/{TemplateScopeType.md → DomainOwner.md} +2 -2
- data/docs/DomainPayload.md +20 -0
- data/docs/DomainUpdatePayload.md +24 -0
- data/docs/DomainsApi.md +583 -0
- data/docs/EmailContent.md +2 -2
- data/docs/EmailJobFailedStatus.md +24 -0
- data/docs/EmailJobStatus.md +56 -0
- data/docs/EmailMessageData.md +1 -1
- data/docs/EmailStatus.md +3 -1
- data/docs/EmailTransactionalMessageData.md +1 -1
- data/docs/EmailValidationResult.md +2 -2
- data/docs/EmailsApi.md +98 -4
- data/docs/EmailsPayload.md +1 -1
- data/docs/ListPayload.md +1 -1
- data/docs/ListsApi.md +78 -0
- data/docs/MergeEmailPayload.md +1 -1
- data/docs/{ContactHistEventType.md → MessageCategoryEnum.md} +2 -2
- 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 +96 -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 +70 -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 +23 -21
- data/lib/ElasticEmail/api_error.rb +1 -1
- data/lib/ElasticEmail/configuration.rb +18 -10
- data/lib/ElasticEmail/models/access_level.rb +4 -3
- data/lib/ElasticEmail/models/account_status_enum.rb +1 -1
- data/lib/ElasticEmail/models/api_key.rb +14 -19
- data/lib/ElasticEmail/models/api_key_payload.rb +18 -19
- data/lib/ElasticEmail/models/body_content_type.rb +1 -1
- data/lib/ElasticEmail/models/body_part.rb +14 -19
- data/lib/ElasticEmail/models/campaign.rb +18 -19
- data/lib/ElasticEmail/models/campaign_options.rb +35 -20
- data/lib/ElasticEmail/models/campaign_recipient.rb +14 -19
- data/lib/ElasticEmail/models/campaign_status.rb +1 -1
- data/lib/ElasticEmail/models/campaign_template.rb +21 -19
- data/lib/ElasticEmail/models/certificate_validation_status.rb +42 -0
- data/lib/ElasticEmail/models/channel_log_status_summary.rb +14 -19
- data/lib/ElasticEmail/models/compression_format.rb +1 -1
- data/lib/ElasticEmail/models/consent_data.rb +14 -19
- data/lib/ElasticEmail/models/consent_tracking.rb +1 -1
- data/lib/ElasticEmail/models/contact.rb +14 -19
- data/lib/ElasticEmail/models/contact_activity.rb +14 -19
- data/lib/ElasticEmail/models/contact_payload.rb +16 -19
- 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 +14 -19
- data/lib/ElasticEmail/models/contacts_list.rb +14 -19
- 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/{contact_history.rb → domain_update_payload.rb} +63 -79
- data/lib/ElasticEmail/models/email_content.rb +21 -19
- data/lib/ElasticEmail/models/email_data.rb +14 -19
- data/lib/ElasticEmail/models/email_job_failed_status.rb +242 -0
- data/lib/ElasticEmail/models/email_job_status.rb +415 -0
- data/lib/ElasticEmail/models/email_message_data.rb +23 -19
- data/lib/ElasticEmail/models/email_predicted_validation_status.rb +1 -1
- data/lib/ElasticEmail/models/email_recipient.rb +16 -19
- data/lib/ElasticEmail/models/email_send.rb +14 -19
- data/lib/ElasticEmail/models/email_status.rb +29 -23
- data/lib/ElasticEmail/models/email_transactional_message_data.rb +23 -19
- data/lib/ElasticEmail/models/email_validation_result.rb +16 -20
- data/lib/ElasticEmail/models/email_validation_status.rb +1 -1
- data/lib/ElasticEmail/models/email_view.rb +14 -19
- data/lib/ElasticEmail/models/emails_payload.rb +14 -19
- 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 +14 -19
- data/lib/ElasticEmail/models/export_status.rb +1 -1
- data/lib/ElasticEmail/models/file_info.rb +14 -19
- data/lib/ElasticEmail/models/file_payload.rb +16 -19
- data/lib/ElasticEmail/models/file_upload_result.rb +14 -19
- data/lib/ElasticEmail/models/inbound_payload.rb +18 -19
- data/lib/ElasticEmail/models/inbound_route.rb +14 -19
- 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 +16 -19
- data/lib/ElasticEmail/models/list_update_payload.rb +14 -19
- data/lib/ElasticEmail/models/log_job_status.rb +1 -1
- data/lib/ElasticEmail/models/log_status_summary.rb +14 -19
- data/lib/ElasticEmail/models/merge_email_payload.rb +23 -19
- data/lib/ElasticEmail/models/message_attachment.rb +18 -19
- 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 +14 -19
- data/lib/ElasticEmail/models/new_smtp_credentials.rb +14 -19
- data/lib/ElasticEmail/models/options.rb +16 -19
- data/lib/ElasticEmail/models/recipient_event.rb +14 -19
- data/lib/ElasticEmail/models/segment.rb +14 -19
- data/lib/ElasticEmail/models/segment_payload.rb +18 -19
- data/lib/ElasticEmail/models/smtp_credentials.rb +14 -19
- data/lib/ElasticEmail/models/smtp_credentials_payload.rb +16 -19
- data/lib/ElasticEmail/models/sort_order_item.rb +18 -19
- data/lib/ElasticEmail/models/split_optimization_type.rb +1 -1
- data/lib/ElasticEmail/models/split_options.rb +14 -19
- data/lib/ElasticEmail/models/sub_account_info.rb +14 -19
- data/lib/ElasticEmail/models/subaccount_email_credits_payload.rb +16 -19
- data/lib/ElasticEmail/models/subaccount_email_settings.rb +14 -19
- data/lib/ElasticEmail/models/subaccount_email_settings_payload.rb +14 -19
- data/lib/ElasticEmail/models/subaccount_payload.rb +18 -19
- data/lib/ElasticEmail/models/subaccount_settings_info.rb +14 -19
- data/lib/ElasticEmail/models/subaccount_settings_info_payload.rb +14 -19
- data/lib/ElasticEmail/models/suppression.rb +14 -19
- data/lib/ElasticEmail/models/template.rb +14 -19
- data/lib/ElasticEmail/models/template_payload.rb +16 -19
- data/lib/ElasticEmail/models/template_scope.rb +1 -1
- data/lib/ElasticEmail/models/template_type.rb +4 -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 +16 -19
- data/lib/ElasticEmail/models/utm.rb +14 -19
- data/lib/ElasticEmail/models/verification_file_result.rb +14 -19
- data/lib/ElasticEmail/models/verification_file_result_details.rb +14 -19
- data/lib/ElasticEmail/models/verification_status.rb +1 -1
- data/lib/ElasticEmail/version.rb +2 -2
- data/lib/ElasticEmail.rb +13 -1
- data/spec/api/campaigns_api_spec.rb +19 -7
- data/spec/api/contacts_api_spec.rb +12 -25
- data/spec/api/domains_api_spec.rb +132 -0
- data/spec/api/emails_api_spec.rb +29 -7
- data/spec/api/events_api_spec.rb +9 -9
- data/spec/api/files_api_spec.rb +7 -7
- data/spec/api/inbound_route_api_spec.rb +8 -8
- data/spec/api/lists_api_spec.rb +23 -9
- data/spec/api/security_api_spec.rb +12 -12
- data/spec/api/segments_api_spec.rb +7 -7
- data/spec/api/statistics_api_spec.rb +7 -7
- data/spec/api/sub_accounts_api_spec.rb +8 -8
- data/spec/api/suppressions_api_spec.rb +26 -26
- data/spec/api/templates_api_spec.rb +7 -7
- data/spec/api/verifications_api_spec.rb +30 -18
- data/spec/models/access_level_spec.rb +5 -3
- data/spec/models/account_status_enum_spec.rb +5 -3
- data/spec/models/api_key_payload_spec.rb +10 -8
- data/spec/models/api_key_spec.rb +11 -9
- data/spec/models/body_content_type_spec.rb +5 -3
- data/spec/models/body_part_spec.rb +8 -6
- data/spec/models/campaign_options_spec.rb +22 -8
- data/spec/models/campaign_recipient_spec.rb +7 -5
- data/spec/models/campaign_spec.rb +10 -8
- data/spec/models/campaign_status_spec.rb +5 -3
- data/spec/models/campaign_template_spec.rb +12 -10
- data/spec/{configuration_spec.rb → models/certificate_validation_status_spec.rb} +15 -27
- data/spec/models/channel_log_status_summary_spec.rb +19 -17
- data/spec/models/compression_format_spec.rb +5 -3
- data/spec/models/consent_data_spec.rb +8 -6
- data/spec/models/consent_tracking_spec.rb +5 -3
- data/spec/models/contact_activity_spec.rb +16 -14
- data/spec/models/contact_payload_spec.rb +11 -9
- data/spec/models/contact_source_spec.rb +5 -3
- data/spec/models/contact_spec.rb +16 -14
- data/spec/models/contact_status_spec.rb +5 -3
- data/spec/models/contact_update_payload_spec.rb +8 -6
- data/spec/models/contacts_list_spec.rb +9 -7
- data/spec/models/delivery_optimization_type_spec.rb +5 -3
- 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 +22 -14
- data/spec/models/email_data_spec.rb +8 -6
- data/spec/models/email_job_failed_status_spec.rb +54 -0
- data/spec/models/email_job_status_spec.rb +150 -0
- data/spec/models/email_message_data_spec.rb +8 -6
- data/spec/models/email_predicted_validation_status_spec.rb +4 -2
- data/spec/models/email_recipient_spec.rb +7 -5
- data/spec/models/email_send_spec.rb +7 -5
- data/spec/models/email_status_spec.rb +23 -15
- data/spec/models/email_transactional_message_data_spec.rb +8 -6
- data/spec/models/email_validation_result_spec.rb +26 -12
- data/spec/models/email_validation_status_spec.rb +5 -3
- data/spec/models/email_view_spec.rb +8 -6
- data/spec/models/emails_payload_spec.rb +7 -5
- data/spec/models/encoding_type_spec.rb +5 -3
- data/spec/models/event_type_spec.rb +5 -3
- data/spec/models/events_order_by_spec.rb +5 -3
- data/spec/models/export_file_formats_spec.rb +5 -3
- data/spec/models/export_link_spec.rb +7 -5
- data/spec/models/export_status_spec.rb +5 -3
- data/spec/models/file_info_spec.rb +10 -8
- data/spec/models/file_payload_spec.rb +8 -6
- data/spec/models/file_upload_result_spec.rb +7 -5
- data/spec/models/inbound_payload_spec.rb +11 -9
- data/spec/models/inbound_route_action_type_spec.rb +5 -3
- data/spec/models/inbound_route_filter_type_spec.rb +5 -3
- data/spec/models/inbound_route_spec.rb +12 -10
- data/spec/models/list_payload_spec.rb +8 -6
- data/spec/models/list_update_payload_spec.rb +7 -5
- data/spec/models/log_job_status_spec.rb +5 -3
- data/spec/models/log_status_summary_spec.rb +18 -16
- data/spec/models/merge_email_payload_spec.rb +8 -6
- data/spec/models/message_attachment_spec.rb +14 -6
- data/spec/models/message_category_enum_spec.rb +30 -0
- data/spec/models/message_category_spec.rb +5 -3
- data/spec/models/new_api_key_spec.rb +12 -10
- data/spec/models/new_smtp_credentials_spec.rb +12 -10
- data/spec/models/options_spec.rb +11 -9
- data/spec/models/recipient_event_spec.rb +18 -16
- data/spec/models/segment_payload_spec.rb +7 -5
- data/spec/models/segment_spec.rb +7 -5
- data/spec/models/smtp_credentials_payload_spec.rb +9 -7
- data/spec/models/smtp_credentials_spec.rb +11 -9
- data/spec/models/sort_order_item_spec.rb +7 -5
- data/spec/models/split_optimization_type_spec.rb +5 -3
- data/spec/models/split_options_spec.rb +7 -5
- data/spec/models/sub_account_info_spec.rb +14 -12
- data/spec/models/subaccount_email_credits_payload_spec.rb +7 -5
- data/spec/models/subaccount_email_settings_payload_spec.rb +17 -9
- data/spec/models/subaccount_email_settings_spec.rb +18 -10
- data/spec/models/subaccount_payload_spec.rb +9 -7
- data/spec/models/subaccount_settings_info_payload_spec.rb +6 -4
- data/spec/models/subaccount_settings_info_spec.rb +6 -4
- data/spec/models/suppression_spec.rb +9 -7
- data/spec/models/template_payload_spec.rb +9 -7
- data/spec/models/template_scope_spec.rb +5 -3
- data/spec/models/template_spec.rb +11 -9
- data/spec/models/template_type_spec.rb +5 -3
- 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 +8 -6
- data/spec/models/utm_spec.rb +9 -7
- data/spec/models/verification_file_result_details_spec.rb +12 -10
- data/spec/models/verification_file_result_spec.rb +11 -9
- data/spec/models/verification_status_spec.rb +5 -3
- data/spec/spec_helper.rb +1 -1
- metadata +126 -94
- data/docs/ContactHistory.md +0 -30
- data/lib/ElasticEmail/models/contact_hist_event_type.rb +0 -49
- data/lib/ElasticEmail/models/template_scope_type.rb +0 -38
- data/spec/api_client_spec.rb +0 -226
- data/spec/models/contact_hist_event_type_spec.rb +0 -28
- data/spec/models/contact_history_spec.rb +0 -70
- data/spec/models/template_scope_type_spec.rb +0 -28
@@ -0,0 +1,545 @@
|
|
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 'cgi'
|
14
|
+
|
15
|
+
module ElasticEmail
|
16
|
+
class DomainsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Delete Domain
|
23
|
+
# Deletes configured domain from Account. Required Access Level: ModifySettings
|
24
|
+
# @param domain [String] Name of the given domain
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [nil]
|
27
|
+
def domains_by_domain_delete(domain, opts = {})
|
28
|
+
domains_by_domain_delete_with_http_info(domain, opts)
|
29
|
+
nil
|
30
|
+
end
|
31
|
+
|
32
|
+
# Delete Domain
|
33
|
+
# Deletes configured domain from Account. Required Access Level: ModifySettings
|
34
|
+
# @param domain [String] Name of the given domain
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
37
|
+
def domains_by_domain_delete_with_http_info(domain, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: DomainsApi.domains_by_domain_delete ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'domain' is set
|
42
|
+
if @api_client.config.client_side_validation && domain.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'domain' when calling DomainsApi.domains_by_domain_delete"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/domains/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
|
54
|
+
# form parameters
|
55
|
+
form_params = opts[:form_params] || {}
|
56
|
+
|
57
|
+
# http body (model)
|
58
|
+
post_body = opts[:debug_body]
|
59
|
+
|
60
|
+
# return_type
|
61
|
+
return_type = opts[:debug_return_type]
|
62
|
+
|
63
|
+
# auth_names
|
64
|
+
auth_names = opts[:debug_auth_names] || ['apikey']
|
65
|
+
|
66
|
+
new_options = opts.merge(
|
67
|
+
:operation => :"DomainsApi.domains_by_domain_delete",
|
68
|
+
:header_params => header_params,
|
69
|
+
:query_params => query_params,
|
70
|
+
:form_params => form_params,
|
71
|
+
:body => post_body,
|
72
|
+
:auth_names => auth_names,
|
73
|
+
:return_type => return_type
|
74
|
+
)
|
75
|
+
|
76
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
77
|
+
if @api_client.config.debugging
|
78
|
+
@api_client.config.logger.debug "API called: DomainsApi#domains_by_domain_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
79
|
+
end
|
80
|
+
return data, status_code, headers
|
81
|
+
end
|
82
|
+
|
83
|
+
# Load Domain
|
84
|
+
# Retrieve a domain configured for this Account. Required Access Level: ViewSettings
|
85
|
+
# @param domain [String] Name of the given domain
|
86
|
+
# @param [Hash] opts the optional parameters
|
87
|
+
# @return [DomainData]
|
88
|
+
def domains_by_domain_get(domain, opts = {})
|
89
|
+
data, _status_code, _headers = domains_by_domain_get_with_http_info(domain, opts)
|
90
|
+
data
|
91
|
+
end
|
92
|
+
|
93
|
+
# Load Domain
|
94
|
+
# Retrieve a domain configured for this Account. Required Access Level: ViewSettings
|
95
|
+
# @param domain [String] Name of the given domain
|
96
|
+
# @param [Hash] opts the optional parameters
|
97
|
+
# @return [Array<(DomainData, Integer, Hash)>] DomainData data, response status code and response headers
|
98
|
+
def domains_by_domain_get_with_http_info(domain, opts = {})
|
99
|
+
if @api_client.config.debugging
|
100
|
+
@api_client.config.logger.debug 'Calling API: DomainsApi.domains_by_domain_get ...'
|
101
|
+
end
|
102
|
+
# verify the required parameter 'domain' is set
|
103
|
+
if @api_client.config.client_side_validation && domain.nil?
|
104
|
+
fail ArgumentError, "Missing the required parameter 'domain' when calling DomainsApi.domains_by_domain_get"
|
105
|
+
end
|
106
|
+
# resource path
|
107
|
+
local_var_path = '/domains/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
|
108
|
+
|
109
|
+
# query parameters
|
110
|
+
query_params = opts[:query_params] || {}
|
111
|
+
|
112
|
+
# header parameters
|
113
|
+
header_params = opts[:header_params] || {}
|
114
|
+
# HTTP header 'Accept' (if needed)
|
115
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
116
|
+
|
117
|
+
# form parameters
|
118
|
+
form_params = opts[:form_params] || {}
|
119
|
+
|
120
|
+
# http body (model)
|
121
|
+
post_body = opts[:debug_body]
|
122
|
+
|
123
|
+
# return_type
|
124
|
+
return_type = opts[:debug_return_type] || 'DomainData'
|
125
|
+
|
126
|
+
# auth_names
|
127
|
+
auth_names = opts[:debug_auth_names] || ['apikey']
|
128
|
+
|
129
|
+
new_options = opts.merge(
|
130
|
+
:operation => :"DomainsApi.domains_by_domain_get",
|
131
|
+
:header_params => header_params,
|
132
|
+
:query_params => query_params,
|
133
|
+
:form_params => form_params,
|
134
|
+
:body => post_body,
|
135
|
+
:auth_names => auth_names,
|
136
|
+
:return_type => return_type
|
137
|
+
)
|
138
|
+
|
139
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
140
|
+
if @api_client.config.debugging
|
141
|
+
@api_client.config.logger.debug "API called: DomainsApi#domains_by_domain_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
142
|
+
end
|
143
|
+
return data, status_code, headers
|
144
|
+
end
|
145
|
+
|
146
|
+
# Update Domain
|
147
|
+
# Updates the specified domain. Required Access Level: ModifySettings
|
148
|
+
# @param domain [String] Name of the given domain
|
149
|
+
# @param domain_update_payload [DomainUpdatePayload] Updated Domain resource
|
150
|
+
# @param [Hash] opts the optional parameters
|
151
|
+
# @return [DomainDetail]
|
152
|
+
def domains_by_domain_put(domain, domain_update_payload, opts = {})
|
153
|
+
data, _status_code, _headers = domains_by_domain_put_with_http_info(domain, domain_update_payload, opts)
|
154
|
+
data
|
155
|
+
end
|
156
|
+
|
157
|
+
# Update Domain
|
158
|
+
# Updates the specified domain. Required Access Level: ModifySettings
|
159
|
+
# @param domain [String] Name of the given domain
|
160
|
+
# @param domain_update_payload [DomainUpdatePayload] Updated Domain resource
|
161
|
+
# @param [Hash] opts the optional parameters
|
162
|
+
# @return [Array<(DomainDetail, Integer, Hash)>] DomainDetail data, response status code and response headers
|
163
|
+
def domains_by_domain_put_with_http_info(domain, domain_update_payload, opts = {})
|
164
|
+
if @api_client.config.debugging
|
165
|
+
@api_client.config.logger.debug 'Calling API: DomainsApi.domains_by_domain_put ...'
|
166
|
+
end
|
167
|
+
# verify the required parameter 'domain' is set
|
168
|
+
if @api_client.config.client_side_validation && domain.nil?
|
169
|
+
fail ArgumentError, "Missing the required parameter 'domain' when calling DomainsApi.domains_by_domain_put"
|
170
|
+
end
|
171
|
+
# verify the required parameter 'domain_update_payload' is set
|
172
|
+
if @api_client.config.client_side_validation && domain_update_payload.nil?
|
173
|
+
fail ArgumentError, "Missing the required parameter 'domain_update_payload' when calling DomainsApi.domains_by_domain_put"
|
174
|
+
end
|
175
|
+
# resource path
|
176
|
+
local_var_path = '/domains/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
|
177
|
+
|
178
|
+
# query parameters
|
179
|
+
query_params = opts[:query_params] || {}
|
180
|
+
|
181
|
+
# header parameters
|
182
|
+
header_params = opts[:header_params] || {}
|
183
|
+
# HTTP header 'Accept' (if needed)
|
184
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
185
|
+
# HTTP header 'Content-Type'
|
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
|
190
|
+
|
191
|
+
# form parameters
|
192
|
+
form_params = opts[:form_params] || {}
|
193
|
+
|
194
|
+
# http body (model)
|
195
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(domain_update_payload)
|
196
|
+
|
197
|
+
# return_type
|
198
|
+
return_type = opts[:debug_return_type] || 'DomainDetail'
|
199
|
+
|
200
|
+
# auth_names
|
201
|
+
auth_names = opts[:debug_auth_names] || ['apikey']
|
202
|
+
|
203
|
+
new_options = opts.merge(
|
204
|
+
:operation => :"DomainsApi.domains_by_domain_put",
|
205
|
+
:header_params => header_params,
|
206
|
+
:query_params => query_params,
|
207
|
+
:form_params => form_params,
|
208
|
+
:body => post_body,
|
209
|
+
:auth_names => auth_names,
|
210
|
+
:return_type => return_type
|
211
|
+
)
|
212
|
+
|
213
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
214
|
+
if @api_client.config.debugging
|
215
|
+
@api_client.config.logger.debug "API called: DomainsApi#domains_by_domain_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
216
|
+
end
|
217
|
+
return data, status_code, headers
|
218
|
+
end
|
219
|
+
|
220
|
+
# Check for domain restriction
|
221
|
+
# Checking if domain is from free provider, or restricted. Required Access Level: ViewSettings
|
222
|
+
# @param domain [String] Name of the given domain
|
223
|
+
# @param [Hash] opts the optional parameters
|
224
|
+
# @return [Boolean]
|
225
|
+
def domains_by_domain_restricted_get(domain, opts = {})
|
226
|
+
data, _status_code, _headers = domains_by_domain_restricted_get_with_http_info(domain, opts)
|
227
|
+
data
|
228
|
+
end
|
229
|
+
|
230
|
+
# Check for domain restriction
|
231
|
+
# Checking if domain is from free provider, or restricted. Required Access Level: ViewSettings
|
232
|
+
# @param domain [String] Name of the given domain
|
233
|
+
# @param [Hash] opts the optional parameters
|
234
|
+
# @return [Array<(Boolean, Integer, Hash)>] Boolean data, response status code and response headers
|
235
|
+
def domains_by_domain_restricted_get_with_http_info(domain, opts = {})
|
236
|
+
if @api_client.config.debugging
|
237
|
+
@api_client.config.logger.debug 'Calling API: DomainsApi.domains_by_domain_restricted_get ...'
|
238
|
+
end
|
239
|
+
# verify the required parameter 'domain' is set
|
240
|
+
if @api_client.config.client_side_validation && domain.nil?
|
241
|
+
fail ArgumentError, "Missing the required parameter 'domain' when calling DomainsApi.domains_by_domain_restricted_get"
|
242
|
+
end
|
243
|
+
# resource path
|
244
|
+
local_var_path = '/domains/{domain}/restricted'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
|
245
|
+
|
246
|
+
# query parameters
|
247
|
+
query_params = opts[:query_params] || {}
|
248
|
+
|
249
|
+
# header parameters
|
250
|
+
header_params = opts[:header_params] || {}
|
251
|
+
# HTTP header 'Accept' (if needed)
|
252
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
253
|
+
|
254
|
+
# form parameters
|
255
|
+
form_params = opts[:form_params] || {}
|
256
|
+
|
257
|
+
# http body (model)
|
258
|
+
post_body = opts[:debug_body]
|
259
|
+
|
260
|
+
# return_type
|
261
|
+
return_type = opts[:debug_return_type] || 'Boolean'
|
262
|
+
|
263
|
+
# auth_names
|
264
|
+
auth_names = opts[:debug_auth_names] || ['apikey']
|
265
|
+
|
266
|
+
new_options = opts.merge(
|
267
|
+
:operation => :"DomainsApi.domains_by_domain_restricted_get",
|
268
|
+
:header_params => header_params,
|
269
|
+
:query_params => query_params,
|
270
|
+
:form_params => form_params,
|
271
|
+
:body => post_body,
|
272
|
+
:auth_names => auth_names,
|
273
|
+
:return_type => return_type
|
274
|
+
)
|
275
|
+
|
276
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
277
|
+
if @api_client.config.debugging
|
278
|
+
@api_client.config.logger.debug "API called: DomainsApi#domains_by_domain_restricted_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
279
|
+
end
|
280
|
+
return data, status_code, headers
|
281
|
+
end
|
282
|
+
|
283
|
+
# Verify Domain
|
284
|
+
# Verifies that required DNS records exist for specified domain. Required Access Level: ModifySettings
|
285
|
+
# @param domain [String] Name of the given domain
|
286
|
+
# @param body [String] Tracking type used in the Tracking verification
|
287
|
+
# @param [Hash] opts the optional parameters
|
288
|
+
# @return [DomainData]
|
289
|
+
def domains_by_domain_verification_put(domain, body, opts = {})
|
290
|
+
data, _status_code, _headers = domains_by_domain_verification_put_with_http_info(domain, body, opts)
|
291
|
+
data
|
292
|
+
end
|
293
|
+
|
294
|
+
# Verify Domain
|
295
|
+
# Verifies that required DNS records exist for specified domain. Required Access Level: ModifySettings
|
296
|
+
# @param domain [String] Name of the given domain
|
297
|
+
# @param body [String] Tracking type used in the Tracking verification
|
298
|
+
# @param [Hash] opts the optional parameters
|
299
|
+
# @return [Array<(DomainData, Integer, Hash)>] DomainData data, response status code and response headers
|
300
|
+
def domains_by_domain_verification_put_with_http_info(domain, body, opts = {})
|
301
|
+
if @api_client.config.debugging
|
302
|
+
@api_client.config.logger.debug 'Calling API: DomainsApi.domains_by_domain_verification_put ...'
|
303
|
+
end
|
304
|
+
# verify the required parameter 'domain' is set
|
305
|
+
if @api_client.config.client_side_validation && domain.nil?
|
306
|
+
fail ArgumentError, "Missing the required parameter 'domain' when calling DomainsApi.domains_by_domain_verification_put"
|
307
|
+
end
|
308
|
+
# verify the required parameter 'body' is set
|
309
|
+
if @api_client.config.client_side_validation && body.nil?
|
310
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling DomainsApi.domains_by_domain_verification_put"
|
311
|
+
end
|
312
|
+
# resource path
|
313
|
+
local_var_path = '/domains/{domain}/verification'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
|
314
|
+
|
315
|
+
# query parameters
|
316
|
+
query_params = opts[:query_params] || {}
|
317
|
+
|
318
|
+
# header parameters
|
319
|
+
header_params = opts[:header_params] || {}
|
320
|
+
# HTTP header 'Accept' (if needed)
|
321
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
322
|
+
# HTTP header 'Content-Type'
|
323
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
324
|
+
if !content_type.nil?
|
325
|
+
header_params['Content-Type'] = content_type
|
326
|
+
end
|
327
|
+
|
328
|
+
# form parameters
|
329
|
+
form_params = opts[:form_params] || {}
|
330
|
+
|
331
|
+
# http body (model)
|
332
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
333
|
+
|
334
|
+
# return_type
|
335
|
+
return_type = opts[:debug_return_type] || 'DomainData'
|
336
|
+
|
337
|
+
# auth_names
|
338
|
+
auth_names = opts[:debug_auth_names] || ['apikey']
|
339
|
+
|
340
|
+
new_options = opts.merge(
|
341
|
+
:operation => :"DomainsApi.domains_by_domain_verification_put",
|
342
|
+
:header_params => header_params,
|
343
|
+
:query_params => query_params,
|
344
|
+
:form_params => form_params,
|
345
|
+
:body => post_body,
|
346
|
+
:auth_names => auth_names,
|
347
|
+
:return_type => return_type
|
348
|
+
)
|
349
|
+
|
350
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
351
|
+
if @api_client.config.debugging
|
352
|
+
@api_client.config.logger.debug "API called: DomainsApi#domains_by_domain_verification_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
353
|
+
end
|
354
|
+
return data, status_code, headers
|
355
|
+
end
|
356
|
+
|
357
|
+
# Set Default
|
358
|
+
# Sets a verified email address as default sender. Required Access Level: ModifySettings
|
359
|
+
# @param email [String] Default email sender, example: mail@yourdomain.com
|
360
|
+
# @param [Hash] opts the optional parameters
|
361
|
+
# @return [DomainDetail]
|
362
|
+
def domains_by_email_default_patch(email, opts = {})
|
363
|
+
data, _status_code, _headers = domains_by_email_default_patch_with_http_info(email, opts)
|
364
|
+
data
|
365
|
+
end
|
366
|
+
|
367
|
+
# Set Default
|
368
|
+
# Sets a verified email address as default sender. Required Access Level: ModifySettings
|
369
|
+
# @param email [String] Default email sender, example: mail@yourdomain.com
|
370
|
+
# @param [Hash] opts the optional parameters
|
371
|
+
# @return [Array<(DomainDetail, Integer, Hash)>] DomainDetail data, response status code and response headers
|
372
|
+
def domains_by_email_default_patch_with_http_info(email, opts = {})
|
373
|
+
if @api_client.config.debugging
|
374
|
+
@api_client.config.logger.debug 'Calling API: DomainsApi.domains_by_email_default_patch ...'
|
375
|
+
end
|
376
|
+
# verify the required parameter 'email' is set
|
377
|
+
if @api_client.config.client_side_validation && email.nil?
|
378
|
+
fail ArgumentError, "Missing the required parameter 'email' when calling DomainsApi.domains_by_email_default_patch"
|
379
|
+
end
|
380
|
+
# resource path
|
381
|
+
local_var_path = '/domains/{email}/default'.sub('{' + 'email' + '}', CGI.escape(email.to_s))
|
382
|
+
|
383
|
+
# query parameters
|
384
|
+
query_params = opts[:query_params] || {}
|
385
|
+
|
386
|
+
# header parameters
|
387
|
+
header_params = opts[:header_params] || {}
|
388
|
+
# HTTP header 'Accept' (if needed)
|
389
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
390
|
+
|
391
|
+
# form parameters
|
392
|
+
form_params = opts[:form_params] || {}
|
393
|
+
|
394
|
+
# http body (model)
|
395
|
+
post_body = opts[:debug_body]
|
396
|
+
|
397
|
+
# return_type
|
398
|
+
return_type = opts[:debug_return_type] || 'DomainDetail'
|
399
|
+
|
400
|
+
# auth_names
|
401
|
+
auth_names = opts[:debug_auth_names] || ['apikey']
|
402
|
+
|
403
|
+
new_options = opts.merge(
|
404
|
+
:operation => :"DomainsApi.domains_by_email_default_patch",
|
405
|
+
:header_params => header_params,
|
406
|
+
:query_params => query_params,
|
407
|
+
:form_params => form_params,
|
408
|
+
:body => post_body,
|
409
|
+
:auth_names => auth_names,
|
410
|
+
:return_type => return_type
|
411
|
+
)
|
412
|
+
|
413
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
414
|
+
if @api_client.config.debugging
|
415
|
+
@api_client.config.logger.debug "API called: DomainsApi#domains_by_email_default_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
416
|
+
end
|
417
|
+
return data, status_code, headers
|
418
|
+
end
|
419
|
+
|
420
|
+
# Load Domains
|
421
|
+
# Returns a list of all domains configured for this Account. Required Access Level: ViewSettings
|
422
|
+
# @param [Hash] opts the optional parameters
|
423
|
+
# @return [Array<DomainDetail>]
|
424
|
+
def domains_get(opts = {})
|
425
|
+
data, _status_code, _headers = domains_get_with_http_info(opts)
|
426
|
+
data
|
427
|
+
end
|
428
|
+
|
429
|
+
# Load Domains
|
430
|
+
# Returns a list of all domains configured for this Account. Required Access Level: ViewSettings
|
431
|
+
# @param [Hash] opts the optional parameters
|
432
|
+
# @return [Array<(Array<DomainDetail>, Integer, Hash)>] Array<DomainDetail> data, response status code and response headers
|
433
|
+
def domains_get_with_http_info(opts = {})
|
434
|
+
if @api_client.config.debugging
|
435
|
+
@api_client.config.logger.debug 'Calling API: DomainsApi.domains_get ...'
|
436
|
+
end
|
437
|
+
# resource path
|
438
|
+
local_var_path = '/domains'
|
439
|
+
|
440
|
+
# query parameters
|
441
|
+
query_params = opts[:query_params] || {}
|
442
|
+
|
443
|
+
# header parameters
|
444
|
+
header_params = opts[:header_params] || {}
|
445
|
+
# HTTP header 'Accept' (if needed)
|
446
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
447
|
+
|
448
|
+
# form parameters
|
449
|
+
form_params = opts[:form_params] || {}
|
450
|
+
|
451
|
+
# http body (model)
|
452
|
+
post_body = opts[:debug_body]
|
453
|
+
|
454
|
+
# return_type
|
455
|
+
return_type = opts[:debug_return_type] || 'Array<DomainDetail>'
|
456
|
+
|
457
|
+
# auth_names
|
458
|
+
auth_names = opts[:debug_auth_names] || ['apikey']
|
459
|
+
|
460
|
+
new_options = opts.merge(
|
461
|
+
:operation => :"DomainsApi.domains_get",
|
462
|
+
:header_params => header_params,
|
463
|
+
:query_params => query_params,
|
464
|
+
:form_params => form_params,
|
465
|
+
:body => post_body,
|
466
|
+
:auth_names => auth_names,
|
467
|
+
:return_type => return_type
|
468
|
+
)
|
469
|
+
|
470
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
471
|
+
if @api_client.config.debugging
|
472
|
+
@api_client.config.logger.debug "API called: DomainsApi#domains_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
473
|
+
end
|
474
|
+
return data, status_code, headers
|
475
|
+
end
|
476
|
+
|
477
|
+
# Add Domain
|
478
|
+
# Add new domain to Account. Required Access Level: ModifySettings
|
479
|
+
# @param domain_payload [DomainPayload] Domain to add
|
480
|
+
# @param [Hash] opts the optional parameters
|
481
|
+
# @return [DomainDetail]
|
482
|
+
def domains_post(domain_payload, opts = {})
|
483
|
+
data, _status_code, _headers = domains_post_with_http_info(domain_payload, opts)
|
484
|
+
data
|
485
|
+
end
|
486
|
+
|
487
|
+
# Add Domain
|
488
|
+
# Add new domain to Account. Required Access Level: ModifySettings
|
489
|
+
# @param domain_payload [DomainPayload] Domain to add
|
490
|
+
# @param [Hash] opts the optional parameters
|
491
|
+
# @return [Array<(DomainDetail, Integer, Hash)>] DomainDetail data, response status code and response headers
|
492
|
+
def domains_post_with_http_info(domain_payload, opts = {})
|
493
|
+
if @api_client.config.debugging
|
494
|
+
@api_client.config.logger.debug 'Calling API: DomainsApi.domains_post ...'
|
495
|
+
end
|
496
|
+
# verify the required parameter 'domain_payload' is set
|
497
|
+
if @api_client.config.client_side_validation && domain_payload.nil?
|
498
|
+
fail ArgumentError, "Missing the required parameter 'domain_payload' when calling DomainsApi.domains_post"
|
499
|
+
end
|
500
|
+
# resource path
|
501
|
+
local_var_path = '/domains'
|
502
|
+
|
503
|
+
# query parameters
|
504
|
+
query_params = opts[:query_params] || {}
|
505
|
+
|
506
|
+
# header parameters
|
507
|
+
header_params = opts[:header_params] || {}
|
508
|
+
# HTTP header 'Accept' (if needed)
|
509
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
510
|
+
# HTTP header 'Content-Type'
|
511
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
512
|
+
if !content_type.nil?
|
513
|
+
header_params['Content-Type'] = content_type
|
514
|
+
end
|
515
|
+
|
516
|
+
# form parameters
|
517
|
+
form_params = opts[:form_params] || {}
|
518
|
+
|
519
|
+
# http body (model)
|
520
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(domain_payload)
|
521
|
+
|
522
|
+
# return_type
|
523
|
+
return_type = opts[:debug_return_type] || 'DomainDetail'
|
524
|
+
|
525
|
+
# auth_names
|
526
|
+
auth_names = opts[:debug_auth_names] || ['apikey']
|
527
|
+
|
528
|
+
new_options = opts.merge(
|
529
|
+
:operation => :"DomainsApi.domains_post",
|
530
|
+
:header_params => header_params,
|
531
|
+
:query_params => query_params,
|
532
|
+
:form_params => form_params,
|
533
|
+
:body => post_body,
|
534
|
+
:auth_names => auth_names,
|
535
|
+
:return_type => return_type
|
536
|
+
)
|
537
|
+
|
538
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
539
|
+
if @api_client.config.debugging
|
540
|
+
@api_client.config.logger.debug "API called: DomainsApi#domains_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
541
|
+
end
|
542
|
+
return data, status_code, headers
|
543
|
+
end
|
544
|
+
end
|
545
|
+
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
|
-
|
9
|
+
Generator version: 7.5.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -82,8 +82,101 @@ module ElasticEmail
|
|
82
82
|
return data, status_code, headers
|
83
83
|
end
|
84
84
|
|
85
|
+
# Get Status
|
86
|
+
# Get status details of an email transaction. Required Access Level: ViewReports
|
87
|
+
# @param transactionid [String] Transaction identifier
|
88
|
+
# @param [Hash] opts the optional parameters
|
89
|
+
# @option opts [Boolean] :show_failed Include Bounced email addresses. (default to false)
|
90
|
+
# @option opts [Boolean] :show_sent Include Sent email addresses. (default to false)
|
91
|
+
# @option opts [Boolean] :show_delivered Include all delivered email addresses. (default to false)
|
92
|
+
# @option opts [Boolean] :show_pending Include Ready to send email addresses. (default to false)
|
93
|
+
# @option opts [Boolean] :show_opened Include Opened email addresses. (default to false)
|
94
|
+
# @option opts [Boolean] :show_clicked Include Clicked email addresses. (default to false)
|
95
|
+
# @option opts [Boolean] :show_abuse Include Reported as abuse email addresses. (default to false)
|
96
|
+
# @option opts [Boolean] :show_unsubscribed Include Unsubscribed email addresses. (default to false)
|
97
|
+
# @option opts [Boolean] :show_errors Include error messages for bounced emails. (default to false)
|
98
|
+
# @option opts [Boolean] :show_message_ids Include all MessageIDs for this transaction (default to false)
|
99
|
+
# @return [EmailJobStatus]
|
100
|
+
def emails_by_transactionid_status_get(transactionid, opts = {})
|
101
|
+
data, _status_code, _headers = emails_by_transactionid_status_get_with_http_info(transactionid, opts)
|
102
|
+
data
|
103
|
+
end
|
104
|
+
|
105
|
+
# Get Status
|
106
|
+
# Get status details of an email transaction. Required Access Level: ViewReports
|
107
|
+
# @param transactionid [String] Transaction identifier
|
108
|
+
# @param [Hash] opts the optional parameters
|
109
|
+
# @option opts [Boolean] :show_failed Include Bounced email addresses. (default to false)
|
110
|
+
# @option opts [Boolean] :show_sent Include Sent email addresses. (default to false)
|
111
|
+
# @option opts [Boolean] :show_delivered Include all delivered email addresses. (default to false)
|
112
|
+
# @option opts [Boolean] :show_pending Include Ready to send email addresses. (default to false)
|
113
|
+
# @option opts [Boolean] :show_opened Include Opened email addresses. (default to false)
|
114
|
+
# @option opts [Boolean] :show_clicked Include Clicked email addresses. (default to false)
|
115
|
+
# @option opts [Boolean] :show_abuse Include Reported as abuse email addresses. (default to false)
|
116
|
+
# @option opts [Boolean] :show_unsubscribed Include Unsubscribed email addresses. (default to false)
|
117
|
+
# @option opts [Boolean] :show_errors Include error messages for bounced emails. (default to false)
|
118
|
+
# @option opts [Boolean] :show_message_ids Include all MessageIDs for this transaction (default to false)
|
119
|
+
# @return [Array<(EmailJobStatus, Integer, Hash)>] EmailJobStatus data, response status code and response headers
|
120
|
+
def emails_by_transactionid_status_get_with_http_info(transactionid, opts = {})
|
121
|
+
if @api_client.config.debugging
|
122
|
+
@api_client.config.logger.debug 'Calling API: EmailsApi.emails_by_transactionid_status_get ...'
|
123
|
+
end
|
124
|
+
# verify the required parameter 'transactionid' is set
|
125
|
+
if @api_client.config.client_side_validation && transactionid.nil?
|
126
|
+
fail ArgumentError, "Missing the required parameter 'transactionid' when calling EmailsApi.emails_by_transactionid_status_get"
|
127
|
+
end
|
128
|
+
# resource path
|
129
|
+
local_var_path = '/emails/{transactionid}/status'.sub('{' + 'transactionid' + '}', CGI.escape(transactionid.to_s))
|
130
|
+
|
131
|
+
# query parameters
|
132
|
+
query_params = opts[:query_params] || {}
|
133
|
+
query_params[:'showFailed'] = opts[:'show_failed'] if !opts[:'show_failed'].nil?
|
134
|
+
query_params[:'showSent'] = opts[:'show_sent'] if !opts[:'show_sent'].nil?
|
135
|
+
query_params[:'showDelivered'] = opts[:'show_delivered'] if !opts[:'show_delivered'].nil?
|
136
|
+
query_params[:'showPending'] = opts[:'show_pending'] if !opts[:'show_pending'].nil?
|
137
|
+
query_params[:'showOpened'] = opts[:'show_opened'] if !opts[:'show_opened'].nil?
|
138
|
+
query_params[:'showClicked'] = opts[:'show_clicked'] if !opts[:'show_clicked'].nil?
|
139
|
+
query_params[:'showAbuse'] = opts[:'show_abuse'] if !opts[:'show_abuse'].nil?
|
140
|
+
query_params[:'showUnsubscribed'] = opts[:'show_unsubscribed'] if !opts[:'show_unsubscribed'].nil?
|
141
|
+
query_params[:'showErrors'] = opts[:'show_errors'] if !opts[:'show_errors'].nil?
|
142
|
+
query_params[:'showMessageIDs'] = opts[:'show_message_ids'] if !opts[:'show_message_ids'].nil?
|
143
|
+
|
144
|
+
# header parameters
|
145
|
+
header_params = opts[:header_params] || {}
|
146
|
+
# HTTP header 'Accept' (if needed)
|
147
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
148
|
+
|
149
|
+
# form parameters
|
150
|
+
form_params = opts[:form_params] || {}
|
151
|
+
|
152
|
+
# http body (model)
|
153
|
+
post_body = opts[:debug_body]
|
154
|
+
|
155
|
+
# return_type
|
156
|
+
return_type = opts[:debug_return_type] || 'EmailJobStatus'
|
157
|
+
|
158
|
+
# auth_names
|
159
|
+
auth_names = opts[:debug_auth_names] || ['apikey']
|
160
|
+
|
161
|
+
new_options = opts.merge(
|
162
|
+
:operation => :"EmailsApi.emails_by_transactionid_status_get",
|
163
|
+
:header_params => header_params,
|
164
|
+
:query_params => query_params,
|
165
|
+
:form_params => form_params,
|
166
|
+
:body => post_body,
|
167
|
+
:auth_names => auth_names,
|
168
|
+
:return_type => return_type
|
169
|
+
)
|
170
|
+
|
171
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
172
|
+
if @api_client.config.debugging
|
173
|
+
@api_client.config.logger.debug "API called: EmailsApi#emails_by_transactionid_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
174
|
+
end
|
175
|
+
return data, status_code, headers
|
176
|
+
end
|
177
|
+
|
85
178
|
# Send Bulk Emails CSV
|
86
|
-
# Send
|
179
|
+
# Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using {merge} tags in the content. Example CSV: email, firstname, lastname test1@gmail.com, michael, smith test2@gmail.com, janet, smith Merge file must not be empty. Required Access Level: SendHttp
|
87
180
|
# @param merge_email_payload [MergeEmailPayload] Email data
|
88
181
|
# @param [Hash] opts the optional parameters
|
89
182
|
# @return [EmailSend]
|
@@ -93,7 +186,7 @@ module ElasticEmail
|
|
93
186
|
end
|
94
187
|
|
95
188
|
# Send Bulk Emails CSV
|
96
|
-
# Send
|
189
|
+
# Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using {merge} tags in the content. Example CSV: email, firstname, lastname test1@gmail.com, michael, smith test2@gmail.com, janet, smith Merge file must not be empty. Required Access Level: SendHttp
|
97
190
|
# @param merge_email_payload [MergeEmailPayload] Email data
|
98
191
|
# @param [Hash] opts the optional parameters
|
99
192
|
# @return [Array<(EmailSend, Integer, Hash)>] EmailSend data, response status code and response headers
|