sib-api-v3-sdk 5.2.3 → 5.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (457) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/LICENSE.md +1 -1
  4. data/README.md +96 -68
  5. data/docs/AbTestCampaignResult.md +13 -0
  6. data/docs/AccountApi.md +3 -3
  7. data/docs/AddContactToList.md +1 -1
  8. data/docs/AttributesApi.md +18 -18
  9. data/docs/ContactsApi.md +123 -60
  10. data/docs/CreateAttribute.md +1 -1
  11. data/docs/CreateChild.md +1 -0
  12. data/docs/CreateContact.md +3 -3
  13. data/docs/CreateDoiContact.md +13 -0
  14. data/docs/CreateEmailCampaign.md +6 -3
  15. data/docs/CreateEmailCampaignSender.md +1 -0
  16. data/docs/CreateReseller.md +1 -0
  17. data/docs/CreateSender.md +1 -1
  18. data/docs/CreateSmtpEmail.md +1 -1
  19. data/docs/CreateSmtpTemplate.md +1 -1
  20. data/docs/CreateSmtpTemplateSender.md +1 -0
  21. data/docs/CreateWebhook.md +2 -2
  22. data/docs/EmailCampaignsApi.md +202 -25
  23. data/docs/EmailExportRecipients.md +1 -1
  24. data/docs/FoldersApi.md +12 -12
  25. data/docs/GetAccountRelay.md +1 -1
  26. data/docs/GetAccountRelayData.md +1 -1
  27. data/docs/GetChildAccountCreationStatus.md +8 -0
  28. data/docs/GetChildrenList.md +1 -0
  29. data/docs/GetDeviceBrowserStats.md +11 -0
  30. data/docs/GetEmailCampaign.md +1 -0
  31. data/docs/GetExtendedCampaignOverview.md +1 -0
  32. data/docs/GetExtendedCampaignOverviewSender.md +1 -0
  33. data/docs/GetExtendedCampaignStats.md +2 -0
  34. data/docs/GetSharedTemplateUrl.md +8 -0
  35. data/docs/GetSmtpTemplateOverview.md +1 -0
  36. data/docs/GetSmtpTemplateOverviewSender.md +1 -0
  37. data/docs/GetSmtpTemplates.md +1 -1
  38. data/docs/GetStatsByBrowser.md +7 -0
  39. data/docs/GetStatsByDevice.md +11 -0
  40. data/docs/GetTransacBlockedContacts.md +9 -0
  41. data/docs/GetTransacBlockedContactsContacts.md +11 -0
  42. data/docs/GetTransacBlockedContactsReason.md +9 -0
  43. data/docs/GetTransacEmailContent.md +14 -0
  44. data/docs/GetTransacEmailContentEvents.md +9 -0
  45. data/docs/GetTransacEmailsList.md +8 -0
  46. data/docs/GetTransacEmailsListTransactionalEmails.md +15 -0
  47. data/docs/ListsApi.md +13 -13
  48. data/docs/PostContactInfoContacts.md +1 -0
  49. data/docs/RemainingCreditModelChild.md +2 -2
  50. data/docs/RemainingCreditModelReseller.md +2 -2
  51. data/docs/RemoveContactFromList.md +2 -2
  52. data/docs/RequestContactExport.md +3 -2
  53. data/docs/RequestContactExportCustomContactFilter.md +13 -0
  54. data/docs/RequestContactImport.md +2 -2
  55. data/docs/RequestSMSRecipientExport.md +1 -1
  56. data/docs/ResellerApi.md +215 -86
  57. data/docs/SMSCampaignsApi.md +24 -24
  58. data/docs/SMTPApi.md +350 -42
  59. data/docs/SendEmail.md +2 -2
  60. data/docs/SendReport.md +1 -1
  61. data/docs/SendReportEmail.md +1 -1
  62. data/docs/SendSmtpEmail.md +4 -4
  63. data/docs/SendSmtpEmailBcc.md +1 -1
  64. data/docs/SendSmtpEmailCc.md +1 -1
  65. data/docs/SendSmtpEmailReplyTo.md +1 -1
  66. data/docs/SendSmtpEmailSender.md +1 -1
  67. data/docs/SendSmtpEmailTo.md +1 -1
  68. data/docs/SendTransacSms.md +1 -1
  69. data/docs/SendersApi.md +8 -8
  70. data/docs/TransactionalSMSApi.md +17 -17
  71. data/docs/UpdateAttribute.md +1 -1
  72. data/docs/UpdateChildAccountStatus.md +11 -0
  73. data/docs/UpdateContact.md +2 -2
  74. data/docs/UpdateEmailCampaign.md +5 -2
  75. data/docs/UpdateEmailCampaignSender.md +1 -0
  76. data/docs/UpdateSmtpTemplate.md +1 -1
  77. data/docs/UpdateSmtpTemplateSender.md +1 -0
  78. data/docs/UploadImageToGallery.md +9 -0
  79. data/docs/WebhooksApi.md +1 -1
  80. data/lib/sib-api-v3-sdk.rb +19 -2
  81. data/lib/sib-api-v3-sdk/api/account_api.rb +8 -11
  82. data/lib/sib-api-v3-sdk/api/attributes_api.rb +23 -35
  83. data/lib/sib-api-v3-sdk/api/contacts_api.rb +169 -186
  84. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +204 -73
  85. data/lib/sib-api-v3-sdk/api/folders_api.rb +29 -47
  86. data/lib/sib-api-v3-sdk/api/lists_api.rb +38 -65
  87. data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
  88. data/lib/sib-api-v3-sdk/api/reseller_api.rb +280 -201
  89. data/lib/sib-api-v3-sdk/api/senders_api.rb +25 -43
  90. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +47 -73
  91. data/lib/sib-api-v3-sdk/api/smtp_api.rb +342 -92
  92. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +19 -31
  93. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
  94. data/lib/sib-api-v3-sdk/api_client.rb +10 -10
  95. data/lib/sib-api-v3-sdk/api_error.rb +2 -2
  96. data/lib/sib-api-v3-sdk/configuration.rb +3 -3
  97. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +280 -0
  98. data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
  99. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +8 -13
  100. data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
  101. data/lib/sib-api-v3-sdk/models/create_attribute.rb +11 -15
  102. data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
  103. data/lib/sib-api-v3-sdk/models/create_child.rb +58 -19
  104. data/lib/sib-api-v3-sdk/models/create_contact.rb +10 -15
  105. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +253 -0
  106. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +82 -32
  107. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
  108. data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
  109. data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
  110. data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
  111. data/lib/sib-api-v3-sdk/models/create_reseller.rb +20 -15
  112. data/lib/sib-api-v3-sdk/models/create_sender.rb +10 -15
  113. data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
  114. data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
  115. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +13 -18
  116. data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
  117. data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +9 -14
  118. data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +11 -16
  119. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
  120. data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
  121. data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
  122. data/lib/sib-api-v3-sdk/models/create_webhook.rb +14 -18
  123. data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
  124. data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
  125. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +12 -16
  126. data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
  127. data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
  128. data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
  129. data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
  130. data/lib/sib-api-v3-sdk/models/get_account_relay.rb +11 -15
  131. data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +12 -16
  132. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +20 -25
  133. data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
  134. data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
  135. data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
  136. data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
  137. data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
  138. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +17 -22
  139. data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
  140. data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
  141. data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
  142. data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
  143. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
  144. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
  145. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
  146. data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
  147. data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
  148. data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
  149. data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
  150. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
  151. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
  152. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
  153. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
  154. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
  155. data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
  156. data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
  157. data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
  158. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +40 -34
  159. data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
  160. data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
  161. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
  162. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +40 -34
  163. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
  164. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
  165. data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
  166. data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
  167. data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
  168. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
  169. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
  170. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
  171. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
  172. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
  173. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
  174. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +9 -14
  175. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +10 -15
  176. data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
  177. data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
  178. data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
  179. data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
  180. data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
  181. data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
  182. data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
  183. data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
  184. data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
  185. data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
  186. data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
  187. data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
  188. data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
  189. data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
  190. data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
  191. data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
  192. data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
  193. data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
  194. data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
  195. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
  196. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
  197. data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
  198. data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
  199. data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
  200. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
  201. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +31 -26
  202. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
  203. data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +8 -13
  204. data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
  205. data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
  206. data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
  207. data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
  208. data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
  209. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
  210. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
  211. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
  212. data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +276 -0
  213. data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +204 -0
  214. data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +185 -0
  215. data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +281 -0
  216. data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
  217. data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
  218. data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
  219. data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
  220. data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
  221. data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
  222. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +19 -14
  223. data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
  224. data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
  225. data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
  226. data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +11 -15
  227. data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +11 -16
  228. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +9 -14
  229. data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
  230. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +19 -20
  231. data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
  232. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +9 -14
  233. data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
  234. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +12 -16
  235. data/lib/sib-api-v3-sdk/models/send_email.rb +10 -15
  236. data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
  237. data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
  238. data/lib/sib-api-v3-sdk/models/send_report_email.rb +14 -17
  239. data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
  240. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +12 -17
  241. data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
  242. data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
  243. data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
  244. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +10 -14
  245. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +10 -14
  246. data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
  247. data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
  248. data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
  249. data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
  250. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +17 -21
  251. data/lib/sib-api-v3-sdk/models/update_attribute.rb +8 -13
  252. data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
  253. data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
  254. data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
  255. data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +214 -0
  256. data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
  257. data/lib/sib-api-v3-sdk/models/update_contact.rb +9 -14
  258. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +79 -29
  259. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
  260. data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
  261. data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
  262. data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
  263. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +9 -15
  264. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +8 -13
  265. data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
  266. data/lib/sib-api-v3-sdk/models/update_webhook.rb +7 -11
  267. data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
  268. data/lib/sib-api-v3-sdk/version.rb +3 -3
  269. data/sib-api-v3-sdk.gemspec +5 -5
  270. data/spec/api/account_api_spec.rb +4 -5
  271. data/spec/api/attributes_api_spec.rb +10 -14
  272. data/spec/api/contacts_api_spec.rb +57 -68
  273. data/spec/api/email_campaigns_api_spec.rb +54 -28
  274. data/spec/api/folders_api_spec.rb +12 -18
  275. data/spec/api/lists_api_spec.rb +15 -24
  276. data/spec/api/process_api_spec.rb +4 -6
  277. data/spec/api/reseller_api_spec.rb +64 -52
  278. data/spec/api/senders_api_spec.rb +10 -16
  279. data/spec/api/sms_campaigns_api_spec.rb +19 -27
  280. data/spec/api/smtp_api_spec.rb +88 -34
  281. data/spec/api/transactional_sms_api_spec.rb +8 -12
  282. data/spec/api/webhooks_api_spec.rb +7 -12
  283. data/spec/api_client_spec.rb +36 -36
  284. data/spec/configuration_spec.rb +10 -10
  285. data/spec/models/ab_test_campaign_result_spec.rb +79 -0
  286. data/spec/models/add_child_domain_spec.rb +3 -4
  287. data/spec/models/add_contact_to_list_spec.rb +3 -4
  288. data/spec/models/add_credits_spec.rb +4 -5
  289. data/spec/models/create_attribute_enumeration_spec.rb +4 -5
  290. data/spec/models/create_attribute_spec.rb +9 -10
  291. data/spec/models/create_child_spec.rb +17 -8
  292. data/spec/models/create_contact_spec.rb +9 -10
  293. data/spec/models/create_doi_contact_spec.rb +71 -0
  294. data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
  295. data/spec/models/create_email_campaign_sender_spec.rb +10 -5
  296. data/spec/models/create_email_campaign_spec.rb +49 -32
  297. data/spec/models/create_list_spec.rb +4 -5
  298. data/spec/models/create_model_spec.rb +3 -4
  299. data/spec/models/create_reseller_spec.rb +9 -4
  300. data/spec/models/create_sender_ips_spec.rb +5 -6
  301. data/spec/models/create_sender_model_spec.rb +5 -6
  302. data/spec/models/create_sender_spec.rb +5 -6
  303. data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
  304. data/spec/models/create_sms_campaign_spec.rb +7 -8
  305. data/spec/models/create_smtp_email_spec.rb +3 -4
  306. data/spec/models/create_smtp_template_sender_spec.rb +10 -5
  307. data/spec/models/create_smtp_template_spec.rb +12 -13
  308. data/spec/models/create_update_contact_model_spec.rb +3 -4
  309. data/spec/models/create_update_folder_spec.rb +3 -4
  310. data/spec/models/create_webhook_spec.rb +14 -15
  311. data/spec/models/created_process_id_spec.rb +3 -4
  312. data/spec/models/delete_hardbounces_spec.rb +5 -6
  313. data/spec/models/email_export_recipients_spec.rb +8 -9
  314. data/spec/models/error_model_spec.rb +8 -9
  315. data/spec/models/get_account_marketing_automation_spec.rb +4 -5
  316. data/spec/models/get_account_plan_spec.rb +16 -17
  317. data/spec/models/get_account_relay_data_spec.rb +5 -6
  318. data/spec/models/get_account_relay_spec.rb +4 -5
  319. data/spec/models/get_account_spec.rb +10 -11
  320. data/spec/models/get_aggregated_report_spec.rb +15 -16
  321. data/spec/models/get_attributes_attributes_spec.rb +15 -16
  322. data/spec/models/get_attributes_enumeration_spec.rb +4 -5
  323. data/spec/models/get_attributes_spec.rb +3 -4
  324. data/spec/models/get_campaign_overview_spec.rb +23 -24
  325. data/spec/models/get_campaign_recipients_spec.rb +4 -5
  326. data/spec/models/get_campaign_stats_spec.rb +14 -15
  327. data/spec/models/get_child_account_creation_status_spec.rb +41 -0
  328. data/spec/models/get_child_domain_spec.rb +4 -5
  329. data/spec/models/get_child_domains_spec.rb +2 -3
  330. data/spec/models/get_child_info_api_keys_spec.rb +4 -5
  331. data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
  332. data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
  333. data/spec/models/get_child_info_credits_spec.rb +4 -5
  334. data/spec/models/get_child_info_spec.rb +11 -12
  335. data/spec/models/get_child_info_statistics_spec.rb +5 -6
  336. data/spec/models/get_children_list_spec.rb +9 -4
  337. data/spec/models/get_client_spec.rb +6 -7
  338. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
  339. data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
  340. data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
  341. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
  342. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
  343. data/spec/models/get_contact_details_spec.rb +11 -12
  344. data/spec/models/get_contacts_spec.rb +4 -5
  345. data/spec/models/get_device_browser_stats_spec.rb +59 -0
  346. data/spec/models/get_email_campaign_spec.rb +46 -41
  347. data/spec/models/get_email_campaigns_spec.rb +4 -5
  348. data/spec/models/get_email_event_report_events_spec.rb +16 -17
  349. data/spec/models/get_email_event_report_spec.rb +3 -4
  350. data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
  351. data/spec/models/get_extended_campaign_overview_spec.rb +44 -39
  352. data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
  353. data/spec/models/get_extended_client_address_spec.rb +6 -7
  354. data/spec/models/get_extended_client_spec.rb +7 -8
  355. data/spec/models/get_extended_contact_details_spec.rb +12 -13
  356. data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
  357. data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
  358. data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
  359. data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
  360. data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
  361. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
  362. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
  363. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
  364. data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
  365. data/spec/models/get_extended_list_spec.rb +10 -11
  366. data/spec/models/get_folder_lists_spec.rb +4 -5
  367. data/spec/models/get_folder_spec.rb +7 -8
  368. data/spec/models/get_folders_spec.rb +4 -5
  369. data/spec/models/get_ip_from_sender_spec.rb +6 -7
  370. data/spec/models/get_ip_spec.rb +6 -7
  371. data/spec/models/get_ips_from_sender_spec.rb +3 -4
  372. data/spec/models/get_ips_spec.rb +3 -4
  373. data/spec/models/get_list_spec.rb +6 -7
  374. data/spec/models/get_lists_spec.rb +4 -5
  375. data/spec/models/get_process_spec.rb +10 -11
  376. data/spec/models/get_processes_spec.rb +4 -5
  377. data/spec/models/get_reports_reports_spec.rb +15 -16
  378. data/spec/models/get_reports_spec.rb +3 -4
  379. data/spec/models/get_senders_list_ips_spec.rb +5 -6
  380. data/spec/models/get_senders_list_senders_spec.rb +7 -8
  381. data/spec/models/get_senders_list_spec.rb +3 -4
  382. data/spec/models/get_shared_template_url_spec.rb +41 -0
  383. data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
  384. data/spec/models/get_sms_campaign_spec.rb +16 -17
  385. data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
  386. data/spec/models/get_sms_campaigns_spec.rb +4 -5
  387. data/spec/models/get_sms_event_report_events_spec.rb +13 -14
  388. data/spec/models/get_sms_event_report_spec.rb +3 -4
  389. data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
  390. data/spec/models/get_smtp_template_overview_spec.rb +20 -15
  391. data/spec/models/get_smtp_templates_spec.rb +4 -5
  392. data/spec/models/get_sso_token_spec.rb +3 -4
  393. data/spec/models/get_stats_by_browser_spec.rb +35 -0
  394. data/spec/models/get_stats_by_device_spec.rb +59 -0
  395. data/spec/models/get_stats_by_domain_spec.rb +2 -3
  396. data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
  397. data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
  398. data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
  399. data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
  400. data/spec/models/get_transac_email_content_events_spec.rb +47 -0
  401. data/spec/models/get_transac_email_content_spec.rb +77 -0
  402. data/spec/models/get_transac_emails_list_spec.rb +41 -0
  403. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +83 -0
  404. data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
  405. data/spec/models/get_transac_sms_report_spec.rb +3 -4
  406. data/spec/models/get_webhook_spec.rb +13 -14
  407. data/spec/models/get_webhooks_spec.rb +3 -4
  408. data/spec/models/manage_ip_spec.rb +3 -4
  409. data/spec/models/post_contact_info_contacts_spec.rb +11 -6
  410. data/spec/models/post_contact_info_spec.rb +3 -4
  411. data/spec/models/post_send_failed_spec.rb +7 -8
  412. data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
  413. data/spec/models/remaining_credit_model_child_spec.rb +4 -5
  414. data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
  415. data/spec/models/remaining_credit_model_spec.rb +4 -5
  416. data/spec/models/remove_contact_from_list_spec.rb +4 -5
  417. data/spec/models/remove_credits_spec.rb +4 -5
  418. data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
  419. data/spec/models/request_contact_export_spec.rb +11 -6
  420. data/spec/models/request_contact_import_new_list_spec.rb +4 -5
  421. data/spec/models/request_contact_import_spec.rb +11 -12
  422. data/spec/models/request_sms_recipient_export_spec.rb +8 -9
  423. data/spec/models/send_email_attachment_spec.rb +4 -5
  424. data/spec/models/send_email_spec.rb +11 -12
  425. data/spec/models/send_report_email_spec.rb +12 -13
  426. data/spec/models/send_report_spec.rb +8 -9
  427. data/spec/models/send_sms_spec.rb +7 -8
  428. data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
  429. data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
  430. data/spec/models/send_smtp_email_cc_spec.rb +4 -5
  431. data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
  432. data/spec/models/send_smtp_email_sender_spec.rb +4 -5
  433. data/spec/models/send_smtp_email_spec.rb +15 -16
  434. data/spec/models/send_smtp_email_to_spec.rb +4 -5
  435. data/spec/models/send_template_email_spec.rb +3 -4
  436. data/spec/models/send_test_email_spec.rb +3 -4
  437. data/spec/models/send_test_sms_spec.rb +3 -4
  438. data/spec/models/send_transac_sms_spec.rb +12 -13
  439. data/spec/models/update_attribute_enumeration_spec.rb +4 -5
  440. data/spec/models/update_attribute_spec.rb +4 -5
  441. data/spec/models/update_campaign_status_spec.rb +7 -8
  442. data/spec/models/update_child_account_status_spec.rb +59 -0
  443. data/spec/models/update_child_domain_spec.rb +3 -4
  444. data/spec/models/update_child_spec.rb +7 -8
  445. data/spec/models/update_contact_spec.rb +8 -9
  446. data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
  447. data/spec/models/update_email_campaign_sender_spec.rb +10 -5
  448. data/spec/models/update_email_campaign_spec.rb +49 -32
  449. data/spec/models/update_list_spec.rb +4 -5
  450. data/spec/models/update_sender_spec.rb +5 -6
  451. data/spec/models/update_sms_campaign_spec.rb +7 -8
  452. data/spec/models/update_smtp_template_sender_spec.rb +10 -5
  453. data/spec/models/update_smtp_template_spec.rb +12 -13
  454. data/spec/models/update_webhook_spec.rb +9 -10
  455. data/spec/models/upload_image_to_gallery_spec.rb +47 -0
  456. data/spec/spec_helper.rb +2 -2
  457. metadata +70 -2
