ElasticEmail 4.0.26 → 4.0.28

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 (263) hide show
  1. checksums.yaml +4 -4
  2. data/ElasticEmail.gemspec +2 -2
  3. data/README.md +24 -9
  4. data/VERSION +1 -1
  5. data/docs/Campaign.md +2 -0
  6. data/docs/CampaignOptions.md +3 -1
  7. data/docs/CampaignTemplate.md +2 -2
  8. data/docs/CampaignsApi.md +12 -12
  9. data/docs/Contact.md +2 -0
  10. data/docs/ContactsApi.md +18 -18
  11. data/docs/DomainsApi.md +16 -16
  12. data/docs/EmailContent.md +2 -2
  13. data/docs/EmailsApi.md +10 -10
  14. data/docs/EventsApi.md +14 -14
  15. data/docs/FilesApi.md +10 -10
  16. data/docs/InboundRouteApi.md +12 -12
  17. data/docs/ListsApi.md +16 -16
  18. data/docs/MessageAttachment.md +2 -2
  19. data/docs/RecipientEvent.md +2 -2
  20. data/docs/SecurityApi.md +30 -30
  21. data/docs/SegmentsApi.md +10 -10
  22. data/docs/StatisticsApi.md +10 -10
  23. data/docs/SubAccountsApi.md +12 -12
  24. data/docs/SuppressionsApi.md +24 -24
  25. data/docs/TemplatesApi.md +10 -10
  26. data/docs/VerificationsApi.md +25 -25
  27. data/docs/Webhook.md +42 -0
  28. data/docs/WebhookApi.md +372 -0
  29. data/docs/WebhookCreatePayload.md +34 -0
  30. data/docs/WebhookUpdatePayload.md +36 -0
  31. data/lib/ElasticEmail/api/campaigns_api.rb +6 -6
  32. data/lib/ElasticEmail/api/contacts_api.rb +8 -8
  33. data/lib/ElasticEmail/api/domains_api.rb +9 -9
  34. data/lib/ElasticEmail/api/emails_api.rb +7 -7
  35. data/lib/ElasticEmail/api/events_api.rb +9 -9
  36. data/lib/ElasticEmail/api/files_api.rb +6 -6
  37. data/lib/ElasticEmail/api/inbound_route_api.rb +7 -7
  38. data/lib/ElasticEmail/api/lists_api.rb +8 -8
  39. data/lib/ElasticEmail/api/security_api.rb +30 -30
  40. data/lib/ElasticEmail/api/segments_api.rb +6 -6
  41. data/lib/ElasticEmail/api/statistics_api.rb +7 -7
  42. data/lib/ElasticEmail/api/sub_accounts_api.rb +6 -6
  43. data/lib/ElasticEmail/api/suppressions_api.rb +10 -10
  44. data/lib/ElasticEmail/api/templates_api.rb +6 -6
  45. data/lib/ElasticEmail/api/verifications_api.rb +19 -19
  46. data/lib/ElasticEmail/api/webhook_api.rb +351 -0
  47. data/lib/ElasticEmail/api_client.rb +4 -4
  48. data/lib/ElasticEmail/api_error.rb +2 -2
  49. data/lib/ElasticEmail/configuration.rb +20 -3
  50. data/lib/ElasticEmail/models/access_level.rb +12 -3
  51. data/lib/ElasticEmail/models/account_status_enum.rb +2 -2
  52. data/lib/ElasticEmail/models/api_key.rb +2 -2
  53. data/lib/ElasticEmail/models/api_key_payload.rb +2 -2
  54. data/lib/ElasticEmail/models/body_content_type.rb +2 -2
  55. data/lib/ElasticEmail/models/body_part.rb +2 -2
  56. data/lib/ElasticEmail/models/campaign.rb +12 -3
  57. data/lib/ElasticEmail/models/campaign_options.rb +17 -6
  58. data/lib/ElasticEmail/models/campaign_recipient.rb +2 -2
  59. data/lib/ElasticEmail/models/campaign_status.rb +2 -2
  60. data/lib/ElasticEmail/models/campaign_template.rb +3 -3
  61. data/lib/ElasticEmail/models/certificate_validation_status.rb +2 -2
  62. data/lib/ElasticEmail/models/channel_log_status_summary.rb +2 -2
  63. data/lib/ElasticEmail/models/compression_format.rb +2 -2
  64. data/lib/ElasticEmail/models/consent_data.rb +2 -2
  65. data/lib/ElasticEmail/models/consent_tracking.rb +2 -2
  66. data/lib/ElasticEmail/models/contact.rb +12 -3
  67. data/lib/ElasticEmail/models/contact_activity.rb +2 -2
  68. data/lib/ElasticEmail/models/contact_payload.rb +2 -2
  69. data/lib/ElasticEmail/models/contact_source.rb +5 -3
  70. data/lib/ElasticEmail/models/contact_status.rb +2 -2
  71. data/lib/ElasticEmail/models/contact_update_payload.rb +2 -2
  72. data/lib/ElasticEmail/models/contacts_list.rb +2 -2
  73. data/lib/ElasticEmail/models/delivery_optimization_type.rb +2 -2
  74. data/lib/ElasticEmail/models/domain_data.rb +2 -2
  75. data/lib/ElasticEmail/models/domain_detail.rb +2 -2
  76. data/lib/ElasticEmail/models/domain_owner.rb +2 -2
  77. data/lib/ElasticEmail/models/domain_payload.rb +2 -2
  78. data/lib/ElasticEmail/models/domain_update_payload.rb +2 -2
  79. data/lib/ElasticEmail/models/email_content.rb +3 -3
  80. data/lib/ElasticEmail/models/email_data.rb +2 -2
  81. data/lib/ElasticEmail/models/email_job_failed_status.rb +2 -2
  82. data/lib/ElasticEmail/models/email_job_status.rb +2 -2
  83. data/lib/ElasticEmail/models/email_message_data.rb +2 -2
  84. data/lib/ElasticEmail/models/email_predicted_validation_status.rb +2 -2
  85. data/lib/ElasticEmail/models/email_recipient.rb +2 -2
  86. data/lib/ElasticEmail/models/email_send.rb +2 -2
  87. data/lib/ElasticEmail/models/email_status.rb +2 -2
  88. data/lib/ElasticEmail/models/email_transactional_message_data.rb +2 -2
  89. data/lib/ElasticEmail/models/email_validation_result.rb +2 -2
  90. data/lib/ElasticEmail/models/email_validation_status.rb +2 -2
  91. data/lib/ElasticEmail/models/email_view.rb +2 -2
  92. data/lib/ElasticEmail/models/emails_payload.rb +2 -2
  93. data/lib/ElasticEmail/models/encoding_type.rb +2 -2
  94. data/lib/ElasticEmail/models/event_type.rb +2 -2
  95. data/lib/ElasticEmail/models/events_order_by.rb +2 -2
  96. data/lib/ElasticEmail/models/export_file_formats.rb +2 -2
  97. data/lib/ElasticEmail/models/export_link.rb +2 -2
  98. data/lib/ElasticEmail/models/export_status.rb +2 -2
  99. data/lib/ElasticEmail/models/file_info.rb +2 -2
  100. data/lib/ElasticEmail/models/file_payload.rb +2 -2
  101. data/lib/ElasticEmail/models/file_upload_result.rb +2 -2
  102. data/lib/ElasticEmail/models/inbound_payload.rb +2 -2
  103. data/lib/ElasticEmail/models/inbound_route.rb +2 -2
  104. data/lib/ElasticEmail/models/inbound_route_action_type.rb +2 -2
  105. data/lib/ElasticEmail/models/inbound_route_filter_type.rb +2 -2
  106. data/lib/ElasticEmail/models/list_payload.rb +2 -2
  107. data/lib/ElasticEmail/models/list_update_payload.rb +2 -2
  108. data/lib/ElasticEmail/models/log_job_status.rb +2 -2
  109. data/lib/ElasticEmail/models/log_status_summary.rb +2 -2
  110. data/lib/ElasticEmail/models/merge_email_payload.rb +2 -2
  111. data/lib/ElasticEmail/models/message_attachment.rb +3 -3
  112. data/lib/ElasticEmail/models/message_category.rb +2 -2
  113. data/lib/ElasticEmail/models/message_category_enum.rb +2 -2
  114. data/lib/ElasticEmail/models/new_api_key.rb +2 -2
  115. data/lib/ElasticEmail/models/new_smtp_credentials.rb +2 -2
  116. data/lib/ElasticEmail/models/options.rb +2 -2
  117. data/lib/ElasticEmail/models/recipient_event.rb +3 -3
  118. data/lib/ElasticEmail/models/segment.rb +2 -2
  119. data/lib/ElasticEmail/models/segment_payload.rb +2 -2
  120. data/lib/ElasticEmail/models/smtp_credentials.rb +2 -2
  121. data/lib/ElasticEmail/models/smtp_credentials_payload.rb +2 -2
  122. data/lib/ElasticEmail/models/sort_order_item.rb +2 -2
  123. data/lib/ElasticEmail/models/split_optimization_type.rb +2 -2
  124. data/lib/ElasticEmail/models/split_options.rb +2 -2
  125. data/lib/ElasticEmail/models/sub_account_info.rb +2 -2
  126. data/lib/ElasticEmail/models/subaccount_email_credits_payload.rb +2 -2
  127. data/lib/ElasticEmail/models/subaccount_email_settings.rb +2 -2
  128. data/lib/ElasticEmail/models/subaccount_email_settings_payload.rb +2 -2
  129. data/lib/ElasticEmail/models/subaccount_payload.rb +2 -2
  130. data/lib/ElasticEmail/models/subaccount_settings_info.rb +2 -2
  131. data/lib/ElasticEmail/models/subaccount_settings_info_payload.rb +2 -2
  132. data/lib/ElasticEmail/models/suppression.rb +2 -2
  133. data/lib/ElasticEmail/models/template.rb +2 -2
  134. data/lib/ElasticEmail/models/template_payload.rb +2 -2
  135. data/lib/ElasticEmail/models/template_scope.rb +2 -2
  136. data/lib/ElasticEmail/models/template_type.rb +10 -3
  137. data/lib/ElasticEmail/models/tracking_type.rb +2 -2
  138. data/lib/ElasticEmail/models/tracking_validation_status.rb +2 -2
  139. data/lib/ElasticEmail/models/transactional_recipient.rb +2 -2
  140. data/lib/ElasticEmail/models/utm.rb +2 -2
  141. data/lib/ElasticEmail/models/verification_file_result.rb +2 -2
  142. data/lib/ElasticEmail/models/verification_file_result_details.rb +2 -2
  143. data/lib/ElasticEmail/models/verification_status.rb +2 -2
  144. data/lib/ElasticEmail/models/webhook.rb +330 -0
  145. data/lib/ElasticEmail/models/webhook_create_payload.rb +303 -0
  146. data/lib/ElasticEmail/models/webhook_update_payload.rb +306 -0
  147. data/lib/ElasticEmail/version.rb +3 -3
  148. data/lib/ElasticEmail.rb +6 -2
  149. data/spec/api/campaigns_api_spec.rb +2 -2
  150. data/spec/api/contacts_api_spec.rb +2 -2
  151. data/spec/api/domains_api_spec.rb +2 -2
  152. data/spec/api/emails_api_spec.rb +2 -2
  153. data/spec/api/events_api_spec.rb +2 -2
  154. data/spec/api/files_api_spec.rb +2 -2
  155. data/spec/api/inbound_route_api_spec.rb +2 -2
  156. data/spec/api/lists_api_spec.rb +2 -2
  157. data/spec/api/security_api_spec.rb +12 -12
  158. data/spec/api/segments_api_spec.rb +2 -2
  159. data/spec/api/statistics_api_spec.rb +2 -2
  160. data/spec/api/sub_accounts_api_spec.rb +2 -2
  161. data/spec/api/suppressions_api_spec.rb +2 -2
  162. data/spec/api/templates_api_spec.rb +2 -2
  163. data/spec/api/verifications_api_spec.rb +7 -7
  164. data/spec/api/webhook_api_spec.rb +97 -0
  165. data/spec/models/access_level_spec.rb +2 -2
  166. data/spec/models/account_status_enum_spec.rb +2 -2
  167. data/spec/models/api_key_payload_spec.rb +2 -2
  168. data/spec/models/api_key_spec.rb +2 -2
  169. data/spec/models/body_content_type_spec.rb +2 -2
  170. data/spec/models/body_part_spec.rb +2 -2
  171. data/spec/models/campaign_options_spec.rb +8 -2
  172. data/spec/models/campaign_recipient_spec.rb +2 -2
  173. data/spec/models/campaign_spec.rb +8 -2
  174. data/spec/models/campaign_status_spec.rb +2 -2
  175. data/spec/models/campaign_template_spec.rb +2 -2
  176. data/spec/models/certificate_validation_status_spec.rb +2 -2
  177. data/spec/models/channel_log_status_summary_spec.rb +2 -2
  178. data/spec/models/compression_format_spec.rb +2 -2
  179. data/spec/models/consent_data_spec.rb +2 -2
  180. data/spec/models/consent_tracking_spec.rb +2 -2
  181. data/spec/models/contact_activity_spec.rb +2 -2
  182. data/spec/models/contact_payload_spec.rb +2 -2
  183. data/spec/models/contact_source_spec.rb +2 -2
  184. data/spec/models/contact_spec.rb +8 -2
  185. data/spec/models/contact_status_spec.rb +2 -2
  186. data/spec/models/contact_update_payload_spec.rb +2 -2
  187. data/spec/models/contacts_list_spec.rb +2 -2
  188. data/spec/models/delivery_optimization_type_spec.rb +2 -2
  189. data/spec/models/domain_data_spec.rb +2 -2
  190. data/spec/models/domain_detail_spec.rb +2 -2
  191. data/spec/models/domain_owner_spec.rb +2 -2
  192. data/spec/models/domain_payload_spec.rb +2 -2
  193. data/spec/models/domain_update_payload_spec.rb +2 -2
  194. data/spec/models/email_content_spec.rb +2 -2
  195. data/spec/models/email_data_spec.rb +2 -2
  196. data/spec/models/email_job_failed_status_spec.rb +2 -2
  197. data/spec/models/email_job_status_spec.rb +2 -2
  198. data/spec/models/email_message_data_spec.rb +2 -2
  199. data/spec/models/email_predicted_validation_status_spec.rb +2 -2
  200. data/spec/models/email_recipient_spec.rb +2 -2
  201. data/spec/models/email_send_spec.rb +2 -2
  202. data/spec/models/email_status_spec.rb +2 -2
  203. data/spec/models/email_transactional_message_data_spec.rb +2 -2
  204. data/spec/models/email_validation_result_spec.rb +2 -2
  205. data/spec/models/email_validation_status_spec.rb +2 -2
  206. data/spec/models/email_view_spec.rb +2 -2
  207. data/spec/models/emails_payload_spec.rb +2 -2
  208. data/spec/models/encoding_type_spec.rb +2 -2
  209. data/spec/models/event_type_spec.rb +2 -2
  210. data/spec/models/events_order_by_spec.rb +2 -2
  211. data/spec/models/export_file_formats_spec.rb +2 -2
  212. data/spec/models/export_link_spec.rb +2 -2
  213. data/spec/models/export_status_spec.rb +2 -2
  214. data/spec/models/file_info_spec.rb +2 -2
  215. data/spec/models/file_payload_spec.rb +2 -2
  216. data/spec/models/file_upload_result_spec.rb +2 -2
  217. data/spec/models/inbound_payload_spec.rb +2 -2
  218. data/spec/models/inbound_route_action_type_spec.rb +2 -2
  219. data/spec/models/inbound_route_filter_type_spec.rb +2 -2
  220. data/spec/models/inbound_route_spec.rb +2 -2
  221. data/spec/models/list_payload_spec.rb +2 -2
  222. data/spec/models/list_update_payload_spec.rb +2 -2
  223. data/spec/models/log_job_status_spec.rb +2 -2
  224. data/spec/models/log_status_summary_spec.rb +2 -2
  225. data/spec/models/merge_email_payload_spec.rb +2 -2
  226. data/spec/models/message_attachment_spec.rb +2 -2
  227. data/spec/models/message_category_enum_spec.rb +2 -2
  228. data/spec/models/message_category_spec.rb +2 -2
  229. data/spec/models/new_api_key_spec.rb +2 -2
  230. data/spec/models/new_smtp_credentials_spec.rb +2 -2
  231. data/spec/models/options_spec.rb +2 -2
  232. data/spec/models/recipient_event_spec.rb +2 -2
  233. data/spec/models/segment_payload_spec.rb +2 -2
  234. data/spec/models/segment_spec.rb +2 -2
  235. data/spec/models/smtp_credentials_payload_spec.rb +2 -2
  236. data/spec/models/smtp_credentials_spec.rb +2 -2
  237. data/spec/models/sort_order_item_spec.rb +2 -2
  238. data/spec/models/split_optimization_type_spec.rb +2 -2
  239. data/spec/models/split_options_spec.rb +2 -2
  240. data/spec/models/sub_account_info_spec.rb +2 -2
  241. data/spec/models/subaccount_email_credits_payload_spec.rb +2 -2
  242. data/spec/models/subaccount_email_settings_payload_spec.rb +2 -2
  243. data/spec/models/subaccount_email_settings_spec.rb +2 -2
  244. data/spec/models/subaccount_payload_spec.rb +2 -2
  245. data/spec/models/subaccount_settings_info_payload_spec.rb +2 -2
  246. data/spec/models/subaccount_settings_info_spec.rb +2 -2
  247. data/spec/models/suppression_spec.rb +2 -2
  248. data/spec/models/template_payload_spec.rb +2 -2
  249. data/spec/models/template_scope_spec.rb +2 -2
  250. data/spec/models/template_spec.rb +2 -2
  251. data/spec/models/template_type_spec.rb +2 -2
  252. data/spec/models/tracking_type_spec.rb +2 -2
  253. data/spec/models/tracking_validation_status_spec.rb +2 -2
  254. data/spec/models/transactional_recipient_spec.rb +2 -2
  255. data/spec/models/utm_spec.rb +2 -2
  256. data/spec/models/verification_file_result_details_spec.rb +2 -2
  257. data/spec/models/verification_file_result_spec.rb +2 -2
  258. data/spec/models/verification_status_spec.rb +2 -2
  259. data/spec/models/webhook_create_payload_spec.rb +84 -0
  260. data/spec/models/webhook_spec.rb +108 -0
  261. data/spec/models/webhook_update_payload_spec.rb +90 -0
  262. data/spec/spec_helper.rb +2 -2
  263. metadata +110 -94
