sib-api-v3-sdk 5.2.5 → 5.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (420) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/LICENSE.md +1 -1
  4. data/README.md +17 -1
  5. data/docs/AbTestCampaignResult.md +13 -0
  6. data/docs/AttributesApi.md +6 -6
  7. data/docs/ContactsApi.md +12 -12
  8. data/docs/CreateContact.md +1 -1
  9. data/docs/CreateEmailCampaign.md +3 -0
  10. data/docs/CreateEmailCampaignSender.md +1 -0
  11. data/docs/CreateSmtpTemplateSender.md +1 -0
  12. data/docs/CreateWebhook.md +1 -1
  13. data/docs/EmailCampaignsApi.md +127 -7
  14. data/docs/GetChildAccountCreationStatus.md +8 -0
  15. data/docs/GetChildrenList.md +1 -0
  16. data/docs/GetDeviceBrowserStats.md +11 -0
  17. data/docs/GetExtendedCampaignOverviewSender.md +1 -0
  18. data/docs/GetExtendedCampaignStats.md +2 -0
  19. data/docs/GetSharedTemplateUrl.md +8 -0
  20. data/docs/GetSmtpTemplateOverviewSender.md +1 -0
  21. data/docs/GetStatsByBrowser.md +7 -0
  22. data/docs/GetStatsByDevice.md +11 -0
  23. data/docs/GetTransacBlockedContacts.md +9 -0
  24. data/docs/GetTransacBlockedContactsContacts.md +11 -0
  25. data/docs/GetTransacBlockedContactsReason.md +9 -0
  26. data/docs/ListsApi.md +1 -1
  27. data/docs/RequestContactExport.md +2 -1
  28. data/docs/RequestContactExportCustomContactFilter.md +13 -0
  29. data/docs/ResellerApi.md +87 -20
  30. data/docs/SMSCampaignsApi.md +3 -3
  31. data/docs/SMTPApi.md +200 -19
  32. data/docs/SendReport.md +1 -1
  33. data/docs/SendReportEmail.md +1 -1
  34. data/docs/SendSmtpEmail.md +2 -2
  35. data/docs/SendSmtpEmailBcc.md +1 -1
  36. data/docs/SendSmtpEmailCc.md +1 -1
  37. data/docs/SendSmtpEmailReplyTo.md +1 -1
  38. data/docs/SendSmtpEmailSender.md +1 -1
  39. data/docs/SendSmtpEmailTo.md +1 -1
  40. data/docs/SendTransacSms.md +1 -1
  41. data/docs/SendersApi.md +2 -2
  42. data/docs/TransactionalSMSApi.md +11 -11
  43. data/docs/UpdateContact.md +1 -1
  44. data/docs/UpdateEmailCampaign.md +3 -0
  45. data/docs/UpdateEmailCampaignSender.md +1 -0
  46. data/docs/UpdateSmtpTemplateSender.md +1 -0
  47. data/docs/WebhooksApi.md +1 -1
  48. data/lib/sib-api-v3-sdk.rb +12 -2
  49. data/lib/sib-api-v3-sdk/api/account_api.rb +6 -9
  50. data/lib/sib-api-v3-sdk/api/attributes_api.rb +15 -27
  51. data/lib/sib-api-v3-sdk/api/contacts_api.rb +81 -155
  52. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +141 -61
  53. data/lib/sib-api-v3-sdk/api/folders_api.rb +21 -39
  54. data/lib/sib-api-v3-sdk/api/lists_api.rb +30 -57
  55. data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
  56. data/lib/sib-api-v3-sdk/api/reseller_api.rb +111 -92
  57. data/lib/sib-api-v3-sdk/api/senders_api.rb +21 -39
  58. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +33 -59
  59. data/lib/sib-api-v3-sdk/api/smtp_api.rb +213 -82
  60. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +15 -27
  61. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
  62. data/lib/sib-api-v3-sdk/api_client.rb +10 -10
  63. data/lib/sib-api-v3-sdk/api_error.rb +2 -2
  64. data/lib/sib-api-v3-sdk/configuration.rb +3 -3
  65. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +280 -0
  66. data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
  67. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +7 -12
  68. data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
  69. data/lib/sib-api-v3-sdk/models/create_attribute.rb +10 -14
  70. data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
  71. data/lib/sib-api-v3-sdk/models/create_child.rb +12 -17
  72. data/lib/sib-api-v3-sdk/models/create_contact.rb +8 -13
  73. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +79 -29
  74. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
  75. data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
  76. data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
  77. data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
  78. data/lib/sib-api-v3-sdk/models/create_reseller.rb +8 -13
  79. data/lib/sib-api-v3-sdk/models/create_sender.rb +9 -14
  80. data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
  81. data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
  82. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +13 -18
  83. data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
  84. data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +8 -13
  85. data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +10 -15
  86. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
  87. data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
  88. data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
  89. data/lib/sib-api-v3-sdk/models/create_webhook.rb +13 -17
  90. data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
  91. data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
  92. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +11 -15
  93. data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
  94. data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
  95. data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
  96. data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
  97. data/lib/sib-api-v3-sdk/models/get_account_relay.rb +9 -13
  98. data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +10 -14
  99. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +20 -25
  100. data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
  101. data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
  102. data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
  103. data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
  104. data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
  105. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +17 -22
  106. data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
  107. data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
  108. data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
  109. data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
  110. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
  111. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
  112. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
  113. data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
  114. data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
  115. data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
  116. data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
  117. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
  118. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
  119. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
  120. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
  121. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
  122. data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
  123. data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
  124. data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
  125. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +29 -33
  126. data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
  127. data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
  128. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
  129. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +27 -31
  130. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
  131. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
  132. data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
  133. data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
  134. data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
  135. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
  136. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
  137. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
  138. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
  139. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
  140. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
  141. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +9 -14
  142. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +10 -15
  143. data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
  144. data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
  145. data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
  146. data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
  147. data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
  148. data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
  149. data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
  150. data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
  151. data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
  152. data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
  153. data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
  154. data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
  155. data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
  156. data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
  157. data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
  158. data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
  159. data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
  160. data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
  161. data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
  162. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
  163. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
  164. data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
  165. data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
  166. data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
  167. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
  168. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +19 -24
  169. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
  170. data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +7 -12
  171. data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
  172. data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
  173. data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
  174. data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
  175. data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
  176. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
  177. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
  178. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
  179. data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +13 -18
  180. data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +9 -14
  181. data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +7 -12
  182. data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +12 -17
  183. data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
  184. data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
  185. data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
  186. data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
  187. data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
  188. data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
  189. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +7 -12
  190. data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
  191. data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
  192. data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
  193. data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +9 -13
  194. data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +9 -14
  195. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +7 -12
  196. data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
  197. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +18 -19
  198. data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
  199. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +7 -12
  200. data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
  201. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +11 -15
  202. data/lib/sib-api-v3-sdk/models/send_email.rb +8 -13
  203. data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
  204. data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
  205. data/lib/sib-api-v3-sdk/models/send_report_email.rb +14 -17
  206. data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
  207. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +10 -15
  208. data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
  209. data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
  210. data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
  211. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +9 -13
  212. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +9 -13
  213. data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
  214. data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
  215. data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
  216. data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
  217. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +17 -21
  218. data/lib/sib-api-v3-sdk/models/update_attribute.rb +7 -12
  219. data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
  220. data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
  221. data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
  222. data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +7 -12
  223. data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
  224. data/lib/sib-api-v3-sdk/models/update_contact.rb +8 -13
  225. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +77 -27
  226. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
  227. data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
  228. data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
  229. data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
  230. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +9 -15
  231. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +7 -12
  232. data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
  233. data/lib/sib-api-v3-sdk/models/update_webhook.rb +7 -11
  234. data/lib/sib-api-v3-sdk/version.rb +3 -3
  235. data/spec/api/account_api_spec.rb +3 -4
  236. data/spec/api/attributes_api_spec.rb +6 -10
  237. data/spec/api/contacts_api_spec.rb +28 -52
  238. data/spec/api/email_campaigns_api_spec.rb +37 -22
  239. data/spec/api/folders_api_spec.rb +8 -14
  240. data/spec/api/lists_api_spec.rb +11 -20
  241. data/spec/api/process_api_spec.rb +4 -6
  242. data/spec/api/reseller_api_spec.rb +31 -32
  243. data/spec/api/senders_api_spec.rb +8 -14
  244. data/spec/api/sms_campaigns_api_spec.rb +12 -20
  245. data/spec/api/smtp_api_spec.rb +53 -27
  246. data/spec/api/transactional_sms_api_spec.rb +6 -10
  247. data/spec/api/webhooks_api_spec.rb +7 -12
  248. data/spec/api_client_spec.rb +36 -36
  249. data/spec/configuration_spec.rb +10 -10
  250. data/spec/models/ab_test_campaign_result_spec.rb +79 -0
  251. data/spec/models/add_child_domain_spec.rb +3 -4
  252. data/spec/models/add_contact_to_list_spec.rb +3 -4
  253. data/spec/models/add_credits_spec.rb +4 -5
  254. data/spec/models/create_attribute_enumeration_spec.rb +4 -5
  255. data/spec/models/create_attribute_spec.rb +9 -10
  256. data/spec/models/create_child_spec.rb +7 -8
  257. data/spec/models/create_contact_spec.rb +9 -10
  258. data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
  259. data/spec/models/create_email_campaign_sender_spec.rb +10 -5
  260. data/spec/models/create_email_campaign_spec.rb +49 -32
  261. data/spec/models/create_list_spec.rb +4 -5
  262. data/spec/models/create_model_spec.rb +3 -4
  263. data/spec/models/create_reseller_spec.rb +3 -4
  264. data/spec/models/create_sender_ips_spec.rb +5 -6
  265. data/spec/models/create_sender_model_spec.rb +5 -6
  266. data/spec/models/create_sender_spec.rb +5 -6
  267. data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
  268. data/spec/models/create_sms_campaign_spec.rb +7 -8
  269. data/spec/models/create_smtp_email_spec.rb +3 -4
  270. data/spec/models/create_smtp_template_sender_spec.rb +10 -5
  271. data/spec/models/create_smtp_template_spec.rb +12 -13
  272. data/spec/models/create_update_contact_model_spec.rb +3 -4
  273. data/spec/models/create_update_folder_spec.rb +3 -4
  274. data/spec/models/create_webhook_spec.rb +14 -15
  275. data/spec/models/created_process_id_spec.rb +3 -4
  276. data/spec/models/delete_hardbounces_spec.rb +5 -6
  277. data/spec/models/email_export_recipients_spec.rb +8 -9
  278. data/spec/models/error_model_spec.rb +8 -9
  279. data/spec/models/get_account_marketing_automation_spec.rb +4 -5
  280. data/spec/models/get_account_plan_spec.rb +16 -17
  281. data/spec/models/get_account_relay_data_spec.rb +5 -6
  282. data/spec/models/get_account_relay_spec.rb +4 -5
  283. data/spec/models/get_account_spec.rb +10 -11
  284. data/spec/models/get_aggregated_report_spec.rb +15 -16
  285. data/spec/models/get_attributes_attributes_spec.rb +15 -16
  286. data/spec/models/get_attributes_enumeration_spec.rb +4 -5
  287. data/spec/models/get_attributes_spec.rb +3 -4
  288. data/spec/models/get_campaign_overview_spec.rb +23 -24
  289. data/spec/models/get_campaign_recipients_spec.rb +4 -5
  290. data/spec/models/get_campaign_stats_spec.rb +14 -15
  291. data/spec/models/get_child_account_creation_status_spec.rb +41 -0
  292. data/spec/models/get_child_domain_spec.rb +4 -5
  293. data/spec/models/get_child_domains_spec.rb +2 -3
  294. data/spec/models/get_child_info_api_keys_spec.rb +4 -5
  295. data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
  296. data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
  297. data/spec/models/get_child_info_credits_spec.rb +4 -5
  298. data/spec/models/get_child_info_spec.rb +11 -12
  299. data/spec/models/get_child_info_statistics_spec.rb +5 -6
  300. data/spec/models/get_children_list_spec.rb +9 -4
  301. data/spec/models/get_client_spec.rb +6 -7
  302. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
  303. data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
  304. data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
  305. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
  306. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
  307. data/spec/models/get_contact_details_spec.rb +11 -12
  308. data/spec/models/get_contacts_spec.rb +4 -5
  309. data/spec/models/get_device_browser_stats_spec.rb +59 -0
  310. data/spec/models/get_email_campaign_spec.rb +40 -41
  311. data/spec/models/get_email_campaigns_spec.rb +4 -5
  312. data/spec/models/get_email_event_report_events_spec.rb +16 -17
  313. data/spec/models/get_email_event_report_spec.rb +3 -4
  314. data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
  315. data/spec/models/get_extended_campaign_overview_spec.rb +38 -39
  316. data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
  317. data/spec/models/get_extended_client_address_spec.rb +6 -7
  318. data/spec/models/get_extended_client_spec.rb +7 -8
  319. data/spec/models/get_extended_contact_details_spec.rb +12 -13
  320. data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
  321. data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
  322. data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
  323. data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
  324. data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
  325. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
  326. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
  327. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
  328. data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
  329. data/spec/models/get_extended_list_spec.rb +10 -11
  330. data/spec/models/get_folder_lists_spec.rb +4 -5
  331. data/spec/models/get_folder_spec.rb +7 -8
  332. data/spec/models/get_folders_spec.rb +4 -5
  333. data/spec/models/get_ip_from_sender_spec.rb +6 -7
  334. data/spec/models/get_ip_spec.rb +6 -7
  335. data/spec/models/get_ips_from_sender_spec.rb +3 -4
  336. data/spec/models/get_ips_spec.rb +3 -4
  337. data/spec/models/get_list_spec.rb +6 -7
  338. data/spec/models/get_lists_spec.rb +4 -5
  339. data/spec/models/get_process_spec.rb +10 -11
  340. data/spec/models/get_processes_spec.rb +4 -5
  341. data/spec/models/get_reports_reports_spec.rb +15 -16
  342. data/spec/models/get_reports_spec.rb +3 -4
  343. data/spec/models/get_senders_list_ips_spec.rb +5 -6
  344. data/spec/models/get_senders_list_senders_spec.rb +7 -8
  345. data/spec/models/get_senders_list_spec.rb +3 -4
  346. data/spec/models/get_shared_template_url_spec.rb +41 -0
  347. data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
  348. data/spec/models/get_sms_campaign_spec.rb +16 -17
  349. data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
  350. data/spec/models/get_sms_campaigns_spec.rb +4 -5
  351. data/spec/models/get_sms_event_report_events_spec.rb +13 -14
  352. data/spec/models/get_sms_event_report_spec.rb +3 -4
  353. data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
  354. data/spec/models/get_smtp_template_overview_spec.rb +14 -15
  355. data/spec/models/get_smtp_templates_spec.rb +4 -5
  356. data/spec/models/get_sso_token_spec.rb +3 -4
  357. data/spec/models/get_stats_by_browser_spec.rb +35 -0
  358. data/spec/models/get_stats_by_device_spec.rb +59 -0
  359. data/spec/models/get_stats_by_domain_spec.rb +2 -3
  360. data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
  361. data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
  362. data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
  363. data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
  364. data/spec/models/get_transac_email_content_events_spec.rb +4 -5
  365. data/spec/models/get_transac_email_content_spec.rb +9 -10
  366. data/spec/models/get_transac_emails_list_spec.rb +3 -4
  367. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +8 -9
  368. data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
  369. data/spec/models/get_transac_sms_report_spec.rb +3 -4
  370. data/spec/models/get_webhook_spec.rb +13 -14
  371. data/spec/models/get_webhooks_spec.rb +3 -4
  372. data/spec/models/manage_ip_spec.rb +3 -4
  373. data/spec/models/post_contact_info_contacts_spec.rb +5 -6
  374. data/spec/models/post_contact_info_spec.rb +3 -4
  375. data/spec/models/post_send_failed_spec.rb +7 -8
  376. data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
  377. data/spec/models/remaining_credit_model_child_spec.rb +4 -5
  378. data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
  379. data/spec/models/remaining_credit_model_spec.rb +4 -5
  380. data/spec/models/remove_contact_from_list_spec.rb +4 -5
  381. data/spec/models/remove_credits_spec.rb +4 -5
  382. data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
  383. data/spec/models/request_contact_export_spec.rb +11 -6
  384. data/spec/models/request_contact_import_new_list_spec.rb +4 -5
  385. data/spec/models/request_contact_import_spec.rb +11 -12
  386. data/spec/models/request_sms_recipient_export_spec.rb +8 -9
  387. data/spec/models/send_email_attachment_spec.rb +4 -5
  388. data/spec/models/send_email_spec.rb +11 -12
  389. data/spec/models/send_report_email_spec.rb +12 -13
  390. data/spec/models/send_report_spec.rb +8 -9
  391. data/spec/models/send_sms_spec.rb +7 -8
  392. data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
  393. data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
  394. data/spec/models/send_smtp_email_cc_spec.rb +4 -5
  395. data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
  396. data/spec/models/send_smtp_email_sender_spec.rb +4 -5
  397. data/spec/models/send_smtp_email_spec.rb +15 -16
  398. data/spec/models/send_smtp_email_to_spec.rb +4 -5
  399. data/spec/models/send_template_email_spec.rb +3 -4
  400. data/spec/models/send_test_email_spec.rb +3 -4
  401. data/spec/models/send_test_sms_spec.rb +3 -4
  402. data/spec/models/send_transac_sms_spec.rb +12 -13
  403. data/spec/models/update_attribute_enumeration_spec.rb +4 -5
  404. data/spec/models/update_attribute_spec.rb +4 -5
  405. data/spec/models/update_campaign_status_spec.rb +7 -8
  406. data/spec/models/update_child_account_status_spec.rb +5 -6
  407. data/spec/models/update_child_domain_spec.rb +3 -4
  408. data/spec/models/update_child_spec.rb +7 -8
  409. data/spec/models/update_contact_spec.rb +8 -9
  410. data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
  411. data/spec/models/update_email_campaign_sender_spec.rb +10 -5
  412. data/spec/models/update_email_campaign_spec.rb +49 -32
  413. data/spec/models/update_list_spec.rb +4 -5
  414. data/spec/models/update_sender_spec.rb +5 -6
  415. data/spec/models/update_sms_campaign_spec.rb +7 -8
  416. data/spec/models/update_smtp_template_sender_spec.rb +10 -5
  417. data/spec/models/update_smtp_template_spec.rb +12 -13
  418. data/spec/models/update_webhook_spec.rb +9 -10
  419. data/spec/spec_helper.rb +2 -2
  420. metadata +42 -2
