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,923 @@
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 ResellerApi
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 Email and/or SMS credits to a specific child account
33
+ # @param child_identifier Either auth key or id of reseller's child
34
+ # @param add_credits Values to post to add credit to a specific child account
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [RemainingCreditModel]
37
+ def add_credits(child_identifier, add_credits, opts = {})
38
+ data, _status_code, _headers = add_credits_with_http_info(child_identifier, add_credits, opts)
39
+ data
40
+ end
41
+
42
+ # Add Email and/or SMS credits to a specific child account
43
+ # @param child_identifier Either auth key or id of reseller's child
44
+ # @param add_credits Values to post to add credit to a specific child account
45
+ # @param [Hash] opts the optional parameters
46
+ # @return [Array<(RemainingCreditModel, Fixnum, Hash)>] RemainingCreditModel data, response status code and response headers
47
+ def add_credits_with_http_info(child_identifier, add_credits, opts = {})
48
+ if @api_client.config.debugging
49
+ @api_client.config.logger.debug 'Calling API: ResellerApi.add_credits ...'
50
+ end
51
+ # verify the required parameter 'child_identifier' is set
52
+ if @api_client.config.client_side_validation && child_identifier.nil?
53
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.add_credits"
54
+ end
55
+ # verify the required parameter 'add_credits' is set
56
+ if @api_client.config.client_side_validation && add_credits.nil?
57
+ fail ArgumentError, "Missing the required parameter 'add_credits' when calling ResellerApi.add_credits"
58
+ end
59
+ # resource path
60
+ local_var_path = '/reseller/children/{childIdentifier}/credits/add'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
61
+
62
+ # query parameters
63
+ query_params = {}
64
+
65
+ # header parameters
66
+ header_params = {}
67
+ # HTTP header 'Accept' (if needed)
68
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
69
+ # HTTP header 'Content-Type'
70
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
71
+
72
+ # form parameters
73
+ form_params = {}
74
+
75
+ # http body (model)
76
+ post_body = @api_client.object_to_http_body(add_credits)
77
+ auth_names = ['api-key', 'partner-key']
78
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
79
+ :header_params => header_params,
80
+ :query_params => query_params,
81
+ :form_params => form_params,
82
+ :body => post_body,
83
+ :auth_names => auth_names,
84
+ :return_type => 'RemainingCreditModel')
85
+ if @api_client.config.debugging
86
+ @api_client.config.logger.debug "API called: ResellerApi#add_credits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
+ end
88
+ return data, status_code, headers
89
+ end
90
+ # Associate a dedicated IP to the child
91
+ # @param child_identifier Either auth key or id of reseller&#39;s child
92
+ # @param ip IP to associate
93
+ # @param [Hash] opts the optional parameters
94
+ # @return [nil]
95
+ def associate_ip_to_child(child_identifier, ip, opts = {})
96
+ associate_ip_to_child_with_http_info(child_identifier, ip, opts)
97
+ nil
98
+ end
99
+
100
+ # Associate a dedicated IP to the child
101
+ # @param child_identifier Either auth key or id of reseller&#39;s child
102
+ # @param ip IP to associate
103
+ # @param [Hash] opts the optional parameters
104
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
105
+ def associate_ip_to_child_with_http_info(child_identifier, ip, opts = {})
106
+ if @api_client.config.debugging
107
+ @api_client.config.logger.debug 'Calling API: ResellerApi.associate_ip_to_child ...'
108
+ end
109
+ # verify the required parameter 'child_identifier' is set
110
+ if @api_client.config.client_side_validation && child_identifier.nil?
111
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.associate_ip_to_child"
112
+ end
113
+ # verify the required parameter 'ip' is set
114
+ if @api_client.config.client_side_validation && ip.nil?
115
+ fail ArgumentError, "Missing the required parameter 'ip' when calling ResellerApi.associate_ip_to_child"
116
+ end
117
+ # resource path
118
+ local_var_path = '/reseller/children/{childIdentifier}/ips/associate'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
119
+
120
+ # query parameters
121
+ query_params = {}
122
+
123
+ # header parameters
124
+ header_params = {}
125
+ # HTTP header 'Accept' (if needed)
126
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
127
+ # HTTP header 'Content-Type'
128
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
129
+
130
+ # form parameters
131
+ form_params = {}
132
+
133
+ # http body (model)
134
+ post_body = @api_client.object_to_http_body(ip)
135
+ auth_names = ['api-key', 'partner-key']
136
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
137
+ :header_params => header_params,
138
+ :query_params => query_params,
139
+ :form_params => form_params,
140
+ :body => post_body,
141
+ :auth_names => auth_names)
142
+ if @api_client.config.debugging
143
+ @api_client.config.logger.debug "API called: ResellerApi#associate_ip_to_child\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
144
+ end
145
+ return data, status_code, headers
146
+ end
147
+ # Create a domain for a child account
148
+ # @param child_identifier Either auth key or id of reseller&#39;s child
149
+ # @param add_child_domain Sender domain to add for a specific child account. This will not be displayed to the parent account.
150
+ # @param [Hash] opts the optional parameters
151
+ # @return [nil]
152
+ def create_child_domain(child_identifier, add_child_domain, opts = {})
153
+ create_child_domain_with_http_info(child_identifier, add_child_domain, opts)
154
+ nil
155
+ end
156
+
157
+ # Create a domain for a child account
158
+ # @param child_identifier Either auth key or id of reseller&#39;s child
159
+ # @param add_child_domain Sender domain to add for a specific child account. This will not be displayed to the parent account.
160
+ # @param [Hash] opts the optional parameters
161
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
162
+ def create_child_domain_with_http_info(child_identifier, add_child_domain, opts = {})
163
+ if @api_client.config.debugging
164
+ @api_client.config.logger.debug 'Calling API: ResellerApi.create_child_domain ...'
165
+ end
166
+ # verify the required parameter 'child_identifier' is set
167
+ if @api_client.config.client_side_validation && child_identifier.nil?
168
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.create_child_domain"
169
+ end
170
+ # verify the required parameter 'add_child_domain' is set
171
+ if @api_client.config.client_side_validation && add_child_domain.nil?
172
+ fail ArgumentError, "Missing the required parameter 'add_child_domain' when calling ResellerApi.create_child_domain"
173
+ end
174
+ # resource path
175
+ local_var_path = '/reseller/children/{childIdentifier}/domains'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
176
+
177
+ # query parameters
178
+ query_params = {}
179
+
180
+ # header parameters
181
+ header_params = {}
182
+ # HTTP header 'Accept' (if needed)
183
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
184
+ # HTTP header 'Content-Type'
185
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
186
+
187
+ # form parameters
188
+ form_params = {}
189
+
190
+ # http body (model)
191
+ post_body = @api_client.object_to_http_body(add_child_domain)
192
+ auth_names = ['api-key', 'partner-key']
193
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
194
+ :header_params => header_params,
195
+ :query_params => query_params,
196
+ :form_params => form_params,
197
+ :body => post_body,
198
+ :auth_names => auth_names)
199
+ if @api_client.config.debugging
200
+ @api_client.config.logger.debug "API called: ResellerApi#create_child_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
201
+ end
202
+ return data, status_code, headers
203
+ end
204
+ # Creates a reseller child
205
+ # @param [Hash] opts the optional parameters
206
+ # @option opts [CreateChild] :reseller_child reseller child to add
207
+ # @return [CreateReseller]
208
+ def create_reseller_child(opts = {})
209
+ data, _status_code, _headers = create_reseller_child_with_http_info(opts)
210
+ data
211
+ end
212
+
213
+ # Creates a reseller child
214
+ # @param [Hash] opts the optional parameters
215
+ # @option opts [CreateChild] :reseller_child reseller child to add
216
+ # @return [Array<(CreateReseller, Fixnum, Hash)>] CreateReseller data, response status code and response headers
217
+ def create_reseller_child_with_http_info(opts = {})
218
+ if @api_client.config.debugging
219
+ @api_client.config.logger.debug 'Calling API: ResellerApi.create_reseller_child ...'
220
+ end
221
+ # resource path
222
+ local_var_path = '/reseller/children'
223
+
224
+ # query parameters
225
+ query_params = {}
226
+
227
+ # header parameters
228
+ header_params = {}
229
+ # HTTP header 'Accept' (if needed)
230
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
231
+ # HTTP header 'Content-Type'
232
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
233
+
234
+ # form parameters
235
+ form_params = {}
236
+
237
+ # http body (model)
238
+ post_body = @api_client.object_to_http_body(opts[:'reseller_child'])
239
+ auth_names = ['api-key', 'partner-key']
240
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
241
+ :header_params => header_params,
242
+ :query_params => query_params,
243
+ :form_params => form_params,
244
+ :body => post_body,
245
+ :auth_names => auth_names,
246
+ :return_type => 'CreateReseller')
247
+ if @api_client.config.debugging
248
+ @api_client.config.logger.debug "API called: ResellerApi#create_reseller_child\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
249
+ end
250
+ return data, status_code, headers
251
+ end
252
+ # Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
253
+ # @param child_identifier Either auth key or id of reseller&#39;s child
254
+ # @param domain_name Pass the existing domain that needs to be deleted
255
+ # @param [Hash] opts the optional parameters
256
+ # @return [nil]
257
+ def delete_child_domain(child_identifier, domain_name, opts = {})
258
+ delete_child_domain_with_http_info(child_identifier, domain_name, opts)
259
+ nil
260
+ end
261
+
262
+ # Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
263
+ # @param child_identifier Either auth key or id of reseller&#39;s child
264
+ # @param domain_name Pass the existing domain that needs to be deleted
265
+ # @param [Hash] opts the optional parameters
266
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
267
+ def delete_child_domain_with_http_info(child_identifier, domain_name, opts = {})
268
+ if @api_client.config.debugging
269
+ @api_client.config.logger.debug 'Calling API: ResellerApi.delete_child_domain ...'
270
+ end
271
+ # verify the required parameter 'child_identifier' is set
272
+ if @api_client.config.client_side_validation && child_identifier.nil?
273
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.delete_child_domain"
274
+ end
275
+ # verify the required parameter 'domain_name' is set
276
+ if @api_client.config.client_side_validation && domain_name.nil?
277
+ fail ArgumentError, "Missing the required parameter 'domain_name' when calling ResellerApi.delete_child_domain"
278
+ end
279
+ # resource path
280
+ local_var_path = '/reseller/children/{childIdentifier}/domains/{domainName}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s).sub('{' + 'domainName' + '}', domain_name.to_s)
281
+
282
+ # query parameters
283
+ query_params = {}
284
+
285
+ # header parameters
286
+ header_params = {}
287
+ # HTTP header 'Accept' (if needed)
288
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
289
+ # HTTP header 'Content-Type'
290
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
291
+
292
+ # form parameters
293
+ form_params = {}
294
+
295
+ # http body (model)
296
+ post_body = nil
297
+ auth_names = ['api-key', 'partner-key']
298
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
299
+ :header_params => header_params,
300
+ :query_params => query_params,
301
+ :form_params => form_params,
302
+ :body => post_body,
303
+ :auth_names => auth_names)
304
+ if @api_client.config.debugging
305
+ @api_client.config.logger.debug "API called: ResellerApi#delete_child_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
306
+ end
307
+ return data, status_code, headers
308
+ end
309
+ # Delete a single reseller child based on the child identifier supplied
310
+ # @param child_identifier Either auth key or child id of reseller&#39;s child
311
+ # @param [Hash] opts the optional parameters
312
+ # @return [nil]
313
+ def delete_reseller_child(child_identifier, opts = {})
314
+ delete_reseller_child_with_http_info(child_identifier, opts)
315
+ nil
316
+ end
317
+
318
+ # Delete a single reseller child based on the child identifier supplied
319
+ # @param child_identifier Either auth key or child id of reseller&#39;s child
320
+ # @param [Hash] opts the optional parameters
321
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
322
+ def delete_reseller_child_with_http_info(child_identifier, opts = {})
323
+ if @api_client.config.debugging
324
+ @api_client.config.logger.debug 'Calling API: ResellerApi.delete_reseller_child ...'
325
+ end
326
+ # verify the required parameter 'child_identifier' is set
327
+ if @api_client.config.client_side_validation && child_identifier.nil?
328
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.delete_reseller_child"
329
+ end
330
+ # resource path
331
+ local_var_path = '/reseller/children/{childIdentifier}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
332
+
333
+ # query parameters
334
+ query_params = {}
335
+
336
+ # header parameters
337
+ header_params = {}
338
+ # HTTP header 'Accept' (if needed)
339
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
340
+ # HTTP header 'Content-Type'
341
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
342
+
343
+ # form parameters
344
+ form_params = {}
345
+
346
+ # http body (model)
347
+ post_body = nil
348
+ auth_names = ['api-key', 'partner-key']
349
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
350
+ :header_params => header_params,
351
+ :query_params => query_params,
352
+ :form_params => form_params,
353
+ :body => post_body,
354
+ :auth_names => auth_names)
355
+ if @api_client.config.debugging
356
+ @api_client.config.logger.debug "API called: ResellerApi#delete_reseller_child\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
357
+ end
358
+ return data, status_code, headers
359
+ end
360
+ # Dissociate a dedicated IP to the child
361
+ # @param child_identifier Either auth key or id of reseller&#39;s child
362
+ # @param ip IP to dissociate
363
+ # @param [Hash] opts the optional parameters
364
+ # @return [nil]
365
+ def dissociate_ip_from_child(child_identifier, ip, opts = {})
366
+ dissociate_ip_from_child_with_http_info(child_identifier, ip, opts)
367
+ nil
368
+ end
369
+
370
+ # Dissociate a dedicated IP to the child
371
+ # @param child_identifier Either auth key or id of reseller&#39;s child
372
+ # @param ip IP to dissociate
373
+ # @param [Hash] opts the optional parameters
374
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
375
+ def dissociate_ip_from_child_with_http_info(child_identifier, ip, opts = {})
376
+ if @api_client.config.debugging
377
+ @api_client.config.logger.debug 'Calling API: ResellerApi.dissociate_ip_from_child ...'
378
+ end
379
+ # verify the required parameter 'child_identifier' is set
380
+ if @api_client.config.client_side_validation && child_identifier.nil?
381
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.dissociate_ip_from_child"
382
+ end
383
+ # verify the required parameter 'ip' is set
384
+ if @api_client.config.client_side_validation && ip.nil?
385
+ fail ArgumentError, "Missing the required parameter 'ip' when calling ResellerApi.dissociate_ip_from_child"
386
+ end
387
+ # resource path
388
+ local_var_path = '/reseller/children/{childIdentifier}/ips/dissociate'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
389
+
390
+ # query parameters
391
+ query_params = {}
392
+
393
+ # header parameters
394
+ header_params = {}
395
+ # HTTP header 'Accept' (if needed)
396
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
397
+ # HTTP header 'Content-Type'
398
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
399
+
400
+ # form parameters
401
+ form_params = {}
402
+
403
+ # http body (model)
404
+ post_body = @api_client.object_to_http_body(ip)
405
+ auth_names = ['api-key', 'partner-key']
406
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
407
+ :header_params => header_params,
408
+ :query_params => query_params,
409
+ :form_params => form_params,
410
+ :body => post_body,
411
+ :auth_names => auth_names)
412
+ if @api_client.config.debugging
413
+ @api_client.config.logger.debug "API called: ResellerApi#dissociate_ip_from_child\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
414
+ end
415
+ return data, status_code, headers
416
+ end
417
+ # Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
418
+ # @param child_identifier Either auth key or id of reseller&#39;s child
419
+ # @param [Hash] opts the optional parameters
420
+ # @return [GetChildAccountCreationStatus]
421
+ def get_child_account_creation_status(child_identifier, opts = {})
422
+ data, _status_code, _headers = get_child_account_creation_status_with_http_info(child_identifier, opts)
423
+ data
424
+ end
425
+
426
+ # Get the status of a reseller&#39;s child account creation, whether it is successfully created (exists) or not based on the identifier supplied
427
+ # @param child_identifier Either auth key or id of reseller&#39;s child
428
+ # @param [Hash] opts the optional parameters
429
+ # @return [Array<(GetChildAccountCreationStatus, Fixnum, Hash)>] GetChildAccountCreationStatus data, response status code and response headers
430
+ def get_child_account_creation_status_with_http_info(child_identifier, opts = {})
431
+ if @api_client.config.debugging
432
+ @api_client.config.logger.debug 'Calling API: ResellerApi.get_child_account_creation_status ...'
433
+ end
434
+ # verify the required parameter 'child_identifier' is set
435
+ if @api_client.config.client_side_validation && child_identifier.nil?
436
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.get_child_account_creation_status"
437
+ end
438
+ # resource path
439
+ local_var_path = '/reseller/children/{childIdentifier}/accountCreationStatus'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
440
+
441
+ # query parameters
442
+ query_params = {}
443
+
444
+ # header parameters
445
+ header_params = {}
446
+ # HTTP header 'Accept' (if needed)
447
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
448
+ # HTTP header 'Content-Type'
449
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
450
+
451
+ # form parameters
452
+ form_params = {}
453
+
454
+ # http body (model)
455
+ post_body = nil
456
+ auth_names = ['api-key', 'partner-key']
457
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
458
+ :header_params => header_params,
459
+ :query_params => query_params,
460
+ :form_params => form_params,
461
+ :body => post_body,
462
+ :auth_names => auth_names,
463
+ :return_type => 'GetChildAccountCreationStatus')
464
+ if @api_client.config.debugging
465
+ @api_client.config.logger.debug "API called: ResellerApi#get_child_account_creation_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
466
+ end
467
+ return data, status_code, headers
468
+ end
469
+ # Get all sender domains for a specific child account
470
+ # @param child_identifier Either auth key or id of reseller&#39;s child
471
+ # @param [Hash] opts the optional parameters
472
+ # @return [GetChildDomains]
473
+ def get_child_domains(child_identifier, opts = {})
474
+ data, _status_code, _headers = get_child_domains_with_http_info(child_identifier, opts)
475
+ data
476
+ end
477
+
478
+ # Get all sender domains for a specific child account
479
+ # @param child_identifier Either auth key or id of reseller&#39;s child
480
+ # @param [Hash] opts the optional parameters
481
+ # @return [Array<(GetChildDomains, Fixnum, Hash)>] GetChildDomains data, response status code and response headers
482
+ def get_child_domains_with_http_info(child_identifier, opts = {})
483
+ if @api_client.config.debugging
484
+ @api_client.config.logger.debug 'Calling API: ResellerApi.get_child_domains ...'
485
+ end
486
+ # verify the required parameter 'child_identifier' is set
487
+ if @api_client.config.client_side_validation && child_identifier.nil?
488
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.get_child_domains"
489
+ end
490
+ # resource path
491
+ local_var_path = '/reseller/children/{childIdentifier}/domains'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
492
+
493
+ # query parameters
494
+ query_params = {}
495
+
496
+ # header parameters
497
+ header_params = {}
498
+ # HTTP header 'Accept' (if needed)
499
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
500
+ # HTTP header 'Content-Type'
501
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
502
+
503
+ # form parameters
504
+ form_params = {}
505
+
506
+ # http body (model)
507
+ post_body = nil
508
+ auth_names = ['api-key', 'partner-key']
509
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
510
+ :header_params => header_params,
511
+ :query_params => query_params,
512
+ :form_params => form_params,
513
+ :body => post_body,
514
+ :auth_names => auth_names,
515
+ :return_type => 'GetChildDomains')
516
+ if @api_client.config.debugging
517
+ @api_client.config.logger.debug "API called: ResellerApi#get_child_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
518
+ end
519
+ return data, status_code, headers
520
+ end
521
+ # Get a child account's details
522
+ # @param child_identifier Either auth key or id of reseller&#39;s child
523
+ # @param [Hash] opts the optional parameters
524
+ # @return [GetChildInfo]
525
+ def get_child_info(child_identifier, opts = {})
526
+ data, _status_code, _headers = get_child_info_with_http_info(child_identifier, opts)
527
+ data
528
+ end
529
+
530
+ # Get a child account&#39;s details
531
+ # @param child_identifier Either auth key or id of reseller&#39;s child
532
+ # @param [Hash] opts the optional parameters
533
+ # @return [Array<(GetChildInfo, Fixnum, Hash)>] GetChildInfo data, response status code and response headers
534
+ def get_child_info_with_http_info(child_identifier, opts = {})
535
+ if @api_client.config.debugging
536
+ @api_client.config.logger.debug 'Calling API: ResellerApi.get_child_info ...'
537
+ end
538
+ # verify the required parameter 'child_identifier' is set
539
+ if @api_client.config.client_side_validation && child_identifier.nil?
540
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.get_child_info"
541
+ end
542
+ # resource path
543
+ local_var_path = '/reseller/children/{childIdentifier}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
544
+
545
+ # query parameters
546
+ query_params = {}
547
+
548
+ # header parameters
549
+ header_params = {}
550
+ # HTTP header 'Accept' (if needed)
551
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
552
+ # HTTP header 'Content-Type'
553
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
554
+
555
+ # form parameters
556
+ form_params = {}
557
+
558
+ # http body (model)
559
+ post_body = nil
560
+ auth_names = ['api-key', 'partner-key']
561
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
562
+ :header_params => header_params,
563
+ :query_params => query_params,
564
+ :form_params => form_params,
565
+ :body => post_body,
566
+ :auth_names => auth_names,
567
+ :return_type => 'GetChildInfo')
568
+ if @api_client.config.debugging
569
+ @api_client.config.logger.debug "API called: ResellerApi#get_child_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
570
+ end
571
+ return data, status_code, headers
572
+ end
573
+ # Get the list of all children accounts
574
+ # @param [Hash] opts the optional parameters
575
+ # @option opts [Integer] :limit Number of documents for child accounts information per page (default to 10)
576
+ # @option opts [Integer] :offset Index of the first document in the page (default to 0)
577
+ # @return [GetChildrenList]
578
+ def get_reseller_childs(opts = {})
579
+ data, _status_code, _headers = get_reseller_childs_with_http_info(opts)
580
+ data
581
+ end
582
+
583
+ # Get the list of all children accounts
584
+ # @param [Hash] opts the optional parameters
585
+ # @option opts [Integer] :limit Number of documents for child accounts information per page
586
+ # @option opts [Integer] :offset Index of the first document in the page
587
+ # @return [Array<(GetChildrenList, Fixnum, Hash)>] GetChildrenList data, response status code and response headers
588
+ def get_reseller_childs_with_http_info(opts = {})
589
+ if @api_client.config.debugging
590
+ @api_client.config.logger.debug 'Calling API: ResellerApi.get_reseller_childs ...'
591
+ end
592
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 20
593
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ResellerApi.get_reseller_childs, must be smaller than or equal to 20.'
594
+ end
595
+
596
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
597
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ResellerApi.get_reseller_childs, must be greater than or equal to 0.'
598
+ end
599
+
600
+ # resource path
601
+ local_var_path = '/reseller/children'
602
+
603
+ # query parameters
604
+ query_params = {}
605
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
606
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
607
+
608
+ # header parameters
609
+ header_params = {}
610
+ # HTTP header 'Accept' (if needed)
611
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
612
+ # HTTP header 'Content-Type'
613
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
614
+
615
+ # form parameters
616
+ form_params = {}
617
+
618
+ # http body (model)
619
+ post_body = nil
620
+ auth_names = ['api-key', 'partner-key']
621
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
622
+ :header_params => header_params,
623
+ :query_params => query_params,
624
+ :form_params => form_params,
625
+ :body => post_body,
626
+ :auth_names => auth_names,
627
+ :return_type => 'GetChildrenList')
628
+ if @api_client.config.debugging
629
+ @api_client.config.logger.debug "API called: ResellerApi#get_reseller_childs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
630
+ end
631
+ return data, status_code, headers
632
+ end
633
+ # Get session token to access Brevo (SSO)
634
+ # It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
635
+ # @param child_identifier Either auth key or id of reseller&#39;s child
636
+ # @param [Hash] opts the optional parameters
637
+ # @return [GetSsoToken]
638
+ def get_sso_token(child_identifier, opts = {})
639
+ data, _status_code, _headers = get_sso_token_with_http_info(child_identifier, opts)
640
+ data
641
+ end
642
+
643
+ # Get session token to access Brevo (SSO)
644
+ # It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern &#x3D;&gt; https:/email.mydomain.com/login/sso?token&#x3D;[token]
645
+ # @param child_identifier Either auth key or id of reseller&#39;s child
646
+ # @param [Hash] opts the optional parameters
647
+ # @return [Array<(GetSsoToken, Fixnum, Hash)>] GetSsoToken data, response status code and response headers
648
+ def get_sso_token_with_http_info(child_identifier, opts = {})
649
+ if @api_client.config.debugging
650
+ @api_client.config.logger.debug 'Calling API: ResellerApi.get_sso_token ...'
651
+ end
652
+ # verify the required parameter 'child_identifier' is set
653
+ if @api_client.config.client_side_validation && child_identifier.nil?
654
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.get_sso_token"
655
+ end
656
+ # resource path
657
+ local_var_path = '/reseller/children/{childIdentifier}/auth'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
658
+
659
+ # query parameters
660
+ query_params = {}
661
+
662
+ # header parameters
663
+ header_params = {}
664
+ # HTTP header 'Accept' (if needed)
665
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
666
+ # HTTP header 'Content-Type'
667
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
668
+
669
+ # form parameters
670
+ form_params = {}
671
+
672
+ # http body (model)
673
+ post_body = nil
674
+ auth_names = ['api-key', 'partner-key']
675
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
676
+ :header_params => header_params,
677
+ :query_params => query_params,
678
+ :form_params => form_params,
679
+ :body => post_body,
680
+ :auth_names => auth_names,
681
+ :return_type => 'GetSsoToken')
682
+ if @api_client.config.debugging
683
+ @api_client.config.logger.debug "API called: ResellerApi#get_sso_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
684
+ end
685
+ return data, status_code, headers
686
+ end
687
+ # Remove Email and/or SMS credits from a specific child account
688
+ # @param child_identifier Either auth key or id of reseller&#39;s child
689
+ # @param remove_credits Values to post to remove email or SMS credits from a specific child account
690
+ # @param [Hash] opts the optional parameters
691
+ # @return [RemainingCreditModel]
692
+ def remove_credits(child_identifier, remove_credits, opts = {})
693
+ data, _status_code, _headers = remove_credits_with_http_info(child_identifier, remove_credits, opts)
694
+ data
695
+ end
696
+
697
+ # Remove Email and/or SMS credits from a specific child account
698
+ # @param child_identifier Either auth key or id of reseller&#39;s child
699
+ # @param remove_credits Values to post to remove email or SMS credits from a specific child account
700
+ # @param [Hash] opts the optional parameters
701
+ # @return [Array<(RemainingCreditModel, Fixnum, Hash)>] RemainingCreditModel data, response status code and response headers
702
+ def remove_credits_with_http_info(child_identifier, remove_credits, opts = {})
703
+ if @api_client.config.debugging
704
+ @api_client.config.logger.debug 'Calling API: ResellerApi.remove_credits ...'
705
+ end
706
+ # verify the required parameter 'child_identifier' is set
707
+ if @api_client.config.client_side_validation && child_identifier.nil?
708
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.remove_credits"
709
+ end
710
+ # verify the required parameter 'remove_credits' is set
711
+ if @api_client.config.client_side_validation && remove_credits.nil?
712
+ fail ArgumentError, "Missing the required parameter 'remove_credits' when calling ResellerApi.remove_credits"
713
+ end
714
+ # resource path
715
+ local_var_path = '/reseller/children/{childIdentifier}/credits/remove'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
716
+
717
+ # query parameters
718
+ query_params = {}
719
+
720
+ # header parameters
721
+ header_params = {}
722
+ # HTTP header 'Accept' (if needed)
723
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
724
+ # HTTP header 'Content-Type'
725
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
726
+
727
+ # form parameters
728
+ form_params = {}
729
+
730
+ # http body (model)
731
+ post_body = @api_client.object_to_http_body(remove_credits)
732
+ auth_names = ['api-key', 'partner-key']
733
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
734
+ :header_params => header_params,
735
+ :query_params => query_params,
736
+ :form_params => form_params,
737
+ :body => post_body,
738
+ :auth_names => auth_names,
739
+ :return_type => 'RemainingCreditModel')
740
+ if @api_client.config.debugging
741
+ @api_client.config.logger.debug "API called: ResellerApi#remove_credits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
742
+ end
743
+ return data, status_code, headers
744
+ end
745
+ # Update info of reseller's child account status based on the childIdentifier supplied
746
+ # @param child_identifier Either auth key or id of reseller&#39;s child
747
+ # @param update_child_account_status values to update in child account status
748
+ # @param [Hash] opts the optional parameters
749
+ # @return [nil]
750
+ def update_child_account_status(child_identifier, update_child_account_status, opts = {})
751
+ update_child_account_status_with_http_info(child_identifier, update_child_account_status, opts)
752
+ nil
753
+ end
754
+
755
+ # Update info of reseller&#39;s child account status based on the childIdentifier supplied
756
+ # @param child_identifier Either auth key or id of reseller&#39;s child
757
+ # @param update_child_account_status values to update in child account status
758
+ # @param [Hash] opts the optional parameters
759
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
760
+ def update_child_account_status_with_http_info(child_identifier, update_child_account_status, opts = {})
761
+ if @api_client.config.debugging
762
+ @api_client.config.logger.debug 'Calling API: ResellerApi.update_child_account_status ...'
763
+ end
764
+ # verify the required parameter 'child_identifier' is set
765
+ if @api_client.config.client_side_validation && child_identifier.nil?
766
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.update_child_account_status"
767
+ end
768
+ # verify the required parameter 'update_child_account_status' is set
769
+ if @api_client.config.client_side_validation && update_child_account_status.nil?
770
+ fail ArgumentError, "Missing the required parameter 'update_child_account_status' when calling ResellerApi.update_child_account_status"
771
+ end
772
+ # resource path
773
+ local_var_path = '/reseller/children/{childIdentifier}/accountStatus'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
774
+
775
+ # query parameters
776
+ query_params = {}
777
+
778
+ # header parameters
779
+ header_params = {}
780
+ # HTTP header 'Accept' (if needed)
781
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
782
+ # HTTP header 'Content-Type'
783
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
784
+
785
+ # form parameters
786
+ form_params = {}
787
+
788
+ # http body (model)
789
+ post_body = @api_client.object_to_http_body(update_child_account_status)
790
+ auth_names = ['api-key', 'partner-key']
791
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
792
+ :header_params => header_params,
793
+ :query_params => query_params,
794
+ :form_params => form_params,
795
+ :body => post_body,
796
+ :auth_names => auth_names)
797
+ if @api_client.config.debugging
798
+ @api_client.config.logger.debug "API called: ResellerApi#update_child_account_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
799
+ end
800
+ return data, status_code, headers
801
+ end
802
+ # Update the sender domain of reseller's child based on the childIdentifier and domainName passed
803
+ # @param child_identifier Either auth key or id of reseller&#39;s child
804
+ # @param domain_name Pass the existing domain that needs to be updated
805
+ # @param update_child_domain value to update for sender domain
806
+ # @param [Hash] opts the optional parameters
807
+ # @return [nil]
808
+ def update_child_domain(child_identifier, domain_name, update_child_domain, opts = {})
809
+ update_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, opts)
810
+ nil
811
+ end
812
+
813
+ # Update the sender domain of reseller&#39;s child based on the childIdentifier and domainName passed
814
+ # @param child_identifier Either auth key or id of reseller&#39;s child
815
+ # @param domain_name Pass the existing domain that needs to be updated
816
+ # @param update_child_domain value to update for sender domain
817
+ # @param [Hash] opts the optional parameters
818
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
819
+ def update_child_domain_with_http_info(child_identifier, domain_name, update_child_domain, opts = {})
820
+ if @api_client.config.debugging
821
+ @api_client.config.logger.debug 'Calling API: ResellerApi.update_child_domain ...'
822
+ end
823
+ # verify the required parameter 'child_identifier' is set
824
+ if @api_client.config.client_side_validation && child_identifier.nil?
825
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.update_child_domain"
826
+ end
827
+ # verify the required parameter 'domain_name' is set
828
+ if @api_client.config.client_side_validation && domain_name.nil?
829
+ fail ArgumentError, "Missing the required parameter 'domain_name' when calling ResellerApi.update_child_domain"
830
+ end
831
+ # verify the required parameter 'update_child_domain' is set
832
+ if @api_client.config.client_side_validation && update_child_domain.nil?
833
+ fail ArgumentError, "Missing the required parameter 'update_child_domain' when calling ResellerApi.update_child_domain"
834
+ end
835
+ # resource path
836
+ local_var_path = '/reseller/children/{childIdentifier}/domains/{domainName}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s).sub('{' + 'domainName' + '}', domain_name.to_s)
837
+
838
+ # query parameters
839
+ query_params = {}
840
+
841
+ # header parameters
842
+ header_params = {}
843
+ # HTTP header 'Accept' (if needed)
844
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
845
+ # HTTP header 'Content-Type'
846
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
847
+
848
+ # form parameters
849
+ form_params = {}
850
+
851
+ # http body (model)
852
+ post_body = @api_client.object_to_http_body(update_child_domain)
853
+ auth_names = ['api-key', 'partner-key']
854
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
855
+ :header_params => header_params,
856
+ :query_params => query_params,
857
+ :form_params => form_params,
858
+ :body => post_body,
859
+ :auth_names => auth_names)
860
+ if @api_client.config.debugging
861
+ @api_client.config.logger.debug "API called: ResellerApi#update_child_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
862
+ end
863
+ return data, status_code, headers
864
+ end
865
+ # Update info of reseller's child based on the child identifier supplied
866
+ # @param child_identifier Either auth key or id of reseller&#39;s child
867
+ # @param reseller_child values to update in child profile
868
+ # @param [Hash] opts the optional parameters
869
+ # @return [nil]
870
+ def update_reseller_child(child_identifier, reseller_child, opts = {})
871
+ update_reseller_child_with_http_info(child_identifier, reseller_child, opts)
872
+ nil
873
+ end
874
+
875
+ # Update info of reseller&#39;s child based on the child identifier supplied
876
+ # @param child_identifier Either auth key or id of reseller&#39;s child
877
+ # @param reseller_child values to update in child profile
878
+ # @param [Hash] opts the optional parameters
879
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
880
+ def update_reseller_child_with_http_info(child_identifier, reseller_child, opts = {})
881
+ if @api_client.config.debugging
882
+ @api_client.config.logger.debug 'Calling API: ResellerApi.update_reseller_child ...'
883
+ end
884
+ # verify the required parameter 'child_identifier' is set
885
+ if @api_client.config.client_side_validation && child_identifier.nil?
886
+ fail ArgumentError, "Missing the required parameter 'child_identifier' when calling ResellerApi.update_reseller_child"
887
+ end
888
+ # verify the required parameter 'reseller_child' is set
889
+ if @api_client.config.client_side_validation && reseller_child.nil?
890
+ fail ArgumentError, "Missing the required parameter 'reseller_child' when calling ResellerApi.update_reseller_child"
891
+ end
892
+ # resource path
893
+ local_var_path = '/reseller/children/{childIdentifier}'.sub('{' + 'childIdentifier' + '}', child_identifier.to_s)
894
+
895
+ # query parameters
896
+ query_params = {}
897
+
898
+ # header parameters
899
+ header_params = {}
900
+ # HTTP header 'Accept' (if needed)
901
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
902
+ # HTTP header 'Content-Type'
903
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
904
+
905
+ # form parameters
906
+ form_params = {}
907
+
908
+ # http body (model)
909
+ post_body = @api_client.object_to_http_body(reseller_child)
910
+ auth_names = ['api-key', 'partner-key']
911
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
912
+ :header_params => header_params,
913
+ :query_params => query_params,
914
+ :form_params => form_params,
915
+ :body => post_body,
916
+ :auth_names => auth_names)
917
+ if @api_client.config.debugging
918
+ @api_client.config.logger.debug "API called: ResellerApi#update_reseller_child\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
919
+ end
920
+ return data, status_code, headers
921
+ end
922
+ end
923
+ end