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.
- checksums.yaml +4 -4
- data/README.md +263 -40
- data/brevo-3.0.0.gem +0 -0
- data/brevo.gemspec +1 -1
- data/docs/AccountApi.md +2 -0
- data/docs/AddContactToList.md +3 -2
- data/docs/AddSubscriptionMemberPayload.md +10 -0
- data/docs/AggregateBalance.md +9 -0
- data/docs/Balance.md +16 -0
- data/docs/BalanceApi.md +1203 -0
- data/docs/BalanceDataPerContact.md +11 -0
- data/docs/BalanceDefinition.md +27 -0
- data/docs/BalanceDefinitionPage.md +8 -0
- data/docs/BalanceLimit.md +17 -0
- data/docs/BalanceOrder.md +19 -0
- data/docs/Body.md +2 -3
- data/docs/Body1.md +2 -3
- data/docs/Body10.md +4 -4
- data/docs/Body11.md +4 -1
- data/docs/Body12.md +4 -4
- data/docs/Body13.md +18 -0
- data/docs/Body14.md +17 -0
- data/docs/Body15.md +13 -0
- data/docs/{ManageIp.md → Body16.md} +2 -2
- data/docs/Body17.md +11 -0
- data/docs/Body18.md +8 -0
- data/docs/Body19.md +11 -0
- data/docs/Body2.md +2 -4
- data/docs/Body3.md +2 -2
- data/docs/Body4.md +1 -2
- data/docs/Body5.md +2 -4
- data/docs/Body6.md +5 -11
- data/docs/Body7.md +5 -10
- data/docs/Body8.md +4 -6
- data/docs/Body9.md +5 -1
- data/docs/Cart.md +9 -0
- data/docs/CompaniesApi.md +185 -60
- data/docs/Configuration.md +8 -0
- data/docs/ContactBalancesResp.md +11 -0
- data/docs/ContactErrorModel.md +10 -0
- data/docs/ContactsApi.md +116 -27
- data/docs/ConversationsApi.md +10 -10
- data/docs/ConversationsMessage.md +15 -0
- data/docs/ConversationsMessageAttachments.md +13 -0
- data/docs/ConversationsMessageForwardedToSourceStatus.md +9 -0
- data/docs/ConversationsMessageFrom.md +9 -0
- data/docs/ConversationsMessageReplyTo.md +9 -0
- data/docs/ConversationsMessageTo.md +9 -0
- data/docs/ConversionSourceMetrics.md +12 -0
- data/docs/ConversionSourceProduct.md +15 -0
- data/docs/CorporateGroupDetailsResponse.md +10 -0
- data/docs/CorporateGroupDetailsResponseGroup.md +10 -0
- data/docs/CorporateGroupDetailsResponseSubaccounts.md +10 -0
- data/docs/CorporateGroupDetailsResponseUsers.md +10 -0
- data/docs/CorporateuseremailpermissionsPrivileges.md +9 -0
- data/docs/CouponsApi.md +12 -9
- data/docs/CreateAttribute.md +3 -2
- data/docs/CreateBalanceDefinitionPayload.md +23 -0
- data/docs/CreateBalanceLimitPayload.md +13 -0
- data/docs/CreateBalancePayload.md +8 -0
- data/docs/CreateContact.md +2 -2
- data/docs/CreateCouponCollection.md +5 -2
- data/docs/CreateDoiContact.md +1 -1
- data/docs/CreateDomainModel.md +1 -0
- data/docs/CreateDomainModelDnsRecords.md +1 -0
- data/docs/CreateEmailCampaign.md +1 -0
- data/docs/CreateEmailCampaignEmailExpirationDate.md +9 -0
- data/docs/CreateEmailCampaignRecipients.md +1 -0
- data/docs/CreateLoyaltyProgramPayload.md +11 -0
- data/docs/CreateOrderPayload.md +14 -0
- data/docs/CreatePaymentRequest.md +13 -0
- data/docs/CreatePaymentResponse.md +9 -0
- data/docs/CreateSubAccount.md +1 -0
- data/docs/CreateSubscriptionPayload.md +10 -0
- data/docs/CreateSubscriptionResponse.md +14 -0
- data/docs/CreateTierGroupRequest.md +11 -0
- data/docs/CreateTransactionPayload.md +16 -0
- data/docs/CreateUpdateCategories.md +1 -0
- data/docs/CreateUpdateCategory.md +1 -0
- data/docs/CreateUpdateProduct.md +2 -1
- data/docs/CreateUpdateProducts.md +2 -1
- data/docs/CreateWebhook.md +5 -1
- data/docs/CreateWhatsAppTemplate.md +1 -0
- data/docs/DealsApi.md +135 -10
- data/docs/EcommerceApi.md +380 -2
- data/docs/EmailCampaignsApi.md +3 -5
- data/docs/ErrorResponse.md +8 -0
- data/docs/Event.md +12 -0
- data/docs/EventIdentifiers.md +12 -0
- data/docs/EventsApi.md +67 -0
- data/docs/ExportWebhooksHistory.md +2 -1
- data/docs/ExternalFeedsApi.md +2 -2
- data/docs/FetchTemplatePreview.md +10 -0
- data/docs/GetAccountPlan.md +2 -3
- data/docs/GetAttributesAttributes.md +1 -0
- data/docs/GetCampaignStats.md +2 -0
- data/docs/GetContactDetails.md +1 -1
- data/docs/GetCorporateInvitedUsersList.md +8 -0
- data/docs/GetCorporateInvitedUsersListFeatureAccess.md +16 -0
- data/docs/GetCorporateInvitedUsersListGroups.md +9 -0
- data/docs/GetCorporateInvitedUsersListUsers.md +12 -0
- data/docs/GetCorporateUserPermission.md +11 -0
- data/docs/GetCorporateUserPermissionFeatureAccess.md +16 -0
- data/docs/GetCorporateUserPermissionGroups.md +9 -0
- data/docs/GetCouponCollection.md +9 -6
- data/docs/GetEmailCampaign.md +4 -0
- data/docs/GetExtendedCampaignOverview.md +4 -0
- data/docs/GetExtendedContactDetails.md +1 -1
- data/docs/GetOrders.md +9 -0
- data/docs/GetPaymentRequest.md +14 -0
- data/docs/{GetSegmentsSegments.md → GetSegment.md} +4 -4
- data/docs/GetSegments.md +1 -1
- data/docs/GetTransacAggregatedSmsReport.md +3 -2
- data/docs/GetTransacSmsReportReports.md +3 -2
- data/docs/GetWebhook.md +3 -0
- data/docs/GetWebhookAuth.md +9 -0
- data/docs/GetWebhookHeaders.md +9 -0
- data/docs/InlineResponse200.md +1 -1
- data/docs/InlineResponse2001.md +2 -3
- data/docs/InlineResponse2002.md +8 -0
- data/docs/InlineResponse2003.md +8 -0
- data/docs/InlineResponse2004.md +8 -0
- data/docs/InlineResponse2005.md +8 -0
- data/docs/InlineResponse2006.md +9 -0
- data/docs/InlineResponse2006Totals.md +10 -0
- data/docs/InlineResponse2007.md +9 -0
- data/docs/InlineResponse2008.md +8 -0
- data/docs/InlineResponse2009.md +10 -0
- data/docs/InlineResponse201.md +1 -1
- data/docs/InlineResponse2011.md +1 -1
- data/docs/InlineResponse2012.md +1 -1
- data/docs/InlineResponse2013.md +1 -1
- data/docs/InlineResponse2014.md +1 -1
- data/docs/InlineResponse2015.md +8 -0
- data/docs/InlineResponse400.md +8 -0
- data/docs/InviteAdminUser.md +11 -0
- data/docs/InviteAdminUserPrivileges.md +9 -0
- data/docs/Inviteuser.md +10 -0
- data/docs/InviteuserPrivileges.md +9 -0
- data/docs/LoyaltyProgram.md +19 -0
- data/docs/LoyaltyProgramPage.md +8 -0
- data/docs/LoyaltyProgramValidationError.md +10 -0
- data/docs/LoyaltyTierPage.md +8 -0
- data/docs/MainAttributeRewardPayload.md +14 -0
- data/docs/MainBillingPayload.md +14 -0
- data/docs/MainCodeCountHttpResponse.md +8 -0
- data/docs/MainCreateRedeemPayload.md +15 -0
- data/docs/MainCreateRedeemPayloadOrder.md +7 -0
- data/docs/MainCreateRewardPayload.md +11 -0
- data/docs/MainCreateRewardResponse.md +15 -0
- data/docs/MainErrorResponse.md +8 -0
- data/docs/MainFilter.md +9 -0
- data/docs/MainGenerator.md +13 -0
- data/docs/MainGetContactRewardsPayload.md +14 -0
- data/docs/MainIdentifiersPayload.md +9 -0
- data/docs/MainLimit.md +15 -0
- data/docs/MainModelContactReward.md +17 -0
- data/docs/MainModelContactRewardsResp.md +12 -0
- data/docs/MainNodeResponse.md +15 -0
- data/docs/MainOrderPayload.md +19 -0
- data/docs/MainOrderPayloadBilling.md +7 -0
- data/docs/MainOrderPayloadIdentifiers.md +7 -0
- data/docs/MainProduct.md +11 -0
- data/docs/MainProductPayload.md +12 -0
- data/docs/MainRedeem.md +21 -0
- data/docs/MainResultParameterResponse.md +9 -0
- data/docs/MainResultParameterResponseValue.md +7 -0
- data/docs/MainReward.md +47 -0
- data/docs/MainRewardAttribution.md +18 -0
- data/docs/MainRewardConfigurations.md +10 -0
- data/docs/MainRewardGenerator.md +7 -0
- data/docs/MainRewardPage.md +9 -0
- data/docs/MainRewardPageObj.md +16 -0
- data/docs/{GetChildDomains.md → MainRewardRule.md} +1 -1
- data/docs/MainRewardValidate.md +8 -0
- data/docs/MainRule.md +20 -0
- data/docs/MainRuleCondition.md +7 -0
- data/docs/MainRuleConditionResponse.md +12 -0
- data/docs/MainRuleConditionResponseLhs.md +7 -0
- data/docs/MainRuleConditionResponseRhs.md +7 -0
- data/docs/MainRuleEvent.md +7 -0
- data/docs/MainRuleEventResponse.md +9 -0
- data/docs/MainRuleResultResponse.md +10 -0
- data/docs/MainValidateRewardPayload.md +13 -0
- data/docs/MainValueResponse.md +15 -0
- data/docs/MainValueResponseExpression.md +7 -0
- data/docs/MainVoucherRevokePayload.md +8 -0
- data/docs/MasterAccountApi.md +1123 -115
- data/docs/MasterDetailsResponsePlanInfoFeatures.md +2 -0
- data/docs/MemberContact.md +10 -0
- data/docs/ModelSubscriptionBalanceResp.md +8 -0
- data/docs/Notification.md +9 -0
- data/docs/Order.md +3 -1
- data/docs/OrderBatch.md +1 -0
- data/docs/OrderBilling.md +2 -1
- data/docs/OrderIdentifiers.md +11 -0
- data/docs/PatchLoyaltyProgramPayload.md +10 -0
- data/docs/PaymentsApi.md +181 -0
- data/docs/ProgramApi.md +695 -0
- data/docs/PutRevokeUserPermission.md +8 -0
- data/docs/Putresendcancelinvitation.md +8 -0
- data/docs/RemoveContactFromList.md +4 -3
- data/docs/RequestContactExport.md +5 -1
- data/docs/RequestContactExportCustomContactFilter.md +2 -1
- data/docs/RequestContactImport.md +1 -0
- data/docs/RewardApi.md +664 -0
- data/docs/SendSmtpEmail.md +3 -3
- data/docs/SendSmtpEmailMessageVersions.md +2 -0
- data/docs/SendTransacSms.md +1 -1
- data/docs/SendTransacSmsTag.md +8 -0
- data/docs/SendWhatsappMessage.md +1 -0
- data/docs/SetConfigDisplayCurrency.md +8 -0
- data/docs/SsoTokenRequestCorporate.md +8 -0
- data/docs/SubAccountAppsToggleRequest.md +1 -1
- data/docs/SubAccountDetailsResponse.md +1 -0
- data/docs/SubAccountDetailsResponseGroups.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoCredits.md +4 -1
- data/docs/SubAccountDetailsResponsePlanInfoCreditsExternalFeeds.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoCreditsSms.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoCreditsWhatsapp.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoCreditsWpSubscribers.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeatures.md +1 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesSalesUsers.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +2 -2
- data/docs/SubAccountUpdatePlanRequestCredits.md +5 -1
- data/docs/SubAccountUpdatePlanRequestFeatures.md +2 -1
- data/docs/SubAccountsResponseGroups.md +9 -0
- data/docs/SubAccountsResponseSubAccounts.md +1 -0
- data/docs/SubAccountsUpdatePlanRequest.md +10 -0
- data/docs/SubAccountsUpdatePlanRequestCredits.md +12 -0
- data/docs/SubAccountsUpdatePlanRequestFeatures.md +10 -0
- data/docs/Subscription.md +14 -0
- data/docs/SubscriptionAggregateBalance.md +9 -0
- data/docs/SubscriptionAttributedReward.md +16 -0
- data/docs/SubscriptionBalances.md +10 -0
- data/docs/SubscriptionHandlerInfo.md +11 -0
- data/docs/SubscriptionHandlerInfoBalance.md +7 -0
- data/docs/SubscriptionMember.md +12 -0
- data/docs/SubscriptionTier.md +14 -0
- data/docs/TasksApi.md +8 -8
- data/docs/TemplatePreview.md +13 -0
- data/docs/Tier.md +16 -0
- data/docs/TierAccessConditions.md +11 -0
- data/docs/TierApi.md +656 -0
- data/docs/TierForContact.md +14 -0
- data/docs/TierGroup.md +15 -0
- data/docs/TierGroupPage.md +8 -0
- data/docs/TierRequest.md +11 -0
- data/docs/TierRequestAccessConditions.md +9 -0
- data/docs/TierRequestPutPayload.md +11 -0
- data/docs/TierRequestTierRewards.md +8 -0
- data/docs/TierTierRewards.md +10 -0
- data/docs/Transaction.md +22 -0
- data/docs/TransactionHistory.md +17 -0
- data/docs/TransactionHistoryResp.md +12 -0
- data/docs/TransactionalEmailsApi.md +65 -7
- data/docs/TransactionalSMSApi.md +51 -0
- data/docs/TransactionalWhatsAppApi.md +2 -2
- data/docs/UnauthorizedResponse.md +8 -0
- data/docs/UpdateAttribute.md +2 -1
- data/docs/UpdateBalanceDefinitionPayload.md +23 -0
- data/docs/UpdateBalanceLimitPayload.md +13 -0
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateCouponCollection.md +4 -1
- data/docs/UpdateEmailCampaign.md +1 -0
- data/docs/UpdateEmailCampaignEmailExpirationDate.md +9 -0
- data/docs/UpdateEmailCampaignRecipients.md +1 -0
- data/docs/UpdateLoyaltyProgramPayload.md +10 -0
- data/docs/UpdateTierGroupRequest.md +11 -0
- data/docs/UpdateWebhook.md +3 -0
- data/docs/UserApi.md +239 -0
- data/docs/ValidationErrors.md +7 -0
- data/docs/WebhooksApi.md +4 -4
- data/docs/WhatsAppCampaignsApi.md +3 -1
- data/lib/brevo/api/account_api.rb +4 -1
- data/lib/brevo/api/balance_api.rb +1244 -0
- data/lib/brevo/api/companies_api.rb +170 -50
- data/lib/brevo/api/contacts_api.rb +136 -38
- data/lib/brevo/api/conversations_api.rb +3 -3
- data/lib/brevo/api/coupons_api.rb +19 -17
- data/lib/brevo/api/deals_api.rb +126 -6
- data/lib/brevo/api/domains_api.rb +1 -1
- data/lib/brevo/api/ecommerce_api.rb +369 -1
- data/lib/brevo/api/email_campaigns_api.rb +5 -8
- data/lib/brevo/api/events_api.rb +86 -0
- data/lib/brevo/api/external_feeds_api.rb +4 -4
- data/lib/brevo/api/files_api.rb +1 -1
- data/lib/brevo/api/inbound_parsing_api.rb +1 -1
- data/lib/brevo/api/master_account_api.rb +1111 -192
- data/lib/brevo/api/notes_api.rb +1 -1
- data/lib/brevo/api/payments_api.rb +188 -0
- data/lib/brevo/api/process_api.rb +1 -1
- data/lib/brevo/api/program_api.rb +663 -0
- data/lib/brevo/api/reward_api.rb +684 -0
- data/lib/brevo/api/senders_api.rb +1 -1
- data/lib/brevo/api/sms_campaigns_api.rb +1 -1
- data/lib/brevo/api/tasks_api.rb +6 -6
- data/lib/brevo/api/tier_api.rb +653 -0
- data/lib/brevo/api/transactional_emails_api.rb +64 -12
- data/lib/brevo/api/transactional_sms_api.rb +48 -3
- data/lib/brevo/api/transactional_whats_app_api.rb +6 -6
- data/lib/brevo/api/user_api.rb +223 -1
- data/lib/brevo/api/webhooks_api.rb +5 -5
- data/lib/brevo/api/whats_app_campaigns_api.rb +7 -1
- data/lib/brevo/api_client.rb +1 -1
- data/lib/brevo/api_error.rb +1 -1
- data/lib/brevo/configuration.rb +1 -1
- data/lib/brevo/models/ab_test_campaign_result.rb +1 -1
- data/lib/brevo/models/ab_test_campaign_result_clicked_links.rb +1 -1
- data/lib/brevo/models/ab_test_campaign_result_statistics.rb +1 -1
- data/lib/brevo/models/ab_test_version_clicks.rb +1 -1
- data/lib/brevo/models/ab_test_version_clicks_inner.rb +1 -1
- data/lib/brevo/models/ab_test_version_stats.rb +1 -1
- data/lib/brevo/models/add_child_domain.rb +1 -1
- data/lib/brevo/models/add_contact_to_list.rb +19 -7
- data/lib/brevo/models/add_subscription_member_payload.rb +227 -0
- data/lib/brevo/models/aggregate_balance.rb +195 -0
- data/lib/brevo/models/authenticate_domain_model.rb +1 -1
- data/lib/brevo/models/balance.rb +265 -0
- data/lib/brevo/models/balance_data_per_contact.rb +211 -0
- data/lib/brevo/models/balance_definition.rb +411 -0
- data/lib/brevo/models/balance_definition_page.rb +187 -0
- data/lib/brevo/models/balance_limit.rb +285 -0
- data/lib/brevo/models/balance_order.rb +345 -0
- data/lib/brevo/models/block_domain.rb +1 -1
- data/lib/brevo/models/body.rb +21 -29
- data/lib/brevo/models/body_1.rb +28 -26
- data/lib/brevo/models/body_10.rb +37 -38
- data/lib/brevo/models/body_11.rb +43 -14
- data/lib/brevo/models/body_12.rb +38 -30
- data/lib/brevo/models/body_13.rb +320 -0
- data/lib/brevo/models/body_14.rb +281 -0
- data/lib/brevo/models/body_15.rb +245 -0
- data/lib/brevo/models/body_16.rb +190 -0
- data/lib/brevo/models/body_17.rb +225 -0
- data/lib/brevo/models/body_18.rb +190 -0
- data/lib/brevo/models/body_19.rb +215 -0
- data/lib/brevo/models/body_2.rb +27 -43
- data/lib/brevo/models/body_3.rb +21 -19
- data/lib/brevo/models/body_4.rb +16 -19
- data/lib/brevo/models/body_5.rb +26 -43
- data/lib/brevo/models/body_6.rb +33 -119
- data/lib/brevo/models/body_7.rb +33 -85
- data/lib/brevo/models/body_8.rb +38 -60
- data/lib/brevo/models/body_9.rb +110 -12
- data/lib/brevo/models/body_variables_items.rb +1 -1
- data/lib/brevo/models/cart.rb +240 -0
- data/lib/brevo/models/companies_list.rb +1 -1
- data/lib/brevo/models/company.rb +1 -1
- data/lib/brevo/models/company_attributes.rb +1 -1
- data/lib/brevo/models/company_attributes_inner.rb +1 -1
- data/lib/brevo/models/component_items.rb +1 -1
- data/lib/brevo/models/configuration.rb +191 -0
- data/lib/brevo/models/contact_balances_resp.rb +213 -0
- data/lib/brevo/models/contact_error_model.rb +249 -0
- data/lib/brevo/models/conversations_message.rb +160 -5
- data/lib/brevo/models/conversations_message_attachments.rb +235 -0
- data/lib/brevo/models/conversations_message_file.rb +1 -1
- data/lib/brevo/models/conversations_message_file_image_info.rb +1 -1
- data/lib/brevo/models/conversations_message_forwarded_to_source_status.rb +194 -0
- data/lib/brevo/models/conversations_message_from.rb +194 -0
- data/lib/brevo/models/conversations_message_reply_to.rb +194 -0
- data/lib/brevo/models/conversations_message_to.rb +193 -0
- data/lib/brevo/models/conversion_source_metrics.rb +279 -0
- data/lib/brevo/models/conversion_source_product.rb +252 -0
- data/lib/brevo/models/corporate_group_details_response.rb +206 -0
- data/lib/brevo/models/corporate_group_details_response_group.rb +205 -0
- data/lib/brevo/models/corporate_group_details_response_subaccounts.rb +205 -0
- data/lib/brevo/models/{remaining_credit_model_child.rb → corporate_group_details_response_users.rb} +27 -28
- data/lib/brevo/models/corporateuseremailpermissions_privileges.rb +232 -0
- data/lib/brevo/models/create_api_key_request.rb +1 -1
- data/lib/brevo/models/create_api_key_response.rb +1 -1
- data/lib/brevo/models/create_attribute.rb +18 -6
- data/lib/brevo/models/create_attribute_enumeration.rb +1 -1
- data/lib/brevo/models/create_balance_definition_payload.rb +474 -0
- data/lib/brevo/models/create_balance_limit_payload.rb +319 -0
- data/lib/brevo/models/create_balance_payload.rb +191 -0
- data/lib/brevo/models/create_category_model.rb +1 -1
- data/lib/brevo/models/create_child.rb +1 -1
- data/lib/brevo/models/create_contact.rb +7 -5
- data/lib/brevo/models/create_coupon_collection.rb +38 -8
- data/lib/brevo/models/create_coupons.rb +1 -1
- data/lib/brevo/models/create_doi_contact.rb +6 -4
- data/lib/brevo/models/create_domain.rb +1 -1
- data/lib/brevo/models/create_domain_model.rb +12 -2
- data/lib/brevo/models/create_domain_model_dns_records.rb +14 -5
- data/lib/brevo/models/create_domain_model_dns_records_dkim_record.rb +1 -1
- data/lib/brevo/models/create_email_campaign.rb +14 -5
- data/lib/brevo/models/create_email_campaign_email_expiration_date.rb +254 -0
- data/lib/brevo/models/create_email_campaign_recipients.rb +17 -5
- data/lib/brevo/models/create_email_campaign_sender.rb +1 -1
- data/lib/brevo/models/create_external_feed.rb +1 -1
- data/lib/brevo/models/create_list.rb +1 -1
- data/lib/brevo/models/create_loyalty_program_payload.rb +256 -0
- data/lib/brevo/models/create_model.rb +1 -1
- data/lib/brevo/models/create_order_payload.rb +290 -0
- data/lib/brevo/models/create_payment_request.rb +247 -0
- data/lib/brevo/models/create_payment_response.rb +200 -0
- data/lib/brevo/models/create_product_model.rb +1 -1
- data/lib/brevo/models/create_sender.rb +1 -1
- data/lib/brevo/models/create_sender_ips.rb +1 -1
- data/lib/brevo/models/create_sender_model.rb +1 -1
- data/lib/brevo/models/create_sms_campaign.rb +1 -1
- data/lib/brevo/models/create_sms_campaign_recipients.rb +1 -1
- data/lib/brevo/models/create_smtp_email.rb +1 -1
- data/lib/brevo/models/create_smtp_template.rb +1 -1
- data/lib/brevo/models/create_smtp_template_sender.rb +1 -1
- data/lib/brevo/models/create_sub_account.rb +17 -5
- data/lib/brevo/models/create_sub_account_response.rb +1 -1
- data/lib/brevo/models/create_subscription_payload.rb +225 -0
- data/lib/brevo/models/create_subscription_response.rb +245 -0
- data/lib/brevo/models/create_tier_group_request.rb +272 -0
- data/lib/brevo/models/create_transaction_payload.rb +291 -0
- data/lib/brevo/models/create_update_batch_category.rb +1 -1
- data/lib/brevo/models/create_update_batch_category_model.rb +1 -1
- data/lib/brevo/models/create_update_batch_products.rb +1 -1
- data/lib/brevo/models/create_update_batch_products_model.rb +1 -1
- data/lib/brevo/models/create_update_categories.rb +15 -5
- data/lib/brevo/models/create_update_category.rb +15 -5
- data/lib/brevo/models/create_update_contact_model.rb +1 -1
- data/lib/brevo/models/create_update_folder.rb +1 -1
- data/lib/brevo/models/create_update_product.rb +16 -6
- data/lib/brevo/models/create_update_products.rb +16 -6
- data/lib/brevo/models/create_webhook.rb +61 -6
- data/lib/brevo/models/create_whats_app_campaign.rb +1 -1
- data/lib/brevo/models/create_whats_app_campaign_recipients.rb +1 -1
- data/lib/brevo/models/create_whats_app_template.rb +29 -7
- data/lib/brevo/models/created_batch_id.rb +1 -1
- data/lib/brevo/models/created_process_id.rb +1 -1
- data/lib/brevo/models/deal.rb +1 -1
- data/lib/brevo/models/deal_attributes.rb +1 -1
- data/lib/brevo/models/deal_attributes_inner.rb +1 -1
- data/lib/brevo/models/deals_list.rb +1 -1
- data/lib/brevo/models/delete_hardbounces.rb +1 -1
- data/lib/brevo/models/email_export_recipients.rb +1 -1
- data/lib/brevo/models/error_model.rb +3 -3
- data/lib/brevo/models/{update_child_domain.rb → error_response.rb} +9 -10
- data/lib/brevo/models/event.rb +234 -0
- data/lib/brevo/models/event_identifiers.rb +226 -0
- data/lib/brevo/models/export_webhooks_history.rb +32 -5
- data/lib/brevo/models/{remaining_credit_model_reseller.rb → fetch_template_preview.rb} +27 -22
- data/lib/brevo/models/file_data.rb +1 -1
- data/lib/brevo/models/file_downloadable_link.rb +1 -1
- data/lib/brevo/models/file_list.rb +1 -1
- data/lib/brevo/models/get_account.rb +1 -1
- data/lib/brevo/models/get_account_activity.rb +1 -1
- data/lib/brevo/models/get_account_activity_logs.rb +1 -1
- data/lib/brevo/models/get_account_marketing_automation.rb +1 -1
- data/lib/brevo/models/get_account_plan.rb +9 -19
- data/lib/brevo/models/get_account_relay.rb +1 -1
- data/lib/brevo/models/get_account_relay_data.rb +1 -1
- data/lib/brevo/models/get_aggregated_report.rb +1 -1
- data/lib/brevo/models/get_all_external_feeds.rb +1 -1
- data/lib/brevo/models/get_all_external_feeds_feeds.rb +1 -1
- data/lib/brevo/models/get_attributes.rb +1 -1
- data/lib/brevo/models/get_attributes_attributes.rb +19 -7
- data/lib/brevo/models/get_attributes_enumeration.rb +1 -1
- data/lib/brevo/models/get_blocked_domains.rb +1 -1
- data/lib/brevo/models/get_campaign_overview.rb +1 -1
- data/lib/brevo/models/get_campaign_recipients.rb +1 -1
- data/lib/brevo/models/get_campaign_stats.rb +35 -5
- data/lib/brevo/models/get_categories.rb +1 -1
- data/lib/brevo/models/get_category_details.rb +1 -1
- data/lib/brevo/models/get_child_domain.rb +1 -1
- data/lib/brevo/models/get_client.rb +1 -1
- data/lib/brevo/models/get_contact_campaign_stats.rb +1 -1
- data/lib/brevo/models/get_contact_campaign_stats_clicked.rb +1 -1
- data/lib/brevo/models/get_contact_campaign_stats_opened.rb +1 -1
- data/lib/brevo/models/get_contact_campaign_stats_transac_attributes.rb +1 -1
- data/lib/brevo/models/get_contact_campaign_stats_unsubscriptions.rb +1 -1
- data/lib/brevo/models/get_contact_details.rb +1 -6
- data/lib/brevo/models/get_contacts.rb +1 -1
- data/lib/brevo/models/get_corporate_invited_users_list.rb +187 -0
- data/lib/brevo/models/get_corporate_invited_users_list_feature_access.rb +284 -0
- data/lib/brevo/models/get_corporate_invited_users_list_groups.rb +196 -0
- data/lib/brevo/models/get_corporate_invited_users_list_users.rb +248 -0
- data/lib/brevo/models/get_corporate_user_permission.rb +236 -0
- data/lib/brevo/models/get_corporate_user_permission_feature_access.rb +284 -0
- data/lib/brevo/models/get_corporate_user_permission_groups.rb +196 -0
- data/lib/brevo/models/get_coupon_collection.rb +41 -11
- data/lib/brevo/models/get_device_browser_stats.rb +1 -1
- data/lib/brevo/models/get_domain_configuration_model.rb +1 -1
- data/lib/brevo/models/get_domains_list.rb +1 -1
- data/lib/brevo/models/get_domains_list_domains.rb +1 -1
- data/lib/brevo/models/get_email_campaign.rb +42 -2
- data/lib/brevo/models/get_email_campaigns.rb +1 -1
- data/lib/brevo/models/get_email_event_report.rb +1 -1
- data/lib/brevo/models/get_email_event_report_events.rb +1 -1
- data/lib/brevo/models/get_extended_campaign_overview.rb +42 -2
- data/lib/brevo/models/get_extended_campaign_overview_sender.rb +1 -1
- data/lib/brevo/models/get_extended_campaign_stats.rb +1 -1
- data/lib/brevo/models/get_extended_campaign_stats_global_stats.rb +1 -1
- data/lib/brevo/models/get_extended_client.rb +1 -1
- data/lib/brevo/models/get_extended_client_address.rb +1 -1
- data/lib/brevo/models/get_extended_contact_details.rb +1 -6
- data/lib/brevo/models/get_extended_contact_details_statistics.rb +1 -1
- data/lib/brevo/models/get_extended_contact_details_statistics_clicked.rb +1 -1
- data/lib/brevo/models/get_extended_contact_details_statistics_delivered.rb +1 -1
- data/lib/brevo/models/get_extended_contact_details_statistics_links.rb +1 -1
- data/lib/brevo/models/get_extended_contact_details_statistics_messages_sent.rb +1 -1
- data/lib/brevo/models/get_extended_contact_details_statistics_opened.rb +1 -1
- data/lib/brevo/models/get_extended_contact_details_statistics_unsubscriptions.rb +1 -1
- data/lib/brevo/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +1 -1
- data/lib/brevo/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +1 -1
- data/lib/brevo/models/get_extended_list.rb +1 -1
- data/lib/brevo/models/get_extended_list_campaign_stats.rb +1 -1
- data/lib/brevo/models/get_external_feed_by_uuid.rb +1 -1
- data/lib/brevo/models/get_external_feed_by_uuid_headers.rb +1 -1
- data/lib/brevo/models/get_folder.rb +1 -1
- data/lib/brevo/models/get_folder_lists.rb +1 -1
- data/lib/brevo/models/get_folders.rb +1 -1
- data/lib/brevo/models/get_inbound_email_events.rb +1 -1
- data/lib/brevo/models/get_inbound_email_events_by_uuid.rb +1 -1
- data/lib/brevo/models/get_inbound_email_events_by_uuid_attachments.rb +1 -1
- data/lib/brevo/models/get_inbound_email_events_by_uuid_logs.rb +1 -1
- data/lib/brevo/models/get_inbound_email_events_events.rb +1 -1
- data/lib/brevo/models/get_invited_users_list.rb +1 -1
- data/lib/brevo/models/get_invited_users_list_feature_access.rb +1 -1
- data/lib/brevo/models/get_invited_users_list_users.rb +1 -1
- data/lib/brevo/models/get_ip.rb +1 -1
- data/lib/brevo/models/get_ip_from_sender.rb +1 -1
- data/lib/brevo/models/get_ips.rb +1 -1
- data/lib/brevo/models/get_ips_from_sender.rb +1 -1
- data/lib/brevo/models/get_list.rb +1 -1
- data/lib/brevo/models/get_lists.rb +1 -1
- data/lib/brevo/models/{get_children_list.rb → get_orders.rb} +11 -12
- data/lib/brevo/models/get_payment_request.rb +296 -0
- data/lib/brevo/models/get_process.rb +1 -1
- data/lib/brevo/models/get_processes.rb +1 -1
- data/lib/brevo/models/get_product_details.rb +1 -1
- data/lib/brevo/models/get_products.rb +1 -1
- data/lib/brevo/models/get_reports.rb +1 -1
- data/lib/brevo/models/get_reports_reports.rb +1 -1
- data/lib/brevo/models/get_scheduled_email_by_batch_id.rb +1 -1
- data/lib/brevo/models/get_scheduled_email_by_batch_id_batches.rb +1 -1
- data/lib/brevo/models/get_scheduled_email_by_message_id.rb +1 -1
- data/lib/brevo/models/{get_segments_segments.rb → get_segment.rb} +18 -3
- data/lib/brevo/models/get_segments.rb +5 -3
- data/lib/brevo/models/get_senders_list.rb +1 -1
- data/lib/brevo/models/get_senders_list_ips.rb +1 -1
- data/lib/brevo/models/get_senders_list_senders.rb +1 -1
- data/lib/brevo/models/get_shared_template_url.rb +1 -1
- data/lib/brevo/models/get_sms_campaign.rb +1 -1
- data/lib/brevo/models/get_sms_campaign_overview.rb +1 -1
- data/lib/brevo/models/get_sms_campaign_recipients.rb +1 -1
- data/lib/brevo/models/get_sms_campaign_stats.rb +1 -1
- data/lib/brevo/models/get_sms_campaigns.rb +1 -1
- data/lib/brevo/models/get_sms_event_report.rb +1 -1
- data/lib/brevo/models/get_sms_event_report_events.rb +3 -3
- data/lib/brevo/models/get_smtp_template_overview.rb +1 -1
- data/lib/brevo/models/get_smtp_template_overview_sender.rb +1 -1
- data/lib/brevo/models/get_smtp_templates.rb +1 -1
- data/lib/brevo/models/get_sso_token.rb +1 -1
- data/lib/brevo/models/get_stats_by_browser.rb +1 -1
- data/lib/brevo/models/get_stats_by_device.rb +1 -1
- data/lib/brevo/models/get_stats_by_domain.rb +1 -1
- data/lib/brevo/models/get_transac_aggregated_sms_report.rb +17 -7
- data/lib/brevo/models/get_transac_blocked_contacts.rb +1 -1
- data/lib/brevo/models/get_transac_blocked_contacts_contacts.rb +1 -1
- data/lib/brevo/models/get_transac_blocked_contacts_reason.rb +1 -1
- data/lib/brevo/models/get_transac_email_content.rb +1 -1
- data/lib/brevo/models/get_transac_email_content_events.rb +1 -1
- data/lib/brevo/models/get_transac_emails_list.rb +1 -1
- data/lib/brevo/models/get_transac_emails_list_transactional_emails.rb +1 -1
- data/lib/brevo/models/get_transac_sms_report.rb +1 -1
- data/lib/brevo/models/get_transac_sms_report_reports.rb +17 -7
- data/lib/brevo/models/get_user_permission.rb +1 -1
- data/lib/brevo/models/get_user_permission_privileges.rb +1 -1
- data/lib/brevo/models/get_wa_templates.rb +1 -1
- data/lib/brevo/models/get_wa_templates_templates.rb +1 -1
- data/lib/brevo/models/get_webhook.rb +36 -5
- data/lib/brevo/models/get_webhook_auth.rb +196 -0
- data/lib/brevo/models/get_webhook_headers.rb +195 -0
- data/lib/brevo/models/get_webhooks.rb +1 -1
- data/lib/brevo/models/get_whats_app_config.rb +1 -1
- data/lib/brevo/models/get_whatsapp_campaign_overview.rb +1 -1
- data/lib/brevo/models/get_whatsapp_campaigns.rb +1 -1
- data/lib/brevo/models/get_whatsapp_campaigns_campaigns.rb +1 -1
- data/lib/brevo/models/get_whatsapp_event_report.rb +1 -1
- data/lib/brevo/models/get_whatsapp_event_report_events.rb +1 -1
- data/lib/brevo/models/inline_response_200.rb +8 -15
- data/lib/brevo/models/inline_response_200_1.rb +10 -35
- data/lib/brevo/models/{create_reseller.rb → inline_response_200_2.rb} +9 -18
- data/lib/brevo/models/inline_response_200_3.rb +190 -0
- data/lib/brevo/models/inline_response_200_4.rb +185 -0
- data/lib/brevo/models/inline_response_200_5.rb +190 -0
- data/lib/brevo/models/inline_response_200_6.rb +206 -0
- data/lib/brevo/models/inline_response_200_6_totals.rb +218 -0
- data/lib/brevo/models/inline_response_200_7.rb +198 -0
- data/lib/brevo/models/inline_response_200_8.rb +192 -0
- data/lib/brevo/models/inline_response_200_9.rb +215 -0
- data/lib/brevo/models/inline_response_201.rb +1 -8
- data/lib/brevo/models/inline_response_201_1.rb +3 -3
- data/lib/brevo/models/inline_response_201_2.rb +3 -2
- data/lib/brevo/models/inline_response_201_3.rb +12 -12
- data/lib/brevo/models/inline_response_201_4.rb +12 -12
- data/lib/brevo/models/inline_response_201_5.rb +190 -0
- data/lib/brevo/models/inline_response_400.rb +184 -0
- data/lib/brevo/models/invite_admin_user.rb +233 -0
- data/lib/brevo/models/invite_admin_user_privileges.rb +232 -0
- data/lib/brevo/models/inviteuser.rb +221 -0
- data/lib/brevo/models/inviteuser_privileges.rb +232 -0
- data/lib/brevo/models/loyalty_program.rb +331 -0
- data/lib/brevo/models/loyalty_program_page.rb +187 -0
- data/lib/brevo/models/loyalty_program_validation_error.rb +205 -0
- data/lib/brevo/models/loyalty_tier_page.rb +186 -0
- data/lib/brevo/models/main_attribute_reward_payload.rb +282 -0
- data/lib/brevo/models/main_billing_payload.rb +245 -0
- data/lib/brevo/models/main_code_count_http_response.rb +185 -0
- data/lib/brevo/models/main_create_redeem_payload.rb +286 -0
- data/lib/brevo/models/{manage_ip.rb → main_create_redeem_payload_order.rb} +5 -14
- data/lib/brevo/models/main_create_reward_payload.rb +269 -0
- data/lib/brevo/models/main_create_reward_response.rb +255 -0
- data/lib/brevo/models/main_error_response.rb +185 -0
- data/lib/brevo/models/main_filter.rb +205 -0
- data/lib/brevo/models/main_generator.rb +235 -0
- data/lib/brevo/models/main_get_contact_rewards_payload.rb +356 -0
- data/lib/brevo/models/main_identifiers_payload.rb +195 -0
- data/lib/brevo/models/main_limit.rb +255 -0
- data/lib/brevo/models/main_model_contact_reward.rb +277 -0
- data/lib/brevo/models/main_model_contact_rewards_resp.rb +227 -0
- data/lib/brevo/models/main_node_response.rb +259 -0
- data/lib/brevo/models/{get_child_info.rb → main_order_payload.rb} +94 -86
- data/lib/brevo/models/main_order_payload_billing.rb +176 -0
- data/lib/brevo/models/main_order_payload_identifiers.rb +176 -0
- data/lib/brevo/models/main_product.rb +215 -0
- data/lib/brevo/models/main_product_payload.rb +227 -0
- data/lib/brevo/models/main_redeem.rb +317 -0
- data/lib/brevo/models/{get_child_info_api_keys_v3.rb → main_result_parameter_response.rb} +10 -21
- data/lib/brevo/models/main_result_parameter_response_value.rb +176 -0
- data/lib/brevo/models/main_reward.rb +616 -0
- data/lib/brevo/models/main_reward_attribution.rb +287 -0
- data/lib/brevo/models/main_reward_configurations.rb +205 -0
- data/lib/brevo/models/main_reward_generator.rb +176 -0
- data/lib/brevo/models/{get_child_info_api_keys.rb → main_reward_page.rb} +18 -24
- data/lib/brevo/models/main_reward_page_obj.rb +265 -0
- data/lib/brevo/models/main_reward_rule.rb +176 -0
- data/lib/brevo/models/main_reward_validate.rb +185 -0
- data/lib/brevo/models/main_rule.rb +305 -0
- data/lib/brevo/models/main_rule_condition.rb +176 -0
- data/lib/brevo/models/main_rule_condition_response.rb +227 -0
- data/lib/brevo/models/main_rule_condition_response_lhs.rb +176 -0
- data/lib/brevo/models/main_rule_condition_response_rhs.rb +176 -0
- data/lib/brevo/models/main_rule_event.rb +176 -0
- data/lib/brevo/models/{get_child_info_api_keys_v2.rb → main_rule_event_response.rb} +11 -21
- data/lib/brevo/models/main_rule_result_response.rb +207 -0
- data/lib/brevo/models/main_validate_reward_payload.rb +250 -0
- data/lib/brevo/models/main_value_response.rb +256 -0
- data/lib/brevo/models/main_value_response_expression.rb +176 -0
- data/lib/brevo/models/{get_child_account_creation_status.rb → main_voucher_revoke_payload.rb} +15 -13
- data/lib/brevo/models/master_details_response.rb +1 -1
- data/lib/brevo/models/master_details_response_billing_info.rb +1 -1
- data/lib/brevo/models/master_details_response_billing_info_address.rb +1 -1
- data/lib/brevo/models/master_details_response_billing_info_name.rb +1 -1
- data/lib/brevo/models/master_details_response_plan_info.rb +1 -1
- data/lib/brevo/models/master_details_response_plan_info_features.rb +22 -2
- data/lib/brevo/models/member_contact.rb +205 -0
- data/lib/brevo/models/model_subscription_balance_resp.rb +186 -0
- data/lib/brevo/models/note.rb +1 -1
- data/lib/brevo/models/note_data.rb +1 -1
- data/lib/brevo/models/note_id.rb +1 -1
- data/lib/brevo/models/note_list.rb +1 -1
- data/lib/brevo/models/notification.rb +240 -0
- data/lib/brevo/models/order.rb +36 -15
- data/lib/brevo/models/order_batch.rb +17 -5
- data/lib/brevo/models/order_billing.rb +13 -3
- data/lib/brevo/models/order_identifiers.rb +216 -0
- data/lib/brevo/models/order_products.rb +1 -1
- data/lib/brevo/models/otp.rb +1 -1
- data/lib/brevo/models/{remaining_credit_model.rb → patch_loyalty_program_payload.rb} +27 -25
- data/lib/brevo/models/pipeline.rb +1 -1
- data/lib/brevo/models/pipeline_stage.rb +1 -1
- data/lib/brevo/models/pipelines.rb +1 -1
- data/lib/brevo/models/post_contact_info.rb +1 -1
- data/lib/brevo/models/post_contact_info_contacts.rb +1 -1
- data/lib/brevo/models/post_send_failed.rb +1 -1
- data/lib/brevo/models/post_send_sms_test_failed.rb +1 -1
- data/lib/brevo/models/{add_credits.rb → put_revoke_user_permission.rb} +11 -15
- data/lib/brevo/models/{remove_credits.rb → putresendcancelinvitation.rb} +11 -15
- data/lib/brevo/models/remove_contact_from_list.rb +17 -5
- data/lib/brevo/models/request_contact_export.rb +54 -6
- data/lib/brevo/models/request_contact_export_custom_contact_filter.rb +13 -3
- data/lib/brevo/models/request_contact_import.rb +14 -2
- data/lib/brevo/models/request_contact_import_json_body.rb +1 -1
- data/lib/brevo/models/request_contact_import_new_list.rb +1 -1
- data/lib/brevo/models/request_sms_recipient_export.rb +1 -1
- data/lib/brevo/models/schedule_smtp_email.rb +1 -1
- data/lib/brevo/models/send_report.rb +1 -1
- data/lib/brevo/models/send_report_email.rb +1 -1
- data/lib/brevo/models/send_sms.rb +1 -1
- data/lib/brevo/models/send_smtp_email.rb +2 -2
- data/lib/brevo/models/send_smtp_email_attachment.rb +1 -1
- data/lib/brevo/models/send_smtp_email_bcc.rb +1 -1
- data/lib/brevo/models/send_smtp_email_cc.rb +1 -1
- data/lib/brevo/models/send_smtp_email_message_versions.rb +25 -5
- data/lib/brevo/models/send_smtp_email_reply_to.rb +1 -1
- data/lib/brevo/models/send_smtp_email_reply_to_1.rb +1 -1
- data/lib/brevo/models/send_smtp_email_sender.rb +1 -1
- data/lib/brevo/models/send_smtp_email_to.rb +1 -1
- data/lib/brevo/models/send_smtp_email_to_1.rb +1 -1
- data/lib/brevo/models/send_test_email.rb +1 -1
- data/lib/brevo/models/send_test_sms.rb +1 -1
- data/lib/brevo/models/send_transac_sms.rb +2 -3
- data/lib/brevo/models/send_transac_sms_tag.rb +186 -0
- data/lib/brevo/models/send_whatsapp_message.rb +12 -2
- data/lib/brevo/models/set_config_display_currency.rb +190 -0
- data/lib/brevo/models/sso_token_request.rb +1 -1
- data/lib/brevo/models/sso_token_request_corporate.rb +190 -0
- data/lib/brevo/models/sub_account_apps_toggle_request.rb +2 -2
- data/lib/brevo/models/sub_account_details_response.rb +14 -2
- data/lib/brevo/models/sub_account_details_response_groups.rb +195 -0
- data/lib/brevo/models/sub_account_details_response_plan_info.rb +1 -1
- data/lib/brevo/models/sub_account_details_response_plan_info_credits.rb +36 -10
- data/lib/brevo/models/sub_account_details_response_plan_info_credits_emails.rb +1 -1
- data/lib/brevo/models/sub_account_details_response_plan_info_credits_external_feeds.rb +196 -0
- data/lib/brevo/models/{get_child_info_credits.rb → sub_account_details_response_plan_info_credits_sms.rb} +18 -18
- data/lib/brevo/models/sub_account_details_response_plan_info_credits_whatsapp.rb +196 -0
- data/lib/brevo/models/sub_account_details_response_plan_info_credits_wp_subscribers.rb +196 -0
- data/lib/brevo/models/sub_account_details_response_plan_info_features.rb +14 -5
- data/lib/brevo/models/sub_account_details_response_plan_info_features_inbox.rb +2 -2
- data/lib/brevo/models/sub_account_details_response_plan_info_features_landing_page.rb +2 -2
- data/lib/brevo/models/sub_account_details_response_plan_info_features_sales_users.rb +196 -0
- data/lib/brevo/models/sub_account_details_response_plan_info_features_users.rb +4 -4
- data/lib/brevo/models/sub_account_update_plan_request.rb +1 -1
- data/lib/brevo/models/sub_account_update_plan_request_credits.rb +46 -6
- data/lib/brevo/models/sub_account_update_plan_request_features.rb +16 -6
- data/lib/brevo/models/sub_accounts_response.rb +1 -1
- data/lib/brevo/models/sub_accounts_response_groups.rb +195 -0
- data/lib/brevo/models/sub_accounts_response_sub_accounts.rb +22 -5
- data/lib/brevo/models/sub_accounts_update_plan_request.rb +206 -0
- data/lib/brevo/models/sub_accounts_update_plan_request_credits.rb +226 -0
- data/lib/brevo/models/sub_accounts_update_plan_request_features.rb +206 -0
- data/lib/brevo/models/subscription.rb +245 -0
- data/lib/brevo/models/subscription_aggregate_balance.rb +195 -0
- data/lib/brevo/models/subscription_attributed_reward.rb +267 -0
- data/lib/brevo/models/subscription_balances.rb +207 -0
- data/lib/brevo/models/subscription_handler_info.rb +220 -0
- data/lib/brevo/models/subscription_handler_info_balance.rb +176 -0
- data/lib/brevo/models/subscription_member.rb +227 -0
- data/lib/brevo/models/subscription_tier.rb +247 -0
- data/lib/brevo/models/task.rb +1 -1
- data/lib/brevo/models/task_list.rb +1 -1
- data/lib/brevo/models/task_reminder.rb +1 -1
- data/lib/brevo/models/task_types.rb +1 -1
- data/lib/brevo/models/{update_child_account_status.rb → template_preview.rb} +52 -31
- data/lib/brevo/models/tier.rb +267 -0
- data/lib/brevo/models/tier_access_conditions.rb +213 -0
- data/lib/brevo/models/tier_for_contact.rb +245 -0
- data/lib/brevo/models/tier_group.rb +307 -0
- data/lib/brevo/models/tier_group_page.rb +186 -0
- data/lib/brevo/models/tier_request.rb +227 -0
- data/lib/brevo/models/tier_request_access_conditions.rb +195 -0
- data/lib/brevo/models/tier_request_put_payload.rb +232 -0
- data/lib/brevo/models/tier_request_tier_rewards.rb +185 -0
- data/lib/brevo/models/tier_tier_rewards.rb +203 -0
- data/lib/brevo/models/transaction.rb +326 -0
- data/lib/brevo/models/transaction_history.rb +276 -0
- data/lib/brevo/models/transaction_history_resp.rb +228 -0
- data/lib/brevo/models/unauthorized_response.rb +185 -0
- data/lib/brevo/models/update_attribute.rb +18 -6
- data/lib/brevo/models/update_attribute_enumeration.rb +1 -1
- data/lib/brevo/models/update_balance_definition_payload.rb +474 -0
- data/lib/brevo/models/update_balance_limit_payload.rb +319 -0
- data/lib/brevo/models/update_batch_contacts.rb +1 -1
- data/lib/brevo/models/update_batch_contacts_contacts.rb +1 -1
- data/lib/brevo/models/update_batch_contacts_model.rb +1 -1
- data/lib/brevo/models/update_campaign_status.rb +1 -1
- data/lib/brevo/models/update_child.rb +1 -1
- data/lib/brevo/models/update_contact.rb +6 -4
- data/lib/brevo/models/update_coupon_collection.rb +35 -10
- data/lib/brevo/models/update_email_campaign.rb +14 -5
- data/lib/brevo/models/update_email_campaign_email_expiration_date.rb +254 -0
- data/lib/brevo/models/update_email_campaign_recipients.rb +17 -5
- data/lib/brevo/models/update_email_campaign_sender.rb +1 -1
- data/lib/brevo/models/update_external_feed.rb +1 -1
- data/lib/brevo/models/update_list.rb +1 -1
- data/lib/brevo/models/update_loyalty_program_payload.rb +210 -0
- data/lib/brevo/models/update_sender.rb +1 -1
- data/lib/brevo/models/update_sms_campaign.rb +1 -1
- data/lib/brevo/models/update_smtp_template.rb +1 -1
- data/lib/brevo/models/update_smtp_template_sender.rb +1 -1
- data/lib/brevo/models/update_tier_group_request.rb +287 -0
- data/lib/brevo/models/update_webhook.rb +36 -5
- data/lib/brevo/models/update_whats_app_campaign.rb +1 -1
- data/lib/brevo/models/upload_image_model.rb +1 -1
- data/lib/brevo/models/upload_image_to_gallery.rb +1 -1
- data/lib/brevo/models/{get_child_domains.rb → validation_errors.rb} +2 -2
- data/lib/brevo/models/variables_items.rb +1 -1
- data/lib/brevo/models/whatsapp_camp_stats.rb +1 -1
- data/lib/brevo/models/whatsapp_camp_template.rb +1 -1
- data/lib/brevo/version.rb +2 -2
- data/lib/brevo.rb +178 -21
- data/spec/api/account_api_spec.rb +2 -1
- data/spec/api/balance_api_spec.rb +292 -0
- data/spec/api/companies_api_spec.rb +38 -12
- data/spec/api/contacts_api_spec.rb +34 -10
- data/spec/api/conversations_api_spec.rb +2 -2
- data/spec/api/coupons_api_spec.rb +5 -4
- data/spec/api/deals_api_spec.rb +29 -3
- data/spec/api/domains_api_spec.rb +1 -1
- data/spec/api/ecommerce_api_spec.rb +82 -1
- data/spec/api/email_campaigns_api_spec.rb +2 -3
- data/spec/api/events_api_spec.rb +47 -0
- data/spec/api/external_feeds_api_spec.rb +2 -2
- data/spec/api/files_api_spec.rb +1 -1
- data/spec/api/inbound_parsing_api_spec.rb +1 -1
- data/spec/api/master_account_api_spec.rb +209 -3
- data/spec/api/notes_api_spec.rb +1 -1
- data/spec/api/payments_api_spec.rb +68 -0
- data/spec/api/process_api_spec.rb +1 -1
- data/spec/api/program_api_spec.rb +178 -0
- data/spec/api/reward_api_spec.rb +175 -0
- data/spec/api/senders_api_spec.rb +1 -1
- data/spec/api/sms_campaigns_api_spec.rb +1 -1
- data/spec/api/tasks_api_spec.rb +3 -3
- data/spec/api/tier_api_spec.rb +170 -0
- data/spec/api/transactional_emails_api_spec.rb +15 -4
- data/spec/api/transactional_sms_api_spec.rb +11 -1
- data/spec/api/transactional_whats_app_api_spec.rb +2 -2
- data/spec/api/user_api_spec.rb +48 -1
- data/spec/api/webhooks_api_spec.rb +3 -3
- data/spec/api/whats_app_campaigns_api_spec.rb +2 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +1 -1
- data/spec/models/ab_test_campaign_result_spec.rb +1 -1
- data/spec/models/ab_test_campaign_result_statistics_spec.rb +1 -1
- data/spec/models/ab_test_version_clicks_inner_spec.rb +1 -1
- data/spec/models/ab_test_version_clicks_spec.rb +1 -1
- data/spec/models/ab_test_version_stats_spec.rb +1 -1
- data/spec/models/add_child_domain_spec.rb +1 -1
- data/spec/models/add_contact_to_list_spec.rb +7 -1
- data/spec/models/add_subscription_member_payload_spec.rb +53 -0
- data/spec/models/aggregate_balance_spec.rb +47 -0
- data/spec/models/authenticate_domain_model_spec.rb +1 -1
- data/spec/models/balance_data_per_contact_spec.rb +59 -0
- data/spec/models/balance_definition_page_spec.rb +41 -0
- data/spec/models/balance_definition_spec.rb +159 -0
- data/spec/models/balance_limit_spec.rb +95 -0
- data/spec/models/balance_order_spec.rb +107 -0
- data/spec/models/{get_child_info_spec.rb → balance_spec.rb} +16 -16
- data/spec/models/block_domain_spec.rb +1 -1
- data/spec/models/body_10_spec.rb +5 -5
- data/spec/models/body_11_spec.rb +20 -2
- data/spec/models/body_12_spec.rb +5 -5
- data/spec/models/body_13_spec.rb +101 -0
- data/spec/models/body_14_spec.rb +95 -0
- data/spec/models/body_15_spec.rb +71 -0
- data/spec/models/{manage_ip_spec.rb → body_16_spec.rb} +8 -8
- data/spec/models/{update_child_account_status_spec.rb → body_17_spec.rb} +11 -11
- data/spec/models/{update_child_domain_spec.rb → body_18_spec.rb} +8 -8
- data/spec/models/body_19_spec.rb +59 -0
- data/spec/models/body_1_spec.rb +3 -9
- data/spec/models/body_2_spec.rb +3 -15
- data/spec/models/body_3_spec.rb +3 -3
- data/spec/models/body_4_spec.rb +2 -8
- data/spec/models/body_5_spec.rb +3 -15
- data/spec/models/body_6_spec.rb +5 -41
- data/spec/models/body_7_spec.rb +5 -35
- data/spec/models/body_8_spec.rb +5 -17
- data/spec/models/body_9_spec.rb +34 -2
- data/spec/models/body_spec.rb +3 -9
- data/spec/models/body_variables_items_spec.rb +1 -1
- data/spec/models/cart_spec.rb +51 -0
- data/spec/models/companies_list_spec.rb +1 -1
- data/spec/models/company_attributes_inner_spec.rb +1 -1
- data/spec/models/company_attributes_spec.rb +1 -1
- data/spec/models/company_spec.rb +1 -1
- data/spec/models/component_items_spec.rb +1 -1
- data/spec/models/configuration_spec.rb +41 -0
- data/spec/models/contact_balances_resp_spec.rb +59 -0
- data/spec/models/contact_error_model_spec.rb +57 -0
- data/spec/models/conversations_message_attachments_spec.rb +71 -0
- data/spec/models/conversations_message_file_image_info_spec.rb +1 -1
- data/spec/models/conversations_message_file_spec.rb +1 -1
- data/spec/models/conversations_message_forwarded_to_source_status_spec.rb +47 -0
- data/spec/models/{remove_credits_spec.rb → conversations_message_from_spec.rb} +9 -9
- data/spec/models/{remaining_credit_model_child_spec.rb → conversations_message_reply_to_spec.rb} +9 -9
- data/spec/models/conversations_message_spec.rb +91 -1
- data/spec/models/{remaining_credit_model_reseller_spec.rb → conversations_message_to_spec.rb} +9 -9
- data/spec/models/conversion_source_metrics_spec.rb +69 -0
- data/spec/models/conversion_source_product_spec.rb +83 -0
- data/spec/models/corporate_group_details_response_group_spec.rb +53 -0
- data/spec/models/corporate_group_details_response_spec.rb +53 -0
- data/spec/models/corporate_group_details_response_subaccounts_spec.rb +53 -0
- data/spec/models/corporate_group_details_response_users_spec.rb +53 -0
- data/spec/models/corporateuseremailpermissions_privileges_spec.rb +55 -0
- data/spec/models/create_api_key_request_spec.rb +1 -1
- data/spec/models/create_api_key_response_spec.rb +1 -1
- data/spec/models/create_attribute_enumeration_spec.rb +1 -1
- data/spec/models/create_attribute_spec.rb +8 -2
- data/spec/models/create_balance_definition_payload_spec.rb +155 -0
- data/spec/models/create_balance_limit_payload_spec.rb +83 -0
- data/spec/models/create_balance_payload_spec.rb +41 -0
- data/spec/models/create_category_model_spec.rb +1 -1
- data/spec/models/create_child_spec.rb +1 -1
- data/spec/models/create_contact_spec.rb +1 -1
- data/spec/models/create_coupon_collection_spec.rb +19 -1
- data/spec/models/create_coupons_spec.rb +1 -1
- data/spec/models/create_doi_contact_spec.rb +1 -1
- data/spec/models/create_domain_model_dns_records_dkim_record_spec.rb +1 -1
- data/spec/models/create_domain_model_dns_records_spec.rb +7 -1
- data/spec/models/create_domain_model_spec.rb +7 -1
- data/spec/models/create_domain_spec.rb +1 -1
- data/spec/models/create_email_campaign_email_expiration_date_spec.rb +51 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +7 -1
- data/spec/models/create_email_campaign_sender_spec.rb +1 -1
- data/spec/models/create_email_campaign_spec.rb +7 -1
- data/spec/models/create_external_feed_spec.rb +1 -1
- data/spec/models/create_list_spec.rb +1 -1
- data/spec/models/create_loyalty_program_payload_spec.rb +59 -0
- data/spec/models/create_model_spec.rb +1 -1
- data/spec/models/create_order_payload_spec.rb +77 -0
- data/spec/models/create_payment_request_spec.rb +71 -0
- data/spec/models/{create_reseller_spec.rb → create_payment_response_spec.rb} +9 -9
- data/spec/models/create_product_model_spec.rb +1 -1
- data/spec/models/create_sender_ips_spec.rb +1 -1
- data/spec/models/create_sender_model_spec.rb +1 -1
- data/spec/models/create_sender_spec.rb +1 -1
- data/spec/models/create_sms_campaign_recipients_spec.rb +1 -1
- data/spec/models/create_sms_campaign_spec.rb +1 -1
- data/spec/models/create_smtp_email_spec.rb +1 -1
- data/spec/models/create_smtp_template_sender_spec.rb +1 -1
- data/spec/models/create_smtp_template_spec.rb +1 -1
- data/spec/models/create_sub_account_response_spec.rb +1 -1
- data/spec/models/create_sub_account_spec.rb +7 -1
- data/spec/models/create_subscription_payload_spec.rb +53 -0
- data/spec/models/create_subscription_response_spec.rb +77 -0
- data/spec/models/create_tier_group_request_spec.rb +67 -0
- data/spec/models/create_transaction_payload_spec.rb +89 -0
- data/spec/models/create_update_batch_category_model_spec.rb +1 -1
- data/spec/models/create_update_batch_category_spec.rb +1 -1
- data/spec/models/create_update_batch_products_model_spec.rb +1 -1
- data/spec/models/create_update_batch_products_spec.rb +1 -1
- data/spec/models/create_update_categories_spec.rb +7 -1
- data/spec/models/create_update_category_spec.rb +7 -1
- data/spec/models/create_update_contact_model_spec.rb +1 -1
- data/spec/models/create_update_folder_spec.rb +1 -1
- data/spec/models/create_update_product_spec.rb +7 -1
- data/spec/models/create_update_products_spec.rb +7 -1
- data/spec/models/create_webhook_spec.rb +29 -1
- data/spec/models/create_whats_app_campaign_recipients_spec.rb +1 -1
- data/spec/models/create_whats_app_campaign_spec.rb +1 -1
- data/spec/models/create_whats_app_template_spec.rb +12 -2
- data/spec/models/created_batch_id_spec.rb +1 -1
- data/spec/models/created_process_id_spec.rb +1 -1
- data/spec/models/deal_attributes_inner_spec.rb +1 -1
- data/spec/models/deal_attributes_spec.rb +1 -1
- data/spec/models/deal_spec.rb +1 -1
- data/spec/models/deals_list_spec.rb +1 -1
- data/spec/models/delete_hardbounces_spec.rb +1 -1
- data/spec/models/email_export_recipients_spec.rb +1 -1
- data/spec/models/error_model_spec.rb +2 -2
- data/spec/models/error_response_spec.rb +41 -0
- data/spec/models/event_identifiers_spec.rb +65 -0
- data/spec/models/event_spec.rb +65 -0
- data/spec/models/export_webhooks_history_spec.rb +12 -2
- data/spec/models/{get_child_info_statistics_spec.rb → fetch_template_preview_spec.rb} +10 -10
- data/spec/models/file_data_spec.rb +1 -1
- data/spec/models/file_downloadable_link_spec.rb +1 -1
- data/spec/models/file_list_spec.rb +1 -1
- data/spec/models/get_account_activity_logs_spec.rb +1 -1
- data/spec/models/get_account_activity_spec.rb +1 -1
- data/spec/models/get_account_marketing_automation_spec.rb +1 -1
- data/spec/models/get_account_plan_spec.rb +2 -8
- data/spec/models/get_account_relay_data_spec.rb +1 -1
- data/spec/models/get_account_relay_spec.rb +1 -1
- data/spec/models/get_account_spec.rb +1 -1
- data/spec/models/get_aggregated_report_spec.rb +1 -1
- data/spec/models/get_all_external_feeds_feeds_spec.rb +1 -1
- data/spec/models/get_all_external_feeds_spec.rb +1 -1
- data/spec/models/get_attributes_attributes_spec.rb +8 -2
- data/spec/models/get_attributes_enumeration_spec.rb +1 -1
- data/spec/models/get_attributes_spec.rb +1 -1
- data/spec/models/get_blocked_domains_spec.rb +1 -1
- data/spec/models/get_campaign_overview_spec.rb +1 -1
- data/spec/models/get_campaign_recipients_spec.rb +1 -1
- data/spec/models/get_campaign_stats_spec.rb +13 -1
- data/spec/models/get_categories_spec.rb +1 -1
- data/spec/models/get_category_details_spec.rb +1 -1
- data/spec/models/get_child_domain_spec.rb +1 -1
- data/spec/models/get_client_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +1 -1
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +1 -1
- data/spec/models/get_contact_details_spec.rb +1 -1
- data/spec/models/get_contacts_spec.rb +1 -1
- data/spec/models/get_corporate_invited_users_list_feature_access_spec.rb +89 -0
- data/spec/models/get_corporate_invited_users_list_groups_spec.rb +47 -0
- data/spec/models/get_corporate_invited_users_list_spec.rb +41 -0
- data/spec/models/get_corporate_invited_users_list_users_spec.rb +65 -0
- data/spec/models/get_corporate_user_permission_feature_access_spec.rb +89 -0
- data/spec/models/get_corporate_user_permission_groups_spec.rb +47 -0
- data/spec/models/get_corporate_user_permission_spec.rb +59 -0
- data/spec/models/get_coupon_collection_spec.rb +19 -1
- data/spec/models/get_device_browser_stats_spec.rb +1 -1
- data/spec/models/get_domain_configuration_model_spec.rb +1 -1
- data/spec/models/get_domains_list_domains_spec.rb +1 -1
- data/spec/models/get_domains_list_spec.rb +1 -1
- data/spec/models/get_email_campaign_spec.rb +25 -1
- data/spec/models/get_email_campaigns_spec.rb +1 -1
- data/spec/models/get_email_event_report_events_spec.rb +1 -1
- data/spec/models/get_email_event_report_spec.rb +1 -1
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +1 -1
- data/spec/models/get_extended_campaign_overview_spec.rb +25 -1
- data/spec/models/get_extended_campaign_stats_global_stats_spec.rb +1 -1
- data/spec/models/get_extended_campaign_stats_spec.rb +1 -1
- data/spec/models/get_extended_client_address_spec.rb +1 -1
- data/spec/models/get_extended_client_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_delivered_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +1 -1
- data/spec/models/get_extended_list_campaign_stats_spec.rb +1 -1
- data/spec/models/get_extended_list_spec.rb +1 -1
- data/spec/models/get_external_feed_by_uuid_headers_spec.rb +1 -1
- data/spec/models/get_external_feed_by_uuid_spec.rb +1 -1
- data/spec/models/get_folder_lists_spec.rb +1 -1
- data/spec/models/get_folder_spec.rb +1 -1
- data/spec/models/get_folders_spec.rb +1 -1
- data/spec/models/get_inbound_email_events_by_uuid_attachments_spec.rb +1 -1
- data/spec/models/get_inbound_email_events_by_uuid_logs_spec.rb +1 -1
- data/spec/models/get_inbound_email_events_by_uuid_spec.rb +1 -1
- data/spec/models/get_inbound_email_events_events_spec.rb +1 -1
- data/spec/models/get_inbound_email_events_spec.rb +1 -1
- data/spec/models/get_invited_users_list_feature_access_spec.rb +1 -1
- data/spec/models/get_invited_users_list_spec.rb +1 -1
- data/spec/models/get_invited_users_list_users_spec.rb +1 -1
- data/spec/models/get_ip_from_sender_spec.rb +1 -1
- data/spec/models/get_ip_spec.rb +1 -1
- data/spec/models/get_ips_from_sender_spec.rb +1 -1
- data/spec/models/get_ips_spec.rb +1 -1
- data/spec/models/get_list_spec.rb +1 -1
- data/spec/models/get_lists_spec.rb +1 -1
- data/spec/models/{get_children_list_spec.rb → get_orders_spec.rb} +8 -8
- data/spec/models/get_payment_request_spec.rb +81 -0
- data/spec/models/get_process_spec.rb +1 -1
- data/spec/models/get_processes_spec.rb +1 -1
- data/spec/models/get_product_details_spec.rb +1 -1
- data/spec/models/get_products_spec.rb +1 -1
- data/spec/models/get_reports_reports_spec.rb +1 -1
- data/spec/models/get_reports_spec.rb +1 -1
- data/spec/models/get_scheduled_email_by_batch_id_batches_spec.rb +1 -1
- data/spec/models/get_scheduled_email_by_batch_id_spec.rb +1 -1
- data/spec/models/get_scheduled_email_by_message_id_spec.rb +1 -1
- data/spec/models/{get_segments_segments_spec.rb → get_segment_spec.rb} +7 -7
- data/spec/models/get_segments_spec.rb +1 -1
- data/spec/models/get_senders_list_ips_spec.rb +1 -1
- data/spec/models/get_senders_list_senders_spec.rb +1 -1
- data/spec/models/get_senders_list_spec.rb +1 -1
- data/spec/models/get_shared_template_url_spec.rb +1 -1
- data/spec/models/get_sms_campaign_overview_spec.rb +1 -1
- data/spec/models/get_sms_campaign_recipients_spec.rb +1 -1
- data/spec/models/get_sms_campaign_spec.rb +1 -1
- data/spec/models/get_sms_campaign_stats_spec.rb +1 -1
- data/spec/models/get_sms_campaigns_spec.rb +1 -1
- data/spec/models/get_sms_event_report_events_spec.rb +2 -2
- data/spec/models/get_sms_event_report_spec.rb +1 -1
- data/spec/models/get_smtp_template_overview_sender_spec.rb +1 -1
- data/spec/models/get_smtp_template_overview_spec.rb +1 -1
- data/spec/models/get_smtp_templates_spec.rb +1 -1
- data/spec/models/get_sso_token_spec.rb +1 -1
- data/spec/models/get_stats_by_browser_spec.rb +1 -1
- data/spec/models/get_stats_by_device_spec.rb +1 -1
- data/spec/models/get_stats_by_domain_spec.rb +1 -1
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +7 -1
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +1 -1
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +1 -1
- data/spec/models/get_transac_blocked_contacts_spec.rb +1 -1
- data/spec/models/get_transac_email_content_events_spec.rb +1 -1
- data/spec/models/get_transac_email_content_spec.rb +1 -1
- data/spec/models/get_transac_emails_list_spec.rb +1 -1
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +1 -1
- data/spec/models/get_transac_sms_report_reports_spec.rb +7 -1
- data/spec/models/get_transac_sms_report_spec.rb +1 -1
- data/spec/models/get_user_permission_privileges_spec.rb +1 -1
- data/spec/models/get_user_permission_spec.rb +1 -1
- data/spec/models/get_wa_templates_spec.rb +1 -1
- data/spec/models/get_wa_templates_templates_spec.rb +1 -1
- data/spec/models/{get_child_info_api_keys_spec.rb → get_webhook_auth_spec.rb} +9 -9
- data/spec/models/{get_child_info_api_keys_v3_spec.rb → get_webhook_headers_spec.rb} +9 -9
- data/spec/models/get_webhook_spec.rb +19 -1
- data/spec/models/get_webhooks_spec.rb +1 -1
- data/spec/models/get_whats_app_config_spec.rb +1 -1
- data/spec/models/get_whatsapp_campaign_overview_spec.rb +1 -1
- data/spec/models/get_whatsapp_campaigns_campaigns_spec.rb +1 -1
- data/spec/models/get_whatsapp_campaigns_spec.rb +1 -1
- data/spec/models/get_whatsapp_event_report_events_spec.rb +1 -1
- data/spec/models/get_whatsapp_event_report_spec.rb +1 -1
- data/spec/models/inline_response_200_1_spec.rb +2 -8
- data/spec/models/inline_response_200_2_spec.rb +41 -0
- data/spec/models/inline_response_200_3_spec.rb +41 -0
- data/spec/models/inline_response_200_4_spec.rb +41 -0
- data/spec/models/inline_response_200_5_spec.rb +41 -0
- data/spec/models/inline_response_200_6_spec.rb +47 -0
- data/spec/models/inline_response_200_6_totals_spec.rb +53 -0
- data/spec/models/inline_response_200_7_spec.rb +47 -0
- data/spec/models/inline_response_200_8_spec.rb +41 -0
- data/spec/models/inline_response_200_9_spec.rb +53 -0
- data/spec/models/inline_response_200_spec.rb +2 -2
- data/spec/models/inline_response_201_1_spec.rb +1 -1
- data/spec/models/inline_response_201_2_spec.rb +1 -1
- data/spec/models/inline_response_201_3_spec.rb +2 -2
- data/spec/models/inline_response_201_4_spec.rb +2 -2
- data/spec/models/inline_response_201_5_spec.rb +41 -0
- data/spec/models/inline_response_201_spec.rb +1 -1
- data/spec/models/inline_response_400_spec.rb +41 -0
- data/spec/models/invite_admin_user_privileges_spec.rb +55 -0
- data/spec/models/invite_admin_user_spec.rb +59 -0
- data/spec/models/inviteuser_privileges_spec.rb +55 -0
- data/spec/models/inviteuser_spec.rb +53 -0
- data/spec/models/loyalty_program_page_spec.rb +41 -0
- data/spec/models/loyalty_program_spec.rb +111 -0
- data/spec/models/loyalty_program_validation_error_spec.rb +53 -0
- data/spec/models/loyalty_tier_page_spec.rb +41 -0
- data/spec/models/main_attribute_reward_payload_spec.rb +77 -0
- data/spec/models/main_billing_payload_spec.rb +77 -0
- data/spec/models/main_code_count_http_response_spec.rb +41 -0
- data/spec/models/main_create_redeem_payload_order_spec.rb +35 -0
- data/spec/models/main_create_redeem_payload_spec.rb +83 -0
- data/spec/models/main_create_reward_payload_spec.rb +59 -0
- data/spec/models/main_create_reward_response_spec.rb +83 -0
- data/spec/models/main_error_response_spec.rb +41 -0
- data/spec/models/{add_credits_spec.rb → main_filter_spec.rb} +9 -9
- data/spec/models/main_generator_spec.rb +71 -0
- data/spec/models/main_get_contact_rewards_payload_spec.rb +85 -0
- data/spec/models/main_identifiers_payload_spec.rb +47 -0
- data/spec/models/main_limit_spec.rb +83 -0
- data/spec/models/main_model_contact_reward_spec.rb +95 -0
- data/spec/models/main_model_contact_rewards_resp_spec.rb +65 -0
- data/spec/models/main_node_response_spec.rb +83 -0
- data/spec/models/main_order_payload_billing_spec.rb +35 -0
- data/spec/models/main_order_payload_identifiers_spec.rb +35 -0
- data/spec/models/main_order_payload_spec.rb +107 -0
- data/spec/models/main_product_payload_spec.rb +65 -0
- data/spec/models/main_product_spec.rb +59 -0
- data/spec/models/main_redeem_spec.rb +119 -0
- data/spec/models/main_result_parameter_response_spec.rb +47 -0
- data/spec/models/main_result_parameter_response_value_spec.rb +35 -0
- data/spec/models/main_reward_attribution_spec.rb +101 -0
- data/spec/models/main_reward_configurations_spec.rb +53 -0
- data/spec/models/main_reward_generator_spec.rb +35 -0
- data/spec/models/main_reward_page_obj_spec.rb +89 -0
- data/spec/models/main_reward_page_spec.rb +47 -0
- data/spec/models/main_reward_rule_spec.rb +35 -0
- data/spec/models/main_reward_spec.rb +279 -0
- data/spec/models/main_reward_validate_spec.rb +41 -0
- data/spec/models/main_rule_condition_response_lhs_spec.rb +35 -0
- data/spec/models/main_rule_condition_response_rhs_spec.rb +35 -0
- data/spec/models/main_rule_condition_response_spec.rb +65 -0
- data/spec/models/main_rule_condition_spec.rb +35 -0
- data/spec/models/{get_child_info_api_keys_v2_spec.rb → main_rule_event_response_spec.rb} +8 -8
- data/spec/models/{get_child_domains_spec.rb → main_rule_event_spec.rb} +7 -7
- data/spec/models/main_rule_result_response_spec.rb +53 -0
- data/spec/models/main_rule_spec.rb +113 -0
- data/spec/models/main_validate_reward_payload_spec.rb +71 -0
- data/spec/models/main_value_response_expression_spec.rb +35 -0
- data/spec/models/main_value_response_spec.rb +83 -0
- data/spec/models/main_voucher_revoke_payload_spec.rb +41 -0
- data/spec/models/master_details_response_billing_info_address_spec.rb +1 -1
- data/spec/models/master_details_response_billing_info_name_spec.rb +1 -1
- data/spec/models/master_details_response_billing_info_spec.rb +1 -1
- data/spec/models/master_details_response_plan_info_features_spec.rb +13 -1
- data/spec/models/master_details_response_plan_info_spec.rb +1 -1
- data/spec/models/master_details_response_spec.rb +1 -1
- data/spec/models/member_contact_spec.rb +53 -0
- data/spec/models/model_subscription_balance_resp_spec.rb +41 -0
- data/spec/models/note_data_spec.rb +1 -1
- data/spec/models/note_id_spec.rb +1 -1
- data/spec/models/note_list_spec.rb +1 -1
- data/spec/models/note_spec.rb +1 -1
- data/spec/models/notification_spec.rb +51 -0
- data/spec/models/order_batch_spec.rb +7 -1
- data/spec/models/order_billing_spec.rb +7 -1
- data/spec/models/order_identifiers_spec.rb +59 -0
- data/spec/models/order_products_spec.rb +1 -1
- data/spec/models/order_spec.rb +15 -3
- data/spec/models/otp_spec.rb +1 -1
- data/spec/models/patch_loyalty_program_payload_spec.rb +53 -0
- data/spec/models/pipeline_spec.rb +1 -1
- data/spec/models/pipeline_stage_spec.rb +1 -1
- data/spec/models/pipelines_spec.rb +1 -1
- data/spec/models/post_contact_info_contacts_spec.rb +1 -1
- data/spec/models/post_contact_info_spec.rb +1 -1
- data/spec/models/post_send_failed_spec.rb +1 -1
- data/spec/models/post_send_sms_test_failed_spec.rb +1 -1
- data/spec/models/put_revoke_user_permission_spec.rb +41 -0
- data/spec/models/putresendcancelinvitation_spec.rb +41 -0
- data/spec/models/remove_contact_from_list_spec.rb +7 -1
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +7 -1
- data/spec/models/request_contact_export_spec.rb +25 -1
- data/spec/models/request_contact_import_json_body_spec.rb +1 -1
- data/spec/models/request_contact_import_new_list_spec.rb +1 -1
- data/spec/models/request_contact_import_spec.rb +7 -1
- data/spec/models/request_sms_recipient_export_spec.rb +1 -1
- data/spec/models/schedule_smtp_email_spec.rb +1 -1
- data/spec/models/send_report_email_spec.rb +1 -1
- data/spec/models/send_report_spec.rb +1 -1
- data/spec/models/send_sms_spec.rb +1 -1
- data/spec/models/send_smtp_email_attachment_spec.rb +1 -1
- data/spec/models/send_smtp_email_bcc_spec.rb +1 -1
- data/spec/models/send_smtp_email_cc_spec.rb +1 -1
- data/spec/models/send_smtp_email_message_versions_spec.rb +13 -1
- data/spec/models/send_smtp_email_reply_to_1_spec.rb +1 -1
- data/spec/models/send_smtp_email_reply_to_spec.rb +1 -1
- data/spec/models/send_smtp_email_sender_spec.rb +1 -1
- data/spec/models/send_smtp_email_spec.rb +1 -1
- data/spec/models/send_smtp_email_to_1_spec.rb +1 -1
- data/spec/models/send_smtp_email_to_spec.rb +1 -1
- data/spec/models/send_test_email_spec.rb +1 -1
- data/spec/models/send_test_sms_spec.rb +1 -1
- data/spec/models/send_transac_sms_spec.rb +1 -1
- data/spec/models/send_transac_sms_tag_spec.rb +41 -0
- data/spec/models/send_whatsapp_message_spec.rb +7 -1
- data/spec/models/{get_child_account_creation_status_spec.rb → set_config_display_currency_spec.rb} +8 -8
- data/spec/models/sso_token_request_corporate_spec.rb +41 -0
- data/spec/models/sso_token_request_spec.rb +1 -1
- data/spec/models/sub_account_apps_toggle_request_spec.rb +1 -1
- data/spec/models/sub_account_details_response_groups_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_credits_emails_spec.rb +1 -1
- data/spec/models/sub_account_details_response_plan_info_credits_external_feeds_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_credits_sms_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_credits_spec.rb +20 -2
- data/spec/models/sub_account_details_response_plan_info_credits_whatsapp_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_credits_wp_subscribers_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_inbox_spec.rb +1 -1
- data/spec/models/sub_account_details_response_plan_info_features_landing_page_spec.rb +1 -1
- data/spec/models/sub_account_details_response_plan_info_features_sales_users_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_spec.rb +7 -1
- data/spec/models/sub_account_details_response_plan_info_features_users_spec.rb +1 -1
- data/spec/models/sub_account_details_response_plan_info_spec.rb +1 -1
- data/spec/models/sub_account_details_response_spec.rb +7 -1
- data/spec/models/sub_account_update_plan_request_credits_spec.rb +25 -1
- data/spec/models/sub_account_update_plan_request_features_spec.rb +7 -1
- data/spec/models/sub_account_update_plan_request_spec.rb +1 -1
- data/spec/models/sub_accounts_response_groups_spec.rb +47 -0
- data/spec/models/sub_accounts_response_spec.rb +1 -1
- data/spec/models/sub_accounts_response_sub_accounts_spec.rb +7 -1
- data/spec/models/sub_accounts_update_plan_request_credits_spec.rb +65 -0
- data/spec/models/sub_accounts_update_plan_request_features_spec.rb +53 -0
- data/spec/models/sub_accounts_update_plan_request_spec.rb +53 -0
- data/spec/models/subscription_aggregate_balance_spec.rb +47 -0
- data/spec/models/subscription_attributed_reward_spec.rb +89 -0
- data/spec/models/subscription_balances_spec.rb +53 -0
- data/spec/models/subscription_handler_info_balance_spec.rb +35 -0
- data/spec/models/subscription_handler_info_spec.rb +59 -0
- data/spec/models/subscription_member_spec.rb +65 -0
- data/spec/models/subscription_spec.rb +77 -0
- data/spec/models/subscription_tier_spec.rb +77 -0
- data/spec/models/task_list_spec.rb +1 -1
- data/spec/models/task_reminder_spec.rb +1 -1
- data/spec/models/task_spec.rb +1 -1
- data/spec/models/task_types_spec.rb +1 -1
- data/spec/models/template_preview_spec.rb +71 -0
- data/spec/models/tier_access_conditions_spec.rb +59 -0
- data/spec/models/tier_for_contact_spec.rb +77 -0
- data/spec/models/tier_group_page_spec.rb +41 -0
- data/spec/models/tier_group_spec.rb +91 -0
- data/spec/models/tier_request_access_conditions_spec.rb +47 -0
- data/spec/models/tier_request_put_payload_spec.rb +59 -0
- data/spec/models/tier_request_spec.rb +59 -0
- data/spec/models/tier_request_tier_rewards_spec.rb +41 -0
- data/spec/models/tier_spec.rb +89 -0
- data/spec/models/tier_tier_rewards_spec.rb +53 -0
- data/spec/models/transaction_history_resp_spec.rb +65 -0
- data/spec/models/transaction_history_spec.rb +95 -0
- data/spec/models/transaction_spec.rb +125 -0
- data/spec/models/unauthorized_response_spec.rb +41 -0
- data/spec/models/update_attribute_enumeration_spec.rb +1 -1
- data/spec/models/update_attribute_spec.rb +7 -1
- data/spec/models/update_balance_definition_payload_spec.rb +155 -0
- data/spec/models/update_balance_limit_payload_spec.rb +83 -0
- data/spec/models/update_batch_contacts_contacts_spec.rb +1 -1
- data/spec/models/update_batch_contacts_model_spec.rb +1 -1
- data/spec/models/update_batch_contacts_spec.rb +1 -1
- data/spec/models/update_campaign_status_spec.rb +1 -1
- data/spec/models/update_child_spec.rb +1 -1
- data/spec/models/update_contact_spec.rb +1 -1
- data/spec/models/update_coupon_collection_spec.rb +19 -1
- data/spec/models/update_email_campaign_email_expiration_date_spec.rb +51 -0
- data/spec/models/update_email_campaign_recipients_spec.rb +7 -1
- data/spec/models/update_email_campaign_sender_spec.rb +1 -1
- data/spec/models/update_email_campaign_spec.rb +7 -1
- data/spec/models/update_external_feed_spec.rb +1 -1
- data/spec/models/update_list_spec.rb +1 -1
- data/spec/models/update_loyalty_program_payload_spec.rb +53 -0
- data/spec/models/update_sender_spec.rb +1 -1
- data/spec/models/update_sms_campaign_spec.rb +1 -1
- data/spec/models/update_smtp_template_sender_spec.rb +1 -1
- data/spec/models/update_smtp_template_spec.rb +1 -1
- data/spec/models/update_tier_group_request_spec.rb +67 -0
- data/spec/models/update_webhook_spec.rb +19 -1
- data/spec/models/update_whats_app_campaign_spec.rb +1 -1
- data/spec/models/upload_image_model_spec.rb +1 -1
- data/spec/models/upload_image_to_gallery_spec.rb +1 -1
- data/spec/models/validation_errors_spec.rb +35 -0
- data/spec/models/variables_items_spec.rb +1 -1
- data/spec/models/whatsapp_camp_stats_spec.rb +1 -1
- data/spec/models/whatsapp_camp_template_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +1013 -387
- data/docs/AddCredits.md +0 -9
- data/docs/CreateReseller.md +0 -9
- data/docs/GetChildAccountCreationStatus.md +0 -8
- data/docs/GetChildInfo.md +0 -16
- data/docs/GetChildInfoApiKeys.md +0 -9
- data/docs/GetChildInfoApiKeysV2.md +0 -9
- data/docs/GetChildInfoApiKeysV3.md +0 -9
- data/docs/GetChildInfoCredits.md +0 -9
- data/docs/GetChildInfoStatistics.md +0 -10
- data/docs/GetChildrenList.md +0 -9
- data/docs/RemainingCreditModel.md +0 -9
- data/docs/RemainingCreditModelChild.md +0 -9
- data/docs/RemainingCreditModelReseller.md +0 -9
- data/docs/RemoveCredits.md +0 -9
- data/docs/ResellerApi.md +0 -964
- data/docs/UpdateChildAccountStatus.md +0 -11
- data/docs/UpdateChildDomain.md +0 -8
- data/lib/brevo/api/reseller_api.rb +0 -923
- data/lib/brevo/models/get_child_info_statistics.rb +0 -206
- data/spec/api/reseller_api_spec.rb +0 -223
- data/spec/models/get_child_info_credits_spec.rb +0 -47
- data/spec/models/remaining_credit_model_spec.rb +0 -47
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Brevo::TierRequestAccessConditions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**balance_definition_id** | **String** | Balance definition identifier for accessing the tier | [optional]
|
|
7
|
+
**minimum_value** | **Integer** | Minimum value required to access the tier | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Brevo::TierRequestPutPayload
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | Name of the tier to be created |
|
|
7
|
+
**image_ref** | **String** | Image of the tier | [optional]
|
|
8
|
+
**access_conditions** | [**Array<TierRequestAccessConditions>**](TierRequestAccessConditions.md) | |
|
|
9
|
+
**tier_rewards** | [**Array<TierRequestTierRewards>**](TierRequestTierRewards.md) | |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Brevo::TierTierRewards
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**reward_id** | **String** | Reward to be attributed on tier assignment | [optional]
|
|
7
|
+
**created_at** | **DateTime** | | [optional]
|
|
8
|
+
**updated_at** | **DateTime** | | [optional]
|
|
9
|
+
|
|
10
|
+
|
data/docs/Transaction.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Brevo::Transaction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**amount** | **Float** | The transaction amount. | [optional]
|
|
7
|
+
**balance_definition_id** | **String** | Unique identifier (UUID) of the associated balance definition. | [optional]
|
|
8
|
+
**cancelled_at** | **String** | Timestamp when the transaction was canceled (nullable). | [optional]
|
|
9
|
+
**completed_at** | **String** | Timestamp when the transaction was completed (nullable). | [optional]
|
|
10
|
+
**contact_id** | **Integer** | Unique identifier of the contact associated with the transaction. | [optional]
|
|
11
|
+
**created_at** | **String** | Timestamp when the transaction was created. | [optional]
|
|
12
|
+
**event_time** | **String** | Optional timestamp indicating when the transaction event occurred. | [optional]
|
|
13
|
+
**expiration_date** | **String** | Expiry date of the transaction (nullable). | [optional]
|
|
14
|
+
**id** | **String** | Unique identifier (UUID) of the transaction. | [optional]
|
|
15
|
+
**loyalty_program_id** | **String** | Unique identifier (UUID) of the associated loyalty program. | [optional]
|
|
16
|
+
**meta** | **Object** | Optional metadata associated with the transaction. | [optional]
|
|
17
|
+
**reject_reason** | **String** | Reason for rejection if the transaction was declined (nullable). | [optional]
|
|
18
|
+
**rejected_at** | **String** | Timestamp when the transaction was rejected (nullable). | [optional]
|
|
19
|
+
**status** | **String** | The current status of the transaction (e.g., pending, completed, rejected). | [optional]
|
|
20
|
+
**updated_at** | **String** | Timestamp when the transaction was last updated. | [optional]
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Brevo::TransactionHistory
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**amount** | **Float** | The transaction amount. | [optional]
|
|
7
|
+
**balance_expiration_date** | **String** | Expiration date of the balance associated with this transaction. | [optional]
|
|
8
|
+
**cancelled_at** | **String** | Timestamp when the transaction was canceled, if applicable. | [optional]
|
|
9
|
+
**completed_at** | **String** | Timestamp when the transaction was successfully completed. | [optional]
|
|
10
|
+
**created_at** | **String** | Timestamp when the transaction was initiated. | [optional]
|
|
11
|
+
**id** | **String** | Unique identifier of the transaction. | [optional]
|
|
12
|
+
**meta** | **Object** | Optional metadata associated with the transaction. | [optional]
|
|
13
|
+
**reject_reason** | **String** | Reason for rejection, if the transaction was declined. | [optional]
|
|
14
|
+
**rejected_at** | **String** | Timestamp when the transaction was rejected. | [optional]
|
|
15
|
+
**status** | **String** | Current status of the transaction (e.g., pending, completed, rejected). | [optional]
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Brevo::TransactionHistoryResp
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**balance_definition_id** | **String** | Unique identifier of the associated balance definition. | [optional]
|
|
7
|
+
**contact_id** | **Integer** | Unique identifier of the contact related to the transactions. | [optional]
|
|
8
|
+
**count** | **Integer** | Total number of transactions in the history. | [optional]
|
|
9
|
+
**loyalty_program_id** | **String** | Unique identifier of the associated loyalty program. | [optional]
|
|
10
|
+
**transaction_history** | [**Array<TransactionHistory>**](TransactionHistory.md) | List of past transactions associated with the balance. | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -21,10 +21,11 @@ Method | HTTP request | Description
|
|
|
21
21
|
[**get_transac_blocked_contacts**](TransactionalEmailsApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
|
|
22
22
|
[**get_transac_email_content**](TransactionalEmailsApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
|
|
23
23
|
[**get_transac_emails_list**](TransactionalEmailsApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
|
|
24
|
+
[**post_preview_smtp_email_templates**](TransactionalEmailsApi.md#post_preview_smtp_email_templates) | **POST** /smtp/template/preview | Generate the rendered preview of transactional template
|
|
24
25
|
[**send_test_template**](TransactionalEmailsApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
|
|
25
26
|
[**send_transac_email**](TransactionalEmailsApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
|
|
26
27
|
[**smtp_blocked_contacts_email_delete**](TransactionalEmailsApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
|
|
27
|
-
[**
|
|
28
|
+
[**smtp_log_identifier_delete**](TransactionalEmailsApi.md#smtp_log_identifier_delete) | **DELETE** /smtp/log/{identifier} | Delete an SMTP transactional log
|
|
28
29
|
[**update_smtp_template**](TransactionalEmailsApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
|
|
29
30
|
|
|
30
31
|
|
|
@@ -1101,6 +1102,63 @@ Name | Type | Description | Notes
|
|
|
1101
1102
|
|
|
1102
1103
|
|
|
1103
1104
|
|
|
1105
|
+
# **post_preview_smtp_email_templates**
|
|
1106
|
+
> TemplatePreview post_preview_smtp_email_templates(fetch_template_preview)
|
|
1107
|
+
|
|
1108
|
+
Generate the rendered preview of transactional template
|
|
1109
|
+
|
|
1110
|
+
### Example
|
|
1111
|
+
```ruby
|
|
1112
|
+
# load the gem
|
|
1113
|
+
require 'brevo'
|
|
1114
|
+
# setup authorization
|
|
1115
|
+
Brevo.configure do |config|
|
|
1116
|
+
# Configure API key authorization: api-key
|
|
1117
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1118
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1119
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1120
|
+
|
|
1121
|
+
# Configure API key authorization: partner-key
|
|
1122
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1123
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1124
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1125
|
+
end
|
|
1126
|
+
|
|
1127
|
+
api_instance = Brevo::TransactionalEmailsApi.new
|
|
1128
|
+
|
|
1129
|
+
fetch_template_preview = Brevo::FetchTemplatePreview.new # FetchTemplatePreview | Values to fetch Template preview
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
begin
|
|
1133
|
+
#Generate the rendered preview of transactional template
|
|
1134
|
+
result = api_instance.post_preview_smtp_email_templates(fetch_template_preview)
|
|
1135
|
+
p result
|
|
1136
|
+
rescue Brevo::ApiError => e
|
|
1137
|
+
puts "Exception when calling TransactionalEmailsApi->post_preview_smtp_email_templates: #{e}"
|
|
1138
|
+
end
|
|
1139
|
+
```
|
|
1140
|
+
|
|
1141
|
+
### Parameters
|
|
1142
|
+
|
|
1143
|
+
Name | Type | Description | Notes
|
|
1144
|
+
------------- | ------------- | ------------- | -------------
|
|
1145
|
+
**fetch_template_preview** | [**FetchTemplatePreview**](FetchTemplatePreview.md)| Values to fetch Template preview |
|
|
1146
|
+
|
|
1147
|
+
### Return type
|
|
1148
|
+
|
|
1149
|
+
[**TemplatePreview**](TemplatePreview.md)
|
|
1150
|
+
|
|
1151
|
+
### Authorization
|
|
1152
|
+
|
|
1153
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1154
|
+
|
|
1155
|
+
### HTTP request headers
|
|
1156
|
+
|
|
1157
|
+
- **Content-Type**: application/json
|
|
1158
|
+
- **Accept**: application/json
|
|
1159
|
+
|
|
1160
|
+
|
|
1161
|
+
|
|
1104
1162
|
# **send_test_template**
|
|
1105
1163
|
> send_test_template(template_id, send_test_email)
|
|
1106
1164
|
|
|
@@ -1273,8 +1331,8 @@ nil (empty response body)
|
|
|
1273
1331
|
|
|
1274
1332
|
|
|
1275
1333
|
|
|
1276
|
-
# **
|
|
1277
|
-
>
|
|
1334
|
+
# **smtp_log_identifier_delete**
|
|
1335
|
+
> smtp_log_identifier_delete(identifier)
|
|
1278
1336
|
|
|
1279
1337
|
Delete an SMTP transactional log
|
|
1280
1338
|
|
|
@@ -1297,14 +1355,14 @@ end
|
|
|
1297
1355
|
|
|
1298
1356
|
api_instance = Brevo::TransactionalEmailsApi.new
|
|
1299
1357
|
|
|
1300
|
-
|
|
1358
|
+
identifier = 'identifier_example' # String | MessageId of the transactional log(s) to delete
|
|
1301
1359
|
|
|
1302
1360
|
|
|
1303
1361
|
begin
|
|
1304
1362
|
#Delete an SMTP transactional log
|
|
1305
|
-
api_instance.
|
|
1363
|
+
api_instance.smtp_log_identifier_delete(identifier)
|
|
1306
1364
|
rescue Brevo::ApiError => e
|
|
1307
|
-
puts "Exception when calling TransactionalEmailsApi->
|
|
1365
|
+
puts "Exception when calling TransactionalEmailsApi->smtp_log_identifier_delete: #{e}"
|
|
1308
1366
|
end
|
|
1309
1367
|
```
|
|
1310
1368
|
|
|
@@ -1312,7 +1370,7 @@ end
|
|
|
1312
1370
|
|
|
1313
1371
|
Name | Type | Description | Notes
|
|
1314
1372
|
------------- | ------------- | ------------- | -------------
|
|
1315
|
-
**
|
|
1373
|
+
**identifier** | **String**| MessageId of the transactional log(s) to delete |
|
|
1316
1374
|
|
|
1317
1375
|
### Return type
|
|
1318
1376
|
|
data/docs/TransactionalSMSApi.md
CHANGED
|
@@ -7,6 +7,7 @@ Method | HTTP request | Description
|
|
|
7
7
|
[**get_sms_events**](TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
|
|
8
8
|
[**get_transac_aggregated_sms_report**](TransactionalSMSApi.md#get_transac_aggregated_sms_report) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
|
|
9
9
|
[**get_transac_sms_report**](TransactionalSMSApi.md#get_transac_sms_report) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
|
|
10
|
+
[**send_async_transactional_sms**](TransactionalSMSApi.md#send_async_transactional_sms) | **POST** /transactionalSMS/send | Send SMS message asynchronously to a mobile number
|
|
10
11
|
[**send_transac_sms**](TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number
|
|
11
12
|
|
|
12
13
|
|
|
@@ -214,6 +215,56 @@ Name | Type | Description | Notes
|
|
|
214
215
|
|
|
215
216
|
|
|
216
217
|
|
|
218
|
+
# **send_async_transactional_sms**
|
|
219
|
+
> send_async_transactional_sms
|
|
220
|
+
|
|
221
|
+
Send SMS message asynchronously to a mobile number
|
|
222
|
+
|
|
223
|
+
### Example
|
|
224
|
+
```ruby
|
|
225
|
+
# load the gem
|
|
226
|
+
require 'brevo'
|
|
227
|
+
# setup authorization
|
|
228
|
+
Brevo.configure do |config|
|
|
229
|
+
# Configure API key authorization: api-key
|
|
230
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
231
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
232
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
233
|
+
|
|
234
|
+
# Configure API key authorization: partner-key
|
|
235
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
236
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
237
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
238
|
+
end
|
|
239
|
+
|
|
240
|
+
api_instance = Brevo::TransactionalSMSApi.new
|
|
241
|
+
|
|
242
|
+
begin
|
|
243
|
+
#Send SMS message asynchronously to a mobile number
|
|
244
|
+
api_instance.send_async_transactional_sms
|
|
245
|
+
rescue Brevo::ApiError => e
|
|
246
|
+
puts "Exception when calling TransactionalSMSApi->send_async_transactional_sms: #{e}"
|
|
247
|
+
end
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
### Parameters
|
|
251
|
+
This endpoint does not need any parameter.
|
|
252
|
+
|
|
253
|
+
### Return type
|
|
254
|
+
|
|
255
|
+
nil (empty response body)
|
|
256
|
+
|
|
257
|
+
### Authorization
|
|
258
|
+
|
|
259
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
260
|
+
|
|
261
|
+
### HTTP request headers
|
|
262
|
+
|
|
263
|
+
- **Content-Type**: application/json
|
|
264
|
+
- **Accept**: application/json
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
217
268
|
# **send_transac_sms**
|
|
218
269
|
> SendSms send_transac_sms(send_transac_sms)
|
|
219
270
|
|
|
@@ -83,7 +83,7 @@ Name | Type | Description | Notes
|
|
|
83
83
|
|
|
84
84
|
|
|
85
85
|
# **send_whatsapp_message**
|
|
86
|
-
>
|
|
86
|
+
> InlineResponse2014 send_whatsapp_message(send_whatsapp_message)
|
|
87
87
|
|
|
88
88
|
Send a WhatsApp message
|
|
89
89
|
|
|
@@ -128,7 +128,7 @@ Name | Type | Description | Notes
|
|
|
128
128
|
|
|
129
129
|
### Return type
|
|
130
130
|
|
|
131
|
-
[**
|
|
131
|
+
[**InlineResponse2014**](InlineResponse2014.md)
|
|
132
132
|
|
|
133
133
|
### Authorization
|
|
134
134
|
|
data/docs/UpdateAttribute.md
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**value** | **String** | Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global' | [optional]
|
|
7
|
-
**enumeration** | [**Array<UpdateAttributeEnumeration>**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] | [optional]
|
|
7
|
+
**enumeration** | [**Array<UpdateAttributeEnumeration>**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". None of the category options can exceed max 200 characters. For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] | [optional]
|
|
8
|
+
**multi_category_options** | **Array<String>** | Use this option to add multiple-choice attributes options only if the attribute's category is \"normal\". **This option is specifically designed for updating multiple-choice attributes. None of the multicategory options can exceed max 200 characters **. For example: **[\"USA\",\"INDIA\"]** | [optional]
|
|
8
9
|
|
|
9
10
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Brevo::UpdateBalanceDefinitionPayload
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**balance_availability_duration_modifier** | **String** | Defines when the balance expires within the selected duration. | [optional]
|
|
7
|
+
**balance_availability_duration_unit** | **String** | Unit of time for balance validity. | [optional]
|
|
8
|
+
**balance_availability_duration_value** | **Integer** | Number of time units before the balance expires. | [optional]
|
|
9
|
+
**balance_expiration_date** | **String** | Expiration date (`dd/mm` format) or empty if not applicable. | [optional]
|
|
10
|
+
**balance_option_amount_overtaking_strategy** | **String** | Defines whether partial credit is allowed when reaching max balance. | [optional]
|
|
11
|
+
**balance_option_credit_rounding** | **String** | Rounding strategy for credit transactions. | [optional]
|
|
12
|
+
**balance_option_debit_rounding** | **String** | Rounding strategy for debit transactions. | [optional]
|
|
13
|
+
**description** | **String** | Short description of the balance definition. | [optional]
|
|
14
|
+
**image_ref** | **String** | URL of an optional image reference. | [optional]
|
|
15
|
+
**max_amount** | **Float** | Maximum allowable balance amount. | [optional]
|
|
16
|
+
**max_credit_amount_limit** | **Float** | Maximum credit allowed per operation. | [optional]
|
|
17
|
+
**max_debit_amount_limit** | **Float** | Maximum debit allowed per operation. | [optional]
|
|
18
|
+
**meta** | **Object** | Optional metadata for the balance definition. | [optional]
|
|
19
|
+
**min_amount** | **Float** | Minimum allowable balance amount. | [optional]
|
|
20
|
+
**name** | **String** | Name of the balance definition. |
|
|
21
|
+
**unit** | **String** | Unit of balance measurement. |
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Brevo::UpdateBalanceLimitPayload
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**constraint_type** | **String** | Defines whether the limit applies to transaction count or amount. |
|
|
7
|
+
**duration_unit** | **String** | Unit of time for which the limit is applicable. |
|
|
8
|
+
**duration_value** | **Integer** | Number of time units for the balance limit. |
|
|
9
|
+
**sliding_schedule** | **BOOLEAN** | Determines if the limit resets on a rolling schedule. | [optional]
|
|
10
|
+
**transaction_type** | **String** | Specifies whether the limit applies to credit or debit transactions. |
|
|
11
|
+
**value** | **Integer** | Maximum allowed value for the specified constraint type. |
|
|
12
|
+
|
|
13
|
+
|
data/docs/UpdateContact.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**attributes** | **Object
|
|
6
|
+
**attributes** | **Hash<String, Object>** | Pass the set of attributes to be updated. These attributes must be present in your account. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored.To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\", \"COUNTRIES\":[\"India\",\"China\"]}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional]
|
|
7
7
|
**ext_id** | **String** | Pass your own Id to update ext_id of a contact. | [optional]
|
|
8
8
|
**email_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional]
|
|
9
9
|
**sms_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional]
|
|
@@ -3,6 +3,9 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**default_coupon** | **String** | A default coupon to be used in case there are no coupons left |
|
|
6
|
+
**default_coupon** | **String** | A default coupon to be used in case there are no coupons left | [optional]
|
|
7
|
+
**expiration_date** | **DateTime** | Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date. | [optional]
|
|
8
|
+
**remaining_days_alert** | **Integer** | Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts. | [optional]
|
|
9
|
+
**remaining_coupons_alert** | **Integer** | Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts. | [optional]
|
|
7
10
|
|
|
8
11
|
|
data/docs/UpdateEmailCampaign.md
CHANGED
|
@@ -34,5 +34,6 @@ Name | Type | Description | Notes
|
|
|
34
34
|
**increase_rate** | **Integer** | Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. | [optional]
|
|
35
35
|
**unsubscription_page_id** | **String** | Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. | [optional]
|
|
36
36
|
**update_form_id** | **String** | Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. | [optional]
|
|
37
|
+
**email_expiration_date** | [**UpdateEmailCampaignEmailExpirationDate**](UpdateEmailCampaignEmailExpirationDate.md) | | [optional]
|
|
37
38
|
|
|
38
39
|
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Brevo::UpdateEmailCampaignEmailExpirationDate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**duration** | **Float** | Duration of the email expiry. maximum duration can be 3600 days or 480 weeks or 120 months. | [optional]
|
|
7
|
+
**unit** | **String** | Date-time of the email expiration | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**exclusion_list_ids** | **Array<Integer>** | List ids which have to be excluded from a campaign | [optional]
|
|
7
7
|
**list_ids** | **Array<Integer>** | Lists Ids to send the campaign to. Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty | [optional]
|
|
8
8
|
**segment_ids** | **Array<Integer>** | Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it. Segment ids to send the campaign to. | [optional]
|
|
9
|
+
**exclusion_segment_ids** | **Array<Integer>** | Segment ids which have to be excluded from a campaign. | [optional]
|
|
9
10
|
|
|
10
11
|
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Brevo::UpdateLoyaltyProgramPayload
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | Loyalty Program name |
|
|
7
|
+
**description** | **String** | Loyalty Program description | [optional]
|
|
8
|
+
**meta** | **Object** | Loyalty Program meta data | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Brevo::UpdateTierGroupRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | Name of the tier group |
|
|
7
|
+
**tier_order** | **Array<String>** | Order of the tiers in the group in ascending order |
|
|
8
|
+
**upgrade_strategy** | **String** | Select real_time to upgrade tier on real time balance updates. Select membership_anniversary to upgrade tier on subscription anniversary. Select tier_anniversary to upgrade tier on tier anniversary. | [default to 'real_time']
|
|
9
|
+
**downgrade_strategy** | **String** | Select real_time to downgrade tier on real time balance updates. Select membership_anniversary to downgrade tier on subscription anniversary. Select tier_anniversary to downgrade tier on tier anniversary. | [default to 'real_time']
|
|
10
|
+
|
|
11
|
+
|
data/docs/UpdateWebhook.md
CHANGED
|
@@ -7,5 +7,8 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**description** | **String** | Description of the webhook | [optional]
|
|
8
8
|
**events** | **Array<String>** | - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed` | [optional]
|
|
9
9
|
**domain** | **String** | Inbound domain of webhook, used in case of event type `inbound` | [optional]
|
|
10
|
+
**batched** | **BOOLEAN** | To send batched webhooks | [optional]
|
|
11
|
+
**auth** | [**GetWebhookAuth**](GetWebhookAuth.md) | | [optional]
|
|
12
|
+
**headers** | [**Array<GetWebhookHeaders>**](GetWebhookHeaders.md) | Custom headers to be send with webhooks | [optional]
|
|
10
13
|
|
|
11
14
|
|