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 SendersApi
@@ -19,28 +19,25 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
-
23
22
  # Create a new sender
24
- #
25
23
  # @param [Hash] opts the optional parameters
26
24
  # @option opts [CreateSender] :sender sender's name
27
25
  # @return [CreateSenderModel]
28
26
  def create_sender(opts = {})
29
27
  data, _status_code, _headers = create_sender_with_http_info(opts)
30
- return data
28
+ data
31
29
  end
32
30
 
33
31
  # Create a new sender
34
- #
35
32
  # @param [Hash] opts the optional parameters
36
33
  # @option opts [CreateSender] :sender sender's name
37
34
  # @return [Array<(CreateSenderModel, Fixnum, Hash)>] CreateSenderModel data, response status code and response headers
38
35
  def create_sender_with_http_info(opts = {})
39
36
  if @api_client.config.debugging
40
- @api_client.config.logger.debug "Calling API: SendersApi.create_sender ..."
37
+ @api_client.config.logger.debug 'Calling API: SendersApi.create_sender ...'
41
38
  end
42
39
  # resource path
43
- local_var_path = "/senders"
40
+ local_var_path = '/senders'
44
41
 
45
42
  # query parameters
46
43
  query_params = {}
@@ -70,32 +67,29 @@ module SibApiV3Sdk
70
67
  end
71
68
  return data, status_code, headers
72
69
  end
73
-
74
70
  # Delete a sender
75
- #
76
71
  # @param sender_id Id of the sender
77
72
  # @param [Hash] opts the optional parameters
78
73
  # @return [nil]
79
74
  def delete_sender(sender_id, opts = {})
80
75
  delete_sender_with_http_info(sender_id, opts)
81
- return nil
76
+ nil
82
77
  end
83
78
 
84
79
  # Delete a sender
85
- #
86
80
  # @param sender_id Id of the sender
87
81
  # @param [Hash] opts the optional parameters
88
82
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
89
83
  def delete_sender_with_http_info(sender_id, opts = {})
90
84
  if @api_client.config.debugging
91
- @api_client.config.logger.debug "Calling API: SendersApi.delete_sender ..."
85
+ @api_client.config.logger.debug 'Calling API: SendersApi.delete_sender ...'
92
86
  end
93
87
  # verify the required parameter 'sender_id' is set
94
88
  if @api_client.config.client_side_validation && sender_id.nil?
95
89
  fail ArgumentError, "Missing the required parameter 'sender_id' when calling SendersApi.delete_sender"
96
90
  end
97
91
  # resource path
98
- local_var_path = "/senders/{senderId}".sub('{' + 'senderId' + '}', sender_id.to_s)
92
+ local_var_path = '/senders/{senderId}'.sub('{' + 'senderId' + '}', sender_id.to_s)
99
93
 
100
94
  # query parameters
101
95
  query_params = {}
@@ -124,26 +118,23 @@ module SibApiV3Sdk
124
118
  end
125
119
  return data, status_code, headers
126
120
  end
127
-
128
- # Return all the dedicated IPs for your account
129
- #
121
+ # Get all the dedicated IPs for your account
130
122
  # @param [Hash] opts the optional parameters
131
123
  # @return [GetIps]
132
124
  def get_ips(opts = {})
133
125
  data, _status_code, _headers = get_ips_with_http_info(opts)
134
- return data
126
+ data
135
127
  end
136
128
 
137
- # Return all the dedicated IPs for your account
138
- #
129
+ # Get all the dedicated IPs for your account
139
130
  # @param [Hash] opts the optional parameters
140
131
  # @return [Array<(GetIps, Fixnum, Hash)>] GetIps data, response status code and response headers
141
132
  def get_ips_with_http_info(opts = {})
142
133
  if @api_client.config.debugging
143
- @api_client.config.logger.debug "Calling API: SendersApi.get_ips ..."
134
+ @api_client.config.logger.debug 'Calling API: SendersApi.get_ips ...'
144
135
  end
145
136
  # resource path