data/docs/SendReport.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **language** | **String** | Language of email content for campaign report sending. | [optional] [default to "fr"]
6
+ **language** | **String** | Language of email content for campaign report sending. | [optional] [default to 'fr']
7
7
  **email** | [**SendReportEmail**](SendReportEmail.md) | |
8
8
 
9
9
 
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **subject** | **String** | Subject of the email message |
7
7
  **to** | **Array<String>** | Email addresses of the recipients |
8
- **content_type** | **String** | Type of the message body | [optional] [default to "html"]
8
+ **content_type** | **String** | Type of the message body | [optional] [default to 'html']
9
9
  **bcc** | **Array<String>** | Email addresses of the recipients in bcc | [optional]
10
10
  **cc** | **Array<String>** | Email addresses of the recipients in cc | [optional]
11
11
  **body** | **String** | Body of the email message |
@@ -11,8 +11,8 @@ Name | Type | Description | Notes
11
11
  **text_content** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional]
12
12
  **subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
13
13
  **reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
14
- **attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"My attachment 1\"}, {\"content\":\"base64 exmaple content\", \"name\":\"My attachment 2\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then only attachment url is accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
15
- **headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} | [optional]
14
+ **attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"My attachment 1\"}, {\"content\":\"base64 exmaple content\", \"name\":\"My attachment 2\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
15
+ **headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [optional]
16
16
  **template_id** | **Integer** | Id of the template | [optional]