@@ -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 FoldersApi
@@ -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 a folder
24
- #
25
23
  # @param create_folder Name of the folder
26
24
  # @param [Hash] opts the optional parameters
27
25
  # @return [CreateModel]
28
26
  def create_folder(create_folder, opts = {})
29
27
  data, _status_code, _headers = create_folder_with_http_info(create_folder, opts)
30
- return data
28
+ data
31
29
  end
32
30
 
33
31
  # Create a folder
34
- #
35
32
  # @param create_folder Name of the folder
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_folder_with_http_info(create_folder, opts = {})
39
36
  if @api_client.config.debugging
40
- @api_client.config.logger.debug "Calling API: FoldersApi.create_folder ..."
37
+ @api_client.config.logger.debug 'Calling API: FoldersApi.create_folder ...'
41
38
  end
42
39
  # verify the required parameter 'create_folder' is set
43
40
  if @api_client.config.client_side_validation && create_folder.nil?
44
41
  fail ArgumentError, "Missing the required parameter 'create_folder' when calling FoldersApi.create_folder"
45
42
  end
46
43
  # resource path
47
- local_var_path = "/contacts/folders"
44
+ local_var_path = '/contacts/folders'
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 a folder (and all its lists)
79
- #
80
75
  # @param folder_id Id of the folder
