sib-api-v3-sdk 5.2.5 → 7.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (470) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/LICENSE.md +1 -1
  4. data/README.md +100 -75
  5. data/docs/AbTestCampaignResult.md +15 -0
  6. data/docs/AbTestCampaignResultClickedLinks.md +9 -0
  7. data/docs/AbTestCampaignResultStatistics.md +13 -0
  8. data/docs/AbTestVersionClicks.md +7 -0
  9. data/docs/AbTestVersionClicksInner.md +10 -0
  10. data/docs/AbTestVersionStats.md +9 -0
  11. data/docs/AccountApi.md +3 -3
  12. data/docs/AddContactToList.md +2 -1
  13. data/docs/AttributesApi.md +18 -18
  14. data/docs/ContactsApi.md +136 -73
  15. data/docs/CreateAttribute.md +1 -1
  16. data/docs/CreateChild.md +1 -0
  17. data/docs/CreateContact.md +2 -2
  18. data/docs/CreateDoiContact.md +13 -0
  19. data/docs/CreateEmailCampaign.md +4 -1
  20. data/docs/CreateEmailCampaignSender.md +1 -0
  21. data/docs/CreateReseller.md +1 -0
  22. data/docs/CreateSender.md +1 -1
  23. data/docs/CreateSmsCampaign.md +1 -1
  24. data/docs/CreateSmtpTemplateSender.md +1 -0
  25. data/docs/CreateWebhook.md +2 -2
  26. data/docs/EmailCampaignsApi.md +202 -25
  27. data/docs/EmailExportRecipients.md +1 -1
  28. data/docs/FoldersApi.md +12 -12
  29. data/docs/GetAggregatedReport.md +13 -13
  30. data/docs/GetCampaignStats.md +1 -0
  31. data/docs/GetChildAccountCreationStatus.md +8 -0
  32. data/docs/GetChildrenList.md +1 -0
  33. data/docs/GetDeviceBrowserStats.md +11 -0
  34. data/docs/GetEmailCampaign.md +1 -0
  35. data/docs/GetExtendedCampaignOverview.md +1 -0
  36. data/docs/GetExtendedCampaignOverviewSender.md +1 -0
  37. data/docs/GetExtendedCampaignStats.md +2 -0
  38. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +1 -1
  39. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +1 -1
  40. data/docs/GetSharedTemplateUrl.md +8 -0
  41. data/docs/GetSmtpTemplateOverview.md +1 -0
  42. data/docs/GetSmtpTemplateOverviewSender.md +1 -0
  43. data/docs/GetStatsByBrowser.md +7 -0
  44. data/docs/GetStatsByDevice.md +11 -0
  45. data/docs/GetTransacBlockedContacts.md +9 -0
  46. data/docs/GetTransacBlockedContactsContacts.md +11 -0
  47. data/docs/GetTransacBlockedContactsReason.md +9 -0
  48. data/docs/GetTransacEmailsListTransactionalEmails.md +2 -0
  49. data/docs/ListsApi.md +17 -17
  50. data/docs/PostContactInfoContacts.md +1 -0
  51. data/docs/RemainingCreditModelChild.md +2 -2
  52. data/docs/RemainingCreditModelReseller.md +2 -2
  53. data/docs/RemoveContactFromList.md +3 -2
  54. data/docs/RequestContactExport.md +3 -2
  55. data/docs/RequestContactExportCustomContactFilter.md +13 -0
  56. data/docs/RequestContactImport.md +2 -2
  57. data/docs/RequestSMSRecipientExport.md +1 -1
  58. data/docs/ResellerApi.md +158 -91
  59. data/docs/SMSCampaignsApi.md +24 -24
  60. data/docs/SendEmail.md +3 -3
  61. data/docs/SendReport.md +1 -1
  62. data/docs/SendReportEmail.md +1 -5
  63. data/docs/SendSmtpEmail.md +4 -4
  64. data/docs/SendSmtpEmailBcc.md +1 -1
  65. data/docs/SendSmtpEmailCc.md +1 -1
  66. data/docs/SendSmtpEmailReplyTo.md +1 -1
  67. data/docs/SendSmtpEmailSender.md +2 -1
  68. data/docs/SendSmtpEmailTo.md +1 -1
  69. data/docs/SendTransacSms.md +2 -2
  70. data/docs/SendersApi.md +8 -8
  71. data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +254 -73
  72. data/docs/TransactionalSMSApi.md +17 -17
  73. data/docs/UpdateAttribute.md +1 -1
  74. data/docs/UpdateChildAccountStatus.md +1 -0
  75. data/docs/UpdateContact.md +1 -1
  76. data/docs/UpdateEmailCampaign.md +4 -1
  77. data/docs/UpdateEmailCampaignSender.md +1 -0
  78. data/docs/UpdateSmsCampaign.md +1 -1
  79. data/docs/UpdateSmtpTemplateSender.md +1 -0
  80. data/docs/UpdateWebhook.md +1 -1
  81. data/docs/UploadImageToGallery.md +9 -0
  82. data/docs/WebhooksApi.md +1 -1
  83. data/lib/sib-api-v3-sdk.rb +20 -3
  84. data/lib/sib-api-v3-sdk/api/account_api.rb +8 -11
  85. data/lib/sib-api-v3-sdk/api/attributes_api.rb +23 -35
  86. data/lib/sib-api-v3-sdk/api/contacts_api.rb +203 -220
  87. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +204 -73
  88. data/lib/sib-api-v3-sdk/api/folders_api.rb +29 -47
  89. data/lib/sib-api-v3-sdk/api/lists_api.rb +42 -69
  90. data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
  91. data/lib/sib-api-v3-sdk/api/reseller_api.rb +233 -214
  92. data/lib/sib-api-v3-sdk/api/senders_api.rb +25 -43
  93. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +47 -73
  94. data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +253 -122
  95. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +19 -31
  96. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
  97. data/lib/sib-api-v3-sdk/api_client.rb +10 -10
  98. data/lib/sib-api-v3-sdk/api_error.rb +2 -2
  99. data/lib/sib-api-v3-sdk/configuration.rb +3 -3
  100. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +298 -0
  101. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +202 -0
  102. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +258 -0
  103. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +175 -0
  104. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +219 -0
  105. data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +205 -0
  106. data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
  107. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +22 -15
  108. data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
  109. data/lib/sib-api-v3-sdk/models/create_attribute.rb +11 -15
  110. data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
  111. data/lib/sib-api-v3-sdk/models/create_child.rb +58 -19
  112. data/lib/sib-api-v3-sdk/models/create_contact.rb +9 -14
  113. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +258 -0
  114. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +80 -30
  115. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
  116. data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
  117. data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
  118. data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
  119. data/lib/sib-api-v3-sdk/models/create_reseller.rb +20 -15
  120. data/lib/sib-api-v3-sdk/models/create_sender.rb +10 -15
  121. data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
  122. data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
  123. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +17 -22
  124. data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
  125. data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +8 -13
  126. data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +10 -15
  127. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
  128. data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
  129. data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
  130. data/lib/sib-api-v3-sdk/models/create_webhook.rb +14 -18
  131. data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
  132. data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
  133. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +12 -16
  134. data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
  135. data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
  136. data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
  137. data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
  138. data/lib/sib-api-v3-sdk/models/get_account_relay.rb +9 -13
  139. data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +10 -14
  140. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +7 -77
  141. data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
  142. data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
  143. data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
  144. data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
  145. data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
  146. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +29 -24
  147. data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
  148. data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
  149. data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
  150. data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
  151. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
  152. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
  153. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
  154. data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
  155. data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
  156. data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
  157. data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
  158. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
  159. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
  160. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
  161. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
  162. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
  163. data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
  164. data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
  165. data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
  166. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +40 -34
  167. data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
  168. data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
  169. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
  170. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +40 -34
  171. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
  172. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
  173. data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
  174. data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
  175. data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
  176. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
  177. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
  178. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
  179. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
  180. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
  181. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
  182. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +8 -18
  183. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +9 -19
  184. data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
  185. data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
  186. data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
  187. data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
  188. data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
  189. data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
  190. data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
  191. data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
  192. data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
  193. data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
  194. data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
  195. data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
  196. data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
  197. data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
  198. data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
  199. data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
  200. data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
  201. data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
  202. data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
  203. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
  204. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
  205. data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
  206. data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
  207. data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
  208. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
  209. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +31 -26
  210. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
  211. data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +7 -12
  212. data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
  213. data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
  214. data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
  215. data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
  216. data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
  217. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
  218. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
  219. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
  220. data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +13 -18
  221. data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +9 -14
  222. data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +7 -12
  223. data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +36 -19
  224. data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
  225. data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
  226. data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
  227. data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
  228. data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
  229. data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
  230. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +19 -14
  231. data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
  232. data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
  233. data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
  234. data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +11 -15
  235. data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +11 -16
  236. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +22 -15
  237. data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
  238. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +19 -20
  239. data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
  240. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +9 -14
  241. data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
  242. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +12 -16
  243. data/lib/sib-api-v3-sdk/models/send_email.rb +11 -16
  244. data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
  245. data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
  246. data/lib/sib-api-v3-sdk/models/send_report_email.rb +12 -100
  247. data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
  248. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +12 -17
  249. data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
  250. data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
  251. data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
  252. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +10 -14
  253. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +22 -16
  254. data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
  255. data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
  256. data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
  257. data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
  258. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +21 -25
  259. data/lib/sib-api-v3-sdk/models/update_attribute.rb +8 -13
  260. data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
  261. data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
  262. data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
  263. data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +19 -14
  264. data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
  265. data/lib/sib-api-v3-sdk/models/update_contact.rb +8 -13
  266. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +78 -28
  267. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
  268. data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
  269. data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
  270. data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
  271. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +13 -19
  272. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +7 -12
  273. data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
  274. data/lib/sib-api-v3-sdk/models/update_webhook.rb +8 -12
  275. data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
  276. data/lib/sib-api-v3-sdk/version.rb +3 -3
  277. data/sib-api-v3-sdk.gemspec +5 -5
  278. data/spec/api/account_api_spec.rb +4 -5
  279. data/spec/api/attributes_api_spec.rb +10 -14
  280. data/spec/api/contacts_api_spec.rb +62 -73
  281. data/spec/api/email_campaigns_api_spec.rb +54 -28
  282. data/spec/api/folders_api_spec.rb +12 -18
  283. data/spec/api/lists_api_spec.rb +17 -26
  284. data/spec/api/process_api_spec.rb +4 -6
  285. data/spec/api/reseller_api_spec.rb +53 -54
  286. data/spec/api/senders_api_spec.rb +10 -16
  287. data/spec/api/sms_campaigns_api_spec.rb +19 -27
  288. data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +65 -39
  289. data/spec/api/transactional_sms_api_spec.rb +8 -12
  290. data/spec/api/webhooks_api_spec.rb +7 -12
  291. data/spec/api_client_spec.rb +36 -36
  292. data/spec/configuration_spec.rb +10 -10
  293. data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
  294. data/spec/models/ab_test_campaign_result_spec.rb +91 -0
  295. data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
  296. data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
  297. data/spec/models/ab_test_version_clicks_spec.rb +35 -0
  298. data/spec/models/ab_test_version_stats_spec.rb +47 -0
  299. data/spec/models/add_child_domain_spec.rb +3 -4
  300. data/spec/models/add_contact_to_list_spec.rb +9 -4
  301. data/spec/models/add_credits_spec.rb +4 -5
  302. data/spec/models/create_attribute_enumeration_spec.rb +4 -5
  303. data/spec/models/create_attribute_spec.rb +9 -10
  304. data/spec/models/create_child_spec.rb +17 -8
  305. data/spec/models/create_contact_spec.rb +9 -10
  306. data/spec/models/create_doi_contact_spec.rb +71 -0
  307. data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
  308. data/spec/models/create_email_campaign_sender_spec.rb +10 -5
  309. data/spec/models/create_email_campaign_spec.rb +49 -32
  310. data/spec/models/create_list_spec.rb +4 -5
  311. data/spec/models/create_model_spec.rb +3 -4
  312. data/spec/models/create_reseller_spec.rb +9 -4
  313. data/spec/models/create_sender_ips_spec.rb +5 -6
  314. data/spec/models/create_sender_model_spec.rb +5 -6
  315. data/spec/models/create_sender_spec.rb +5 -6
  316. data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
  317. data/spec/models/create_sms_campaign_spec.rb +7 -8
  318. data/spec/models/create_smtp_email_spec.rb +3 -4
  319. data/spec/models/create_smtp_template_sender_spec.rb +10 -5
  320. data/spec/models/create_smtp_template_spec.rb +12 -13
  321. data/spec/models/create_update_contact_model_spec.rb +3 -4
  322. data/spec/models/create_update_folder_spec.rb +3 -4
  323. data/spec/models/create_webhook_spec.rb +14 -15
  324. data/spec/models/created_process_id_spec.rb +3 -4
  325. data/spec/models/delete_hardbounces_spec.rb +5 -6
  326. data/spec/models/email_export_recipients_spec.rb +8 -9
  327. data/spec/models/error_model_spec.rb +8 -9
  328. data/spec/models/get_account_marketing_automation_spec.rb +4 -5
  329. data/spec/models/get_account_plan_spec.rb +16 -17
  330. data/spec/models/get_account_relay_data_spec.rb +5 -6
  331. data/spec/models/get_account_relay_spec.rb +4 -5
  332. data/spec/models/get_account_spec.rb +10 -11
  333. data/spec/models/get_aggregated_report_spec.rb +15 -16
  334. data/spec/models/get_attributes_attributes_spec.rb +15 -16
  335. data/spec/models/get_attributes_enumeration_spec.rb +4 -5
  336. data/spec/models/get_attributes_spec.rb +3 -4
  337. data/spec/models/get_campaign_overview_spec.rb +23 -24
  338. data/spec/models/get_campaign_recipients_spec.rb +4 -5
  339. data/spec/models/get_campaign_stats_spec.rb +20 -15
  340. data/spec/models/get_child_account_creation_status_spec.rb +41 -0
  341. data/spec/models/get_child_domain_spec.rb +4 -5
  342. data/spec/models/get_child_domains_spec.rb +2 -3
  343. data/spec/models/get_child_info_api_keys_spec.rb +4 -5
  344. data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
  345. data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
  346. data/spec/models/get_child_info_credits_spec.rb +4 -5
  347. data/spec/models/get_child_info_spec.rb +11 -12
  348. data/spec/models/get_child_info_statistics_spec.rb +5 -6
  349. data/spec/models/get_children_list_spec.rb +9 -4
  350. data/spec/models/get_client_spec.rb +6 -7
  351. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
  352. data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
  353. data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
  354. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
  355. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
  356. data/spec/models/get_contact_details_spec.rb +11 -12
  357. data/spec/models/get_contacts_spec.rb +4 -5
  358. data/spec/models/get_device_browser_stats_spec.rb +59 -0
  359. data/spec/models/get_email_campaign_spec.rb +46 -41
  360. data/spec/models/get_email_campaigns_spec.rb +4 -5
  361. data/spec/models/get_email_event_report_events_spec.rb +16 -17
  362. data/spec/models/get_email_event_report_spec.rb +3 -4
  363. data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
  364. data/spec/models/get_extended_campaign_overview_spec.rb +44 -39
  365. data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
  366. data/spec/models/get_extended_client_address_spec.rb +6 -7
  367. data/spec/models/get_extended_client_spec.rb +7 -8
  368. data/spec/models/get_extended_contact_details_spec.rb +12 -13
  369. data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
  370. data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
  371. data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
  372. data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
  373. data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
  374. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
  375. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
  376. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
  377. data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
  378. data/spec/models/get_extended_list_spec.rb +10 -11
  379. data/spec/models/get_folder_lists_spec.rb +4 -5
  380. data/spec/models/get_folder_spec.rb +7 -8
  381. data/spec/models/get_folders_spec.rb +4 -5
  382. data/spec/models/get_ip_from_sender_spec.rb +6 -7
  383. data/spec/models/get_ip_spec.rb +6 -7
  384. data/spec/models/get_ips_from_sender_spec.rb +3 -4
  385. data/spec/models/get_ips_spec.rb +3 -4
  386. data/spec/models/get_list_spec.rb +6 -7
  387. data/spec/models/get_lists_spec.rb +4 -5
  388. data/spec/models/get_process_spec.rb +10 -11
  389. data/spec/models/get_processes_spec.rb +4 -5
  390. data/spec/models/get_reports_reports_spec.rb +15 -16
  391. data/spec/models/get_reports_spec.rb +3 -4
  392. data/spec/models/get_senders_list_ips_spec.rb +5 -6
  393. data/spec/models/get_senders_list_senders_spec.rb +7 -8
  394. data/spec/models/get_senders_list_spec.rb +3 -4
  395. data/spec/models/get_shared_template_url_spec.rb +41 -0
  396. data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
  397. data/spec/models/get_sms_campaign_spec.rb +16 -17
  398. data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
  399. data/spec/models/get_sms_campaigns_spec.rb +4 -5
  400. data/spec/models/get_sms_event_report_events_spec.rb +13 -14
  401. data/spec/models/get_sms_event_report_spec.rb +3 -4
  402. data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
  403. data/spec/models/get_smtp_template_overview_spec.rb +20 -15
  404. data/spec/models/get_smtp_templates_spec.rb +4 -5
  405. data/spec/models/get_sso_token_spec.rb +3 -4
  406. data/spec/models/get_stats_by_browser_spec.rb +35 -0
  407. data/spec/models/get_stats_by_device_spec.rb +59 -0
  408. data/spec/models/get_stats_by_domain_spec.rb +2 -3
  409. data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
  410. data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
  411. data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
  412. data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
  413. data/spec/models/get_transac_email_content_events_spec.rb +4 -5
  414. data/spec/models/get_transac_email_content_spec.rb +9 -10
  415. data/spec/models/get_transac_emails_list_spec.rb +3 -4
  416. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +20 -9
  417. data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
  418. data/spec/models/get_transac_sms_report_spec.rb +3 -4
  419. data/spec/models/get_webhook_spec.rb +13 -14
  420. data/spec/models/get_webhooks_spec.rb +3 -4
  421. data/spec/models/manage_ip_spec.rb +3 -4
  422. data/spec/models/post_contact_info_contacts_spec.rb +11 -6
  423. data/spec/models/post_contact_info_spec.rb +3 -4
  424. data/spec/models/post_send_failed_spec.rb +7 -8
  425. data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
  426. data/spec/models/remaining_credit_model_child_spec.rb +4 -5
  427. data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
  428. data/spec/models/remaining_credit_model_spec.rb +4 -5
  429. data/spec/models/remove_contact_from_list_spec.rb +10 -5
  430. data/spec/models/remove_credits_spec.rb +4 -5
  431. data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
  432. data/spec/models/request_contact_export_spec.rb +11 -6
  433. data/spec/models/request_contact_import_new_list_spec.rb +4 -5
  434. data/spec/models/request_contact_import_spec.rb +11 -12
  435. data/spec/models/request_sms_recipient_export_spec.rb +8 -9
  436. data/spec/models/send_email_attachment_spec.rb +4 -5
  437. data/spec/models/send_email_spec.rb +11 -12
  438. data/spec/models/send_report_email_spec.rb +4 -33
  439. data/spec/models/send_report_spec.rb +8 -9
  440. data/spec/models/send_sms_spec.rb +7 -8
  441. data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
  442. data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
  443. data/spec/models/send_smtp_email_cc_spec.rb +4 -5
  444. data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
  445. data/spec/models/send_smtp_email_sender_spec.rb +10 -5
  446. data/spec/models/send_smtp_email_spec.rb +15 -16
  447. data/spec/models/send_smtp_email_to_spec.rb +4 -5
  448. data/spec/models/send_template_email_spec.rb +3 -4
  449. data/spec/models/send_test_email_spec.rb +3 -4
  450. data/spec/models/send_test_sms_spec.rb +3 -4
  451. data/spec/models/send_transac_sms_spec.rb +12 -13
  452. data/spec/models/update_attribute_enumeration_spec.rb +4 -5
  453. data/spec/models/update_attribute_spec.rb +4 -5
  454. data/spec/models/update_campaign_status_spec.rb +7 -8
  455. data/spec/models/update_child_account_status_spec.rb +11 -6
  456. data/spec/models/update_child_domain_spec.rb +3 -4
  457. data/spec/models/update_child_spec.rb +7 -8
  458. data/spec/models/update_contact_spec.rb +8 -9
  459. data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
  460. data/spec/models/update_email_campaign_sender_spec.rb +10 -5
  461. data/spec/models/update_email_campaign_spec.rb +49 -32
  462. data/spec/models/update_list_spec.rb +4 -5
  463. data/spec/models/update_sender_spec.rb +5 -6
  464. data/spec/models/update_sms_campaign_spec.rb +7 -8
  465. data/spec/models/update_smtp_template_sender_spec.rb +10 -5
  466. data/spec/models/update_smtp_template_spec.rb +12 -13
  467. data/spec/models/update_webhook_spec.rb +9 -10
  468. data/spec/models/upload_image_to_gallery_spec.rb +47 -0
  469. data/spec/spec_helper.rb +2 -2
  470. metadata +78 -10
