sib-api-v3-sdk 7.0.0 → 7.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (464) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -8
  3. data/docs/BlockDomain.md +8 -0
  4. data/docs/ContactsApi.md +25 -13
  5. data/docs/CreateEmailCampaign.md +1 -1
  6. data/docs/CreateSmsCampaign.md +1 -1
  7. data/docs/CreateSmtpEmail.md +2 -1
  8. data/docs/CreateSmtpTemplateSender.md +1 -1
  9. data/docs/EmailCampaignsApi.md +7 -5
  10. data/docs/FoldersApi.md +9 -3
  11. data/docs/GetBlockedDomains.md +8 -0
  12. data/docs/GetCampaignOverview.md +1 -1
  13. data/docs/GetChildDomain.md +2 -2
  14. data/docs/GetChildrenList.md +1 -1
  15. data/docs/GetContactCampaignStatsOpened.md +1 -1
  16. data/docs/GetContactDetails.md +2 -2
  17. data/docs/GetEmailCampaign.md +8 -8
  18. data/docs/GetEmailCampaigns.md +1 -1
  19. data/docs/GetEmailEventReportEvents.md +2 -1
  20. data/docs/GetExtendedCampaignOverview.md +6 -6
  21. data/docs/GetExtendedCampaignStats.md +1 -1
  22. data/docs/GetExtendedCampaignStatsGlobalStats.md +7 -0
  23. data/docs/GetExtendedContactDetails.md +2 -2
  24. data/docs/GetExtendedContactDetailsStatisticsLinks.md +1 -1
  25. data/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +1 -1
  26. data/docs/GetExtendedContactDetailsStatisticsOpened.md +1 -1
  27. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +2 -2
  28. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +2 -2
  29. data/docs/GetExtendedList.md +2 -1
  30. data/docs/GetFolderLists.md +2 -2
  31. data/docs/GetList.md +1 -0
  32. data/docs/GetLists.md +2 -2
  33. data/docs/GetProcesses.md +1 -1
  34. data/docs/GetSmsCampaign.md +5 -5
  35. data/docs/GetSmsCampaignOverview.md +3 -3
  36. data/docs/GetSmsCampaignRecipients.md +7 -0
  37. data/docs/GetSmsCampaigns.md +1 -1
  38. data/docs/GetSmsEventReportEvents.md +4 -4
  39. data/docs/GetSmtpTemplateOverview.md +2 -2
  40. data/docs/GetTransacAggregatedSmsReport.md +10 -10
  41. data/docs/GetTransacBlockedContactsContacts.md +1 -1
  42. data/docs/GetTransacEmailContent.md +1 -1
  43. data/docs/GetTransacEmailContentEvents.md +1 -1
  44. data/docs/GetTransacEmailsList.md +1 -0
  45. data/docs/GetTransacEmailsListTransactionalEmails.md +1 -1
  46. data/docs/GetTransacSmsReportReports.md +10 -10
  47. data/docs/GetWebhook.md +2 -2
  48. data/docs/ListsApi.md +11 -5
  49. data/docs/ProcessApi.md +3 -1
  50. data/docs/SMSCampaignsApi.md +7 -5
  51. data/docs/SendReportEmail.md +1 -5
  52. data/docs/SendSmtpEmail.md +3 -2
  53. data/docs/SendSmtpEmailMessageVersions.md +13 -0
  54. data/docs/SendSmtpEmailReplyTo1.md +9 -0
  55. data/docs/SendSmtpEmailSender.md +3 -3
  56. data/docs/SendSmtpEmailTo1.md +9 -0
  57. data/docs/SendTestEmail.md +1 -1
  58. data/docs/TransactionalEmailsApi.md +197 -11
  59. data/docs/TransactionalSMSApi.md +9 -5
  60. data/docs/UpdateEmailCampaign.md +1 -1
  61. data/docs/UpdateSmsCampaign.md +1 -1
  62. data/docs/WebhooksApi.md +3 -1
  63. data/lib/sib-api-v3-sdk.rb +16 -9
  64. data/lib/sib-api-v3-sdk/api/account_api.rb +11 -1
  65. data/lib/sib-api-v3-sdk/api/attributes_api.rb +11 -1
  66. data/lib/sib-api-v3-sdk/api/contacts_api.rb +49 -9
  67. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +21 -5
  68. data/lib/sib-api-v3-sdk/api/folders_api.rb +23 -1
  69. data/lib/sib-api-v3-sdk/api/lists_api.rb +31 -3
  70. data/lib/sib-api-v3-sdk/api/process_api.rb +17 -1
  71. data/lib/sib-api-v3-sdk/api/reseller_api.rb +11 -1
  72. data/lib/sib-api-v3-sdk/api/senders_api.rb +11 -1
  73. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +21 -5
  74. data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +211 -7
  75. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +23 -1
  76. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +17 -1
  77. data/lib/sib-api-v3-sdk/api_client.rb +8 -5
  78. data/lib/sib-api-v3-sdk/api_error.rb +1 -1
  79. data/lib/sib-api-v3-sdk/configuration.rb +3 -3
  80. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +3 -2
  81. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +3 -2
  82. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +3 -2
  83. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +3 -2
  84. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +3 -2
  85. data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +3 -2
  86. data/lib/sib-api-v3-sdk/models/add_child_domain.rb +3 -2
  87. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +3 -2
  88. data/lib/sib-api-v3-sdk/models/add_credits.rb +3 -2
  89. data/lib/sib-api-v3-sdk/models/block_domain.rb +190 -0
  90. data/lib/sib-api-v3-sdk/models/create_attribute.rb +3 -2
  91. data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +3 -2
  92. data/lib/sib-api-v3-sdk/models/create_child.rb +3 -2
  93. data/lib/sib-api-v3-sdk/models/create_contact.rb +3 -2
  94. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +3 -2
  95. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +4 -3
  96. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +3 -2
  97. data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +3 -2
  98. data/lib/sib-api-v3-sdk/models/create_list.rb +3 -2
  99. data/lib/sib-api-v3-sdk/models/create_model.rb +3 -2
  100. data/lib/sib-api-v3-sdk/models/create_reseller.rb +3 -2
  101. data/lib/sib-api-v3-sdk/models/create_sender.rb +3 -2
  102. data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +3 -2
  103. data/lib/sib-api-v3-sdk/models/create_sender_model.rb +3 -2
  104. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +4 -3
  105. data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +3 -2
  106. data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +18 -11
  107. data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +3 -2
  108. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +3 -7
  109. data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +3 -2
  110. data/lib/sib-api-v3-sdk/models/create_update_folder.rb +3 -2
  111. data/lib/sib-api-v3-sdk/models/create_webhook.rb +3 -2
  112. data/lib/sib-api-v3-sdk/models/created_process_id.rb +3 -2
  113. data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +3 -2
  114. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +3 -2
  115. data/lib/sib-api-v3-sdk/models/error_model.rb +3 -2
  116. data/lib/sib-api-v3-sdk/models/get_account.rb +3 -2
  117. data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +3 -2
  118. data/lib/sib-api-v3-sdk/models/get_account_plan.rb +3 -2
  119. data/lib/sib-api-v3-sdk/models/get_account_relay.rb +3 -2
  120. data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +3 -2
  121. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +3 -2
  122. data/lib/sib-api-v3-sdk/models/get_attributes.rb +3 -2
  123. data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +3 -2
  124. data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +3 -2
  125. data/lib/sib-api-v3-sdk/models/get_blocked_domains.rb +193 -0
  126. data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +4 -3
  127. data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +3 -2
  128. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +3 -2
  129. data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +3 -2
  130. data/lib/sib-api-v3-sdk/models/get_child_domain.rb +3 -12
  131. data/lib/sib-api-v3-sdk/models/get_child_domains.rb +3 -2
  132. data/lib/sib-api-v3-sdk/models/get_child_info.rb +3 -2
  133. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +3 -2
  134. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +3 -2
  135. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +3 -2
  136. data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +3 -2
  137. data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +3 -2
  138. data/lib/sib-api-v3-sdk/models/get_children_list.rb +3 -7
  139. data/lib/sib-api-v3-sdk/models/get_client.rb +3 -2
  140. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +3 -2
  141. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +3 -2
  142. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +4 -3
  143. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +3 -2
  144. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +3 -2
  145. data/lib/sib-api-v3-sdk/models/get_contact_details.rb +5 -4
  146. data/lib/sib-api-v3-sdk/models/get_contacts.rb +3 -2
  147. data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +3 -2
  148. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +9 -18
  149. data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +3 -7
  150. data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +3 -2
  151. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +20 -9
  152. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +7 -16
  153. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +3 -2
  154. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +4 -4
  155. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats_global_stats.rb +176 -0
  156. data/lib/sib-api-v3-sdk/models/get_extended_client.rb +3 -2
  157. data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +3 -2
  158. data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +5 -4
  159. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +3 -2
  160. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +3 -2
  161. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +4 -3
  162. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +4 -3
  163. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +4 -3
  164. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +3 -2
  165. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +4 -8
  166. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +4 -8
  167. data/lib/sib-api-v3-sdk/models/get_extended_list.rb +20 -4
  168. data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +3 -2
  169. data/lib/sib-api-v3-sdk/models/get_folder.rb +3 -2
  170. data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +3 -12
  171. data/lib/sib-api-v3-sdk/models/get_folders.rb +3 -2
  172. data/lib/sib-api-v3-sdk/models/get_ip.rb +3 -2
  173. data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +3 -2
  174. data/lib/sib-api-v3-sdk/models/get_ips.rb +3 -2
  175. data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +3 -2
  176. data/lib/sib-api-v3-sdk/models/get_list.rb +22 -6
  177. data/lib/sib-api-v3-sdk/models/get_lists.rb +3 -12
  178. data/lib/sib-api-v3-sdk/models/get_process.rb +3 -2
  179. data/lib/sib-api-v3-sdk/models/get_processes.rb +3 -7
  180. data/lib/sib-api-v3-sdk/models/get_reports.rb +3 -2
  181. data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +3 -2
  182. data/lib/sib-api-v3-sdk/models/get_senders_list.rb +3 -2
  183. data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +3 -2
  184. data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +3 -2
  185. data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +3 -2
  186. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +8 -12
  187. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +6 -10
  188. data/lib/sib-api-v3-sdk/models/get_sms_campaign_recipients.rb +175 -0
  189. data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +3 -2
  190. data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +3 -7
  191. data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +3 -2
  192. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +4 -23
  193. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +5 -4
  194. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +3 -2
  195. data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +3 -2
  196. data/lib/sib-api-v3-sdk/models/get_sso_token.rb +3 -2
  197. data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +3 -2
  198. data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +3 -2
  199. data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +3 -2
  200. data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +3 -52
  201. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +3 -2
  202. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +4 -3
  203. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +3 -2
  204. data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +4 -3
  205. data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +4 -3
  206. data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +14 -3
  207. data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +4 -3
  208. data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +3 -2
  209. data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +3 -52
  210. data/lib/sib-api-v3-sdk/models/get_webhook.rb +5 -4
  211. data/lib/sib-api-v3-sdk/models/get_webhooks.rb +3 -2
  212. data/lib/sib-api-v3-sdk/models/manage_ip.rb +3 -2
  213. data/lib/sib-api-v3-sdk/models/post_contact_info.rb +3 -2
  214. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +3 -2
  215. data/lib/sib-api-v3-sdk/models/post_send_failed.rb +3 -2
  216. data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +3 -2
  217. data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +3 -2
  218. data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +3 -2
  219. data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +3 -2
  220. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +3 -2
  221. data/lib/sib-api-v3-sdk/models/remove_credits.rb +3 -2
  222. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +3 -2
  223. data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +3 -2
  224. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +3 -2
  225. data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +3 -2
  226. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +3 -2
  227. data/lib/sib-api-v3-sdk/models/send_email.rb +3 -2
  228. data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +3 -2
  229. data/lib/sib-api-v3-sdk/models/send_report.rb +3 -2
  230. data/lib/sib-api-v3-sdk/models/send_report_email.rb +6 -90
  231. data/lib/sib-api-v3-sdk/models/send_sms.rb +3 -2
  232. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +18 -10
  233. data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +3 -2
  234. data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +3 -2
  235. data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +3 -2
  236. data/lib/sib-api-v3-sdk/models/send_smtp_email_message_versions.rb +247 -0
  237. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +3 -2
  238. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to_1.rb +201 -0
  239. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +7 -11
  240. data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +3 -2
  241. data/lib/sib-api-v3-sdk/models/send_smtp_email_to_1.rb +200 -0
  242. data/lib/sib-api-v3-sdk/models/send_template_email.rb +3 -2
  243. data/lib/sib-api-v3-sdk/models/send_test_email.rb +4 -3
  244. data/lib/sib-api-v3-sdk/models/send_test_sms.rb +3 -2
  245. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +3 -2
  246. data/lib/sib-api-v3-sdk/models/update_attribute.rb +3 -2
  247. data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +3 -2
  248. data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +3 -2
  249. data/lib/sib-api-v3-sdk/models/update_child.rb +3 -2
  250. data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +3 -2
  251. data/lib/sib-api-v3-sdk/models/update_child_domain.rb +3 -2
  252. data/lib/sib-api-v3-sdk/models/update_contact.rb +3 -2
  253. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +4 -3
  254. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +3 -2
  255. data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +3 -2
  256. data/lib/sib-api-v3-sdk/models/update_list.rb +3 -2
  257. data/lib/sib-api-v3-sdk/models/update_sender.rb +3 -2
  258. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +4 -3
  259. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +3 -2
  260. data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +3 -2
  261. data/lib/sib-api-v3-sdk/models/update_webhook.rb +3 -2
  262. data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +3 -2
  263. data/lib/sib-api-v3-sdk/version.rb +2 -2
  264. data/spec/api/account_api_spec.rb +1 -1
  265. data/spec/api/attributes_api_spec.rb +1 -1
  266. data/spec/api/contacts_api_spec.rb +10 -5
  267. data/spec/api/email_campaigns_api_spec.rb +4 -3
  268. data/spec/api/folders_api_spec.rb +3 -1
  269. data/spec/api/lists_api_spec.rb +5 -2
  270. data/spec/api/process_api_spec.rb +2 -1
  271. data/spec/api/reseller_api_spec.rb +1 -1
  272. data/spec/api/senders_api_spec.rb +1 -1
  273. data/spec/api/sms_campaigns_api_spec.rb +4 -3
  274. data/spec/api/transactional_emails_api_spec.rb +45 -3
  275. data/spec/api/transactional_sms_api_spec.rb +3 -1
  276. data/spec/api/webhooks_api_spec.rb +2 -1
  277. data/spec/api_client_spec.rb +18 -1
  278. data/spec/configuration_spec.rb +1 -1
  279. data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +1 -1
  280. data/spec/models/ab_test_campaign_result_spec.rb +1 -1
  281. data/spec/models/ab_test_campaign_result_statistics_spec.rb +1 -1
  282. data/spec/models/ab_test_version_clicks_inner_spec.rb +1 -1
  283. data/spec/models/ab_test_version_clicks_spec.rb +1 -1
  284. data/spec/models/ab_test_version_stats_spec.rb +1 -1
  285. data/spec/models/add_child_domain_spec.rb +1 -1
  286. data/spec/models/add_contact_to_list_spec.rb +1 -1
  287. data/spec/models/add_credits_spec.rb +1 -1
  288. data/spec/models/block_domain_spec.rb +41 -0
  289. data/spec/models/create_attribute_enumeration_spec.rb +1 -1
  290. data/spec/models/create_attribute_spec.rb +1 -1
  291. data/spec/models/create_child_spec.rb +1 -1
  292. data/spec/models/create_contact_spec.rb +1 -1
  293. data/spec/models/create_doi_contact_spec.rb +1 -1
  294. data/spec/models/create_email_campaign_recipients_spec.rb +1 -1
  295. data/spec/models/create_email_campaign_sender_spec.rb +1 -1
  296. data/spec/models/create_email_campaign_spec.rb +1 -1
  297. data/spec/models/create_list_spec.rb +1 -1
  298. data/spec/models/create_model_spec.rb +1 -1
  299. data/spec/models/create_reseller_spec.rb +1 -1
  300. data/spec/models/create_sender_ips_spec.rb +1 -1
  301. data/spec/models/create_sender_model_spec.rb +1 -1
  302. data/spec/models/create_sender_spec.rb +1 -1
  303. data/spec/models/create_sms_campaign_recipients_spec.rb +1 -1
  304. data/spec/models/create_sms_campaign_spec.rb +1 -1
  305. data/spec/models/create_smtp_email_spec.rb +7 -1
  306. data/spec/models/create_smtp_template_sender_spec.rb +1 -1
  307. data/spec/models/create_smtp_template_spec.rb +1 -1
  308. data/spec/models/create_update_contact_model_spec.rb +1 -1
  309. data/spec/models/create_update_folder_spec.rb +1 -1
  310. data/spec/models/create_webhook_spec.rb +1 -1
  311. data/spec/models/created_process_id_spec.rb +1 -1
  312. data/spec/models/delete_hardbounces_spec.rb +1 -1
  313. data/spec/models/email_export_recipients_spec.rb +1 -1
  314. data/spec/models/error_model_spec.rb +1 -1
  315. data/spec/models/get_account_marketing_automation_spec.rb +1 -1
  316. data/spec/models/get_account_plan_spec.rb +1 -1
  317. data/spec/models/get_account_relay_data_spec.rb +1 -1
  318. data/spec/models/get_account_relay_spec.rb +1 -1
  319. data/spec/models/get_account_spec.rb +1 -1
  320. data/spec/models/get_aggregated_report_spec.rb +1 -1
  321. data/spec/models/get_attributes_attributes_spec.rb +1 -1
  322. data/spec/models/get_attributes_enumeration_spec.rb +1 -1
  323. data/spec/models/get_attributes_spec.rb +1 -1
  324. data/spec/models/get_blocked_domains_spec.rb +41 -0
  325. data/spec/models/get_campaign_overview_spec.rb +1 -1
  326. data/spec/models/get_campaign_recipients_spec.rb +1 -1
  327. data/spec/models/get_campaign_stats_spec.rb +1 -1
  328. data/spec/models/get_child_account_creation_status_spec.rb +1 -1
  329. data/spec/models/get_child_domain_spec.rb +1 -1
  330. data/spec/models/get_child_domains_spec.rb +1 -1
  331. data/spec/models/get_child_info_api_keys_spec.rb +1 -1
  332. data/spec/models/get_child_info_api_keys_v2_spec.rb +1 -1
  333. data/spec/models/get_child_info_api_keys_v3_spec.rb +1 -1
  334. data/spec/models/get_child_info_credits_spec.rb +1 -1
  335. data/spec/models/get_child_info_spec.rb +1 -1
  336. data/spec/models/get_child_info_statistics_spec.rb +1 -1
  337. data/spec/models/get_children_list_spec.rb +1 -1
  338. data/spec/models/get_client_spec.rb +1 -1
  339. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +1 -1
  340. data/spec/models/get_contact_campaign_stats_opened_spec.rb +1 -1
  341. data/spec/models/get_contact_campaign_stats_spec.rb +1 -1
  342. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +1 -1
  343. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +1 -1
  344. data/spec/models/get_contact_details_spec.rb +1 -1
  345. data/spec/models/get_contacts_spec.rb +1 -1
  346. data/spec/models/get_device_browser_stats_spec.rb +1 -1
  347. data/spec/models/get_email_campaign_spec.rb +1 -1
  348. data/spec/models/get_email_campaigns_spec.rb +1 -1
  349. data/spec/models/get_email_event_report_events_spec.rb +8 -2
  350. data/spec/models/get_email_event_report_spec.rb +1 -1
  351. data/spec/models/get_extended_campaign_overview_sender_spec.rb +1 -1
  352. data/spec/models/get_extended_campaign_overview_spec.rb +1 -1
  353. data/spec/models/get_extended_campaign_stats_global_stats_spec.rb +35 -0
  354. data/spec/models/get_extended_campaign_stats_spec.rb +1 -1
  355. data/spec/models/get_extended_client_address_spec.rb +1 -1
  356. data/spec/models/get_extended_client_spec.rb +1 -1
  357. data/spec/models/get_extended_contact_details_spec.rb +1 -1
  358. data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +1 -1
  359. data/spec/models/get_extended_contact_details_statistics_links_spec.rb +1 -1
  360. data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +1 -1
  361. data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +1 -1
  362. data/spec/models/get_extended_contact_details_statistics_spec.rb +1 -1
  363. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +1 -1
  364. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +1 -1
  365. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +1 -1
  366. data/spec/models/get_extended_list_campaign_stats_spec.rb +1 -1
  367. data/spec/models/get_extended_list_spec.rb +7 -1
  368. data/spec/models/get_folder_lists_spec.rb +1 -1
  369. data/spec/models/get_folder_spec.rb +1 -1
  370. data/spec/models/get_folders_spec.rb +1 -1
  371. data/spec/models/get_ip_from_sender_spec.rb +1 -1
  372. data/spec/models/get_ip_spec.rb +1 -1
  373. data/spec/models/get_ips_from_sender_spec.rb +1 -1
  374. data/spec/models/get_ips_spec.rb +1 -1
  375. data/spec/models/get_list_spec.rb +7 -1
  376. data/spec/models/get_lists_spec.rb +1 -1
  377. data/spec/models/get_process_spec.rb +1 -1
  378. data/spec/models/get_processes_spec.rb +1 -1
  379. data/spec/models/get_reports_reports_spec.rb +1 -1
  380. data/spec/models/get_reports_spec.rb +1 -1
  381. data/spec/models/get_senders_list_ips_spec.rb +1 -1
  382. data/spec/models/get_senders_list_senders_spec.rb +1 -1
  383. data/spec/models/get_senders_list_spec.rb +1 -1
  384. data/spec/models/get_shared_template_url_spec.rb +1 -1
  385. data/spec/models/get_sms_campaign_overview_spec.rb +1 -1
  386. data/spec/models/get_sms_campaign_recipients_spec.rb +35 -0
  387. data/spec/models/get_sms_campaign_spec.rb +1 -1
  388. data/spec/models/get_sms_campaign_stats_spec.rb +1 -1
  389. data/spec/models/get_sms_campaigns_spec.rb +1 -1
  390. data/spec/models/get_sms_event_report_events_spec.rb +1 -1
  391. data/spec/models/get_sms_event_report_spec.rb +1 -1
  392. data/spec/models/get_smtp_template_overview_sender_spec.rb +1 -1
  393. data/spec/models/get_smtp_template_overview_spec.rb +1 -1
  394. data/spec/models/get_smtp_templates_spec.rb +1 -1
  395. data/spec/models/get_sso_token_spec.rb +1 -1
  396. data/spec/models/get_stats_by_browser_spec.rb +1 -1
  397. data/spec/models/get_stats_by_device_spec.rb +1 -1
  398. data/spec/models/get_stats_by_domain_spec.rb +1 -1
  399. data/spec/models/get_transac_aggregated_sms_report_spec.rb +1 -1
  400. data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +1 -1
  401. data/spec/models/get_transac_blocked_contacts_reason_spec.rb +1 -1
  402. data/spec/models/get_transac_blocked_contacts_spec.rb +1 -1
  403. data/spec/models/get_transac_email_content_events_spec.rb +1 -1
  404. data/spec/models/get_transac_email_content_spec.rb +1 -1
  405. data/spec/models/get_transac_emails_list_spec.rb +7 -1
  406. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +1 -1
  407. data/spec/models/get_transac_sms_report_reports_spec.rb +1 -1
  408. data/spec/models/get_transac_sms_report_spec.rb +1 -1
  409. data/spec/models/get_webhook_spec.rb +1 -1
  410. data/spec/models/get_webhooks_spec.rb +1 -1
  411. data/spec/models/manage_ip_spec.rb +1 -1
  412. data/spec/models/post_contact_info_contacts_spec.rb +1 -1
  413. data/spec/models/post_contact_info_spec.rb +1 -1
  414. data/spec/models/post_send_failed_spec.rb +1 -1
  415. data/spec/models/post_send_sms_test_failed_spec.rb +1 -1
  416. data/spec/models/remaining_credit_model_child_spec.rb +1 -1
  417. data/spec/models/remaining_credit_model_reseller_spec.rb +1 -1
  418. data/spec/models/remaining_credit_model_spec.rb +1 -1
  419. data/spec/models/remove_contact_from_list_spec.rb +1 -1
  420. data/spec/models/remove_credits_spec.rb +1 -1
  421. data/spec/models/request_contact_export_custom_contact_filter_spec.rb +1 -1
  422. data/spec/models/request_contact_export_spec.rb +1 -1
  423. data/spec/models/request_contact_import_new_list_spec.rb +1 -1
  424. data/spec/models/request_contact_import_spec.rb +1 -1
  425. data/spec/models/request_sms_recipient_export_spec.rb +1 -1
  426. data/spec/models/send_email_attachment_spec.rb +1 -1
  427. data/spec/models/send_email_spec.rb +1 -1
  428. data/spec/models/send_report_email_spec.rb +1 -29
  429. data/spec/models/send_report_spec.rb +1 -1
  430. data/spec/models/send_sms_spec.rb +1 -1
  431. data/spec/models/send_smtp_email_attachment_spec.rb +1 -1
  432. data/spec/models/send_smtp_email_bcc_spec.rb +1 -1
  433. data/spec/models/send_smtp_email_cc_spec.rb +1 -1
  434. data/spec/models/send_smtp_email_message_versions_spec.rb +71 -0
  435. data/spec/models/send_smtp_email_reply_to_1_spec.rb +47 -0
  436. data/spec/models/send_smtp_email_reply_to_spec.rb +1 -1
  437. data/spec/models/send_smtp_email_sender_spec.rb +1 -1
  438. data/spec/models/send_smtp_email_spec.rb +7 -1
  439. data/spec/models/send_smtp_email_to_1_spec.rb +47 -0
  440. data/spec/models/send_smtp_email_to_spec.rb +1 -1
  441. data/spec/models/send_template_email_spec.rb +1 -1
  442. data/spec/models/send_test_email_spec.rb +1 -1
  443. data/spec/models/send_test_sms_spec.rb +1 -1
  444. data/spec/models/send_transac_sms_spec.rb +1 -1
  445. data/spec/models/update_attribute_enumeration_spec.rb +1 -1
  446. data/spec/models/update_attribute_spec.rb +1 -1
  447. data/spec/models/update_campaign_status_spec.rb +1 -1
  448. data/spec/models/update_child_account_status_spec.rb +1 -1
  449. data/spec/models/update_child_domain_spec.rb +1 -1
  450. data/spec/models/update_child_spec.rb +1 -1
  451. data/spec/models/update_contact_spec.rb +1 -1
  452. data/spec/models/update_email_campaign_recipients_spec.rb +1 -1
  453. data/spec/models/update_email_campaign_sender_spec.rb +1 -1
  454. data/spec/models/update_email_campaign_spec.rb +1 -1
  455. data/spec/models/update_list_spec.rb +1 -1
  456. data/spec/models/update_sender_spec.rb +1 -1
  457. data/spec/models/update_sms_campaign_spec.rb +1 -1
  458. data/spec/models/update_smtp_template_sender_spec.rb +1 -1
  459. data/spec/models/update_smtp_template_spec.rb +1 -1
  460. data/spec/models/update_webhook_spec.rb +1 -1
  461. data/spec/models/upload_image_to_gallery_spec.rb +1 -1
  462. data/spec/spec_helper.rb +1 -1
  463. metadata +193 -167
  464. data/testfile.rb +0 -23
