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.
Files changed (242) hide show
  1. checksums.yaml +4 -4
  2. data/ElasticEmail.gemspec +1 -1
  3. data/README.md +23 -5
  4. data/VERSION +1 -1
  5. data/docs/CampaignsApi.md +71 -0
  6. data/docs/CertificateValidationStatus.md +15 -0
  7. data/docs/DomainData.md +54 -0
  8. data/docs/DomainDetail.md +52 -0
  9. data/docs/DomainOwner.md +15 -0
  10. data/docs/DomainPayload.md +20 -0
  11. data/docs/DomainUpdatePayload.md +24 -0
  12. data/docs/DomainsApi.md +583 -0
  13. data/docs/EmailStatus.md +3 -1
  14. data/docs/EmailsApi.md +1 -1
  15. data/docs/MessageCategoryEnum.md +15 -0
  16. data/docs/TrackingType.md +15 -0
  17. data/docs/TrackingValidationStatus.md +15 -0
  18. data/lib/ElasticEmail/api/campaigns_api.rb +62 -1
  19. data/lib/ElasticEmail/api/contacts_api.rb +1 -1
  20. data/lib/ElasticEmail/api/domains_api.rb +545 -0
  21. data/lib/ElasticEmail/api/emails_api.rb +3 -3
  22. data/lib/ElasticEmail/api/events_api.rb +1 -1
  23. data/lib/ElasticEmail/api/files_api.rb +1 -1
  24. data/lib/ElasticEmail/api/inbound_route_api.rb +1 -1
  25. data/lib/ElasticEmail/api/lists_api.rb +1 -1
  26. data/lib/ElasticEmail/api/security_api.rb +1 -1
  27. data/lib/ElasticEmail/api/segments_api.rb +1 -1
  28. data/lib/ElasticEmail/api/statistics_api.rb +1 -1
  29. data/lib/ElasticEmail/api/sub_accounts_api.rb +1 -1
  30. data/lib/ElasticEmail/api/suppressions_api.rb +1 -1
  31. data/lib/ElasticEmail/api/templates_api.rb +1 -1
  32. data/lib/ElasticEmail/api/verifications_api.rb +1 -1
  33. data/lib/ElasticEmail/api_client.rb +3 -3
  34. data/lib/ElasticEmail/api_error.rb +1 -1
  35. data/lib/ElasticEmail/configuration.rb +1 -11
  36. data/lib/ElasticEmail/models/access_level.rb +3 -2
  37. data/lib/ElasticEmail/models/account_status_enum.rb +1 -1
  38. data/lib/ElasticEmail/models/api_key.rb +1 -1
  39. data/lib/ElasticEmail/models/api_key_payload.rb +1 -1
  40. data/lib/ElasticEmail/models/body_content_type.rb +1 -1
  41. data/lib/ElasticEmail/models/body_part.rb +1 -1
  42. data/lib/ElasticEmail/models/campaign.rb +1 -1
  43. data/lib/ElasticEmail/models/campaign_options.rb +1 -1
  44. data/lib/ElasticEmail/models/campaign_recipient.rb +1 -1
  45. data/lib/ElasticEmail/models/campaign_status.rb +1 -1
  46. data/lib/ElasticEmail/models/campaign_template.rb +1 -1
  47. data/lib/ElasticEmail/models/certificate_validation_status.rb +42 -0
  48. data/lib/ElasticEmail/models/channel_log_status_summary.rb +1 -1
  49. data/lib/ElasticEmail/models/compression_format.rb +1 -1
  50. data/lib/ElasticEmail/models/consent_data.rb +1 -1
  51. data/lib/ElasticEmail/models/consent_tracking.rb +1 -1
  52. data/lib/ElasticEmail/models/contact.rb +1 -1
  53. data/lib/ElasticEmail/models/contact_activity.rb +1 -1
  54. data/lib/ElasticEmail/models/contact_payload.rb +1 -1
  55. data/lib/ElasticEmail/models/contact_source.rb +1 -1
  56. data/lib/ElasticEmail/models/contact_status.rb +1 -1
  57. data/lib/ElasticEmail/models/contact_update_payload.rb +1 -1
  58. data/lib/ElasticEmail/models/contacts_list.rb +1 -1
  59. data/lib/ElasticEmail/models/delivery_optimization_type.rb +1 -1
  60. data/lib/ElasticEmail/models/domain_data.rb +417 -0
  61. data/lib/ElasticEmail/models/domain_detail.rb +407 -0
  62. data/lib/ElasticEmail/models/domain_owner.rb +40 -0
  63. data/lib/ElasticEmail/models/domain_payload.rb +224 -0
  64. data/lib/ElasticEmail/models/domain_update_payload.rb +265 -0
  65. data/lib/ElasticEmail/models/email_content.rb +1 -1
  66. data/lib/ElasticEmail/models/email_data.rb +1 -1
  67. data/lib/ElasticEmail/models/email_job_failed_status.rb +1 -1
  68. data/lib/ElasticEmail/models/email_job_status.rb +1 -1
  69. data/lib/ElasticEmail/models/email_message_data.rb +1 -1
  70. data/lib/ElasticEmail/models/email_predicted_validation_status.rb +1 -1
  71. data/lib/ElasticEmail/models/email_recipient.rb +1 -1
  72. data/lib/ElasticEmail/models/email_send.rb +1 -1
  73. data/lib/ElasticEmail/models/email_status.rb +16 -5
  74. data/lib/ElasticEmail/models/email_transactional_message_data.rb +1 -1
  75. data/lib/ElasticEmail/models/email_validation_result.rb +1 -1
  76. data/lib/ElasticEmail/models/email_validation_status.rb +1 -1
  77. data/lib/ElasticEmail/models/email_view.rb +1 -1
  78. data/lib/ElasticEmail/models/emails_payload.rb +1 -1
  79. data/lib/ElasticEmail/models/encoding_type.rb +1 -1
  80. data/lib/ElasticEmail/models/event_type.rb +1 -1
  81. data/lib/ElasticEmail/models/events_order_by.rb +1 -1
  82. data/lib/ElasticEmail/models/export_file_formats.rb +1 -1
  83. data/lib/ElasticEmail/models/export_link.rb +1 -1
  84. data/lib/ElasticEmail/models/export_status.rb +1 -1
  85. data/lib/ElasticEmail/models/file_info.rb +1 -1
  86. data/lib/ElasticEmail/models/file_payload.rb +1 -1
  87. data/lib/ElasticEmail/models/file_upload_result.rb +1 -1
  88. data/lib/ElasticEmail/models/inbound_payload.rb +1 -1
  89. data/lib/ElasticEmail/models/inbound_route.rb +1 -1
  90. data/lib/ElasticEmail/models/inbound_route_action_type.rb +1 -1
  91. data/lib/ElasticEmail/models/inbound_route_filter_type.rb +1 -1
  92. data/lib/ElasticEmail/models/list_payload.rb +1 -1
  93. data/lib/ElasticEmail/models/list_update_payload.rb +1 -1
  94. data/lib/ElasticEmail/models/log_job_status.rb +1 -1
  95. data/lib/ElasticEmail/models/log_status_summary.rb +1 -1
  96. data/lib/ElasticEmail/models/merge_email_payload.rb +1 -1
  97. data/lib/ElasticEmail/models/message_attachment.rb +1 -1
  98. data/lib/ElasticEmail/models/message_category.rb +1 -1
  99. data/lib/ElasticEmail/models/message_category_enum.rb +55 -0
  100. data/lib/ElasticEmail/models/new_api_key.rb +1 -1
  101. data/lib/ElasticEmail/models/new_smtp_credentials.rb +1 -1
  102. data/lib/ElasticEmail/models/options.rb +1 -1
  103. data/lib/ElasticEmail/models/recipient_event.rb +1 -1
  104. data/lib/ElasticEmail/models/segment.rb +1 -1
  105. data/lib/ElasticEmail/models/segment_payload.rb +1 -1
  106. data/lib/ElasticEmail/models/smtp_credentials.rb +1 -1
  107. data/lib/ElasticEmail/models/smtp_credentials_payload.rb +1 -1
  108. data/lib/ElasticEmail/models/sort_order_item.rb +1 -1
  109. data/lib/ElasticEmail/models/split_optimization_type.rb +1 -1
  110. data/lib/ElasticEmail/models/split_options.rb +1 -1
  111. data/lib/ElasticEmail/models/sub_account_info.rb +1 -1
  112. data/lib/ElasticEmail/models/subaccount_email_credits_payload.rb +1 -1
  113. data/lib/ElasticEmail/models/subaccount_email_settings.rb +1 -1
  114. data/lib/ElasticEmail/models/subaccount_email_settings_payload.rb +1 -1
  115. data/lib/ElasticEmail/models/subaccount_payload.rb +1 -1
  116. data/lib/ElasticEmail/models/subaccount_settings_info.rb +1 -1
  117. data/lib/ElasticEmail/models/subaccount_settings_info_payload.rb +1 -1
  118. data/lib/ElasticEmail/models/suppression.rb +1 -1
  119. data/lib/ElasticEmail/models/template.rb +1 -1
  120. data/lib/ElasticEmail/models/template_payload.rb +1 -1
  121. data/lib/ElasticEmail/models/template_scope.rb +1 -1
  122. data/lib/ElasticEmail/models/template_type.rb +3 -2
  123. data/lib/ElasticEmail/models/tracking_type.rb +44 -0
  124. data/lib/ElasticEmail/models/tracking_validation_status.rb +42 -0
  125. data/lib/ElasticEmail/models/transactional_recipient.rb +1 -1
  126. data/lib/ElasticEmail/models/utm.rb +1 -1
  127. data/lib/ElasticEmail/models/verification_file_result.rb +1 -1
  128. data/lib/ElasticEmail/models/verification_file_result_details.rb +1 -1
  129. data/lib/ElasticEmail/models/verification_status.rb +1 -1
  130. data/lib/ElasticEmail/version.rb +2 -2
  131. data/lib/ElasticEmail.rb +11 -1
  132. data/spec/api/campaigns_api_spec.rb +13 -1
  133. data/spec/api/contacts_api_spec.rb +1 -1
  134. data/spec/api/domains_api_spec.rb +132 -0
  135. data/spec/api/emails_api_spec.rb +2 -2
  136. data/spec/api/events_api_spec.rb +1 -1
  137. data/spec/api/files_api_spec.rb +1 -1
  138. data/spec/api/inbound_route_api_spec.rb +1 -1
  139. data/spec/api/lists_api_spec.rb +1 -1
  140. data/spec/api/security_api_spec.rb +1 -1
  141. data/spec/api/segments_api_spec.rb +1 -1
  142. data/spec/api/statistics_api_spec.rb +1 -1
  143. data/spec/api/sub_accounts_api_spec.rb +1 -1
  144. data/spec/api/suppressions_api_spec.rb +1 -1
  145. data/spec/api/templates_api_spec.rb +1 -1
  146. data/spec/api/verifications_api_spec.rb +1 -1
  147. data/spec/models/access_level_spec.rb +1 -1
  148. data/spec/models/account_status_enum_spec.rb +1 -1
  149. data/spec/models/api_key_payload_spec.rb +1 -1
  150. data/spec/models/api_key_spec.rb +1 -1
  151. data/spec/models/body_content_type_spec.rb +1 -1
  152. data/spec/models/body_part_spec.rb +1 -1
  153. data/spec/models/campaign_options_spec.rb +1 -1
  154. data/spec/models/campaign_recipient_spec.rb +1 -1
  155. data/spec/models/campaign_spec.rb +1 -1
  156. data/spec/models/campaign_status_spec.rb +1 -1
  157. data/spec/models/campaign_template_spec.rb +1 -1
  158. data/spec/models/certificate_validation_status_spec.rb +30 -0
  159. data/spec/models/channel_log_status_summary_spec.rb +1 -1
  160. data/spec/models/compression_format_spec.rb +1 -1
  161. data/spec/models/consent_data_spec.rb +1 -1
  162. data/spec/models/consent_tracking_spec.rb +1 -1
  163. data/spec/models/contact_activity_spec.rb +1 -1
  164. data/spec/models/contact_payload_spec.rb +1 -1
  165. data/spec/models/contact_source_spec.rb +1 -1
  166. data/spec/models/contact_spec.rb +1 -1
  167. data/spec/models/contact_status_spec.rb +1 -1
  168. data/spec/models/contact_update_payload_spec.rb +1 -1
  169. data/spec/models/contacts_list_spec.rb +1 -1
  170. data/spec/models/delivery_optimization_type_spec.rb +1 -1
  171. data/spec/models/domain_data_spec.rb +144 -0
  172. data/spec/models/domain_detail_spec.rb +138 -0
  173. data/spec/models/domain_owner_spec.rb +30 -0
  174. data/spec/models/domain_payload_spec.rb +42 -0
  175. data/spec/models/domain_update_payload_spec.rb +54 -0
  176. data/spec/models/email_content_spec.rb +1 -1
  177. data/spec/models/email_data_spec.rb +1 -1
  178. data/spec/models/email_job_failed_status_spec.rb +1 -1
  179. data/spec/models/email_job_status_spec.rb +1 -1
  180. data/spec/models/email_message_data_spec.rb +1 -1
  181. data/spec/models/email_predicted_validation_status_spec.rb +1 -1
  182. data/spec/models/email_recipient_spec.rb +1 -1
  183. data/spec/models/email_send_spec.rb +1 -1
  184. data/spec/models/email_status_spec.rb +7 -1
  185. data/spec/models/email_transactional_message_data_spec.rb +1 -1
  186. data/spec/models/email_validation_result_spec.rb +1 -1
  187. data/spec/models/email_validation_status_spec.rb +1 -1
  188. data/spec/models/email_view_spec.rb +1 -1
  189. data/spec/models/emails_payload_spec.rb +1 -1
  190. data/spec/models/encoding_type_spec.rb +1 -1
  191. data/spec/models/event_type_spec.rb +1 -1
  192. data/spec/models/events_order_by_spec.rb +1 -1
  193. data/spec/models/export_file_formats_spec.rb +1 -1
  194. data/spec/models/export_link_spec.rb +1 -1
  195. data/spec/models/export_status_spec.rb +1 -1
  196. data/spec/models/file_info_spec.rb +1 -1
  197. data/spec/models/file_payload_spec.rb +1 -1
  198. data/spec/models/file_upload_result_spec.rb +1 -1
  199. data/spec/models/inbound_payload_spec.rb +1 -1
  200. data/spec/models/inbound_route_action_type_spec.rb +1 -1
  201. data/spec/models/inbound_route_filter_type_spec.rb +1 -1
  202. data/spec/models/inbound_route_spec.rb +1 -1
  203. data/spec/models/list_payload_spec.rb +1 -1
  204. data/spec/models/list_update_payload_spec.rb +1 -1
  205. data/spec/models/log_job_status_spec.rb +1 -1
  206. data/spec/models/log_status_summary_spec.rb +1 -1
  207. data/spec/models/merge_email_payload_spec.rb +1 -1
  208. data/spec/models/message_attachment_spec.rb +1 -1
  209. data/spec/models/message_category_enum_spec.rb +30 -0
  210. data/spec/models/message_category_spec.rb +1 -1
  211. data/spec/models/new_api_key_spec.rb +1 -1
  212. data/spec/models/new_smtp_credentials_spec.rb +1 -1
  213. data/spec/models/options_spec.rb +1 -1
  214. data/spec/models/recipient_event_spec.rb +1 -1
  215. data/spec/models/segment_payload_spec.rb +1 -1
  216. data/spec/models/segment_spec.rb +1 -1
  217. data/spec/models/smtp_credentials_payload_spec.rb +1 -1
  218. data/spec/models/smtp_credentials_spec.rb +1 -1
  219. data/spec/models/sort_order_item_spec.rb +1 -1
  220. data/spec/models/split_optimization_type_spec.rb +1 -1
  221. data/spec/models/split_options_spec.rb +1 -1
  222. data/spec/models/sub_account_info_spec.rb +1 -1
  223. data/spec/models/subaccount_email_credits_payload_spec.rb +1 -1
  224. data/spec/models/subaccount_email_settings_payload_spec.rb +1 -1
  225. data/spec/models/subaccount_email_settings_spec.rb +1 -1
  226. data/spec/models/subaccount_payload_spec.rb +1 -1
  227. data/spec/models/subaccount_settings_info_payload_spec.rb +1 -1
  228. data/spec/models/subaccount_settings_info_spec.rb +1 -1
  229. data/spec/models/suppression_spec.rb +1 -1
  230. data/spec/models/template_payload_spec.rb +1 -1
  231. data/spec/models/template_scope_spec.rb +1 -1
  232. data/spec/models/template_spec.rb +1 -1
  233. data/spec/models/template_type_spec.rb +1 -1
  234. data/spec/models/tracking_type_spec.rb +30 -0
  235. data/spec/models/tracking_validation_status_spec.rb +30 -0
  236. data/spec/models/transactional_recipient_spec.rb +1 -1
  237. data/spec/models/utm_spec.rb +1 -1
  238. data/spec/models/verification_file_result_details_spec.rb +1 -1
  239. data/spec/models/verification_file_result_spec.rb +1 -1
  240. data/spec/models/verification_status_spec.rb +1 -1
  241. data/spec/spec_helper.rb +1 -1
  242. metadata +120 -80
