ElasticEmail 4.0.23 → 4.0.24

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 (232) hide show
  1. checksums.yaml +4 -4
  2. data/ElasticEmail.gemspec +2 -1
  3. data/README.md +10 -4
  4. data/VERSION +1 -1
  5. data/docs/CampaignOptions.md +4 -0
  6. data/docs/CampaignTemplate.md +2 -2
  7. data/docs/EmailContent.md +2 -2
  8. data/docs/EmailJobFailedStatus.md +24 -0
  9. data/docs/EmailJobStatus.md +56 -0
  10. data/docs/EmailMessageData.md +1 -1
  11. data/docs/EmailTransactionalMessageData.md +1 -1
  12. data/docs/EmailValidationResult.md +2 -2
  13. data/docs/EmailsApi.md +97 -3
  14. data/docs/EmailsPayload.md +1 -1
  15. data/docs/ListPayload.md +1 -1
  16. data/docs/ListsApi.md +78 -0
  17. data/docs/MergeEmailPayload.md +1 -1
  18. data/lib/ElasticEmail/api/campaigns_api.rb +1 -1
  19. data/lib/ElasticEmail/api/contacts_api.rb +1 -1
  20. data/lib/ElasticEmail/api/emails_api.rb +94 -1
  21. data/lib/ElasticEmail/api/events_api.rb +1 -1
  22. data/lib/ElasticEmail/api/files_api.rb +1 -1
  23. data/lib/ElasticEmail/api/inbound_route_api.rb +1 -1
  24. data/lib/ElasticEmail/api/lists_api.rb +70 -1
  25. data/lib/ElasticEmail/api/security_api.rb +1 -1
  26. data/lib/ElasticEmail/api/segments_api.rb +1 -1
  27. data/lib/ElasticEmail/api/statistics_api.rb +1 -1
  28. data/lib/ElasticEmail/api/sub_accounts_api.rb +1 -1
  29. data/lib/ElasticEmail/api/suppressions_api.rb +1 -1
  30. data/lib/ElasticEmail/api/templates_api.rb +1 -1
  31. data/lib/ElasticEmail/api/verifications_api.rb +1 -1
  32. data/lib/ElasticEmail/api_client.rb +25 -23
  33. data/lib/ElasticEmail/api_error.rb +1 -1
  34. data/lib/ElasticEmail/configuration.rb +28 -10
  35. data/lib/ElasticEmail/models/access_level.rb +3 -3
  36. data/lib/ElasticEmail/models/account_status_enum.rb +1 -1
  37. data/lib/ElasticEmail/models/api_key.rb +14 -19
  38. data/lib/ElasticEmail/models/api_key_payload.rb +18 -19
  39. data/lib/ElasticEmail/models/body_content_type.rb +1 -1
  40. data/lib/ElasticEmail/models/body_part.rb +14 -19
  41. data/lib/ElasticEmail/models/campaign.rb +18 -19
  42. data/lib/ElasticEmail/models/campaign_options.rb +35 -20
  43. data/lib/ElasticEmail/models/campaign_recipient.rb +14 -19
  44. data/lib/ElasticEmail/models/campaign_status.rb +1 -1
  45. data/lib/ElasticEmail/models/campaign_template.rb +21 -19
  46. data/lib/ElasticEmail/models/channel_log_status_summary.rb +14 -19
  47. data/lib/ElasticEmail/models/compression_format.rb +1 -1
  48. data/lib/ElasticEmail/models/consent_data.rb +14 -19
  49. data/lib/ElasticEmail/models/consent_tracking.rb +1 -1
  50. data/lib/ElasticEmail/models/contact.rb +14 -19
  51. data/lib/ElasticEmail/models/contact_activity.rb +14 -19
  52. data/lib/ElasticEmail/models/contact_payload.rb +16 -19
  53. data/lib/ElasticEmail/models/contact_source.rb +1 -1
  54. data/lib/ElasticEmail/models/contact_status.rb +1 -1
  55. data/lib/ElasticEmail/models/contact_update_payload.rb +14 -19
  56. data/lib/ElasticEmail/models/contacts_list.rb +14 -19
  57. data/lib/ElasticEmail/models/delivery_optimization_type.rb +1 -1
  58. data/lib/ElasticEmail/models/email_content.rb +21 -19
  59. data/lib/ElasticEmail/models/email_data.rb +14 -19
  60. data/lib/ElasticEmail/models/{contact_history.rb → email_job_failed_status.rb} +44 -83
  61. data/lib/ElasticEmail/models/email_job_status.rb +415 -0
  62. data/lib/ElasticEmail/models/email_message_data.rb +23 -19
  63. data/lib/ElasticEmail/models/email_predicted_validation_status.rb +1 -1
  64. data/lib/ElasticEmail/models/email_recipient.rb +16 -19
  65. data/lib/ElasticEmail/models/email_send.rb +14 -19
  66. data/lib/ElasticEmail/models/email_status.rb +14 -19
  67. data/lib/ElasticEmail/models/email_transactional_message_data.rb +23 -19
  68. data/lib/ElasticEmail/models/email_validation_result.rb +16 -20
  69. data/lib/ElasticEmail/models/email_validation_status.rb +1 -1
  70. data/lib/ElasticEmail/models/email_view.rb +14 -19
  71. data/lib/ElasticEmail/models/emails_payload.rb +14 -19
  72. data/lib/ElasticEmail/models/encoding_type.rb +1 -1
  73. data/lib/ElasticEmail/models/event_type.rb +1 -1
  74. data/lib/ElasticEmail/models/events_order_by.rb +1 -1
  75. data/lib/ElasticEmail/models/export_file_formats.rb +1 -1
  76. data/lib/ElasticEmail/models/export_link.rb +14 -19
  77. data/lib/ElasticEmail/models/export_status.rb +1 -1
  78. data/lib/ElasticEmail/models/file_info.rb +14 -19
  79. data/lib/ElasticEmail/models/file_payload.rb +16 -19
  80. data/lib/ElasticEmail/models/file_upload_result.rb +14 -19
  81. data/lib/ElasticEmail/models/inbound_payload.rb +18 -19
  82. data/lib/ElasticEmail/models/inbound_route.rb +14 -19
  83. data/lib/ElasticEmail/models/inbound_route_action_type.rb +1 -1
  84. data/lib/ElasticEmail/models/inbound_route_filter_type.rb +1 -1
  85. data/lib/ElasticEmail/models/list_payload.rb +16 -19
  86. data/lib/ElasticEmail/models/list_update_payload.rb +14 -19
  87. data/lib/ElasticEmail/models/log_job_status.rb +1 -1
  88. data/lib/ElasticEmail/models/log_status_summary.rb +14 -19
  89. data/lib/ElasticEmail/models/merge_email_payload.rb +23 -19
  90. data/lib/ElasticEmail/models/message_attachment.rb +18 -19
  91. data/lib/ElasticEmail/models/message_category.rb +1 -1
  92. data/lib/ElasticEmail/models/new_api_key.rb +14 -19
  93. data/lib/ElasticEmail/models/new_smtp_credentials.rb +14 -19
  94. data/lib/ElasticEmail/models/options.rb +16 -19
  95. data/lib/ElasticEmail/models/recipient_event.rb +14 -19
  96. data/lib/ElasticEmail/models/segment.rb +14 -19
  97. data/lib/ElasticEmail/models/segment_payload.rb +18 -19
  98. data/lib/ElasticEmail/models/smtp_credentials.rb +14 -19
  99. data/lib/ElasticEmail/models/smtp_credentials_payload.rb +16 -19
  100. data/lib/ElasticEmail/models/sort_order_item.rb +18 -19
  101. data/lib/ElasticEmail/models/split_optimization_type.rb +1 -1
  102. data/lib/ElasticEmail/models/split_options.rb +14 -19
  103. data/lib/ElasticEmail/models/sub_account_info.rb +14 -19
  104. data/lib/ElasticEmail/models/subaccount_email_credits_payload.rb +16 -19
  105. data/lib/ElasticEmail/models/subaccount_email_settings.rb +14 -19
  106. data/lib/ElasticEmail/models/subaccount_email_settings_payload.rb +14 -19
  107. data/lib/ElasticEmail/models/subaccount_payload.rb +18 -19
  108. data/lib/ElasticEmail/models/subaccount_settings_info.rb +14 -19
  109. data/lib/ElasticEmail/models/subaccount_settings_info_payload.rb +14 -19
  110. data/lib/ElasticEmail/models/suppression.rb +14 -19
  111. data/lib/ElasticEmail/models/template.rb +14 -19
  112. data/lib/ElasticEmail/models/template_payload.rb +16 -19
  113. data/lib/ElasticEmail/models/template_scope.rb +1 -1
  114. data/lib/ElasticEmail/models/template_type.rb +3 -2
  115. data/lib/ElasticEmail/models/transactional_recipient.rb +16 -19
  116. data/lib/ElasticEmail/models/utm.rb +14 -19
  117. data/lib/ElasticEmail/models/verification_file_result.rb +14 -19
  118. data/lib/ElasticEmail/models/verification_file_result_details.rb +14 -19
  119. data/lib/ElasticEmail/models/verification_status.rb +1 -1
  120. data/lib/ElasticEmail/version.rb +2 -2
  121. data/lib/ElasticEmail.rb +3 -1
  122. data/spec/api/campaigns_api_spec.rb +7 -7
  123. data/spec/api/contacts_api_spec.rb +12 -25
  124. data/spec/api/emails_api_spec.rb +28 -6
  125. data/spec/api/events_api_spec.rb +9 -9
  126. data/spec/api/files_api_spec.rb +7 -7
  127. data/spec/api/inbound_route_api_spec.rb +8 -8
  128. data/spec/api/lists_api_spec.rb +23 -9
  129. data/spec/api/security_api_spec.rb +12 -12
  130. data/spec/api/segments_api_spec.rb +7 -7
  131. data/spec/api/statistics_api_spec.rb +7 -7
  132. data/spec/api/sub_accounts_api_spec.rb +8 -8
  133. data/spec/api/suppressions_api_spec.rb +26 -26
  134. data/spec/api/templates_api_spec.rb +7 -7
  135. data/spec/api/verifications_api_spec.rb +30 -18
  136. data/spec/models/access_level_spec.rb +5 -3
  137. data/spec/models/account_status_enum_spec.rb +5 -3
  138. data/spec/models/api_key_payload_spec.rb +10 -8
  139. data/spec/models/api_key_spec.rb +11 -9
  140. data/spec/models/body_content_type_spec.rb +5 -3
  141. data/spec/models/body_part_spec.rb +8 -6
  142. data/spec/models/campaign_options_spec.rb +22 -8
  143. data/spec/models/campaign_recipient_spec.rb +7 -5
  144. data/spec/models/campaign_spec.rb +10 -8
  145. data/spec/models/campaign_status_spec.rb +5 -3
  146. data/spec/models/campaign_template_spec.rb +12 -10
  147. data/spec/models/channel_log_status_summary_spec.rb +19 -17
  148. data/spec/models/compression_format_spec.rb +5 -3
  149. data/spec/models/consent_data_spec.rb +8 -6
  150. data/spec/models/consent_tracking_spec.rb +5 -3
  151. data/spec/models/contact_activity_spec.rb +16 -14
  152. data/spec/models/contact_payload_spec.rb +11 -9
  153. data/spec/models/contact_source_spec.rb +5 -3
  154. data/spec/models/contact_spec.rb +16 -14
  155. data/spec/models/contact_status_spec.rb +5 -3
  156. data/spec/models/contact_update_payload_spec.rb +8 -6
  157. data/spec/models/contacts_list_spec.rb +9 -7
  158. data/spec/models/delivery_optimization_type_spec.rb +5 -3
  159. data/spec/models/email_content_spec.rb +22 -14
  160. data/spec/models/email_data_spec.rb +8 -6
  161. data/spec/models/email_job_failed_status_spec.rb +54 -0
  162. data/spec/models/email_job_status_spec.rb +150 -0
  163. data/spec/models/email_message_data_spec.rb +8 -6
  164. data/spec/models/email_predicted_validation_status_spec.rb +4 -2
  165. data/spec/models/email_recipient_spec.rb +7 -5
  166. data/spec/models/email_send_spec.rb +7 -5
  167. data/spec/models/email_status_spec.rb +17 -15
  168. data/spec/models/email_transactional_message_data_spec.rb +8 -6
  169. data/spec/models/email_validation_result_spec.rb +26 -12
  170. data/spec/models/email_validation_status_spec.rb +5 -3
  171. data/spec/models/email_view_spec.rb +8 -6
  172. data/spec/models/emails_payload_spec.rb +7 -5
  173. data/spec/models/encoding_type_spec.rb +5 -3
  174. data/spec/models/event_type_spec.rb +5 -3
  175. data/spec/models/events_order_by_spec.rb +5 -3
  176. data/spec/models/export_file_formats_spec.rb +5 -3
  177. data/spec/models/export_link_spec.rb +7 -5
  178. data/spec/models/export_status_spec.rb +5 -3
  179. data/spec/models/file_info_spec.rb +10 -8
  180. data/spec/models/file_payload_spec.rb +8 -6
  181. data/spec/models/file_upload_result_spec.rb +7 -5
  182. data/spec/models/inbound_payload_spec.rb +11 -9
  183. data/spec/models/inbound_route_action_type_spec.rb +5 -3
  184. data/spec/models/inbound_route_filter_type_spec.rb +5 -3
  185. data/spec/models/inbound_route_spec.rb +12 -10
  186. data/spec/models/list_payload_spec.rb +8 -6
  187. data/spec/models/list_update_payload_spec.rb +7 -5
  188. data/spec/models/log_job_status_spec.rb +5 -3
  189. data/spec/models/log_status_summary_spec.rb +18 -16
  190. data/spec/models/merge_email_payload_spec.rb +8 -6
  191. data/spec/models/message_attachment_spec.rb +14 -6
  192. data/spec/models/message_category_spec.rb +5 -3
  193. data/spec/models/new_api_key_spec.rb +12 -10
  194. data/spec/models/new_smtp_credentials_spec.rb +12 -10
  195. data/spec/models/options_spec.rb +11 -9
  196. data/spec/models/recipient_event_spec.rb +18 -16
  197. data/spec/models/segment_payload_spec.rb +7 -5
  198. data/spec/models/segment_spec.rb +7 -5
  199. data/spec/models/smtp_credentials_payload_spec.rb +9 -7
  200. data/spec/models/smtp_credentials_spec.rb +11 -9
  201. data/spec/models/sort_order_item_spec.rb +7 -5
  202. data/spec/models/split_optimization_type_spec.rb +5 -3
  203. data/spec/models/split_options_spec.rb +7 -5
  204. data/spec/models/sub_account_info_spec.rb +14 -12
  205. data/spec/models/subaccount_email_credits_payload_spec.rb +7 -5
  206. data/spec/models/subaccount_email_settings_payload_spec.rb +17 -9
  207. data/spec/models/subaccount_email_settings_spec.rb +18 -10
  208. data/spec/models/subaccount_payload_spec.rb +9 -7
  209. data/spec/models/subaccount_settings_info_payload_spec.rb +6 -4
  210. data/spec/models/subaccount_settings_info_spec.rb +6 -4
  211. data/spec/models/suppression_spec.rb +9 -7
  212. data/spec/models/template_payload_spec.rb +9 -7
  213. data/spec/models/template_scope_spec.rb +5 -3
  214. data/spec/models/template_spec.rb +11 -9
  215. data/spec/models/template_type_spec.rb +5 -3
  216. data/spec/models/transactional_recipient_spec.rb +8 -6
  217. data/spec/models/utm_spec.rb +9 -7
  218. data/spec/models/verification_file_result_details_spec.rb +12 -10
  219. data/spec/models/verification_file_result_spec.rb +11 -9
  220. data/spec/models/verification_status_spec.rb +5 -3
  221. data/spec/spec_helper.rb +1 -1
  222. metadata +10 -18
  223. data/docs/ContactHistEventType.md +0 -15
  224. data/docs/ContactHistory.md +0 -30
  225. data/docs/TemplateScopeType.md +0 -15
  226. data/lib/ElasticEmail/models/contact_hist_event_type.rb +0 -49
  227. data/lib/ElasticEmail/models/template_scope_type.rb +0 -38
  228. data/spec/api_client_spec.rb +0 -226
  229. data/spec/configuration_spec.rb +0 -42
  230. data/spec/models/contact_hist_event_type_spec.rb +0 -28
  231. data/spec/models/contact_history_spec.rb +0 -70
  232. 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: 2cf1c9217625cef16555bee235d90e20d39ba360d535db2e13f2367eda9ddca0