17
17
  **params** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if template is in New Template Language format. | [optional]
18
18
  **tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **email** | **String** | Email address of the recipient in bcc |
7
- **name** | **String** | Name of the recipient in bcc | [optional]
7
+ **name** | **String** | Name of the recipient in bcc. Maximum allowed characters are 70. | [optional]
8
8
 
9
9
 
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **email** | **String** | Email address of the recipient in cc |
7
- **name** | **String** | Name of the recipient in cc | [optional]
7
+ **name** | **String** | Name of the recipient in cc. Maximum allowed characters are 70. | [optional]
8
8
 
9
9
 
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **email** | **String** | Email address in reply to |
7
- **name** | **String** | Name in reply to | [optional]
7
+ **name** | **String** | Name in reply to. Maximum allowed characters are 70. | [optional]
8
8
 
9
9
 
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **name** | **String** | Name of the sender from which the emails will be sent | [optional]
6
+ **name** | **String** | Name of the sender from which the emails will be sent. Maximum allowed characters are 70. | [optional]
7
7
  **email** | **String** | Email of the sender from which the emails will be sent |
8
8
 
9
9
 
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **email** | **String** | Email address of the recipient |
7
- **name** | **String** | Name of the recipient | [optional]
7
+ **name** | **String** | Name of the recipient. Maximum allowed characters are 70. | [optional]
8
8
 