81
76
  # @param [Hash] opts the optional parameters
82
77
  # @return [nil]
83
78
  def delete_folder(folder_id, opts = {})
84
79
  delete_folder_with_http_info(folder_id, opts)
85
- return nil
80
+ nil
86
81
  end
87
82
 
88
83
  # Delete a folder (and all its lists)
89
- #
90
84
  # @param folder_id Id of the folder
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_folder_with_http_info(folder_id, opts = {})
94
88
  if @api_client.config.debugging
95
- @api_client.config.logger.debug "Calling API: FoldersApi.delete_folder ..."
89
+ @api_client.config.logger.debug 'Calling API: FoldersApi.delete_folder ...'
96
90
  end
97
91
  # verify the required parameter 'folder_id' is set
98
92
  if @api_client.config.client_side_validation && folder_id.nil?
99
93
  fail ArgumentError, "Missing the required parameter 'folder_id' when calling FoldersApi.delete_folder"
100
94
  end
101
95
  # resource path
102
- local_var_path = "/contacts/folders/{folderId}".sub('{' + 'folderId' + '}', folder_id.to_s)
96
+ local_var_path = '/contacts/folders/{folderId}'.sub('{' + 'folderId' + '}', folder_id.to_s)
103
97
 
104
98
  # query parameters
