brevo 3.0.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1278) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +210 -39
  3. data/brevo-3.0.0.gem +0 -0
  4. data/brevo.gemspec +1 -1
  5. data/docs/AccountApi.md +2 -0
  6. data/docs/AddContactToList.md +3 -2
  7. data/docs/AddSubscriptionMemberPayload.md +10 -0
  8. data/docs/AggregateBalance.md +9 -0
  9. data/docs/Balance.md +16 -0
  10. data/docs/BalanceApi.md +1203 -0
  11. data/docs/BalanceDataPerContact.md +11 -0
  12. data/docs/BalanceDefinition.md +27 -0
  13. data/docs/BalanceDefinitionPage.md +8 -0
  14. data/docs/BalanceLimit.md +17 -0
  15. data/docs/BalanceOrder.md +19 -0
  16. data/docs/Body1.md +2 -2
  17. data/docs/Body10.md +4 -10
  18. data/docs/Body11.md +4 -6
  19. data/docs/Body12.md +4 -1
  20. data/docs/Body13.md +11 -4
  21. data/docs/Body14.md +10 -1
  22. data/docs/Body15.md +4 -2
  23. data/docs/{ManageIp.md → Body16.md} +2 -2
  24. data/docs/Body17.md +11 -0
  25. data/docs/Body18.md +8 -0
  26. data/docs/Body19.md +11 -0
  27. data/docs/Body2.md +2 -1
  28. data/docs/Body3.md +2 -3
  29. data/docs/Body4.md +1 -3
  30. data/docs/Body5.md +2 -4
  31. data/docs/Body6.md +5 -2
  32. data/docs/Body7.md +5 -2
  33. data/docs/Body8.md +4 -4
  34. data/docs/Body9.md +5 -11
  35. data/docs/Cart.md +9 -0
  36. data/docs/CompaniesApi.md +183 -58
  37. data/docs/Configuration.md +8 -0
  38. data/docs/ContactBalancesResp.md +11 -0
  39. data/docs/ContactErrorModel.md +10 -0
  40. data/docs/ContactsApi.md +103 -24
  41. data/docs/ConversationsApi.md +10 -10
  42. data/docs/ConversationsMessage.md +15 -0
  43. data/docs/ConversationsMessageAttachments.md +13 -0
  44. data/docs/ConversationsMessageForwardedToSourceStatus.md +9 -0
  45. data/docs/ConversationsMessageFrom.md +9 -0
  46. data/docs/ConversationsMessageReplyTo.md +9 -0
  47. data/docs/ConversationsMessageTo.md +9 -0
  48. data/docs/ConversionSourceMetrics.md +1 -1
  49. data/docs/CorporateuseremailpermissionsPrivileges.md +9 -0
  50. data/docs/CouponsApi.md +4 -4
  51. data/docs/CreateAttribute.md +3 -2
  52. data/docs/CreateBalanceDefinitionPayload.md +23 -0
  53. data/docs/CreateBalanceLimitPayload.md +13 -0
  54. data/docs/CreateBalancePayload.md +8 -0
  55. data/docs/CreateContact.md +2 -2
  56. data/docs/CreateDoiContact.md +1 -1
  57. data/docs/CreateEmailCampaign.md +1 -0
  58. data/docs/CreateEmailCampaignEmailExpirationDate.md +9 -0
  59. data/docs/CreateEmailCampaignRecipients.md +1 -0
  60. data/docs/CreateLoyaltyProgramPayload.md +11 -0
  61. data/docs/CreateOrderPayload.md +14 -0
  62. data/docs/CreatePaymentRequest.md +13 -0
  63. data/docs/CreatePaymentResponse.md +9 -0
  64. data/docs/CreateSubAccount.md +1 -0
  65. data/docs/CreateSubscriptionPayload.md +10 -0
  66. data/docs/CreateSubscriptionResponse.md +14 -0
  67. data/docs/CreateTierGroupRequest.md +11 -0
  68. data/docs/CreateTransactionPayload.md +16 -0
  69. data/docs/CreateUpdateCategories.md +1 -0
  70. data/docs/CreateUpdateCategory.md +1 -0
  71. data/docs/CreateUpdateProduct.md +2 -1
  72. data/docs/CreateUpdateProducts.md +2 -1
  73. data/docs/CreateWebhook.md +2 -1
  74. data/docs/DealsApi.md +131 -6
  75. data/docs/EcommerceApi.md +155 -36
  76. data/docs/EmailCampaignsApi.md +2 -2
  77. data/docs/ErrorResponse.md +8 -0
  78. data/docs/EventIdentifiers.md +5 -5
  79. data/docs/FetchTemplatePreview.md +10 -0
  80. data/docs/GetAccountPlan.md +2 -3
  81. data/docs/GetAttributesAttributes.md +1 -0
  82. data/docs/GetCampaignStats.md +2 -0
  83. data/docs/GetCorporateInvitedUsersListFeatureAccess.md +5 -0
  84. data/docs/GetCorporateUserPermissionFeatureAccess.md +5 -0
  85. data/docs/GetEmailCampaign.md +4 -0
  86. data/docs/GetExtendedCampaignOverview.md +4 -0
  87. data/docs/GetPaymentRequest.md +14 -0
  88. data/docs/{GetSegmentsSegments.md → GetSegment.md} +4 -4
  89. data/docs/GetSegments.md +1 -1
  90. data/docs/GetTransacAggregatedSmsReport.md +3 -2
  91. data/docs/GetTransacSmsReportReports.md +3 -2
  92. data/docs/InlineResponse2003.md +1 -3
  93. data/docs/InlineResponse2004.md +8 -0
  94. data/docs/InlineResponse2005.md +8 -0
  95. data/docs/InlineResponse2006.md +9 -0
  96. data/docs/InlineResponse2006Totals.md +10 -0
  97. data/docs/InlineResponse2007.md +9 -0
  98. data/docs/InlineResponse2008.md +8 -0
  99. data/docs/InlineResponse2009.md +10 -0
  100. data/docs/InlineResponse400.md +8 -0
  101. data/docs/LoyaltyProgram.md +19 -0
  102. data/docs/LoyaltyProgramPage.md +8 -0
  103. data/docs/LoyaltyProgramValidationError.md +10 -0
  104. data/docs/LoyaltyTierPage.md +8 -0
  105. data/docs/MainAttributeRewardPayload.md +14 -0
  106. data/docs/MainBillingPayload.md +14 -0
  107. data/docs/MainCodeCountHttpResponse.md +8 -0
  108. data/docs/MainCreateRedeemPayload.md +15 -0
  109. data/docs/MainCreateRedeemPayloadOrder.md +7 -0
  110. data/docs/MainCreateRewardPayload.md +11 -0
  111. data/docs/MainCreateRewardResponse.md +15 -0
  112. data/docs/MainErrorResponse.md +8 -0
  113. data/docs/MainFilter.md +9 -0
  114. data/docs/MainGenerator.md +13 -0
  115. data/docs/MainGetContactRewardsPayload.md +14 -0
  116. data/docs/MainIdentifiersPayload.md +9 -0
  117. data/docs/MainLimit.md +15 -0
  118. data/docs/MainModelContactReward.md +17 -0
  119. data/docs/MainModelContactRewardsResp.md +12 -0
  120. data/docs/MainNodeResponse.md +15 -0
  121. data/docs/MainOrderPayload.md +19 -0
  122. data/docs/MainOrderPayloadBilling.md +7 -0
  123. data/docs/MainOrderPayloadIdentifiers.md +7 -0
  124. data/docs/MainProduct.md +11 -0
  125. data/docs/MainProductPayload.md +12 -0
  126. data/docs/MainRedeem.md +21 -0
  127. data/docs/MainResultParameterResponse.md +9 -0
  128. data/docs/MainResultParameterResponseValue.md +7 -0
  129. data/docs/MainReward.md +47 -0
  130. data/docs/MainRewardAttribution.md +18 -0
  131. data/docs/MainRewardConfigurations.md +10 -0
  132. data/docs/MainRewardGenerator.md +7 -0
  133. data/docs/MainRewardPage.md +9 -0
  134. data/docs/MainRewardPageObj.md +16 -0
  135. data/docs/{GetChildDomains.md → MainRewardRule.md} +1 -1
  136. data/docs/MainRewardValidate.md +8 -0
  137. data/docs/MainRule.md +20 -0
  138. data/docs/MainRuleCondition.md +7 -0
  139. data/docs/MainRuleConditionResponse.md +12 -0
  140. data/docs/MainRuleConditionResponseLhs.md +7 -0
  141. data/docs/MainRuleConditionResponseRhs.md +7 -0
  142. data/docs/MainRuleEvent.md +7 -0
  143. data/docs/MainRuleEventResponse.md +9 -0
  144. data/docs/MainRuleResultResponse.md +10 -0
  145. data/docs/MainValidateRewardPayload.md +13 -0
  146. data/docs/MainValueResponse.md +15 -0
  147. data/docs/MainValueResponseExpression.md +7 -0
  148. data/docs/MainVoucherRevokePayload.md +8 -0
  149. data/docs/MasterAccountApi.md +304 -7
  150. data/docs/MemberContact.md +10 -0
  151. data/docs/ModelSubscriptionBalanceResp.md +8 -0
  152. data/docs/Notification.md +9 -0
  153. data/docs/Order.md +3 -1
  154. data/docs/OrderBilling.md +2 -1
  155. data/docs/OrderIdentifiers.md +11 -0
  156. data/docs/PatchLoyaltyProgramPayload.md +10 -0
  157. data/docs/PaymentsApi.md +181 -0
  158. data/docs/ProgramApi.md +695 -0
  159. data/docs/RemoveContactFromList.md +4 -3
  160. data/docs/RequestContactExport.md +5 -1
  161. data/docs/RequestContactExportCustomContactFilter.md +2 -1
  162. data/docs/RewardApi.md +664 -0
  163. data/docs/SendSmtpEmail.md +19 -18
  164. data/docs/SendTransacSms.md +1 -1
  165. data/docs/SendTransacSmsTag.md +8 -0
  166. data/docs/SetConfigDisplayCurrency.md +8 -0
  167. data/docs/SubAccountDetailsResponse.md +1 -0
  168. data/docs/SubAccountDetailsResponseGroups.md +9 -0
  169. data/docs/SubAccountDetailsResponsePlanInfoCredits.md +4 -1
  170. data/docs/SubAccountDetailsResponsePlanInfoCreditsExternalFeeds.md +9 -0
  171. data/docs/SubAccountDetailsResponsePlanInfoCreditsSms.md +9 -0
  172. data/docs/SubAccountDetailsResponsePlanInfoCreditsWhatsapp.md +9 -0
  173. data/docs/SubAccountDetailsResponsePlanInfoCreditsWpSubscribers.md +9 -0
  174. data/docs/SubAccountDetailsResponsePlanInfoFeatures.md +1 -0
  175. data/docs/SubAccountDetailsResponsePlanInfoFeaturesSalesUsers.md +9 -0
  176. data/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +2 -2
  177. data/docs/SubAccountUpdatePlanRequestCredits.md +5 -1
  178. data/docs/SubAccountUpdatePlanRequestFeatures.md +2 -1
  179. data/docs/SubAccountsResponseGroups.md +9 -0
  180. data/docs/SubAccountsResponseSubAccounts.md +1 -0
  181. data/docs/SubAccountsUpdatePlanRequest.md +10 -0
  182. data/docs/SubAccountsUpdatePlanRequestCredits.md +12 -0
  183. data/docs/SubAccountsUpdatePlanRequestFeatures.md +10 -0
  184. data/docs/Subscription.md +14 -0
  185. data/docs/SubscriptionAggregateBalance.md +9 -0
  186. data/docs/SubscriptionAttributedReward.md +16 -0
  187. data/docs/SubscriptionBalances.md +10 -0
  188. data/docs/SubscriptionHandlerInfo.md +11 -0
  189. data/docs/SubscriptionHandlerInfoBalance.md +7 -0
  190. data/docs/SubscriptionMember.md +12 -0
  191. data/docs/SubscriptionTier.md +14 -0
  192. data/docs/TasksApi.md +4 -4
  193. data/docs/TemplatePreview.md +13 -0
  194. data/docs/Tier.md +16 -0
  195. data/docs/TierAccessConditions.md +11 -0
  196. data/docs/TierApi.md +656 -0
  197. data/docs/TierForContact.md +14 -0
  198. data/docs/TierGroup.md +15 -0
  199. data/docs/TierGroupPage.md +8 -0
  200. data/docs/TierRequest.md +11 -0
  201. data/docs/TierRequestAccessConditions.md +9 -0
  202. data/docs/TierRequestPutPayload.md +11 -0
  203. data/docs/TierRequestTierRewards.md +8 -0
  204. data/docs/TierTierRewards.md +10 -0
  205. data/docs/Transaction.md +22 -0
  206. data/docs/TransactionHistory.md +17 -0
  207. data/docs/TransactionHistoryResp.md +12 -0
  208. data/docs/TransactionalEmailsApi.md +60 -2
  209. data/docs/TransactionalSMSApi.md +51 -0
  210. data/docs/UnauthorizedResponse.md +8 -0
  211. data/docs/UpdateAttribute.md +2 -1
  212. data/docs/UpdateBalanceDefinitionPayload.md +23 -0
  213. data/docs/UpdateBalanceLimitPayload.md +13 -0
  214. data/docs/UpdateContact.md +1 -1
  215. data/docs/UpdateEmailCampaign.md +1 -0
  216. data/docs/UpdateEmailCampaignEmailExpirationDate.md +9 -0
  217. data/docs/UpdateEmailCampaignRecipients.md +1 -0
  218. data/docs/UpdateLoyaltyProgramPayload.md +10 -0
  219. data/docs/UpdateTierGroupRequest.md +11 -0
  220. data/docs/UserApi.md +2 -2
  221. data/docs/ValidationErrors.md +7 -0
  222. data/lib/brevo/api/account_api.rb +4 -1
  223. data/lib/brevo/api/balance_api.rb +1244 -0
  224. data/lib/brevo/api/companies_api.rb +167 -47
  225. data/lib/brevo/api/contacts_api.rb +122 -36
  226. data/lib/brevo/api/conversations_api.rb +3 -3
  227. data/lib/brevo/api/coupons_api.rb +9 -6
  228. data/lib/brevo/api/deals_api.rb +121 -1
  229. data/lib/brevo/api/domains_api.rb +1 -1
  230. data/lib/brevo/api/ecommerce_api.rb +159 -41
  231. data/lib/brevo/api/email_campaigns_api.rb +5 -5
  232. data/lib/brevo/api/events_api.rb +1 -1
  233. data/lib/brevo/api/external_feeds_api.rb +1 -1
  234. data/lib/brevo/api/files_api.rb +1 -1
  235. data/lib/brevo/api/inbound_parsing_api.rb +1 -1
  236. data/lib/brevo/api/master_account_api.rb +278 -7
  237. data/lib/brevo/api/notes_api.rb +1 -1
  238. data/lib/brevo/api/payments_api.rb +188 -0
  239. data/lib/brevo/api/process_api.rb +1 -1
  240. data/lib/brevo/api/program_api.rb +663 -0
  241. data/lib/brevo/api/reward_api.rb +684 -0
  242. data/lib/brevo/api/senders_api.rb +1 -1
  243. data/lib/brevo/api/sms_campaigns_api.rb +1 -1
  244. data/lib/brevo/api/tasks_api.rb +1 -1
  245. data/lib/brevo/api/tier_api.rb +653 -0
  246. data/lib/brevo/api/transactional_emails_api.rb +55 -3
  247. data/lib/brevo/api/transactional_sms_api.rb +48 -3
  248. data/lib/brevo/api/transactional_whats_app_api.rb +3 -3
  249. data/lib/brevo/api/user_api.rb +5 -5
  250. data/lib/brevo/api/webhooks_api.rb +1 -1
  251. data/lib/brevo/api/whats_app_campaigns_api.rb +1 -1
  252. data/lib/brevo/api_client.rb +1 -1
  253. data/lib/brevo/api_error.rb +1 -1
  254. data/lib/brevo/configuration.rb +1 -1
  255. data/lib/brevo/models/ab_test_campaign_result.rb +1 -1
  256. data/lib/brevo/models/ab_test_campaign_result_clicked_links.rb +1 -1
  257. data/lib/brevo/models/ab_test_campaign_result_statistics.rb +1 -1
  258. data/lib/brevo/models/ab_test_version_clicks.rb +1 -1
  259. data/lib/brevo/models/ab_test_version_clicks_inner.rb +1 -1
  260. data/lib/brevo/models/ab_test_version_stats.rb +1 -1
  261. data/lib/brevo/models/add_child_domain.rb +1 -1
  262. data/lib/brevo/models/add_contact_to_list.rb +19 -7
  263. data/lib/brevo/models/add_subscription_member_payload.rb +227 -0
  264. data/lib/brevo/models/aggregate_balance.rb +195 -0
  265. data/lib/brevo/models/authenticate_domain_model.rb +1 -1
  266. data/lib/brevo/models/balance.rb +265 -0
  267. data/lib/brevo/models/balance_data_per_contact.rb +211 -0
  268. data/lib/brevo/models/balance_definition.rb +411 -0
  269. data/lib/brevo/models/balance_definition_page.rb +187 -0
  270. data/lib/brevo/models/balance_limit.rb +285 -0
  271. data/lib/brevo/models/balance_order.rb +345 -0
  272. data/lib/brevo/models/block_domain.rb +1 -1
  273. data/lib/brevo/models/body.rb +1 -1
  274. data/lib/brevo/models/body_1.rb +25 -20
  275. data/lib/brevo/models/body_10.rb +31 -88
  276. data/lib/brevo/models/body_11.rb +34 -60
  277. data/lib/brevo/models/body_12.rb +47 -14
  278. data/lib/brevo/models/body_13.rb +131 -36
  279. data/lib/brevo/models/body_14.rb +105 -14
  280. data/lib/brevo/models/body_15.rb +34 -4
  281. data/lib/brevo/models/body_16.rb +190 -0
  282. data/lib/brevo/models/body_17.rb +225 -0
  283. data/lib/brevo/models/body_18.rb +190 -0
  284. data/lib/brevo/models/body_19.rb +215 -0
  285. data/lib/brevo/models/body_2.rb +28 -13
  286. data/lib/brevo/models/body_3.rb +21 -29
  287. data/lib/brevo/models/body_4.rb +16 -29
  288. data/lib/brevo/models/body_5.rb +26 -43
  289. data/lib/brevo/models/body_6.rb +41 -7
  290. data/lib/brevo/models/body_7.rb +41 -7
  291. data/lib/brevo/models/body_8.rb +20 -20
  292. data/lib/brevo/models/body_9.rb +92 -124
  293. data/lib/brevo/models/body_variables_items.rb +1 -1
  294. data/lib/brevo/models/cart.rb +240 -0
  295. data/lib/brevo/models/companies_list.rb +1 -1
  296. data/lib/brevo/models/company.rb +1 -1
  297. data/lib/brevo/models/company_attributes.rb +1 -1
  298. data/lib/brevo/models/company_attributes_inner.rb +1 -1
  299. data/lib/brevo/models/component_items.rb +1 -1
  300. data/lib/brevo/models/configuration.rb +191 -0
  301. data/lib/brevo/models/contact_balances_resp.rb +213 -0
  302. data/lib/brevo/models/contact_error_model.rb +249 -0
  303. data/lib/brevo/models/conversations_message.rb +160 -5
  304. data/lib/brevo/models/conversations_message_attachments.rb +235 -0
  305. data/lib/brevo/models/conversations_message_file.rb +1 -1
  306. data/lib/brevo/models/conversations_message_file_image_info.rb +1 -1
  307. data/lib/brevo/models/conversations_message_forwarded_to_source_status.rb +194 -0
  308. data/lib/brevo/models/{add_credits.rb → conversations_message_from.rb} +16 -17
  309. data/lib/brevo/models/{remove_credits.rb → conversations_message_reply_to.rb} +16 -17
  310. data/lib/brevo/models/conversations_message_to.rb +193 -0
  311. data/lib/brevo/models/conversion_source_metrics.rb +4 -4
  312. data/lib/brevo/models/conversion_source_product.rb +1 -1
  313. data/lib/brevo/models/corporate_group_details_response.rb +1 -1
  314. data/lib/brevo/models/corporate_group_details_response_group.rb +1 -1
  315. data/lib/brevo/models/corporate_group_details_response_subaccounts.rb +1 -1
  316. data/lib/brevo/models/corporate_group_details_response_users.rb +1 -1
  317. data/lib/brevo/models/corporateuseremailpermissions_privileges.rb +232 -0
  318. data/lib/brevo/models/create_api_key_request.rb +1 -1
  319. data/lib/brevo/models/create_api_key_response.rb +1 -1
  320. data/lib/brevo/models/create_attribute.rb +18 -6
  321. data/lib/brevo/models/create_attribute_enumeration.rb +1 -1
  322. data/lib/brevo/models/create_balance_definition_payload.rb +474 -0
  323. data/lib/brevo/models/create_balance_limit_payload.rb +319 -0
  324. data/lib/brevo/models/create_balance_payload.rb +191 -0
  325. data/lib/brevo/models/create_category_model.rb +1 -1
  326. data/lib/brevo/models/create_child.rb +1 -1
  327. data/lib/brevo/models/create_contact.rb +7 -5
  328. data/lib/brevo/models/create_coupon_collection.rb +1 -1
  329. data/lib/brevo/models/create_coupons.rb +1 -1
  330. data/lib/brevo/models/create_doi_contact.rb +6 -4
  331. data/lib/brevo/models/create_domain.rb +1 -1
  332. data/lib/brevo/models/create_domain_model.rb +1 -1
  333. data/lib/brevo/models/create_domain_model_dns_records.rb +1 -1
  334. data/lib/brevo/models/create_domain_model_dns_records_dkim_record.rb +1 -1
  335. data/lib/brevo/models/create_email_campaign.rb +14 -5
  336. data/lib/brevo/models/create_email_campaign_email_expiration_date.rb +254 -0
  337. data/lib/brevo/models/create_email_campaign_recipients.rb +17 -5
  338. data/lib/brevo/models/create_email_campaign_sender.rb +1 -1
  339. data/lib/brevo/models/create_external_feed.rb +1 -1
  340. data/lib/brevo/models/create_list.rb +1 -1
  341. data/lib/brevo/models/create_loyalty_program_payload.rb +256 -0
  342. data/lib/brevo/models/create_model.rb +1 -1
  343. data/lib/brevo/models/create_order_payload.rb +290 -0
  344. data/lib/brevo/models/create_payment_request.rb +247 -0
  345. data/lib/brevo/models/{create_reseller.rb → create_payment_response.rb} +20 -20
  346. data/lib/brevo/models/create_product_model.rb +1 -1
  347. data/lib/brevo/models/create_sender.rb +1 -1
  348. data/lib/brevo/models/create_sender_ips.rb +1 -1
  349. data/lib/brevo/models/create_sender_model.rb +1 -1
  350. data/lib/brevo/models/create_sms_campaign.rb +1 -1
  351. data/lib/brevo/models/create_sms_campaign_recipients.rb +1 -1
  352. data/lib/brevo/models/create_smtp_email.rb +1 -1
  353. data/lib/brevo/models/create_smtp_template.rb +1 -1
  354. data/lib/brevo/models/create_smtp_template_sender.rb +1 -1
  355. data/lib/brevo/models/create_sub_account.rb +17 -5
  356. data/lib/brevo/models/create_sub_account_response.rb +1 -1
  357. data/lib/brevo/models/create_subscription_payload.rb +225 -0
  358. data/lib/brevo/models/create_subscription_response.rb +245 -0
  359. data/lib/brevo/models/create_tier_group_request.rb +272 -0
  360. data/lib/brevo/models/create_transaction_payload.rb +291 -0
  361. data/lib/brevo/models/create_update_batch_category.rb +1 -1
  362. data/lib/brevo/models/create_update_batch_category_model.rb +1 -1
  363. data/lib/brevo/models/create_update_batch_products.rb +1 -1
  364. data/lib/brevo/models/create_update_batch_products_model.rb +1 -1
  365. data/lib/brevo/models/create_update_categories.rb +15 -5
  366. data/lib/brevo/models/create_update_category.rb +15 -5
  367. data/lib/brevo/models/create_update_contact_model.rb +1 -1
  368. data/lib/brevo/models/create_update_folder.rb +1 -1
  369. data/lib/brevo/models/create_update_product.rb +16 -6
  370. data/lib/brevo/models/create_update_products.rb +16 -6
  371. data/lib/brevo/models/create_webhook.rb +27 -3
  372. data/lib/brevo/models/create_whats_app_campaign.rb +1 -1
  373. data/lib/brevo/models/create_whats_app_campaign_recipients.rb +1 -1
  374. data/lib/brevo/models/create_whats_app_template.rb +1 -1
  375. data/lib/brevo/models/created_batch_id.rb +1 -1
  376. data/lib/brevo/models/created_process_id.rb +1 -1
  377. data/lib/brevo/models/deal.rb +1 -1
  378. data/lib/brevo/models/deal_attributes.rb +1 -1
  379. data/lib/brevo/models/deal_attributes_inner.rb +1 -1
  380. data/lib/brevo/models/deals_list.rb +1 -1
  381. data/lib/brevo/models/delete_hardbounces.rb +1 -1
  382. data/lib/brevo/models/email_export_recipients.rb +1 -1
  383. data/lib/brevo/models/error_model.rb +3 -3
  384. data/lib/brevo/models/{update_child_domain.rb → error_response.rb} +9 -10
  385. data/lib/brevo/models/event.rb +1 -1
  386. data/lib/brevo/models/event_identifiers.rb +21 -31
  387. data/lib/brevo/models/export_webhooks_history.rb +1 -1
  388. data/lib/brevo/models/{remaining_credit_model_reseller.rb → fetch_template_preview.rb} +27 -22
  389. data/lib/brevo/models/file_data.rb +1 -1
  390. data/lib/brevo/models/file_downloadable_link.rb +1 -1
  391. data/lib/brevo/models/file_list.rb +1 -1
  392. data/lib/brevo/models/get_account.rb +1 -1
  393. data/lib/brevo/models/get_account_activity.rb +1 -1
  394. data/lib/brevo/models/get_account_activity_logs.rb +1 -1
  395. data/lib/brevo/models/get_account_marketing_automation.rb +1 -1
  396. data/lib/brevo/models/get_account_plan.rb +9 -19
  397. data/lib/brevo/models/get_account_relay.rb +1 -1
  398. data/lib/brevo/models/get_account_relay_data.rb +1 -1
  399. data/lib/brevo/models/get_aggregated_report.rb +1 -1
  400. data/lib/brevo/models/get_all_external_feeds.rb +1 -1
  401. data/lib/brevo/models/get_all_external_feeds_feeds.rb +1 -1
  402. data/lib/brevo/models/get_attributes.rb +1 -1
  403. data/lib/brevo/models/get_attributes_attributes.rb +19 -7
  404. data/lib/brevo/models/get_attributes_enumeration.rb +1 -1
  405. data/lib/brevo/models/get_blocked_domains.rb +1 -1
  406. data/lib/brevo/models/get_campaign_overview.rb +1 -1
  407. data/lib/brevo/models/get_campaign_recipients.rb +1 -1
  408. data/lib/brevo/models/get_campaign_stats.rb +35 -5
  409. data/lib/brevo/models/get_categories.rb +1 -1
  410. data/lib/brevo/models/get_category_details.rb +1 -1
  411. data/lib/brevo/models/get_child_domain.rb +1 -1
  412. data/lib/brevo/models/get_client.rb +1 -1
  413. data/lib/brevo/models/get_contact_campaign_stats.rb +1 -1
  414. data/lib/brevo/models/get_contact_campaign_stats_clicked.rb +1 -1
  415. data/lib/brevo/models/get_contact_campaign_stats_opened.rb +1 -1
  416. data/lib/brevo/models/get_contact_campaign_stats_transac_attributes.rb +1 -1
  417. data/lib/brevo/models/get_contact_campaign_stats_unsubscriptions.rb +1 -1
  418. data/lib/brevo/models/get_contact_details.rb +1 -1
  419. data/lib/brevo/models/get_contacts.rb +1 -1
  420. data/lib/brevo/models/get_corporate_invited_users_list.rb +1 -1
  421. data/lib/brevo/models/get_corporate_invited_users_list_feature_access.rb +65 -5
  422. data/lib/brevo/models/get_corporate_invited_users_list_groups.rb +1 -1
  423. data/lib/brevo/models/get_corporate_invited_users_list_users.rb +1 -1
  424. data/lib/brevo/models/get_corporate_user_permission.rb +1 -1
  425. data/lib/brevo/models/get_corporate_user_permission_feature_access.rb +65 -5
  426. data/lib/brevo/models/get_corporate_user_permission_groups.rb +1 -1
  427. data/lib/brevo/models/get_coupon_collection.rb +1 -1
  428. data/lib/brevo/models/get_device_browser_stats.rb +1 -1
  429. data/lib/brevo/models/get_domain_configuration_model.rb +1 -1
  430. data/lib/brevo/models/get_domains_list.rb +1 -1
  431. data/lib/brevo/models/get_domains_list_domains.rb +1 -1
  432. data/lib/brevo/models/get_email_campaign.rb +42 -2
  433. data/lib/brevo/models/get_email_campaigns.rb +1 -1
  434. data/lib/brevo/models/get_email_event_report.rb +1 -1
  435. data/lib/brevo/models/get_email_event_report_events.rb +1 -1
  436. data/lib/brevo/models/get_extended_campaign_overview.rb +42 -2
  437. data/lib/brevo/models/get_extended_campaign_overview_sender.rb +1 -1
  438. data/lib/brevo/models/get_extended_campaign_stats.rb +1 -1
  439. data/lib/brevo/models/get_extended_campaign_stats_global_stats.rb +1 -1
  440. data/lib/brevo/models/get_extended_client.rb +1 -1
  441. data/lib/brevo/models/get_extended_client_address.rb +1 -1
  442. data/lib/brevo/models/get_extended_contact_details.rb +1 -1
  443. data/lib/brevo/models/get_extended_contact_details_statistics.rb +1 -1
  444. data/lib/brevo/models/get_extended_contact_details_statistics_clicked.rb +1 -1
  445. data/lib/brevo/models/get_extended_contact_details_statistics_delivered.rb +1 -1
  446. data/lib/brevo/models/get_extended_contact_details_statistics_links.rb +1 -1
  447. data/lib/brevo/models/get_extended_contact_details_statistics_messages_sent.rb +1 -1
  448. data/lib/brevo/models/get_extended_contact_details_statistics_opened.rb +1 -1
  449. data/lib/brevo/models/get_extended_contact_details_statistics_unsubscriptions.rb +1 -1
  450. data/lib/brevo/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +1 -1
  451. data/lib/brevo/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +1 -1
  452. data/lib/brevo/models/get_extended_list.rb +1 -1
  453. data/lib/brevo/models/get_extended_list_campaign_stats.rb +1 -1
  454. data/lib/brevo/models/get_external_feed_by_uuid.rb +1 -1
  455. data/lib/brevo/models/get_external_feed_by_uuid_headers.rb +1 -1
  456. data/lib/brevo/models/get_folder.rb +1 -1
  457. data/lib/brevo/models/get_folder_lists.rb +1 -1
  458. data/lib/brevo/models/get_folders.rb +1 -1
  459. data/lib/brevo/models/get_inbound_email_events.rb +1 -1
  460. data/lib/brevo/models/get_inbound_email_events_by_uuid.rb +1 -1
  461. data/lib/brevo/models/get_inbound_email_events_by_uuid_attachments.rb +1 -1
  462. data/lib/brevo/models/get_inbound_email_events_by_uuid_logs.rb +1 -1
  463. data/lib/brevo/models/get_inbound_email_events_events.rb +1 -1
  464. data/lib/brevo/models/get_invited_users_list.rb +1 -1
  465. data/lib/brevo/models/get_invited_users_list_feature_access.rb +1 -1
  466. data/lib/brevo/models/get_invited_users_list_users.rb +1 -1
  467. data/lib/brevo/models/get_ip.rb +1 -1
  468. data/lib/brevo/models/get_ip_from_sender.rb +1 -1
  469. data/lib/brevo/models/get_ips.rb +1 -1
  470. data/lib/brevo/models/get_ips_from_sender.rb +1 -1
  471. data/lib/brevo/models/get_list.rb +1 -1
  472. data/lib/brevo/models/get_lists.rb +1 -1
  473. data/lib/brevo/models/get_orders.rb +1 -1
  474. data/lib/brevo/models/get_payment_request.rb +296 -0
  475. data/lib/brevo/models/get_process.rb +1 -1
  476. data/lib/brevo/models/get_processes.rb +1 -1
  477. data/lib/brevo/models/get_product_details.rb +1 -1
  478. data/lib/brevo/models/get_products.rb +1 -1
  479. data/lib/brevo/models/get_reports.rb +1 -1
  480. data/lib/brevo/models/get_reports_reports.rb +1 -1
  481. data/lib/brevo/models/get_scheduled_email_by_batch_id.rb +1 -1
  482. data/lib/brevo/models/get_scheduled_email_by_batch_id_batches.rb +1 -1
  483. data/lib/brevo/models/get_scheduled_email_by_message_id.rb +1 -1
  484. data/lib/brevo/models/{get_segments_segments.rb → get_segment.rb} +18 -3
  485. data/lib/brevo/models/get_segments.rb +5 -3
  486. data/lib/brevo/models/get_senders_list.rb +1 -1
  487. data/lib/brevo/models/get_senders_list_ips.rb +1 -1
  488. data/lib/brevo/models/get_senders_list_senders.rb +1 -1
  489. data/lib/brevo/models/get_shared_template_url.rb +1 -1
  490. data/lib/brevo/models/get_sms_campaign.rb +1 -1
  491. data/lib/brevo/models/get_sms_campaign_overview.rb +1 -1
  492. data/lib/brevo/models/get_sms_campaign_recipients.rb +1 -1
  493. data/lib/brevo/models/get_sms_campaign_stats.rb +1 -1
  494. data/lib/brevo/models/get_sms_campaigns.rb +1 -1
  495. data/lib/brevo/models/get_sms_event_report.rb +1 -1
  496. data/lib/brevo/models/get_sms_event_report_events.rb +3 -3
  497. data/lib/brevo/models/get_smtp_template_overview.rb +1 -1
  498. data/lib/brevo/models/get_smtp_template_overview_sender.rb +1 -1
  499. data/lib/brevo/models/get_smtp_templates.rb +1 -1
  500. data/lib/brevo/models/get_sso_token.rb +1 -1
  501. data/lib/brevo/models/get_stats_by_browser.rb +1 -1
  502. data/lib/brevo/models/get_stats_by_device.rb +1 -1
  503. data/lib/brevo/models/get_stats_by_domain.rb +1 -1
  504. data/lib/brevo/models/get_transac_aggregated_sms_report.rb +17 -7
  505. data/lib/brevo/models/get_transac_blocked_contacts.rb +1 -1
  506. data/lib/brevo/models/get_transac_blocked_contacts_contacts.rb +1 -1
  507. data/lib/brevo/models/get_transac_blocked_contacts_reason.rb +1 -1
  508. data/lib/brevo/models/get_transac_email_content.rb +1 -1
  509. data/lib/brevo/models/get_transac_email_content_events.rb +1 -1
  510. data/lib/brevo/models/get_transac_emails_list.rb +1 -1
  511. data/lib/brevo/models/get_transac_emails_list_transactional_emails.rb +1 -1
  512. data/lib/brevo/models/get_transac_sms_report.rb +1 -1
  513. data/lib/brevo/models/get_transac_sms_report_reports.rb +17 -7
  514. data/lib/brevo/models/get_user_permission.rb +1 -1
  515. data/lib/brevo/models/get_user_permission_privileges.rb +1 -1
  516. data/lib/brevo/models/get_wa_templates.rb +1 -1
  517. data/lib/brevo/models/get_wa_templates_templates.rb +1 -1
  518. data/lib/brevo/models/get_webhook.rb +1 -1
  519. data/lib/brevo/models/get_webhook_auth.rb +1 -1
  520. data/lib/brevo/models/get_webhook_headers.rb +1 -1
  521. data/lib/brevo/models/get_webhooks.rb +1 -1
  522. data/lib/brevo/models/get_whats_app_config.rb +1 -1
  523. data/lib/brevo/models/get_whatsapp_campaign_overview.rb +1 -1
  524. data/lib/brevo/models/get_whatsapp_campaigns.rb +1 -1
  525. data/lib/brevo/models/get_whatsapp_campaigns_campaigns.rb +1 -1
  526. data/lib/brevo/models/get_whatsapp_event_report.rb +1 -1
  527. data/lib/brevo/models/get_whatsapp_event_report_events.rb +1 -1
  528. data/lib/brevo/models/inline_response_200.rb +1 -1
  529. data/lib/brevo/models/inline_response_200_1.rb +1 -1
  530. data/lib/brevo/models/inline_response_200_2.rb +1 -1
  531. data/lib/brevo/models/inline_response_200_3.rb +6 -31
  532. data/lib/brevo/models/inline_response_200_4.rb +185 -0
  533. data/lib/brevo/models/inline_response_200_5.rb +190 -0
  534. data/lib/brevo/models/inline_response_200_6.rb +206 -0
  535. data/lib/brevo/models/inline_response_200_6_totals.rb +218 -0
  536. data/lib/brevo/models/inline_response_200_7.rb +198 -0
  537. data/lib/brevo/models/inline_response_200_8.rb +192 -0
  538. data/lib/brevo/models/inline_response_200_9.rb +215 -0
  539. data/lib/brevo/models/inline_response_201.rb +1 -1
  540. data/lib/brevo/models/inline_response_201_1.rb +1 -1
  541. data/lib/brevo/models/inline_response_201_2.rb +1 -1
  542. data/lib/brevo/models/inline_response_201_3.rb +1 -1
  543. data/lib/brevo/models/inline_response_201_4.rb +1 -1
  544. data/lib/brevo/models/inline_response_201_5.rb +1 -1
  545. data/lib/brevo/models/inline_response_400.rb +184 -0
  546. data/lib/brevo/models/invite_admin_user.rb +1 -1
  547. data/lib/brevo/models/invite_admin_user_privileges.rb +3 -3
  548. data/lib/brevo/models/inviteuser.rb +1 -1
  549. data/lib/brevo/models/inviteuser_privileges.rb +3 -3
  550. data/lib/brevo/models/loyalty_program.rb +331 -0
  551. data/lib/brevo/models/loyalty_program_page.rb +187 -0
  552. data/lib/brevo/models/loyalty_program_validation_error.rb +205 -0
  553. data/lib/brevo/models/loyalty_tier_page.rb +186 -0
  554. data/lib/brevo/models/main_attribute_reward_payload.rb +282 -0
  555. data/lib/brevo/models/main_billing_payload.rb +245 -0
  556. data/lib/brevo/models/{get_children_list.rb → main_code_count_http_response.rb} +4 -16
  557. data/lib/brevo/models/main_create_redeem_payload.rb +286 -0
  558. data/lib/brevo/models/{manage_ip.rb → main_create_redeem_payload_order.rb} +5 -14
  559. data/lib/brevo/models/main_create_reward_payload.rb +269 -0
  560. data/lib/brevo/models/main_create_reward_response.rb +255 -0
  561. data/lib/brevo/models/main_error_response.rb +185 -0
  562. data/lib/brevo/models/main_filter.rb +205 -0
  563. data/lib/brevo/models/main_generator.rb +235 -0
  564. data/lib/brevo/models/main_get_contact_rewards_payload.rb +356 -0
  565. data/lib/brevo/models/main_identifiers_payload.rb +195 -0
  566. data/lib/brevo/models/main_limit.rb +255 -0
  567. data/lib/brevo/models/main_model_contact_reward.rb +277 -0
  568. data/lib/brevo/models/main_model_contact_rewards_resp.rb +227 -0
  569. data/lib/brevo/models/main_node_response.rb +259 -0
  570. data/lib/brevo/models/{get_child_info.rb → main_order_payload.rb} +94 -86
  571. data/lib/brevo/models/main_order_payload_billing.rb +176 -0
  572. data/lib/brevo/models/main_order_payload_identifiers.rb +176 -0
  573. data/lib/brevo/models/main_product.rb +215 -0
  574. data/lib/brevo/models/main_product_payload.rb +227 -0
  575. data/lib/brevo/models/main_redeem.rb +317 -0
  576. data/lib/brevo/models/{get_child_info_api_keys_v3.rb → main_result_parameter_response.rb} +10 -21
  577. data/lib/brevo/models/main_result_parameter_response_value.rb +176 -0
  578. data/lib/brevo/models/main_reward.rb +616 -0
  579. data/lib/brevo/models/main_reward_attribution.rb +287 -0
  580. data/lib/brevo/models/{remaining_credit_model_child.rb → main_reward_configurations.rb} +27 -28
  581. data/lib/brevo/models/main_reward_generator.rb +176 -0
  582. data/lib/brevo/models/{get_child_info_api_keys.rb → main_reward_page.rb} +18 -24
  583. data/lib/brevo/models/main_reward_page_obj.rb +265 -0
  584. data/lib/brevo/models/main_reward_rule.rb +176 -0
  585. data/lib/brevo/models/main_reward_validate.rb +185 -0
  586. data/lib/brevo/models/main_rule.rb +305 -0
  587. data/lib/brevo/models/main_rule_condition.rb +176 -0
  588. data/lib/brevo/models/main_rule_condition_response.rb +227 -0
  589. data/lib/brevo/models/main_rule_condition_response_lhs.rb +176 -0
  590. data/lib/brevo/models/main_rule_condition_response_rhs.rb +176 -0
  591. data/lib/brevo/models/main_rule_event.rb +176 -0
  592. data/lib/brevo/models/{get_child_info_api_keys_v2.rb → main_rule_event_response.rb} +11 -21
  593. data/lib/brevo/models/main_rule_result_response.rb +207 -0
  594. data/lib/brevo/models/main_validate_reward_payload.rb +250 -0
  595. data/lib/brevo/models/main_value_response.rb +256 -0
  596. data/lib/brevo/models/main_value_response_expression.rb +176 -0
  597. data/lib/brevo/models/{get_child_account_creation_status.rb → main_voucher_revoke_payload.rb} +15 -13
  598. data/lib/brevo/models/master_details_response.rb +1 -1
  599. data/lib/brevo/models/master_details_response_billing_info.rb +1 -1
  600. data/lib/brevo/models/master_details_response_billing_info_address.rb +1 -1
  601. data/lib/brevo/models/master_details_response_billing_info_name.rb +1 -1
  602. data/lib/brevo/models/master_details_response_plan_info.rb +1 -1
  603. data/lib/brevo/models/master_details_response_plan_info_features.rb +1 -1
  604. data/lib/brevo/models/member_contact.rb +205 -0
  605. data/lib/brevo/models/model_subscription_balance_resp.rb +186 -0
  606. data/lib/brevo/models/note.rb +1 -1
  607. data/lib/brevo/models/note_data.rb +1 -1
  608. data/lib/brevo/models/note_id.rb +1 -1
  609. data/lib/brevo/models/note_list.rb +1 -1
  610. data/lib/brevo/models/notification.rb +240 -0
  611. data/lib/brevo/models/order.rb +36 -15
  612. data/lib/brevo/models/order_batch.rb +1 -1
  613. data/lib/brevo/models/order_billing.rb +13 -3
  614. data/lib/brevo/models/order_identifiers.rb +216 -0
  615. data/lib/brevo/models/order_products.rb +1 -1
  616. data/lib/brevo/models/otp.rb +1 -1
  617. data/lib/brevo/models/{remaining_credit_model.rb → patch_loyalty_program_payload.rb} +27 -25
  618. data/lib/brevo/models/pipeline.rb +1 -1
  619. data/lib/brevo/models/pipeline_stage.rb +1 -1
  620. data/lib/brevo/models/pipelines.rb +1 -1
  621. data/lib/brevo/models/post_contact_info.rb +1 -1
  622. data/lib/brevo/models/post_contact_info_contacts.rb +1 -1
  623. data/lib/brevo/models/post_send_failed.rb +1 -1
  624. data/lib/brevo/models/post_send_sms_test_failed.rb +1 -1
  625. data/lib/brevo/models/put_revoke_user_permission.rb +1 -1
  626. data/lib/brevo/models/putresendcancelinvitation.rb +1 -1
  627. data/lib/brevo/models/remove_contact_from_list.rb +17 -5
  628. data/lib/brevo/models/request_contact_export.rb +54 -6
  629. data/lib/brevo/models/request_contact_export_custom_contact_filter.rb +13 -3
  630. data/lib/brevo/models/request_contact_import.rb +1 -1
  631. data/lib/brevo/models/request_contact_import_json_body.rb +1 -1
  632. data/lib/brevo/models/request_contact_import_new_list.rb +1 -1
  633. data/lib/brevo/models/request_sms_recipient_export.rb +1 -1
  634. data/lib/brevo/models/schedule_smtp_email.rb +1 -1
  635. data/lib/brevo/models/send_report.rb +1 -1
  636. data/lib/brevo/models/send_report_email.rb +1 -1
  637. data/lib/brevo/models/send_sms.rb +1 -1
  638. data/lib/brevo/models/send_smtp_email.rb +2 -2
  639. data/lib/brevo/models/send_smtp_email_attachment.rb +1 -1
  640. data/lib/brevo/models/send_smtp_email_bcc.rb +1 -1
  641. data/lib/brevo/models/send_smtp_email_cc.rb +1 -1
  642. data/lib/brevo/models/send_smtp_email_message_versions.rb +1 -1
  643. data/lib/brevo/models/send_smtp_email_reply_to.rb +1 -1
  644. data/lib/brevo/models/send_smtp_email_reply_to_1.rb +1 -1
  645. data/lib/brevo/models/send_smtp_email_sender.rb +1 -1
  646. data/lib/brevo/models/send_smtp_email_to.rb +1 -1
  647. data/lib/brevo/models/send_smtp_email_to_1.rb +1 -1
  648. data/lib/brevo/models/send_test_email.rb +1 -1
  649. data/lib/brevo/models/send_test_sms.rb +1 -1
  650. data/lib/brevo/models/send_transac_sms.rb +2 -3
  651. data/lib/brevo/models/send_transac_sms_tag.rb +186 -0
  652. data/lib/brevo/models/send_whatsapp_message.rb +1 -1
  653. data/lib/brevo/models/set_config_display_currency.rb +190 -0
  654. data/lib/brevo/models/sso_token_request.rb +1 -1
  655. data/lib/brevo/models/sso_token_request_corporate.rb +1 -1
  656. data/lib/brevo/models/sub_account_apps_toggle_request.rb +1 -1
  657. data/lib/brevo/models/sub_account_details_response.rb +14 -2
  658. data/lib/brevo/models/sub_account_details_response_groups.rb +195 -0
  659. data/lib/brevo/models/sub_account_details_response_plan_info.rb +1 -1
  660. data/lib/brevo/models/sub_account_details_response_plan_info_credits.rb +36 -10
  661. data/lib/brevo/models/sub_account_details_response_plan_info_credits_emails.rb +1 -1
  662. data/lib/brevo/models/sub_account_details_response_plan_info_credits_external_feeds.rb +196 -0
  663. data/lib/brevo/models/{get_child_info_credits.rb → sub_account_details_response_plan_info_credits_sms.rb} +18 -18
  664. data/lib/brevo/models/sub_account_details_response_plan_info_credits_whatsapp.rb +196 -0
  665. data/lib/brevo/models/sub_account_details_response_plan_info_credits_wp_subscribers.rb +196 -0
  666. data/lib/brevo/models/sub_account_details_response_plan_info_features.rb +14 -5
  667. data/lib/brevo/models/sub_account_details_response_plan_info_features_inbox.rb +1 -1
  668. data/lib/brevo/models/sub_account_details_response_plan_info_features_landing_page.rb +1 -1
  669. data/lib/brevo/models/sub_account_details_response_plan_info_features_sales_users.rb +196 -0
  670. data/lib/brevo/models/sub_account_details_response_plan_info_features_users.rb +4 -4
  671. data/lib/brevo/models/sub_account_update_plan_request.rb +1 -1
  672. data/lib/brevo/models/sub_account_update_plan_request_credits.rb +46 -6
  673. data/lib/brevo/models/sub_account_update_plan_request_features.rb +16 -6
  674. data/lib/brevo/models/sub_accounts_response.rb +1 -1
  675. data/lib/brevo/models/sub_accounts_response_groups.rb +195 -0
  676. data/lib/brevo/models/sub_accounts_response_sub_accounts.rb +22 -5
  677. data/lib/brevo/models/sub_accounts_update_plan_request.rb +206 -0
  678. data/lib/brevo/models/sub_accounts_update_plan_request_credits.rb +226 -0
  679. data/lib/brevo/models/sub_accounts_update_plan_request_features.rb +206 -0
  680. data/lib/brevo/models/subscription.rb +245 -0
  681. data/lib/brevo/models/subscription_aggregate_balance.rb +195 -0
  682. data/lib/brevo/models/subscription_attributed_reward.rb +267 -0
  683. data/lib/brevo/models/subscription_balances.rb +207 -0
  684. data/lib/brevo/models/subscription_handler_info.rb +220 -0
  685. data/lib/brevo/models/subscription_handler_info_balance.rb +176 -0
  686. data/lib/brevo/models/subscription_member.rb +227 -0
  687. data/lib/brevo/models/subscription_tier.rb +247 -0
  688. data/lib/brevo/models/task.rb +1 -1
  689. data/lib/brevo/models/task_list.rb +1 -1
  690. data/lib/brevo/models/task_reminder.rb +1 -1
  691. data/lib/brevo/models/task_types.rb +1 -1
  692. data/lib/brevo/models/{update_child_account_status.rb → template_preview.rb} +52 -31
  693. data/lib/brevo/models/tier.rb +267 -0
  694. data/lib/brevo/models/tier_access_conditions.rb +213 -0
  695. data/lib/brevo/models/tier_for_contact.rb +245 -0
  696. data/lib/brevo/models/tier_group.rb +307 -0
  697. data/lib/brevo/models/tier_group_page.rb +186 -0
  698. data/lib/brevo/models/tier_request.rb +227 -0
  699. data/lib/brevo/models/tier_request_access_conditions.rb +195 -0
  700. data/lib/brevo/models/tier_request_put_payload.rb +232 -0
  701. data/lib/brevo/models/tier_request_tier_rewards.rb +185 -0
  702. data/lib/brevo/models/tier_tier_rewards.rb +203 -0
  703. data/lib/brevo/models/transaction.rb +326 -0
  704. data/lib/brevo/models/transaction_history.rb +276 -0
  705. data/lib/brevo/models/transaction_history_resp.rb +228 -0
  706. data/lib/brevo/models/unauthorized_response.rb +185 -0
  707. data/lib/brevo/models/update_attribute.rb +18 -6
  708. data/lib/brevo/models/update_attribute_enumeration.rb +1 -1
  709. data/lib/brevo/models/update_balance_definition_payload.rb +474 -0
  710. data/lib/brevo/models/update_balance_limit_payload.rb +319 -0
  711. data/lib/brevo/models/update_batch_contacts.rb +1 -1
  712. data/lib/brevo/models/update_batch_contacts_contacts.rb +1 -1
  713. data/lib/brevo/models/update_batch_contacts_model.rb +1 -1
  714. data/lib/brevo/models/update_campaign_status.rb +1 -1
  715. data/lib/brevo/models/update_child.rb +1 -1
  716. data/lib/brevo/models/update_contact.rb +6 -4
  717. data/lib/brevo/models/update_coupon_collection.rb +1 -1
  718. data/lib/brevo/models/update_email_campaign.rb +14 -5
  719. data/lib/brevo/models/update_email_campaign_email_expiration_date.rb +254 -0
  720. data/lib/brevo/models/update_email_campaign_recipients.rb +17 -5
  721. data/lib/brevo/models/update_email_campaign_sender.rb +1 -1
  722. data/lib/brevo/models/update_external_feed.rb +1 -1
  723. data/lib/brevo/models/update_list.rb +1 -1
  724. data/lib/brevo/models/update_loyalty_program_payload.rb +210 -0
  725. data/lib/brevo/models/update_sender.rb +1 -1
  726. data/lib/brevo/models/update_sms_campaign.rb +1 -1
  727. data/lib/brevo/models/update_smtp_template.rb +1 -1
  728. data/lib/brevo/models/update_smtp_template_sender.rb +1 -1
  729. data/lib/brevo/models/update_tier_group_request.rb +287 -0
  730. data/lib/brevo/models/update_webhook.rb +1 -1
  731. data/lib/brevo/models/update_whats_app_campaign.rb +1 -1
  732. data/lib/brevo/models/upload_image_model.rb +1 -1
  733. data/lib/brevo/models/upload_image_to_gallery.rb +1 -1
  734. data/lib/brevo/models/{get_child_domains.rb → validation_errors.rb} +2 -2
  735. data/lib/brevo/models/variables_items.rb +1 -1
  736. data/lib/brevo/models/whatsapp_camp_stats.rb +1 -1
  737. data/lib/brevo/models/whatsapp_camp_template.rb +1 -1
  738. data/lib/brevo/version.rb +2 -2
  739. data/lib/brevo.rb +146 -21
  740. data/spec/api/account_api_spec.rb +2 -1
  741. data/spec/api/balance_api_spec.rb +292 -0
  742. data/spec/api/companies_api_spec.rb +37 -11
  743. data/spec/api/contacts_api_spec.rb +29 -9
  744. data/spec/api/conversations_api_spec.rb +2 -2
  745. data/spec/api/coupons_api_spec.rb +3 -3
  746. data/spec/api/deals_api_spec.rb +27 -1
  747. data/spec/api/domains_api_spec.rb +1 -1
  748. data/spec/api/ecommerce_api_spec.rb +40 -16
  749. data/spec/api/email_campaigns_api_spec.rb +2 -2
  750. data/spec/api/events_api_spec.rb +1 -1
  751. data/spec/api/external_feeds_api_spec.rb +1 -1
  752. data/spec/api/files_api_spec.rb +1 -1
  753. data/spec/api/inbound_parsing_api_spec.rb +1 -1
  754. data/spec/api/master_account_api_spec.rb +66 -4
  755. data/spec/api/notes_api_spec.rb +1 -1
  756. data/spec/api/payments_api_spec.rb +68 -0
  757. data/spec/api/process_api_spec.rb +1 -1
  758. data/spec/api/program_api_spec.rb +178 -0
  759. data/spec/api/reward_api_spec.rb +175 -0
  760. data/spec/api/senders_api_spec.rb +1 -1
  761. data/spec/api/sms_campaigns_api_spec.rb +1 -1
  762. data/spec/api/tasks_api_spec.rb +1 -1
  763. data/spec/api/tier_api_spec.rb +170 -0
  764. data/spec/api/transactional_emails_api_spec.rb +13 -2
  765. data/spec/api/transactional_sms_api_spec.rb +11 -1
  766. data/spec/api/transactional_whats_app_api_spec.rb +1 -1
  767. data/spec/api/user_api_spec.rb +3 -3
  768. data/spec/api/webhooks_api_spec.rb +1 -1
  769. data/spec/api/whats_app_campaigns_api_spec.rb +1 -1
  770. data/spec/api_client_spec.rb +1 -1
  771. data/spec/configuration_spec.rb +1 -1
  772. data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +1 -1
  773. data/spec/models/ab_test_campaign_result_spec.rb +1 -1
  774. data/spec/models/ab_test_campaign_result_statistics_spec.rb +1 -1
  775. data/spec/models/ab_test_version_clicks_inner_spec.rb +1 -1
  776. data/spec/models/ab_test_version_clicks_spec.rb +1 -1
  777. data/spec/models/ab_test_version_stats_spec.rb +1 -1
  778. data/spec/models/add_child_domain_spec.rb +1 -1
  779. data/spec/models/add_contact_to_list_spec.rb +7 -1
  780. data/spec/models/add_subscription_member_payload_spec.rb +53 -0
  781. data/spec/models/aggregate_balance_spec.rb +47 -0
  782. data/spec/models/authenticate_domain_model_spec.rb +1 -1
  783. data/spec/models/balance_data_per_contact_spec.rb +59 -0
  784. data/spec/models/balance_definition_page_spec.rb +41 -0
  785. data/spec/models/balance_definition_spec.rb +159 -0
  786. data/spec/models/balance_limit_spec.rb +95 -0
  787. data/spec/models/balance_order_spec.rb +107 -0
  788. data/spec/models/{get_child_info_spec.rb → balance_spec.rb} +16 -16
  789. data/spec/models/block_domain_spec.rb +1 -1
  790. data/spec/models/body_10_spec.rb +4 -40
  791. data/spec/models/body_11_spec.rb +5 -17
  792. data/spec/models/body_12_spec.rb +20 -2
  793. data/spec/models/body_13_spec.rb +47 -5
  794. data/spec/models/body_14_spec.rb +56 -2
  795. data/spec/models/body_15_spec.rb +13 -1
  796. data/spec/models/{manage_ip_spec.rb → body_16_spec.rb} +8 -8
  797. data/spec/models/{update_child_account_status_spec.rb → body_17_spec.rb} +11 -11
  798. data/spec/models/{update_child_domain_spec.rb → body_18_spec.rb} +8 -8
  799. data/spec/models/body_19_spec.rb +59 -0
  800. data/spec/models/body_1_spec.rb +3 -3
  801. data/spec/models/body_2_spec.rb +8 -2
  802. data/spec/models/body_3_spec.rb +3 -9
  803. data/spec/models/body_4_spec.rb +2 -14
  804. data/spec/models/body_5_spec.rb +3 -15
  805. data/spec/models/body_6_spec.rb +19 -1
  806. data/spec/models/body_7_spec.rb +19 -1
  807. data/spec/models/body_8_spec.rb +3 -3
  808. data/spec/models/body_9_spec.rb +14 -42
  809. data/spec/models/body_spec.rb +1 -1
  810. data/spec/models/body_variables_items_spec.rb +1 -1
  811. data/spec/models/cart_spec.rb +51 -0
  812. data/spec/models/companies_list_spec.rb +1 -1
  813. data/spec/models/company_attributes_inner_spec.rb +1 -1
  814. data/spec/models/company_attributes_spec.rb +1 -1
  815. data/spec/models/company_spec.rb +1 -1
  816. data/spec/models/component_items_spec.rb +1 -1
  817. data/spec/models/configuration_spec.rb +41 -0
  818. data/spec/models/contact_balances_resp_spec.rb +59 -0
  819. data/spec/models/contact_error_model_spec.rb +57 -0
  820. data/spec/models/conversations_message_attachments_spec.rb +71 -0
  821. data/spec/models/conversations_message_file_image_info_spec.rb +1 -1
  822. data/spec/models/conversations_message_file_spec.rb +1 -1
  823. data/spec/models/conversations_message_forwarded_to_source_status_spec.rb +47 -0
  824. data/spec/models/{remove_credits_spec.rb → conversations_message_from_spec.rb} +9 -9
  825. data/spec/models/{remaining_credit_model_child_spec.rb → conversations_message_reply_to_spec.rb} +9 -9
  826. data/spec/models/conversations_message_spec.rb +91 -1
  827. data/spec/models/{remaining_credit_model_reseller_spec.rb → conversations_message_to_spec.rb} +9 -9
  828. data/spec/models/conversion_source_metrics_spec.rb +2 -2
  829. data/spec/models/conversion_source_product_spec.rb +1 -1
  830. data/spec/models/corporate_group_details_response_group_spec.rb +1 -1
  831. data/spec/models/corporate_group_details_response_spec.rb +1 -1
  832. data/spec/models/corporate_group_details_response_subaccounts_spec.rb +1 -1
  833. data/spec/models/corporate_group_details_response_users_spec.rb +1 -1
  834. data/spec/models/corporateuseremailpermissions_privileges_spec.rb +55 -0
  835. data/spec/models/create_api_key_request_spec.rb +1 -1
  836. data/spec/models/create_api_key_response_spec.rb +1 -1
  837. data/spec/models/create_attribute_enumeration_spec.rb +1 -1
  838. data/spec/models/create_attribute_spec.rb +8 -2
  839. data/spec/models/create_balance_definition_payload_spec.rb +155 -0
  840. data/spec/models/create_balance_limit_payload_spec.rb +83 -0
  841. data/spec/models/create_balance_payload_spec.rb +41 -0
  842. data/spec/models/create_category_model_spec.rb +1 -1
  843. data/spec/models/create_child_spec.rb +1 -1
  844. data/spec/models/create_contact_spec.rb +1 -1
  845. data/spec/models/create_coupon_collection_spec.rb +1 -1
  846. data/spec/models/create_coupons_spec.rb +1 -1
  847. data/spec/models/create_doi_contact_spec.rb +1 -1
  848. data/spec/models/create_domain_model_dns_records_dkim_record_spec.rb +1 -1
  849. data/spec/models/create_domain_model_dns_records_spec.rb +1 -1
  850. data/spec/models/create_domain_model_spec.rb +1 -1
  851. data/spec/models/create_domain_spec.rb +1 -1
  852. data/spec/models/create_email_campaign_email_expiration_date_spec.rb +51 -0
  853. data/spec/models/create_email_campaign_recipients_spec.rb +7 -1
  854. data/spec/models/create_email_campaign_sender_spec.rb +1 -1
  855. data/spec/models/create_email_campaign_spec.rb +7 -1
  856. data/spec/models/create_external_feed_spec.rb +1 -1
  857. data/spec/models/create_list_spec.rb +1 -1
  858. data/spec/models/create_loyalty_program_payload_spec.rb +59 -0
  859. data/spec/models/create_model_spec.rb +1 -1
  860. data/spec/models/create_order_payload_spec.rb +77 -0
  861. data/spec/models/create_payment_request_spec.rb +71 -0
  862. data/spec/models/{create_reseller_spec.rb → create_payment_response_spec.rb} +9 -9
  863. data/spec/models/create_product_model_spec.rb +1 -1
  864. data/spec/models/create_sender_ips_spec.rb +1 -1
  865. data/spec/models/create_sender_model_spec.rb +1 -1
  866. data/spec/models/create_sender_spec.rb +1 -1
  867. data/spec/models/create_sms_campaign_recipients_spec.rb +1 -1
  868. data/spec/models/create_sms_campaign_spec.rb +1 -1
  869. data/spec/models/create_smtp_email_spec.rb +1 -1
  870. data/spec/models/create_smtp_template_sender_spec.rb +1 -1
  871. data/spec/models/create_smtp_template_spec.rb +1 -1
  872. data/spec/models/create_sub_account_response_spec.rb +1 -1
  873. data/spec/models/create_sub_account_spec.rb +7 -1
  874. data/spec/models/create_subscription_payload_spec.rb +53 -0
  875. data/spec/models/create_subscription_response_spec.rb +77 -0
  876. data/spec/models/create_tier_group_request_spec.rb +67 -0
  877. data/spec/models/create_transaction_payload_spec.rb +89 -0
  878. data/spec/models/create_update_batch_category_model_spec.rb +1 -1
  879. data/spec/models/create_update_batch_category_spec.rb +1 -1
  880. data/spec/models/create_update_batch_products_model_spec.rb +1 -1
  881. data/spec/models/create_update_batch_products_spec.rb +1 -1
  882. data/spec/models/create_update_categories_spec.rb +7 -1
  883. data/spec/models/create_update_category_spec.rb +7 -1
  884. data/spec/models/create_update_contact_model_spec.rb +1 -1
  885. data/spec/models/create_update_folder_spec.rb +1 -1
  886. data/spec/models/create_update_product_spec.rb +7 -1
  887. data/spec/models/create_update_products_spec.rb +7 -1
  888. data/spec/models/create_webhook_spec.rb +11 -1
  889. data/spec/models/create_whats_app_campaign_recipients_spec.rb +1 -1
  890. data/spec/models/create_whats_app_campaign_spec.rb +1 -1
  891. data/spec/models/create_whats_app_template_spec.rb +1 -1
  892. data/spec/models/created_batch_id_spec.rb +1 -1
  893. data/spec/models/created_process_id_spec.rb +1 -1
  894. data/spec/models/deal_attributes_inner_spec.rb +1 -1
  895. data/spec/models/deal_attributes_spec.rb +1 -1
  896. data/spec/models/deal_spec.rb +1 -1
  897. data/spec/models/deals_list_spec.rb +1 -1
  898. data/spec/models/delete_hardbounces_spec.rb +1 -1
  899. data/spec/models/email_export_recipients_spec.rb +1 -1
  900. data/spec/models/error_model_spec.rb +2 -2
  901. data/spec/models/error_response_spec.rb +41 -0
  902. data/spec/models/event_identifiers_spec.rb +4 -4
  903. data/spec/models/event_spec.rb +1 -1
  904. data/spec/models/export_webhooks_history_spec.rb +1 -1
  905. data/spec/models/{get_child_info_statistics_spec.rb → fetch_template_preview_spec.rb} +10 -10
  906. data/spec/models/file_data_spec.rb +1 -1
  907. data/spec/models/file_downloadable_link_spec.rb +1 -1
  908. data/spec/models/file_list_spec.rb +1 -1
  909. data/spec/models/get_account_activity_logs_spec.rb +1 -1
  910. data/spec/models/get_account_activity_spec.rb +1 -1
  911. data/spec/models/get_account_marketing_automation_spec.rb +1 -1
  912. data/spec/models/get_account_plan_spec.rb +2 -8
  913. data/spec/models/get_account_relay_data_spec.rb +1 -1
  914. data/spec/models/get_account_relay_spec.rb +1 -1
  915. data/spec/models/get_account_spec.rb +1 -1
  916. data/spec/models/get_aggregated_report_spec.rb +1 -1
  917. data/spec/models/get_all_external_feeds_feeds_spec.rb +1 -1
  918. data/spec/models/get_all_external_feeds_spec.rb +1 -1
  919. data/spec/models/get_attributes_attributes_spec.rb +8 -2
  920. data/spec/models/get_attributes_enumeration_spec.rb +1 -1
  921. data/spec/models/get_attributes_spec.rb +1 -1
  922. data/spec/models/get_blocked_domains_spec.rb +1 -1
  923. data/spec/models/get_campaign_overview_spec.rb +1 -1
  924. data/spec/models/get_campaign_recipients_spec.rb +1 -1
  925. data/spec/models/get_campaign_stats_spec.rb +13 -1
  926. data/spec/models/get_categories_spec.rb +1 -1
  927. data/spec/models/get_category_details_spec.rb +1 -1
  928. data/spec/models/get_child_domain_spec.rb +1 -1
  929. data/spec/models/get_client_spec.rb +1 -1
  930. data/spec/models/get_contact_campaign_stats_clicked_spec.rb +1 -1
  931. data/spec/models/get_contact_campaign_stats_opened_spec.rb +1 -1
  932. data/spec/models/get_contact_campaign_stats_spec.rb +1 -1
  933. data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +1 -1
  934. data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +1 -1
  935. data/spec/models/get_contact_details_spec.rb +1 -1
  936. data/spec/models/get_contacts_spec.rb +1 -1
  937. data/spec/models/get_corporate_invited_users_list_feature_access_spec.rb +31 -1
  938. data/spec/models/get_corporate_invited_users_list_groups_spec.rb +1 -1
  939. data/spec/models/get_corporate_invited_users_list_spec.rb +1 -1
  940. data/spec/models/get_corporate_invited_users_list_users_spec.rb +1 -1
  941. data/spec/models/get_corporate_user_permission_feature_access_spec.rb +31 -1
  942. data/spec/models/get_corporate_user_permission_groups_spec.rb +1 -1
  943. data/spec/models/get_corporate_user_permission_spec.rb +1 -1
  944. data/spec/models/get_coupon_collection_spec.rb +1 -1
  945. data/spec/models/get_device_browser_stats_spec.rb +1 -1
  946. data/spec/models/get_domain_configuration_model_spec.rb +1 -1
  947. data/spec/models/get_domains_list_domains_spec.rb +1 -1
  948. data/spec/models/get_domains_list_spec.rb +1 -1
  949. data/spec/models/get_email_campaign_spec.rb +25 -1
  950. data/spec/models/get_email_campaigns_spec.rb +1 -1
  951. data/spec/models/get_email_event_report_events_spec.rb +1 -1
  952. data/spec/models/get_email_event_report_spec.rb +1 -1
  953. data/spec/models/get_extended_campaign_overview_sender_spec.rb +1 -1
  954. data/spec/models/get_extended_campaign_overview_spec.rb +25 -1
  955. data/spec/models/get_extended_campaign_stats_global_stats_spec.rb +1 -1
  956. data/spec/models/get_extended_campaign_stats_spec.rb +1 -1
  957. data/spec/models/get_extended_client_address_spec.rb +1 -1
  958. data/spec/models/get_extended_client_spec.rb +1 -1
  959. data/spec/models/get_extended_contact_details_spec.rb +1 -1
  960. data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +1 -1
  961. data/spec/models/get_extended_contact_details_statistics_delivered_spec.rb +1 -1
  962. data/spec/models/get_extended_contact_details_statistics_links_spec.rb +1 -1
  963. data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +1 -1
  964. data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +1 -1
  965. data/spec/models/get_extended_contact_details_statistics_spec.rb +1 -1
  966. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +1 -1
  967. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +1 -1
  968. data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +1 -1
  969. data/spec/models/get_extended_list_campaign_stats_spec.rb +1 -1
  970. data/spec/models/get_extended_list_spec.rb +1 -1
  971. data/spec/models/get_external_feed_by_uuid_headers_spec.rb +1 -1
  972. data/spec/models/get_external_feed_by_uuid_spec.rb +1 -1
  973. data/spec/models/get_folder_lists_spec.rb +1 -1
  974. data/spec/models/get_folder_spec.rb +1 -1
  975. data/spec/models/get_folders_spec.rb +1 -1
  976. data/spec/models/get_inbound_email_events_by_uuid_attachments_spec.rb +1 -1
  977. data/spec/models/get_inbound_email_events_by_uuid_logs_spec.rb +1 -1
  978. data/spec/models/get_inbound_email_events_by_uuid_spec.rb +1 -1
  979. data/spec/models/get_inbound_email_events_events_spec.rb +1 -1
  980. data/spec/models/get_inbound_email_events_spec.rb +1 -1
  981. data/spec/models/get_invited_users_list_feature_access_spec.rb +1 -1
  982. data/spec/models/get_invited_users_list_spec.rb +1 -1
  983. data/spec/models/get_invited_users_list_users_spec.rb +1 -1
  984. data/spec/models/get_ip_from_sender_spec.rb +1 -1
  985. data/spec/models/get_ip_spec.rb +1 -1
  986. data/spec/models/get_ips_from_sender_spec.rb +1 -1
  987. data/spec/models/get_ips_spec.rb +1 -1
  988. data/spec/models/get_list_spec.rb +1 -1
  989. data/spec/models/get_lists_spec.rb +1 -1
  990. data/spec/models/get_orders_spec.rb +1 -1
  991. data/spec/models/get_payment_request_spec.rb +81 -0
  992. data/spec/models/get_process_spec.rb +1 -1
  993. data/spec/models/get_processes_spec.rb +1 -1
  994. data/spec/models/get_product_details_spec.rb +1 -1
  995. data/spec/models/get_products_spec.rb +1 -1
  996. data/spec/models/get_reports_reports_spec.rb +1 -1
  997. data/spec/models/get_reports_spec.rb +1 -1
  998. data/spec/models/get_scheduled_email_by_batch_id_batches_spec.rb +1 -1
  999. data/spec/models/get_scheduled_email_by_batch_id_spec.rb +1 -1
  1000. data/spec/models/get_scheduled_email_by_message_id_spec.rb +1 -1
  1001. data/spec/models/{get_segments_segments_spec.rb → get_segment_spec.rb} +7 -7
  1002. data/spec/models/get_segments_spec.rb +1 -1
  1003. data/spec/models/get_senders_list_ips_spec.rb +1 -1
  1004. data/spec/models/get_senders_list_senders_spec.rb +1 -1
  1005. data/spec/models/get_senders_list_spec.rb +1 -1
  1006. data/spec/models/get_shared_template_url_spec.rb +1 -1
  1007. data/spec/models/get_sms_campaign_overview_spec.rb +1 -1
  1008. data/spec/models/get_sms_campaign_recipients_spec.rb +1 -1
  1009. data/spec/models/get_sms_campaign_spec.rb +1 -1
  1010. data/spec/models/get_sms_campaign_stats_spec.rb +1 -1
  1011. data/spec/models/get_sms_campaigns_spec.rb +1 -1
  1012. data/spec/models/get_sms_event_report_events_spec.rb +2 -2
  1013. data/spec/models/get_sms_event_report_spec.rb +1 -1
  1014. data/spec/models/get_smtp_template_overview_sender_spec.rb +1 -1
  1015. data/spec/models/get_smtp_template_overview_spec.rb +1 -1
  1016. data/spec/models/get_smtp_templates_spec.rb +1 -1
  1017. data/spec/models/get_sso_token_spec.rb +1 -1
  1018. data/spec/models/get_stats_by_browser_spec.rb +1 -1
  1019. data/spec/models/get_stats_by_device_spec.rb +1 -1
  1020. data/spec/models/get_stats_by_domain_spec.rb +1 -1
  1021. data/spec/models/get_transac_aggregated_sms_report_spec.rb +7 -1
  1022. data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +1 -1
  1023. data/spec/models/get_transac_blocked_contacts_reason_spec.rb +1 -1
  1024. data/spec/models/get_transac_blocked_contacts_spec.rb +1 -1
  1025. data/spec/models/get_transac_email_content_events_spec.rb +1 -1
  1026. data/spec/models/get_transac_email_content_spec.rb +1 -1
  1027. data/spec/models/get_transac_emails_list_spec.rb +1 -1
  1028. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +1 -1
  1029. data/spec/models/get_transac_sms_report_reports_spec.rb +7 -1
  1030. data/spec/models/get_transac_sms_report_spec.rb +1 -1
  1031. data/spec/models/get_user_permission_privileges_spec.rb +1 -1
  1032. data/spec/models/get_user_permission_spec.rb +1 -1
  1033. data/spec/models/get_wa_templates_spec.rb +1 -1
  1034. data/spec/models/get_wa_templates_templates_spec.rb +1 -1
  1035. data/spec/models/get_webhook_auth_spec.rb +1 -1
  1036. data/spec/models/get_webhook_headers_spec.rb +1 -1
  1037. data/spec/models/get_webhook_spec.rb +1 -1
  1038. data/spec/models/get_webhooks_spec.rb +1 -1
  1039. data/spec/models/get_whats_app_config_spec.rb +1 -1
  1040. data/spec/models/get_whatsapp_campaign_overview_spec.rb +1 -1
  1041. data/spec/models/get_whatsapp_campaigns_campaigns_spec.rb +1 -1
  1042. data/spec/models/get_whatsapp_campaigns_spec.rb +1 -1
  1043. data/spec/models/get_whatsapp_event_report_events_spec.rb +1 -1
  1044. data/spec/models/get_whatsapp_event_report_spec.rb +1 -1
  1045. data/spec/models/inline_response_200_1_spec.rb +1 -1
  1046. data/spec/models/inline_response_200_2_spec.rb +1 -1
  1047. data/spec/models/inline_response_200_3_spec.rb +1 -13
  1048. data/spec/models/inline_response_200_4_spec.rb +41 -0
  1049. data/spec/models/inline_response_200_5_spec.rb +41 -0
  1050. data/spec/models/{get_child_info_api_keys_spec.rb → inline_response_200_6_spec.rb} +9 -9
  1051. data/spec/models/inline_response_200_6_totals_spec.rb +53 -0
  1052. data/spec/models/inline_response_200_7_spec.rb +47 -0
  1053. data/spec/models/inline_response_200_8_spec.rb +41 -0
  1054. data/spec/models/inline_response_200_9_spec.rb +53 -0
  1055. data/spec/models/inline_response_200_spec.rb +1 -1
  1056. data/spec/models/inline_response_201_1_spec.rb +1 -1
  1057. data/spec/models/inline_response_201_2_spec.rb +1 -1
  1058. data/spec/models/inline_response_201_3_spec.rb +1 -1
  1059. data/spec/models/inline_response_201_4_spec.rb +1 -1
  1060. data/spec/models/inline_response_201_5_spec.rb +1 -1
  1061. data/spec/models/inline_response_201_spec.rb +1 -1
  1062. data/spec/models/inline_response_400_spec.rb +41 -0
  1063. data/spec/models/invite_admin_user_privileges_spec.rb +3 -3
  1064. data/spec/models/invite_admin_user_spec.rb +1 -1
  1065. data/spec/models/inviteuser_privileges_spec.rb +3 -3
  1066. data/spec/models/inviteuser_spec.rb +1 -1
  1067. data/spec/models/loyalty_program_page_spec.rb +41 -0
  1068. data/spec/models/loyalty_program_spec.rb +111 -0
  1069. data/spec/models/loyalty_program_validation_error_spec.rb +53 -0
  1070. data/spec/models/loyalty_tier_page_spec.rb +41 -0
  1071. data/spec/models/main_attribute_reward_payload_spec.rb +77 -0
  1072. data/spec/models/main_billing_payload_spec.rb +77 -0
  1073. data/spec/models/{get_children_list_spec.rb → main_code_count_http_response_spec.rb} +7 -13
  1074. data/spec/models/main_create_redeem_payload_order_spec.rb +35 -0
  1075. data/spec/models/main_create_redeem_payload_spec.rb +83 -0
  1076. data/spec/models/main_create_reward_payload_spec.rb +59 -0
  1077. data/spec/models/main_create_reward_response_spec.rb +83 -0
  1078. data/spec/models/main_error_response_spec.rb +41 -0
  1079. data/spec/models/{add_credits_spec.rb → main_filter_spec.rb} +9 -9
  1080. data/spec/models/main_generator_spec.rb +71 -0
  1081. data/spec/models/main_get_contact_rewards_payload_spec.rb +85 -0
  1082. data/spec/models/main_identifiers_payload_spec.rb +47 -0
  1083. data/spec/models/main_limit_spec.rb +83 -0
  1084. data/spec/models/main_model_contact_reward_spec.rb +95 -0
  1085. data/spec/models/main_model_contact_rewards_resp_spec.rb +65 -0
  1086. data/spec/models/main_node_response_spec.rb +83 -0
  1087. data/spec/models/main_order_payload_billing_spec.rb +35 -0
  1088. data/spec/models/main_order_payload_identifiers_spec.rb +35 -0
  1089. data/spec/models/main_order_payload_spec.rb +107 -0
  1090. data/spec/models/main_product_payload_spec.rb +65 -0
  1091. data/spec/models/main_product_spec.rb +59 -0
  1092. data/spec/models/main_redeem_spec.rb +119 -0
  1093. data/spec/models/main_result_parameter_response_spec.rb +47 -0
  1094. data/spec/models/main_result_parameter_response_value_spec.rb +35 -0
  1095. data/spec/models/main_reward_attribution_spec.rb +101 -0
  1096. data/spec/models/main_reward_configurations_spec.rb +53 -0
  1097. data/spec/models/main_reward_generator_spec.rb +35 -0
  1098. data/spec/models/main_reward_page_obj_spec.rb +89 -0
  1099. data/spec/models/{get_child_info_api_keys_v2_spec.rb → main_reward_page_spec.rb} +9 -9
  1100. data/spec/models/main_reward_rule_spec.rb +35 -0
  1101. data/spec/models/main_reward_spec.rb +279 -0
  1102. data/spec/models/main_reward_validate_spec.rb +41 -0
  1103. data/spec/models/main_rule_condition_response_lhs_spec.rb +35 -0
  1104. data/spec/models/main_rule_condition_response_rhs_spec.rb +35 -0
  1105. data/spec/models/main_rule_condition_response_spec.rb +65 -0
  1106. data/spec/models/main_rule_condition_spec.rb +35 -0
  1107. data/spec/models/{get_child_info_api_keys_v3_spec.rb → main_rule_event_response_spec.rb} +8 -8
  1108. data/spec/models/{get_child_domains_spec.rb → main_rule_event_spec.rb} +7 -7
  1109. data/spec/models/main_rule_result_response_spec.rb +53 -0
  1110. data/spec/models/main_rule_spec.rb +113 -0
  1111. data/spec/models/main_validate_reward_payload_spec.rb +71 -0
  1112. data/spec/models/main_value_response_expression_spec.rb +35 -0
  1113. data/spec/models/main_value_response_spec.rb +83 -0
  1114. data/spec/models/main_voucher_revoke_payload_spec.rb +41 -0
  1115. data/spec/models/master_details_response_billing_info_address_spec.rb +1 -1
  1116. data/spec/models/master_details_response_billing_info_name_spec.rb +1 -1
  1117. data/spec/models/master_details_response_billing_info_spec.rb +1 -1
  1118. data/spec/models/master_details_response_plan_info_features_spec.rb +1 -1
  1119. data/spec/models/master_details_response_plan_info_spec.rb +1 -1
  1120. data/spec/models/master_details_response_spec.rb +1 -1
  1121. data/spec/models/member_contact_spec.rb +53 -0
  1122. data/spec/models/model_subscription_balance_resp_spec.rb +41 -0
  1123. data/spec/models/note_data_spec.rb +1 -1
  1124. data/spec/models/note_id_spec.rb +1 -1
  1125. data/spec/models/note_list_spec.rb +1 -1
  1126. data/spec/models/note_spec.rb +1 -1
  1127. data/spec/models/notification_spec.rb +51 -0
  1128. data/spec/models/order_batch_spec.rb +1 -1
  1129. data/spec/models/order_billing_spec.rb +7 -1
  1130. data/spec/models/order_identifiers_spec.rb +59 -0
  1131. data/spec/models/order_products_spec.rb +1 -1
  1132. data/spec/models/order_spec.rb +15 -3
  1133. data/spec/models/otp_spec.rb +1 -1
  1134. data/spec/models/patch_loyalty_program_payload_spec.rb +53 -0
  1135. data/spec/models/pipeline_spec.rb +1 -1
  1136. data/spec/models/pipeline_stage_spec.rb +1 -1
  1137. data/spec/models/pipelines_spec.rb +1 -1
  1138. data/spec/models/post_contact_info_contacts_spec.rb +1 -1
  1139. data/spec/models/post_contact_info_spec.rb +1 -1
  1140. data/spec/models/post_send_failed_spec.rb +1 -1
  1141. data/spec/models/post_send_sms_test_failed_spec.rb +1 -1
  1142. data/spec/models/put_revoke_user_permission_spec.rb +1 -1
  1143. data/spec/models/putresendcancelinvitation_spec.rb +1 -1
  1144. data/spec/models/remove_contact_from_list_spec.rb +7 -1
  1145. data/spec/models/request_contact_export_custom_contact_filter_spec.rb +7 -1
  1146. data/spec/models/request_contact_export_spec.rb +25 -1
  1147. data/spec/models/request_contact_import_json_body_spec.rb +1 -1
  1148. data/spec/models/request_contact_import_new_list_spec.rb +1 -1
  1149. data/spec/models/request_contact_import_spec.rb +1 -1
  1150. data/spec/models/request_sms_recipient_export_spec.rb +1 -1
  1151. data/spec/models/schedule_smtp_email_spec.rb +1 -1
  1152. data/spec/models/send_report_email_spec.rb +1 -1
  1153. data/spec/models/send_report_spec.rb +1 -1
  1154. data/spec/models/send_sms_spec.rb +1 -1
  1155. data/spec/models/send_smtp_email_attachment_spec.rb +1 -1
  1156. data/spec/models/send_smtp_email_bcc_spec.rb +1 -1
  1157. data/spec/models/send_smtp_email_cc_spec.rb +1 -1
  1158. data/spec/models/send_smtp_email_message_versions_spec.rb +1 -1
  1159. data/spec/models/send_smtp_email_reply_to_1_spec.rb +1 -1
  1160. data/spec/models/send_smtp_email_reply_to_spec.rb +1 -1
  1161. data/spec/models/send_smtp_email_sender_spec.rb +1 -1
  1162. data/spec/models/send_smtp_email_spec.rb +1 -1
  1163. data/spec/models/send_smtp_email_to_1_spec.rb +1 -1
  1164. data/spec/models/send_smtp_email_to_spec.rb +1 -1
  1165. data/spec/models/send_test_email_spec.rb +1 -1
  1166. data/spec/models/send_test_sms_spec.rb +1 -1
  1167. data/spec/models/send_transac_sms_spec.rb +1 -1
  1168. data/spec/models/send_transac_sms_tag_spec.rb +41 -0
  1169. data/spec/models/send_whatsapp_message_spec.rb +1 -1
  1170. data/spec/models/{get_child_account_creation_status_spec.rb → set_config_display_currency_spec.rb} +8 -8
  1171. data/spec/models/sso_token_request_corporate_spec.rb +1 -1
  1172. data/spec/models/sso_token_request_spec.rb +1 -1
  1173. data/spec/models/sub_account_apps_toggle_request_spec.rb +1 -1
  1174. data/spec/models/sub_account_details_response_groups_spec.rb +47 -0
  1175. data/spec/models/sub_account_details_response_plan_info_credits_emails_spec.rb +1 -1
  1176. data/spec/models/sub_account_details_response_plan_info_credits_external_feeds_spec.rb +47 -0
  1177. data/spec/models/sub_account_details_response_plan_info_credits_sms_spec.rb +47 -0
  1178. data/spec/models/sub_account_details_response_plan_info_credits_spec.rb +20 -2
  1179. data/spec/models/sub_account_details_response_plan_info_credits_whatsapp_spec.rb +47 -0
  1180. data/spec/models/sub_account_details_response_plan_info_credits_wp_subscribers_spec.rb +47 -0
  1181. data/spec/models/sub_account_details_response_plan_info_features_inbox_spec.rb +1 -1
  1182. data/spec/models/sub_account_details_response_plan_info_features_landing_page_spec.rb +1 -1
  1183. data/spec/models/sub_account_details_response_plan_info_features_sales_users_spec.rb +47 -0
  1184. data/spec/models/sub_account_details_response_plan_info_features_spec.rb +7 -1
  1185. data/spec/models/sub_account_details_response_plan_info_features_users_spec.rb +1 -1
  1186. data/spec/models/sub_account_details_response_plan_info_spec.rb +1 -1
  1187. data/spec/models/sub_account_details_response_spec.rb +7 -1
  1188. data/spec/models/sub_account_update_plan_request_credits_spec.rb +25 -1
  1189. data/spec/models/sub_account_update_plan_request_features_spec.rb +7 -1
  1190. data/spec/models/sub_account_update_plan_request_spec.rb +1 -1
  1191. data/spec/models/sub_accounts_response_groups_spec.rb +47 -0
  1192. data/spec/models/sub_accounts_response_spec.rb +1 -1
  1193. data/spec/models/sub_accounts_response_sub_accounts_spec.rb +7 -1
  1194. data/spec/models/sub_accounts_update_plan_request_credits_spec.rb +65 -0
  1195. data/spec/models/sub_accounts_update_plan_request_features_spec.rb +53 -0
  1196. data/spec/models/sub_accounts_update_plan_request_spec.rb +53 -0
  1197. data/spec/models/subscription_aggregate_balance_spec.rb +47 -0
  1198. data/spec/models/subscription_attributed_reward_spec.rb +89 -0
  1199. data/spec/models/subscription_balances_spec.rb +53 -0
  1200. data/spec/models/subscription_handler_info_balance_spec.rb +35 -0
  1201. data/spec/models/subscription_handler_info_spec.rb +59 -0
  1202. data/spec/models/subscription_member_spec.rb +65 -0
  1203. data/spec/models/subscription_spec.rb +77 -0
  1204. data/spec/models/subscription_tier_spec.rb +77 -0
  1205. data/spec/models/task_list_spec.rb +1 -1
  1206. data/spec/models/task_reminder_spec.rb +1 -1
  1207. data/spec/models/task_spec.rb +1 -1
  1208. data/spec/models/task_types_spec.rb +1 -1
  1209. data/spec/models/template_preview_spec.rb +71 -0
  1210. data/spec/models/tier_access_conditions_spec.rb +59 -0
  1211. data/spec/models/tier_for_contact_spec.rb +77 -0
  1212. data/spec/models/tier_group_page_spec.rb +41 -0
  1213. data/spec/models/tier_group_spec.rb +91 -0
  1214. data/spec/models/tier_request_access_conditions_spec.rb +47 -0
  1215. data/spec/models/tier_request_put_payload_spec.rb +59 -0
  1216. data/spec/models/tier_request_spec.rb +59 -0
  1217. data/spec/models/tier_request_tier_rewards_spec.rb +41 -0
  1218. data/spec/models/tier_spec.rb +89 -0
  1219. data/spec/models/tier_tier_rewards_spec.rb +53 -0
  1220. data/spec/models/transaction_history_resp_spec.rb +65 -0
  1221. data/spec/models/transaction_history_spec.rb +95 -0
  1222. data/spec/models/transaction_spec.rb +125 -0
  1223. data/spec/models/unauthorized_response_spec.rb +41 -0
  1224. data/spec/models/update_attribute_enumeration_spec.rb +1 -1
  1225. data/spec/models/update_attribute_spec.rb +7 -1
  1226. data/spec/models/update_balance_definition_payload_spec.rb +155 -0
  1227. data/spec/models/update_balance_limit_payload_spec.rb +83 -0
  1228. data/spec/models/update_batch_contacts_contacts_spec.rb +1 -1
  1229. data/spec/models/update_batch_contacts_model_spec.rb +1 -1
  1230. data/spec/models/update_batch_contacts_spec.rb +1 -1
  1231. data/spec/models/update_campaign_status_spec.rb +1 -1
  1232. data/spec/models/update_child_spec.rb +1 -1
  1233. data/spec/models/update_contact_spec.rb +1 -1
  1234. data/spec/models/update_coupon_collection_spec.rb +1 -1
  1235. data/spec/models/update_email_campaign_email_expiration_date_spec.rb +51 -0
  1236. data/spec/models/update_email_campaign_recipients_spec.rb +7 -1
  1237. data/spec/models/update_email_campaign_sender_spec.rb +1 -1
  1238. data/spec/models/update_email_campaign_spec.rb +7 -1
  1239. data/spec/models/update_external_feed_spec.rb +1 -1
  1240. data/spec/models/update_list_spec.rb +1 -1
  1241. data/spec/models/update_loyalty_program_payload_spec.rb +53 -0
  1242. data/spec/models/update_sender_spec.rb +1 -1
  1243. data/spec/models/update_sms_campaign_spec.rb +1 -1
  1244. data/spec/models/update_smtp_template_sender_spec.rb +1 -1
  1245. data/spec/models/update_smtp_template_spec.rb +1 -1
  1246. data/spec/models/update_tier_group_request_spec.rb +67 -0
  1247. data/spec/models/update_webhook_spec.rb +1 -1
  1248. data/spec/models/update_whats_app_campaign_spec.rb +1 -1
  1249. data/spec/models/upload_image_model_spec.rb +1 -1
  1250. data/spec/models/upload_image_to_gallery_spec.rb +1 -1
  1251. data/spec/models/validation_errors_spec.rb +35 -0
  1252. data/spec/models/variables_items_spec.rb +1 -1
  1253. data/spec/models/whatsapp_camp_stats_spec.rb +1 -1
  1254. data/spec/models/whatsapp_camp_template_spec.rb +1 -1
  1255. data/spec/spec_helper.rb +1 -1
  1256. metadata +931 -433
  1257. data/docs/AddCredits.md +0 -9
  1258. data/docs/CreateReseller.md +0 -9
  1259. data/docs/GetChildAccountCreationStatus.md +0 -8
  1260. data/docs/GetChildInfo.md +0 -16
  1261. data/docs/GetChildInfoApiKeys.md +0 -9
  1262. data/docs/GetChildInfoApiKeysV2.md +0 -9
  1263. data/docs/GetChildInfoApiKeysV3.md +0 -9
  1264. data/docs/GetChildInfoCredits.md +0 -9
  1265. data/docs/GetChildInfoStatistics.md +0 -10
  1266. data/docs/GetChildrenList.md +0 -9
  1267. data/docs/RemainingCreditModel.md +0 -9
  1268. data/docs/RemainingCreditModelChild.md +0 -9
  1269. data/docs/RemainingCreditModelReseller.md +0 -9
  1270. data/docs/RemoveCredits.md +0 -9
  1271. data/docs/ResellerApi.md +0 -964
  1272. data/docs/UpdateChildAccountStatus.md +0 -11
  1273. data/docs/UpdateChildDomain.md +0 -8
  1274. data/lib/brevo/api/reseller_api.rb +0 -923
  1275. data/lib/brevo/models/get_child_info_statistics.rb +0 -206
  1276. data/spec/api/reseller_api_spec.rb +0 -223
  1277. data/spec/models/get_child_info_credits_spec.rb +0 -47
  1278. data/spec/models/remaining_credit_model_spec.rb +0 -47
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -1098,6 +1098,58 @@ module Brevo
1098
1098
  end
