sib-api-v3-sdk 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (487) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/LICENSE.md +21 -0
  4. data/README.md +349 -0
  5. data/Rakefile +8 -0
  6. data/docs/AccountApi.md +55 -0
  7. data/docs/AddCredits.md +9 -0
  8. data/docs/AddRemoveContactToList.md +8 -0
  9. data/docs/AttributesApi.md +160 -0
  10. data/docs/ContactsApi.md +1310 -0
  11. data/docs/CreaUpdateFolder.md +8 -0
  12. data/docs/CreateAttribute.md +12 -0
  13. data/docs/CreateAttributeEnumemaration.md +9 -0
  14. data/docs/CreateChild.md +12 -0
  15. data/docs/CreateContact.md +12 -0
  16. data/docs/CreateEmailCampaign.md +25 -0
  17. data/docs/CreateEmailCampaignRecipients.md +9 -0
  18. data/docs/CreateEmailCampaignSender.md +9 -0
  19. data/docs/CreateList.md +9 -0
  20. data/docs/CreateModel.md +8 -0
  21. data/docs/CreateSender.md +10 -0
  22. data/docs/CreateSenderIps.md +10 -0
  23. data/docs/CreateSenderModel.md +10 -0
  24. data/docs/CreateSmsCampaign.md +12 -0
  25. data/docs/CreateSmsCampaignRecipients.md +9 -0
  26. data/docs/CreateSmtpEmail.md +8 -0
  27. data/docs/CreateSmtpTemplate.md +17 -0
  28. data/docs/CreateSmtpTemplateSender.md +9 -0
  29. data/docs/CreateWebhook.md +11 -0
  30. data/docs/CreatedProcessId.md +8 -0
  31. data/docs/DeleteHardbounces.md +10 -0
  32. data/docs/EmailCampaignsApi.md +557 -0
  33. data/docs/EmailExportRecipients.md +9 -0
  34. data/docs/ErrorModel.md +9 -0
  35. data/docs/FoldersApi.md +336 -0
  36. data/docs/GetAccount.md +15 -0
  37. data/docs/GetAccountMarketingAutomation.md +9 -0
  38. data/docs/GetAccountPlan.md +10 -0
  39. data/docs/GetAccountRelay.md +9 -0
  40. data/docs/GetAccountRelayData.md +10 -0
  41. data/docs/GetAggregatedReport.md +19 -0
  42. data/docs/GetAttributes.md +8 -0
  43. data/docs/GetAttributesAttributes.md +13 -0
  44. data/docs/GetAttributesEnumeration.md +9 -0
  45. data/docs/GetCampaignOverview.md +13 -0
  46. data/docs/GetCampaignRecipients.md +9 -0
  47. data/docs/GetCampaignRecipientsExclusionLists.md +9 -0
  48. data/docs/GetCampaignRecipientsLists.md +9 -0
  49. data/docs/GetCampaignStats.md +19 -0
  50. data/docs/GetChildInfo.md +16 -0
  51. data/docs/GetChildInfoApiKeys.md +10 -0
  52. data/docs/GetChildInfoCredits.md +9 -0
  53. data/docs/GetChildInfoIps.md +9 -0
  54. data/docs/GetChildInfoStatistics.md +10 -0
  55. data/docs/GetChildrenList.md +8 -0
  56. data/docs/GetClient.md +11 -0
  57. data/docs/GetContactCampaignStats.md +15 -0
  58. data/docs/GetContactCampaignStatsClicked.md +9 -0
  59. data/docs/GetContactCampaignStatsLinks.md +11 -0
  60. data/docs/GetContactCampaignStatsMessagesSent.md +9 -0
  61. data/docs/GetContactCampaignStatsOpened.md +11 -0
  62. data/docs/GetContactCampaignStatsTransacAttributes.md +10 -0
  63. data/docs/GetContactCampaignStatsUnsubscriptions.md +9 -0
  64. data/docs/GetContactCampaignStatsUnsubscriptionsAdminUnsubscription.md +9 -0
  65. data/docs/GetContactCampaignStatsUnsubscriptionsUserUnsubscription.md +10 -0
  66. data/docs/GetContactDetails.md +15 -0
  67. data/docs/GetContacts.md +9 -0
  68. data/docs/GetEmailCampaign.md +27 -0
  69. data/docs/GetEmailCampaigns.md +9 -0
  70. data/docs/GetEmailEventReport.md +8 -0
  71. data/docs/GetEmailEventReportEvents.md +14 -0
  72. data/docs/GetExtendedCampaignOverview.md +27 -0
  73. data/docs/GetExtendedCampaignOverviewSender.md +9 -0
  74. data/docs/GetExtendedCampaignStats.md +12 -0
  75. data/docs/GetExtendedCampaignStatsLinksStats.md +8 -0
  76. data/docs/GetExtendedClient.md +12 -0
  77. data/docs/GetExtendedClientAddress.md +11 -0
  78. data/docs/GetExtendedContactDetails.md +15 -0
  79. data/docs/GetExtendedList.md +15 -0
  80. data/docs/GetExtendedListCampaignStats.md +9 -0
  81. data/docs/GetFolder.md +12 -0
  82. data/docs/GetFolderLists.md +9 -0
  83. data/docs/GetFolders.md +9 -0
  84. data/docs/GetIp.md +11 -0
  85. data/docs/GetIpFromSender.md +11 -0
  86. data/docs/GetIps.md +8 -0
  87. data/docs/GetIpsFromSender.md +8 -0
  88. data/docs/GetList.md +11 -0
  89. data/docs/GetLists.md +9 -0
  90. data/docs/GetListsFolder.md +9 -0
  91. data/docs/GetListsLists.md +8 -0
  92. data/docs/GetProcess.md +11 -0
  93. data/docs/GetProcesses.md +9 -0
  94. data/docs/GetReports.md +8 -0
  95. data/docs/GetReportsReports.md +20 -0
  96. data/docs/GetSendersList.md +8 -0
  97. data/docs/GetSendersListIps.md +10 -0
  98. data/docs/GetSendersListSenders.md +12 -0
  99. data/docs/GetSmsCampaign.md +16 -0
  100. data/docs/GetSmsCampaignOverview.md +16 -0
  101. data/docs/GetSmsCampaignStats.md +14 -0
  102. data/docs/GetSmsCampaigns.md +9 -0
  103. data/docs/GetSmsEventReport.md +8 -0
  104. data/docs/GetSmsEventReportEvents.md +14 -0
  105. data/docs/GetSmtpTemplateOverview.md +19 -0
  106. data/docs/GetSmtpTemplateOverviewSender.md +9 -0
  107. data/docs/GetSmtpTemplates.md +9 -0
  108. data/docs/GetStatsByDomain.md +7 -0
  109. data/docs/GetTransacAggregatedSmsReport.md +17 -0
  110. data/docs/GetTransacSmsReport.md +8 -0
  111. data/docs/GetTransacSmsReportReports.md +18 -0
  112. data/docs/GetWebhook.md +14 -0
  113. data/docs/GetWebhooks.md +8 -0
  114. data/docs/ListsApi.md +509 -0
  115. data/docs/ManageIp.md +8 -0
  116. data/docs/PostContactInfo.md +8 -0
  117. data/docs/PostContactInfoContacts.md +9 -0
  118. data/docs/PostSendFailed.md +12 -0
  119. data/docs/PostSendSmsTestFailed.md +11 -0
  120. data/docs/ProcessApi.md +117 -0
  121. data/docs/RemainingCreditModel.md +9 -0
  122. data/docs/RemainingCreditModelChild.md +9 -0
  123. data/docs/RemainingCreditModelReseller.md +9 -0
  124. data/docs/RemoveCredits.md +9 -0
  125. data/docs/RequestContactExport.md +10 -0
  126. data/docs/RequestContactImport.md +12 -0
  127. data/docs/RequestContactImportNewList.md +9 -0
  128. data/docs/RequestSMSRecipientExport.md +9 -0
  129. data/docs/ResellerApi.md +491 -0
  130. data/docs/SMSCampaignsApi.md +560 -0
  131. data/docs/SMTPApi.md +642 -0
  132. data/docs/SendEmail.md +15 -0
  133. data/docs/SendEmailAttachment.md +9 -0
  134. data/docs/SendReport.md +9 -0
  135. data/docs/SendReportEmail.md +13 -0
  136. data/docs/SendSms.md +8 -0
  137. data/docs/SendSmtpEmail.md +17 -0
  138. data/docs/SendSmtpEmailAttachment.md +10 -0
  139. data/docs/SendSmtpEmailBcc.md +9 -0
  140. data/docs/SendSmtpEmailCc.md +9 -0
  141. data/docs/SendSmtpEmailReplyTo.md +9 -0
  142. data/docs/SendSmtpEmailSender.md +9 -0
  143. data/docs/SendSmtpEmailTo.md +9 -0
  144. data/docs/SendTemplateEmail.md +8 -0
  145. data/docs/SendTestEmail.md +8 -0
  146. data/docs/SendTestSms.md +8 -0
  147. data/docs/SendTransacSms.md +12 -0
  148. data/docs/SendersApi.md +326 -0
  149. data/docs/TransactionalSMSApi.md +249 -0
  150. data/docs/UpdateCampaignStatus.md +8 -0
  151. data/docs/UpdateChild.md +13 -0
  152. data/docs/UpdateContact.md +12 -0
  153. data/docs/UpdateEmailCampaign.md +24 -0
  154. data/docs/UpdateEmailCampaignRecipients.md +9 -0
  155. data/docs/UpdateEmailCampaignSender.md +9 -0
  156. data/docs/UpdateList.md +9 -0
  157. data/docs/UpdateSender.md +10 -0
  158. data/docs/UpdateSmsCampaign.md +12 -0
  159. data/docs/UpdateSmtpTemplate.md +17 -0
  160. data/docs/UpdateSmtpTemplateSender.md +9 -0
  161. data/docs/UpdateWebhook.md +10 -0
  162. data/docs/WebhooksApi.md +275 -0
  163. data/git_push.sh +55 -0
  164. data/lib/sib-api-v3-sdk.rb +196 -0
  165. data/lib/sib-api-v3-sdk/api/account_api.rb +72 -0
  166. data/lib/sib-api-v3-sdk/api/attributes_api.rb +181 -0
  167. data/lib/sib-api-v3-sdk/api/contacts_api.rb +1408 -0
  168. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +609 -0
  169. data/lib/sib-api-v3-sdk/api/folders_api.rb +379 -0
  170. data/lib/sib-api-v3-sdk/api/lists_api.rb +565 -0
  171. data/lib/sib-api-v3-sdk/api/process_api.rb +137 -0
  172. data/lib/sib-api-v3-sdk/api/reseller_api.rb +534 -0
  173. data/lib/sib-api-v3-sdk/api/senders_api.rb +343 -0
  174. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +609 -0
  175. data/lib/sib-api-v3-sdk/api/smtp_api.rb +699 -0
  176. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +280 -0
  177. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +302 -0
  178. data/lib/sib-api-v3-sdk/api_client.rb +389 -0
  179. data/lib/sib-api-v3-sdk/api_error.rb +38 -0
  180. data/lib/sib-api-v3-sdk/configuration.rb +209 -0
  181. data/lib/sib-api-v3-sdk/models/add_credits.rb +199 -0
  182. data/lib/sib-api-v3-sdk/models/add_remove_contact_to_list.rb +191 -0
  183. data/lib/sib-api-v3-sdk/models/crea_update_folder.rb +189 -0
  184. data/lib/sib-api-v3-sdk/models/create_attribute.rb +291 -0
  185. data/lib/sib-api-v3-sdk/models/create_attribute_enumemaration.rb +199 -0
  186. data/lib/sib-api-v3-sdk/models/create_child.rb +254 -0
  187. data/lib/sib-api-v3-sdk/models/create_contact.rb +231 -0
  188. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +425 -0
  189. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +203 -0
  190. data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +204 -0
  191. data/lib/sib-api-v3-sdk/models/create_list.rb +209 -0
  192. data/lib/sib-api-v3-sdk/models/create_model.rb +194 -0
  193. data/lib/sib-api-v3-sdk/models/create_sender.rb +221 -0
  194. data/lib/sib-api-v3-sdk/models/create_sender_ips.rb +244 -0
  195. data/lib/sib-api-v3-sdk/models/create_sender_model.rb +214 -0
  196. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +273 -0
  197. data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +213 -0
  198. data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +194 -0
  199. data/lib/sib-api-v3-sdk/models/create_smtp_template.rb +288 -0
  200. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +204 -0
  201. data/lib/sib-api-v3-sdk/models/create_webhook.rb +261 -0
  202. data/lib/sib-api-v3-sdk/models/created_process_id.rb +194 -0
  203. data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +209 -0
  204. data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +237 -0
  205. data/lib/sib-api-v3-sdk/models/error_model.rb +242 -0
  206. data/lib/sib-api-v3-sdk/models/get_account.rb +283 -0
  207. data/lib/sib-api-v3-sdk/models/get_account_marketing_automation.rb +204 -0
  208. data/lib/sib-api-v3-sdk/models/get_account_plan.rb +269 -0
  209. data/lib/sib-api-v3-sdk/models/get_account_relay.rb +203 -0
  210. data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +224 -0
  211. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +359 -0
  212. data/lib/sib-api-v3-sdk/models/get_attributes.rb +196 -0
  213. data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +301 -0
  214. data/lib/sib-api-v3-sdk/models/get_attributes_enumeration.rb +209 -0
  215. data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +325 -0
  216. data/lib/sib-api-v3-sdk/models/get_campaign_recipients.rb +213 -0
  217. data/lib/sib-api-v3-sdk/models/get_campaign_recipients_exclusion_lists.rb +209 -0
  218. data/lib/sib-api-v3-sdk/models/get_campaign_recipients_lists.rb +209 -0
  219. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +359 -0
  220. data/lib/sib-api-v3-sdk/models/get_child_info.rb +296 -0
  221. data/lib/sib-api-v3-sdk/models/get_child_info_api_keys.rb +219 -0
  222. data/lib/sib-api-v3-sdk/models/get_child_info_credits.rb +199 -0
  223. data/lib/sib-api-v3-sdk/models/get_child_info_ips.rb +209 -0
  224. data/lib/sib-api-v3-sdk/models/get_child_info_statistics.rb +209 -0
  225. data/lib/sib-api-v3-sdk/models/get_children_list.rb +191 -0
  226. data/lib/sib-api-v3-sdk/models/get_client.rb +239 -0
  227. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +265 -0
  228. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +210 -0
  229. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_links.rb +239 -0
  230. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_messages_sent.rb +209 -0
  231. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +239 -0
  232. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes.rb +224 -0
  233. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +213 -0
  234. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions_admin_unsubscription.rb +209 -0
  235. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions_user_unsubscription.rb +224 -0
  236. data/lib/sib-api-v3-sdk/models/get_contact_details.rb +316 -0
  237. data/lib/sib-api-v3-sdk/models/get_contacts.rb +210 -0
  238. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +552 -0
  239. data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +205 -0
  240. data/lib/sib-api-v3-sdk/models/get_email_event_report.rb +190 -0
  241. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +312 -0
  242. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +552 -0
  243. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview_sender.rb +199 -0
  244. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +255 -0
  245. data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats_links_stats.rb +194 -0
  246. data/lib/sib-api-v3-sdk/models/get_extended_client.rb +248 -0
  247. data/lib/sib-api-v3-sdk/models/get_extended_client_address.rb +239 -0
  248. data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +316 -0
  249. data/lib/sib-api-v3-sdk/models/get_extended_list.rb +309 -0
  250. data/lib/sib-api-v3-sdk/models/get_extended_list_campaign_stats.rb +208 -0
  251. data/lib/sib-api-v3-sdk/models/get_folder.rb +254 -0
  252. data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +210 -0
  253. data/lib/sib-api-v3-sdk/models/get_folders.rb +200 -0
  254. data/lib/sib-api-v3-sdk/models/get_ip.rb +239 -0
  255. data/lib/sib-api-v3-sdk/models/get_ip_from_sender.rb +239 -0
  256. data/lib/sib-api-v3-sdk/models/get_ips.rb +196 -0
  257. data/lib/sib-api-v3-sdk/models/get_ips_from_sender.rb +196 -0
  258. data/lib/sib-api-v3-sdk/models/get_list.rb +239 -0
  259. data/lib/sib-api-v3-sdk/models/get_lists.rb +211 -0
  260. data/lib/sib-api-v3-sdk/models/get_lists_folder.rb +209 -0
  261. data/lib/sib-api-v3-sdk/models/get_lists_lists.rb +188 -0
  262. data/lib/sib-api-v3-sdk/models/get_process.rb +267 -0
  263. data/lib/sib-api-v3-sdk/models/get_processes.rb +206 -0
  264. data/lib/sib-api-v3-sdk/models/get_reports.rb +190 -0
  265. data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +374 -0
  266. data/lib/sib-api-v3-sdk/models/get_senders_list.rb +191 -0
  267. data/lib/sib-api-v3-sdk/models/get_senders_list_ips.rb +224 -0
  268. data/lib/sib-api-v3-sdk/models/get_senders_list_senders.rb +251 -0
  269. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +404 -0
  270. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +404 -0
  271. data/lib/sib-api-v3-sdk/models/get_sms_campaign_stats.rb +284 -0
  272. data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +205 -0
  273. data/lib/sib-api-v3-sdk/models/get_sms_event_report.rb +190 -0
  274. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +311 -0
  275. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +391 -0
  276. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview_sender.rb +199 -0
  277. data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +200 -0
  278. data/lib/sib-api-v3-sdk/models/get_stats_by_domain.rb +179 -0
  279. data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +329 -0
  280. data/lib/sib-api-v3-sdk/models/get_transac_sms_report.rb +190 -0
  281. data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +344 -0
  282. data/lib/sib-api-v3-sdk/models/get_webhook.rb +356 -0
  283. data/lib/sib-api-v3-sdk/models/get_webhooks.rb +195 -0
  284. data/lib/sib-api-v3-sdk/models/manage_ip.rb +189 -0
  285. data/lib/sib-api-v3-sdk/models/post_contact_info.rb +188 -0
  286. data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +206 -0
  287. data/lib/sib-api-v3-sdk/models/post_send_failed.rb +242 -0
  288. data/lib/sib-api-v3-sdk/models/post_send_sms_test_failed.rb +231 -0
  289. data/lib/sib-api-v3-sdk/models/remaining_credit_model.rb +197 -0
  290. data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +209 -0
  291. data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +209 -0
  292. data/lib/sib-api-v3-sdk/models/remove_credits.rb +199 -0
  293. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +216 -0
  294. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +230 -0
  295. data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +199 -0
  296. data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +239 -0
  297. data/lib/sib-api-v3-sdk/models/send_email.rb +274 -0
  298. data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +215 -0
  299. data/lib/sib-api-v3-sdk/models/send_report.rb +233 -0
  300. data/lib/sib-api-v3-sdk/models/send_report_email.rb +278 -0
  301. data/lib/sib-api-v3-sdk/models/send_sms.rb +193 -0
  302. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +301 -0
  303. data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +225 -0
  304. data/lib/sib-api-v3-sdk/models/send_smtp_email_bcc.rb +204 -0
  305. data/lib/sib-api-v3-sdk/models/send_smtp_email_cc.rb +204 -0
  306. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +204 -0
  307. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +204 -0
  308. data/lib/sib-api-v3-sdk/models/send_smtp_email_to.rb +204 -0
  309. data/lib/sib-api-v3-sdk/models/send_template_email.rb +194 -0
  310. data/lib/sib-api-v3-sdk/models/send_test_email.rb +191 -0
  311. data/lib/sib-api-v3-sdk/models/send_test_sms.rb +191 -0
  312. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +282 -0
  313. data/lib/sib-api-v3-sdk/models/update_campaign_status.rb +221 -0
  314. data/lib/sib-api-v3-sdk/models/update_child.rb +240 -0
  315. data/lib/sib-api-v3-sdk/models/update_contact.rb +234 -0
  316. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +367 -0
  317. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +203 -0
  318. data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +199 -0
  319. data/lib/sib-api-v3-sdk/models/update_list.rb +199 -0
  320. data/lib/sib-api-v3-sdk/models/update_sender.rb +211 -0
  321. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +260 -0
  322. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +278 -0
  323. data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +199 -0
  324. data/lib/sib-api-v3-sdk/models/update_webhook.rb +211 -0
  325. data/lib/sib-api-v3-sdk/version.rb +15 -0
  326. data/sib-api-v3-sdk.gemspec +45 -0
  327. data/spec/api/account_api_spec.rb +46 -0
  328. data/spec/api/attributes_api_spec.rb +70 -0
  329. data/spec/api/contacts_api_spec.rb +335 -0
  330. data/spec/api/email_campaigns_api_spec.rb +163 -0
  331. data/spec/api/folders_api_spec.rb +111 -0
  332. data/spec/api/lists_api_spec.rb +152 -0
  333. data/spec/api/process_api_spec.rb +60 -0
  334. data/spec/api/reseller_api_spec.rb +147 -0
  335. data/spec/api/senders_api_spec.rb +108 -0
  336. data/spec/api/sms_campaigns_api_spec.rb +163 -0
  337. data/spec/api/smtp_api_spec.rb +189 -0
  338. data/spec/api/transactional_sms_api_spec.rb +96 -0
  339. data/spec/api/webhooks_api_spec.rb +96 -0
  340. data/spec/api_client_spec.rb +226 -0
  341. data/spec/configuration_spec.rb +42 -0
  342. data/spec/models/add_credits_spec.rb +48 -0
  343. data/spec/models/add_remove_contact_to_list_spec.rb +42 -0
  344. data/spec/models/crea_update_folder_spec.rb +42 -0
  345. data/spec/models/create_attribute_enumemaration_spec.rb +48 -0
  346. data/spec/models/create_attribute_spec.rb +74 -0
  347. data/spec/models/create_child_spec.rb +66 -0
  348. data/spec/models/create_contact_spec.rb +66 -0
  349. data/spec/models/create_email_campaign_recipients_spec.rb +48 -0
  350. data/spec/models/create_email_campaign_sender_spec.rb +48 -0
  351. data/spec/models/create_email_campaign_spec.rb +148 -0
  352. data/spec/models/create_list_spec.rb +48 -0
  353. data/spec/models/create_model_spec.rb +42 -0
  354. data/spec/models/create_sender_ips_spec.rb +54 -0
  355. data/spec/models/create_sender_model_spec.rb +54 -0
  356. data/spec/models/create_sender_spec.rb +54 -0
  357. data/spec/models/create_sms_campaign_recipients_spec.rb +48 -0
  358. data/spec/models/create_sms_campaign_spec.rb +66 -0
  359. data/spec/models/create_smtp_email_spec.rb +42 -0
  360. data/spec/models/create_smtp_template_sender_spec.rb +48 -0
  361. data/spec/models/create_smtp_template_spec.rb +96 -0
  362. data/spec/models/create_webhook_spec.rb +64 -0
  363. data/spec/models/created_process_id_spec.rb +42 -0
  364. data/spec/models/delete_hardbounces_spec.rb +54 -0
  365. data/spec/models/email_export_recipients_spec.rb +52 -0
  366. data/spec/models/error_model_spec.rb +52 -0
  367. data/spec/models/get_account_marketing_automation_spec.rb +48 -0
  368. data/spec/models/get_account_plan_spec.rb +62 -0
  369. data/spec/models/get_account_relay_data_spec.rb +54 -0
  370. data/spec/models/get_account_relay_spec.rb +48 -0
  371. data/spec/models/get_account_spec.rb +84 -0
  372. data/spec/models/get_aggregated_report_spec.rb +108 -0
  373. data/spec/models/get_attributes_attributes_spec.rb +80 -0
  374. data/spec/models/get_attributes_enumeration_spec.rb +48 -0
  375. data/spec/models/get_attributes_spec.rb +42 -0
  376. data/spec/models/get_campaign_overview_spec.rb +80 -0
  377. data/spec/models/get_campaign_recipients_exclusion_lists_spec.rb +48 -0
  378. data/spec/models/get_campaign_recipients_lists_spec.rb +48 -0
  379. data/spec/models/get_campaign_recipients_spec.rb +48 -0
  380. data/spec/models/get_campaign_stats_spec.rb +108 -0
  381. data/spec/models/get_child_info_api_keys_spec.rb +54 -0
  382. data/spec/models/get_child_info_credits_spec.rb +48 -0
  383. data/spec/models/get_child_info_ips_spec.rb +48 -0
  384. data/spec/models/get_child_info_spec.rb +90 -0
  385. data/spec/models/get_child_info_statistics_spec.rb +54 -0
  386. data/spec/models/get_children_list_spec.rb +42 -0
  387. data/spec/models/get_client_spec.rb +60 -0
  388. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +48 -0
  389. data/spec/models/get_contact_campaign_stats_links_spec.rb +60 -0
  390. data/spec/models/get_contact_campaign_stats_messages_sent_spec.rb +48 -0
  391. data/spec/models/get_contact_campaign_stats_opened_spec.rb +60 -0
  392. data/spec/models/get_contact_campaign_stats_spec.rb +84 -0
  393. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +54 -0
  394. data/spec/models/get_contact_campaign_stats_unsubscriptions_admin_unsubscription_spec.rb +48 -0
  395. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +48 -0
  396. data/spec/models/get_contact_campaign_stats_unsubscriptions_user_unsubscription_spec.rb +54 -0
  397. data/spec/models/get_contact_details_spec.rb +84 -0
  398. data/spec/models/get_contacts_spec.rb +48 -0
  399. data/spec/models/get_email_campaign_spec.rb +164 -0
  400. data/spec/models/get_email_campaigns_spec.rb +48 -0
  401. data/spec/models/get_email_event_report_events_spec.rb +82 -0
  402. data/spec/models/get_email_event_report_spec.rb +42 -0
  403. data/spec/models/get_extended_campaign_overview_sender_spec.rb +48 -0
  404. data/spec/models/get_extended_campaign_overview_spec.rb +164 -0
  405. data/spec/models/get_extended_campaign_stats_links_stats_spec.rb +42 -0
  406. data/spec/models/get_extended_campaign_stats_spec.rb +66 -0
  407. data/spec/models/get_extended_client_address_spec.rb +60 -0
  408. data/spec/models/get_extended_client_spec.rb +66 -0
  409. data/spec/models/get_extended_contact_details_spec.rb +84 -0
  410. data/spec/models/get_extended_list_campaign_stats_spec.rb +48 -0
  411. data/spec/models/get_extended_list_spec.rb +84 -0
  412. data/spec/models/get_folder_lists_spec.rb +48 -0
  413. data/spec/models/get_folder_spec.rb +66 -0
  414. data/spec/models/get_folders_spec.rb +48 -0
  415. data/spec/models/get_ip_from_sender_spec.rb +60 -0
  416. data/spec/models/get_ip_spec.rb +60 -0
  417. data/spec/models/get_ips_from_sender_spec.rb +42 -0
  418. data/spec/models/get_ips_spec.rb +42 -0
  419. data/spec/models/get_list_spec.rb +60 -0
  420. data/spec/models/get_lists_folder_spec.rb +48 -0
  421. data/spec/models/get_lists_lists_spec.rb +42 -0
  422. data/spec/models/get_lists_spec.rb +48 -0
  423. data/spec/models/get_process_spec.rb +64 -0
  424. data/spec/models/get_processes_spec.rb +48 -0
  425. data/spec/models/get_reports_reports_spec.rb +114 -0
  426. data/spec/models/get_reports_spec.rb +42 -0
  427. data/spec/models/get_senders_list_ips_spec.rb +54 -0
  428. data/spec/models/get_senders_list_senders_spec.rb +66 -0
  429. data/spec/models/get_senders_list_spec.rb +42 -0
  430. data/spec/models/get_sms_campaign_overview_spec.rb +94 -0
  431. data/spec/models/get_sms_campaign_spec.rb +94 -0
  432. data/spec/models/get_sms_campaign_stats_spec.rb +78 -0
  433. data/spec/models/get_sms_campaigns_spec.rb +48 -0
  434. data/spec/models/get_sms_event_report_events_spec.rb +82 -0
  435. data/spec/models/get_sms_event_report_spec.rb +42 -0
  436. data/spec/models/get_smtp_template_overview_sender_spec.rb +48 -0
  437. data/spec/models/get_smtp_template_overview_spec.rb +108 -0
  438. data/spec/models/get_smtp_templates_spec.rb +48 -0
  439. data/spec/models/get_stats_by_domain_spec.rb +36 -0
  440. data/spec/models/get_transac_aggregated_sms_report_spec.rb +96 -0
  441. data/spec/models/get_transac_sms_report_reports_spec.rb +102 -0
  442. data/spec/models/get_transac_sms_report_spec.rb +42 -0
  443. data/spec/models/get_webhook_spec.rb +82 -0
  444. data/spec/models/get_webhooks_spec.rb +42 -0
  445. data/spec/models/manage_ip_spec.rb +42 -0
  446. data/spec/models/post_contact_info_contacts_spec.rb +48 -0
  447. data/spec/models/post_contact_info_spec.rb +42 -0
  448. data/spec/models/post_send_failed_spec.rb +66 -0
  449. data/spec/models/post_send_sms_test_failed_spec.rb +60 -0
  450. data/spec/models/remaining_credit_model_child_spec.rb +48 -0
  451. data/spec/models/remaining_credit_model_reseller_spec.rb +48 -0
  452. data/spec/models/remaining_credit_model_spec.rb +48 -0
  453. data/spec/models/remove_credits_spec.rb +48 -0
  454. data/spec/models/request_contact_export_spec.rb +54 -0
  455. data/spec/models/request_contact_import_new_list_spec.rb +48 -0
  456. data/spec/models/request_contact_import_spec.rb +66 -0
  457. data/spec/models/request_sms_recipient_export_spec.rb +52 -0
  458. data/spec/models/send_email_attachment_spec.rb +48 -0
  459. data/spec/models/send_email_spec.rb +84 -0
  460. data/spec/models/send_report_email_spec.rb +76 -0
  461. data/spec/models/send_report_spec.rb +52 -0
  462. data/spec/models/send_sms_spec.rb +42 -0
  463. data/spec/models/send_smtp_email_attachment_spec.rb +54 -0
  464. data/spec/models/send_smtp_email_bcc_spec.rb +48 -0
  465. data/spec/models/send_smtp_email_cc_spec.rb +48 -0
  466. data/spec/models/send_smtp_email_reply_to_spec.rb +48 -0
  467. data/spec/models/send_smtp_email_sender_spec.rb +48 -0
  468. data/spec/models/send_smtp_email_spec.rb +96 -0
  469. data/spec/models/send_smtp_email_to_spec.rb +48 -0
  470. data/spec/models/send_template_email_spec.rb +42 -0
  471. data/spec/models/send_test_email_spec.rb +42 -0
  472. data/spec/models/send_test_sms_spec.rb +42 -0
  473. data/spec/models/send_transac_sms_spec.rb +66 -0
  474. data/spec/models/update_campaign_status_spec.rb +46 -0
  475. data/spec/models/update_child_spec.rb +72 -0
  476. data/spec/models/update_contact_spec.rb +66 -0
  477. data/spec/models/update_email_campaign_recipients_spec.rb +48 -0
  478. data/spec/models/update_email_campaign_sender_spec.rb +48 -0
  479. data/spec/models/update_email_campaign_spec.rb +138 -0
  480. data/spec/models/update_list_spec.rb +48 -0
  481. data/spec/models/update_sender_spec.rb +54 -0
  482. data/spec/models/update_sms_campaign_spec.rb +66 -0
  483. data/spec/models/update_smtp_template_sender_spec.rb +48 -0
  484. data/spec/models/update_smtp_template_spec.rb +96 -0
  485. data/spec/models/update_webhook_spec.rb +54 -0
  486. data/spec/spec_helper.rb +111 -0
  487. metadata +869 -0
