sib-api-v3-sdk 5.2.3 → 5.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (457) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/LICENSE.md +1 -1
  4. data/README.md +96 -68
  5. data/docs/AbTestCampaignResult.md +13 -0
  6. data/docs/AccountApi.md +3 -3
  7. data/docs/AddContactToList.md +1 -1
  8. data/docs/AttributesApi.md +18 -18
  9. data/docs/ContactsApi.md +123 -60
  10. data/docs/CreateAttribute.md +1 -1
  11. data/docs/CreateChild.md +1 -0
  12. data/docs/CreateContact.md +3 -3
  13. data/docs/CreateDoiContact.md +13 -0
  14. data/docs/CreateEmailCampaign.md +6 -3
  15. data/docs/CreateEmailCampaignSender.md +1 -0
  16. data/docs/CreateReseller.md +1 -0
  17. data/docs/CreateSender.md +1 -1
  18. data/docs/CreateSmtpEmail.md +1 -1
  19. data/docs/CreateSmtpTemplate.md +1 -1
  20. data/docs/CreateSmtpTemplateSender.md +1 -0
  21. data/docs/CreateWebhook.md +2 -2
  22. data/docs/EmailCampaignsApi.md +202 -25
  23. data/docs/EmailExportRecipients.md +1 -1
  24. data/docs/FoldersApi.md +12 -12
  25. data/docs/GetAccountRelay.md +1 -1
  26. data/docs/GetAccountRelayData.md +1 -1
  27. data/docs/GetChildAccountCreationStatus.md +8 -0
  28. data/docs/GetChildrenList.md +1 -0
  29. data/docs/GetDeviceBrowserStats.md +11 -0
  30. data/docs/GetEmailCampaign.md +1 -0
  31. data/docs/GetExtendedCampaignOverview.md +1 -0
  32. data/docs/GetExtendedCampaignOverviewSender.md +1 -0
  33. data/docs/GetExtendedCampaignStats.md +2 -0
  34. data/docs/GetSharedTemplateUrl.md +8 -0
  35. data/docs/GetSmtpTemplateOverview.md +1 -0
  36. data/docs/GetSmtpTemplateOverviewSender.md +1 -0
  37. data/docs/GetSmtpTemplates.md +1 -1
  38. data/docs/GetStatsByBrowser.md +7 -0
  39. data/docs/GetStatsByDevice.md +11 -0
  40. data/docs/GetTransacBlockedContacts.md +9 -0
  41. data/docs/GetTransacBlockedContactsContacts.md +11 -0
  42. data/docs/GetTransacBlockedContactsReason.md +9 -0
  43. data/docs/GetTransacEmailContent.md +14 -0
  44. data/docs/GetTransacEmailContentEvents.md +9 -0
  45. data/docs/GetTransacEmailsList.md +8 -0
  46. data/docs/GetTransacEmailsListTransactionalEmails.md +15 -0
  47. data/docs/ListsApi.md +13 -13
  48. data/docs/PostContactInfoContacts.md +1 -0
  49. data/docs/RemainingCreditModelChild.md +2 -2
  50. data/docs/RemainingCreditModelReseller.md +2 -2
  51. data/docs/RemoveContactFromList.md +2 -2
  52. data/docs/RequestContactExport.md +3 -2
  53. data/docs/RequestContactExportCustomContactFilter.md +13 -0
  54. data/docs/RequestContactImport.md +2 -2
  55. data/docs/RequestSMSRecipientExport.md +1 -1
  56. data/docs/ResellerApi.md +215 -86
  57. data/docs/SMSCampaignsApi.md +24 -24
  58. data/docs/SMTPApi.md +350 -42
  59. data/docs/SendEmail.md +2 -2
  60. data/docs/SendReport.md +1 -1
  61. data/docs/SendReportEmail.md +1 -1
  62. data/docs/SendSmtpEmail.md +4 -4
  63. data/docs/SendSmtpEmailBcc.md +1 -1
  64. data/docs/SendSmtpEmailCc.md +1 -1
  65. data/docs/SendSmtpEmailReplyTo.md +1 -1
  66. data/docs/SendSmtpEmailSender.md +1 -1
  67. data/docs/SendSmtpEmailTo.md +1 -1
  68. data/docs/SendTransacSms.md +1 -1
  69. data/docs/SendersApi.md +8 -8
  70. data/docs/TransactionalSMSApi.md +17 -17
  71. data/docs/UpdateAttribute.md +1 -1
  72. data/docs/UpdateChildAccountStatus.md +11 -0
  73. data/docs/UpdateContact.md +2 -2
  74. data/docs/UpdateEmailCampaign.md +5 -2
  75. data/docs/UpdateEmailCampaignSender.md +1 -0
  76. data/docs/UpdateSmtpTemplate.md +1 -1
  77. data/docs/UpdateSmtpTemplateSender.md +1 -0
  78. data/docs/UploadImageToGallery.md +9 -0
  79. data/docs/WebhooksApi.md +1 -1
  80. data/lib/sib-api-v3-sdk.rb +19 -2
  81. data/lib/sib-api-v3-sdk/api/account_api.rb +8 -11
  82. data/lib/sib-api-v3-sdk/api/attributes_api.rb +23 -35
  83. data/lib/sib-api-v3-sdk/api/contacts_api.rb +169 -186
  84. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +204 -73
  85. data/lib/sib-api-v3-sdk/api/folders_api.rb +29 -47
  86. data/lib/sib-api-v3-sdk/api/lists_api.rb +38 -65
  87. data/lib/sib-api-v3-sdk/api/process_api.rb +9 -15
  88. data/lib/sib-api-v3-sdk/api/reseller_api.rb +280 -201
  89. data/lib/sib-api-v3-sdk/api/senders_api.rb +25 -43
  90. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +47 -73
  91. data/lib/sib-api-v3-sdk/api/smtp_api.rb +342 -92
  92. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +19 -31
  93. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +18 -33
  94. data/lib/sib-api-v3-sdk/api_client.rb +10 -10
  95. data/lib/sib-api-v3-sdk/api_error.rb +2 -2
  96. data/lib/sib-api-v3-sdk/configuration.rb +3 -3
  97. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +280 -0
  98. data/lib/sib-api-v3-sdk/models/add_child_domain.rb +7 -12
  99. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +8 -13
  100. data/lib/sib-api-v3-sdk/models/add_credits.rb +7 -12
  101. data/lib/sib-api-v3-sdk/models/create_attribute.rb +11 -15
  102. data/lib/sib-api-v3-sdk/models/create_attribute_enumeration.rb +9 -14
  103. data/lib/sib-api-v3-sdk/models/create_child.rb +58 -19
  104. data/lib/sib-api-v3-sdk/models/create_contact.rb +10 -15
  105. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +253 -0
  106. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +82 -32
  107. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +7 -11
  108. data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +21 -15
  109. data/lib/sib-api-v3-sdk/models/create_list.rb +9 -14
  110. data/lib/sib-api-v3-sdk/models/create_model.rb +8 -13
  111. data/lib/sib-api-v3-sdk/models/create_reseller.rb +20 -15
  112. data/lib/sib-api-v3-sdk/models/create_sender.rb +10 -15
  113. data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +13 -19
  114. data/lib/sib-api-v3-sdk/models/create_sender_model.rb +8 -13
  115. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +13 -18
  116. data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +8 -13
  117. data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +9 -14
  118. data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +11 -16
  119. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +21 -15
  120. data/lib/sib-api-v3-sdk/models/create_update_contact_model.rb +7 -12
  121. data/lib/sib-api-v3-sdk/models/create_update_folder.rb +7 -12
  122. data/lib/sib-api-v3-sdk/models/create_webhook.rb +14 -18
  123. data/lib/sib-api-v3-sdk/models/created_process_id.rb +8 -13
  124. data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +7 -12
  125. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +12 -16
  126. data/lib/sib-api-v3-sdk/models/error_model.rb +12 -16
  127. data/lib/sib-api-v3-sdk/models/get_account.rb +14 -19
  128. data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +8 -13
  129. data/lib/sib-api-v3-sdk/models/get_account_plan.rb +16 -20
  130. data/lib/sib-api-v3-sdk/models/get_account_relay.rb +11 -15
  131. data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +12 -16
  132. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +20 -25
  133. data/lib/sib-api-v3-sdk/models/get_attributes.rb +8 -13
  134. data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +15 -19
  135. data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +9 -14
  136. data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +17 -21
  137. data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +9 -14
  138. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +17 -22
  139. data/lib/sib-api-v3-sdk/models/get_child_account_creation_status.rb +189 -0
  140. data/lib/sib-api-v3-sdk/models/get_child_domain.rb +9 -14
  141. data/lib/sib-api-v3-sdk/models/get_child_domains.rb +7 -12
  142. data/lib/sib-api-v3-sdk/models/get_child_info.rb +12 -17
  143. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +8 -12
  144. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v2.rb +9 -14
  145. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys_v3.rb +9 -14
  146. data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +7 -11
  147. data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +7 -11
  148. data/lib/sib-api-v3-sdk/models/get_children_list.rb +24 -14
  149. data/lib/sib-api-v3-sdk/models/get_client.rb +11 -16
  150. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +7 -11
  151. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +9 -14
  152. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +11 -16
  153. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +10 -15
  154. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +9 -14
  155. data/lib/sib-api-v3-sdk/models/get_contact_details.rb +15 -20
  156. data/lib/sib-api-v3-sdk/models/get_contacts.rb +9 -14
  157. data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb +234 -0
  158. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +40 -34
  159. data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +8 -13
  160. data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +7 -12
  161. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +14 -18
  162. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +40 -34
  163. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +19 -14
  164. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +45 -20
  165. data/lib/sib-api-v3-sdk/models/get_extended_client.rb +12 -17
  166. data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +11 -15
  167. data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +16 -21
  168. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +7 -11
  169. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked.rb +9 -14
  170. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +11 -16
  171. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +9 -14
  172. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +11 -16
  173. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions.rb +9 -13
  174. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +9 -14
  175. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +10 -15
  176. data/lib/sib-api-v3-sdk/models/get_extended_list.rb +13 -18
  177. data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +9 -14
  178. data/lib/sib-api-v3-sdk/models/get_folder.rb +12 -17
  179. data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +9 -14
  180. data/lib/sib-api-v3-sdk/models/get_folders.rb +7 -12
  181. data/lib/sib-api-v3-sdk/models/get_ip.rb +11 -16
  182. data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +11 -16
  183. data/lib/sib-api-v3-sdk/models/get_ips.rb +8 -13
  184. data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +8 -13
  185. data/lib/sib-api-v3-sdk/models/get_list.rb +11 -16
  186. data/lib/sib-api-v3-sdk/models/get_lists.rb +9 -14
  187. data/lib/sib-api-v3-sdk/models/get_process.rb +13 -17
  188. data/lib/sib-api-v3-sdk/models/get_processes.rb +8 -13
  189. data/lib/sib-api-v3-sdk/models/get_reports.rb +7 -12
  190. data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +20 -25
  191. data/lib/sib-api-v3-sdk/models/get_senders_list.rb +7 -12
  192. data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +10 -15
  193. data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +11 -16
  194. data/lib/sib-api-v3-sdk/models/get_shared_template_url.rb +189 -0
  195. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +20 -24
  196. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +18 -22
  197. data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +14 -19
  198. data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +8 -13
  199. data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +7 -12
  200. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +14 -18
  201. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +31 -26
  202. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +19 -14
  203. data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +8 -13
  204. data/lib/sib-api-v3-sdk/models/get_sso_token.rb +8 -13
  205. data/lib/sib-api-v3-sdk/models/get_stats_by_browser.rb +174 -0
  206. data/lib/sib-api-v3-sdk/models/get_stats_by_device.rb +222 -0
  207. data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +7 -12
  208. data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +17 -22
  209. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts.rb +195 -0
  210. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +233 -0
  211. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_reason.rb +229 -0
  212. data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +276 -0
  213. data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +204 -0
  214. data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +185 -0
  215. data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +281 -0
  216. data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +7 -12
  217. data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +17 -22
  218. data/lib/sib-api-v3-sdk/models/get_webhook.rb +17 -21
  219. data/lib/sib-api-v3-sdk/models/get_webhooks.rb +8 -13
  220. data/lib/sib-api-v3-sdk/models/manage_ip.rb +7 -12
  221. data/lib/sib-api-v3-sdk/models/post_contact_info.rb +8 -13
  222. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +19 -14
  223. data/lib/sib-api-v3-sdk/models/post_send_failed.rb +9 -14
  224. data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +9 -14
  225. data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +9 -14
  226. data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +11 -15
  227. data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +11 -16
  228. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +9 -14
  229. data/lib/sib-api-v3-sdk/models/remove_credits.rb +7 -12
  230. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +19 -20
  231. data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +293 -0
  232. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +9 -14
  233. data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +7 -11
  234. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +12 -16
  235. data/lib/sib-api-v3-sdk/models/send_email.rb +10 -15
  236. data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +12 -17
  237. data/lib/sib-api-v3-sdk/models/send_report.rb +12 -16
  238. data/lib/sib-api-v3-sdk/models/send_report_email.rb +14 -17
  239. data/lib/sib-api-v3-sdk/models/send_sms.rb +9 -14
  240. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +12 -17
  241. data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +9 -15
  242. data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +9 -14
  243. data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +9 -14
  244. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +10 -14
  245. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +10 -14
  246. data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +9 -14
  247. data/lib/sib-api-v3-sdk/models/send_template_email.rb +8 -13
  248. data/lib/sib-api-v3-sdk/models/send_test_email.rb +7 -12
  249. data/lib/sib-api-v3-sdk/models/send_test_sms.rb +7 -12
  250. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +17 -21
  251. data/lib/sib-api-v3-sdk/models/update_attribute.rb +8 -13
  252. data/lib/sib-api-v3-sdk/models/update_attribute_enumeration.rb +9 -14
  253. data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +10 -13
  254. data/lib/sib-api-v3-sdk/models/update_child.rb +7 -12
  255. data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +214 -0
  256. data/lib/sib-api-v3-sdk/models/update_child_domain.rb +7 -12
  257. data/lib/sib-api-v3-sdk/models/update_contact.rb +9 -14
  258. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +79 -29
  259. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +7 -11
  260. data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +20 -14
  261. data/lib/sib-api-v3-sdk/models/update_list.rb +7 -12
  262. data/lib/sib-api-v3-sdk/models/update_sender.rb +7 -12
  263. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +9 -15
  264. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +8 -13
  265. data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +20 -14
  266. data/lib/sib-api-v3-sdk/models/update_webhook.rb +7 -11
  267. data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
  268. data/lib/sib-api-v3-sdk/version.rb +3 -3
  269. data/sib-api-v3-sdk.gemspec +5 -5
  270. data/spec/api/account_api_spec.rb +4 -5
  271. data/spec/api/attributes_api_spec.rb +10 -14
  272. data/spec/api/contacts_api_spec.rb +57 -68
  273. data/spec/api/email_campaigns_api_spec.rb +54 -28
  274. data/spec/api/folders_api_spec.rb +12 -18
  275. data/spec/api/lists_api_spec.rb +15 -24
  276. data/spec/api/process_api_spec.rb +4 -6
  277. data/spec/api/reseller_api_spec.rb +64 -52
  278. data/spec/api/senders_api_spec.rb +10 -16
  279. data/spec/api/sms_campaigns_api_spec.rb +19 -27
  280. data/spec/api/smtp_api_spec.rb +88 -34
  281. data/spec/api/transactional_sms_api_spec.rb +8 -12
  282. data/spec/api/webhooks_api_spec.rb +7 -12
  283. data/spec/api_client_spec.rb +36 -36
  284. data/spec/configuration_spec.rb +10 -10
  285. data/spec/models/ab_test_campaign_result_spec.rb +79 -0
  286. data/spec/models/add_child_domain_spec.rb +3 -4
  287. data/spec/models/add_contact_to_list_spec.rb +3 -4
  288. data/spec/models/add_credits_spec.rb +4 -5
  289. data/spec/models/create_attribute_enumeration_spec.rb +4 -5
  290. data/spec/models/create_attribute_spec.rb +9 -10
  291. data/spec/models/create_child_spec.rb +17 -8
  292. data/spec/models/create_contact_spec.rb +9 -10
  293. data/spec/models/create_doi_contact_spec.rb +71 -0
  294. data/spec/models/create_email_campaign_recipients_spec.rb +4 -5
  295. data/spec/models/create_email_campaign_sender_spec.rb +10 -5
  296. data/spec/models/create_email_campaign_spec.rb +49 -32
  297. data/spec/models/create_list_spec.rb +4 -5
  298. data/spec/models/create_model_spec.rb +3 -4
  299. data/spec/models/create_reseller_spec.rb +9 -4
  300. data/spec/models/create_sender_ips_spec.rb +5 -6
  301. data/spec/models/create_sender_model_spec.rb +5 -6
  302. data/spec/models/create_sender_spec.rb +5 -6
  303. data/spec/models/create_sms_campaign_recipients_spec.rb +4 -5
  304. data/spec/models/create_sms_campaign_spec.rb +7 -8
  305. data/spec/models/create_smtp_email_spec.rb +3 -4
  306. data/spec/models/create_smtp_template_sender_spec.rb +10 -5
  307. data/spec/models/create_smtp_template_spec.rb +12 -13
  308. data/spec/models/create_update_contact_model_spec.rb +3 -4
  309. data/spec/models/create_update_folder_spec.rb +3 -4
  310. data/spec/models/create_webhook_spec.rb +14 -15
  311. data/spec/models/created_process_id_spec.rb +3 -4
  312. data/spec/models/delete_hardbounces_spec.rb +5 -6
  313. data/spec/models/email_export_recipients_spec.rb +8 -9
  314. data/spec/models/error_model_spec.rb +8 -9
  315. data/spec/models/get_account_marketing_automation_spec.rb +4 -5
  316. data/spec/models/get_account_plan_spec.rb +16 -17
  317. data/spec/models/get_account_relay_data_spec.rb +5 -6
  318. data/spec/models/get_account_relay_spec.rb +4 -5
  319. data/spec/models/get_account_spec.rb +10 -11
  320. data/spec/models/get_aggregated_report_spec.rb +15 -16
  321. data/spec/models/get_attributes_attributes_spec.rb +15 -16
  322. data/spec/models/get_attributes_enumeration_spec.rb +4 -5
  323. data/spec/models/get_attributes_spec.rb +3 -4
  324. data/spec/models/get_campaign_overview_spec.rb +23 -24
  325. data/spec/models/get_campaign_recipients_spec.rb +4 -5
  326. data/spec/models/get_campaign_stats_spec.rb +14 -15
  327. data/spec/models/get_child_account_creation_status_spec.rb +41 -0
  328. data/spec/models/get_child_domain_spec.rb +4 -5
  329. data/spec/models/get_child_domains_spec.rb +2 -3
  330. data/spec/models/get_child_info_api_keys_spec.rb +4 -5
  331. data/spec/models/get_child_info_api_keys_v2_spec.rb +4 -5
  332. data/spec/models/get_child_info_api_keys_v3_spec.rb +4 -5
  333. data/spec/models/get_child_info_credits_spec.rb +4 -5
  334. data/spec/models/get_child_info_spec.rb +11 -12
  335. data/spec/models/get_child_info_statistics_spec.rb +5 -6
  336. data/spec/models/get_children_list_spec.rb +9 -4
  337. data/spec/models/get_client_spec.rb +6 -7
  338. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +4 -5
  339. data/spec/models/get_contact_campaign_stats_opened_spec.rb +6 -7
  340. data/spec/models/get_contact_campaign_stats_spec.rb +10 -11
  341. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +5 -6
  342. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +4 -5
  343. data/spec/models/get_contact_details_spec.rb +11 -12
  344. data/spec/models/get_contacts_spec.rb +4 -5
  345. data/spec/models/get_device_browser_stats_spec.rb +59 -0
  346. data/spec/models/get_email_campaign_spec.rb +46 -41
  347. data/spec/models/get_email_campaigns_spec.rb +4 -5
  348. data/spec/models/get_email_event_report_events_spec.rb +16 -17
  349. data/spec/models/get_email_event_report_spec.rb +3 -4
  350. data/spec/models/get_extended_campaign_overview_sender_spec.rb +10 -5
  351. data/spec/models/get_extended_campaign_overview_spec.rb +44 -39
  352. data/spec/models/get_extended_campaign_stats_spec.rb +20 -9
  353. data/spec/models/get_extended_client_address_spec.rb +6 -7
  354. data/spec/models/get_extended_client_spec.rb +7 -8
  355. data/spec/models/get_extended_contact_details_spec.rb +12 -13
  356. data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +4 -5
  357. data/spec/models/get_extended_contact_details_statistics_links_spec.rb +6 -7
  358. data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +4 -5
  359. data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +6 -7
  360. data/spec/models/get_extended_contact_details_statistics_spec.rb +10 -11
  361. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +4 -5
  362. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +4 -5
  363. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +5 -6
  364. data/spec/models/get_extended_list_campaign_stats_spec.rb +4 -5
  365. data/spec/models/get_extended_list_spec.rb +10 -11
  366. data/spec/models/get_folder_lists_spec.rb +4 -5
  367. data/spec/models/get_folder_spec.rb +7 -8
  368. data/spec/models/get_folders_spec.rb +4 -5
  369. data/spec/models/get_ip_from_sender_spec.rb +6 -7
  370. data/spec/models/get_ip_spec.rb +6 -7
  371. data/spec/models/get_ips_from_sender_spec.rb +3 -4
  372. data/spec/models/get_ips_spec.rb +3 -4
  373. data/spec/models/get_list_spec.rb +6 -7
  374. data/spec/models/get_lists_spec.rb +4 -5
  375. data/spec/models/get_process_spec.rb +10 -11
  376. data/spec/models/get_processes_spec.rb +4 -5
  377. data/spec/models/get_reports_reports_spec.rb +15 -16
  378. data/spec/models/get_reports_spec.rb +3 -4
  379. data/spec/models/get_senders_list_ips_spec.rb +5 -6
  380. data/spec/models/get_senders_list_senders_spec.rb +7 -8
  381. data/spec/models/get_senders_list_spec.rb +3 -4
  382. data/spec/models/get_shared_template_url_spec.rb +41 -0
  383. data/spec/models/get_sms_campaign_overview_spec.rb +14 -15
  384. data/spec/models/get_sms_campaign_spec.rb +16 -17
  385. data/spec/models/get_sms_campaign_stats_spec.rb +9 -10
  386. data/spec/models/get_sms_campaigns_spec.rb +4 -5
  387. data/spec/models/get_sms_event_report_events_spec.rb +13 -14
  388. data/spec/models/get_sms_event_report_spec.rb +3 -4
  389. data/spec/models/get_smtp_template_overview_sender_spec.rb +10 -5
  390. data/spec/models/get_smtp_template_overview_spec.rb +20 -15
  391. data/spec/models/get_smtp_templates_spec.rb +4 -5
  392. data/spec/models/get_sso_token_spec.rb +3 -4
  393. data/spec/models/get_stats_by_browser_spec.rb +35 -0
  394. data/spec/models/get_stats_by_device_spec.rb +59 -0
  395. data/spec/models/get_stats_by_domain_spec.rb +2 -3
  396. data/spec/models/get_transac_aggregated_sms_report_spec.rb +12 -13
  397. data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
  398. data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
  399. data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
  400. data/spec/models/get_transac_email_content_events_spec.rb +47 -0
  401. data/spec/models/get_transac_email_content_spec.rb +77 -0
  402. data/spec/models/get_transac_emails_list_spec.rb +41 -0
  403. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +83 -0
  404. data/spec/models/get_transac_sms_report_reports_spec.rb +12 -13
  405. data/spec/models/get_transac_sms_report_spec.rb +3 -4
  406. data/spec/models/get_webhook_spec.rb +13 -14
  407. data/spec/models/get_webhooks_spec.rb +3 -4
  408. data/spec/models/manage_ip_spec.rb +3 -4
  409. data/spec/models/post_contact_info_contacts_spec.rb +11 -6
  410. data/spec/models/post_contact_info_spec.rb +3 -4
  411. data/spec/models/post_send_failed_spec.rb +7 -8
  412. data/spec/models/post_send_sms_test_failed_spec.rb +6 -7
  413. data/spec/models/remaining_credit_model_child_spec.rb +4 -5
  414. data/spec/models/remaining_credit_model_reseller_spec.rb +4 -5
  415. data/spec/models/remaining_credit_model_spec.rb +4 -5
  416. data/spec/models/remove_contact_from_list_spec.rb +4 -5
  417. data/spec/models/remove_credits_spec.rb +4 -5
  418. data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
  419. data/spec/models/request_contact_export_spec.rb +11 -6
  420. data/spec/models/request_contact_import_new_list_spec.rb +4 -5
  421. data/spec/models/request_contact_import_spec.rb +11 -12
  422. data/spec/models/request_sms_recipient_export_spec.rb +8 -9
  423. data/spec/models/send_email_attachment_spec.rb +4 -5
  424. data/spec/models/send_email_spec.rb +11 -12
  425. data/spec/models/send_report_email_spec.rb +12 -13
  426. data/spec/models/send_report_spec.rb +8 -9
  427. data/spec/models/send_sms_spec.rb +7 -8
  428. data/spec/models/send_smtp_email_attachment_spec.rb +5 -6
  429. data/spec/models/send_smtp_email_bcc_spec.rb +4 -5
  430. data/spec/models/send_smtp_email_cc_spec.rb +4 -5
  431. data/spec/models/send_smtp_email_reply_to_spec.rb +4 -5
  432. data/spec/models/send_smtp_email_sender_spec.rb +4 -5
  433. data/spec/models/send_smtp_email_spec.rb +15 -16
  434. data/spec/models/send_smtp_email_to_spec.rb +4 -5
  435. data/spec/models/send_template_email_spec.rb +3 -4
  436. data/spec/models/send_test_email_spec.rb +3 -4
  437. data/spec/models/send_test_sms_spec.rb +3 -4
  438. data/spec/models/send_transac_sms_spec.rb +12 -13
  439. data/spec/models/update_attribute_enumeration_spec.rb +4 -5
  440. data/spec/models/update_attribute_spec.rb +4 -5
  441. data/spec/models/update_campaign_status_spec.rb +7 -8
  442. data/spec/models/update_child_account_status_spec.rb +59 -0
  443. data/spec/models/update_child_domain_spec.rb +3 -4
  444. data/spec/models/update_child_spec.rb +7 -8
  445. data/spec/models/update_contact_spec.rb +8 -9
  446. data/spec/models/update_email_campaign_recipients_spec.rb +4 -5
  447. data/spec/models/update_email_campaign_sender_spec.rb +10 -5
  448. data/spec/models/update_email_campaign_spec.rb +49 -32
  449. data/spec/models/update_list_spec.rb +4 -5
  450. data/spec/models/update_sender_spec.rb +5 -6
  451. data/spec/models/update_sms_campaign_spec.rb +7 -8
  452. data/spec/models/update_smtp_template_sender_spec.rb +10 -5
  453. data/spec/models/update_smtp_template_spec.rb +12 -13
  454. data/spec/models/update_webhook_spec.rb +9 -10
  455. data/spec/models/upload_image_to_gallery_spec.rb +47 -0
  456. data/spec/spec_helper.rb +2 -2
  457. metadata +70 -2