@@ -6,7 +6,7 @@
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.4.12
9
+ Swagger Codegen version: 2.4.19
10
10
 
11
11
  =end
12
12
 
@@ -19,6 +19,16 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+
23
+ # Set custom user_agent if explicitly passed in api
24
+ # default will still remain Swagger-Codegen/#{VERSION}/ruby
25
+ def setUserAgent(user_agent)
26
+ @user_agent = user_agent
27
+ if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
28
+ @api_client.default_headers['User-Agent'] = @user_agent
29
+ end
30
+ end
31
+
22
32
  # Create a folder
23
33
  # @param create_folder Name of the folder
24
34
  # @param [Hash] opts the optional parameters
@@ -179,6 +189,7 @@ module SibApiV3Sdk
179
189
  # @param [Hash] opts the optional parameters
180
190
  # @option opts [Integer] :limit Number of documents per page (default to 10)
181
191
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
192
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
182
193
  # @return [GetFolderLists]
183
194
  def get_folder_lists(folder_id, opts = {})
184
195
  data, _status_code, _headers = get_folder_lists_with_http_info(folder_id, opts)
@@ -190,6 +201,7 @@ module SibApiV3Sdk
190
201
  # @param [Hash] opts the optional parameters
191
202
  # @option opts [Integer] :limit Number of documents per page
