brevo-ruby 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1077) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/LICENSE.md +21 -0
  4. data/README.md +651 -0
  5. data/Rakefile +8 -0
  6. data/brevo-ruby.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 +37 -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 +536 -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 +799 -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 +20 -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 +38 -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 +36 -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 +549 -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/RequestContactImportNewList.md +9 -0
  287. data/docs/RequestSMSRecipientExport.md +9 -0
  288. data/docs/ResellerApi.md +964 -0
  289. data/docs/SMSCampaignsApi.md +613 -0
  290. data/docs/ScheduleSmtpEmail.md +10 -0
  291. data/docs/SendReport.md +9 -0
  292. data/docs/SendReportEmail.md +9 -0
  293. data/docs/SendSms.md +12 -0
  294. data/docs/SendSmtpEmail.md +23 -0
  295. data/docs/SendSmtpEmailAttachment.md +10 -0
  296. data/docs/SendSmtpEmailBcc.md +9 -0
  297. data/docs/SendSmtpEmailCc.md +9 -0
  298. data/docs/SendSmtpEmailMessageVersions.md +13 -0
  299. data/docs/SendSmtpEmailReplyTo.md +9 -0
  300. data/docs/SendSmtpEmailReplyTo1.md +9 -0
  301. data/docs/SendSmtpEmailSender.md +10 -0
  302. data/docs/SendSmtpEmailTo.md +9 -0
  303. data/docs/SendSmtpEmailTo1.md +9 -0
  304. data/docs/SendTestEmail.md +8 -0
  305. data/docs/SendTestSms.md +8 -0
  306. data/docs/SendTransacSms.md +15 -0
  307. data/docs/SendWhatsappMessage.md +11 -0
  308. data/docs/SendersApi.md +417 -0
  309. data/docs/SsoTokenRequest.md +10 -0
  310. data/docs/SubAccountDetailsResponse.md +11 -0
  311. data/docs/SubAccountDetailsResponsePlanInfo.md +10 -0
  312. data/docs/SubAccountDetailsResponsePlanInfoCredits.md +9 -0
  313. data/docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md +9 -0
  314. data/docs/SubAccountDetailsResponsePlanInfoFeatures.md +10 -0
  315. data/docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md +9 -0
  316. data/docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md +9 -0
  317. data/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +9 -0
  318. data/docs/SubAccountUpdatePlanRequest.md +9 -0
  319. data/docs/SubAccountUpdatePlanRequestCredits.md +8 -0
  320. data/docs/SubAccountUpdatePlanRequestFeatures.md +10 -0
  321. data/docs/SubAccountsResponse.md +9 -0
  322. data/docs/SubAccountsResponseSubAccounts.md +11 -0
  323. data/docs/Task.md +13 -0
  324. data/docs/TaskList.md +8 -0
  325. data/docs/TaskReminder.md +10 -0
  326. data/docs/TaskTypes.md +9 -0
  327. data/docs/TasksApi.md +376 -0
  328. data/docs/TransactionalEmailsApi.md +1390 -0
  329. data/docs/TransactionalSMSApi.md +273 -0
  330. data/docs/TransactionalWhatsAppApi.md +143 -0
  331. data/docs/UpdateAttribute.md +9 -0
  332. data/docs/UpdateAttributeEnumeration.md +9 -0
  333. data/docs/UpdateBatchContacts.md +8 -0
  334. data/docs/UpdateBatchContactsContacts.md +17 -0
  335. data/docs/UpdateBatchContactsModel.md +9 -0
  336. data/docs/UpdateCampaignStatus.md +8 -0
  337. data/docs/UpdateChild.md +12 -0
  338. data/docs/UpdateChildAccountStatus.md +11 -0
  339. data/docs/UpdateChildDomain.md +8 -0
  340. data/docs/UpdateContact.md +14 -0
  341. data/docs/UpdateCouponCollection.md +8 -0
  342. data/docs/UpdateEmailCampaign.md +37 -0
  343. data/docs/UpdateEmailCampaignRecipients.md +10 -0
  344. data/docs/UpdateEmailCampaignSender.md +10 -0
  345. data/docs/UpdateExternalFeed.md +16 -0
  346. data/docs/UpdateList.md +9 -0
  347. data/docs/UpdateSender.md +10 -0
  348. data/docs/UpdateSmsCampaign.md +15 -0
  349. data/docs/UpdateSmtpTemplate.md +17 -0
  350. data/docs/UpdateSmtpTemplateSender.md +10 -0
  351. data/docs/UpdateWebhook.md +11 -0
  352. data/docs/UpdateWhatsAppCampaign.md +11 -0
  353. data/docs/UploadImageModel.md +8 -0
  354. data/docs/UploadImageToGallery.md +9 -0
  355. data/docs/UserApi.md +118 -0
  356. data/docs/VariablesItems.md +10 -0
  357. data/docs/WebhooksApi.md +362 -0
  358. data/docs/WhatsAppCampaignsApi.md +543 -0
  359. data/docs/WhatsappCampStats.md +12 -0
  360. data/docs/WhatsappCampTemplate.md +18 -0
  361. data/lib/brevo-ruby/api/account_api.rb +145 -0
  362. data/lib/brevo-ruby/api/companies_api.rb +419 -0
  363. data/lib/brevo-ruby/api/contacts_api.rb +1735 -0
  364. data/lib/brevo-ruby/api/conversations_api.rb +514 -0
  365. data/lib/brevo-ruby/api/coupons_api.rb +316 -0
  366. data/lib/brevo-ruby/api/deals_api.rb +518 -0
  367. data/lib/brevo-ruby/api/domains_api.rb +282 -0
  368. data/lib/brevo-ruby/api/ecommerce_api.rb +655 -0
  369. data/lib/brevo-ruby/api/email_campaigns_api.rb +782 -0
  370. data/lib/brevo-ruby/api/external_feeds_api.rb +336 -0
  371. data/lib/brevo-ruby/api/files_api.rb +323 -0
  372. data/lib/brevo-ruby/api/inbound_parsing_api.rb +218 -0
  373. data/lib/brevo-ruby/api/master_account_api.rb +535 -0
  374. data/lib/brevo-ruby/api/notes_api.rb +318 -0
  375. data/lib/brevo-ruby/api/process_api.rb +151 -0
  376. data/lib/brevo-ruby/api/reseller_api.rb +923 -0
  377. data/lib/brevo-ruby/api/senders_api.rb +388 -0
  378. data/lib/brevo-ruby/api/sms_campaigns_api.rb +603 -0
  379. data/lib/brevo-ruby/api/tasks_api.rb +385 -0
  380. data/lib/brevo-ruby/api/transactional_emails_api.rb +1370 -0
  381. data/lib/brevo-ruby/api/transactional_sms_api.rb +290 -0
  382. data/lib/brevo-ruby/api/transactional_whats_app_api.rb +173 -0
  383. data/lib/brevo-ruby/api/user_api.rb +131 -0
  384. data/lib/brevo-ruby/api/webhooks_api.rb +357 -0
  385. data/lib/brevo-ruby/api/whats_app_campaigns_api.rb +534 -0
  386. data/lib/brevo-ruby/api_client.rb +392 -0
  387. data/lib/brevo-ruby/api_error.rb +38 -0
  388. data/lib/brevo-ruby/configuration.rb +216 -0
  389. data/lib/brevo-ruby/models/ab_test_campaign_result.rb +299 -0
  390. data/lib/brevo-ruby/models/ab_test_campaign_result_clicked_links.rb +203 -0
  391. data/lib/brevo-ruby/models/ab_test_campaign_result_statistics.rb +259 -0
  392. data/lib/brevo-ruby/models/ab_test_version_clicks.rb +176 -0
  393. data/lib/brevo-ruby/models/ab_test_version_clicks_inner.rb +220 -0
  394. data/lib/brevo-ruby/models/ab_test_version_stats.rb +206 -0
  395. data/lib/brevo-ruby/models/add_child_domain.rb +185 -0
  396. data/lib/brevo-ruby/models/add_contact_to_list.rb +199 -0
  397. data/lib/brevo-ruby/models/add_credits.rb +195 -0
  398. data/lib/brevo-ruby/models/authenticate_domain_model.rb +205 -0
  399. data/lib/brevo-ruby/models/block_domain.rb +190 -0
  400. data/lib/brevo-ruby/models/body.rb +210 -0
  401. data/lib/brevo-ruby/models/body_1.rb +205 -0
  402. data/lib/brevo-ruby/models/body_10.rb +225 -0
  403. data/lib/brevo-ruby/models/body_11.rb +190 -0
  404. data/lib/brevo-ruby/models/body_12.rb +215 -0
  405. data/lib/brevo-ruby/models/body_2.rb +223 -0
  406. data/lib/brevo-ruby/models/body_3.rb +200 -0
  407. data/lib/brevo-ruby/models/body_4.rb +195 -0
  408. data/lib/brevo-ruby/models/body_5.rb +223 -0
  409. data/lib/brevo-ruby/models/body_6.rb +320 -0
  410. data/lib/brevo-ruby/models/body_7.rb +281 -0
  411. data/lib/brevo-ruby/models/body_8.rb +245 -0
  412. data/lib/brevo-ruby/models/body_9.rb +190 -0
  413. data/lib/brevo-ruby/models/body_variables_items.rb +175 -0
  414. data/lib/brevo-ruby/models/companies_list.rb +188 -0
  415. data/lib/brevo-ruby/models/company.rb +220 -0
  416. data/lib/brevo-ruby/models/company_attributes.rb +176 -0
  417. data/lib/brevo-ruby/models/company_attributes_inner.rb +223 -0
  418. data/lib/brevo-ruby/models/component_items.rb +193 -0
  419. data/lib/brevo-ruby/models/conversations_message.rb +324 -0
  420. data/lib/brevo-ruby/models/conversations_message_file.rb +239 -0
  421. data/lib/brevo-ruby/models/conversations_message_file_image_info.rb +236 -0
  422. data/lib/brevo-ruby/models/create_api_key_request.rb +200 -0
  423. data/lib/brevo-ruby/models/create_api_key_response.rb +195 -0
  424. data/lib/brevo-ruby/models/create_attribute.rb +251 -0
  425. data/lib/brevo-ruby/models/create_attribute_enumeration.rb +205 -0
  426. data/lib/brevo-ruby/models/create_category_model.rb +185 -0
  427. data/lib/brevo-ruby/models/create_child.rb +294 -0
  428. data/lib/brevo-ruby/models/create_contact.rb +261 -0
  429. data/lib/brevo-ruby/models/create_coupon_collection.rb +205 -0
  430. data/lib/brevo-ruby/models/create_coupons.rb +206 -0
  431. data/lib/brevo-ruby/models/create_doi_contact.rb +259 -0
  432. data/lib/brevo-ruby/models/create_domain.rb +190 -0
  433. data/lib/brevo-ruby/models/create_domain_model.rb +219 -0
  434. data/lib/brevo-ruby/models/create_domain_model_dns_records.rb +193 -0
  435. data/lib/brevo-ruby/models/create_domain_model_dns_records_dkim_record.rb +211 -0
  436. data/lib/brevo-ruby/models/create_email_campaign.rb +597 -0
  437. data/lib/brevo-ruby/models/create_email_campaign_recipients.rb +212 -0
  438. data/lib/brevo-ruby/models/create_email_campaign_sender.rb +211 -0
  439. data/lib/brevo-ruby/models/create_external_feed.rb +339 -0
  440. data/lib/brevo-ruby/models/create_list.rb +205 -0
  441. data/lib/brevo-ruby/models/create_model.rb +190 -0
  442. data/lib/brevo-ruby/models/create_product_model.rb +185 -0
  443. data/lib/brevo-ruby/models/create_reseller.rb +200 -0
  444. data/lib/brevo-ruby/models/create_sender.rb +217 -0
  445. data/lib/brevo-ruby/models/create_sender_ips.rb +239 -0
  446. data/lib/brevo-ruby/models/create_sender_model.rb +210 -0
  447. data/lib/brevo-ruby/models/create_sms_campaign.rb +290 -0
  448. data/lib/brevo-ruby/models/create_sms_campaign_recipients.rb +204 -0
  449. data/lib/brevo-ruby/models/create_smtp_email.rb +196 -0
  450. data/lib/brevo-ruby/models/create_smtp_template.rb +289 -0
  451. data/lib/brevo-ruby/models/create_smtp_template_sender.rb +206 -0
  452. data/lib/brevo-ruby/models/create_sub_account.rb +259 -0
  453. data/lib/brevo-ruby/models/create_sub_account_response.rb +190 -0
  454. data/lib/brevo-ruby/models/create_update_batch_category.rb +202 -0
  455. data/lib/brevo-ruby/models/create_update_batch_category_model.rb +195 -0
  456. data/lib/brevo-ruby/models/create_update_batch_products.rb +202 -0
  457. data/lib/brevo-ruby/models/create_update_batch_products_model.rb +195 -0
  458. data/lib/brevo-ruby/models/create_update_categories.rb +220 -0
  459. data/lib/brevo-ruby/models/create_update_category.rb +232 -0
  460. data/lib/brevo-ruby/models/create_update_contact_model.rb +185 -0
  461. data/lib/brevo-ruby/models/create_update_folder.rb +185 -0
  462. data/lib/brevo-ruby/models/create_update_product.rb +301 -0
  463. data/lib/brevo-ruby/models/create_update_products.rb +289 -0
  464. data/lib/brevo-ruby/models/create_webhook.rb +273 -0
  465. data/lib/brevo-ruby/models/create_whats_app_campaign.rb +234 -0
  466. data/lib/brevo-ruby/models/create_whats_app_campaign_recipients.rb +212 -0
  467. data/lib/brevo-ruby/models/create_whats_app_template.rb +289 -0
  468. data/lib/brevo-ruby/models/created_batch_id.rb +190 -0
  469. data/lib/brevo-ruby/models/created_process_id.rb +190 -0
  470. data/lib/brevo-ruby/models/deal.rb +220 -0
  471. data/lib/brevo-ruby/models/deal_attributes.rb +176 -0
  472. data/lib/brevo-ruby/models/deal_attributes_inner.rb +223 -0
  473. data/lib/brevo-ruby/models/deals_list.rb +188 -0
  474. data/lib/brevo-ruby/models/delete_hardbounces.rb +205 -0
  475. data/lib/brevo-ruby/models/email_export_recipients.rb +234 -0
  476. data/lib/brevo-ruby/models/error_model.rb +239 -0
  477. data/lib/brevo-ruby/models/export_webhooks_history.rb +309 -0
  478. data/lib/brevo-ruby/models/file_data.rb +246 -0
  479. data/lib/brevo-ruby/models/file_downloadable_link.rb +190 -0
  480. data/lib/brevo-ruby/models/file_list.rb +176 -0
  481. data/lib/brevo-ruby/models/get_account.rb +289 -0
  482. data/lib/brevo-ruby/models/get_account_activity.rb +187 -0
  483. data/lib/brevo-ruby/models/get_account_activity_logs.rb +250 -0
  484. data/lib/brevo-ruby/models/get_account_marketing_automation.rb +200 -0
  485. data/lib/brevo-ruby/models/get_account_plan.rb +296 -0
  486. data/lib/brevo-ruby/models/get_account_relay.rb +205 -0
  487. data/lib/brevo-ruby/models/get_account_relay_data.rb +221 -0
  488. data/lib/brevo-ruby/models/get_aggregated_report.rb +305 -0
  489. data/lib/brevo-ruby/models/get_all_external_feeds.rb +196 -0
  490. data/lib/brevo-ruby/models/get_all_external_feeds_feeds.rb +404 -0
  491. data/lib/brevo-ruby/models/get_attributes.rb +192 -0
  492. data/lib/brevo-ruby/models/get_attributes_attributes.rb +283 -0
  493. data/lib/brevo-ruby/models/get_attributes_enumeration.rb +205 -0
  494. data/lib/brevo-ruby/models/get_blocked_domains.rb +193 -0
  495. data/lib/brevo-ruby/models/get_campaign_overview.rb +371 -0
  496. data/lib/brevo-ruby/models/get_campaign_recipients.rb +207 -0
  497. data/lib/brevo-ruby/models/get_campaign_stats.rb +390 -0
  498. data/lib/brevo-ruby/models/get_categories.rb +206 -0
  499. data/lib/brevo-ruby/models/get_category_details.rb +255 -0
  500. data/lib/brevo-ruby/models/get_child_account_creation_status.rb +190 -0
  501. data/lib/brevo-ruby/models/get_child_domain.rb +195 -0
  502. data/lib/brevo-ruby/models/get_child_domains.rb +175 -0
  503. data/lib/brevo-ruby/models/get_child_info.rb +289 -0
  504. data/lib/brevo-ruby/models/get_child_info_api_keys.rb +203 -0
  505. data/lib/brevo-ruby/models/get_child_info_api_keys_v2.rb +205 -0
  506. data/lib/brevo-ruby/models/get_child_info_api_keys_v3.rb +205 -0
  507. data/lib/brevo-ruby/models/get_child_info_credits.rb +196 -0
  508. data/lib/brevo-ruby/models/get_child_info_statistics.rb +206 -0
  509. data/lib/brevo-ruby/models/get_children_list.rb +197 -0
  510. data/lib/brevo-ruby/models/get_client.rb +235 -0
  511. data/lib/brevo-ruby/models/get_contact_campaign_stats.rb +273 -0
  512. data/lib/brevo-ruby/models/get_contact_campaign_stats_clicked.rb +206 -0
  513. data/lib/brevo-ruby/models/get_contact_campaign_stats_opened.rb +235 -0
  514. data/lib/brevo-ruby/models/get_contact_campaign_stats_transac_attributes.rb +220 -0
  515. data/lib/brevo-ruby/models/get_contact_campaign_stats_unsubscriptions.rb +209 -0
  516. data/lib/brevo-ruby/models/get_contact_details.rb +307 -0
  517. data/lib/brevo-ruby/models/get_contacts.rb +206 -0
  518. data/lib/brevo-ruby/models/get_coupon_collection.rb +265 -0
  519. data/lib/brevo-ruby/models/get_device_browser_stats.rb +235 -0
  520. data/lib/brevo-ruby/models/get_domain_configuration_model.rb +234 -0
  521. data/lib/brevo-ruby/models/get_domains_list.rb +187 -0
  522. data/lib/brevo-ruby/models/get_domains_list_domains.rb +245 -0
  523. data/lib/brevo-ruby/models/get_email_campaign.rb +598 -0
  524. data/lib/brevo-ruby/models/get_email_campaigns.rb +196 -0
  525. data/lib/brevo-ruby/models/get_email_event_report.rb +186 -0
  526. data/lib/brevo-ruby/models/get_email_event_report_events.rb +339 -0
  527. data/lib/brevo-ruby/models/get_extended_campaign_overview.rb +570 -0
  528. data/lib/brevo-ruby/models/get_extended_campaign_overview_sender.rb +205 -0
  529. data/lib/brevo-ruby/models/get_extended_campaign_stats.rb +295 -0
  530. data/lib/brevo-ruby/models/get_extended_campaign_stats_global_stats.rb +176 -0
  531. data/lib/brevo-ruby/models/get_extended_client.rb +249 -0
  532. data/lib/brevo-ruby/models/get_extended_client_address.rb +236 -0
  533. data/lib/brevo-ruby/models/get_extended_contact_details.rb +321 -0
  534. data/lib/brevo-ruby/models/get_extended_contact_details_statistics.rb +281 -0
  535. data/lib/brevo-ruby/models/get_extended_contact_details_statistics_clicked.rb +207 -0
  536. data/lib/brevo-ruby/models/get_extended_contact_details_statistics_delivered.rb +205 -0
  537. data/lib/brevo-ruby/models/get_extended_contact_details_statistics_links.rb +235 -0
  538. data/lib/brevo-ruby/models/get_extended_contact_details_statistics_messages_sent.rb +205 -0
  539. data/lib/brevo-ruby/models/get_extended_contact_details_statistics_opened.rb +235 -0
  540. data/lib/brevo-ruby/models/get_extended_contact_details_statistics_unsubscriptions.rb +210 -0
  541. data/lib/brevo-ruby/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +200 -0
  542. data/lib/brevo-ruby/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +215 -0
  543. data/lib/brevo-ruby/models/get_extended_list.rb +301 -0
  544. data/lib/brevo-ruby/models/get_extended_list_campaign_stats.rb +204 -0
  545. data/lib/brevo-ruby/models/get_external_feed_by_uuid.rb +404 -0
  546. data/lib/brevo-ruby/models/get_external_feed_by_uuid_headers.rb +195 -0
  547. data/lib/brevo-ruby/models/get_folder.rb +250 -0
  548. data/lib/brevo-ruby/models/get_folder_lists.rb +196 -0
  549. data/lib/brevo-ruby/models/get_folders.rb +196 -0
  550. data/lib/brevo-ruby/models/get_inbound_email_events.rb +186 -0
  551. data/lib/brevo-ruby/models/get_inbound_email_events_by_uuid.rb +259 -0
  552. data/lib/brevo-ruby/models/get_inbound_email_events_by_uuid_attachments.rb +215 -0
  553. data/lib/brevo-ruby/models/get_inbound_email_events_by_uuid_logs.rb +229 -0
  554. data/lib/brevo-ruby/models/get_inbound_email_events_events.rb +235 -0
  555. data/lib/brevo-ruby/models/get_invited_users_list.rb +187 -0
  556. data/lib/brevo-ruby/models/get_invited_users_list_feature_access.rb +206 -0
  557. data/lib/brevo-ruby/models/get_invited_users_list_users.rb +234 -0
  558. data/lib/brevo-ruby/models/get_ip.rb +235 -0
  559. data/lib/brevo-ruby/models/get_ip_from_sender.rb +235 -0
  560. data/lib/brevo-ruby/models/get_ips.rb +192 -0
  561. data/lib/brevo-ruby/models/get_ips_from_sender.rb +192 -0
  562. data/lib/brevo-ruby/models/get_list.rb +250 -0
  563. data/lib/brevo-ruby/models/get_lists.rb +197 -0
  564. data/lib/brevo-ruby/models/get_process.rb +264 -0
  565. data/lib/brevo-ruby/models/get_processes.rb +197 -0
  566. data/lib/brevo-ruby/models/get_product_details.rb +357 -0
  567. data/lib/brevo-ruby/models/get_products.rb +206 -0
  568. data/lib/brevo-ruby/models/get_reports.rb +186 -0
  569. data/lib/brevo-ruby/models/get_reports_reports.rb +370 -0
  570. data/lib/brevo-ruby/models/get_scheduled_email_by_batch_id.rb +196 -0
  571. data/lib/brevo-ruby/models/get_scheduled_email_by_batch_id_batches.rb +254 -0
  572. data/lib/brevo-ruby/models/get_scheduled_email_by_message_id.rb +254 -0
  573. data/lib/brevo-ruby/models/get_segments.rb +194 -0
  574. data/lib/brevo-ruby/models/get_segments_segments.rb +215 -0
  575. data/lib/brevo-ruby/models/get_senders_list.rb +187 -0
  576. data/lib/brevo-ruby/models/get_senders_list_ips.rb +220 -0
  577. data/lib/brevo-ruby/models/get_senders_list_senders.rb +247 -0
  578. data/lib/brevo-ruby/models/get_shared_template_url.rb +190 -0
  579. data/lib/brevo-ruby/models/get_sms_campaign.rb +352 -0
  580. data/lib/brevo-ruby/models/get_sms_campaign_overview.rb +324 -0
  581. data/lib/brevo-ruby/models/get_sms_campaign_recipients.rb +175 -0
  582. data/lib/brevo-ruby/models/get_sms_campaign_stats.rb +280 -0
  583. data/lib/brevo-ruby/models/get_sms_campaigns.rb +196 -0
  584. data/lib/brevo-ruby/models/get_sms_event_report.rb +186 -0
  585. data/lib/brevo-ruby/models/get_sms_event_report_events.rb +278 -0
  586. data/lib/brevo-ruby/models/get_smtp_template_overview.rb +364 -0
  587. data/lib/brevo-ruby/models/get_smtp_template_overview_sender.rb +205 -0
  588. data/lib/brevo-ruby/models/get_smtp_templates.rb +196 -0
  589. data/lib/brevo-ruby/models/get_sso_token.rb +190 -0
  590. data/lib/brevo-ruby/models/get_stats_by_browser.rb +175 -0
  591. data/lib/brevo-ruby/models/get_stats_by_device.rb +223 -0
  592. data/lib/brevo-ruby/models/get_stats_by_domain.rb +175 -0
  593. data/lib/brevo-ruby/models/get_transac_aggregated_sms_report.rb +275 -0
  594. data/lib/brevo-ruby/models/get_transac_blocked_contacts.rb +196 -0
  595. data/lib/brevo-ruby/models/get_transac_blocked_contacts_contacts.rb +234 -0
  596. data/lib/brevo-ruby/models/get_transac_blocked_contacts_reason.rb +230 -0
  597. data/lib/brevo-ruby/models/get_transac_email_content.rb +277 -0
  598. data/lib/brevo-ruby/models/get_transac_email_content_events.rb +205 -0
  599. data/lib/brevo-ruby/models/get_transac_emails_list.rb +196 -0
  600. data/lib/brevo-ruby/models/get_transac_emails_list_transactional_emails.rb +282 -0
  601. data/lib/brevo-ruby/models/get_transac_sms_report.rb +186 -0
  602. data/lib/brevo-ruby/models/get_transac_sms_report_reports.rb +275 -0
  603. data/lib/brevo-ruby/models/get_user_permission.rb +223 -0
  604. data/lib/brevo-ruby/models/get_user_permission_privileges.rb +205 -0
  605. data/lib/brevo-ruby/models/get_wa_templates.rb +206 -0
  606. data/lib/brevo-ruby/models/get_wa_templates_templates.rb +290 -0
  607. data/lib/brevo-ruby/models/get_webhook.rb +315 -0
  608. data/lib/brevo-ruby/models/get_webhooks.rb +191 -0
  609. data/lib/brevo-ruby/models/get_whats_app_config.rb +281 -0
  610. data/lib/brevo-ruby/models/get_whatsapp_campaign_overview.rb +332 -0
  611. data/lib/brevo-ruby/models/get_whatsapp_campaigns.rb +196 -0
  612. data/lib/brevo-ruby/models/get_whatsapp_campaigns_campaigns.rb +353 -0
  613. data/lib/brevo-ruby/models/get_whatsapp_event_report.rb +186 -0
  614. data/lib/brevo-ruby/models/get_whatsapp_event_report_events.rb +314 -0
  615. data/lib/brevo-ruby/models/inline_response_200.rb +191 -0
  616. data/lib/brevo-ruby/models/inline_response_200_1.rb +220 -0
  617. data/lib/brevo-ruby/models/inline_response_201.rb +191 -0
  618. data/lib/brevo-ruby/models/inline_response_201_1.rb +191 -0
  619. data/lib/brevo-ruby/models/inline_response_201_2.rb +190 -0
  620. data/lib/brevo-ruby/models/inline_response_201_3.rb +190 -0
  621. data/lib/brevo-ruby/models/inline_response_201_4.rb +190 -0
  622. data/lib/brevo-ruby/models/manage_ip.rb +185 -0
  623. data/lib/brevo-ruby/models/master_details_response.rb +243 -0
  624. data/lib/brevo-ruby/models/master_details_response_billing_info.rb +214 -0
  625. data/lib/brevo-ruby/models/master_details_response_billing_info_address.rb +226 -0
  626. data/lib/brevo-ruby/models/master_details_response_billing_info_name.rb +196 -0
  627. data/lib/brevo-ruby/models/master_details_response_plan_info.rb +272 -0
  628. data/lib/brevo-ruby/models/master_details_response_plan_info_features.rb +225 -0
  629. data/lib/brevo-ruby/models/note.rb +283 -0
  630. data/lib/brevo-ruby/models/note_data.rb +255 -0
  631. data/lib/brevo-ruby/models/note_id.rb +186 -0
  632. data/lib/brevo-ruby/models/note_list.rb +176 -0
  633. data/lib/brevo-ruby/models/order.rb +297 -0
  634. data/lib/brevo-ruby/models/order_batch.rb +202 -0
  635. data/lib/brevo-ruby/models/order_billing.rb +246 -0
  636. data/lib/brevo-ruby/models/order_products.rb +231 -0
  637. data/lib/brevo-ruby/models/otp.rb +185 -0
  638. data/lib/brevo-ruby/models/pipeline.rb +208 -0
  639. data/lib/brevo-ruby/models/pipeline_stage.rb +196 -0
  640. data/lib/brevo-ruby/models/pipelines.rb +176 -0
  641. data/lib/brevo-ruby/models/post_contact_info.rb +189 -0
  642. data/lib/brevo-ruby/models/post_contact_info_contacts.rb +217 -0
  643. data/lib/brevo-ruby/models/post_send_failed.rb +238 -0
  644. data/lib/brevo-ruby/models/post_send_sms_test_failed.rb +227 -0
  645. data/lib/brevo-ruby/models/remaining_credit_model.rb +203 -0
  646. data/lib/brevo-ruby/models/remaining_credit_model_child.rb +206 -0
  647. data/lib/brevo-ruby/models/remaining_credit_model_reseller.rb +205 -0
  648. data/lib/brevo-ruby/models/remove_contact_from_list.rb +209 -0
  649. data/lib/brevo-ruby/models/remove_credits.rb +195 -0
  650. data/lib/brevo-ruby/models/request_contact_export.rb +211 -0
  651. data/lib/brevo-ruby/models/request_contact_export_custom_contact_filter.rb +294 -0
  652. data/lib/brevo-ruby/models/request_contact_import.rb +286 -0
  653. data/lib/brevo-ruby/models/request_contact_import_new_list.rb +196 -0
  654. data/lib/brevo-ruby/models/request_sms_recipient_export.rb +234 -0
  655. data/lib/brevo-ruby/models/schedule_smtp_email.rb +206 -0
  656. data/lib/brevo-ruby/models/send_report.rb +235 -0
  657. data/lib/brevo-ruby/models/send_report_email.rb +208 -0
  658. data/lib/brevo-ruby/models/send_sms.rb +233 -0
  659. data/lib/brevo-ruby/models/send_smtp_email.rb +345 -0
  660. data/lib/brevo-ruby/models/send_smtp_email_attachment.rb +220 -0
  661. data/lib/brevo-ruby/models/send_smtp_email_bcc.rb +200 -0
  662. data/lib/brevo-ruby/models/send_smtp_email_cc.rb +200 -0
  663. data/lib/brevo-ruby/models/send_smtp_email_message_versions.rb +247 -0
  664. data/lib/brevo-ruby/models/send_smtp_email_reply_to.rb +201 -0
  665. data/lib/brevo-ruby/models/send_smtp_email_reply_to_1.rb +201 -0
  666. data/lib/brevo-ruby/models/send_smtp_email_sender.rb +206 -0
  667. data/lib/brevo-ruby/models/send_smtp_email_to.rb +200 -0
  668. data/lib/brevo-ruby/models/send_smtp_email_to_1.rb +200 -0
  669. data/lib/brevo-ruby/models/send_test_email.rb +187 -0
  670. data/lib/brevo-ruby/models/send_test_sms.rb +185 -0
  671. data/lib/brevo-ruby/models/send_transac_sms.rb +327 -0
  672. data/lib/brevo-ruby/models/send_whatsapp_message.rb +227 -0
  673. data/lib/brevo-ruby/models/sso_token_request.rb +244 -0
  674. data/lib/brevo-ruby/models/sub_account_details_response.rb +214 -0
  675. data/lib/brevo-ruby/models/sub_account_details_response_plan_info.rb +204 -0
  676. data/lib/brevo-ruby/models/sub_account_details_response_plan_info_credits.rb +195 -0
  677. data/lib/brevo-ruby/models/sub_account_details_response_plan_info_credits_emails.rb +196 -0
  678. data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features.rb +203 -0
  679. data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features_inbox.rb +196 -0
  680. data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features_landing_page.rb +196 -0
  681. data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features_users.rb +196 -0
  682. data/lib/brevo-ruby/models/sub_account_update_plan_request.rb +194 -0
  683. data/lib/brevo-ruby/models/sub_account_update_plan_request_credits.rb +186 -0
  684. data/lib/brevo-ruby/models/sub_account_update_plan_request_features.rb +206 -0
  685. data/lib/brevo-ruby/models/sub_accounts_response.rb +196 -0
  686. data/lib/brevo-ruby/models/sub_accounts_response_sub_accounts.rb +235 -0
  687. data/lib/brevo-ruby/models/task.rb +252 -0
  688. data/lib/brevo-ruby/models/task_list.rb +188 -0
  689. data/lib/brevo-ruby/models/task_reminder.rb +257 -0
  690. data/lib/brevo-ruby/models/task_types.rb +196 -0
  691. data/lib/brevo-ruby/models/update_attribute.rb +197 -0
  692. data/lib/brevo-ruby/models/update_attribute_enumeration.rb +205 -0
  693. data/lib/brevo-ruby/models/update_batch_contacts.rb +187 -0
  694. data/lib/brevo-ruby/models/update_batch_contacts_contacts.rb +283 -0
  695. data/lib/brevo-ruby/models/update_batch_contacts_model.rb +197 -0
  696. data/lib/brevo-ruby/models/update_campaign_status.rb +220 -0
  697. data/lib/brevo-ruby/models/update_child.rb +225 -0
  698. data/lib/brevo-ruby/models/update_child_account_status.rb +215 -0
  699. data/lib/brevo-ruby/models/update_child_domain.rb +185 -0
  700. data/lib/brevo-ruby/models/update_contact.rb +251 -0
  701. data/lib/brevo-ruby/models/update_coupon_collection.rb +190 -0
  702. data/lib/brevo-ruby/models/update_email_campaign.rb +587 -0
  703. data/lib/brevo-ruby/models/update_email_campaign_recipients.rb +212 -0
  704. data/lib/brevo-ruby/models/update_email_campaign_sender.rb +206 -0
  705. data/lib/brevo-ruby/models/update_external_feed.rb +327 -0
  706. data/lib/brevo-ruby/models/update_list.rb +195 -0
  707. data/lib/brevo-ruby/models/update_sender.rb +207 -0
  708. data/lib/brevo-ruby/models/update_sms_campaign.rb +271 -0
  709. data/lib/brevo-ruby/models/update_smtp_template.rb +274 -0
  710. data/lib/brevo-ruby/models/update_smtp_template_sender.rb +206 -0
  711. data/lib/brevo-ruby/models/update_webhook.rb +239 -0
  712. data/lib/brevo-ruby/models/update_whats_app_campaign.rb +250 -0
  713. data/lib/brevo-ruby/models/upload_image_model.rb +190 -0
  714. data/lib/brevo-ruby/models/upload_image_to_gallery.rb +200 -0
  715. data/lib/brevo-ruby/models/variables_items.rb +202 -0
  716. data/lib/brevo-ruby/models/whatsapp_camp_stats.rb +245 -0
  717. data/lib/brevo-ruby/models/whatsapp_camp_template.rb +287 -0
  718. data/lib/brevo-ruby/version.rb +15 -0
  719. data/lib/brevo-ruby.rb +393 -0
  720. data/spec/api/account_api_spec.rb +59 -0
  721. data/spec/api/companies_api_spec.rb +119 -0
  722. data/spec/api/contacts_api_spec.rb +387 -0
  723. data/spec/api/conversations_api_spec.rb +140 -0
  724. data/spec/api/coupons_api_spec.rb +93 -0
  725. data/spec/api/deals_api_spec.rb +141 -0
  726. data/spec/api/domains_api_spec.rb +89 -0
  727. data/spec/api/ecommerce_api_spec.rb +173 -0
  728. data/spec/api/email_campaigns_api_spec.rb +195 -0
  729. data/spec/api/external_feeds_api_spec.rb +102 -0
  730. data/spec/api/files_api_spec.rb +99 -0
  731. data/spec/api/inbound_parsing_api_spec.rb +76 -0
  732. data/spec/api/master_account_api_spec.rb +145 -0
  733. data/spec/api/notes_api_spec.rb +97 -0
  734. data/spec/api/process_api_spec.rb +59 -0
  735. data/spec/api/reseller_api_spec.rb +223 -0
  736. data/spec/api/senders_api_spec.rb +114 -0
  737. data/spec/api/sms_campaigns_api_spec.rb +157 -0
  738. data/spec/api/tasks_api_spec.rb +113 -0
  739. data/spec/api/transactional_emails_api_spec.rb +330 -0
  740. data/spec/api/transactional_sms_api_spec.rb +94 -0
  741. data/spec/api/transactional_whats_app_api_spec.rb +66 -0
  742. data/spec/api/user_api_spec.rb +56 -0
  743. data/spec/api/webhooks_api_spec.rb +104 -0
  744. data/spec/api/whats_app_campaigns_api_spec.rb +142 -0
  745. data/spec/api_client_spec.rb +243 -0
  746. data/spec/configuration_spec.rb +42 -0
  747. data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
  748. data/spec/models/ab_test_campaign_result_spec.rb +91 -0
  749. data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
  750. data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
  751. data/spec/models/ab_test_version_clicks_spec.rb +35 -0
  752. data/spec/models/ab_test_version_stats_spec.rb +47 -0
  753. data/spec/models/add_child_domain_spec.rb +41 -0
  754. data/spec/models/add_contact_to_list_spec.rb +47 -0
  755. data/spec/models/add_credits_spec.rb +47 -0
  756. data/spec/models/authenticate_domain_model_spec.rb +47 -0
  757. data/spec/models/block_domain_spec.rb +41 -0
  758. data/spec/models/body_10_spec.rb +59 -0
  759. data/spec/models/body_11_spec.rb +41 -0
  760. data/spec/models/body_12_spec.rb +59 -0
  761. data/spec/models/body_1_spec.rb +53 -0
  762. data/spec/models/body_2_spec.rb +59 -0
  763. data/spec/models/body_3_spec.rb +47 -0
  764. data/spec/models/body_4_spec.rb +47 -0
  765. data/spec/models/body_5_spec.rb +59 -0
  766. data/spec/models/body_6_spec.rb +101 -0
  767. data/spec/models/body_7_spec.rb +95 -0
  768. data/spec/models/body_8_spec.rb +71 -0
  769. data/spec/models/body_9_spec.rb +41 -0
  770. data/spec/models/body_spec.rb +53 -0
  771. data/spec/models/body_variables_items_spec.rb +35 -0
  772. data/spec/models/companies_list_spec.rb +41 -0
  773. data/spec/models/company_attributes_inner_spec.rb +65 -0
  774. data/spec/models/company_attributes_spec.rb +35 -0
  775. data/spec/models/company_spec.rb +59 -0
  776. data/spec/models/component_items_spec.rb +47 -0
  777. data/spec/models/conversations_message_file_image_info_spec.rb +53 -0
  778. data/spec/models/conversations_message_file_spec.rb +65 -0
  779. data/spec/models/conversations_message_spec.rb +99 -0
  780. data/spec/models/create_api_key_request_spec.rb +47 -0
  781. data/spec/models/create_api_key_response_spec.rb +47 -0
  782. data/spec/models/create_attribute_enumeration_spec.rb +47 -0
  783. data/spec/models/create_attribute_spec.rb +63 -0
  784. data/spec/models/create_category_model_spec.rb +41 -0
  785. data/spec/models/create_child_spec.rb +75 -0
  786. data/spec/models/create_contact_spec.rb +83 -0
  787. data/spec/models/create_coupon_collection_spec.rb +47 -0
  788. data/spec/models/create_coupons_spec.rb +47 -0
  789. data/spec/models/create_doi_contact_spec.rb +71 -0
  790. data/spec/models/create_domain_model_dns_records_dkim_record_spec.rb +59 -0
  791. data/spec/models/create_domain_model_dns_records_spec.rb +47 -0
  792. data/spec/models/create_domain_model_spec.rb +59 -0
  793. data/spec/models/create_domain_spec.rb +41 -0
  794. data/spec/models/create_email_campaign_recipients_spec.rb +53 -0
  795. data/spec/models/create_email_campaign_sender_spec.rb +53 -0
  796. data/spec/models/create_email_campaign_spec.rb +219 -0
  797. data/spec/models/create_external_feed_spec.rb +93 -0
  798. data/spec/models/create_list_spec.rb +47 -0
  799. data/spec/models/create_model_spec.rb +41 -0
  800. data/spec/models/create_product_model_spec.rb +41 -0
  801. data/spec/models/create_reseller_spec.rb +47 -0
  802. data/spec/models/create_sender_ips_spec.rb +53 -0
  803. data/spec/models/create_sender_model_spec.rb +53 -0
  804. data/spec/models/create_sender_spec.rb +53 -0
  805. data/spec/models/create_sms_campaign_recipients_spec.rb +47 -0
  806. data/spec/models/create_sms_campaign_spec.rb +83 -0
  807. data/spec/models/create_smtp_email_spec.rb +47 -0
  808. data/spec/models/create_smtp_template_sender_spec.rb +53 -0
  809. data/spec/models/create_smtp_template_spec.rb +95 -0
  810. data/spec/models/create_sub_account_response_spec.rb +41 -0
  811. data/spec/models/create_sub_account_spec.rb +63 -0
  812. data/spec/models/create_update_batch_category_model_spec.rb +47 -0
  813. data/spec/models/create_update_batch_category_spec.rb +47 -0
  814. data/spec/models/create_update_batch_products_model_spec.rb +47 -0
  815. data/spec/models/create_update_batch_products_spec.rb +47 -0
  816. data/spec/models/create_update_categories_spec.rb +59 -0
  817. data/spec/models/create_update_category_spec.rb +65 -0
  818. data/spec/models/create_update_contact_model_spec.rb +41 -0
  819. data/spec/models/create_update_folder_spec.rb +41 -0
  820. data/spec/models/create_update_product_spec.rb +101 -0
  821. data/spec/models/create_update_products_spec.rb +95 -0
  822. data/spec/models/create_webhook_spec.rb +73 -0
  823. data/spec/models/create_whats_app_campaign_recipients_spec.rb +53 -0
  824. data/spec/models/create_whats_app_campaign_spec.rb +59 -0
  825. data/spec/models/create_whats_app_template_spec.rb +75 -0
  826. data/spec/models/created_batch_id_spec.rb +41 -0
  827. data/spec/models/created_process_id_spec.rb +41 -0
  828. data/spec/models/deal_attributes_inner_spec.rb +65 -0
  829. data/spec/models/deal_attributes_spec.rb +35 -0
  830. data/spec/models/deal_spec.rb +59 -0
  831. data/spec/models/deals_list_spec.rb +41 -0
  832. data/spec/models/delete_hardbounces_spec.rb +53 -0
  833. data/spec/models/email_export_recipients_spec.rb +51 -0
  834. data/spec/models/error_model_spec.rb +51 -0
  835. data/spec/models/export_webhooks_history_spec.rb +93 -0
  836. data/spec/models/file_data_spec.rb +77 -0
  837. data/spec/models/file_downloadable_link_spec.rb +41 -0
  838. data/spec/models/file_list_spec.rb +35 -0
  839. data/spec/models/get_account_activity_logs_spec.rb +65 -0
  840. data/spec/models/get_account_activity_spec.rb +41 -0
  841. data/spec/models/get_account_marketing_automation_spec.rb +47 -0
  842. data/spec/models/get_account_plan_spec.rb +79 -0
  843. data/spec/models/get_account_relay_data_spec.rb +53 -0
  844. data/spec/models/get_account_relay_spec.rb +47 -0
  845. data/spec/models/get_account_spec.rb +83 -0
  846. data/spec/models/get_aggregated_report_spec.rb +113 -0
  847. data/spec/models/get_all_external_feeds_feeds_spec.rb +111 -0
  848. data/spec/models/get_all_external_feeds_spec.rb +47 -0
  849. data/spec/models/get_attributes_attributes_spec.rb +73 -0
  850. data/spec/models/get_attributes_enumeration_spec.rb +47 -0
  851. data/spec/models/get_attributes_spec.rb +41 -0
  852. data/spec/models/get_blocked_domains_spec.rb +41 -0
  853. data/spec/models/get_campaign_overview_spec.rb +121 -0
  854. data/spec/models/get_campaign_recipients_spec.rb +47 -0
  855. data/spec/models/get_campaign_stats_spec.rb +131 -0
  856. data/spec/models/get_categories_spec.rb +47 -0
  857. data/spec/models/get_category_details_spec.rb +71 -0
  858. data/spec/models/get_child_account_creation_status_spec.rb +41 -0
  859. data/spec/models/get_child_domain_spec.rb +47 -0
  860. data/spec/models/get_child_domains_spec.rb +35 -0
  861. data/spec/models/get_child_info_api_keys_spec.rb +47 -0
  862. data/spec/models/get_child_info_api_keys_v2_spec.rb +47 -0
  863. data/spec/models/get_child_info_api_keys_v3_spec.rb +47 -0
  864. data/spec/models/get_child_info_credits_spec.rb +47 -0
  865. data/spec/models/get_child_info_spec.rb +89 -0
  866. data/spec/models/get_child_info_statistics_spec.rb +53 -0
  867. data/spec/models/get_children_list_spec.rb +47 -0
  868. data/spec/models/get_client_spec.rb +59 -0
  869. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +47 -0
  870. data/spec/models/get_contact_campaign_stats_opened_spec.rb +59 -0
  871. data/spec/models/get_contact_campaign_stats_spec.rb +89 -0
  872. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +53 -0
  873. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +47 -0
  874. data/spec/models/get_contact_details_spec.rb +89 -0
  875. data/spec/models/get_contacts_spec.rb +47 -0
  876. data/spec/models/get_coupon_collection_spec.rb +71 -0
  877. data/spec/models/get_device_browser_stats_spec.rb +59 -0
  878. data/spec/models/get_domain_configuration_model_spec.rb +59 -0
  879. data/spec/models/get_domains_list_domains_spec.rb +65 -0
  880. data/spec/models/get_domains_list_spec.rb +41 -0
  881. data/spec/models/get_email_campaign_spec.rb +229 -0
  882. data/spec/models/get_email_campaigns_spec.rb +47 -0
  883. data/spec/models/get_email_event_report_events_spec.rb +105 -0
  884. data/spec/models/get_email_event_report_spec.rb +41 -0
  885. data/spec/models/get_extended_campaign_overview_sender_spec.rb +53 -0
  886. data/spec/models/get_extended_campaign_overview_spec.rb +217 -0
  887. data/spec/models/get_extended_campaign_stats_global_stats_spec.rb +35 -0
  888. data/spec/models/get_extended_campaign_stats_spec.rb +83 -0
  889. data/spec/models/get_extended_client_address_spec.rb +59 -0
  890. data/spec/models/get_extended_client_spec.rb +65 -0
  891. data/spec/models/get_extended_contact_details_spec.rb +95 -0
  892. data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +47 -0
  893. data/spec/models/get_extended_contact_details_statistics_delivered_spec.rb +47 -0
  894. data/spec/models/get_extended_contact_details_statistics_links_spec.rb +59 -0
  895. data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +47 -0
  896. data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +59 -0
  897. data/spec/models/get_extended_contact_details_statistics_spec.rb +89 -0
  898. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +47 -0
  899. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +47 -0
  900. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +53 -0
  901. data/spec/models/get_extended_list_campaign_stats_spec.rb +47 -0
  902. data/spec/models/get_extended_list_spec.rb +89 -0
  903. data/spec/models/get_external_feed_by_uuid_headers_spec.rb +47 -0
  904. data/spec/models/get_external_feed_by_uuid_spec.rb +111 -0
  905. data/spec/models/get_folder_lists_spec.rb +47 -0
  906. data/spec/models/get_folder_spec.rb +65 -0
  907. data/spec/models/get_folders_spec.rb +47 -0
  908. data/spec/models/get_inbound_email_events_by_uuid_attachments_spec.rb +59 -0
  909. data/spec/models/get_inbound_email_events_by_uuid_logs_spec.rb +51 -0
  910. data/spec/models/get_inbound_email_events_by_uuid_spec.rb +83 -0
  911. data/spec/models/get_inbound_email_events_events_spec.rb +59 -0
  912. data/spec/models/get_inbound_email_events_spec.rb +41 -0
  913. data/spec/models/get_invited_users_list_feature_access_spec.rb +53 -0
  914. data/spec/models/get_invited_users_list_spec.rb +41 -0
  915. data/spec/models/get_invited_users_list_users_spec.rb +59 -0
  916. data/spec/models/get_ip_from_sender_spec.rb +59 -0
  917. data/spec/models/get_ip_spec.rb +59 -0
  918. data/spec/models/get_ips_from_sender_spec.rb +41 -0
  919. data/spec/models/get_ips_spec.rb +41 -0
  920. data/spec/models/get_list_spec.rb +65 -0
  921. data/spec/models/get_lists_spec.rb +47 -0
  922. data/spec/models/get_process_spec.rb +63 -0
  923. data/spec/models/get_processes_spec.rb +47 -0
  924. data/spec/models/get_product_details_spec.rb +125 -0
  925. data/spec/models/get_products_spec.rb +47 -0
  926. data/spec/models/get_reports_reports_spec.rb +113 -0
  927. data/spec/models/get_reports_spec.rb +41 -0
  928. data/spec/models/get_scheduled_email_by_batch_id_batches_spec.rb +57 -0
  929. data/spec/models/get_scheduled_email_by_batch_id_spec.rb +47 -0
  930. data/spec/models/get_scheduled_email_by_message_id_spec.rb +57 -0
  931. data/spec/models/get_segments_segments_spec.rb +59 -0
  932. data/spec/models/get_segments_spec.rb +47 -0
  933. data/spec/models/get_senders_list_ips_spec.rb +53 -0
  934. data/spec/models/get_senders_list_senders_spec.rb +65 -0
  935. data/spec/models/get_senders_list_spec.rb +41 -0
  936. data/spec/models/get_shared_template_url_spec.rb +41 -0
  937. data/spec/models/get_sms_campaign_overview_spec.rb +87 -0
  938. data/spec/models/get_sms_campaign_recipients_spec.rb +35 -0
  939. data/spec/models/get_sms_campaign_spec.rb +99 -0
  940. data/spec/models/get_sms_campaign_stats_spec.rb +77 -0
  941. data/spec/models/get_sms_campaigns_spec.rb +47 -0
  942. data/spec/models/get_sms_event_report_events_spec.rb +81 -0
  943. data/spec/models/get_sms_event_report_spec.rb +41 -0
  944. data/spec/models/get_smtp_template_overview_sender_spec.rb +53 -0
  945. data/spec/models/get_smtp_template_overview_spec.rb +113 -0
  946. data/spec/models/get_smtp_templates_spec.rb +47 -0
  947. data/spec/models/get_sso_token_spec.rb +41 -0
  948. data/spec/models/get_stats_by_browser_spec.rb +35 -0
  949. data/spec/models/get_stats_by_device_spec.rb +59 -0
  950. data/spec/models/get_stats_by_domain_spec.rb +35 -0
  951. data/spec/models/get_transac_aggregated_sms_report_spec.rb +95 -0
  952. data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
  953. data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
  954. data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
  955. data/spec/models/get_transac_email_content_events_spec.rb +47 -0
  956. data/spec/models/get_transac_email_content_spec.rb +77 -0
  957. data/spec/models/get_transac_emails_list_spec.rb +47 -0
  958. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +83 -0
  959. data/spec/models/get_transac_sms_report_reports_spec.rb +95 -0
  960. data/spec/models/get_transac_sms_report_spec.rb +41 -0
  961. data/spec/models/get_user_permission_privileges_spec.rb +47 -0
  962. data/spec/models/get_user_permission_spec.rb +53 -0
  963. data/spec/models/get_wa_templates_spec.rb +47 -0
  964. data/spec/models/get_wa_templates_templates_spec.rb +83 -0
  965. data/spec/models/get_webhook_spec.rb +81 -0
  966. data/spec/models/get_webhooks_spec.rb +41 -0
  967. data/spec/models/get_whats_app_config_spec.rb +79 -0
  968. data/spec/models/get_whatsapp_campaign_overview_spec.rb +93 -0
  969. data/spec/models/get_whatsapp_campaigns_campaigns_spec.rb +105 -0
  970. data/spec/models/get_whatsapp_campaigns_spec.rb +47 -0
  971. data/spec/models/get_whatsapp_event_report_events_spec.rb +87 -0
  972. data/spec/models/get_whatsapp_event_report_spec.rb +41 -0
  973. data/spec/models/inline_response_200_1_spec.rb +53 -0
  974. data/spec/models/inline_response_200_spec.rb +41 -0
  975. data/spec/models/inline_response_201_1_spec.rb +41 -0
  976. data/spec/models/inline_response_201_2_spec.rb +41 -0
  977. data/spec/models/inline_response_201_3_spec.rb +41 -0
  978. data/spec/models/inline_response_201_4_spec.rb +41 -0
  979. data/spec/models/inline_response_201_spec.rb +41 -0
  980. data/spec/models/manage_ip_spec.rb +41 -0
  981. data/spec/models/master_details_response_billing_info_address_spec.rb +65 -0
  982. data/spec/models/master_details_response_billing_info_name_spec.rb +47 -0
  983. data/spec/models/master_details_response_billing_info_spec.rb +59 -0
  984. data/spec/models/master_details_response_plan_info_features_spec.rb +65 -0
  985. data/spec/models/master_details_response_plan_info_spec.rb +75 -0
  986. data/spec/models/master_details_response_spec.rb +77 -0
  987. data/spec/models/note_data_spec.rb +59 -0
  988. data/spec/models/note_id_spec.rb +41 -0
  989. data/spec/models/note_list_spec.rb +35 -0
  990. data/spec/models/note_spec.rb +77 -0
  991. data/spec/models/order_batch_spec.rb +47 -0
  992. data/spec/models/order_billing_spec.rb +77 -0
  993. data/spec/models/order_products_spec.rb +59 -0
  994. data/spec/models/order_spec.rb +89 -0
  995. data/spec/models/otp_spec.rb +41 -0
  996. data/spec/models/pipeline_spec.rb +53 -0
  997. data/spec/models/pipeline_stage_spec.rb +47 -0
  998. data/spec/models/pipelines_spec.rb +35 -0
  999. data/spec/models/post_contact_info_contacts_spec.rb +59 -0
  1000. data/spec/models/post_contact_info_spec.rb +41 -0
  1001. data/spec/models/post_send_failed_spec.rb +65 -0
  1002. data/spec/models/post_send_sms_test_failed_spec.rb +59 -0
  1003. data/spec/models/remaining_credit_model_child_spec.rb +47 -0
  1004. data/spec/models/remaining_credit_model_reseller_spec.rb +47 -0
  1005. data/spec/models/remaining_credit_model_spec.rb +47 -0
  1006. data/spec/models/remove_contact_from_list_spec.rb +53 -0
  1007. data/spec/models/remove_credits_spec.rb +47 -0
  1008. data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
  1009. data/spec/models/request_contact_export_spec.rb +53 -0
  1010. data/spec/models/request_contact_import_new_list_spec.rb +47 -0
  1011. data/spec/models/request_contact_import_spec.rb +95 -0
  1012. data/spec/models/request_sms_recipient_export_spec.rb +51 -0
  1013. data/spec/models/schedule_smtp_email_spec.rb +53 -0
  1014. data/spec/models/send_report_email_spec.rb +47 -0
  1015. data/spec/models/send_report_spec.rb +51 -0
  1016. data/spec/models/send_sms_spec.rb +65 -0
  1017. data/spec/models/send_smtp_email_attachment_spec.rb +53 -0
  1018. data/spec/models/send_smtp_email_bcc_spec.rb +47 -0
  1019. data/spec/models/send_smtp_email_cc_spec.rb +47 -0
  1020. data/spec/models/send_smtp_email_message_versions_spec.rb +71 -0
  1021. data/spec/models/send_smtp_email_reply_to_1_spec.rb +47 -0
  1022. data/spec/models/send_smtp_email_reply_to_spec.rb +47 -0
  1023. data/spec/models/send_smtp_email_sender_spec.rb +53 -0
  1024. data/spec/models/send_smtp_email_spec.rb +131 -0
  1025. data/spec/models/send_smtp_email_to_1_spec.rb +47 -0
  1026. data/spec/models/send_smtp_email_to_spec.rb +47 -0
  1027. data/spec/models/send_test_email_spec.rb +41 -0
  1028. data/spec/models/send_test_sms_spec.rb +41 -0
  1029. data/spec/models/send_transac_sms_spec.rb +87 -0
  1030. data/spec/models/send_whatsapp_message_spec.rb +59 -0
  1031. data/spec/models/sso_token_request_spec.rb +57 -0
  1032. data/spec/models/sub_account_details_response_plan_info_credits_emails_spec.rb +47 -0
  1033. data/spec/models/sub_account_details_response_plan_info_credits_spec.rb +47 -0
  1034. data/spec/models/sub_account_details_response_plan_info_features_inbox_spec.rb +47 -0
  1035. data/spec/models/sub_account_details_response_plan_info_features_landing_page_spec.rb +47 -0
  1036. data/spec/models/sub_account_details_response_plan_info_features_spec.rb +53 -0
  1037. data/spec/models/sub_account_details_response_plan_info_features_users_spec.rb +47 -0
  1038. data/spec/models/sub_account_details_response_plan_info_spec.rb +53 -0
  1039. data/spec/models/sub_account_details_response_spec.rb +59 -0
  1040. data/spec/models/sub_account_update_plan_request_credits_spec.rb +41 -0
  1041. data/spec/models/sub_account_update_plan_request_features_spec.rb +53 -0
  1042. data/spec/models/sub_account_update_plan_request_spec.rb +47 -0
  1043. data/spec/models/sub_accounts_response_spec.rb +47 -0
  1044. data/spec/models/sub_accounts_response_sub_accounts_spec.rb +59 -0
  1045. data/spec/models/task_list_spec.rb +41 -0
  1046. data/spec/models/task_reminder_spec.rb +57 -0
  1047. data/spec/models/task_spec.rb +71 -0
  1048. data/spec/models/task_types_spec.rb +47 -0
  1049. data/spec/models/update_attribute_enumeration_spec.rb +47 -0
  1050. data/spec/models/update_attribute_spec.rb +47 -0
  1051. data/spec/models/update_batch_contacts_contacts_spec.rb +95 -0
  1052. data/spec/models/update_batch_contacts_model_spec.rb +47 -0
  1053. data/spec/models/update_batch_contacts_spec.rb +41 -0
  1054. data/spec/models/update_campaign_status_spec.rb +45 -0
  1055. data/spec/models/update_child_account_status_spec.rb +59 -0
  1056. data/spec/models/update_child_domain_spec.rb +41 -0
  1057. data/spec/models/update_child_spec.rb +65 -0
  1058. data/spec/models/update_contact_spec.rb +77 -0
  1059. data/spec/models/update_coupon_collection_spec.rb +41 -0
  1060. data/spec/models/update_email_campaign_recipients_spec.rb +53 -0
  1061. data/spec/models/update_email_campaign_sender_spec.rb +53 -0
  1062. data/spec/models/update_email_campaign_spec.rb +219 -0
  1063. data/spec/models/update_external_feed_spec.rb +93 -0
  1064. data/spec/models/update_list_spec.rb +47 -0
  1065. data/spec/models/update_sender_spec.rb +53 -0
  1066. data/spec/models/update_sms_campaign_spec.rb +83 -0
  1067. data/spec/models/update_smtp_template_sender_spec.rb +53 -0
  1068. data/spec/models/update_smtp_template_spec.rb +95 -0
  1069. data/spec/models/update_webhook_spec.rb +63 -0
  1070. data/spec/models/update_whats_app_campaign_spec.rb +63 -0
  1071. data/spec/models/upload_image_model_spec.rb +41 -0
  1072. data/spec/models/upload_image_to_gallery_spec.rb +47 -0
  1073. data/spec/models/variables_items_spec.rb +53 -0
  1074. data/spec/models/whatsapp_camp_stats_spec.rb +65 -0
  1075. data/spec/models/whatsapp_camp_template_spec.rb +101 -0
  1076. data/spec/spec_helper.rb +111 -0
  1077. metadata +1675 -0