@@ -0,0 +1,214 @@
1
+ =begin
2
+ #SendinBlue API
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 | | 406 | Error. Not Acceptable |
5
+
6
+ OpenAPI spec version: 3.0.0
7
+ Contact: contact@sendinblue.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.12
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module SibApiV3Sdk
16
+ class UpdateChildAccountStatus
17
+ # Status of Transactional Email Platform activation for your account (true=enabled, false=disabled)
18
+ attr_accessor :transactional_email
19
+
20
+ # Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled)
21
+ attr_accessor :transactional_sms
22
+
23
+ # Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled)
24
+ attr_accessor :marketing_automation
25
+
26
+ # Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled)
27
+ attr_accessor :sms_campaign
28
+
29
+ # Attribute mapping from ruby-style variable name to JSON key.
30
+ def self.attribute_map
31
+ {
32
+ :'transactional_email' => :'transactionalEmail',
33
+ :'transactional_sms' => :'transactionalSms',
34
+ :'marketing_automation' => :'marketingAutomation',
35
+ :'sms_campaign' => :'smsCampaign'
36
+ }
37
+ end
38
+
39
+ # Attribute type mapping.
40
+ def self.swagger_types
41
+ {
42
+ :'transactional_email' => :'BOOLEAN',
43
+ :'transactional_sms' => :'BOOLEAN',
44
+ :'marketing_automation' => :'BOOLEAN',
45
+ :'sms_campaign' => :'BOOLEAN'
46
+ }
47
+ end
48
+
49
+ # Initializes the object
50
+ # @param [Hash] attributes Model attributes in the form of hash
51
+ def initialize(attributes = {})
52
+ return unless attributes.is_a?(Hash)
53
+
54
+ # convert string to symbol for hash key
55
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
56
+
57
+ if attributes.has_key?(:'transactionalEmail')
58
+ self.transactional_email = attributes[:'transactionalEmail']
59
+ end
60
+
61
+ if attributes.has_key?(:'transactionalSms')
62
+ self.transactional_sms = attributes[:'transactionalSms']
63
+ end
64
+
65
+ if attributes.has_key?(:'marketingAutomation')
66
+ self.marketing_automation = attributes[:'marketingAutomation']
67
+ end
68
+
69
+ if attributes.has_key?(:'smsCampaign')
70
+ self.sms_campaign = attributes[:'smsCampaign']
71
+ end
72
+ end
73
+
74
+ # Show invalid properties with the reasons. Usually used together with valid?
75
+ # @return Array for valid properties with the reasons
76
+ def list_invalid_properties
77
+ invalid_properties = Array.new
78
+ invalid_properties
79
+ end
80
+
81
+ # Check to see if the all the properties in the model are valid
82
+ # @return true if the model is valid
83
+ def valid?
84
+ true
85
+ end
86
+
87
+ # Checks equality by comparing each attribute.
88
+ # @param [Object] Object to be compared
89
+ def ==(o)
90
+ return true if self.equal?(o)
91
+ self.class == o.class &&
92
+ transactional_email == o.transactional_email &&
93
+ transactional_sms == o.transactional_sms &&
94
+ marketing_automation == o.marketing_automation &&
95
+ sms_campaign == o.sms_campaign
96
+ end
97
+
98
+ # @see the `==` method
99
+ # @param [Object] Object to be compared
100
+ def eql?(o)
101
+ self == o
102
+ end
103
+
104
+ # Calculates hash code according to all attributes.
105
+ # @return [Fixnum] Hash code
106
+ def hash
107
+ [transactional_email, transactional_sms, marketing_automation, sms_campaign].hash
108
+ end
109
+
110
+ # Builds the object from hash
111
+ # @param [Hash] attributes Model attributes in the form of hash
112
+ # @return [Object] Returns the model itself
113
+ def build_from_hash(attributes)
114
+ return nil unless attributes.is_a?(Hash)
115
+ self.class.swagger_types.each_pair do |key, type|
116
+ if type =~ /\AArray<(.*)>/i
117
+ # check to ensure the input is an array given that the the attribute
118
+ # is documented as an array but the input is not
119
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
120
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
121
+ end
122
+ elsif !attributes[self.class.attribute_map[key]].nil?
123
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
124
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
125
+ end
126
+
127
+ self
128
+ end
129
+
130
+ # Deserializes the data based on type
131
+ # @param string type Data type
132
+ # @param string value Value to be deserialized
133
+ # @return [Object] Deserialized data
134
+ def _deserialize(type, value)
135
+ case type.to_sym
136
+ when :DateTime
137
+ DateTime.parse(value)
138
+ when :Date
139
+ Date.parse(value)
140
+ when :String
141
+ value.to_s
142
+ when :Integer
143
+ value.to_i
144
+ when :Float
145
+ value.to_f
146
+ when :BOOLEAN
147
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
148
+ true
149
+ else
150
+ false
151
+ end
152
+ when :Object
153
+ # generic object (usually a Hash), return directly
154
+ value
155
+ when /\AArray<(?<inner_type>.+)>\z/
156
+ inner_type = Regexp.last_match[:inner_type]
157
+ value.map { |v| _deserialize(inner_type, v) }
158
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
159
+ k_type = Regexp.last_match[:k_type]
160
+ v_type = Regexp.last_match[:v_type]
161
+ {}.tap do |hash|
162
+ value.each do |k, v|
163
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
164
+ end
165
+ end
166
+ else # model
167
+ temp_model = SibApiV3Sdk.const_get(type).new
168
+ temp_model.build_from_hash(value)
169
+ end
170
+ end
171
+
172
+ # Returns the string representation of the object
173
+ # @return [String] String presentation of the object
174
+ def to_s
175
+ to_hash.to_s
176
+ end
177
+
178
+ # to_body is an alias to to_hash (backward compatibility)
179
+ # @return [Hash] Returns the object in the form of hash
180
+ def to_body
181
+ to_hash
182
+ end
183
+
184
+ # Returns the object in the form of hash
185
+ # @return [Hash] Returns the object in the form of hash
186
+ def to_hash
187
+ hash = {}
188
+ self.class.attribute_map.each_pair do |attr, param|
189
+ value = self.send(attr)
190
+ next if value.nil?
191
+ hash[param] = _to_hash(value)
192
+ end
193
+ hash
194
+ end
195
+
196
+ # Outputs non-array value in the form of hash
197
+ # For object, use to_hash. Otherwise, just return the value
198
+ # @param [Object] value Any valid value
199
+ # @return [Hash] Returns the value in the form of hash
200
+ def _to_hash(value)
201
+ if value.is_a?(Array)
202
+ value.compact.map { |v| _to_hash(v) }
203
+ elsif value.is_a?(Hash)
204
+ {}.tap do |hash|
205
+ value.each { |k, v| hash[k] = _to_hash(v) }
206
+ end
207
+ elsif value.respond_to? :to_hash
208
+ value.to_hash
209
+ else
210
+ value
211
+ end
212
+ end
213
+ end
214
+ end
@@ -1,24 +1,22 @@
1
1
  =begin