105
99
  query_params = {}
@@ -128,32 +122,29 @@ module SibApiV3Sdk
128
122
  end
129
123
  return data, status_code, headers
130
124
  end
131
-
132
- # Returns folder details
133
- #
125
+ # Returns a folder's details
134
126
  # @param folder_id id of the folder
135
127
  # @param [Hash] opts the optional parameters
136
128
  # @return [GetFolder]
137
129
  def get_folder(folder_id, opts = {})
138
130
  data, _status_code, _headers = get_folder_with_http_info(folder_id, opts)
139
- return data
131
+ data
140
132
  end
141
133
 
142
- # Returns folder details
143
- #
134
+ # Returns a folder&#39;s details
144
135
  # @param folder_id id of the folder
145
136
  # @param [Hash] opts the optional parameters
146
137
  # @return [Array<(GetFolder, Fixnum, Hash)>] GetFolder data, response status code and response headers
147
138
  def get_folder_with_http_info(folder_id, opts = {})
148
139
  if @api_client.config.debugging
149
- @api_client.config.logger.debug "Calling API: FoldersApi.get_folder ..."
140
+ @api_client.config.logger.debug 'Calling API: FoldersApi.get_folder ...'
150
141
  end
151
142
  # verify the required parameter 'folder_id' is set
152
143
  if @api_client.config.client_side_validation && folder_id.nil?