@@ -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.7.0
9
+ Generator version: 7.5.0
10
10
 
11
11
  =end
12
12
 
@@ -143,6 +143,67 @@ module ElasticEmail
143
143
  return data, status_code, headers
144
144
  end
145
145
 
146
+ # Pause Campaign
147
+ # Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns
148
+ # @param name [String] Name of Campaign to pause
149
+ # @param [Hash] opts the optional parameters
150
+ # @return [nil]
151
+ def campaigns_by_name_pause_put(name, opts = {})
152
+ campaigns_by_name_pause_put_with_http_info(name, opts)
153
+ nil
154
+ end
155
+
156
+ # Pause Campaign
157
+ # Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns
158
+ # @param name [String] Name of Campaign to pause
159
+ # @param [Hash] opts the optional parameters
160
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
161
+ def campaigns_by_name_pause_put_with_http_info(name, opts = {})
162
+ if @api_client.config.debugging
163
+ @api_client.config.logger.debug 'Calling API: CampaignsApi.campaigns_by_name_pause_put ...'
164
+ end
165
+ # verify the required parameter 'name' is set
166
+ if @api_client.config.client_side_validation && name.nil?
167
+ fail ArgumentError, "Missing the required parameter 'name' when calling CampaignsApi.campaigns_by_name_pause_put"
168
+ end
169
+ # resource path
170
+ local_var_path = '/campaigns/{name}/pause'.sub('{' + 'name' + '}', CGI.escape(name.to_s))
171
+
172
+ # query parameters
173
+ query_params = opts[:query_params] || {}
174
+
175
+ # header parameters
176
+ header_params = opts[:header_params] || {}
177
+
178
+ # form parameters
179
+ form_params = opts[:form_params] || {}
180
+
181
+ # http body (model)
182
+ post_body = opts[:debug_body]
183
+
184
+ # return_type
185
+ return_type = opts[:debug_return_type]
186
+
187
+ # auth_names
188
+ auth_names = opts[:debug_auth_names] || ['apikey']
189
+
190
+ new_options = opts.merge(
191
+ :operation => :"CampaignsApi.campaigns_by_name_pause_put",
192
+ :header_params => header_params,
193
+ :query_params => query_params,
194
+ :form_params => form_params,
195
+ :body => post_body,
196
+ :auth_names => auth_names,
197
+ :return_type => return_type
198
+ )
199
+
200
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
201
+ if @api_client.config.debugging
202
+ @api_client.config.logger.debug "API called: CampaignsApi#campaigns_by_name_pause_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
203
+ end
204
+ return data, status_code, headers
205
+ end
206
+
146
207
  # Update Campaign