2
2
  #SendinBlue API
3
3
 
4
- #SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
4
+ #SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@sendinblue.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.3.1
9
+ Swagger Codegen version: 2.4.12
10
10
 
11
11
  =end
12
12
 
13
13
  require 'date'
14
14
 
15
15
  module SibApiV3Sdk
16
-
17
16
  class UpdateChildDomain
18
17
  # Value for the sender domain that will replace the existing domain
19
18
  attr_accessor :domain
20
19
 
21
-
22
20
  # Attribute mapping from ruby-style variable name to JSON key.
23
21
  def self.attribute_map
24
22
  {
@@ -39,25 +37,24 @@ module SibApiV3Sdk
39
37
  return unless attributes.is_a?(Hash)
40
38
 
41
39
  # convert string to symbol for hash key
42
- attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
40
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
43
41
 
44
42
  if attributes.has_key?(:'domain')
45
43
  self.domain = attributes[:'domain']
46
44
  end
47
-
48
45
  end
49
46
 
50
47
  # Show invalid properties with the reasons. Usually used together with valid?
51
48
  # @return Array for valid properties with the reasons
52
49
  def list_invalid_properties
53
50
  invalid_properties = Array.new
54
- return invalid_properties
51
+ invalid_properties
55
52
  end
56
53
 
57
54
  # Check to see if the all the properties in the model are valid
58
55
  # @return true if the model is valid
59
56
  def valid?
60
- return true
57
+ true
61
58
  end
62
59
 
63
60
  # Checks equality by comparing each attribute.
@@ -90,7 +87,7 @@ module SibApiV3Sdk
90
87
  # check to ensure the input is an array given that the the attribute
91
88
  # is documented as an array but the input is not
92
89
  if attributes[self.class.attribute_map[key]].is_a?(Array)
93
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
90
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
94
91
  end
95
92
  elsif !attributes[self.class.attribute_map[key]].nil?
96
93
  self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -172,7 +169,7 @@ module SibApiV3Sdk
172
169
  # @return [Hash] Returns the value in the form of hash
173
170
  def _to_hash(value)
174
171
  if value.is_a?(Array)
175
- value.compact.map{ |v| _to_hash(v) }
172
+ value.compact.map { |v| _to_hash(v) }
176
173
  elsif value.is_a?(Hash)
177
174
  {}.tap do |hash|
178
175
  value.each { |k, v| hash[k] = _to_hash(v) }
@@ -183,7 +180,5 @@ module SibApiV3Sdk
183
180
  value
184
181
  end
185
182
  end
186
-
187
183
  end
188
-
189
184
  end
@@ -1,21 +1,20 @@
1
1
  =begin
2
2
  #SendinBlue API
3
3
 
4
- #SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
4
+ #SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@sendinblue.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.3.1
9
+ Swagger Codegen version: 2.4.12
10
10
 
11
11
  =end
12
12
 
13
13
  require 'date'
14
14
 
15
15
  module SibApiV3Sdk
16
-
17
16
  class UpdateContact
18
- # 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'}`
17
+ # 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\"}`. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}
19
18
  attr_accessor :attributes
20
19
 
21
20
  # Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)
@@ -30,10 +29,9 @@ module SibApiV3Sdk
30
29
  # Ids of the lists to remove the contact from
31
30
  attr_accessor :unlink_list_ids
32
31
 
33
- # SMTP forbidden sender for contact. Use only for email Contact
32
+ # transactional email forbidden sender for contact. Use only for email Contact
34
33
  attr_accessor :smtp_blacklist_sender
35
34
 
36
-
37
35
  # Attribute mapping from ruby-style variable name to JSON key.
38
36
  def self.attribute_map
39
37
  {
@@ -64,7 +62,7 @@ module SibApiV3Sdk
64
62
  return unless attributes.is_a?(Hash)
65
63
 
66
64
  # convert string to symbol for hash key
67
- attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
65
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
68
66
 
69
67
  if attributes.has_key?(:'attributes')
70
68
  self.attributes = attributes[:'attributes']
@@ -95,20 +93,19 @@ module SibApiV3Sdk
95
93
  self.smtp_blacklist_sender = value
96
94
  end
97
95
  end
98
-
99
96
  end
100
97
 
101
98
  # Show invalid properties with the reasons. Usually used together with valid?
102
99
  # @return Array for valid properties with the reasons
103
100
  def list_invalid_properties
104
101
  invalid_properties = Array.new
105
- return invalid_properties
102
+ invalid_properties
106
103
  end
107
104
 
108
105
  # Check to see if the all the properties in the model are valid
109
106
  # @return true if the model is valid
110
107
  def valid?
111
- return true
108
+ true
112
109
  end
113
110
 
114
111
  # Checks equality by comparing each attribute.
@@ -146,7 +143,7 @@ module SibApiV3Sdk
146
143
  # check to ensure the input is an array given that the the attribute
147
144
  # is documented as an array but the input is not
148
145
  if attributes[self.class.attribute_map[key]].is_a?(Array)
149
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
146
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
150
147
  end
151
148
  elsif !attributes[self.class.attribute_map[key]].nil?
152
149
  self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -228,7 +225,7 @@ module SibApiV3Sdk
228
225
  # @return [Hash] Returns the value in the form of hash
229
226
  def _to_hash(value)
230
227
  if value.is_a?(Array)
231
- value.compact.map{ |v| _to_hash(v) }
228
+ value.compact.map { |v| _to_hash(v) }
232
229
  elsif value.is_a?(Hash)
233
230
  {}.tap do |hash|
234
231
  value.each { |k, v| hash[k] = _to_hash(v) }
@@ -239,7 +236,5 @@ module SibApiV3Sdk
239
236
  value
240
237
  end
241
238
  end
242
-
243
239
  end
244
-
245
240
  end
@@ -1,19 +1,18 @@
1
1
  =begin
2
2
  #SendinBlue API
3
3
 
4
- #SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed |
4
+ #SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@sendinblue.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.3.1
9
+ Swagger Codegen version: 2.4.12
10
10
 
11
11
  =end
12
12
 
13
13
  require 'date'
14
14
 
15
15
  module SibApiV3Sdk
16
-
17
16
  class UpdateEmailCampaign
18
17
  # Tag of the campaign
19
18
  attr_accessor :tag
@@ -38,7 +37,7 @@ module SibApiV3Sdk
38
37
  # Email on which campaign recipients will be able to reply to
39
38
  attr_accessor :reply_to
40
39
 
41
- # To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization
40
+ # To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
42
41
  attr_accessor :to_field
43
42
 
44
43
  attr_accessor :recipients
@@ -64,7 +63,7 @@ module SibApiV3Sdk
64
63
  # Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
65
64
  attr_accessor :utm_campaign
66
65
 
67
- # Pass the set of attributes to customize the type 'classic' campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}`. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
66
+ # Pass the set of attributes to customize the type 'classic' campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
68
67
  attr_accessor :params
69
68
 
70
69
  # Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled.
@@ -88,6 +87,15 @@ module SibApiV3Sdk
88
87
  # 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
89
88
  attr_accessor :winner_delay
90
89
 
90
+ # Available for dedicated ip clients. Set this to true if you wish to warm up your ip.
91
+ attr_accessor :ip_warmup_enable
92
+
93
+ # Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.
94
+ attr_accessor :initial_quota
95
+
96
+ # 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%.
97
+ attr_accessor :increase_rate
98
+
91
99
  class EnumAttributeValidator
92
100
  attr_reader :datatype
93
101
  attr_reader :allowable_values
@@ -137,7 +145,10 @@ module SibApiV3Sdk
137
145
  :'subject_b' => :'subjectB',
138
146
  :'split_rule' => :'splitRule',
139
147
  :'winner_criteria' => :'winnerCriteria',
140
- :'winner_delay' => :'winnerDelay'
148
+ :'winner_delay' => :'winnerDelay',
149
+ :'ip_warmup_enable' => :'ipWarmupEnable',
150
+ :'initial_quota' => :'initialQuota',
151
+ :'increase_rate' => :'increaseRate'
141
152
  }
142
153
  end
143
154
 
@@ -168,7 +179,10 @@ module SibApiV3Sdk
168
179
  :'subject_b' => :'String',
169
180
  :'split_rule' => :'Integer',
170
181
  :'winner_criteria' => :'String',
171
- :'winner_delay' => :'Integer'
182
+ :'winner_delay' => :'Integer',
183
+ :'ip_warmup_enable' => :'BOOLEAN',
184
+ :'initial_quota' => :'Integer',
185
+ :'increase_rate' => :'Integer'
172
186
  }