9
9
 
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  **sender** | **String** | Name of the sender. Only alphanumeric characters. No more than 11 characters |
7
7
  **recipient** | **String** | Mobile number to send SMS with the country code |
8
8
  **content** | **String** | Content of the message. If more than 160 characters long, will be sent as multiple text messages |
9
- **type** | **String** | Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. | [optional] [default to "transactional"]
9
+ **type** | **String** | Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. | [optional] [default to 'transactional']
10
10
  **tag** | **String** | Tag of the message | [optional]
11
11
  **web_url** | **String** | Webhook to call for each event triggered by the message (delivered etc.) | [optional]
12
12
 
data/docs/SendersApi.md CHANGED
@@ -259,8 +259,8 @@ end
259
259
  api_instance = SibApiV3Sdk::SendersApi.new
260
260
 
261
261
  opts = {
262
- ip: "ip_example", # String | Filter your senders for a specific ip (available for dedicated IP usage only)
263
- domain: "domain_example" # String | Filter your senders for a specific domain
262
+ ip: 'ip_example', # String | Filter your senders for a specific ip (available for dedicated IP usage only)
263
+ domain: 'domain_example' # String | Filter your senders for a specific domain
264
264
  }
265
265
 
266
266
  begin
@@ -36,13 +36,13 @@ api_instance = SibApiV3Sdk::TransactionalSMSApi.new
36
36
 
