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
@@ -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 ContactsApi
@@ -19,27 +19,24 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
-
23
22
  # Add existing contacts to a list
24
- #
25
23
  # @param list_id Id of the list
26
24
  # @param contact_emails Emails addresses of the contacts
27
25
  # @param [Hash] opts the optional parameters
28
26
  # @return [PostContactInfo]
29
27
  def add_contact_to_list(list_id, contact_emails, opts = {})
30
28
  data, _status_code, _headers = add_contact_to_list_with_http_info(list_id, contact_emails, opts)
31
- return data
29
+ data
32
30
  end
33
31
 
34
32
  # Add existing contacts to a list
35
- #
36
33
  # @param list_id Id of the list
37
34
  # @param contact_emails Emails addresses of the contacts
38
35
  # @param [Hash] opts the optional parameters
39
36
  # @return [Array<(PostContactInfo, Fixnum, Hash)>] PostContactInfo data, response status code and response headers
40
37
  def add_contact_to_list_with_http_info(list_id, contact_emails, opts = {})
41
38
  if @api_client.config.debugging
42
- @api_client.config.logger.debug "Calling API: ContactsApi.add_contact_to_list ..."
39
+ @api_client.config.logger.debug 'Calling API: ContactsApi.add_contact_to_list ...'
43
40
  end
44
41
  # verify the required parameter 'list_id' is set
45
42
  if @api_client.config.client_side_validation && list_id.nil?
@@ -50,7 +47,7 @@ module SibApiV3Sdk
50
47
  fail ArgumentError, "Missing the required parameter 'contact_emails' when calling ContactsApi.add_contact_to_list"
51
48
  end
52
49
  # resource path
53
- local_var_path = "/contacts/lists/{listId}/contacts/add".sub('{' + 'listId' + '}', list_id.to_s)
50
+ local_var_path = '/contacts/lists/{listId}/contacts/add'.sub('{' + 'listId' + '}', list_id.to_s)
54
51
 
55
52
  # query parameters
56
53
  query_params = {}
@@ -80,9 +77,7 @@ module SibApiV3Sdk
80
77
  end
81
78
  return data, status_code, headers
82
79
  end
83
-
84
80
  # Creates contact attribute
85
- #
86
81
  # @param attribute_category Category of the attribute
87
82
  # @param attribute_name Name of the attribute
88
83
  # @param create_attribute Values to create an attribute
@@ -90,11 +85,10 @@ module SibApiV3Sdk
90
85
  # @return [nil]
91
86
  def create_attribute(attribute_category, attribute_name, create_attribute, opts = {})
92
87
  create_attribute_with_http_info(attribute_category, attribute_name, create_attribute, opts)
93
- return nil
88
+ nil
94
89
  end
95
90
 
96
91
  # Creates contact attribute
97
- #
98
92
  # @param attribute_category Category of the attribute
99
93
  # @param attribute_name Name of the attribute
100
94
  # @param create_attribute Values to create an attribute
@@ -102,7 +96,7 @@ module SibApiV3Sdk
102
96
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
103
97
  def create_attribute_with_http_info(attribute_category, attribute_name, create_attribute, opts = {})
104
98
  if @api_client.config.debugging
105
- @api_client.config.logger.debug "Calling API: ContactsApi.create_attribute ..."
99
+ @api_client.config.logger.debug 'Calling API: ContactsApi.create_attribute ...'
106
100
  end
107
101
  # verify the required parameter 'attribute_category' is set
108
102
  if @api_client.config.client_side_validation && attribute_category.nil?
@@ -121,7 +115,7 @@ module SibApiV3Sdk
121
115
  fail ArgumentError, "Missing the required parameter 'create_attribute' when calling ContactsApi.create_attribute"
122
116
  end
123
117
  # resource path
124
- local_var_path = "/contacts/attributes/{attributeCategory}/{attributeName}".sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
118
+ local_var_path = '/contacts/attributes/{attributeCategory}/{attributeName}'.sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
125
119
 
126
120
  # query parameters
127
121
  query_params = {}
@@ -150,32 +144,29 @@ module SibApiV3Sdk
150
144
  end
151
145
  return data, status_code, headers
152
146
  end
153
-
154
147
  # Create a contact
155
- #
156
148
  # @param create_contact Values to create a contact
157
149
  # @param [Hash] opts the optional parameters
158
150
  # @return [CreateUpdateContactModel]
159
151
  def create_contact(create_contact, opts = {})
160
152
  data, _status_code, _headers = create_contact_with_http_info(create_contact, opts)
161
- return data
153
+ data
162
154
  end
163
155
 
164
156
  # Create a contact
165
- #
166
157
  # @param create_contact Values to create a contact
167
158
  # @param [Hash] opts the optional parameters
168
159
  # @return [Array<(CreateUpdateContactModel, Fixnum, Hash)>] CreateUpdateContactModel data, response status code and response headers
169
160
  def create_contact_with_http_info(create_contact, opts = {})
170
161
  if @api_client.config.debugging
171
- @api_client.config.logger.debug "Calling API: ContactsApi.create_contact ..."
162
+ @api_client.config.logger.debug 'Calling API: ContactsApi.create_contact ...'
172
163
  end
173
164
  # verify the required parameter 'create_contact' is set
174
165
  if @api_client.config.client_side_validation && create_contact.nil?
175
166
  fail ArgumentError, "Missing the required parameter 'create_contact' when calling ContactsApi.create_contact"
176
167
  end
177
168
  # resource path
178
- local_var_path = "/contacts"
169
+ local_var_path = '/contacts'
179
170
 
180
171
  # query parameters
181
172
  query_params = {}
@@ -205,32 +196,29 @@ module SibApiV3Sdk
205
196
  end
206
197
  return data, status_code, headers
207
198
  end
208
-
209
199
  # Create a folder
