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