data/docs/SuppressionsApi.md CHANGED
@@ -34,9 +34,9 @@ require 'ElasticEmail'
34
34
  # setup authorization
35
35
  ElasticEmail.configure do |config|
36
36
  # Configure API key authorization: apikey
37
- config.api_key['apikey'] = 'YOUR API KEY'
37
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
38
38
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
39
- # config.api_key_prefix['apikey'] = 'Bearer'
39
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
40
40
  end
41
41
 
42
42
  api_instance = ElasticEmail::SuppressionsApi.new
@@ -111,9 +111,9 @@ require 'ElasticEmail'
111
111
  # setup authorization
112
112
  ElasticEmail.configure do |config|
113
113
  # Configure API key authorization: apikey
114
- config.api_key['apikey'] = 'YOUR API KEY'
114
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
115
115
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
116
- # config.api_key_prefix['apikey'] = 'Bearer'
116
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
117
117
  end
118
118
 
119
119
  api_instance = ElasticEmail::SuppressionsApi.new
@@ -183,9 +183,9 @@ require 'ElasticEmail'
183
183
  # setup authorization
184
184
  ElasticEmail.configure do |config|
185
185
  # Configure API key authorization: apikey
186
- config.api_key['apikey'] = 'YOUR API KEY'
186
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
187
187
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
188
- # config.api_key_prefix['apikey'] = 'Bearer'
188
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
189
189
  end
