sib-api-v3-sdk 5.2.5 → 5.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (420) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/LICENSE.md +1 -1
  4. data/README.md +17 -1
  5. data/docs/AbTestCampaignResult.md +13 -0
  6. data/docs/AttributesApi.md +6 -6
  7. data/docs/ContactsApi.md +12 -12
  8. data/docs/CreateContact.md +1 -1
  9. data/docs/CreateEmailCampaign.md +3 -0
  10. data/docs/CreateEmailCampaignSender.md +1 -0
  11. data/docs/CreateSmtpTemplateSender.md +1 -0
  12. data/docs/CreateWebhook.md +1 -1
  13. data/docs/EmailCampaignsApi.md +127 -7
  14. data/docs/GetChildAccountCreationStatus.md +8 -0
  15. data/docs/GetChildrenList.md +1 -0
  16. data/docs/GetDeviceBrowserStats.md +11 -0
  17. data/docs/GetExtendedCampaignOverviewSender.md +1 -0
  18. data/docs/GetExtendedCampaignStats.md +2 -0
  19. data/docs/GetSharedTemplateUrl.md +8 -0
  20. data/docs/GetSmtpTemplateOverviewSender.md +1 -0
  21. data/docs/GetStatsByBrowser.md +7 -0
  22. data/docs/GetStatsByDevice.md +11 -0
  23. data/docs/GetTransacBlockedContacts.md +9 -0
  24. data/docs/GetTransacBlockedContactsContacts.md +11 -0
  25. data/docs/GetTransacBlockedContactsReason.md +9 -0
  26. data/docs/ListsApi.md +1 -1
  27. data/docs/RequestContactExport.md +2 -1
  28. data/docs/RequestContactExportCustomContactFilter.md +13 -0
  29. data/docs/ResellerApi.md +87 -20
  30. data/docs/SMSCampaignsApi.md +3 -3
  31. data/docs/SMTPApi.md +200 -19
  32. data/docs/SendReport.md +1 -1
  33. data/docs/SendReportEmail.md +1 -1
  34. data/docs/SendSmtpEmail.md +2 -2
  35. data/docs/SendSmtpEmailBcc.md +1 -1
  36. data/docs/SendSmtpEmailCc.md +1 -1
  37. data/docs/SendSmtpEmailReplyTo.md +1 -1
  38. data/docs/SendSmtpEmailSender.md +1 -1
  39. data/docs/SendSmtpEmailTo.md +1 -1
  40. data/docs/SendTransacSms.md +1 -1
  41. data/docs/SendersApi.md +2 -2
  42. data/docs/TransactionalSMSApi.md +11 -11
  43. data/docs/UpdateContact.md +1 -1
  44. data/docs/UpdateEmailCampaign.md +3 -0
  45. data/docs/UpdateEmailCampaignSender.md +1 -0
  46. data/docs/UpdateSmtpTemplateSender.md +1 -0
  47. data/docs/WebhooksApi.md +1 -1
  48. data/lib/sib-api-v3-sdk.rb +12 -2
  49. data/lib/sib-api-v3-sdk/api/account_api.rb +6 -9
  50. data/lib/sib-api-v3-sdk/api/attributes_api.rb +15 -27
  51. data/lib/sib-api-v3-sdk/api/contacts_api.rb +81 -155
  52. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +141 -61
  53. data/lib/sib-api-v3-sdk/api/folders_api.rb +21 -39
  54. data/lib/sib-api-v3-sdk/api/lists_api.rb +30 -57
  55. data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
  56. data/lib/sib-api-v3-sdk/api/reseller_api.rb +111 -92
  57. data/lib/sib-api-v3-sdk/api/senders_api.rb +21 -39
  58. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +33 -59
  59. data/lib/sib-api-v3-sdk/api/smtp_api.rb +213 -82
  60. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +15 -27
  61. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
  62. data/lib/sib-api-v3-sdk/api_client.rb +10 -10
  63. data/lib/sib-api-v3-sdk/api_error.rb +2 -2
  64. data/lib/sib-api-v3-sdk/configuration.rb +3 -3
  65. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +280 -0
  66. data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
  67. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +7 -12
  68. data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
  69. data/lib/sib-api-v3-sdk/models/create_attribute.rb +10 -14
  70. data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
  71. data/lib/sib-api-v3-sdk/models/create_child.rb +12 -17
  72. data/lib/sib-api-v3-sdk/models/create_contact.rb +8 -13
  73. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +79 -29
  74. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
  75. data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
  76. data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
  77. data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
  78. data/lib/sib-api-v3-sdk/models/create_reseller.rb +8 -13
  79. data/lib/sib-api-v3-sdk/models/create_sender.rb +9 -14
  80. data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
  81. data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
  82. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +13 -18
  83. data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
  84. data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +8 -13
  85. data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +10 -15
  86. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
  87. data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
  88. data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
  89. data/lib/sib-api-v3-sdk/models/create_webhook.rb +13 -17
  90. data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
  91. data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
  92. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +11 -15
  93. data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
  94. data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
  95. data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
  96. data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
  97. data/lib/sib-api-v3-sdk/models/get_account_relay.rb +9 -13
  98. data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +10 -14
  99. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +20 -25
  100. data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
  101. data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
  102. data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
  103. data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
  104. data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
  105. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +17 -22
  106. data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
  107. data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
  108. data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
  109. data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
  110. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
  111. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
  112. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
  113. data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
  114. data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
  115. data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
  116. data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
  117. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
  118. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
  119. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
  120. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
  121. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
  122. data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
  123. data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
  124. data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
  125. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +29 -33
  126. data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
  127. data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
  128. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
  129. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +27 -31
  130. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
  131. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
  132. data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
  133. data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
  134. data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
  135. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
  136. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
  137. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
  138. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
  139. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
  140. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
  141. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +9 -14
  142. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +10 -15
  143. data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
  144. data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
  145. data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
  146. data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
  147. data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
  148. data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
  149. data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
  150. data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
  151. data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
  152. data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
  153. data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
  154. data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
  155. data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
  156. data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
  157. data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
  158. data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
  159. data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
  160. data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
  161. data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
  162. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
  163. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
  164. data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
  165. data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
  166. data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
  167. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
  168. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +19 -24
  169. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
  170. data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +7 -12
  171. data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
  172. data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
  173. data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
  174. data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
  175. data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
  176. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
  177. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
  178. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
  179. data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +13 -18
  180. data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +9 -14
  181. data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +7 -12
  182. data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +12 -17
  183. data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
  184. data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
  185. data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
  186. data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
  187. data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
  188. data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
  189. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +7 -12
  190. data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
  191. data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
  192. data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
  193. data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +9 -13
  194. data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +9 -14
  195. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +7 -12
  196. data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
  197. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +18 -19
  198. data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
  199. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +7 -12
  200. data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
  201. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +11 -15
  202. data/lib/sib-api-v3-sdk/models/send_email.rb +8 -13
  203. data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
  204. data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
  205. data/lib/sib-api-v3-sdk/models/send_report_email.rb +14 -17
  206. data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
  207. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +10 -15
  208. data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
  209. data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
  210. data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
  211. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +9 -13
  212. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +9 -13
  213. data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
  214. data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
  215. data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
  216. data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
  217. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +17 -21
  218. data/lib/sib-api-v3-sdk/models/update_attribute.rb +7 -12
  219. data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
  220. data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
  221. data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
  222. data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +7 -12
  223. data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
  224. data/lib/sib-api-v3-sdk/models/update_contact.rb +8 -13
  225. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +77 -27
  226. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
  227. data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
  228. data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
  229. data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
  230. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +9 -15
  231. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +7 -12
  232. data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
  233. data/lib/sib-api-v3-sdk/models/update_webhook.rb +7 -11
  234. data/lib/sib-api-v3-sdk/version.rb +3 -3
  235. data/spec/api/account_api_spec.rb +3 -4
  236. data/spec/api/attributes_api_spec.rb +6 -10
  237. data/spec/api/contacts_api_spec.rb +28 -52
  238. data/spec/api/email_campaigns_api_spec.rb +37 -22
  239. data/spec/api/folders_api_spec.rb +8 -14
  240. data/spec/api/lists_api_spec.rb +11 -20
  241. data/spec/api/process_api_spec.rb +4 -6
  242. data/spec/api/reseller_api_spec.rb +31 -32
  243. data/spec/api/senders_api_spec.rb +8 -14
  244. data/spec/api/sms_campaigns_api_spec.rb +12 -20
  245. data/spec/api/smtp_api_spec.rb +53 -27
  246. data/spec/api/transactional_sms_api_spec.rb +6 -10
  247. data/spec/api/webhooks_api_spec.rb +7 -12
  248. data/spec/api_client_spec.rb +36 -36
  249. data/spec/configuration_spec.rb +10 -10
  250. data/spec/models/ab_test_campaign_result_spec.rb +79 -0
  251. data/spec/models/add_child_domain_spec.rb +3 -4
  252. data/spec/models/add_contact_to_list_spec.rb +3 -4
  253. data/spec/models/add_credits_spec.rb +4 -5
  254. data/spec/models/create_attribute_enumeration_spec.rb +4 -5
  255. data/spec/models/create_attribute_spec.rb +9 -10
  256. data/spec/models/create_child_spec.rb +7 -8
  257. data/spec/models/create_contact_spec.rb +9 -10
  258. data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
  259. data/spec/models/create_email_campaign_sender_spec.rb +10 -5
  260. data/spec/models/create_email_campaign_spec.rb +49 -32
  261. data/spec/models/create_list_spec.rb +4 -5
  262. data/spec/models/create_model_spec.rb +3 -4
  263. data/spec/models/create_reseller_spec.rb +3 -4
  264. data/spec/models/create_sender_ips_spec.rb +5 -6
  265. data/spec/models/create_sender_model_spec.rb +5 -6
  266. data/spec/models/create_sender_spec.rb +5 -6
  267. data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
  268. data/spec/models/create_sms_campaign_spec.rb +7 -8
  269. data/spec/models/create_smtp_email_spec.rb +3 -4
  270. data/spec/models/create_smtp_template_sender_spec.rb +10 -5
  271. data/spec/models/create_smtp_template_spec.rb +12 -13
  272. data/spec/models/create_update_contact_model_spec.rb +3 -4
  273. data/spec/models/create_update_folder_spec.rb +3 -4
  274. data/spec/models/create_webhook_spec.rb +14 -15
  275. data/spec/models/created_process_id_spec.rb +3 -4
  276. data/spec/models/delete_hardbounces_spec.rb +5 -6
  277. data/spec/models/email_export_recipients_spec.rb +8 -9
  278. data/spec/models/error_model_spec.rb +8 -9
  279. data/spec/models/get_account_marketing_automation_spec.rb +4 -5
  280. data/spec/models/get_account_plan_spec.rb +16 -17
  281. data/spec/models/get_account_relay_data_spec.rb +5 -6
  282. data/spec/models/get_account_relay_spec.rb +4 -5
  283. data/spec/models/get_account_spec.rb +10 -11
  284. data/spec/models/get_aggregated_report_spec.rb +15 -16
  285. data/spec/models/get_attributes_attributes_spec.rb +15 -16
  286. data/spec/models/get_attributes_enumeration_spec.rb +4 -5
  287. data/spec/models/get_attributes_spec.rb +3 -4
  288. data/spec/models/get_campaign_overview_spec.rb +23 -24
  289. data/spec/models/get_campaign_recipients_spec.rb +4 -5
  290. data/spec/models/get_campaign_stats_spec.rb +14 -15
  291. data/spec/models/get_child_account_creation_status_spec.rb +41 -0
  292. data/spec/models/get_child_domain_spec.rb +4 -5
  293. data/spec/models/get_child_domains_spec.rb +2 -3
  294. data/spec/models/get_child_info_api_keys_spec.rb +4 -5
  295. data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
  296. data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
  297. data/spec/models/get_child_info_credits_spec.rb +4 -5
  298. data/spec/models/get_child_info_spec.rb +11 -12
  299. data/spec/models/get_child_info_statistics_spec.rb +5 -6
  300. data/spec/models/get_children_list_spec.rb +9 -4
  301. data/spec/models/get_client_spec.rb +6 -7
  302. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
  303. data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
  304. data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
  305. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
  306. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
  307. data/spec/models/get_contact_details_spec.rb +11 -12
  308. data/spec/models/get_contacts_spec.rb +4 -5
  309. data/spec/models/get_device_browser_stats_spec.rb +59 -0
  310. data/spec/models/get_email_campaign_spec.rb +40 -41
  311. data/spec/models/get_email_campaigns_spec.rb +4 -5
  312. data/spec/models/get_email_event_report_events_spec.rb +16 -17
  313. data/spec/models/get_email_event_report_spec.rb +3 -4
  314. data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
  315. data/spec/models/get_extended_campaign_overview_spec.rb +38 -39
  316. data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
  317. data/spec/models/get_extended_client_address_spec.rb +6 -7
  318. data/spec/models/get_extended_client_spec.rb +7 -8
  319. data/spec/models/get_extended_contact_details_spec.rb +12 -13
  320. data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
  321. data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
  322. data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
  323. data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
  324. data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
  325. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
  326. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
  327. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
  328. data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
  329. data/spec/models/get_extended_list_spec.rb +10 -11
  330. data/spec/models/get_folder_lists_spec.rb +4 -5
  331. data/spec/models/get_folder_spec.rb +7 -8
  332. data/spec/models/get_folders_spec.rb +4 -5
  333. data/spec/models/get_ip_from_sender_spec.rb +6 -7
  334. data/spec/models/get_ip_spec.rb +6 -7
  335. data/spec/models/get_ips_from_sender_spec.rb +3 -4
  336. data/spec/models/get_ips_spec.rb +3 -4
  337. data/spec/models/get_list_spec.rb +6 -7
  338. data/spec/models/get_lists_spec.rb +4 -5
  339. data/spec/models/get_process_spec.rb +10 -11
  340. data/spec/models/get_processes_spec.rb +4 -5
  341. data/spec/models/get_reports_reports_spec.rb +15 -16
  342. data/spec/models/get_reports_spec.rb +3 -4
  343. data/spec/models/get_senders_list_ips_spec.rb +5 -6
  344. data/spec/models/get_senders_list_senders_spec.rb +7 -8
  345. data/spec/models/get_senders_list_spec.rb +3 -4
  346. data/spec/models/get_shared_template_url_spec.rb +41 -0
  347. data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
  348. data/spec/models/get_sms_campaign_spec.rb +16 -17
  349. data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
  350. data/spec/models/get_sms_campaigns_spec.rb +4 -5
  351. data/spec/models/get_sms_event_report_events_spec.rb +13 -14
  352. data/spec/models/get_sms_event_report_spec.rb +3 -4
  353. data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
  354. data/spec/models/get_smtp_template_overview_spec.rb +14 -15
  355. data/spec/models/get_smtp_templates_spec.rb +4 -5
  356. data/spec/models/get_sso_token_spec.rb +3 -4
  357. data/spec/models/get_stats_by_browser_spec.rb +35 -0
  358. data/spec/models/get_stats_by_device_spec.rb +59 -0
  359. data/spec/models/get_stats_by_domain_spec.rb +2 -3
  360. data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
  361. data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
  362. data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
  363. data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
  364. data/spec/models/get_transac_email_content_events_spec.rb +4 -5
  365. data/spec/models/get_transac_email_content_spec.rb +9 -10
  366. data/spec/models/get_transac_emails_list_spec.rb +3 -4
  367. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +8 -9
  368. data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
  369. data/spec/models/get_transac_sms_report_spec.rb +3 -4
  370. data/spec/models/get_webhook_spec.rb +13 -14
  371. data/spec/models/get_webhooks_spec.rb +3 -4
  372. data/spec/models/manage_ip_spec.rb +3 -4
  373. data/spec/models/post_contact_info_contacts_spec.rb +5 -6
  374. data/spec/models/post_contact_info_spec.rb +3 -4
  375. data/spec/models/post_send_failed_spec.rb +7 -8
  376. data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
  377. data/spec/models/remaining_credit_model_child_spec.rb +4 -5
  378. data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
  379. data/spec/models/remaining_credit_model_spec.rb +4 -5
  380. data/spec/models/remove_contact_from_list_spec.rb +4 -5
  381. data/spec/models/remove_credits_spec.rb +4 -5
  382. data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
  383. data/spec/models/request_contact_export_spec.rb +11 -6
  384. data/spec/models/request_contact_import_new_list_spec.rb +4 -5
  385. data/spec/models/request_contact_import_spec.rb +11 -12
  386. data/spec/models/request_sms_recipient_export_spec.rb +8 -9
  387. data/spec/models/send_email_attachment_spec.rb +4 -5
  388. data/spec/models/send_email_spec.rb +11 -12
  389. data/spec/models/send_report_email_spec.rb +12 -13
  390. data/spec/models/send_report_spec.rb +8 -9
  391. data/spec/models/send_sms_spec.rb +7 -8
  392. data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
  393. data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
  394. data/spec/models/send_smtp_email_cc_spec.rb +4 -5
  395. data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
  396. data/spec/models/send_smtp_email_sender_spec.rb +4 -5
  397. data/spec/models/send_smtp_email_spec.rb +15 -16
  398. data/spec/models/send_smtp_email_to_spec.rb +4 -5
  399. data/spec/models/send_template_email_spec.rb +3 -4
  400. data/spec/models/send_test_email_spec.rb +3 -4
  401. data/spec/models/send_test_sms_spec.rb +3 -4
  402. data/spec/models/send_transac_sms_spec.rb +12 -13
  403. data/spec/models/update_attribute_enumeration_spec.rb +4 -5
  404. data/spec/models/update_attribute_spec.rb +4 -5
  405. data/spec/models/update_campaign_status_spec.rb +7 -8
  406. data/spec/models/update_child_account_status_spec.rb +5 -6
  407. data/spec/models/update_child_domain_spec.rb +3 -4
  408. data/spec/models/update_child_spec.rb +7 -8
  409. data/spec/models/update_contact_spec.rb +8 -9
  410. data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
  411. data/spec/models/update_email_campaign_sender_spec.rb +10 -5
  412. data/spec/models/update_email_campaign_spec.rb +49 -32
  413. data/spec/models/update_list_spec.rb +4 -5
  414. data/spec/models/update_sender_spec.rb +5 -6
  415. data/spec/models/update_sms_campaign_spec.rb +7 -8
  416. data/spec/models/update_smtp_template_sender_spec.rb +10 -5
  417. data/spec/models/update_smtp_template_spec.rb +12 -13
  418. data/spec/models/update_webhook_spec.rb +9 -10
  419. data/spec/spec_helper.rb +2 -2
  420. metadata +42 -2
