brevo 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1083) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/LICENSE.md +21 -0
  4. data/README.md +655 -0
  5. data/Rakefile +8 -0
  6. data/brevo.gemspec +46 -0
  7. data/docs/AbTestCampaignResult.md +15 -0
  8. data/docs/AbTestCampaignResultClickedLinks.md +9 -0
  9. data/docs/AbTestCampaignResultStatistics.md +13 -0
  10. data/docs/AbTestVersionClicks.md +7 -0
  11. data/docs/AbTestVersionClicksInner.md +10 -0
  12. data/docs/AbTestVersionStats.md +9 -0
  13. data/docs/AccountApi.md +125 -0
  14. data/docs/AddChildDomain.md +8 -0
  15. data/docs/AddContactToList.md +9 -0
  16. data/docs/AddCredits.md +9 -0
  17. data/docs/AuthenticateDomainModel.md +9 -0
  18. data/docs/BlockDomain.md +8 -0
  19. data/docs/Body.md +10 -0
  20. data/docs/Body1.md +10 -0
  21. data/docs/Body10.md +11 -0
  22. data/docs/Body11.md +8 -0
  23. data/docs/Body12.md +11 -0
  24. data/docs/Body2.md +11 -0
  25. data/docs/Body3.md +9 -0
  26. data/docs/Body4.md +9 -0
  27. data/docs/Body5.md +11 -0
  28. data/docs/Body6.md +18 -0
  29. data/docs/Body7.md +17 -0
  30. data/docs/Body8.md +13 -0
  31. data/docs/Body9.md +8 -0
  32. data/docs/BodyVariablesItems.md +7 -0
  33. data/docs/CompaniesApi.md +425 -0
  34. data/docs/CompaniesList.md +8 -0
  35. data/docs/Company.md +11 -0
  36. data/docs/CompanyAttributes.md +7 -0
  37. data/docs/CompanyAttributesInner.md +12 -0
  38. data/docs/ComponentItems.md +9 -0
  39. data/docs/ContactsApi.md +1767 -0
  40. data/docs/ConversationsApi.md +542 -0
  41. data/docs/ConversationsMessage.md +17 -0
  42. data/docs/ConversationsMessageFile.md +12 -0
  43. data/docs/ConversationsMessageFileImageInfo.md +10 -0
  44. data/docs/CouponsApi.md +305 -0
  45. data/docs/CreateApiKeyRequest.md +9 -0
  46. data/docs/CreateApiKeyResponse.md +9 -0
  47. data/docs/CreateAttribute.md +11 -0
  48. data/docs/CreateAttributeEnumeration.md +9 -0
  49. data/docs/CreateCategoryModel.md +8 -0
  50. data/docs/CreateChild.md +13 -0
  51. data/docs/CreateContact.md +15 -0
  52. data/docs/CreateCouponCollection.md +9 -0
  53. data/docs/CreateCoupons.md +9 -0
  54. data/docs/CreateDoiContact.md +13 -0
  55. data/docs/CreateDomain.md +8 -0
  56. data/docs/CreateDomainModel.md +11 -0
  57. data/docs/CreateDomainModelDnsRecords.md +9 -0
  58. data/docs/CreateDomainModelDnsRecordsDkimRecord.md +11 -0
  59. data/docs/CreateEmailCampaign.md +38 -0
  60. data/docs/CreateEmailCampaignRecipients.md +10 -0
  61. data/docs/CreateEmailCampaignSender.md +10 -0
  62. data/docs/CreateExternalFeed.md +16 -0
  63. data/docs/CreateList.md +9 -0
  64. data/docs/CreateModel.md +8 -0
  65. data/docs/CreateProductModel.md +8 -0
  66. data/docs/CreateReseller.md +9 -0
  67. data/docs/CreateSender.md +10 -0
  68. data/docs/CreateSenderIps.md +10 -0
  69. data/docs/CreateSenderModel.md +10 -0
  70. data/docs/CreateSmsCampaign.md +15 -0
  71. data/docs/CreateSmsCampaignRecipients.md +9 -0
  72. data/docs/CreateSmtpEmail.md +9 -0
  73. data/docs/CreateSmtpTemplate.md +17 -0
  74. data/docs/CreateSmtpTemplateSender.md +10 -0
  75. data/docs/CreateSubAccount.md +11 -0
  76. data/docs/CreateSubAccountResponse.md +8 -0
  77. data/docs/CreateUpdateBatchCategory.md +9 -0
  78. data/docs/CreateUpdateBatchCategoryModel.md +9 -0
  79. data/docs/CreateUpdateBatchProducts.md +9 -0
  80. data/docs/CreateUpdateBatchProductsModel.md +9 -0
  81. data/docs/CreateUpdateCategories.md +11 -0
  82. data/docs/CreateUpdateCategory.md +12 -0
  83. data/docs/CreateUpdateContactModel.md +8 -0
  84. data/docs/CreateUpdateFolder.md +8 -0
  85. data/docs/CreateUpdateProduct.md +18 -0
  86. data/docs/CreateUpdateProducts.md +17 -0
  87. data/docs/CreateWebhook.md +12 -0
  88. data/docs/CreateWhatsAppCampaign.md +11 -0
  89. data/docs/CreateWhatsAppCampaignRecipients.md +10 -0
  90. data/docs/CreateWhatsAppTemplate.md +13 -0
  91. data/docs/CreatedBatchId.md +8 -0
  92. data/docs/CreatedProcessId.md +8 -0
  93. data/docs/Deal.md +11 -0
  94. data/docs/DealAttributes.md +7 -0
  95. data/docs/DealAttributesInner.md +12 -0
  96. data/docs/DealsApi.md +588 -0
  97. data/docs/DealsList.md +8 -0
  98. data/docs/DeleteHardbounces.md +10 -0
  99. data/docs/DomainsApi.md +292 -0
  100. data/docs/EcommerceApi.md +675 -0
  101. data/docs/EmailCampaignsApi.md +801 -0
  102. data/docs/EmailExportRecipients.md +9 -0
  103. data/docs/ErrorModel.md +9 -0
  104. data/docs/ExportWebhooksHistory.md +16 -0
  105. data/docs/ExternalFeedsApi.md +322 -0
  106. data/docs/FileData.md +14 -0
  107. data/docs/FileDownloadableLink.md +8 -0
  108. data/docs/FileList.md +7 -0
  109. data/docs/FilesApi.md +318 -0
  110. data/docs/GetAccount.md +15 -0
  111. data/docs/GetAccountActivity.md +8 -0
  112. data/docs/GetAccountActivityLogs.md +12 -0
  113. data/docs/GetAccountMarketingAutomation.md +9 -0
  114. data/docs/GetAccountPlan.md +13 -0
  115. data/docs/GetAccountRelay.md +9 -0
  116. data/docs/GetAccountRelayData.md +10 -0
  117. data/docs/GetAggregatedReport.md +20 -0
  118. data/docs/GetAllExternalFeeds.md +9 -0
  119. data/docs/GetAllExternalFeedsFeeds.md +19 -0
  120. data/docs/GetAttributes.md +8 -0
  121. data/docs/GetAttributesAttributes.md +12 -0
  122. data/docs/GetAttributesEnumeration.md +9 -0
  123. data/docs/GetBlockedDomains.md +8 -0
  124. data/docs/GetCampaignOverview.md +21 -0
  125. data/docs/GetCampaignRecipients.md +9 -0
  126. data/docs/GetCampaignStats.md +23 -0
  127. data/docs/GetCategories.md +9 -0
  128. data/docs/GetCategoryDetails.md +13 -0
  129. data/docs/GetChildAccountCreationStatus.md +8 -0
  130. data/docs/GetChildDomain.md +9 -0
  131. data/docs/GetChildDomains.md +7 -0
  132. data/docs/GetChildInfo.md +16 -0
  133. data/docs/GetChildInfoApiKeys.md +9 -0
  134. data/docs/GetChildInfoApiKeysV2.md +9 -0
  135. data/docs/GetChildInfoApiKeysV3.md +9 -0
  136. data/docs/GetChildInfoCredits.md +9 -0
  137. data/docs/GetChildInfoStatistics.md +10 -0
  138. data/docs/GetChildrenList.md +9 -0
  139. data/docs/GetClient.md +11 -0
  140. data/docs/GetContactCampaignStats.md +16 -0
  141. data/docs/GetContactCampaignStatsClicked.md +9 -0
  142. data/docs/GetContactCampaignStatsOpened.md +11 -0
  143. data/docs/GetContactCampaignStatsTransacAttributes.md +10 -0
  144. data/docs/GetContactCampaignStatsUnsubscriptions.md +9 -0
  145. data/docs/GetContactDetails.md +16 -0
  146. data/docs/GetContacts.md +9 -0
  147. data/docs/GetCouponCollection.md +13 -0
  148. data/docs/GetDeviceBrowserStats.md +11 -0
  149. data/docs/GetDomainConfigurationModel.md +11 -0
  150. data/docs/GetDomainsList.md +8 -0
  151. data/docs/GetDomainsListDomains.md +12 -0
  152. data/docs/GetEmailCampaign.md +39 -0
  153. data/docs/GetEmailCampaigns.md +9 -0
  154. data/docs/GetEmailEventReport.md +8 -0
  155. data/docs/GetEmailEventReportEvents.md +18 -0
  156. data/docs/GetExtendedCampaignOverview.md +37 -0
  157. data/docs/GetExtendedCampaignOverviewSender.md +10 -0
  158. data/docs/GetExtendedCampaignStats.md +15 -0
  159. data/docs/GetExtendedCampaignStatsGlobalStats.md +7 -0
  160. data/docs/GetExtendedClient.md +12 -0
  161. data/docs/GetExtendedClientAddress.md +11 -0
  162. data/docs/GetExtendedContactDetails.md +17 -0
  163. data/docs/GetExtendedContactDetailsStatistics.md +16 -0
  164. data/docs/GetExtendedContactDetailsStatisticsClicked.md +9 -0
  165. data/docs/GetExtendedContactDetailsStatisticsDelivered.md +9 -0
  166. data/docs/GetExtendedContactDetailsStatisticsLinks.md +11 -0
  167. data/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +9 -0
  168. data/docs/GetExtendedContactDetailsStatisticsOpened.md +11 -0
  169. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md +9 -0
  170. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +9 -0
  171. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +10 -0
  172. data/docs/GetExtendedList.md +16 -0
  173. data/docs/GetExtendedListCampaignStats.md +9 -0
  174. data/docs/GetExternalFeedByUUID.md +19 -0
  175. data/docs/GetExternalFeedByUUIDHeaders.md +9 -0
  176. data/docs/GetFolder.md +12 -0
  177. data/docs/GetFolderLists.md +9 -0
  178. data/docs/GetFolders.md +9 -0
  179. data/docs/GetInboundEmailEvents.md +8 -0
  180. data/docs/GetInboundEmailEventsByUuid.md +15 -0
  181. data/docs/GetInboundEmailEventsByUuidAttachments.md +11 -0
  182. data/docs/GetInboundEmailEventsByUuidLogs.md +9 -0
  183. data/docs/GetInboundEmailEventsEvents.md +11 -0
  184. data/docs/GetInvitedUsersList.md +8 -0
  185. data/docs/GetInvitedUsersListFeatureAccess.md +10 -0
  186. data/docs/GetInvitedUsersListUsers.md +11 -0
  187. data/docs/GetIp.md +11 -0
  188. data/docs/GetIpFromSender.md +11 -0
  189. data/docs/GetIps.md +8 -0
  190. data/docs/GetIpsFromSender.md +8 -0
  191. data/docs/GetList.md +12 -0
  192. data/docs/GetLists.md +9 -0
  193. data/docs/GetProcess.md +11 -0
  194. data/docs/GetProcesses.md +9 -0
  195. data/docs/GetProductDetails.md +22 -0
  196. data/docs/GetProducts.md +9 -0
  197. data/docs/GetReports.md +8 -0
  198. data/docs/GetReportsReports.md +20 -0
  199. data/docs/GetScheduledEmailByBatchId.md +9 -0
  200. data/docs/GetScheduledEmailByBatchIdBatches.md +10 -0
  201. data/docs/GetScheduledEmailByMessageId.md +10 -0
  202. data/docs/GetSegments.md +9 -0
  203. data/docs/GetSegmentsSegments.md +11 -0
  204. data/docs/GetSendersList.md +8 -0
  205. data/docs/GetSendersListIps.md +10 -0
  206. data/docs/GetSendersListSenders.md +12 -0
  207. data/docs/GetSharedTemplateUrl.md +8 -0
  208. data/docs/GetSmsCampaign.md +17 -0
  209. data/docs/GetSmsCampaignOverview.md +15 -0
  210. data/docs/GetSmsCampaignRecipients.md +7 -0
  211. data/docs/GetSmsCampaignStats.md +14 -0
  212. data/docs/GetSmsCampaigns.md +9 -0
  213. data/docs/GetSmsEventReport.md +8 -0
  214. data/docs/GetSmsEventReportEvents.md +14 -0
  215. data/docs/GetSmtpTemplateOverview.md +20 -0
  216. data/docs/GetSmtpTemplateOverviewSender.md +10 -0
  217. data/docs/GetSmtpTemplates.md +9 -0
  218. data/docs/GetSsoToken.md +8 -0
  219. data/docs/GetStatsByBrowser.md +7 -0
  220. data/docs/GetStatsByDevice.md +11 -0
  221. data/docs/GetStatsByDomain.md +7 -0
  222. data/docs/GetTransacAggregatedSmsReport.md +17 -0
  223. data/docs/GetTransacBlockedContacts.md +9 -0
  224. data/docs/GetTransacBlockedContactsContacts.md +11 -0
  225. data/docs/GetTransacBlockedContactsReason.md +9 -0
  226. data/docs/GetTransacEmailContent.md +14 -0
  227. data/docs/GetTransacEmailContentEvents.md +9 -0
  228. data/docs/GetTransacEmailsList.md +9 -0
  229. data/docs/GetTransacEmailsListTransactionalEmails.md +15 -0
  230. data/docs/GetTransacSmsReport.md +8 -0
  231. data/docs/GetTransacSmsReportReports.md +17 -0
  232. data/docs/GetUserPermission.md +10 -0
  233. data/docs/GetUserPermissionPrivileges.md +9 -0
  234. data/docs/GetWATemplates.md +9 -0
  235. data/docs/GetWATemplatesTemplates.md +15 -0
  236. data/docs/GetWebhook.md +14 -0
  237. data/docs/GetWebhooks.md +8 -0
  238. data/docs/GetWhatsAppConfig.md +13 -0
  239. data/docs/GetWhatsappCampaignOverview.md +16 -0
  240. data/docs/GetWhatsappCampaigns.md +9 -0
  241. data/docs/GetWhatsappCampaignsCampaigns.md +18 -0
  242. data/docs/GetWhatsappEventReport.md +8 -0
  243. data/docs/GetWhatsappEventReportEvents.md +15 -0
  244. data/docs/InboundParsingApi.md +199 -0
  245. data/docs/InlineResponse200.md +8 -0
  246. data/docs/InlineResponse2001.md +10 -0
  247. data/docs/InlineResponse201.md +8 -0
  248. data/docs/InlineResponse2011.md +8 -0
  249. data/docs/InlineResponse2012.md +8 -0
  250. data/docs/InlineResponse2013.md +8 -0
  251. data/docs/InlineResponse2014.md +8 -0
  252. data/docs/ManageIp.md +8 -0
  253. data/docs/MasterAccountApi.md +611 -0
  254. data/docs/MasterDetailsResponse.md +14 -0
  255. data/docs/MasterDetailsResponseBillingInfo.md +11 -0
  256. data/docs/MasterDetailsResponseBillingInfoAddress.md +12 -0
  257. data/docs/MasterDetailsResponseBillingInfoName.md +9 -0
  258. data/docs/MasterDetailsResponsePlanInfo.md +13 -0
  259. data/docs/MasterDetailsResponsePlanInfoFeatures.md +12 -0
  260. data/docs/Note.md +14 -0
  261. data/docs/NoteData.md +11 -0
  262. data/docs/NoteId.md +8 -0
  263. data/docs/NoteList.md +7 -0
  264. data/docs/NotesApi.md +312 -0
  265. data/docs/Order.md +16 -0
  266. data/docs/OrderBatch.md +9 -0
  267. data/docs/OrderBilling.md +14 -0
  268. data/docs/OrderProducts.md +11 -0
  269. data/docs/Otp.md +8 -0
  270. data/docs/Pipeline.md +10 -0
  271. data/docs/PipelineStage.md +9 -0
  272. data/docs/Pipelines.md +7 -0
  273. data/docs/PostContactInfo.md +8 -0
  274. data/docs/PostContactInfoContacts.md +11 -0
  275. data/docs/PostSendFailed.md +12 -0
  276. data/docs/PostSendSmsTestFailed.md +11 -0
  277. data/docs/ProcessApi.md +129 -0
  278. data/docs/RemainingCreditModel.md +9 -0
  279. data/docs/RemainingCreditModelChild.md +9 -0
  280. data/docs/RemainingCreditModelReseller.md +9 -0
  281. data/docs/RemoveContactFromList.md +10 -0
  282. data/docs/RemoveCredits.md +9 -0
  283. data/docs/RequestContactExport.md +10 -0
  284. data/docs/RequestContactExportCustomContactFilter.md +13 -0
  285. data/docs/RequestContactImport.md +17 -0
  286. data/docs/RequestContactImportJsonBody.md +9 -0
  287. data/docs/RequestContactImportNewList.md +9 -0
  288. data/docs/RequestSMSRecipientExport.md +9 -0
  289. data/docs/ResellerApi.md +964 -0
  290. data/docs/SMSCampaignsApi.md +613 -0
  291. data/docs/ScheduleSmtpEmail.md +10 -0
  292. data/docs/SendReport.md +9 -0
  293. data/docs/SendReportEmail.md +9 -0
  294. data/docs/SendSms.md +12 -0
  295. data/docs/SendSmtpEmail.md +23 -0
  296. data/docs/SendSmtpEmailAttachment.md +10 -0
  297. data/docs/SendSmtpEmailBcc.md +9 -0
  298. data/docs/SendSmtpEmailCc.md +9 -0
  299. data/docs/SendSmtpEmailMessageVersions.md +13 -0
  300. data/docs/SendSmtpEmailReplyTo.md +9 -0
  301. data/docs/SendSmtpEmailReplyTo1.md +9 -0
  302. data/docs/SendSmtpEmailSender.md +10 -0
  303. data/docs/SendSmtpEmailTo.md +9 -0
  304. data/docs/SendSmtpEmailTo1.md +9 -0
  305. data/docs/SendTestEmail.md +8 -0
  306. data/docs/SendTestSms.md +8 -0
  307. data/docs/SendTransacSms.md +15 -0
  308. data/docs/SendWhatsappMessage.md +11 -0
  309. data/docs/SendersApi.md +417 -0
  310. data/docs/SsoTokenRequest.md +11 -0
  311. data/docs/SubAccountAppsToggleRequest.md +20 -0
  312. data/docs/SubAccountDetailsResponse.md +11 -0
  313. data/docs/SubAccountDetailsResponsePlanInfo.md +10 -0
  314. data/docs/SubAccountDetailsResponsePlanInfoCredits.md +9 -0
  315. data/docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md +9 -0
  316. data/docs/SubAccountDetailsResponsePlanInfoFeatures.md +10 -0
  317. data/docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md +9 -0
  318. data/docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md +9 -0
  319. data/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +9 -0
  320. data/docs/SubAccountUpdatePlanRequest.md +9 -0
  321. data/docs/SubAccountUpdatePlanRequestCredits.md +8 -0
  322. data/docs/SubAccountUpdatePlanRequestFeatures.md +10 -0
  323. data/docs/SubAccountsResponse.md +9 -0
  324. data/docs/SubAccountsResponseSubAccounts.md +11 -0
  325. data/docs/Task.md +13 -0
  326. data/docs/TaskList.md +8 -0
  327. data/docs/TaskReminder.md +10 -0
  328. data/docs/TaskTypes.md +9 -0
  329. data/docs/TasksApi.md +376 -0
  330. data/docs/TransactionalEmailsApi.md +1390 -0
  331. data/docs/TransactionalSMSApi.md +273 -0
  332. data/docs/TransactionalWhatsAppApi.md +143 -0
  333. data/docs/UpdateAttribute.md +9 -0
  334. data/docs/UpdateAttributeEnumeration.md +9 -0
  335. data/docs/UpdateBatchContacts.md +8 -0
  336. data/docs/UpdateBatchContactsContacts.md +17 -0
  337. data/docs/UpdateBatchContactsModel.md +9 -0
  338. data/docs/UpdateCampaignStatus.md +8 -0
  339. data/docs/UpdateChild.md +12 -0
  340. data/docs/UpdateChildAccountStatus.md +11 -0
  341. data/docs/UpdateChildDomain.md +8 -0
  342. data/docs/UpdateContact.md +14 -0
  343. data/docs/UpdateCouponCollection.md +8 -0
  344. data/docs/UpdateEmailCampaign.md +38 -0
  345. data/docs/UpdateEmailCampaignRecipients.md +10 -0
  346. data/docs/UpdateEmailCampaignSender.md +10 -0
  347. data/docs/UpdateExternalFeed.md +16 -0
  348. data/docs/UpdateList.md +9 -0
  349. data/docs/UpdateSender.md +10 -0
  350. data/docs/UpdateSmsCampaign.md +15 -0
  351. data/docs/UpdateSmtpTemplate.md +17 -0
  352. data/docs/UpdateSmtpTemplateSender.md +10 -0
  353. data/docs/UpdateWebhook.md +11 -0
  354. data/docs/UpdateWhatsAppCampaign.md +11 -0
  355. data/docs/UploadImageModel.md +8 -0
  356. data/docs/UploadImageToGallery.md +9 -0
  357. data/docs/UserApi.md +118 -0
  358. data/docs/VariablesItems.md +10 -0
  359. data/docs/WebhooksApi.md +362 -0
  360. data/docs/WhatsAppCampaignsApi.md +543 -0
  361. data/docs/WhatsappCampStats.md +12 -0
  362. data/docs/WhatsappCampTemplate.md +18 -0
  363. data/lib/brevo/api/account_api.rb +145 -0
  364. data/lib/brevo/api/companies_api.rb +419 -0
  365. data/lib/brevo/api/contacts_api.rb +1735 -0
  366. data/lib/brevo/api/conversations_api.rb +514 -0
  367. data/lib/brevo/api/coupons_api.rb +316 -0
  368. data/lib/brevo/api/deals_api.rb +564 -0
  369. data/lib/brevo/api/domains_api.rb +282 -0
  370. data/lib/brevo/api/ecommerce_api.rb +655 -0
  371. data/lib/brevo/api/email_campaigns_api.rb +785 -0
  372. data/lib/brevo/api/external_feeds_api.rb +336 -0
  373. data/lib/brevo/api/files_api.rb +323 -0
  374. data/lib/brevo/api/inbound_parsing_api.rb +218 -0
  375. data/lib/brevo/api/master_account_api.rb +594 -0
  376. data/lib/brevo/api/notes_api.rb +318 -0
  377. data/lib/brevo/api/process_api.rb +151 -0
  378. data/lib/brevo/api/reseller_api.rb +923 -0
  379. data/lib/brevo/api/senders_api.rb +388 -0
  380. data/lib/brevo/api/sms_campaigns_api.rb +603 -0
  381. data/lib/brevo/api/tasks_api.rb +385 -0
  382. data/lib/brevo/api/transactional_emails_api.rb +1370 -0
  383. data/lib/brevo/api/transactional_sms_api.rb +290 -0
  384. data/lib/brevo/api/transactional_whats_app_api.rb +173 -0
  385. data/lib/brevo/api/user_api.rb +131 -0
  386. data/lib/brevo/api/webhooks_api.rb +357 -0
  387. data/lib/brevo/api/whats_app_campaigns_api.rb +534 -0
  388. data/lib/brevo/api_client.rb +392 -0
  389. data/lib/brevo/api_error.rb +38 -0
  390. data/lib/brevo/configuration.rb +216 -0
  391. data/lib/brevo/models/ab_test_campaign_result.rb +299 -0
  392. data/lib/brevo/models/ab_test_campaign_result_clicked_links.rb +203 -0
  393. data/lib/brevo/models/ab_test_campaign_result_statistics.rb +259 -0
  394. data/lib/brevo/models/ab_test_version_clicks.rb +176 -0
  395. data/lib/brevo/models/ab_test_version_clicks_inner.rb +220 -0
  396. data/lib/brevo/models/ab_test_version_stats.rb +206 -0
  397. data/lib/brevo/models/add_child_domain.rb +185 -0
  398. data/lib/brevo/models/add_contact_to_list.rb +199 -0
  399. data/lib/brevo/models/add_credits.rb +195 -0
  400. data/lib/brevo/models/authenticate_domain_model.rb +205 -0
  401. data/lib/brevo/models/block_domain.rb +190 -0
  402. data/lib/brevo/models/body.rb +210 -0
  403. data/lib/brevo/models/body_1.rb +205 -0
  404. data/lib/brevo/models/body_10.rb +225 -0
  405. data/lib/brevo/models/body_11.rb +190 -0
  406. data/lib/brevo/models/body_12.rb +215 -0
  407. data/lib/brevo/models/body_2.rb +223 -0
  408. data/lib/brevo/models/body_3.rb +200 -0
  409. data/lib/brevo/models/body_4.rb +195 -0
  410. data/lib/brevo/models/body_5.rb +223 -0
  411. data/lib/brevo/models/body_6.rb +320 -0
  412. data/lib/brevo/models/body_7.rb +281 -0
  413. data/lib/brevo/models/body_8.rb +245 -0
  414. data/lib/brevo/models/body_9.rb +190 -0
  415. data/lib/brevo/models/body_variables_items.rb +175 -0
  416. data/lib/brevo/models/companies_list.rb +188 -0
  417. data/lib/brevo/models/company.rb +220 -0
  418. data/lib/brevo/models/company_attributes.rb +176 -0
  419. data/lib/brevo/models/company_attributes_inner.rb +223 -0
  420. data/lib/brevo/models/component_items.rb +193 -0
  421. data/lib/brevo/models/conversations_message.rb +324 -0
  422. data/lib/brevo/models/conversations_message_file.rb +239 -0
  423. data/lib/brevo/models/conversations_message_file_image_info.rb +236 -0
  424. data/lib/brevo/models/create_api_key_request.rb +200 -0
  425. data/lib/brevo/models/create_api_key_response.rb +195 -0
  426. data/lib/brevo/models/create_attribute.rb +251 -0
  427. data/lib/brevo/models/create_attribute_enumeration.rb +205 -0
  428. data/lib/brevo/models/create_category_model.rb +185 -0
  429. data/lib/brevo/models/create_child.rb +294 -0
  430. data/lib/brevo/models/create_contact.rb +261 -0
  431. data/lib/brevo/models/create_coupon_collection.rb +205 -0
  432. data/lib/brevo/models/create_coupons.rb +206 -0
  433. data/lib/brevo/models/create_doi_contact.rb +259 -0
  434. data/lib/brevo/models/create_domain.rb +190 -0
  435. data/lib/brevo/models/create_domain_model.rb +219 -0
  436. data/lib/brevo/models/create_domain_model_dns_records.rb +193 -0
  437. data/lib/brevo/models/create_domain_model_dns_records_dkim_record.rb +211 -0
  438. data/lib/brevo/models/create_email_campaign.rb +607 -0
  439. data/lib/brevo/models/create_email_campaign_recipients.rb +212 -0
  440. data/lib/brevo/models/create_email_campaign_sender.rb +211 -0
  441. data/lib/brevo/models/create_external_feed.rb +339 -0
  442. data/lib/brevo/models/create_list.rb +205 -0
  443. data/lib/brevo/models/create_model.rb +190 -0
  444. data/lib/brevo/models/create_product_model.rb +185 -0
  445. data/lib/brevo/models/create_reseller.rb +200 -0
  446. data/lib/brevo/models/create_sender.rb +217 -0
  447. data/lib/brevo/models/create_sender_ips.rb +239 -0
  448. data/lib/brevo/models/create_sender_model.rb +210 -0
  449. data/lib/brevo/models/create_sms_campaign.rb +290 -0
  450. data/lib/brevo/models/create_sms_campaign_recipients.rb +204 -0
  451. data/lib/brevo/models/create_smtp_email.rb +196 -0
  452. data/lib/brevo/models/create_smtp_template.rb +289 -0
  453. data/lib/brevo/models/create_smtp_template_sender.rb +206 -0
  454. data/lib/brevo/models/create_sub_account.rb +259 -0
  455. data/lib/brevo/models/create_sub_account_response.rb +190 -0
  456. data/lib/brevo/models/create_update_batch_category.rb +202 -0
  457. data/lib/brevo/models/create_update_batch_category_model.rb +195 -0
  458. data/lib/brevo/models/create_update_batch_products.rb +202 -0
  459. data/lib/brevo/models/create_update_batch_products_model.rb +195 -0
  460. data/lib/brevo/models/create_update_categories.rb +220 -0
  461. data/lib/brevo/models/create_update_category.rb +232 -0
  462. data/lib/brevo/models/create_update_contact_model.rb +185 -0
  463. data/lib/brevo/models/create_update_folder.rb +185 -0
  464. data/lib/brevo/models/create_update_product.rb +301 -0
  465. data/lib/brevo/models/create_update_products.rb +289 -0
  466. data/lib/brevo/models/create_webhook.rb +273 -0
  467. data/lib/brevo/models/create_whats_app_campaign.rb +234 -0
  468. data/lib/brevo/models/create_whats_app_campaign_recipients.rb +212 -0
  469. data/lib/brevo/models/create_whats_app_template.rb +289 -0
  470. data/lib/brevo/models/created_batch_id.rb +190 -0
  471. data/lib/brevo/models/created_process_id.rb +190 -0
  472. data/lib/brevo/models/deal.rb +220 -0
  473. data/lib/brevo/models/deal_attributes.rb +176 -0
  474. data/lib/brevo/models/deal_attributes_inner.rb +223 -0
  475. data/lib/brevo/models/deals_list.rb +188 -0
  476. data/lib/brevo/models/delete_hardbounces.rb +205 -0
  477. data/lib/brevo/models/email_export_recipients.rb +234 -0
  478. data/lib/brevo/models/error_model.rb +239 -0
  479. data/lib/brevo/models/export_webhooks_history.rb +309 -0
  480. data/lib/brevo/models/file_data.rb +246 -0
  481. data/lib/brevo/models/file_downloadable_link.rb +190 -0
  482. data/lib/brevo/models/file_list.rb +176 -0
  483. data/lib/brevo/models/get_account.rb +289 -0
  484. data/lib/brevo/models/get_account_activity.rb +187 -0
  485. data/lib/brevo/models/get_account_activity_logs.rb +250 -0
  486. data/lib/brevo/models/get_account_marketing_automation.rb +200 -0
  487. data/lib/brevo/models/get_account_plan.rb +296 -0
  488. data/lib/brevo/models/get_account_relay.rb +205 -0
  489. data/lib/brevo/models/get_account_relay_data.rb +221 -0
  490. data/lib/brevo/models/get_aggregated_report.rb +305 -0
  491. data/lib/brevo/models/get_all_external_feeds.rb +196 -0
  492. data/lib/brevo/models/get_all_external_feeds_feeds.rb +404 -0
  493. data/lib/brevo/models/get_attributes.rb +192 -0
  494. data/lib/brevo/models/get_attributes_attributes.rb +283 -0
  495. data/lib/brevo/models/get_attributes_enumeration.rb +205 -0
  496. data/lib/brevo/models/get_blocked_domains.rb +193 -0
  497. data/lib/brevo/models/get_campaign_overview.rb +381 -0
  498. data/lib/brevo/models/get_campaign_recipients.rb +207 -0
  499. data/lib/brevo/models/get_campaign_stats.rb +390 -0
  500. data/lib/brevo/models/get_categories.rb +206 -0
  501. data/lib/brevo/models/get_category_details.rb +255 -0
  502. data/lib/brevo/models/get_child_account_creation_status.rb +190 -0
  503. data/lib/brevo/models/get_child_domain.rb +195 -0
  504. data/lib/brevo/models/get_child_domains.rb +175 -0
  505. data/lib/brevo/models/get_child_info.rb +289 -0
  506. data/lib/brevo/models/get_child_info_api_keys.rb +203 -0
  507. data/lib/brevo/models/get_child_info_api_keys_v2.rb +205 -0
  508. data/lib/brevo/models/get_child_info_api_keys_v3.rb +205 -0
  509. data/lib/brevo/models/get_child_info_credits.rb +196 -0
  510. data/lib/brevo/models/get_child_info_statistics.rb +206 -0
  511. data/lib/brevo/models/get_children_list.rb +197 -0
  512. data/lib/brevo/models/get_client.rb +235 -0
  513. data/lib/brevo/models/get_contact_campaign_stats.rb +273 -0
  514. data/lib/brevo/models/get_contact_campaign_stats_clicked.rb +206 -0
  515. data/lib/brevo/models/get_contact_campaign_stats_opened.rb +235 -0
  516. data/lib/brevo/models/get_contact_campaign_stats_transac_attributes.rb +220 -0
  517. data/lib/brevo/models/get_contact_campaign_stats_unsubscriptions.rb +209 -0
  518. data/lib/brevo/models/get_contact_details.rb +307 -0
  519. data/lib/brevo/models/get_contacts.rb +206 -0
  520. data/lib/brevo/models/get_coupon_collection.rb +265 -0
  521. data/lib/brevo/models/get_device_browser_stats.rb +235 -0
  522. data/lib/brevo/models/get_domain_configuration_model.rb +234 -0
  523. data/lib/brevo/models/get_domains_list.rb +187 -0
  524. data/lib/brevo/models/get_domains_list_domains.rb +245 -0
  525. data/lib/brevo/models/get_email_campaign.rb +608 -0
  526. data/lib/brevo/models/get_email_campaigns.rb +196 -0
  527. data/lib/brevo/models/get_email_event_report.rb +186 -0
  528. data/lib/brevo/models/get_email_event_report_events.rb +339 -0
  529. data/lib/brevo/models/get_extended_campaign_overview.rb +580 -0
  530. data/lib/brevo/models/get_extended_campaign_overview_sender.rb +205 -0
  531. data/lib/brevo/models/get_extended_campaign_stats.rb +295 -0
  532. data/lib/brevo/models/get_extended_campaign_stats_global_stats.rb +176 -0
  533. data/lib/brevo/models/get_extended_client.rb +249 -0
  534. data/lib/brevo/models/get_extended_client_address.rb +236 -0
  535. data/lib/brevo/models/get_extended_contact_details.rb +321 -0
  536. data/lib/brevo/models/get_extended_contact_details_statistics.rb +281 -0
  537. data/lib/brevo/models/get_extended_contact_details_statistics_clicked.rb +207 -0
  538. data/lib/brevo/models/get_extended_contact_details_statistics_delivered.rb +205 -0
  539. data/lib/brevo/models/get_extended_contact_details_statistics_links.rb +235 -0
  540. data/lib/brevo/models/get_extended_contact_details_statistics_messages_sent.rb +205 -0
  541. data/lib/brevo/models/get_extended_contact_details_statistics_opened.rb +235 -0
  542. data/lib/brevo/models/get_extended_contact_details_statistics_unsubscriptions.rb +210 -0
  543. data/lib/brevo/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +200 -0
  544. data/lib/brevo/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +215 -0
  545. data/lib/brevo/models/get_extended_list.rb +301 -0
  546. data/lib/brevo/models/get_extended_list_campaign_stats.rb +204 -0
  547. data/lib/brevo/models/get_external_feed_by_uuid.rb +404 -0
  548. data/lib/brevo/models/get_external_feed_by_uuid_headers.rb +195 -0
  549. data/lib/brevo/models/get_folder.rb +250 -0
  550. data/lib/brevo/models/get_folder_lists.rb +196 -0
  551. data/lib/brevo/models/get_folders.rb +196 -0
  552. data/lib/brevo/models/get_inbound_email_events.rb +186 -0
  553. data/lib/brevo/models/get_inbound_email_events_by_uuid.rb +259 -0
  554. data/lib/brevo/models/get_inbound_email_events_by_uuid_attachments.rb +215 -0
  555. data/lib/brevo/models/get_inbound_email_events_by_uuid_logs.rb +229 -0
  556. data/lib/brevo/models/get_inbound_email_events_events.rb +235 -0
  557. data/lib/brevo/models/get_invited_users_list.rb +187 -0
  558. data/lib/brevo/models/get_invited_users_list_feature_access.rb +206 -0
  559. data/lib/brevo/models/get_invited_users_list_users.rb +234 -0
  560. data/lib/brevo/models/get_ip.rb +235 -0
  561. data/lib/brevo/models/get_ip_from_sender.rb +235 -0
  562. data/lib/brevo/models/get_ips.rb +192 -0
  563. data/lib/brevo/models/get_ips_from_sender.rb +192 -0
  564. data/lib/brevo/models/get_list.rb +250 -0
  565. data/lib/brevo/models/get_lists.rb +197 -0
  566. data/lib/brevo/models/get_process.rb +264 -0
  567. data/lib/brevo/models/get_processes.rb +197 -0
  568. data/lib/brevo/models/get_product_details.rb +357 -0
  569. data/lib/brevo/models/get_products.rb +206 -0
  570. data/lib/brevo/models/get_reports.rb +186 -0
  571. data/lib/brevo/models/get_reports_reports.rb +370 -0
  572. data/lib/brevo/models/get_scheduled_email_by_batch_id.rb +196 -0
  573. data/lib/brevo/models/get_scheduled_email_by_batch_id_batches.rb +254 -0
  574. data/lib/brevo/models/get_scheduled_email_by_message_id.rb +254 -0
  575. data/lib/brevo/models/get_segments.rb +194 -0
  576. data/lib/brevo/models/get_segments_segments.rb +215 -0
  577. data/lib/brevo/models/get_senders_list.rb +187 -0
  578. data/lib/brevo/models/get_senders_list_ips.rb +220 -0
  579. data/lib/brevo/models/get_senders_list_senders.rb +247 -0
  580. data/lib/brevo/models/get_shared_template_url.rb +190 -0
  581. data/lib/brevo/models/get_sms_campaign.rb +352 -0
  582. data/lib/brevo/models/get_sms_campaign_overview.rb +324 -0
  583. data/lib/brevo/models/get_sms_campaign_recipients.rb +175 -0
  584. data/lib/brevo/models/get_sms_campaign_stats.rb +280 -0
  585. data/lib/brevo/models/get_sms_campaigns.rb +196 -0
  586. data/lib/brevo/models/get_sms_event_report.rb +186 -0
  587. data/lib/brevo/models/get_sms_event_report_events.rb +278 -0
  588. data/lib/brevo/models/get_smtp_template_overview.rb +364 -0
  589. data/lib/brevo/models/get_smtp_template_overview_sender.rb +205 -0
  590. data/lib/brevo/models/get_smtp_templates.rb +196 -0
  591. data/lib/brevo/models/get_sso_token.rb +190 -0
  592. data/lib/brevo/models/get_stats_by_browser.rb +175 -0
  593. data/lib/brevo/models/get_stats_by_device.rb +223 -0
  594. data/lib/brevo/models/get_stats_by_domain.rb +175 -0
  595. data/lib/brevo/models/get_transac_aggregated_sms_report.rb +275 -0
  596. data/lib/brevo/models/get_transac_blocked_contacts.rb +196 -0
  597. data/lib/brevo/models/get_transac_blocked_contacts_contacts.rb +234 -0
  598. data/lib/brevo/models/get_transac_blocked_contacts_reason.rb +230 -0
  599. data/lib/brevo/models/get_transac_email_content.rb +277 -0
  600. data/lib/brevo/models/get_transac_email_content_events.rb +205 -0
  601. data/lib/brevo/models/get_transac_emails_list.rb +196 -0
  602. data/lib/brevo/models/get_transac_emails_list_transactional_emails.rb +282 -0
  603. data/lib/brevo/models/get_transac_sms_report.rb +186 -0
  604. data/lib/brevo/models/get_transac_sms_report_reports.rb +275 -0
  605. data/lib/brevo/models/get_user_permission.rb +223 -0
  606. data/lib/brevo/models/get_user_permission_privileges.rb +205 -0
  607. data/lib/brevo/models/get_wa_templates.rb +206 -0
  608. data/lib/brevo/models/get_wa_templates_templates.rb +290 -0
  609. data/lib/brevo/models/get_webhook.rb +315 -0
  610. data/lib/brevo/models/get_webhooks.rb +191 -0
  611. data/lib/brevo/models/get_whats_app_config.rb +281 -0
  612. data/lib/brevo/models/get_whatsapp_campaign_overview.rb +332 -0
  613. data/lib/brevo/models/get_whatsapp_campaigns.rb +196 -0
  614. data/lib/brevo/models/get_whatsapp_campaigns_campaigns.rb +353 -0
  615. data/lib/brevo/models/get_whatsapp_event_report.rb +186 -0
  616. data/lib/brevo/models/get_whatsapp_event_report_events.rb +314 -0
  617. data/lib/brevo/models/inline_response_200.rb +191 -0
  618. data/lib/brevo/models/inline_response_200_1.rb +220 -0
  619. data/lib/brevo/models/inline_response_201.rb +191 -0
  620. data/lib/brevo/models/inline_response_201_1.rb +191 -0
  621. data/lib/brevo/models/inline_response_201_2.rb +190 -0
  622. data/lib/brevo/models/inline_response_201_3.rb +190 -0
  623. data/lib/brevo/models/inline_response_201_4.rb +190 -0
  624. data/lib/brevo/models/manage_ip.rb +185 -0
  625. data/lib/brevo/models/master_details_response.rb +243 -0
  626. data/lib/brevo/models/master_details_response_billing_info.rb +214 -0
  627. data/lib/brevo/models/master_details_response_billing_info_address.rb +226 -0
  628. data/lib/brevo/models/master_details_response_billing_info_name.rb +196 -0
  629. data/lib/brevo/models/master_details_response_plan_info.rb +272 -0
  630. data/lib/brevo/models/master_details_response_plan_info_features.rb +225 -0
  631. data/lib/brevo/models/note.rb +283 -0
  632. data/lib/brevo/models/note_data.rb +255 -0
  633. data/lib/brevo/models/note_id.rb +186 -0
  634. data/lib/brevo/models/note_list.rb +176 -0
  635. data/lib/brevo/models/order.rb +297 -0
  636. data/lib/brevo/models/order_batch.rb +202 -0
  637. data/lib/brevo/models/order_billing.rb +246 -0
  638. data/lib/brevo/models/order_products.rb +231 -0
  639. data/lib/brevo/models/otp.rb +185 -0
  640. data/lib/brevo/models/pipeline.rb +208 -0
  641. data/lib/brevo/models/pipeline_stage.rb +196 -0
  642. data/lib/brevo/models/pipelines.rb +176 -0
  643. data/lib/brevo/models/post_contact_info.rb +189 -0
  644. data/lib/brevo/models/post_contact_info_contacts.rb +217 -0
  645. data/lib/brevo/models/post_send_failed.rb +238 -0
  646. data/lib/brevo/models/post_send_sms_test_failed.rb +227 -0
  647. data/lib/brevo/models/remaining_credit_model.rb +203 -0
  648. data/lib/brevo/models/remaining_credit_model_child.rb +206 -0
  649. data/lib/brevo/models/remaining_credit_model_reseller.rb +205 -0
  650. data/lib/brevo/models/remove_contact_from_list.rb +209 -0
  651. data/lib/brevo/models/remove_credits.rb +195 -0
  652. data/lib/brevo/models/request_contact_export.rb +211 -0
  653. data/lib/brevo/models/request_contact_export_custom_contact_filter.rb +294 -0
  654. data/lib/brevo/models/request_contact_import.rb +286 -0
  655. data/lib/brevo/models/request_contact_import_json_body.rb +194 -0
  656. data/lib/brevo/models/request_contact_import_new_list.rb +196 -0
  657. data/lib/brevo/models/request_sms_recipient_export.rb +234 -0
  658. data/lib/brevo/models/schedule_smtp_email.rb +206 -0
  659. data/lib/brevo/models/send_report.rb +235 -0
  660. data/lib/brevo/models/send_report_email.rb +208 -0
  661. data/lib/brevo/models/send_sms.rb +233 -0
  662. data/lib/brevo/models/send_smtp_email.rb +345 -0
  663. data/lib/brevo/models/send_smtp_email_attachment.rb +220 -0
  664. data/lib/brevo/models/send_smtp_email_bcc.rb +200 -0
  665. data/lib/brevo/models/send_smtp_email_cc.rb +200 -0
  666. data/lib/brevo/models/send_smtp_email_message_versions.rb +247 -0
  667. data/lib/brevo/models/send_smtp_email_reply_to.rb +201 -0
  668. data/lib/brevo/models/send_smtp_email_reply_to_1.rb +201 -0
  669. data/lib/brevo/models/send_smtp_email_sender.rb +206 -0
  670. data/lib/brevo/models/send_smtp_email_to.rb +200 -0
  671. data/lib/brevo/models/send_smtp_email_to_1.rb +200 -0
  672. data/lib/brevo/models/send_test_email.rb +187 -0
  673. data/lib/brevo/models/send_test_sms.rb +185 -0
  674. data/lib/brevo/models/send_transac_sms.rb +327 -0
  675. data/lib/brevo/models/send_whatsapp_message.rb +227 -0
  676. data/lib/brevo/models/sso_token_request.rb +254 -0
  677. data/lib/brevo/models/sub_account_apps_toggle_request.rb +306 -0
  678. data/lib/brevo/models/sub_account_details_response.rb +214 -0
  679. data/lib/brevo/models/sub_account_details_response_plan_info.rb +204 -0
  680. data/lib/brevo/models/sub_account_details_response_plan_info_credits.rb +195 -0
  681. data/lib/brevo/models/sub_account_details_response_plan_info_credits_emails.rb +196 -0
  682. data/lib/brevo/models/sub_account_details_response_plan_info_features.rb +203 -0
  683. data/lib/brevo/models/sub_account_details_response_plan_info_features_inbox.rb +196 -0
  684. data/lib/brevo/models/sub_account_details_response_plan_info_features_landing_page.rb +196 -0
  685. data/lib/brevo/models/sub_account_details_response_plan_info_features_users.rb +196 -0
  686. data/lib/brevo/models/sub_account_update_plan_request.rb +194 -0
  687. data/lib/brevo/models/sub_account_update_plan_request_credits.rb +186 -0
  688. data/lib/brevo/models/sub_account_update_plan_request_features.rb +206 -0
  689. data/lib/brevo/models/sub_accounts_response.rb +196 -0
  690. data/lib/brevo/models/sub_accounts_response_sub_accounts.rb +235 -0
  691. data/lib/brevo/models/task.rb +252 -0
  692. data/lib/brevo/models/task_list.rb +188 -0
  693. data/lib/brevo/models/task_reminder.rb +257 -0
  694. data/lib/brevo/models/task_types.rb +196 -0
  695. data/lib/brevo/models/update_attribute.rb +197 -0
  696. data/lib/brevo/models/update_attribute_enumeration.rb +205 -0
  697. data/lib/brevo/models/update_batch_contacts.rb +187 -0
  698. data/lib/brevo/models/update_batch_contacts_contacts.rb +283 -0
  699. data/lib/brevo/models/update_batch_contacts_model.rb +197 -0
  700. data/lib/brevo/models/update_campaign_status.rb +220 -0
  701. data/lib/brevo/models/update_child.rb +225 -0
  702. data/lib/brevo/models/update_child_account_status.rb +215 -0
  703. data/lib/brevo/models/update_child_domain.rb +185 -0
  704. data/lib/brevo/models/update_contact.rb +251 -0
  705. data/lib/brevo/models/update_coupon_collection.rb +190 -0
  706. data/lib/brevo/models/update_email_campaign.rb +597 -0
  707. data/lib/brevo/models/update_email_campaign_recipients.rb +212 -0
  708. data/lib/brevo/models/update_email_campaign_sender.rb +206 -0
  709. data/lib/brevo/models/update_external_feed.rb +327 -0
  710. data/lib/brevo/models/update_list.rb +195 -0
  711. data/lib/brevo/models/update_sender.rb +207 -0
  712. data/lib/brevo/models/update_sms_campaign.rb +271 -0
  713. data/lib/brevo/models/update_smtp_template.rb +274 -0
  714. data/lib/brevo/models/update_smtp_template_sender.rb +206 -0
  715. data/lib/brevo/models/update_webhook.rb +239 -0
  716. data/lib/brevo/models/update_whats_app_campaign.rb +250 -0
  717. data/lib/brevo/models/upload_image_model.rb +190 -0
  718. data/lib/brevo/models/upload_image_to_gallery.rb +200 -0
  719. data/lib/brevo/models/variables_items.rb +202 -0
  720. data/lib/brevo/models/whatsapp_camp_stats.rb +245 -0
  721. data/lib/brevo/models/whatsapp_camp_template.rb +287 -0
  722. data/lib/brevo/version.rb +15 -0
  723. data/lib/brevo.rb +395 -0
  724. data/spec/api/account_api_spec.rb +59 -0
  725. data/spec/api/companies_api_spec.rb +119 -0
  726. data/spec/api/contacts_api_spec.rb +387 -0
  727. data/spec/api/conversations_api_spec.rb +140 -0
  728. data/spec/api/coupons_api_spec.rb +93 -0
  729. data/spec/api/deals_api_spec.rb +151 -0
  730. data/spec/api/domains_api_spec.rb +89 -0
  731. data/spec/api/ecommerce_api_spec.rb +173 -0
  732. data/spec/api/email_campaigns_api_spec.rb +196 -0
  733. data/spec/api/external_feeds_api_spec.rb +102 -0
  734. data/spec/api/files_api_spec.rb +99 -0
  735. data/spec/api/inbound_parsing_api_spec.rb +76 -0
  736. data/spec/api/master_account_api_spec.rb +158 -0
  737. data/spec/api/notes_api_spec.rb +97 -0
  738. data/spec/api/process_api_spec.rb +59 -0
  739. data/spec/api/reseller_api_spec.rb +223 -0
  740. data/spec/api/senders_api_spec.rb +114 -0
  741. data/spec/api/sms_campaigns_api_spec.rb +157 -0
  742. data/spec/api/tasks_api_spec.rb +113 -0
  743. data/spec/api/transactional_emails_api_spec.rb +330 -0
  744. data/spec/api/transactional_sms_api_spec.rb +94 -0
  745. data/spec/api/transactional_whats_app_api_spec.rb +66 -0
  746. data/spec/api/user_api_spec.rb +56 -0
  747. data/spec/api/webhooks_api_spec.rb +104 -0
  748. data/spec/api/whats_app_campaigns_api_spec.rb +142 -0
  749. data/spec/api_client_spec.rb +243 -0
  750. data/spec/configuration_spec.rb +42 -0
  751. data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
  752. data/spec/models/ab_test_campaign_result_spec.rb +91 -0
  753. data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
  754. data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
  755. data/spec/models/ab_test_version_clicks_spec.rb +35 -0
  756. data/spec/models/ab_test_version_stats_spec.rb +47 -0
  757. data/spec/models/add_child_domain_spec.rb +41 -0
  758. data/spec/models/add_contact_to_list_spec.rb +47 -0
  759. data/spec/models/add_credits_spec.rb +47 -0
  760. data/spec/models/authenticate_domain_model_spec.rb +47 -0
  761. data/spec/models/block_domain_spec.rb +41 -0
  762. data/spec/models/body_10_spec.rb +59 -0
  763. data/spec/models/body_11_spec.rb +41 -0
  764. data/spec/models/body_12_spec.rb +59 -0
  765. data/spec/models/body_1_spec.rb +53 -0
  766. data/spec/models/body_2_spec.rb +59 -0
  767. data/spec/models/body_3_spec.rb +47 -0
  768. data/spec/models/body_4_spec.rb +47 -0
  769. data/spec/models/body_5_spec.rb +59 -0
  770. data/spec/models/body_6_spec.rb +101 -0
  771. data/spec/models/body_7_spec.rb +95 -0
  772. data/spec/models/body_8_spec.rb +71 -0
  773. data/spec/models/body_9_spec.rb +41 -0
  774. data/spec/models/body_spec.rb +53 -0
  775. data/spec/models/body_variables_items_spec.rb +35 -0
  776. data/spec/models/companies_list_spec.rb +41 -0
  777. data/spec/models/company_attributes_inner_spec.rb +65 -0
  778. data/spec/models/company_attributes_spec.rb +35 -0
  779. data/spec/models/company_spec.rb +59 -0
  780. data/spec/models/component_items_spec.rb +47 -0
  781. data/spec/models/conversations_message_file_image_info_spec.rb +53 -0
  782. data/spec/models/conversations_message_file_spec.rb +65 -0
  783. data/spec/models/conversations_message_spec.rb +99 -0
  784. data/spec/models/create_api_key_request_spec.rb +47 -0
  785. data/spec/models/create_api_key_response_spec.rb +47 -0
  786. data/spec/models/create_attribute_enumeration_spec.rb +47 -0
  787. data/spec/models/create_attribute_spec.rb +63 -0
  788. data/spec/models/create_category_model_spec.rb +41 -0
  789. data/spec/models/create_child_spec.rb +75 -0
  790. data/spec/models/create_contact_spec.rb +83 -0
  791. data/spec/models/create_coupon_collection_spec.rb +47 -0
  792. data/spec/models/create_coupons_spec.rb +47 -0
  793. data/spec/models/create_doi_contact_spec.rb +71 -0
  794. data/spec/models/create_domain_model_dns_records_dkim_record_spec.rb +59 -0
  795. data/spec/models/create_domain_model_dns_records_spec.rb +47 -0
  796. data/spec/models/create_domain_model_spec.rb +59 -0
  797. data/spec/models/create_domain_spec.rb +41 -0
  798. data/spec/models/create_email_campaign_recipients_spec.rb +53 -0
  799. data/spec/models/create_email_campaign_sender_spec.rb +53 -0
  800. data/spec/models/create_email_campaign_spec.rb +225 -0
  801. data/spec/models/create_external_feed_spec.rb +93 -0
  802. data/spec/models/create_list_spec.rb +47 -0
  803. data/spec/models/create_model_spec.rb +41 -0
  804. data/spec/models/create_product_model_spec.rb +41 -0
  805. data/spec/models/create_reseller_spec.rb +47 -0
  806. data/spec/models/create_sender_ips_spec.rb +53 -0
  807. data/spec/models/create_sender_model_spec.rb +53 -0
  808. data/spec/models/create_sender_spec.rb +53 -0
  809. data/spec/models/create_sms_campaign_recipients_spec.rb +47 -0
  810. data/spec/models/create_sms_campaign_spec.rb +83 -0
  811. data/spec/models/create_smtp_email_spec.rb +47 -0
  812. data/spec/models/create_smtp_template_sender_spec.rb +53 -0
  813. data/spec/models/create_smtp_template_spec.rb +95 -0
  814. data/spec/models/create_sub_account_response_spec.rb +41 -0
  815. data/spec/models/create_sub_account_spec.rb +63 -0
  816. data/spec/models/create_update_batch_category_model_spec.rb +47 -0
  817. data/spec/models/create_update_batch_category_spec.rb +47 -0
  818. data/spec/models/create_update_batch_products_model_spec.rb +47 -0
  819. data/spec/models/create_update_batch_products_spec.rb +47 -0
  820. data/spec/models/create_update_categories_spec.rb +59 -0
  821. data/spec/models/create_update_category_spec.rb +65 -0
  822. data/spec/models/create_update_contact_model_spec.rb +41 -0
  823. data/spec/models/create_update_folder_spec.rb +41 -0
  824. data/spec/models/create_update_product_spec.rb +101 -0
  825. data/spec/models/create_update_products_spec.rb +95 -0
  826. data/spec/models/create_webhook_spec.rb +73 -0
  827. data/spec/models/create_whats_app_campaign_recipients_spec.rb +53 -0
  828. data/spec/models/create_whats_app_campaign_spec.rb +59 -0
  829. data/spec/models/create_whats_app_template_spec.rb +75 -0
  830. data/spec/models/created_batch_id_spec.rb +41 -0
  831. data/spec/models/created_process_id_spec.rb +41 -0
  832. data/spec/models/deal_attributes_inner_spec.rb +65 -0
  833. data/spec/models/deal_attributes_spec.rb +35 -0
  834. data/spec/models/deal_spec.rb +59 -0
  835. data/spec/models/deals_list_spec.rb +41 -0
  836. data/spec/models/delete_hardbounces_spec.rb +53 -0
  837. data/spec/models/email_export_recipients_spec.rb +51 -0
  838. data/spec/models/error_model_spec.rb +51 -0
  839. data/spec/models/export_webhooks_history_spec.rb +93 -0
  840. data/spec/models/file_data_spec.rb +77 -0
  841. data/spec/models/file_downloadable_link_spec.rb +41 -0
  842. data/spec/models/file_list_spec.rb +35 -0
  843. data/spec/models/get_account_activity_logs_spec.rb +65 -0
  844. data/spec/models/get_account_activity_spec.rb +41 -0
  845. data/spec/models/get_account_marketing_automation_spec.rb +47 -0
  846. data/spec/models/get_account_plan_spec.rb +79 -0
  847. data/spec/models/get_account_relay_data_spec.rb +53 -0
  848. data/spec/models/get_account_relay_spec.rb +47 -0
  849. data/spec/models/get_account_spec.rb +83 -0
  850. data/spec/models/get_aggregated_report_spec.rb +113 -0
  851. data/spec/models/get_all_external_feeds_feeds_spec.rb +111 -0
  852. data/spec/models/get_all_external_feeds_spec.rb +47 -0
  853. data/spec/models/get_attributes_attributes_spec.rb +73 -0
  854. data/spec/models/get_attributes_enumeration_spec.rb +47 -0
  855. data/spec/models/get_attributes_spec.rb +41 -0
  856. data/spec/models/get_blocked_domains_spec.rb +41 -0
  857. data/spec/models/get_campaign_overview_spec.rb +127 -0
  858. data/spec/models/get_campaign_recipients_spec.rb +47 -0
  859. data/spec/models/get_campaign_stats_spec.rb +131 -0
  860. data/spec/models/get_categories_spec.rb +47 -0
  861. data/spec/models/get_category_details_spec.rb +71 -0
  862. data/spec/models/get_child_account_creation_status_spec.rb +41 -0
  863. data/spec/models/get_child_domain_spec.rb +47 -0
  864. data/spec/models/get_child_domains_spec.rb +35 -0
  865. data/spec/models/get_child_info_api_keys_spec.rb +47 -0
  866. data/spec/models/get_child_info_api_keys_v2_spec.rb +47 -0
  867. data/spec/models/get_child_info_api_keys_v3_spec.rb +47 -0
  868. data/spec/models/get_child_info_credits_spec.rb +47 -0
  869. data/spec/models/get_child_info_spec.rb +89 -0
  870. data/spec/models/get_child_info_statistics_spec.rb +53 -0
  871. data/spec/models/get_children_list_spec.rb +47 -0
  872. data/spec/models/get_client_spec.rb +59 -0
  873. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +47 -0
  874. data/spec/models/get_contact_campaign_stats_opened_spec.rb +59 -0
  875. data/spec/models/get_contact_campaign_stats_spec.rb +89 -0
  876. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +53 -0
  877. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +47 -0
  878. data/spec/models/get_contact_details_spec.rb +89 -0
  879. data/spec/models/get_contacts_spec.rb +47 -0
  880. data/spec/models/get_coupon_collection_spec.rb +71 -0
  881. data/spec/models/get_device_browser_stats_spec.rb +59 -0
  882. data/spec/models/get_domain_configuration_model_spec.rb +59 -0
  883. data/spec/models/get_domains_list_domains_spec.rb +65 -0
  884. data/spec/models/get_domains_list_spec.rb +41 -0
  885. data/spec/models/get_email_campaign_spec.rb +235 -0
  886. data/spec/models/get_email_campaigns_spec.rb +47 -0
  887. data/spec/models/get_email_event_report_events_spec.rb +105 -0
  888. data/spec/models/get_email_event_report_spec.rb +41 -0
  889. data/spec/models/get_extended_campaign_overview_sender_spec.rb +53 -0
  890. data/spec/models/get_extended_campaign_overview_spec.rb +223 -0
  891. data/spec/models/get_extended_campaign_stats_global_stats_spec.rb +35 -0
  892. data/spec/models/get_extended_campaign_stats_spec.rb +83 -0
  893. data/spec/models/get_extended_client_address_spec.rb +59 -0
  894. data/spec/models/get_extended_client_spec.rb +65 -0
  895. data/spec/models/get_extended_contact_details_spec.rb +95 -0
  896. data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +47 -0
  897. data/spec/models/get_extended_contact_details_statistics_delivered_spec.rb +47 -0
  898. data/spec/models/get_extended_contact_details_statistics_links_spec.rb +59 -0
  899. data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +47 -0
  900. data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +59 -0
  901. data/spec/models/get_extended_contact_details_statistics_spec.rb +89 -0
  902. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +47 -0
  903. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +47 -0
  904. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +53 -0
  905. data/spec/models/get_extended_list_campaign_stats_spec.rb +47 -0
  906. data/spec/models/get_extended_list_spec.rb +89 -0
  907. data/spec/models/get_external_feed_by_uuid_headers_spec.rb +47 -0
  908. data/spec/models/get_external_feed_by_uuid_spec.rb +111 -0
  909. data/spec/models/get_folder_lists_spec.rb +47 -0
  910. data/spec/models/get_folder_spec.rb +65 -0
  911. data/spec/models/get_folders_spec.rb +47 -0
  912. data/spec/models/get_inbound_email_events_by_uuid_attachments_spec.rb +59 -0
  913. data/spec/models/get_inbound_email_events_by_uuid_logs_spec.rb +51 -0
  914. data/spec/models/get_inbound_email_events_by_uuid_spec.rb +83 -0
  915. data/spec/models/get_inbound_email_events_events_spec.rb +59 -0
  916. data/spec/models/get_inbound_email_events_spec.rb +41 -0
  917. data/spec/models/get_invited_users_list_feature_access_spec.rb +53 -0
  918. data/spec/models/get_invited_users_list_spec.rb +41 -0
  919. data/spec/models/get_invited_users_list_users_spec.rb +59 -0
  920. data/spec/models/get_ip_from_sender_spec.rb +59 -0
  921. data/spec/models/get_ip_spec.rb +59 -0
  922. data/spec/models/get_ips_from_sender_spec.rb +41 -0
  923. data/spec/models/get_ips_spec.rb +41 -0
  924. data/spec/models/get_list_spec.rb +65 -0
  925. data/spec/models/get_lists_spec.rb +47 -0
  926. data/spec/models/get_process_spec.rb +63 -0
  927. data/spec/models/get_processes_spec.rb +47 -0
  928. data/spec/models/get_product_details_spec.rb +125 -0
  929. data/spec/models/get_products_spec.rb +47 -0
  930. data/spec/models/get_reports_reports_spec.rb +113 -0
  931. data/spec/models/get_reports_spec.rb +41 -0
  932. data/spec/models/get_scheduled_email_by_batch_id_batches_spec.rb +57 -0
  933. data/spec/models/get_scheduled_email_by_batch_id_spec.rb +47 -0
  934. data/spec/models/get_scheduled_email_by_message_id_spec.rb +57 -0
  935. data/spec/models/get_segments_segments_spec.rb +59 -0
  936. data/spec/models/get_segments_spec.rb +47 -0
  937. data/spec/models/get_senders_list_ips_spec.rb +53 -0
  938. data/spec/models/get_senders_list_senders_spec.rb +65 -0
  939. data/spec/models/get_senders_list_spec.rb +41 -0
  940. data/spec/models/get_shared_template_url_spec.rb +41 -0
  941. data/spec/models/get_sms_campaign_overview_spec.rb +87 -0
  942. data/spec/models/get_sms_campaign_recipients_spec.rb +35 -0
  943. data/spec/models/get_sms_campaign_spec.rb +99 -0
  944. data/spec/models/get_sms_campaign_stats_spec.rb +77 -0
  945. data/spec/models/get_sms_campaigns_spec.rb +47 -0
  946. data/spec/models/get_sms_event_report_events_spec.rb +81 -0
  947. data/spec/models/get_sms_event_report_spec.rb +41 -0
  948. data/spec/models/get_smtp_template_overview_sender_spec.rb +53 -0
  949. data/spec/models/get_smtp_template_overview_spec.rb +113 -0
  950. data/spec/models/get_smtp_templates_spec.rb +47 -0
  951. data/spec/models/get_sso_token_spec.rb +41 -0
  952. data/spec/models/get_stats_by_browser_spec.rb +35 -0
  953. data/spec/models/get_stats_by_device_spec.rb +59 -0
  954. data/spec/models/get_stats_by_domain_spec.rb +35 -0
  955. data/spec/models/get_transac_aggregated_sms_report_spec.rb +95 -0
  956. data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
  957. data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
  958. data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
  959. data/spec/models/get_transac_email_content_events_spec.rb +47 -0
  960. data/spec/models/get_transac_email_content_spec.rb +77 -0
  961. data/spec/models/get_transac_emails_list_spec.rb +47 -0
  962. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +83 -0
  963. data/spec/models/get_transac_sms_report_reports_spec.rb +95 -0
  964. data/spec/models/get_transac_sms_report_spec.rb +41 -0
  965. data/spec/models/get_user_permission_privileges_spec.rb +47 -0
  966. data/spec/models/get_user_permission_spec.rb +53 -0
  967. data/spec/models/get_wa_templates_spec.rb +47 -0
  968. data/spec/models/get_wa_templates_templates_spec.rb +83 -0
  969. data/spec/models/get_webhook_spec.rb +81 -0
  970. data/spec/models/get_webhooks_spec.rb +41 -0
  971. data/spec/models/get_whats_app_config_spec.rb +79 -0
  972. data/spec/models/get_whatsapp_campaign_overview_spec.rb +93 -0
  973. data/spec/models/get_whatsapp_campaigns_campaigns_spec.rb +105 -0
  974. data/spec/models/get_whatsapp_campaigns_spec.rb +47 -0
  975. data/spec/models/get_whatsapp_event_report_events_spec.rb +87 -0
  976. data/spec/models/get_whatsapp_event_report_spec.rb +41 -0
  977. data/spec/models/inline_response_200_1_spec.rb +53 -0
  978. data/spec/models/inline_response_200_spec.rb +41 -0
  979. data/spec/models/inline_response_201_1_spec.rb +41 -0
  980. data/spec/models/inline_response_201_2_spec.rb +41 -0
  981. data/spec/models/inline_response_201_3_spec.rb +41 -0
  982. data/spec/models/inline_response_201_4_spec.rb +41 -0
  983. data/spec/models/inline_response_201_spec.rb +41 -0
  984. data/spec/models/manage_ip_spec.rb +41 -0
  985. data/spec/models/master_details_response_billing_info_address_spec.rb +65 -0
  986. data/spec/models/master_details_response_billing_info_name_spec.rb +47 -0
  987. data/spec/models/master_details_response_billing_info_spec.rb +59 -0
  988. data/spec/models/master_details_response_plan_info_features_spec.rb +65 -0
  989. data/spec/models/master_details_response_plan_info_spec.rb +75 -0
  990. data/spec/models/master_details_response_spec.rb +77 -0
  991. data/spec/models/note_data_spec.rb +59 -0
  992. data/spec/models/note_id_spec.rb +41 -0
  993. data/spec/models/note_list_spec.rb +35 -0
  994. data/spec/models/note_spec.rb +77 -0
  995. data/spec/models/order_batch_spec.rb +47 -0
  996. data/spec/models/order_billing_spec.rb +77 -0
  997. data/spec/models/order_products_spec.rb +59 -0
  998. data/spec/models/order_spec.rb +89 -0
  999. data/spec/models/otp_spec.rb +41 -0
  1000. data/spec/models/pipeline_spec.rb +53 -0
  1001. data/spec/models/pipeline_stage_spec.rb +47 -0
  1002. data/spec/models/pipelines_spec.rb +35 -0
  1003. data/spec/models/post_contact_info_contacts_spec.rb +59 -0
  1004. data/spec/models/post_contact_info_spec.rb +41 -0
  1005. data/spec/models/post_send_failed_spec.rb +65 -0
  1006. data/spec/models/post_send_sms_test_failed_spec.rb +59 -0
  1007. data/spec/models/remaining_credit_model_child_spec.rb +47 -0
  1008. data/spec/models/remaining_credit_model_reseller_spec.rb +47 -0
  1009. data/spec/models/remaining_credit_model_spec.rb +47 -0
  1010. data/spec/models/remove_contact_from_list_spec.rb +53 -0
  1011. data/spec/models/remove_credits_spec.rb +47 -0
  1012. data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
  1013. data/spec/models/request_contact_export_spec.rb +53 -0
  1014. data/spec/models/request_contact_import_json_body_spec.rb +47 -0
  1015. data/spec/models/request_contact_import_new_list_spec.rb +47 -0
  1016. data/spec/models/request_contact_import_spec.rb +95 -0
  1017. data/spec/models/request_sms_recipient_export_spec.rb +51 -0
  1018. data/spec/models/schedule_smtp_email_spec.rb +53 -0
  1019. data/spec/models/send_report_email_spec.rb +47 -0
  1020. data/spec/models/send_report_spec.rb +51 -0
  1021. data/spec/models/send_sms_spec.rb +65 -0
  1022. data/spec/models/send_smtp_email_attachment_spec.rb +53 -0
  1023. data/spec/models/send_smtp_email_bcc_spec.rb +47 -0
  1024. data/spec/models/send_smtp_email_cc_spec.rb +47 -0
  1025. data/spec/models/send_smtp_email_message_versions_spec.rb +71 -0
  1026. data/spec/models/send_smtp_email_reply_to_1_spec.rb +47 -0
  1027. data/spec/models/send_smtp_email_reply_to_spec.rb +47 -0
  1028. data/spec/models/send_smtp_email_sender_spec.rb +53 -0
  1029. data/spec/models/send_smtp_email_spec.rb +131 -0
  1030. data/spec/models/send_smtp_email_to_1_spec.rb +47 -0
  1031. data/spec/models/send_smtp_email_to_spec.rb +47 -0
  1032. data/spec/models/send_test_email_spec.rb +41 -0
  1033. data/spec/models/send_test_sms_spec.rb +41 -0
  1034. data/spec/models/send_transac_sms_spec.rb +87 -0
  1035. data/spec/models/send_whatsapp_message_spec.rb +59 -0
  1036. data/spec/models/sso_token_request_spec.rb +63 -0
  1037. data/spec/models/sub_account_apps_toggle_request_spec.rb +113 -0
  1038. data/spec/models/sub_account_details_response_plan_info_credits_emails_spec.rb +47 -0
  1039. data/spec/models/sub_account_details_response_plan_info_credits_spec.rb +47 -0
  1040. data/spec/models/sub_account_details_response_plan_info_features_inbox_spec.rb +47 -0
  1041. data/spec/models/sub_account_details_response_plan_info_features_landing_page_spec.rb +47 -0
  1042. data/spec/models/sub_account_details_response_plan_info_features_spec.rb +53 -0
  1043. data/spec/models/sub_account_details_response_plan_info_features_users_spec.rb +47 -0
  1044. data/spec/models/sub_account_details_response_plan_info_spec.rb +53 -0
  1045. data/spec/models/sub_account_details_response_spec.rb +59 -0
  1046. data/spec/models/sub_account_update_plan_request_credits_spec.rb +41 -0
  1047. data/spec/models/sub_account_update_plan_request_features_spec.rb +53 -0
  1048. data/spec/models/sub_account_update_plan_request_spec.rb +47 -0
  1049. data/spec/models/sub_accounts_response_spec.rb +47 -0
  1050. data/spec/models/sub_accounts_response_sub_accounts_spec.rb +59 -0
  1051. data/spec/models/task_list_spec.rb +41 -0
  1052. data/spec/models/task_reminder_spec.rb +57 -0
  1053. data/spec/models/task_spec.rb +71 -0
  1054. data/spec/models/task_types_spec.rb +47 -0
  1055. data/spec/models/update_attribute_enumeration_spec.rb +47 -0
  1056. data/spec/models/update_attribute_spec.rb +47 -0
  1057. data/spec/models/update_batch_contacts_contacts_spec.rb +95 -0
  1058. data/spec/models/update_batch_contacts_model_spec.rb +47 -0
  1059. data/spec/models/update_batch_contacts_spec.rb +41 -0
  1060. data/spec/models/update_campaign_status_spec.rb +45 -0
  1061. data/spec/models/update_child_account_status_spec.rb +59 -0
  1062. data/spec/models/update_child_domain_spec.rb +41 -0
  1063. data/spec/models/update_child_spec.rb +65 -0
  1064. data/spec/models/update_contact_spec.rb +77 -0
  1065. data/spec/models/update_coupon_collection_spec.rb +41 -0
  1066. data/spec/models/update_email_campaign_recipients_spec.rb +53 -0
  1067. data/spec/models/update_email_campaign_sender_spec.rb +53 -0
  1068. data/spec/models/update_email_campaign_spec.rb +225 -0
  1069. data/spec/models/update_external_feed_spec.rb +93 -0
  1070. data/spec/models/update_list_spec.rb +47 -0
  1071. data/spec/models/update_sender_spec.rb +53 -0
  1072. data/spec/models/update_sms_campaign_spec.rb +83 -0
  1073. data/spec/models/update_smtp_template_sender_spec.rb +53 -0
  1074. data/spec/models/update_smtp_template_spec.rb +95 -0
  1075. data/spec/models/update_webhook_spec.rb +63 -0
  1076. data/spec/models/update_whats_app_campaign_spec.rb +63 -0
  1077. data/spec/models/upload_image_model_spec.rb +41 -0
  1078. data/spec/models/upload_image_to_gallery_spec.rb +47 -0
  1079. data/spec/models/variables_items_spec.rb +53 -0
  1080. data/spec/models/whatsapp_camp_stats_spec.rb +65 -0
  1081. data/spec/models/whatsapp_camp_template_spec.rb +101 -0
  1082. data/spec/spec_helper.rb +111 -0
  1083. metadata +1683 -0
