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,15 +1,15 @@
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
13
  module SibApiV3Sdk
14
- VERSION = "5.2.3"
14
+ VERSION = "5.5.0"
15
15
  end
@@ -1,14 +1,14 @@
1
1
  # -*- encoding: utf-8 -*-
2
- #
2
+
3
3
  =begin
4
4
  #SendinBlue API
5
5
 
6
- #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 |
6
+ #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 |
7
7
 
8
8
  OpenAPI spec version: 3.0.0
9
9
  Contact: contact@sendinblue.com
10
10
  Generated by: https://github.com/swagger-api/swagger-codegen.git
11
- Swagger Codegen version: 2.3.1
11
+ Swagger Codegen version: 2.4.12
12
12
 
13
13
  =end
14
14
 
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
24
24
  s.homepage = "https://www.sendinblue.com/"
25
25
  s.summary = "SendinBlue API V3 Ruby Gem"
26
26
  s.description = "Official SendinBlue provided RESTFul API V3 ruby library"
27
- s.license = "MIT"
27
+ s.license = 'MIT'
28
28
  s.required_ruby_version = ">= 1.9"
29
29
 
30
30
  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
@@ -38,7 +38,7 @@ Gem::Specification.new do |s|
38
38
  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
39
39
  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
40
40
 
41
- s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
41
+ s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
42
42
  s.test_files = `find spec/*`.split("\n")
43
43
  s.executables = []
44
44
  s.require_paths = ["lib"]
@@ -1,12 +1,12 @@
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
 
@@ -33,12 +33,11 @@ describe 'AccountApi' do
33
33
  end
34
34
 
35
35
  # unit tests for get_account
36
- # Get your account informations, plans and credits details
37
- #
36
+ # Get your account information, plan and credits details
38
37
  # @param [Hash] opts the optional parameters
39
38
  # @return [GetAccount]
40
39
  describe 'get_account test' do
41
- it "should work" do
40
+ it 'should work' do
42
41
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
43
42
  end
44
43
  end
@@ -1,12 +1,12 @@
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
 
@@ -33,53 +33,49 @@ describe 'AttributesApi' do
33
33
  end
34
34
 
35
35
  # unit tests for create_attribute
36
- # Creates contact attribute
37
- #
36
+ # Create contact attribute
38
37
  # @param attribute_category Category of the attribute
39
38
  # @param attribute_name Name of the attribute
40
39
  # @param create_attribute Values to create an attribute
41
40
  # @param [Hash] opts the optional parameters
42
41
  # @return [nil]
43
42
  describe 'create_attribute test' do
44
- it "should work" do
43
+ it 'should work' do
45
44
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
46
45
  end
47
46
  end
48
47
 
49
48
  # unit tests for delete_attribute
50
- # Deletes an attribute
51
- #
49
+ # Delete an attribute
52
50
  # @param attribute_category Category of the attribute
53
51
  # @param attribute_name Name of the existing attribute
54
52
  # @param [Hash] opts the optional parameters
55
53
  # @return [nil]
56
54
  describe 'delete_attribute test' do
57
- it "should work" do
55
+ it 'should work' do
58
56
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
59
57
  end
60
58
  end
61
59
 
62
60
  # unit tests for get_attributes
63
- # Lists all attributes
64
- #
61
+ # List all attributes
65
62
  # @param [Hash] opts the optional parameters
66
63
  # @return [GetAttributes]
67
64
  describe 'get_attributes test' do
68
- it "should work" do
65
+ it 'should work' do
69
66
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
70
67
  end
71
68
  end
72
69
 
73
70
  # unit tests for update_attribute
74
- # Updates contact attribute
75
- #
71
+ # Update contact attribute
76
72
  # @param attribute_category Category of the attribute
77
73
  # @param attribute_name Name of the existing attribute
78
74
  # @param update_attribute Values to update an attribute
79
75
  # @param [Hash] opts the optional parameters
80
76
  # @return [nil]
81
77
  describe 'update_attribute test' do
82
- it "should work" do
78
+ it 'should work' do
83
79
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
84
80
  end
85
81
  end
@@ -1,12 +1,12 @@
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
 