@@ -0,0 +1,8 @@
1
+ # SibApiV3Sdk::GetChildAccountCreationStatus
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **child_account_created** | **BOOLEAN** | Status of child account creation whether it is successfully created (exists) or not. |
7
+
8
+
@@ -4,5 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **children** | **Array<Object>** | Your children's account information | [optional]
7
+ **count** | **Integer** | Number of child accounts |
7
8
 
8
9
 
@@ -0,0 +1,11 @@
1
+ # SibApiV3Sdk::GetDeviceBrowserStats
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **clickers** | **Integer** | Number of total clicks for the campaign using the particular browser |
7
+ **unique_clicks** | **Integer** | Number of unique clicks for the campaign using the particular browser |
8
+ **viewed** | **Integer** | Number of openings for the campaign using the particular browser |
9
+ **unique_views** | **Integer** | Number of unique openings for the campaign using the particular browser |
10
+
11
+
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **name** | **String** | Sender name of the campaign | [optional]
7
7
  **email** | **String** | Sender email of the campaign | [optional]
8
+ **id** | **String** | Sender id of the campaign | [optional]
8
9
 
9
10
 
@@ -9,5 +9,7 @@ Name | Type | Description | Notes
9
9
  **remaining** | **Integer** | Number of remaning emails to send |