173
187
  end
174
188
 
@@ -178,7 +192,7 @@ module SibApiV3Sdk
178
192
  return unless attributes.is_a?(Hash)
179
193
 
180
194
  # convert string to symbol for hash key
181
- attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
195
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
182
196
 
183
197
  if attributes.has_key?(:'tag')
184
198
  self.tag = attributes[:'tag']
@@ -286,6 +300,19 @@ module SibApiV3Sdk
286
300
  self.winner_delay = attributes[:'winnerDelay']
287
301
  end
288
302
 
303
+ if attributes.has_key?(:'ipWarmupEnable')
304
+ self.ip_warmup_enable = attributes[:'ipWarmupEnable']
305
+ else
306
+ self.ip_warmup_enable = false
307
+ end
308
+
309
+ if attributes.has_key?(:'initialQuota')
310
+ self.initial_quota = attributes[:'initialQuota']
311
+ end
312
+
313
+ if attributes.has_key?(:'increaseRate')
314
+ self.increase_rate = attributes[:'increaseRate']
315
+ end
289
316
  end
290
317
 
291
318
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -293,22 +320,30 @@ module SibApiV3Sdk
293
320
  def list_invalid_properties
294
321
  invalid_properties = Array.new
295
322
  if !@split_rule.nil? && @split_rule > 50
