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
@@ -1,12 +1,12 @@
1
1
  =begin
2
2
  #Elastic Email REST API
3
3
 
4
- #This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://app.elasticemail.com/marketing/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
4
+ #This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target='_blank' href='https://app.elasticemail.com/marketing/settings/new/manage-api'>here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target='_blank' href='https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme'>here</a>
5
5
 
6
6
  The version of the OpenAPI document: 4.0.0
7
7
  Contact: support@elasticemail.com
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.5.0
9
+ Generator version: 7.11.0
10
10
 
11
11
  =end
12
12
 
@@ -1,12 +1,12 @@
1
1
  =begin
2
2
  #Elastic Email REST API
3
3
 
4
- #This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://app.elasticemail.com/marketing/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
4
+ #This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target='_blank' href='https://app.elasticemail.com/marketing/settings/new/manage-api'>here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target='_blank' href='https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme'>here</a>
5
5
 
6
6
  The version of the OpenAPI document: 4.0.0
7
7
  Contact: support@elasticemail.com
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.5.0
9
+ Generator version: 7.11.0
10
10
 
11
11
  =end
12
12
 
@@ -1,12 +1,12 @@
1
1
  =begin
2
2
  #Elastic Email REST API
3
3
 
4
- #This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://app.elasticemail.com/marketing/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
4
+ #This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target='_blank' href='https://app.elasticemail.com/marketing/settings/new/manage-api'>here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target='_blank' href='https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme'>here</a>
5
5
 
6
6
  The version of the OpenAPI document: 4.0.0
7
7
  Contact: support@elasticemail.com
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.5.0
9
+ Generator version: 7.11.0
10
10
 
11
11
  =end
12
12
 
@@ -1,12 +1,12 @@
1
1
  =begin
2
2
  #Elastic Email REST API
3
3
 
4
- #This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://app.elasticemail.com/marketing/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
4
+ #This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target='_blank' href='https://app.elasticemail.com/marketing/settings/new/manage-api'>here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target='_blank' href='https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme'>here</a>
5
5
 
6
6
  The version of the OpenAPI document: 4.0.0
7
7
  Contact: support@elasticemail.com
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.5.0
9
+ Generator version: 7.11.0
10
10
 
11
11
  =end
12
12
 