190
190
 
191
191
  api_instance = ElasticEmail::SuppressionsApi.new
@@ -254,9 +254,9 @@ require 'ElasticEmail'
254
254
  # setup authorization
255
255
  ElasticEmail.configure do |config|
256
256
  # Configure API key authorization: apikey
257
- config.api_key['apikey'] = 'YOUR API KEY'
257
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
258
258
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
259
- # config.api_key_prefix['apikey'] = 'Bearer'
259
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
260
260
  end
261
261
 
262
262
  api_instance = ElasticEmail::SuppressionsApi.new
@@ -324,9 +324,9 @@ require 'ElasticEmail'
324
324
  # setup authorization
325
325
  ElasticEmail.configure do |config|
326
326
  # Configure API key authorization: apikey
327
- config.api_key['apikey'] = 'YOUR API KEY'
327
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
328
328
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
329
- # config.api_key_prefix['apikey'] = 'Bearer'
329
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
330
330
  end
331
331
 
332
332
  api_instance = ElasticEmail::SuppressionsApi.new
@@ -395,9 +395,9 @@ require 'ElasticEmail'
395
395
  # setup authorization
396
396
  ElasticEmail.configure do |config|
397
397
  # Configure API key authorization: apikey
398
- config.api_key['apikey'] = 'YOUR API KEY'
398
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
399
399
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
400
- # config.api_key_prefix['apikey'] = 'Bearer'
400
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
401
401
  end