192
203
  # @option opts [Integer] :offset Index of the first document of the page
204
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
193
205
  # @return [Array<(GetFolderLists, Fixnum, Hash)>] GetFolderLists data, response status code and response headers
194
206
  def get_folder_lists_with_http_info(folder_id, opts = {})
195
207
  if @api_client.config.debugging
@@ -203,6 +215,9 @@ module SibApiV3Sdk
203
215
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling FoldersApi.get_folder_lists, must be smaller than or equal to 50.'
204
216
  end
205
217
 
218
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
219
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
220
+ end
206
221
  # resource path
207
222
  local_var_path = '/contacts/folders/{folderId}/lists'.sub('{' + 'folderId' + '}', folder_id.to_s)
208
223
 
@@ -210,6 +225,7 @@ module SibApiV3Sdk
210
225
  query_params = {}
211
226
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
212
227
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
228
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
213
229
 
214
230
  # header parameters
215
231
  header_params = {}
@@ -240,6 +256,7 @@ module SibApiV3Sdk
240
256
  # @param limit Number of documents per page
241
257
  # @param offset Index of the first document of the page
242
258
  # @param [Hash] opts the optional parameters
259
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
243
260
  # @return [GetFolders]
244
261
  def get_folders(limit, offset, opts = {})
245
262
  data, _status_code, _headers = get_folders_with_http_info(limit, offset, opts)