10
10
  **links_stats** | **Object** | Statistics about the number of clicks for the links |
11
11
  **stats_by_domain** | [**GetStatsByDomain**](GetStatsByDomain.md) | |
12
+ **stats_by_device** | [**GetStatsByDevice**](GetStatsByDevice.md) | Statistics about the campaign on the basis of various devices |
13
+ **stats_by_browser** | [**GetStatsByBrowser**](GetStatsByBrowser.md) | Statistics about the campaign on the basis of various browsers |
12
14
 
13
15
 
@@ -0,0 +1,8 @@
1
+ # SibApiV3Sdk::GetSharedTemplateUrl
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **shared_url** | **String** | A unique URL for the email campaign or transactional template. This URL can be shared with other Sendinblue users. |
7
+
8
+
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **name** | **String** | From email for the template | [optional]
7
7
  **email** | **String** | From email for the template | [optional]
8
+ **id** | **String** | Sender id of the template | [optional]
8
9
 
9
10
 
@@ -0,0 +1,7 @@
1
+ # SibApiV3Sdk::GetStatsByBrowser
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+
7
+
@@ -0,0 +1,11 @@
1
+ # SibApiV3Sdk::GetStatsByDevice
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **desktop** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of desktop devices | [optional]
7
+ **mobile** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of mobile devices | [optional]
8
+ **tablet** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of tablet devices | [optional]
9
+ **unknown** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of unknown devices | [optional]
10
+
11
+
@@ -0,0 +1,9 @@
1
+ # SibApiV3Sdk::GetTransacBlockedContacts
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **count** | **Integer** | Count of blocked or unsubscribed contact | [optional]
7
+ **contacts** | [**Array<GetTransacBlockedContactsContacts>**](GetTransacBlockedContactsContacts.md) | | [optional]
8
+
9
+
@@ -0,0 +1,11 @@
1
+ # SibApiV3Sdk::GetTransacBlockedContactsContacts
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email** | **String** | Email address of the blocked or unsubscribed contact |
7
+ **sender_email** | **String** | Sender email address of the blocked or unsubscribed contact |
8
+ **reason** | [**GetTransacBlockedContactsReason**](GetTransacBlockedContactsReason.md) | |
9
+ **blocked_at** | **Date** | Date when the contact was blocked or unsubscribed on |
10
+
11
+
@@ -0,0 +1,9 @@
1
+ # SibApiV3Sdk::GetTransacBlockedContactsReason
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **code** | **String** | Reason code for blocking / unsubscribing (This code is safe for comparison) | [optional]
7
+ **message** | **String** | Reason for blocking / unsubscribing (This string is not safe for comparison) | [optional]
8
+
9
+
data/docs/ListsApi.md CHANGED
@@ -215,7 +215,7 @@ api_instance = SibApiV3Sdk::ListsApi.new
215
215
  list_id = 789 # Integer | Id of the list