1099
1099
  return data, status_code, headers
1100
1100
  end
1101
+ # Generate the rendered preview of transactional template
1102
+ # @param fetch_template_preview Values to fetch Template preview
1103
+ # @param [Hash] opts the optional parameters
1104
+ # @return [TemplatePreview]
1105
+ def post_preview_smtp_email_templates(fetch_template_preview, opts = {})
1106
+ data, _status_code, _headers = post_preview_smtp_email_templates_with_http_info(fetch_template_preview, opts)
1107
+ data
1108
+ end
1109
+
1110
+ # Generate the rendered preview of transactional template
1111
+ # @param fetch_template_preview Values to fetch Template preview
1112
+ # @param [Hash] opts the optional parameters
1113
+ # @return [Array<(TemplatePreview, Fixnum, Hash)>] TemplatePreview data, response status code and response headers
1114
+ def post_preview_smtp_email_templates_with_http_info(fetch_template_preview, opts = {})
1115
+ if @api_client.config.debugging
1116
+ @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.post_preview_smtp_email_templates ...'
1117
+ end
1118
+ # verify the required parameter 'fetch_template_preview' is set
1119
+ if @api_client.config.client_side_validation && fetch_template_preview.nil?
1120
+ fail ArgumentError, "Missing the required parameter 'fetch_template_preview' when calling TransactionalEmailsApi.post_preview_smtp_email_templates"
1121
+ end
1122
+ # resource path
1123
+ local_var_path = '/smtp/template/preview'
1124
+
1125
+ # query parameters
1126
+ query_params = {}
1127
+
1128
+ # header parameters
1129
+ header_params = {}
1130
+ # HTTP header 'Accept' (if needed)
1131
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1132
+ # HTTP header 'Content-Type'
1133
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1134
+
1135
+ # form parameters
1136
+ form_params = {}
1137
+
1138
+ # http body (model)
1139
+ post_body = @api_client.object_to_http_body(fetch_template_preview)
1140
+ auth_names = ['api-key', 'partner-key']
1141
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1142
+ :header_params => header_params,
1143
+ :query_params => query_params,
1144
+ :form_params => form_params,
1145
+ :body => post_body,
1146
+ :auth_names => auth_names,
1147
+ :return_type => 'TemplatePreview')
1148
+ if @api_client.config.debugging
1149
+ @api_client.config.logger.debug "API called: TransactionalEmailsApi#post_preview_smtp_email_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1150
+ end
1151
+ return data, status_code, headers
1152
+ end
1101
1153
  # Send a template to your test list
