sib-api-v3-sdk 5.2.3 → 5.5.0

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 (457) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/LICENSE.md +1 -1
  4. data/README.md +96 -68
  5. data/docs/AbTestCampaignResult.md +13 -0
  6. data/docs/AccountApi.md +3 -3
  7. data/docs/AddContactToList.md +1 -1
  8. data/docs/AttributesApi.md +18 -18
  9. data/docs/ContactsApi.md +123 -60
  10. data/docs/CreateAttribute.md +1 -1
  11. data/docs/CreateChild.md +1 -0
  12. data/docs/CreateContact.md +3 -3
  13. data/docs/CreateDoiContact.md +13 -0
  14. data/docs/CreateEmailCampaign.md +6 -3
  15. data/docs/CreateEmailCampaignSender.md +1 -0
  16. data/docs/CreateReseller.md +1 -0
  17. data/docs/CreateSender.md +1 -1
  18. data/docs/CreateSmtpEmail.md +1 -1
  19. data/docs/CreateSmtpTemplate.md +1 -1
  20. data/docs/CreateSmtpTemplateSender.md +1 -0
  21. data/docs/CreateWebhook.md +2 -2
  22. data/docs/EmailCampaignsApi.md +202 -25
  23. data/docs/EmailExportRecipients.md +1 -1
  24. data/docs/FoldersApi.md +12 -12
  25. data/docs/GetAccountRelay.md +1 -1
  26. data/docs/GetAccountRelayData.md +1 -1
  27. data/docs/GetChildAccountCreationStatus.md +8 -0
  28. data/docs/GetChildrenList.md +1 -0
  29. data/docs/GetDeviceBrowserStats.md +11 -0
  30. data/docs/GetEmailCampaign.md +1 -0
  31. data/docs/GetExtendedCampaignOverview.md +1 -0
  32. data/docs/GetExtendedCampaignOverviewSender.md +1 -0
  33. data/docs/GetExtendedCampaignStats.md +2 -0
  34. data/docs/GetSharedTemplateUrl.md +8 -0
  35. data/docs/GetSmtpTemplateOverview.md +1 -0
  36. data/docs/GetSmtpTemplateOverviewSender.md +1 -0
  37. data/docs/GetSmtpTemplates.md +1 -1
  38. data/docs/GetStatsByBrowser.md +7 -0
  39. data/docs/GetStatsByDevice.md +11 -0
  40. data/docs/GetTransacBlockedContacts.md +9 -0
  41. data/docs/GetTransacBlockedContactsContacts.md +11 -0
  42. data/docs/GetTransacBlockedContactsReason.md +9 -0
  43. data/docs/GetTransacEmailContent.md +14 -0
  44. data/docs/GetTransacEmailContentEvents.md +9 -0
  45. data/docs/GetTransacEmailsList.md +8 -0
  46. data/docs/GetTransacEmailsListTransactionalEmails.md +15 -0
  47. data/docs/ListsApi.md +13 -13
  48. data/docs/PostContactInfoContacts.md +1 -0
  49. data/docs/RemainingCreditModelChild.md +2 -2
  50. data/docs/RemainingCreditModelReseller.md +2 -2
  51. data/docs/RemoveContactFromList.md +2 -2
  52. data/docs/RequestContactExport.md +3 -2
  53. data/docs/RequestContactExportCustomContactFilter.md +13 -0
  54. data/docs/RequestContactImport.md +2 -2
  55. data/docs/RequestSMSRecipientExport.md +1 -1
  56. data/docs/ResellerApi.md +215 -86
  57. data/docs/SMSCampaignsApi.md +24 -24
  58. data/docs/SMTPApi.md +350 -42
  59. data/docs/SendEmail.md +2 -2
  60. data/docs/SendReport.md +1 -1
  61. data/docs/SendReportEmail.md +1 -1
  62. data/docs/SendSmtpEmail.md +4 -4
  63. data/docs/SendSmtpEmailBcc.md +1 -1
  64. data/docs/SendSmtpEmailCc.md +1 -1
  65. data/docs/SendSmtpEmailReplyTo.md +1 -1
  66. data/docs/SendSmtpEmailSender.md +1 -1
  67. data/docs/SendSmtpEmailTo.md +1 -1
  68. data/docs/SendTransacSms.md +1 -1
  69. data/docs/SendersApi.md +8 -8
  70. data/docs/TransactionalSMSApi.md +17 -17
  71. data/docs/UpdateAttribute.md +1 -1
  72. data/docs/UpdateChildAccountStatus.md +11 -0
  73. data/docs/UpdateContact.md +2 -2
  74. data/docs/UpdateEmailCampaign.md +5 -2
  75. data/docs/UpdateEmailCampaignSender.md +1 -0
  76. data/docs/UpdateSmtpTemplate.md +1 -1
  77. data/docs/UpdateSmtpTemplateSender.md +1 -0
  78. data/docs/UploadImageToGallery.md +9 -0
  79. data/docs/WebhooksApi.md +1 -1
  80. data/lib/sib-api-v3-sdk.rb +19 -2
  81. data/lib/sib-api-v3-sdk/api/account_api.rb +8 -11
  82. data/lib/sib-api-v3-sdk/api/attributes_api.rb +23 -35
  83. data/lib/sib-api-v3-sdk/api/contacts_api.rb +169 -186
  84. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +204 -73
  85. data/lib/sib-api-v3-sdk/api/folders_api.rb +29 -47
  86. data/lib/sib-api-v3-sdk/api/lists_api.rb +38 -65
  87. data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
  88. data/lib/sib-api-v3-sdk/api/reseller_api.rb +280 -201
  89. data/lib/sib-api-v3-sdk/api/senders_api.rb +25 -43
  90. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +47 -73
  91. data/lib/sib-api-v3-sdk/api/smtp_api.rb +342 -92
  92. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +19 -31
  93. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
  94. data/lib/sib-api-v3-sdk/api_client.rb +10 -10
  95. data/lib/sib-api-v3-sdk/api_error.rb +2 -2
  96. data/lib/sib-api-v3-sdk/configuration.rb +3 -3
  97. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +280 -0
  98. data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
  99. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +8 -13
  100. data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
  101. data/lib/sib-api-v3-sdk/models/create_attribute.rb +11 -15
  102. data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
  103. data/lib/sib-api-v3-sdk/models/create_child.rb +58 -19
  104. data/lib/sib-api-v3-sdk/models/create_contact.rb +10 -15
  105. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +253 -0
  106. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +82 -32
  107. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
  108. data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
  109. data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
  110. data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
  111. data/lib/sib-api-v3-sdk/models/create_reseller.rb +20 -15
  112. data/lib/sib-api-v3-sdk/models/create_sender.rb +10 -15
  113. data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
  114. data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
  115. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +13 -18
  116. data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
  117. data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +9 -14
  118. data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +11 -16
  119. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
  120. data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
  121. data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
  122. data/lib/sib-api-v3-sdk/models/create_webhook.rb +14 -18
  123. data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
  124. data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
  125. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +12 -16
  126. data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
  127. data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
  128. data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
  129. data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
  130. data/lib/sib-api-v3-sdk/models/get_account_relay.rb +11 -15
  131. data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +12 -16
  132. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +20 -25
  133. data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
  134. data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
  135. data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
  136. data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
  137. data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
  138. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +17 -22
  139. data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
  140. data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
  141. data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
  142. data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
  143. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
  144. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
  145. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
  146. data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
  147. data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
  148. data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
  149. data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
  150. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
  151. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
  152. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
  153. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
  154. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
  155. data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
  156. data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
  157. data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
  158. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +40 -34
  159. data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
  160. data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
  161. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
  162. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +40 -34
  163. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
  164. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
  165. data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
  166. data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
  167. data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
  168. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
  169. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
  170. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
  171. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
  172. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
  173. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
  174. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +9 -14
  175. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +10 -15
  176. data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
  177. data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
  178. data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
  179. data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
  180. data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
  181. data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
  182. data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
  183. data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
  184. data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
  185. data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
  186. data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
  187. data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
  188. data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
  189. data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
  190. data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
  191. data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
  192. data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
  193. data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
  194. data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
  195. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
  196. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
  197. data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
  198. data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
  199. data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
  200. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
  201. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +31 -26
  202. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
  203. data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +8 -13
  204. data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
  205. data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
  206. data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
  207. data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
  208. data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
  209. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
  210. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
  211. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
  212. data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +276 -0
  213. data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +204 -0
  214. data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +185 -0
  215. data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +281 -0
  216. data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
  217. data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
  218. data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
  219. data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
  220. data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
  221. data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
  222. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +19 -14
  223. data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
  224. data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
  225. data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
  226. data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +11 -15
  227. data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +11 -16
  228. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +9 -14
  229. data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
  230. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +19 -20
  231. data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
  232. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +9 -14
  233. data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
  234. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +12 -16
  235. data/lib/sib-api-v3-sdk/models/send_email.rb +10 -15
  236. data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
  237. data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
  238. data/lib/sib-api-v3-sdk/models/send_report_email.rb +14 -17
  239. data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
  240. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +12 -17
  241. data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
  242. data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
  243. data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
  244. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +10 -14
  245. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +10 -14
  246. data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
  247. data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
  248. data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
  249. data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
  250. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +17 -21
  251. data/lib/sib-api-v3-sdk/models/update_attribute.rb +8 -13
  252. data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
  253. data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
  254. data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
  255. data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +214 -0
  256. data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
  257. data/lib/sib-api-v3-sdk/models/update_contact.rb +9 -14
  258. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +79 -29
  259. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
  260. data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
  261. data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
  262. data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
  263. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +9 -15
  264. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +8 -13
  265. data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
  266. data/lib/sib-api-v3-sdk/models/update_webhook.rb +7 -11
  267. data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
  268. data/lib/sib-api-v3-sdk/version.rb +3 -3
  269. data/sib-api-v3-sdk.gemspec +5 -5
  270. data/spec/api/account_api_spec.rb +4 -5
  271. data/spec/api/attributes_api_spec.rb +10 -14
  272. data/spec/api/contacts_api_spec.rb +57 -68
  273. data/spec/api/email_campaigns_api_spec.rb +54 -28
  274. data/spec/api/folders_api_spec.rb +12 -18
  275. data/spec/api/lists_api_spec.rb +15 -24
  276. data/spec/api/process_api_spec.rb +4 -6
  277. data/spec/api/reseller_api_spec.rb +64 -52
  278. data/spec/api/senders_api_spec.rb +10 -16
  279. data/spec/api/sms_campaigns_api_spec.rb +19 -27
  280. data/spec/api/smtp_api_spec.rb +88 -34
  281. data/spec/api/transactional_sms_api_spec.rb +8 -12
  282. data/spec/api/webhooks_api_spec.rb +7 -12
  283. data/spec/api_client_spec.rb +36 -36
  284. data/spec/configuration_spec.rb +10 -10
  285. data/spec/models/ab_test_campaign_result_spec.rb +79 -0
  286. data/spec/models/add_child_domain_spec.rb +3 -4
  287. data/spec/models/add_contact_to_list_spec.rb +3 -4
  288. data/spec/models/add_credits_spec.rb +4 -5
  289. data/spec/models/create_attribute_enumeration_spec.rb +4 -5
  290. data/spec/models/create_attribute_spec.rb +9 -10
  291. data/spec/models/create_child_spec.rb +17 -8
  292. data/spec/models/create_contact_spec.rb +9 -10
  293. data/spec/models/create_doi_contact_spec.rb +71 -0
  294. data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
  295. data/spec/models/create_email_campaign_sender_spec.rb +10 -5
  296. data/spec/models/create_email_campaign_spec.rb +49 -32
  297. data/spec/models/create_list_spec.rb +4 -5
  298. data/spec/models/create_model_spec.rb +3 -4
  299. data/spec/models/create_reseller_spec.rb +9 -4
  300. data/spec/models/create_sender_ips_spec.rb +5 -6
  301. data/spec/models/create_sender_model_spec.rb +5 -6
  302. data/spec/models/create_sender_spec.rb +5 -6
  303. data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
  304. data/spec/models/create_sms_campaign_spec.rb +7 -8
  305. data/spec/models/create_smtp_email_spec.rb +3 -4
  306. data/spec/models/create_smtp_template_sender_spec.rb +10 -5
  307. data/spec/models/create_smtp_template_spec.rb +12 -13
  308. data/spec/models/create_update_contact_model_spec.rb +3 -4
  309. data/spec/models/create_update_folder_spec.rb +3 -4
  310. data/spec/models/create_webhook_spec.rb +14 -15
  311. data/spec/models/created_process_id_spec.rb +3 -4
  312. data/spec/models/delete_hardbounces_spec.rb +5 -6
  313. data/spec/models/email_export_recipients_spec.rb +8 -9
  314. data/spec/models/error_model_spec.rb +8 -9
  315. data/spec/models/get_account_marketing_automation_spec.rb +4 -5
  316. data/spec/models/get_account_plan_spec.rb +16 -17
  317. data/spec/models/get_account_relay_data_spec.rb +5 -6
  318. data/spec/models/get_account_relay_spec.rb +4 -5
  319. data/spec/models/get_account_spec.rb +10 -11
  320. data/spec/models/get_aggregated_report_spec.rb +15 -16
  321. data/spec/models/get_attributes_attributes_spec.rb +15 -16
  322. data/spec/models/get_attributes_enumeration_spec.rb +4 -5
  323. data/spec/models/get_attributes_spec.rb +3 -4
  324. data/spec/models/get_campaign_overview_spec.rb +23 -24
  325. data/spec/models/get_campaign_recipients_spec.rb +4 -5
  326. data/spec/models/get_campaign_stats_spec.rb +14 -15
  327. data/spec/models/get_child_account_creation_status_spec.rb +41 -0
  328. data/spec/models/get_child_domain_spec.rb +4 -5
  329. data/spec/models/get_child_domains_spec.rb +2 -3
  330. data/spec/models/get_child_info_api_keys_spec.rb +4 -5
  331. data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
  332. data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
  333. data/spec/models/get_child_info_credits_spec.rb +4 -5
  334. data/spec/models/get_child_info_spec.rb +11 -12
  335. data/spec/models/get_child_info_statistics_spec.rb +5 -6
  336. data/spec/models/get_children_list_spec.rb +9 -4
  337. data/spec/models/get_client_spec.rb +6 -7
  338. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
  339. data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
  340. data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
  341. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
  342. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
  343. data/spec/models/get_contact_details_spec.rb +11 -12
  344. data/spec/models/get_contacts_spec.rb +4 -5
  345. data/spec/models/get_device_browser_stats_spec.rb +59 -0
  346. data/spec/models/get_email_campaign_spec.rb +46 -41
  347. data/spec/models/get_email_campaigns_spec.rb +4 -5
  348. data/spec/models/get_email_event_report_events_spec.rb +16 -17
  349. data/spec/models/get_email_event_report_spec.rb +3 -4
  350. data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
  351. data/spec/models/get_extended_campaign_overview_spec.rb +44 -39
  352. data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
  353. data/spec/models/get_extended_client_address_spec.rb +6 -7
  354. data/spec/models/get_extended_client_spec.rb +7 -8
  355. data/spec/models/get_extended_contact_details_spec.rb +12 -13
  356. data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
  357. data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
  358. data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
  359. data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
  360. data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
  361. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
  362. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
  363. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
  364. data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
  365. data/spec/models/get_extended_list_spec.rb +10 -11
  366. data/spec/models/get_folder_lists_spec.rb +4 -5
  367. data/spec/models/get_folder_spec.rb +7 -8
  368. data/spec/models/get_folders_spec.rb +4 -5
  369. data/spec/models/get_ip_from_sender_spec.rb +6 -7
  370. data/spec/models/get_ip_spec.rb +6 -7
  371. data/spec/models/get_ips_from_sender_spec.rb +3 -4
  372. data/spec/models/get_ips_spec.rb +3 -4
  373. data/spec/models/get_list_spec.rb +6 -7
  374. data/spec/models/get_lists_spec.rb +4 -5
  375. data/spec/models/get_process_spec.rb +10 -11
  376. data/spec/models/get_processes_spec.rb +4 -5
  377. data/spec/models/get_reports_reports_spec.rb +15 -16
  378. data/spec/models/get_reports_spec.rb +3 -4
  379. data/spec/models/get_senders_list_ips_spec.rb +5 -6
  380. data/spec/models/get_senders_list_senders_spec.rb +7 -8
  381. data/spec/models/get_senders_list_spec.rb +3 -4
  382. data/spec/models/get_shared_template_url_spec.rb +41 -0
  383. data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
  384. data/spec/models/get_sms_campaign_spec.rb +16 -17
  385. data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
  386. data/spec/models/get_sms_campaigns_spec.rb +4 -5
  387. data/spec/models/get_sms_event_report_events_spec.rb +13 -14
  388. data/spec/models/get_sms_event_report_spec.rb +3 -4
  389. data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
  390. data/spec/models/get_smtp_template_overview_spec.rb +20 -15
  391. data/spec/models/get_smtp_templates_spec.rb +4 -5
  392. data/spec/models/get_sso_token_spec.rb +3 -4
  393. data/spec/models/get_stats_by_browser_spec.rb +35 -0
  394. data/spec/models/get_stats_by_device_spec.rb +59 -0
  395. data/spec/models/get_stats_by_domain_spec.rb +2 -3
  396. data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
  397. data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
  398. data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
  399. data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
  400. data/spec/models/get_transac_email_content_events_spec.rb +47 -0
  401. data/spec/models/get_transac_email_content_spec.rb +77 -0
  402. data/spec/models/get_transac_emails_list_spec.rb +41 -0
  403. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +83 -0
  404. data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
  405. data/spec/models/get_transac_sms_report_spec.rb +3 -4
  406. data/spec/models/get_webhook_spec.rb +13 -14
  407. data/spec/models/get_webhooks_spec.rb +3 -4
  408. data/spec/models/manage_ip_spec.rb +3 -4
  409. data/spec/models/post_contact_info_contacts_spec.rb +11 -6
  410. data/spec/models/post_contact_info_spec.rb +3 -4
  411. data/spec/models/post_send_failed_spec.rb +7 -8
  412. data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
  413. data/spec/models/remaining_credit_model_child_spec.rb +4 -5
  414. data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
  415. data/spec/models/remaining_credit_model_spec.rb +4 -5
  416. data/spec/models/remove_contact_from_list_spec.rb +4 -5
  417. data/spec/models/remove_credits_spec.rb +4 -5
  418. data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
  419. data/spec/models/request_contact_export_spec.rb +11 -6
  420. data/spec/models/request_contact_import_new_list_spec.rb +4 -5
  421. data/spec/models/request_contact_import_spec.rb +11 -12
  422. data/spec/models/request_sms_recipient_export_spec.rb +8 -9
  423. data/spec/models/send_email_attachment_spec.rb +4 -5
  424. data/spec/models/send_email_spec.rb +11 -12
  425. data/spec/models/send_report_email_spec.rb +12 -13
  426. data/spec/models/send_report_spec.rb +8 -9
  427. data/spec/models/send_sms_spec.rb +7 -8
  428. data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
  429. data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
  430. data/spec/models/send_smtp_email_cc_spec.rb +4 -5
  431. data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
  432. data/spec/models/send_smtp_email_sender_spec.rb +4 -5
  433. data/spec/models/send_smtp_email_spec.rb +15 -16
  434. data/spec/models/send_smtp_email_to_spec.rb +4 -5
  435. data/spec/models/send_template_email_spec.rb +3 -4
  436. data/spec/models/send_test_email_spec.rb +3 -4
  437. data/spec/models/send_test_sms_spec.rb +3 -4
  438. data/spec/models/send_transac_sms_spec.rb +12 -13
  439. data/spec/models/update_attribute_enumeration_spec.rb +4 -5
  440. data/spec/models/update_attribute_spec.rb +4 -5
  441. data/spec/models/update_campaign_status_spec.rb +7 -8
  442. data/spec/models/update_child_account_status_spec.rb +59 -0
  443. data/spec/models/update_child_domain_spec.rb +3 -4
  444. data/spec/models/update_child_spec.rb +7 -8
  445. data/spec/models/update_contact_spec.rb +8 -9
  446. data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
  447. data/spec/models/update_email_campaign_sender_spec.rb +10 -5
  448. data/spec/models/update_email_campaign_spec.rb +49 -32
  449. data/spec/models/update_list_spec.rb +4 -5
  450. data/spec/models/update_sender_spec.rb +5 -6
  451. data/spec/models/update_sms_campaign_spec.rb +7 -8
  452. data/spec/models/update_smtp_template_sender_spec.rb +10 -5
  453. data/spec/models/update_smtp_template_spec.rb +12 -13
  454. data/spec/models/update_webhook_spec.rb +9 -10
  455. data/spec/models/upload_image_to_gallery_spec.rb +47 -0
  456. data/spec/spec_helper.rb +2 -2
  457. metadata +70 -2