@@ -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}"
@@ -8,9 +8,9 @@ Name | Type | Description | Notes
8
8
  **email_cc** | **Array<String>** | List of the email addresses of the recipients in cc | [optional]
9
9
  **reply_to** | **String** | Email address which shall be used by campaign recipients to reply back | [optional]
10
10
  **attachment_url** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional]
11
- **attachment** | [**Array<SendEmailAttachment>**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, [{'content':'base64 encoded content 1', 'name':'attcahment1'}, {'content':'base64 encoded content 2', 'name':'attcahment2'}]. | [optional]
12
- **headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} | [optional]
13
- **attributes** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} | [optional]
11
+ **attachment** | [**Array<SendEmailAttachment>**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, [{\"content\":\"base64 encoded content 1\", \"name\":\"attcahment1\"}, {\"content\":\"base64 encoded content 2\", \"name\":\"attcahment2\"}]. | [optional]
12
+ **headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, {\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"} | [optional]
13
+ **attributes** | **Object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"} | [optional]
14
14
  **tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
15
15
 
16
16
 
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **language** | **String** | Language of email content for campaign report sending. | [optional] [default to "fr"]
6
+ **language** | **String** | Language of email content for campaign report sending. | [optional] [default to 'fr']
7
7
  **email** | [**SendReportEmail**](SendReportEmail.md) | |
8
8
 
9
9
 
@@ -3,11 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **subject** | **String** | Subject of the email message |
7
6
  **to** | **Array<String>** | Email addresses of the recipients |
8
- **content_type** | **String** | Type of the message body | [optional] [default to "html"]
9
- **bcc** | **Array<String>** | Email addresses of the recipients in bcc | [optional]
10
- **cc** | **Array<String>** | Email addresses of the recipients in cc | [optional]
11
- **body** | **String** | Body of the email message |
7
+ **body** | **String** | Custom text message to be presented in the report email. |
12
8
 
13
9
 
@@ -4,17 +4,17 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional]
7
- **to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}] |
7
+ **to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] |
8
8
  **bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
