sib-api-v3-sdk 7.0.0 → 7.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (464) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -8
  3. data/docs/BlockDomain.md +8 -0
  4. data/docs/ContactsApi.md +25 -13
  5. data/docs/CreateEmailCampaign.md +1 -1
  6. data/docs/CreateSmsCampaign.md +1 -1
  7. data/docs/CreateSmtpEmail.md +2 -1
  8. data/docs/CreateSmtpTemplateSender.md +1 -1
  9. data/docs/EmailCampaignsApi.md +7 -5
  10. data/docs/FoldersApi.md +9 -3
  11. data/docs/GetBlockedDomains.md +8 -0
  12. data/docs/GetCampaignOverview.md +1 -1
  13. data/docs/GetChildDomain.md +2 -2
  14. data/docs/GetChildrenList.md +1 -1
  15. data/docs/GetContactCampaignStatsOpened.md +1 -1
  16. data/docs/GetContactDetails.md +2 -2
  17. data/docs/GetEmailCampaign.md +8 -8
  18. data/docs/GetEmailCampaigns.md +1 -1
  19. data/docs/GetEmailEventReportEvents.md +2 -1
  20. data/docs/GetExtendedCampaignOverview.md +6 -6
  21. data/docs/GetExtendedCampaignStats.md +1 -1
  22. data/docs/GetExtendedCampaignStatsGlobalStats.md +7 -0
  23. data/docs/GetExtendedContactDetails.md +2 -2
  24. data/docs/GetExtendedContactDetailsStatisticsLinks.md +1 -1
  25. data/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +1 -1
  26. data/docs/GetExtendedContactDetailsStatisticsOpened.md +1 -1
  27. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +2 -2
  28. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +2 -2
  29. data/docs/GetExtendedList.md +2 -1
  30. data/docs/GetFolderLists.md +2 -2
  31. data/docs/GetList.md +1 -0
  32. data/docs/GetLists.md +2 -2
  33. data/docs/GetProcesses.md +1 -1
  34. data/docs/GetSmsCampaign.md +5 -5
  35. data/docs/GetSmsCampaignOverview.md +3 -3
  36. data/docs/GetSmsCampaignRecipients.md +7 -0
  37. data/docs/GetSmsCampaigns.md +1 -1
  38. data/docs/GetSmsEventReportEvents.md +4 -4
  39. data/docs/GetSmtpTemplateOverview.md +2 -2
  40. data/docs/GetTransacAggregatedSmsReport.md +10 -10
  41. data/docs/GetTransacBlockedContactsContacts.md +1 -1
  42. data/docs/GetTransacEmailContent.md +1 -1
  43. data/docs/GetTransacEmailContentEvents.md +1 -1
  44. data/docs/GetTransacEmailsList.md +1 -0
  45. data/docs/GetTransacEmailsListTransactionalEmails.md +1 -1
  46. data/docs/GetTransacSmsReportReports.md +10 -10
  47. data/docs/GetWebhook.md +2 -2
  48. data/docs/ListsApi.md +11 -5
  49. data/docs/ProcessApi.md +3 -1
  50. data/docs/SMSCampaignsApi.md +7 -5
  51. data/docs/SendReportEmail.md +1 -5
  52. data/docs/SendSmtpEmail.md +3 -2
  53. data/docs/SendSmtpEmailMessageVersions.md +13 -0
  54. data/docs/SendSmtpEmailReplyTo1.md +9 -0
  55. data/docs/SendSmtpEmailSender.md +3 -3
  56. data/docs/SendSmtpEmailTo1.md +9 -0
  57. data/docs/SendTestEmail.md +1 -1
  58. data/docs/TransactionalEmailsApi.md +197 -11
  59. data/docs/TransactionalSMSApi.md +9 -5
  60. data/docs/UpdateEmailCampaign.md +1 -1
  61. data/docs/UpdateSmsCampaign.md +1 -1
  62. data/docs/WebhooksApi.md +3 -1
  63. data/lib/sib-api-v3-sdk.rb +16 -9
  64. data/lib/sib-api-v3-sdk/api/account_api.rb +11 -1
  65. data/lib/sib-api-v3-sdk/api/attributes_api.rb +11 -1
  66. data/lib/sib-api-v3-sdk/api/contacts_api.rb +49 -9
  67. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +21 -5
  68. data/lib/sib-api-v3-sdk/api/folders_api.rb +23 -1
  69. data/lib/sib-api-v3-sdk/api/lists_api.rb +31 -3
  70. data/lib/sib-api-v3-sdk/api/process_api.rb +17 -1
  71. data/lib/sib-api-v3-sdk/api/reseller_api.rb +11 -1
  72. data/lib/sib-api-v3-sdk/api/senders_api.rb +11 -1
  73. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +21 -5
  74. data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +211 -7
  75. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +23 -1
  76. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +17 -1
  77. data/lib/sib-api-v3-sdk/api_client.rb +8 -5
  78. data/lib/sib-api-v3-sdk/api_error.rb +1 -1
  79. data/lib/sib-api-v3-sdk/configuration.rb +3 -3
  80. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +3 -2
  81. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +3 -2
  82. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +3 -2
  83. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +3 -2
  84. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +3 -2
  85. data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +3 -2
  86. data/lib/sib-api-v3-sdk/models/add_child_domain.rb +3 -2
  87. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +3 -2
  88. data/lib/sib-api-v3-sdk/models/add_credits.rb +3 -2
  89. data/lib/sib-api-v3-sdk/models/block_domain.rb +190 -0
  90. data/lib/sib-api-v3-sdk/models/create_attribute.rb +3 -2
  91. data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +3 -2
  92. data/lib/sib-api-v3-sdk/models/create_child.rb +3 -2
  93. data/lib/sib-api-v3-sdk/models/create_contact.rb +3 -2
  94. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +3 -2
  95. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +4 -3
  96. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +3 -2
  97. data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +3 -2
  98. data/lib/sib-api-v3-sdk/models/create_list.rb +3 -2
  99. data/lib/sib-api-v3-sdk/models/create_model.rb +3 -2
  100. data/lib/sib-api-v3-sdk/models/create_reseller.rb +3 -2
  101. data/lib/sib-api-v3-sdk/models/create_sender.rb +3 -2
  102. data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +3 -2
  103. data/lib/sib-api-v3-sdk/models/create_sender_model.rb +3 -2
  104. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +4 -3
  105. data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +3 -2
  106. data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +18 -11
  107. data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +3 -2
  108. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +3 -7
  109. data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +3 -2
  110. data/lib/sib-api-v3-sdk/models/create_update_folder.rb +3 -2
  111. data/lib/sib-api-v3-sdk/models/create_webhook.rb +3 -2
  112. data/lib/sib-api-v3-sdk/models/created_process_id.rb +3 -2
  113. data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +3 -2
  114. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +3 -2
  115. data/lib/sib-api-v3-sdk/models/error_model.rb +3 -2
  116. data/lib/sib-api-v3-sdk/models/get_account.rb +3 -2
  117. data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +3 -2
  118. data/lib/sib-api-v3-sdk/models/get_account_plan.rb +3 -2
  119. data/lib/sib-api-v3-sdk/models/get_account_relay.rb +3 -2
  120. data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +3 -2
  121. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +3 -2
  122. data/lib/sib-api-v3-sdk/models/get_attributes.rb +3 -2
  123. data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +3 -2
  124. data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +3 -2
  125. data/lib/sib-api-v3-sdk/models/get_blocked_domains.rb +193 -0
  126. data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +4 -3
  127. data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +3 -2
  128. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +3 -2
  129. data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +3 -2
  130. data/lib/sib-api-v3-sdk/models/get_child_domain.rb +3 -12
  131. data/lib/sib-api-v3-sdk/models/get_child_domains.rb +3 -2
  132. data/lib/sib-api-v3-sdk/models/get_child_info.rb +3 -2
  133. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +3 -2
  134. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +3 -2
  135. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +3 -2
  136. data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +3 -2
  137. data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +3 -2
  138. data/lib/sib-api-v3-sdk/models/get_children_list.rb +3 -7
  139. data/lib/sib-api-v3-sdk/models/get_client.rb +3 -2
  140. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +3 -2
  141. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +3 -2
  142. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +4 -3
  143. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +3 -2
  144. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +3 -2
  145. data/lib/sib-api-v3-sdk/models/get_contact_details.rb +5 -4
  146. data/lib/sib-api-v3-sdk/models/get_contacts.rb +3 -2
  147. data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +3 -2
  148. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +9 -18
  149. data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +3 -7
  150. data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +3 -2
  151. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +20 -9
  152. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +7 -16
  153. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +3 -2
  154. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +4 -4
  155. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats_global_stats.rb +176 -0
  156. data/lib/sib-api-v3-sdk/models/get_extended_client.rb +3 -2
  157. data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +3 -2
  158. data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +5 -4
  159. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +3 -2
  160. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +3 -2
  161. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +4 -3
  162. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +4 -3
  163. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +4 -3
  164. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +3 -2
  165. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +4 -8
  166. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +4 -8
  167. data/lib/sib-api-v3-sdk/models/get_extended_list.rb +20 -4
  168. data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +3 -2
  169. data/lib/sib-api-v3-sdk/models/get_folder.rb +3 -2
  170. data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +3 -12
  171. data/lib/sib-api-v3-sdk/models/get_folders.rb +3 -2
  172. data/lib/sib-api-v3-sdk/models/get_ip.rb +3 -2
  173. data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +3 -2
  174. data/lib/sib-api-v3-sdk/models/get_ips.rb +3 -2
  175. data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +3 -2
  176. data/lib/sib-api-v3-sdk/models/get_list.rb +22 -6
  177. data/lib/sib-api-v3-sdk/models/get_lists.rb +3 -12
  178. data/lib/sib-api-v3-sdk/models/get_process.rb +3 -2
  179. data/lib/sib-api-v3-sdk/models/get_processes.rb +3 -7
  180. data/lib/sib-api-v3-sdk/models/get_reports.rb +3 -2
  181. data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +3 -2
  182. data/lib/sib-api-v3-sdk/models/get_senders_list.rb +3 -2
  183. data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +3 -2
  184. data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +3 -2
  185. data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +3 -2
  186. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +8 -12
  187. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +6 -10
  188. data/lib/sib-api-v3-sdk/models/get_sms_campaign_recipients.rb +175 -0
  189. data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +3 -2
  190. data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +3 -7
  191. data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +3 -2
  192. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +4 -23
  193. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +5 -4
  194. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +3 -2
  195. data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +3 -2
  196. data/lib/sib-api-v3-sdk/models/get_sso_token.rb +3 -2
  197. data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +3 -2
  198. data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +3 -2
  199. data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +3 -2
  200. data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +3 -52
  201. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +3 -2
  202. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +4 -3
  203. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +3 -2
  204. data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +4 -3
  205. data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +4 -3
  206. data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +14 -3
  207. data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +4 -3
  208. data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +3 -2
  209. data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +3 -52
  210. data/lib/sib-api-v3-sdk/models/get_webhook.rb +5 -4
  211. data/lib/sib-api-v3-sdk/models/get_webhooks.rb +3 -2
  212. data/lib/sib-api-v3-sdk/models/manage_ip.rb +3 -2
  213. data/lib/sib-api-v3-sdk/models/post_contact_info.rb +3 -2
  214. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +3 -2
  215. data/lib/sib-api-v3-sdk/models/post_send_failed.rb +3 -2
  216. data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +3 -2
  217. data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +3 -2
  218. data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +3 -2
  219. data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +3 -2
  220. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +3 -2
  221. data/lib/sib-api-v3-sdk/models/remove_credits.rb +3 -2
  222. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +3 -2
  223. data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +3 -2
  224. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +3 -2
  225. data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +3 -2
  226. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +3 -2
  227. data/lib/sib-api-v3-sdk/models/send_email.rb +3 -2
  228. data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +3 -2
  229. data/lib/sib-api-v3-sdk/models/send_report.rb +3 -2
  230. data/lib/sib-api-v3-sdk/models/send_report_email.rb +6 -90
  231. data/lib/sib-api-v3-sdk/models/send_sms.rb +3 -2
  232. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +18 -10
  233. data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +3 -2
  234. data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +3 -2
  235. data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +3 -2
  236. data/lib/sib-api-v3-sdk/models/send_smtp_email_message_versions.rb +247 -0
  237. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +3 -2
  238. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to_1.rb +201 -0
  239. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +7 -11
  240. data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +3 -2
  241. data/lib/sib-api-v3-sdk/models/send_smtp_email_to_1.rb +200 -0
  242. data/lib/sib-api-v3-sdk/models/send_template_email.rb +3 -2
  243. data/lib/sib-api-v3-sdk/models/send_test_email.rb +4 -3
  244. data/lib/sib-api-v3-sdk/models/send_test_sms.rb +3 -2
  245. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +3 -2
  246. data/lib/sib-api-v3-sdk/models/update_attribute.rb +3 -2
  247. data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +3 -2
  248. data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +3 -2
  249. data/lib/sib-api-v3-sdk/models/update_child.rb +3 -2
  250. data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +3 -2
  251. data/lib/sib-api-v3-sdk/models/update_child_domain.rb +3 -2
  252. data/lib/sib-api-v3-sdk/models/update_contact.rb +3 -2
  253. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +4 -3
  254. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +3 -2
  255. data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +3 -2
  256. data/lib/sib-api-v3-sdk/models/update_list.rb +3 -2
  257. data/lib/sib-api-v3-sdk/models/update_sender.rb +3 -2
  258. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +4 -3
  259. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +3 -2
  260. data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +3 -2
  261. data/lib/sib-api-v3-sdk/models/update_webhook.rb +3 -2
  262. data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +3 -2
  263. data/lib/sib-api-v3-sdk/version.rb +2 -2
  264. data/spec/api/account_api_spec.rb +1 -1
  265. data/spec/api/attributes_api_spec.rb +1 -1
  266. data/spec/api/contacts_api_spec.rb +10 -5
  267. data/spec/api/email_campaigns_api_spec.rb +4 -3
  268. data/spec/api/folders_api_spec.rb +3 -1
  269. data/spec/api/lists_api_spec.rb +5 -2
  270. data/spec/api/process_api_spec.rb +2 -1
  271. data/spec/api/reseller_api_spec.rb +1 -1
  272. data/spec/api/senders_api_spec.rb +1 -1
  273. data/spec/api/sms_campaigns_api_spec.rb +4 -3
  274. data/spec/api/transactional_emails_api_spec.rb +45 -3
  275. data/spec/api/transactional_sms_api_spec.rb +3 -1
  276. data/spec/api/webhooks_api_spec.rb +2 -1
  277. data/spec/api_client_spec.rb +18 -1
  278. data/spec/configuration_spec.rb +1 -1
  279. data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +1 -1
  280. data/spec/models/ab_test_campaign_result_spec.rb +1 -1
  281. data/spec/models/ab_test_campaign_result_statistics_spec.rb +1 -1
  282. data/spec/models/ab_test_version_clicks_inner_spec.rb +1 -1
  283. data/spec/models/ab_test_version_clicks_spec.rb +1 -1
  284. data/spec/models/ab_test_version_stats_spec.rb +1 -1
  285. data/spec/models/add_child_domain_spec.rb +1 -1
  286. data/spec/models/add_contact_to_list_spec.rb +1 -1
  287. data/spec/models/add_credits_spec.rb +1 -1
  288. data/spec/models/block_domain_spec.rb +41 -0
  289. data/spec/models/create_attribute_enumeration_spec.rb +1 -1
  290. data/spec/models/create_attribute_spec.rb +1 -1
  291. data/spec/models/create_child_spec.rb +1 -1
  292. data/spec/models/create_contact_spec.rb +1 -1
  293. data/spec/models/create_doi_contact_spec.rb +1 -1
  294. data/spec/models/create_email_campaign_recipients_spec.rb +1 -1
  295. data/spec/models/create_email_campaign_sender_spec.rb +1 -1
  296. data/spec/models/create_email_campaign_spec.rb +1 -1
  297. data/spec/models/create_list_spec.rb +1 -1
  298. data/spec/models/create_model_spec.rb +1 -1
  299. data/spec/models/create_reseller_spec.rb +1 -1
  300. data/spec/models/create_sender_ips_spec.rb +1 -1
  301. data/spec/models/create_sender_model_spec.rb +1 -1
  302. data/spec/models/create_sender_spec.rb +1 -1
  303. data/spec/models/create_sms_campaign_recipients_spec.rb +1 -1
  304. data/spec/models/create_sms_campaign_spec.rb +1 -1
  305. data/spec/models/create_smtp_email_spec.rb +7 -1
  306. data/spec/models/create_smtp_template_sender_spec.rb +1 -1
  307. data/spec/models/create_smtp_template_spec.rb +1 -1
  308. data/spec/models/create_update_contact_model_spec.rb +1 -1
  309. data/spec/models/create_update_folder_spec.rb +1 -1
  310. data/spec/models/create_webhook_spec.rb +1 -1
  311. data/spec/models/created_process_id_spec.rb +1 -1
  312. data/spec/models/delete_hardbounces_spec.rb +1 -1
  313. data/spec/models/email_export_recipients_spec.rb +1 -1
  314. data/spec/models/error_model_spec.rb +1 -1
  315. data/spec/models/get_account_marketing_automation_spec.rb +1 -1
  316. data/spec/models/get_account_plan_spec.rb +1 -1
  317. data/spec/models/get_account_relay_data_spec.rb +1 -1
  318. data/spec/models/get_account_relay_spec.rb +1 -1
  319. data/spec/models/get_account_spec.rb +1 -1
  320. data/spec/models/get_aggregated_report_spec.rb +1 -1
  321. data/spec/models/get_attributes_attributes_spec.rb +1 -1
  322. data/spec/models/get_attributes_enumeration_spec.rb +1 -1
  323. data/spec/models/get_attributes_spec.rb +1 -1
  324. data/spec/models/get_blocked_domains_spec.rb +41 -0
  325. data/spec/models/get_campaign_overview_spec.rb +1 -1
  326. data/spec/models/get_campaign_recipients_spec.rb +1 -1
  327. data/spec/models/get_campaign_stats_spec.rb +1 -1
  328. data/spec/models/get_child_account_creation_status_spec.rb +1 -1
  329. data/spec/models/get_child_domain_spec.rb +1 -1
  330. data/spec/models/get_child_domains_spec.rb +1 -1
  331. data/spec/models/get_child_info_api_keys_spec.rb +1 -1
  332. data/spec/models/get_child_info_api_keys_v2_spec.rb +1 -1
  333. data/spec/models/get_child_info_api_keys_v3_spec.rb +1 -1
  334. data/spec/models/get_child_info_credits_spec.rb +1 -1
  335. data/spec/models/get_child_info_spec.rb +1 -1
  336. data/spec/models/get_child_info_statistics_spec.rb +1 -1
  337. data/spec/models/get_children_list_spec.rb +1 -1
  338. data/spec/models/get_client_spec.rb +1 -1
  339. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +1 -1
  340. data/spec/models/get_contact_campaign_stats_opened_spec.rb +1 -1
  341. data/spec/models/get_contact_campaign_stats_spec.rb +1 -1
  342. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +1 -1
  343. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +1 -1
  344. data/spec/models/get_contact_details_spec.rb +1 -1
  345. data/spec/models/get_contacts_spec.rb +1 -1
  346. data/spec/models/get_device_browser_stats_spec.rb +1 -1
  347. data/spec/models/get_email_campaign_spec.rb +1 -1
  348. data/spec/models/get_email_campaigns_spec.rb +1 -1
  349. data/spec/models/get_email_event_report_events_spec.rb +8 -2
  350. data/spec/models/get_email_event_report_spec.rb +1 -1
  351. data/spec/models/get_extended_campaign_overview_sender_spec.rb +1 -1
  352. data/spec/models/get_extended_campaign_overview_spec.rb +1 -1
  353. data/spec/models/get_extended_campaign_stats_global_stats_spec.rb +35 -0
  354. data/spec/models/get_extended_campaign_stats_spec.rb +1 -1
  355. data/spec/models/get_extended_client_address_spec.rb +1 -1
  356. data/spec/models/get_extended_client_spec.rb +1 -1
  357. data/spec/models/get_extended_contact_details_spec.rb +1 -1
  358. data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +1 -1
  359. data/spec/models/get_extended_contact_details_statistics_links_spec.rb +1 -1
  360. data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +1 -1
  361. data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +1 -1
  362. data/spec/models/get_extended_contact_details_statistics_spec.rb +1 -1
  363. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +1 -1
  364. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +1 -1
  365. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +1 -1
  366. data/spec/models/get_extended_list_campaign_stats_spec.rb +1 -1
  367. data/spec/models/get_extended_list_spec.rb +7 -1
  368. data/spec/models/get_folder_lists_spec.rb +1 -1
  369. data/spec/models/get_folder_spec.rb +1 -1
  370. data/spec/models/get_folders_spec.rb +1 -1
  371. data/spec/models/get_ip_from_sender_spec.rb +1 -1
  372. data/spec/models/get_ip_spec.rb +1 -1
  373. data/spec/models/get_ips_from_sender_spec.rb +1 -1
  374. data/spec/models/get_ips_spec.rb +1 -1
  375. data/spec/models/get_list_spec.rb +7 -1
  376. data/spec/models/get_lists_spec.rb +1 -1
  377. data/spec/models/get_process_spec.rb +1 -1
  378. data/spec/models/get_processes_spec.rb +1 -1
  379. data/spec/models/get_reports_reports_spec.rb +1 -1
  380. data/spec/models/get_reports_spec.rb +1 -1
  381. data/spec/models/get_senders_list_ips_spec.rb +1 -1
  382. data/spec/models/get_senders_list_senders_spec.rb +1 -1
  383. data/spec/models/get_senders_list_spec.rb +1 -1
  384. data/spec/models/get_shared_template_url_spec.rb +1 -1
  385. data/spec/models/get_sms_campaign_overview_spec.rb +1 -1
  386. data/spec/models/get_sms_campaign_recipients_spec.rb +35 -0
  387. data/spec/models/get_sms_campaign_spec.rb +1 -1
  388. data/spec/models/get_sms_campaign_stats_spec.rb +1 -1
  389. data/spec/models/get_sms_campaigns_spec.rb +1 -1
  390. data/spec/models/get_sms_event_report_events_spec.rb +1 -1
  391. data/spec/models/get_sms_event_report_spec.rb +1 -1
  392. data/spec/models/get_smtp_template_overview_sender_spec.rb +1 -1
  393. data/spec/models/get_smtp_template_overview_spec.rb +1 -1
  394. data/spec/models/get_smtp_templates_spec.rb +1 -1
  395. data/spec/models/get_sso_token_spec.rb +1 -1
  396. data/spec/models/get_stats_by_browser_spec.rb +1 -1
  397. data/spec/models/get_stats_by_device_spec.rb +1 -1
  398. data/spec/models/get_stats_by_domain_spec.rb +1 -1
  399. data/spec/models/get_transac_aggregated_sms_report_spec.rb +1 -1
  400. data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +1 -1
  401. data/spec/models/get_transac_blocked_contacts_reason_spec.rb +1 -1
  402. data/spec/models/get_transac_blocked_contacts_spec.rb +1 -1
  403. data/spec/models/get_transac_email_content_events_spec.rb +1 -1
  404. data/spec/models/get_transac_email_content_spec.rb +1 -1
  405. data/spec/models/get_transac_emails_list_spec.rb +7 -1
  406. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +1 -1
  407. data/spec/models/get_transac_sms_report_reports_spec.rb +1 -1
  408. data/spec/models/get_transac_sms_report_spec.rb +1 -1
  409. data/spec/models/get_webhook_spec.rb +1 -1
  410. data/spec/models/get_webhooks_spec.rb +1 -1
  411. data/spec/models/manage_ip_spec.rb +1 -1
  412. data/spec/models/post_contact_info_contacts_spec.rb +1 -1
  413. data/spec/models/post_contact_info_spec.rb +1 -1
  414. data/spec/models/post_send_failed_spec.rb +1 -1
  415. data/spec/models/post_send_sms_test_failed_spec.rb +1 -1
  416. data/spec/models/remaining_credit_model_child_spec.rb +1 -1
  417. data/spec/models/remaining_credit_model_reseller_spec.rb +1 -1
  418. data/spec/models/remaining_credit_model_spec.rb +1 -1
  419. data/spec/models/remove_contact_from_list_spec.rb +1 -1
  420. data/spec/models/remove_credits_spec.rb +1 -1
  421. data/spec/models/request_contact_export_custom_contact_filter_spec.rb +1 -1
  422. data/spec/models/request_contact_export_spec.rb +1 -1
  423. data/spec/models/request_contact_import_new_list_spec.rb +1 -1
  424. data/spec/models/request_contact_import_spec.rb +1 -1
  425. data/spec/models/request_sms_recipient_export_spec.rb +1 -1
  426. data/spec/models/send_email_attachment_spec.rb +1 -1
  427. data/spec/models/send_email_spec.rb +1 -1
  428. data/spec/models/send_report_email_spec.rb +1 -29
  429. data/spec/models/send_report_spec.rb +1 -1
  430. data/spec/models/send_sms_spec.rb +1 -1
  431. data/spec/models/send_smtp_email_attachment_spec.rb +1 -1
  432. data/spec/models/send_smtp_email_bcc_spec.rb +1 -1
  433. data/spec/models/send_smtp_email_cc_spec.rb +1 -1
  434. data/spec/models/send_smtp_email_message_versions_spec.rb +71 -0
  435. data/spec/models/send_smtp_email_reply_to_1_spec.rb +47 -0
  436. data/spec/models/send_smtp_email_reply_to_spec.rb +1 -1
  437. data/spec/models/send_smtp_email_sender_spec.rb +1 -1
  438. data/spec/models/send_smtp_email_spec.rb +7 -1
  439. data/spec/models/send_smtp_email_to_1_spec.rb +47 -0
  440. data/spec/models/send_smtp_email_to_spec.rb +1 -1
  441. data/spec/models/send_template_email_spec.rb +1 -1
  442. data/spec/models/send_test_email_spec.rb +1 -1
  443. data/spec/models/send_test_sms_spec.rb +1 -1
  444. data/spec/models/send_transac_sms_spec.rb +1 -1
  445. data/spec/models/update_attribute_enumeration_spec.rb +1 -1
  446. data/spec/models/update_attribute_spec.rb +1 -1
  447. data/spec/models/update_campaign_status_spec.rb +1 -1
  448. data/spec/models/update_child_account_status_spec.rb +1 -1
  449. data/spec/models/update_child_domain_spec.rb +1 -1
  450. data/spec/models/update_child_spec.rb +1 -1
  451. data/spec/models/update_contact_spec.rb +1 -1
  452. data/spec/models/update_email_campaign_recipients_spec.rb +1 -1
  453. data/spec/models/update_email_campaign_sender_spec.rb +1 -1
  454. data/spec/models/update_email_campaign_spec.rb +1 -1
  455. data/spec/models/update_list_spec.rb +1 -1
  456. data/spec/models/update_sender_spec.rb +1 -1
  457. data/spec/models/update_sms_campaign_spec.rb +1 -1
  458. data/spec/models/update_smtp_template_sender_spec.rb +1 -1
  459. data/spec/models/update_smtp_template_spec.rb +1 -1
  460. data/spec/models/update_webhook_spec.rb +1 -1
  461. data/spec/models/upload_image_to_gallery_spec.rb +1 -1
  462. data/spec/spec_helper.rb +1 -1
  463. metadata +193 -167
  464. data/testfile.rb +0 -23