@@ -0,0 +1,699 @@
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 |
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.2.3
10
+
11
+ =end
12
+
13
+ require "uri"
14
+
15
+ module SibApiV3Sdk
16
+ class SMTPApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+
23
+ # Create an smtp template
24
+ #
25
+ # @param smtp_template values to update in smtp template
26
+ # @param [Hash] opts the optional parameters
27
+ # @return [CreateModel]
28
+ def create_smtp_template(smtp_template, opts = {})
29
+ data, _status_code, _headers = create_smtp_template_with_http_info(smtp_template, opts)
30
+ return data
31
+ end
32
+
33
+ # Create an smtp template
34
+ #
35
+ # @param smtp_template values to update in smtp template
36
+ # @param [Hash] opts the optional parameters
37
+ # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers
38
+ def create_smtp_template_with_http_info(smtp_template, opts = {})
39
+ if @api_client.config.debugging
40
+ @api_client.config.logger.debug "Calling API: SMTPApi.create_smtp_template ..."
41
+ end
42
+ # verify the required parameter 'smtp_template' is set
43
+ if @api_client.config.client_side_validation && smtp_template.nil?
44
+ fail ArgumentError, "Missing the required parameter 'smtp_template' when calling SMTPApi.create_smtp_template"
45
+ end
46
+ # resource path
47
+ local_var_path = "/smtp/templates"
48
+
49
+ # query parameters
50
+ query_params = {}
51
+
52
+ # header parameters
53
+ header_params = {}
54
+ # HTTP header 'Accept' (if needed)
55
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
56
+ # HTTP header 'Content-Type'
57
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
58
+
59
+ # form parameters
60
+ form_params = {}
61
+
62
+ # http body (model)
63
+ post_body = @api_client.object_to_http_body(smtp_template)
64
+ auth_names = ['api-key']
65
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
66
+ :header_params => header_params,
67
+ :query_params => query_params,
68
+ :form_params => form_params,
69
+ :body => post_body,
70
+ :auth_names => auth_names,
71
+ :return_type => 'CreateModel')
72
+ if @api_client.config.debugging
73
+ @api_client.config.logger.debug "API called: SMTPApi#create_smtp_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
74
+ end
75
+ return data, status_code, headers
76
+ end
77
+
78
+ # Delete hardbounces
79
+ # Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
80
+ # @param [Hash] opts the optional parameters
81
+ # @option opts [DeleteHardbounces] :delete_hardbounces values to delete hardbounces
82
+ # @return [nil]
83
+ def delete_hardbounces(opts = {})
84
+ delete_hardbounces_with_http_info(opts)
85
+ return nil
86
+ end
87
+
88
+ # Delete hardbounces
89
+ # Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
90
+ # @param [Hash] opts the optional parameters
91
+ # @option opts [DeleteHardbounces] :delete_hardbounces values to delete hardbounces
92
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
93
+ def delete_hardbounces_with_http_info(opts = {})
94
+ if @api_client.config.debugging
95
+ @api_client.config.logger.debug "Calling API: SMTPApi.delete_hardbounces ..."
96
+ end
97
+ # resource path
98
+ local_var_path = "/smtp/deleteHardbounces"
99
+
100
+ # query parameters
101
+ query_params = {}
102
+
103
+ # header parameters
104
+ header_params = {}
105
+ # HTTP header 'Accept' (if needed)
106
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
107
+ # HTTP header 'Content-Type'
108
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
109
+
110
+ # form parameters
111
+ form_params = {}
112
+
113
+ # http body (model)
114
+ post_body = @api_client.object_to_http_body(opts[:'delete_hardbounces'])
115
+ auth_names = ['api-key']
116
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
117
+ :header_params => header_params,
118
+ :query_params => query_params,
119
+ :form_params => form_params,
120
+ :body => post_body,
121
+ :auth_names => auth_names)
122
+ if @api_client.config.debugging
123
+ @api_client.config.logger.debug "API called: SMTPApi#delete_hardbounces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
124
+ end
125
+ return data, status_code, headers
126
+ end
127
+
128
+ # Get your SMTP activity aggregated over a period of time
129
+ #
130
+ # @param [Hash] opts the optional parameters
131
+ # @option opts [Date] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
132
+ # @option opts [Date] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
133
+ # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
134
+ # @option opts [String] :tag Tag of the emails
135
+ # @return [GetAggregatedReport]
136
+ def get_aggregated_smtp_report(opts = {})
137
+ data, _status_code, _headers = get_aggregated_smtp_report_with_http_info(opts)
138
+ return data
139
+ end
140
+
141
+ # Get your SMTP activity aggregated over a period of time
142
+ #
143
+ # @param [Hash] opts the optional parameters
144
+ # @option opts [Date] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
145
+ # @option opts [Date] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
146
+ # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
147
+ # @option opts [String] :tag Tag of the emails
148
+ # @return [Array<(GetAggregatedReport, Fixnum, Hash)>] GetAggregatedReport data, response status code and response headers
149
+ def get_aggregated_smtp_report_with_http_info(opts = {})
150
+ if @api_client.config.debugging
151
+ @api_client.config.logger.debug "Calling API: SMTPApi.get_aggregated_smtp_report ..."
152
+ end
153
+ # resource path
154
+ local_var_path = "/smtp/statistics/aggregatedReport"
155
+
156
+ # query parameters
157
+ query_params = {}
158
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
159
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
160
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
161
+ query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
162
+
163
+ # header parameters
164
+ header_params = {}
165
+ # HTTP header 'Accept' (if needed)
166
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
167
+ # HTTP header 'Content-Type'
168
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
169
+
170
+ # form parameters
171
+ form_params = {}
172
+
173
+ # http body (model)
174
+ post_body = nil
175
+ auth_names = ['api-key']
176
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
177
+ :header_params => header_params,
178
+ :query_params => query_params,
179
+ :form_params => form_params,
180
+ :body => post_body,
181
+ :auth_names => auth_names,
182
+ :return_type => 'GetAggregatedReport')
183
+ if @api_client.config.debugging
184
+ @api_client.config.logger.debug "API called: SMTPApi#get_aggregated_smtp_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
185
+ end
186
+ return data, status_code, headers
187
+ end
188
+
189
+ # Get all your SMTP activity (unaggregated events)
190
+ #
191
+ # @param [Hash] opts the optional parameters
192
+ # @option opts [Integer] :limit Number limitation for the result returned (default to 50)
193
+ # @option opts [Integer] :offset Beginning point in the list to retrieve from. (default to 0)
194
+ # @option opts [Date] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
195
+ # @option opts [Date] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
196
+ # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
197
+ # @option opts [String] :email Filter the report for a specific email addresses
198
+ # @option opts [String] :event Filter the report for a specific event type
199
+ # @option opts [String] :tags Filter the report for tags (serialized and urlencoded array)
200
+ # @option opts [String] :message_id Filter on a specific message id
201
+ # @option opts [String] :template_id Filter on a specific template id
202
+ # @return [GetEmailEventReport]
203
+ def get_email_event_report(opts = {})
204
+ data, _status_code, _headers = get_email_event_report_with_http_info(opts)
205
+ return data
206
+ end
207
+
208
+ # Get all your SMTP activity (unaggregated events)
209
+ #
210
+ # @param [Hash] opts the optional parameters
211
+ # @option opts [Integer] :limit Number limitation for the result returned
212
+ # @option opts [Integer] :offset Beginning point in the list to retrieve from.
213
+ # @option opts [Date] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
214
+ # @option opts [Date] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
215
+ # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
216
+ # @option opts [String] :email Filter the report for a specific email addresses
217
+ # @option opts [String] :event Filter the report for a specific event type
218
+ # @option opts [String] :tags Filter the report for tags (serialized and urlencoded array)
219
+ # @option opts [String] :message_id Filter on a specific message id
220
+ # @option opts [String] :template_id Filter on a specific template id
221
+ # @return [Array<(GetEmailEventReport, Fixnum, Hash)>] GetEmailEventReport data, response status code and response headers
222
+ def get_email_event_report_with_http_info(opts = {})
223
+ if @api_client.config.debugging
224
+ @api_client.config.logger.debug "Calling API: SMTPApi.get_email_event_report ..."
225
+ end
226
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
227
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMTPApi.get_email_event_report, must be smaller than or equal to 100.'
228
+ end
229
+
230
+ if @api_client.config.client_side_validation && opts[:'event'] && !['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked'].include?(opts[:'event'])
231
+ fail ArgumentError, 'invalid value for "event", must be one of bounces, hardBounces, softBounces, delivered, spam, requests, opened, clicks, invalid, deferred, blocked'
232
+ end
233
+ # resource path
234
+ local_var_path = "/smtp/statistics/events"
235
+
236
+ # query parameters
237
+ query_params = {}
238
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
239
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
240
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
241
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
242
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
243
+ query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
244
+ query_params[:'event'] = opts[:'event'] if !opts[:'event'].nil?
245
+ query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
246
+ query_params[:'messageId'] = opts[:'message_id'] if !opts[:'message_id'].nil?
247
+ query_params[:'templateId'] = opts[:'template_id'] if !opts[:'template_id'].nil?
248
+
249
+ # header parameters
250
+ header_params = {}
251
+ # HTTP header 'Accept' (if needed)
252
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
253
+ # HTTP header 'Content-Type'
254
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
255
+
256
+ # form parameters
257
+ form_params = {}
258
+
259
+ # http body (model)
260
+ post_body = nil
261
+ auth_names = ['api-key']
262
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
263
+ :header_params => header_params,
264
+ :query_params => query_params,
265
+ :form_params => form_params,
266
+ :body => post_body,
267
+ :auth_names => auth_names,
268
+ :return_type => 'GetEmailEventReport')
269
+ if @api_client.config.debugging
270
+ @api_client.config.logger.debug "API called: SMTPApi#get_email_event_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
271
+ end
272
+ return data, status_code, headers
273
+ end
274
+
275
+ # Get your SMTP activity aggregated per day
276
+ #
277
+ # @param [Hash] opts the optional parameters
278
+ # @option opts [Integer] :limit Number of documents returned per page (default to 50)
279
+ # @option opts [Integer] :offset Index of the first document on the page (default to 0)
280
+ # @option opts [Date] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
281
+ # @option opts [Date] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
282
+ # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
283
+ # @option opts [String] :tag Tag of the emails
284
+ # @return [GetReports]
285
+ def get_smtp_report(opts = {})
286
+ data, _status_code, _headers = get_smtp_report_with_http_info(opts)
287
+ return data
288
+ end
289
+
290
+ # Get your SMTP activity aggregated per day
291
+ #
292
+ # @param [Hash] opts the optional parameters
293
+ # @option opts [Integer] :limit Number of documents returned per page
294
+ # @option opts [Integer] :offset Index of the first document on the page
295
+ # @option opts [Date] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
296
+ # @option opts [Date] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
297
+ # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
298
+ # @option opts [String] :tag Tag of the emails
299
+ # @return [Array<(GetReports, Fixnum, Hash)>] GetReports data, response status code and response headers
300
+ def get_smtp_report_with_http_info(opts = {})
301
+ if @api_client.config.debugging
302
+ @api_client.config.logger.debug "Calling API: SMTPApi.get_smtp_report ..."
303
+ end
304
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
305
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMTPApi.get_smtp_report, must be smaller than or equal to 100.'
306
+ end
307
+
308
+ # resource path
309
+ local_var_path = "/smtp/statistics/reports"
310
+
311
+ # query parameters
312
+ query_params = {}
313
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
314
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
315
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
316
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
317
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
318
+ query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
319
+
320
+ # header parameters
321
+ header_params = {}
322
+ # HTTP header 'Accept' (if needed)
323
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
324
+ # HTTP header 'Content-Type'
325
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
326
+
327
+ # form parameters
328
+ form_params = {}
329
+
330
+ # http body (model)
331
+ post_body = nil
332
+ auth_names = ['api-key']
333
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
334
+ :header_params => header_params,
335
+ :query_params => query_params,
336
+ :form_params => form_params,
337
+ :body => post_body,
338
+ :auth_names => auth_names,
339
+ :return_type => 'GetReports')
340
+ if @api_client.config.debugging
341
+ @api_client.config.logger.debug "API called: SMTPApi#get_smtp_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
342
+ end
343
+ return data, status_code, headers
344
+ end
345
+
346
+ # Returns the template informations
347
+ #
348
+ # @param template_id id of the template
349
+ # @param [Hash] opts the optional parameters
350
+ # @return [GetSmtpTemplateOverview]
351
+ def get_smtp_template(template_id, opts = {})
352
+ data, _status_code, _headers = get_smtp_template_with_http_info(template_id, opts)
353
+ return data
354
+ end
355
+
356
+ # Returns the template informations
357
+ #
358
+ # @param template_id id of the template
359
+ # @param [Hash] opts the optional parameters
360
+ # @return [Array<(GetSmtpTemplateOverview, Fixnum, Hash)>] GetSmtpTemplateOverview data, response status code and response headers
361
+ def get_smtp_template_with_http_info(template_id, opts = {})
362
+ if @api_client.config.debugging
363
+ @api_client.config.logger.debug "Calling API: SMTPApi.get_smtp_template ..."
364
+ end
365
+ # verify the required parameter 'template_id' is set
366
+ if @api_client.config.client_side_validation && template_id.nil?
367
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling SMTPApi.get_smtp_template"
368
+ end
369
+ # resource path
370
+ local_var_path = "/smtp/templates/{templateId}".sub('{' + 'templateId' + '}', template_id.to_s)
371
+
372
+ # query parameters
373
+ query_params = {}
374
+
375
+ # header parameters
376
+ header_params = {}
377
+ # HTTP header 'Accept' (if needed)
378
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
379
+ # HTTP header 'Content-Type'
380
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
381
+
382
+ # form parameters
383
+ form_params = {}
384
+
385
+ # http body (model)
386
+ post_body = nil
387
+ auth_names = ['api-key']
388
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
389
+ :header_params => header_params,
390
+ :query_params => query_params,
391
+ :form_params => form_params,
392
+ :body => post_body,
393
+ :auth_names => auth_names,
394
+ :return_type => 'GetSmtpTemplateOverview')
395
+ if @api_client.config.debugging
396
+ @api_client.config.logger.debug "API called: SMTPApi#get_smtp_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
397
+ end
398
+ return data, status_code, headers
399
+ end
400
+
401
+ # Get the list of SMTP templates
402
+ #
403
+ # @param [Hash] opts the optional parameters
404
+ # @option opts [BOOLEAN] :template_status Filter on the status of the template. Active &#x3D; true, inactive &#x3D; false
405
+ # @option opts [Integer] :limit Number of documents returned per page (default to 50)
406
+ # @option opts [Integer] :offset Index of the first document in the page (default to 0)
407
+ # @return [GetSmtpTemplates]
408
+ def get_smtp_templates(opts = {})
409
+ data, _status_code, _headers = get_smtp_templates_with_http_info(opts)
410
+ return data
411
+ end
412
+
413
+ # Get the list of SMTP templates
414
+ #
415
+ # @param [Hash] opts the optional parameters
416
+ # @option opts [BOOLEAN] :template_status Filter on the status of the template. Active &#x3D; true, inactive &#x3D; false
417
+ # @option opts [Integer] :limit Number of documents returned per page
418
+ # @option opts [Integer] :offset Index of the first document in the page
419
+ # @return [Array<(GetSmtpTemplates, Fixnum, Hash)>] GetSmtpTemplates data, response status code and response headers
420
+ def get_smtp_templates_with_http_info(opts = {})
421
+ if @api_client.config.debugging
422
+ @api_client.config.logger.debug "Calling API: SMTPApi.get_smtp_templates ..."
423
+ end
424
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
425
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMTPApi.get_smtp_templates, must be smaller than or equal to 1000.'
426
+ end
427
+
428
+ # resource path
429
+ local_var_path = "/smtp/templates"
430
+
431
+ # query parameters
432
+ query_params = {}
433
+ query_params[:'templateStatus'] = opts[:'template_status'] if !opts[:'template_status'].nil?
434
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
435
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
436
+
437
+ # header parameters
438
+ header_params = {}
439
+ # HTTP header 'Accept' (if needed)
440
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
441
+ # HTTP header 'Content-Type'
442
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
443
+
444
+ # form parameters
445
+ form_params = {}
446
+
447
+ # http body (model)
448
+ post_body = nil
449
+ auth_names = ['api-key']
450
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
451
+ :header_params => header_params,
452
+ :query_params => query_params,
453
+ :form_params => form_params,
454
+ :body => post_body,
455
+ :auth_names => auth_names,
456
+ :return_type => 'GetSmtpTemplates')
457
+ if @api_client.config.debugging
458
+ @api_client.config.logger.debug "API called: SMTPApi#get_smtp_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
459
+ end
460
+ return data, status_code, headers
461
+ end
462
+
463
+ # Send a template
464
+ #
465
+ # @param template_id Id of the template
466
+ # @param send_email
467
+ # @param [Hash] opts the optional parameters
468
+ # @return [SendTemplateEmail]
469
+ def send_template(template_id, send_email, opts = {})
470
+ data, _status_code, _headers = send_template_with_http_info(template_id, send_email, opts)
471
+ return data
472
+ end
473
+
474
+ # Send a template
475
+ #
476
+ # @param template_id Id of the template
477
+ # @param send_email
478
+ # @param [Hash] opts the optional parameters
479
+ # @return [Array<(SendTemplateEmail, Fixnum, Hash)>] SendTemplateEmail data, response status code and response headers
480
+ def send_template_with_http_info(template_id, send_email, opts = {})
481
+ if @api_client.config.debugging
482
+ @api_client.config.logger.debug "Calling API: SMTPApi.send_template ..."
483
+ end
484
+ # verify the required parameter 'template_id' is set
485
+ if @api_client.config.client_side_validation && template_id.nil?
486
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling SMTPApi.send_template"
487
+ end
488
+ # verify the required parameter 'send_email' is set
489
+ if @api_client.config.client_side_validation && send_email.nil?
490
+ fail ArgumentError, "Missing the required parameter 'send_email' when calling SMTPApi.send_template"
491
+ end
492
+ # resource path
493
+ local_var_path = "/smtp/templates/{templateId}/send".sub('{' + 'templateId' + '}', template_id.to_s)
494
+
495
+ # query parameters
496
+ query_params = {}
497
+
498
+ # header parameters
499
+ header_params = {}
500
+ # HTTP header 'Accept' (if needed)
501
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
502
+ # HTTP header 'Content-Type'
503
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
504
+
505
+ # form parameters
506
+ form_params = {}
507
+
508
+ # http body (model)
509
+ post_body = @api_client.object_to_http_body(send_email)
510
+ auth_names = ['api-key']
511
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
512
+ :header_params => header_params,
513
+ :query_params => query_params,
514
+ :form_params => form_params,
515
+ :body => post_body,
516
+ :auth_names => auth_names,
517
+ :return_type => 'SendTemplateEmail')
518
+ if @api_client.config.debugging
519
+ @api_client.config.logger.debug "API called: SMTPApi#send_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
520
+ end
521
+ return data, status_code, headers
522
+ end
523
+
524
+ # Send a template to your test list
525
+ #
526
+ # @param template_id Id of the template
527
+ # @param send_test_email
528
+ # @param [Hash] opts the optional parameters
529
+ # @return [nil]
530
+ def send_test_template(template_id, send_test_email, opts = {})
531
+ send_test_template_with_http_info(template_id, send_test_email, opts)
532
+ return nil
533
+ end
534
+
535
+ # Send a template to your test list
536
+ #
537
+ # @param template_id Id of the template
538
+ # @param send_test_email
539
+ # @param [Hash] opts the optional parameters
540
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
541
+ def send_test_template_with_http_info(template_id, send_test_email, opts = {})
542
+ if @api_client.config.debugging
543
+ @api_client.config.logger.debug "Calling API: SMTPApi.send_test_template ..."
544
+ end
545
+ # verify the required parameter 'template_id' is set
546
+ if @api_client.config.client_side_validation && template_id.nil?
547
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling SMTPApi.send_test_template"
548
+ end
549
+ # verify the required parameter 'send_test_email' is set
550
+ if @api_client.config.client_side_validation && send_test_email.nil?
551
+ fail ArgumentError, "Missing the required parameter 'send_test_email' when calling SMTPApi.send_test_template"
552
+ end
553
+ # resource path
554
+ local_var_path = "/smtp/templates/{templateId}/sendTest".sub('{' + 'templateId' + '}', template_id.to_s)
555
+
556
+ # query parameters
557
+ query_params = {}
558
+
559
+ # header parameters
560
+ header_params = {}
561
+ # HTTP header 'Accept' (if needed)
562
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
563
+ # HTTP header 'Content-Type'
564
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
565
+
566
+ # form parameters
567
+ form_params = {}
568
+
569
+ # http body (model)
570
+ post_body = @api_client.object_to_http_body(send_test_email)
571
+ auth_names = ['api-key']
572
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
573
+ :header_params => header_params,
574
+ :query_params => query_params,
575
+ :form_params => form_params,
576
+ :body => post_body,
577
+ :auth_names => auth_names)
578
+ if @api_client.config.debugging
579
+ @api_client.config.logger.debug "API called: SMTPApi#send_test_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
580
+ end
581
+ return data, status_code, headers
582
+ end
583
+
584
+ # Send a transactional email
585
+ #
586
+ # @param send_smtp_email Values to send a transactional email
587
+ # @param [Hash] opts the optional parameters
588
+ # @return [CreateSmtpEmail]
589
+ def send_transac_email(send_smtp_email, opts = {})
590
+ data, _status_code, _headers = send_transac_email_with_http_info(send_smtp_email, opts)
591
+ return data
592
+ end
593
+
594
+ # Send a transactional email
595
+ #
596
+ # @param send_smtp_email Values to send a transactional email
597
+ # @param [Hash] opts the optional parameters
598
+ # @return [Array<(CreateSmtpEmail, Fixnum, Hash)>] CreateSmtpEmail data, response status code and response headers
599
+ def send_transac_email_with_http_info(send_smtp_email, opts = {})
600
+ if @api_client.config.debugging
601
+ @api_client.config.logger.debug "Calling API: SMTPApi.send_transac_email ..."
602
+ end
603
+ # verify the required parameter 'send_smtp_email' is set
604
+ if @api_client.config.client_side_validation && send_smtp_email.nil?
605
+ fail ArgumentError, "Missing the required parameter 'send_smtp_email' when calling SMTPApi.send_transac_email"
606
+ end
607
+ # resource path
608
+ local_var_path = "/smtp/email"
609
+
610
+ # query parameters
611
+ query_params = {}
612
+
613
+ # header parameters
614
+ header_params = {}
615
+ # HTTP header 'Accept' (if needed)
616
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
617
+ # HTTP header 'Content-Type'
618
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
619
+
620
+ # form parameters
621
+ form_params = {}
622
+
623
+ # http body (model)
624
+ post_body = @api_client.object_to_http_body(send_smtp_email)
625
+ auth_names = ['api-key']
626
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
627
+ :header_params => header_params,
628
+ :query_params => query_params,
629
+ :form_params => form_params,
630
+ :body => post_body,
631
+ :auth_names => auth_names,
632
+ :return_type => 'CreateSmtpEmail')
633
+ if @api_client.config.debugging
634
+ @api_client.config.logger.debug "API called: SMTPApi#send_transac_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
635
+ end
636
+ return data, status_code, headers
637
+ end
638
+
639
+ # Updates an smtp templates
640
+ #
641
+ # @param template_id id of the template
642
+ # @param smtp_template values to update in smtp template
643
+ # @param [Hash] opts the optional parameters
644
+ # @return [nil]
645
+ def update_smtp_template(template_id, smtp_template, opts = {})
646
+ update_smtp_template_with_http_info(template_id, smtp_template, opts)
647
+ return nil
648
+ end
649
+
650
+ # Updates an smtp templates
651
+ #
652
+ # @param template_id id of the template
653
+ # @param smtp_template values to update in smtp template
654
+ # @param [Hash] opts the optional parameters
655
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
656
+ def update_smtp_template_with_http_info(template_id, smtp_template, opts = {})
657
+ if @api_client.config.debugging
658
+ @api_client.config.logger.debug "Calling API: SMTPApi.update_smtp_template ..."
659
+ end
660
+ # verify the required parameter 'template_id' is set
661
+ if @api_client.config.client_side_validation && template_id.nil?
662
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling SMTPApi.update_smtp_template"
663
+ end
664
+ # verify the required parameter 'smtp_template' is set
665
+ if @api_client.config.client_side_validation && smtp_template.nil?
666
+ fail ArgumentError, "Missing the required parameter 'smtp_template' when calling SMTPApi.update_smtp_template"
667
+ end
668
+ # resource path
669
+ local_var_path = "/smtp/templates/{templateId}".sub('{' + 'templateId' + '}', template_id.to_s)
670
+
671
+ # query parameters
672
+ query_params = {}
673
+
674
+ # header parameters
675
+ header_params = {}
676
+ # HTTP header 'Accept' (if needed)
677
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
678
+ # HTTP header 'Content-Type'
679
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
680
+
681
+ # form parameters
682
+ form_params = {}
683
+
684
+ # http body (model)
685
+ post_body = @api_client.object_to_http_body(smtp_template)
686
+ auth_names = ['api-key']
687
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
688
+ :header_params => header_params,
689
+ :query_params => query_params,
690
+ :form_params => form_params,
691
+ :body => post_body,
692
+ :auth_names => auth_names)
693
+ if @api_client.config.debugging
694
+ @api_client.config.logger.debug "API called: SMTPApi#update_smtp_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
695
+ end
696
+ return data, status_code, headers
697
+ end
698
+ end
699
+ end