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.
Files changed (261) hide show
  1. checksums.yaml +4 -4
  2. data/ElasticEmail.gemspec +2 -1
  3. data/README.md +28 -4
  4. data/VERSION +1 -1
  5. data/docs/CampaignOptions.md +4 -0
  6. data/docs/CampaignTemplate.md +2 -2
  7. data/docs/CampaignsApi.md +71 -0
  8. data/docs/CertificateValidationStatus.md +15 -0
  9. data/docs/DomainData.md +54 -0
  10. data/docs/DomainDetail.md +52 -0
  11. data/docs/{TemplateScopeType.md → DomainOwner.md} +2 -2
  12. data/docs/DomainPayload.md +20 -0
  13. data/docs/DomainUpdatePayload.md +24 -0
  14. data/docs/DomainsApi.md +583 -0
  15. data/docs/EmailContent.md +2 -2
  16. data/docs/EmailJobFailedStatus.md +24 -0
  17. data/docs/EmailJobStatus.md +56 -0
  18. data/docs/EmailMessageData.md +1 -1
  19. data/docs/EmailStatus.md +3 -1
  20. data/docs/EmailTransactionalMessageData.md +1 -1
  21. data/docs/EmailValidationResult.md +2 -2
  22. data/docs/EmailsApi.md +98 -4
  23. data/docs/EmailsPayload.md +1 -1
  24. data/docs/ListPayload.md +1 -1
  25. data/docs/ListsApi.md +78 -0
  26. data/docs/MergeEmailPayload.md +1 -1
  27. data/docs/{ContactHistEventType.md → MessageCategoryEnum.md} +2 -2
  28. data/docs/TrackingType.md +15 -0
  29. data/docs/TrackingValidationStatus.md +15 -0
  30. data/lib/ElasticEmail/api/campaigns_api.rb +62 -1
  31. data/lib/ElasticEmail/api/contacts_api.rb +1 -1
  32. data/lib/ElasticEmail/api/domains_api.rb +545 -0
  33. data/lib/ElasticEmail/api/emails_api.rb +96 -3
  34. data/lib/ElasticEmail/api/events_api.rb +1 -1
  35. data/lib/ElasticEmail/api/files_api.rb +1 -1
  36. data/lib/ElasticEmail/api/inbound_route_api.rb +1 -1
  37. data/lib/ElasticEmail/api/lists_api.rb +70 -1
  38. data/lib/ElasticEmail/api/security_api.rb +1 -1
  39. data/lib/ElasticEmail/api/segments_api.rb +1 -1
  40. data/lib/ElasticEmail/api/statistics_api.rb +1 -1
  41. data/lib/ElasticEmail/api/sub_accounts_api.rb +1 -1
  42. data/lib/ElasticEmail/api/suppressions_api.rb +1 -1
  43. data/lib/ElasticEmail/api/templates_api.rb +1 -1
  44. data/lib/ElasticEmail/api/verifications_api.rb +1 -1
  45. data/lib/ElasticEmail/api_client.rb +23 -21
  46. data/lib/ElasticEmail/api_error.rb +1 -1
  47. data/lib/ElasticEmail/configuration.rb +18 -10
  48. data/lib/ElasticEmail/models/access_level.rb +4 -3
  49. data/lib/ElasticEmail/models/account_status_enum.rb +1 -1
  50. data/lib/ElasticEmail/models/api_key.rb +14 -19
  51. data/lib/ElasticEmail/models/api_key_payload.rb +18 -19
  52. data/lib/ElasticEmail/models/body_content_type.rb +1 -1
  53. data/lib/ElasticEmail/models/body_part.rb +14 -19
  54. data/lib/ElasticEmail/models/campaign.rb +18 -19
  55. data/lib/ElasticEmail/models/campaign_options.rb +35 -20
  56. data/lib/ElasticEmail/models/campaign_recipient.rb +14 -19
  57. data/lib/ElasticEmail/models/campaign_status.rb +1 -1
  58. data/lib/ElasticEmail/models/campaign_template.rb +21 -19
  59. data/lib/ElasticEmail/models/certificate_validation_status.rb +42 -0
  60. data/lib/ElasticEmail/models/channel_log_status_summary.rb +14 -19
  61. data/lib/ElasticEmail/models/compression_format.rb +1 -1
  62. data/lib/ElasticEmail/models/consent_data.rb +14 -19
  63. data/lib/ElasticEmail/models/consent_tracking.rb +1 -1
  64. data/lib/ElasticEmail/models/contact.rb +14 -19
  65. data/lib/ElasticEmail/models/contact_activity.rb +14 -19
  66. data/lib/ElasticEmail/models/contact_payload.rb +16 -19
  67. data/lib/ElasticEmail/models/contact_source.rb +1 -1
  68. data/lib/ElasticEmail/models/contact_status.rb +1 -1
  69. data/lib/ElasticEmail/models/contact_update_payload.rb +14 -19
  70. data/lib/ElasticEmail/models/contacts_list.rb +14 -19
  71. data/lib/ElasticEmail/models/delivery_optimization_type.rb +1 -1
  72. data/lib/ElasticEmail/models/domain_data.rb +417 -0
  73. data/lib/ElasticEmail/models/domain_detail.rb +407 -0
  74. data/lib/ElasticEmail/models/domain_owner.rb +40 -0
  75. data/lib/ElasticEmail/models/domain_payload.rb +224 -0
  76. data/lib/ElasticEmail/models/{contact_history.rb → domain_update_payload.rb} +63 -79
  77. data/lib/ElasticEmail/models/email_content.rb +21 -19
  78. data/lib/ElasticEmail/models/email_data.rb +14 -19
  79. data/lib/ElasticEmail/models/email_job_failed_status.rb +242 -0
  80. data/lib/ElasticEmail/models/email_job_status.rb +415 -0
  81. data/lib/ElasticEmail/models/email_message_data.rb +23 -19
  82. data/lib/ElasticEmail/models/email_predicted_validation_status.rb +1 -1
  83. data/lib/ElasticEmail/models/email_recipient.rb +16 -19
  84. data/lib/ElasticEmail/models/email_send.rb +14 -19
  85. data/lib/ElasticEmail/models/email_status.rb +29 -23
  86. data/lib/ElasticEmail/models/email_transactional_message_data.rb +23 -19
  87. data/lib/ElasticEmail/models/email_validation_result.rb +16 -20
  88. data/lib/ElasticEmail/models/email_validation_status.rb +1 -1
  89. data/lib/ElasticEmail/models/email_view.rb +14 -19
  90. data/lib/ElasticEmail/models/emails_payload.rb +14 -19
  91. data/lib/ElasticEmail/models/encoding_type.rb +1 -1
  92. data/lib/ElasticEmail/models/event_type.rb +1 -1
  93. data/lib/ElasticEmail/models/events_order_by.rb +1 -1
  94. data/lib/ElasticEmail/models/export_file_formats.rb +1 -1
  95. data/lib/ElasticEmail/models/export_link.rb +14 -19
  96. data/lib/ElasticEmail/models/export_status.rb +1 -1
  97. data/lib/ElasticEmail/models/file_info.rb +14 -19
  98. data/lib/ElasticEmail/models/file_payload.rb +16 -19
  99. data/lib/ElasticEmail/models/file_upload_result.rb +14 -19
  100. data/lib/ElasticEmail/models/inbound_payload.rb +18 -19
  101. data/lib/ElasticEmail/models/inbound_route.rb +14 -19
  102. data/lib/ElasticEmail/models/inbound_route_action_type.rb +1 -1
  103. data/lib/ElasticEmail/models/inbound_route_filter_type.rb +1 -1
  104. data/lib/ElasticEmail/models/list_payload.rb +16 -19
  105. data/lib/ElasticEmail/models/list_update_payload.rb +14 -19
  106. data/lib/ElasticEmail/models/log_job_status.rb +1 -1
  107. data/lib/ElasticEmail/models/log_status_summary.rb +14 -19
  108. data/lib/ElasticEmail/models/merge_email_payload.rb +23 -19
  109. data/lib/ElasticEmail/models/message_attachment.rb +18 -19
  110. data/lib/ElasticEmail/models/message_category.rb +1 -1
  111. data/lib/ElasticEmail/models/message_category_enum.rb +55 -0
  112. data/lib/ElasticEmail/models/new_api_key.rb +14 -19
  113. data/lib/ElasticEmail/models/new_smtp_credentials.rb +14 -19
  114. data/lib/ElasticEmail/models/options.rb +16 -19
  115. data/lib/ElasticEmail/models/recipient_event.rb +14 -19
  116. data/lib/ElasticEmail/models/segment.rb +14 -19
  117. data/lib/ElasticEmail/models/segment_payload.rb +18 -19
  118. data/lib/ElasticEmail/models/smtp_credentials.rb +14 -19
  119. data/lib/ElasticEmail/models/smtp_credentials_payload.rb +16 -19
  120. data/lib/ElasticEmail/models/sort_order_item.rb +18 -19
  121. data/lib/ElasticEmail/models/split_optimization_type.rb +1 -1
  122. data/lib/ElasticEmail/models/split_options.rb +14 -19
  123. data/lib/ElasticEmail/models/sub_account_info.rb +14 -19
  124. data/lib/ElasticEmail/models/subaccount_email_credits_payload.rb +16 -19
  125. data/lib/ElasticEmail/models/subaccount_email_settings.rb +14 -19
  126. data/lib/ElasticEmail/models/subaccount_email_settings_payload.rb +14 -19
  127. data/lib/ElasticEmail/models/subaccount_payload.rb +18 -19
  128. data/lib/ElasticEmail/models/subaccount_settings_info.rb +14 -19
  129. data/lib/ElasticEmail/models/subaccount_settings_info_payload.rb +14 -19
  130. data/lib/ElasticEmail/models/suppression.rb +14 -19
  131. data/lib/ElasticEmail/models/template.rb +14 -19
  132. data/lib/ElasticEmail/models/template_payload.rb +16 -19
  133. data/lib/ElasticEmail/models/template_scope.rb +1 -1
  134. data/lib/ElasticEmail/models/template_type.rb +4 -2
  135. data/lib/ElasticEmail/models/tracking_type.rb +44 -0
  136. data/lib/ElasticEmail/models/tracking_validation_status.rb +42 -0
  137. data/lib/ElasticEmail/models/transactional_recipient.rb +16 -19
  138. data/lib/ElasticEmail/models/utm.rb +14 -19
  139. data/lib/ElasticEmail/models/verification_file_result.rb +14 -19
  140. data/lib/ElasticEmail/models/verification_file_result_details.rb +14 -19
  141. data/lib/ElasticEmail/models/verification_status.rb +1 -1
  142. data/lib/ElasticEmail/version.rb +2 -2
  143. data/lib/ElasticEmail.rb +13 -1
  144. data/spec/api/campaigns_api_spec.rb +19 -7
  145. data/spec/api/contacts_api_spec.rb +12 -25
  146. data/spec/api/domains_api_spec.rb +132 -0
  147. data/spec/api/emails_api_spec.rb +29 -7
  148. data/spec/api/events_api_spec.rb +9 -9
  149. data/spec/api/files_api_spec.rb +7 -7
  150. data/spec/api/inbound_route_api_spec.rb +8 -8
  151. data/spec/api/lists_api_spec.rb +23 -9
  152. data/spec/api/security_api_spec.rb +12 -12
  153. data/spec/api/segments_api_spec.rb +7 -7
  154. data/spec/api/statistics_api_spec.rb +7 -7
  155. data/spec/api/sub_accounts_api_spec.rb +8 -8
  156. data/spec/api/suppressions_api_spec.rb +26 -26
  157. data/spec/api/templates_api_spec.rb +7 -7
  158. data/spec/api/verifications_api_spec.rb +30 -18
  159. data/spec/models/access_level_spec.rb +5 -3
  160. data/spec/models/account_status_enum_spec.rb +5 -3
  161. data/spec/models/api_key_payload_spec.rb +10 -8
  162. data/spec/models/api_key_spec.rb +11 -9
  163. data/spec/models/body_content_type_spec.rb +5 -3
  164. data/spec/models/body_part_spec.rb +8 -6
  165. data/spec/models/campaign_options_spec.rb +22 -8
  166. data/spec/models/campaign_recipient_spec.rb +7 -5
  167. data/spec/models/campaign_spec.rb +10 -8
  168. data/spec/models/campaign_status_spec.rb +5 -3
  169. data/spec/models/campaign_template_spec.rb +12 -10
  170. data/spec/{configuration_spec.rb → models/certificate_validation_status_spec.rb} +15 -27
  171. data/spec/models/channel_log_status_summary_spec.rb +19 -17
  172. data/spec/models/compression_format_spec.rb +5 -3
  173. data/spec/models/consent_data_spec.rb +8 -6
  174. data/spec/models/consent_tracking_spec.rb +5 -3
  175. data/spec/models/contact_activity_spec.rb +16 -14
  176. data/spec/models/contact_payload_spec.rb +11 -9
  177. data/spec/models/contact_source_spec.rb +5 -3
  178. data/spec/models/contact_spec.rb +16 -14
  179. data/spec/models/contact_status_spec.rb +5 -3
  180. data/spec/models/contact_update_payload_spec.rb +8 -6
  181. data/spec/models/contacts_list_spec.rb +9 -7
  182. data/spec/models/delivery_optimization_type_spec.rb +5 -3
  183. data/spec/models/domain_data_spec.rb +144 -0
  184. data/spec/models/domain_detail_spec.rb +138 -0
  185. data/spec/models/domain_owner_spec.rb +30 -0
  186. data/spec/models/domain_payload_spec.rb +42 -0
  187. data/spec/models/domain_update_payload_spec.rb +54 -0
  188. data/spec/models/email_content_spec.rb +22 -14
  189. data/spec/models/email_data_spec.rb +8 -6
  190. data/spec/models/email_job_failed_status_spec.rb +54 -0
  191. data/spec/models/email_job_status_spec.rb +150 -0
  192. data/spec/models/email_message_data_spec.rb +8 -6
  193. data/spec/models/email_predicted_validation_status_spec.rb +4 -2
  194. data/spec/models/email_recipient_spec.rb +7 -5
  195. data/spec/models/email_send_spec.rb +7 -5
  196. data/spec/models/email_status_spec.rb +23 -15
  197. data/spec/models/email_transactional_message_data_spec.rb +8 -6
  198. data/spec/models/email_validation_result_spec.rb +26 -12
  199. data/spec/models/email_validation_status_spec.rb +5 -3
  200. data/spec/models/email_view_spec.rb +8 -6
  201. data/spec/models/emails_payload_spec.rb +7 -5
  202. data/spec/models/encoding_type_spec.rb +5 -3
  203. data/spec/models/event_type_spec.rb +5 -3
  204. data/spec/models/events_order_by_spec.rb +5 -3
  205. data/spec/models/export_file_formats_spec.rb +5 -3
  206. data/spec/models/export_link_spec.rb +7 -5
  207. data/spec/models/export_status_spec.rb +5 -3
  208. data/spec/models/file_info_spec.rb +10 -8
  209. data/spec/models/file_payload_spec.rb +8 -6
  210. data/spec/models/file_upload_result_spec.rb +7 -5
  211. data/spec/models/inbound_payload_spec.rb +11 -9
  212. data/spec/models/inbound_route_action_type_spec.rb +5 -3
  213. data/spec/models/inbound_route_filter_type_spec.rb +5 -3
  214. data/spec/models/inbound_route_spec.rb +12 -10
  215. data/spec/models/list_payload_spec.rb +8 -6
  216. data/spec/models/list_update_payload_spec.rb +7 -5
  217. data/spec/models/log_job_status_spec.rb +5 -3
  218. data/spec/models/log_status_summary_spec.rb +18 -16
  219. data/spec/models/merge_email_payload_spec.rb +8 -6
  220. data/spec/models/message_attachment_spec.rb +14 -6
  221. data/spec/models/message_category_enum_spec.rb +30 -0
  222. data/spec/models/message_category_spec.rb +5 -3
  223. data/spec/models/new_api_key_spec.rb +12 -10
  224. data/spec/models/new_smtp_credentials_spec.rb +12 -10
  225. data/spec/models/options_spec.rb +11 -9
  226. data/spec/models/recipient_event_spec.rb +18 -16
  227. data/spec/models/segment_payload_spec.rb +7 -5
  228. data/spec/models/segment_spec.rb +7 -5
  229. data/spec/models/smtp_credentials_payload_spec.rb +9 -7
  230. data/spec/models/smtp_credentials_spec.rb +11 -9
  231. data/spec/models/sort_order_item_spec.rb +7 -5
  232. data/spec/models/split_optimization_type_spec.rb +5 -3
  233. data/spec/models/split_options_spec.rb +7 -5
  234. data/spec/models/sub_account_info_spec.rb +14 -12
  235. data/spec/models/subaccount_email_credits_payload_spec.rb +7 -5
  236. data/spec/models/subaccount_email_settings_payload_spec.rb +17 -9
  237. data/spec/models/subaccount_email_settings_spec.rb +18 -10
  238. data/spec/models/subaccount_payload_spec.rb +9 -7
  239. data/spec/models/subaccount_settings_info_payload_spec.rb +6 -4
  240. data/spec/models/subaccount_settings_info_spec.rb +6 -4
  241. data/spec/models/suppression_spec.rb +9 -7
  242. data/spec/models/template_payload_spec.rb +9 -7
  243. data/spec/models/template_scope_spec.rb +5 -3
  244. data/spec/models/template_spec.rb +11 -9
  245. data/spec/models/template_type_spec.rb +5 -3
  246. data/spec/models/tracking_type_spec.rb +30 -0
  247. data/spec/models/tracking_validation_status_spec.rb +30 -0
  248. data/spec/models/transactional_recipient_spec.rb +8 -6
  249. data/spec/models/utm_spec.rb +9 -7
  250. data/spec/models/verification_file_result_details_spec.rb +12 -10
  251. data/spec/models/verification_file_result_spec.rb +11 -9
  252. data/spec/models/verification_status_spec.rb +5 -3
  253. data/spec/spec_helper.rb +1 -1
  254. metadata +126 -94
  255. data/docs/ContactHistory.md +0 -30
  256. data/lib/ElasticEmail/models/contact_hist_event_type.rb +0 -49
  257. data/lib/ElasticEmail/models/template_scope_type.rb +0 -38
  258. data/spec/api_client_spec.rb +0 -226
  259. data/spec/models/contact_hist_event_type_spec.rb +0 -28
  260. data/spec/models/contact_history_spec.rb +0 -70
  261. data/spec/models/template_scope_type_spec.rb +0 -28
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '098d8c859460aa81d183ce017abe42f45e4d4d1accf612be137a8a164b7749f0'
4
- data.tar.gz: 6b41f3fdab2fc32657bfba092b9c14acc3b959f610f5ed9e77f2da89ad587f98
3
+ metadata.gz: a9ecf6eb6f47d9832e11cf38d1db2fc98c39f102ebc8bc04c8718bbf6747c55f
4
+ data.tar.gz: 279fa98c3e36a0651fce7a5fc52d45d23c27d626f3de8bdd7d4f972fa3fafef2
5
5
  SHA512:
6
- metadata.gz: 2d993c884f791ef79a00cb58fde2171e53dea89083e0623828ce9faece82c4fb4cd097e390efb2a4e20b59e707167358bfd8fd2c8ac651d31175477283bfea50
7
- data.tar.gz: 388ceb010b34402bc3359e48d12bcfdd39137983a2e6d8cc8fb75a62868e9eb94c8c66f659bcd85af6249f70e4fd56802557576b834e8dda07336007bea02823
6
+ metadata.gz: d6f3b3366b5dc1baf8cb871a0c688c8206f6e2d6d9a1ff87291bbabb4fabd3001365058ecd7875aa77d4b43828a3165684b5a6a2e5d0f11c4eea11c63f25aeb3
7
+ data.tar.gz: 7fb8a657c88a68b406350cbf30dbdc9bc3d7405308b5f478e3c39db6a68865ba4fcc0ccdd5c7f8bf3911596950ac23e365c8612872f21ba9ca1a807ee0ea253f
data/ElasticEmail.gemspec CHANGED
@@ -8,7 +8,7 @@
8
8
  The version of the OpenAPI document: 4.0.0
9
9
  Contact: support@elasticemail.com
10
10
  Generated by: https://openapi-generator.tech
11
- OpenAPI Generator version: 6.3.0
11
+ Generator version: 7.5.0
12
12
 
