sib-api-v3-sdk 5.2.5 → 7.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (470) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/LICENSE.md +1 -1
  4. data/README.md +100 -75
  5. data/docs/AbTestCampaignResult.md +15 -0
  6. data/docs/AbTestCampaignResultClickedLinks.md +9 -0
  7. data/docs/AbTestCampaignResultStatistics.md +13 -0
  8. data/docs/AbTestVersionClicks.md +7 -0
  9. data/docs/AbTestVersionClicksInner.md +10 -0
  10. data/docs/AbTestVersionStats.md +9 -0
  11. data/docs/AccountApi.md +3 -3
  12. data/docs/AddContactToList.md +2 -1
  13. data/docs/AttributesApi.md +18 -18
  14. data/docs/ContactsApi.md +136 -73
  15. data/docs/CreateAttribute.md +1 -1
  16. data/docs/CreateChild.md +1 -0
  17. data/docs/CreateContact.md +2 -2
  18. data/docs/CreateDoiContact.md +13 -0
  19. data/docs/CreateEmailCampaign.md +4 -1
  20. data/docs/CreateEmailCampaignSender.md +1 -0
  21. data/docs/CreateReseller.md +1 -0
  22. data/docs/CreateSender.md +1 -1
  23. data/docs/CreateSmsCampaign.md +1 -1
  24. data/docs/CreateSmtpTemplateSender.md +1 -0
  25. data/docs/CreateWebhook.md +2 -2
  26. data/docs/EmailCampaignsApi.md +202 -25
  27. data/docs/EmailExportRecipients.md +1 -1
  28. data/docs/FoldersApi.md +12 -12
  29. data/docs/GetAggregatedReport.md +13 -13
  30. data/docs/GetCampaignStats.md +1 -0
  31. data/docs/GetChildAccountCreationStatus.md +8 -0
  32. data/docs/GetChildrenList.md +1 -0
  33. data/docs/GetDeviceBrowserStats.md +11 -0
  34. data/docs/GetEmailCampaign.md +1 -0
  35. data/docs/GetExtendedCampaignOverview.md +1 -0
  36. data/docs/GetExtendedCampaignOverviewSender.md +1 -0
  37. data/docs/GetExtendedCampaignStats.md +2 -0
  38. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +1 -1
  39. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +1 -1
  40. data/docs/GetSharedTemplateUrl.md +8 -0
  41. data/docs/GetSmtpTemplateOverview.md +1 -0
  42. data/docs/GetSmtpTemplateOverviewSender.md +1 -0
  43. data/docs/GetStatsByBrowser.md +7 -0
  44. data/docs/GetStatsByDevice.md +11 -0
  45. data/docs/GetTransacBlockedContacts.md +9 -0
  46. data/docs/GetTransacBlockedContactsContacts.md +11 -0
  47. data/docs/GetTransacBlockedContactsReason.md +9 -0
  48. data/docs/GetTransacEmailsListTransactionalEmails.md +2 -0
  49. data/docs/ListsApi.md +17 -17
  50. data/docs/PostContactInfoContacts.md +1 -0
  51. data/docs/RemainingCreditModelChild.md +2 -2
  52. data/docs/RemainingCreditModelReseller.md +2 -2
  53. data/docs/RemoveContactFromList.md +3 -2
  54. data/docs/RequestContactExport.md +3 -2
  55. data/docs/RequestContactExportCustomContactFilter.md +13 -0
  56. data/docs/RequestContactImport.md +2 -2
  57. data/docs/RequestSMSRecipientExport.md +1 -1
  58. data/docs/ResellerApi.md +158 -91
  59. data/docs/SMSCampaignsApi.md +24 -24
  60. data/docs/SendEmail.md +3 -3
  61. data/docs/SendReport.md +1 -1
  62. data/docs/SendReportEmail.md +1 -5
  63. data/docs/SendSmtpEmail.md +4 -4
  64. data/docs/SendSmtpEmailBcc.md +1 -1
  65. data/docs/SendSmtpEmailCc.md +1 -1
  66. data/docs/SendSmtpEmailReplyTo.md +1 -1
  67. data/docs/SendSmtpEmailSender.md +2 -1
  68. data/docs/SendSmtpEmailTo.md +1 -1
  69. data/docs/SendTransacSms.md +2 -2
  70. data/docs/SendersApi.md +8 -8
  71. data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +254 -73
  72. data/docs/TransactionalSMSApi.md +17 -17
  73. data/docs/UpdateAttribute.md +1 -1
  74. data/docs/UpdateChildAccountStatus.md +1 -0
  75. data/docs/UpdateContact.md +1 -1
  76. data/docs/UpdateEmailCampaign.md +4 -1
  77. data/docs/UpdateEmailCampaignSender.md +1 -0
  78. data/docs/UpdateSmsCampaign.md +1 -1
  79. data/docs/UpdateSmtpTemplateSender.md +1 -0
  80. data/docs/UpdateWebhook.md +1 -1
  81. data/docs/UploadImageToGallery.md +9 -0
  82. data/docs/WebhooksApi.md +1 -1
  83. data/lib/sib-api-v3-sdk.rb +20 -3
  84. data/lib/sib-api-v3-sdk/api/account_api.rb +8 -11
  85. data/lib/sib-api-v3-sdk/api/attributes_api.rb +23 -35
  86. data/lib/sib-api-v3-sdk/api/contacts_api.rb +203 -220
  87. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +204 -73
  88. data/lib/sib-api-v3-sdk/api/folders_api.rb +29 -47
  89. data/lib/sib-api-v3-sdk/api/lists_api.rb +42 -69
  90. data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
  91. data/lib/sib-api-v3-sdk/api/reseller_api.rb +233 -214
  92. data/lib/sib-api-v3-sdk/api/senders_api.rb +25 -43
  93. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +47 -73
  94. data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +253 -122
  95. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +19 -31
  96. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
  97. data/lib/sib-api-v3-sdk/api_client.rb +10 -10
  98. data/lib/sib-api-v3-sdk/api_error.rb +2 -2
  99. data/lib/sib-api-v3-sdk/configuration.rb +3 -3
  100. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +298 -0
  101. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +202 -0
  102. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +258 -0
  103. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +175 -0
  104. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +219 -0
  105. data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +205 -0
  106. data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
  107. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +22 -15
  108. data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
  109. data/lib/sib-api-v3-sdk/models/create_attribute.rb +11 -15
  110. data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
  111. data/lib/sib-api-v3-sdk/models/create_child.rb +58 -19
  112. data/lib/sib-api-v3-sdk/models/create_contact.rb +9 -14
  113. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +258 -0
  114. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +80 -30
  115. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
  116. data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
  117. data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
  118. data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
  119. data/lib/sib-api-v3-sdk/models/create_reseller.rb +20 -15
  120. data/lib/sib-api-v3-sdk/models/create_sender.rb +10 -15
  121. data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
  122. data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
  123. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +17 -22
  124. data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
  125. data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +8 -13
  126. data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +10 -15
  127. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
  128. data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
  129. data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
  130. data/lib/sib-api-v3-sdk/models/create_webhook.rb +14 -18
  131. data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
  132. data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
  133. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +12 -16
  134. data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
  135. data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
  136. data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
  137. data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
  138. data/lib/sib-api-v3-sdk/models/get_account_relay.rb +9 -13
  139. data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +10 -14
  140. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +7 -77
  141. data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
  142. data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
  143. data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
  144. data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
  145. data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
  146. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +29 -24
  147. data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
  148. data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
  149. data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
  150. data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
  151. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
  152. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
  153. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
  154. data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
  155. data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
  156. data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
  157. data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
  158. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
  159. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
  160. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
  161. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
  162. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
  163. data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
  164. data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
  165. data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
  166. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +40 -34
  167. data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
  168. data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
  169. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
  170. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +40 -34
  171. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
  172. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
  173. data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
  174. data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
  175. data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
  176. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
  177. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
  178. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
  179. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
  180. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
  181. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
  182. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +8 -18
  183. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +9 -19
  184. data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
  185. data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
  186. data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
  187. data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
  188. data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
  189. data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
  190. data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
  191. data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
  192. data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
  193. data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
  194. data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
  195. data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
  196. data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
  197. data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
  198. data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
  199. data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
  200. data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
  201. data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
  202. data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
  203. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
  204. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
  205. data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
  206. data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
  207. data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
  208. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
  209. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +31 -26
  210. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
  211. data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +7 -12
  212. data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
  213. data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
  214. data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
  215. data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
  216. data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
  217. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
  218. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
  219. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
  220. data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +13 -18
  221. data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +9 -14
  222. data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +7 -12
  223. data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +36 -19
  224. data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
  225. data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
  226. data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
  227. data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
  228. data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
  229. data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
  230. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +19 -14
  231. data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
  232. data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
  233. data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
  234. data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +11 -15
  235. data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +11 -16
  236. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +22 -15
  237. data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
  238. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +19 -20
  239. data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
  240. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +9 -14
  241. data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
  242. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +12 -16
  243. data/lib/sib-api-v3-sdk/models/send_email.rb +11 -16
  244. data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
  245. data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
  246. data/lib/sib-api-v3-sdk/models/send_report_email.rb +12 -100
  247. data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
  248. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +12 -17
  249. data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
  250. data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
  251. data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
  252. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +10 -14
  253. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +22 -16
  254. data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
  255. data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
  256. data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
  257. data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
  258. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +21 -25
  259. data/lib/sib-api-v3-sdk/models/update_attribute.rb +8 -13
  260. data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
  261. data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
  262. data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
  263. data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +19 -14
  264. data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
  265. data/lib/sib-api-v3-sdk/models/update_contact.rb +8 -13
  266. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +78 -28
  267. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
  268. data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
  269. data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
  270. data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
  271. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +13 -19
  272. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +7 -12
  273. data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
  274. data/lib/sib-api-v3-sdk/models/update_webhook.rb +8 -12
  275. data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
  276. data/lib/sib-api-v3-sdk/version.rb +3 -3
  277. data/sib-api-v3-sdk.gemspec +5 -5
  278. data/spec/api/account_api_spec.rb +4 -5
  279. data/spec/api/attributes_api_spec.rb +10 -14
  280. data/spec/api/contacts_api_spec.rb +62 -73
  281. data/spec/api/email_campaigns_api_spec.rb +54 -28
  282. data/spec/api/folders_api_spec.rb +12 -18
  283. data/spec/api/lists_api_spec.rb +17 -26
  284. data/spec/api/process_api_spec.rb +4 -6
  285. data/spec/api/reseller_api_spec.rb +53 -54
  286. data/spec/api/senders_api_spec.rb +10 -16
  287. data/spec/api/sms_campaigns_api_spec.rb +19 -27
  288. data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +65 -39
  289. data/spec/api/transactional_sms_api_spec.rb +8 -12
  290. data/spec/api/webhooks_api_spec.rb +7 -12
  291. data/spec/api_client_spec.rb +36 -36
  292. data/spec/configuration_spec.rb +10 -10
  293. data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
  294. data/spec/models/ab_test_campaign_result_spec.rb +91 -0
  295. data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
  296. data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
  297. data/spec/models/ab_test_version_clicks_spec.rb +35 -0
  298. data/spec/models/ab_test_version_stats_spec.rb +47 -0
  299. data/spec/models/add_child_domain_spec.rb +3 -4
  300. data/spec/models/add_contact_to_list_spec.rb +9 -4
  301. data/spec/models/add_credits_spec.rb +4 -5
  302. data/spec/models/create_attribute_enumeration_spec.rb +4 -5
  303. data/spec/models/create_attribute_spec.rb +9 -10
  304. data/spec/models/create_child_spec.rb +17 -8
  305. data/spec/models/create_contact_spec.rb +9 -10
  306. data/spec/models/create_doi_contact_spec.rb +71 -0
  307. data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
  308. data/spec/models/create_email_campaign_sender_spec.rb +10 -5
  309. data/spec/models/create_email_campaign_spec.rb +49 -32
  310. data/spec/models/create_list_spec.rb +4 -5
  311. data/spec/models/create_model_spec.rb +3 -4
  312. data/spec/models/create_reseller_spec.rb +9 -4
  313. data/spec/models/create_sender_ips_spec.rb +5 -6
  314. data/spec/models/create_sender_model_spec.rb +5 -6
  315. data/spec/models/create_sender_spec.rb +5 -6
  316. data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
  317. data/spec/models/create_sms_campaign_spec.rb +7 -8
  318. data/spec/models/create_smtp_email_spec.rb +3 -4
  319. data/spec/models/create_smtp_template_sender_spec.rb +10 -5
  320. data/spec/models/create_smtp_template_spec.rb +12 -13
  321. data/spec/models/create_update_contact_model_spec.rb +3 -4
  322. data/spec/models/create_update_folder_spec.rb +3 -4
  323. data/spec/models/create_webhook_spec.rb +14 -15
  324. data/spec/models/created_process_id_spec.rb +3 -4
  325. data/spec/models/delete_hardbounces_spec.rb +5 -6
  326. data/spec/models/email_export_recipients_spec.rb +8 -9
  327. data/spec/models/error_model_spec.rb +8 -9
  328. data/spec/models/get_account_marketing_automation_spec.rb +4 -5
  329. data/spec/models/get_account_plan_spec.rb +16 -17
  330. data/spec/models/get_account_relay_data_spec.rb +5 -6
  331. data/spec/models/get_account_relay_spec.rb +4 -5
  332. data/spec/models/get_account_spec.rb +10 -11
  333. data/spec/models/get_aggregated_report_spec.rb +15 -16
  334. data/spec/models/get_attributes_attributes_spec.rb +15 -16
  335. data/spec/models/get_attributes_enumeration_spec.rb +4 -5
  336. data/spec/models/get_attributes_spec.rb +3 -4
  337. data/spec/models/get_campaign_overview_spec.rb +23 -24
  338. data/spec/models/get_campaign_recipients_spec.rb +4 -5
  339. data/spec/models/get_campaign_stats_spec.rb +20 -15
  340. data/spec/models/get_child_account_creation_status_spec.rb +41 -0
  341. data/spec/models/get_child_domain_spec.rb +4 -5
  342. data/spec/models/get_child_domains_spec.rb +2 -3
  343. data/spec/models/get_child_info_api_keys_spec.rb +4 -5
  344. data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
  345. data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
  346. data/spec/models/get_child_info_credits_spec.rb +4 -5
  347. data/spec/models/get_child_info_spec.rb +11 -12
  348. data/spec/models/get_child_info_statistics_spec.rb +5 -6
  349. data/spec/models/get_children_list_spec.rb +9 -4
  350. data/spec/models/get_client_spec.rb +6 -7
  351. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
  352. data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
  353. data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
  354. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
  355. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
  356. data/spec/models/get_contact_details_spec.rb +11 -12
  357. data/spec/models/get_contacts_spec.rb +4 -5
  358. data/spec/models/get_device_browser_stats_spec.rb +59 -0
  359. data/spec/models/get_email_campaign_spec.rb +46 -41
  360. data/spec/models/get_email_campaigns_spec.rb +4 -5
  361. data/spec/models/get_email_event_report_events_spec.rb +16 -17
  362. data/spec/models/get_email_event_report_spec.rb +3 -4
  363. data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
  364. data/spec/models/get_extended_campaign_overview_spec.rb +44 -39
  365. data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
  366. data/spec/models/get_extended_client_address_spec.rb +6 -7
  367. data/spec/models/get_extended_client_spec.rb +7 -8
  368. data/spec/models/get_extended_contact_details_spec.rb +12 -13
  369. data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
  370. data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
  371. data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
  372. data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
  373. data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
  374. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
  375. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
  376. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
  377. data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
  378. data/spec/models/get_extended_list_spec.rb +10 -11
  379. data/spec/models/get_folder_lists_spec.rb +4 -5
  380. data/spec/models/get_folder_spec.rb +7 -8
  381. data/spec/models/get_folders_spec.rb +4 -5
  382. data/spec/models/get_ip_from_sender_spec.rb +6 -7
  383. data/spec/models/get_ip_spec.rb +6 -7
  384. data/spec/models/get_ips_from_sender_spec.rb +3 -4
  385. data/spec/models/get_ips_spec.rb +3 -4
  386. data/spec/models/get_list_spec.rb +6 -7
  387. data/spec/models/get_lists_spec.rb +4 -5
  388. data/spec/models/get_process_spec.rb +10 -11
  389. data/spec/models/get_processes_spec.rb +4 -5
  390. data/spec/models/get_reports_reports_spec.rb +15 -16
  391. data/spec/models/get_reports_spec.rb +3 -4
  392. data/spec/models/get_senders_list_ips_spec.rb +5 -6
  393. data/spec/models/get_senders_list_senders_spec.rb +7 -8
  394. data/spec/models/get_senders_list_spec.rb +3 -4
  395. data/spec/models/get_shared_template_url_spec.rb +41 -0
  396. data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
  397. data/spec/models/get_sms_campaign_spec.rb +16 -17
  398. data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
  399. data/spec/models/get_sms_campaigns_spec.rb +4 -5
  400. data/spec/models/get_sms_event_report_events_spec.rb +13 -14
  401. data/spec/models/get_sms_event_report_spec.rb +3 -4
  402. data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
  403. data/spec/models/get_smtp_template_overview_spec.rb +20 -15
  404. data/spec/models/get_smtp_templates_spec.rb +4 -5
  405. data/spec/models/get_sso_token_spec.rb +3 -4
  406. data/spec/models/get_stats_by_browser_spec.rb +35 -0
  407. data/spec/models/get_stats_by_device_spec.rb +59 -0
  408. data/spec/models/get_stats_by_domain_spec.rb +2 -3
  409. data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
  410. data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
  411. data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
  412. data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
  413. data/spec/models/get_transac_email_content_events_spec.rb +4 -5
  414. data/spec/models/get_transac_email_content_spec.rb +9 -10
  415. data/spec/models/get_transac_emails_list_spec.rb +3 -4
  416. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +20 -9
  417. data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
  418. data/spec/models/get_transac_sms_report_spec.rb +3 -4
  419. data/spec/models/get_webhook_spec.rb +13 -14
  420. data/spec/models/get_webhooks_spec.rb +3 -4
  421. data/spec/models/manage_ip_spec.rb +3 -4
  422. data/spec/models/post_contact_info_contacts_spec.rb +11 -6
  423. data/spec/models/post_contact_info_spec.rb +3 -4
  424. data/spec/models/post_send_failed_spec.rb +7 -8
  425. data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
  426. data/spec/models/remaining_credit_model_child_spec.rb +4 -5
  427. data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
  428. data/spec/models/remaining_credit_model_spec.rb +4 -5
  429. data/spec/models/remove_contact_from_list_spec.rb +10 -5
  430. data/spec/models/remove_credits_spec.rb +4 -5
  431. data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
  432. data/spec/models/request_contact_export_spec.rb +11 -6
  433. data/spec/models/request_contact_import_new_list_spec.rb +4 -5
  434. data/spec/models/request_contact_import_spec.rb +11 -12
  435. data/spec/models/request_sms_recipient_export_spec.rb +8 -9
  436. data/spec/models/send_email_attachment_spec.rb +4 -5
  437. data/spec/models/send_email_spec.rb +11 -12
  438. data/spec/models/send_report_email_spec.rb +4 -33
  439. data/spec/models/send_report_spec.rb +8 -9
  440. data/spec/models/send_sms_spec.rb +7 -8
  441. data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
  442. data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
  443. data/spec/models/send_smtp_email_cc_spec.rb +4 -5
  444. data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
  445. data/spec/models/send_smtp_email_sender_spec.rb +10 -5
  446. data/spec/models/send_smtp_email_spec.rb +15 -16
  447. data/spec/models/send_smtp_email_to_spec.rb +4 -5
  448. data/spec/models/send_template_email_spec.rb +3 -4
  449. data/spec/models/send_test_email_spec.rb +3 -4
  450. data/spec/models/send_test_sms_spec.rb +3 -4
  451. data/spec/models/send_transac_sms_spec.rb +12 -13
  452. data/spec/models/update_attribute_enumeration_spec.rb +4 -5
  453. data/spec/models/update_attribute_spec.rb +4 -5
  454. data/spec/models/update_campaign_status_spec.rb +7 -8
  455. data/spec/models/update_child_account_status_spec.rb +11 -6
  456. data/spec/models/update_child_domain_spec.rb +3 -4
  457. data/spec/models/update_child_spec.rb +7 -8
  458. data/spec/models/update_contact_spec.rb +8 -9
  459. data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
  460. data/spec/models/update_email_campaign_sender_spec.rb +10 -5
  461. data/spec/models/update_email_campaign_spec.rb +49 -32
  462. data/spec/models/update_list_spec.rb +4 -5
  463. data/spec/models/update_sender_spec.rb +5 -6
  464. data/spec/models/update_sms_campaign_spec.rb +7 -8
  465. data/spec/models/update_smtp_template_sender_spec.rb +10 -5
  466. data/spec/models/update_smtp_template_spec.rb +12 -13
  467. data/spec/models/update_webhook_spec.rb +9 -10
  468. data/spec/models/upload_image_to_gallery_spec.rb +47 -0
  469. data/spec/spec_helper.rb +2 -2
  470. metadata +78 -10