210
- #
211
200
  # @param create_folder Name of the folder
212
201
  # @param [Hash] opts the optional parameters
213
202
  # @return [CreateModel]
214
203
  def create_folder(create_folder, opts = {})
215
204
  data, _status_code, _headers = create_folder_with_http_info(create_folder, opts)
216
- return data
205
+ data
217
206
  end
218
207
 
219
208
  # Create a folder
220
- #
221
209
  # @param create_folder Name of the folder
222
210
  # @param [Hash] opts the optional parameters
223
211
  # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers
224
212
  def create_folder_with_http_info(create_folder, opts = {})
225
213
  if @api_client.config.debugging
226
- @api_client.config.logger.debug "Calling API: ContactsApi.create_folder ..."
214
+ @api_client.config.logger.debug 'Calling API: ContactsApi.create_folder ...'
227
215
  end
228
216
  # verify the required parameter 'create_folder' is set
229
217
  if @api_client.config.client_side_validation && create_folder.nil?
230
218
  fail ArgumentError, "Missing the required parameter 'create_folder' when calling ContactsApi.create_folder"
231
219
  end
232
220
  # resource path
233
- local_var_path = "/contacts/folders"
221
+ local_var_path = '/contacts/folders'
234
222
 
235
223
  # query parameters
236
224
  query_params = {}
@@ -260,32 +248,29 @@ module SibApiV3Sdk
260
248
  end
261
249
  return data, status_code, headers
262
250
  end
263
-
264
251
  # Create a list
265
- #
266
252
  # @param create_list Values to create a list
267
253
  # @param [Hash] opts the optional parameters
268
254
  # @return [CreateModel]
269
255
  def create_list(create_list, opts = {})
270
256
  data, _status_code, _headers = create_list_with_http_info(create_list, opts)
271
- return data
257
+ data
272
258
  end
273
259
 
274
260
  # Create a list
275
- #
276
261
  # @param create_list Values to create a list
277
262
  # @param [Hash] opts the optional parameters
278
263
  # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers
279
264
  def create_list_with_http_info(create_list, opts = {})
280
265
  if @api_client.config.debugging
281
- @api_client.config.logger.debug "Calling API: ContactsApi.create_list ..."
266
+ @api_client.config.logger.debug 'Calling API: ContactsApi.create_list ...'
282
267
  end
283
268
  # verify the required parameter 'create_list' is set
284
269
  if @api_client.config.client_side_validation && create_list.nil?
285
270
  fail ArgumentError, "Missing the required parameter 'create_list' when calling ContactsApi.create_list"
286
271
  end
287
272
  # resource path
288
- local_var_path = "/contacts/lists"
273
+ local_var_path = '/contacts/lists'
289
274
 
290
275
  # query parameters
291
276
  query_params = {}
@@ -315,27 +300,24 @@ module SibApiV3Sdk
315
300
  end
316
301
  return data, status_code, headers
317
302
  end
318
-
319
303
  # Deletes an attribute
320
- #
321
304
  # @param attribute_category Category of the attribute
322
305
  # @param attribute_name Name of the existing attribute
323
306
  # @param [Hash] opts the optional parameters
324
307
  # @return [nil]
325
308
  def delete_attribute(attribute_category, attribute_name, opts = {})
326
309
  delete_attribute_with_http_info(attribute_category, attribute_name, opts)
327
- return nil
310
+ nil
328
311
  end
329
312
 
330
313
  # Deletes an attribute
331
- #
332
314
  # @param attribute_category Category of the attribute
333
315
  # @param attribute_name Name of the existing attribute
334
316
  # @param [Hash] opts the optional parameters
335
317
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
336
318
  def delete_attribute_with_http_info(attribute_category, attribute_name, opts = {})
337
319
  if @api_client.config.debugging
338
- @api_client.config.logger.debug "Calling API: ContactsApi.delete_attribute ..."
320
+ @api_client.config.logger.debug 'Calling API: ContactsApi.delete_attribute ...'
339
321
  end
340
322
  # verify the required parameter 'attribute_category' is set
341
323
  if @api_client.config.client_side_validation && attribute_category.nil?
@@ -350,7 +332,7 @@ module SibApiV3Sdk
350
332
  fail ArgumentError, "Missing the required parameter 'attribute_name' when calling ContactsApi.delete_attribute"
351
333
  end
352
334
  # resource path
353
- local_var_path = "/contacts/attributes/{attributeCategory}/{attributeName}".sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
335
+ local_var_path = '/contacts/attributes/{attributeCategory}/{attributeName}'.sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
354
336
 
355
337
  # query parameters
356
338
  query_params = {}
@@ -379,32 +361,29 @@ module SibApiV3Sdk
379
361
  end
380
362
  return data, status_code, headers
381
363
  end
382
-
383
364
  # Deletes a contact
384
- #
385
365
  # @param email Email (urlencoded) of the contact
386
366
  # @param [Hash] opts the optional parameters
387
367
  # @return [nil]
388
368
  def delete_contact(email, opts = {})
389
369
  delete_contact_with_http_info(email, opts)
390
- return nil
370
+ nil
391
371
  end
392
372
 
393
373
  # Deletes a contact
394
- #
395
374
  # @param email Email (urlencoded) of the contact
396
375
  # @param [Hash] opts the optional parameters
397
376
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
398
377
  def delete_contact_with_http_info(email, opts = {})
399
378
  if @api_client.config.debugging
400
- @api_client.config.logger.debug "Calling API: ContactsApi.delete_contact ..."
379
+ @api_client.config.logger.debug 'Calling API: ContactsApi.delete_contact ...'
401
380
  end
402
381
  # verify the required parameter 'email' is set
403
382
  if @api_client.config.client_side_validation && email.nil?
404
383
  fail ArgumentError, "Missing the required parameter 'email' when calling ContactsApi.delete_contact"
405
384
  end