402
402
 
403
403
  api_instance = ElasticEmail::SuppressionsApi.new
@@ -472,9 +472,9 @@ require 'ElasticEmail'
472
472
  # setup authorization
473
473
  ElasticEmail.configure do |config|
474
474
  # Configure API key authorization: apikey
475
- config.api_key['apikey'] = 'YOUR API KEY'
475
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
476
476
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
477
- # config.api_key_prefix['apikey'] = 'Bearer'
477
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
478
478
  end
479
479
 
480
480
  api_instance = ElasticEmail::SuppressionsApi.new
@@ -544,9 +544,9 @@ require 'ElasticEmail'
544
544
  # setup authorization
545
545
  ElasticEmail.configure do |config|
546
546
  # Configure API key authorization: apikey
547
- config.api_key['apikey'] = 'YOUR API KEY'
547
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
548
548
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
549
- # config.api_key_prefix['apikey'] = 'Bearer'
549
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
550
550
  end
551
551
 
552
552
  api_instance = ElasticEmail::SuppressionsApi.new
@@ -615,9 +615,9 @@ require 'ElasticEmail'
615
615
  # setup authorization
616
616
  ElasticEmail.configure do |config|
617
617
  # Configure API key authorization: apikey
618
- config.api_key['apikey'] = 'YOUR API KEY'
618
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
619
619
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
620
- # config.api_key_prefix['apikey'] = 'Bearer'
620
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
621
621
  end