146
- local_var_path = "/senders/ips"
137
+ local_var_path = '/senders/ips'
147
138
 
148
139
  # query parameters
149
140
  query_params = {}
@@ -173,32 +164,29 @@ module SibApiV3Sdk
173
164
  end
174
165
  return data, status_code, headers
175
166
  end
176
-
177
- # Return all the dedicated IPs for a sender
178
- #
167
+ # Get all the dedicated IPs for a sender
179
168
  # @param sender_id Id of the sender
180
169
  # @param [Hash] opts the optional parameters
181
170
  # @return [GetIpsFromSender]
182
171
  def get_ips_from_sender(sender_id, opts = {})
183
172
  data, _status_code, _headers = get_ips_from_sender_with_http_info(sender_id, opts)
184
- return data
173
+ data
185
174
  end
186
175
 
187
- # Return all the dedicated IPs for a sender
188
- #
176
+ # Get all the dedicated IPs for a sender
189
177
  # @param sender_id Id of the sender
190
178
  # @param [Hash] opts the optional parameters
191
179
  # @return [Array<(GetIpsFromSender, Fixnum, Hash)>] GetIpsFromSender data, response status code and response headers
192
180
  def get_ips_from_sender_with_http_info(sender_id, opts = {})
193
181
  if @api_client.config.debugging
194
- @api_client.config.logger.debug "Calling API: SendersApi.get_ips_from_sender ..."
182
+ @api_client.config.logger.debug 'Calling API: SendersApi.get_ips_from_sender ...'
195
183
  end
196
184
  # verify the required parameter 'sender_id' is set
197
185
  if @api_client.config.client_side_validation && sender_id.nil?
198
186
  fail ArgumentError, "Missing the required parameter 'sender_id' when calling SendersApi.get_ips_from_sender"
199
187
  end
200
188
  # resource path
201
- local_var_path = "/senders/{senderId}/ips".sub('{' + 'senderId' + '}', sender_id.to_s)
189
+ local_var_path = '/senders/{senderId}/ips'.sub('{' + 'senderId' + '}', sender_id.to_s)
202
190
 
203
191
  # query parameters
204
192
  query_params = {}
@@ -228,30 +216,27 @@ module SibApiV3Sdk
228
216
  end
229
217
  return data, status_code, headers
230
218
  end
231
-
232
219
  # Get the list of all your senders
233
- #
234
220
  # @param [Hash] opts the optional parameters
235
221
  # @option opts [String] :ip Filter your senders for a specific ip (available for dedicated IP usage only)
236
222
  # @option opts [String] :domain Filter your senders for a specific domain
237
223
  # @return [GetSendersList]
238
224
  def get_senders(opts = {})
239
225
  data, _status_code, _headers = get_senders_with_http_info(opts)
240
- return data
226
+ data
241
227
  end
242
228
 
243
229
  # Get the list of all your senders
244
- #
245
230
  # @param [Hash] opts the optional parameters
246
231
  # @option opts [String] :ip Filter your senders for a specific ip (available for dedicated IP usage only)
247
232
  # @option opts [String] :domain Filter your senders for a specific domain
248
233
  # @return [Array<(GetSendersList, Fixnum, Hash)>] GetSendersList data, response status code and response headers
249
234
  def get_senders_with_http_info(opts = {})
250
235
  if @api_client.config.debugging
251
- @api_client.config.logger.debug "Calling API: SendersApi.get_senders ..."
236
+ @api_client.config.logger.debug 'Calling API: SendersApi.get_senders ...'
252
237
  end
253
238
  # resource path
254
- local_var_path = "/senders"
239
+ local_var_path = '/senders'
255
240
 
256
241
  # query parameters
257
242
  query_params = {}
@@ -283,34 +268,31 @@ module SibApiV3Sdk
283
268
  end
284
269
  return data, status_code, headers
285
270
  end
286
-
287
271
  # Update a sender
288
- #
289
272
  # @param sender_id Id of the sender