406
385
  # resource path
407
- local_var_path = "/contacts/{email}".sub('{' + 'email' + '}', email.to_s)
386
+ local_var_path = '/contacts/{email}'.sub('{' + 'email' + '}', email.to_s)
408
387
 
409
388
  # query parameters
410
389
  query_params = {}
@@ -433,32 +412,29 @@ module SibApiV3Sdk
433
412
  end
434
413
  return data, status_code, headers
435
414
  end
436
-
437
415
  # Delete a folder (and all its lists)
438
- #
439
416
  # @param folder_id Id of the folder
440
417
  # @param [Hash] opts the optional parameters
441
418
  # @return [nil]
442
419
  def delete_folder(folder_id, opts = {})
443
420
  delete_folder_with_http_info(folder_id, opts)
444
- return nil
421
+ nil
445
422
  end
446
423
 
447
424
  # Delete a folder (and all its lists)
448
- #
449
425
  # @param folder_id Id of the folder
450
426
  # @param [Hash] opts the optional parameters
451
427
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
452
428
  def delete_folder_with_http_info(folder_id, opts = {})
453
429
  if @api_client.config.debugging
454
- @api_client.config.logger.debug "Calling API: ContactsApi.delete_folder ..."
430
+ @api_client.config.logger.debug 'Calling API: ContactsApi.delete_folder ...'
455
431
  end
456
432
  # verify the required parameter 'folder_id' is set
457
433
  if @api_client.config.client_side_validation && folder_id.nil?
458
434
  fail ArgumentError, "Missing the required parameter 'folder_id' when calling ContactsApi.delete_folder"
459
435
  end
460
436
  # resource path
461
- local_var_path = "/contacts/folders/{folderId}".sub('{' + 'folderId' + '}', folder_id.to_s)
437
+ local_var_path = '/contacts/folders/{folderId}'.sub('{' + 'folderId' + '}', folder_id.to_s)
462
438
 
463
439
  # query parameters
464
440
  query_params = {}
@@ -487,32 +463,29 @@ module SibApiV3Sdk
487
463
  end
488
464
  return data, status_code, headers
489
465
  end
490
-
491
466
  # Delete a list
492
- #
493
467
  # @param list_id Id of the list
494
468
  # @param [Hash] opts the optional parameters
495
469
  # @return [nil]
496
470
  def delete_list(list_id, opts = {})
497
471
  delete_list_with_http_info(list_id, opts)
498
- return nil
472
+ nil
499
473
  end
500
474
 
501
475
  # Delete a list
502
- #
503
476
  # @param list_id Id of the list
504
477
  # @param [Hash] opts the optional parameters
505
478
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
506
479
  def delete_list_with_http_info(list_id, opts = {})
507
480
  if @api_client.config.debugging
508
- @api_client.config.logger.debug "Calling API: ContactsApi.delete_list ..."
481
+ @api_client.config.logger.debug 'Calling API: ContactsApi.delete_list ...'
509
482
  end
510
483
  # verify the required parameter 'list_id' is set
511
484
  if @api_client.config.client_side_validation && list_id.nil?
512
485
  fail ArgumentError, "Missing the required parameter 'list_id' when calling ContactsApi.delete_list"
513
486
  end
514
487
  # resource path
515
- local_var_path = "/contacts/lists/{listId}".sub('{' + 'listId' + '}', list_id.to_s)
488
+ local_var_path = '/contacts/lists/{listId}'.sub('{' + 'listId' + '}', list_id.to_s)
516
489
 
517
490
  # query parameters
518
491
  query_params = {}
@@ -541,26 +514,23 @@ module SibApiV3Sdk
541
514
  end
542
515
  return data, status_code, headers
543
516
  end
544
-
545
517
  # Lists all attributes
546
- #
547
518
  # @param [Hash] opts the optional parameters
548
519
  # @return [GetAttributes]
549
520
  def get_attributes(opts = {})
550
521
  data, _status_code, _headers = get_attributes_with_http_info(opts)
551
- return data
522
+ data
552
523
  end
553
524
 
554
525
  # Lists all attributes
555
- #
556
526
  # @param [Hash] opts the optional parameters
557
527
  # @return [Array<(GetAttributes, Fixnum, Hash)>] GetAttributes data, response status code and response headers
558
528
  def get_attributes_with_http_info(opts = {})
559
529
  if @api_client.config.debugging
560
- @api_client.config.logger.debug "Calling API: ContactsApi.get_attributes ..."
530
+ @api_client.config.logger.debug 'Calling API: ContactsApi.get_attributes ...'
561
531
  end
562
532
  # resource path
563
- local_var_path = "/contacts/attributes"
533
+ local_var_path = '/contacts/attributes'
564
534
 
565
535
  # query parameters
566
536
  query_params = {}
@@ -590,32 +560,29 @@ module SibApiV3Sdk
590
560
  end
591
561
  return data, status_code, headers
592
562
  end
593
-
594
563
  # Retrieves contact informations
595
- #
596
564
  # @param email Email (urlencoded) of the contact OR its SMS attribute value
597
565
  # @param [Hash] opts the optional parameters
598
566
  # @return [GetExtendedContactDetails]
599
567
  def get_contact_info(email, opts = {})
600
568
  data, _status_code, _headers = get_contact_info_with_http_info(email, opts)
601
- return data
569
+ data
602
570
  end
603
571
 
604
572
  # Retrieves contact informations
605
- #
606
573
  # @param email Email (urlencoded) of the contact OR its SMS attribute value
607
574
  # @param [Hash] opts the optional parameters
608
575
  # @return [Array<(GetExtendedContactDetails, Fixnum, Hash)>] GetExtendedContactDetails data, response status code and response headers
609
576
  def get_contact_info_with_http_info(email, opts = {})
610
577
  if @api_client.config.debugging