@@ -212,10 +212,11 @@ api_instance = SibApiV3Sdk::SMSCampaignsApi.new
212
212
 
213
213
  opts = {
214
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' )
215
+ start_date: 'start_date_example', # String | 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: 'end_date_example', # String | 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
- offset: 0 # Integer | Beginning point in the list to retrieve from.
218
+ offset: 0, # Integer | Beginning point in the list to retrieve from.
219
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
219
220
  }
220
221
 
221
222
  begin
@@ -232,10 +233,11 @@ end
232
233
  Name | Type | Description | Notes
233
234
  ------------- | ------------- | ------------- | -------------
234
235
  **status** | **String**| Status of campaign. | [optional]
235
- **start_date** | **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' ) | [optional]
236
- **end_date** | **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' ) | [optional]
236
+ **start_date** | **String**| 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' ) | [optional]
237
+ **end_date** | **String**| 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' ) | [optional]
237
238
  **limit** | **Integer**| Number limitation for the result returned | [optional] [default to 500]
238
239
  **offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
240
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
239
241
 
240
242
  ### Return type
241
243
 
@@ -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,7 +4,7 @@
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) | Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] | [optional]
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]
@@ -13,8 +13,9 @@ Name | Type | Description | Notes
13
13
  **reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
14
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
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
- **template_id** | **Integer** | Id of the template | [optional]
16
+ **template_id** | **Integer** | Id of the template. Mandatory if messageVersions are passed | [optional]
17
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
+ **message_versions** | [**Array<SendSmtpEmailMessageVersions>**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails | [optional]
18
19
  **tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
19
20
 
20
21
 
@@ -0,0 +1,13 @@
1
+ # SibApiV3Sdk::SendSmtpEmailMessageVersions
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **to** | [**Array<SendSmtpEmailTo1>**](SendSmtpEmailTo1.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
+ **params** | **Hash<String, 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]
8
+ **bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
9
+ **cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
10
+ **reply_to** | [**SendSmtpEmailReplyTo1**](SendSmtpEmailReplyTo1.md) | | [optional]
11
+ **subject** | **String** | Custom subject specific to message version | [optional]
12
+
13
+
@@ -0,0 +1,9 @@
1
+ # SibApiV3Sdk::SendSmtpEmailReplyTo1
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email** | **String** | Email address in reply to |
7
+ **name** | **String** | Name in reply to. Maximum allowed characters are 70. | [optional]
8
+
9
+
@@ -3,8 +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. Maximum allowed characters are 70. | [optional]
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]
6
+ **name** | **String** | Name of the sender from which the emails will be sent. Maximum allowed characters are 70. Applicable only when email is passed. | [optional]
7
+ **email** | **String** | Email of the sender from which the emails will be sent. Mandatory if sender id is not passed. | [optional]
8
+ **id** | **Integer** | Id of the sender from which the emails will be sent. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). Mandatory if email is not passed. | [optional]
9
9
 