296
- invalid_properties.push("invalid value for 'split_rule', must be smaller than or equal to 50.")
323
+ invalid_properties.push('invalid value for "split_rule", must be smaller than or equal to 50.')
297
324
  end
298
325
 
299
326
  if !@split_rule.nil? && @split_rule < 1
300
- invalid_properties.push("invalid value for 'split_rule', must be greater than or equal to 1.")
327
+ invalid_properties.push('invalid value for "split_rule", must be greater than or equal to 1.')
301
328
  end
302
329
 
303
330
  if !@winner_delay.nil? && @winner_delay > 168
304
- invalid_properties.push("invalid value for 'winner_delay', must be smaller than or equal to 168.")
331
+ invalid_properties.push('invalid value for "winner_delay", must be smaller than or equal to 168.')
305
332
  end
306
333
 
307
334
  if !@winner_delay.nil? && @winner_delay < 1
308
- invalid_properties.push("invalid value for 'winner_delay', must be greater than or equal to 1.")
335
+ invalid_properties.push('invalid value for "winner_delay", must be greater than or equal to 1.')
309
336
  end
310
337
 
311
- return invalid_properties
338
+ if !@increase_rate.nil? && @increase_rate > 100
339
+ invalid_properties.push('invalid value for "increase_rate", must be smaller than or equal to 100.')
340
+ end
341
+
342
+ if !@increase_rate.nil? && @increase_rate < 0
343
+ invalid_properties.push('invalid value for "increase_rate", must be greater than or equal to 0.')
344
+ end
345
+
346
+ invalid_properties
312
347
  end