611
- @api_client.config.logger.debug "Calling API: ContactsApi.get_contact_info ..."
578
+ @api_client.config.logger.debug 'Calling API: ContactsApi.get_contact_info ...'
612
579
  end
613
580
  # verify the required parameter 'email' is set
614
581
  if @api_client.config.client_side_validation && email.nil?
615
582
  fail ArgumentError, "Missing the required parameter 'email' when calling ContactsApi.get_contact_info"
616
583
  end
617
584
  # resource path
618
- local_var_path = "/contacts/{email}".sub('{' + 'email' + '}', email.to_s)
585
+ local_var_path = '/contacts/{email}'.sub('{' + 'email' + '}', email.to_s)
619
586
 
620
587
  # query parameters
621
588
  query_params = {}
@@ -645,32 +612,29 @@ module SibApiV3Sdk
645
612
  end
646
613
  return data, status_code, headers
647
614
  end
648
-
649
615
  # Get the campaigns statistics for a contact
650
- #
651
616
  # @param email Email address (urlencoded) of the contact
652
617
  # @param [Hash] opts the optional parameters
653
618
  # @return [GetContactCampaignStats]
654
619
  def get_contact_stats(email, opts = {})
655
620
  data, _status_code, _headers = get_contact_stats_with_http_info(email, opts)
656
- return data
621
+ data
657
622
  end
658
623
 
659
624
  # Get the campaigns statistics for a contact
660
- #
661
625
  # @param email Email address (urlencoded) of the contact
662
626
  # @param [Hash] opts the optional parameters
663
627
  # @return [Array<(GetContactCampaignStats, Fixnum, Hash)>] GetContactCampaignStats data, response status code and response headers
664
628
  def get_contact_stats_with_http_info(email, opts = {})
665
629
  if @api_client.config.debugging
666
- @api_client.config.logger.debug "Calling API: ContactsApi.get_contact_stats ..."
630
+ @api_client.config.logger.debug 'Calling API: ContactsApi.get_contact_stats ...'
667
631
  end
668
632
  # verify the required parameter 'email' is set
669
633
  if @api_client.config.client_side_validation && email.nil?
670
634
  fail ArgumentError, "Missing the required parameter 'email' when calling ContactsApi.get_contact_stats"
671
635
  end
672
636
  # resource path
673
- local_var_path = "/contacts/{email}/campaignStats".sub('{' + 'email' + '}', email.to_s)
637
+ local_var_path = '/contacts/{email}/campaignStats'.sub('{' + 'email' + '}', email.to_s)
674
638
 
675
639
  # query parameters
676
640
  query_params = {}
@@ -700,9 +664,7 @@ module SibApiV3Sdk
700
664
  end
701
665
  return data, status_code, headers
702
666
  end
703
-
704
667
  # Get all the contacts
705
- #
706
668
  # @param [Hash] opts the optional parameters
707
669
  # @option opts [Integer] :limit Number of documents per page (default to 50)
708
670
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
@@ -710,11 +672,10 @@ module SibApiV3Sdk
710
672
  # @return [GetContacts]
711
673
  def get_contacts(opts = {})
712
674
  data, _status_code, _headers = get_contacts_with_http_info(opts)
713
- return data
675
+ data
714
676
  end
715
677
 
716
678
  # Get all the contacts
717
- #
718
679
  # @param [Hash] opts the optional parameters
719
680
  # @option opts [Integer] :limit Number of documents per page
720
681
  # @option opts [Integer] :offset Index of the first document of the page
@@ -722,14 +683,14 @@ module SibApiV3Sdk
722
683
  # @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
723
684
  def get_contacts_with_http_info(opts = {})
724
685
  if @api_client.config.debugging
725
- @api_client.config.logger.debug "Calling API: ContactsApi.get_contacts ..."
686
+ @api_client.config.logger.debug 'Calling API: ContactsApi.get_contacts ...'
726
687
  end
727
688
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
728
689
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_contacts, must be smaller than or equal to 1000.'
729
690
  end
730
691
 
731
692
  # resource path
732
- local_var_path = "/contacts"
693
+ local_var_path = '/contacts'
733
694
 
734
695
  # query parameters
735
696
  query_params = {}
@@ -762,9 +723,7 @@ module SibApiV3Sdk
762
723
  end
763
724
  return data, status_code, headers
764
725
  end
765
-
766
726
  # Get the contacts in a list
767
- #
768
727
  # @param list_id Id of the list
769
728
  # @param [Hash] opts the optional parameters
770
729
  # @option opts [DateTime] :modified_since Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
@@ -773,11 +732,10 @@ module SibApiV3Sdk
773
732
  # @return [GetContacts]
774
733
  def get_contacts_from_list(list_id, opts = {})
775
734
  data, _status_code, _headers = get_contacts_from_list_with_http_info(list_id, opts)
776
- return data
735
+ data
777
736
  end
778
737
 
779
738
  # Get the contacts in a list
780
- #
781
739
  # @param list_id Id of the list
782
740
  # @param [Hash] opts the optional parameters
783
741
  # @option opts [DateTime] :modified_since Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
@@ -786,7 +744,7 @@ module SibApiV3Sdk
786
744
  # @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
787
745
  def get_contacts_from_list_with_http_info(list_id, opts = {})
788
746
  if @api_client.config.debugging
789
- @api_client.config.logger.debug "Calling API: ContactsApi.get_contacts_from_list ..."
747
+ @api_client.config.logger.debug 'Calling API: ContactsApi.get_contacts_from_list ...'
790
748
  end
791
749
  # verify the required parameter 'list_id' is set
792
750
  if @api_client.config.client_side_validation && list_id.nil?
@@ -797,7 +755,7 @@ module SibApiV3Sdk
797
755
  end
798
756
 
799
757
  # resource path