@@ -250,6 +267,7 @@ module SibApiV3Sdk
250
267
  # @param limit Number of documents per page
251
268
  # @param offset Index of the first document of the page
252
269
  # @param [Hash] opts the optional parameters
270
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
253
271
  # @return [Array<(GetFolders, Fixnum, Hash)>] GetFolders data, response status code and response headers
254
272
  def get_folders_with_http_info(limit, offset, opts = {})
255
273
  if @api_client.config.debugging
@@ -267,6 +285,9 @@ module SibApiV3Sdk
267
285
  if @api_client.config.client_side_validation && offset.nil?
268
286
  fail ArgumentError, "Missing the required parameter 'offset' when calling FoldersApi.get_folders"
269
287
  end
288
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
289
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
290
+ end
270
291
  # resource path
271
292
  local_var_path = '/contacts/folders'
272
293
 
@@ -274,6 +295,7 @@ module SibApiV3Sdk
274
295
  query_params = {}
275
296
  query_params[:'limit'] = limit
276
297
  query_params[:'offset'] = offset
298
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
277
299
 
278
300
  # header parameters
279
301
  header_params = {}
@@ -6,7 +6,7 @@
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.4.12
9
+ Swagger Codegen version: 2.4.19
10
10
 
11
11
  =end
12
12
 