@@ -1,16 +1,16 @@
1
1
  =begin
2
2
  #SendinBlue API
3
3
 
4
- #SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
4
+ #SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@sendinblue.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.3.1
9
+ Swagger Codegen version: 2.4.12
10
10
 
11
11
  =end
12
12
 
13
- require "uri"
13
+ require 'uri'
14
14
 
15
15
  module SibApiV3Sdk
16
16
  class EmailCampaignsApi
@@ -19,32 +19,29 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
-
23
22
  # Create an email campaign
24
- #
25
23
  # @param email_campaigns Values to create a campaign
26
24
  # @param [Hash] opts the optional parameters
27
25
  # @return [CreateModel]
28
26
  def create_email_campaign(email_campaigns, opts = {})
29
27
  data, _status_code, _headers = create_email_campaign_with_http_info(email_campaigns, opts)
30
- return data
28
+ data
31
29
  end
32
30
 
33
31
  # Create an email campaign
34
- #
35
32
  # @param email_campaigns Values to create a campaign
36
33
  # @param [Hash] opts the optional parameters
37
34
  # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers
38
35
  def create_email_campaign_with_http_info(email_campaigns, opts = {})
39
36
  if @api_client.config.debugging
40
- @api_client.config.logger.debug "Calling API: EmailCampaignsApi.create_email_campaign ..."
37
+ @api_client.config.logger.debug 'Calling API: EmailCampaignsApi.create_email_campaign ...'
41
38
  end