37
37
  opts = {
38
38
  limit: 50, # Integer | Number of documents per page
39
- start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
40
- end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
39
+ start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
40
+ end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
41
41
  offset: 0, # Integer | Index of the first document of the page
42
42
  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
43
- phone_number: "phone_number_example", # String | Filter the report for a specific phone number
44
- event: "event_example", # String | Filter the report for specific events
45
- tags: "tags_example" # String | Filter the report for specific tags passed as a serialized urlencoded array
43
+ phone_number: 'phone_number_example', # String | Filter the report for a specific phone number
44
+ event: 'event_example', # String | Filter the report for specific events
45
+ tags: 'tags_example' # String | Filter the report for specific tags passed as a serialized urlencoded array
46
46
  }
47
47
 
48
48
  begin
@@ -107,10 +107,10 @@ end
107
107
  api_instance = SibApiV3Sdk::TransactionalSMSApi.new
108
108
 
109
109
  opts = {
110
- start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
111
- end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
110
+ start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
111
+ end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
112
112
  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with startDate and endDate
113
- tag: "tag_example" # String | Filter on a tag
113
+ tag: 'tag_example' # String | Filter on a tag
114
114
  }
115
115
 
116
116
  begin
@@ -171,10 +171,10 @@ end
171
171
  api_instance = SibApiV3Sdk::TransactionalSMSApi.new