@@ -19,6 +19,16 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+
23
+ # Set custom user_agent if explicitly passed in api
24
+ # default will still remain Swagger-Codegen/#{VERSION}/ruby
25
+ def setUserAgent(user_agent)
26
+ @user_agent = user_agent
27
+ if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
28
+ @api_client.default_headers['User-Agent'] = @user_agent
29
+ end
30
+ end
31
+
22
32
  # Add existing contacts to a list
23
33
  # @param list_id Id of the list
24
34
  # @param contact_emails Emails addresses OR IDs of the contacts
@@ -183,9 +193,10 @@ module SibApiV3Sdk
183
193
  # Get contacts in a list
184
194
  # @param list_id Id of the list
185
195
  # @param [Hash] opts the optional parameters
186
- # @option opts [DateTime] :modified_since 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.
196
+ # @option opts [String] :modified_since 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.
187
197
  # @option opts [Integer] :limit Number of documents per page (default to 50)
188
198
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
199
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
189
200
  # @return [GetContacts]
190
201
  def get_contacts_from_list(list_id, opts = {})
191
202
  data, _status_code, _headers = get_contacts_from_list_with_http_info(list_id, opts)
@@ -195,9 +206,10 @@ module SibApiV3Sdk
195
206
  # Get contacts in a list
196
207
  # @param list_id Id of the list
197
208
  # @param [Hash] opts the optional parameters
198
- # @option opts [DateTime] :modified_since 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.
209
+ # @option opts [String] :modified_since 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.
199
210
  # @option opts [Integer] :limit Number of documents per page
200
211
  # @option opts [Integer] :offset Index of the first document of the page
212
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
201
213
  # @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
202
214
  def get_contacts_from_list_with_http_info(list_id, opts = {})
203
215
  if @api_client.config.debugging
@@ -211,6 +223,9 @@ module SibApiV3Sdk
211
223
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ListsApi.get_contacts_from_list, must be smaller than or equal to 500.'
212
224
  end
213
225
 
226
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
227
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
228
+ end
214
229
  # resource path
215
230
  local_var_path = '/contacts/lists/{listId}/contacts'.sub('{' + 'listId' + '}', list_id.to_s)
216
231
 
@@ -219,6 +234,7 @@ module SibApiV3Sdk
219
234
  query_params[:'modifiedSince'] = opts[:'modified_since'] if !opts[:'modified_since'].nil?
220
235
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
221
236
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
237
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
222
238
 
223
239
  # header parameters
224
240
  header_params = {}
@@ -250,6 +266,7 @@ module SibApiV3Sdk
250
266
  # @param [Hash] opts the optional parameters
251
267
  # @option opts [Integer] :limit Number of documents per page (default to 10)
252
268
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
269
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
253
270
  # @return [GetFolderLists]
254
271
  def get_folder_lists(folder_id, opts = {})
255
272
  data, _status_code, _headers = get_folder_lists_with_http_info(folder_id, opts)
@@ -261,6 +278,7 @@ module SibApiV3Sdk
261
278
  # @param [Hash] opts the optional parameters
262
279
  # @option opts [Integer] :limit Number of documents per page
263
280
  # @option opts [Integer] :offset Index of the first document of the page
281
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
264
282
  # @return [Array<(GetFolderLists, Fixnum, Hash)>] GetFolderLists data, response status code and response headers
265
283
  def get_folder_lists_with_http_info(folder_id, opts = {})
266
284
  if @api_client.config.debugging
@@ -274,6 +292,9 @@ module SibApiV3Sdk
274
292
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ListsApi.get_folder_lists, must be smaller than or equal to 50.'
275
293
  end
276
294
 
295
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
296
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
297
+ end
277
298
  # resource path
278
299
  local_var_path = '/contacts/folders/{folderId}/lists'.sub('{' + 'folderId' + '}', folder_id.to_s)
279
300
 
@@ -281,6 +302,7 @@ module SibApiV3Sdk
281
302
  query_params = {}
282
303
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
283
304
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
305
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
284
306
 
285
307
  # header parameters
286
308
  header_params = {}
@@ -363,6 +385,7 @@ module SibApiV3Sdk
363
385
  # @param [Hash] opts the optional parameters
364
386
  # @option opts [Integer] :limit Number of documents per page (default to 10)
365
387
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
388
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
366
389
  # @return [GetLists]
367
390
  def get_lists(opts = {})
368
391
  data, _status_code, _headers = get_lists_with_http_info(opts)
@@ -373,6 +396,7 @@ module SibApiV3Sdk
373
396
  # @param [Hash] opts the optional parameters
374
397
  # @option opts [Integer] :limit Number of documents per page
375
398
  # @option opts [Integer] :offset Index of the first document of the page
399
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
376
400
  # @return [Array<(GetLists, Fixnum, Hash)>] GetLists data, response status code and response headers
377
401
  def get_lists_with_http_info(opts = {})
378
402
  if @api_client.config.debugging
@@ -382,6 +406,9 @@ module SibApiV3Sdk
382
406
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ListsApi.get_lists, must be smaller than or equal to 50.'
383
407
  end
384
408
 
409
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
410
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
411
+ end
385
412
  # resource path
386
413
  local_var_path = '/contacts/lists'
387
414
 
@@ -389,6 +416,7 @@ module SibApiV3Sdk
389
416
  query_params = {}
390
417
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
391
418
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
419
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
392
420
 
393
421
  # header parameters
394
422
  header_params = {}
@@ -6,7 +6,7 @@
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.4.12
9
+ Swagger Codegen version: 2.4.19
10
10
 
11
11
  =end
12
12
 