800
- local_var_path = "/contacts/lists/{listId}/contacts".sub('{' + 'listId' + '}', list_id.to_s)
758
+ local_var_path = '/contacts/lists/{listId}/contacts'.sub('{' + 'listId' + '}', list_id.to_s)
801
759
 
802
760
  # query parameters
803
761
  query_params = {}
@@ -830,32 +788,29 @@ module SibApiV3Sdk
830
788
  end
831
789
  return data, status_code, headers
832
790
  end
833
-
834
791
  # Returns folder details
835
- #
836
792
  # @param folder_id id of the folder
837
793
  # @param [Hash] opts the optional parameters
838
794
  # @return [GetFolder]
839
795
  def get_folder(folder_id, opts = {})
840
796
  data, _status_code, _headers = get_folder_with_http_info(folder_id, opts)
841
- return data
797
+ data
842
798
  end
843
799
 
844
800
  # Returns folder details
845
- #
846
801
  # @param folder_id id of the folder
847
802
  # @param [Hash] opts the optional parameters
848
803
  # @return [Array<(GetFolder, Fixnum, Hash)>] GetFolder data, response status code and response headers
849
804
  def get_folder_with_http_info(folder_id, opts = {})
850
805
  if @api_client.config.debugging
851
- @api_client.config.logger.debug "Calling API: ContactsApi.get_folder ..."
806
+ @api_client.config.logger.debug 'Calling API: ContactsApi.get_folder ...'
852
807
  end
853
808
  # verify the required parameter 'folder_id' is set
854
809
  if @api_client.config.client_side_validation && folder_id.nil?
855
810
  fail ArgumentError, "Missing the required parameter 'folder_id' when calling ContactsApi.get_folder"
856
811
  end
857
812
  # resource path
858
- local_var_path = "/contacts/folders/{folderId}".sub('{' + 'folderId' + '}', folder_id.to_s)
813
+ local_var_path = '/contacts/folders/{folderId}'.sub('{' + 'folderId' + '}', folder_id.to_s)
859
814
 
860
815
  # query parameters
861
816
  query_params = {}
@@ -885,9 +840,7 @@ module SibApiV3Sdk
885
840
  end
886
841
  return data, status_code, headers
887
842
  end
888
-
889
843
  # Get the lists in a folder
890
- #
891
844
  # @param folder_id Id of the folder
892
845
  # @param [Hash] opts the optional parameters
893
846
  # @option opts [Integer] :limit Number of documents per page (default to 10)
@@ -895,11 +848,10 @@ module SibApiV3Sdk
895
848
  # @return [GetFolderLists]
896
849
  def get_folder_lists(folder_id, opts = {})
897
850
  data, _status_code, _headers = get_folder_lists_with_http_info(folder_id, opts)
898
- return data
851
+ data
899
852
  end
900
853
 
901
854
  # Get the lists in a folder
902
- #
903
855
  # @param folder_id Id of the folder
904
856
  # @param [Hash] opts the optional parameters
905
857
  # @option opts [Integer] :limit Number of documents per page
@@ -907,7 +859,7 @@ module SibApiV3Sdk
907
859
  # @return [Array<(GetFolderLists, Fixnum, Hash)>] GetFolderLists data, response status code and response headers
908
860
  def get_folder_lists_with_http_info(folder_id, opts = {})
909
861
  if @api_client.config.debugging
910
- @api_client.config.logger.debug "Calling API: ContactsApi.get_folder_lists ..."
862
+ @api_client.config.logger.debug 'Calling API: ContactsApi.get_folder_lists ...'
911
863
  end
912
864
  # verify the required parameter 'folder_id' is set
913
865
  if @api_client.config.client_side_validation && folder_id.nil?
@@ -918,7 +870,7 @@ module SibApiV3Sdk
918
870
  end
919
871
 
920
872
  # resource path
921
- local_var_path = "/contacts/folders/{folderId}/lists".sub('{' + 'folderId' + '}', folder_id.to_s)
873
+ local_var_path = '/contacts/folders/{folderId}/lists'.sub('{' + 'folderId' + '}', folder_id.to_s)
922
874
 
923
875
  # query parameters
924
876
  query_params = {}
@@ -950,27 +902,24 @@ module SibApiV3Sdk
950
902
  end
951
903
  return data, status_code, headers
952
904
  end
953
-
954
905
  # Get all the folders
955
- #
956
906
  # @param limit Number of documents per page
957
907
  # @param offset Index of the first document of the page
958
908
  # @param [Hash] opts the optional parameters
959
909
  # @return [GetFolders]
960
910
  def get_folders(limit, offset, opts = {})
961
911
  data, _status_code, _headers = get_folders_with_http_info(limit, offset, opts)
962
- return data
912
+ data
963
913
  end
964
914
 
965
915
  # Get all the folders
966
- #
967
916
  # @param limit Number of documents per page
968
917
  # @param offset Index of the first document of the page
969
918
  # @param [Hash] opts the optional parameters
970
919
  # @return [Array<(GetFolders, Fixnum, Hash)>] GetFolders data, response status code and response headers
971
920
  def get_folders_with_http_info(limit, offset, opts = {})
972
921
  if @api_client.config.debugging
973
- @api_client.config.logger.debug "Calling API: ContactsApi.get_folders ..."
922
+ @api_client.config.logger.debug 'Calling API: ContactsApi.get_folders ...'
974
923
  end
975
924
  # verify the required parameter 'limit' is set
976
925
  if @api_client.config.client_side_validation && limit.nil?
@@ -985,7 +934,7 @@ module SibApiV3Sdk
985
934
  fail ArgumentError, "Missing the required parameter 'offset' when calling ContactsApi.get_folders"
986
935
  end
987
936
  # resource path
988
- local_var_path = "/contacts/folders"
937
+ local_var_path = '/contacts/folders'
989
938
 
990
939
  # query parameters
991
940
  query_params = {}