153
144
  fail ArgumentError, "Missing the required parameter 'folder_id' when calling FoldersApi.get_folder"
154
145
  end
155
146
  # resource path
156
- local_var_path = "/contacts/folders/{folderId}".sub('{' + 'folderId' + '}', folder_id.to_s)
147
+ local_var_path = '/contacts/folders/{folderId}'.sub('{' + 'folderId' + '}', folder_id.to_s)
157
148
 
158
149
  # query parameters
159
150
  query_params = {}
@@ -183,9 +174,7 @@ module SibApiV3Sdk
183
174
  end
184
175
  return data, status_code, headers
185
176
  end
186
-
187
- # Get the lists in a folder
188
- #
177
+ # Get lists in a folder
189
178
  # @param folder_id Id of the folder
190
179
  # @param [Hash] opts the optional parameters
191
180
  # @option opts [Integer] :limit Number of documents per page (default to 10)
@@ -193,11 +182,10 @@ module SibApiV3Sdk
193
182
  # @return [GetFolderLists]
194
183
  def get_folder_lists(folder_id, opts = {})
195
184
  data, _status_code, _headers = get_folder_lists_with_http_info(folder_id, opts)
196
- return data
185
+ data
197
186
  end
198
187
 
199
- # Get the lists in a folder
200
- #
188
+ # Get lists in a folder
201
189
  # @param folder_id Id of the folder
202
190
  # @param [Hash] opts the optional parameters
203
191
  # @option opts [Integer] :limit Number of documents per page
@@ -205,7 +193,7 @@ module SibApiV3Sdk
205
193
  # @return [Array<(GetFolderLists, Fixnum, Hash)>] GetFolderLists data, response status code and response headers
206
194
  def get_folder_lists_with_http_info(folder_id, opts = {})
207
195
  if @api_client.config.debugging
208
- @api_client.config.logger.debug "Calling API: FoldersApi.get_folder_lists ..."
196
+ @api_client.config.logger.debug 'Calling API: FoldersApi.get_folder_lists ...'
209
197
  end
210
198
  # verify the required parameter 'folder_id' is set
211
199
  if @api_client.config.client_side_validation && folder_id.nil?
@@ -216,7 +204,7 @@ module SibApiV3Sdk
216
204
  end
217
205
 
218
206
  # resource path
219
- local_var_path = "/contacts/folders/{folderId}/lists".sub('{' + 'folderId' + '}', folder_id.to_s)
207
+ local_var_path = '/contacts/folders/{folderId}/lists'.sub('{' + 'folderId' + '}', folder_id.to_s)
220
208
 
221
209
  # query parameters
222
210
  query_params = {}
@@ -248,27 +236,24 @@ module SibApiV3Sdk
248
236
  end
249
237
  return data, status_code, headers
250
238
  end
251
-
252
- # Get all the folders
253
- #
239
+ # Get all folders
254
240
  # @param limit Number of documents per page
255
241
  # @param offset Index of the first document of the page
256
242
  # @param [Hash] opts the optional parameters
257
243
  # @return [GetFolders]
258
244
  def get_folders(limit, offset, opts = {})
259
245
  data, _status_code, _headers = get_folders_with_http_info(limit, offset, opts)
260
- return data
246
+ data
261
247
  end
262
248
 
263
- # Get all the folders
264
- #
249
+ # Get all folders
265
250
  # @param limit Number of documents per page
266
251
  # @param offset Index of the first document of the page
267
252
  # @param [Hash] opts the optional parameters
268
253
  # @return [Array<(GetFolders, Fixnum, Hash)>] GetFolders data, response status code and response headers
269
254
  def get_folders_with_http_info(limit, offset, opts = {})
270
255
  if @api_client.config.debugging
271
- @api_client.config.logger.debug "Calling API: FoldersApi.get_folders ..."
256
+ @api_client.config.logger.debug 'Calling API: FoldersApi.get_folders ...'
272
257
  end
273
258
  # verify the required parameter 'limit' is set
274
259
  if @api_client.config.client_side_validation && limit.nil?
@@ -283,7 +268,7 @@ module SibApiV3Sdk
283
268
  fail ArgumentError, "Missing the required parameter 'offset' when calling FoldersApi.get_folders"
284
269
  end
285
270
  # resource path
286
- local_var_path = "/contacts/folders"
271
+ local_var_path = '/contacts/folders'
287
272
 
288
273
  # query parameters
289
274
  query_params = {}
@@ -315,27 +300,24 @@ module SibApiV3Sdk
315
300
  end
316
301
  return data, status_code, headers
317
302
  end