@@ -19,6 +19,16 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+
23
+ # Set custom user_agent if explicitly passed in api
24
+ # default will still remain Swagger-Codegen/#{VERSION}/ruby
25
+ def setUserAgent(user_agent)
26
+ @user_agent = user_agent
27
+ if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
28
+ @api_client.default_headers['User-Agent'] = @user_agent
29
+ end
30
+ end
31
+
22
32
  # Return the informations for a process
23
33
  # @param process_id Id of the process
24
34
  # @param [Hash] opts the optional parameters
@@ -75,6 +85,7 @@ module SibApiV3Sdk
75
85
  # @param [Hash] opts the optional parameters
76
86
  # @option opts [Integer] :limit Number limitation for the result returned (default to 10)
77
87
  # @option opts [Integer] :offset Beginning point in the list to retrieve from. (default to 0)
88
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
78
89
  # @return [GetProcesses]
79
90
  def get_processes(opts = {})
80
91
  data, _status_code, _headers = get_processes_with_http_info(opts)
@@ -85,6 +96,7 @@ module SibApiV3Sdk
85
96
  # @param [Hash] opts the optional parameters
86
97
  # @option opts [Integer] :limit Number limitation for the result returned
87
98
  # @option opts [Integer] :offset Beginning point in the list to retrieve from.
99
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
88
100
  # @return [Array<(GetProcesses, Fixnum, Hash)>] GetProcesses data, response status code and response headers
89
101
  def get_processes_with_http_info(opts = {})
90
102
  if @api_client.config.debugging
@@ -94,6 +106,9 @@ module SibApiV3Sdk
94
106
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ProcessApi.get_processes, must be smaller than or equal to 50.'
95
107
  end
96
108
 
109
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
110
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
111
+ end
97
112
  # resource path
98
113
  local_var_path = '/processes'
99
114
 
@@ -101,6 +116,7 @@ module SibApiV3Sdk
101
116
  query_params = {}
102
117
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
103
118
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
119
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
104
120
 
105
121
  # header parameters
106
122
  header_params = {}
@@ -6,7 +6,7 @@
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.4.12
9
+ Swagger Codegen version: 2.4.19
10
10
 
11
11
  =end
12
12
 
@@ -19,6 +19,16 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+
23
+ # Set custom user_agent if explicitly passed in api
24
+ # default will still remain Swagger-Codegen/#{VERSION}/ruby
25
+ def setUserAgent(user_agent)
26
+ @user_agent = user_agent
27
+ if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
28
+ @api_client.default_headers['User-Agent'] = @user_agent
29
+ end
30
+ end
31
+
22
32
  # Add Email and/or SMS credits to a specific child account
23
33
  # @param child_identifier Either auth key or id of reseller&#39;s child
24
34
  # @param add_credits Values to post to add credit to a specific child account
@@ -6,7 +6,7 @@
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.4.12
9
+ Swagger Codegen version: 2.4.19
10
10
 
11
11
  =end
12
12
 
@@ -19,6 +19,16 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+
23
+ # Set custom user_agent if explicitly passed in api
24
+ # default will still remain Swagger-Codegen/#{VERSION}/ruby
25
+ def setUserAgent(user_agent)
26
+ @user_agent = user_agent
27
+ if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
28
+ @api_client.default_headers['User-Agent'] = @user_agent
29
+ end
30
+ end
31
+
22
32
  # Create a new sender
23
33
  # @param [Hash] opts the optional parameters
24
34
  # @option opts [CreateSender] :sender sender&#39;s name
@@ -6,7 +6,7 @@
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.4.12
9
+ Swagger Codegen version: 2.4.19
10
10
 
11
11
  =end
12
12
 
@@ -19,6 +19,16 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+
23
+ # Set custom user_agent if explicitly passed in api
24
+ # default will still remain Swagger-Codegen/#{VERSION}/ruby
25
+ def setUserAgent(user_agent)
26
+ @user_agent = user_agent
27
+ if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
28
+ @api_client.default_headers['User-Agent'] = @user_agent
29
+ end
30
+ end
31
+
22
32
  # Creates an SMS campaign
23
33
  # @param create_sms_campaign Values to create an SMS Campaign
24
34
  # @param [Hash] opts the optional parameters
@@ -177,10 +187,11 @@ module SibApiV3Sdk
177
187
  # Returns the information for all your created SMS campaigns
178
188
  # @param [Hash] opts the optional parameters
179
189
  # @option opts [String] :status Status of campaign.
180
- # @option opts [DateTime] :start_date 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 &#39;status&#39; not passed and if passed is set to &#39;sent&#39; )
181
- # @option opts [DateTime] :end_date 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 &#39;status&#39; not passed and if passed is set to &#39;sent&#39; )
190
+ # @option opts [String] :start_date 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 &#39;status&#39; not passed and if passed is set to &#39;sent&#39; )
191
+ # @option opts [String] :end_date 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 &#39;status&#39; not passed and if passed is set to &#39;sent&#39; )
182
192
  # @option opts [Integer] :limit Number limitation for the result returned (default to 500)
183
193
  # @option opts [Integer] :offset Beginning point in the list to retrieve from. (default to 0)
194
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
184
195
  # @return [GetSmsCampaigns]
185
196
  def get_sms_campaigns(opts = {})
186
197
  data, _status_code, _headers = get_sms_campaigns_with_http_info(opts)
@@ -190,10 +201,11 @@ module SibApiV3Sdk
190
201
  # Returns the information for all your created SMS campaigns
191
202
  # @param [Hash] opts the optional parameters
192
203
  # @option opts [String] :status Status of campaign.
193
- # @option opts [DateTime] :start_date 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 &#39;status&#39; not passed and if passed is set to &#39;sent&#39; )
194
- # @option opts [DateTime] :end_date 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 &#39;status&#39; not passed and if passed is set to &#39;sent&#39; )
204
+ # @option opts [String] :start_date 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 &#39;status&#39; not passed and if passed is set to &#39;sent&#39; )
205
+ # @option opts [String] :end_date 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 &#39;status&#39; not passed and if passed is set to &#39;sent&#39; )
195
206
  # @option opts [Integer] :limit Number limitation for the result returned
196
207
  # @option opts [Integer] :offset Beginning point in the list to retrieve from.
208
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
197
209
  # @return [Array<(GetSmsCampaigns, Fixnum, Hash)>] GetSmsCampaigns data, response status code and response headers
198
210
  def get_sms_campaigns_with_http_info(opts = {})
199
211
  if @api_client.config.debugging
@@ -206,6 +218,9 @@ module SibApiV3Sdk
206
218
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMSCampaignsApi.get_sms_campaigns, must be smaller than or equal to 1000.'
207
219
  end
208
220
 
221
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
222
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
223
+ end
209
224
  # resource path
210
225
  local_var_path = '/smsCampaigns'
211
226
 
@@ -216,6 +231,7 @@ module SibApiV3Sdk
216
231
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
217
232
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
218
233
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
234
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
219
235
 
220
236
  # header parameters
221
237
  header_params = {}
@@ -6,7 +6,7 @@
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.4.12
9
+ Swagger Codegen version: 2.4.19
10
10
 
11
11
  =end
12
12
 
