sib-api-v3-sdk 5.5.0 → 7.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (473) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +44 -29
  3. data/docs/AbTestCampaignResult.md +2 -0
  4. data/docs/AbTestCampaignResultClickedLinks.md +9 -0
  5. data/docs/AbTestCampaignResultStatistics.md +13 -0
  6. data/docs/AbTestVersionClicks.md +7 -0
  7. data/docs/AbTestVersionClicksInner.md +10 -0
  8. data/docs/AbTestVersionStats.md +9 -0
  9. data/docs/AddContactToList.md +2 -1
  10. data/docs/BlockDomain.md +8 -0
  11. data/docs/ContactsApi.md +45 -33
  12. data/docs/CreateDoiContact.md +1 -1
  13. data/docs/CreateEmailCampaign.md +1 -1
  14. data/docs/CreateSmsCampaign.md +2 -2
  15. data/docs/CreateSmtpEmail.md +2 -1
  16. data/docs/CreateSmtpTemplateSender.md +1 -1
  17. data/docs/CreateWebhook.md +1 -1
  18. data/docs/EmailCampaignsApi.md +7 -5
  19. data/docs/FoldersApi.md +9 -3
  20. data/docs/GetAggregatedReport.md +13 -13
  21. data/docs/GetBlockedDomains.md +8 -0
  22. data/docs/GetCampaignOverview.md +1 -1
  23. data/docs/GetCampaignStats.md +1 -0
  24. data/docs/GetChildDomain.md +2 -2
  25. data/docs/GetChildrenList.md +1 -1
  26. data/docs/GetContactCampaignStatsOpened.md +1 -1
  27. data/docs/GetContactDetails.md +2 -2
  28. data/docs/GetEmailCampaign.md +8 -8
  29. data/docs/GetEmailCampaigns.md +1 -1
  30. data/docs/GetEmailEventReportEvents.md +2 -1
  31. data/docs/GetExtendedCampaignOverview.md +6 -6
  32. data/docs/GetExtendedCampaignStats.md +1 -1
  33. data/docs/GetExtendedCampaignStatsGlobalStats.md +7 -0
  34. data/docs/GetExtendedContactDetails.md +2 -2
  35. data/docs/GetExtendedContactDetailsStatisticsLinks.md +1 -1
  36. data/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +1 -1
  37. data/docs/GetExtendedContactDetailsStatisticsOpened.md +1 -1
  38. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +2 -2
  39. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +2 -2
  40. data/docs/GetExtendedList.md +1 -1
  41. data/docs/GetFolderLists.md +2 -2
  42. data/docs/GetLists.md +2 -2
  43. data/docs/GetProcesses.md +1 -1
  44. data/docs/GetSmsCampaign.md +5 -5
  45. data/docs/GetSmsCampaignOverview.md +3 -3
  46. data/docs/GetSmsCampaignRecipients.md +7 -0
  47. data/docs/GetSmsCampaigns.md +1 -1
  48. data/docs/GetSmsEventReportEvents.md +4 -4
  49. data/docs/GetSmtpTemplateOverview.md +2 -2
  50. data/docs/GetTransacAggregatedSmsReport.md +10 -10
  51. data/docs/GetTransacBlockedContactsContacts.md +1 -1
  52. data/docs/GetTransacEmailContent.md +1 -1
  53. data/docs/GetTransacEmailContentEvents.md +1 -1
  54. data/docs/GetTransacEmailsListTransactionalEmails.md +1 -1
  55. data/docs/GetTransacSmsReportReports.md +10 -10
  56. data/docs/GetWebhook.md +2 -2
  57. data/docs/ListsApi.md +15 -9
  58. data/docs/ProcessApi.md +3 -1
  59. data/docs/RemoveContactFromList.md +2 -1
  60. data/docs/SMSCampaignsApi.md +7 -5
  61. data/docs/SendReportEmail.md +1 -5
  62. data/docs/SendSmtpEmail.md +3 -2
  63. data/docs/SendSmtpEmailMessageVersions.md +13 -0
  64. data/docs/SendSmtpEmailReplyTo1.md +9 -0
  65. data/docs/SendSmtpEmailSender.md +3 -2
  66. data/docs/SendSmtpEmailTo1.md +9 -0
  67. data/docs/SendTransacSms.md +1 -1
  68. data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +242 -60
  69. data/docs/TransactionalSMSApi.md +9 -5
  70. data/docs/UpdateEmailCampaign.md +1 -1
  71. data/docs/UpdateSmsCampaign.md +2 -2
  72. data/docs/UpdateWebhook.md +1 -1
  73. data/lib/sib-api-v3-sdk.rb +22 -10
  74. data/lib/sib-api-v3-sdk/api/account_api.rb +11 -1
  75. data/lib/sib-api-v3-sdk/api/attributes_api.rb +11 -1
  76. data/lib/sib-api-v3-sdk/api/contacts_api.rb +85 -45
  77. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +21 -5
  78. data/lib/sib-api-v3-sdk/api/folders_api.rb +23 -1
  79. data/lib/sib-api-v3-sdk/api/lists_api.rb +35 -7
  80. data/lib/sib-api-v3-sdk/api/process_api.rb +17 -1
  81. data/lib/sib-api-v3-sdk/api/reseller_api.rb +11 -1
  82. data/lib/sib-api-v3-sdk/api/senders_api.rb +11 -1
  83. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +21 -5
  84. data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +249 -55
  85. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +23 -1
  86. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +11 -1
  87. data/lib/sib-api-v3-sdk/api_client.rb +6 -4
  88. data/lib/sib-api-v3-sdk/api_error.rb +1 -1
  89. data/lib/sib-api-v3-sdk/configuration.rb +3 -3
  90. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +25 -6
  91. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +203 -0
  92. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +259 -0
  93. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +176 -0
  94. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +220 -0
  95. data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +206 -0
  96. data/lib/sib-api-v3-sdk/models/add_child_domain.rb +3 -2
  97. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +20 -7
  98. data/lib/sib-api-v3-sdk/models/add_credits.rb +3 -2
  99. data/lib/sib-api-v3-sdk/models/block_domain.rb +190 -0
  100. data/lib/sib-api-v3-sdk/models/create_attribute.rb +3 -2
  101. data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +3 -2
  102. data/lib/sib-api-v3-sdk/models/create_child.rb +3 -2
  103. data/lib/sib-api-v3-sdk/models/create_contact.rb +3 -2
  104. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +8 -2
  105. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +4 -3
  106. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +3 -2
  107. data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +3 -2
  108. data/lib/sib-api-v3-sdk/models/create_list.rb +3 -2
  109. data/lib/sib-api-v3-sdk/models/create_model.rb +3 -2
  110. data/lib/sib-api-v3-sdk/models/create_reseller.rb +3 -2
  111. data/lib/sib-api-v3-sdk/models/create_sender.rb +3 -2
  112. data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +3 -2
  113. data/lib/sib-api-v3-sdk/models/create_sender_model.rb +3 -2
  114. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +10 -9
  115. data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +3 -2
  116. data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +18 -11
  117. data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +3 -2
  118. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +3 -7
  119. data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +3 -2
  120. data/lib/sib-api-v3-sdk/models/create_update_folder.rb +3 -2
  121. data/lib/sib-api-v3-sdk/models/create_webhook.rb +4 -3
  122. data/lib/sib-api-v3-sdk/models/created_process_id.rb +3 -2
  123. data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +3 -2
  124. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +3 -2
  125. data/lib/sib-api-v3-sdk/models/error_model.rb +3 -2
  126. data/lib/sib-api-v3-sdk/models/get_account.rb +3 -2
  127. data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +3 -2
  128. data/lib/sib-api-v3-sdk/models/get_account_plan.rb +3 -2
  129. data/lib/sib-api-v3-sdk/models/get_account_relay.rb +3 -2
  130. data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +3 -2
  131. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +3 -67
  132. data/lib/sib-api-v3-sdk/models/get_attributes.rb +3 -2
  133. data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +3 -2
  134. data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +3 -2
  135. data/lib/sib-api-v3-sdk/models/get_blocked_domains.rb +193 -0
  136. data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +4 -3
  137. data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +3 -2
  138. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +17 -6
  139. data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +3 -2
  140. data/lib/sib-api-v3-sdk/models/get_child_domain.rb +3 -12
  141. data/lib/sib-api-v3-sdk/models/get_child_domains.rb +3 -2
  142. data/lib/sib-api-v3-sdk/models/get_child_info.rb +3 -2
  143. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +3 -2
  144. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +3 -2
  145. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +3 -2
  146. data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +3 -2
  147. data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +3 -2
  148. data/lib/sib-api-v3-sdk/models/get_children_list.rb +3 -7
  149. data/lib/sib-api-v3-sdk/models/get_client.rb +3 -2
  150. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +3 -2
  151. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +3 -2
  152. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +4 -3
  153. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +3 -2
  154. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +3 -2
  155. data/lib/sib-api-v3-sdk/models/get_contact_details.rb +5 -4
  156. data/lib/sib-api-v3-sdk/models/get_contacts.rb +3 -2
  157. data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +3 -2
  158. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +9 -18
  159. data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +3 -7
  160. data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +3 -2
  161. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +20 -9
  162. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +7 -16
  163. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +3 -2
  164. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +4 -4
  165. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats_global_stats.rb +176 -0
  166. data/lib/sib-api-v3-sdk/models/get_extended_client.rb +3 -2
  167. data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +3 -2
  168. data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +5 -4
  169. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +3 -2
  170. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +3 -2
  171. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +4 -3
  172. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +4 -3
  173. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +4 -3
  174. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +3 -2
  175. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +4 -8
  176. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +4 -8
  177. data/lib/sib-api-v3-sdk/models/get_extended_list.rb +4 -3
  178. data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +3 -2
  179. data/lib/sib-api-v3-sdk/models/get_folder.rb +3 -2
  180. data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +3 -12
  181. data/lib/sib-api-v3-sdk/models/get_folders.rb +3 -2
  182. data/lib/sib-api-v3-sdk/models/get_ip.rb +3 -2
  183. data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +3 -2
  184. data/lib/sib-api-v3-sdk/models/get_ips.rb +3 -2
  185. data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +3 -2
  186. data/lib/sib-api-v3-sdk/models/get_list.rb +3 -2
  187. data/lib/sib-api-v3-sdk/models/get_lists.rb +3 -12
  188. data/lib/sib-api-v3-sdk/models/get_process.rb +3 -2
  189. data/lib/sib-api-v3-sdk/models/get_processes.rb +3 -7
  190. data/lib/sib-api-v3-sdk/models/get_reports.rb +3 -2
  191. data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +3 -2
  192. data/lib/sib-api-v3-sdk/models/get_senders_list.rb +3 -2
  193. data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +3 -2
  194. data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +3 -2
  195. data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +3 -2
  196. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +8 -12
  197. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +6 -10
  198. data/lib/sib-api-v3-sdk/models/get_sms_campaign_recipients.rb +175 -0
  199. data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +3 -2
  200. data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +3 -7
  201. data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +3 -2
  202. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +4 -23
  203. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +5 -4
  204. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +3 -2
  205. data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +3 -2
  206. data/lib/sib-api-v3-sdk/models/get_sso_token.rb +3 -2
  207. data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +3 -2
  208. data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +3 -2
  209. data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +3 -2
  210. data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +3 -52
  211. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +3 -2
  212. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +4 -3
  213. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +3 -2
  214. data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +4 -3
  215. data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +4 -3
  216. data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +3 -2
  217. data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +4 -3
  218. data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +3 -2
  219. data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +3 -52
  220. data/lib/sib-api-v3-sdk/models/get_webhook.rb +5 -4
  221. data/lib/sib-api-v3-sdk/models/get_webhooks.rb +3 -2
  222. data/lib/sib-api-v3-sdk/models/manage_ip.rb +3 -2
  223. data/lib/sib-api-v3-sdk/models/post_contact_info.rb +3 -2
  224. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +3 -2
  225. data/lib/sib-api-v3-sdk/models/post_send_failed.rb +3 -2
  226. data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +3 -2
  227. data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +3 -2
  228. data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +3 -2
  229. data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +3 -2
  230. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +17 -4
  231. data/lib/sib-api-v3-sdk/models/remove_credits.rb +3 -2
  232. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +3 -2
  233. data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +3 -2
  234. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +3 -2
  235. data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +3 -2
  236. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +3 -2
  237. data/lib/sib-api-v3-sdk/models/send_email.rb +3 -2
  238. data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +3 -2
  239. data/lib/sib-api-v3-sdk/models/send_report.rb +3 -2
  240. data/lib/sib-api-v3-sdk/models/send_report_email.rb +6 -90
  241. data/lib/sib-api-v3-sdk/models/send_sms.rb +3 -2
  242. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +18 -10
  243. data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +3 -2
  244. data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +3 -2
  245. data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +3 -2
  246. data/lib/sib-api-v3-sdk/models/send_smtp_email_message_versions.rb +247 -0
  247. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +3 -2
  248. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to_1.rb +201 -0
  249. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +20 -14
  250. data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +3 -2
  251. data/lib/sib-api-v3-sdk/models/send_smtp_email_to_1.rb +200 -0
  252. data/lib/sib-api-v3-sdk/models/send_template_email.rb +3 -2
  253. data/lib/sib-api-v3-sdk/models/send_test_email.rb +3 -2
  254. data/lib/sib-api-v3-sdk/models/send_test_sms.rb +3 -2
  255. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +9 -8
  256. data/lib/sib-api-v3-sdk/models/update_attribute.rb +3 -2
  257. data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +3 -2
  258. data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +3 -2
  259. data/lib/sib-api-v3-sdk/models/update_child.rb +3 -2
  260. data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +3 -2
  261. data/lib/sib-api-v3-sdk/models/update_child_domain.rb +3 -2
  262. data/lib/sib-api-v3-sdk/models/update_contact.rb +3 -2
  263. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +4 -3
  264. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +3 -2
  265. data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +3 -2
  266. data/lib/sib-api-v3-sdk/models/update_list.rb +3 -2
  267. data/lib/sib-api-v3-sdk/models/update_sender.rb +3 -2
  268. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +10 -9
  269. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +3 -2
  270. data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +3 -2
  271. data/lib/sib-api-v3-sdk/models/update_webhook.rb +4 -3
  272. data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +3 -2
  273. data/lib/sib-api-v3-sdk/version.rb +2 -2
  274. data/spec/api/account_api_spec.rb +1 -1
  275. data/spec/api/attributes_api_spec.rb +1 -1
  276. data/spec/api/contacts_api_spec.rb +14 -9
  277. data/spec/api/email_campaigns_api_spec.rb +4 -3
  278. data/spec/api/folders_api_spec.rb +3 -1
  279. data/spec/api/lists_api_spec.rb +7 -4
  280. data/spec/api/process_api_spec.rb +2 -1
  281. data/spec/api/reseller_api_spec.rb +1 -1
  282. data/spec/api/senders_api_spec.rb +1 -1
  283. data/spec/api/sms_campaigns_api_spec.rb +4 -3
  284. data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +47 -7
  285. data/spec/api/transactional_sms_api_spec.rb +3 -1
  286. data/spec/api/webhooks_api_spec.rb +1 -1
  287. data/spec/api_client_spec.rb +18 -1
  288. data/spec/configuration_spec.rb +1 -1
  289. data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
  290. data/spec/models/ab_test_campaign_result_spec.rb +13 -1
  291. data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
  292. data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
  293. data/spec/models/ab_test_version_clicks_spec.rb +35 -0
  294. data/spec/models/ab_test_version_stats_spec.rb +47 -0
  295. data/spec/models/add_child_domain_spec.rb +1 -1
  296. data/spec/models/add_contact_to_list_spec.rb +7 -1
  297. data/spec/models/add_credits_spec.rb +1 -1
  298. data/spec/models/block_domain_spec.rb +41 -0
  299. data/spec/models/create_attribute_enumeration_spec.rb +1 -1
  300. data/spec/models/create_attribute_spec.rb +1 -1
  301. data/spec/models/create_child_spec.rb +1 -1
  302. data/spec/models/create_contact_spec.rb +1 -1
  303. data/spec/models/create_doi_contact_spec.rb +1 -1
  304. data/spec/models/create_email_campaign_recipients_spec.rb +1 -1
  305. data/spec/models/create_email_campaign_sender_spec.rb +1 -1
  306. data/spec/models/create_email_campaign_spec.rb +1 -1
  307. data/spec/models/create_list_spec.rb +1 -1
  308. data/spec/models/create_model_spec.rb +1 -1
  309. data/spec/models/create_reseller_spec.rb +1 -1
  310. data/spec/models/create_sender_ips_spec.rb +1 -1
  311. data/spec/models/create_sender_model_spec.rb +1 -1
  312. data/spec/models/create_sender_spec.rb +1 -1
  313. data/spec/models/create_sms_campaign_recipients_spec.rb +1 -1
  314. data/spec/models/create_sms_campaign_spec.rb +1 -1
  315. data/spec/models/create_smtp_email_spec.rb +7 -1
  316. data/spec/models/create_smtp_template_sender_spec.rb +1 -1
  317. data/spec/models/create_smtp_template_spec.rb +1 -1
  318. data/spec/models/create_update_contact_model_spec.rb +1 -1
  319. data/spec/models/create_update_folder_spec.rb +1 -1
  320. data/spec/models/create_webhook_spec.rb +1 -1
  321. data/spec/models/created_process_id_spec.rb +1 -1
  322. data/spec/models/delete_hardbounces_spec.rb +1 -1
  323. data/spec/models/email_export_recipients_spec.rb +1 -1
  324. data/spec/models/error_model_spec.rb +1 -1
  325. data/spec/models/get_account_marketing_automation_spec.rb +1 -1
  326. data/spec/models/get_account_plan_spec.rb +1 -1
  327. data/spec/models/get_account_relay_data_spec.rb +1 -1
  328. data/spec/models/get_account_relay_spec.rb +1 -1
  329. data/spec/models/get_account_spec.rb +1 -1
  330. data/spec/models/get_aggregated_report_spec.rb +1 -1
  331. data/spec/models/get_attributes_attributes_spec.rb +1 -1
  332. data/spec/models/get_attributes_enumeration_spec.rb +1 -1
  333. data/spec/models/get_attributes_spec.rb +1 -1
  334. data/spec/models/get_blocked_domains_spec.rb +41 -0
  335. data/spec/models/get_campaign_overview_spec.rb +1 -1
  336. data/spec/models/get_campaign_recipients_spec.rb +1 -1
  337. data/spec/models/get_campaign_stats_spec.rb +7 -1
  338. data/spec/models/get_child_account_creation_status_spec.rb +1 -1
  339. data/spec/models/get_child_domain_spec.rb +1 -1
  340. data/spec/models/get_child_domains_spec.rb +1 -1
  341. data/spec/models/get_child_info_api_keys_spec.rb +1 -1
  342. data/spec/models/get_child_info_api_keys_v2_spec.rb +1 -1
  343. data/spec/models/get_child_info_api_keys_v3_spec.rb +1 -1
  344. data/spec/models/get_child_info_credits_spec.rb +1 -1
  345. data/spec/models/get_child_info_spec.rb +1 -1
  346. data/spec/models/get_child_info_statistics_spec.rb +1 -1
  347. data/spec/models/get_children_list_spec.rb +1 -1
  348. data/spec/models/get_client_spec.rb +1 -1
  349. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +1 -1
  350. data/spec/models/get_contact_campaign_stats_opened_spec.rb +1 -1
  351. data/spec/models/get_contact_campaign_stats_spec.rb +1 -1
  352. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +1 -1
  353. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +1 -1
  354. data/spec/models/get_contact_details_spec.rb +1 -1
  355. data/spec/models/get_contacts_spec.rb +1 -1
  356. data/spec/models/get_device_browser_stats_spec.rb +1 -1
  357. data/spec/models/get_email_campaign_spec.rb +1 -1
  358. data/spec/models/get_email_campaigns_spec.rb +1 -1
  359. data/spec/models/get_email_event_report_events_spec.rb +8 -2
  360. data/spec/models/get_email_event_report_spec.rb +1 -1
  361. data/spec/models/get_extended_campaign_overview_sender_spec.rb +1 -1
  362. data/spec/models/get_extended_campaign_overview_spec.rb +1 -1
  363. data/spec/models/get_extended_campaign_stats_global_stats_spec.rb +35 -0
  364. data/spec/models/get_extended_campaign_stats_spec.rb +1 -1
  365. data/spec/models/get_extended_client_address_spec.rb +1 -1
  366. data/spec/models/get_extended_client_spec.rb +1 -1
  367. data/spec/models/get_extended_contact_details_spec.rb +1 -1
  368. data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +1 -1
  369. data/spec/models/get_extended_contact_details_statistics_links_spec.rb +1 -1
  370. data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +1 -1
  371. data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +1 -1
  372. data/spec/models/get_extended_contact_details_statistics_spec.rb +1 -1
  373. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +1 -1
  374. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +1 -1
  375. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +1 -1
  376. data/spec/models/get_extended_list_campaign_stats_spec.rb +1 -1
  377. data/spec/models/get_extended_list_spec.rb +1 -1
  378. data/spec/models/get_folder_lists_spec.rb +1 -1
  379. data/spec/models/get_folder_spec.rb +1 -1
  380. data/spec/models/get_folders_spec.rb +1 -1
  381. data/spec/models/get_ip_from_sender_spec.rb +1 -1
  382. data/spec/models/get_ip_spec.rb +1 -1
  383. data/spec/models/get_ips_from_sender_spec.rb +1 -1
  384. data/spec/models/get_ips_spec.rb +1 -1
  385. data/spec/models/get_list_spec.rb +1 -1
  386. data/spec/models/get_lists_spec.rb +1 -1
  387. data/spec/models/get_process_spec.rb +1 -1
  388. data/spec/models/get_processes_spec.rb +1 -1
  389. data/spec/models/get_reports_reports_spec.rb +1 -1
  390. data/spec/models/get_reports_spec.rb +1 -1
  391. data/spec/models/get_senders_list_ips_spec.rb +1 -1
  392. data/spec/models/get_senders_list_senders_spec.rb +1 -1
  393. data/spec/models/get_senders_list_spec.rb +1 -1
  394. data/spec/models/get_shared_template_url_spec.rb +1 -1
  395. data/spec/models/get_sms_campaign_overview_spec.rb +1 -1
  396. data/spec/models/get_sms_campaign_recipients_spec.rb +35 -0
  397. data/spec/models/get_sms_campaign_spec.rb +1 -1
  398. data/spec/models/get_sms_campaign_stats_spec.rb +1 -1
  399. data/spec/models/get_sms_campaigns_spec.rb +1 -1
  400. data/spec/models/get_sms_event_report_events_spec.rb +1 -1
  401. data/spec/models/get_sms_event_report_spec.rb +1 -1
  402. data/spec/models/get_smtp_template_overview_sender_spec.rb +1 -1
  403. data/spec/models/get_smtp_template_overview_spec.rb +1 -1
  404. data/spec/models/get_smtp_templates_spec.rb +1 -1
  405. data/spec/models/get_sso_token_spec.rb +1 -1
  406. data/spec/models/get_stats_by_browser_spec.rb +1 -1
  407. data/spec/models/get_stats_by_device_spec.rb +1 -1
  408. data/spec/models/get_stats_by_domain_spec.rb +1 -1
  409. data/spec/models/get_transac_aggregated_sms_report_spec.rb +1 -1
  410. data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +1 -1
  411. data/spec/models/get_transac_blocked_contacts_reason_spec.rb +1 -1
  412. data/spec/models/get_transac_blocked_contacts_spec.rb +1 -1
  413. data/spec/models/get_transac_email_content_events_spec.rb +1 -1
  414. data/spec/models/get_transac_email_content_spec.rb +1 -1
  415. data/spec/models/get_transac_emails_list_spec.rb +1 -1
  416. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +1 -1
  417. data/spec/models/get_transac_sms_report_reports_spec.rb +1 -1
  418. data/spec/models/get_transac_sms_report_spec.rb +1 -1
  419. data/spec/models/get_webhook_spec.rb +1 -1
  420. data/spec/models/get_webhooks_spec.rb +1 -1
  421. data/spec/models/manage_ip_spec.rb +1 -1
  422. data/spec/models/post_contact_info_contacts_spec.rb +1 -1
  423. data/spec/models/post_contact_info_spec.rb +1 -1
  424. data/spec/models/post_send_failed_spec.rb +1 -1
  425. data/spec/models/post_send_sms_test_failed_spec.rb +1 -1
  426. data/spec/models/remaining_credit_model_child_spec.rb +1 -1
  427. data/spec/models/remaining_credit_model_reseller_spec.rb +1 -1
  428. data/spec/models/remaining_credit_model_spec.rb +1 -1
  429. data/spec/models/remove_contact_from_list_spec.rb +7 -1
  430. data/spec/models/remove_credits_spec.rb +1 -1
  431. data/spec/models/request_contact_export_custom_contact_filter_spec.rb +1 -1
  432. data/spec/models/request_contact_export_spec.rb +1 -1
  433. data/spec/models/request_contact_import_new_list_spec.rb +1 -1
  434. data/spec/models/request_contact_import_spec.rb +1 -1
  435. data/spec/models/request_sms_recipient_export_spec.rb +1 -1
  436. data/spec/models/send_email_attachment_spec.rb +1 -1
  437. data/spec/models/send_email_spec.rb +1 -1
  438. data/spec/models/send_report_email_spec.rb +1 -29
  439. data/spec/models/send_report_spec.rb +1 -1
  440. data/spec/models/send_sms_spec.rb +1 -1
  441. data/spec/models/send_smtp_email_attachment_spec.rb +1 -1
  442. data/spec/models/send_smtp_email_bcc_spec.rb +1 -1
  443. data/spec/models/send_smtp_email_cc_spec.rb +1 -1
  444. data/spec/models/send_smtp_email_message_versions_spec.rb +71 -0
  445. data/spec/models/send_smtp_email_reply_to_1_spec.rb +47 -0
  446. data/spec/models/send_smtp_email_reply_to_spec.rb +1 -1
  447. data/spec/models/send_smtp_email_sender_spec.rb +7 -1
  448. data/spec/models/send_smtp_email_spec.rb +7 -1
  449. data/spec/models/send_smtp_email_to_1_spec.rb +47 -0
  450. data/spec/models/send_smtp_email_to_spec.rb +1 -1
  451. data/spec/models/send_template_email_spec.rb +1 -1
  452. data/spec/models/send_test_email_spec.rb +1 -1
  453. data/spec/models/send_test_sms_spec.rb +1 -1
  454. data/spec/models/send_transac_sms_spec.rb +1 -1
  455. data/spec/models/update_attribute_enumeration_spec.rb +1 -1
  456. data/spec/models/update_attribute_spec.rb +1 -1
  457. data/spec/models/update_campaign_status_spec.rb +1 -1
  458. data/spec/models/update_child_account_status_spec.rb +1 -1
  459. data/spec/models/update_child_domain_spec.rb +1 -1
  460. data/spec/models/update_child_spec.rb +1 -1
  461. data/spec/models/update_contact_spec.rb +1 -1
  462. data/spec/models/update_email_campaign_recipients_spec.rb +1 -1
  463. data/spec/models/update_email_campaign_sender_spec.rb +1 -1
  464. data/spec/models/update_email_campaign_spec.rb +1 -1
  465. data/spec/models/update_list_spec.rb +1 -1
  466. data/spec/models/update_sender_spec.rb +1 -1
  467. data/spec/models/update_sms_campaign_spec.rb +1 -1
  468. data/spec/models/update_smtp_template_sender_spec.rb +1 -1
  469. data/spec/models/update_smtp_template_spec.rb +1 -1
  470. data/spec/models/update_webhook_spec.rb +1 -1
  471. data/spec/models/upload_image_to_gallery_spec.rb +1 -1
  472. data/spec/spec_helper.rb +1 -1
  473. metadata +58 -10
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f95ab1900ea673f64cf7a1edee7db7c1810e8bc1018ea2e1933fbbb6d94a0059
4
- data.tar.gz: 5545aac0b0762fdf65b9b105350a9699d49562d0e0626f77beadffeb17bec006
3
+ metadata.gz: 30ce4095a80ff1d1c8650786dae1e129230c6d4a7f7ff0e19f489bf747c31be1
4
+ data.tar.gz: 9f82e028135b54b8d52d15682a3808c812effb59a0b8aa7fced5f24ca0ea15a7
5
5
  SHA512:
6
- metadata.gz: 40d877f79b569f7f4d44f8972e72f7b64ce1a4068d309ba9c3007705ba4b7e62c102a61286aae544f7c450ee3c2c80f58ede98b103afe1aacf1dde544d509e05
7
- data.tar.gz: fb703e781f1730fbfe885c3ae6bfe4e2d1cdc585945591a8dcbe43ba66cf5fbedee0263ecc83071e4edb1a02b0e031311061852c59b813c80de3171c255fcbfe
6
+ metadata.gz: 6f6315fc12b200fbac89fb8948240e932da3161e6a281351e8d9341f5226e344cc9b619e1aef4992a3459e39552f810646b739057024254e2bfa6f78367baa2a
7
+ data.tar.gz: 1077e37a3a31f1f0df35e14247ee013118f7a646b95838bce8dd26594925673965a1d66dd692504e76891656cdc48b394bcdf9e61b759ef8aa4ad96f357fac35
data/README.md CHANGED
@@ -96,12 +96,12 @@ Class | Method | HTTP request | Description
96
96
  *SibApiV3Sdk::ContactsApi* | [**create_folder**](docs/ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
97
97
  *SibApiV3Sdk::ContactsApi* | [**create_list**](docs/ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
98
98
  *SibApiV3Sdk::ContactsApi* | [**delete_attribute**](docs/ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
99
- *SibApiV3Sdk::ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} | Delete a contact
99
+ *SibApiV3Sdk::ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /contacts/{identifier} | Delete a contact
100
100
  *SibApiV3Sdk::ContactsApi* | [**delete_folder**](docs/ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
101
101
  *SibApiV3Sdk::ContactsApi* | [**delete_list**](docs/ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
102
102
  *SibApiV3Sdk::ContactsApi* | [**get_attributes**](docs/ContactsApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
103
- *SibApiV3Sdk::ContactsApi* | [**get_contact_info**](docs/ContactsApi.md#get_contact_info) | **GET** /contacts/{email} | Get a contact's details
104
- *SibApiV3Sdk::ContactsApi* | [**get_contact_stats**](docs/ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get email campaigns' statistics for a contact
103
+ *SibApiV3Sdk::ContactsApi* | [**get_contact_info**](docs/ContactsApi.md#get_contact_info) | **GET** /contacts/{identifier} | Get a contact's details
104
+ *SibApiV3Sdk::ContactsApi* | [**get_contact_stats**](docs/ContactsApi.md#get_contact_stats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
105
105
  *SibApiV3Sdk::ContactsApi* | [**get_contacts**](docs/ContactsApi.md#get_contacts) | **GET** /contacts | Get all the contacts
106
106
  *SibApiV3Sdk::ContactsApi* | [**get_contacts_from_list**](docs/ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
107
107
  *SibApiV3Sdk::ContactsApi* | [**get_folder**](docs/ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
@@ -113,7 +113,7 @@ Class | Method | HTTP request | Description
113
113
  *SibApiV3Sdk::ContactsApi* | [**remove_contact_from_list**](docs/ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
114
114
  *SibApiV3Sdk::ContactsApi* | [**request_contact_export**](docs/ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
115
115
  *SibApiV3Sdk::ContactsApi* | [**update_attribute**](docs/ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
116
- *SibApiV3Sdk::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Update a contact
116
+ *SibApiV3Sdk::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{identifier} | Update a contact
117
117
  *SibApiV3Sdk::ContactsApi* | [**update_folder**](docs/ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
118
118
  *SibApiV3Sdk::ContactsApi* | [**update_list**](docs/ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
119
119
  *SibApiV3Sdk::EmailCampaignsApi* | [**create_email_campaign**](docs/EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
@@ -172,29 +172,32 @@ Class | Method | HTTP request | Description
172
172
  *SibApiV3Sdk::SMSCampaignsApi* | [**send_test_sms**](docs/SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign
173
173
  *SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign**](docs/SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign
174
174
  *SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign_status**](docs/SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status
175
- *SibApiV3Sdk::SMTPApi* | [**create_smtp_template**](docs/SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
176
- *SibApiV3Sdk::SMTPApi* | [**delete_hardbounces**](docs/SMTPApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
177
- *SibApiV3Sdk::SMTPApi* | [**delete_smtp_template**](docs/SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
178
- *SibApiV3Sdk::SMTPApi* | [**get_aggregated_smtp_report**](docs/SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
179
- *SibApiV3Sdk::SMTPApi* | [**get_email_event_report**](docs/SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
180
- *SibApiV3Sdk::SMTPApi* | [**get_smtp_report**](docs/SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
181
- *SibApiV3Sdk::SMTPApi* | [**get_smtp_template**](docs/SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
182
- *SibApiV3Sdk::SMTPApi* | [**get_smtp_templates**](docs/SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
183
- *SibApiV3Sdk::SMTPApi* | [**get_transac_blocked_contacts**](docs/SMTPApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
184
- *SibApiV3Sdk::SMTPApi* | [**get_transac_email_content**](docs/SMTPApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
185
- *SibApiV3Sdk::SMTPApi* | [**get_transac_emails_list**](docs/SMTPApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
186
- *SibApiV3Sdk::SMTPApi* | [**send_template**](docs/SMTPApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
187
- *SibApiV3Sdk::SMTPApi* | [**send_test_template**](docs/SMTPApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
188
- *SibApiV3Sdk::SMTPApi* | [**send_transac_email**](docs/SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
189
- *SibApiV3Sdk::SMTPApi* | [**smtp_blocked_contacts_email_delete**](docs/SMTPApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
190
- *SibApiV3Sdk::SMTPApi* | [**smtp_log_message_id_delete**](docs/SMTPApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
191
- *SibApiV3Sdk::SMTPApi* | [**update_smtp_template**](docs/SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
192
175
  *SibApiV3Sdk::SendersApi* | [**create_sender**](docs/SendersApi.md#create_sender) | **POST** /senders | Create a new sender
193
176
  *SibApiV3Sdk::SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{senderId} | Delete a sender
194
177
  *SibApiV3Sdk::SendersApi* | [**get_ips**](docs/SendersApi.md#get_ips) | **GET** /senders/ips | Get all the dedicated IPs for your account
195
178
  *SibApiV3Sdk::SendersApi* | [**get_ips_from_sender**](docs/SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
196
179
  *SibApiV3Sdk::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Get the list of all your senders
197
180
  *SibApiV3Sdk::SendersApi* | [**update_sender**](docs/SendersApi.md#update_sender) | **PUT** /senders/{senderId} | Update a sender
181
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**block_new_domain**](docs/TransactionalEmailsApi.md#block_new_domain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
182
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**create_smtp_template**](docs/TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
183
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**delete_blocked_domain**](docs/TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
184
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**delete_hardbounces**](docs/TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
185
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**delete_smtp_template**](docs/TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
186
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_aggregated_smtp_report**](docs/TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
187
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_blocked_domains**](docs/TransactionalEmailsApi.md#get_blocked_domains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
188
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_email_event_report**](docs/TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
189
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_report**](docs/TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
190
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_template**](docs/TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
191
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_templates**](docs/TransactionalEmailsApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
192
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_transac_blocked_contacts**](docs/TransactionalEmailsApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
193
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_transac_email_content**](docs/TransactionalEmailsApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
194
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**get_transac_emails_list**](docs/TransactionalEmailsApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
195
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**send_template**](docs/TransactionalEmailsApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
196
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**send_test_template**](docs/TransactionalEmailsApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
197
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**send_transac_email**](docs/TransactionalEmailsApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
198
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**smtp_blocked_contacts_email_delete**](docs/TransactionalEmailsApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
199
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**smtp_log_message_id_delete**](docs/TransactionalEmailsApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
200
+ *SibApiV3Sdk::TransactionalEmailsApi* | [**update_smtp_template**](docs/TransactionalEmailsApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
198
201
  *SibApiV3Sdk::TransactionalSMSApi* | [**get_sms_events**](docs/TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
199
202
  *SibApiV3Sdk::TransactionalSMSApi* | [**get_transac_aggregated_sms_report**](docs/TransactionalSMSApi.md#get_transac_aggregated_sms_report) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
200
203
  *SibApiV3Sdk::TransactionalSMSApi* | [**get_transac_sms_report**](docs/TransactionalSMSApi.md#get_transac_sms_report) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
@@ -209,9 +212,15 @@ Class | Method | HTTP request | Description
209
212
  ## Documentation for Models
210
213
 
211
214
  - [SibApiV3Sdk::AbTestCampaignResult](docs/AbTestCampaignResult.md)
215
+ - [SibApiV3Sdk::AbTestCampaignResultClickedLinks](docs/AbTestCampaignResultClickedLinks.md)
216
+ - [SibApiV3Sdk::AbTestCampaignResultStatistics](docs/AbTestCampaignResultStatistics.md)
217
+ - [SibApiV3Sdk::AbTestVersionClicks](docs/AbTestVersionClicks.md)
218
+ - [SibApiV3Sdk::AbTestVersionClicksInner](docs/AbTestVersionClicksInner.md)
219
+ - [SibApiV3Sdk::AbTestVersionStats](docs/AbTestVersionStats.md)
212
220
  - [SibApiV3Sdk::AddChildDomain](docs/AddChildDomain.md)
213
221
  - [SibApiV3Sdk::AddContactToList](docs/AddContactToList.md)
214
222
  - [SibApiV3Sdk::AddCredits](docs/AddCredits.md)
223
+ - [SibApiV3Sdk::BlockDomain](docs/BlockDomain.md)
215
224
  - [SibApiV3Sdk::CreateAttribute](docs/CreateAttribute.md)
216
225
  - [SibApiV3Sdk::CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
217
226
  - [SibApiV3Sdk::CreateChild](docs/CreateChild.md)
@@ -238,6 +247,7 @@ Class | Method | HTTP request | Description
238
247
  - [SibApiV3Sdk::DeleteHardbounces](docs/DeleteHardbounces.md)
239
248
  - [SibApiV3Sdk::EmailExportRecipients](docs/EmailExportRecipients.md)
240
249
  - [SibApiV3Sdk::ErrorModel](docs/ErrorModel.md)
250
+ - [SibApiV3Sdk::GetAccount](docs/GetAccount.md)
241
251
  - [SibApiV3Sdk::GetAccountMarketingAutomation](docs/GetAccountMarketingAutomation.md)
242
252
  - [SibApiV3Sdk::GetAccountPlan](docs/GetAccountPlan.md)
243
253
  - [SibApiV3Sdk::GetAccountRelay](docs/GetAccountRelay.md)
@@ -246,12 +256,14 @@ Class | Method | HTTP request | Description
246
256
  - [SibApiV3Sdk::GetAttributes](docs/GetAttributes.md)
247
257
  - [SibApiV3Sdk::GetAttributesAttributes](docs/GetAttributesAttributes.md)
248
258
  - [SibApiV3Sdk::GetAttributesEnumeration](docs/GetAttributesEnumeration.md)
259
+ - [SibApiV3Sdk::GetBlockedDomains](docs/GetBlockedDomains.md)
249
260
  - [SibApiV3Sdk::GetCampaignOverview](docs/GetCampaignOverview.md)
250
261
  - [SibApiV3Sdk::GetCampaignRecipients](docs/GetCampaignRecipients.md)
251
262
  - [SibApiV3Sdk::GetCampaignStats](docs/GetCampaignStats.md)
252
263
  - [SibApiV3Sdk::GetChildAccountCreationStatus](docs/GetChildAccountCreationStatus.md)
253
264
  - [SibApiV3Sdk::GetChildDomain](docs/GetChildDomain.md)
254
265
  - [SibApiV3Sdk::GetChildDomains](docs/GetChildDomains.md)
266
+ - [SibApiV3Sdk::GetChildInfo](docs/GetChildInfo.md)
255
267
  - [SibApiV3Sdk::GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
256
268
  - [SibApiV3Sdk::GetChildInfoApiKeysV2](docs/GetChildInfoApiKeysV2.md)
257
269
  - [SibApiV3Sdk::GetChildInfoApiKeysV3](docs/GetChildInfoApiKeysV3.md)
@@ -267,12 +279,17 @@ Class | Method | HTTP request | Description
267
279
  - [SibApiV3Sdk::GetContactDetails](docs/GetContactDetails.md)
268
280
  - [SibApiV3Sdk::GetContacts](docs/GetContacts.md)
269
281
  - [SibApiV3Sdk::GetDeviceBrowserStats](docs/GetDeviceBrowserStats.md)
282
+ - [SibApiV3Sdk::GetEmailCampaign](docs/GetEmailCampaign.md)
270
283
  - [SibApiV3Sdk::GetEmailCampaigns](docs/GetEmailCampaigns.md)
271
284
  - [SibApiV3Sdk::GetEmailEventReport](docs/GetEmailEventReport.md)
272
285
  - [SibApiV3Sdk::GetEmailEventReportEvents](docs/GetEmailEventReportEvents.md)
286
+ - [SibApiV3Sdk::GetExtendedCampaignOverview](docs/GetExtendedCampaignOverview.md)
273
287
  - [SibApiV3Sdk::GetExtendedCampaignOverviewSender](docs/GetExtendedCampaignOverviewSender.md)
274
288
  - [SibApiV3Sdk::GetExtendedCampaignStats](docs/GetExtendedCampaignStats.md)
289
+ - [SibApiV3Sdk::GetExtendedCampaignStatsGlobalStats](docs/GetExtendedCampaignStatsGlobalStats.md)
290
+ - [SibApiV3Sdk::GetExtendedClient](docs/GetExtendedClient.md)
275
291
  - [SibApiV3Sdk::GetExtendedClientAddress](docs/GetExtendedClientAddress.md)
292
+ - [SibApiV3Sdk::GetExtendedContactDetails](docs/GetExtendedContactDetails.md)
276
293
  - [SibApiV3Sdk::GetExtendedContactDetailsStatistics](docs/GetExtendedContactDetailsStatistics.md)
277
294
  - [SibApiV3Sdk::GetExtendedContactDetailsStatisticsClicked](docs/GetExtendedContactDetailsStatisticsClicked.md)
278
295
  - [SibApiV3Sdk::GetExtendedContactDetailsStatisticsLinks](docs/GetExtendedContactDetailsStatisticsLinks.md)
@@ -281,6 +298,7 @@ Class | Method | HTTP request | Description
281
298
  - [SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptions](docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md)
282
299
  - [SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription](docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md)
283
300
  - [SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription](docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md)
301
+ - [SibApiV3Sdk::GetExtendedList](docs/GetExtendedList.md)
284
302
  - [SibApiV3Sdk::GetExtendedListCampaignStats](docs/GetExtendedListCampaignStats.md)
285
303
  - [SibApiV3Sdk::GetFolder](docs/GetFolder.md)
286
304
  - [SibApiV3Sdk::GetFolderLists](docs/GetFolderLists.md)
@@ -299,7 +317,9 @@ Class | Method | HTTP request | Description
299
317
  - [SibApiV3Sdk::GetSendersListIps](docs/GetSendersListIps.md)
300
318
  - [SibApiV3Sdk::GetSendersListSenders](docs/GetSendersListSenders.md)
301
319
  - [SibApiV3Sdk::GetSharedTemplateUrl](docs/GetSharedTemplateUrl.md)
320
+ - [SibApiV3Sdk::GetSmsCampaign](docs/GetSmsCampaign.md)
302
321
  - [SibApiV3Sdk::GetSmsCampaignOverview](docs/GetSmsCampaignOverview.md)
322
+ - [SibApiV3Sdk::GetSmsCampaignRecipients](docs/GetSmsCampaignRecipients.md)
303
323
  - [SibApiV3Sdk::GetSmsCampaignStats](docs/GetSmsCampaignStats.md)
304
324
  - [SibApiV3Sdk::GetSmsCampaigns](docs/GetSmsCampaigns.md)
305
325
  - [SibApiV3Sdk::GetSmsEventReport](docs/GetSmsEventReport.md)
@@ -347,9 +367,12 @@ Class | Method | HTTP request | Description
347
367
  - [SibApiV3Sdk::SendSmtpEmailAttachment](docs/SendSmtpEmailAttachment.md)
348
368
  - [SibApiV3Sdk::SendSmtpEmailBcc](docs/SendSmtpEmailBcc.md)
349
369
  - [SibApiV3Sdk::SendSmtpEmailCc](docs/SendSmtpEmailCc.md)
370
+ - [SibApiV3Sdk::SendSmtpEmailMessageVersions](docs/SendSmtpEmailMessageVersions.md)
350
371
  - [SibApiV3Sdk::SendSmtpEmailReplyTo](docs/SendSmtpEmailReplyTo.md)
372
+ - [SibApiV3Sdk::SendSmtpEmailReplyTo1](docs/SendSmtpEmailReplyTo1.md)
351
373
  - [SibApiV3Sdk::SendSmtpEmailSender](docs/SendSmtpEmailSender.md)
352
374
  - [SibApiV3Sdk::SendSmtpEmailTo](docs/SendSmtpEmailTo.md)
375
+ - [SibApiV3Sdk::SendSmtpEmailTo1](docs/SendSmtpEmailTo1.md)
353
376
  - [SibApiV3Sdk::SendTemplateEmail](docs/SendTemplateEmail.md)
354
377
  - [SibApiV3Sdk::SendTestEmail](docs/SendTestEmail.md)
355
378
  - [SibApiV3Sdk::SendTestSms](docs/SendTestSms.md)
@@ -371,14 +394,6 @@ Class | Method | HTTP request | Description
371
394
  - [SibApiV3Sdk::UpdateSmtpTemplateSender](docs/UpdateSmtpTemplateSender.md)
372
395
  - [SibApiV3Sdk::UpdateWebhook](docs/UpdateWebhook.md)
373
396
  - [SibApiV3Sdk::UploadImageToGallery](docs/UploadImageToGallery.md)
374
- - [SibApiV3Sdk::GetChildInfo](docs/GetChildInfo.md)
375
- - [SibApiV3Sdk::GetExtendedCampaignOverview](docs/GetExtendedCampaignOverview.md)
376
- - [SibApiV3Sdk::GetExtendedClient](docs/GetExtendedClient.md)
377
- - [SibApiV3Sdk::GetExtendedContactDetails](docs/GetExtendedContactDetails.md)
378
- - [SibApiV3Sdk::GetExtendedList](docs/GetExtendedList.md)
379
- - [SibApiV3Sdk::GetSmsCampaign](docs/GetSmsCampaign.md)
380
- - [SibApiV3Sdk::GetAccount](docs/GetAccount.md)
381
- - [SibApiV3Sdk::GetEmailCampaign](docs/GetEmailCampaign.md)
382
397
 
383
398
 
384
399
  ## Documentation for Authorization
@@ -9,5 +9,7 @@ Name | Type | Description | Notes
9
9
  **open_rate** | **String** | Open rate for current winning version | [optional]
10
10
  **click_rate** | **String** | Click rate for current winning version | [optional]
11
11
  **winning_version_rate** | **String** | Open/Click rate for the winner version | [optional]
12
+ **statistics** | [**AbTestCampaignResultStatistics**](AbTestCampaignResultStatistics.md) | | [optional]
13
+ **clicked_links** | [**AbTestCampaignResultClickedLinks**](AbTestCampaignResultClickedLinks.md) | | [optional]
12
14
 
13
15
 
@@ -0,0 +1,9 @@
1
+ # SibApiV3Sdk::AbTestCampaignResultClickedLinks
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **version_a** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | |
7
+ **version_b** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | |
8
+
9
+
@@ -0,0 +1,13 @@
1
+ # SibApiV3Sdk::AbTestCampaignResultStatistics
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **openers** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
7
+ **clicks** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
8
+ **unsubscribed** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
9
+ **hard_bounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
10
+ **soft_bounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
11
+ **complaints** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
12
+
13
+
@@ -0,0 +1,7 @@
1
+ # SibApiV3Sdk::AbTestVersionClicks
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+
7
+
@@ -0,0 +1,10 @@
1
+ # SibApiV3Sdk::AbTestVersionClicksInner
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **link** | **String** | URL of the link |
7
+ **clicks_count** | **Float** | Number of times a link is clicked |
8
+ **click_rate** | **String** | Percentage of clicks of link with respect to total clicks |
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # SibApiV3Sdk::AbTestVersionStats
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **version_a** | **String** | percentage of an event for version A |
7
+ **version_b** | **String** | percentage of an event for version B |
8
+
9
+
@@ -3,6 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **emails** | **Array<String>** | Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
6
+ **emails** | **Array<String>** | Mandatory if IDs are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
7
+ **ids** | **Array<Integer>** | Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
7
8
 
8
9
 
@@ -0,0 +1,8 @@
1
+ # SibApiV3Sdk::BlockDomain
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **domain** | **String** | name of the domain to be blocked |
7
+
8
+
data/docs/ContactsApi.md CHANGED
@@ -11,12 +11,12 @@ Method | HTTP request | Description
11
11
  [**create_folder**](ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
12
12
  [**create_list**](ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
13
13
  [**delete_attribute**](ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
14
- [**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} | Delete a contact
14
+ [**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{identifier} | Delete a contact
15
15
  [**delete_folder**](ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
16
16
  [**delete_list**](ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
17
17
  [**get_attributes**](ContactsApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
18
- [**get_contact_info**](ContactsApi.md#get_contact_info) | **GET** /contacts/{email} | Get a contact's details
19
- [**get_contact_stats**](ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get email campaigns' statistics for a contact
18
+ [**get_contact_info**](ContactsApi.md#get_contact_info) | **GET** /contacts/{identifier} | Get a contact's details
19
+ [**get_contact_stats**](ContactsApi.md#get_contact_stats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
20
20
  [**get_contacts**](ContactsApi.md#get_contacts) | **GET** /contacts | Get all the contacts
21
21
  [**get_contacts_from_list**](ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
22
22
  [**get_folder**](ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
@@ -28,7 +28,7 @@ Method | HTTP request | Description
28
28
  [**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
29
29
  [**request_contact_export**](ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
30
30
  [**update_attribute**](ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
31
- [**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Update a contact
31
+ [**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{identifier} | Update a contact
32
32
  [**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
33
33
  [**update_list**](ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
34
34
 
@@ -59,7 +59,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
59
59
 
60
60
  list_id = 789 # Integer | Id of the list
61
61
 
62
- contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses of the contacts
62
+ contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses OR IDs of the contacts
63
63
 
64
64
 
65
65
  begin
@@ -76,7 +76,7 @@ end
76
76
  Name | Type | Description | Notes
77
77
  ------------- | ------------- | ------------- | -------------
78
78
  **list_id** | **Integer**| Id of the list |
79
- **contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts |
79
+ **contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts |
80
80
 
81
81
  ### Return type
82
82
 
@@ -442,7 +442,7 @@ nil (empty response body)
442
442
 
443
443
 
444
444
  # **delete_contact**
445
- > delete_contact(email)
445
+ > delete_contact(identifier)
446
446
 
447
447
  Delete a contact
448
448
 
@@ -465,12 +465,12 @@ end
465
465
 
466
466
  api_instance = SibApiV3Sdk::ContactsApi.new
467
467
 
468
- email = 'email_example' # String | Email (urlencoded) of the contact
468
+ identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
469
469
 
470
470
 
471
471
  begin
472
472
  #Delete a contact
473
- api_instance.delete_contact(email)
473
+ api_instance.delete_contact(identifier)
474
474
  rescue SibApiV3Sdk::ApiError => e
475
475
  puts "Exception when calling ContactsApi->delete_contact: #{e}"
476
476
  end
@@ -480,7 +480,7 @@ end
480
480
 
481
481
  Name | Type | Description | Notes
482
482
  ------------- | ------------- | ------------- | -------------
483
- **email** | **String**| Email (urlencoded) of the contact |
483
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact |
484
484
 
485
485
  ### Return type
486
486
 
@@ -661,7 +661,7 @@ This endpoint does not need any parameter.
661
661
 
662
662
 
663
663
  # **get_contact_info**
664
- > GetExtendedContactDetails get_contact_info(email)
664
+ > GetExtendedContactDetails get_contact_info(identifier)
665
665
 
666
666
  Get a contact's details
667
667
 
@@ -684,12 +684,12 @@ end
684
684
 
685
685
  api_instance = SibApiV3Sdk::ContactsApi.new
686
686
 
687
- email = 'email_example' # String | Email (urlencoded) of the contact OR its SMS attribute value
687
+ identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact OR its SMS attribute value
688
688
 
689
689
 
690
690
  begin
691
691
  #Get a contact's details
692
- result = api_instance.get_contact_info(email)
692
+ result = api_instance.get_contact_info(identifier)
693
693
  p result
694
694
  rescue SibApiV3Sdk::ApiError => e
695
695
  puts "Exception when calling ContactsApi->get_contact_info: #{e}"
@@ -700,7 +700,7 @@ end
700
700
 
701
701
  Name | Type | Description | Notes
702
702
  ------------- | ------------- | ------------- | -------------
703
- **email** | **String**| Email (urlencoded) of the contact OR its SMS attribute value |
703
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact OR its SMS attribute value |
704
704
 
705
705
  ### Return type
706
706
 
@@ -718,7 +718,7 @@ Name | Type | Description | Notes
718
718
 
719
719
 
720
720
  # **get_contact_stats**
721
- > GetContactCampaignStats get_contact_stats(email, opts)
721
+ > GetContactCampaignStats get_contact_stats(identifier, opts)
722
722
 
723
723
  Get email campaigns' statistics for a contact
724
724
 
@@ -741,7 +741,7 @@ end
741
741
 
742
742
  api_instance = SibApiV3Sdk::ContactsApi.new
743
743
 
744
- email = 'email_example' # String | Email address (urlencoded) of the contact
744
+ identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
745
745
 
746
746
  opts = {
747
747
  start_date: Date.parse('2013-10-20'), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
@@ -750,7 +750,7 @@ opts = {
750
750
 
751
751
  begin
752
752
  #Get email campaigns' statistics for a contact
753
- result = api_instance.get_contact_stats(email, opts)
753
+ result = api_instance.get_contact_stats(identifier, opts)
754
754
  p result
755
755
  rescue SibApiV3Sdk::ApiError => e
756
756
  puts "Exception when calling ContactsApi->get_contact_stats: #{e}"
@@ -761,7 +761,7 @@ end
761
761
 
762
762
  Name | Type | Description | Notes
763
763
  ------------- | ------------- | ------------- | -------------
764
- **email** | **String**| Email address (urlencoded) of the contact |
764
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact |
765
765
  **start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
766
766
  **end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate | [optional]
767
767
 
@@ -807,7 +807,8 @@ api_instance = SibApiV3Sdk::ContactsApi.new
807
807
  opts = {
808
808
  limit: 50, # Integer | Number of documents per page
809
809
  offset: 0, # Integer | Index of the first document of the page
810
- modified_since: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
810
+ modified_since: 'modified_since_example', # String | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
811
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
811
812
  }
812
813
 
813
814
  begin
@@ -825,7 +826,8 @@ Name | Type | Description | Notes
825
826
  ------------- | ------------- | ------------- | -------------
826
827
  **limit** | **Integer**| Number of documents per page | [optional] [default to 50]
827
828
  **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
828
- **modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
829
+ **modified_since** | **String**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
830
+ **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]
829
831
 
830
832
  ### Return type
831
833
 
@@ -869,9 +871,10 @@ api_instance = SibApiV3Sdk::ContactsApi.new
869
871
  list_id = 789 # Integer | Id of the list
870
872
 
871
873
  opts = {
872
- modified_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
874
+ modified_since: 'modified_since_example', # String | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
873
875
  limit: 50, # Integer | Number of documents per page
874
- offset: 0 # Integer | Index of the first document of the page
876
+ offset: 0, # Integer | Index of the first document of the page
877
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
875
878
  }
876
879
 
877
880
  begin
@@ -888,9 +891,10 @@ end
888
891
  Name | Type | Description | Notes
889
892
  ------------- | ------------- | ------------- | -------------
890
893
  **list_id** | **Integer**| Id of the list |
891
- **modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
894
+ **modified_since** | **String**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
892
895
  **limit** | **Integer**| Number of documents per page | [optional] [default to 50]
893
896
  **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
897
+ **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]
894
898
 
895
899
  ### Return type
896
900
 
@@ -992,7 +996,8 @@ folder_id = 789 # Integer | Id of the folder
992
996
 
993
997
  opts = {
994
998
  limit: 10, # Integer | Number of documents per page
995
- offset: 0 # Integer | Index of the first document of the page
999
+ offset: 0, # Integer | Index of the first document of the page
1000
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
996
1001
  }
997
1002
 
998
1003
  begin
@@ -1011,6 +1016,7 @@ Name | Type | Description | Notes
1011
1016
  **folder_id** | **Integer**| Id of the folder |
1012
1017
  **limit** | **Integer**| Number of documents per page | [optional] [default to 10]
1013
1018
  **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
1019
+ **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]
1014
1020
 
1015
1021
  ### Return type
1016
1022
 
@@ -1028,7 +1034,7 @@ Name | Type | Description | Notes
1028
1034
 
1029
1035
 
1030
1036
  # **get_folders**
1031
- > GetFolders get_folders(limit, offset)
1037
+ > GetFolders get_folders(limit, offset, opts)
1032
1038
 
1033
1039
  Get all folders
1034
1040
 
@@ -1055,10 +1061,13 @@ limit = 10 # Integer | Number of documents per page
1055
1061
 
1056
1062
  offset = 0 # Integer | Index of the first document of the page
1057
1063
 
1064
+ opts = {
1065
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
1066
+ }
1058
1067
 
1059
1068
  begin
1060
1069
  #Get all folders
1061
- result = api_instance.get_folders(limit, offset)
1070
+ result = api_instance.get_folders(limit, offset, opts)
1062
1071
  p result
1063
1072
  rescue SibApiV3Sdk::ApiError => e
1064
1073
  puts "Exception when calling ContactsApi->get_folders: #{e}"
@@ -1071,6 +1080,7 @@ Name | Type | Description | Notes
1071
1080
  ------------- | ------------- | ------------- | -------------
1072
1081
  **limit** | **Integer**| Number of documents per page | [default to 10]
1073
1082
  **offset** | **Integer**| Index of the first document of the page | [default to 0]
1083
+ **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]
1074
1084
 
1075
1085
  ### Return type
1076
1086
 
@@ -1170,7 +1180,8 @@ api_instance = SibApiV3Sdk::ContactsApi.new
1170
1180
 
1171
1181
  opts = {
1172
1182
  limit: 10, # Integer | Number of documents per page
1173
- offset: 0 # Integer | Index of the first document of the page
1183
+ offset: 0, # Integer | Index of the first document of the page
1184
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
1174
1185
  }
1175
1186
 
1176
1187
  begin
@@ -1188,6 +1199,7 @@ Name | Type | Description | Notes
1188
1199
  ------------- | ------------- | ------------- | -------------
1189
1200
  **limit** | **Integer**| Number of documents per page | [optional] [default to 10]
1190
1201
  **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
1202
+ **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]
1191
1203
 
1192
1204
  ### Return type
1193
1205
 
@@ -1289,7 +1301,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
1289
1301
 
1290
1302
  list_id = 789 # Integer | Id of the list
1291
1303
 
1292
- contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails adresses of the contact
1304
+ contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails addresses OR IDs of the contacts
1293
1305
 
1294
1306
 
1295
1307
  begin
@@ -1306,7 +1318,7 @@ end
1306
1318
  Name | Type | Description | Notes
1307
1319
  ------------- | ------------- | ------------- | -------------
1308
1320
  **list_id** | **Integer**| Id of the list |
1309
- **contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact |
1321
+ **contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts |
1310
1322
 
1311
1323
  ### Return type
1312
1324
 
@@ -1445,7 +1457,7 @@ nil (empty response body)
1445
1457
 
1446
1458
 
1447
1459
  # **update_contact**
1448
- > update_contact(email, update_contact)
1460
+ > update_contact(identifier, update_contact)
1449
1461
 
1450
1462
  Update a contact
1451
1463
 
@@ -1468,14 +1480,14 @@ end
1468
1480
 
1469
1481
  api_instance = SibApiV3Sdk::ContactsApi.new
1470
1482
 
1471
- email = 'email_example' # String | Email (urlencoded) of the contact
1483
+ identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
1472
1484
 
1473
1485
  update_contact = SibApiV3Sdk::UpdateContact.new # UpdateContact | Values to update a contact
1474
1486
 
1475
1487
 
1476
1488
  begin
1477
1489
  #Update a contact
1478
- api_instance.update_contact(email, update_contact)
1490
+ api_instance.update_contact(identifier, update_contact)
1479
1491
  rescue SibApiV3Sdk::ApiError => e
1480
1492
  puts "Exception when calling ContactsApi->update_contact: #{e}"
1481
1493
  end
@@ -1485,7 +1497,7 @@ end
1485
1497
 
1486
1498
  Name | Type | Description | Notes
1487
1499
  ------------- | ------------- | ------------- | -------------
1488
- **email** | **String**| Email (urlencoded) of the contact |
1500
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact |
1489
1501
  **update_contact** | [**UpdateContact**](UpdateContact.md)| Values to update a contact |
1490
1502
 
1491
1503
  ### Return type