@@ -34,168 +34,167 @@ describe 'ContactsApi' do
34
34
 
35
35
  # unit tests for add_contact_to_list
36
36
  # Add existing contacts to a list
37
- #
38
37
  # @param list_id Id of the list
39
38
  # @param contact_emails Emails addresses of the contacts
40
39
  # @param [Hash] opts the optional parameters
41
40
  # @return [PostContactInfo]
42
41
  describe 'add_contact_to_list test' do
43
- it "should work" do
42
+ it 'should work' do
44
43
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
45
44
  end
46
45
  end
47
46
 
48
47
  # unit tests for create_attribute
49
- # Creates contact attribute
50
- #
48
+ # Create contact attribute
51
49
  # @param attribute_category Category of the attribute
52
50
  # @param attribute_name Name of the attribute
53
51
  # @param create_attribute Values to create an attribute
54
52
  # @param [Hash] opts the optional parameters
55
53
  # @return [nil]
56
54
  describe 'create_attribute test' do
57
- it "should work" do
55
+ it 'should work' do
58
56
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
59
57
  end
60
58
  end
61
59
 
62
60
  # unit tests for create_contact
63
61
  # Create a contact
64
- #
65
62
  # @param create_contact Values to create a contact
66
63
  # @param [Hash] opts the optional parameters
67
64
  # @return [CreateUpdateContactModel]
68
65
  describe 'create_contact test' do
69
- it "should work" do
66
+ it 'should work' do
67
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
68
+ end
69
+ end
70
+
71
+ # unit tests for create_doi_contact
72
+ # Create Contact via DOI (Double-Opt-In) Flow
73
+ # @param create_doi_contact Values to create the Double opt-in (DOI) contact
74
+ # @param [Hash] opts the optional parameters
75
+ # @return [nil]
76
+ describe 'create_doi_contact test' do
77
+ it 'should work' do
70
78
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
71
79
  end
72
80
  end
73
81
 
74
82
  # unit tests for create_folder
75
83
  # Create a folder
76
- #
77
84
  # @param create_folder Name of the folder
78
85
  # @param [Hash] opts the optional parameters
79
86
  # @return [CreateModel]
80
87
  describe 'create_folder test' do
81
- it "should work" do
88
+ it 'should work' do
82
89
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
83
90
  end
84
91
  end
85
92
 
86
93
  # unit tests for create_list
87
94
  # Create a list
88
- #
89
95
  # @param create_list Values to create a list
90
96
  # @param [Hash] opts the optional parameters
91
97
  # @return [CreateModel]
92
98
  describe 'create_list test' do
93
- it "should work" do
99
+ it 'should work' do
94
100
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
95
101
  end
96
102
  end
97
103
 
98
104
  # unit tests for delete_attribute
99
- # Deletes an attribute
100
- #
105
+ # Delete an attribute
101
106
  # @param attribute_category Category of the attribute
102
107
  # @param attribute_name Name of the existing attribute
103
108
  # @param [Hash] opts the optional parameters
104
109
  # @return [nil]
105
110
  describe 'delete_attribute test' do
106
- it "should work" do
111
+ it 'should work' do
107
112
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
108
113
  end
109
114
  end
110
115
 
111
116
  # unit tests for delete_contact
112
- # Deletes a contact
113
- #
117
+ # Delete a contact
114
118
  # @param email Email (urlencoded) of the contact
115
119
  # @param [Hash] opts the optional parameters
116
120
  # @return [nil]
117
121
  describe 'delete_contact test' do
118
- it "should work" do
122
+ it 'should work' do
119
123
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
120
124
  end
121
125
  end
122
126
 
123
127
  # unit tests for delete_folder
124
128
  # Delete a folder (and all its lists)
125
- #
126
129
  # @param folder_id Id of the folder
127
130
  # @param [Hash] opts the optional parameters
128
131
  # @return [nil]
129
132
  describe 'delete_folder test' do
130
- it "should work" do
133
+ it 'should work' do
131
134
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
132
135
  end
133
136
  end
134
137
 
135
138
  # unit tests for delete_list
136
139
  # Delete a list
137
- #
138
140
  # @param list_id Id of the list