318
-
319
- # Update a contact folder
320
- #
303
+ # Update a folder
321
304
  # @param folder_id Id of the folder
322
305
  # @param update_folder Name of the folder
323
306
  # @param [Hash] opts the optional parameters
324
307
  # @return [nil]
325
308
  def update_folder(folder_id, update_folder, opts = {})
326
309
  update_folder_with_http_info(folder_id, update_folder, opts)
327
- return nil
310
+ nil
328
311
  end
329
312
 
330
- # Update a contact folder
331
- #
313
+ # Update a folder
332
314
  # @param folder_id Id of the folder
333
315
  # @param update_folder Name of the folder
334
316
  # @param [Hash] opts the optional parameters
335
317
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
336
318
  def update_folder_with_http_info(folder_id, update_folder, opts = {})
337
319
  if @api_client.config.debugging
338
- @api_client.config.logger.debug "Calling API: FoldersApi.update_folder ..."
320
+ @api_client.config.logger.debug 'Calling API: FoldersApi.update_folder ...'
339
321
  end
340
322
  # verify the required parameter 'folder_id' is set
341
323
  if @api_client.config.client_side_validation && folder_id.nil?
@@ -346,7 +328,7 @@ module SibApiV3Sdk
346
328
  fail ArgumentError, "Missing the required parameter 'update_folder' when calling FoldersApi.update_folder"
347
329
  end
348
330
  # resource path
349
- local_var_path = "/contacts/folders/{folderId}".sub('{' + 'folderId' + '}', folder_id.to_s)
331
+ local_var_path = '/contacts/folders/{folderId}'.sub('{' + 'folderId' + '}', folder_id.to_s)
350
332
 
351
333
  # query parameters
352
334
  query_params = {}
@@ -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 ListsApi
@@ -19,27 +19,24 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
-
23
22
  # Add existing contacts to a list
24
- #
25
23
  # @param list_id Id of the list
26
24
  # @param contact_emails Emails addresses of the contacts
27
25
  # @param [Hash] opts the optional parameters
28
26
  # @return [PostContactInfo]
29
27
  def add_contact_to_list(list_id, contact_emails, opts = {})
30
28
  data, _status_code, _headers = add_contact_to_list_with_http_info(list_id, contact_emails, opts)
31
- return data
29
+ data
32
30
  end
33
31
 
34
32
  # Add existing contacts to a list
35
- #
36
33
  # @param list_id Id of the list
37
34
  # @param contact_emails Emails addresses of the contacts
38
35
  # @param [Hash] opts the optional parameters
39
36
  # @return [Array<(PostContactInfo, Fixnum, Hash)>] PostContactInfo data, response status code and response headers
40
37
  def add_contact_to_list_with_http_info(list_id, contact_emails, opts = {})
41
38
  if @api_client.config.debugging
42
- @api_client.config.logger.debug "Calling API: ListsApi.add_contact_to_list ..."
39
+ @api_client.config.logger.debug 'Calling API: ListsApi.add_contact_to_list ...'
43
40
  end
44
41
  # verify the required parameter 'list_id' is set
45
42
  if @api_client.config.client_side_validation && list_id.nil?
@@ -50,7 +47,7 @@ module SibApiV3Sdk
50
47
  fail ArgumentError, "Missing the required parameter 'contact_emails' when calling ListsApi.add_contact_to_list"
51
48
  end
52
49
  # resource path
53
- local_var_path = "/contacts/lists/{listId}/contacts/add".sub('{' + 'listId' + '}', list_id.to_s)
50
+ local_var_path = '/contacts/lists/{listId}/contacts/add'.sub('{' + 'listId' + '}', list_id.to_s)
54
51
 
55
52
  # query parameters
56
53
  query_params = {}
@@ -80,32 +77,29 @@ module SibApiV3Sdk
80
77
  end
81
78
  return data, status_code, headers
82
79
  end
83
-
84
80
  # Create a list
85
- #
86
81
  # @param create_list Values to create a list
87
82
  # @param [Hash] opts the optional parameters
88
83
  # @return [CreateModel]
89
84
  def create_list(create_list, opts = {})
90
85
  data, _status_code, _headers = create_list_with_http_info(create_list, opts)
91
- return data
86
+ data
92
87
  end
93
88
 
94
89
  # Create a list
95
- #
96
90
  # @param create_list Values to create a list
97
91
  # @param [Hash] opts the optional parameters
98
92
  # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers
99
93
  def create_list_with_http_info(create_list, opts = {})
100
94
  if @api_client.config.debugging
101
- @api_client.config.logger.debug "Calling API: ListsApi.create_list ..."
95
+ @api_client.config.logger.debug 'Calling API: ListsApi.create_list ...'
102
96
  end
103
97
  # verify the required parameter 'create_list' is set
104
98
  if @api_client.config.client_side_validation && create_list.nil?
105
99
  fail ArgumentError, "Missing the required parameter 'create_list' when calling ListsApi.create_list"
106
100
  end
107
101
  # resource path
108
- local_var_path = "/contacts/lists"
102
+ local_var_path = '/contacts/lists'
109
103
 
110
104
  # query parameters
111
105
  query_params = {}
@@ -135,32 +129,29 @@ module SibApiV3Sdk
135
129
  end
136
130
  return data, status_code, headers
137
131
  end
138
-
139
132
  # Delete a list
140
- #
141
133
  # @param list_id Id of the list
142
134
  # @param [Hash] opts the optional parameters
143
135
  # @return [nil]
144
136
  def delete_list(list_id, opts = {})
145
137
  delete_list_with_http_info(list_id, opts)
146
- return nil
138
+ nil
147
139
  end
148
140
 
149
141
  # Delete a list
150
- #
151
142
  # @param list_id Id of the list
152
143
  # @param [Hash] opts the optional parameters
153
144
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
154
145
  def delete_list_with_http_info(list_id, opts = {})
155
146
  if @api_client.config.debugging