1102
1154
  # @param template_id Id of the template
1103
1155
  # @param send_test_email
@@ -1259,7 +1311,7 @@ module Brevo
1259
1311
  return data, status_code, headers
1260
1312
  end
1261
1313
  # Delete an SMTP transactional log
1262
- # @param identifier MessageId or Email of the transactional log(s) to delete
1314
+ # @param identifier MessageId of the transactional log(s) to delete
1263
1315
  # @param [Hash] opts the optional parameters
1264
1316
  # @return [nil]
1265
1317
  def smtp_log_identifier_delete(identifier, opts = {})
@@ -1268,7 +1320,7 @@ module Brevo
1268
1320
  end
1269
1321
 
1270
1322
  # Delete an SMTP transactional log
1271
- # @param identifier MessageId or Email of the transactional log(s) to delete
1323
+ # @param identifier MessageId of the transactional log(s) to delete
1272
1324
  # @param [Hash] opts the optional parameters
1273
1325
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1274
1326
  def smtp_log_identifier_delete_with_http_info(identifier, opts = {})
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -66,8 +66,8 @@ module Brevo
66
66
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalSMSApi.get_sms_events, must be smaller than or equal to 100.'
67
67
  end
68
68
 
69
- if @api_client.config.client_side_validation && opts[:'event'] && !['bounces', 'hardBounces', 'softBounces', 'delivered', 'sent', 'accepted', 'unsubscription', 'replies', 'blocked', 'rejected'].include?(opts[:'event'])
70
- fail ArgumentError, 'invalid value for "event", must be one of bounces, hardBounces, softBounces, delivered, sent, accepted, unsubscription, replies, blocked, rejected'
69
+ if @api_client.config.client_side_validation && opts[:'event'] && !['bounces', 'hardBounces', 'softBounces', 'delivered', 'sent', 'accepted', 'unsubscription', 'replies', 'blocked', 'rejected', 'skipped'].include?(opts[:'event'])
70
+ fail ArgumentError, 'invalid value for "event", must be one of bounces, hardBounces, softBounces, delivered, sent, accepted, unsubscription, replies, blocked, rejected, skipped'
71
71
  end