290
273
  # @param [Hash] opts the optional parameters
291
274
  # @option opts [UpdateSender] :sender sender&#39;s name
292
275
  # @return [nil]
293
276
  def update_sender(sender_id, opts = {})
294
277
  update_sender_with_http_info(sender_id, opts)
295
- return nil
278
+ nil
296
279
  end
297
280
 
298
281
  # Update a sender
299
- #
300
282
  # @param sender_id Id of the sender
301
283
  # @param [Hash] opts the optional parameters
302
284
  # @option opts [UpdateSender] :sender sender&#39;s name
303
285
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
304
286
  def update_sender_with_http_info(sender_id, opts = {})
305
287
  if @api_client.config.debugging
306
- @api_client.config.logger.debug "Calling API: SendersApi.update_sender ..."
288
+ @api_client.config.logger.debug 'Calling API: SendersApi.update_sender ...'
307
289
  end
308
290
  # verify the required parameter 'sender_id' is set
309
291
  if @api_client.config.client_side_validation && sender_id.nil?
310
292
  fail ArgumentError, "Missing the required parameter 'sender_id' when calling SendersApi.update_sender"
311
293
  end
312
294
  # resource path
313
- local_var_path = "/senders/{senderId}".sub('{' + 'senderId' + '}', sender_id.to_s)
295
+ local_var_path = '/senders/{senderId}'.sub('{' + 'senderId' + '}', sender_id.to_s)
314
296
 
315
297
  # query parameters
316
298
  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 SMSCampaignsApi
@@ -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
  # Creates an SMS campaign
24
- #
25
23
  # @param create_sms_campaign Values to create an SMS Campaign
26
24
  # @param [Hash] opts the optional parameters
27
25
  # @return [CreateModel]
28
26
  def create_sms_campaign(create_sms_campaign, opts = {})
29
27
  data, _status_code, _headers = create_sms_campaign_with_http_info(create_sms_campaign, opts)
30
- return data
28
+ data
31
29
  end
32
30
 
33
31
  # Creates an SMS campaign
34
- #
35
32
  # @param create_sms_campaign Values to create an SMS Campaign
36
33
  # @param [Hash] opts the optional parameters
37
34
  # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers
38
35
  def create_sms_campaign_with_http_info(create_sms_campaign, opts = {})
39
36
  if @api_client.config.debugging
40
- @api_client.config.logger.debug "Calling API: SMSCampaignsApi.create_sms_campaign ..."
37
+ @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.create_sms_campaign ...'
41
38
  end
42
39
  # verify the required parameter 'create_sms_campaign' is set
43
40
  if @api_client.config.client_side_validation && create_sms_campaign.nil?
44
41
  fail ArgumentError, "Missing the required parameter 'create_sms_campaign' when calling SMSCampaignsApi.create_sms_campaign"
45
42
  end
46
43
  # resource path
47
- local_var_path = "/smsCampaigns"
44
+ local_var_path = '/smsCampaigns'
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
- # Delete the SMS campaign
79
- #
74
+ # Delete an SMS campaign
80
75
  # @param campaign_id id of the SMS campaign
81
76
  # @param [Hash] opts the optional parameters
82
77
  # @return [nil]
83
78
  def delete_sms_campaign(campaign_id, opts = {})
84
79
  delete_sms_campaign_with_http_info(campaign_id, opts)
85
- return nil
80
+ nil
86
81
  end
87
82
 
88
- # Delete the SMS campaign
89
- #
83
+ # Delete an SMS campaign
90
84
  # @param campaign_id id of the SMS campaign
91
85
  # @param [Hash] opts the optional parameters
92
86
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
93
87
  def delete_sms_campaign_with_http_info(campaign_id, opts = {})
94
88
  if @api_client.config.debugging
95
- @api_client.config.logger.debug "Calling API: SMSCampaignsApi.delete_sms_campaign ..."
89
+ @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.delete_sms_campaign ...'
96
90
  end
97
91
  # verify the required parameter 'campaign_id' is set