622
622
 
623
623
  api_instance = ElasticEmail::SuppressionsApi.new
@@ -690,9 +690,9 @@ require 'ElasticEmail'
690
690
  # setup authorization
691
691
  ElasticEmail.configure do |config|
692
692
  # Configure API key authorization: apikey
693
- config.api_key['apikey'] = 'YOUR API KEY'
693
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
694
694
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
695
- # config.api_key_prefix['apikey'] = 'Bearer'
695
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
696
696
  end
697
697
 
698
698
  api_instance = ElasticEmail::SuppressionsApi.new
@@ -767,9 +767,9 @@ require 'ElasticEmail'
767
767
  # setup authorization
768
768
  ElasticEmail.configure do |config|
769
769
  # Configure API key authorization: apikey
770
- config.api_key['apikey'] = 'YOUR API KEY'
770
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
771
771
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
772
- # config.api_key_prefix['apikey'] = 'Bearer'
772
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
773
773
  end
774
774
 
775
775
  api_instance = ElasticEmail::SuppressionsApi.new
@@ -839,9 +839,9 @@ require 'ElasticEmail'
839
839
  # setup authorization
840
840
  ElasticEmail.configure do |config|
841
841
  # Configure API key authorization: apikey
842
- config.api_key['apikey'] = 'YOUR API KEY'
842
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
843
843
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
844
- # config.api_key_prefix['apikey'] = 'Bearer'
844
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
845
845
  end