147
208
  # Updates a previously added campaign. Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns
148
209
  # @param name [String] Name of Campaign to update
@@ -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.7.0
9
+ Generator version: 7.5.0
10
10
 
11
11
  =end
12
12
 
@@ -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
- Generator version: 7.7.0
9
+ Generator version: 7.5.0
10
10
 
11
11
  =end
12
12
 
@@ -176,7 +176,7 @@ module ElasticEmail
176
176
  end
177
177
 
178
178
  # Send Bulk Emails CSV
179
- # Send bulk merge email. Required Access Level: SendHttp
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
180
180
  # @param merge_email_payload [MergeEmailPayload] Email data
181
181
  # @param [Hash] opts the optional parameters
182
182
  # @return [EmailSend]
@@ -186,7 +186,7 @@ module ElasticEmail
186
186
  end
187
187
 
188
188
  # Send Bulk Emails CSV
189
- # Send bulk merge email. Required Access Level: SendHttp
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
190
190
  # @param merge_email_payload [MergeEmailPayload] Email data
191
191
  # @param [Hash] opts the optional parameters
192
192
  # @return [Array<(EmailSend, Integer, Hash)>] EmailSend data, response status code and response headers
@@ -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.7.0
9
+ Generator version: 7.5.0
10
10
 
11
11
  =end
12
12
 
@@ -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.7.0
9
+ Generator version: 7.5.0
10
10
 
11
11
  =end
12
12
 
@@ -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.7.0
9
+ Generator version: 7.5.0
10
10
 
11
11
  =end
12
12