42
39
  # verify the required parameter 'email_campaigns' is set
43
40
  if @api_client.config.client_side_validation && email_campaigns.nil?
44
41
  fail ArgumentError, "Missing the required parameter 'email_campaigns' when calling EmailCampaignsApi.create_email_campaign"
45
42
  end
46
43
  # resource path
47
- local_var_path = "/emailCampaigns"
44
+ local_var_path = '/emailCampaigns'
48
45
 
49
46
  # query parameters
50
47
  query_params = {}
@@ -74,32 +71,29 @@ module SibApiV3Sdk
74
71
  end
75
72
  return data, status_code, headers
76
73
  end
77
-
78
74
  # Delete an email campaign
79
- #
80
75
  # @param campaign_id id of the campaign
81
76
  # @param [Hash] opts the optional parameters
82
77
  # @return [nil]
83
78
  def delete_email_campaign(campaign_id, opts = {})
84
79
  delete_email_campaign_with_http_info(campaign_id, opts)
85
- return nil
80
+ nil
86
81
  end
87
82
 
88
83
  # Delete an email campaign
89
- #
90
84
  # @param campaign_id id of the campaign
91
85
  # @param [Hash] opts the optional parameters
92
86
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
93
87
  def delete_email_campaign_with_http_info(campaign_id, opts = {})