172
172
 
173
173
  opts = {
174
- start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
175
- end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
174
+ start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
175
+ end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
176
176
  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
177
- tag: "tag_example" # String | Filter on a tag
177
+ tag: 'tag_example' # String | Filter on a tag
178
178
  }
179
179
 
180
180
  begin
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For eg. { 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'} | [optional]
6
+ **attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, { 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'} `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. Keep in mind transactional attributes can be updated the same way as normal attributes. | [optional]
7
7
  **email_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional]
8
8
  **sms_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional]
9
9
  **list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
@@ -28,5 +28,8 @@ Name | Type | Description | Notes
28
28
  **split_rule** | **Integer** | Add the size of your test groups. Considered if abTesting = true. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional]
29
29
  **winner_criteria** | **String** | Choose the metrics that will determinate the winning version. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed or alreday exist in record | [optional]
30
30
  **winner_delay** | **Integer** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed or alreday exist in record | [optional]
31
+ **ip_warmup_enable** | **BOOLEAN** | Available for dedicated ip clients. Set this to true if you wish to warm up your ip. | [optional] [default to false]
32
+ **initial_quota** | **Integer** | Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional]
33
+ **increase_rate** | **Integer** | Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. | [optional]
31
34
 
32
35
 
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **name** | **String** | Sender Name from which the campaign emails are sent | [optional]
7
7
  **email** | **String** | Sender email from which the campaign emails are sent | [optional]
8
+ **id** | **Integer** | Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional]
8
9
 
9
10
 
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **name** | **String** | Name of the sender | [optional]
7
7
  **email** | **String** | Email of the sender | [optional]
8
+ **id** | **Integer** | Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional]
8
9
 
9
10
 
data/docs/WebhooksApi.md CHANGED
@@ -206,7 +206,7 @@ end
206
206
  api_instance = SibApiV3Sdk::WebhooksApi.new
207
207
 
208
208
  opts = {
209
- type: "transactional" # String | Filter on webhook type
209
+ type: 'transactional' # String | Filter on webhook type
210
210
  }
211
211
 
212
212
  begin
@@ -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
 
@@ -17,6 +17,7 @@ require 'sib-api-v3-sdk/version'
17
17
  require 'sib-api-v3-sdk/configuration'
18
18
 
19
19
  # Models
20
+ require 'sib-api-v3-sdk/models/ab_test_campaign_result'
20
21
  require 'sib-api-v3-sdk/models/add_child_domain'
21
22
  require 'sib-api-v3-sdk/models/add_contact_to_list'
22
23
  require 'sib-api-v3-sdk/models/add_credits'
@@ -56,6 +57,7 @@ require 'sib-api-v3-sdk/models/get_attributes_enumeration'
56
57
  require 'sib-api-v3-sdk/models/get_campaign_overview'
57
58
  require 'sib-api-v3-sdk/models/get_campaign_recipients'
58
59
  require 'sib-api-v3-sdk/models/get_campaign_stats'
60
+ require 'sib-api-v3-sdk/models/get_child_account_creation_status'
59
61
  require 'sib-api-v3-sdk/models/get_child_domain'
60
62
  require 'sib-api-v3-sdk/models/get_child_domains'
61
63
  require 'sib-api-v3-sdk/models/get_child_info_api_keys'
@@ -72,6 +74,7 @@ require 'sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes'
72
74
  require 'sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions'
73
75
  require 'sib-api-v3-sdk/models/get_contact_details'
74
76
  require 'sib-api-v3-sdk/models/get_contacts'
77
+ require 'sib-api-v3-sdk/models/get_device_browser_stats'
75
78
  require 'sib-api-v3-sdk/models/get_email_campaigns'
76
79
  require 'sib-api-v3-sdk/models/get_email_event_report'
77
80
  require 'sib-api-v3-sdk/models/get_email_event_report_events'
@@ -103,6 +106,7 @@ require 'sib-api-v3-sdk/models/get_reports_reports'
103
106
  require 'sib-api-v3-sdk/models/get_senders_list'
104
107
  require 'sib-api-v3-sdk/models/get_senders_list_ips'
105
108
  require 'sib-api-v3-sdk/models/get_senders_list_senders'
109
+ require 'sib-api-v3-sdk/models/get_shared_template_url'
106
110
  require 'sib-api-v3-sdk/models/get_sms_campaign_overview'
107
111
  require 'sib-api-v3-sdk/models/get_sms_campaign_stats'
108
112
  require 'sib-api-v3-sdk/models/get_sms_campaigns'
@@ -112,8 +116,13 @@ require 'sib-api-v3-sdk/models/get_smtp_template_overview'
112
116
  require 'sib-api-v3-sdk/models/get_smtp_template_overview_sender'
