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,613 @@
1
+ # BrevoRuby::SMSCampaignsApi
2
+
3
+ All URIs are relative to *https://api.brevo.com/v3*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create_sms_campaign**](SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
8
+ [**delete_sms_campaign**](SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign
9
+ [**get_sms_campaign**](SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
10
+ [**get_sms_campaigns**](SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns
11
+ [**request_sms_recipient_export**](SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients
12
+ [**send_sms_campaign_now**](SMSCampaignsApi.md#send_sms_campaign_now) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
13
+ [**send_sms_report**](SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report
14
+ [**send_test_sms**](SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign
15
+ [**update_sms_campaign**](SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign
16
+ [**update_sms_campaign_status**](SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status
17
+
18
+
19
+ # **create_sms_campaign**
20
+ > CreateModel create_sms_campaign(create_sms_campaign)
21
+
22
+ Creates an SMS campaign
23
+
24
+ ### Example
25
+ ```ruby
26
+ # load the gem
27
+ require 'brevo-ruby'
28
+ # setup authorization
29
+ BrevoRuby.configure do |config|
30
+ # Configure API key authorization: api-key
31
+ config.api_key['api-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['api-key'] = 'Bearer'
34
+
35
+ # Configure API key authorization: partner-key
36
+ config.api_key['partner-key'] = 'YOUR API KEY'
37
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
38
+ #config.api_key_prefix['partner-key'] = 'Bearer'
39
+ end
40
+
41
+ api_instance = BrevoRuby::SMSCampaignsApi.new
42
+
43
+ create_sms_campaign = BrevoRuby::CreateSmsCampaign.new # CreateSmsCampaign | Values to create an SMS Campaign
44
+
45
+
46
+ begin
47
+ #Creates an SMS campaign
48
+ result = api_instance.create_sms_campaign(create_sms_campaign)
49
+ p result
50
+ rescue BrevoRuby::ApiError => e
51
+ puts "Exception when calling SMSCampaignsApi->create_sms_campaign: #{e}"
52
+ end
53
+ ```
54
+
55
+ ### Parameters
56
+
57
+ Name | Type | Description | Notes
58
+ ------------- | ------------- | ------------- | -------------
59
+ **create_sms_campaign** | [**CreateSmsCampaign**](CreateSmsCampaign.md)| Values to create an SMS Campaign |
60
+
61
+ ### Return type
62
+
63
+ [**CreateModel**](CreateModel.md)
64
+
65
+ ### Authorization
66
+
67
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
68
+
69
+ ### HTTP request headers
70
+
71
+ - **Content-Type**: application/json
72
+ - **Accept**: application/json
73
+
74
+
75
+
76
+ # **delete_sms_campaign**
77
+ > delete_sms_campaign(campaign_id)
78
+
79
+ Delete an SMS campaign
80
+
81
+ ### Example
82
+ ```ruby
83
+ # load the gem
84
+ require 'brevo-ruby'
85
+ # setup authorization
86
+ BrevoRuby.configure do |config|
87
+ # Configure API key authorization: api-key
88
+ config.api_key['api-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['api-key'] = 'Bearer'
91
+
92
+ # Configure API key authorization: partner-key
93
+ config.api_key['partner-key'] = 'YOUR API KEY'
94
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
95
+ #config.api_key_prefix['partner-key'] = 'Bearer'
96
+ end
97
+
98
+ api_instance = BrevoRuby::SMSCampaignsApi.new
99
+
100
+ campaign_id = 789 # Integer | id of the SMS campaign
101
+
102
+
103
+ begin
104
+ #Delete an SMS campaign
105
+ api_instance.delete_sms_campaign(campaign_id)
106
+ rescue BrevoRuby::ApiError => e
107
+ puts "Exception when calling SMSCampaignsApi->delete_sms_campaign: #{e}"
108
+ end
109
+ ```
110
+
111
+ ### Parameters
112
+
113
+ Name | Type | Description | Notes
114
+ ------------- | ------------- | ------------- | -------------
115
+ **campaign_id** | **Integer**| id of the SMS campaign |
116
+
117
+ ### Return type
118
+
119
+ nil (empty response body)
120
+
121
+ ### Authorization
122
+
123
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
124
+
125
+ ### HTTP request headers
126
+
127
+ - **Content-Type**: application/json
128
+ - **Accept**: application/json
129
+
130
+
131
+
132
+ # **get_sms_campaign**
133
+ > GetSmsCampaign get_sms_campaign(campaign_id)
134
+
135
+ Get an SMS campaign
136
+
137
+ ### Example
138
+ ```ruby
139
+ # load the gem
140
+ require 'brevo-ruby'
141
+ # setup authorization
142
+ BrevoRuby.configure do |config|
143
+ # Configure API key authorization: api-key
144
+ config.api_key['api-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['api-key'] = 'Bearer'
147
+
148
+ # Configure API key authorization: partner-key
149
+ config.api_key['partner-key'] = 'YOUR API KEY'
150
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
151
+ #config.api_key_prefix['partner-key'] = 'Bearer'
152
+ end
153
+
154
+ api_instance = BrevoRuby::SMSCampaignsApi.new
155
+
156
+ campaign_id = 789 # Integer | id of the SMS campaign
157
+
158
+
159
+ begin
160
+ #Get an SMS campaign
161
+ result = api_instance.get_sms_campaign(campaign_id)
162
+ p result
163
+ rescue BrevoRuby::ApiError => e
164
+ puts "Exception when calling SMSCampaignsApi->get_sms_campaign: #{e}"
165
+ end
166
+ ```
167
+
168
+ ### Parameters
169
+
170
+ Name | Type | Description | Notes
171
+ ------------- | ------------- | ------------- | -------------
172
+ **campaign_id** | **Integer**| id of the SMS campaign |
173
+
174
+ ### Return type
175
+
176
+ [**GetSmsCampaign**](GetSmsCampaign.md)
177
+
178
+ ### Authorization
179
+
180
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
181
+
182
+ ### HTTP request headers
183
+
184
+ - **Content-Type**: application/json
185
+ - **Accept**: application/json
186
+
187
+
188
+
189
+ # **get_sms_campaigns**
190
+ > GetSmsCampaigns get_sms_campaigns(opts)
191
+
192
+ Returns the information for all your created SMS campaigns
193
+
194
+ ### Example
195
+ ```ruby
196
+ # load the gem
197
+ require 'brevo-ruby'
198
+ # setup authorization
199
+ BrevoRuby.configure do |config|
200
+ # Configure API key authorization: api-key
201
+ config.api_key['api-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['api-key'] = 'Bearer'
204
+
205
+ # Configure API key authorization: partner-key
206
+ config.api_key['partner-key'] = 'YOUR API KEY'
207
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
208
+ #config.api_key_prefix['partner-key'] = 'Bearer'
209
+ end
210
+
211
+ api_instance = BrevoRuby::SMSCampaignsApi.new
212
+
213
+ opts = {
214
+ status: 'status_example', # String | Status of campaign.
215
+ start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
216
+ end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
217
+ limit: 500, # Integer | Number limitation for the result returned
218
+ offset: 0, # Integer | Beginning point in the list to retrieve from.
219
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
220
+ }
221
+
222
+ begin
223
+ #Returns the information for all your created SMS campaigns
224
+ result = api_instance.get_sms_campaigns(opts)
225
+ p result
226
+ rescue BrevoRuby::ApiError => e
227
+ puts "Exception when calling SMSCampaignsApi->get_sms_campaigns: #{e}"
228
+ end
229
+ ```
230
+
231
+ ### Parameters
232
+
233
+ Name | Type | Description | Notes
234
+ ------------- | ------------- | ------------- | -------------
235
+ **status** | **String**| Status of campaign. | [optional]
236
+ **start_date** | **String**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
237
+ **end_date** | **String**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
238
+ **limit** | **Integer**| Number limitation for the result returned | [optional] [default to 500]
239
+ **offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
240
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
241
+
242
+ ### Return type
243
+
244
+ [**GetSmsCampaigns**](GetSmsCampaigns.md)
245
+
246
+ ### Authorization
247
+
248
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
249
+
250
+ ### HTTP request headers
251
+
252
+ - **Content-Type**: application/json
253
+ - **Accept**: application/json
254
+
255
+
256
+
257
+ # **request_sms_recipient_export**
258
+ > CreatedProcessId request_sms_recipient_export(campaign_id, opts)
259
+
260
+ Export an SMS campaign's recipients
261
+
262
+ It returns the background process ID which on completion calls the notify URL that you have set in the input.
263
+
264
+ ### Example
265
+ ```ruby
266
+ # load the gem
267
+ require 'brevo-ruby'
268
+ # setup authorization
269
+ BrevoRuby.configure do |config|
270
+ # Configure API key authorization: api-key
271
+ config.api_key['api-key'] = 'YOUR API KEY'
272
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
273
+ #config.api_key_prefix['api-key'] = 'Bearer'
274
+
275
+ # Configure API key authorization: partner-key
276
+ config.api_key['partner-key'] = 'YOUR API KEY'
277
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
278
+ #config.api_key_prefix['partner-key'] = 'Bearer'
279
+ end
280
+
281
+ api_instance = BrevoRuby::SMSCampaignsApi.new
282
+
283
+ campaign_id = 789 # Integer | id of the campaign
284
+
285
+ opts = {
286
+ recipient_export: BrevoRuby::RequestSmsRecipientExport.new # RequestSmsRecipientExport | Values to send for a recipient export request
287
+ }
288
+
289
+ begin
290
+ #Export an SMS campaign's recipients
291
+ result = api_instance.request_sms_recipient_export(campaign_id, opts)
292
+ p result
293
+ rescue BrevoRuby::ApiError => e
294
+ puts "Exception when calling SMSCampaignsApi->request_sms_recipient_export: #{e}"
295
+ end
296
+ ```
297
+
298
+ ### Parameters
299
+
300
+ Name | Type | Description | Notes
301
+ ------------- | ------------- | ------------- | -------------
302
+ **campaign_id** | **Integer**| id of the campaign |
303
+ **recipient_export** | [**RequestSmsRecipientExport**](RequestSmsRecipientExport.md)| Values to send for a recipient export request | [optional]
304
+
305
+ ### Return type
306
+
307
+ [**CreatedProcessId**](CreatedProcessId.md)
308
+
309
+ ### Authorization
310
+
311
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
312
+
313
+ ### HTTP request headers
314
+
315
+ - **Content-Type**: application/json
316
+ - **Accept**: application/json
317
+
318
+
319
+
320
+ # **send_sms_campaign_now**
321
+ > send_sms_campaign_now(campaign_id)
322
+
323
+ Send your SMS campaign immediately
324
+
325
+ ### Example
326
+ ```ruby
327
+ # load the gem
328
+ require 'brevo-ruby'
329
+ # setup authorization
330
+ BrevoRuby.configure do |config|
331
+ # Configure API key authorization: api-key
332
+ config.api_key['api-key'] = 'YOUR API KEY'
333
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
334
+ #config.api_key_prefix['api-key'] = 'Bearer'
335
+
336
+ # Configure API key authorization: partner-key
337
+ config.api_key['partner-key'] = 'YOUR API KEY'
338
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
339
+ #config.api_key_prefix['partner-key'] = 'Bearer'
340
+ end
341
+
342
+ api_instance = BrevoRuby::SMSCampaignsApi.new
343
+
344
+ campaign_id = 789 # Integer | id of the campaign
345
+
346
+
347
+ begin
348
+ #Send your SMS campaign immediately
349
+ api_instance.send_sms_campaign_now(campaign_id)
350
+ rescue BrevoRuby::ApiError => e
351
+ puts "Exception when calling SMSCampaignsApi->send_sms_campaign_now: #{e}"
352
+ end
353
+ ```
354
+
355
+ ### Parameters
356
+
357
+ Name | Type | Description | Notes
358
+ ------------- | ------------- | ------------- | -------------
359
+ **campaign_id** | **Integer**| id of the campaign |
360
+
361
+ ### Return type
362
+
363
+ nil (empty response body)
364
+
365
+ ### Authorization
366
+
367
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
368
+
369
+ ### HTTP request headers
370
+
371
+ - **Content-Type**: application/json
372
+ - **Accept**: application/json
373
+
374
+
375
+
376
+ # **send_sms_report**
377
+ > send_sms_report(campaign_id, send_report)
378
+
379
+ Send an SMS campaign's report
380
+
381
+ Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
382
+
383
+ ### Example
384
+ ```ruby
385
+ # load the gem
386
+ require 'brevo-ruby'
387
+ # setup authorization
388
+ BrevoRuby.configure do |config|
389
+ # Configure API key authorization: api-key
390
+ config.api_key['api-key'] = 'YOUR API KEY'
391
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
392
+ #config.api_key_prefix['api-key'] = 'Bearer'
393
+
394
+ # Configure API key authorization: partner-key
395
+ config.api_key['partner-key'] = 'YOUR API KEY'
396
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
397
+ #config.api_key_prefix['partner-key'] = 'Bearer'
398
+ end
399
+
400
+ api_instance = BrevoRuby::SMSCampaignsApi.new
401
+
402
+ campaign_id = 789 # Integer | id of the campaign
403
+
404
+ send_report = BrevoRuby::SendReport.new # SendReport | Values for send a report
405
+
406
+
407
+ begin
408
+ #Send an SMS campaign's report
409
+ api_instance.send_sms_report(campaign_id, send_report)
410
+ rescue BrevoRuby::ApiError => e
411
+ puts "Exception when calling SMSCampaignsApi->send_sms_report: #{e}"
412
+ end
413
+ ```
414
+
415
+ ### Parameters
416
+
417
+ Name | Type | Description | Notes
418
+ ------------- | ------------- | ------------- | -------------
419
+ **campaign_id** | **Integer**| id of the campaign |
420
+ **send_report** | [**SendReport**](SendReport.md)| Values for send a report |
421
+
422
+ ### Return type
423
+
424
+ nil (empty response body)
425
+
426
+ ### Authorization
427
+
428
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
429
+
430
+ ### HTTP request headers
431
+
432
+ - **Content-Type**: application/json
433
+ - **Accept**: application/json
434
+
435
+
436
+
437
+ # **send_test_sms**
438
+ > send_test_sms(campaign_id, phone_number)
439
+
440
+ Send a test SMS campaign
441
+
442
+ ### Example
443
+ ```ruby
444
+ # load the gem
445
+ require 'brevo-ruby'
446
+ # setup authorization
447
+ BrevoRuby.configure do |config|
448
+ # Configure API key authorization: api-key
449
+ config.api_key['api-key'] = 'YOUR API KEY'
450
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
451
+ #config.api_key_prefix['api-key'] = 'Bearer'
452
+
453
+ # Configure API key authorization: partner-key
454
+ config.api_key['partner-key'] = 'YOUR API KEY'
455
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
456
+ #config.api_key_prefix['partner-key'] = 'Bearer'
457
+ end
458
+
459
+ api_instance = BrevoRuby::SMSCampaignsApi.new
460
+
461
+ campaign_id = 789 # Integer | Id of the SMS campaign
462
+
463
+ phone_number = BrevoRuby::SendTestSms.new # SendTestSms | Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted
464
+
465
+
466
+ begin
467
+ #Send a test SMS campaign
468
+ api_instance.send_test_sms(campaign_id, phone_number)
469
+ rescue BrevoRuby::ApiError => e
470
+ puts "Exception when calling SMSCampaignsApi->send_test_sms: #{e}"
471
+ end
472
+ ```
473
+
474
+ ### Parameters
475
+
476
+ Name | Type | Description | Notes
477
+ ------------- | ------------- | ------------- | -------------
478
+ **campaign_id** | **Integer**| Id of the SMS campaign |
479
+ **phone_number** | [**SendTestSms**](SendTestSms.md)| Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted |
480
+
481
+ ### Return type
482
+
483
+ nil (empty response body)
484
+
485
+ ### Authorization
486
+
487
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
488
+
489
+ ### HTTP request headers
490
+
491
+ - **Content-Type**: application/json
492
+ - **Accept**: application/json
493
+
494
+
495
+
496
+ # **update_sms_campaign**
497
+ > update_sms_campaign(campaign_id, update_sms_campaign)
498
+
499
+ Update an SMS campaign
500
+
501
+ ### Example
502
+ ```ruby
503
+ # load the gem
504
+ require 'brevo-ruby'
505
+ # setup authorization
506
+ BrevoRuby.configure do |config|
507
+ # Configure API key authorization: api-key
508
+ config.api_key['api-key'] = 'YOUR API KEY'
509
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
510
+ #config.api_key_prefix['api-key'] = 'Bearer'
511
+
512
+ # Configure API key authorization: partner-key
513
+ config.api_key['partner-key'] = 'YOUR API KEY'
514
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
515
+ #config.api_key_prefix['partner-key'] = 'Bearer'
516
+ end
517
+
518
+ api_instance = BrevoRuby::SMSCampaignsApi.new
519
+
520
+ campaign_id = 789 # Integer | id of the SMS campaign
521
+
522
+ update_sms_campaign = BrevoRuby::UpdateSmsCampaign.new # UpdateSmsCampaign | Values to update an SMS Campaign
523
+
524
+
525
+ begin
526
+ #Update an SMS campaign
527
+ api_instance.update_sms_campaign(campaign_id, update_sms_campaign)
528
+ rescue BrevoRuby::ApiError => e
529
+ puts "Exception when calling SMSCampaignsApi->update_sms_campaign: #{e}"
530
+ end
531
+ ```
532
+
533
+ ### Parameters
534
+
535
+ Name | Type | Description | Notes
536
+ ------------- | ------------- | ------------- | -------------
537
+ **campaign_id** | **Integer**| id of the SMS campaign |
538
+ **update_sms_campaign** | [**UpdateSmsCampaign**](UpdateSmsCampaign.md)| Values to update an SMS Campaign |
539
+
540
+ ### Return type
541
+
542
+ nil (empty response body)
543
+
544
+ ### Authorization
545
+
546
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
547
+
548
+ ### HTTP request headers
549
+
550
+ - **Content-Type**: application/json
551
+ - **Accept**: application/json
552
+
553
+
554
+
555
+ # **update_sms_campaign_status**
556
+ > update_sms_campaign_status(campaign_id, status)
557
+
558
+ Update a campaign's status
559
+
560
+ ### Example
561
+ ```ruby
562
+ # load the gem
563
+ require 'brevo-ruby'
564
+ # setup authorization
565
+ BrevoRuby.configure do |config|
566
+ # Configure API key authorization: api-key
567
+ config.api_key['api-key'] = 'YOUR API KEY'
568
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
569
+ #config.api_key_prefix['api-key'] = 'Bearer'
570
+
571
+ # Configure API key authorization: partner-key
572
+ config.api_key['partner-key'] = 'YOUR API KEY'
573
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
574
+ #config.api_key_prefix['partner-key'] = 'Bearer'
575
+ end
576
+
577
+ api_instance = BrevoRuby::SMSCampaignsApi.new
578
+
579
+ campaign_id = 789 # Integer | id of the campaign
580
+
581
+ status = BrevoRuby::UpdateCampaignStatus.new # UpdateCampaignStatus | Status of the campaign.
582
+
583
+
584
+ begin
585
+ #Update a campaign's status
586
+ api_instance.update_sms_campaign_status(campaign_id, status)
587
+ rescue BrevoRuby::ApiError => e
588
+ puts "Exception when calling SMSCampaignsApi->update_sms_campaign_status: #{e}"
589
+ end
590
+ ```
591
+
592
+ ### Parameters
593
+
594
+ Name | Type | Description | Notes
595
+ ------------- | ------------- | ------------- | -------------
596
+ **campaign_id** | **Integer**| id of the campaign |
597
+ **status** | [**UpdateCampaignStatus**](UpdateCampaignStatus.md)| Status of the campaign. |
598
+
599
+ ### Return type
600
+
601
+ nil (empty response body)
602
+
603
+ ### Authorization
604
+
605
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
606
+
607
+ ### HTTP request headers
608
+
609
+ - **Content-Type**: application/json
610
+ - **Accept**: application/json
611
+
612
+
613
+
@@ -0,0 +1,10 @@
1
+ # BrevoRuby::ScheduleSmtpEmail
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **message_id** | **String** | Message ID of the transactional email scheduled | [optional]
7
+ **message_ids** | **Array<String>** | | [optional]
8
+ **batch_id** | **String** | Batch ID of the batch transactional email scheduled | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # BrevoRuby::SendReport
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **language** | **String** | Language of email content for campaign report sending. | [optional] [default to 'fr']
7
+ **email** | [**SendReportEmail**](SendReportEmail.md) | |
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # BrevoRuby::SendReportEmail
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **to** | **Array<String>** | Email addresses of the recipients |
7
+ **body** | **String** | Custom text message to be presented in the report email. |
8
+
9
+
data/docs/SendSms.md ADDED
@@ -0,0 +1,12 @@
1
+ # BrevoRuby::SendSms
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **reference** | **String** | |
7
+ **message_id** | **Integer** | |
8
+ **sms_count** | **Integer** | Count of SMS's to send multiple text messages | [optional]
9
+ **used_credits** | **Float** | SMS credits used per text message | [optional]
10
+ **remaining_credits** | **Float** | Remaining SMS credits of the user | [optional]
11
+
12
+
@@ -0,0 +1,23 @@
1
+ # BrevoRuby::SendSmtpEmail
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional]
7
+ **to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] | [optional]
8
+ **bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
9
+ **cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
10
+ **html_content** | **String** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional]
11
+ **text_content** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional]
12
+ **subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
13
+ **reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
14
+ **attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: 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, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass and xlsm ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
15
+ **headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\", \"idempotencyKey\":\"abc-123\"}`. | [optional]
16
+ **‘templateId’** | **Integer** | Id of the template. | [optional]
17
+ **params** | **Object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional]
18
+ **message_versions** | [**Array<SendSmtpEmailMessageVersions>**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a mail. templateId can be customized only if global parameter contains templateId. htmlContent and textContent can be customized only if any of the two, htmlContent or textContent, is present in global parameters. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 2000. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.brevo.com/docs/batch-send-transactional-emails | [optional]
19
+ **tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
20
+ **scheduled_at** | **DateTime** | UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery. **Please note this feature is currently a public beta**. | [optional]
21
+ **batch_id** | **String** | Valid UUIDv4 batch id to identify the scheduled batches transactional email. If not passed we will create a valid UUIDv4 batch id at our end. | [optional]
22
+
23
+
@@ -0,0 +1,10 @@
1
+ # BrevoRuby::SendSmtpEmailAttachment
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **url** | **String** | Absolute url of the attachment (no local file). | [optional]
7
+ **content** | **String** | Base64 encoded chunk data of the attachment generated on the fly | [optional]
8
+ **name** | **String** | Required if content is passed. Name of the attachment | [optional]
9
+
10
+