94
88
  if @api_client.config.debugging
95
- @api_client.config.logger.debug "Calling API: EmailCampaignsApi.delete_email_campaign ..."
89
+ @api_client.config.logger.debug 'Calling API: EmailCampaignsApi.delete_email_campaign ...'
96
90
  end
97
91
  # verify the required parameter 'campaign_id' is set
98
92
  if @api_client.config.client_side_validation && campaign_id.nil?
99
93
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling EmailCampaignsApi.delete_email_campaign"
100
94
  end
101
95
  # resource path
102
- local_var_path = "/emailCampaigns/{campaignId}".sub('{' + 'campaignId' + '}', campaign_id.to_s)
96
+ local_var_path = '/emailCampaigns/{campaignId}'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
103
97
 
104
98
  # query parameters
105
99
  query_params = {}
@@ -128,34 +122,31 @@ module SibApiV3Sdk
128
122
  end
129
123
  return data, status_code, headers
130
124
  end
131
-
132
- # Export the recipients of a campaign
133
- #
125
+ # Export the recipients of an email campaign
134
126
  # @param campaign_id Id of the campaign
135
127
  # @param [Hash] opts the optional parameters
136
128
  # @option opts [EmailExportRecipients] :recipient_export Values to send for a recipient export request
137
129
  # @return [CreatedProcessId]