@@ -0,0 +1,330 @@
1
+ =begin
2
+ #Elastic Email REST API
3
+
4
+ #This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target='_blank' href='https://app.elasticemail.com/marketing/settings/new/manage-api'>here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target='_blank' href='https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme'>here</a>
5
+
6
+ The version of the OpenAPI document: 4.0.0
7
+ Contact: support@elasticemail.com
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.11.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module ElasticEmail
17
+ # Notification webhook setting
18
+ class Webhook
19
+ # Public webhook ID
20
+ attr_accessor :webhook_id
21
+
22
+ # Filename
23
+ attr_accessor :name
24
+
25
+ # Creation date.
26
+ attr_accessor :date_created
27
+
28
+ # Last change date
29
+ attr_accessor :date_updated
30
+
31
+ # URL of notification.
32
+ attr_accessor :url
33
+
34
+ attr_accessor :notify_once_per_email
35
+
36
+ attr_accessor :notification_for_sent
37
+
38
+ attr_accessor :notification_for_opened
39
+
40
+ attr_accessor :notification_for_clicked
41
+
42
+ attr_accessor :notification_for_unsubscribed
43
+
44
+ attr_accessor :notification_for_abuse_report
45
+
46
+ attr_accessor :notification_for_error
47
+
48
+ attr_accessor :is_enabled
49
+
50
+ # Attribute mapping from ruby-style variable name to JSON key.
51
+ def self.attribute_map
52
+ {
53
+ :'webhook_id' => :'WebhookID',
54
+ :'name' => :'Name',
55
+ :'date_created' => :'DateCreated',
56
+ :'date_updated' => :'DateUpdated',
57
+ :'url' => :'URL',
58
+ :'notify_once_per_email' => :'NotifyOncePerEmail',
59
+ :'notification_for_sent' => :'NotificationForSent',
60
+ :'notification_for_opened' => :'NotificationForOpened',
61
+ :'notification_for_clicked' => :'NotificationForClicked',
62
+ :'notification_for_unsubscribed' => :'NotificationForUnsubscribed',
63
+ :'notification_for_abuse_report' => :'NotificationForAbuseReport',
64
+ :'notification_for_error' => :'NotificationForError',
65
+ :'is_enabled' => :'IsEnabled'
66
+ }
67
+ end
68
+
69
+ # Returns all the JSON keys this model knows about
70
+ def self.acceptable_attributes
71
+ attribute_map.values
72
+ end
73
+
74
+ # Attribute type mapping.
75
+ def self.openapi_types
76
+ {
77
+ :'webhook_id' => :'String',
78
+ :'name' => :'String',
79
+ :'date_created' => :'Time',
80
+ :'date_updated' => :'Time',
81
+ :'url' => :'String',
82
+ :'notify_once_per_email' => :'Boolean',
83
+ :'notification_for_sent' => :'Boolean',
84
+ :'notification_for_opened' => :'Boolean',
85
+ :'notification_for_clicked' => :'Boolean',
86
+ :'notification_for_unsubscribed' => :'Boolean',
87
+ :'notification_for_abuse_report' => :'Boolean',
88
+ :'notification_for_error' => :'Boolean',
89
+ :'is_enabled' => :'Boolean'
90
+ }
91
+ end
92
+
93
+ # List of attributes with nullable: true
94
+ def self.openapi_nullable
95
+ Set.new([
96
+ :'date_created',
97
+ :'date_updated',
98
+ ])
99
+ end
100
+
101
+ # Initializes the object
102
+ # @param [Hash] attributes Model attributes in the form of hash
103
+ def initialize(attributes = {})
104
+ if (!attributes.is_a?(Hash))
105
+ fail ArgumentError, "The input argument (attributes) must be a hash in `ElasticEmail::Webhook` initialize method"
106
+ end
107
+
108
+ # check to see if the attribute exists and convert string to symbol for hash key
109
+ attributes = attributes.each_with_object({}) { |(k, v), h|
110
+ if (!self.class.attribute_map.key?(k.to_sym))
111
+ fail ArgumentError, "`#{k}` is not a valid attribute in `ElasticEmail::Webhook`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
112
+ end
113
+ h[k.to_sym] = v
114
+ }
115
+
116
+ if attributes.key?(:'webhook_id')
117
+ self.webhook_id = attributes[:'webhook_id']
118
+ end
119
+
120
+ if attributes.key?(:'name')
121
+ self.name = attributes[:'name']
122
+ end
123
+
124
+ if attributes.key?(:'date_created')
125
+ self.date_created = attributes[:'date_created']
126
+ end
127
+
128
+ if attributes.key?(:'date_updated')
129
+ self.date_updated = attributes[:'date_updated']
130
+ end
131
+
132
+ if attributes.key?(:'url')
133
+ self.url = attributes[:'url']
134
+ end
135
+
136
+ if attributes.key?(:'notify_once_per_email')
137
+ self.notify_once_per_email = attributes[:'notify_once_per_email']
138
+ end
139
+
140
+ if attributes.key?(:'notification_for_sent')
141
+ self.notification_for_sent = attributes[:'notification_for_sent']
142
+ end
143
+
144
+ if attributes.key?(:'notification_for_opened')
145
+ self.notification_for_opened = attributes[:'notification_for_opened']
146
+ end
147
+
148
+ if attributes.key?(:'notification_for_clicked')
149
+ self.notification_for_clicked = attributes[:'notification_for_clicked']
150
+ end
151
+
152
+ if attributes.key?(:'notification_for_unsubscribed')
153
+ self.notification_for_unsubscribed = attributes[:'notification_for_unsubscribed']
154
+ end
155
+
156
+ if attributes.key?(:'notification_for_abuse_report')
157
+ self.notification_for_abuse_report = attributes[:'notification_for_abuse_report']
158
+ end
159
+
160
+ if attributes.key?(:'notification_for_error')
161
+ self.notification_for_error = attributes[:'notification_for_error']
162
+ end
163
+
164
+ if attributes.key?(:'is_enabled')
165
+ self.is_enabled = attributes[:'is_enabled']
166
+ end
167
+ end
168
+
169
+ # Show invalid properties with the reasons. Usually used together with valid?
170
+ # @return Array for valid properties with the reasons
171
+ def list_invalid_properties
172
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
173
+ invalid_properties = Array.new
174
+ invalid_properties
175
+ end
176
+
177
+ # Check to see if the all the properties in the model are valid
178
+ # @return true if the model is valid
179
+ def valid?
180
+ warn '[DEPRECATED] the `valid?` method is obsolete'
181
+ true
182
+ end
183
+
184
+ # Checks equality by comparing each attribute.
185
+ # @param [Object] Object to be compared
186
+ def ==(o)
187
+ return true if self.equal?(o)
188
+ self.class == o.class &&
189
+ webhook_id == o.webhook_id &&
190
+ name == o.name &&
191
+ date_created == o.date_created &&
192
+ date_updated == o.date_updated &&
193
+ url == o.url &&
194
+ notify_once_per_email == o.notify_once_per_email &&
195
+ notification_for_sent == o.notification_for_sent &&
196
+ notification_for_opened == o.notification_for_opened &&
197
+ notification_for_clicked == o.notification_for_clicked &&
198
+ notification_for_unsubscribed == o.notification_for_unsubscribed &&
199
+ notification_for_abuse_report == o.notification_for_abuse_report &&
200
+ notification_for_error == o.notification_for_error &&
201
+ is_enabled == o.is_enabled
202
+ end
203
+
204
+ # @see the `==` method
205
+ # @param [Object] Object to be compared
206
+ def eql?(o)
207
+ self == o
208
+ end
209
+
210
+ # Calculates hash code according to all attributes.
211
+ # @return [Integer] Hash code
212
+ def hash
213
+ [webhook_id, name, date_created, date_updated, url, notify_once_per_email, notification_for_sent, notification_for_opened, notification_for_clicked, notification_for_unsubscribed, notification_for_abuse_report, notification_for_error, is_enabled].hash
214
+ end
215
+
216
+ # Builds the object from hash
217
+ # @param [Hash] attributes Model attributes in the form of hash
218
+ # @return [Object] Returns the model itself
219
+ def self.build_from_hash(attributes)
220
+ return nil unless attributes.is_a?(Hash)
221
+ attributes = attributes.transform_keys(&:to_sym)
222
+ transformed_hash = {}
223
+ openapi_types.each_pair do |key, type|
224
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
225
+ transformed_hash["#{key}"] = nil
226
+ elsif type =~ /\AArray<(.*)>/i
227
+ # check to ensure the input is an array given that the attribute
228
+ # is documented as an array but the input is not
229
+ if attributes[attribute_map[key]].is_a?(Array)
230
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
231
+ end
232
+ elsif !attributes[attribute_map[key]].nil?
233
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
234
+ end
235
+ end
236
+ new(transformed_hash)
237
+ end
238
+
239
+ # Deserializes the data based on type
240
+ # @param string type Data type
241
+ # @param string value Value to be deserialized
242
+ # @return [Object] Deserialized data
243
+ def self._deserialize(type, value)
244
+ case type.to_sym
245
+ when :Time
246
+ Time.parse(value)
247
+ when :Date
248
+ Date.parse(value)
249
+ when :String
250
+ value.to_s
251
+ when :Integer
252
+ value.to_i
253
+ when :Float
254
+ value.to_f
255
+ when :Boolean
256
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
257
+ true
258
+ else
259
+ false
260
+ end
261
+ when :Object
262
+ # generic object (usually a Hash), return directly
263
+ value
264
+ when /\AArray<(?<inner_type>.+)>\z/
265
+ inner_type = Regexp.last_match[:inner_type]
266
+ value.map { |v| _deserialize(inner_type, v) }
267
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
268
+ k_type = Regexp.last_match[:k_type]
269
+ v_type = Regexp.last_match[:v_type]
270
+ {}.tap do |hash|
271
+ value.each do |k, v|
272
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
273
+ end
274
+ end
275
+ else # model
276
+ # models (e.g. Pet) or oneOf
277
+ klass = ElasticEmail.const_get(type)
278
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
279
+ end
280
+ end
281
+
282
+ # Returns the string representation of the object
283
+ # @return [String] String presentation of the object
284
+ def to_s
285
+ to_hash.to_s
286
+ end
287
+
288
+ # to_body is an alias to to_hash (backward compatibility)
289
+ # @return [Hash] Returns the object in the form of hash
290
+ def to_body
291
+ to_hash
292
+ end
293
+
294
+ # Returns the object in the form of hash
295
+ # @return [Hash] Returns the object in the form of hash
296
+ def to_hash
297
+ hash = {}
298
+ self.class.attribute_map.each_pair do |attr, param|
299
+ value = self.send(attr)
300
+ if value.nil?
301
+ is_nullable = self.class.openapi_nullable.include?(attr)
302
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
303
+ end
304
+
305
+ hash[param] = _to_hash(value)
306
+ end
307
+ hash
308
+ end
309
+
310
+ # Outputs non-array value in the form of hash
311
+ # For object, use to_hash. Otherwise, just return the value
312
+ # @param [Object] value Any valid value
313
+ # @return [Hash] Returns the value in the form of hash
314
+ def _to_hash(value)
315
+ if value.is_a?(Array)
316
+ value.compact.map { |v| _to_hash(v) }
317
+ elsif value.is_a?(Hash)
318
+ {}.tap do |hash|
319
+ value.each { |k, v| hash[k] = _to_hash(v) }
320
+ end
321
+ elsif value.respond_to? :to_hash
322
+ value.to_hash
323
+ else
324
+ value
325
+ end
326
+ end
327
+
328
+ end
329
+
330
+ end