113
117
  require 'sib-api-v3-sdk/models/get_smtp_templates'
114
118
  require 'sib-api-v3-sdk/models/get_sso_token'
119
+ require 'sib-api-v3-sdk/models/get_stats_by_browser'
120
+ require 'sib-api-v3-sdk/models/get_stats_by_device'
115
121
  require 'sib-api-v3-sdk/models/get_stats_by_domain'
116
122
  require 'sib-api-v3-sdk/models/get_transac_aggregated_sms_report'
123
+ require 'sib-api-v3-sdk/models/get_transac_blocked_contacts'
124
+ require 'sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts'
125
+ require 'sib-api-v3-sdk/models/get_transac_blocked_contacts_reason'
117
126
  require 'sib-api-v3-sdk/models/get_transac_email_content'
118
127
  require 'sib-api-v3-sdk/models/get_transac_email_content_events'
119
128
  require 'sib-api-v3-sdk/models/get_transac_emails_list'
@@ -133,6 +142,7 @@ require 'sib-api-v3-sdk/models/remaining_credit_model_reseller'
133
142
  require 'sib-api-v3-sdk/models/remove_contact_from_list'
134
143
  require 'sib-api-v3-sdk/models/remove_credits'
135
144
  require 'sib-api-v3-sdk/models/request_contact_export'
145
+ require 'sib-api-v3-sdk/models/request_contact_export_custom_contact_filter'
136
146
  require 'sib-api-v3-sdk/models/request_contact_import'
137
147
  require 'sib-api-v3-sdk/models/request_contact_import_new_list'
138
148
  require 'sib-api-v3-sdk/models/request_sms_recipient_export'
@@ -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 AccountApi
@@ -19,26 +19,23 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
-
23
22
  # Get your account informations, plans and credits details
24
- #
25
23
  # @param [Hash] opts the optional parameters
26
24
  # @return [GetAccount]
27
25
  def get_account(opts = {})
28
26
  data, _status_code, _headers = get_account_with_http_info(opts)
29
- return data
27
+ data
30
28
  end
31
29
 
32
30
  # Get your account informations, plans and credits details
33
- #
34
31
  # @param [Hash] opts the optional parameters
35
32
  # @return [Array<(GetAccount, Fixnum, Hash)>] GetAccount data, response status code and response headers
36
33
  def get_account_with_http_info(opts = {})
37
34
  if @api_client.config.debugging
38
- @api_client.config.logger.debug "Calling API: AccountApi.get_account ..."
35
+ @api_client.config.logger.debug 'Calling API: AccountApi.get_account ...'
39
36
  end
40
37
  # resource path
41
- local_var_path = "/account"
38
+ local_var_path = '/account'
42
39
 
43
40
  # query parameters
44
41
  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 AttributesApi
@@ -19,9 +19,7 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
-
23
22
  # Creates contact attribute
24
- #
25
23
  # @param attribute_category Category of the attribute
26
24
  # @param attribute_name Name of the attribute
27
25
  # @param create_attribute Values to create an attribute
@@ -29,11 +27,10 @@ module SibApiV3Sdk
29
27
  # @return [nil]
30
28
  def create_attribute(attribute_category, attribute_name, create_attribute, opts = {})
31
29
  create_attribute_with_http_info(attribute_category, attribute_name, create_attribute, opts)
32
- return nil
30
+ nil
33
31
  end
34
32
 
35
33
  # Creates contact attribute
36
- #
37
34
  # @param attribute_category Category of the attribute
38
35
  # @param attribute_name Name of the attribute
39
36
  # @param create_attribute Values to create an attribute
@@ -41,7 +38,7 @@ module SibApiV3Sdk
41
38
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
42
39
  def create_attribute_with_http_info(attribute_category, attribute_name, create_attribute, opts = {})
43
40
  if @api_client.config.debugging
44
- @api_client.config.logger.debug "Calling API: AttributesApi.create_attribute ..."
41
+ @api_client.config.logger.debug 'Calling API: AttributesApi.create_attribute ...'
45
42
  end
46
43
  # verify the required parameter 'attribute_category' is set
47
44
  if @api_client.config.client_side_validation && attribute_category.nil?
@@ -60,7 +57,7 @@ module SibApiV3Sdk
60
57
  fail ArgumentError, "Missing the required parameter 'create_attribute' when calling AttributesApi.create_attribute"
61
58
  end
62
59
  # resource path
63
- local_var_path = "/contacts/attributes/{attributeCategory}/{attributeName}".sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
60
+ local_var_path = '/contacts/attributes/{attributeCategory}/{attributeName}'.sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
64
61
 
65
62
  # query parameters
66
63
  query_params = {}
@@ -89,27 +86,24 @@ module SibApiV3Sdk
89
86
  end
90
87
  return data, status_code, headers
91
88
  end
92
-
93
89
  # Deletes an attribute