138
130
  def email_export_recipients(campaign_id, opts = {})
139
131
  data, _status_code, _headers = email_export_recipients_with_http_info(campaign_id, opts)
140
- return data
132
+ data
141
133
  end
142
134
 
143
- # Export the recipients of a campaign
144
- #
135
+ # Export the recipients of an email campaign
145
136
  # @param campaign_id Id of the campaign
146
137
  # @param [Hash] opts the optional parameters
147
138
  # @option opts [EmailExportRecipients] :recipient_export Values to send for a recipient export request
148
139
  # @return [Array<(CreatedProcessId, Fixnum, Hash)>] CreatedProcessId data, response status code and response headers
149
140
  def email_export_recipients_with_http_info(campaign_id, opts = {})
150
141
  if @api_client.config.debugging
151
- @api_client.config.logger.debug "Calling API: EmailCampaignsApi.email_export_recipients ..."
142
+ @api_client.config.logger.debug 'Calling API: EmailCampaignsApi.email_export_recipients ...'
152
143
  end
153
144
  # verify the required parameter 'campaign_id' is set
154
145
  if @api_client.config.client_side_validation && campaign_id.nil?
155
146
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling EmailCampaignsApi.email_export_recipients"
156
147
  end
157
148
  # resource path
158
- local_var_path = "/emailCampaigns/{campaignId}/exportRecipients".sub('{' + 'campaignId' + '}', campaign_id.to_s)
149
+ local_var_path = '/emailCampaigns/{campaignId}/exportRecipients'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
159
150
 
160
151
  # query parameters
161
152
  query_params = {}
@@ -185,32 +176,83 @@ module SibApiV3Sdk
185
176
  end
186
177
  return data, status_code, headers
187
178
  end
179
+ # Get an A/B test email campaign results
180
+ # Obtain winning version of an A/B test email campaign
181
+ # @param campaign_id Id of the A/B test campaign
182
+ # @param [Hash] opts the optional parameters
183
+ # @return [AbTestCampaignResult]
184
+ def get_ab_test_campaign_result(campaign_id, opts = {})
185
+ data, _status_code, _headers = get_ab_test_campaign_result_with_http_info(campaign_id, opts)
186
+ data
187
+ end
188
188
 
189
- # Get campaign informations
190
- #
189
+ # Get an A/B test email campaign results
190
+ # Obtain winning version of an A/B test email campaign
191
+ # @param campaign_id Id of the A/B test campaign
192
+ # @param [Hash] opts the optional parameters
193
+ # @return [Array<(AbTestCampaignResult, Fixnum, Hash)>] AbTestCampaignResult data, response status code and response headers
194
+ def get_ab_test_campaign_result_with_http_info(campaign_id, opts = {})
195
+ if @api_client.config.debugging
196
+ @api_client.config.logger.debug 'Calling API: EmailCampaignsApi.get_ab_test_campaign_result ...'
197
+ end
198
+ # verify the required parameter 'campaign_id' is set
199
+ if @api_client.config.client_side_validation && campaign_id.nil?
200
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling EmailCampaignsApi.get_ab_test_campaign_result"
201
+ end
202
+ # resource path
203
+ local_var_path = '/emailCampaigns/{campaignId}/abTestCampaignResult'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
204
+
205
+ # query parameters
206
+ query_params = {}
207
+
208
+ # header parameters
209
+ header_params = {}
210
+ # HTTP header 'Accept' (if needed)
211
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
212
+ # HTTP header 'Content-Type'
213
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
214
+
215
+ # form parameters
216
+ form_params = {}
217
+
218
+ # http body (model)
219
+ post_body = nil
220
+ auth_names = ['api-key', 'partner-key']
221
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
222
+ :header_params => header_params,
223
+ :query_params => query_params,
224
+ :form_params => form_params,
225
+ :body => post_body,
226
+ :auth_names => auth_names,
227
+ :return_type => 'AbTestCampaignResult')
228
+ if @api_client.config.debugging
229
+ @api_client.config.logger.debug "API called: EmailCampaignsApi#get_ab_test_campaign_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
230
+ end
231
+ return data, status_code, headers
232
+ end
233
+ # Get an email campaign report
191
234
  # @param campaign_id Id of the campaign