139
141
  # @param [Hash] opts the optional parameters
140
142
  # @return [nil]
141
143
  describe 'delete_list test' do
142
- it "should work" do
144
+ it 'should work' do
143
145
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
144
146
  end
145
147
  end
146
148
 
147
149
  # unit tests for get_attributes
148
- # Lists all attributes
149
- #
150
+ # List all attributes
150
151
  # @param [Hash] opts the optional parameters
151
152
  # @return [GetAttributes]
152
153
  describe 'get_attributes test' do
153
- it "should work" do
154
+ it 'should work' do
154
155
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
155
156
  end
156
157
  end
157
158
 
158
159
  # unit tests for get_contact_info
159
- # Retrieves contact informations
160
- #
161
- # @param email Email (urlencoded) of the contact
160
+ # Get a contact's details
161
+ # @param email Email (urlencoded) of the contact OR its SMS attribute value
162
162
  # @param [Hash] opts the optional parameters
163
163
  # @return [GetExtendedContactDetails]
164
164
  describe 'get_contact_info test' do
165
- it "should work" do
165
+ it 'should work' do
166
166
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
167
167
  end
168
168
  end
169
169
 
170
170
  # unit tests for get_contact_stats
171
- # Get the campaigns statistics for a contact
172
- #
171
+ # Get email campaigns' statistics for a contact
173
172
  # @param email Email address (urlencoded) of the contact
174
173
  # @param [Hash] opts the optional parameters
174
+ # @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
175
+ # @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
175
176
  # @return [GetContactCampaignStats]
176
177
  describe 'get_contact_stats test' do
177
- it "should work" do
178
+ it 'should work' do
178
179
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
179
180
  end
180
181
  end
181
182
 
182
183
  # unit tests for get_contacts
183
184
  # Get all the contacts
184
- #
185
185
  # @param [Hash] opts the optional parameters
186
186
  # @option opts [Integer] :limit Number of documents per page
187
187
  # @option opts [Integer] :offset Index of the first document of the page
188
188
  # @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.
189
189
  # @return [GetContacts]
190
190
  describe 'get_contacts test' do
191
- it "should work" do
191
+ it 'should work' do
192
192
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
193
193
  end
194
194
  end
195
195
 
196
196
  # unit tests for get_contacts_from_list
197
- # Get the contacts in a list
198
- #
197
+ # Get contacts in a list
199
198
  # @param list_id Id of the list
200
199
  # @param [Hash] opts the optional parameters
201
200
  # @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.
@@ -203,71 +202,66 @@ describe 'ContactsApi' do
203
202
  # @option opts [Integer] :offset Index of the first document of the page
204
203
  # @return [GetContacts]
205
204
  describe 'get_contacts_from_list test' do
206
- it "should work" do
205
+ it 'should work' do
207
206
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
208
207
  end
209
208
  end
210
209
 
211
210
  # unit tests for get_folder
212
- # Returns folder details
213
- #
211
+ # Returns a folder's details
214
212
  # @param folder_id id of the folder
215
213
  # @param [Hash] opts the optional parameters
216
214
  # @return [GetFolder]
217
215
  describe 'get_folder test' do
218
- it "should work" do
216
+ it 'should work' do
219
217
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
220
218
  end
221
219
  end
222
220
 
223
221
  # unit tests for get_folder_lists
224
- # Get the lists in a folder
225
- #
222
+ # Get lists in a folder
226
223
  # @param folder_id Id of the folder
227
224
  # @param [Hash] opts the optional parameters
228
225
  # @option opts [Integer] :limit Number of documents per page
229
226
  # @option opts [Integer] :offset Index of the first document of the page
230
227
  # @return [GetFolderLists]
231
228
  describe 'get_folder_lists test' do
232
- it "should work" do
229
+ it 'should work' do
233
230
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
234
231
  end
235
232
  end
236
233
 
237
234
  # unit tests for get_folders
238
- # Get all the folders
239
- #
235
+ # Get all folders
240
236
  # @param limit Number of documents per page
241
237
  # @param offset Index of the first document of the page
242
238
  # @param [Hash] opts the optional parameters