@@ -1017,32 +966,29 @@ module SibApiV3Sdk
1017
966
  end
1018
967
  return data, status_code, headers
1019
968
  end
1020
-
1021
969
  # Get the details of a list
1022
- #
1023
970
  # @param list_id Id of the list
1024
971
  # @param [Hash] opts the optional parameters
1025
972
  # @return [GetExtendedList]
1026
973
  def get_list(list_id, opts = {})
1027
974
  data, _status_code, _headers = get_list_with_http_info(list_id, opts)
1028
- return data
975
+ data
1029
976
  end
1030
977
 
1031
978
  # Get the details of a list
1032
- #
1033
979
  # @param list_id Id of the list
1034
980
  # @param [Hash] opts the optional parameters
1035
981
  # @return [Array<(GetExtendedList, Fixnum, Hash)>] GetExtendedList data, response status code and response headers
1036
982
  def get_list_with_http_info(list_id, opts = {})
1037
983
  if @api_client.config.debugging
1038
- @api_client.config.logger.debug "Calling API: ContactsApi.get_list ..."
984
+ @api_client.config.logger.debug 'Calling API: ContactsApi.get_list ...'
1039
985
  end
1040
986
  # verify the required parameter 'list_id' is set
1041
987
  if @api_client.config.client_side_validation && list_id.nil?
1042
988
  fail ArgumentError, "Missing the required parameter 'list_id' when calling ContactsApi.get_list"
1043
989
  end
1044
990
  # resource path
1045
- local_var_path = "/contacts/lists/{listId}".sub('{' + 'listId' + '}', list_id.to_s)
991
+ local_var_path = '/contacts/lists/{listId}'.sub('{' + 'listId' + '}', list_id.to_s)
1046
992
 
1047
993
  # query parameters
1048
994
  query_params = {}
@@ -1072,34 +1018,31 @@ module SibApiV3Sdk
1072
1018
  end
1073
1019
  return data, status_code, headers
1074
1020
  end
1075
-
1076
1021
  # Get all the lists
1077
- #
1078
1022
  # @param [Hash] opts the optional parameters
1079
1023
  # @option opts [Integer] :limit Number of documents per page (default to 10)
1080
1024
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
1081
1025
  # @return [GetLists]
1082
1026
  def get_lists(opts = {})
1083
1027
  data, _status_code, _headers = get_lists_with_http_info(opts)
1084
- return data
1028
+ data
1085
1029
  end
1086
1030
 
1087
1031
  # Get all the lists
1088
- #
1089
1032
  # @param [Hash] opts the optional parameters
1090
1033
  # @option opts [Integer] :limit Number of documents per page
1091
1034
  # @option opts [Integer] :offset Index of the first document of the page
1092
1035
  # @return [Array<(GetLists, Fixnum, Hash)>] GetLists data, response status code and response headers
1093
1036
  def get_lists_with_http_info(opts = {})
1094
1037
  if @api_client.config.debugging
1095
- @api_client.config.logger.debug "Calling API: ContactsApi.get_lists ..."
1038
+ @api_client.config.logger.debug 'Calling API: ContactsApi.get_lists ...'
1096
1039
  end
1097
1040
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 50
1098
1041
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_lists, must be smaller than or equal to 50.'
1099
1042
  end
1100
1043
 
1101
1044
  # resource path
1102
- local_var_path = "/contacts/lists"
1045
+ local_var_path = '/contacts/lists'
1103
1046
 
1104
1047
  # query parameters
1105
1048
  query_params = {}
@@ -1131,7 +1074,6 @@ module SibApiV3Sdk
1131
1074
  end
1132
1075
  return data, status_code, headers
1133
1076
  end
1134
-
1135
1077
  # Import contacts
1136
1078
  # It returns the background process ID which on completion calls the notify URL that you have set in the input.
1137
1079
  # @param request_contact_import Values to import contacts in Sendinblue. To know more about the expected format, please have a look at &#x60;&#x60;https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns&#x60;&#x60;
@@ -1139,7 +1081,7 @@ module SibApiV3Sdk
1139
1081
  # @return [CreatedProcessId]
1140
1082
  def import_contacts(request_contact_import, opts = {})
1141
1083
  data, _status_code, _headers = import_contacts_with_http_info(request_contact_import, opts)
1142
- return data
1084
+ data
1143
1085
  end
1144
1086
 
1145
1087
  # Import contacts
@@ -1149,14 +1091,14 @@ module SibApiV3Sdk
1149
1091
  # @return [Array<(CreatedProcessId, Fixnum, Hash)>] CreatedProcessId data, response status code and response headers
1150
1092
  def import_contacts_with_http_info(request_contact_import, opts = {})
1151
1093
  if @api_client.config.debugging
1152
- @api_client.config.logger.debug "Calling API: ContactsApi.import_contacts ..."
1094
+ @api_client.config.logger.debug 'Calling API: ContactsApi.import_contacts ...'
1153
1095
  end
1154
1096
  # verify the required parameter 'request_contact_import' is set
1155
1097
  if @api_client.config.client_side_validation && request_contact_import.nil?
1156
1098
  fail ArgumentError, "Missing the required parameter 'request_contact_import' when calling ContactsApi.import_contacts"
1157
1099
  end
1158
1100
  # resource path
1159
- local_var_path = "/contacts/import"
1101
+ local_var_path = '/contacts/import'
1160
1102
 
1161
1103
  # query parameters
1162
1104
  query_params = {}
@@ -1186,27 +1128,24 @@ module SibApiV3Sdk
1186
1128
  end
1187
1129
  return data, status_code, headers
1188
1130
  end
1189
-
1190
1131
  # Remove existing contacts from a list
1191
- #
1192
1132
  # @param list_id Id of the list
1193
1133
  # @param contact_emails Emails adresses of the contact
1194
1134
  # @param [Hash] opts the optional parameters