192
235
  # @param [Hash] opts the optional parameters
193
236
  # @return [GetEmailCampaign]
194
237
  def get_email_campaign(campaign_id, opts = {})
195
238
  data, _status_code, _headers = get_email_campaign_with_http_info(campaign_id, opts)
196
- return data
239
+ data
197
240
  end
198
241
 
199
- # Get campaign informations
200
- #
242
+ # Get an email campaign report
201
243
  # @param campaign_id Id of the campaign
202
244
  # @param [Hash] opts the optional parameters
203
245
  # @return [Array<(GetEmailCampaign, Fixnum, Hash)>] GetEmailCampaign data, response status code and response headers
204
246
  def get_email_campaign_with_http_info(campaign_id, opts = {})
205
247
  if @api_client.config.debugging
206
- @api_client.config.logger.debug "Calling API: EmailCampaignsApi.get_email_campaign ..."
248
+ @api_client.config.logger.debug 'Calling API: EmailCampaignsApi.get_email_campaign ...'
207
249
  end
208
250
  # verify the required parameter 'campaign_id' is set
209
251
  if @api_client.config.client_side_validation && campaign_id.nil?
210
252
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling EmailCampaignsApi.get_email_campaign"
211
253
  end
212
254
  # resource path
213
- local_var_path = "/emailCampaigns/{campaignId}".sub('{' + 'campaignId' + '}', campaign_id.to_s)
255
+ local_var_path = '/emailCampaigns/{campaignId}'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
214
256
 
215
257
  # query parameters
216
258
  query_params = {}
@@ -240,9 +282,7 @@ module SibApiV3Sdk
240
282
  end
241
283
  return data, status_code, headers
242
284
  end
243
-
244
- # Return all your created campaigns
245
- #
285
+ # Return all your created email campaigns
246
286
  # @param [Hash] opts the optional parameters
247
287
  # @option opts [String] :type Filter on the type of the campaigns
248
288
  # @option opts [String] :status Filter on the status of the campaign
@@ -253,11 +293,10 @@ module SibApiV3Sdk
253
293
  # @return [GetEmailCampaigns]
254
294
  def get_email_campaigns(opts = {})
255
295
  data, _status_code, _headers = get_email_campaigns_with_http_info(opts)
256
- return data
296
+ data
257
297
  end
258
298
 
259
- # Return all your created campaigns
260
- #
299
+ # Return all your created email campaigns
261
300
  # @param [Hash] opts the optional parameters
262
301
  # @option opts [String] :type Filter on the type of the campaigns
263
302
  # @option opts [String] :status Filter on the status of the campaign
@@ -268,7 +307,7 @@ module SibApiV3Sdk
268
307
  # @return [Array<(GetEmailCampaigns, Fixnum, Hash)>] GetEmailCampaigns data, response status code and response headers
269
308
  def get_email_campaigns_with_http_info(opts = {})
270
309
  if @api_client.config.debugging
271
- @api_client.config.logger.debug "Calling API: EmailCampaignsApi.get_email_campaigns ..."
310
+ @api_client.config.logger.debug 'Calling API: EmailCampaignsApi.get_email_campaigns ...'
272
311
  end
273
312
  if @api_client.config.client_side_validation && opts[:'type'] && !['classic', 'trigger'].include?(opts[:'type'])
274
313
  fail ArgumentError, 'invalid value for "type", must be one of classic, trigger'
@@ -281,7 +320,7 @@ module SibApiV3Sdk
281
320
  end
282
321
 
283
322
  # resource path
284
- local_var_path = "/emailCampaigns"
323
+ local_var_path = '/emailCampaigns'
285
324
 
286
325
  # query parameters
287
326
  query_params = {}
@@ -317,32 +356,83 @@ module SibApiV3Sdk
317
356
  end
318
357
  return data, status_code, headers
319
358
  end
359
+ # Get a shared template url
360
+ # Get a unique URL to share & import an email template from one Sendinblue account to another.
361
+ # @param campaign_id Id of the campaign or template
362
+ # @param [Hash] opts the optional parameters
363
+ # @return [GetSharedTemplateUrl]
364
+ def get_shared_template_url(campaign_id, opts = {})
365
+ data, _status_code, _headers = get_shared_template_url_with_http_info(campaign_id, opts)
366
+ data
367
+ end
368
+
369
+ # Get a shared template url
370
+ # Get a unique URL to share &amp; import an email template from one Sendinblue account to another.
371
+ # @param campaign_id Id of the campaign or template
372
+ # @param [Hash] opts the optional parameters
373
+ # @return [Array<(GetSharedTemplateUrl, Fixnum, Hash)>] GetSharedTemplateUrl data, response status code and response headers
374
+ def get_shared_template_url_with_http_info(campaign_id, opts = {})
375
+ if @api_client.config.debugging
376
+ @api_client.config.logger.debug 'Calling API: EmailCampaignsApi.get_shared_template_url ...'
377
+ end
378
+ # verify the required parameter 'campaign_id' is set
379
+ if @api_client.config.client_side_validation && campaign_id.nil?
380
+ fail ArgumentError, "Missing the required parameter 'campaign_id' when calling EmailCampaignsApi.get_shared_template_url"
381
+ end
382
+ # resource path
383
+ local_var_path = '/emailCampaigns/{campaignId}/sharedUrl'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
384
+
385
+ # query parameters
386
+ query_params = {}
387
+
388
+ # header parameters
389
+ header_params = {}
390
+ # HTTP header 'Accept' (if needed)
391
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
392
+ # HTTP header 'Content-Type'
393
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
394
+
395
+ # form parameters
396
+ form_params = {}
320
397
 