72
72
  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
73
73
  fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
@@ -234,6 +234,51 @@ module Brevo
234
234
  end
235
235
  return data, status_code, headers
236
236
  end
237
+ # Send SMS message asynchronously to a mobile number
238
+ # @param [Hash] opts the optional parameters
239
+ # @return [nil]
240
+ def send_async_transactional_sms(opts = {})
241
+ send_async_transactional_sms_with_http_info(opts)
242
+ nil
243
+ end
244
+
245
+ # Send SMS message asynchronously to a mobile number
246
+ # @param [Hash] opts the optional parameters
247
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
248
+ def send_async_transactional_sms_with_http_info(opts = {})
249
+ if @api_client.config.debugging
250
+ @api_client.config.logger.debug 'Calling API: TransactionalSMSApi.send_async_transactional_sms ...'
251
+ end
252
+ # resource path
253
+ local_var_path = '/transactionalSMS/send'
254
+
255
+ # query parameters
256
+ query_params = {}
257
+
258
+ # header parameters
259
+ header_params = {}
260
+ # HTTP header 'Accept' (if needed)
261
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
262
+ # HTTP header 'Content-Type'
263
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
264
+
265
+ # form parameters
266
+ form_params = {}
267
+
268
+ # http body (model)
269
+ post_body = nil
270
+ auth_names = ['api-key', 'partner-key']
271
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
272
+ :header_params => header_params,
273
+ :query_params => query_params,
274
+ :form_params => form_params,
275
+ :body => post_body,
276
+ :auth_names => auth_names)
277
+ if @api_client.config.debugging
278
+ @api_client.config.logger.debug "API called: TransactionalSMSApi#send_async_transactional_sms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
279
+ end
280
+ return data, status_code, headers
281
+ end
237
282
  # Send SMS message to a mobile number