@@ -0,0 +1,1370 @@
1
+ =begin
2
+ #Brevo API
3
+
4
+ #Brevo 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/brevo **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@brevo.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.19
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module Brevo
16
+ class TransactionalEmailsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+
23
+ # Set custom user_agent if explicitly passed in api
24
+ # default will still remain Swagger-Codegen/#{VERSION}/ruby
25
+ def setUserAgent(user_agent)
26
+ @user_agent = user_agent
27
+ if user_agent.is_a?(String) && user_agent.downcase.start_with?('brevo_')
28
+ @api_client.default_headers['User-Agent'] = @user_agent
29
+ end
30
+ end
31
+
32
+ # Add a new domain to the list of blocked domains
33
+ # Blocks a new domain in order to avoid messages being sent to the same
34
+ # @param block_domain
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [nil]
37
+ def block_new_domain(block_domain, opts = {})
38
+ block_new_domain_with_http_info(block_domain, opts)
39
+ nil
40
+ end
41
+
42
+ # Add a new domain to the list of blocked domains
43
+ # Blocks a new domain in order to avoid messages being sent to the same
44
+ # @param block_domain
45
+ # @param [Hash] opts the optional parameters
46
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
47
+ def block_new_domain_with_http_info(block_domain, opts = {})
48
+ if @api_client.config.debugging
49
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.block_new_domain ...'
50
+ end
51
+ # verify the required parameter 'block_domain' is set
52
+ if @api_client.config.client_side_validation && block_domain.nil?
53
+ fail ArgumentError, "Missing the required parameter 'block_domain' when calling TransactionalEmailsApi.block_new_domain"
54
+ end
55
+ # resource path
56
+ local_var_path = '/smtp/blockedDomains'
57
+
58
+ # query parameters
59
+ query_params = {}
60
+
61
+ # header parameters
62
+ header_params = {}
63
+ # HTTP header 'Accept' (if needed)
64
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
65
+ # HTTP header 'Content-Type'
66
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
67
+
68
+ # form parameters
69
+ form_params = {}
70
+
71
+ # http body (model)
72
+ post_body = @api_client.object_to_http_body(block_domain)
73
+ auth_names = ['api-key', 'partner-key']
74
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names)
80
+ if @api_client.config.debugging
81
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#block_new_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
82
+ end
83
+ return data, status_code, headers
84
+ end
85
+ # Create an email template
86
+ # @param smtp_template values to update in transactional email template
87
+ # @param [Hash] opts the optional parameters
88
+ # @return [CreateModel]
89
+ def create_smtp_template(smtp_template, opts = {})
90
+ data, _status_code, _headers = create_smtp_template_with_http_info(smtp_template, opts)
91
+ data
92
+ end
93
+
94
+ # Create an email template
95
+ # @param smtp_template values to update in transactional email template
96
+ # @param [Hash] opts the optional parameters
97
+ # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers
98
+ def create_smtp_template_with_http_info(smtp_template, opts = {})
99
+ if @api_client.config.debugging
100
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.create_smtp_template ...'
101
+ end
102
+ # verify the required parameter 'smtp_template' is set
103
+ if @api_client.config.client_side_validation && smtp_template.nil?
104
+ fail ArgumentError, "Missing the required parameter 'smtp_template' when calling TransactionalEmailsApi.create_smtp_template"
105
+ end
106
+ # resource path
107
+ local_var_path = '/smtp/templates'
108
+
109
+ # query parameters
110
+ query_params = {}
111
+
112
+ # header parameters
113
+ header_params = {}
114
+ # HTTP header 'Accept' (if needed)
115
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
116
+ # HTTP header 'Content-Type'
117
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
118
+
119
+ # form parameters
120
+ form_params = {}
121
+
122
+ # http body (model)
123
+ post_body = @api_client.object_to_http_body(smtp_template)
124
+ auth_names = ['api-key', 'partner-key']
125
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
126
+ :header_params => header_params,
127
+ :query_params => query_params,
128
+ :form_params => form_params,
129
+ :body => post_body,
130
+ :auth_names => auth_names,
131
+ :return_type => 'CreateModel')
132
+ if @api_client.config.debugging
133
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#create_smtp_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
134
+ end
135
+ return data, status_code, headers
136
+ end
137
+ # Unblock an existing domain from the list of blocked domains
138
+ # Unblocks an existing domain from the list of blocked domains
139
+ # @param domain The name of the domain to be deleted
140
+ # @param [Hash] opts the optional parameters
141
+ # @return [nil]
142
+ def delete_blocked_domain(domain, opts = {})
143
+ delete_blocked_domain_with_http_info(domain, opts)
144
+ nil
145
+ end
146
+
147
+ # Unblock an existing domain from the list of blocked domains
148
+ # Unblocks an existing domain from the list of blocked domains
149
+ # @param domain The name of the domain to be deleted
150
+ # @param [Hash] opts the optional parameters
151
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
152
+ def delete_blocked_domain_with_http_info(domain, opts = {})
153
+ if @api_client.config.debugging
154
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.delete_blocked_domain ...'
155
+ end
156
+ # verify the required parameter 'domain' is set
157
+ if @api_client.config.client_side_validation && domain.nil?
158
+ fail ArgumentError, "Missing the required parameter 'domain' when calling TransactionalEmailsApi.delete_blocked_domain"
159
+ end
160
+ # resource path
161
+ local_var_path = '/smtp/blockedDomains/{domain}'.sub('{' + 'domain' + '}', domain.to_s)
162
+
163
+ # query parameters
164
+ query_params = {}
165
+
166
+ # header parameters
167
+ header_params = {}
168
+ # HTTP header 'Accept' (if needed)
169
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
170
+ # HTTP header 'Content-Type'
171
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
172
+
173
+ # form parameters
174
+ form_params = {}
175
+
176
+ # http body (model)
177
+ post_body = nil
178
+ auth_names = ['api-key', 'partner-key']
179
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
180
+ :header_params => header_params,
181
+ :query_params => query_params,
182
+ :form_params => form_params,
183
+ :body => post_body,
184
+ :auth_names => auth_names)
185
+ if @api_client.config.debugging
186
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#delete_blocked_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
187
+ end
188
+ return data, status_code, headers
189
+ end
190
+ # Delete hardbounces
191
+ # Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
192
+ # @param [Hash] opts the optional parameters
193
+ # @option opts [DeleteHardbounces] :delete_hardbounces values to delete hardbounces
194
+ # @return [nil]
195
+ def delete_hardbounces(opts = {})
196
+ delete_hardbounces_with_http_info(opts)
197
+ nil
198
+ end
199
+
200
+ # Delete hardbounces
201
+ # Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
202
+ # @param [Hash] opts the optional parameters
203
+ # @option opts [DeleteHardbounces] :delete_hardbounces values to delete hardbounces
204
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
205
+ def delete_hardbounces_with_http_info(opts = {})
206
+ if @api_client.config.debugging
207
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.delete_hardbounces ...'
208
+ end
209
+ # resource path
210
+ local_var_path = '/smtp/deleteHardbounces'
211
+
212
+ # query parameters
213
+ query_params = {}
214
+
215
+ # header parameters
216
+ header_params = {}
217
+ # HTTP header 'Accept' (if needed)
218
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
219
+ # HTTP header 'Content-Type'
220
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
221
+
222
+ # form parameters
223
+ form_params = {}
224
+
225
+ # http body (model)
226
+ post_body = @api_client.object_to_http_body(opts[:'delete_hardbounces'])
227
+ auth_names = ['api-key', 'partner-key']
228
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
229
+ :header_params => header_params,
230
+ :query_params => query_params,
231
+ :form_params => form_params,
232
+ :body => post_body,
233
+ :auth_names => auth_names)
234
+ if @api_client.config.debugging
235
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#delete_hardbounces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
236
+ end
237
+ return data, status_code, headers
238
+ end
239
+ # Delete scheduled emails by batchId or messageId
240
+ # Delete scheduled batch of emails by batchId or single scheduled email by messageId
241
+ # @param identifier The &#x60;batchId&#x60; of scheduled emails batch (Should be a valid UUIDv4) or the &#x60;messageId&#x60; of scheduled email.
242
+ # @param [Hash] opts the optional parameters
243
+ # @return [nil]
244
+ def delete_scheduled_email_by_id(identifier, opts = {})
245
+ delete_scheduled_email_by_id_with_http_info(identifier, opts)
246
+ nil
247
+ end
248
+
249
+ # Delete scheduled emails by batchId or messageId
250
+ # Delete scheduled batch of emails by batchId or single scheduled email by messageId
251
+ # @param identifier The &#x60;batchId&#x60; of scheduled emails batch (Should be a valid UUIDv4) or the &#x60;messageId&#x60; of scheduled email.
252
+ # @param [Hash] opts the optional parameters
253
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
254
+ def delete_scheduled_email_by_id_with_http_info(identifier, opts = {})
255
+ if @api_client.config.debugging
256
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.delete_scheduled_email_by_id ...'
257
+ end
258
+ # verify the required parameter 'identifier' is set
259
+ if @api_client.config.client_side_validation && identifier.nil?
260
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling TransactionalEmailsApi.delete_scheduled_email_by_id"
261
+ end
262
+ # resource path
263
+ local_var_path = '/smtp/email/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)
264
+
265
+ # query parameters
266
+ query_params = {}
267
+
268
+ # header parameters
269
+ header_params = {}
270
+ # HTTP header 'Accept' (if needed)
271
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
272
+ # HTTP header 'Content-Type'
273
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
274
+
275
+ # form parameters
276
+ form_params = {}
277
+
278
+ # http body (model)
279
+ post_body = nil
280
+ auth_names = ['api-key', 'partner-key']
281
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
282
+ :header_params => header_params,
283
+ :query_params => query_params,
284
+ :form_params => form_params,
285
+ :body => post_body,
286
+ :auth_names => auth_names)
287
+ if @api_client.config.debugging
288
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#delete_scheduled_email_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
289
+ end
290
+ return data, status_code, headers
291
+ end
292
+ # Delete an inactive email template
293
+ # @param template_id id of the template
294
+ # @param [Hash] opts the optional parameters
295
+ # @return [nil]
296
+ def delete_smtp_template(template_id, opts = {})
297
+ delete_smtp_template_with_http_info(template_id, opts)
298
+ nil
299
+ end
300
+
301
+ # Delete an inactive email template
302
+ # @param template_id id of the template
303
+ # @param [Hash] opts the optional parameters
304
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
305
+ def delete_smtp_template_with_http_info(template_id, opts = {})
306
+ if @api_client.config.debugging
307
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.delete_smtp_template ...'
308
+ end
309
+ # verify the required parameter 'template_id' is set
310
+ if @api_client.config.client_side_validation && template_id.nil?
311
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling TransactionalEmailsApi.delete_smtp_template"
312
+ end
313
+ # resource path
314
+ local_var_path = '/smtp/templates/{templateId}'.sub('{' + 'templateId' + '}', template_id.to_s)
315
+
316
+ # query parameters
317
+ query_params = {}
318
+
319
+ # header parameters
320
+ header_params = {}
321
+ # HTTP header 'Accept' (if needed)
322
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
323
+ # HTTP header 'Content-Type'
324
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
325
+
326
+ # form parameters
327
+ form_params = {}
328
+
329
+ # http body (model)
330
+ post_body = nil
331
+ auth_names = ['api-key', 'partner-key']
332
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
333
+ :header_params => header_params,
334
+ :query_params => query_params,
335
+ :form_params => form_params,
336
+ :body => post_body,
337
+ :auth_names => auth_names)
338
+ if @api_client.config.debugging
339
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#delete_smtp_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
340
+ end
341
+ return data, status_code, headers
342
+ end
343
+ # Get your transactional email activity aggregated over a period of time
344
+ # This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
345
+ # @param [Hash] opts the optional parameters
346
+ # @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
347
+ # @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
348
+ # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
349
+ # @option opts [String] :tag Tag of the emails
350
+ # @return [GetAggregatedReport]
351
+ def get_aggregated_smtp_report(opts = {})
352
+ data, _status_code, _headers = get_aggregated_smtp_report_with_http_info(opts)
353
+ data
354
+ end
355
+
356
+ # Get your transactional email activity aggregated over a period of time
357
+ # This endpoint will show the aggregated stats for past 90 days by default if &#x60;startDate&#x60; and &#x60;endDate&#x60; OR &#x60;days&#x60; is not passed. The date range can not exceed 90 days
358
+ # @param [Hash] opts the optional parameters
359
+ # @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
360
+ # @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
361
+ # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
362
+ # @option opts [String] :tag Tag of the emails
363
+ # @return [Array<(GetAggregatedReport, Fixnum, Hash)>] GetAggregatedReport data, response status code and response headers
364
+ def get_aggregated_smtp_report_with_http_info(opts = {})
365
+ if @api_client.config.debugging
366
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.get_aggregated_smtp_report ...'
367
+ end
368
+ # resource path
369
+ local_var_path = '/smtp/statistics/aggregatedReport'
370
+
371
+ # query parameters
372
+ query_params = {}
373
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
374
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
375
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
376
+ query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
377
+
378
+ # header parameters
379
+ header_params = {}
380
+ # HTTP header 'Accept' (if needed)
381
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
382
+ # HTTP header 'Content-Type'
383
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
384
+
385
+ # form parameters
386
+ form_params = {}
387
+
388
+ # http body (model)
389
+ post_body = nil
390
+ auth_names = ['api-key', 'partner-key']
391
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
392
+ :header_params => header_params,
393
+ :query_params => query_params,
394
+ :form_params => form_params,
395
+ :body => post_body,
396
+ :auth_names => auth_names,
397
+ :return_type => 'GetAggregatedReport')
398
+ if @api_client.config.debugging
399
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#get_aggregated_smtp_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
400
+ end
401
+ return data, status_code, headers
402
+ end
403
+ # Get the list of blocked domains
404
+ # Get the list of blocked domains
405
+ # @param [Hash] opts the optional parameters
406
+ # @return [GetBlockedDomains]
407
+ def get_blocked_domains(opts = {})
408
+ data, _status_code, _headers = get_blocked_domains_with_http_info(opts)
409
+ data
410
+ end
411
+
412
+ # Get the list of blocked domains
413
+ # Get the list of blocked domains
414
+ # @param [Hash] opts the optional parameters
415
+ # @return [Array<(GetBlockedDomains, Fixnum, Hash)>] GetBlockedDomains data, response status code and response headers
416
+ def get_blocked_domains_with_http_info(opts = {})
417
+ if @api_client.config.debugging
418
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.get_blocked_domains ...'
419
+ end
420
+ # resource path
421
+ local_var_path = '/smtp/blockedDomains'
422
+
423
+ # query parameters
424
+ query_params = {}
425
+
426
+ # header parameters
427
+ header_params = {}
428
+ # HTTP header 'Accept' (if needed)
429
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
430
+ # HTTP header 'Content-Type'
431
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
432
+
433
+ # form parameters
434
+ form_params = {}
435
+
436
+ # http body (model)
437
+ post_body = nil
438
+ auth_names = ['api-key', 'partner-key']
439
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
440
+ :header_params => header_params,
441
+ :query_params => query_params,
442
+ :form_params => form_params,
443
+ :body => post_body,
444
+ :auth_names => auth_names,
445
+ :return_type => 'GetBlockedDomains')
446
+ if @api_client.config.debugging
447
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#get_blocked_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
448
+ end
449
+ return data, status_code, headers
450
+ end
451
+ # Get all your transactional email activity (unaggregated events)
452
+ # This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
453
+ # @param [Hash] opts the optional parameters
454
+ # @option opts [Integer] :limit Number limitation for the result returned (default to 2500)
455
+ # @option opts [Integer] :offset Beginning point in the list to retrieve from. (default to 0)
456
+ # @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
457
+ # @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
458
+ # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
459
+ # @option opts [String] :email Filter the report for a specific email addresses
460
+ # @option opts [String] :event Filter the report for a specific event type
461
+ # @option opts [String] :tags Filter the report for tags (serialized and urlencoded array)
462
+ # @option opts [String] :message_id Filter on a specific message id
463
+ # @option opts [Integer] :template_id Filter on a specific template id
464
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
465
+ # @return [GetEmailEventReport]
466
+ def get_email_event_report(opts = {})
467
+ data, _status_code, _headers = get_email_event_report_with_http_info(opts)
468
+ data
469
+ end
470
+
471
+ # Get all your transactional email activity (unaggregated events)
472
+ # This endpoint will show the aggregated stats for past 30 days by default if &#x60;startDate&#x60; and &#x60;endDate&#x60; OR &#x60;days&#x60; is not passed. The date range can not exceed 90 days
473
+ # @param [Hash] opts the optional parameters
474
+ # @option opts [Integer] :limit Number limitation for the result returned
475
+ # @option opts [Integer] :offset Beginning point in the list to retrieve from.
476
+ # @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
477
+ # @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
478
+ # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
479
+ # @option opts [String] :email Filter the report for a specific email addresses
480
+ # @option opts [String] :event Filter the report for a specific event type
481
+ # @option opts [String] :tags Filter the report for tags (serialized and urlencoded array)
482
+ # @option opts [String] :message_id Filter on a specific message id
483
+ # @option opts [Integer] :template_id Filter on a specific template id
484
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
485
+ # @return [Array<(GetEmailEventReport, Fixnum, Hash)>] GetEmailEventReport data, response status code and response headers
486
+ def get_email_event_report_with_http_info(opts = {})
487
+ if @api_client.config.debugging
488
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.get_email_event_report ...'
489
+ end
490
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 5000
491
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_email_event_report, must be smaller than or equal to 5000.'
492
+ end
493
+
494
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
495
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_email_event_report, must be greater than or equal to 0.'
496
+ end
497
+
498
+ if @api_client.config.client_side_validation && opts[:'event'] && !['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked', 'unsubscribed', 'error', 'loadedByProxy'].include?(opts[:'event'])
499
+ fail ArgumentError, 'invalid value for "event", must be one of bounces, hardBounces, softBounces, delivered, spam, requests, opened, clicks, invalid, deferred, blocked, unsubscribed, error, loadedByProxy'
500
+ end
501
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
502
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
503
+ end
504
+ # resource path
505
+ local_var_path = '/smtp/statistics/events'
506
+
507
+ # query parameters
508
+ query_params = {}
509
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
510
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
511
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
512
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
513
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
514
+ query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
515
+ query_params[:'event'] = opts[:'event'] if !opts[:'event'].nil?
516
+ query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
517
+ query_params[:'messageId'] = opts[:'message_id'] if !opts[:'message_id'].nil?
518
+ query_params[:'templateId'] = opts[:'template_id'] if !opts[:'template_id'].nil?
519
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
520
+
521
+ # header parameters
522
+ header_params = {}
523
+ # HTTP header 'Accept' (if needed)
524
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
525
+ # HTTP header 'Content-Type'
526
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
527
+
528
+ # form parameters
529
+ form_params = {}
530
+
531
+ # http body (model)
532
+ post_body = nil
533
+ auth_names = ['api-key', 'partner-key']
534
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
535
+ :header_params => header_params,
536
+ :query_params => query_params,
537
+ :form_params => form_params,
538
+ :body => post_body,
539
+ :auth_names => auth_names,
540
+ :return_type => 'GetEmailEventReport')
541
+ if @api_client.config.debugging
542
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#get_email_event_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
543
+ end
544
+ return data, status_code, headers
545
+ end
546
+ # Fetch scheduled emails by batchId
547
+ # Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old)
548
+ # @param batch_id The batchId of scheduled emails batch (Should be a valid UUIDv4)
549
+ # @param [Hash] opts the optional parameters
550
+ # @option opts [Date] :start_date Mandatory if &#x60;endDate&#x60; is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
551
+ # @option opts [Date] :end_date Mandatory if &#x60;startDate&#x60; is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
552
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
553
+ # @option opts [String] :status Filter the records by &#x60;status&#x60; of the scheduled email batch or message.
554
+ # @option opts [Integer] :limit Number of documents returned per page (default to 100)
555
+ # @option opts [Integer] :offset Index of the first document on the page (default to 0)
556
+ # @return [GetScheduledEmailByBatchId]
557
+ def get_scheduled_email_by_batch_id(batch_id, opts = {})
558
+ data, _status_code, _headers = get_scheduled_email_by_batch_id_with_http_info(batch_id, opts)
559
+ data
560
+ end
561
+
562
+ # Fetch scheduled emails by batchId
563
+ # Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old)
564
+ # @param batch_id The batchId of scheduled emails batch (Should be a valid UUIDv4)
565
+ # @param [Hash] opts the optional parameters
566
+ # @option opts [Date] :start_date Mandatory if &#x60;endDate&#x60; is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
567
+ # @option opts [Date] :end_date Mandatory if &#x60;startDate&#x60; is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
568
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
569
+ # @option opts [String] :status Filter the records by &#x60;status&#x60; of the scheduled email batch or message.
570
+ # @option opts [Integer] :limit Number of documents returned per page
571
+ # @option opts [Integer] :offset Index of the first document on the page
572
+ # @return [Array<(GetScheduledEmailByBatchId, Fixnum, Hash)>] GetScheduledEmailByBatchId data, response status code and response headers
573
+ def get_scheduled_email_by_batch_id_with_http_info(batch_id, opts = {})
574
+ if @api_client.config.debugging
575
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.get_scheduled_email_by_batch_id ...'
576
+ end
577
+ # verify the required parameter 'batch_id' is set
578
+ if @api_client.config.client_side_validation && batch_id.nil?
579
+ fail ArgumentError, "Missing the required parameter 'batch_id' when calling TransactionalEmailsApi.get_scheduled_email_by_batch_id"
580
+ end
581
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
582
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
583
+ end
584
+ if @api_client.config.client_side_validation && opts[:'status'] && !['processed', 'inProgress', 'queued'].include?(opts[:'status'])
585
+ fail ArgumentError, 'invalid value for "status", must be one of processed, inProgress, queued'
586
+ end
587
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
588
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_scheduled_email_by_batch_id, must be smaller than or equal to 500.'
589
+ end
590
+
591
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
592
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_scheduled_email_by_batch_id, must be greater than or equal to 0.'
593
+ end
594
+
595
+ # resource path
596
+ local_var_path = '/smtp/emailStatus/{batchId}'.sub('{' + 'batchId' + '}', batch_id.to_s)
597
+
598
+ # query parameters
599
+ query_params = {}
600
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
601
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
602
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
603
+ query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
604
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
605
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
606
+
607
+ # header parameters
608
+ header_params = {}
609
+ # HTTP header 'Accept' (if needed)
610
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
611
+ # HTTP header 'Content-Type'
612
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
613
+
614
+ # form parameters
615
+ form_params = {}
616
+
617
+ # http body (model)
618
+ post_body = nil
619
+ auth_names = ['api-key', 'partner-key']
620
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
621
+ :header_params => header_params,
622
+ :query_params => query_params,
623
+ :form_params => form_params,
624
+ :body => post_body,
625
+ :auth_names => auth_names,
626
+ :return_type => 'GetScheduledEmailByBatchId')
627
+ if @api_client.config.debugging
628
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#get_scheduled_email_by_batch_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
629
+ end
630
+ return data, status_code, headers
631
+ end
632
+ # Fetch scheduled email by messageId
633
+ # Fetch scheduled email by messageId (Can retrieve data upto 30 days old)
634
+ # @param message_id The messageId of scheduled email
635
+ # @param [Hash] opts the optional parameters
636
+ # @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
637
+ # @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
638
+ # @return [GetScheduledEmailByMessageId]
639
+ def get_scheduled_email_by_message_id(message_id, opts = {})
640
+ data, _status_code, _headers = get_scheduled_email_by_message_id_with_http_info(message_id, opts)
641
+ data
642
+ end
643
+
644
+ # Fetch scheduled email by messageId
645
+ # Fetch scheduled email by messageId (Can retrieve data upto 30 days old)
646
+ # @param message_id The messageId of scheduled email
647
+ # @param [Hash] opts the optional parameters
648
+ # @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
649
+ # @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
650
+ # @return [Array<(GetScheduledEmailByMessageId, Fixnum, Hash)>] GetScheduledEmailByMessageId data, response status code and response headers
651
+ def get_scheduled_email_by_message_id_with_http_info(message_id, opts = {})
652
+ if @api_client.config.debugging
653
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.get_scheduled_email_by_message_id ...'
654
+ end
655
+ # verify the required parameter 'message_id' is set
656
+ if @api_client.config.client_side_validation && message_id.nil?
657
+ fail ArgumentError, "Missing the required parameter 'message_id' when calling TransactionalEmailsApi.get_scheduled_email_by_message_id"
658
+ end
659
+ # resource path
660
+ local_var_path = '/smtp/emailStatus/{messageId}'.sub('{' + 'messageId' + '}', message_id.to_s)
661
+
662
+ # query parameters
663
+ query_params = {}
664
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
665
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
666
+
667
+ # header parameters
668
+ header_params = {}
669
+ # HTTP header 'Accept' (if needed)
670
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
671
+ # HTTP header 'Content-Type'
672
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
673
+
674
+ # form parameters
675
+ form_params = {}
676
+
677
+ # http body (model)
678
+ post_body = nil
679
+ auth_names = ['api-key', 'partner-key']
680
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
681
+ :header_params => header_params,
682
+ :query_params => query_params,
683
+ :form_params => form_params,
684
+ :body => post_body,
685
+ :auth_names => auth_names,
686
+ :return_type => 'GetScheduledEmailByMessageId')
687
+ if @api_client.config.debugging
688
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#get_scheduled_email_by_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
689
+ end
690
+ return data, status_code, headers
691
+ end
692
+ # Get your transactional email activity aggregated per day
693
+ # @param [Hash] opts the optional parameters
694
+ # @option opts [Integer] :limit Number of documents returned per page (default to 10)
695
+ # @option opts [Integer] :offset Index of the first document on the page (default to 0)
696
+ # @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
697
+ # @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
698
+ # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
699
+ # @option opts [String] :tag Tag of the emails
700
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
701
+ # @return [GetReports]
702
+ def get_smtp_report(opts = {})
703
+ data, _status_code, _headers = get_smtp_report_with_http_info(opts)
704
+ data
705
+ end
706
+
707
+ # Get your transactional email activity aggregated per day
708
+ # @param [Hash] opts the optional parameters
709
+ # @option opts [Integer] :limit Number of documents returned per page
710
+ # @option opts [Integer] :offset Index of the first document on the page
711
+ # @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
712
+ # @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
713
+ # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
714
+ # @option opts [String] :tag Tag of the emails
715
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
716
+ # @return [Array<(GetReports, Fixnum, Hash)>] GetReports data, response status code and response headers
717
+ def get_smtp_report_with_http_info(opts = {})
718
+ if @api_client.config.debugging
719
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.get_smtp_report ...'
720
+ end
721
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 30
722
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_smtp_report, must be smaller than or equal to 30.'
723
+ end
724
+
725
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
726
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_smtp_report, must be greater than or equal to 0.'
727
+ end
728
+
729
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
730
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
731
+ end
732
+ # resource path
733
+ local_var_path = '/smtp/statistics/reports'
734
+
735
+ # query parameters
736
+ query_params = {}
737
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
738
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
739
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
740
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
741
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
742
+ query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
743
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
744
+
745
+ # header parameters
746
+ header_params = {}
747
+ # HTTP header 'Accept' (if needed)
748
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
749
+ # HTTP header 'Content-Type'
750
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
751
+
752
+ # form parameters
753
+ form_params = {}
754
+
755
+ # http body (model)
756
+ post_body = nil
757
+ auth_names = ['api-key', 'partner-key']
758
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
759
+ :header_params => header_params,
760
+ :query_params => query_params,
761
+ :form_params => form_params,
762
+ :body => post_body,
763
+ :auth_names => auth_names,
764
+ :return_type => 'GetReports')
765
+ if @api_client.config.debugging
766
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#get_smtp_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
767
+ end
768
+ return data, status_code, headers
769
+ end
770
+ # Returns the template information
771
+ # @param template_id id of the template
772
+ # @param [Hash] opts the optional parameters
773
+ # @return [GetSmtpTemplateOverview]
774
+ def get_smtp_template(template_id, opts = {})
775
+ data, _status_code, _headers = get_smtp_template_with_http_info(template_id, opts)
776
+ data
777
+ end
778
+
779
+ # Returns the template information
780
+ # @param template_id id of the template
781
+ # @param [Hash] opts the optional parameters
782
+ # @return [Array<(GetSmtpTemplateOverview, Fixnum, Hash)>] GetSmtpTemplateOverview data, response status code and response headers
783
+ def get_smtp_template_with_http_info(template_id, opts = {})
784
+ if @api_client.config.debugging
785
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.get_smtp_template ...'
786
+ end
787
+ # verify the required parameter 'template_id' is set
788
+ if @api_client.config.client_side_validation && template_id.nil?
789
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling TransactionalEmailsApi.get_smtp_template"
790
+ end
791
+ # resource path
792
+ local_var_path = '/smtp/templates/{templateId}'.sub('{' + 'templateId' + '}', template_id.to_s)
793
+
794
+ # query parameters
795
+ query_params = {}
796
+
797
+ # header parameters
798
+ header_params = {}
799
+ # HTTP header 'Accept' (if needed)
800
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
801
+ # HTTP header 'Content-Type'
802
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
803
+
804
+ # form parameters
805
+ form_params = {}
806
+
807
+ # http body (model)
808
+ post_body = nil
809
+ auth_names = ['api-key', 'partner-key']
810
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
811
+ :header_params => header_params,
812
+ :query_params => query_params,
813
+ :form_params => form_params,
814
+ :body => post_body,
815
+ :auth_names => auth_names,
816
+ :return_type => 'GetSmtpTemplateOverview')
817
+ if @api_client.config.debugging
818
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#get_smtp_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
819
+ end
820
+ return data, status_code, headers
821
+ end
822
+ # Get the list of email templates
823
+ # @param [Hash] opts the optional parameters
824
+ # @option opts [BOOLEAN] :template_status Filter on the status of the template. Active &#x3D; true, inactive &#x3D; false
825
+ # @option opts [Integer] :limit Number of documents returned per page (default to 50)
826
+ # @option opts [Integer] :offset Index of the first document in the page (default to 0)
827
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
828
+ # @return [GetSmtpTemplates]
829
+ def get_smtp_templates(opts = {})
830
+ data, _status_code, _headers = get_smtp_templates_with_http_info(opts)
831
+ data
832
+ end
833
+
834
+ # Get the list of email templates
835
+ # @param [Hash] opts the optional parameters
836
+ # @option opts [BOOLEAN] :template_status Filter on the status of the template. Active &#x3D; true, inactive &#x3D; false
837
+ # @option opts [Integer] :limit Number of documents returned per page
838
+ # @option opts [Integer] :offset Index of the first document in the page
839
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
840
+ # @return [Array<(GetSmtpTemplates, Fixnum, Hash)>] GetSmtpTemplates data, response status code and response headers
841
+ def get_smtp_templates_with_http_info(opts = {})
842
+ if @api_client.config.debugging
843
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.get_smtp_templates ...'
844
+ end
845
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
846
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_smtp_templates, must be smaller than or equal to 1000.'
847
+ end
848
+
849
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
850
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_smtp_templates, must be greater than or equal to 0.'
851
+ end
852
+
853
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
854
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
855
+ end
856
+ # resource path
857
+ local_var_path = '/smtp/templates'
858
+
859
+ # query parameters
860
+ query_params = {}
861
+ query_params[:'templateStatus'] = opts[:'template_status'] if !opts[:'template_status'].nil?
862
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
863
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
864
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
865
+
866
+ # header parameters
867
+ header_params = {}
868
+ # HTTP header 'Accept' (if needed)
869
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
870
+ # HTTP header 'Content-Type'
871
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
872
+
873
+ # form parameters
874
+ form_params = {}
875
+
876
+ # http body (model)
877
+ post_body = nil
878
+ auth_names = ['api-key', 'partner-key']
879
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
880
+ :header_params => header_params,
881
+ :query_params => query_params,
882
+ :form_params => form_params,
883
+ :body => post_body,
884
+ :auth_names => auth_names,
885
+ :return_type => 'GetSmtpTemplates')
886
+ if @api_client.config.debugging
887
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#get_smtp_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
888
+ end
889
+ return data, status_code, headers
890
+ end
891
+ # Get the list of blocked or unsubscribed transactional contacts
892
+ # @param [Hash] opts the optional parameters
893
+ # @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
894
+ # @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
895
+ # @option opts [Integer] :limit Number of documents returned per page (default to 50)
896
+ # @option opts [Integer] :offset Index of the first document on the page (default to 0)
897
+ # @option opts [Array<String>] :senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
898
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
899
+ # @return [GetTransacBlockedContacts]
900
+ def get_transac_blocked_contacts(opts = {})
901
+ data, _status_code, _headers = get_transac_blocked_contacts_with_http_info(opts)
902
+ data
903
+ end
904
+
905
+ # Get the list of blocked or unsubscribed transactional contacts
906
+ # @param [Hash] opts the optional parameters
907
+ # @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
908
+ # @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
909
+ # @option opts [Integer] :limit Number of documents returned per page
910
+ # @option opts [Integer] :offset Index of the first document on the page
911
+ # @option opts [Array<String>] :senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
912
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
913
+ # @return [Array<(GetTransacBlockedContacts, Fixnum, Hash)>] GetTransacBlockedContacts data, response status code and response headers
914
+ def get_transac_blocked_contacts_with_http_info(opts = {})
915
+ if @api_client.config.debugging
916
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.get_transac_blocked_contacts ...'
917
+ end
918
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
919
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_transac_blocked_contacts, must be smaller than or equal to 100.'
920
+ end
921
+
922
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
923
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_transac_blocked_contacts, must be greater than or equal to 0.'
924
+ end
925
+
926
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
927
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
928
+ end
929
+ # resource path
930
+ local_var_path = '/smtp/blockedContacts'
931
+
932
+ # query parameters
933
+ query_params = {}
934
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
935
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
936
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
937
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
938
+ query_params[:'senders'] = @api_client.build_collection_param(opts[:'senders'], :csv) if !opts[:'senders'].nil?
939
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
940
+
941
+ # header parameters
942
+ header_params = {}
943
+ # HTTP header 'Accept' (if needed)
944
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
945
+ # HTTP header 'Content-Type'
946
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
947
+
948
+ # form parameters
949
+ form_params = {}
950
+
951
+ # http body (model)
952
+ post_body = nil
953
+ auth_names = ['api-key', 'partner-key']
954
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
955
+ :header_params => header_params,
956
+ :query_params => query_params,
957
+ :form_params => form_params,
958
+ :body => post_body,
959
+ :auth_names => auth_names,
960
+ :return_type => 'GetTransacBlockedContacts')
961
+ if @api_client.config.debugging
962
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#get_transac_blocked_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
963
+ end
964
+ return data, status_code, headers
965
+ end
966
+ # Get the personalized content of a sent transactional email
967
+ # @param uuid Unique id of the transactional email that has been sent to a particular contact
968
+ # @param [Hash] opts the optional parameters
969
+ # @return [GetTransacEmailContent]
970
+ def get_transac_email_content(uuid, opts = {})
971
+ data, _status_code, _headers = get_transac_email_content_with_http_info(uuid, opts)
972
+ data
973
+ end
974
+
975
+ # Get the personalized content of a sent transactional email
976
+ # @param uuid Unique id of the transactional email that has been sent to a particular contact
977
+ # @param [Hash] opts the optional parameters
978
+ # @return [Array<(GetTransacEmailContent, Fixnum, Hash)>] GetTransacEmailContent data, response status code and response headers
979
+ def get_transac_email_content_with_http_info(uuid, opts = {})
980
+ if @api_client.config.debugging
981
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.get_transac_email_content ...'
982
+ end
983
+ # verify the required parameter 'uuid' is set
984
+ if @api_client.config.client_side_validation && uuid.nil?
985
+ fail ArgumentError, "Missing the required parameter 'uuid' when calling TransactionalEmailsApi.get_transac_email_content"
986
+ end
987
+ # resource path
988
+ local_var_path = '/smtp/emails/{uuid}'.sub('{' + 'uuid' + '}', uuid.to_s)
989
+
990
+ # query parameters
991
+ query_params = {}
992
+
993
+ # header parameters
994
+ header_params = {}
995
+ # HTTP header 'Accept' (if needed)
996
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
997
+ # HTTP header 'Content-Type'
998
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
999
+
1000
+ # form parameters
1001
+ form_params = {}
1002
+
1003
+ # http body (model)
1004
+ post_body = nil
1005
+ auth_names = ['api-key', 'partner-key']
1006
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1007
+ :header_params => header_params,
1008
+ :query_params => query_params,
1009
+ :form_params => form_params,
1010
+ :body => post_body,
1011
+ :auth_names => auth_names,
1012
+ :return_type => 'GetTransacEmailContent')
1013
+ if @api_client.config.debugging
1014
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#get_transac_email_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1015
+ end
1016
+ return data, status_code, headers
1017
+ end
1018
+ # Get the list of transactional emails on the basis of allowed filters
1019
+ # This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
1020
+ # @param [Hash] opts the optional parameters
1021
+ # @option opts [String] :email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
1022
+ # @option opts [Integer] :template_id Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
1023
+ # @option opts [String] :message_id Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
1024
+ # @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
1025
+ # @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
1026
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
1027
+ # @option opts [Integer] :limit Number of documents returned per page (default to 500)
1028
+ # @option opts [Integer] :offset Index of the first document in the page (default to 0)
1029
+ # @return [GetTransacEmailsList]
1030
+ def get_transac_emails_list(opts = {})
1031
+ data, _status_code, _headers = get_transac_emails_list_with_http_info(opts)
1032
+ data
1033
+ end
1034
+
1035
+ # Get the list of transactional emails on the basis of allowed filters
1036
+ # This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
1037
+ # @param [Hash] opts the optional parameters
1038
+ # @option opts [String] :email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
1039
+ # @option opts [Integer] :template_id Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
1040
+ # @option opts [String] :message_id Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
1041
+ # @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
1042
+ # @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
1043
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
1044
+ # @option opts [Integer] :limit Number of documents returned per page
1045
+ # @option opts [Integer] :offset Index of the first document in the page
1046
+ # @return [Array<(GetTransacEmailsList, Fixnum, Hash)>] GetTransacEmailsList data, response status code and response headers
1047
+ def get_transac_emails_list_with_http_info(opts = {})
1048
+ if @api_client.config.debugging
1049
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.get_transac_emails_list ...'
1050
+ end
1051
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
1052
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
1053
+ end
1054
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
1055
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_transac_emails_list, must be smaller than or equal to 1000.'
1056
+ end
1057
+
1058
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
1059
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_transac_emails_list, must be greater than or equal to 0.'
1060
+ end
1061
+
1062
+ # resource path
1063
+ local_var_path = '/smtp/emails'
1064
+
1065
+ # query parameters
1066
+ query_params = {}
1067
+ query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
1068
+ query_params[:'templateId'] = opts[:'template_id'] if !opts[:'template_id'].nil?
1069
+ query_params[:'messageId'] = opts[:'message_id'] if !opts[:'message_id'].nil?
1070
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
1071
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
1072
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1073
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1074
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1075
+
1076
+ # header parameters
1077
+ header_params = {}
1078
+ # HTTP header 'Accept' (if needed)
1079
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1080
+ # HTTP header 'Content-Type'
1081
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1082
+
1083
+ # form parameters
1084
+ form_params = {}
1085
+
1086
+ # http body (model)
1087
+ post_body = nil
1088
+ auth_names = ['api-key', 'partner-key']
1089
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1090
+ :header_params => header_params,
1091
+ :query_params => query_params,
1092
+ :form_params => form_params,
1093
+ :body => post_body,
1094
+ :auth_names => auth_names,
1095
+ :return_type => 'GetTransacEmailsList')
1096
+ if @api_client.config.debugging
1097
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#get_transac_emails_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1098
+ end
1099
+ return data, status_code, headers
1100
+ end
1101
+ # Send a template to your test list
1102
+ # @param template_id Id of the template
1103
+ # @param send_test_email
1104
+ # @param [Hash] opts the optional parameters
1105
+ # @return [nil]
1106
+ def send_test_template(template_id, send_test_email, opts = {})
1107
+ send_test_template_with_http_info(template_id, send_test_email, opts)
1108
+ nil
1109
+ end
1110
+
1111
+ # Send a template to your test list
1112
+ # @param template_id Id of the template
1113
+ # @param send_test_email
1114
+ # @param [Hash] opts the optional parameters
1115
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1116
+ def send_test_template_with_http_info(template_id, send_test_email, opts = {})
1117
+ if @api_client.config.debugging
1118
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.send_test_template ...'
1119
+ end
1120
+ # verify the required parameter 'template_id' is set
1121
+ if @api_client.config.client_side_validation && template_id.nil?
1122
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling TransactionalEmailsApi.send_test_template"
1123
+ end
1124
+ # verify the required parameter 'send_test_email' is set
1125
+ if @api_client.config.client_side_validation && send_test_email.nil?
1126
+ fail ArgumentError, "Missing the required parameter 'send_test_email' when calling TransactionalEmailsApi.send_test_template"
1127
+ end
1128
+ # resource path
1129
+ local_var_path = '/smtp/templates/{templateId}/sendTest'.sub('{' + 'templateId' + '}', template_id.to_s)
1130
+
1131
+ # query parameters
1132
+ query_params = {}
1133
+
1134
+ # header parameters
1135
+ header_params = {}
1136
+ # HTTP header 'Accept' (if needed)
1137
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1138
+ # HTTP header 'Content-Type'
1139
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1140
+
1141
+ # form parameters
1142
+ form_params = {}
1143
+
1144
+ # http body (model)
1145
+ post_body = @api_client.object_to_http_body(send_test_email)
1146
+ auth_names = ['api-key', 'partner-key']
1147
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1148
+ :header_params => header_params,
1149
+ :query_params => query_params,
1150
+ :form_params => form_params,
1151
+ :body => post_body,
1152
+ :auth_names => auth_names)
1153
+ if @api_client.config.debugging
1154
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#send_test_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1155
+ end
1156
+ return data, status_code, headers
1157
+ end
1158
+ # Send a transactional email
1159
+ # @param send_smtp_email Values to send a transactional email
1160
+ # @param [Hash] opts the optional parameters
1161
+ # @return [CreateSmtpEmail]
1162
+ def send_transac_email(send_smtp_email, opts = {})
1163
+ data, _status_code, _headers = send_transac_email_with_http_info(send_smtp_email, opts)
1164
+ data
1165
+ end
1166
+
1167
+ # Send a transactional email
1168
+ # @param send_smtp_email Values to send a transactional email
1169
+ # @param [Hash] opts the optional parameters
1170
+ # @return [Array<(CreateSmtpEmail, Fixnum, Hash)>] CreateSmtpEmail data, response status code and response headers
1171
+ def send_transac_email_with_http_info(send_smtp_email, opts = {})
1172
+ if @api_client.config.debugging
1173
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.send_transac_email ...'
1174
+ end
1175
+ # verify the required parameter 'send_smtp_email' is set
1176
+ if @api_client.config.client_side_validation && send_smtp_email.nil?
1177
+ fail ArgumentError, "Missing the required parameter 'send_smtp_email' when calling TransactionalEmailsApi.send_transac_email"
1178
+ end
1179
+ # resource path
1180
+ local_var_path = '/smtp/email'
1181
+
1182
+ # query parameters
1183
+ query_params = {}
1184
+
1185
+ # header parameters
1186
+ header_params = {}
1187
+ # HTTP header 'Accept' (if needed)
1188
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1189
+ # HTTP header 'Content-Type'
1190
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1191
+
1192
+ # form parameters
1193
+ form_params = {}
1194
+
1195
+ # http body (model)
1196
+ post_body = @api_client.object_to_http_body(send_smtp_email)
1197
+ auth_names = ['api-key', 'partner-key']
1198
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1199
+ :header_params => header_params,
1200
+ :query_params => query_params,
1201
+ :form_params => form_params,
1202
+ :body => post_body,
1203
+ :auth_names => auth_names,
1204
+ :return_type => 'CreateSmtpEmail')
1205
+ if @api_client.config.debugging
1206
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#send_transac_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1207
+ end
1208
+ return data, status_code, headers
1209
+ end
1210
+ # Unblock or resubscribe a transactional contact
1211
+ # @param email contact email (urlencoded) to unblock.
1212
+ # @param [Hash] opts the optional parameters
1213
+ # @return [nil]
1214
+ def smtp_blocked_contacts_email_delete(email, opts = {})
1215
+ smtp_blocked_contacts_email_delete_with_http_info(email, opts)
1216
+ nil
1217
+ end
1218
+
1219
+ # Unblock or resubscribe a transactional contact
1220
+ # @param email contact email (urlencoded) to unblock.
1221
+ # @param [Hash] opts the optional parameters
1222
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1223
+ def smtp_blocked_contacts_email_delete_with_http_info(email, opts = {})
1224
+ if @api_client.config.debugging
1225
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.smtp_blocked_contacts_email_delete ...'
1226
+ end
1227
+ # verify the required parameter 'email' is set
1228
+ if @api_client.config.client_side_validation && email.nil?
1229
+ fail ArgumentError, "Missing the required parameter 'email' when calling TransactionalEmailsApi.smtp_blocked_contacts_email_delete"
1230
+ end
1231
+ # resource path
1232
+ local_var_path = '/smtp/blockedContacts/{email}'.sub('{' + 'email' + '}', email.to_s)
1233
+
1234
+ # query parameters
1235
+ query_params = {}
1236
+
1237
+ # header parameters
1238
+ header_params = {}
1239
+ # HTTP header 'Accept' (if needed)
1240
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1241
+ # HTTP header 'Content-Type'
1242
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1243
+
1244
+ # form parameters
1245
+ form_params = {}
1246
+
1247
+ # http body (model)
1248
+ post_body = nil
1249
+ auth_names = ['api-key', 'partner-key']
1250
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
1251
+ :header_params => header_params,
1252
+ :query_params => query_params,
1253
+ :form_params => form_params,
1254
+ :body => post_body,
1255
+ :auth_names => auth_names)
1256
+ if @api_client.config.debugging
1257
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#smtp_blocked_contacts_email_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1258
+ end
1259
+ return data, status_code, headers
1260
+ end
1261
+ # Delete an SMTP transactional log
1262
+ # @param message_id MessageId of the transactional log to delete
1263
+ # @param [Hash] opts the optional parameters
1264
+ # @return [nil]
1265
+ def smtp_log_message_id_delete(message_id, opts = {})
1266
+ smtp_log_message_id_delete_with_http_info(message_id, opts)
1267
+ nil
1268
+ end
1269
+
1270
+ # Delete an SMTP transactional log
1271
+ # @param message_id MessageId of the transactional log to delete
1272
+ # @param [Hash] opts the optional parameters
1273
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1274
+ def smtp_log_message_id_delete_with_http_info(message_id, opts = {})
1275
+ if @api_client.config.debugging
1276
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.smtp_log_message_id_delete ...'
1277
+ end
1278
+ # verify the required parameter 'message_id' is set
1279
+ if @api_client.config.client_side_validation && message_id.nil?
1280
+ fail ArgumentError, "Missing the required parameter 'message_id' when calling TransactionalEmailsApi.smtp_log_message_id_delete"
1281
+ end
1282
+ # resource path
1283
+ local_var_path = '/smtp/log/{messageId}'.sub('{' + 'messageId' + '}', message_id.to_s)
1284
+
1285
+ # query parameters
1286
+ query_params = {}
1287
+
1288
+ # header parameters
1289
+ header_params = {}
1290
+ # HTTP header 'Accept' (if needed)
1291
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1292
+ # HTTP header 'Content-Type'
1293
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1294
+
1295
+ # form parameters
1296
+ form_params = {}
1297
+
1298
+ # http body (model)
1299
+ post_body = nil
1300
+ auth_names = ['api-key', 'partner-key']
1301
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
1302
+ :header_params => header_params,
1303
+ :query_params => query_params,
1304
+ :form_params => form_params,
1305
+ :body => post_body,
1306
+ :auth_names => auth_names)
1307
+ if @api_client.config.debugging
1308
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#smtp_log_message_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1309
+ end
1310
+ return data, status_code, headers
1311
+ end
1312
+ # Update an email template
1313
+ # @param template_id id of the template
1314
+ # @param smtp_template values to update in transactional email template
1315
+ # @param [Hash] opts the optional parameters
1316
+ # @return [nil]
1317
+ def update_smtp_template(template_id, smtp_template, opts = {})
1318
+ update_smtp_template_with_http_info(template_id, smtp_template, opts)
1319
+ nil
1320
+ end
1321
+
1322
+ # Update an email template
1323
+ # @param template_id id of the template
1324
+ # @param smtp_template values to update in transactional email template
1325
+ # @param [Hash] opts the optional parameters
1326
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1327
+ def update_smtp_template_with_http_info(template_id, smtp_template, opts = {})
1328
+ if @api_client.config.debugging
1329
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.update_smtp_template ...'
1330
+ end
1331
+ # verify the required parameter 'template_id' is set
1332
+ if @api_client.config.client_side_validation && template_id.nil?
1333
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling TransactionalEmailsApi.update_smtp_template"
1334
+ end
1335
+ # verify the required parameter 'smtp_template' is set
1336
+ if @api_client.config.client_side_validation && smtp_template.nil?
1337
+ fail ArgumentError, "Missing the required parameter 'smtp_template' when calling TransactionalEmailsApi.update_smtp_template"
1338
+ end
1339
+ # resource path
1340
+ local_var_path = '/smtp/templates/{templateId}'.sub('{' + 'templateId' + '}', template_id.to_s)
1341
+
1342
+ # query parameters
1343
+ query_params = {}
1344
+
1345
+ # header parameters
1346
+ header_params = {}
1347
+ # HTTP header 'Accept' (if needed)
1348
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1349
+ # HTTP header 'Content-Type'
1350
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1351
+
1352
+ # form parameters
1353
+ form_params = {}
1354
+
1355
+ # http body (model)
1356
+ post_body = @api_client.object_to_http_body(smtp_template)
1357
+ auth_names = ['api-key', 'partner-key']
1358
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1359
+ :header_params => header_params,
1360
+ :query_params => query_params,
1361
+ :form_params => form_params,
1362
+ :body => post_body,
1363
+ :auth_names => auth_names)
1364
+ if @api_client.config.debugging
1365
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#update_smtp_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1366
+ end
1367
+ return data, status_code, headers
1368
+ end
1369
+ end
1370
+ end