156
- @api_client.config.logger.debug "Calling API: ListsApi.delete_list ..."
147
+ @api_client.config.logger.debug 'Calling API: ListsApi.delete_list ...'
157
148
  end
158
149
  # verify the required parameter 'list_id' is set
159
150
  if @api_client.config.client_side_validation && list_id.nil?
160
151
  fail ArgumentError, "Missing the required parameter 'list_id' when calling ListsApi.delete_list"
161
152
  end
162
153
  # resource path
163
- local_var_path = "/contacts/lists/{listId}".sub('{' + 'listId' + '}', list_id.to_s)
154
+ local_var_path = '/contacts/lists/{listId}'.sub('{' + 'listId' + '}', list_id.to_s)
164
155
 
165
156
  # query parameters
166
157
  query_params = {}
@@ -189,9 +180,7 @@ module SibApiV3Sdk
189
180
  end
190
181
  return data, status_code, headers
191
182
  end
192
-
193
- # Get the contacts in a list
194
- #
183
+ # Get contacts in a list
195
184
  # @param list_id Id of the list
196
185
  # @param [Hash] opts the optional parameters
197
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.
@@ -200,11 +189,10 @@ module SibApiV3Sdk
200
189
  # @return [GetContacts]
201
190
  def get_contacts_from_list(list_id, opts = {})
202
191
  data, _status_code, _headers = get_contacts_from_list_with_http_info(list_id, opts)
203
- return data
192
+ data
204
193
  end
205
194
 
206
- # Get the contacts in a list
207
- #
195
+ # Get contacts in a list
208
196
  # @param list_id Id of the list
209
197
  # @param [Hash] opts the optional parameters
210
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.
@@ -213,7 +201,7 @@ module SibApiV3Sdk
213
201
  # @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
214
202
  def get_contacts_from_list_with_http_info(list_id, opts = {})
215
203
  if @api_client.config.debugging
216
- @api_client.config.logger.debug "Calling API: ListsApi.get_contacts_from_list ..."
204
+ @api_client.config.logger.debug 'Calling API: ListsApi.get_contacts_from_list ...'
217
205
  end
218
206
  # verify the required parameter 'list_id' is set
219
207
  if @api_client.config.client_side_validation && list_id.nil?
@@ -224,7 +212,7 @@ module SibApiV3Sdk
224
212
  end
225
213
 
226
214
  # resource path
227
- local_var_path = "/contacts/lists/{listId}/contacts".sub('{' + 'listId' + '}', list_id.to_s)
215
+ local_var_path = '/contacts/lists/{listId}/contacts'.sub('{' + 'listId' + '}', list_id.to_s)
228
216
 
229
217
  # query parameters
230
218
  query_params = {}
@@ -257,9 +245,7 @@ module SibApiV3Sdk
257
245
  end
258
246
  return data, status_code, headers
259
247
  end
260
-
261
- # Get the lists in a folder
262
- #
248
+ # Get lists in a folder
263
249
  # @param folder_id Id of the folder
264
250
  # @param [Hash] opts the optional parameters
265
251
  # @option opts [Integer] :limit Number of documents per page (default to 10)
@@ -267,11 +253,10 @@ module SibApiV3Sdk
267
253
  # @return [GetFolderLists]
268
254
  def get_folder_lists(folder_id, opts = {})
269
255
  data, _status_code, _headers = get_folder_lists_with_http_info(folder_id, opts)
270
- return data
256
+ data
271
257
  end
272
258
 
273
- # Get the lists in a folder
274
- #
259
+ # Get lists in a folder
275
260
  # @param folder_id Id of the folder
276
261
  # @param [Hash] opts the optional parameters
277
262
  # @option opts [Integer] :limit Number of documents per page
@@ -279,7 +264,7 @@ module SibApiV3Sdk
279
264
  # @return [Array<(GetFolderLists, Fixnum, Hash)>] GetFolderLists data, response status code and response headers
280
265
  def get_folder_lists_with_http_info(folder_id, opts = {})
281
266
  if @api_client.config.debugging
282
- @api_client.config.logger.debug "Calling API: ListsApi.get_folder_lists ..."
267
+ @api_client.config.logger.debug 'Calling API: ListsApi.get_folder_lists ...'
283
268
  end
284
269
  # verify the required parameter 'folder_id' is set
285
270
  if @api_client.config.client_side_validation && folder_id.nil?
@@ -290,7 +275,7 @@ module SibApiV3Sdk
290
275
  end
291
276
 
292
277
  # resource path
293
- local_var_path = "/contacts/folders/{folderId}/lists".sub('{' + 'folderId' + '}', folder_id.to_s)
278
+ local_var_path = '/contacts/folders/{folderId}/lists'.sub('{' + 'folderId' + '}', folder_id.to_s)
294
279
 
295
280
  # query parameters
296
281
  query_params = {}
@@ -322,32 +307,29 @@ module SibApiV3Sdk
322
307
  end
323
308
  return data, status_code, headers
324
309
  end
325
-
326
- # Get the details of a list
327
- #
310
+ # Get a list's details
328
311
  # @param list_id Id of the list
329
312
  # @param [Hash] opts the optional parameters
330
313
  # @return [GetExtendedList]
331
314
  def get_list(list_id, opts = {})
332
315
  data, _status_code, _headers = get_list_with_http_info(list_id, opts)
333
- return data
316
+ data
334
317
  end
335
318
 
336
- # Get the details of a list
337
- #
319
+ # Get a list&#39;s details
338
320
  # @param list_id Id of the list
339
321
  # @param [Hash] opts the optional parameters
340
322
  # @return [Array<(GetExtendedList, Fixnum, Hash)>] GetExtendedList data, response status code and response headers
341
323
  def get_list_with_http_info(list_id, opts = {})
342
324
  if @api_client.config.debugging
343
- @api_client.config.logger.debug "Calling API: ListsApi.get_list ..."
325
+ @api_client.config.logger.debug 'Calling API: ListsApi.get_list ...'
344
326
  end
345
327
  # verify the required parameter 'list_id' is set