238
283
  # @param send_transac_sms Values to send a transactional SMS
239
284
  # @param [Hash] opts the optional parameters
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -62,8 +62,8 @@ module Brevo
62
62
  if @api_client.config.debugging
63
63
  @api_client.config.logger.debug 'Calling API: TransactionalWhatsAppApi.get_whatsapp_event_report ...'
64
64
  end
65
- if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 5000
66
- fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalWhatsAppApi.get_whatsapp_event_report, must be smaller than or equal to 5000.'
65
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 10000
66
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalWhatsAppApi.get_whatsapp_event_report, must be smaller than or equal to 10000.'
67
67
  end
68
68
 
69
69
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -30,7 +30,7 @@ module Brevo
30
30
  end
31
31
 
32
32
  # Update permission for a user
33
- # `Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. `Permission` - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - `email_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `sms_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `contacts`: - \"view\" - \"create_edit_delete\" - \"import\" - \"export\" - \"list_and_attributes\" - \"forms\" - `templates`: - \"create_edit_delete\" - \"activate_deactivate\" - `workflows`: - \"create_edit_delete\" - \"activate_deactivate_pause\" - \"settings\" - `facebook_ads`: - \"create_edit_delete\" - \"schedule_pause\" - `landing_pages`: - \"all\" - `transactional_emails`: - \"settings\" - \"logs\" - `smtp_api`: - \"smtp\" - \"api_keys\" - \"authorized_ips\" - `user_management`: - \"all\" - `sales_platform`: - \"manage_owned_deals_tasks_companies\" - \"manage_others_deals_tasks_companies\" - \"reports\" - \"settings\" - `phone`: - \"all\" - `conversations`: - \"access\" - \"assign\" - \"configure\" - `senders_domains_dedicated_ips`: - \"senders_management\" - \"domains_management\" - \"dedicated_ips_management\" - `push_notifications`: - \"view\" - \"create_edit_delete\" - \"send\" - \"settings\" **Note**: - The privileges array remains the same as in the send invitation; the user simply needs to provide the permissions that need to be updated. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
33
+ # `Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. `Permission` - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - `email_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `sms_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `contacts`: - \"view\" - \"create_edit_delete\" - \"import\" - \"export\" - \"list_and_attributes\" - \"forms\" - `templates`: - \"create_edit_delete\" - \"activate_deactivate\" - `workflows`: - \"create_edit_delete\" - \"activate_deactivate_pause\" - \"settings\" - `landing_pages`: - \"all\" - `transactional_emails`: - \"settings\" - \"logs\" - `smtp_api`: - \"smtp\" - \"api_keys\" - \"authorized_ips\" - `user_management`: - \"all\" - `sales_platform`: - \"create_edit_deals\" - \"delete_deals\" - \"manage_others_deals_tasks\" - \"reports\" - \"settings\" - `phone`: - \"all\" - `conversations`: - \"access\" - \"assign\" - \"configure\" - `senders_domains_dedicated_ips`: - \"senders_management\" - \"domains_management\" - \"dedicated_ips_management\" - `push_notifications`: - \"view\" - \"create_edit_delete\" - \"send\" - \"settings\" - `companies`: - \"manage_owned_companies\" - \"manage_other_companies\" - \"settings\" **Note**: - The privileges array remains the same as in the send invitation; the user simply needs to provide the permissions that need to be updated. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
34
34
  # @param update_permissions Values to update permissions for an invited user
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Inviteuser]
@@ -40,7 +40,7 @@ module Brevo
40
40
  end