9
9
  **cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
10
10
  **html_content** | **String** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional]
11
11
  **text_content** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional]
12
12
  **subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
13
13
  **reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
14
- **attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"My attachment 1\"}, {\"content\":\"base64 exmaple content\", \"name\":\"My attachment 2\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then only attachment url is accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
15
- **headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} | [optional]
14
+ **attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
15
+ **headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [optional]
16
16
  **template_id** | **Integer** | Id of the template | [optional]
17
- **params** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if template is in New Template Language format. | [optional]
17
+ **params** | **Object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional]
18
18
  **tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
19
19
 
20
20
 
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **email** | **String** | Email address of the recipient in bcc |
7
- **name** | **String** | Name of the recipient in bcc | [optional]
7
+ **name** | **String** | Name of the recipient in bcc. Maximum allowed characters are 70. | [optional]
8
8
 
9
9
 
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **email** | **String** | Email address of the recipient in cc |
7
- **name** | **String** | Name of the recipient in cc | [optional]
7
+ **name** | **String** | Name of the recipient in cc. Maximum allowed characters are 70. | [optional]
8
8
 
9
9
 
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **email** | **String** | Email address in reply to |
7
- **name** | **String** | Name in reply to | [optional]
7
+ **name** | **String** | Name in reply to. Maximum allowed characters are 70. | [optional]
8
8
 