94
- #
95
90
  # @param attribute_category Category of the attribute
96
91
  # @param attribute_name Name of the existing attribute
97
92
  # @param [Hash] opts the optional parameters
98
93
  # @return [nil]
99
94
  def delete_attribute(attribute_category, attribute_name, opts = {})
100
95
  delete_attribute_with_http_info(attribute_category, attribute_name, opts)
101
- return nil
96
+ nil
102
97
  end
103
98
 
104
99
  # Deletes an attribute
105
- #
106
100
  # @param attribute_category Category of the attribute
107
101
  # @param attribute_name Name of the existing attribute
108
102
  # @param [Hash] opts the optional parameters
109
103
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
110
104
  def delete_attribute_with_http_info(attribute_category, attribute_name, opts = {})
111
105
  if @api_client.config.debugging
112
- @api_client.config.logger.debug "Calling API: AttributesApi.delete_attribute ..."
106
+ @api_client.config.logger.debug 'Calling API: AttributesApi.delete_attribute ...'
113
107
  end
114
108
  # verify the required parameter 'attribute_category' is set
115
109
  if @api_client.config.client_side_validation && attribute_category.nil?
@@ -124,7 +118,7 @@ module SibApiV3Sdk
124
118
  fail ArgumentError, "Missing the required parameter 'attribute_name' when calling AttributesApi.delete_attribute"
125
119
  end
126
120
  # resource path
127
- local_var_path = "/contacts/attributes/{attributeCategory}/{attributeName}".sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
121
+ local_var_path = '/contacts/attributes/{attributeCategory}/{attributeName}'.sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
128
122
 
129
123
  # query parameters
130
124
  query_params = {}
@@ -153,26 +147,23 @@ module SibApiV3Sdk
153
147
  end
154
148
  return data, status_code, headers
155
149
  end
156
-
157
150
  # Lists all attributes
158
- #
159
151
  # @param [Hash] opts the optional parameters
160
152
  # @return [GetAttributes]
161
153
  def get_attributes(opts = {})
162
154
  data, _status_code, _headers = get_attributes_with_http_info(opts)
163
- return data
155
+ data
164
156
  end
165
157
 
166
158
  # Lists all attributes
167
- #
168
159
  # @param [Hash] opts the optional parameters
169
160
  # @return [Array<(GetAttributes, Fixnum, Hash)>] GetAttributes data, response status code and response headers
170
161
  def get_attributes_with_http_info(opts = {})
171
162
  if @api_client.config.debugging
172
- @api_client.config.logger.debug "Calling API: AttributesApi.get_attributes ..."
163
+ @api_client.config.logger.debug 'Calling API: AttributesApi.get_attributes ...'
173
164
  end
174
165
  # resource path
175
- local_var_path = "/contacts/attributes"
166
+ local_var_path = '/contacts/attributes'
176
167
 
177
168
  # query parameters
178
169
  query_params = {}
@@ -202,9 +193,7 @@ module SibApiV3Sdk
202
193
  end
203
194
  return data, status_code, headers
204
195
  end
205
-
206
196
  # Updates contact attribute
207
- #
208
197
  # @param attribute_category Category of the attribute
209
198
  # @param attribute_name Name of the existing attribute
210
199
  # @param update_attribute Values to update an attribute
@@ -212,11 +201,10 @@ module SibApiV3Sdk
212
201
  # @return [nil]
213
202
  def update_attribute(attribute_category, attribute_name, update_attribute, opts = {})
214
203
  update_attribute_with_http_info(attribute_category, attribute_name, update_attribute, opts)
215
- return nil
204
+ nil
216
205
  end
217
206
 
218
207
  # Updates contact attribute
219
- #
220
208
  # @param attribute_category Category of the attribute
221
209
  # @param attribute_name Name of the existing attribute
222
210
  # @param update_attribute Values to update an attribute
@@ -224,7 +212,7 @@ module SibApiV3Sdk
224
212
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
225
213
  def update_attribute_with_http_info(attribute_category, attribute_name, update_attribute, opts = {})
226
214
  if @api_client.config.debugging
227
- @api_client.config.logger.debug "Calling API: AttributesApi.update_attribute ..."
215
+ @api_client.config.logger.debug 'Calling API: AttributesApi.update_attribute ...'
228
216
  end
229
217
  # verify the required parameter 'attribute_category' is set
230
218
  if @api_client.config.client_side_validation && attribute_category.nil?
@@ -243,7 +231,7 @@ module SibApiV3Sdk
243
231
  fail ArgumentError, "Missing the required parameter 'update_attribute' when calling AttributesApi.update_attribute"
244
232
  end
245
233
  # resource path
246
- local_var_path = "/contacts/attributes/{attributeCategory}/{attributeName}".sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
234
+ local_var_path = '/contacts/attributes/{attributeCategory}/{attributeName}'.sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
247
235
 
248
236
  # query parameters
249
237
  query_params = {}