346
328
  if @api_client.config.client_side_validation && list_id.nil?
347
329
  fail ArgumentError, "Missing the required parameter 'list_id' when calling ListsApi.get_list"
348
330
  end
349
331
  # resource path
350
- local_var_path = "/contacts/lists/{listId}".sub('{' + 'listId' + '}', list_id.to_s)
332
+ local_var_path = '/contacts/lists/{listId}'.sub('{' + 'listId' + '}', list_id.to_s)
351
333
 
352
334
  # query parameters
353
335
  query_params = {}
@@ -377,34 +359,31 @@ module SibApiV3Sdk
377
359
  end
378
360
  return data, status_code, headers
379
361
  end
380
-
381
362
  # Get all the lists
382
- #
383
363
  # @param [Hash] opts the optional parameters
384
364
  # @option opts [Integer] :limit Number of documents per page (default to 10)
385
365
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
386
366
  # @return [GetLists]
387
367
  def get_lists(opts = {})
388
368
  data, _status_code, _headers = get_lists_with_http_info(opts)
389
- return data
369
+ data
390
370
  end
391
371
 
392
372
  # Get all the lists
393
- #
394
373
  # @param [Hash] opts the optional parameters
395
374
  # @option opts [Integer] :limit Number of documents per page
396
375
  # @option opts [Integer] :offset Index of the first document of the page
397
376
  # @return [Array<(GetLists, Fixnum, Hash)>] GetLists data, response status code and response headers
398
377
  def get_lists_with_http_info(opts = {})
399
378
  if @api_client.config.debugging
400
- @api_client.config.logger.debug "Calling API: ListsApi.get_lists ..."
379
+ @api_client.config.logger.debug 'Calling API: ListsApi.get_lists ...'
401
380
  end
402
381
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 50
403
382
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ListsApi.get_lists, must be smaller than or equal to 50.'
404
383
  end
405
384
 
406
385
  # resource path
407
- local_var_path = "/contacts/lists"
386
+ local_var_path = '/contacts/lists'
408
387
 
409
388
  # query parameters
410
389
  query_params = {}
@@ -436,27 +415,24 @@ module SibApiV3Sdk
436
415
  end
437
416
  return data, status_code, headers
438
417
  end
439
-
440
- # Remove existing contacts from a list
441
- #
418
+ # Delete a contact from a list
442
419
  # @param list_id Id of the list
443
420
  # @param contact_emails Emails adresses of the contact
444
421
  # @param [Hash] opts the optional parameters
445
422
  # @return [PostContactInfo]
446
423
  def remove_contact_from_list(list_id, contact_emails, opts = {})
447
424
  data, _status_code, _headers = remove_contact_from_list_with_http_info(list_id, contact_emails, opts)
448
- return data
425
+ data
449
426
  end
450
427
 
451
- # Remove existing contacts from a list
452
- #
428
+ # Delete a contact from a list
453
429
  # @param list_id Id of the list
454
430
  # @param contact_emails Emails adresses of the contact
455
431
  # @param [Hash] opts the optional parameters
456
432
  # @return [Array<(PostContactInfo, Fixnum, Hash)>] PostContactInfo data, response status code and response headers
457
433
  def remove_contact_from_list_with_http_info(list_id, contact_emails, opts = {})
458
434
  if @api_client.config.debugging
459
- @api_client.config.logger.debug "Calling API: ListsApi.remove_contact_from_list ..."
435
+ @api_client.config.logger.debug 'Calling API: ListsApi.remove_contact_from_list ...'
460
436
  end
461
437
  # verify the required parameter 'list_id' is set
462
438
  if @api_client.config.client_side_validation && list_id.nil?
@@ -467,7 +443,7 @@ module SibApiV3Sdk
467
443
  fail ArgumentError, "Missing the required parameter 'contact_emails' when calling ListsApi.remove_contact_from_list"
468
444
  end
469
445
  # resource path
470
- local_var_path = "/contacts/lists/{listId}/contacts/remove".sub('{' + 'listId' + '}', list_id.to_s)
446
+ local_var_path = '/contacts/lists/{listId}/contacts/remove'.sub('{' + 'listId' + '}', list_id.to_s)
471
447
 
472
448
  # query parameters
473
449
  query_params = {}
@@ -497,27 +473,24 @@ module SibApiV3Sdk
497
473
  end
498
474
  return data, status_code, headers
499
475
  end
500
-
501
476
  # Update a list
502
- #
503
477
  # @param list_id Id of the list
504
478
  # @param update_list Values to update a list
505
479
  # @param [Hash] opts the optional parameters
506
480
  # @return [nil]
507
481
  def update_list(list_id, update_list, opts = {})
508
482
  update_list_with_http_info(list_id, update_list, opts)
509
- return nil
483
+ nil
510
484
  end
511
485
 
512
486
  # Update a list
513
- #
514
487
  # @param list_id Id of the list
515
488
  # @param update_list Values to update a list
516
489
  # @param [Hash] opts the optional parameters
517
490
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
518
491
  def update_list_with_http_info(list_id, update_list, opts = {})
519
492
  if @api_client.config.debugging
520
- @api_client.config.logger.debug "Calling API: ListsApi.update_list ..."
493
+ @api_client.config.logger.debug 'Calling API: ListsApi.update_list ...'
521
494
  end
522
495
  # verify the required parameter 'list_id' is set
523
496
  if @api_client.config.client_side_validation && list_id.nil?
@@ -528,7 +501,7 @@ module SibApiV3Sdk
528
501
  fail ArgumentError, "Missing the required parameter 'update_list' when calling ListsApi.update_list"
529
502
  end
530
503
  # resource path
531
- local_var_path = "/contacts/lists/{listId}".sub('{' + 'listId' + '}', list_id.to_s)
504
+ local_var_path = '/contacts/lists/{listId}'.sub('{' + 'listId' + '}', list_id.to_s)
532
505
 
533
506
  # query parameters
534
507
  query_params = {}