9
9
 
@@ -3,7 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **name** | **String** | Name of the sender from which the emails will be sent | [optional]
6
+ **name** | **String** | Name of the sender from which the emails will be sent. Maximum allowed characters are 70. | [optional]
7
7
  **email** | **String** | Email of the sender from which the emails will be sent |
8
+ **id** | **Integer** | Id of the sender from which the emails will be sent | [optional]
8
9
 
9
10
 
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **email** | **String** | Email address of the recipient |
7
- **name** | **String** | Name of the recipient | [optional]
7
+ **name** | **String** | Name of the recipient. Maximum allowed characters are 70. | [optional]
8
8
 
9
9
 
@@ -3,10 +3,10 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **sender** | **String** | Name of the sender. Only alphanumeric characters. No more than 11 characters |
6
+ **sender** | **String** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** |
7
7
  **recipient** | **String** | Mobile number to send SMS with the country code |
8
8
  **content** | **String** | Content of the message. If more than 160 characters long, will be sent as multiple text messages |
9
- **type** | **String** | Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. | [optional] [default to "transactional"]
9
+ **type** | **String** | Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. | [optional] [default to 'transactional']
10
10
  **tag** | **String** | Tag of the message | [optional]
11
11
  **web_url** | **String** | Webhook to call for each event triggered by the message (delivered etc.) | [optional]