@@ -5,15 +5,15 @@ All URIs are relative to *https://api.sendinblue.com/v3*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**create_sms_campaign**](SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
8
- [**delete_sms_campaign**](SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
8
+ [**delete_sms_campaign**](SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign
9
9
  [**get_sms_campaign**](SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
10
- [**get_sms_campaigns**](SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns
11
- [**request_sms_recipient_export**](SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign.
10
+ [**get_sms_campaigns**](SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns
11
+ [**request_sms_recipient_export**](SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients
12
12
  [**send_sms_campaign_now**](SMSCampaignsApi.md#send_sms_campaign_now) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
13
- [**send_sms_report**](SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send report of SMS campaigns
14
- [**send_test_sms**](SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS
15
- [**update_sms_campaign**](SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Updates an SMS campaign
16
- [**update_sms_campaign_status**](SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status
13
+ [**send_sms_report**](SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report
14
+ [**send_test_sms**](SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign
15
+ [**update_sms_campaign**](SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign
16
+ [**update_sms_campaign_status**](SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status
17
17
 
18
18
 
19
19
  # **create_sms_campaign**
@@ -76,7 +76,7 @@ Name | Type | Description | Notes
76
76
  # **delete_sms_campaign**
77
77
  > delete_sms_campaign(campaign_id)
78
78
 
79
- Delete the SMS campaign
79
+ Delete an SMS campaign
80
80
 
81
81
  ### Example
82
82
  ```ruby
@@ -101,7 +101,7 @@ campaign_id = 789 # Integer | id of the SMS campaign
101
101
 
102
102
 
103
103
  begin
104
- #Delete the SMS campaign
104
+ #Delete an SMS campaign
105
105
  api_instance.delete_sms_campaign(campaign_id)
106
106
  rescue SibApiV3Sdk::ApiError => e
107
107
  puts "Exception when calling SMSCampaignsApi->delete_sms_campaign: #{e}"
@@ -189,7 +189,7 @@ Name | Type | Description | Notes
189
189
  # **get_sms_campaigns**
190
190
  > GetSmsCampaigns get_sms_campaigns(opts)
191
191
 
192
- Returns the informations for all your created SMS campaigns
192
+ Returns the information for all your created SMS campaigns
193
193
 
194
194
  ### Example
195
195
  ```ruby
@@ -211,15 +211,15 @@ end
211
211
  api_instance = SibApiV3Sdk::SMSCampaignsApi.new
212
212
 
213
213
  opts = {
214
- status: "status_example", # String | Status of campaign.
215
- start_date: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
216
- end_date: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
214
+ status: 'status_example', # String | Status of campaign.
215
+ start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
216
+ end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
217
217
  limit: 500, # Integer | Number limitation for the result returned
218
218
  offset: 0 # Integer | Beginning point in the list to retrieve from.
219
219
  }
220
220
 
221
221
  begin
222
- #Returns the informations for all your created SMS campaigns
222
+ #Returns the information for all your created SMS campaigns
223
223
  result = api_instance.get_sms_campaigns(opts)
224
224
  p result
225
225
  rescue SibApiV3Sdk::ApiError => e
@@ -255,7 +255,7 @@ Name | Type | Description | Notes
255
255
  # **request_sms_recipient_export**
256
256
  > CreatedProcessId request_sms_recipient_export(campaign_id, opts)
257
257
 
258
- Exports the recipients of the specified campaign.
258
+ Export an SMS campaign's recipients
259
259
 
260
260
  It returns the background process ID which on completion calls the notify URL that you have set in the input.
261
261
 
@@ -285,7 +285,7 @@ opts = {
285
285
  }
286
286
 
287
287
  begin
288
- #Exports the recipients of the specified campaign.
288
+ #Export an SMS campaign's recipients
289
289
  result = api_instance.request_sms_recipient_export(campaign_id, opts)
290
290
  p result
291
291
  rescue SibApiV3Sdk::ApiError => e
@@ -374,7 +374,7 @@ nil (empty response body)
374
374
  # **send_sms_report**
375
375
  > send_sms_report(campaign_id, send_report)
376
376
 
377
- Send report of SMS campaigns
377
+ Send an SMS campaign's report
378
378
 
379
379
  Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
380
380
 
@@ -403,7 +403,7 @@ send_report = SibApiV3Sdk::SendReport.new # SendReport | Values for send a repor
403
403
 
404
404
 
405
405
  begin
406
- #Send report of SMS campaigns
406
+ #Send an SMS campaign's report
407
407
  api_instance.send_sms_report(campaign_id, send_report)
408
408
  rescue SibApiV3Sdk::ApiError => e
409
409
  puts "Exception when calling SMSCampaignsApi->send_sms_report: #{e}"
@@ -435,7 +435,7 @@ nil (empty response body)
435
435
  # **send_test_sms**
436
436
  > send_test_sms(campaign_id, phone_number)
437
437
 
438
- Send an SMS
438
+ Send a test SMS campaign
439
439
 
440
440
  ### Example
441
441
  ```ruby
@@ -462,7 +462,7 @@ phone_number = SibApiV3Sdk::SendTestSms.new # SendTestSms | Mobile number of the
462
462
 
463
463
 
464
464
  begin
465
- #Send an SMS
465
+ #Send a test SMS campaign
466
466
  api_instance.send_test_sms(campaign_id, phone_number)
467
467
  rescue SibApiV3Sdk::ApiError => e
468
468
  puts "Exception when calling SMSCampaignsApi->send_test_sms: #{e}"
@@ -494,7 +494,7 @@ nil (empty response body)
494
494
  # **update_sms_campaign**
495
495
  > update_sms_campaign(campaign_id, update_sms_campaign)
496
496
 
497
- Updates an SMS campaign
497
+ Update an SMS campaign
498
498
 
499
499
  ### Example
500
500
  ```ruby
@@ -521,7 +521,7 @@ update_sms_campaign = SibApiV3Sdk::UpdateSmsCampaign.new # UpdateSmsCampaign | V
521
521
 
522
522
 
523
523
  begin
524
- #Updates an SMS campaign
524
+ #Update an SMS campaign
525
525
  api_instance.update_sms_campaign(campaign_id, update_sms_campaign)
526
526
  rescue SibApiV3Sdk::ApiError => e
527
527
  puts "Exception when calling SMSCampaignsApi->update_sms_campaign: #{e}"
@@ -553,7 +553,7 @@ nil (empty response body)
553
553
  # **update_sms_campaign_status**
554
554
  > update_sms_campaign_status(campaign_id, status)
555
555
 
556
- Update the campaign status
556
+ Update a campaign's status
557
557
 
558
558
  ### Example
559
559
  ```ruby
@@ -580,7 +580,7 @@ status = SibApiV3Sdk::UpdateCampaignStatus.new # UpdateCampaignStatus | Status o
580
580
 
581
581
 
582
582
  begin
583
- #Update the campaign status
583
+ #Update a campaign's status
584
584
  api_instance.update_sms_campaign_status(campaign_id, status)
585
585
  rescue SibApiV3Sdk::ApiError => e
586
586
  puts "Exception when calling SMSCampaignsApi->update_sms_campaign_status: #{e}"
@@ -4,24 +4,29 @@ All URIs are relative to *https://api.sendinblue.com/v3*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**create_smtp_template**](SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create an smtp template
7
+ [**create_smtp_template**](SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
8
8
  [**delete_hardbounces**](SMTPApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
9
- [**delete_smtp_template**](SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive smtp template
10
- [**get_aggregated_smtp_report**](SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your SMTP activity aggregated over a period of time
11
- [**get_email_event_report**](SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your SMTP activity (unaggregated events)
12
- [**get_smtp_report**](SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your SMTP activity aggregated per day
13
- [**get_smtp_template**](SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template informations
14
- [**get_smtp_templates**](SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of SMTP templates
9
+ [**delete_smtp_template**](SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
10
+ [**get_aggregated_smtp_report**](SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
11
+ [**get_email_event_report**](SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
12
+ [**get_smtp_report**](SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
13
+ [**get_smtp_template**](SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
14
+ [**get_smtp_templates**](SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
15
+ [**get_transac_blocked_contacts**](SMTPApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
16
+ [**get_transac_email_content**](SMTPApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
17
+ [**get_transac_emails_list**](SMTPApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
15
18
  [**send_template**](SMTPApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
16
19
  [**send_test_template**](SMTPApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
17
20
  [**send_transac_email**](SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
18
- [**update_smtp_template**](SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Updates an smtp templates
21
+ [**smtp_blocked_contacts_email_delete**](SMTPApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
22
+ [**smtp_log_message_id_delete**](SMTPApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
23
+ [**update_smtp_template**](SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
19
24
 
20
25
 
21
26
  # **create_smtp_template**
22
27
  > CreateModel create_smtp_template(smtp_template)
23
28
 
24
- Create an smtp template
29
+ Create an email template
25
30
 
26
31
  ### Example
27
32
  ```ruby
@@ -42,11 +47,11 @@ end
42
47
 
43
48
  api_instance = SibApiV3Sdk::SMTPApi.new
44
49
 
45
- smtp_template = SibApiV3Sdk::CreateSmtpTemplate.new # CreateSmtpTemplate | values to update in smtp template
50
+ smtp_template = SibApiV3Sdk::CreateSmtpTemplate.new # CreateSmtpTemplate | values to update in transactional email template
46
51
 
47
52
 
48
53
  begin
49
- #Create an smtp template
54
+ #Create an email template
50
55
  result = api_instance.create_smtp_template(smtp_template)
51
56
  p result
52
57
  rescue SibApiV3Sdk::ApiError => e
@@ -58,7 +63,7 @@ end
58
63
 
59
64
  Name | Type | Description | Notes
60
65
  ------------- | ------------- | ------------- | -------------
61
- **smtp_template** | [**CreateSmtpTemplate**](CreateSmtpTemplate.md)| values to update in smtp template |
66
+ **smtp_template** | [**CreateSmtpTemplate**](CreateSmtpTemplate.md)| values to update in transactional email template |
62
67
 
63
68
  ### Return type
64
69
 
@@ -137,7 +142,7 @@ nil (empty response body)
137
142
  # **delete_smtp_template**
138
143
  > delete_smtp_template(template_id)
139
144
 
140
- Delete an inactive smtp template
145
+ Delete an inactive email template
141
146
 
142
147
  ### Example
143
148
  ```ruby
@@ -162,7 +167,7 @@ template_id = 789 # Integer | id of the template
162
167
 
163
168
 
164
169
  begin
165
- #Delete an inactive smtp template
170
+ #Delete an inactive email template
166
171
  api_instance.delete_smtp_template(template_id)
167
172
  rescue SibApiV3Sdk::ApiError => e
168
173
  puts "Exception when calling SMTPApi->delete_smtp_template: #{e}"
@@ -193,7 +198,7 @@ nil (empty response body)
193
198
  # **get_aggregated_smtp_report**
194
199
  > GetAggregatedReport get_aggregated_smtp_report(opts)
195
200
 
196
- Get your SMTP activity aggregated over a period of time
201
+ Get your transactional email activity aggregated over a period of time
197
202
 
198
203
  ### Example
199
204
  ```ruby
@@ -215,14 +220,14 @@ end
215
220
  api_instance = SibApiV3Sdk::SMTPApi.new
216
221
 
217
222
  opts = {
218
- start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
219
- end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
223
+ start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
224
+ end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
220
225
  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
221
- tag: "tag_example" # String | Tag of the emails
226
+ tag: 'tag_example' # String | Tag of the emails
222
227
  }
223
228
 
224
229
  begin
225
- #Get your SMTP activity aggregated over a period of time
230
+ #Get your transactional email activity aggregated over a period of time
226
231
  result = api_instance.get_aggregated_smtp_report(opts)
227
232
  p result
228
233
  rescue SibApiV3Sdk::ApiError => e
@@ -257,7 +262,7 @@ Name | Type | Description | Notes
257
262
  # **get_email_event_report**
258
263
  > GetEmailEventReport get_email_event_report(opts)
259
264
 
260
- Get all your SMTP activity (unaggregated events)
265
+ Get all your transactional email activity (unaggregated events)
261
266
 
262
267
  ### Example
263
268
  ```ruby
@@ -281,18 +286,18 @@ api_instance = SibApiV3Sdk::SMTPApi.new
281
286
  opts = {
282
287
  limit: 50, # Integer | Number limitation for the result returned
283
288
  offset: 0, # Integer | Beginning point in the list to retrieve from.
284
- start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
285
- end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
289
+ start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
290
+ end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
286
291
  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
287
- email: "email_example", # String | Filter the report for a specific email addresses
288
- event: "event_example", # String | Filter the report for a specific event type
289
- tags: "tags_example", # String | Filter the report for tags (serialized and urlencoded array)
290
- message_id: "message_id_example", # String | Filter on a specific message id
292
+ email: 'email_example', # String | Filter the report for a specific email addresses
293
+ event: 'event_example', # String | Filter the report for a specific event type
294
+ tags: 'tags_example', # String | Filter the report for tags (serialized and urlencoded array)
295
+ message_id: 'message_id_example', # String | Filter on a specific message id
291
296
  template_id: 789 # Integer | Filter on a specific template id
292
297
  }
293
298
 
294
299
  begin
295
- #Get all your SMTP activity (unaggregated events)
300
+ #Get all your transactional email activity (unaggregated events)
296
301
  result = api_instance.get_email_event_report(opts)
297
302
  p result
298
303
  rescue SibApiV3Sdk::ApiError => e
@@ -333,7 +338,7 @@ Name | Type | Description | Notes
333
338
  # **get_smtp_report**
334
339
  > GetReports get_smtp_report(opts)
335
340
 
336
- Get your SMTP activity aggregated per day
341
+ Get your transactional email activity aggregated per day
337
342
 
338
343
  ### Example
339
344
  ```ruby
@@ -355,16 +360,16 @@ end
355
360
  api_instance = SibApiV3Sdk::SMTPApi.new
356
361
 
357
362
  opts = {
358
- limit: 50, # Integer | Number of documents returned per page
363
+ limit: 10, # Integer | Number of documents returned per page
359
364
  offset: 0, # Integer | Index of the first document on the page
360
- start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
361
- end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
365
+ start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
366
+ end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
362
367
  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
363
- tag: "tag_example" # String | Tag of the emails
368
+ tag: 'tag_example' # String | Tag of the emails
364
369
  }
365
370
 
366
371
  begin
367
- #Get your SMTP activity aggregated per day
372
+ #Get your transactional email activity aggregated per day
368
373
  result = api_instance.get_smtp_report(opts)
369
374
  p result
370
375
  rescue SibApiV3Sdk::ApiError => e
@@ -376,7 +381,7 @@ end
376
381
 
377
382
  Name | Type | Description | Notes
378
383
  ------------- | ------------- | ------------- | -------------
379
- **limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
384
+ **limit** | **Integer**| Number of documents returned per page | [optional] [default to 10]
380
385
  **offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
381
386
  **start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional]
382
387
  **end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
@@ -401,7 +406,7 @@ Name | Type | Description | Notes
401
406
  # **get_smtp_template**
402
407
  > GetSmtpTemplateOverview get_smtp_template(template_id)
403
408
 
404
- Returns the template informations
409
+ Returns the template information
405
410
 
406
411
  ### Example
407
412
  ```ruby
@@ -426,7 +431,7 @@ template_id = 789 # Integer | id of the template
426
431
 
427
432
 
428
433
  begin
429
- #Returns the template informations
434
+ #Returns the template information
430
435
  result = api_instance.get_smtp_template(template_id)
431
436
  p result
432
437
  rescue SibApiV3Sdk::ApiError => e
@@ -458,7 +463,7 @@ Name | Type | Description | Notes
458
463
  # **get_smtp_templates**
459
464
  > GetSmtpTemplates get_smtp_templates(opts)
460
465
 
461
- Get the list of SMTP templates
466
+ Get the list of email templates
462
467
 
463
468
  ### Example
464
469
  ```ruby
@@ -486,7 +491,7 @@ opts = {
486
491
  }
487
492
 
488
493
  begin
489
- #Get the list of SMTP templates
494
+ #Get the list of email templates
490
495
  result = api_instance.get_smtp_templates(opts)
491
496
  p result
492
497
  rescue SibApiV3Sdk::ApiError => e
@@ -517,6 +522,197 @@ Name | Type | Description | Notes
517
522
 
518
523
 
519
524
 
525
+ # **get_transac_blocked_contacts**
526
+ > GetTransacBlockedContacts get_transac_blocked_contacts(opts)
527
+
528
+ Get the list of blocked or unsubscribed transactional contacts
529
+
530
+ ### Example
531
+ ```ruby
532
+ # load the gem
533
+ require 'sib-api-v3-sdk'
534
+ # setup authorization
535
+ SibApiV3Sdk.configure do |config|
536
+ # Configure API key authorization: api-key
537
+ config.api_key['api-key'] = 'YOUR API KEY'
538
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
539
+ #config.api_key_prefix['api-key'] = 'Bearer'
540
+
541
+ # Configure API key authorization: partner-key
542
+ config.api_key['partner-key'] = 'YOUR API KEY'
543
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
544
+ #config.api_key_prefix['partner-key'] = 'Bearer'
545
+ end
546
+
547
+ api_instance = SibApiV3Sdk::SMTPApi.new
548
+
549
+ opts = {
550
+ start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
551
+ end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
552
+ limit: 50, # Integer | Number of documents returned per page
553
+ offset: 0, # Integer | Index of the first document on the page
554
+ senders: ['senders_example'] # Array<String> | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
555
+ }
556
+
557
+ begin
558
+ #Get the list of blocked or unsubscribed transactional contacts
559
+ result = api_instance.get_transac_blocked_contacts(opts)
560
+ p result
561
+ rescue SibApiV3Sdk::ApiError => e
562
+ puts "Exception when calling SMTPApi->get_transac_blocked_contacts: #{e}"
563
+ end
564
+ ```
565
+
566
+ ### Parameters
567
+
568
+ Name | Type | Description | Notes
569
+ ------------- | ------------- | ------------- | -------------
570
+ **start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts | [optional]
571
+ **end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts | [optional]
572
+ **limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
573
+ **offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
574
+ **senders** | [**Array&lt;String&gt;**](String.md)| Comma separated list of emails of the senders from which contacts are blocked or unsubscribed | [optional]
575
+
576
+ ### Return type
577
+
578
+ [**GetTransacBlockedContacts**](GetTransacBlockedContacts.md)
579
+
580
+ ### Authorization
581
+
582
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
583
+
584
+ ### HTTP request headers
585
+
586
+ - **Content-Type**: application/json
587
+ - **Accept**: application/json
588
+
589
+
590
+
591
+ # **get_transac_email_content**
592
+ > GetTransacEmailContent get_transac_email_content(uuid)
593
+
594
+ Get the personalized content of a sent transactional email
595
+
596
+ ### Example
597
+ ```ruby
598
+ # load the gem
599
+ require 'sib-api-v3-sdk'
600
+ # setup authorization
601
+ SibApiV3Sdk.configure do |config|
602
+ # Configure API key authorization: api-key
603
+ config.api_key['api-key'] = 'YOUR API KEY'
604
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
605
+ #config.api_key_prefix['api-key'] = 'Bearer'
606
+
607
+ # Configure API key authorization: partner-key
608
+ config.api_key['partner-key'] = 'YOUR API KEY'
609
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
610
+ #config.api_key_prefix['partner-key'] = 'Bearer'
611
+ end
612
+
613
+ api_instance = SibApiV3Sdk::SMTPApi.new
614
+
615
+ uuid = 'uuid_example' # String | Unique id of the transactional email that has been sent to a particular contact
616
+
617
+
618
+ begin
619
+ #Get the personalized content of a sent transactional email
620
+ result = api_instance.get_transac_email_content(uuid)
621
+ p result
622
+ rescue SibApiV3Sdk::ApiError => e
623
+ puts "Exception when calling SMTPApi->get_transac_email_content: #{e}"
624
+ end
625
+ ```
626
+
627
+ ### Parameters
628
+
629
+ Name | Type | Description | Notes
630
+ ------------- | ------------- | ------------- | -------------
631
+ **uuid** | **String**| Unique id of the transactional email that has been sent to a particular contact |
632
+
633
+ ### Return type
634
+
635
+ [**GetTransacEmailContent**](GetTransacEmailContent.md)
636
+
637
+ ### Authorization
638
+
639
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
640
+
641
+ ### HTTP request headers
642
+
643
+ - **Content-Type**: application/json
644
+ - **Accept**: application/json
645
+
646
+
647
+
648
+ # **get_transac_emails_list**
649
+ > GetTransacEmailsList get_transac_emails_list(opts)
650
+
651
+ Get the list of transactional emails on the basis of allowed filters
652
+
653
+ This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
654
+
655
+ ### Example
656
+ ```ruby
657
+ # load the gem
658
+ require 'sib-api-v3-sdk'
659
+ # setup authorization
660
+ SibApiV3Sdk.configure do |config|
661
+ # Configure API key authorization: api-key
662
+ config.api_key['api-key'] = 'YOUR API KEY'
663
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
664
+ #config.api_key_prefix['api-key'] = 'Bearer'
665
+
666
+ # Configure API key authorization: partner-key
667
+ config.api_key['partner-key'] = 'YOUR API KEY'
668
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
669
+ #config.api_key_prefix['partner-key'] = 'Bearer'
670
+ end
671
+
672
+ api_instance = SibApiV3Sdk::SMTPApi.new
673
+
674
+ opts = {
675
+ email: 'email_example', # String | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
676
+ template_id: 789, # Integer | Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
677
+ message_id: 'message_id_example', # String | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
678
+ start_date: Date.parse('2013-10-20'), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
679
+ end_date: Date.parse('2013-10-20') # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
680
+ }
681
+
682
+ begin
683
+ #Get the list of transactional emails on the basis of allowed filters
684
+ result = api_instance.get_transac_emails_list(opts)
685
+ p result
686
+ rescue SibApiV3Sdk::ApiError => e
687
+ puts "Exception when calling SMTPApi->get_transac_emails_list: #{e}"
688
+ end
689
+ ```
690
+
691
+ ### Parameters
692
+
693
+ Name | Type | Description | Notes
694
+ ------------- | ------------- | ------------- | -------------
695
+ **email** | **String**| Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. | [optional]
696
+ **template_id** | **Integer**| Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. | [optional]
697
+ **message_id** | **String**| Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | [optional]
698
+ **start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
699
+ **end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
700
+
701
+ ### Return type
702
+
703
+ [**GetTransacEmailsList**](GetTransacEmailsList.md)
704
+
705
+ ### Authorization
706
+
707
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
708
+
709
+ ### HTTP request headers
710
+
711
+ - **Content-Type**: application/json
712
+ - **Accept**: application/json
713
+
714
+
715
+
520
716
  # **send_template**
521
717
  > SendTemplateEmail send_template(template_id, send_email)
522
718
 
@@ -695,10 +891,122 @@ Name | Type | Description | Notes
695
891
 
696
892
 
697
893
 
894
+ # **smtp_blocked_contacts_email_delete**
895
+ > smtp_blocked_contacts_email_delete(email)
896
+
897
+ Unblock or resubscribe a transactional contact
898
+
899
+ ### Example
900
+ ```ruby
901
+ # load the gem
902
+ require 'sib-api-v3-sdk'
903
+ # setup authorization
904
+ SibApiV3Sdk.configure do |config|
905
+ # Configure API key authorization: api-key
906
+ config.api_key['api-key'] = 'YOUR API KEY'
907
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
908
+ #config.api_key_prefix['api-key'] = 'Bearer'
909
+
910
+ # Configure API key authorization: partner-key
911
+ config.api_key['partner-key'] = 'YOUR API KEY'
912
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
913
+ #config.api_key_prefix['partner-key'] = 'Bearer'
914
+ end
915
+
916
+ api_instance = SibApiV3Sdk::SMTPApi.new
917
+
918
+ email = 'email_example' # String | contact email (urlencoded) to unblock.
919
+
920
+
921
+ begin
922
+ #Unblock or resubscribe a transactional contact
923
+ api_instance.smtp_blocked_contacts_email_delete(email)
924
+ rescue SibApiV3Sdk::ApiError => e
925
+ puts "Exception when calling SMTPApi->smtp_blocked_contacts_email_delete: #{e}"
926
+ end
927
+ ```
928
+
929
+ ### Parameters
930
+
931
+ Name | Type | Description | Notes
932
+ ------------- | ------------- | ------------- | -------------
933
+ **email** | **String**| contact email (urlencoded) to unblock. |
934
+
935
+ ### Return type
936
+
937
+ nil (empty response body)
938
+
939
+ ### Authorization
940
+
941
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
942
+
943
+ ### HTTP request headers
944
+
945
+ - **Content-Type**: application/json
946
+ - **Accept**: application/json
947
+
948
+
949
+
950
+ # **smtp_log_message_id_delete**
951
+ > smtp_log_message_id_delete(message_id)
952
+
953
+ Delete an SMTP transactional log
954
+
955
+ ### Example
956
+ ```ruby
957
+ # load the gem
958
+ require 'sib-api-v3-sdk'
959
+ # setup authorization
960
+ SibApiV3Sdk.configure do |config|
961
+ # Configure API key authorization: api-key
962
+ config.api_key['api-key'] = 'YOUR API KEY'
963
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
964
+ #config.api_key_prefix['api-key'] = 'Bearer'
965
+
966
+ # Configure API key authorization: partner-key
967
+ config.api_key['partner-key'] = 'YOUR API KEY'
968
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
969
+ #config.api_key_prefix['partner-key'] = 'Bearer'
970
+ end
971
+
972
+ api_instance = SibApiV3Sdk::SMTPApi.new
973
+
974
+ message_id = 'message_id_example' # String | MessageId of the transactional log to delete
975
+
976
+
977
+ begin
978
+ #Delete an SMTP transactional log
979
+ api_instance.smtp_log_message_id_delete(message_id)
980
+ rescue SibApiV3Sdk::ApiError => e
981
+ puts "Exception when calling SMTPApi->smtp_log_message_id_delete: #{e}"
982
+ end
983
+ ```
984
+
985
+ ### Parameters
986
+
987
+ Name | Type | Description | Notes
988
+ ------------- | ------------- | ------------- | -------------
989
+ **message_id** | **String**| MessageId of the transactional log to delete |
990
+
991
+ ### Return type
992
+
993
+ nil (empty response body)
994
+
995
+ ### Authorization
996
+
997
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
998
+
999
+ ### HTTP request headers
1000
+
1001
+ - **Content-Type**: application/json
1002
+ - **Accept**: application/json
1003
+
1004
+
1005
+
698
1006
  # **update_smtp_template**
699
1007
  > update_smtp_template(template_id, smtp_template)
700
1008
 
701
- Updates an smtp templates
1009
+ Update an email template
702
1010
 
703
1011
  ### Example
704
1012
  ```ruby
@@ -721,11 +1029,11 @@ api_instance = SibApiV3Sdk::SMTPApi.new
721
1029
 
722
1030
  template_id = 789 # Integer | id of the template
723
1031
 
724
- smtp_template = SibApiV3Sdk::UpdateSmtpTemplate.new # UpdateSmtpTemplate | values to update in smtp template
1032
+ smtp_template = SibApiV3Sdk::UpdateSmtpTemplate.new # UpdateSmtpTemplate | values to update in transactional email template
725
1033
 
726
1034
 
727
1035
  begin
728
- #Updates an smtp templates
1036
+ #Update an email template
729
1037
  api_instance.update_smtp_template(template_id, smtp_template)
730
1038
  rescue SibApiV3Sdk::ApiError => e
731
1039
  puts "Exception when calling SMTPApi->update_smtp_template: #{e}"
@@ -737,7 +1045,7 @@ end
737
1045
  Name | Type | Description | Notes
738
1046
  ------------- | ------------- | ------------- | -------------
739
1047
  **template_id** | **Integer**| id of the template |
740
- **smtp_template** | [**UpdateSmtpTemplate**](UpdateSmtpTemplate.md)| values to update in smtp template |
1048
+ **smtp_template** | [**UpdateSmtpTemplate**](UpdateSmtpTemplate.md)| values to update in transactional email template |
741
1049
 
742
1050
  ### Return type
743
1051