@@ -0,0 +1,305 @@
1
+ # BrevoRuby::CouponsApi
2
+
3
+ All URIs are relative to *https://api.brevo.com/v3*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create_coupon_collection**](CouponsApi.md#create_coupon_collection) | **POST** /couponCollections | Create а coupon collection
8
+ [**create_coupons**](CouponsApi.md#create_coupons) | **POST** /coupons | Create coupons for a coupon collection
9
+ [**get_coupon_collection**](CouponsApi.md#get_coupon_collection) | **GET** /couponCollections/{id} | Get a coupon collection by id
10
+ [**get_coupon_collections**](CouponsApi.md#get_coupon_collections) | **GET** /couponCollections | Get all your coupon collections
11
+ [**update_coupon_collection**](CouponsApi.md#update_coupon_collection) | **PATCH** /couponCollections/{id} | Update a coupon collection by id
12
+
13
+
14
+ # **create_coupon_collection**
15
+ > InlineResponse2012 create_coupon_collection(create_coupon_collection)
16
+
17
+ Create а coupon collection
18
+
19
+ ### Example
20
+ ```ruby
21
+ # load the gem
22
+ require 'brevo-ruby'
23
+ # setup authorization
24
+ BrevoRuby.configure do |config|
25
+ # Configure API key authorization: api-key
26
+ config.api_key['api-key'] = 'YOUR API KEY'
27
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
+ #config.api_key_prefix['api-key'] = 'Bearer'
29
+
30
+ # Configure API key authorization: partner-key
31
+ config.api_key['partner-key'] = 'YOUR API KEY'
32
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
33
+ #config.api_key_prefix['partner-key'] = 'Bearer'
34
+ end
35
+
36
+ api_instance = BrevoRuby::CouponsApi.new
37
+
38
+ create_coupon_collection = BrevoRuby::CreateCouponCollection.new # CreateCouponCollection | Values to create a coupon collection
39
+
40
+
41
+ begin
42
+ #Create а coupon collection
43
+ result = api_instance.create_coupon_collection(create_coupon_collection)
44
+ p result
45
+ rescue BrevoRuby::ApiError => e
46
+ puts "Exception when calling CouponsApi->create_coupon_collection: #{e}"
47
+ end
48
+ ```
49
+
50
+ ### Parameters
51
+
52
+ Name | Type | Description | Notes
53
+ ------------- | ------------- | ------------- | -------------
54
+ **create_coupon_collection** | [**CreateCouponCollection**](CreateCouponCollection.md)| Values to create a coupon collection |
55
+
56
+ ### Return type
57
+
58
+ [**InlineResponse2012**](InlineResponse2012.md)
59
+
60
+ ### Authorization
61
+
62
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
63
+
64
+ ### HTTP request headers
65
+
66
+ - **Content-Type**: application/json
67
+ - **Accept**: application/json
68
+
69
+
70
+
71
+ # **create_coupons**
72
+ > create_coupons(create_coupons)
73
+
74
+ Create coupons for a coupon collection
75
+
76
+ ### Example
77
+ ```ruby
78
+ # load the gem
79
+ require 'brevo-ruby'
80
+ # setup authorization
81
+ BrevoRuby.configure do |config|
82
+ # Configure API key authorization: api-key
83
+ config.api_key['api-key'] = 'YOUR API KEY'
84
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
85
+ #config.api_key_prefix['api-key'] = 'Bearer'
86
+
87
+ # Configure API key authorization: partner-key
88
+ config.api_key['partner-key'] = 'YOUR API KEY'
89
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
90
+ #config.api_key_prefix['partner-key'] = 'Bearer'
91
+ end
92
+
93
+ api_instance = BrevoRuby::CouponsApi.new
94
+
95
+ create_coupons = BrevoRuby::CreateCoupons.new # CreateCoupons | Values to create coupons
96
+
97
+
98
+ begin
99
+ #Create coupons for a coupon collection
100
+ api_instance.create_coupons(create_coupons)
101
+ rescue BrevoRuby::ApiError => e
102
+ puts "Exception when calling CouponsApi->create_coupons: #{e}"
103
+ end
104
+ ```
105
+
106
+ ### Parameters
107
+
108
+ Name | Type | Description | Notes
109
+ ------------- | ------------- | ------------- | -------------
110
+ **create_coupons** | [**CreateCoupons**](CreateCoupons.md)| Values to create coupons |
111
+
112
+ ### Return type
113
+
114
+ nil (empty response body)
115
+
116
+ ### Authorization
117
+
118
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
119
+
120
+ ### HTTP request headers
121
+
122
+ - **Content-Type**: application/json
123
+ - **Accept**: application/json
124
+
125
+
126
+
127
+ # **get_coupon_collection**
128
+ > GetCouponCollection get_coupon_collection(id)
129
+
130
+ Get a coupon collection by id
131
+
132
+ ### Example
133
+ ```ruby
134
+ # load the gem
135
+ require 'brevo-ruby'
136
+ # setup authorization
137
+ BrevoRuby.configure do |config|
138
+ # Configure API key authorization: api-key
139
+ config.api_key['api-key'] = 'YOUR API KEY'
140
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
141
+ #config.api_key_prefix['api-key'] = 'Bearer'
142
+
143
+ # Configure API key authorization: partner-key
144
+ config.api_key['partner-key'] = 'YOUR API KEY'
145
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
146
+ #config.api_key_prefix['partner-key'] = 'Bearer'
147
+ end
148
+
149
+ api_instance = BrevoRuby::CouponsApi.new
150
+
151
+ id = 'id_example' # String | Id of the collection to return
152
+
153
+
154
+ begin
155
+ #Get a coupon collection by id
156
+ result = api_instance.get_coupon_collection(id)
157
+ p result
158
+ rescue BrevoRuby::ApiError => e
159
+ puts "Exception when calling CouponsApi->get_coupon_collection: #{e}"
160
+ end
161
+ ```
162
+
163
+ ### Parameters
164
+
165
+ Name | Type | Description | Notes
166
+ ------------- | ------------- | ------------- | -------------
167
+ **id** | **String**| Id of the collection to return |
168
+
169
+ ### Return type
170
+
171
+ [**GetCouponCollection**](GetCouponCollection.md)
172
+
173
+ ### Authorization
174
+
175
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
176
+
177
+ ### HTTP request headers
178
+
179
+ - **Content-Type**: application/json
180
+ - **Accept**: application/json
181
+
182
+
183
+
184
+ # **get_coupon_collections**
185
+ > GetCouponCollection get_coupon_collections(opts)
186
+
187
+ Get all your coupon collections
188
+
189
+ ### Example
190
+ ```ruby
191
+ # load the gem
192
+ require 'brevo-ruby'
193
+ # setup authorization
194
+ BrevoRuby.configure do |config|
195
+ # Configure API key authorization: api-key
196
+ config.api_key['api-key'] = 'YOUR API KEY'
197
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
198
+ #config.api_key_prefix['api-key'] = 'Bearer'
199
+
200
+ # Configure API key authorization: partner-key
201
+ config.api_key['partner-key'] = 'YOUR API KEY'
202
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
203
+ #config.api_key_prefix['partner-key'] = 'Bearer'
204
+ end
205
+
206
+ api_instance = BrevoRuby::CouponsApi.new
207
+
208
+ opts = {
209
+ limit: 50, # Integer | Number of documents returned per page
210
+ offset: 0, # Integer | Index of the first document on the page
211
+ sort: 'desc' # String | Sort the results by creation time in ascending/descending order
212
+ }
213
+
214
+ begin
215
+ #Get all your coupon collections
216
+ result = api_instance.get_coupon_collections(opts)
217
+ p result
218
+ rescue BrevoRuby::ApiError => e
219
+ puts "Exception when calling CouponsApi->get_coupon_collections: #{e}"
220
+ end
221
+ ```
222
+
223
+ ### Parameters
224
+
225
+ Name | Type | Description | Notes
226
+ ------------- | ------------- | ------------- | -------------
227
+ **limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
228
+ **offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
229
+ **sort** | **String**| Sort the results by creation time in ascending/descending order | [optional] [default to desc]
230
+
231
+ ### Return type
232
+
233
+ [**GetCouponCollection**](GetCouponCollection.md)
234
+
235
+ ### Authorization
236
+
237
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
238
+
239
+ ### HTTP request headers
240
+
241
+ - **Content-Type**: application/json
242
+ - **Accept**: application/json
243
+
244
+
245
+
246
+ # **update_coupon_collection**
247
+ > InlineResponse2001 update_coupon_collection(id, update_coupon_collection)
248
+
249
+ Update a coupon collection by id
250
+
251
+ ### Example
252
+ ```ruby
253
+ # load the gem
254
+ require 'brevo-ruby'
255
+ # setup authorization
256
+ BrevoRuby.configure do |config|
257
+ # Configure API key authorization: api-key
258
+ config.api_key['api-key'] = 'YOUR API KEY'
259
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
260
+ #config.api_key_prefix['api-key'] = 'Bearer'
261
+
262
+ # Configure API key authorization: partner-key
263
+ config.api_key['partner-key'] = 'YOUR API KEY'
264
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
265
+ #config.api_key_prefix['partner-key'] = 'Bearer'
266
+ end
267
+
268
+ api_instance = BrevoRuby::CouponsApi.new
269
+
270
+ id = 'id_example' # String | Id of the collection to update
271
+
272
+ update_coupon_collection = BrevoRuby::UpdateCouponCollection.new # UpdateCouponCollection | Values to update the coupon collection
273
+
274
+
275
+ begin
276
+ #Update a coupon collection by id
277
+ result = api_instance.update_coupon_collection(id, update_coupon_collection)
278
+ p result
279
+ rescue BrevoRuby::ApiError => e
280
+ puts "Exception when calling CouponsApi->update_coupon_collection: #{e}"
281
+ end
282
+ ```
283
+
284
+ ### Parameters
285
+
286
+ Name | Type | Description | Notes
287
+ ------------- | ------------- | ------------- | -------------
288
+ **id** | **String**| Id of the collection to update |
289
+ **update_coupon_collection** | [**UpdateCouponCollection**](UpdateCouponCollection.md)| Values to update the coupon collection |
290
+
291
+ ### Return type
292
+
293
+ [**InlineResponse2001**](InlineResponse2001.md)
294
+
295
+ ### Authorization
296
+
297
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
298
+
299
+ ### HTTP request headers
300
+
301
+ - **Content-Type**: application/json
302
+ - **Accept**: application/json
303
+
304
+
305
+
@@ -0,0 +1,9 @@
1
+ # BrevoRuby::CreateApiKeyRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | Id of the sub-account organization |
7
+ **name** | **String** | Name of the API key | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # BrevoRuby::CreateApiKeyResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **status** | **String** | Status of the API operation. | [optional]
7
+ **key** | **String** | API Key | [optional]
8
+
9
+
@@ -0,0 +1,11 @@
1
+ # BrevoRuby::CreateAttribute
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **value** | **String** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
7
+ **is_recurring** | **BOOLEAN** | Type of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
8
+ **enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] | [optional]
9
+ **type** | **String** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional]
10
+
11
+
@@ -0,0 +1,9 @@
1
+ # BrevoRuby::CreateAttributeEnumeration
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **value** | **Integer** | Id of the value |
7
+ **label** | **String** | Label of the value |
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # BrevoRuby::CreateCategoryModel
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | ID of the category when a new category is created | [optional]
7
+
8
+
@@ -0,0 +1,13 @@
1
+ # BrevoRuby::CreateChild
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email** | **String** | Email address to create the child account |
7
+ **first_name** | **String** | First name to use to create the child account |
8
+ **last_name** | **String** | Last name to use to create the child account |
9
+ **company_name** | **String** | Company name to use to create the child account |
10
+ **password** | **String** | Password for the child account to login |
11
+ **language** | **String** | Language of the child account | [optional]
12
+
13
+
@@ -0,0 +1,15 @@
1
+ # BrevoRuby::CreateContact
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email** | **String** | Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional]
7
+ **ext_id** | **String** | Pass your own Id to create a contact. | [optional]
8
+ **attributes** | **Object** | Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. These attributes must be present in your Brevo account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} | [optional]
9
+ **email_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]
10
+ **sms_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
11
+ **list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
12
+ **update_enabled** | **BOOLEAN** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional] [default to false]
13
+ **smtp_blacklist_sender** | **Array<String>** | transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional]
14
+
15
+
@@ -0,0 +1,9 @@
1
+ # BrevoRuby::CreateCouponCollection
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **Object** | Name of the collection with no white spaces between words |
7
+ **default_coupon** | **Object** | A default coupon to be used in case there are no coupons left |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # BrevoRuby::CreateCoupons
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **collection_id** | **String** | The id of the coupon collection for which the coupons will be created |
7
+ **coupons** | **Array<String>** | |
8
+
9
+
@@ -0,0 +1,13 @@
1
+ # BrevoRuby::CreateDoiContact
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email** | **String** | Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. |
7
+ **attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your Brevo account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional]
8
+ **include_list_ids** | **Array<Integer>** | Lists under user account where contact should be added |
9
+ **exclude_list_ids** | **Array<Integer>** | Lists under user account where contact should not be added | [optional]
10
+ **template_id** | **Integer** | Id of the Double opt-in (DOI) template |
11
+ **redirection_url** | **String** | URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. |
12
+
13
+
@@ -0,0 +1,8 @@
1
+ # BrevoRuby::CreateDomain
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | Domain name |
7
+
8
+
@@ -0,0 +1,11 @@
1
+ # BrevoRuby::CreateDomainModel
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | ID of the Domain created |
7
+ **domain_name** | **String** | Domain | [optional]
8
+ **message** | **String** | Success message | [optional]
9
+ **dns_records** | [**CreateDomainModelDnsRecords**](CreateDomainModelDnsRecords.md) | | [optional]
10
+
11
+
@@ -0,0 +1,9 @@
1
+ # BrevoRuby::CreateDomainModelDnsRecords
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **dkim_record** | [**CreateDomainModelDnsRecordsDkimRecord**](CreateDomainModelDnsRecordsDkimRecord.md) | | [optional]
7
+ **brevo_code** | [**CreateDomainModelDnsRecordsDkimRecord**](CreateDomainModelDnsRecordsDkimRecord.md) | | [optional]
8
+
9
+
@@ -0,0 +1,11 @@
1
+ # BrevoRuby::CreateDomainModelDnsRecordsDkimRecord
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **type** | **String** | | [optional]
7
+ **value** | **String** | | [optional]
8
+ **host_name** | **String** | | [optional]
9
+ **status** | **BOOLEAN** | | [optional]
10
+
11
+
@@ -0,0 +1,37 @@
1
+ # BrevoRuby::CreateEmailCampaign
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **tag** | **String** | Tag of the campaign | [optional]
7
+ **sender** | [**CreateEmailCampaignSender**](CreateEmailCampaignSender.md) | |
8
+ **name** | **String** | Name of the campaign |
9
+ **html_content** | **String** | Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) | [optional]
10
+ **html_url** | **String** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional]
11
+ **template_id** | **Integer** | Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional]
12
+ **scheduled_at** | **String** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
13
+ **subject** | **String** | Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional]
14
+ **reply_to** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
15
+ **to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
16
+ **recipients** | [**CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) | | [optional]
17
+ **attachment_url** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional]
18
+ **inline_image_activation** | **BOOLEAN** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false]
19
+ **mirror_active** | **BOOLEAN** | Use true to enable the mirror link | [optional]
20
+ **footer** | **String** | Footer of the email campaign | [optional]
21
+ **header** | **String** | Header of the email campaign | [optional]
22
+ **utm_campaign** | **String** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional]
23
+ **params** | **Object** | Pass the set of attributes to customize the type classic campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
24
+ **send_at_best_time** | **BOOLEAN** | Set this to true if you want to send your campaign at best time. | [optional] [default to false]
25
+ **ab_testing** | **BOOLEAN** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to false]
26
+ **subject_a** | **String** | Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional]
27
+ **subject_b** | **String** | Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional]
28
+ **split_rule** | **Integer** | Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional]
29
+ **winner_criteria** | **String** | Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed | [optional]
30
+ **winner_delay** | **Integer** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed | [optional]
31
+ **ip_warmup_enable** | **BOOLEAN** | Available for dedicated ip clients. Set this to true if you wish to warm up your ip. | [optional] [default to false]
32
+ **initial_quota** | **Integer** | Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional]
33
+ **increase_rate** | **Integer** | Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. | [optional]
34
+ **unsubscription_page_id** | **String** | Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used. | [optional]
35
+ **update_form_id** | **String** | Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used. | [optional]
36
+
37
+
@@ -0,0 +1,10 @@
1
+ # BrevoRuby::CreateEmailCampaignRecipients
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **exclusion_list_ids** | **Array<Integer>** | List ids to exclude from the campaign | [optional]
7
+ **list_ids** | **Array<Integer>** | Mandatory if scheduledAt is not empty. List Ids to send the campaign to | [optional]
8
+ **segment_ids** | **Array<Integer>** | Mandatory if listIds are not used. Segment ids to send the campaign to. | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # BrevoRuby::CreateEmailCampaignSender
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | Sender Name | [optional]
7
+ **email** | **String** | Sender email |
8
+ **id** | **Integer** | Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional]
9
+
10
+
@@ -0,0 +1,16 @@
1
+ # BrevoRuby::CreateExternalFeed
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | Name of the feed |
7
+ **url** | **String** | URL of the feed |
8
+ **auth_type** | **String** | Auth type of the feed: * `basic` * `token` * `noAuth` | [optional] [default to 'noAuth']
9
+ **username** | **String** | Username for authType `basic` | [optional]
10
+ **password** | **String** | Password for authType `basic` | [optional]
11
+ **token** | **String** | Token for authType `token` | [optional]
12
+ **headers** | [**Array<GetExternalFeedByUUIDHeaders>**](GetExternalFeedByUUIDHeaders.md) | Custom headers for the feed | [optional]
13
+ **max_retries** | **Integer** | Maximum number of retries on the feed url | [optional]
14
+ **cache** | **BOOLEAN** | Toggle caching of feed url response | [optional] [default to false]
15
+
16
+
@@ -0,0 +1,9 @@
1
+ # BrevoRuby::CreateList
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | Name of the list |
7
+ **folder_id** | **Integer** | Id of the parent folder in which this list is to be created |
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # BrevoRuby::CreateModel
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | ID of the object created |
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # BrevoRuby::CreateProductModel
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | ID of the Product when a new product is created | [optional]
7
+
8
+
@@ -0,0 +1,9 @@
1
+ # BrevoRuby::CreateReseller
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **auth_key** | **String** | AuthKey of Reseller child created |
7
+ **id** | **Integer** | Id of Reseller child created | [optional]
8
+
9
+
@@ -0,0 +1,10 @@
1
+ # BrevoRuby::CreateSender
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | From Name to use for the sender |
7
+ **email** | **String** | From email to use for the sender. A verification email will be sent to this address. |
8
+ **ips** | [**Array<CreateSenderIps>**](CreateSenderIps.md) | Mandatory in case of dedicated IP, IPs to associate to the sender | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # BrevoRuby::CreateSenderIps
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **ip** | **String** | Dedicated IP available in your account |
7
+ **domain** | **String** | Domain of the IP |
8
+ **weight** | **Integer** | Weight to apply to the IP. Sum of all IP weights must be 100. Should be passed for either ALL or NONE of the IPs. If it's not passed, the sending will be equally balanced on all IPs. | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # BrevoRuby::CreateSenderModel
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | ID of the Sender created |
7
+ **spf_error** | **BOOLEAN** | Status of SPF configuration for the sender (true = SPF not well configured, false = SPF well configured) | [optional]
8
+ **dkim_error** | **BOOLEAN** | Status of DKIM configuration for the sender (true = DKIM not well configured, false = DKIM well configured) | [optional]
9
+
10
+
@@ -0,0 +1,15 @@
1
+ # BrevoRuby::CreateSmsCampaign
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | Name of the campaign |
7
+ **sender** | **String** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** |
8
+ **content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS |
9
+ **recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
10
+ **scheduled_at** | **String** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
11
+ **unicode_enabled** | **BOOLEAN** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false]
12
+ **organisation_prefix** | **String** | A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** | [optional]
13
+ **unsubscribe_instruction** | **String** | Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.** | [optional]
14
+
15
+