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
data/docs/MasterAccountApi.md
CHANGED
|
@@ -4,24 +4,919 @@ All URIs are relative to *https://api.brevo.com/v3*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
+
[**corporate_group_id_delete**](MasterAccountApi.md#corporate_group_id_delete) | **DELETE** /corporate/group/{id} | Delete a group
|
|
8
|
+
[**corporate_group_id_get**](MasterAccountApi.md#corporate_group_id_get) | **GET** /corporate/group/{id} | GET a group details
|
|
9
|
+
[**corporate_group_id_put**](MasterAccountApi.md#corporate_group_id_put) | **PUT** /corporate/group/{id} | Update a group of sub-accounts
|
|
10
|
+
[**corporate_group_post**](MasterAccountApi.md#corporate_group_post) | **POST** /corporate/group | Create a new group of sub-accounts
|
|
11
|
+
[**corporate_group_unlink_group_id_sub_accounts_put**](MasterAccountApi.md#corporate_group_unlink_group_id_sub_accounts_put) | **PUT** /corporate/group/unlink/{groupId}/subAccounts | Delete sub-account from group
|
|
12
|
+
[**corporate_ip_get**](MasterAccountApi.md#corporate_ip_get) | **GET** /corporate/ip | List of all IPs
|
|
7
13
|
[**corporate_master_account_get**](MasterAccountApi.md#corporate_master_account_get) | **GET** /corporate/masterAccount | Get the details of requested master account
|
|
14
|
+
[**corporate_sso_token_post**](MasterAccountApi.md#corporate_sso_token_post) | **POST** /corporate/ssoToken | Generate SSO token to access admin account
|
|
8
15
|
[**corporate_sub_account_get**](MasterAccountApi.md#corporate_sub_account_get) | **GET** /corporate/subAccount | Get the list of all the sub-accounts of the master account.
|
|
9
16
|
[**corporate_sub_account_id_applications_toggle_put**](MasterAccountApi.md#corporate_sub_account_id_applications_toggle_put) | **PUT** /corporate/subAccount/{id}/applications/toggle | Enable/disable sub-account application(s)
|
|
10
17
|
[**corporate_sub_account_id_delete**](MasterAccountApi.md#corporate_sub_account_id_delete) | **DELETE** /corporate/subAccount/{id} | Delete a sub-account
|
|
11
18
|
[**corporate_sub_account_id_get**](MasterAccountApi.md#corporate_sub_account_id_get) | **GET** /corporate/subAccount/{id} | Get sub-account details
|
|
12
19
|
[**corporate_sub_account_id_plan_put**](MasterAccountApi.md#corporate_sub_account_id_plan_put) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan
|
|
20
|
+
[**corporate_sub_account_ip_associate_post**](MasterAccountApi.md#corporate_sub_account_ip_associate_post) | **POST** /corporate/subAccount/ip/associate | Associate an IP to sub-accounts
|
|
21
|
+
[**corporate_sub_account_ip_dissociate_put**](MasterAccountApi.md#corporate_sub_account_ip_dissociate_put) | **PUT** /corporate/subAccount/ip/dissociate | Dissociate an IP from sub-accounts
|
|
13
22
|
[**corporate_sub_account_key_post**](MasterAccountApi.md#corporate_sub_account_key_post) | **POST** /corporate/subAccount/key | Create an API key for a sub-account
|
|
14
23
|
[**corporate_sub_account_post**](MasterAccountApi.md#corporate_sub_account_post) | **POST** /corporate/subAccount | Create a new sub-account under a master account.
|
|
15
|
-
[**corporate_sub_account_sso_token_post**](MasterAccountApi.md#corporate_sub_account_sso_token_post) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access
|
|
24
|
+
[**corporate_sub_account_sso_token_post**](MasterAccountApi.md#corporate_sub_account_sso_token_post) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access sub-account
|
|
25
|
+
[**corporate_sub_accounts_plan_put**](MasterAccountApi.md#corporate_sub_accounts_plan_put) | **PUT** /corporate/subAccounts/plan | Update sub-accounts plan
|
|
26
|
+
[**corporate_user_email_permissions_put**](MasterAccountApi.md#corporate_user_email_permissions_put) | **PUT** /corporate/user/{email}/permissions | Change admin user permissions
|
|
27
|
+
[**corporate_user_invitation_action_email_put**](MasterAccountApi.md#corporate_user_invitation_action_email_put) | **PUT** /corporate/user/invitation/{action}/{email} | Resend / cancel admin user invitation
|
|
28
|
+
[**corporate_user_revoke_email_delete**](MasterAccountApi.md#corporate_user_revoke_email_delete) | **DELETE** /corporate/user/revoke/{email} | Revoke an admin user
|
|
16
29
|
[**get_account_activity**](MasterAccountApi.md#get_account_activity) | **GET** /organization/activities | Get user activity logs
|
|
30
|
+
[**get_corporate_invited_users_list**](MasterAccountApi.md#get_corporate_invited_users_list) | **GET** /corporate/invited/users | Get the list of all admin users
|
|
31
|
+
[**get_corporate_user_permission**](MasterAccountApi.md#get_corporate_user_permission) | **GET** /corporate/user/{email}/permissions | Check admin user permissions
|
|
32
|
+
[**get_sub_account_groups**](MasterAccountApi.md#get_sub_account_groups) | **GET** /corporate/groups | Get the list of groups
|
|
33
|
+
[**invite_admin_user**](MasterAccountApi.md#invite_admin_user) | **POST** /corporate/user/invitation/send | Send invitation to an admin user
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
# **corporate_group_id_delete**
|
|
37
|
+
> corporate_group_id_delete(id)
|
|
38
|
+
|
|
39
|
+
Delete a group
|
|
40
|
+
|
|
41
|
+
This endpoint allows you to delete a group of sub-organizations. When a group is deleted, the sub-organizations are no longer part of this group. The users associated with the group are no longer associated with the group once deleted.
|
|
42
|
+
|
|
43
|
+
### Example
|
|
44
|
+
```ruby
|
|
45
|
+
# load the gem
|
|
46
|
+
require 'brevo'
|
|
47
|
+
# setup authorization
|
|
48
|
+
Brevo.configure do |config|
|
|
49
|
+
# Configure API key authorization: api-key
|
|
50
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
51
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
52
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
53
|
+
|
|
54
|
+
# Configure API key authorization: partner-key
|
|
55
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
56
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
57
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
61
|
+
|
|
62
|
+
id = 'id_example' # String | Id of the group
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
begin
|
|
66
|
+
#Delete a group
|
|
67
|
+
api_instance.corporate_group_id_delete(id)
|
|
68
|
+
rescue Brevo::ApiError => e
|
|
69
|
+
puts "Exception when calling MasterAccountApi->corporate_group_id_delete: #{e}"
|
|
70
|
+
end
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Parameters
|
|
74
|
+
|
|
75
|
+
Name | Type | Description | Notes
|
|
76
|
+
------------- | ------------- | ------------- | -------------
|
|
77
|
+
**id** | **String**| Id of the group |
|
|
78
|
+
|
|
79
|
+
### Return type
|
|
80
|
+
|
|
81
|
+
nil (empty response body)
|
|
82
|
+
|
|
83
|
+
### Authorization
|
|
84
|
+
|
|
85
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
86
|
+
|
|
87
|
+
### HTTP request headers
|
|
88
|
+
|
|
89
|
+
- **Content-Type**: application/json
|
|
90
|
+
- **Accept**: application/json
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
# **corporate_group_id_get**
|
|
95
|
+
> CorporateGroupDetailsResponse corporate_group_id_get(id)
|
|
96
|
+
|
|
97
|
+
GET a group details
|
|
98
|
+
|
|
99
|
+
This endpoint allows you to retrieve a specific group’s information such as the list of sub-organizations and the user associated with the group.
|
|
100
|
+
|
|
101
|
+
### Example
|
|
102
|
+
```ruby
|
|
103
|
+
# load the gem
|
|
104
|
+
require 'brevo'
|
|
105
|
+
# setup authorization
|
|
106
|
+
Brevo.configure do |config|
|
|
107
|
+
# Configure API key authorization: api-key
|
|
108
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
109
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
110
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
111
|
+
|
|
112
|
+
# Configure API key authorization: partner-key
|
|
113
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
114
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
115
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
119
|
+
|
|
120
|
+
id = 'id_example' # String | Id of the group of sub-organization
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
begin
|
|
124
|
+
#GET a group details
|
|
125
|
+
result = api_instance.corporate_group_id_get(id)
|
|
126
|
+
p result
|
|
127
|
+
rescue Brevo::ApiError => e
|
|
128
|
+
puts "Exception when calling MasterAccountApi->corporate_group_id_get: #{e}"
|
|
129
|
+
end
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### Parameters
|
|
133
|
+
|
|
134
|
+
Name | Type | Description | Notes
|
|
135
|
+
------------- | ------------- | ------------- | -------------
|
|
136
|
+
**id** | **String**| Id of the group of sub-organization |
|
|
137
|
+
|
|
138
|
+
### Return type
|
|
139
|
+
|
|
140
|
+
[**CorporateGroupDetailsResponse**](CorporateGroupDetailsResponse.md)
|
|
141
|
+
|
|
142
|
+
### Authorization
|
|
143
|
+
|
|
144
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
145
|
+
|
|
146
|
+
### HTTP request headers
|
|
147
|
+
|
|
148
|
+
- **Content-Type**: application/json
|
|
149
|
+
- **Accept**: application/json
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
# **corporate_group_id_put**
|
|
154
|
+
> corporate_group_id_put(id, body)
|
|
155
|
+
|
|
156
|
+
Update a group of sub-accounts
|
|
157
|
+
|
|
158
|
+
This endpoint allows you to update a group of sub-accounts
|
|
159
|
+
|
|
160
|
+
### Example
|
|
161
|
+
```ruby
|
|
162
|
+
# load the gem
|
|
163
|
+
require 'brevo'
|
|
164
|
+
# setup authorization
|
|
165
|
+
Brevo.configure do |config|
|
|
166
|
+
# Configure API key authorization: api-key
|
|
167
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
168
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
169
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
170
|
+
|
|
171
|
+
# Configure API key authorization: partner-key
|
|
172
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
173
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
174
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
178
|
+
|
|
179
|
+
id = 'id_example' # String | Id of the group
|
|
180
|
+
|
|
181
|
+
body = Brevo::Body3.new # Body3 | Group details to be updated.
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
begin
|
|
185
|
+
#Update a group of sub-accounts
|
|
186
|
+
api_instance.corporate_group_id_put(id, body)
|
|
187
|
+
rescue Brevo::ApiError => e
|
|
188
|
+
puts "Exception when calling MasterAccountApi->corporate_group_id_put: #{e}"
|
|
189
|
+
end
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### Parameters
|
|
193
|
+
|
|
194
|
+
Name | Type | Description | Notes
|
|
195
|
+
------------- | ------------- | ------------- | -------------
|
|
196
|
+
**id** | **String**| Id of the group |
|
|
197
|
+
**body** | [**Body3**](Body3.md)| Group details to be updated. |
|
|
198
|
+
|
|
199
|
+
### Return type
|
|
200
|
+
|
|
201
|
+
nil (empty response body)
|
|
202
|
+
|
|
203
|
+
### Authorization
|
|
204
|
+
|
|
205
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
206
|
+
|
|
207
|
+
### HTTP request headers
|
|
208
|
+
|
|
209
|
+
- **Content-Type**: application/json
|
|
210
|
+
- **Accept**: application/json
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
# **corporate_group_post**
|
|
215
|
+
> InlineResponse201 corporate_group_post(body)
|
|
216
|
+
|
|
217
|
+
Create a new group of sub-accounts
|
|
218
|
+
|
|
219
|
+
This endpoint allows to create a group of sub-accounts
|
|
220
|
+
|
|
221
|
+
### Example
|
|
222
|
+
```ruby
|
|
223
|
+
# load the gem
|
|
224
|
+
require 'brevo'
|
|
225
|
+
# setup authorization
|
|
226
|
+
Brevo.configure do |config|
|
|
227
|
+
# Configure API key authorization: api-key
|
|
228
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
229
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
230
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
231
|
+
|
|
232
|
+
# Configure API key authorization: partner-key
|
|
233
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
234
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
235
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
236
|
+
end
|
|
237
|
+
|
|
238
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
239
|
+
|
|
240
|
+
body = Brevo::Body.new # Body | Group details to be created.
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
begin
|
|
244
|
+
#Create a new group of sub-accounts
|
|
245
|
+
result = api_instance.corporate_group_post(body)
|
|
246
|
+
p result
|
|
247
|
+
rescue Brevo::ApiError => e
|
|
248
|
+
puts "Exception when calling MasterAccountApi->corporate_group_post: #{e}"
|
|
249
|
+
end
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
### Parameters
|
|
253
|
+
|
|
254
|
+
Name | Type | Description | Notes
|
|
255
|
+
------------- | ------------- | ------------- | -------------
|
|
256
|
+
**body** | [**Body**](Body.md)| Group details to be created. |
|
|
257
|
+
|
|
258
|
+
### Return type
|
|
259
|
+
|
|
260
|
+
[**InlineResponse201**](InlineResponse201.md)
|
|
261
|
+
|
|
262
|
+
### Authorization
|
|
263
|
+
|
|
264
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
265
|
+
|
|
266
|
+
### HTTP request headers
|
|
267
|
+
|
|
268
|
+
- **Content-Type**: application/json
|
|
269
|
+
- **Accept**: application/json
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
# **corporate_group_unlink_group_id_sub_accounts_put**
|
|
274
|
+
> corporate_group_unlink_group_id_sub_accounts_put(group_id, body)
|
|
275
|
+
|
|
276
|
+
Delete sub-account from group
|
|
277
|
+
|
|
278
|
+
This endpoint allows you to remove a sub-organization from a group.
|
|
279
|
+
|
|
280
|
+
### Example
|
|
281
|
+
```ruby
|
|
282
|
+
# load the gem
|
|
283
|
+
require 'brevo'
|
|
284
|
+
# setup authorization
|
|
285
|
+
Brevo.configure do |config|
|
|
286
|
+
# Configure API key authorization: api-key
|
|
287
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
288
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
289
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
290
|
+
|
|
291
|
+
# Configure API key authorization: partner-key
|
|
292
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
293
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
294
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
295
|
+
end
|
|
296
|
+
|
|
297
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
298
|
+
|
|
299
|
+
group_id = 'group_id_example' # String | Id of the group
|
|
300
|
+
|
|
301
|
+
body = Brevo::Body4.new # Body4 | List of sub-account ids
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
begin
|
|
305
|
+
#Delete sub-account from group
|
|
306
|
+
api_instance.corporate_group_unlink_group_id_sub_accounts_put(group_id, body)
|
|
307
|
+
rescue Brevo::ApiError => e
|
|
308
|
+
puts "Exception when calling MasterAccountApi->corporate_group_unlink_group_id_sub_accounts_put: #{e}"
|
|
309
|
+
end
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
### Parameters
|
|
313
|
+
|
|
314
|
+
Name | Type | Description | Notes
|
|
315
|
+
------------- | ------------- | ------------- | -------------
|
|
316
|
+
**group_id** | **String**| Id of the group |
|
|
317
|
+
**body** | [**Body4**](Body4.md)| List of sub-account ids |
|
|
318
|
+
|
|
319
|
+
### Return type
|
|
320
|
+
|
|
321
|
+
nil (empty response body)
|
|
322
|
+
|
|
323
|
+
### Authorization
|
|
324
|
+
|
|
325
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
326
|
+
|
|
327
|
+
### HTTP request headers
|
|
328
|
+
|
|
329
|
+
- **Content-Type**: application/json
|
|
330
|
+
- **Accept**: application/json
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
# **corporate_ip_get**
|
|
335
|
+
> corporate_ip_get
|
|
336
|
+
|
|
337
|
+
List of all IPs
|
|
338
|
+
|
|
339
|
+
This endpoint allows you to retrieve the list of active IPs on your Admin account
|
|
340
|
+
|
|
341
|
+
### Example
|
|
342
|
+
```ruby
|
|
343
|
+
# load the gem
|
|
344
|
+
require 'brevo'
|
|
345
|
+
# setup authorization
|
|
346
|
+
Brevo.configure do |config|
|
|
347
|
+
# Configure API key authorization: api-key
|
|
348
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
349
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
350
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
351
|
+
|
|
352
|
+
# Configure API key authorization: partner-key
|
|
353
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
354
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
355
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
356
|
+
end
|
|
357
|
+
|
|
358
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
359
|
+
|
|
360
|
+
begin
|
|
361
|
+
#List of all IPs
|
|
362
|
+
api_instance.corporate_ip_get
|
|
363
|
+
rescue Brevo::ApiError => e
|
|
364
|
+
puts "Exception when calling MasterAccountApi->corporate_ip_get: #{e}"
|
|
365
|
+
end
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
### Parameters
|
|
369
|
+
This endpoint does not need any parameter.
|
|
370
|
+
|
|
371
|
+
### Return type
|
|
372
|
+
|
|
373
|
+
nil (empty response body)
|
|
374
|
+
|
|
375
|
+
### Authorization
|
|
376
|
+
|
|
377
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
378
|
+
|
|
379
|
+
### HTTP request headers
|
|
380
|
+
|
|
381
|
+
- **Content-Type**: application/json
|
|
382
|
+
- **Accept**: application/json
|
|
383
|
+
|
|
17
384
|
|
|
18
385
|
|
|
19
386
|
# **corporate_master_account_get**
|
|
20
387
|
> MasterDetailsResponse corporate_master_account_get
|
|
21
388
|
|
|
22
|
-
Get the details of requested master account
|
|
389
|
+
Get the details of requested master account
|
|
390
|
+
|
|
391
|
+
This endpoint will provide the details of the master account.
|
|
392
|
+
|
|
393
|
+
### Example
|
|
394
|
+
```ruby
|
|
395
|
+
# load the gem
|
|
396
|
+
require 'brevo'
|
|
397
|
+
# setup authorization
|
|
398
|
+
Brevo.configure do |config|
|
|
399
|
+
# Configure API key authorization: api-key
|
|
400
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
401
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
402
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
403
|
+
|
|
404
|
+
# Configure API key authorization: partner-key
|
|
405
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
406
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
407
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
408
|
+
end
|
|
409
|
+
|
|
410
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
411
|
+
|
|
412
|
+
begin
|
|
413
|
+
#Get the details of requested master account
|
|
414
|
+
result = api_instance.corporate_master_account_get
|
|
415
|
+
p result
|
|
416
|
+
rescue Brevo::ApiError => e
|
|
417
|
+
puts "Exception when calling MasterAccountApi->corporate_master_account_get: #{e}"
|
|
418
|
+
end
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
### Parameters
|
|
422
|
+
This endpoint does not need any parameter.
|
|
423
|
+
|
|
424
|
+
### Return type
|
|
425
|
+
|
|
426
|
+
[**MasterDetailsResponse**](MasterDetailsResponse.md)
|
|
427
|
+
|
|
428
|
+
### Authorization
|
|
429
|
+
|
|
430
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
431
|
+
|
|
432
|
+
### HTTP request headers
|
|
433
|
+
|
|
434
|
+
- **Content-Type**: application/json
|
|
435
|
+
- **Accept**: application/json
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
# **corporate_sso_token_post**
|
|
440
|
+
> GetSsoToken corporate_sso_token_post(sso_token_request_corporate)
|
|
441
|
+
|
|
442
|
+
Generate SSO token to access admin account
|
|
443
|
+
|
|
444
|
+
This endpoint generates an SSO token to authenticate and access the admin account using the endpoint https://account-app.brevo.com/account/login/corporate/sso/[token], where [token] will be replaced by the actual token.
|
|
445
|
+
|
|
446
|
+
### Example
|
|
447
|
+
```ruby
|
|
448
|
+
# load the gem
|
|
449
|
+
require 'brevo'
|
|
450
|
+
# setup authorization
|
|
451
|
+
Brevo.configure do |config|
|
|
452
|
+
# Configure API key authorization: api-key
|
|
453
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
454
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
455
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
456
|
+
|
|
457
|
+
# Configure API key authorization: partner-key
|
|
458
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
459
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
460
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
461
|
+
end
|
|
462
|
+
|
|
463
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
464
|
+
|
|
465
|
+
sso_token_request_corporate = Brevo::SsoTokenRequestCorporate.new # SsoTokenRequestCorporate | User email of admin account
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
begin
|
|
469
|
+
#Generate SSO token to access admin account
|
|
470
|
+
result = api_instance.corporate_sso_token_post(sso_token_request_corporate)
|
|
471
|
+
p result
|
|
472
|
+
rescue Brevo::ApiError => e
|
|
473
|
+
puts "Exception when calling MasterAccountApi->corporate_sso_token_post: #{e}"
|
|
474
|
+
end
|
|
475
|
+
```
|
|
476
|
+
|
|
477
|
+
### Parameters
|
|
478
|
+
|
|
479
|
+
Name | Type | Description | Notes
|
|
480
|
+
------------- | ------------- | ------------- | -------------
|
|
481
|
+
**sso_token_request_corporate** | [**SsoTokenRequestCorporate**](SsoTokenRequestCorporate.md)| User email of admin account |
|
|
482
|
+
|
|
483
|
+
### Return type
|
|
484
|
+
|
|
485
|
+
[**GetSsoToken**](GetSsoToken.md)
|
|
486
|
+
|
|
487
|
+
### Authorization
|
|
488
|
+
|
|
489
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
490
|
+
|
|
491
|
+
### HTTP request headers
|
|
492
|
+
|
|
493
|
+
- **Content-Type**: application/json
|
|
494
|
+
- **Accept**: application/json
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
# **corporate_sub_account_get**
|
|
499
|
+
> SubAccountsResponse corporate_sub_account_get(offset, limit)
|
|
500
|
+
|
|
501
|
+
Get the list of all the sub-accounts of the master account.
|
|
502
|
+
|
|
503
|
+
This endpoint will provide the list all the sub-accounts of the master account.
|
|
504
|
+
|
|
505
|
+
### Example
|
|
506
|
+
```ruby
|
|
507
|
+
# load the gem
|
|
508
|
+
require 'brevo'
|
|
509
|
+
# setup authorization
|
|
510
|
+
Brevo.configure do |config|
|
|
511
|
+
# Configure API key authorization: api-key
|
|
512
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
513
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
514
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
515
|
+
|
|
516
|
+
# Configure API key authorization: partner-key
|
|
517
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
518
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
519
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
520
|
+
end
|
|
521
|
+
|
|
522
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
523
|
+
|
|
524
|
+
offset = 56 # Integer | Index of the first sub-account in the page
|
|
525
|
+
|
|
526
|
+
limit = 56 # Integer | Number of sub-accounts to be displayed on each page
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
begin
|
|
530
|
+
#Get the list of all the sub-accounts of the master account.
|
|
531
|
+
result = api_instance.corporate_sub_account_get(offset, limit)
|
|
532
|
+
p result
|
|
533
|
+
rescue Brevo::ApiError => e
|
|
534
|
+
puts "Exception when calling MasterAccountApi->corporate_sub_account_get: #{e}"
|
|
535
|
+
end
|
|
536
|
+
```
|
|
537
|
+
|
|
538
|
+
### Parameters
|
|
539
|
+
|
|
540
|
+
Name | Type | Description | Notes
|
|
541
|
+
------------- | ------------- | ------------- | -------------
|
|
542
|
+
**offset** | **Integer**| Index of the first sub-account in the page |
|
|
543
|
+
**limit** | **Integer**| Number of sub-accounts to be displayed on each page |
|
|
544
|
+
|
|
545
|
+
### Return type
|
|
546
|
+
|
|
547
|
+
[**SubAccountsResponse**](SubAccountsResponse.md)
|
|
548
|
+
|
|
549
|
+
### Authorization
|
|
550
|
+
|
|
551
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
552
|
+
|
|
553
|
+
### HTTP request headers
|
|
554
|
+
|
|
555
|
+
- **Content-Type**: application/json
|
|
556
|
+
- **Accept**: application/json
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
# **corporate_sub_account_id_applications_toggle_put**
|
|
561
|
+
> corporate_sub_account_id_applications_toggle_put(id, toggle_applications)
|
|
562
|
+
|
|
563
|
+
Enable/disable sub-account application(s)
|
|
564
|
+
|
|
565
|
+
API endpoint for the Corporate owner to enable/disable applications on the sub-account
|
|
566
|
+
|
|
567
|
+
### Example
|
|
568
|
+
```ruby
|
|
569
|
+
# load the gem
|
|
570
|
+
require 'brevo'
|
|
571
|
+
# setup authorization
|
|
572
|
+
Brevo.configure do |config|
|
|
573
|
+
# Configure API key authorization: api-key
|
|
574
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
575
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
576
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
577
|
+
|
|
578
|
+
# Configure API key authorization: partner-key
|
|
579
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
580
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
581
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
582
|
+
end
|
|
583
|
+
|
|
584
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
585
|
+
|
|
586
|
+
id = 789 # Integer | Id of the sub-account organization (mandatory)
|
|
587
|
+
|
|
588
|
+
toggle_applications = Brevo::SubAccountAppsToggleRequest.new # SubAccountAppsToggleRequest | List of applications to activate or deactivate on a sub-account
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
begin
|
|
592
|
+
#Enable/disable sub-account application(s)
|
|
593
|
+
api_instance.corporate_sub_account_id_applications_toggle_put(id, toggle_applications)
|
|
594
|
+
rescue Brevo::ApiError => e
|
|
595
|
+
puts "Exception when calling MasterAccountApi->corporate_sub_account_id_applications_toggle_put: #{e}"
|
|
596
|
+
end
|
|
597
|
+
```
|
|
598
|
+
|
|
599
|
+
### Parameters
|
|
600
|
+
|
|
601
|
+
Name | Type | Description | Notes
|
|
602
|
+
------------- | ------------- | ------------- | -------------
|
|
603
|
+
**id** | **Integer**| Id of the sub-account organization (mandatory) |
|
|
604
|
+
**toggle_applications** | [**SubAccountAppsToggleRequest**](SubAccountAppsToggleRequest.md)| List of applications to activate or deactivate on a sub-account |
|
|
605
|
+
|
|
606
|
+
### Return type
|
|
607
|
+
|
|
608
|
+
nil (empty response body)
|
|
609
|
+
|
|
610
|
+
### Authorization
|
|
611
|
+
|
|
612
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
613
|
+
|
|
614
|
+
### HTTP request headers
|
|
615
|
+
|
|
616
|
+
- **Content-Type**: application/json
|
|
617
|
+
- **Accept**: application/json
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
# **corporate_sub_account_id_delete**
|
|
622
|
+
> corporate_sub_account_id_delete(id)
|
|
623
|
+
|
|
624
|
+
Delete a sub-account
|
|
625
|
+
|
|
626
|
+
### Example
|
|
627
|
+
```ruby
|
|
628
|
+
# load the gem
|
|
629
|
+
require 'brevo'
|
|
630
|
+
# setup authorization
|
|
631
|
+
Brevo.configure do |config|
|
|
632
|
+
# Configure API key authorization: api-key
|
|
633
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
634
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
635
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
636
|
+
|
|
637
|
+
# Configure API key authorization: partner-key
|
|
638
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
639
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
640
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
641
|
+
end
|
|
642
|
+
|
|
643
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
644
|
+
|
|
645
|
+
id = 789 # Integer | Id of the sub-account organization to be deleted
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
begin
|
|
649
|
+
#Delete a sub-account
|
|
650
|
+
api_instance.corporate_sub_account_id_delete(id)
|
|
651
|
+
rescue Brevo::ApiError => e
|
|
652
|
+
puts "Exception when calling MasterAccountApi->corporate_sub_account_id_delete: #{e}"
|
|
653
|
+
end
|
|
654
|
+
```
|
|
655
|
+
|
|
656
|
+
### Parameters
|
|
657
|
+
|
|
658
|
+
Name | Type | Description | Notes
|
|
659
|
+
------------- | ------------- | ------------- | -------------
|
|
660
|
+
**id** | **Integer**| Id of the sub-account organization to be deleted |
|
|
661
|
+
|
|
662
|
+
### Return type
|
|
663
|
+
|
|
664
|
+
nil (empty response body)
|
|
665
|
+
|
|
666
|
+
### Authorization
|
|
667
|
+
|
|
668
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
669
|
+
|
|
670
|
+
### HTTP request headers
|
|
671
|
+
|
|
672
|
+
- **Content-Type**: application/json
|
|
673
|
+
- **Accept**: application/json
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
# **corporate_sub_account_id_get**
|
|
678
|
+
> SubAccountDetailsResponse corporate_sub_account_id_get(id)
|
|
679
|
+
|
|
680
|
+
Get sub-account details
|
|
681
|
+
|
|
682
|
+
This endpoint will provide the details for the specified sub-account company
|
|
683
|
+
|
|
684
|
+
### Example
|
|
685
|
+
```ruby
|
|
686
|
+
# load the gem
|
|
687
|
+
require 'brevo'
|
|
688
|
+
# setup authorization
|
|
689
|
+
Brevo.configure do |config|
|
|
690
|
+
# Configure API key authorization: api-key
|
|
691
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
692
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
693
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
694
|
+
|
|
695
|
+
# Configure API key authorization: partner-key
|
|
696
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
697
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
698
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
699
|
+
end
|
|
700
|
+
|
|
701
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
702
|
+
|
|
703
|
+
id = 789 # Integer | Id of the sub-account organization
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
begin
|
|
707
|
+
#Get sub-account details
|
|
708
|
+
result = api_instance.corporate_sub_account_id_get(id)
|
|
709
|
+
p result
|
|
710
|
+
rescue Brevo::ApiError => e
|
|
711
|
+
puts "Exception when calling MasterAccountApi->corporate_sub_account_id_get: #{e}"
|
|
712
|
+
end
|
|
713
|
+
```
|
|
714
|
+
|
|
715
|
+
### Parameters
|
|
716
|
+
|
|
717
|
+
Name | Type | Description | Notes
|
|
718
|
+
------------- | ------------- | ------------- | -------------
|
|
719
|
+
**id** | **Integer**| Id of the sub-account organization |
|
|
720
|
+
|
|
721
|
+
### Return type
|
|
722
|
+
|
|
723
|
+
[**SubAccountDetailsResponse**](SubAccountDetailsResponse.md)
|
|
724
|
+
|
|
725
|
+
### Authorization
|
|
726
|
+
|
|
727
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
728
|
+
|
|
729
|
+
### HTTP request headers
|
|
730
|
+
|
|
731
|
+
- **Content-Type**: application/json
|
|
732
|
+
- **Accept**: application/json
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
# **corporate_sub_account_id_plan_put**
|
|
737
|
+
> corporate_sub_account_id_plan_put(id, update_plan_details)
|
|
738
|
+
|
|
739
|
+
Update sub-account plan
|
|
740
|
+
|
|
741
|
+
This endpoint will update the sub-account plan. On the Corporate solution new version v2, you can set an unlimited number of credits in your sub-organization. Please pass the value “-1\" to set the consumable in unlimited mode.
|
|
742
|
+
|
|
743
|
+
### Example
|
|
744
|
+
```ruby
|
|
745
|
+
# load the gem
|
|
746
|
+
require 'brevo'
|
|
747
|
+
# setup authorization
|
|
748
|
+
Brevo.configure do |config|
|
|
749
|
+
# Configure API key authorization: api-key
|
|
750
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
751
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
752
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
753
|
+
|
|
754
|
+
# Configure API key authorization: partner-key
|
|
755
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
756
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
757
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
758
|
+
end
|
|
759
|
+
|
|
760
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
761
|
+
|
|
762
|
+
id = 789 # Integer | Id of the sub-account organization
|
|
763
|
+
|
|
764
|
+
update_plan_details = Brevo::SubAccountUpdatePlanRequest.new # SubAccountUpdatePlanRequest | Values to update a sub-account plan
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
begin
|
|
768
|
+
#Update sub-account plan
|
|
769
|
+
api_instance.corporate_sub_account_id_plan_put(id, update_plan_details)
|
|
770
|
+
rescue Brevo::ApiError => e
|
|
771
|
+
puts "Exception when calling MasterAccountApi->corporate_sub_account_id_plan_put: #{e}"
|
|
772
|
+
end
|
|
773
|
+
```
|
|
774
|
+
|
|
775
|
+
### Parameters
|
|
776
|
+
|
|
777
|
+
Name | Type | Description | Notes
|
|
778
|
+
------------- | ------------- | ------------- | -------------
|
|
779
|
+
**id** | **Integer**| Id of the sub-account organization |
|
|
780
|
+
**update_plan_details** | [**SubAccountUpdatePlanRequest**](SubAccountUpdatePlanRequest.md)| Values to update a sub-account plan |
|
|
781
|
+
|
|
782
|
+
### Return type
|
|
783
|
+
|
|
784
|
+
nil (empty response body)
|
|
785
|
+
|
|
786
|
+
### Authorization
|
|
787
|
+
|
|
788
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
789
|
+
|
|
790
|
+
### HTTP request headers
|
|
791
|
+
|
|
792
|
+
- **Content-Type**: application/json
|
|
793
|
+
- **Accept**: application/json
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
# **corporate_sub_account_ip_associate_post**
|
|
798
|
+
> Object corporate_sub_account_ip_associate_post(body)
|
|
799
|
+
|
|
800
|
+
Associate an IP to sub-accounts
|
|
801
|
+
|
|
802
|
+
This endpoint allows to associate an IP to sub-accounts
|
|
803
|
+
|
|
804
|
+
### Example
|
|
805
|
+
```ruby
|
|
806
|
+
# load the gem
|
|
807
|
+
require 'brevo'
|
|
808
|
+
# setup authorization
|
|
809
|
+
Brevo.configure do |config|
|
|
810
|
+
# Configure API key authorization: api-key
|
|
811
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
812
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
813
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
814
|
+
|
|
815
|
+
# Configure API key authorization: partner-key
|
|
816
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
817
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
818
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
819
|
+
end
|
|
820
|
+
|
|
821
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
822
|
+
|
|
823
|
+
body = Brevo::Body1.new # Body1 | Ip address association details
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
begin
|
|
827
|
+
#Associate an IP to sub-accounts
|
|
828
|
+
result = api_instance.corporate_sub_account_ip_associate_post(body)
|
|
829
|
+
p result
|
|
830
|
+
rescue Brevo::ApiError => e
|
|
831
|
+
puts "Exception when calling MasterAccountApi->corporate_sub_account_ip_associate_post: #{e}"
|
|
832
|
+
end
|
|
833
|
+
```
|
|
834
|
+
|
|
835
|
+
### Parameters
|
|
836
|
+
|
|
837
|
+
Name | Type | Description | Notes
|
|
838
|
+
------------- | ------------- | ------------- | -------------
|
|
839
|
+
**body** | [**Body1**](Body1.md)| Ip address association details |
|
|
840
|
+
|
|
841
|
+
### Return type
|
|
842
|
+
|
|
843
|
+
**Object**
|
|
844
|
+
|
|
845
|
+
### Authorization
|
|
846
|
+
|
|
847
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
848
|
+
|
|
849
|
+
### HTTP request headers
|
|
850
|
+
|
|
851
|
+
- **Content-Type**: application/json
|
|
852
|
+
- **Accept**: application/json
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
# **corporate_sub_account_ip_dissociate_put**
|
|
857
|
+
> corporate_sub_account_ip_dissociate_put(body)
|
|
858
|
+
|
|
859
|
+
Dissociate an IP from sub-accounts
|
|
860
|
+
|
|
861
|
+
This endpoint allows to dissociate an IP from sub-accounts
|
|
862
|
+
|
|
863
|
+
### Example
|
|
864
|
+
```ruby
|
|
865
|
+
# load the gem
|
|
866
|
+
require 'brevo'
|
|
867
|
+
# setup authorization
|
|
868
|
+
Brevo.configure do |config|
|
|
869
|
+
# Configure API key authorization: api-key
|
|
870
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
871
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
872
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
873
|
+
|
|
874
|
+
# Configure API key authorization: partner-key
|
|
875
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
876
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
877
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
878
|
+
end
|
|
879
|
+
|
|
880
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
881
|
+
|
|
882
|
+
body = Brevo::Body2.new # Body2 | Ip address dissociation details
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
begin
|
|
886
|
+
#Dissociate an IP from sub-accounts
|
|
887
|
+
api_instance.corporate_sub_account_ip_dissociate_put(body)
|
|
888
|
+
rescue Brevo::ApiError => e
|
|
889
|
+
puts "Exception when calling MasterAccountApi->corporate_sub_account_ip_dissociate_put: #{e}"
|
|
890
|
+
end
|
|
891
|
+
```
|
|
892
|
+
|
|
893
|
+
### Parameters
|
|
894
|
+
|
|
895
|
+
Name | Type | Description | Notes
|
|
896
|
+
------------- | ------------- | ------------- | -------------
|
|
897
|
+
**body** | [**Body2**](Body2.md)| Ip address dissociation details |
|
|
898
|
+
|
|
899
|
+
### Return type
|
|
900
|
+
|
|
901
|
+
nil (empty response body)
|
|
902
|
+
|
|
903
|
+
### Authorization
|
|
904
|
+
|
|
905
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
906
|
+
|
|
907
|
+
### HTTP request headers
|
|
908
|
+
|
|
909
|
+
- **Content-Type**: application/json
|
|
910
|
+
- **Accept**: application/json
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
# **corporate_sub_account_key_post**
|
|
915
|
+
> CreateApiKeyResponse corporate_sub_account_key_post(create_api_key_request)
|
|
916
|
+
|
|
917
|
+
Create an API key for a sub-account
|
|
23
918
|
|
|
24
|
-
This endpoint will
|
|
919
|
+
This endpoint will generate an API v3 key for a sub account
|
|
25
920
|
|
|
26
921
|
### Example
|
|
27
922
|
```ruby
|
|
@@ -42,21 +937,27 @@ end
|
|
|
42
937
|
|
|
43
938
|
api_instance = Brevo::MasterAccountApi.new
|
|
44
939
|
|
|
940
|
+
create_api_key_request = Brevo::CreateApiKeyRequest.new # CreateApiKeyRequest | Values to generate API key for sub-account
|
|
941
|
+
|
|
942
|
+
|
|
45
943
|
begin
|
|
46
|
-
#
|
|
47
|
-
result = api_instance.
|
|
944
|
+
#Create an API key for a sub-account
|
|
945
|
+
result = api_instance.corporate_sub_account_key_post(create_api_key_request)
|
|
48
946
|
p result
|
|
49
947
|
rescue Brevo::ApiError => e
|
|
50
|
-
puts "Exception when calling MasterAccountApi->
|
|
948
|
+
puts "Exception when calling MasterAccountApi->corporate_sub_account_key_post: #{e}"
|
|
51
949
|
end
|
|
52
950
|
```
|
|
53
951
|
|
|
54
952
|
### Parameters
|
|
55
|
-
|
|
953
|
+
|
|
954
|
+
Name | Type | Description | Notes
|
|
955
|
+
------------- | ------------- | ------------- | -------------
|
|
956
|
+
**create_api_key_request** | [**CreateApiKeyRequest**](CreateApiKeyRequest.md)| Values to generate API key for sub-account |
|
|
56
957
|
|
|
57
958
|
### Return type
|
|
58
959
|
|
|
59
|
-
[**
|
|
960
|
+
[**CreateApiKeyResponse**](CreateApiKeyResponse.md)
|
|
60
961
|
|
|
61
962
|
### Authorization
|
|
62
963
|
|
|
@@ -69,12 +970,12 @@ This endpoint does not need any parameter.
|
|
|
69
970
|
|
|
70
971
|
|
|
71
972
|
|
|
72
|
-
# **
|
|
73
|
-
>
|
|
973
|
+
# **corporate_sub_account_post**
|
|
974
|
+
> CreateSubAccountResponse corporate_sub_account_post(sub_account_create)
|
|
74
975
|
|
|
75
|
-
|
|
976
|
+
Create a new sub-account under a master account.
|
|
76
977
|
|
|
77
|
-
This endpoint will
|
|
978
|
+
This endpoint will create a new sub-account under a master account
|
|
78
979
|
|
|
79
980
|
### Example
|
|
80
981
|
```ruby
|
|
@@ -95,17 +996,15 @@ end
|
|
|
95
996
|
|
|
96
997
|
api_instance = Brevo::MasterAccountApi.new
|
|
97
998
|
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
limit = 56 # Integer | Number of sub-accounts to be displayed on each page
|
|
999
|
+
sub_account_create = Brevo::CreateSubAccount.new # CreateSubAccount | values to create new sub-account
|
|
101
1000
|
|
|
102
1001
|
|
|
103
1002
|
begin
|
|
104
|
-
#
|
|
105
|
-
result = api_instance.
|
|
1003
|
+
#Create a new sub-account under a master account.
|
|
1004
|
+
result = api_instance.corporate_sub_account_post(sub_account_create)
|
|
106
1005
|
p result
|
|
107
1006
|
rescue Brevo::ApiError => e
|
|
108
|
-
puts "Exception when calling MasterAccountApi->
|
|
1007
|
+
puts "Exception when calling MasterAccountApi->corporate_sub_account_post: #{e}"
|
|
109
1008
|
end
|
|
110
1009
|
```
|
|
111
1010
|
|
|
@@ -113,12 +1012,11 @@ end
|
|
|
113
1012
|
|
|
114
1013
|
Name | Type | Description | Notes
|
|
115
1014
|
------------- | ------------- | ------------- | -------------
|
|
116
|
-
**
|
|
117
|
-
**limit** | **Integer**| Number of sub-accounts to be displayed on each page |
|
|
1015
|
+
**sub_account_create** | [**CreateSubAccount**](CreateSubAccount.md)| values to create new sub-account |
|
|
118
1016
|
|
|
119
1017
|
### Return type
|
|
120
1018
|
|
|
121
|
-
[**
|
|
1019
|
+
[**CreateSubAccountResponse**](CreateSubAccountResponse.md)
|
|
122
1020
|
|
|
123
1021
|
### Authorization
|
|
124
1022
|
|
|
@@ -131,12 +1029,12 @@ Name | Type | Description | Notes
|
|
|
131
1029
|
|
|
132
1030
|
|
|
133
1031
|
|
|
134
|
-
# **
|
|
135
|
-
>
|
|
1032
|
+
# **corporate_sub_account_sso_token_post**
|
|
1033
|
+
> GetSsoToken corporate_sub_account_sso_token_post(sso_token_request)
|
|
136
1034
|
|
|
137
|
-
|
|
1035
|
+
Generate SSO token to access sub-account
|
|
138
1036
|
|
|
139
|
-
|
|
1037
|
+
This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.brevo.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.
|
|
140
1038
|
|
|
141
1039
|
### Example
|
|
142
1040
|
```ruby
|
|
@@ -157,16 +1055,15 @@ end
|
|
|
157
1055
|
|
|
158
1056
|
api_instance = Brevo::MasterAccountApi.new
|
|
159
1057
|
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
toggle_applications = Brevo::SubAccountAppsToggleRequest.new # SubAccountAppsToggleRequest | List of applications to activate or deactivate on a sub-account
|
|
1058
|
+
sso_token_request = Brevo::SsoTokenRequest.new # SsoTokenRequest | Values to generate SSO token for sub-account
|
|
163
1059
|
|
|
164
1060
|
|
|
165
1061
|
begin
|
|
166
|
-
#
|
|
167
|
-
api_instance.
|
|
1062
|
+
#Generate SSO token to access sub-account
|
|
1063
|
+
result = api_instance.corporate_sub_account_sso_token_post(sso_token_request)
|
|
1064
|
+
p result
|
|
168
1065
|
rescue Brevo::ApiError => e
|
|
169
|
-
puts "Exception when calling MasterAccountApi->
|
|
1066
|
+
puts "Exception when calling MasterAccountApi->corporate_sub_account_sso_token_post: #{e}"
|
|
170
1067
|
end
|
|
171
1068
|
```
|
|
172
1069
|
|
|
@@ -174,12 +1071,11 @@ end
|
|
|
174
1071
|
|
|
175
1072
|
Name | Type | Description | Notes
|
|
176
1073
|
------------- | ------------- | ------------- | -------------
|
|
177
|
-
**
|
|
178
|
-
**toggle_applications** | [**SubAccountAppsToggleRequest**](SubAccountAppsToggleRequest.md)| List of applications to activate or deactivate on a sub-account |
|
|
1074
|
+
**sso_token_request** | [**SsoTokenRequest**](SsoTokenRequest.md)| Values to generate SSO token for sub-account |
|
|
179
1075
|
|
|
180
1076
|
### Return type
|
|
181
1077
|
|
|
182
|
-
|
|
1078
|
+
[**GetSsoToken**](GetSsoToken.md)
|
|
183
1079
|
|
|
184
1080
|
### Authorization
|
|
185
1081
|
|
|
@@ -192,10 +1088,12 @@ nil (empty response body)
|
|
|
192
1088
|
|
|
193
1089
|
|
|
194
1090
|
|
|
195
|
-
# **
|
|
196
|
-
>
|
|
1091
|
+
# **corporate_sub_accounts_plan_put**
|
|
1092
|
+
> corporate_sub_accounts_plan_put(update_plan_details)
|
|
197
1093
|
|
|
198
|
-
|
|
1094
|
+
Update sub-accounts plan
|
|
1095
|
+
|
|
1096
|
+
This endpoint will update multiple sub-accounts plan. On the Corporate solution new version v2, you can set an unlimited number of credits in your sub-organization. Please pass the value “-1\" to set the consumable in unlimited mode.
|
|
199
1097
|
|
|
200
1098
|
### Example
|
|
201
1099
|
```ruby
|
|
@@ -216,14 +1114,14 @@ end
|
|
|
216
1114
|
|
|
217
1115
|
api_instance = Brevo::MasterAccountApi.new
|
|
218
1116
|
|
|
219
|
-
|
|
1117
|
+
update_plan_details = Brevo::SubAccountsUpdatePlanRequest.new # SubAccountsUpdatePlanRequest | Values to update sub-accounts plan
|
|
220
1118
|
|
|
221
1119
|
|
|
222
1120
|
begin
|
|
223
|
-
#
|
|
224
|
-
api_instance.
|
|
1121
|
+
#Update sub-accounts plan
|
|
1122
|
+
api_instance.corporate_sub_accounts_plan_put(update_plan_details)
|
|
225
1123
|
rescue Brevo::ApiError => e
|
|
226
|
-
puts "Exception when calling MasterAccountApi->
|
|
1124
|
+
puts "Exception when calling MasterAccountApi->corporate_sub_accounts_plan_put: #{e}"
|
|
227
1125
|
end
|
|
228
1126
|
```
|
|
229
1127
|
|
|
@@ -231,7 +1129,7 @@ end
|
|
|
231
1129
|
|
|
232
1130
|
Name | Type | Description | Notes
|
|
233
1131
|
------------- | ------------- | ------------- | -------------
|
|
234
|
-
**
|
|
1132
|
+
**update_plan_details** | [**SubAccountsUpdatePlanRequest**](SubAccountsUpdatePlanRequest.md)| Values to update sub-accounts plan |
|
|
235
1133
|
|
|
236
1134
|
### Return type
|
|
237
1135
|
|
|
@@ -248,12 +1146,12 @@ nil (empty response body)
|
|
|
248
1146
|
|
|
249
1147
|
|
|
250
1148
|
|
|
251
|
-
# **
|
|
252
|
-
>
|
|
1149
|
+
# **corporate_user_email_permissions_put**
|
|
1150
|
+
> corporate_user_email_permissions_put(email, body)
|
|
253
1151
|
|
|
254
|
-
|
|
1152
|
+
Change admin user permissions
|
|
255
1153
|
|
|
256
|
-
This endpoint will
|
|
1154
|
+
This endpoint will allow you to change the permissions of Admin users of your Admin account
|
|
257
1155
|
|
|
258
1156
|
### Example
|
|
259
1157
|
```ruby
|
|
@@ -274,15 +1172,16 @@ end
|
|
|
274
1172
|
|
|
275
1173
|
api_instance = Brevo::MasterAccountApi.new
|
|
276
1174
|
|
|
277
|
-
|
|
1175
|
+
email = 'email_example' # String | Email address of Admin user
|
|
1176
|
+
|
|
1177
|
+
body = Brevo::Body5.new # Body5 | Values to update an admin user permissions
|
|
278
1178
|
|
|
279
1179
|
|
|
280
1180
|
begin
|
|
281
|
-
#
|
|
282
|
-
|
|
283
|
-
p result
|
|
1181
|
+
#Change admin user permissions
|
|
1182
|
+
api_instance.corporate_user_email_permissions_put(email, body)
|
|
284
1183
|
rescue Brevo::ApiError => e
|
|
285
|
-
puts "Exception when calling MasterAccountApi->
|
|
1184
|
+
puts "Exception when calling MasterAccountApi->corporate_user_email_permissions_put: #{e}"
|
|
286
1185
|
end
|
|
287
1186
|
```
|
|
288
1187
|
|
|
@@ -290,11 +1189,12 @@ end
|
|
|
290
1189
|
|
|
291
1190
|
Name | Type | Description | Notes
|
|
292
1191
|
------------- | ------------- | ------------- | -------------
|
|
293
|
-
**
|
|
1192
|
+
**email** | **String**| Email address of Admin user |
|
|
1193
|
+
**body** | [**Body5**](Body5.md)| Values to update an admin user permissions |
|
|
294
1194
|
|
|
295
1195
|
### Return type
|
|
296
1196
|
|
|
297
|
-
|
|
1197
|
+
nil (empty response body)
|
|
298
1198
|
|
|
299
1199
|
### Authorization
|
|
300
1200
|
|
|
@@ -307,12 +1207,12 @@ Name | Type | Description | Notes
|
|
|
307
1207
|
|
|
308
1208
|
|
|
309
1209
|
|
|
310
|
-
# **
|
|
311
|
-
>
|
|
1210
|
+
# **corporate_user_invitation_action_email_put**
|
|
1211
|
+
> InlineResponse200 corporate_user_invitation_action_email_put(action, email)
|
|
312
1212
|
|
|
313
|
-
|
|
1213
|
+
Resend / cancel admin user invitation
|
|
314
1214
|
|
|
315
|
-
This endpoint will
|
|
1215
|
+
This endpoint will allow the user to: - Resend an admin user invitation - Cancel an admin user invitation
|
|
316
1216
|
|
|
317
1217
|
### Example
|
|
318
1218
|
```ruby
|
|
@@ -333,16 +1233,17 @@ end
|
|
|
333
1233
|
|
|
334
1234
|
api_instance = Brevo::MasterAccountApi.new
|
|
335
1235
|
|
|
336
|
-
|
|
1236
|
+
action = 'action_example' # String | Action to be performed (cancel / resend)
|
|
337
1237
|
|
|
338
|
-
|
|
1238
|
+
email = 'email_example' # String | Email address of the recipient
|
|
339
1239
|
|
|
340
1240
|
|
|
341
1241
|
begin
|
|
342
|
-
#
|
|
343
|
-
api_instance.
|
|
1242
|
+
#Resend / cancel admin user invitation
|
|
1243
|
+
result = api_instance.corporate_user_invitation_action_email_put(action, email)
|
|
1244
|
+
p result
|
|
344
1245
|
rescue Brevo::ApiError => e
|
|
345
|
-
puts "Exception when calling MasterAccountApi->
|
|
1246
|
+
puts "Exception when calling MasterAccountApi->corporate_user_invitation_action_email_put: #{e}"
|
|
346
1247
|
end
|
|
347
1248
|
```
|
|
348
1249
|
|
|
@@ -350,12 +1251,12 @@ end
|
|
|
350
1251
|
|
|
351
1252
|
Name | Type | Description | Notes
|
|
352
1253
|
------------- | ------------- | ------------- | -------------
|
|
353
|
-
**
|
|
354
|
-
**
|
|
1254
|
+
**action** | **String**| Action to be performed (cancel / resend) |
|
|
1255
|
+
**email** | **String**| Email address of the recipient |
|
|
355
1256
|
|
|
356
1257
|
### Return type
|
|
357
1258
|
|
|
358
|
-
|
|
1259
|
+
[**InlineResponse200**](InlineResponse200.md)
|
|
359
1260
|
|
|
360
1261
|
### Authorization
|
|
361
1262
|
|
|
@@ -368,12 +1269,12 @@ nil (empty response body)
|
|
|
368
1269
|
|
|
369
1270
|
|
|
370
1271
|
|
|
371
|
-
# **
|
|
372
|
-
>
|
|
1272
|
+
# **corporate_user_revoke_email_delete**
|
|
1273
|
+
> corporate_user_revoke_email_delete(email)
|
|
373
1274
|
|
|
374
|
-
|
|
1275
|
+
Revoke an admin user
|
|
375
1276
|
|
|
376
|
-
This endpoint
|
|
1277
|
+
This endpoint allows to revoke/remove an invited member of your Admin account
|
|
377
1278
|
|
|
378
1279
|
### Example
|
|
379
1280
|
```ruby
|
|
@@ -394,15 +1295,14 @@ end
|
|
|
394
1295
|
|
|
395
1296
|
api_instance = Brevo::MasterAccountApi.new
|
|
396
1297
|
|
|
397
|
-
|
|
1298
|
+
email = 'email_example' # String | Email of the invited user
|
|
398
1299
|
|
|
399
1300
|
|
|
400
1301
|
begin
|
|
401
|
-
#
|
|
402
|
-
|
|
403
|
-
p result
|
|
1302
|
+
#Revoke an admin user
|
|
1303
|
+
api_instance.corporate_user_revoke_email_delete(email)
|
|
404
1304
|
rescue Brevo::ApiError => e
|
|
405
|
-
puts "Exception when calling MasterAccountApi->
|
|
1305
|
+
puts "Exception when calling MasterAccountApi->corporate_user_revoke_email_delete: #{e}"
|
|
406
1306
|
end
|
|
407
1307
|
```
|
|
408
1308
|
|
|
@@ -410,11 +1310,11 @@ end
|
|
|
410
1310
|
|
|
411
1311
|
Name | Type | Description | Notes
|
|
412
1312
|
------------- | ------------- | ------------- | -------------
|
|
413
|
-
**
|
|
1313
|
+
**email** | **String**| Email of the invited user |
|
|
414
1314
|
|
|
415
1315
|
### Return type
|
|
416
1316
|
|
|
417
|
-
|
|
1317
|
+
nil (empty response body)
|
|
418
1318
|
|
|
419
1319
|
### Authorization
|
|
420
1320
|
|
|
@@ -427,12 +1327,10 @@ Name | Type | Description | Notes
|
|
|
427
1327
|
|
|
428
1328
|
|
|
429
1329
|
|
|
430
|
-
# **
|
|
431
|
-
>
|
|
432
|
-
|
|
433
|
-
Create a new sub-account under a master account.
|
|
1330
|
+
# **get_account_activity**
|
|
1331
|
+
> GetAccountActivity get_account_activity(opts)
|
|
434
1332
|
|
|
435
|
-
|
|
1333
|
+
Get user activity logs
|
|
436
1334
|
|
|
437
1335
|
### Example
|
|
438
1336
|
```ruby
|
|
@@ -453,15 +1351,20 @@ end
|
|
|
453
1351
|
|
|
454
1352
|
api_instance = Brevo::MasterAccountApi.new
|
|
455
1353
|
|
|
456
|
-
|
|
457
|
-
|
|
1354
|
+
opts = {
|
|
1355
|
+
start_date: 'start_date_example', # String | Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search.
|
|
1356
|
+
end_date: 'end_date_example', # String | Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month.
|
|
1357
|
+
email: 'email_example', # String | Enter the user's email address to filter their activity in the account.
|
|
1358
|
+
limit: 10, # Integer | Number of documents per page
|
|
1359
|
+
offset: 0 # Integer | Index of the first document in the page.
|
|
1360
|
+
}
|
|
458
1361
|
|
|
459
1362
|
begin
|
|
460
|
-
#
|
|
461
|
-
result = api_instance.
|
|
1363
|
+
#Get user activity logs
|
|
1364
|
+
result = api_instance.get_account_activity(opts)
|
|
462
1365
|
p result
|
|
463
1366
|
rescue Brevo::ApiError => e
|
|
464
|
-
puts "Exception when calling MasterAccountApi->
|
|
1367
|
+
puts "Exception when calling MasterAccountApi->get_account_activity: #{e}"
|
|
465
1368
|
end
|
|
466
1369
|
```
|
|
467
1370
|
|
|
@@ -469,11 +1372,15 @@ end
|
|
|
469
1372
|
|
|
470
1373
|
Name | Type | Description | Notes
|
|
471
1374
|
------------- | ------------- | ------------- | -------------
|
|
472
|
-
**
|
|
1375
|
+
**start_date** | **String**| Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. | [optional]
|
|
1376
|
+
**end_date** | **String**| Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. | [optional]
|
|
1377
|
+
**email** | **String**| Enter the user's email address to filter their activity in the account. | [optional]
|
|
1378
|
+
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
|
1379
|
+
**offset** | **Integer**| Index of the first document in the page. | [optional] [default to 0]
|
|
473
1380
|
|
|
474
1381
|
### Return type
|
|
475
1382
|
|
|
476
|
-
[**
|
|
1383
|
+
[**GetAccountActivity**](GetAccountActivity.md)
|
|
477
1384
|
|
|
478
1385
|
### Authorization
|
|
479
1386
|
|
|
@@ -486,12 +1393,12 @@ Name | Type | Description | Notes
|
|
|
486
1393
|
|
|
487
1394
|
|
|
488
1395
|
|
|
489
|
-
# **
|
|
490
|
-
>
|
|
1396
|
+
# **get_corporate_invited_users_list**
|
|
1397
|
+
> GetCorporateInvitedUsersList get_corporate_invited_users_list
|
|
491
1398
|
|
|
492
|
-
|
|
1399
|
+
Get the list of all admin users
|
|
493
1400
|
|
|
494
|
-
This endpoint
|
|
1401
|
+
This endpoint allows you to list all Admin users of your Admin account
|
|
495
1402
|
|
|
496
1403
|
### Example
|
|
497
1404
|
```ruby
|
|
@@ -512,15 +1419,68 @@ end
|
|
|
512
1419
|
|
|
513
1420
|
api_instance = Brevo::MasterAccountApi.new
|
|
514
1421
|
|
|
515
|
-
|
|
1422
|
+
begin
|
|
1423
|
+
#Get the list of all admin users
|
|
1424
|
+
result = api_instance.get_corporate_invited_users_list
|
|
1425
|
+
p result
|
|
1426
|
+
rescue Brevo::ApiError => e
|
|
1427
|
+
puts "Exception when calling MasterAccountApi->get_corporate_invited_users_list: #{e}"
|
|
1428
|
+
end
|
|
1429
|
+
```
|
|
1430
|
+
|
|
1431
|
+
### Parameters
|
|
1432
|
+
This endpoint does not need any parameter.
|
|
1433
|
+
|
|
1434
|
+
### Return type
|
|
1435
|
+
|
|
1436
|
+
[**GetCorporateInvitedUsersList**](GetCorporateInvitedUsersList.md)
|
|
1437
|
+
|
|
1438
|
+
### Authorization
|
|
1439
|
+
|
|
1440
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1441
|
+
|
|
1442
|
+
### HTTP request headers
|
|
1443
|
+
|
|
1444
|
+
- **Content-Type**: application/json
|
|
1445
|
+
- **Accept**: application/json
|
|
1446
|
+
|
|
1447
|
+
|
|
1448
|
+
|
|
1449
|
+
# **get_corporate_user_permission**
|
|
1450
|
+
> GetCorporateUserPermission get_corporate_user_permission(email)
|
|
1451
|
+
|
|
1452
|
+
Check admin user permissions
|
|
1453
|
+
|
|
1454
|
+
This endpoint will provide the list of admin user permissions
|
|
1455
|
+
|
|
1456
|
+
### Example
|
|
1457
|
+
```ruby
|
|
1458
|
+
# load the gem
|
|
1459
|
+
require 'brevo'
|
|
1460
|
+
# setup authorization
|
|
1461
|
+
Brevo.configure do |config|
|
|
1462
|
+
# Configure API key authorization: api-key
|
|
1463
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1464
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1465
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1466
|
+
|
|
1467
|
+
# Configure API key authorization: partner-key
|
|
1468
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1469
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1470
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1471
|
+
end
|
|
1472
|
+
|
|
1473
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
1474
|
+
|
|
1475
|
+
email = 'email_example' # String | Email of the invited user
|
|
516
1476
|
|
|
517
1477
|
|
|
518
1478
|
begin
|
|
519
|
-
#
|
|
520
|
-
result = api_instance.
|
|
1479
|
+
#Check admin user permissions
|
|
1480
|
+
result = api_instance.get_corporate_user_permission(email)
|
|
521
1481
|
p result
|
|
522
1482
|
rescue Brevo::ApiError => e
|
|
523
|
-
puts "Exception when calling MasterAccountApi->
|
|
1483
|
+
puts "Exception when calling MasterAccountApi->get_corporate_user_permission: #{e}"
|
|
524
1484
|
end
|
|
525
1485
|
```
|
|
526
1486
|
|
|
@@ -528,11 +1488,11 @@ end
|
|
|
528
1488
|
|
|
529
1489
|
Name | Type | Description | Notes
|
|
530
1490
|
------------- | ------------- | ------------- | -------------
|
|
531
|
-
**
|
|
1491
|
+
**email** | **String**| Email of the invited user |
|
|
532
1492
|
|
|
533
1493
|
### Return type
|
|
534
1494
|
|
|
535
|
-
[**
|
|
1495
|
+
[**GetCorporateUserPermission**](GetCorporateUserPermission.md)
|
|
536
1496
|
|
|
537
1497
|
### Authorization
|
|
538
1498
|
|
|
@@ -545,10 +1505,12 @@ Name | Type | Description | Notes
|
|
|
545
1505
|
|
|
546
1506
|
|
|
547
1507
|
|
|
548
|
-
# **
|
|
549
|
-
>
|
|
1508
|
+
# **get_sub_account_groups**
|
|
1509
|
+
> Array<InlineResponse2001> get_sub_account_groups
|
|
550
1510
|
|
|
551
|
-
Get
|
|
1511
|
+
Get the list of groups
|
|
1512
|
+
|
|
1513
|
+
This endpoint allows you to list all groups created on your Admin account.
|
|
552
1514
|
|
|
553
1515
|
### Example
|
|
554
1516
|
```ruby
|
|
@@ -569,19 +1531,68 @@ end
|
|
|
569
1531
|
|
|
570
1532
|
api_instance = Brevo::MasterAccountApi.new
|
|
571
1533
|
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
}
|
|
1534
|
+
begin
|
|
1535
|
+
#Get the list of groups
|
|
1536
|
+
result = api_instance.get_sub_account_groups
|
|
1537
|
+
p result
|
|
1538
|
+
rescue Brevo::ApiError => e
|
|
1539
|
+
puts "Exception when calling MasterAccountApi->get_sub_account_groups: #{e}"
|
|
1540
|
+
end
|
|
1541
|
+
```
|
|
1542
|
+
|
|
1543
|
+
### Parameters
|
|
1544
|
+
This endpoint does not need any parameter.
|
|
1545
|
+
|
|
1546
|
+
### Return type
|
|
1547
|
+
|
|
1548
|
+
[**Array<InlineResponse2001>**](InlineResponse2001.md)
|
|
1549
|
+
|
|
1550
|
+
### Authorization
|
|
1551
|
+
|
|
1552
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1553
|
+
|
|
1554
|
+
### HTTP request headers
|
|
1555
|
+
|
|
1556
|
+
- **Content-Type**: application/json
|
|
1557
|
+
- **Accept**: application/json
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
|
|
1561
|
+
# **invite_admin_user**
|
|
1562
|
+
> InviteAdminUser invite_admin_user(send_invitation)
|
|
1563
|
+
|
|
1564
|
+
Send invitation to an admin user
|
|
1565
|
+
|
|
1566
|
+
`This endpoint allows you to invite a member to manage the Admin account Features and their respective permissions are as below: - `my_plan`: - \"all\" - `api`: - \"none\" - `user_management`: - \"all\" - `app_management` | Not available in ENTv2: - \"all\" - `sub_organization_groups` - \"create\" - \"edit_delete\" - `create_sub_organizations` - \"all\" - `manage_sub_organizations` - \"all\" - `analytics` - \"download_data\" - \"create_alerts\" - \"my_looks\" - \"explore_create\" - `security` - \"all\" **Note**: - If `all_features_access: false` then only privileges are required otherwise if `true` then it's assumed that all permissions will be there for the invited admin user.
|
|
1567
|
+
|
|
1568
|
+
### Example
|
|
1569
|
+
```ruby
|
|
1570
|
+
# load the gem
|
|
1571
|
+
require 'brevo'
|
|
1572
|
+
# setup authorization
|
|
1573
|
+
Brevo.configure do |config|
|
|
1574
|
+
# Configure API key authorization: api-key
|
|
1575
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1576
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1577
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1578
|
+
|
|
1579
|
+
# Configure API key authorization: partner-key
|
|
1580
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1581
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1582
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1583
|
+
end
|
|
1584
|
+
|
|
1585
|
+
api_instance = Brevo::MasterAccountApi.new
|
|
1586
|
+
|
|
1587
|
+
send_invitation = Brevo::InviteAdminUser.new # InviteAdminUser | Payload to send an invitation
|
|
1588
|
+
|
|
578
1589
|
|
|
579
1590
|
begin
|
|
580
|
-
#
|
|
581
|
-
result = api_instance.
|
|
1591
|
+
#Send invitation to an admin user
|
|
1592
|
+
result = api_instance.invite_admin_user(send_invitation)
|
|
582
1593
|
p result
|
|
583
1594
|
rescue Brevo::ApiError => e
|
|
584
|
-
puts "Exception when calling MasterAccountApi->
|
|
1595
|
+
puts "Exception when calling MasterAccountApi->invite_admin_user: #{e}"
|
|
585
1596
|
end
|
|
586
1597
|
```
|
|
587
1598
|
|
|
@@ -589,14 +1600,11 @@ end
|
|
|
589
1600
|
|
|
590
1601
|
Name | Type | Description | Notes
|
|
591
1602
|
------------- | ------------- | ------------- | -------------
|
|
592
|
-
**
|
|
593
|
-
**end_date** | **String**| Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. | [optional]
|
|
594
|
-
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
|
595
|
-
**offset** | **Integer**| Index of the first document in the page. | [optional] [default to 0]
|
|
1603
|
+
**send_invitation** | [**InviteAdminUser**](InviteAdminUser.md)| Payload to send an invitation |
|
|
596
1604
|
|
|
597
1605
|
### Return type
|
|
598
1606
|
|
|
599
|
-
[**
|
|
1607
|
+
[**InviteAdminUser**](InviteAdminUser.md)
|
|
600
1608
|
|
|
601
1609
|
### Authorization
|
|
602
1610
|
|