13
13
  =end
14
14
 
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
26
26
  s.description = "The Ruby library for the Elastic Email REST API. This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. To start using this API, you will need your Access Token. Remember to keep it safe."
27
27
  s.license = "Unlicense"
28
28
  s.required_ruby_version = ">= 2.7"
29
+ s.metadata = {}
29
30
 
30
31
  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
31
32
 
data/README.md CHANGED
@@ -15,7 +15,8 @@ Downloadable library clients can be found in our Github repository [here](https:
15
15
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
16
16
 
17
17
  - API version: 4.0.0
18
- - Package version: 4.0.23
18
+ - Package version: 4.0.25
19
+ - Generator version: 7.5.0
19
20
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
20
21
 
21
22
  ## Installation
@@ -31,16 +32,16 @@ gem build ElasticEmail.gemspec
31
32
  Then either install the gem locally:
32
33
 
33
34
  ```shell
34
- gem install ./ElasticEmail-4.0.23.gem
35
+ gem install ./ElasticEmail-4.0.25.gem
35
36
  ```
36
37
 
37
- (for development, run `gem install --dev ./ElasticEmail-4.0.23.gem` to install the development dependencies)
38
+ (for development, run `gem install --dev ./ElasticEmail-4.0.25.gem` to install the development dependencies)
38
39
 
39
40
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
40
41
 
41
42
  Finally add this to the Gemfile:
42
43
 
43
- gem 'ElasticEmail', '~> 4.0.23'
44
+ gem 'ElasticEmail', '~> 4.0.25'
44
45
 
45
46
  ### Install from Git
46
47
 
@@ -92,6 +93,7 @@ Class | Method | HTTP request | Description
92
93
  ------------ | ------------- | ------------- | -------------
93
94
  *ElasticEmail::CampaignsApi* | [**campaigns_by_name_delete**](docs/CampaignsApi.md#campaigns_by_name_delete) | **DELETE** /campaigns/{name} | Delete Campaign
94
95
  *ElasticEmail::CampaignsApi* | [**campaigns_by_name_get**](docs/CampaignsApi.md#campaigns_by_name_get) | **GET** /campaigns/{name} | Load Campaign
96
+ *ElasticEmail::CampaignsApi* | [**campaigns_by_name_pause_put**](docs/CampaignsApi.md#campaigns_by_name_pause_put) | **PUT** /campaigns/{name}/pause | Pause Campaign
95
97
  *ElasticEmail::CampaignsApi* | [**campaigns_by_name_put**](docs/CampaignsApi.md#campaigns_by_name_put) | **PUT** /campaigns/{name} | Update Campaign
96
98
  *ElasticEmail::CampaignsApi* | [**campaigns_get**](docs/CampaignsApi.md#campaigns_get) | **GET** /campaigns | Load Campaigns
97
99
  *ElasticEmail::CampaignsApi* | [**campaigns_post**](docs/CampaignsApi.md#campaigns_post) | **POST** /campaigns | Add Campaign
@@ -104,7 +106,16 @@ Class | Method | HTTP request | Description
104
106
  *ElasticEmail::ContactsApi* | [**contacts_get**](docs/ContactsApi.md#contacts_get) | **GET** /contacts | Load Contacts
105
107
  *ElasticEmail::ContactsApi* | [**contacts_import_post**](docs/ContactsApi.md#contacts_import_post) | **POST** /contacts/import | Upload Contacts
106
108
  *ElasticEmail::ContactsApi* | [**contacts_post**](docs/ContactsApi.md#contacts_post) | **POST** /contacts | Add Contact
109
+ *ElasticEmail::DomainsApi* | [**domains_by_domain_delete**](docs/DomainsApi.md#domains_by_domain_delete) | **DELETE** /domains/{domain} | Delete Domain
110
+ *ElasticEmail::DomainsApi* | [**domains_by_domain_get**](docs/DomainsApi.md#domains_by_domain_get) | **GET** /domains/{domain} | Load Domain
111
+ *ElasticEmail::DomainsApi* | [**domains_by_domain_put**](docs/DomainsApi.md#domains_by_domain_put) | **PUT** /domains/{domain} | Update Domain
112
+ *ElasticEmail::DomainsApi* | [**domains_by_domain_restricted_get**](docs/DomainsApi.md#domains_by_domain_restricted_get) | **GET** /domains/{domain}/restricted | Check for domain restriction
113
+ *ElasticEmail::DomainsApi* | [**domains_by_domain_verification_put**](docs/DomainsApi.md#domains_by_domain_verification_put) | **PUT** /domains/{domain}/verification | Verify Domain
114
+ *ElasticEmail::DomainsApi* | [**domains_by_email_default_patch**](docs/DomainsApi.md#domains_by_email_default_patch) | **PATCH** /domains/{email}/default | Set Default
115
+ *ElasticEmail::DomainsApi* | [**domains_get**](docs/DomainsApi.md#domains_get) | **GET** /domains | Load Domains
116
+ *ElasticEmail::DomainsApi* | [**domains_post**](docs/DomainsApi.md#domains_post) | **POST** /domains | Add Domain
107
117
  *ElasticEmail::EmailsApi* | [**emails_by_msgid_view_get**](docs/EmailsApi.md#emails_by_msgid_view_get) | **GET** /emails/{msgid}/view | View Email
118
+ *ElasticEmail::EmailsApi* | [**emails_by_transactionid_status_get**](docs/EmailsApi.md#emails_by_transactionid_status_get) | **GET** /emails/{transactionid}/status | Get Status
108
119
  *ElasticEmail::EmailsApi* | [**emails_mergefile_post**](docs/EmailsApi.md#emails_mergefile_post) | **POST** /emails/mergefile | Send Bulk Emails CSV
109
120
  *ElasticEmail::EmailsApi* | [**emails_post**](docs/EmailsApi.md#emails_post) | **POST** /emails | Send Bulk Emails
110
121
  *ElasticEmail::EmailsApi* | [**emails_transactional_post**](docs/EmailsApi.md#emails_transactional_post) | **POST** /emails/transactional | Send Transactional Email
@@ -126,6 +137,7 @@ Class | Method | HTTP request | Description
126
137
  *ElasticEmail::InboundRouteApi* | [**inboundroute_get**](docs/InboundRouteApi.md#inboundroute_get) | **GET** /inboundroute | Get Routes
127
138
  *ElasticEmail::InboundRouteApi* | [**inboundroute_order_put**](docs/InboundRouteApi.md#inboundroute_order_put) | **PUT** /inboundroute/order | Update Sorting
128
139
  *ElasticEmail::InboundRouteApi* | [**inboundroute_post**](docs/InboundRouteApi.md#inboundroute_post) | **POST** /inboundroute | Create Route
140
+ *ElasticEmail::ListsApi* | [**lists_by_listname_contacts_get**](docs/ListsApi.md#lists_by_listname_contacts_get) | **GET** /lists/{listname}/contacts | Load Contacts in List
129
141
  *ElasticEmail::ListsApi* | [**lists_by_name_contacts_post**](docs/ListsApi.md#lists_by_name_contacts_post) | **POST** /lists/{name}/contacts | Add Contacts to List
130
142
  *ElasticEmail::ListsApi* | [**lists_by_name_contacts_remove_post**](docs/ListsApi.md#lists_by_name_contacts_remove_post) | **POST** /lists/{name}/contacts/remove | Remove Contacts from List
131
143
  *ElasticEmail::ListsApi* | [**lists_by_name_delete**](docs/ListsApi.md#lists_by_name_delete) | **DELETE** /lists/{name} | Delete List
@@ -201,6 +213,7 @@ Class | Method | HTTP request | Description
201
213
  - [ElasticEmail::CampaignRecipient](docs/CampaignRecipient.md)
202
214
  - [ElasticEmail::CampaignStatus](docs/CampaignStatus.md)
203
215
  - [ElasticEmail::CampaignTemplate](docs/CampaignTemplate.md)
216
+ - [ElasticEmail::CertificateValidationStatus](docs/CertificateValidationStatus.md)
204
217
  - [ElasticEmail::ChannelLogStatusSummary](docs/ChannelLogStatusSummary.md)
205
218
  - [ElasticEmail::CompressionFormat](docs/CompressionFormat.md)
206
219
  - [ElasticEmail::ConsentData](docs/ConsentData.md)
@@ -213,8 +226,15 @@ Class | Method | HTTP request | Description
213
226
  - [ElasticEmail::ContactUpdatePayload](docs/ContactUpdatePayload.md)
214
227
  - [ElasticEmail::ContactsList](docs/ContactsList.md)
215
228
  - [ElasticEmail::DeliveryOptimizationType](docs/DeliveryOptimizationType.md)
229
+ - [ElasticEmail::DomainData](docs/DomainData.md)
230
+ - [ElasticEmail::DomainDetail](docs/DomainDetail.md)
231
+ - [ElasticEmail::DomainOwner](docs/DomainOwner.md)
232
+ - [ElasticEmail::DomainPayload](docs/DomainPayload.md)
233
+ - [ElasticEmail::DomainUpdatePayload](docs/DomainUpdatePayload.md)
216
234
  - [ElasticEmail::EmailContent](docs/EmailContent.md)
217
235
  - [ElasticEmail::EmailData](docs/EmailData.md)
236
+ - [ElasticEmail::EmailJobFailedStatus](docs/EmailJobFailedStatus.md)
237
+ - [ElasticEmail::EmailJobStatus](docs/EmailJobStatus.md)
218
238
  - [ElasticEmail::EmailMessageData](docs/EmailMessageData.md)
219
239
  - [ElasticEmail::EmailPredictedValidationStatus](docs/EmailPredictedValidationStatus.md)
220
240
  - [ElasticEmail::EmailRecipient](docs/EmailRecipient.md)
@@ -245,6 +265,7 @@ Class | Method | HTTP request | Description
245
265
  - [ElasticEmail::MergeEmailPayload](docs/MergeEmailPayload.md)
246
266
  - [ElasticEmail::MessageAttachment](docs/MessageAttachment.md)
247
267
  - [ElasticEmail::MessageCategory](docs/MessageCategory.md)
268
+ - [ElasticEmail::MessageCategoryEnum](docs/MessageCategoryEnum.md)
248
269
  - [ElasticEmail::NewApiKey](docs/NewApiKey.md)
249
270
  - [ElasticEmail::NewSmtpCredentials](docs/NewSmtpCredentials.md)
250
271
  - [ElasticEmail::Options](docs/Options.md)
@@ -268,6 +289,8 @@ Class | Method | HTTP request | Description
268
289
  - [ElasticEmail::TemplatePayload](docs/TemplatePayload.md)
269
290
  - [ElasticEmail::TemplateScope](docs/TemplateScope.md)
270
291
  - [ElasticEmail::TemplateType](docs/TemplateType.md)
292
+ - [ElasticEmail::TrackingType](docs/TrackingType.md)
293
+ - [ElasticEmail::TrackingValidationStatus](docs/TrackingValidationStatus.md)
271
294
  - [ElasticEmail::TransactionalRecipient](docs/TransactionalRecipient.md)
272
295
  - [ElasticEmail::Utm](docs/Utm.md)
273
296
  - [ElasticEmail::VerificationFileResult](docs/VerificationFileResult.md)
@@ -278,6 +301,7 @@ Class | Method | HTTP request | Description
278
301
  ## Documentation for Authorization
279
302
 
280
303
 
304
+ Authentication schemes defined for the API:
281
305
  ### apikey
282
306
 
283
307
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 4.0.23
1
+ 4.0.25
@@ -8,6 +8,8 @@
8
8
  | **track_opens** | **Boolean** | Should the opens be tracked? If no value has been provided, Account's default setting will be used. | [optional] |
9
9
  | **track_clicks** | **Boolean** | Should the clicks be tracked? If no value has been provided, Account's default setting will be used. | [optional] |
10
10
  | **schedule_for** | **Time** | Date when this Campaign is scheduled to be sent on | [optional] |
11
+ | **trigger_frequency** | **Float** | How often (in minutes) to send the campaign | [optional] |
12
+ | **trigger_count** | **Integer** | How many times send the campaign | [optional] |
11
13
  | **split_options** | [**SplitOptions**](SplitOptions.md) | | [optional] |
12
14
 
13
15
  ## Example
@@ -20,6 +22,8 @@ instance = ElasticEmail::CampaignOptions.new(
20
22
  track_opens: true,
21
23
  track_clicks: true,
22
24
  schedule_for: null,
25
+ trigger_frequency: null,
26
+ trigger_count: null,
23
27
  split_options: null
24
28
  )
25
29
  ```
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **poolname** | **String** | Name of your custom IP Pool to be used in the sending process | [optional] |
8
- | **from** | **String** | Your e-mail with an optional name (e.g.: John Doe <email@domain.com>) | [optional] |
8
+ | **from** | **String** | Your e-mail with an optional name (e.g.: John Doe <email@domain.com>) | |
9
9
  | **reply_to** | **String** | To what address should the recipients reply to (e.g. John Doe <email@domain.com>) | [optional] |
10
10
  | **subject** | **String** | Default subject of email. | [optional] |
11
11
  | **template_name** | **String** | Name of template. | [optional] |
@@ -23,7 +23,7 @@ instance = ElasticEmail::CampaignTemplate.new(
23
23
  reply_to: John Doe <email@domain.com>,
24
24
  subject: Hello!,
25
25
  template_name: Template01,
26
- attach_files: [ "preuploaded.jpg" ],
26
+ attach_files: ["preuploaded.jpg"],
27
27
  utm: null
28
28
  )
29
29
  ```
data/docs/CampaignsApi.md CHANGED
@@ -6,6 +6,7 @@ All URIs are relative to *https://api.elasticemail.com/v4*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**campaigns_by_name_delete**](CampaignsApi.md#campaigns_by_name_delete) | **DELETE** /campaigns/{name} | Delete Campaign |
8
8
  | [**campaigns_by_name_get**](CampaignsApi.md#campaigns_by_name_get) | **GET** /campaigns/{name} | Load Campaign |
9
+ | [**campaigns_by_name_pause_put**](CampaignsApi.md#campaigns_by_name_pause_put) | **PUT** /campaigns/{name}/pause | Pause Campaign |
9
10
  | [**campaigns_by_name_put**](CampaignsApi.md#campaigns_by_name_put) | **PUT** /campaigns/{name} | Update Campaign |
10
11
  | [**campaigns_get**](CampaignsApi.md#campaigns_get) | **GET** /campaigns | Load Campaigns |
11
12
  | [**campaigns_post**](CampaignsApi.md#campaigns_post) | **POST** /campaigns | Add Campaign |
@@ -152,6 +153,76 @@ end
152
153
  - **Accept**: application/json
153
154
 
154
155
 
156
+ ## campaigns_by_name_pause_put
157
+
158
+ > campaigns_by_name_pause_put(name)
159
+
160
+ Pause Campaign
161
+
162
+ Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns
163
+
164
+ ### Examples
165
+
166
+ ```ruby
167
+ require 'time'
168
+ require 'ElasticEmail'
169
+ # setup authorization
170
+ ElasticEmail.configure do |config|
171
+ # Configure API key authorization: apikey
172
+ config.api_key['apikey'] = 'YOUR API KEY'
173
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
174
+ # config.api_key_prefix['apikey'] = 'Bearer'
175
+ end
176
+
177
+ api_instance = ElasticEmail::CampaignsApi.new
178
+ name = 'name_example' # String | Name of Campaign to pause
179
+
180
+ begin
181
+ # Pause Campaign
182
+ api_instance.campaigns_by_name_pause_put(name)
183
+ rescue ElasticEmail::ApiError => e
184
+ puts "Error when calling CampaignsApi->campaigns_by_name_pause_put: #{e}"
185
+ end
186
+ ```
187
+
188
+ #### Using the campaigns_by_name_pause_put_with_http_info variant
189
+
190
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
191
+
192
+ > <Array(nil, Integer, Hash)> campaigns_by_name_pause_put_with_http_info(name)
193
+
194
+ ```ruby
195
+ begin
196
+ # Pause Campaign
197
+ data, status_code, headers = api_instance.campaigns_by_name_pause_put_with_http_info(name)
198
+ p status_code # => 2xx
199
+ p headers # => { ... }
200
+ p data # => nil
201
+ rescue ElasticEmail::ApiError => e
202
+ puts "Error when calling CampaignsApi->campaigns_by_name_pause_put_with_http_info: #{e}"
203
+ end
204
+ ```
205
+
206
+ ### Parameters
207
+
208
+ | Name | Type | Description | Notes |
209
+ | ---- | ---- | ----------- | ----- |
210
+ | **name** | **String** | Name of Campaign to pause | |
211
+
212
+ ### Return type
213
+
214
+ nil (empty response body)
215
+
216
+ ### Authorization
217
+
218
+ [apikey](../README.md#apikey)
219
+
220
+ ### HTTP request headers
221
+
222
+ - **Content-Type**: Not defined
223
+ - **Accept**: Not defined
224
+
225
+
155
226
  ## campaigns_by_name_put
156
227
 
157
228
  > <Campaign> campaigns_by_name_put(name, campaign)
@@ -0,0 +1,15 @@
1
+ # ElasticEmail::CertificateValidationStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'ElasticEmail'
12
+
13
+ instance = ElasticEmail::CertificateValidationStatus.new()
14
+ ```
15
+
@@ -0,0 +1,54 @@
1
+ # ElasticEmail::DomainData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **validation_log** | **String** | Domain validation results - when domain has been running through validation process | [optional] |
8
+ | **domain** | **String** | Name of selected domain. | [optional] |
9
+ | **default_domain** | **Boolean** | True, if domain is used as default. Otherwise, false, | [optional] |
10
+ | **spf** | **Boolean** | True, if SPF record is verified | [optional] |
11
+ | **dkim** | **Boolean** | True, if DKIM record is verified | [optional] |
12
+ | **mx** | **Boolean** | True, if MX record is verified | [optional] |
13
+ | **dmarc** | **Boolean** | | [optional] |
14
+ | **is_rewrite_domain_valid** | **Boolean** | True, if tracking CNAME record is verified | [optional] |
15
+ | **verify** | **Boolean** | True, if DKIM, SPF, or tracking are still to be verified | [optional] |
16
+ | **type** | [**TrackingType**](TrackingType.md) | | [optional][default to &#39;None&#39;] |
17
+ | **tracking_status** | [**TrackingValidationStatus**](TrackingValidationStatus.md) | | [optional][default to &#39;Validated&#39;] |
18
+ | **certificate_status** | [**CertificateValidationStatus**](CertificateValidationStatus.md) | | [optional][default to &#39;ErrorOccured&#39;] |
19
+ | **certificate_validation_error** | **String** | | [optional] |
20
+ | **tracking_type_user_request** | [**TrackingType**](TrackingType.md) | | [optional][default to &#39;None&#39;] |
21
+ | **verp** | **Boolean** | | [optional] |
22
+ | **custom_bounces_domain** | **String** | | [optional] |
23
+ | **is_custom_bounces_domain_default** | **Boolean** | | [optional] |
24
+ | **is_marked_for_deletion** | **Boolean** | | [optional] |
25
+ | **ownership** | [**DomainOwner**](DomainOwner.md) | | [optional][default to &#39;Current&#39;] |
26
+
27
+ ## Example
28
+
29
+ ```ruby
30
+ require 'ElasticEmail'
31
+
32
+ instance = ElasticEmail::DomainData.new(
33
+ validation_log: null,
34
+ domain: example.com,
35
+ default_domain: null,
36
+ spf: true,
37
+ dkim: true,
38
+ mx: true,
39
+ dmarc: null,
40
+ is_rewrite_domain_valid: true,
41
+ verify: true,
42
+ type: null,
43
+ tracking_status: null,
44
+ certificate_status: null,
45
+ certificate_validation_error: null,
46
+ tracking_type_user_request: null,
47
+ verp: null,
48
+ custom_bounces_domain: null,
49
+ is_custom_bounces_domain_default: null,
50
+ is_marked_for_deletion: null,
51
+ ownership: null
52
+ )
53
+ ```
54
+
@@ -0,0 +1,52 @@
1
+ # ElasticEmail::DomainDetail
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **domain** | **String** | Name of selected domain. | [optional] |
8
+ | **default_domain** | **Boolean** | True, if domain is used as default. Otherwise, false, | [optional] |
9
+ | **spf** | **Boolean** | True, if SPF record is verified | [optional] |
10
+ | **dkim** | **Boolean** | True, if DKIM record is verified | [optional] |
11
+ | **mx** | **Boolean** | True, if MX record is verified | [optional] |
12
+ | **dmarc** | **Boolean** | | [optional] |
13
+ | **is_rewrite_domain_valid** | **Boolean** | True, if tracking CNAME record is verified | [optional] |
14
+ | **verify** | **Boolean** | True, if DKIM, SPF, or tracking are still to be verified | [optional] |
15
+ | **type** | [**TrackingType**](TrackingType.md) | | [optional][default to &#39;None&#39;] |
16
+ | **tracking_status** | [**TrackingValidationStatus**](TrackingValidationStatus.md) | | [optional][default to &#39;Validated&#39;] |
17
+ | **certificate_status** | [**CertificateValidationStatus**](CertificateValidationStatus.md) | | [optional][default to &#39;ErrorOccured&#39;] |
18
+ | **certificate_validation_error** | **String** | | [optional] |
19
+ | **tracking_type_user_request** | [**TrackingType**](TrackingType.md) | | [optional][default to &#39;None&#39;] |
20
+ | **verp** | **Boolean** | | [optional] |
21
+ | **custom_bounces_domain** | **String** | | [optional] |
22
+ | **is_custom_bounces_domain_default** | **Boolean** | | [optional] |
23
+ | **is_marked_for_deletion** | **Boolean** | | [optional] |
24
+ | **ownership** | [**DomainOwner**](DomainOwner.md) | | [optional][default to &#39;Current&#39;] |
25
+
26
+ ## Example
27
+
28
+ ```ruby
29
+ require 'ElasticEmail'
30
+
31
+ instance = ElasticEmail::DomainDetail.new(
32
+ domain: example.com,
33
+ default_domain: null,
34
+ spf: true,
35
+ dkim: true,
36
+ mx: true,
37
+ dmarc: null,
38
+ is_rewrite_domain_valid: true,
39
+ verify: true,
40
+ type: null,
41
+ tracking_status: null,
42
+ certificate_status: null,
43
+ certificate_validation_error: null,
44
+ tracking_type_user_request: null,
45
+ verp: null,
46
+ custom_bounces_domain: null,
47
+ is_custom_bounces_domain_default: null,
48
+ is_marked_for_deletion: null,
49
+ ownership: null
50
+ )
51
+ ```
52
+
@@ -1,4 +1,4 @@
1
- # ElasticEmail::TemplateScopeType
1
+ # ElasticEmail::DomainOwner
2
2
 
3
3
  ## Properties
4
4
 
@@ -10,6 +10,6 @@
10
10
  ```ruby
11
11
  require 'ElasticEmail'
12
12
 
13
- instance = ElasticEmail::TemplateScopeType.new()
13
+ instance = ElasticEmail::DomainOwner.new()
14
14
  ```
15
15
 
@@ -0,0 +1,20 @@
1
+ # ElasticEmail::DomainPayload
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **domain** | **String** | Name of selected domain. | [optional] |
8
+ | **set_as_default** | **Boolean** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ElasticEmail'
14
+
15
+ instance = ElasticEmail::DomainPayload.new(
16
+ domain: example.com,
17
+ set_as_default: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # ElasticEmail::DomainUpdatePayload
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **certificate_status** | [**CertificateValidationStatus**](CertificateValidationStatus.md) | | [optional][default to &#39;ErrorOccured&#39;] |
8
+ | **verp** | **Boolean** | | [optional] |
9
+ | **custom_bounces_domain** | **String** | | [optional] |
10
+ | **is_custom_bounces_domain_default** | **Boolean** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ElasticEmail'
16
+
17
+ instance = ElasticEmail::DomainUpdatePayload.new(
18
+ certificate_status: null,
19
+ verp: null,
20
+ custom_bounces_domain: null,
21
+ is_custom_bounces_domain_default: null
22
+ )
23
+ ```
24
+