313
348
 
314
349
  # Check to see if the all the properties in the model are valid
@@ -316,23 +351,24 @@ module SibApiV3Sdk
316
351
  def valid?
317
352
  return false if !@split_rule.nil? && @split_rule > 50
318
353
  return false if !@split_rule.nil? && @split_rule < 1
319
- winner_criteria_validator = EnumAttributeValidator.new('String', ["open", "click"])
354
+ winner_criteria_validator = EnumAttributeValidator.new('String', ['open', 'click'])
320
355
  return false unless winner_criteria_validator.valid?(@winner_criteria)
321
356
  return false if !@winner_delay.nil? && @winner_delay > 168
322
357
  return false if !@winner_delay.nil? && @winner_delay < 1
323
- return true
358
+ return false if !@increase_rate.nil? && @increase_rate > 100
359
+ return false if !@increase_rate.nil? && @increase_rate < 0
360
+ true
324
361
  end
325
362
 
326
363
  # Custom attribute writer method with validation
327
364
  # @param [Object] split_rule Value to be assigned
328
365
  def split_rule=(split_rule)
329
-
330
366
  if !split_rule.nil? && split_rule > 50
331
- fail ArgumentError, "invalid value for 'split_rule', must be smaller than or equal to 50."
367
+ fail ArgumentError, 'invalid value for "split_rule", must be smaller than or equal to 50.'
332
368
  end