846
846
 
847
847
  api_instance = ElasticEmail::SuppressionsApi.new
data/docs/TemplatesApi.md CHANGED
@@ -27,9 +27,9 @@ require 'ElasticEmail'
27
27
  # setup authorization
28
28
  ElasticEmail.configure do |config|
29
29
  # Configure API key authorization: apikey
30
- config.api_key['apikey'] = 'YOUR API KEY'
30
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
31
31
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
32
- # config.api_key_prefix['apikey'] = 'Bearer'
32
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
33
33
  end
34
34
 
35
35
  api_instance = ElasticEmail::TemplatesApi.new
@@ -97,9 +97,9 @@ require 'ElasticEmail'
97
97
  # setup authorization
98
98
  ElasticEmail.configure do |config|
99
99
  # Configure API key authorization: apikey
100
- config.api_key['apikey'] = 'YOUR API KEY'
100
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
101
101
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
102
- # config.api_key_prefix['apikey'] = 'Bearer'
102
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
103
103
  end
104
104
 
105
105
  api_instance = ElasticEmail::TemplatesApi.new
@@ -168,9 +168,9 @@ require 'ElasticEmail'
168
168
  # setup authorization
169
169
  ElasticEmail.configure do |config|
170
170
  # Configure API key authorization: apikey
171
- config.api_key['apikey'] = 'YOUR API KEY'
171
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
172
172
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
173
- # config.api_key_prefix['apikey'] = 'Bearer'
173
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
174
174
  end
175
175
 
176
176
  api_instance = ElasticEmail::TemplatesApi.new
@@ -241,9 +241,9 @@ require 'ElasticEmail'
241
241
  # setup authorization
242
242
  ElasticEmail.configure do |config|
243
243
  # Configure API key authorization: apikey
244
- config.api_key['apikey'] = 'YOUR API KEY'
244
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
245
245
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
246
- # config.api_key_prefix['apikey'] = 'Bearer'
246
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
247
247
  end