10
10
 
@@ -0,0 +1,9 @@
1
+ # SibApiV3Sdk::SendSmtpEmailTo1
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email** | **String** | Email address of the recipient |
7
+ **name** | **String** | Name of the recipient. **Maximum allowed characters are 70**. | [optional]
8
+
9
+
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **email_to** | **Array<String>** | List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. | [optional]
6
+ **email_to** | **Array<String>** | List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day. | [optional]
7
7
 
8
8
 
@@ -4,10 +4,13 @@ All URIs are relative to *https://api.sendinblue.com/v3*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**block_new_domain**](TransactionalEmailsApi.md#block_new_domain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
7
8
  [**create_smtp_template**](TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
9
+ [**delete_blocked_domain**](TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
8
10
  [**delete_hardbounces**](TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
9
11
  [**delete_smtp_template**](TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
10
12
  [**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
13
+ [**get_blocked_domains**](TransactionalEmailsApi.md#get_blocked_domains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
11
14
  [**get_email_event_report**](TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
12
15
  [**get_smtp_report**](TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
13
16
  [**get_smtp_template**](TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
@@ -23,6 +26,64 @@ Method | HTTP request | Description
23
26
  [**update_smtp_template**](TransactionalEmailsApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
24
27
 
25
28
 
29
+ # **block_new_domain**
30
+ > block_new_domain(block_domain)
31
+
32
+ Add a new domain to the list of blocked domains
33
+
34
+ Blocks a new domain in order to avoid messages being sent to the same
35
+
36
+ ### Example
37
+ ```ruby
38
+ # load the gem
39
+ require 'sib-api-v3-sdk'
40
+ # setup authorization
41
+ SibApiV3Sdk.configure do |config|
42
+ # Configure API key authorization: api-key
43
+ config.api_key['api-key'] = 'YOUR API KEY'
44
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
45
+ #config.api_key_prefix['api-key'] = 'Bearer'
46
+
47
+ # Configure API key authorization: partner-key
48
+ config.api_key['partner-key'] = 'YOUR API KEY'
49
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
50
+ #config.api_key_prefix['partner-key'] = 'Bearer'
51
+ end
52
+
53
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
54
+
55
+ block_domain = SibApiV3Sdk::BlockDomain.new # BlockDomain |
56
+
57
+
58
+ begin
59
+ #Add a new domain to the list of blocked domains
60
+ api_instance.block_new_domain(block_domain)
61
+ rescue SibApiV3Sdk::ApiError => e
62
+ puts "Exception when calling TransactionalEmailsApi->block_new_domain: #{e}"
63
+ end
64
+ ```
65
+
66
+ ### Parameters
67
+
68
+ Name | Type | Description | Notes
69
+ ------------- | ------------- | ------------- | -------------
70
+ **block_domain** | [**BlockDomain**](BlockDomain.md)| |
71
+
72
+ ### Return type
73
+
74
+ nil (empty response body)
75
+
76
+ ### Authorization
77
+
78
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
79
+
80
+ ### HTTP request headers
81
+
82
+ - **Content-Type**: application/json
83
+ - **Accept**: application/json
84
+
85
+
86
+
26
87
  # **create_smtp_template**
27
88
  > CreateModel create_smtp_template(smtp_template)
28
89
 
@@ -80,6 +141,64 @@ Name | Type | Description | Notes
80
141
 
81
142
 
82
143
 
144
+ # **delete_blocked_domain**
145
+ > delete_blocked_domain(domain)
146
+
147
+ Unblock an existing domain from the list of blocked domains
148
+
149
+ Unblocks an existing domain from the list of blocked domains
150
+
151
+ ### Example
152
+ ```ruby
153
+ # load the gem
154
+ require 'sib-api-v3-sdk'
155
+ # setup authorization
156
+ SibApiV3Sdk.configure do |config|
157
+ # Configure API key authorization: api-key
158
+ config.api_key['api-key'] = 'YOUR API KEY'
159
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
160
+ #config.api_key_prefix['api-key'] = 'Bearer'
161
+
162
+ # Configure API key authorization: partner-key
163
+ config.api_key['partner-key'] = 'YOUR API KEY'
164
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
165
+ #config.api_key_prefix['partner-key'] = 'Bearer'
166
+ end
167
+
168
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
169
+
170
+ domain = 'domain_example' # String | The name of the domain to be deleted
171
+
172
+
173
+ begin
174
+ #Unblock an existing domain from the list of blocked domains
175
+ api_instance.delete_blocked_domain(domain)
176
+ rescue SibApiV3Sdk::ApiError => e
177
+ puts "Exception when calling TransactionalEmailsApi->delete_blocked_domain: #{e}"
178
+ end
179
+ ```
180
+
181
+ ### Parameters
182
+
183
+ Name | Type | Description | Notes
184
+ ------------- | ------------- | ------------- | -------------
185
+ **domain** | **String**| The name of the domain to be deleted |
186
+
187
+ ### Return type
188
+
189
+ nil (empty response body)
190
+
191
+ ### Authorization
192
+
193
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
194
+
195
+ ### HTTP request headers
196
+
197
+ - **Content-Type**: application/json
198
+ - **Accept**: application/json
199
+
200
+
201
+
83
202
  # **delete_hardbounces**
84
203
  > delete_hardbounces(opts)
85
204
 
@@ -222,7 +341,7 @@ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
222
341
  opts = {
223
342
  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
343
  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
225
- days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
344
+ days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
226
345
  tag: 'tag_example' # String | Tag of the emails
227
346
  }
228
347
 
@@ -259,6 +378,59 @@ Name | Type | Description | Notes
259
378
 
260
379
 
261
380
 
381
+ # **get_blocked_domains**
382
+ > GetBlockedDomains get_blocked_domains
383
+
384
+ Get the list of blocked domains
385
+
386
+ Get the list of blocked domains
387
+
388
+ ### Example
389
+ ```ruby
390
+ # load the gem
391
+ require 'sib-api-v3-sdk'
392
+ # setup authorization
393
+ SibApiV3Sdk.configure do |config|
394
+ # Configure API key authorization: api-key
395
+ config.api_key['api-key'] = 'YOUR API KEY'
396
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
397
+ #config.api_key_prefix['api-key'] = 'Bearer'
398
+
399
+ # Configure API key authorization: partner-key
400
+ config.api_key['partner-key'] = 'YOUR API KEY'
401
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
402
+ #config.api_key_prefix['partner-key'] = 'Bearer'
403
+ end
404
+
405
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
406
+
407
+ begin
408
+ #Get the list of blocked domains
409
+ result = api_instance.get_blocked_domains
410
+ p result
411
+ rescue SibApiV3Sdk::ApiError => e
412
+ puts "Exception when calling TransactionalEmailsApi->get_blocked_domains: #{e}"
413
+ end
414
+ ```
415
+
416
+ ### Parameters
417
+ This endpoint does not need any parameter.
418
+
419
+ ### Return type
420
+
421
+ [**GetBlockedDomains**](GetBlockedDomains.md)
422
+
423
+ ### Authorization
424
+
425
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
426
+
427
+ ### HTTP request headers
428
+
429
+ - **Content-Type**: application/json
430
+ - **Accept**: application/json
431
+
432
+
433
+
262
434
  # **get_email_event_report**
263
435
  > GetEmailEventReport get_email_event_report(opts)
264
436
 
@@ -288,12 +460,13 @@ opts = {
288
460
  offset: 0, # Integer | Beginning point in the list to retrieve from.
289
461
  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
462
  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
291
- days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
463
+ days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
292
464
  email: 'email_example', # String | Filter the report for a specific email addresses
293
465
  event: 'event_example', # String | Filter the report for a specific event type
294
466
  tags: 'tags_example', # String | Filter the report for tags (serialized and urlencoded array)
295
467
  message_id: 'message_id_example', # String | Filter on a specific message id
296
- template_id: 789 # Integer | Filter on a specific template id
468
+ template_id: 789, # Integer | Filter on a specific template id
469
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
297
470
  }
298
471
 
299
472
  begin
@@ -319,6 +492,7 @@ Name | Type | Description | Notes
319
492
  **tags** | **String**| Filter the report for tags (serialized and urlencoded array) | [optional]
320
493
  **message_id** | **String**| Filter on a specific message id | [optional]
321
494
  **template_id** | **Integer**| Filter on a specific template id | [optional]
495
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
322
496
 
323
497
  ### Return type
324
498
 
@@ -364,8 +538,9 @@ opts = {
364
538
  offset: 0, # Integer | Index of the first document on the page
365
539
  start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
366
540
  end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
367
- days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
368
- tag: 'tag_example' # String | Tag of the emails
541
+ days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
542
+ tag: 'tag_example', # String | Tag of the emails
543
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
369
544
  }
370
545
 
371
546
  begin
@@ -387,6 +562,7 @@ Name | Type | Description | Notes
387
562
  **end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
388
563
  **days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
389
564
  **tag** | **String**| Tag of the emails | [optional]
565
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
390
566
 
391
567
  ### Return type
392
568
 
@@ -487,7 +663,8 @@ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
487
663
  opts = {
488
664
  template_status: true, # BOOLEAN | Filter on the status of the template. Active = true, inactive = false
489
665
  limit: 50, # Integer | Number of documents returned per page
490
- offset: 0 # Integer | Index of the first document in the page
666
+ offset: 0, # Integer | Index of the first document in the page
667
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
491
668
  }
492
669
 
493
670
  begin
@@ -506,6 +683,7 @@ Name | Type | Description | Notes
506
683
  **template_status** | **BOOLEAN**| Filter on the status of the template. Active = true, inactive = false | [optional]
507
684
  **limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
508
685
  **offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
686
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
509
687
 
510
688
  ### Return type
511
689
 
@@ -551,7 +729,8 @@ opts = {
551
729
  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
730
  limit: 50, # Integer | Number of documents returned per page
553
731
  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
732
+ senders: ['senders_example'], # Array<String> | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
733
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
555
734
  }
556
735
 
557
736
  begin
@@ -572,6 +751,7 @@ Name | Type | Description | Notes
572
751
  **limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
573
752
  **offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
574
753
  **senders** | [**Array&lt;String&gt;**](String.md)| Comma separated list of emails of the senders from which contacts are blocked or unsubscribed | [optional]
754
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed | [optional] [default to desc]
575
755
 
576
756
  ### Return type
577
757
 
@@ -675,8 +855,11 @@ opts = {
675
855
  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
856
  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
857
  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.
858
+ 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.
859
+ end_date: 'end_date_example', # String | 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.
860
+ sort: 'desc', # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
861
+ limit: 500, # Integer | Number of documents returned per page
862
+ offset: 0 # Integer | Index of the first document in the page
680
863
  }
681
864
 
682
865
  begin
@@ -695,8 +878,11 @@ Name | Type | Description | Notes
695
878
  **email** | **String**| Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. | [optional]
696
879
  **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
880
  **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]
881
+ **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]
882
+ **end_date** | **String**| 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]
883
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed | [optional] [default to desc]
884
+ **limit** | **Integer**| Number of documents returned per page | [optional] [default to 500]
885
+ **offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
700
886
 
701
887
  ### Return type
702
888
 
@@ -39,10 +39,11 @@ opts = {
39
39
  start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
40
40
  end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
41
41
  offset: 0, # Integer | Index of the first document of the page
42
- days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
42
+ days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
43
43
  phone_number: 'phone_number_example', # String | Filter the report for a specific phone number
44
44
  event: 'event_example', # String | Filter the report for specific events
45
- tags: 'tags_example' # String | Filter the report for specific tags passed as a serialized urlencoded array
45
+ tags: 'tags_example', # String | Filter the report for specific tags passed as a serialized urlencoded array
46
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
46
47
  }
47
48
 
48
49
  begin
@@ -66,6 +67,7 @@ Name | Type | Description | Notes
66
67
  **phone_number** | **String**| Filter the report for a specific phone number | [optional]
67
68
  **event** | **String**| Filter the report for specific events | [optional]
68
69
  **tags** | **String**| Filter the report for specific tags passed as a serialized urlencoded array | [optional]
70
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed | [optional] [default to desc]
69
71
 
70
72
  ### Return type
71
73
 
@@ -109,7 +111,7 @@ api_instance = SibApiV3Sdk::TransactionalSMSApi.new
109
111
  opts = {
110
112
  start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
111
113
  end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
112
- days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with startDate and endDate
114
+ days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with startDate and endDate
113
115
  tag: 'tag_example' # String | Filter on a tag
114
116
  }
115
117
 
@@ -173,8 +175,9 @@ api_instance = SibApiV3Sdk::TransactionalSMSApi.new
173
175
  opts = {
174
176
  start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
175
177
  end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
176
- days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
177
- tag: 'tag_example' # String | Filter on a tag
178
+ days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
179
+ tag: 'tag_example', # String | Filter on a tag
180
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
178
181
  }
179
182
 
180
183
  begin
@@ -194,6 +197,7 @@ Name | Type | Description | Notes
194
197
  **end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
195
198
  **days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39; | [optional]
196
199
  **tag** | **String**| Filter on a tag | [optional]
200
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed | [optional] [default to desc]
197
201
 
198
202
  ### Return type
199
203