333
369
 
334
370
  if !split_rule.nil? && split_rule < 1
335
- fail ArgumentError, "invalid value for 'split_rule', must be greater than or equal to 1."
371
+ fail ArgumentError, 'invalid value for "split_rule", must be greater than or equal to 1.'
336
372
  end
337
373
 
338
374
  @split_rule = split_rule
@@ -341,9 +377,9 @@ module SibApiV3Sdk
341
377
  # Custom attribute writer method checking allowed values (enum).
342
378
  # @param [Object] winner_criteria Object to be assigned
343
379
  def winner_criteria=(winner_criteria)
344
- validator = EnumAttributeValidator.new('String', ["open", "click"])
380
+ validator = EnumAttributeValidator.new('String', ['open', 'click'])
345
381
  unless validator.valid?(winner_criteria)
346
- fail ArgumentError, "invalid value for 'winner_criteria', must be one of #{validator.allowable_values}."
382
+ fail ArgumentError, 'invalid value for "winner_criteria", must be one of #{validator.allowable_values}.'
347
383
  end
348
384
  @winner_criteria = winner_criteria
349
385
  end
@@ -351,18 +387,31 @@ module SibApiV3Sdk
351
387
  # Custom attribute writer method with validation
352
388
  # @param [Object] winner_delay Value to be assigned