248
248
 
249
249
  api_instance = ElasticEmail::TemplatesApi.new
@@ -320,9 +320,9 @@ require 'ElasticEmail'
320
320
  # setup authorization
321
321
  ElasticEmail.configure do |config|
322
322
  # Configure API key authorization: apikey
323
- config.api_key['apikey'] = 'YOUR API KEY'
323
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
324
324
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
325
- # config.api_key_prefix['apikey'] = 'Bearer'
325
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
326
326
  end
327
327
 
328
328
  api_instance = ElasticEmail::TemplatesApi.new
data/docs/VerificationsApi.md CHANGED
@@ -32,9 +32,9 @@ require 'ElasticEmail'
32
32
  # setup authorization
33
33
  ElasticEmail.configure do |config|
34
34
  # Configure API key authorization: apikey
35
- config.api_key['apikey'] = 'YOUR API KEY'
35
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
36
36
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
37
- # config.api_key_prefix['apikey'] = 'Bearer'
37
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
38
38
  end
39
39
 
40
40
  api_instance = ElasticEmail::VerificationsApi.new
@@ -92,7 +92,7 @@ nil (empty response body)
92
92
 
93
93
  Get Email Verification Result
94
94
 
95
- Returns a result of verified email. Required Access Level: VerifyEmails
95
+ Returns a result of verified email. Required Access Level: ViewVerifyEmails
96
96
 
97
97
  ### Examples
98
98
 
@@ -102,9 +102,9 @@ require 'ElasticEmail'
102
102
  # setup authorization
103
103
  ElasticEmail.configure do |config|
104
104
  # Configure API key authorization: apikey
105
- config.api_key['apikey'] = 'YOUR API KEY'
105
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
106
106
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
107
- # config.api_key_prefix['apikey'] = 'Bearer'
107
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
108
108
  end
109
109
 
110
110
  api_instance = ElasticEmail::VerificationsApi.new
@@ -173,9 +173,9 @@ require 'ElasticEmail'
173
173
  # setup authorization
174
174
  ElasticEmail.configure do |config|
175
175
  # Configure API key authorization: apikey
176
- config.api_key['apikey'] = 'YOUR API KEY'
176
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
177
177
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
178
- # config.api_key_prefix['apikey'] = 'Bearer'
178
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
179
179
  end
180
180
 
181
181
  api_instance = ElasticEmail::VerificationsApi.new
@@ -244,9 +244,9 @@ require 'ElasticEmail'
244
244
  # setup authorization
245
245
  ElasticEmail.configure do |config|
246
246
  # Configure API key authorization: apikey
247
- config.api_key['apikey'] = 'YOUR API KEY'
247
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
248
248
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
249
- # config.api_key_prefix['apikey'] = 'Bearer'
249
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
250
250
  end
251
251
 
252
252
  api_instance = ElasticEmail::VerificationsApi.new
@@ -304,7 +304,7 @@ nil (empty response body)
304
304
 
305
305
  Download File Verification Result
306
306
 
307
- Download verification results as a ZIP file. Required Access Level: VerifyEmails
307
+ Download verification results as a ZIP file. Required Access Level: ViewVerifyEmails
308
308
 
309
309
  ### Examples
310
310
 
@@ -314,9 +314,9 @@ require 'ElasticEmail'
314
314
  # setup authorization
315
315
  ElasticEmail.configure do |config|
316
316
  # Configure API key authorization: apikey
317
- config.api_key['apikey'] = 'YOUR API KEY'
317
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
318
318
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
319
- # config.api_key_prefix['apikey'] = 'Bearer'
319
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
320
320
  end
321
321
 
322
322
  api_instance = ElasticEmail::VerificationsApi.new
@@ -375,7 +375,7 @@ end
375
375
 
376
376
  Get Detailed File Verification Result
377
377
 
378
- Returns status and results (if verified) of file with given ID. Required Access Level: VerifyEmails
378
+ Returns status and results (if verified) of file with given ID. Required Access Level: ViewVerifyEmails
379
379
 
380
380
  ### Examples
381
381
 
@@ -385,9 +385,9 @@ require 'ElasticEmail'
385
385
  # setup authorization
386
386
  ElasticEmail.configure do |config|
387
387
  # Configure API key authorization: apikey
388
- config.api_key['apikey'] = 'YOUR API KEY'
388
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
389
389
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
390
- # config.api_key_prefix['apikey'] = 'Bearer'
390
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
391
391
  end