98
92
  if @api_client.config.client_side_validation && campaign_id.nil?
99
93
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling SMSCampaignsApi.delete_sms_campaign"
100
94
  end
101
95
  # resource path
102
- local_var_path = "/smsCampaigns/{campaignId}".sub('{' + 'campaignId' + '}', campaign_id.to_s)
96
+ local_var_path = '/smsCampaigns/{campaignId}'.sub('{' + 'campaignId' + '}', campaign_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
125
  # Get an SMS campaign
133
- #
134
126
  # @param campaign_id id of the SMS campaign
135
127
  # @param [Hash] opts the optional parameters
136
128
  # @return [GetSmsCampaign]
137
129
  def get_sms_campaign(campaign_id, opts = {})
138
130
  data, _status_code, _headers = get_sms_campaign_with_http_info(campaign_id, opts)
139
- return data
131
+ data
140
132
  end
141
133
 
142
134
  # Get an SMS campaign
143
- #
144
135
  # @param campaign_id id of the SMS campaign
145
136
  # @param [Hash] opts the optional parameters
146
137
  # @return [Array<(GetSmsCampaign, Fixnum, Hash)>] GetSmsCampaign data, response status code and response headers
147
138
  def get_sms_campaign_with_http_info(campaign_id, opts = {})
148
139
  if @api_client.config.debugging
149
- @api_client.config.logger.debug "Calling API: SMSCampaignsApi.get_sms_campaign ..."
140
+ @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.get_sms_campaign ...'
150
141
  end
151
142
  # verify the required parameter 'campaign_id' is set
152
143
  if @api_client.config.client_side_validation && campaign_id.nil?
153
144
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling SMSCampaignsApi.get_sms_campaign"
154
145
  end
155
146
  # resource path
156
- local_var_path = "/smsCampaigns/{campaignId}".sub('{' + 'campaignId' + '}', campaign_id.to_s)
147
+ local_var_path = '/smsCampaigns/{campaignId}'.sub('{' + 'campaignId' + '}', campaign_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
- # Returns the informations for all your created SMS campaigns
188
- #
177
+ # Returns the information for all your created SMS campaigns
189
178
  # @param [Hash] opts the optional parameters
190
179
  # @option opts [String] :status Status of campaign.
191
180
  # @option opts [DateTime] :start_date Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either &#39;status&#39; not passed and if passed is set to &#39;sent&#39; )
@@ -195,11 +184,10 @@ module SibApiV3Sdk
195
184
  # @return [GetSmsCampaigns]
196
185
  def get_sms_campaigns(opts = {})
197
186
  data, _status_code, _headers = get_sms_campaigns_with_http_info(opts)
198
- return data
187
+ data
199
188
  end
200
189
 
201
- # Returns the informations for all your created SMS campaigns
202
- #
190
+ # Returns the information for all your created SMS campaigns
203
191
  # @param [Hash] opts the optional parameters
204
192
  # @option opts [String] :status Status of campaign.
205
193
  # @option opts [DateTime] :start_date Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either &#39;status&#39; not passed and if passed is set to &#39;sent&#39; )
@@ -209,7 +197,7 @@ module SibApiV3Sdk
209
197
  # @return [Array<(GetSmsCampaigns, Fixnum, Hash)>] GetSmsCampaigns data, response status code and response headers
210
198
  def get_sms_campaigns_with_http_info(opts = {})
211
199
  if @api_client.config.debugging
212
- @api_client.config.logger.debug "Calling API: SMSCampaignsApi.get_sms_campaigns ..."
200
+ @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.get_sms_campaigns ...'
213
201
  end
214
202
  if @api_client.config.client_side_validation && opts[:'status'] && !['suspended', 'archive', 'sent', 'queued', 'draft', 'inProcess'].include?(opts[:'status'])
215
203
  fail ArgumentError, 'invalid value for "status", must be one of suspended, archive, sent, queued, draft, inProcess'
@@ -219,7 +207,7 @@ module SibApiV3Sdk
219
207
  end
220
208
 
221
209
  # resource path
222
- local_var_path = "/smsCampaigns"
210
+ local_var_path = '/smsCampaigns'
223
211
 
224
212
  # query parameters
225
213
  query_params = {}
@@ -254,8 +242,7 @@ module SibApiV3Sdk
254
242
  end
255
243
  return data, status_code, headers
256
244
  end
257
-
258
- # Exports the recipients of the specified campaign.
245
+ # Export an SMS campaign's recipients
259
246
  # It returns the background process ID which on completion calls the notify URL that you have set in the input.
260
247
  # @param campaign_id id of the campaign
261
248
  # @param [Hash] opts the optional parameters
@@ -263,10 +250,10 @@ module SibApiV3Sdk
263
250
  # @return [CreatedProcessId]
264
251
  def request_sms_recipient_export(campaign_id, opts = {})
265
252
  data, _status_code, _headers = request_sms_recipient_export_with_http_info(campaign_id, opts)
266
- return data
253
+ data
267
254
  end
268
255
 
269
- # Exports the recipients of the specified campaign.
256
+ # Export an SMS campaign&#39;s recipients
270
257
  # It returns the background process ID which on completion calls the notify URL that you have set in the input.
271
258
  # @param campaign_id id of the campaign
272
259
  # @param [Hash] opts the optional parameters
@@ -274,14 +261,14 @@ module SibApiV3Sdk
274
261
  # @return [Array<(CreatedProcessId, Fixnum, Hash)>] CreatedProcessId data, response status code and response headers
275
262
  def request_sms_recipient_export_with_http_info(campaign_id, opts = {})
276
263
  if @api_client.config.debugging
277
- @api_client.config.logger.debug "Calling API: SMSCampaignsApi.request_sms_recipient_export ..."
264
+ @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.request_sms_recipient_export ...'
278
265
  end
279
266
  # verify the required parameter 'campaign_id' is set
280
267
  if @api_client.config.client_side_validation && campaign_id.nil?
281
268
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling SMSCampaignsApi.request_sms_recipient_export"
282
269
  end
283
270
  # resource path
284
- local_var_path = "/smsCampaigns/{campaignId}/exportRecipients".sub('{' + 'campaignId' + '}', campaign_id.to_s)
271
+ local_var_path = '/smsCampaigns/{campaignId}/exportRecipients'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
285
272
 
286
273
  # query parameters
287
274
  query_params = {}
@@ -311,32 +298,29 @@ module SibApiV3Sdk
311
298
  end
312
299
  return data, status_code, headers
313
300
  end
314
-
315
301
  # Send your SMS campaign immediately
316
- #
317
302
  # @param campaign_id id of the campaign
318
303
  # @param [Hash] opts the optional parameters
319
304
  # @return [nil]
320
305
  def send_sms_campaign_now(campaign_id, opts = {})
321
306
  send_sms_campaign_now_with_http_info(campaign_id, opts)
322
- return nil
307
+ nil
323
308
  end
324
309
 
325
310
  # Send your SMS campaign immediately
326
- #
327
311
  # @param campaign_id id of the campaign
328
312
  # @param [Hash] opts the optional parameters
329
313
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
330
314
  def send_sms_campaign_now_with_http_info(campaign_id, opts = {})
331
315
  if @api_client.config.debugging
332
- @api_client.config.logger.debug "Calling API: SMSCampaignsApi.send_sms_campaign_now ..."
316
+ @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.send_sms_campaign_now ...'
333
317
  end
334
318
  # verify the required parameter 'campaign_id' is set
335
319
  if @api_client.config.client_side_validation && campaign_id.nil?
336
320
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling SMSCampaignsApi.send_sms_campaign_now"
337
321
  end
338
322
  # resource path
339
- local_var_path = "/smsCampaigns/{campaignId}/sendNow".sub('{' + 'campaignId' + '}', campaign_id.to_s)
323
+ local_var_path = '/smsCampaigns/{campaignId}/sendNow'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
340
324
 
341
325
  # query parameters
342
326
  query_params = {}
@@ -365,8 +349,7 @@ module SibApiV3Sdk
365
349
  end
366
350
  return data, status_code, headers
367
351
  end
368
-
369
- # Send report of SMS campaigns
352
+ # Send an SMS campaign's report
370
353
  # Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
371
354
  # @param campaign_id id of the campaign
372
355
  # @param send_report Values for send a report
@@ -374,10 +357,10 @@ module SibApiV3Sdk
374
357
  # @return [nil]
375
358
  def send_sms_report(campaign_id, send_report, opts = {})
376
359
  send_sms_report_with_http_info(campaign_id, send_report, opts)
377
- return nil
360
+ nil
378
361
  end
379
362
 
380
- # Send report of SMS campaigns
363
+ # Send an SMS campaign&#39;s report
381
364
  # Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
382
365
  # @param campaign_id id of the campaign
383
366
  # @param send_report Values for send a report
@@ -385,7 +368,7 @@ module SibApiV3Sdk
385
368
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
386
369
  def send_sms_report_with_http_info(campaign_id, send_report, opts = {})
387
370
  if @api_client.config.debugging
388
- @api_client.config.logger.debug "Calling API: SMSCampaignsApi.send_sms_report ..."
371
+ @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.send_sms_report ...'
389
372
  end
390
373
  # verify the required parameter 'campaign_id' is set
391
374
  if @api_client.config.client_side_validation && campaign_id.nil?
@@ -396,7 +379,7 @@ module SibApiV3Sdk
396
379
  fail ArgumentError, "Missing the required parameter 'send_report' when calling SMSCampaignsApi.send_sms_report"
397
380
  end
398
381
  # resource path
399
- local_var_path = "/smsCampaigns/{campaignId}/sendReport".sub('{' + 'campaignId' + '}', campaign_id.to_s)
382
+ local_var_path = '/smsCampaigns/{campaignId}/sendReport'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
400
383
 
401
384
  # query parameters
402
385
  query_params = {}
@@ -425,27 +408,24 @@ module SibApiV3Sdk
425
408
  end
426
409
  return data, status_code, headers
427
410
  end
428
-
429
- # Send an SMS
430
- #
411
+ # Send a test SMS campaign
431
412
  # @param campaign_id Id of the SMS campaign
432
413
  # @param phone_number Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted
433
414
  # @param [Hash] opts the optional parameters
434
415
  # @return [nil]
435
416
  def send_test_sms(campaign_id, phone_number, opts = {})
436
417
  send_test_sms_with_http_info(campaign_id, phone_number, opts)
437
- return nil
418
+ nil
438
419
  end
439
420
 
440
- # Send an SMS
441
- #
421
+ # Send a test SMS campaign
442
422
  # @param campaign_id Id of the SMS campaign
443
423
  # @param phone_number Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted
444
424
  # @param [Hash] opts the optional parameters
445
425
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
446
426
  def send_test_sms_with_http_info(campaign_id, phone_number, opts = {})
447
427
  if @api_client.config.debugging
448
- @api_client.config.logger.debug "Calling API: SMSCampaignsApi.send_test_sms ..."
428
+ @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.send_test_sms ...'
449
429
  end
450
430
  # verify the required parameter 'campaign_id' is set
451
431
  if @api_client.config.client_side_validation && campaign_id.nil?
@@ -456,7 +436,7 @@ module SibApiV3Sdk
456
436
  fail ArgumentError, "Missing the required parameter 'phone_number' when calling SMSCampaignsApi.send_test_sms"
457
437
  end
458
438
  # resource path
459
- local_var_path = "/smsCampaigns/{campaignId}/sendTest".sub('{' + 'campaignId' + '}', campaign_id.to_s)
439
+ local_var_path = '/smsCampaigns/{campaignId}/sendTest'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
460
440
 
461
441
  # query parameters
462
442
  query_params = {}
@@ -485,27 +465,24 @@ module SibApiV3Sdk
485
465
  end
486
466
  return data, status_code, headers
487
467
  end
488
-
489
- # Updates an SMS campaign
490
- #
468
+ # Update an SMS campaign
491
469
  # @param campaign_id id of the SMS campaign
492
470
  # @param update_sms_campaign Values to update an SMS Campaign
493
471
  # @param [Hash] opts the optional parameters
494
472
  # @return [nil]
495
473
  def update_sms_campaign(campaign_id, update_sms_campaign, opts = {})
496
474
  update_sms_campaign_with_http_info(campaign_id, update_sms_campaign, opts)
497
- return nil
475
+ nil
498
476
  end
499
477
 
500
- # Updates an SMS campaign
501
- #
478
+ # Update an SMS campaign
502
479
  # @param campaign_id id of the SMS campaign
503
480
  # @param update_sms_campaign Values to update an SMS Campaign
504
481
  # @param [Hash] opts the optional parameters
505
482
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
506
483
  def update_sms_campaign_with_http_info(campaign_id, update_sms_campaign, opts = {})
507
484
  if @api_client.config.debugging
508
- @api_client.config.logger.debug "Calling API: SMSCampaignsApi.update_sms_campaign ..."
485
+ @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.update_sms_campaign ...'
509
486
  end
510
487
  # verify the required parameter 'campaign_id' is set
511
488
  if @api_client.config.client_side_validation && campaign_id.nil?
@@ -516,7 +493,7 @@ module SibApiV3Sdk
516
493
  fail ArgumentError, "Missing the required parameter 'update_sms_campaign' when calling SMSCampaignsApi.update_sms_campaign"
517
494
  end
518
495
  # resource path
519
- local_var_path = "/smsCampaigns/{campaignId}".sub('{' + 'campaignId' + '}', campaign_id.to_s)
496
+ local_var_path = '/smsCampaigns/{campaignId}'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
520
497
 
521
498
  # query parameters
522
499
  query_params = {}
@@ -545,27 +522,24 @@ module SibApiV3Sdk
545
522
  end
546
523
  return data, status_code, headers
547
524
  end
548
-
549
- # Update the campaign status
550
- #
525
+ # Update a campaign's status
551
526
  # @param campaign_id id of the campaign
552
527
  # @param status Status of the campaign.
553
528
  # @param [Hash] opts the optional parameters
554
529
  # @return [nil]
555
530
  def update_sms_campaign_status(campaign_id, status, opts = {})
556
531
  update_sms_campaign_status_with_http_info(campaign_id, status, opts)
557
- return nil
532
+ nil
558
533
  end
559
534
 
560
- # Update the campaign status
561
- #
535
+ # Update a campaign&#39;s status
562
536
  # @param campaign_id id of the campaign
563
537
  # @param status Status of the campaign.
564
538
  # @param [Hash] opts the optional parameters
565
539
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
566
540
  def update_sms_campaign_status_with_http_info(campaign_id, status, opts = {})
567
541
  if @api_client.config.debugging
568
- @api_client.config.logger.debug "Calling API: SMSCampaignsApi.update_sms_campaign_status ..."
542
+ @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.update_sms_campaign_status ...'
569
543
  end
570
544
  # verify the required parameter 'campaign_id' is set
571
545
  if @api_client.config.client_side_validation && campaign_id.nil?
@@ -576,7 +550,7 @@ module SibApiV3Sdk
576
550
  fail ArgumentError, "Missing the required parameter 'status' when calling SMSCampaignsApi.update_sms_campaign_status"
577
551
  end
578
552
  # resource path
579
- local_var_path = "/smsCampaigns/{campaignId}/status".sub('{' + 'campaignId' + '}', campaign_id.to_s)
553
+ local_var_path = '/smsCampaigns/{campaignId}/status'.sub('{' + 'campaignId' + '}', campaign_id.to_s)
580
554
 
581
555
  # query parameters
582
556
  query_params = {}