1195
1135
  # @return [PostContactInfo]
1196
1136
  def remove_contact_from_list(list_id, contact_emails, opts = {})
1197
1137
  data, _status_code, _headers = remove_contact_from_list_with_http_info(list_id, contact_emails, opts)
1198
- return data
1138
+ data
1199
1139
  end
1200
1140
 
1201
1141
  # Remove existing contacts from a list
1202
- #
1203
1142
  # @param list_id Id of the list
1204
1143
  # @param contact_emails Emails adresses of the contact
1205
1144
  # @param [Hash] opts the optional parameters
1206
1145
  # @return [Array<(PostContactInfo, Fixnum, Hash)>] PostContactInfo data, response status code and response headers
1207
1146
  def remove_contact_from_list_with_http_info(list_id, contact_emails, opts = {})
1208
1147
  if @api_client.config.debugging
1209
- @api_client.config.logger.debug "Calling API: ContactsApi.remove_contact_from_list ..."
1148
+ @api_client.config.logger.debug 'Calling API: ContactsApi.remove_contact_from_list ...'
1210
1149
  end
1211
1150
  # verify the required parameter 'list_id' is set
1212
1151
  if @api_client.config.client_side_validation && list_id.nil?
@@ -1217,7 +1156,7 @@ module SibApiV3Sdk
1217
1156
  fail ArgumentError, "Missing the required parameter 'contact_emails' when calling ContactsApi.remove_contact_from_list"
1218
1157
  end
1219
1158
  # resource path
1220
- local_var_path = "/contacts/lists/{listId}/contacts/remove".sub('{' + 'listId' + '}', list_id.to_s)
1159
+ local_var_path = '/contacts/lists/{listId}/contacts/remove'.sub('{' + 'listId' + '}', list_id.to_s)
1221
1160
 
1222
1161
  # query parameters
1223
1162
  query_params = {}
@@ -1247,7 +1186,6 @@ module SibApiV3Sdk
1247
1186
  end
1248
1187
  return data, status_code, headers
1249
1188
  end
1250
-
1251
1189
  # Export contacts
1252
1190
  # It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.
1253
1191
  # @param request_contact_export Values to request a contact export
@@ -1255,7 +1193,7 @@ module SibApiV3Sdk
1255
1193
  # @return [CreatedProcessId]
1256
1194
  def request_contact_export(request_contact_export, opts = {})
1257
1195
  data, _status_code, _headers = request_contact_export_with_http_info(request_contact_export, opts)
1258
- return data
1196
+ data
1259
1197
  end
1260
1198
 
1261
1199
  # Export contacts
@@ -1265,14 +1203,14 @@ module SibApiV3Sdk
1265
1203
  # @return [Array<(CreatedProcessId, Fixnum, Hash)>] CreatedProcessId data, response status code and response headers
1266
1204
  def request_contact_export_with_http_info(request_contact_export, opts = {})
1267
1205
  if @api_client.config.debugging
1268
- @api_client.config.logger.debug "Calling API: ContactsApi.request_contact_export ..."
1206
+ @api_client.config.logger.debug 'Calling API: ContactsApi.request_contact_export ...'
1269
1207
  end
1270
1208
  # verify the required parameter 'request_contact_export' is set
1271
1209
  if @api_client.config.client_side_validation && request_contact_export.nil?
1272
1210
  fail ArgumentError, "Missing the required parameter 'request_contact_export' when calling ContactsApi.request_contact_export"
1273
1211
  end
1274
1212
  # resource path
1275
- local_var_path = "/contacts/export"
1213
+ local_var_path = '/contacts/export'
1276
1214
 
1277
1215
  # query parameters
1278
1216
  query_params = {}
@@ -1302,9 +1240,7 @@ module SibApiV3Sdk
1302
1240
  end
1303
1241
  return data, status_code, headers
1304
1242
  end
1305
-
1306
1243
  # Updates contact attribute
1307
- #
1308
1244
  # @param attribute_category Category of the attribute
1309
1245
  # @param attribute_name Name of the existing attribute
1310
1246
  # @param update_attribute Values to update an attribute
@@ -1312,11 +1248,10 @@ module SibApiV3Sdk
1312
1248
  # @return [nil]
1313
1249
  def update_attribute(attribute_category, attribute_name, update_attribute, opts = {})
1314
1250
  update_attribute_with_http_info(attribute_category, attribute_name, update_attribute, opts)
1315
- return nil
1251
+ nil
1316
1252
  end
1317
1253
 
1318
1254
  # Updates contact attribute
1319
- #
1320
1255
  # @param attribute_category Category of the attribute
1321
1256
  # @param attribute_name Name of the existing attribute
1322
1257
  # @param update_attribute Values to update an attribute
@@ -1324,7 +1259,7 @@ module SibApiV3Sdk
1324
1259
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1325
1260
  def update_attribute_with_http_info(attribute_category, attribute_name, update_attribute, opts = {})
1326
1261
  if @api_client.config.debugging
1327
- @api_client.config.logger.debug "Calling API: ContactsApi.update_attribute ..."
1262
+ @api_client.config.logger.debug 'Calling API: ContactsApi.update_attribute ...'
1328
1263
  end
1329
1264
  # verify the required parameter 'attribute_category' is set
1330
1265
  if @api_client.config.client_side_validation && attribute_category.nil?
@@ -1343,7 +1278,7 @@ module SibApiV3Sdk
1343
1278
  fail ArgumentError, "Missing the required parameter 'update_attribute' when calling ContactsApi.update_attribute"
1344
1279
  end
1345
1280
  # resource path
1346
- local_var_path = "/contacts/attributes/{attributeCategory}/{attributeName}".sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
1281
+ local_var_path = '/contacts/attributes/{attributeCategory}/{attributeName}'.sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
1347
1282
 
1348
1283
  # query parameters
1349
1284
  query_params = {}