321
- # Send an email campaign id of the campaign immediately
322
- #
398
+ # http body (model)
399
+ post_body = nil
400
+ auth_names = ['api-key', 'partner-key']
401
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
402
+ :header_params => header_params,
403
+ :query_params => query_params,
404
+ :form_params => form_params,
405
+ :body => post_body,
406
+ :auth_names => auth_names,
407
+ :return_type => 'GetSharedTemplateUrl')
408
+ if @api_client.config.debugging
409
+ @api_client.config.logger.debug "API called: EmailCampaignsApi#get_shared_template_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
410
+ end
411
+ return data, status_code, headers
412
+ end
413
+ # Send an email campaign immediately, based on campaignId
323
414
  # @param campaign_id Id of the campaign
324
415
  # @param [Hash] opts the optional parameters
325
416
  # @return [nil]
326
417
  def send_email_campaign_now(campaign_id, opts = {})
327
418
  send_email_campaign_now_with_http_info(campaign_id, opts)
328
- return nil
419
+ nil
329
420
  end
330
421
 
331
- # Send an email campaign id of the campaign immediately
332
- #
422
+ # Send an email campaign immediately, based on campaignId
333
423
  # @param campaign_id Id of the campaign
334
424
  # @param [Hash] opts the optional parameters
335
425
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
336
426
  def send_email_campaign_now_with_http_info(campaign_id, opts = {})
337
427
  if @api_client.config.debugging
338
- @api_client.config.logger.debug "Calling API: EmailCampaignsApi.send_email_campaign_now ..."
428
+ @api_client.config.logger.debug 'Calling API: EmailCampaignsApi.send_email_campaign_now ...'
339
429
  end
340
430
  # verify the required parameter 'campaign_id' is set
341
431
  if @api_client.config.client_side_validation && campaign_id.nil?
342
432
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling EmailCampaignsApi.send_email_campaign_now"
343
433
  end
344
434
  # resource path
345
- local_var_path = "/emailCampaigns/{campaignId}/sendNow".sub('{' + 'campaignId' + '}', campaign_id.to_s)
435
+ local_var_path = '/emailCampaigns/{campaignId}/sendNow'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
346
436
 
347
437
  # query parameters
348
438
  query_params = {}
@@ -371,8 +461,7 @@ module SibApiV3Sdk
371
461
  end
372
462
  return data, status_code, headers
373
463
  end
374
-
375
- # Send the report of a campaigns
464
+ # Send the report of a campaign
376
465
  # A PDF will be sent to the specified email addresses
377
466
  # @param campaign_id Id of the campaign
378
467
  # @param send_report Values for send a report
@@ -380,10 +469,10 @@ module SibApiV3Sdk
380
469
  # @return [nil]
381
470
  def send_report(campaign_id, send_report, opts = {})
382
471
  send_report_with_http_info(campaign_id, send_report, opts)
383
- return nil
472
+ nil
384
473
  end
385
474
 
386
- # Send the report of a campaigns
475
+ # Send the report of a campaign
387
476
  # A PDF will be sent to the specified email addresses
388
477
  # @param campaign_id Id of the campaign
389
478
  # @param send_report Values for send a report
@@ -391,7 +480,7 @@ module SibApiV3Sdk
391
480
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
392
481
  def send_report_with_http_info(campaign_id, send_report, opts = {})
393
482
  if @api_client.config.debugging
394
- @api_client.config.logger.debug "Calling API: EmailCampaignsApi.send_report ..."
483
+ @api_client.config.logger.debug 'Calling API: EmailCampaignsApi.send_report ...'
395
484
  end
396
485
  # verify the required parameter 'campaign_id' is set
397
486
  if @api_client.config.client_side_validation && campaign_id.nil?
@@ -402,7 +491,7 @@ module SibApiV3Sdk
402
491
  fail ArgumentError, "Missing the required parameter 'send_report' when calling EmailCampaignsApi.send_report"
403
492
  end
404
493
  # resource path
405
- local_var_path = "/emailCampaigns/{campaignId}/sendReport".sub('{' + 'campaignId' + '}', campaign_id.to_s)
494
+ local_var_path = '/emailCampaigns/{campaignId}/sendReport'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
406
495
 
407
496
  # query parameters
408
497
  query_params = {}
@@ -431,27 +520,24 @@ module SibApiV3Sdk
431
520
  end
432
521
  return data, status_code, headers
433
522
  end
434
-
435
523
  # Send an email campaign to your test list
436
- #
437
524
  # @param campaign_id Id of the campaign
438
525
  # @param email_to
439
526
  # @param [Hash] opts the optional parameters
440
527
  # @return [nil]
441
528
  def send_test_email(campaign_id, email_to, opts = {})
442
529
  send_test_email_with_http_info(campaign_id, email_to, opts)
443
- return nil
530
+ nil
444
531
  end
445
532
 
446
533
  # Send an email campaign to your test list
447
- #
448
534
  # @param campaign_id Id of the campaign
449
535
  # @param email_to
450
536
  # @param [Hash] opts the optional parameters
451
537
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
452
538
  def send_test_email_with_http_info(campaign_id, email_to, opts = {})
453
539
  if @api_client.config.debugging
454
- @api_client.config.logger.debug "Calling API: EmailCampaignsApi.send_test_email ..."
540
+ @api_client.config.logger.debug 'Calling API: EmailCampaignsApi.send_test_email ...'
455
541
  end
456
542
  # verify the required parameter 'campaign_id' is set
457
543
  if @api_client.config.client_side_validation && campaign_id.nil?
@@ -462,7 +548,7 @@ module SibApiV3Sdk
462
548
  fail ArgumentError, "Missing the required parameter 'email_to' when calling EmailCampaignsApi.send_test_email"
463
549
  end
464
550
  # resource path
465
- local_var_path = "/emailCampaigns/{campaignId}/sendTest".sub('{' + 'campaignId' + '}', campaign_id.to_s)
551
+ local_var_path = '/emailCampaigns/{campaignId}/sendTest'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
466
552
 
467
553
  # query parameters
468
554
  query_params = {}
@@ -491,27 +577,24 @@ module SibApiV3Sdk
491
577
  end