353
389
  def winner_delay=(winner_delay)
354
-
355
390
  if !winner_delay.nil? && winner_delay > 168
356
- fail ArgumentError, "invalid value for 'winner_delay', must be smaller than or equal to 168."
391
+ fail ArgumentError, 'invalid value for "winner_delay", must be smaller than or equal to 168.'
357
392
  end
358
393
 
359
394
  if !winner_delay.nil? && winner_delay < 1
360
- fail ArgumentError, "invalid value for 'winner_delay', must be greater than or equal to 1."
395
+ fail ArgumentError, 'invalid value for "winner_delay", must be greater than or equal to 1.'
361
396
  end
362
397
 
363
398
  @winner_delay = winner_delay
364
399
  end
365
400
 
401
+ # Custom attribute writer method with validation
402
+ # @param [Object] increase_rate Value to be assigned
403
+ def increase_rate=(increase_rate)
404
+ if !increase_rate.nil? && increase_rate > 100
405
+ fail ArgumentError, 'invalid value for "increase_rate", must be smaller than or equal to 100.'
406
+ end
407
+
408
+ if !increase_rate.nil? && increase_rate < 0
409
+ fail ArgumentError, 'invalid value for "increase_rate", must be greater than or equal to 0.'
410
+ end
411
+
412
+ @increase_rate = increase_rate
413
+ end
414
+
366
415
  # Checks equality by comparing each attribute.
367
416
  # @param [Object] Object to be compared
368
417
  def ==(o)
@@ -392,7 +441,10 @@ module SibApiV3Sdk
392
441
  subject_b == o.subject_b &&
393
442
  split_rule == o.split_rule &&
394
443
  winner_criteria == o.winner_criteria &&
395
- winner_delay == o.winner_delay
444
+ winner_delay == o.winner_delay &&
445
+ ip_warmup_enable == o.ip_warmup_enable &&
446
+ initial_quota == o.initial_quota &&
447
+ increase_rate == o.increase_rate
396
448
  end
397
449
 
398
450
  # @see the `==` method
@@ -404,7 +456,7 @@ module SibApiV3Sdk
404
456
  # Calculates hash code according to all attributes.
405
457
  # @return [Fixnum] Hash code
406
458
  def hash
407
- [tag, sender, name, html_content, html_url, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, recurring, footer, header, utm_campaign, params, send_at_best_time, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay].hash
459
+ [tag, sender, name, html_content, html_url, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, recurring, footer, header, utm_campaign, params, send_at_best_time, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay, ip_warmup_enable, initial_quota, increase_rate].hash
408
460
  end
409
461
 
410
462
  # Builds the object from hash
@@ -417,7 +469,7 @@ module SibApiV3Sdk
417
469
  # check to ensure the input is an array given that the the attribute
418
470
  # is documented as an array but the input is not
419
471
  if attributes[self.class.attribute_map[key]].is_a?(Array)
420
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
472
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
421
473
  end
422
474
  elsif !attributes[self.class.attribute_map[key]].nil?
423
475
  self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -499,7 +551,7 @@ module SibApiV3Sdk
499
551
  # @return [Hash] Returns the value in the form of hash
500
552
  def _to_hash(value)
501
553
  if value.is_a?(Array)
502
- value.compact.map{ |v| _to_hash(v) }
554
+ value.compact.map { |v| _to_hash(v) }
503
555
  elsif value.is_a?(Hash)
504
556
  {}.tap do |hash|
505
557
  value.each { |k, v| hash[k] = _to_hash(v) }
@@ -510,7 +562,5 @@ module SibApiV3Sdk
510
562
  value
511
563
  end
512
564
  end
513
-
514
565
  end
515
-
516
566
  end