@@ -1372,27 +1307,24 @@ module SibApiV3Sdk
1372
1307
  end
1373
1308
  return data, status_code, headers
1374
1309
  end
1375
-
1376
1310
  # Updates a contact
1377
- #
1378
1311
  # @param email Email (urlencoded) of the contact
1379
1312
  # @param update_contact Values to update a contact
1380
1313
  # @param [Hash] opts the optional parameters
1381
1314
  # @return [nil]
1382
1315
  def update_contact(email, update_contact, opts = {})
1383
1316
  update_contact_with_http_info(email, update_contact, opts)
1384
- return nil
1317
+ nil
1385
1318
  end
1386
1319
 
1387
1320
  # Updates a contact
1388
- #
1389
1321
  # @param email Email (urlencoded) of the contact
1390
1322
  # @param update_contact Values to update a contact
1391
1323
  # @param [Hash] opts the optional parameters
1392
1324
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1393
1325
  def update_contact_with_http_info(email, update_contact, opts = {})
1394
1326
  if @api_client.config.debugging
1395
- @api_client.config.logger.debug "Calling API: ContactsApi.update_contact ..."
1327
+ @api_client.config.logger.debug 'Calling API: ContactsApi.update_contact ...'
1396
1328
  end
1397
1329
  # verify the required parameter 'email' is set
1398
1330
  if @api_client.config.client_side_validation && email.nil?
@@ -1403,7 +1335,7 @@ module SibApiV3Sdk
1403
1335
  fail ArgumentError, "Missing the required parameter 'update_contact' when calling ContactsApi.update_contact"
1404
1336
  end
1405
1337
  # resource path
1406
- local_var_path = "/contacts/{email}".sub('{' + 'email' + '}', email.to_s)
1338
+ local_var_path = '/contacts/{email}'.sub('{' + 'email' + '}', email.to_s)
1407
1339
 
1408
1340
  # query parameters
1409
1341
  query_params = {}
@@ -1432,27 +1364,24 @@ module SibApiV3Sdk
1432
1364
  end
1433
1365
  return data, status_code, headers
1434
1366
  end
1435
-
1436
1367
  # Update a contact folder
1437
- #
1438
1368
  # @param folder_id Id of the folder
1439
1369
  # @param update_folder Name of the folder
1440
1370
  # @param [Hash] opts the optional parameters
1441
1371
  # @return [nil]
1442
1372
  def update_folder(folder_id, update_folder, opts = {})
1443
1373
  update_folder_with_http_info(folder_id, update_folder, opts)
1444
- return nil
1374
+ nil
1445
1375
  end
1446
1376
 
1447
1377
  # Update a contact folder
1448
- #
1449
1378
  # @param folder_id Id of the folder
1450
1379
  # @param update_folder Name of the folder
1451
1380
  # @param [Hash] opts the optional parameters
1452
1381
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1453
1382
  def update_folder_with_http_info(folder_id, update_folder, opts = {})
1454
1383
  if @api_client.config.debugging
1455
- @api_client.config.logger.debug "Calling API: ContactsApi.update_folder ..."
1384
+ @api_client.config.logger.debug 'Calling API: ContactsApi.update_folder ...'
1456
1385
  end
1457
1386
  # verify the required parameter 'folder_id' is set
1458
1387
  if @api_client.config.client_side_validation && folder_id.nil?
@@ -1463,7 +1392,7 @@ module SibApiV3Sdk
1463
1392
  fail ArgumentError, "Missing the required parameter 'update_folder' when calling ContactsApi.update_folder"
1464
1393
  end
1465
1394
  # resource path
1466
- local_var_path = "/contacts/folders/{folderId}".sub('{' + 'folderId' + '}', folder_id.to_s)
1395
+ local_var_path = '/contacts/folders/{folderId}'.sub('{' + 'folderId' + '}', folder_id.to_s)
1467
1396
 
1468
1397
  # query parameters
1469
1398
  query_params = {}
@@ -1492,27 +1421,24 @@ module SibApiV3Sdk
1492
1421
  end
1493
1422
  return data, status_code, headers
1494
1423
  end
1495
-
1496
1424
  # Update a list
1497
- #
1498
1425
  # @param list_id Id of the list
1499
1426
  # @param update_list Values to update a list
1500
1427
  # @param [Hash] opts the optional parameters
1501
1428
  # @return [nil]
1502
1429
  def update_list(list_id, update_list, opts = {})
1503
1430
  update_list_with_http_info(list_id, update_list, opts)
1504
- return nil
1431
+ nil
1505
1432
  end
1506
1433
 
1507
1434
  # Update a list
1508
- #
1509
1435
  # @param list_id Id of the list
1510
1436
  # @param update_list Values to update a list
1511
1437
  # @param [Hash] opts the optional parameters
1512
1438
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1513
1439
  def update_list_with_http_info(list_id, update_list, opts = {})
1514
1440
  if @api_client.config.debugging
1515
- @api_client.config.logger.debug "Calling API: ContactsApi.update_list ..."
1441
+ @api_client.config.logger.debug 'Calling API: ContactsApi.update_list ...'
1516
1442
  end
1517
1443
  # verify the required parameter 'list_id' is set
1518
1444
  if @api_client.config.client_side_validation && list_id.nil?
@@ -1523,7 +1449,7 @@ module SibApiV3Sdk
1523
1449
  fail ArgumentError, "Missing the required parameter 'update_list' when calling ContactsApi.update_list"
1524
1450
  end
1525
1451
  # resource path
1526
- local_var_path = "/contacts/lists/{listId}".sub('{' + 'listId' + '}', list_id.to_s)
1452
+ local_var_path = '/contacts/lists/{listId}'.sub('{' + 'listId' + '}', list_id.to_s)
1527
1453
 
1528
1454
  # query parameters
1529
1455
  query_params = {}