216
216
 
217
217
  opts = {
218
- 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.
218
+ 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.
219
219
  limit: 50, # Integer | Number of documents per page
220
220
  offset: 0 # Integer | Index of the first document of the page
221
221
  }
@@ -4,7 +4,8 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **export_attributes** | **Array<String>** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. | [optional]
7
- **contact_filter** | **Object** | Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts. |
7
+ **contact_filter** | **Object** | This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts. | [optional]
8
+ **custom_contact_filter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) | | [optional]
8
9
  **notify_url** | **String** | Webhook that will be called once the export process is finished | [optional]
9
10
 
10
11
 
@@ -0,0 +1,13 @@
1
+ # SibApiV3Sdk::RequestContactExportCustomContactFilter
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **action_for_contacts** | **String** | Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on contacts as per the list id. * allContacts - Fetch the list of all contacts for a particular list. * subscribed & unsubscribed - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * unsubscribedPerList - Fetch the list of contacts that are unsubscribed from a particular list only. | [optional]
7
+ **action_for_email_campaigns** | **String** | Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on email campaigns. * openers & nonOpeners - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * clickers & nonClickers - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * unsubscribed - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * hardBounces & softBounces - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s). | [optional]
8
+ **action_for_sms_campaigns** | **String** | Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed. This will export the contacts on the basis of provided action applied on sms campaigns. * unsubscribed - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * hardBounces & softBounces - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns. | [optional]
9
+ **list_id** | **Integer** | Mandatory if actionForContacts is passed, ignored otherwise. Id of the list for which the corresponding action shall be applied in the filter. | [optional]
10
+ **email_campaign_id** | **Integer** | Considered only if actionForEmailCampaigns is passed, ignored otherwise. Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed. The id of the email campaign for which the corresponding action shall be applied in the filter. | [optional]
11
+ **sms_campaign_id** | **Integer** | Considered only if actionForSmsCampaigns is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter. | [optional]
12
+
13
+
data/docs/ResellerApi.md CHANGED
@@ -11,6 +11,7 @@ Method | HTTP request | Description
11
11
  [**delete_child_domain**](ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
12
12
  [**delete_reseller_child**](ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied
13
13
  [**dissociate_ip_from_child**](ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child
14
+ [**get_child_account_creation_status**](ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childAuthKey}/accountCreationStatus | Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
14
15
  [**get_child_domains**](ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account
15
16
  [**get_child_info**](ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
16
17
  [**get_reseller_childs**](ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts
@@ -45,7 +46,7 @@ end
45
46
 
46
47
  api_instance = SibApiV3Sdk::ResellerApi.new
47
48
 
48
- child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
49
+ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
49
50
 
50
51
  add_credits = SibApiV3Sdk::AddCredits.new # AddCredits | Values to post to add credit to a specific child account
51
52
 
@@ -105,7 +106,7 @@ end
105
106
 
106
107
  api_instance = SibApiV3Sdk::ResellerApi.new
107
108
 
108
- child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
109
+ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
109
110
 
110
111
  ip = SibApiV3Sdk::ManageIp.new # ManageIp | IP to associate
111
112
 
@@ -164,9 +165,9 @@ end
164
165
 
165
166
  api_instance = SibApiV3Sdk::ResellerApi.new
166
167
 
167
- child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
168
+ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
168
169
 
169
- add_child_domain = SibApiV3Sdk::AddChildDomain.new # AddChildDomain | Sender domain to add for a specific child account
170
+ add_child_domain = SibApiV3Sdk::AddChildDomain.new # AddChildDomain | Sender domain to add for a specific child account. This will not be displayed to the parent account.
170
171
 
171
172
 
172
173
  begin
@@ -182,7 +183,7 @@ end
182
183
  Name | Type | Description | Notes
183
184
  ------------- | ------------- | ------------- | -------------
184
185
  **child_auth_key** | **String**| auth key of reseller's child |
185
- **add_child_domain** | [**AddChildDomain**](AddChildDomain.md)| Sender domain to add for a specific child account |
186
+ **add_child_domain** | [**AddChildDomain**](AddChildDomain.md)| Sender domain to add for a specific child account. This will not be displayed to the parent account. |
186
187
 
187
188
  ### Return type
188
189
 
@@ -281,9 +282,9 @@ end
281
282
 
282
283
  api_instance = SibApiV3Sdk::ResellerApi.new
283
284
 
284
- child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
285
+ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
285
286
 
286
- domain_name = "domain_name_example" # String | Pass the existing domain that needs to be deleted
287
+ domain_name = 'domain_name_example' # String | Pass the existing domain that needs to be deleted
287
288
 
288
289
 
289
290
  begin
@@ -340,7 +341,7 @@ end
340
341
 
341
342
  api_instance = SibApiV3Sdk::ResellerApi.new
342
343
 
343
- child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
344
+ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
344
345
 
345
346
 
346
347
  begin
@@ -396,7 +397,7 @@ end
396
397
 
397
398
  api_instance = SibApiV3Sdk::ResellerApi.new
398
399
 
399
- child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
400
+ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
400
401
 
401
402
  ip = SibApiV3Sdk::ManageIp.new # ManageIp | IP to dissociate
402
403
 
@@ -431,6 +432,63 @@ nil (empty response body)
431
432
 
432
433
 
433
434
 
435
+ # **get_child_account_creation_status**
436
+ > GetChildAccountCreationStatus get_child_account_creation_status(child_auth_key)
437
+
438
+ Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
439
+
440
+ ### Example
441
+ ```ruby
442
+ # load the gem
443
+ require 'sib-api-v3-sdk'
444
+ # setup authorization
445
+ SibApiV3Sdk.configure do |config|
446
+ # Configure API key authorization: api-key
447
+ config.api_key['api-key'] = 'YOUR API KEY'
448
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
449
+ #config.api_key_prefix['api-key'] = 'Bearer'
450
+
451
+ # Configure API key authorization: partner-key
452
+ config.api_key['partner-key'] = 'YOUR API KEY'
453
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
454
+ #config.api_key_prefix['partner-key'] = 'Bearer'
455
+ end
456
+
457
+ api_instance = SibApiV3Sdk::ResellerApi.new
458
+
459
+ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
460
+
461
+
462
+ begin
463
+ #Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
464
+ result = api_instance.get_child_account_creation_status(child_auth_key)
465
+ p result
466
+ rescue SibApiV3Sdk::ApiError => e
467
+ puts "Exception when calling ResellerApi->get_child_account_creation_status: #{e}"
468
+ end
469
+ ```
470
+
471
+ ### Parameters
472
+
473
+ Name | Type | Description | Notes
474
+ ------------- | ------------- | ------------- | -------------
475
+ **child_auth_key** | **String**| auth key of reseller's child |
476
+
477
+ ### Return type
478
+
479
+ [**GetChildAccountCreationStatus**](GetChildAccountCreationStatus.md)
480
+
481
+ ### Authorization
482
+
483
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
484
+
485
+ ### HTTP request headers
486
+
487
+ - **Content-Type**: application/json
488
+ - **Accept**: application/json
489
+
490
+
491
+
434
492
  # **get_child_domains**
435
493
  > GetChildDomains get_child_domains(child_auth_key)
436
494
 
@@ -455,7 +513,7 @@ end
455
513
 
456
514
  api_instance = SibApiV3Sdk::ResellerApi.new
457
515
 
458
- child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
516
+ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
459
517
 
460
518
 
461
519
  begin
@@ -512,7 +570,7 @@ end
512
570
 
513
571
  api_instance = SibApiV3Sdk::ResellerApi.new
514
572
 
515
- child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
573
+ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
516
574
 
517
575
 
518
576
  begin
@@ -546,7 +604,7 @@ Name | Type | Description | Notes
546
604
 
547
605
 
548
606
  # **get_reseller_childs**
549
- > GetChildrenList get_reseller_childs
607
+ > GetChildrenList get_reseller_childs(opts)
550
608
 
551
609
  Gets the list of all reseller's children accounts
552
610
 
@@ -569,9 +627,14 @@ end
569
627
 
570
628
  api_instance = SibApiV3Sdk::ResellerApi.new
571
629
 
630
+ opts = {
631
+ limit: 10, # Integer | Number of documents for child accounts information per page
632
+ offset: 0 # Integer | Index of the first document in the page
633
+ }
634
+
572
635
  begin
573
636
  #Gets the list of all reseller's children accounts
574
- result = api_instance.get_reseller_childs
637
+ result = api_instance.get_reseller_childs(opts)
575
638
  p result
576
639
  rescue SibApiV3Sdk::ApiError => e
577
640
  puts "Exception when calling ResellerApi->get_reseller_childs: #{e}"
@@ -579,7 +642,11 @@ end
579
642
  ```
580
643
 
581
644
  ### Parameters
582
- This endpoint does not need any parameter.
645
+
646
+ Name | Type | Description | Notes
647
+ ------------- | ------------- | ------------- | -------------
648
+ **limit** | **Integer**| Number of documents for child accounts information per page | [optional] [default to 10]
649
+ **offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
583
650
 
584
651
  ### Return type
585
652
 
@@ -622,7 +689,7 @@ end
622
689
 
623
690
  api_instance = SibApiV3Sdk::ResellerApi.new
624
691
 
625
- child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
692
+ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
626
693
 
627
694
 
628
695
  begin
@@ -679,7 +746,7 @@ end
679
746
 
680
747
  api_instance = SibApiV3Sdk::ResellerApi.new
681
748
 
682
- child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
749
+ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
683
750
 
684
751
  remove_credits = SibApiV3Sdk::RemoveCredits.new # RemoveCredits | Values to post to remove email or SMS credits from a specific child account
685
752
 
@@ -739,7 +806,7 @@ end
739
806
 
740
807
  api_instance = SibApiV3Sdk::ResellerApi.new
741
808
 
742
- child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
809
+ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
743
810
 
744
811
  update_child_account_status = SibApiV3Sdk::UpdateChildAccountStatus.new # UpdateChildAccountStatus | values to update in child account status
745
812
 
@@ -798,9 +865,9 @@ end
798
865
 
799
866
  api_instance = SibApiV3Sdk::ResellerApi.new
800
867
 
801
- child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
868
+ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
802
869
 
803
- domain_name = "domain_name_example" # String | Pass the existing domain that needs to be updated
870
+ domain_name = 'domain_name_example' # String | Pass the existing domain that needs to be updated
804
871
 
805
872
  update_child_domain = SibApiV3Sdk::UpdateChildDomain.new # UpdateChildDomain | value to update for sender domain
806
873
 
@@ -860,7 +927,7 @@ end
860
927
 
861
928
  api_instance = SibApiV3Sdk::ResellerApi.new
862
929
 
863
- child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
930
+ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
864
931
 
865
932
  reseller_child = SibApiV3Sdk::UpdateChild.new # UpdateChild | values to update in child profile
866
933
 
@@ -211,9 +211,9 @@ end
211
211
  api_instance = SibApiV3Sdk::SMSCampaignsApi.new
212
212
 
213
213
  opts = {
214
- status: "status_example", # String | Status of campaign.
215
- start_date: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
216
- end_date: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
214
+ status: 'status_example', # String | Status of campaign.
215
+ start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
216
+ end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
217
217
  limit: 500, # Integer | Number limitation for the result returned
218
218
  offset: 0 # Integer | Beginning point in the list to retrieve from.
219
219
  }
data/docs/SMTPApi.md CHANGED
@@ -12,11 +12,14 @@ Method | HTTP request | Description
12
12
  [**get_smtp_report**](SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
13
13
  [**get_smtp_template**](SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template informations
14
14
  [**get_smtp_templates**](SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of transactional email templates
15
+ [**get_transac_blocked_contacts**](SMTPApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
15
16
  [**get_transac_email_content**](SMTPApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
16
17
  [**get_transac_emails_list**](SMTPApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
17
18
  [**send_template**](SMTPApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
18
19
  [**send_test_template**](SMTPApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
19
20
  [**send_transac_email**](SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
21
+ [**smtp_blocked_contacts_email_delete**](SMTPApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
22
+ [**smtp_log_message_id_delete**](SMTPApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
20
23
  [**update_smtp_template**](SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Updates a transactional email templates
21
24
 
22
25
 
@@ -217,10 +220,10 @@ end
217
220
  api_instance = SibApiV3Sdk::SMTPApi.new
218
221
 
219
222
  opts = {
220
- start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
221
- end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
223
+ start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
224
+ end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
222
225
  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
223
- tag: "tag_example" # String | Tag of the emails
226
+ tag: 'tag_example' # String | Tag of the emails
224
227
  }
225
228
 
226
229
  begin
@@ -283,13 +286,13 @@ api_instance = SibApiV3Sdk::SMTPApi.new
283
286
  opts = {
284
287
  limit: 50, # Integer | Number limitation for the result returned
285
288
  offset: 0, # Integer | Beginning point in the list to retrieve from.
286
- start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
287
- end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
289
+ start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
290
+ end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
288
291
  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
289
- email: "email_example", # String | Filter the report for a specific email addresses
290
- event: "event_example", # String | Filter the report for a specific event type
291
- tags: "tags_example", # String | Filter the report for tags (serialized and urlencoded array)
292
- message_id: "message_id_example", # String | Filter on a specific message id
292
+ email: 'email_example', # String | Filter the report for a specific email addresses
293
+ event: 'event_example', # String | Filter the report for a specific event type
294
+ tags: 'tags_example', # String | Filter the report for tags (serialized and urlencoded array)
295
+ message_id: 'message_id_example', # String | Filter on a specific message id
293
296
  template_id: 789 # Integer | Filter on a specific template id
294
297
  }
295
298
 
@@ -357,12 +360,12 @@ end
357
360
  api_instance = SibApiV3Sdk::SMTPApi.new
358
361
 
359
362
  opts = {
360
- limit: 50, # Integer | Number of documents returned per page
363
+ limit: 10, # Integer | Number of documents returned per page
361
364
  offset: 0, # Integer | Index of the first document on the page
362
- start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
363
- end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
365
+ start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
366
+ end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
364
367
  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
365
- tag: "tag_example" # String | Tag of the emails
368
+ tag: 'tag_example' # String | Tag of the emails
366
369
  }
367
370
 
368
371
  begin
@@ -378,7 +381,7 @@ end
378
381
 
379
382
  Name | Type | Description | Notes
380
383
  ------------- | ------------- | ------------- | -------------
381
- **limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
384
+ **limit** | **Integer**| Number of documents returned per page | [optional] [default to 10]
382
385
  **offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
383
386
  **start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional]
384
387
  **end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
@@ -519,6 +522,72 @@ Name | Type | Description | Notes
519
522
 
520
523
 
521
524
 
525
+ # **get_transac_blocked_contacts**
526
+ > GetTransacBlockedContacts get_transac_blocked_contacts(opts)
527
+
528
+ Get the list of blocked or unsubscribed transactional contacts
529
+
530
+ ### Example
531
+ ```ruby
532
+ # load the gem
533
+ require 'sib-api-v3-sdk'
534
+ # setup authorization
535
+ SibApiV3Sdk.configure do |config|
536
+ # Configure API key authorization: api-key
537
+ config.api_key['api-key'] = 'YOUR API KEY'
538
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
539
+ #config.api_key_prefix['api-key'] = 'Bearer'
540
+
541
+ # Configure API key authorization: partner-key
542
+ config.api_key['partner-key'] = 'YOUR API KEY'
543
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
544
+ #config.api_key_prefix['partner-key'] = 'Bearer'
545
+ end
546
+
547
+ api_instance = SibApiV3Sdk::SMTPApi.new
548
+
549
+ opts = {
550
+ start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
551
+ end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
552
+ limit: 50, # Integer | Number of documents returned per page
553
+ offset: 0, # Integer | Index of the first document on the page
554
+ senders: ['senders_example'] # Array<String> | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
555
+ }
556
+
557
+ begin
558
+ #Get the list of blocked or unsubscribed transactional contacts
559
+ result = api_instance.get_transac_blocked_contacts(opts)
560
+ p result
561
+ rescue SibApiV3Sdk::ApiError => e
562
+ puts "Exception when calling SMTPApi->get_transac_blocked_contacts: #{e}"
563
+ end
564
+ ```
565
+
566
+ ### Parameters
567
+
568
+ Name | Type | Description | Notes
569
+ ------------- | ------------- | ------------- | -------------
570
+ **start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts | [optional]
571
+ **end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts | [optional]
572
+ **limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
573
+ **offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
574
+ **senders** | [**Array&lt;String&gt;**](String.md)| Comma separated list of emails of the senders from which contacts are blocked or unsubscribed | [optional]
575
+
576
+ ### Return type
577
+
578
+ [**GetTransacBlockedContacts**](GetTransacBlockedContacts.md)
579
+
580
+ ### Authorization
581
+
582
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
583
+
584
+ ### HTTP request headers
585
+
586
+ - **Content-Type**: application/json
587
+ - **Accept**: application/json
588
+
589
+
590
+
522
591
  # **get_transac_email_content**
523
592
  > GetTransacEmailContent get_transac_email_content(uuid)
524
593
 
@@ -543,7 +612,7 @@ end
543
612
 
544
613
  api_instance = SibApiV3Sdk::SMTPApi.new
545
614
 
546
- uuid = "uuid_example" # String | Unique id of the transactional email that has been sent to a particular contact
615
+ uuid = 'uuid_example' # String | Unique id of the transactional email that has been sent to a particular contact
547
616
 
548
617
 
549
618
  begin
@@ -603,11 +672,11 @@ end
603
672
  api_instance = SibApiV3Sdk::SMTPApi.new
604
673
 
605
674
  opts = {
606
- email: "email_example", # String | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
675
+ email: 'email_example', # String | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
607
676
  template_id: 789, # Integer | Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
608
- message_id: "message_id_example", # String | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
609
- start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
610
- end_date: Date.parse("2013-10-20") # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
677
+ message_id: 'message_id_example', # String | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
678
+ start_date: '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.
679
+ end_date: Date.parse('2013-10-20') # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
611
680
  }
612
681
 
613
682
  begin
@@ -822,6 +891,118 @@ Name | Type | Description | Notes
822
891
 
823
892
 
824
893
 
894
+ # **smtp_blocked_contacts_email_delete**
895
+ > smtp_blocked_contacts_email_delete(email)
896
+
897
+ Unblock or resubscribe a transactional contact
898
+
899
+ ### Example
900
+ ```ruby
901
+ # load the gem
902
+ require 'sib-api-v3-sdk'
903
+ # setup authorization
904
+ SibApiV3Sdk.configure do |config|
905
+ # Configure API key authorization: api-key
906
+ config.api_key['api-key'] = 'YOUR API KEY'
907
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
908
+ #config.api_key_prefix['api-key'] = 'Bearer'
909
+
910
+ # Configure API key authorization: partner-key
911
+ config.api_key['partner-key'] = 'YOUR API KEY'
912
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
913
+ #config.api_key_prefix['partner-key'] = 'Bearer'
914
+ end
915
+
916
+ api_instance = SibApiV3Sdk::SMTPApi.new
917
+
918
+ email = 'email_example' # String | contact email (urlencoded) to unblock.
919
+
920
+
921
+ begin
922
+ #Unblock or resubscribe a transactional contact
923
+ api_instance.smtp_blocked_contacts_email_delete(email)
924
+ rescue SibApiV3Sdk::ApiError => e
925
+ puts "Exception when calling SMTPApi->smtp_blocked_contacts_email_delete: #{e}"
926
+ end
927
+ ```
928
+
929
+ ### Parameters
930
+
931
+ Name | Type | Description | Notes
932
+ ------------- | ------------- | ------------- | -------------
933
+ **email** | **String**| contact email (urlencoded) to unblock. |
934
+
935
+ ### Return type
936
+
937
+ nil (empty response body)
938
+
939
+ ### Authorization
940
+
941
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
942
+
943
+ ### HTTP request headers
944
+
945
+ - **Content-Type**: application/json
946
+ - **Accept**: application/json
947
+
948
+
949
+
950
+ # **smtp_log_message_id_delete**
951
+ > smtp_log_message_id_delete(message_id)
952
+
953
+ Delete an SMTP transactional log
954
+
955
+ ### Example
956
+ ```ruby
957
+ # load the gem
958
+ require 'sib-api-v3-sdk'
959
+ # setup authorization
960
+ SibApiV3Sdk.configure do |config|
961
+ # Configure API key authorization: api-key
962
+ config.api_key['api-key'] = 'YOUR API KEY'
963
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
964
+ #config.api_key_prefix['api-key'] = 'Bearer'
965
+
966
+ # Configure API key authorization: partner-key
967
+ config.api_key['partner-key'] = 'YOUR API KEY'
968
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
969
+ #config.api_key_prefix['partner-key'] = 'Bearer'
970
+ end
971
+
972
+ api_instance = SibApiV3Sdk::SMTPApi.new
973
+
974
+ message_id = 'message_id_example' # String | MessageId of the transactional log to delete
975
+
976
+
977
+ begin
978
+ #Delete an SMTP transactional log
979
+ api_instance.smtp_log_message_id_delete(message_id)
980
+ rescue SibApiV3Sdk::ApiError => e
981
+ puts "Exception when calling SMTPApi->smtp_log_message_id_delete: #{e}"
982
+ end
983
+ ```
984
+
985
+ ### Parameters
986
+
987
+ Name | Type | Description | Notes
988
+ ------------- | ------------- | ------------- | -------------
989
+ **message_id** | **String**| MessageId of the transactional log to delete |
990
+
991
+ ### Return type
992
+
993
+ nil (empty response body)
994
+
995
+ ### Authorization
996
+
997
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
998
+
999
+ ### HTTP request headers
1000
+
1001
+ - **Content-Type**: application/json
1002
+ - **Accept**: application/json
1003
+
1004
+
1005
+
825
1006
  # **update_smtp_template**
826
1007
  > update_smtp_template(template_id, smtp_template)
827
1008