@@ -19,6 +19,69 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+
23
+ # Set custom user_agent if explicitly passed in api
24
+ # default will still remain Swagger-Codegen/#{VERSION}/ruby
25
+ def setUserAgent(user_agent)
26
+ @user_agent = user_agent
27
+ if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
28
+ @api_client.default_headers['User-Agent'] = @user_agent
29
+ end
30
+ end
31
+
32
+ # Add a new domain to the list of blocked domains
33
+ # Blocks a new domain in order to avoid messages being sent to the same
34
+ # @param block_domain
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [nil]
37
+ def block_new_domain(block_domain, opts = {})
38
+ block_new_domain_with_http_info(block_domain, opts)
39
+ nil
40
+ end
41
+
42
+ # Add a new domain to the list of blocked domains
43
+ # Blocks a new domain in order to avoid messages being sent to the same
44
+ # @param block_domain
45
+ # @param [Hash] opts the optional parameters
46
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
47
+ def block_new_domain_with_http_info(block_domain, opts = {})
48
+ if @api_client.config.debugging
49
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.block_new_domain ...'
50
+ end
51
+ # verify the required parameter 'block_domain' is set
52
+ if @api_client.config.client_side_validation && block_domain.nil?
53
+ fail ArgumentError, "Missing the required parameter 'block_domain' when calling TransactionalEmailsApi.block_new_domain"
54
+ end
55
+ # resource path
56
+ local_var_path = '/smtp/blockedDomains'
57
+
58
+ # query parameters
59
+ query_params = {}
60
+
61
+ # header parameters
62
+ header_params = {}
63
+ # HTTP header 'Accept' (if needed)
64
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
65
+ # HTTP header 'Content-Type'
66
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
67
+
68
+ # form parameters
69
+ form_params = {}
70
+
71
+ # http body (model)
72
+ post_body = @api_client.object_to_http_body(block_domain)
73
+ auth_names = ['api-key', 'partner-key']
74
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names)
80
+ if @api_client.config.debugging
81
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#block_new_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
82
+ end
83
+ return data, status_code, headers
84
+ end
22
85
  # Create an email template
23
86
  # @param smtp_template values to update in transactional email template
24
87
  # @param [Hash] opts the optional parameters
@@ -71,6 +134,59 @@ module SibApiV3Sdk
71
134
  end
72
135
  return data, status_code, headers
73
136
  end
137
+ # Unblock an existing domain from the list of blocked domains
138
+ # Unblocks an existing domain from the list of blocked domains
139
+ # @param domain The name of the domain to be deleted
140
+ # @param [Hash] opts the optional parameters
141
+ # @return [nil]
142
+ def delete_blocked_domain(domain, opts = {})
143
+ delete_blocked_domain_with_http_info(domain, opts)
144
+ nil
145
+ end
146
+
147
+ # Unblock an existing domain from the list of blocked domains
148
+ # Unblocks an existing domain from the list of blocked domains
149
+ # @param domain The name of the domain to be deleted
150
+ # @param [Hash] opts the optional parameters
151
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
152
+ def delete_blocked_domain_with_http_info(domain, opts = {})
153
+ if @api_client.config.debugging
154
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.delete_blocked_domain ...'
155
+ end
156
+ # verify the required parameter 'domain' is set
157
+ if @api_client.config.client_side_validation && domain.nil?
158
+ fail ArgumentError, "Missing the required parameter 'domain' when calling TransactionalEmailsApi.delete_blocked_domain"
159
+ end
160
+ # resource path
161
+ local_var_path = '/smtp/blockedDomains/{domain}'.sub('{' + 'domain' + '}', domain.to_s)
162
+
163
+ # query parameters
164
+ query_params = {}
165
+
166
+ # header parameters
167
+ header_params = {}
168
+ # HTTP header 'Accept' (if needed)
169
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
170
+ # HTTP header 'Content-Type'
171
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
172
+
173
+ # form parameters
174
+ form_params = {}
175
+
176
+ # http body (model)
177
+ post_body = nil
178
+ auth_names = ['api-key', 'partner-key']
179
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
180
+ :header_params => header_params,
181
+ :query_params => query_params,
182
+ :form_params => form_params,
183
+ :body => post_body,
184
+ :auth_names => auth_names)
185
+ if @api_client.config.debugging
186
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#delete_blocked_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
187
+ end
188
+ return data, status_code, headers
189
+ end
74
190
  # Delete hardbounces
75
191
  # Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
76
192
  # @param [Hash] opts the optional parameters
@@ -229,6 +345,54 @@ module SibApiV3Sdk
229
345
  end
230
346
  return data, status_code, headers
231
347
  end
348
+ # Get the list of blocked domains
349
+ # Get the list of blocked domains
350
+ # @param [Hash] opts the optional parameters
351
+ # @return [GetBlockedDomains]
352
+ def get_blocked_domains(opts = {})
353
+ data, _status_code, _headers = get_blocked_domains_with_http_info(opts)
354
+ data
355
+ end
356
+
357
+ # Get the list of blocked domains
358
+ # Get the list of blocked domains
359
+ # @param [Hash] opts the optional parameters
360
+ # @return [Array<(GetBlockedDomains, Fixnum, Hash)>] GetBlockedDomains data, response status code and response headers
361
+ def get_blocked_domains_with_http_info(opts = {})
362
+ if @api_client.config.debugging
363
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.get_blocked_domains ...'
364
+ end
365
+ # resource path
366
+ local_var_path = '/smtp/blockedDomains'
367
+
368
+ # query parameters
369
+ query_params = {}
370
+
371
+ # header parameters
372
+ header_params = {}
373
+ # HTTP header 'Accept' (if needed)
374
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
375
+ # HTTP header 'Content-Type'
376
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
377
+
378
+ # form parameters
379
+ form_params = {}
380
+
381
+ # http body (model)
382
+ post_body = nil
383
+ auth_names = ['api-key', 'partner-key']
384
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
385
+ :header_params => header_params,
386
+ :query_params => query_params,
387
+ :form_params => form_params,
388
+ :body => post_body,
389
+ :auth_names => auth_names,
390
+ :return_type => 'GetBlockedDomains')
391
+ if @api_client.config.debugging
392
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#get_blocked_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
393
+ end
394
+ return data, status_code, headers
395
+ end
232
396
  # Get all your transactional email activity (unaggregated events)
233
397
  # @param [Hash] opts the optional parameters
234
398
  # @option opts [Integer] :limit Number limitation for the result returned (default to 50)
@@ -241,6 +405,7 @@ module SibApiV3Sdk
241
405
  # @option opts [String] :tags Filter the report for tags (serialized and urlencoded array)
242
406
  # @option opts [String] :message_id Filter on a specific message id
243
407
  # @option opts [Integer] :template_id Filter on a specific template id
408
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
244
409
  # @return [GetEmailEventReport]
245
410
  def get_email_event_report(opts = {})
246
411
  data, _status_code, _headers = get_email_event_report_with_http_info(opts)
@@ -259,6 +424,7 @@ module SibApiV3Sdk
259
424
  # @option opts [String] :tags Filter the report for tags (serialized and urlencoded array)
260
425
  # @option opts [String] :message_id Filter on a specific message id
261
426
  # @option opts [Integer] :template_id Filter on a specific template id
427
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
262
428
  # @return [Array<(GetEmailEventReport, Fixnum, Hash)>] GetEmailEventReport data, response status code and response headers
263
429
  def get_email_event_report_with_http_info(opts = {})
264
430
  if @api_client.config.debugging
@@ -268,8 +434,11 @@ module SibApiV3Sdk
268
434
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_email_event_report, must be smaller than or equal to 100.'
269
435
  end
270
436
 
271
- if @api_client.config.client_side_validation && opts[:'event'] && !['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked', 'unsubscribed'].include?(opts[:'event'])
272
- fail ArgumentError, 'invalid value for "event", must be one of bounces, hardBounces, softBounces, delivered, spam, requests, opened, clicks, invalid, deferred, blocked, unsubscribed'
437
+ if @api_client.config.client_side_validation && opts[:'event'] && !['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked', 'unsubscribed', 'error'].include?(opts[:'event'])
438
+ fail ArgumentError, 'invalid value for "event", must be one of bounces, hardBounces, softBounces, delivered, spam, requests, opened, clicks, invalid, deferred, blocked, unsubscribed, error'
439
+ end
440
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
441
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
273
442
  end