492
578
  return data, status_code, headers
493
579
  end
494
-
495
- # Update a campaign status
496
- #
580
+ # Update an email campaign status
497
581
  # @param campaign_id Id of the campaign
498
582
  # @param status Status of the campaign
499
583
  # @param [Hash] opts the optional parameters
500
584
  # @return [nil]
501
585
  def update_campaign_status(campaign_id, status, opts = {})
502
586
  update_campaign_status_with_http_info(campaign_id, status, opts)
503
- return nil
587
+ nil
504
588
  end
505
589
 
506
- # Update a campaign status
507
- #
590
+ # Update an email campaign status
508
591
  # @param campaign_id Id of the campaign
509
592
  # @param status Status of the campaign
510
593
  # @param [Hash] opts the optional parameters
511
594
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
512
595
  def update_campaign_status_with_http_info(campaign_id, status, opts = {})
513
596
  if @api_client.config.debugging
514
- @api_client.config.logger.debug "Calling API: EmailCampaignsApi.update_campaign_status ..."
597
+ @api_client.config.logger.debug 'Calling API: EmailCampaignsApi.update_campaign_status ...'
515
598
  end
516
599
  # verify the required parameter 'campaign_id' is set
517
600
  if @api_client.config.client_side_validation && campaign_id.nil?
@@ -522,7 +605,7 @@ module SibApiV3Sdk
522
605
  fail ArgumentError, "Missing the required parameter 'status' when calling EmailCampaignsApi.update_campaign_status"
523
606
  end
524
607
  # resource path
525
- local_var_path = "/emailCampaigns/{campaignId}/status".sub('{' + 'campaignId' + '}', campaign_id.to_s)
608
+ local_var_path = '/emailCampaigns/{campaignId}/status'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
526
609
 
527
610
  # query parameters
528
611
  query_params = {}
@@ -551,27 +634,24 @@ module SibApiV3Sdk
551
634
  end
552
635
  return data, status_code, headers
553
636
  end
554
-
555
- # Update a campaign
556
- #
637
+ # Update an email campaign
557
638
  # @param campaign_id Id of the campaign
558
639
  # @param email_campaign Values to update a campaign
559
640
  # @param [Hash] opts the optional parameters
560
641
  # @return [nil]
561
642
  def update_email_campaign(campaign_id, email_campaign, opts = {})
562
643
  update_email_campaign_with_http_info(campaign_id, email_campaign, opts)
563
- return nil
644
+ nil
564
645
  end
565
646
 
566
- # Update a campaign
567
- #
647
+ # Update an email campaign
568
648
  # @param campaign_id Id of the campaign
569
649
  # @param email_campaign Values to update a campaign
570
650
  # @param [Hash] opts the optional parameters
571
651
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
572
652
  def update_email_campaign_with_http_info(campaign_id, email_campaign, opts = {})
573
653
  if @api_client.config.debugging
574
- @api_client.config.logger.debug "Calling API: EmailCampaignsApi.update_email_campaign ..."
654
+ @api_client.config.logger.debug 'Calling API: EmailCampaignsApi.update_email_campaign ...'
575
655
  end
576
656
  # verify the required parameter 'campaign_id' is set
577
657
  if @api_client.config.client_side_validation && campaign_id.nil?
@@ -582,7 +662,7 @@ module SibApiV3Sdk
582
662
  fail ArgumentError, "Missing the required parameter 'email_campaign' when calling EmailCampaignsApi.update_email_campaign"
583
663
  end
584
664
  # resource path
585
- local_var_path = "/emailCampaigns/{campaignId}".sub('{' + 'campaignId' + '}', campaign_id.to_s)
665
+ local_var_path = '/emailCampaigns/{campaignId}'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
586
666
 
587
667
  # query parameters
588
668
  query_params = {}
@@ -611,5 +691,56 @@ module SibApiV3Sdk
611
691
  end
612
692
  return data, status_code, headers
613
693
  end
694
+ # Upload an image to your account's image gallery
695
+ # @param upload_image Parameters to upload an image
696
+ # @param [Hash] opts the optional parameters
697
+ # @return [nil]
698
+ def upload_image_to_gallery(upload_image, opts = {})
699
+ upload_image_to_gallery_with_http_info(upload_image, opts)
700
+ nil
701
+ end
702
+
703
+ # Upload an image to your account&#39;s image gallery
704
+ # @param upload_image Parameters to upload an image
705
+ # @param [Hash] opts the optional parameters
706
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
707
+ def upload_image_to_gallery_with_http_info(upload_image, opts = {})
708
+ if @api_client.config.debugging
709
+ @api_client.config.logger.debug 'Calling API: EmailCampaignsApi.upload_image_to_gallery ...'
710
+ end
711
+ # verify the required parameter 'upload_image' is set
712
+ if @api_client.config.client_side_validation && upload_image.nil?
713
+ fail ArgumentError, "Missing the required parameter 'upload_image' when calling EmailCampaignsApi.upload_image_to_gallery"
714
+ end
715
+ # resource path
716
+ local_var_path = '/emailCampaigns/images'
717
+
718
+ # query parameters
719
+ query_params = {}
720
+
721
+ # header parameters
722
+ header_params = {}
723
+ # HTTP header 'Accept' (if needed)
724
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
725
+ # HTTP header 'Content-Type'
726
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
727
+
728
+ # form parameters
729
+ form_params = {}
730
+
731
+ # http body (model)
732
+ post_body = @api_client.object_to_http_body(upload_image)
733
+ auth_names = ['api-key', 'partner-key']
734
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
735
+ :header_params => header_params,
736
+ :query_params => query_params,
737
+ :form_params => form_params,
738
+ :body => post_body,
739
+ :auth_names => auth_names)
740
+ if @api_client.config.debugging
741
+ @api_client.config.logger.debug "API called: EmailCampaignsApi#upload_image_to_gallery\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
742
+ end
743
+ return data, status_code, headers
744
+ end
614
745
  end
615
746
  end