12
12
 
@@ -6,8 +6,8 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**create_sender**](SendersApi.md#create_sender) | **POST** /senders | Create a new sender
8
8
  [**delete_sender**](SendersApi.md#delete_sender) | **DELETE** /senders/{senderId} | Delete a sender
9
- [**get_ips**](SendersApi.md#get_ips) | **GET** /senders/ips | Return all the dedicated IPs for your account
10
- [**get_ips_from_sender**](SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Return all the dedicated IPs for a sender
9
+ [**get_ips**](SendersApi.md#get_ips) | **GET** /senders/ips | Get all the dedicated IPs for your account
10
+ [**get_ips_from_sender**](SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
11
11
  [**get_senders**](SendersApi.md#get_senders) | **GET** /senders | Get the list of all your senders
12
12
  [**update_sender**](SendersApi.md#update_sender) | **PUT** /senders/{senderId} | Update a sender
13
13
 
@@ -129,7 +129,7 @@ nil (empty response body)
129
129
  # **get_ips**
130
130
  > GetIps get_ips
131
131
 
132
- Return all the dedicated IPs for your account
132
+ Get all the dedicated IPs for your account
133
133
 
134
134
  ### Example
135
135
  ```ruby
@@ -151,7 +151,7 @@ end
151
151
  api_instance = SibApiV3Sdk::SendersApi.new
152
152
 
153
153
  begin
154
- #Return all the dedicated IPs for your account
154
+ #Get all the dedicated IPs for your account
155
155
  result = api_instance.get_ips
156
156
  p result
157
157
  rescue SibApiV3Sdk::ApiError => e
@@ -180,7 +180,7 @@ This endpoint does not need any parameter.
180
180
  # **get_ips_from_sender**
181
181
  > GetIpsFromSender get_ips_from_sender(sender_id)
182
182
 
183
- Return all the dedicated IPs for a sender
183
+ Get all the dedicated IPs for a sender
184
184
 
185
185
  ### Example
186
186
  ```ruby
@@ -205,7 +205,7 @@ sender_id = 789 # Integer | Id of the sender
205
205
 
206
206
 
207
207
  begin
208
- #Return all the dedicated IPs for a sender
208
+ #Get all the dedicated IPs for a sender
209
209
  result = api_instance.get_ips_from_sender(sender_id)
210
210
  p result
211
211
  rescue SibApiV3Sdk::ApiError => e
@@ -259,8 +259,8 @@ end
259
259
  api_instance = SibApiV3Sdk::SendersApi.new
260
260
 
261
261
  opts = {
262
- ip: "ip_example", # String | Filter your senders for a specific ip (available for dedicated IP usage only)
263
- domain: "domain_example" # String | Filter your senders for a specific domain
262
+ ip: 'ip_example', # String | Filter your senders for a specific ip (available for dedicated IP usage only)
263
+ domain: 'domain_example' # String | Filter your senders for a specific domain
264
264
  }
265
265
 
266
266
  begin
@@ -1,29 +1,32 @@
1
- # SibApiV3Sdk::SMTPApi
1
+ # SibApiV3Sdk::TransactionalEmailsApi
2
2
 
3
3
  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 a transactional email template
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 transactional 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 informations
14
- [**get_smtp_templates**](SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of transactional email templates
15
- [**get_transac_email_content**](SMTPApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
16
- [**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
17
- [**send_template**](SMTPApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
18
- [**send_test_template**](SMTPApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
19
- [**send_transac_email**](SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
20
- [**update_smtp_template**](SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Updates a transactional email templates
7
+ [**create_smtp_template**](TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
8
+ [**delete_hardbounces**](TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
9
+ [**delete_smtp_template**](TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
10
+ [**get_aggregated_smtp_report**](TransactionalEmailsApi.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**](TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
12
+ [**get_smtp_report**](TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
13
+ [**get_smtp_template**](TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
14
+ [**get_smtp_templates**](TransactionalEmailsApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
15
+ [**get_transac_blocked_contacts**](TransactionalEmailsApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
16
+ [**get_transac_email_content**](TransactionalEmailsApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
17
+ [**get_transac_emails_list**](TransactionalEmailsApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
18
+ [**send_template**](TransactionalEmailsApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
19
+ [**send_test_template**](TransactionalEmailsApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
20
+ [**send_transac_email**](TransactionalEmailsApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
21
+ [**smtp_blocked_contacts_email_delete**](TransactionalEmailsApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
22
+ [**smtp_log_message_id_delete**](TransactionalEmailsApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
23
+ [**update_smtp_template**](TransactionalEmailsApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
21
24
 
22
25
 
23
26
  # **create_smtp_template**
24
27
  > CreateModel create_smtp_template(smtp_template)
25
28
 
26
- Create a transactional email template
29
+ Create an email template
27
30
 
28
31
  ### Example
29
32
  ```ruby
@@ -42,17 +45,17 @@ SibApiV3Sdk.configure do |config|
42
45
  #config.api_key_prefix['partner-key'] = 'Bearer'
43
46
  end
44
47
 
45
- api_instance = SibApiV3Sdk::SMTPApi.new
48
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
46
49
 
47
50
  smtp_template = SibApiV3Sdk::CreateSmtpTemplate.new # CreateSmtpTemplate | values to update in transactional email template
48
51
 
49
52
 
50
53
  begin
51
- #Create a transactional email template
54
+ #Create an email template
52
55
  result = api_instance.create_smtp_template(smtp_template)
53
56
  p result
54
57
  rescue SibApiV3Sdk::ApiError => e
55
- puts "Exception when calling SMTPApi->create_smtp_template: #{e}"
58
+ puts "Exception when calling TransactionalEmailsApi->create_smtp_template: #{e}"
56
59
  end
57
60
  ```
58
61
 
@@ -101,7 +104,7 @@ SibApiV3Sdk.configure do |config|
101
104
  #config.api_key_prefix['partner-key'] = 'Bearer'
102
105
  end
103
106
 
104
- api_instance = SibApiV3Sdk::SMTPApi.new
107
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
105
108
 
106
109
  opts = {
107
110
  delete_hardbounces: SibApiV3Sdk::DeleteHardbounces.new # DeleteHardbounces | values to delete hardbounces
@@ -111,7 +114,7 @@ begin
111
114
  #Delete hardbounces
112
115
  api_instance.delete_hardbounces(opts)
113
116
  rescue SibApiV3Sdk::ApiError => e
114
- puts "Exception when calling SMTPApi->delete_hardbounces: #{e}"
117
+ puts "Exception when calling TransactionalEmailsApi->delete_hardbounces: #{e}"
115
118
  end
116
119
  ```
117
120
 
@@ -139,7 +142,7 @@ nil (empty response body)
139
142
  # **delete_smtp_template**
140
143
  > delete_smtp_template(template_id)
141
144
 
142
- Delete an inactive transactional email template
145
+ Delete an inactive email template
143
146
 
144
147
  ### Example
145
148
  ```ruby
@@ -158,16 +161,16 @@ SibApiV3Sdk.configure do |config|
158
161
  #config.api_key_prefix['partner-key'] = 'Bearer'
159
162
  end
160
163
 
161
- api_instance = SibApiV3Sdk::SMTPApi.new
164
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
162
165
 
163
166
  template_id = 789 # Integer | id of the template
164
167
 
165
168
 
166
169
  begin
167
- #Delete an inactive transactional email template
170
+ #Delete an inactive email template
168
171
  api_instance.delete_smtp_template(template_id)
169
172
  rescue SibApiV3Sdk::ApiError => e
170
- puts "Exception when calling SMTPApi->delete_smtp_template: #{e}"
173
+ puts "Exception when calling TransactionalEmailsApi->delete_smtp_template: #{e}"
171
174
  end
172
175
  ```
173
176
 
@@ -214,13 +217,13 @@ SibApiV3Sdk.configure do |config|
214
217
  #config.api_key_prefix['partner-key'] = 'Bearer'
215
218
  end
216
219
 
217
- api_instance = SibApiV3Sdk::SMTPApi.new
220
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
218
221
 
219
222
  opts = {
220
- 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
221
- 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
222
225
  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
223
- tag: "tag_example" # String | Tag of the emails
226
+ tag: 'tag_example' # String | Tag of the emails
224
227
  }
225
228
 
226
229
  begin
@@ -228,7 +231,7 @@ begin
228
231
  result = api_instance.get_aggregated_smtp_report(opts)
229
232
  p result
230
233
  rescue SibApiV3Sdk::ApiError => e
231
- puts "Exception when calling SMTPApi->get_aggregated_smtp_report: #{e}"
234
+ puts "Exception when calling TransactionalEmailsApi->get_aggregated_smtp_report: #{e}"
232
235
  end
233
236
  ```
234
237
 
@@ -278,18 +281,18 @@ SibApiV3Sdk.configure do |config|
278
281
  #config.api_key_prefix['partner-key'] = 'Bearer'
279
282
  end
280
283
 
281
- api_instance = SibApiV3Sdk::SMTPApi.new
284
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
282
285
 
283
286
  opts = {
284
287
  limit: 50, # Integer | Number limitation for the result returned
285
288
  offset: 0, # Integer | Beginning point in the list to retrieve from.
286
- 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
287
- 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
288
291
  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
289
- email: "email_example", # String | Filter the report for a specific email addresses
290
- event: "event_example", # String | Filter the report for a specific event type
291
- tags: "tags_example", # String | Filter the report for tags (serialized and urlencoded array)
292
- 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
293
296
  template_id: 789 # Integer | Filter on a specific template id
294
297
  }
295
298
 
@@ -298,7 +301,7 @@ begin
298
301
  result = api_instance.get_email_event_report(opts)
299
302
  p result
300
303
  rescue SibApiV3Sdk::ApiError => e
301
- puts "Exception when calling SMTPApi->get_email_event_report: #{e}"
304
+ puts "Exception when calling TransactionalEmailsApi->get_email_event_report: #{e}"
302
305
  end
303
306
  ```
304
307
 
@@ -354,15 +357,15 @@ SibApiV3Sdk.configure do |config|
354
357
  #config.api_key_prefix['partner-key'] = 'Bearer'
355
358
  end
356
359
 
357
- api_instance = SibApiV3Sdk::SMTPApi.new
360
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
358
361
 
359
362
  opts = {
360
- limit: 50, # Integer | Number of documents returned per page
363
+ limit: 10, # Integer | Number of documents returned per page
361
364
  offset: 0, # Integer | Index of the first document on the page
362
- start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
363
- 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)
364
367
  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
365
- tag: "tag_example" # String | Tag of the emails
368
+ tag: 'tag_example' # String | Tag of the emails
366
369
  }
367
370
 
368
371
  begin
@@ -370,7 +373,7 @@ begin
370
373
  result = api_instance.get_smtp_report(opts)
371
374
  p result
372
375
  rescue SibApiV3Sdk::ApiError => e
373
- puts "Exception when calling SMTPApi->get_smtp_report: #{e}"
376
+ puts "Exception when calling TransactionalEmailsApi->get_smtp_report: #{e}"
374
377
  end
375
378
  ```
376
379
 
@@ -378,7 +381,7 @@ end
378
381
 
379
382
  Name | Type | Description | Notes
380
383
  ------------- | ------------- | ------------- | -------------
381
- **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]
382
385
  **offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
383
386
  **start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional]
384
387
  **end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
@@ -403,7 +406,7 @@ Name | Type | Description | Notes
403
406
  # **get_smtp_template**
404
407
  > GetSmtpTemplateOverview get_smtp_template(template_id)
405
408
 
406
- Returns the template informations
409
+ Returns the template information
407
410
 
408
411
  ### Example
409
412
  ```ruby
@@ -422,17 +425,17 @@ SibApiV3Sdk.configure do |config|
422
425
  #config.api_key_prefix['partner-key'] = 'Bearer'
423
426
  end
424
427
 
425
- api_instance = SibApiV3Sdk::SMTPApi.new
428
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
426
429
 
427
430
  template_id = 789 # Integer | id of the template
428
431
 
429
432
 
430
433
  begin
431
- #Returns the template informations
434
+ #Returns the template information
432
435
  result = api_instance.get_smtp_template(template_id)
433
436
  p result
434
437
  rescue SibApiV3Sdk::ApiError => e
435
- puts "Exception when calling SMTPApi->get_smtp_template: #{e}"
438
+ puts "Exception when calling TransactionalEmailsApi->get_smtp_template: #{e}"
436
439
  end
437
440
  ```
438
441
 
@@ -460,7 +463,7 @@ Name | Type | Description | Notes
460
463
  # **get_smtp_templates**
461
464
  > GetSmtpTemplates get_smtp_templates(opts)
462
465
 
463
- Get the list of transactional email templates
466
+ Get the list of email templates
464
467
 
465
468
  ### Example
466
469
  ```ruby
@@ -479,7 +482,7 @@ SibApiV3Sdk.configure do |config|
479
482
  #config.api_key_prefix['partner-key'] = 'Bearer'
480
483
  end
481
484
 
482
- api_instance = SibApiV3Sdk::SMTPApi.new
485
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
483
486
 
484
487
  opts = {
485
488
  template_status: true, # BOOLEAN | Filter on the status of the template. Active = true, inactive = false
@@ -488,11 +491,11 @@ opts = {
488
491
  }
489
492
 
490
493
  begin
491
- #Get the list of transactional email templates
494
+ #Get the list of email templates
492
495
  result = api_instance.get_smtp_templates(opts)
493
496
  p result
494
497
  rescue SibApiV3Sdk::ApiError => e
495
- puts "Exception when calling SMTPApi->get_smtp_templates: #{e}"
498
+ puts "Exception when calling TransactionalEmailsApi->get_smtp_templates: #{e}"
496
499
  end
497
500
  ```
498
501
 
@@ -519,6 +522,72 @@ Name | Type | Description | Notes
519
522
 
520
523
 
521
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::TransactionalEmailsApi.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 TransactionalEmailsApi->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
+
522
591
  # **get_transac_email_content**
523
592
  > GetTransacEmailContent get_transac_email_content(uuid)
524
593
 
@@ -541,9 +610,9 @@ SibApiV3Sdk.configure do |config|
541
610
  #config.api_key_prefix['partner-key'] = 'Bearer'
542
611
  end
543
612
 
544
- api_instance = SibApiV3Sdk::SMTPApi.new
613
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
545
614
 
546
- uuid = "uuid_example" # String | Unique id of the transactional email that has been sent to a particular contact
615
+ uuid = 'uuid_example' # String | Unique id of the transactional email that has been sent to a particular contact
547
616
 
548
617
 
549
618
  begin
@@ -551,7 +620,7 @@ begin
551
620
  result = api_instance.get_transac_email_content(uuid)
552
621
  p result
553
622
  rescue SibApiV3Sdk::ApiError => e
554
- puts "Exception when calling SMTPApi->get_transac_email_content: #{e}"
623
+ puts "Exception when calling TransactionalEmailsApi->get_transac_email_content: #{e}"
555
624
  end
556
625
  ```
557
626
 
@@ -600,14 +669,14 @@ SibApiV3Sdk.configure do |config|
600
669
  #config.api_key_prefix['partner-key'] = 'Bearer'
601
670
  end
602
671
 
603
- api_instance = SibApiV3Sdk::SMTPApi.new
672
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
604
673
 
605
674
  opts = {
606
- email: "email_example", # String | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
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.
607
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.
608
- message_id: "message_id_example", # String | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
609
- start_date: "start_date_example", # String | 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.
610
- 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.
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.
611
680
  }
612
681
 
613
682
  begin
@@ -615,7 +684,7 @@ begin
615
684
  result = api_instance.get_transac_emails_list(opts)
616
685
  p result
617
686
  rescue SibApiV3Sdk::ApiError => e
618
- puts "Exception when calling SMTPApi->get_transac_emails_list: #{e}"
687
+ puts "Exception when calling TransactionalEmailsApi->get_transac_emails_list: #{e}"
619
688
  end
620
689
  ```
621
690
 
@@ -626,7 +695,7 @@ Name | Type | Description | Notes
626
695
  **email** | **String**| Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. | [optional]
627
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]
628
697
  **message_id** | **String**| Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | [optional]
629
- **start_date** | **String**| 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]
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]
630
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]
631
700
 
632
701
  ### Return type
@@ -668,7 +737,7 @@ SibApiV3Sdk.configure do |config|
668
737
  #config.api_key_prefix['partner-key'] = 'Bearer'
669
738
  end
670
739
 
671
- api_instance = SibApiV3Sdk::SMTPApi.new
740
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
672
741
 
673
742
  template_id = 789 # Integer | Id of the template
674
743
 
@@ -680,7 +749,7 @@ begin
680
749
  result = api_instance.send_template(template_id, send_email)
681
750
  p result
682
751
  rescue SibApiV3Sdk::ApiError => e
683
- puts "Exception when calling SMTPApi->send_template: #{e}"
752
+ puts "Exception when calling TransactionalEmailsApi->send_template: #{e}"
684
753
  end
685
754
  ```
686
755
 
@@ -728,7 +797,7 @@ SibApiV3Sdk.configure do |config|
728
797
  #config.api_key_prefix['partner-key'] = 'Bearer'
729
798
  end
730
799
 
731
- api_instance = SibApiV3Sdk::SMTPApi.new
800
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
732
801
 
733
802
  template_id = 789 # Integer | Id of the template
734
803
 
@@ -739,7 +808,7 @@ begin
739
808
  #Send a template to your test list
740
809
  api_instance.send_test_template(template_id, send_test_email)
741
810
  rescue SibApiV3Sdk::ApiError => e
742
- puts "Exception when calling SMTPApi->send_test_template: #{e}"
811
+ puts "Exception when calling TransactionalEmailsApi->send_test_template: #{e}"
743
812
  end
744
813
  ```
745
814
 
@@ -787,7 +856,7 @@ SibApiV3Sdk.configure do |config|
787
856
  #config.api_key_prefix['partner-key'] = 'Bearer'
788
857
  end
789
858
 
790
- api_instance = SibApiV3Sdk::SMTPApi.new
859
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
791
860
 
792
861
  send_smtp_email = SibApiV3Sdk::SendSmtpEmail.new # SendSmtpEmail | Values to send a transactional email
793
862
 
@@ -797,7 +866,7 @@ begin
797
866
  result = api_instance.send_transac_email(send_smtp_email)
798
867
  p result
799
868
  rescue SibApiV3Sdk::ApiError => e
800
- puts "Exception when calling SMTPApi->send_transac_email: #{e}"
869
+ puts "Exception when calling TransactionalEmailsApi->send_transac_email: #{e}"
801
870
  end
802
871
  ```
803
872
 
@@ -822,10 +891,122 @@ Name | Type | Description | Notes
822
891
 
823
892
 
824
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::TransactionalEmailsApi.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 TransactionalEmailsApi->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::TransactionalEmailsApi.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 TransactionalEmailsApi->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
+
825
1006
  # **update_smtp_template**
826
1007
  > update_smtp_template(template_id, smtp_template)
827
1008
 
828
- Updates a transactional email templates
1009
+ Update an email template
829
1010
 
830
1011
  ### Example
831
1012
  ```ruby
@@ -844,7 +1025,7 @@ SibApiV3Sdk.configure do |config|
844
1025
  #config.api_key_prefix['partner-key'] = 'Bearer'
845
1026
  end
846
1027
 
847
- api_instance = SibApiV3Sdk::SMTPApi.new
1028
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
848
1029
 
849
1030
  template_id = 789 # Integer | id of the template
850
1031
 
@@ -852,10 +1033,10 @@ smtp_template = SibApiV3Sdk::UpdateSmtpTemplate.new # UpdateSmtpTemplate | value
852
1033
 
853
1034
 
854
1035
  begin
855
- #Updates a transactional email templates
1036
+ #Update an email template
856
1037
  api_instance.update_smtp_template(template_id, smtp_template)
857
1038
  rescue SibApiV3Sdk::ApiError => e
858
- puts "Exception when calling SMTPApi->update_smtp_template: #{e}"
1039
+ puts "Exception when calling TransactionalEmailsApi->update_smtp_template: #{e}"
859
1040
  end
860
1041
  ```
861
1042