274
443
  # resource path
275
444
  local_var_path = '/smtp/statistics/events'
@@ -286,6 +455,7 @@ module SibApiV3Sdk
286
455
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
287
456
  query_params[:'messageId'] = opts[:'message_id'] if !opts[:'message_id'].nil?
288
457
  query_params[:'templateId'] = opts[:'template_id'] if !opts[:'template_id'].nil?
458
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
289
459
 
290
460
  # header parameters
291
461
  header_params = {}
@@ -320,6 +490,7 @@ module SibApiV3Sdk
320
490
  # @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
321
491
  # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
322
492
  # @option opts [String] :tag Tag of the emails
493
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
323
494
  # @return [GetReports]
324
495
  def get_smtp_report(opts = {})
325
496
  data, _status_code, _headers = get_smtp_report_with_http_info(opts)
@@ -334,6 +505,7 @@ module SibApiV3Sdk
334
505
  # @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
335
506
  # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
336
507
  # @option opts [String] :tag Tag of the emails
508
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
337
509
  # @return [Array<(GetReports, Fixnum, Hash)>] GetReports data, response status code and response headers
338
510
  def get_smtp_report_with_http_info(opts = {})
339
511
  if @api_client.config.debugging
@@ -343,6 +515,9 @@ module SibApiV3Sdk
343
515
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_smtp_report, must be smaller than or equal to 30.'
344
516
  end
345
517
 
518
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
519
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
520
+ end
346
521
  # resource path
347
522
  local_var_path = '/smtp/statistics/reports'
348
523
 
@@ -354,6 +529,7 @@ module SibApiV3Sdk
354
529
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
355
530
  query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
356
531
  query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
532
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
357
533
 
358
534
  # header parameters
359
535
  header_params = {}
@@ -437,6 +613,7 @@ module SibApiV3Sdk
437
613
  # @option opts [BOOLEAN] :template_status Filter on the status of the template. Active &#x3D; true, inactive &#x3D; false
438
614
  # @option opts [Integer] :limit Number of documents returned per page (default to 50)
439
615
  # @option opts [Integer] :offset Index of the first document in the page (default to 0)
616
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
440
617
  # @return [GetSmtpTemplates]
441
618
  def get_smtp_templates(opts = {})
442
619
  data, _status_code, _headers = get_smtp_templates_with_http_info(opts)
@@ -448,6 +625,7 @@ module SibApiV3Sdk
448
625
  # @option opts [BOOLEAN] :template_status Filter on the status of the template. Active &#x3D; true, inactive &#x3D; false
449
626
  # @option opts [Integer] :limit Number of documents returned per page
450
627
  # @option opts [Integer] :offset Index of the first document in the page
628
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
451
629
  # @return [Array<(GetSmtpTemplates, Fixnum, Hash)>] GetSmtpTemplates data, response status code and response headers
452
630
  def get_smtp_templates_with_http_info(opts = {})
453
631
  if @api_client.config.debugging
@@ -457,6 +635,9 @@ module SibApiV3Sdk
457
635
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_smtp_templates, must be smaller than or equal to 1000.'
458
636
  end
459
637
 
638
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
639
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
640
+ end
460
641
  # resource path
461
642
  local_var_path = '/smtp/templates'
462
643
 
@@ -465,6 +646,7 @@ module SibApiV3Sdk
465
646
  query_params[:'templateStatus'] = opts[:'template_status'] if !opts[:'template_status'].nil?
466
647
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
467
648
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
649
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
468
650
 
469
651
  # header parameters
470
652
  header_params = {}
@@ -498,6 +680,7 @@ module SibApiV3Sdk
498
680
  # @option opts [Integer] :limit Number of documents returned per page (default to 50)
499
681
  # @option opts [Integer] :offset Index of the first document on the page (default to 0)
500
682
  # @option opts [Array<String>] :senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
683
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
501
684
  # @return [GetTransacBlockedContacts]
502
685
  def get_transac_blocked_contacts(opts = {})
503
686
  data, _status_code, _headers = get_transac_blocked_contacts_with_http_info(opts)
@@ -511,6 +694,7 @@ module SibApiV3Sdk
511
694
  # @option opts [Integer] :limit Number of documents returned per page
512
695
  # @option opts [Integer] :offset Index of the first document on the page
513
696
  # @option opts [Array<String>] :senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
697
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
514
698
  # @return [Array<(GetTransacBlockedContacts, Fixnum, Hash)>] GetTransacBlockedContacts data, response status code and response headers
515
699
  def get_transac_blocked_contacts_with_http_info(opts = {})
516
700
  if @api_client.config.debugging
@@ -520,6 +704,9 @@ module SibApiV3Sdk
520
704
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_transac_blocked_contacts, must be smaller than or equal to 100.'
521
705
  end
522
706
 
707
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
708
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
709
+ end
523
710
  # resource path
524
711
  local_var_path = '/smtp/blockedContacts'
525
712
 
@@ -530,6 +717,7 @@ module SibApiV3Sdk
530
717
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
531
718
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
532
719
  query_params[:'senders'] = @api_client.build_collection_param(opts[:'senders'], :csv) if !opts[:'senders'].nil?
720
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
533
721
 
534
722
  # header parameters
535
723
  header_params = {}
@@ -614,8 +802,11 @@ module SibApiV3Sdk
614
802
  # @option opts [String] :email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
615
803
  # @option opts [Integer] :template_id Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
616
804
  # @option opts [String] :message_id Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
617
- # @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
618
- # @option opts [Date] :end_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.
805
+ # @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
806
+ # @option opts [String] :end_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.
807
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
808
+ # @option opts [Integer] :limit Number of documents returned per page (default to 500)
809
+ # @option opts [Integer] :offset Index of the first document in the page (default to 0)
619
810
  # @return [GetTransacEmailsList]
620
811
  def get_transac_emails_list(opts = {})
621
812
  data, _status_code, _headers = get_transac_emails_list_with_http_info(opts)
@@ -628,13 +819,23 @@ module SibApiV3Sdk
628
819
  # @option opts [String] :email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
629
820
  # @option opts [Integer] :template_id Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
630
821
  # @option opts [String] :message_id Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
631
- # @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
632
- # @option opts [Date] :end_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.
822
+ # @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
823
+ # @option opts [String] :end_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.
824
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
825
+ # @option opts [Integer] :limit Number of documents returned per page
826
+ # @option opts [Integer] :offset Index of the first document in the page
633
827
  # @return [Array<(GetTransacEmailsList, Fixnum, Hash)>] GetTransacEmailsList data, response status code and response headers
634
828
  def get_transac_emails_list_with_http_info(opts = {})
635
829
  if @api_client.config.debugging
636
830
  @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.get_transac_emails_list ...'
637
831
  end
832
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
833
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
834
+ end
835
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
836
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_transac_emails_list, must be smaller than or equal to 1000.'
837
+ end
838
+
638
839
  # resource path
639
840
  local_var_path = '/smtp/emails'
640
841
 
@@ -645,6 +846,9 @@ module SibApiV3Sdk
645
846
  query_params[:'messageId'] = opts[:'message_id'] if !opts[:'message_id'].nil?
646
847
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
647
848
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
849
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
850
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
851
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
648
852
 
649
853
  # header parameters
650
854
  header_params = {}