392
392
 
393
393
  api_instance = ElasticEmail::VerificationsApi.new
@@ -462,9 +462,9 @@ require 'ElasticEmail'
462
462
  # setup authorization
463
463
  ElasticEmail.configure do |config|
464
464
  # Configure API key authorization: apikey
465
- config.api_key['apikey'] = 'YOUR API KEY'
465
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
466
466
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
467
- # config.api_key_prefix['apikey'] = 'Bearer'
467
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
468
468
  end
469
469
 
470
470
  api_instance = ElasticEmail::VerificationsApi.new
@@ -532,9 +532,9 @@ require 'ElasticEmail'
532
532
  # setup authorization
533
533
  ElasticEmail.configure do |config|
534
534
  # Configure API key authorization: apikey
535
- config.api_key['apikey'] = 'YOUR API KEY'
535
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
536
536
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
537
- # config.api_key_prefix['apikey'] = 'Bearer'
537
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
538
538
  end
539
539
 
540
540
  api_instance = ElasticEmail::VerificationsApi.new
@@ -595,7 +595,7 @@ end
595
595
 
596
596
  Get Files Verification Results
597
597
 
598
- Returns a list of uploaded files, their statuses and results. Required Access Level: VerifyEmails
598
+ Returns a list of uploaded files, their statuses and results. Required Access Level: ViewVerifyEmails
599
599
 
600
600
  ### Examples
601
601
 
@@ -605,9 +605,9 @@ require 'ElasticEmail'
605
605
  # setup authorization
606
606
  ElasticEmail.configure do |config|
607
607
  # Configure API key authorization: apikey
608
- config.api_key['apikey'] = 'YOUR API KEY'
608
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
609
609
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
610
- # config.api_key_prefix['apikey'] = 'Bearer'
610
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
611
611
  end
612
612
 
613
613
  api_instance = ElasticEmail::VerificationsApi.new
@@ -663,7 +663,7 @@ This endpoint does not need any parameter.
663
663
 
664
664
  Get Emails Verification Results
665
665
 
666
- Returns a results of all verified single emails. Required Access Level: VerifyEmails
666
+ Returns a results of all verified single emails. Required Access Level: ViewVerifyEmails
667
667
 
668
668
  ### Examples
669
669
 
@@ -673,9 +673,9 @@ require 'ElasticEmail'
673
673
  # setup authorization
674
674
  ElasticEmail.configure do |config|
675
675
  # Configure API key authorization: apikey
676
- config.api_key['apikey'] = 'YOUR API KEY'
676
+ config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
677
677
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
678
- # config.api_key_prefix['apikey'] = 'Bearer'
678
+ # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
679
679
  end
680
680
 
681
681
  api_instance = ElasticEmail::VerificationsApi.new
data/docs/Webhook.md ADDED
@@ -0,0 +1,42 @@
1
+ # ElasticEmail::Webhook
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **webhook_id** | **String** | Public webhook ID | [optional] |
8
+ | **name** | **String** | Filename | [optional] |
9
+ | **date_created** | **Time** | Creation date. | [optional] |
10
+ | **date_updated** | **Time** | Last change date | [optional] |
11
+ | **url** | **String** | URL of notification. | [optional] |
12
+ | **notify_once_per_email** | **Boolean** | | [optional] |
13
+ | **notification_for_sent** | **Boolean** | | [optional] |
14
+ | **notification_for_opened** | **Boolean** | | [optional] |
15
+ | **notification_for_clicked** | **Boolean** | | [optional] |
16
+ | **notification_for_unsubscribed** | **Boolean** | | [optional] |
17
+ | **notification_for_abuse_report** | **Boolean** | | [optional] |
18
+ | **notification_for_error** | **Boolean** | | [optional] |
19
+ | **is_enabled** | **Boolean** | | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'ElasticEmail'
25
+
26
+ instance = ElasticEmail::Webhook.new(
27
+ webhook_id: null,
28
+ name: attachment.txt,
29
+ date_created: null,
30
+ date_updated: null,
31
+ url: http://address.for.notification.com,
32
+ notify_once_per_email: null,
33
+ notification_for_sent: null,
34
+ notification_for_opened: null,
35
+ notification_for_clicked: null,
36
+ notification_for_unsubscribed: null,
37
+ notification_for_abuse_report: null,
38
+ notification_for_error: null,
39
+ is_enabled: null
40
+ )
41
+ ```
42
+