41
41
 
42
42
  # Update permission for a user
43
- # &#x60;Feature&#x60; - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. &#x60;Permission&#x60; - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - &#x60;email_campaigns&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;send_schedule_suspend\&quot; - &#x60;sms_campaigns&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;send_schedule_suspend\&quot; - &#x60;contacts&#x60;: - \&quot;view\&quot; - \&quot;create_edit_delete\&quot; - \&quot;import\&quot; - \&quot;export\&quot; - \&quot;list_and_attributes\&quot; - \&quot;forms\&quot; - &#x60;templates&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;activate_deactivate\&quot; - &#x60;workflows&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;activate_deactivate_pause\&quot; - \&quot;settings\&quot; - &#x60;facebook_ads&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;schedule_pause\&quot; - &#x60;landing_pages&#x60;: - \&quot;all\&quot; - &#x60;transactional_emails&#x60;: - \&quot;settings\&quot; - \&quot;logs\&quot; - &#x60;smtp_api&#x60;: - \&quot;smtp\&quot; - \&quot;api_keys\&quot; - \&quot;authorized_ips\&quot; - &#x60;user_management&#x60;: - \&quot;all\&quot; - &#x60;sales_platform&#x60;: - \&quot;manage_owned_deals_tasks_companies\&quot; - \&quot;manage_others_deals_tasks_companies\&quot; - \&quot;reports\&quot; - \&quot;settings\&quot; - &#x60;phone&#x60;: - \&quot;all\&quot; - &#x60;conversations&#x60;: - \&quot;access\&quot; - \&quot;assign\&quot; - \&quot;configure\&quot; - &#x60;senders_domains_dedicated_ips&#x60;: - \&quot;senders_management\&quot; - \&quot;domains_management\&quot; - \&quot;dedicated_ips_management\&quot; - &#x60;push_notifications&#x60;: - \&quot;view\&quot; - \&quot;create_edit_delete\&quot; - \&quot;send\&quot; - \&quot;settings\&quot; **Note**: - The privileges array remains the same as in the send invitation; the user simply needs to provide the permissions that need to be updated. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
43
+ # &#x60;Feature&#x60; - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. &#x60;Permission&#x60; - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - &#x60;email_campaigns&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;send_schedule_suspend\&quot; - &#x60;sms_campaigns&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;send_schedule_suspend\&quot; - &#x60;contacts&#x60;: - \&quot;view\&quot; - \&quot;create_edit_delete\&quot; - \&quot;import\&quot; - \&quot;export\&quot; - \&quot;list_and_attributes\&quot; - \&quot;forms\&quot; - &#x60;templates&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;activate_deactivate\&quot; - &#x60;workflows&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;activate_deactivate_pause\&quot; - \&quot;settings\&quot; - &#x60;landing_pages&#x60;: - \&quot;all\&quot; - &#x60;transactional_emails&#x60;: - \&quot;settings\&quot; - \&quot;logs\&quot; - &#x60;smtp_api&#x60;: - \&quot;smtp\&quot; - \&quot;api_keys\&quot; - \&quot;authorized_ips\&quot; - &#x60;user_management&#x60;: - \&quot;all\&quot; - &#x60;sales_platform&#x60;: - \&quot;create_edit_deals\&quot; - \&quot;delete_deals\&quot; - \&quot;manage_others_deals_tasks\&quot; - \&quot;reports\&quot; - \&quot;settings\&quot; - &#x60;phone&#x60;: - \&quot;all\&quot; - &#x60;conversations&#x60;: - \&quot;access\&quot; - \&quot;assign\&quot; - \&quot;configure\&quot; - &#x60;senders_domains_dedicated_ips&#x60;: - \&quot;senders_management\&quot; - \&quot;domains_management\&quot; - \&quot;dedicated_ips_management\&quot; - &#x60;push_notifications&#x60;: - \&quot;view\&quot; - \&quot;create_edit_delete\&quot; - \&quot;send\&quot; - \&quot;settings\&quot; - &#x60;companies&#x60;: - \&quot;manage_owned_companies\&quot; - \&quot;manage_other_companies\&quot; - \&quot;settings\&quot; **Note**: - The privileges array remains the same as in the send invitation; the user simply needs to provide the permissions that need to be updated. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
44
44
  # @param update_permissions Values to update permissions for an invited user