243
239
  # @return [GetFolders]
244
240
  describe 'get_folders test' do
245
- it "should work" do
241
+ it 'should work' do
246
242
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
247
243
  end
248
244
  end
249
245
 
250
246
  # unit tests for get_list
251
- # Get the details of a list
252
- #
247
+ # Get a list's details
253
248
  # @param list_id Id of the list
254
249
  # @param [Hash] opts the optional parameters
255
250
  # @return [GetExtendedList]
256
251
  describe 'get_list test' do
257
- it "should work" do
252
+ it 'should work' do
258
253
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
259
254
  end
260
255
  end
261
256
 
262
257
  # unit tests for get_lists
263
258
  # Get all the lists
264
- #
265
259
  # @param [Hash] opts the optional parameters
266
260
  # @option opts [Integer] :limit Number of documents per page
267
261
  # @option opts [Integer] :offset Index of the first document of the page
268
262
  # @return [GetLists]
269
263
  describe 'get_lists test' do
270
- it "should work" do
264
+ it 'should work' do
271
265
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
272
266
  end
273
267
  end
@@ -279,20 +273,19 @@ describe 'ContactsApi' do
279
273
  # @param [Hash] opts the optional parameters
280
274
  # @return [CreatedProcessId]
281
275
  describe 'import_contacts test' do
282
- it "should work" do
276
+ it 'should work' do
283
277
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
284
278
  end
285
279
  end
286
280
 
287
281
  # unit tests for remove_contact_from_list
288
- # Remove existing contacts from a list
289
- #
282
+ # Delete a contact from a list
290
283
  # @param list_id Id of the list
291
284
  # @param contact_emails Emails adresses of the contact
292
285
  # @param [Hash] opts the optional parameters
293
286
  # @return [PostContactInfo]
294
287
  describe 'remove_contact_from_list test' do
295
- it "should work" do
288
+ it 'should work' do
296
289
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
297
290
  end
298
291
  end
@@ -304,60 +297,56 @@ describe 'ContactsApi' do
304
297
  # @param [Hash] opts the optional parameters
305
298
  # @return [CreatedProcessId]
306
299
  describe 'request_contact_export test' do
307
- it "should work" do
300
+ it 'should work' do
308
301
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
309
302
  end
310
303
  end
311
304
 
312
305
  # unit tests for update_attribute
313
- # Updates contact attribute
314
- #
306
+ # Update contact attribute
315
307
  # @param attribute_category Category of the attribute
316
308
  # @param attribute_name Name of the existing attribute
317
309
  # @param update_attribute Values to update an attribute
318
310
  # @param [Hash] opts the optional parameters
319
311
  # @return [nil]
320
312
  describe 'update_attribute test' do
321
- it "should work" do
313
+ it 'should work' do
322
314
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
323
315
  end
324
316
  end
325
317
 
326
318
  # unit tests for update_contact
327
- # Updates a contact
328
- #
319
+ # Update a contact
329
320
  # @param email Email (urlencoded) of the contact
330
321
  # @param update_contact Values to update a contact
331
322
  # @param [Hash] opts the optional parameters
332
323
  # @return [nil]
333
324
  describe 'update_contact test' do
334
- it "should work" do
325
+ it 'should work' do
335
326
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
336
327
  end
337
328
  end
338
329
 
339
330
  # unit tests for update_folder
340
- # Update a contact folder
341
- #
331
+ # Update a folder
342
332
  # @param folder_id Id of the folder
343
333
  # @param update_folder Name of the folder
344
334
  # @param [Hash] opts the optional parameters
345
335
  # @return [nil]
346
336
  describe 'update_folder test' do
347
- it "should work" do
337
+ it 'should work' do
348
338
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
349
339
  end
350
340
  end
351
341
 
352
342
  # unit tests for update_list
353
343
  # Update a list
354
- #
355
344
  # @param list_id Id of the list
356
345
  # @param update_list Values to update a list
357
346
  # @param [Hash] opts the optional parameters
358
347
  # @return [nil]
359
348
  describe 'update_list test' do
360
- it "should work" do
349
+ it 'should work' do
361
350
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
362
351
  end
363
352
  end