4
+ data.tar.gz: f821031e0e7a06077f858706c3ee3fbe3baa5087ca4c20f761bbdb902f8b7185
5
5
  SHA512:
6
- metadata.gz: 2d993c884f791ef79a00cb58fde2171e53dea89083e0623828ce9faece82c4fb4cd097e390efb2a4e20b59e707167358bfd8fd2c8ac651d31175477283bfea50
7
- data.tar.gz: 388ceb010b34402bc3359e48d12bcfdd39137983a2e6d8cc8fb75a62868e9eb94c8c66f659bcd85af6249f70e4fd56802557576b834e8dda07336007bea02823
6
+ metadata.gz: 5118ea476a962dd3e8515c753b76878a116994fabd7ee1b982e4be11701701829cbcb2d30c22efaaa0458f94a0a0ee56ba6b4519e9e8e2dbeb1de82ec19d649d
7
+ data.tar.gz: 677db984d6484d85595666ddcb720f1d317ace9410bf121346fc135de7bb0af153f62ae1718a3783b21e0b635a2fca76ac4dbcdcbd999b9a9b0a9d596f18eefc
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.7.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.24
19
+ - Generator version: 7.7.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.24.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.24.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.24'
44
45
 
45
46
  ### Install from Git
46
47
 
@@ -105,6 +106,7 @@ Class | Method | HTTP request | Description
105
106
  *ElasticEmail::ContactsApi* | [**contacts_import_post**](docs/ContactsApi.md#contacts_import_post) | **POST** /contacts/import | Upload Contacts
106
107
  *ElasticEmail::ContactsApi* | [**contacts_post**](docs/ContactsApi.md#contacts_post) | **POST** /contacts | Add Contact
107
108
  *ElasticEmail::EmailsApi* | [**emails_by_msgid_view_get**](docs/EmailsApi.md#emails_by_msgid_view_get) | **GET** /emails/{msgid}/view | View Email
109
+ *ElasticEmail::EmailsApi* | [**emails_by_transactionid_status_get**](docs/EmailsApi.md#emails_by_transactionid_status_get) | **GET** /emails/{transactionid}/status | Get Status
108
110
  *ElasticEmail::EmailsApi* | [**emails_mergefile_post**](docs/EmailsApi.md#emails_mergefile_post) | **POST** /emails/mergefile | Send Bulk Emails CSV
109
111
  *ElasticEmail::EmailsApi* | [**emails_post**](docs/EmailsApi.md#emails_post) | **POST** /emails | Send Bulk Emails
110
112
  *ElasticEmail::EmailsApi* | [**emails_transactional_post**](docs/EmailsApi.md#emails_transactional_post) | **POST** /emails/transactional | Send Transactional Email
@@ -126,6 +128,7 @@ Class | Method | HTTP request | Description
126
128
  *ElasticEmail::InboundRouteApi* | [**inboundroute_get**](docs/InboundRouteApi.md#inboundroute_get) | **GET** /inboundroute | Get Routes
127
129
  *ElasticEmail::InboundRouteApi* | [**inboundroute_order_put**](docs/InboundRouteApi.md#inboundroute_order_put) | **PUT** /inboundroute/order | Update Sorting
128
130
  *ElasticEmail::InboundRouteApi* | [**inboundroute_post**](docs/InboundRouteApi.md#inboundroute_post) | **POST** /inboundroute | Create Route
131
+ *ElasticEmail::ListsApi* | [**lists_by_listname_contacts_get**](docs/ListsApi.md#lists_by_listname_contacts_get) | **GET** /lists/{listname}/contacts | Load Contacts in List
129
132
  *ElasticEmail::ListsApi* | [**lists_by_name_contacts_post**](docs/ListsApi.md#lists_by_name_contacts_post) | **POST** /lists/{name}/contacts | Add Contacts to List
130
133
  *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
134
  *ElasticEmail::ListsApi* | [**lists_by_name_delete**](docs/ListsApi.md#lists_by_name_delete) | **DELETE** /lists/{name} | Delete List
@@ -215,6 +218,8 @@ Class | Method | HTTP request | Description
215
218
  - [ElasticEmail::DeliveryOptimizationType](docs/DeliveryOptimizationType.md)
216
219
  - [ElasticEmail::EmailContent](docs/EmailContent.md)
217
220
  - [ElasticEmail::EmailData](docs/EmailData.md)
221
+ - [ElasticEmail::EmailJobFailedStatus](docs/EmailJobFailedStatus.md)
222
+ - [ElasticEmail::EmailJobStatus](docs/EmailJobStatus.md)
218
223
  - [ElasticEmail::EmailMessageData](docs/EmailMessageData.md)
219
224
  - [ElasticEmail::EmailPredictedValidationStatus](docs/EmailPredictedValidationStatus.md)
220
225
  - [ElasticEmail::EmailRecipient](docs/EmailRecipient.md)
@@ -278,6 +283,7 @@ Class | Method | HTTP request | Description
278
283
  ## Documentation for Authorization
279
284
 
280
285
 
286
+ Authentication schemes defined for the API:
281
287
  ### apikey
282
288
 
283
289
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 4.0.23
1
+ 4.0.24
@@ -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/EmailContent.md CHANGED
@@ -10,7 +10,7 @@
10
10
  | **headers** | **Hash<String, String>** | A key-value collection of custom e-mail headers. | [optional] |
11
11
  | **postback** | **String** | Postback header. | [optional] |
12
12
  | **envelope_from** | **String** | E-mail with an optional name to be used as the envelope from address (e.g.: John Doe <email@domain.com>) | [optional] |
13
- | **from** | **String** | Your e-mail with an optional name (e.g.: John Doe <email@domain.com>) | [optional] |
13
+ | **from** | **String** | Your e-mail with an optional name (e.g.: John Doe <email@domain.com>) | |
14
14
  | **reply_to** | **String** | To what address should the recipients reply to (e.g. John Doe <email@domain.com>) | [optional] |
15
15
  | **subject** | **String** | Default subject of email. | [optional] |
16
16
  | **template_name** | **String** | Name of template. | [optional] |
@@ -33,7 +33,7 @@ instance = ElasticEmail::EmailContent.new(
33
33
  reply_to: John Doe <email@domain.com>,
34
34
  subject: Hello!,
35
35
  template_name: Template01,
36
- attach_files: [ "preuploaded.jpg" ],
36
+ attach_files: ["preuploaded.jpg"],
37
37
  utm: null
38
38
  )
39
39
  ```
@@ -0,0 +1,24 @@
1
+ # ElasticEmail::EmailJobFailedStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **address** | **String** | | [optional] |
8
+ | **error** | **String** | | [optional] |
9
+ | **error_code** | **Integer** | RFC Error code | [optional] |
10
+ | **category** | **String** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ElasticEmail'
16
+
17
+ instance = ElasticEmail::EmailJobFailedStatus.new(
18
+ address: null,
19
+ error: null,
20
+ error_code: 550,
21
+ category: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,56 @@
1
+ # ElasticEmail::EmailJobStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | ID number of your attachment | [optional] |
8
+ | **status** | **String** | Name of status: submitted, complete, in_progress | [optional] |
9
+ | **recipients_count** | **Integer** | | [optional] |
10
+ | **failed** | [**Array<EmailJobFailedStatus>**](EmailJobFailedStatus.md) | | [optional] |
11
+ | **failed_count** | **Integer** | Total emails failed. | [optional] |
12
+ | **sent** | **Array<String>** | | [optional] |
13
+ | **sent_count** | **Integer** | Total emails sent. | [optional] |
14
+ | **delivered** | **Array<String>** | Number of delivered messages | [optional] |
15
+ | **delivered_count** | **Integer** | | [optional] |
16
+ | **pending** | **Array<String>** | | [optional] |
17
+ | **pending_count** | **Integer** | | [optional] |
18
+ | **opened** | **Array<String>** | Number of opened messages | [optional] |
19
+ | **opened_count** | **Integer** | Total emails opened. | [optional] |
20
+ | **clicked** | **Array<String>** | Number of clicked messages | [optional] |
21
+ | **clicked_count** | **Integer** | Total emails clicked | [optional] |
22
+ | **unsubscribed** | **Array<String>** | Number of unsubscribed messages | [optional] |
23
+ | **unsubscribed_count** | **Integer** | Total emails unsubscribed | [optional] |
24
+ | **abuse_reports** | **Array<String>** | | [optional] |
25
+ | **abuse_reports_count** | **Integer** | | [optional] |
26
+ | **message_ids** | **Array<String>** | List of all MessageIDs for this job. | [optional] |
27
+
28
+ ## Example
29
+
30
+ ```ruby
31
+ require 'ElasticEmail'
32
+
33
+ instance = ElasticEmail::EmailJobStatus.new(
34
+ id: 123456,
35
+ status: null,
36
+ recipients_count: null,
37
+ failed: null,
38
+ failed_count: 1000,
39
+ sent: null,
40
+ sent_count: 1000,
41
+ delivered: ["1000"],
42
+ delivered_count: null,
43
+ pending: null,
44
+ pending_count: null,
45
+ opened: ["1000"],
46
+ opened_count: 1000,
47
+ clicked: ["1000"],
48
+ clicked_count: 1000,
49
+ unsubscribed: ["1000"],
50
+ unsubscribed_count: 1000,
51
+ abuse_reports: null,
52
+ abuse_reports_count: null,
53
+ message_ids: null
54
+ )
55
+ ```
56
+
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **recipients** | [**Array<EmailRecipient>**](EmailRecipient.md) | List of recipients | |
8
- | **content** | [**EmailContent**](EmailContent.md) | | [optional] |
8
+ | **content** | [**EmailContent**](EmailContent.md) | | |
9
9
  | **options** | [**Options**](Options.md) | | [optional] |
10
10
 
11
11
  ## Example
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **recipients** | [**TransactionalRecipient**](TransactionalRecipient.md) | | |
8
- | **content** | [**EmailContent**](EmailContent.md) | | [optional] |
8
+ | **content** | [**EmailContent**](EmailContent.md) | | |
9
9
  | **options** | [**Options**](Options.md) | | [optional] |
10
10
 
11
11
  ## Example
@@ -11,9 +11,9 @@
11
11
  | **disposable** | **Boolean** | Does the email have a temporary domain | [optional] |
12
12
  | **role** | **Boolean** | Is an email a role email (e.g. info@, noreply@ etc.) | [optional] |
13
13
  | **reason** | **String** | All detected issues | [optional] |
14
- | **date_added** | **Time** | Date of creation in YYYY-MM-DDThh:ii:ss format | [optional] |
14
+ | **date_added** | **Time** | Added date | [optional] |
15
15
  | **result** | [**EmailValidationStatus**](EmailValidationStatus.md) | | [optional][default to 'None'] |
16
- | **predicted_score** | **Float** | | [optional] |
16
+ | **predicted_score** | **Float** | Predicted score | [optional] |
17
17
  | **predicted_status** | [**EmailPredictedValidationStatus**](EmailPredictedValidationStatus.md) | | [optional][default to 'None'] |
18
18
 
19
19
  ## Example
data/docs/EmailsApi.md CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.elasticemail.com/v4*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**emails_by_msgid_view_get**](EmailsApi.md#emails_by_msgid_view_get) | **GET** /emails/{msgid}/view | View Email |
8
+ | [**emails_by_transactionid_status_get**](EmailsApi.md#emails_by_transactionid_status_get) | **GET** /emails/{transactionid}/status | Get Status |
8
9
  | [**emails_mergefile_post**](EmailsApi.md#emails_mergefile_post) | **POST** /emails/mergefile | Send Bulk Emails CSV |
9
10
  | [**emails_post**](EmailsApi.md#emails_post) | **POST** /emails | Send Bulk Emails |
10
11
  | [**emails_transactional_post**](EmailsApi.md#emails_transactional_post) | **POST** /emails/transactional | Send Transactional Email |
@@ -81,6 +82,99 @@ end
81
82
  - **Accept**: application/json
82
83
 
83
84
 
85
+ ## emails_by_transactionid_status_get
86
+
87
+ > <EmailJobStatus> emails_by_transactionid_status_get(transactionid, opts)
88
+
89
+ Get Status
90
+
91
+ Get status details of an email transaction. Required Access Level: ViewReports
92
+
93
+ ### Examples
94
+
95
+ ```ruby
96
+ require 'time'
97
+ require 'ElasticEmail'
98
+ # setup authorization
99
+ ElasticEmail.configure do |config|
100
+ # Configure API key authorization: apikey
101
+ config.api_key['apikey'] = 'YOUR API KEY'
102
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
103
+ # config.api_key_prefix['apikey'] = 'Bearer'
104
+ end
105
+
106
+ api_instance = ElasticEmail::EmailsApi.new
107
+ transactionid = 'transactionid_example' # String | Transaction identifier
108
+ opts = {
109
+ show_failed: true, # Boolean | Include Bounced email addresses.
110
+ show_sent: true, # Boolean | Include Sent email addresses.
111
+ show_delivered: true, # Boolean | Include all delivered email addresses.
112
+ show_pending: true, # Boolean | Include Ready to send email addresses.
113
+ show_opened: true, # Boolean | Include Opened email addresses.
114
+ show_clicked: true, # Boolean | Include Clicked email addresses.
115
+ show_abuse: true, # Boolean | Include Reported as abuse email addresses.
116
+ show_unsubscribed: true, # Boolean | Include Unsubscribed email addresses.
117
+ show_errors: true, # Boolean | Include error messages for bounced emails.
118
+ show_message_ids: true # Boolean | Include all MessageIDs for this transaction
119
+ }
120
+
121
+ begin
122
+ # Get Status
123
+ result = api_instance.emails_by_transactionid_status_get(transactionid, opts)
124
+ p result
125
+ rescue ElasticEmail::ApiError => e
126
+ puts "Error when calling EmailsApi->emails_by_transactionid_status_get: #{e}"
127
+ end
128
+ ```
129
+
130
+ #### Using the emails_by_transactionid_status_get_with_http_info variant
131
+
132
+ This returns an Array which contains the response data, status code and headers.
133
+
134
+ > <Array(<EmailJobStatus>, Integer, Hash)> emails_by_transactionid_status_get_with_http_info(transactionid, opts)
135
+
136
+ ```ruby
137
+ begin
138
+ # Get Status
139
+ data, status_code, headers = api_instance.emails_by_transactionid_status_get_with_http_info(transactionid, opts)
140
+ p status_code # => 2xx
141
+ p headers # => { ... }
142
+ p data # => <EmailJobStatus>
143
+ rescue ElasticEmail::ApiError => e
144
+ puts "Error when calling EmailsApi->emails_by_transactionid_status_get_with_http_info: #{e}"
145
+ end
146
+ ```
147
+
148
+ ### Parameters
149
+
150
+ | Name | Type | Description | Notes |
151
+ | ---- | ---- | ----------- | ----- |
152
+ | **transactionid** | **String** | Transaction identifier | |
153
+ | **show_failed** | **Boolean** | Include Bounced email addresses. | [optional][default to false] |
154
+ | **show_sent** | **Boolean** | Include Sent email addresses. | [optional][default to false] |
155
+ | **show_delivered** | **Boolean** | Include all delivered email addresses. | [optional][default to false] |
156
+ | **show_pending** | **Boolean** | Include Ready to send email addresses. | [optional][default to false] |
157
+ | **show_opened** | **Boolean** | Include Opened email addresses. | [optional][default to false] |
158
+ | **show_clicked** | **Boolean** | Include Clicked email addresses. | [optional][default to false] |
159
+ | **show_abuse** | **Boolean** | Include Reported as abuse email addresses. | [optional][default to false] |
160
+ | **show_unsubscribed** | **Boolean** | Include Unsubscribed email addresses. | [optional][default to false] |
161
+ | **show_errors** | **Boolean** | Include error messages for bounced emails. | [optional][default to false] |
162
+ | **show_message_ids** | **Boolean** | Include all MessageIDs for this transaction | [optional][default to false] |
163
+
164
+ ### Return type
165
+
166
+ [**EmailJobStatus**](EmailJobStatus.md)
167
+
168
+ ### Authorization
169
+
170
+ [apikey](../README.md#apikey)
171
+
172
+ ### HTTP request headers
173
+
174
+ - **Content-Type**: Not defined
175
+ - **Accept**: application/json
176
+
177
+
84
178
  ## emails_mergefile_post
85
179
 
86
180
  > <EmailSend> emails_mergefile_post(merge_email_payload)
@@ -103,7 +197,7 @@ ElasticEmail.configure do |config|
103
197
  end
104
198
 
105
199
  api_instance = ElasticEmail::EmailsApi.new
106
- merge_email_payload = ElasticEmail::MergeEmailPayload.new({merge_file: ElasticEmail::MessageAttachment.new({binary_content: 'binary_content_example', name: 'name_example'})}) # MergeEmailPayload | Email data
200
+ merge_email_payload = ElasticEmail::MergeEmailPayload.new({merge_file: ElasticEmail::MessageAttachment.new({binary_content: 'binary_content_example', name: 'name_example'}), content: ElasticEmail::EmailContent.new({from: 'John Doe <email@domain.com>'})}) # MergeEmailPayload | Email data
107
201
 
108
202
  begin
109
203
  # Send Bulk Emails CSV
@@ -174,7 +268,7 @@ ElasticEmail.configure do |config|
174
268
  end
175
269
 
176
270
  api_instance = ElasticEmail::EmailsApi.new
177
- email_message_data = ElasticEmail::EmailMessageData.new({recipients: [ElasticEmail::EmailRecipient.new({email: 'mail@example.com'})]}) # EmailMessageData | Email data
271
+ email_message_data = ElasticEmail::EmailMessageData.new({recipients: [ElasticEmail::EmailRecipient.new({email: 'mail@example.com'})], content: ElasticEmail::EmailContent.new({from: 'John Doe <email@domain.com>'})}) # EmailMessageData | Email data
178
272
 
179
273
  begin
180
274
  # Send Bulk Emails
@@ -245,7 +339,7 @@ ElasticEmail.configure do |config|
245
339
  end
246
340
 
247
341
  api_instance = ElasticEmail::EmailsApi.new
248
- email_transactional_message_data = ElasticEmail::EmailTransactionalMessageData.new({recipients: ElasticEmail::TransactionalRecipient.new({to: ['to_example']})}) # EmailTransactionalMessageData | Email data
342
+ email_transactional_message_data = ElasticEmail::EmailTransactionalMessageData.new({recipients: ElasticEmail::TransactionalRecipient.new({to: ['to_example']}), content: ElasticEmail::EmailContent.new({from: 'John Doe <email@domain.com>'})}) # EmailTransactionalMessageData | Email data
249
343
 
250
344
  begin
251
345
  # Send Transactional Email
@@ -14,7 +14,7 @@ require 'ElasticEmail'
14
14
 
15
15
  instance = ElasticEmail::EmailsPayload.new(
16
16
  rule: null,
17
- emails: [ &quot;john.doe@sample.com&quot; ]
17
+ emails: [&quot;john.doe@sample.com&quot;]
18
18
  )
19
19
  ```
20
20
 
data/docs/ListPayload.md CHANGED
@@ -16,7 +16,7 @@ require 'ElasticEmail'
16
16
  instance = ElasticEmail::ListPayload.new(
17
17
  list_name: My List 1,
18
18
  allow_unsubscribe: false,
19
- emails: null
19
+ emails: [&quot;john.doe@sample.com&quot;]
20
20
  )
21
21
  ```
22
22
 
data/docs/ListsApi.md CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.elasticemail.com/v4*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**lists_by_listname_contacts_get**](ListsApi.md#lists_by_listname_contacts_get) | **GET** /lists/{listname}/contacts | Load Contacts in List |
7
8
  | [**lists_by_name_contacts_post**](ListsApi.md#lists_by_name_contacts_post) | **POST** /lists/{name}/contacts | Add Contacts to List |
8
9
  | [**lists_by_name_contacts_remove_post**](ListsApi.md#lists_by_name_contacts_remove_post) | **POST** /lists/{name}/contacts/remove | Remove Contacts from List |
9
10
  | [**lists_by_name_delete**](ListsApi.md#lists_by_name_delete) | **DELETE** /lists/{name} | Delete List |
@@ -13,6 +14,83 @@ All URIs are relative to *https://api.elasticemail.com/v4*
13
14
  | [**lists_post**](ListsApi.md#lists_post) | **POST** /lists | Add List |
14
15
 
15
16
 
17
+ ## lists_by_listname_contacts_get
18
+
19
+ > <Array<Contact>> lists_by_listname_contacts_get(listname, opts)
20
+
21
+ Load Contacts in List
22
+
23
+ Returns a list of contacts. Required Access Level: ViewContacts
24
+
25
+ ### Examples
26
+
27
+ ```ruby
28
+ require 'time'
29
+ require 'ElasticEmail'
30
+ # setup authorization
31
+ ElasticEmail.configure do |config|
32
+ # Configure API key authorization: apikey
33
+ config.api_key['apikey'] = 'YOUR API KEY'
34
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
35
+ # config.api_key_prefix['apikey'] = 'Bearer'
36
+ end
37
+
38
+ api_instance = ElasticEmail::ListsApi.new
39
+ listname = 'My List 1' # String | Name of your list.
40
+ opts = {
41
+ limit: 100, # Integer | Maximum number of returned items.
42
+ offset: 20 # Integer | How many items should be returned ahead.
43
+ }
44
+
45
+ begin
46
+ # Load Contacts in List
47
+ result = api_instance.lists_by_listname_contacts_get(listname, opts)
48
+ p result
49
+ rescue ElasticEmail::ApiError => e
50
+ puts "Error when calling ListsApi->lists_by_listname_contacts_get: #{e}"
51
+ end
52
+ ```
53
+
54
+ #### Using the lists_by_listname_contacts_get_with_http_info variant
55
+
56
+ This returns an Array which contains the response data, status code and headers.
57
+
58
+ > <Array(<Array<Contact>>, Integer, Hash)> lists_by_listname_contacts_get_with_http_info(listname, opts)
59
+
60
+ ```ruby
61
+ begin
62
+ # Load Contacts in List
63
+ data, status_code, headers = api_instance.lists_by_listname_contacts_get_with_http_info(listname, opts)
64
+ p status_code # => 2xx
65
+ p headers # => { ... }
66
+ p data # => <Array<Contact>>
67
+ rescue ElasticEmail::ApiError => e
68
+ puts "Error when calling ListsApi->lists_by_listname_contacts_get_with_http_info: #{e}"
69
+ end
70
+ ```
71
+
72
+ ### Parameters
73
+
74
+ | Name | Type | Description | Notes |
75
+ | ---- | ---- | ----------- | ----- |
76
+ | **listname** | **String** | Name of your list. | |
77
+ | **limit** | **Integer** | Maximum number of returned items. | [optional] |
78
+ | **offset** | **Integer** | How many items should be returned ahead. | [optional] |
79
+
80
+ ### Return type
81
+
82
+ [**Array&lt;Contact&gt;**](Contact.md)
83
+
84
+ ### Authorization
85
+
86
+ [apikey](../README.md#apikey)
87
+
88
+ ### HTTP request headers
89
+
90
+ - **Content-Type**: Not defined
91
+ - **Accept**: application/json
92
+
93
+
16
94
  ## lists_by_name_contacts_post
17
95
 
18
96
  > <ContactsList> lists_by_name_contacts_post(name, emails_payload)
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **merge_file** | [**MessageAttachment**](MessageAttachment.md) | | |
8
- | **content** | [**EmailContent**](EmailContent.md) | | [optional] |
8
+ | **content** | [**EmailContent**](EmailContent.md) | | |
9
9
  | **options** | [**Options**](Options.md) | | [optional] |
10
10
 
11
11
  ## Example
@@ -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
- OpenAPI Generator version: 6.3.0
9
+ Generator version: 7.7.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
- OpenAPI Generator version: 6.3.0
9
+ Generator version: 7.7.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
- OpenAPI Generator version: 6.3.0
9
+ Generator version: 7.7.0
10
10
 
11
11
  =end
12
12
 
@@ -82,6 +82,99 @@ 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
179
  # Send bulk merge email. Required Access Level: SendHttp
87
180
  # @param merge_email_payload [MergeEmailPayload] Email data