45
45
  # @param [Hash] opts the optional parameters
46
46
  # @return [Array<(Inviteuser, Fixnum, Hash)>] Inviteuser data, response status code and response headers
@@ -182,7 +182,7 @@ module Brevo
182
182
  return data, status_code, headers
183
183
  end
184
184
  # Send invitation to user
185
- # `Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. `Permission` - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - `email_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `sms_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `contacts`: - \"view\" - \"create_edit_delete\" - \"import\" - \"export\" - \"list_and_attributes\" - \"forms\" - `templates`: - \"create_edit_delete\" - \"activate_deactivate\" - `workflows`: - \"create_edit_delete\" - \"activate_deactivate_pause\" - \"settings\" - `facebook_ads`: - \"create_edit_delete\" - \"schedule_pause\" - `landing_pages`: - \"all\" - `transactional_emails`: - \"settings\" - \"logs\" - `smtp_api`: - \"smtp\" - \"api_keys\" - \"authorized_ips\" - `user_management`: - \"all\" - `sales_platform`: - \"manage_owned_deals_tasks_companies\" - \"manage_others_deals_tasks_companies\" - \"reports\" - \"settings\" - `phone`: - \"all\" - `conversations`: - \"access\" - \"assign\" - \"configure\" - `senders_domains_dedicated_ips`: - \"senders_management\" - \"domains_management\" - \"dedicated_ips_management\" - `push_notifications`: - \"view\" - \"create_edit_delete\" - \"send\" - \"settings\" **Note**: - If `all_features_access: false` then only privileges are required otherwise if `true` then it's assumed that all permissions will be there for the invited user. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
185
+ # `Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. `Permission` - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - `email_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `sms_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `contacts`: - \"view\" - \"create_edit_delete\" - \"import\" - \"export\" - \"list_and_attributes\" - \"forms\" - `templates`: - \"create_edit_delete\" - \"activate_deactivate\" - `workflows`: - \"create_edit_delete\" - \"activate_deactivate_pause\" - \"settings\" - `landing_pages`: - \"all\" - `transactional_emails`: - \"settings\" - \"logs\" - `smtp_api`: - \"smtp\" - \"api_keys\" - \"authorized_ips\" - `user_management`: - \"all\" - `sales_platform`: - \"create_edit_deals\" - \"delete_deals\" - \"manage_others_deals_tasks\" - \"reports\" - \"settings\" - `phone`: - \"all\" - `conversations`: - \"access\" - \"assign\" - \"configure\" - `senders_domains_dedicated_ips`: - \"senders_management\" - \"domains_management\" - \"dedicated_ips_management\" - `push_notifications`: - \"view\" - \"create_edit_delete\" - \"send\" - \"settings\" - `companies`: - \"manage_owned_companies\" - \"manage_other_companies\" - \"settings\" **Note**: - If `all_features_access: false` then only privileges are required otherwise if `true` then it's assumed that all permissions will be there for the invited user. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
186
186
  # @param send_invitation Values to create an invitation
187
187
  # @param [Hash] opts the optional parameters
188
188
  # @return [Inviteuser]
@@ -192,7 +192,7 @@ module Brevo
192
192
  end
193
193
 
194
194
  # Send invitation to user
195
- # &#x60;Feature&#x60; - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. &#x60;Permission&#x60; - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - &#x60;email_campaigns&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;send_schedule_suspend\&quot; - &#x60;sms_campaigns&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;send_schedule_suspend\&quot; - &#x60;contacts&#x60;: - \&quot;view\&quot; - \&quot;create_edit_delete\&quot; - \&quot;import\&quot; - \&quot;export\&quot; - \&quot;list_and_attributes\&quot; - \&quot;forms\&quot; - &#x60;templates&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;activate_deactivate\&quot; - &#x60;workflows&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;activate_deactivate_pause\&quot; - \&quot;settings\&quot; - &#x60;facebook_ads&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;schedule_pause\&quot; - &#x60;landing_pages&#x60;: - \&quot;all\&quot; - &#x60;transactional_emails&#x60;: - \&quot;settings\&quot; - \&quot;logs\&quot; - &#x60;smtp_api&#x60;: - \&quot;smtp\&quot; - \&quot;api_keys\&quot; - \&quot;authorized_ips\&quot; - &#x60;user_management&#x60;: - \&quot;all\&quot; - &#x60;sales_platform&#x60;: - \&quot;manage_owned_deals_tasks_companies\&quot; - \&quot;manage_others_deals_tasks_companies\&quot; - \&quot;reports\&quot; - \&quot;settings\&quot; - &#x60;phone&#x60;: - \&quot;all\&quot; - &#x60;conversations&#x60;: - \&quot;access\&quot; - \&quot;assign\&quot; - \&quot;configure\&quot; - &#x60;senders_domains_dedicated_ips&#x60;: - \&quot;senders_management\&quot; - \&quot;domains_management\&quot; - \&quot;dedicated_ips_management\&quot; - &#x60;push_notifications&#x60;: - \&quot;view\&quot; - \&quot;create_edit_delete\&quot; - \&quot;send\&quot; - \&quot;settings\&quot; **Note**: - If &#x60;all_features_access: false&#x60; then only privileges are required otherwise if &#x60;true&#x60; then it&#39;s assumed that all permissions will be there for the invited user. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
195
+ # &#x60;Feature&#x60; - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. &#x60;Permission&#x60; - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - &#x60;email_campaigns&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;send_schedule_suspend\&quot; - &#x60;sms_campaigns&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;send_schedule_suspend\&quot; - &#x60;contacts&#x60;: - \&quot;view\&quot; - \&quot;create_edit_delete\&quot; - \&quot;import\&quot; - \&quot;export\&quot; - \&quot;list_and_attributes\&quot; - \&quot;forms\&quot; - &#x60;templates&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;activate_deactivate\&quot; - &#x60;workflows&#x60;: - \&quot;create_edit_delete\&quot; - \&quot;activate_deactivate_pause\&quot; - \&quot;settings\&quot; - &#x60;landing_pages&#x60;: - \&quot;all\&quot; - &#x60;transactional_emails&#x60;: - \&quot;settings\&quot; - \&quot;logs\&quot; - &#x60;smtp_api&#x60;: - \&quot;smtp\&quot; - \&quot;api_keys\&quot; - \&quot;authorized_ips\&quot; - &#x60;user_management&#x60;: - \&quot;all\&quot; - &#x60;sales_platform&#x60;: - \&quot;create_edit_deals\&quot; - \&quot;delete_deals\&quot; - \&quot;manage_others_deals_tasks\&quot; - \&quot;reports\&quot; - \&quot;settings\&quot; - &#x60;phone&#x60;: - \&quot;all\&quot; - &#x60;conversations&#x60;: - \&quot;access\&quot; - \&quot;assign\&quot; - \&quot;configure\&quot; - &#x60;senders_domains_dedicated_ips&#x60;: - \&quot;senders_management\&quot; - \&quot;domains_management\&quot; - \&quot;dedicated_ips_management\&quot; - &#x60;push_notifications&#x60;: - \&quot;view\&quot; - \&quot;create_edit_delete\&quot; - \&quot;send\&quot; - \&quot;settings\&quot; - &#x60;companies&#x60;: - \&quot;manage_owned_companies\&quot; - \&quot;manage_other_companies\&quot; - \&quot;settings\&quot; **Note**: - If &#x60;all_features_access: false&#x60; then only privileges are required otherwise if &#x60;true&#x60; then it&#39;s assumed that all permissions will be there for the invited user. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
196
196
  # @param send_invitation Values to create an invitation
197
197
  # @param [Hash] opts the optional parameters
198
198
  # @return [Array<(Inviteuser, Fixnum, Hash)>] Inviteuser data, response status code and response headers
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Brevo API
3
3
 
4
- #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
4
+ #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
5
5
 
6
6
  OpenAPI spec version: 3.0.0
7
7
  Contact: contact@brevo.com
@@ -14,17 +14,21 @@ require 'date'
14
14
 
15
15
  module Brevo
16
16
  class AddContactToList
17
- # Mandatory if IDs are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api.
17
+ # Mandatory if IDs, EXT_ID attributes are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api.
18
18
  attr_accessor :emails
19
19
 
20
- # Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api.
20
+ # Mandatory if Emails, EXT_ID attributes are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 ids for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api.
21
21
  attr_accessor :ids
22
22
 
23
+ # Mandatory if Emails, IDs are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 extIds for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api.
24
+ attr_accessor :ext_ids
25
+
23
26
  # Attribute mapping from ruby-style variable name to JSON key.
24
27
  def self.attribute_map
25
28
  {
26
29
  :'emails' => :'emails',
27
- :'ids' => :'ids'
30
+ :'ids' => :'ids',
31
+ :'ext_ids' => :'extIds'
28
32
  }
29
33
  end
30
34
 
@@ -32,7 +36,8 @@ module Brevo
32
36
  def self.swagger_types
33
37
  {
34
38
  :'emails' => :'Array<String>',
35
- :'ids' => :'Array<Integer>'
39
+ :'ids' => :'Array<Integer>',
40
+ :'ext_ids' => :'Array<String>'
36
41
  }
37
42
  end
38
43
 
@@ -55,6 +60,12 @@ module Brevo
55
60
  self.ids = value
56
61
  end
57
62
  end
63
+
64
+ if attributes.has_key?(:'extIds')
65
+ if (value = attributes[:'extIds']).is_a?(Array)
66
+ self.ext_ids = value
67
+ end
68
+ end
58
69
  end
59
70
 
60
71
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -76,7 +87,8 @@ module Brevo
76
87
  return true if self.equal?(o)
77
88
  self.class == o.class &&
78
89
  emails == o.emails &&
79
- ids == o.ids
90
+ ids == o.ids &&
91
+ ext_ids == o.ext_ids
80
92
  end
81
93
 
82
94
  # @see the `==` method
@@ -88,7 +100,7 @@ module Brevo
88
100
  # Calculates hash code according to all attributes.
89
101
  # @return [Fixnum] Hash code
90
102
  def hash
91
- [emails, ids].hash
103
+ [emails, ids, ext_ids].hash
92
104
  end
93
105
 
94
106
  # Builds the object from hash