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
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Brevo API
|
|
3
3
|
|
|
4
|
-
#Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
4
|
+
#Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
|
|
5
5
|
|
|
6
6
|
OpenAPI spec version: 3.0.0
|
|
7
7
|
Contact: contact@brevo.com
|
|
@@ -19,7 +19,7 @@ module Brevo
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
-
|
|
22
|
+
|
|
23
23
|
# Set custom user_agent if explicitly passed in api
|
|
24
24
|
# default will still remain Swagger-Codegen/#{VERSION}/ruby
|
|
25
25
|
def setUserAgent(user_agent)
|
|
@@ -28,26 +28,32 @@ module Brevo
|
|
|
28
28
|
@api_client.default_headers['User-Agent'] = @user_agent
|
|
29
29
|
end
|
|
30
30
|
end
|
|
31
|
-
|
|
32
|
-
#
|
|
33
|
-
# This endpoint
|
|
31
|
+
|
|
32
|
+
# Delete a group
|
|
33
|
+
# 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.
|
|
34
|
+
# @param id Id of the group
|
|
34
35
|
# @param [Hash] opts the optional parameters
|
|
35
|
-
# @return [
|
|
36
|
-
def
|
|
37
|
-
|
|
38
|
-
|
|
36
|
+
# @return [nil]
|
|
37
|
+
def corporate_group_id_delete(id, opts = {})
|
|
38
|
+
corporate_group_id_delete_with_http_info(id, opts)
|
|
39
|
+
nil
|
|
39
40
|
end
|
|
40
41
|
|
|
41
|
-
#
|
|
42
|
-
# This endpoint
|
|
42
|
+
# Delete a group
|
|
43
|
+
# 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.
|
|
44
|
+
# @param id Id of the group
|
|
43
45
|
# @param [Hash] opts the optional parameters
|
|
44
|
-
# @return [Array<(
|
|
45
|
-
def
|
|
46
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
47
|
+
def corporate_group_id_delete_with_http_info(id, opts = {})
|
|
46
48
|
if @api_client.config.debugging
|
|
47
|
-
@api_client.config.logger.debug 'Calling API: MasterAccountApi.
|
|
49
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_group_id_delete ...'
|
|
50
|
+
end
|
|
51
|
+
# verify the required parameter 'id' is set
|
|
52
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
53
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_group_id_delete"
|
|
48
54
|
end
|
|
49
55
|
# resource path
|
|
50
|
-
local_var_path = '/corporate/
|
|
56
|
+
local_var_path = '/corporate/group/{id}'.sub('{' + 'id' + '}', id.to_s)
|
|
51
57
|
|
|
52
58
|
# query parameters
|
|
53
59
|
query_params = {}
|
|
@@ -65,54 +71,45 @@ module Brevo
|
|
|
65
71
|
# http body (model)
|
|
66
72
|
post_body = nil
|
|
67
73
|
auth_names = ['api-key', 'partner-key']
|
|
68
|
-
data, status_code, headers = @api_client.call_api(:
|
|
74
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
69
75
|
:header_params => header_params,
|
|
70
76
|
:query_params => query_params,
|
|
71
77
|
:form_params => form_params,
|
|
72
78
|
:body => post_body,
|
|
73
|
-
:auth_names => auth_names
|
|
74
|
-
:return_type => 'MasterDetailsResponse')
|
|
79
|
+
:auth_names => auth_names)
|
|
75
80
|
if @api_client.config.debugging
|
|
76
|
-
@api_client.config.logger.debug "API called: MasterAccountApi#
|
|
81
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_group_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
77
82
|
end
|
|
78
83
|
return data, status_code, headers
|
|
79
84
|
end
|
|
80
|
-
#
|
|
81
|
-
# This endpoint
|
|
82
|
-
# @param
|
|
83
|
-
# @param limit Number of sub-accounts to be displayed on each page
|
|
85
|
+
# GET a group details
|
|
86
|
+
# 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.
|
|
87
|
+
# @param id Id of the group of sub-organization
|
|
84
88
|
# @param [Hash] opts the optional parameters
|
|
85
|
-
# @return [
|
|
86
|
-
def
|
|
87
|
-
data, _status_code, _headers =
|
|
89
|
+
# @return [CorporateGroupDetailsResponse]
|
|
90
|
+
def corporate_group_id_get(id, opts = {})
|
|
91
|
+
data, _status_code, _headers = corporate_group_id_get_with_http_info(id, opts)
|
|
88
92
|
data
|
|
89
93
|
end
|
|
90
94
|
|
|
91
|
-
#
|
|
92
|
-
# This endpoint
|
|
93
|
-
# @param
|
|
94
|
-
# @param limit Number of sub-accounts to be displayed on each page
|
|
95
|
+
# GET a group details
|
|
96
|
+
# 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.
|
|
97
|
+
# @param id Id of the group of sub-organization
|
|
95
98
|
# @param [Hash] opts the optional parameters
|
|
96
|
-
# @return [Array<(
|
|
97
|
-
def
|
|
99
|
+
# @return [Array<(CorporateGroupDetailsResponse, Fixnum, Hash)>] CorporateGroupDetailsResponse data, response status code and response headers
|
|
100
|
+
def corporate_group_id_get_with_http_info(id, opts = {})
|
|
98
101
|
if @api_client.config.debugging
|
|
99
|
-
@api_client.config.logger.debug 'Calling API: MasterAccountApi.
|
|
100
|
-
end
|
|
101
|
-
# verify the required parameter 'offset' is set
|
|
102
|
-
if @api_client.config.client_side_validation && offset.nil?
|
|
103
|
-
fail ArgumentError, "Missing the required parameter 'offset' when calling MasterAccountApi.corporate_sub_account_get"
|
|
102
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_group_id_get ...'
|
|
104
103
|
end
|
|
105
|
-
# verify the required parameter '
|
|
106
|
-
if @api_client.config.client_side_validation &&
|
|
107
|
-
fail ArgumentError, "Missing the required parameter '
|
|
104
|
+
# verify the required parameter 'id' is set
|
|
105
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
106
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_group_id_get"
|
|
108
107
|
end
|
|
109
108
|
# resource path
|
|
110
|
-
local_var_path = '/corporate/
|
|
109
|
+
local_var_path = '/corporate/group/{id}'.sub('{' + 'id' + '}', id.to_s)
|
|
111
110
|
|
|
112
111
|
# query parameters
|
|
113
112
|
query_params = {}
|
|
114
|
-
query_params[:'offset'] = offset
|
|
115
|
-
query_params[:'limit'] = limit
|
|
116
113
|
|
|
117
114
|
# header parameters
|
|
118
115
|
header_params = {}
|
|
@@ -133,43 +130,43 @@ module Brevo
|
|
|
133
130
|
:form_params => form_params,
|
|
134
131
|
:body => post_body,
|
|
135
132
|
:auth_names => auth_names,
|
|
136
|
-
:return_type => '
|
|
133
|
+
:return_type => 'CorporateGroupDetailsResponse')
|
|
137
134
|
if @api_client.config.debugging
|
|
138
|
-
@api_client.config.logger.debug "API called: MasterAccountApi#
|
|
135
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_group_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
139
136
|
end
|
|
140
137
|
return data, status_code, headers
|
|
141
138
|
end
|
|
142
|
-
#
|
|
143
|
-
#
|
|
144
|
-
# @param id Id of the
|
|
145
|
-
# @param
|
|
139
|
+
# Update a group of sub-accounts
|
|
140
|
+
# This endpoint allows you to update a group of sub-accounts
|
|
141
|
+
# @param id Id of the group
|
|
142
|
+
# @param body Group details to be updated.
|
|
146
143
|
# @param [Hash] opts the optional parameters
|
|
147
144
|
# @return [nil]
|
|
148
|
-
def
|
|
149
|
-
|
|
145
|
+
def corporate_group_id_put(id, body, opts = {})
|
|
146
|
+
corporate_group_id_put_with_http_info(id, body, opts)
|
|
150
147
|
nil
|
|
151
148
|
end
|
|
152
149
|
|
|
153
|
-
#
|
|
154
|
-
#
|
|
155
|
-
# @param id Id of the
|
|
156
|
-
# @param
|
|
150
|
+
# Update a group of sub-accounts
|
|
151
|
+
# This endpoint allows you to update a group of sub-accounts
|
|
152
|
+
# @param id Id of the group
|
|
153
|
+
# @param body Group details to be updated.
|
|
157
154
|
# @param [Hash] opts the optional parameters
|
|
158
155
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
159
|
-
def
|
|
156
|
+
def corporate_group_id_put_with_http_info(id, body, opts = {})
|
|
160
157
|
if @api_client.config.debugging
|
|
161
|
-
@api_client.config.logger.debug 'Calling API: MasterAccountApi.
|
|
158
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_group_id_put ...'
|
|
162
159
|
end
|
|
163
160
|
# verify the required parameter 'id' is set
|
|
164
161
|
if @api_client.config.client_side_validation && id.nil?
|
|
165
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.
|
|
162
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_group_id_put"
|
|
166
163
|
end
|
|
167
|
-
# verify the required parameter '
|
|
168
|
-
if @api_client.config.client_side_validation &&
|
|
169
|
-
fail ArgumentError, "Missing the required parameter '
|
|
164
|
+
# verify the required parameter 'body' is set
|
|
165
|
+
if @api_client.config.client_side_validation && body.nil?
|
|
166
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling MasterAccountApi.corporate_group_id_put"
|
|
170
167
|
end
|
|
171
168
|
# resource path
|
|
172
|
-
local_var_path = '/corporate/
|
|
169
|
+
local_var_path = '/corporate/group/{id}'.sub('{' + 'id' + '}', id.to_s)
|
|
173
170
|
|
|
174
171
|
# query parameters
|
|
175
172
|
query_params = {}
|
|
@@ -185,7 +182,7 @@ module Brevo
|
|
|
185
182
|
form_params = {}
|
|
186
183
|
|
|
187
184
|
# http body (model)
|
|
188
|
-
post_body = @api_client.object_to_http_body(
|
|
185
|
+
post_body = @api_client.object_to_http_body(body)
|
|
189
186
|
auth_names = ['api-key', 'partner-key']
|
|
190
187
|
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
191
188
|
:header_params => header_params,
|
|
@@ -194,33 +191,35 @@ module Brevo
|
|
|
194
191
|
:body => post_body,
|
|
195
192
|
:auth_names => auth_names)
|
|
196
193
|
if @api_client.config.debugging
|
|
197
|
-
@api_client.config.logger.debug "API called: MasterAccountApi#
|
|
194
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_group_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
198
195
|
end
|
|
199
196
|
return data, status_code, headers
|
|
200
197
|
end
|
|
201
|
-
#
|
|
202
|
-
#
|
|
198
|
+
# Create a new group of sub-accounts
|
|
199
|
+
# This endpoint allows to create a group of sub-accounts
|
|
200
|
+
# @param body Group details to be created.
|
|
203
201
|
# @param [Hash] opts the optional parameters
|
|
204
|
-
# @return [
|
|
205
|
-
def
|
|
206
|
-
|
|
207
|
-
|
|
202
|
+
# @return [InlineResponse201]
|
|
203
|
+
def corporate_group_post(body, opts = {})
|
|
204
|
+
data, _status_code, _headers = corporate_group_post_with_http_info(body, opts)
|
|
205
|
+
data
|
|
208
206
|
end
|
|
209
207
|
|
|
210
|
-
#
|
|
211
|
-
#
|
|
208
|
+
# Create a new group of sub-accounts
|
|
209
|
+
# This endpoint allows to create a group of sub-accounts
|
|
210
|
+
# @param body Group details to be created.
|
|
212
211
|
# @param [Hash] opts the optional parameters
|
|
213
|
-
# @return [Array<(
|
|
214
|
-
def
|
|
212
|
+
# @return [Array<(InlineResponse201, Fixnum, Hash)>] InlineResponse201 data, response status code and response headers
|
|
213
|
+
def corporate_group_post_with_http_info(body, opts = {})
|
|
215
214
|
if @api_client.config.debugging
|
|
216
|
-
@api_client.config.logger.debug 'Calling API: MasterAccountApi.
|
|
215
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_group_post ...'
|
|
217
216
|
end
|
|
218
|
-
# verify the required parameter '
|
|
219
|
-
if @api_client.config.client_side_validation &&
|
|
220
|
-
fail ArgumentError, "Missing the required parameter '
|
|
217
|
+
# verify the required parameter 'body' is set
|
|
218
|
+
if @api_client.config.client_side_validation && body.nil?
|
|
219
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling MasterAccountApi.corporate_group_post"
|
|
221
220
|
end
|
|
222
221
|
# resource path
|
|
223
|
-
local_var_path = '/corporate/
|
|
222
|
+
local_var_path = '/corporate/group'
|
|
224
223
|
|
|
225
224
|
# query parameters
|
|
226
225
|
query_params = {}
|
|
@@ -236,44 +235,51 @@ module Brevo
|
|
|
236
235
|
form_params = {}
|
|
237
236
|
|
|
238
237
|
# http body (model)
|
|
239
|
-
post_body =
|
|
238
|
+
post_body = @api_client.object_to_http_body(body)
|
|
240
239
|
auth_names = ['api-key', 'partner-key']
|
|
241
|
-
data, status_code, headers = @api_client.call_api(:
|
|
240
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
242
241
|
:header_params => header_params,
|
|
243
242
|
:query_params => query_params,
|
|
244
243
|
:form_params => form_params,
|
|
245
244
|
:body => post_body,
|
|
246
|
-
:auth_names => auth_names
|
|
245
|
+
:auth_names => auth_names,
|
|
246
|
+
:return_type => 'InlineResponse201')
|
|
247
247
|
if @api_client.config.debugging
|
|
248
|
-
@api_client.config.logger.debug "API called: MasterAccountApi#
|
|
248
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_group_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
249
249
|
end
|
|
250
250
|
return data, status_code, headers
|
|
251
251
|
end
|
|
252
|
-
#
|
|
253
|
-
# This endpoint
|
|
254
|
-
# @param
|
|
252
|
+
# Delete sub-account from group
|
|
253
|
+
# This endpoint allows you to remove a sub-organization from a group.
|
|
254
|
+
# @param group_id Id of the group
|
|
255
|
+
# @param body List of sub-account ids
|
|
255
256
|
# @param [Hash] opts the optional parameters
|
|
256
|
-
# @return [
|
|
257
|
-
def
|
|
258
|
-
|
|
259
|
-
|
|
257
|
+
# @return [nil]
|
|
258
|
+
def corporate_group_unlink_group_id_sub_accounts_put(group_id, body, opts = {})
|
|
259
|
+
corporate_group_unlink_group_id_sub_accounts_put_with_http_info(group_id, body, opts)
|
|
260
|
+
nil
|
|
260
261
|
end
|
|
261
262
|
|
|
262
|
-
#
|
|
263
|
-
# This endpoint
|
|
264
|
-
# @param
|
|
263
|
+
# Delete sub-account from group
|
|
264
|
+
# This endpoint allows you to remove a sub-organization from a group.
|
|
265
|
+
# @param group_id Id of the group
|
|
266
|
+
# @param body List of sub-account ids
|
|
265
267
|
# @param [Hash] opts the optional parameters
|
|
266
|
-
# @return [Array<(
|
|
267
|
-
def
|
|
268
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
269
|
+
def corporate_group_unlink_group_id_sub_accounts_put_with_http_info(group_id, body, opts = {})
|
|
268
270
|
if @api_client.config.debugging
|
|
269
|
-
@api_client.config.logger.debug 'Calling API: MasterAccountApi.
|
|
271
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_group_unlink_group_id_sub_accounts_put ...'
|
|
270
272
|
end
|
|
271
|
-
# verify the required parameter '
|
|
272
|
-
if @api_client.config.client_side_validation &&
|
|
273
|
-
fail ArgumentError, "Missing the required parameter '
|
|
273
|
+
# verify the required parameter 'group_id' is set
|
|
274
|
+
if @api_client.config.client_side_validation && group_id.nil?
|
|
275
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling MasterAccountApi.corporate_group_unlink_group_id_sub_accounts_put"
|
|
276
|
+
end
|
|
277
|
+
# verify the required parameter 'body' is set
|
|
278
|
+
if @api_client.config.client_side_validation && body.nil?
|
|
279
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling MasterAccountApi.corporate_group_unlink_group_id_sub_accounts_put"
|
|
274
280
|
end
|
|
275
281
|
# resource path
|
|
276
|
-
local_var_path = '/corporate/
|
|
282
|
+
local_var_path = '/corporate/group/unlink/{groupId}/subAccounts'.sub('{' + 'groupId' + '}', group_id.to_s)
|
|
277
283
|
|
|
278
284
|
# query parameters
|
|
279
285
|
query_params = {}
|
|
@@ -289,51 +295,38 @@ module Brevo
|
|
|
289
295
|
form_params = {}
|
|
290
296
|
|
|
291
297
|
# http body (model)
|
|
292
|
-
post_body =
|
|
298
|
+
post_body = @api_client.object_to_http_body(body)
|
|
293
299
|
auth_names = ['api-key', 'partner-key']
|
|
294
|
-
data, status_code, headers = @api_client.call_api(:
|
|
300
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
295
301
|
:header_params => header_params,
|
|
296
302
|
:query_params => query_params,
|
|
297
303
|
:form_params => form_params,
|
|
298
304
|
:body => post_body,
|
|
299
|
-
:auth_names => auth_names
|
|
300
|
-
:return_type => 'SubAccountDetailsResponse')
|
|
305
|
+
:auth_names => auth_names)
|
|
301
306
|
if @api_client.config.debugging
|
|
302
|
-
@api_client.config.logger.debug "API called: MasterAccountApi#
|
|
307
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_group_unlink_group_id_sub_accounts_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
303
308
|
end
|
|
304
309
|
return data, status_code, headers
|
|
305
310
|
end
|
|
306
|
-
#
|
|
307
|
-
# This endpoint
|
|
308
|
-
# @param id Id of the sub-account organization
|
|
309
|
-
# @param update_plan_details Values to update a sub-account plan
|
|
311
|
+
# List of all IPs
|
|
312
|
+
# This endpoint allows you to retrieve the list of active IPs on your Admin account
|
|
310
313
|
# @param [Hash] opts the optional parameters
|
|
311
314
|
# @return [nil]
|
|
312
|
-
def
|
|
313
|
-
|
|
315
|
+
def corporate_ip_get(opts = {})
|
|
316
|
+
corporate_ip_get_with_http_info(opts)
|
|
314
317
|
nil
|
|
315
318
|
end
|
|
316
319
|
|
|
317
|
-
#
|
|
318
|
-
# This endpoint
|
|
319
|
-
# @param id Id of the sub-account organization
|
|
320
|
-
# @param update_plan_details Values to update a sub-account plan
|
|
320
|
+
# List of all IPs
|
|
321
|
+
# This endpoint allows you to retrieve the list of active IPs on your Admin account
|
|
321
322
|
# @param [Hash] opts the optional parameters
|
|
322
323
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
323
|
-
def
|
|
324
|
+
def corporate_ip_get_with_http_info(opts = {})
|
|
324
325
|
if @api_client.config.debugging
|
|
325
|
-
@api_client.config.logger.debug 'Calling API: MasterAccountApi.
|
|
326
|
-
end
|
|
327
|
-
# verify the required parameter 'id' is set
|
|
328
|
-
if @api_client.config.client_side_validation && id.nil?
|
|
329
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_sub_account_id_plan_put"
|
|
330
|
-
end
|
|
331
|
-
# verify the required parameter 'update_plan_details' is set
|
|
332
|
-
if @api_client.config.client_side_validation && update_plan_details.nil?
|
|
333
|
-
fail ArgumentError, "Missing the required parameter 'update_plan_details' when calling MasterAccountApi.corporate_sub_account_id_plan_put"
|
|
326
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_ip_get ...'
|
|
334
327
|
end
|
|
335
328
|
# resource path
|
|
336
|
-
local_var_path = '/corporate/
|
|
329
|
+
local_var_path = '/corporate/ip'
|
|
337
330
|
|
|
338
331
|
# query parameters
|
|
339
332
|
query_params = {}
|
|
@@ -349,44 +342,38 @@ module Brevo
|
|
|
349
342
|
form_params = {}
|
|
350
343
|
|
|
351
344
|
# http body (model)
|
|
352
|
-
post_body =
|
|
345
|
+
post_body = nil
|
|
353
346
|
auth_names = ['api-key', 'partner-key']
|
|
354
|
-
data, status_code, headers = @api_client.call_api(:
|
|
347
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
355
348
|
:header_params => header_params,
|
|
356
349
|
:query_params => query_params,
|
|
357
350
|
:form_params => form_params,
|
|
358
351
|
:body => post_body,
|
|
359
352
|
:auth_names => auth_names)
|
|
360
353
|
if @api_client.config.debugging
|
|
361
|
-
@api_client.config.logger.debug "API called: MasterAccountApi#
|
|
354
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_ip_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
362
355
|
end
|
|
363
356
|
return data, status_code, headers
|
|
364
357
|
end
|
|
365
|
-
#
|
|
366
|
-
# This endpoint will
|
|
367
|
-
# @param create_api_key_request Values to generate API key for sub-account
|
|
358
|
+
# Get the details of requested master account
|
|
359
|
+
# This endpoint will provide the details of the master account.
|
|
368
360
|
# @param [Hash] opts the optional parameters
|
|
369
|
-
# @return [
|
|
370
|
-
def
|
|
371
|
-
data, _status_code, _headers =
|
|
361
|
+
# @return [MasterDetailsResponse]
|
|
362
|
+
def corporate_master_account_get(opts = {})
|
|
363
|
+
data, _status_code, _headers = corporate_master_account_get_with_http_info(opts)
|
|
372
364
|
data
|
|
373
365
|
end
|
|
374
366
|
|
|
375
|
-
#
|
|
376
|
-
# This endpoint will
|
|
377
|
-
# @param create_api_key_request Values to generate API key for sub-account
|
|
367
|
+
# Get the details of requested master account
|
|
368
|
+
# This endpoint will provide the details of the master account.
|
|
378
369
|
# @param [Hash] opts the optional parameters
|
|
379
|
-
# @return [Array<(
|
|
380
|
-
def
|
|
370
|
+
# @return [Array<(MasterDetailsResponse, Fixnum, Hash)>] MasterDetailsResponse data, response status code and response headers
|
|
371
|
+
def corporate_master_account_get_with_http_info(opts = {})
|
|
381
372
|
if @api_client.config.debugging
|
|
382
|
-
@api_client.config.logger.debug 'Calling API: MasterAccountApi.
|
|
383
|
-
end
|
|
384
|
-
# verify the required parameter 'create_api_key_request' is set
|
|
385
|
-
if @api_client.config.client_side_validation && create_api_key_request.nil?
|
|
386
|
-
fail ArgumentError, "Missing the required parameter 'create_api_key_request' when calling MasterAccountApi.corporate_sub_account_key_post"
|
|
373
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_master_account_get ...'
|
|
387
374
|
end
|
|
388
375
|
# resource path
|
|
389
|
-
local_var_path = '/corporate/
|
|
376
|
+
local_var_path = '/corporate/masterAccount'
|
|
390
377
|
|
|
391
378
|
# query parameters
|
|
392
379
|
query_params = {}
|
|
@@ -402,45 +389,45 @@ module Brevo
|
|
|
402
389
|
form_params = {}
|
|
403
390
|
|
|
404
391
|
# http body (model)
|
|
405
|
-
post_body =
|
|
392
|
+
post_body = nil
|
|
406
393
|
auth_names = ['api-key', 'partner-key']
|
|
407
|
-
data, status_code, headers = @api_client.call_api(:
|
|
394
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
408
395
|
:header_params => header_params,
|
|
409
396
|
:query_params => query_params,
|
|
410
397
|
:form_params => form_params,
|
|
411
398
|
:body => post_body,
|
|
412
399
|
:auth_names => auth_names,
|
|
413
|
-
:return_type => '
|
|
400
|
+
:return_type => 'MasterDetailsResponse')
|
|
414
401
|
if @api_client.config.debugging
|
|
415
|
-
@api_client.config.logger.debug "API called: MasterAccountApi#
|
|
402
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_master_account_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
416
403
|
end
|
|
417
404
|
return data, status_code, headers
|
|
418
405
|
end
|
|
419
|
-
#
|
|
420
|
-
# This endpoint
|
|
421
|
-
# @param
|
|
406
|
+
# Generate SSO token to access admin account
|
|
407
|
+
# 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.
|
|
408
|
+
# @param sso_token_request_corporate User email of admin account
|
|
422
409
|
# @param [Hash] opts the optional parameters
|
|
423
|
-
# @return [
|
|
424
|
-
def
|
|
425
|
-
data, _status_code, _headers =
|
|
410
|
+
# @return [GetSsoToken]
|
|
411
|
+
def corporate_sso_token_post(sso_token_request_corporate, opts = {})
|
|
412
|
+
data, _status_code, _headers = corporate_sso_token_post_with_http_info(sso_token_request_corporate, opts)
|
|
426
413
|
data
|
|
427
414
|
end
|
|
428
415
|
|
|
429
|
-
#
|
|
430
|
-
# This endpoint
|
|
431
|
-
# @param
|
|
416
|
+
# Generate SSO token to access admin account
|
|
417
|
+
# 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.
|
|
418
|
+
# @param sso_token_request_corporate User email of admin account
|
|
432
419
|
# @param [Hash] opts the optional parameters
|
|
433
|
-
# @return [Array<(
|
|
434
|
-
def
|
|
420
|
+
# @return [Array<(GetSsoToken, Fixnum, Hash)>] GetSsoToken data, response status code and response headers
|
|
421
|
+
def corporate_sso_token_post_with_http_info(sso_token_request_corporate, opts = {})
|
|
435
422
|
if @api_client.config.debugging
|
|
436
|
-
@api_client.config.logger.debug 'Calling API: MasterAccountApi.
|
|
423
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sso_token_post ...'
|
|
437
424
|
end
|
|
438
|
-
# verify the required parameter '
|
|
439
|
-
if @api_client.config.client_side_validation &&
|
|
440
|
-
fail ArgumentError, "Missing the required parameter '
|
|
425
|
+
# verify the required parameter 'sso_token_request_corporate' is set
|
|
426
|
+
if @api_client.config.client_side_validation && sso_token_request_corporate.nil?
|
|
427
|
+
fail ArgumentError, "Missing the required parameter 'sso_token_request_corporate' when calling MasterAccountApi.corporate_sso_token_post"
|
|
441
428
|
end
|
|
442
429
|
# resource path
|
|
443
|
-
local_var_path = '/corporate/
|
|
430
|
+
local_var_path = '/corporate/ssoToken'
|
|
444
431
|
|
|
445
432
|
# query parameters
|
|
446
433
|
query_params = {}
|
|
@@ -456,7 +443,7 @@ module Brevo
|
|
|
456
443
|
form_params = {}
|
|
457
444
|
|
|
458
445
|
# http body (model)
|
|
459
|
-
post_body = @api_client.object_to_http_body(
|
|
446
|
+
post_body = @api_client.object_to_http_body(sso_token_request_corporate)
|
|
460
447
|
auth_names = ['api-key', 'partner-key']
|
|
461
448
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
462
449
|
:header_params => header_params,
|
|
@@ -464,40 +451,48 @@ module Brevo
|
|
|
464
451
|
:form_params => form_params,
|
|
465
452
|
:body => post_body,
|
|
466
453
|
:auth_names => auth_names,
|
|
467
|
-
:return_type => '
|
|
454
|
+
:return_type => 'GetSsoToken')
|
|
468
455
|
if @api_client.config.debugging
|
|
469
|
-
@api_client.config.logger.debug "API called: MasterAccountApi#
|
|
456
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_sso_token_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
470
457
|
end
|
|
471
458
|
return data, status_code, headers
|
|
472
459
|
end
|
|
473
|
-
#
|
|
474
|
-
# This endpoint
|
|
475
|
-
# @param
|
|
460
|
+
# Get the list of all the sub-accounts of the master account.
|
|
461
|
+
# This endpoint will provide the list all the sub-accounts of the master account.
|
|
462
|
+
# @param offset Index of the first sub-account in the page
|
|
463
|
+
# @param limit Number of sub-accounts to be displayed on each page
|
|
476
464
|
# @param [Hash] opts the optional parameters
|
|
477
|
-
# @return [
|
|
478
|
-
def
|
|
479
|
-
data, _status_code, _headers =
|
|
465
|
+
# @return [SubAccountsResponse]
|
|
466
|
+
def corporate_sub_account_get(offset, limit, opts = {})
|
|
467
|
+
data, _status_code, _headers = corporate_sub_account_get_with_http_info(offset, limit, opts)
|
|
480
468
|
data
|
|
481
469
|
end
|
|
482
470
|
|
|
483
|
-
#
|
|
484
|
-
# This endpoint
|
|
485
|
-
# @param
|
|
471
|
+
# Get the list of all the sub-accounts of the master account.
|
|
472
|
+
# This endpoint will provide the list all the sub-accounts of the master account.
|
|
473
|
+
# @param offset Index of the first sub-account in the page
|
|
474
|
+
# @param limit Number of sub-accounts to be displayed on each page
|
|
486
475
|
# @param [Hash] opts the optional parameters
|
|
487
|
-
# @return [Array<(
|
|
488
|
-
def
|
|
476
|
+
# @return [Array<(SubAccountsResponse, Fixnum, Hash)>] SubAccountsResponse data, response status code and response headers
|
|
477
|
+
def corporate_sub_account_get_with_http_info(offset, limit, opts = {})
|
|
489
478
|
if @api_client.config.debugging
|
|
490
|
-
@api_client.config.logger.debug 'Calling API: MasterAccountApi.
|
|
479
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_get ...'
|
|
491
480
|
end
|
|
492
|
-
# verify the required parameter '
|
|
493
|
-
if @api_client.config.client_side_validation &&
|
|
494
|
-
fail ArgumentError, "Missing the required parameter '
|
|
481
|
+
# verify the required parameter 'offset' is set
|
|
482
|
+
if @api_client.config.client_side_validation && offset.nil?
|
|
483
|
+
fail ArgumentError, "Missing the required parameter 'offset' when calling MasterAccountApi.corporate_sub_account_get"
|
|
484
|
+
end
|
|
485
|
+
# verify the required parameter 'limit' is set
|
|
486
|
+
if @api_client.config.client_side_validation && limit.nil?
|
|
487
|
+
fail ArgumentError, "Missing the required parameter 'limit' when calling MasterAccountApi.corporate_sub_account_get"
|
|
495
488
|
end
|
|
496
489
|
# resource path
|
|
497
|
-
local_var_path = '/corporate/subAccount
|
|
490
|
+
local_var_path = '/corporate/subAccount'
|
|
498
491
|
|
|
499
492
|
# query parameters
|
|
500
493
|
query_params = {}
|
|
494
|
+
query_params[:'offset'] = offset
|
|
495
|
+
query_params[:'limit'] = limit
|
|
501
496
|
|
|
502
497
|
# header parameters
|
|
503
498
|
header_params = {}
|
|
@@ -510,24 +505,742 @@ module Brevo
|
|
|
510
505
|
form_params = {}
|
|
511
506
|
|
|
512
507
|
# http body (model)
|
|
513
|
-
post_body =
|
|
508
|
+
post_body = nil
|
|
514
509
|
auth_names = ['api-key', 'partner-key']
|
|
515
|
-
data, status_code, headers = @api_client.call_api(:
|
|
510
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
516
511
|
:header_params => header_params,
|
|
517
512
|
:query_params => query_params,
|
|
518
513
|
:form_params => form_params,
|
|
519
514
|
:body => post_body,
|
|
520
515
|
:auth_names => auth_names,
|
|
521
|
-
:return_type => '
|
|
516
|
+
:return_type => 'SubAccountsResponse')
|
|
522
517
|
if @api_client.config.debugging
|
|
523
|
-
@api_client.config.logger.debug "API called: MasterAccountApi#
|
|
518
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
524
519
|
end
|
|
525
520
|
return data, status_code, headers
|
|
526
521
|
end
|
|
527
|
-
#
|
|
528
|
-
#
|
|
529
|
-
# @
|
|
522
|
+
# Enable/disable sub-account application(s)
|
|
523
|
+
# API endpoint for the Corporate owner to enable/disable applications on the sub-account
|
|
524
|
+
# @param id Id of the sub-account organization (mandatory)
|
|
525
|
+
# @param toggle_applications List of applications to activate or deactivate on a sub-account
|
|
526
|
+
# @param [Hash] opts the optional parameters
|
|
527
|
+
# @return [nil]
|
|
528
|
+
def corporate_sub_account_id_applications_toggle_put(id, toggle_applications, opts = {})
|
|
529
|
+
corporate_sub_account_id_applications_toggle_put_with_http_info(id, toggle_applications, opts)
|
|
530
|
+
nil
|
|
531
|
+
end
|
|
532
|
+
|
|
533
|
+
# Enable/disable sub-account application(s)
|
|
534
|
+
# API endpoint for the Corporate owner to enable/disable applications on the sub-account
|
|
535
|
+
# @param id Id of the sub-account organization (mandatory)
|
|
536
|
+
# @param toggle_applications List of applications to activate or deactivate on a sub-account
|
|
537
|
+
# @param [Hash] opts the optional parameters
|
|
538
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
539
|
+
def corporate_sub_account_id_applications_toggle_put_with_http_info(id, toggle_applications, opts = {})
|
|
540
|
+
if @api_client.config.debugging
|
|
541
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_id_applications_toggle_put ...'
|
|
542
|
+
end
|
|
543
|
+
# verify the required parameter 'id' is set
|
|
544
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
545
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_sub_account_id_applications_toggle_put"
|
|
546
|
+
end
|
|
547
|
+
# verify the required parameter 'toggle_applications' is set
|
|
548
|
+
if @api_client.config.client_side_validation && toggle_applications.nil?
|
|
549
|
+
fail ArgumentError, "Missing the required parameter 'toggle_applications' when calling MasterAccountApi.corporate_sub_account_id_applications_toggle_put"
|
|
550
|
+
end
|
|
551
|
+
# resource path
|
|
552
|
+
local_var_path = '/corporate/subAccount/{id}/applications/toggle'.sub('{' + 'id' + '}', id.to_s)
|
|
553
|
+
|
|
554
|
+
# query parameters
|
|
555
|
+
query_params = {}
|
|
556
|
+
|
|
557
|
+
# header parameters
|
|
558
|
+
header_params = {}
|
|
559
|
+
# HTTP header 'Accept' (if needed)
|
|
560
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
561
|
+
# HTTP header 'Content-Type'
|
|
562
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
563
|
+
|
|
564
|
+
# form parameters
|
|
565
|
+
form_params = {}
|
|
566
|
+
|
|
567
|
+
# http body (model)
|
|
568
|
+
post_body = @api_client.object_to_http_body(toggle_applications)
|
|
569
|
+
auth_names = ['api-key', 'partner-key']
|
|
570
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
571
|
+
:header_params => header_params,
|
|
572
|
+
:query_params => query_params,
|
|
573
|
+
:form_params => form_params,
|
|
574
|
+
:body => post_body,
|
|
575
|
+
:auth_names => auth_names)
|
|
576
|
+
if @api_client.config.debugging
|
|
577
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_id_applications_toggle_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
578
|
+
end
|
|
579
|
+
return data, status_code, headers
|
|
580
|
+
end
|
|
581
|
+
# Delete a sub-account
|
|
582
|
+
# @param id Id of the sub-account organization to be deleted
|
|
583
|
+
# @param [Hash] opts the optional parameters
|
|
584
|
+
# @return [nil]
|
|
585
|
+
def corporate_sub_account_id_delete(id, opts = {})
|
|
586
|
+
corporate_sub_account_id_delete_with_http_info(id, opts)
|
|
587
|
+
nil
|
|
588
|
+
end
|
|
589
|
+
|
|
590
|
+
# Delete a sub-account
|
|
591
|
+
# @param id Id of the sub-account organization to be deleted
|
|
592
|
+
# @param [Hash] opts the optional parameters
|
|
593
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
594
|
+
def corporate_sub_account_id_delete_with_http_info(id, opts = {})
|
|
595
|
+
if @api_client.config.debugging
|
|
596
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_id_delete ...'
|
|
597
|
+
end
|
|
598
|
+
# verify the required parameter 'id' is set
|
|
599
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
600
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_sub_account_id_delete"
|
|
601
|
+
end
|
|
602
|
+
# resource path
|
|
603
|
+
local_var_path = '/corporate/subAccount/{id}'.sub('{' + 'id' + '}', id.to_s)
|
|
604
|
+
|
|
605
|
+
# query parameters
|
|
606
|
+
query_params = {}
|
|
607
|
+
|
|
608
|
+
# header parameters
|
|
609
|
+
header_params = {}
|
|
610
|
+
# HTTP header 'Accept' (if needed)
|
|
611
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
612
|
+
# HTTP header 'Content-Type'
|
|
613
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
614
|
+
|
|
615
|
+
# form parameters
|
|
616
|
+
form_params = {}
|
|
617
|
+
|
|
618
|
+
# http body (model)
|
|
619
|
+
post_body = nil
|
|
620
|
+
auth_names = ['api-key', 'partner-key']
|
|
621
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
622
|
+
:header_params => header_params,
|
|
623
|
+
:query_params => query_params,
|
|
624
|
+
:form_params => form_params,
|
|
625
|
+
:body => post_body,
|
|
626
|
+
:auth_names => auth_names)
|
|
627
|
+
if @api_client.config.debugging
|
|
628
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
629
|
+
end
|
|
630
|
+
return data, status_code, headers
|
|
631
|
+
end
|
|
632
|
+
# Get sub-account details
|
|
633
|
+
# This endpoint will provide the details for the specified sub-account company
|
|
634
|
+
# @param id Id of the sub-account organization
|
|
635
|
+
# @param [Hash] opts the optional parameters
|
|
636
|
+
# @return [SubAccountDetailsResponse]
|
|
637
|
+
def corporate_sub_account_id_get(id, opts = {})
|
|
638
|
+
data, _status_code, _headers = corporate_sub_account_id_get_with_http_info(id, opts)
|
|
639
|
+
data
|
|
640
|
+
end
|
|
641
|
+
|
|
642
|
+
# Get sub-account details
|
|
643
|
+
# This endpoint will provide the details for the specified sub-account company
|
|
644
|
+
# @param id Id of the sub-account organization
|
|
645
|
+
# @param [Hash] opts the optional parameters
|
|
646
|
+
# @return [Array<(SubAccountDetailsResponse, Fixnum, Hash)>] SubAccountDetailsResponse data, response status code and response headers
|
|
647
|
+
def corporate_sub_account_id_get_with_http_info(id, opts = {})
|
|
648
|
+
if @api_client.config.debugging
|
|
649
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_id_get ...'
|
|
650
|
+
end
|
|
651
|
+
# verify the required parameter 'id' is set
|
|
652
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
653
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_sub_account_id_get"
|
|
654
|
+
end
|
|
655
|
+
# resource path
|
|
656
|
+
local_var_path = '/corporate/subAccount/{id}'.sub('{' + 'id' + '}', id.to_s)
|
|
657
|
+
|
|
658
|
+
# query parameters
|
|
659
|
+
query_params = {}
|
|
660
|
+
|
|
661
|
+
# header parameters
|
|
662
|
+
header_params = {}
|
|
663
|
+
# HTTP header 'Accept' (if needed)
|
|
664
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
665
|
+
# HTTP header 'Content-Type'
|
|
666
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
667
|
+
|
|
668
|
+
# form parameters
|
|
669
|
+
form_params = {}
|
|
670
|
+
|
|
671
|
+
# http body (model)
|
|
672
|
+
post_body = nil
|
|
673
|
+
auth_names = ['api-key', 'partner-key']
|
|
674
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
675
|
+
:header_params => header_params,
|
|
676
|
+
:query_params => query_params,
|
|
677
|
+
:form_params => form_params,
|
|
678
|
+
:body => post_body,
|
|
679
|
+
:auth_names => auth_names,
|
|
680
|
+
:return_type => 'SubAccountDetailsResponse')
|
|
681
|
+
if @api_client.config.debugging
|
|
682
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
683
|
+
end
|
|
684
|
+
return data, status_code, headers
|
|
685
|
+
end
|
|
686
|
+
# Update sub-account plan
|
|
687
|
+
# 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.
|
|
688
|
+
# @param id Id of the sub-account organization
|
|
689
|
+
# @param update_plan_details Values to update a sub-account plan
|
|
690
|
+
# @param [Hash] opts the optional parameters
|
|
691
|
+
# @return [nil]
|
|
692
|
+
def corporate_sub_account_id_plan_put(id, update_plan_details, opts = {})
|
|
693
|
+
corporate_sub_account_id_plan_put_with_http_info(id, update_plan_details, opts)
|
|
694
|
+
nil
|
|
695
|
+
end
|
|
696
|
+
|
|
697
|
+
# Update sub-account plan
|
|
698
|
+
# 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.
|
|
699
|
+
# @param id Id of the sub-account organization
|
|
700
|
+
# @param update_plan_details Values to update a sub-account plan
|
|
701
|
+
# @param [Hash] opts the optional parameters
|
|
702
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
703
|
+
def corporate_sub_account_id_plan_put_with_http_info(id, update_plan_details, opts = {})
|
|
704
|
+
if @api_client.config.debugging
|
|
705
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_id_plan_put ...'
|
|
706
|
+
end
|
|
707
|
+
# verify the required parameter 'id' is set
|
|
708
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
709
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_sub_account_id_plan_put"
|
|
710
|
+
end
|
|
711
|
+
# verify the required parameter 'update_plan_details' is set
|
|
712
|
+
if @api_client.config.client_side_validation && update_plan_details.nil?
|
|
713
|
+
fail ArgumentError, "Missing the required parameter 'update_plan_details' when calling MasterAccountApi.corporate_sub_account_id_plan_put"
|
|
714
|
+
end
|
|
715
|
+
# resource path
|
|
716
|
+
local_var_path = '/corporate/subAccount/{id}/plan'.sub('{' + 'id' + '}', id.to_s)
|
|
717
|
+
|
|
718
|
+
# query parameters
|
|
719
|
+
query_params = {}
|
|
720
|
+
|
|
721
|
+
# header parameters
|
|
722
|
+
header_params = {}
|
|
723
|
+
# HTTP header 'Accept' (if needed)
|
|
724
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
725
|
+
# HTTP header 'Content-Type'
|
|
726
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
727
|
+
|
|
728
|
+
# form parameters
|
|
729
|
+
form_params = {}
|
|
730
|
+
|
|
731
|
+
# http body (model)
|
|
732
|
+
post_body = @api_client.object_to_http_body(update_plan_details)
|
|
733
|
+
auth_names = ['api-key', 'partner-key']
|
|
734
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
735
|
+
:header_params => header_params,
|
|
736
|
+
:query_params => query_params,
|
|
737
|
+
:form_params => form_params,
|
|
738
|
+
:body => post_body,
|
|
739
|
+
:auth_names => auth_names)
|
|
740
|
+
if @api_client.config.debugging
|
|
741
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_id_plan_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
742
|
+
end
|
|
743
|
+
return data, status_code, headers
|
|
744
|
+
end
|
|
745
|
+
# Associate an IP to sub-accounts
|
|
746
|
+
# This endpoint allows to associate an IP to sub-accounts
|
|
747
|
+
# @param body Ip address association details
|
|
748
|
+
# @param [Hash] opts the optional parameters
|
|
749
|
+
# @return [Object]
|
|
750
|
+
def corporate_sub_account_ip_associate_post(body, opts = {})
|
|
751
|
+
data, _status_code, _headers = corporate_sub_account_ip_associate_post_with_http_info(body, opts)
|
|
752
|
+
data
|
|
753
|
+
end
|
|
754
|
+
|
|
755
|
+
# Associate an IP to sub-accounts
|
|
756
|
+
# This endpoint allows to associate an IP to sub-accounts
|
|
757
|
+
# @param body Ip address association details
|
|
758
|
+
# @param [Hash] opts the optional parameters
|
|
759
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
|
760
|
+
def corporate_sub_account_ip_associate_post_with_http_info(body, opts = {})
|
|
761
|
+
if @api_client.config.debugging
|
|
762
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_ip_associate_post ...'
|
|
763
|
+
end
|
|
764
|
+
# verify the required parameter 'body' is set
|
|
765
|
+
if @api_client.config.client_side_validation && body.nil?
|
|
766
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling MasterAccountApi.corporate_sub_account_ip_associate_post"
|
|
767
|
+
end
|
|
768
|
+
# resource path
|
|
769
|
+
local_var_path = '/corporate/subAccount/ip/associate'
|
|
770
|
+
|
|
771
|
+
# query parameters
|
|
772
|
+
query_params = {}
|
|
773
|
+
|
|
774
|
+
# header parameters
|
|
775
|
+
header_params = {}
|
|
776
|
+
# HTTP header 'Accept' (if needed)
|
|
777
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
778
|
+
# HTTP header 'Content-Type'
|
|
779
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
780
|
+
|
|
781
|
+
# form parameters
|
|
782
|
+
form_params = {}
|
|
783
|
+
|
|
784
|
+
# http body (model)
|
|
785
|
+
post_body = @api_client.object_to_http_body(body)
|
|
786
|
+
auth_names = ['api-key', 'partner-key']
|
|
787
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
788
|
+
:header_params => header_params,
|
|
789
|
+
:query_params => query_params,
|
|
790
|
+
:form_params => form_params,
|
|
791
|
+
:body => post_body,
|
|
792
|
+
:auth_names => auth_names,
|
|
793
|
+
:return_type => 'Object')
|
|
794
|
+
if @api_client.config.debugging
|
|
795
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_ip_associate_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
796
|
+
end
|
|
797
|
+
return data, status_code, headers
|
|
798
|
+
end
|
|
799
|
+
# Dissociate an IP from sub-accounts
|
|
800
|
+
# This endpoint allows to dissociate an IP from sub-accounts
|
|
801
|
+
# @param body Ip address dissociation details
|
|
802
|
+
# @param [Hash] opts the optional parameters
|
|
803
|
+
# @return [nil]
|
|
804
|
+
def corporate_sub_account_ip_dissociate_put(body, opts = {})
|
|
805
|
+
corporate_sub_account_ip_dissociate_put_with_http_info(body, opts)
|
|
806
|
+
nil
|
|
807
|
+
end
|
|
808
|
+
|
|
809
|
+
# Dissociate an IP from sub-accounts
|
|
810
|
+
# This endpoint allows to dissociate an IP from sub-accounts
|
|
811
|
+
# @param body Ip address dissociation details
|
|
812
|
+
# @param [Hash] opts the optional parameters
|
|
813
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
814
|
+
def corporate_sub_account_ip_dissociate_put_with_http_info(body, opts = {})
|
|
815
|
+
if @api_client.config.debugging
|
|
816
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_ip_dissociate_put ...'
|
|
817
|
+
end
|
|
818
|
+
# verify the required parameter 'body' is set
|
|
819
|
+
if @api_client.config.client_side_validation && body.nil?
|
|
820
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling MasterAccountApi.corporate_sub_account_ip_dissociate_put"
|
|
821
|
+
end
|
|
822
|
+
# resource path
|
|
823
|
+
local_var_path = '/corporate/subAccount/ip/dissociate'
|
|
824
|
+
|
|
825
|
+
# query parameters
|
|
826
|
+
query_params = {}
|
|
827
|
+
|
|
828
|
+
# header parameters
|
|
829
|
+
header_params = {}
|
|
830
|
+
# HTTP header 'Accept' (if needed)
|
|
831
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
832
|
+
# HTTP header 'Content-Type'
|
|
833
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
834
|
+
|
|
835
|
+
# form parameters
|
|
836
|
+
form_params = {}
|
|
837
|
+
|
|
838
|
+
# http body (model)
|
|
839
|
+
post_body = @api_client.object_to_http_body(body)
|
|
840
|
+
auth_names = ['api-key', 'partner-key']
|
|
841
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
842
|
+
:header_params => header_params,
|
|
843
|
+
:query_params => query_params,
|
|
844
|
+
:form_params => form_params,
|
|
845
|
+
:body => post_body,
|
|
846
|
+
:auth_names => auth_names)
|
|
847
|
+
if @api_client.config.debugging
|
|
848
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_ip_dissociate_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
849
|
+
end
|
|
850
|
+
return data, status_code, headers
|
|
851
|
+
end
|
|
852
|
+
# Create an API key for a sub-account
|
|
853
|
+
# This endpoint will generate an API v3 key for a sub account
|
|
854
|
+
# @param create_api_key_request Values to generate API key for sub-account
|
|
855
|
+
# @param [Hash] opts the optional parameters
|
|
856
|
+
# @return [CreateApiKeyResponse]
|
|
857
|
+
def corporate_sub_account_key_post(create_api_key_request, opts = {})
|
|
858
|
+
data, _status_code, _headers = corporate_sub_account_key_post_with_http_info(create_api_key_request, opts)
|
|
859
|
+
data
|
|
860
|
+
end
|
|
861
|
+
|
|
862
|
+
# Create an API key for a sub-account
|
|
863
|
+
# This endpoint will generate an API v3 key for a sub account
|
|
864
|
+
# @param create_api_key_request Values to generate API key for sub-account
|
|
865
|
+
# @param [Hash] opts the optional parameters
|
|
866
|
+
# @return [Array<(CreateApiKeyResponse, Fixnum, Hash)>] CreateApiKeyResponse data, response status code and response headers
|
|
867
|
+
def corporate_sub_account_key_post_with_http_info(create_api_key_request, opts = {})
|
|
868
|
+
if @api_client.config.debugging
|
|
869
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_key_post ...'
|
|
870
|
+
end
|
|
871
|
+
# verify the required parameter 'create_api_key_request' is set
|
|
872
|
+
if @api_client.config.client_side_validation && create_api_key_request.nil?
|
|
873
|
+
fail ArgumentError, "Missing the required parameter 'create_api_key_request' when calling MasterAccountApi.corporate_sub_account_key_post"
|
|
874
|
+
end
|
|
875
|
+
# resource path
|
|
876
|
+
local_var_path = '/corporate/subAccount/key'
|
|
877
|
+
|
|
878
|
+
# query parameters
|
|
879
|
+
query_params = {}
|
|
880
|
+
|
|
881
|
+
# header parameters
|
|
882
|
+
header_params = {}
|
|
883
|
+
# HTTP header 'Accept' (if needed)
|
|
884
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
885
|
+
# HTTP header 'Content-Type'
|
|
886
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
887
|
+
|
|
888
|
+
# form parameters
|
|
889
|
+
form_params = {}
|
|
890
|
+
|
|
891
|
+
# http body (model)
|
|
892
|
+
post_body = @api_client.object_to_http_body(create_api_key_request)
|
|
893
|
+
auth_names = ['api-key', 'partner-key']
|
|
894
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
895
|
+
:header_params => header_params,
|
|
896
|
+
:query_params => query_params,
|
|
897
|
+
:form_params => form_params,
|
|
898
|
+
:body => post_body,
|
|
899
|
+
:auth_names => auth_names,
|
|
900
|
+
:return_type => 'CreateApiKeyResponse')
|
|
901
|
+
if @api_client.config.debugging
|
|
902
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_key_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
903
|
+
end
|
|
904
|
+
return data, status_code, headers
|
|
905
|
+
end
|
|
906
|
+
# Create a new sub-account under a master account.
|
|
907
|
+
# This endpoint will create a new sub-account under a master account
|
|
908
|
+
# @param sub_account_create values to create new sub-account
|
|
909
|
+
# @param [Hash] opts the optional parameters
|
|
910
|
+
# @return [CreateSubAccountResponse]
|
|
911
|
+
def corporate_sub_account_post(sub_account_create, opts = {})
|
|
912
|
+
data, _status_code, _headers = corporate_sub_account_post_with_http_info(sub_account_create, opts)
|
|
913
|
+
data
|
|
914
|
+
end
|
|
915
|
+
|
|
916
|
+
# Create a new sub-account under a master account.
|
|
917
|
+
# This endpoint will create a new sub-account under a master account
|
|
918
|
+
# @param sub_account_create values to create new sub-account
|
|
919
|
+
# @param [Hash] opts the optional parameters
|
|
920
|
+
# @return [Array<(CreateSubAccountResponse, Fixnum, Hash)>] CreateSubAccountResponse data, response status code and response headers
|
|
921
|
+
def corporate_sub_account_post_with_http_info(sub_account_create, opts = {})
|
|
922
|
+
if @api_client.config.debugging
|
|
923
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_post ...'
|
|
924
|
+
end
|
|
925
|
+
# verify the required parameter 'sub_account_create' is set
|
|
926
|
+
if @api_client.config.client_side_validation && sub_account_create.nil?
|
|
927
|
+
fail ArgumentError, "Missing the required parameter 'sub_account_create' when calling MasterAccountApi.corporate_sub_account_post"
|
|
928
|
+
end
|
|
929
|
+
# resource path
|
|
930
|
+
local_var_path = '/corporate/subAccount'
|
|
931
|
+
|
|
932
|
+
# query parameters
|
|
933
|
+
query_params = {}
|
|
934
|
+
|
|
935
|
+
# header parameters
|
|
936
|
+
header_params = {}
|
|
937
|
+
# HTTP header 'Accept' (if needed)
|
|
938
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
939
|
+
# HTTP header 'Content-Type'
|
|
940
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
941
|
+
|
|
942
|
+
# form parameters
|
|
943
|
+
form_params = {}
|
|
944
|
+
|
|
945
|
+
# http body (model)
|
|
946
|
+
post_body = @api_client.object_to_http_body(sub_account_create)
|
|
947
|
+
auth_names = ['api-key', 'partner-key']
|
|
948
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
949
|
+
:header_params => header_params,
|
|
950
|
+
:query_params => query_params,
|
|
951
|
+
:form_params => form_params,
|
|
952
|
+
:body => post_body,
|
|
953
|
+
:auth_names => auth_names,
|
|
954
|
+
:return_type => 'CreateSubAccountResponse')
|
|
955
|
+
if @api_client.config.debugging
|
|
956
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
957
|
+
end
|
|
958
|
+
return data, status_code, headers
|
|
959
|
+
end
|
|
960
|
+
# Generate SSO token to access sub-account
|
|
961
|
+
# 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.
|
|
962
|
+
# @param sso_token_request Values to generate SSO token for sub-account
|
|
963
|
+
# @param [Hash] opts the optional parameters
|
|
964
|
+
# @return [GetSsoToken]
|
|
965
|
+
def corporate_sub_account_sso_token_post(sso_token_request, opts = {})
|
|
966
|
+
data, _status_code, _headers = corporate_sub_account_sso_token_post_with_http_info(sso_token_request, opts)
|
|
967
|
+
data
|
|
968
|
+
end
|
|
969
|
+
|
|
970
|
+
# Generate SSO token to access sub-account
|
|
971
|
+
# 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.
|
|
972
|
+
# @param sso_token_request Values to generate SSO token for sub-account
|
|
973
|
+
# @param [Hash] opts the optional parameters
|
|
974
|
+
# @return [Array<(GetSsoToken, Fixnum, Hash)>] GetSsoToken data, response status code and response headers
|
|
975
|
+
def corporate_sub_account_sso_token_post_with_http_info(sso_token_request, opts = {})
|
|
976
|
+
if @api_client.config.debugging
|
|
977
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_sso_token_post ...'
|
|
978
|
+
end
|
|
979
|
+
# verify the required parameter 'sso_token_request' is set
|
|
980
|
+
if @api_client.config.client_side_validation && sso_token_request.nil?
|
|
981
|
+
fail ArgumentError, "Missing the required parameter 'sso_token_request' when calling MasterAccountApi.corporate_sub_account_sso_token_post"
|
|
982
|
+
end
|
|
983
|
+
# resource path
|
|
984
|
+
local_var_path = '/corporate/subAccount/ssoToken'
|
|
985
|
+
|
|
986
|
+
# query parameters
|
|
987
|
+
query_params = {}
|
|
988
|
+
|
|
989
|
+
# header parameters
|
|
990
|
+
header_params = {}
|
|
991
|
+
# HTTP header 'Accept' (if needed)
|
|
992
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
993
|
+
# HTTP header 'Content-Type'
|
|
994
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
995
|
+
|
|
996
|
+
# form parameters
|
|
997
|
+
form_params = {}
|
|
998
|
+
|
|
999
|
+
# http body (model)
|
|
1000
|
+
post_body = @api_client.object_to_http_body(sso_token_request)
|
|
1001
|
+
auth_names = ['api-key', 'partner-key']
|
|
1002
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
1003
|
+
:header_params => header_params,
|
|
1004
|
+
:query_params => query_params,
|
|
1005
|
+
:form_params => form_params,
|
|
1006
|
+
:body => post_body,
|
|
1007
|
+
:auth_names => auth_names,
|
|
1008
|
+
:return_type => 'GetSsoToken')
|
|
1009
|
+
if @api_client.config.debugging
|
|
1010
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_sso_token_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1011
|
+
end
|
|
1012
|
+
return data, status_code, headers
|
|
1013
|
+
end
|
|
1014
|
+
# Update sub-accounts plan
|
|
1015
|
+
# 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.
|
|
1016
|
+
# @param update_plan_details Values to update sub-accounts plan
|
|
1017
|
+
# @param [Hash] opts the optional parameters
|
|
1018
|
+
# @return [nil]
|
|
1019
|
+
def corporate_sub_accounts_plan_put(update_plan_details, opts = {})
|
|
1020
|
+
corporate_sub_accounts_plan_put_with_http_info(update_plan_details, opts)
|
|
1021
|
+
nil
|
|
1022
|
+
end
|
|
1023
|
+
|
|
1024
|
+
# Update sub-accounts plan
|
|
1025
|
+
# 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.
|
|
1026
|
+
# @param update_plan_details Values to update sub-accounts plan
|
|
1027
|
+
# @param [Hash] opts the optional parameters
|
|
1028
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1029
|
+
def corporate_sub_accounts_plan_put_with_http_info(update_plan_details, opts = {})
|
|
1030
|
+
if @api_client.config.debugging
|
|
1031
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_accounts_plan_put ...'
|
|
1032
|
+
end
|
|
1033
|
+
# verify the required parameter 'update_plan_details' is set
|
|
1034
|
+
if @api_client.config.client_side_validation && update_plan_details.nil?
|
|
1035
|
+
fail ArgumentError, "Missing the required parameter 'update_plan_details' when calling MasterAccountApi.corporate_sub_accounts_plan_put"
|
|
1036
|
+
end
|
|
1037
|
+
# resource path
|
|
1038
|
+
local_var_path = '/corporate/subAccounts/plan'
|
|
1039
|
+
|
|
1040
|
+
# query parameters
|
|
1041
|
+
query_params = {}
|
|
1042
|
+
|
|
1043
|
+
# header parameters
|
|
1044
|
+
header_params = {}
|
|
1045
|
+
# HTTP header 'Accept' (if needed)
|
|
1046
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1047
|
+
# HTTP header 'Content-Type'
|
|
1048
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1049
|
+
|
|
1050
|
+
# form parameters
|
|
1051
|
+
form_params = {}
|
|
1052
|
+
|
|
1053
|
+
# http body (model)
|
|
1054
|
+
post_body = @api_client.object_to_http_body(update_plan_details)
|
|
1055
|
+
auth_names = ['api-key', 'partner-key']
|
|
1056
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1057
|
+
:header_params => header_params,
|
|
1058
|
+
:query_params => query_params,
|
|
1059
|
+
:form_params => form_params,
|
|
1060
|
+
:body => post_body,
|
|
1061
|
+
:auth_names => auth_names)
|
|
1062
|
+
if @api_client.config.debugging
|
|
1063
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_accounts_plan_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1064
|
+
end
|
|
1065
|
+
return data, status_code, headers
|
|
1066
|
+
end
|
|
1067
|
+
# Change admin user permissions
|
|
1068
|
+
# This endpoint will allow you to change the permissions of Admin users of your Admin account
|
|
1069
|
+
# @param email Email address of Admin user
|
|
1070
|
+
# @param body Values to update an admin user permissions
|
|
1071
|
+
# @param [Hash] opts the optional parameters
|
|
1072
|
+
# @return [nil]
|
|
1073
|
+
def corporate_user_email_permissions_put(email, body, opts = {})
|
|
1074
|
+
corporate_user_email_permissions_put_with_http_info(email, body, opts)
|
|
1075
|
+
nil
|
|
1076
|
+
end
|
|
1077
|
+
|
|
1078
|
+
# Change admin user permissions
|
|
1079
|
+
# This endpoint will allow you to change the permissions of Admin users of your Admin account
|
|
1080
|
+
# @param email Email address of Admin user
|
|
1081
|
+
# @param body Values to update an admin user permissions
|
|
1082
|
+
# @param [Hash] opts the optional parameters
|
|
1083
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1084
|
+
def corporate_user_email_permissions_put_with_http_info(email, body, opts = {})
|
|
1085
|
+
if @api_client.config.debugging
|
|
1086
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_user_email_permissions_put ...'
|
|
1087
|
+
end
|
|
1088
|
+
# verify the required parameter 'email' is set
|
|
1089
|
+
if @api_client.config.client_side_validation && email.nil?
|
|
1090
|
+
fail ArgumentError, "Missing the required parameter 'email' when calling MasterAccountApi.corporate_user_email_permissions_put"
|
|
1091
|
+
end
|
|
1092
|
+
# verify the required parameter 'body' is set
|
|
1093
|
+
if @api_client.config.client_side_validation && body.nil?
|
|
1094
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling MasterAccountApi.corporate_user_email_permissions_put"
|
|
1095
|
+
end
|
|
1096
|
+
# resource path
|
|
1097
|
+
local_var_path = '/corporate/user/{email}/permissions'.sub('{' + 'email' + '}', email.to_s)
|
|
1098
|
+
|
|
1099
|
+
# query parameters
|
|
1100
|
+
query_params = {}
|
|
1101
|
+
|
|
1102
|
+
# header parameters
|
|
1103
|
+
header_params = {}
|
|
1104
|
+
# HTTP header 'Accept' (if needed)
|
|
1105
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1106
|
+
# HTTP header 'Content-Type'
|
|
1107
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1108
|
+
|
|
1109
|
+
# form parameters
|
|
1110
|
+
form_params = {}
|
|
1111
|
+
|
|
1112
|
+
# http body (model)
|
|
1113
|
+
post_body = @api_client.object_to_http_body(body)
|
|
1114
|
+
auth_names = ['api-key', 'partner-key']
|
|
1115
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1116
|
+
:header_params => header_params,
|
|
1117
|
+
:query_params => query_params,
|
|
1118
|
+
:form_params => form_params,
|
|
1119
|
+
:body => post_body,
|
|
1120
|
+
:auth_names => auth_names)
|
|
1121
|
+
if @api_client.config.debugging
|
|
1122
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_user_email_permissions_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1123
|
+
end
|
|
1124
|
+
return data, status_code, headers
|
|
1125
|
+
end
|
|
1126
|
+
# Resend / cancel admin user invitation
|
|
1127
|
+
# This endpoint will allow the user to: - Resend an admin user invitation - Cancel an admin user invitation
|
|
1128
|
+
# @param action Action to be performed (cancel / resend)
|
|
1129
|
+
# @param email Email address of the recipient
|
|
1130
|
+
# @param [Hash] opts the optional parameters
|
|
1131
|
+
# @return [InlineResponse200]
|
|
1132
|
+
def corporate_user_invitation_action_email_put(action, email, opts = {})
|
|
1133
|
+
data, _status_code, _headers = corporate_user_invitation_action_email_put_with_http_info(action, email, opts)
|
|
1134
|
+
data
|
|
1135
|
+
end
|
|
1136
|
+
|
|
1137
|
+
# Resend / cancel admin user invitation
|
|
1138
|
+
# This endpoint will allow the user to: - Resend an admin user invitation - Cancel an admin user invitation
|
|
1139
|
+
# @param action Action to be performed (cancel / resend)
|
|
1140
|
+
# @param email Email address of the recipient
|
|
1141
|
+
# @param [Hash] opts the optional parameters
|
|
1142
|
+
# @return [Array<(InlineResponse200, Fixnum, Hash)>] InlineResponse200 data, response status code and response headers
|
|
1143
|
+
def corporate_user_invitation_action_email_put_with_http_info(action, email, opts = {})
|
|
1144
|
+
if @api_client.config.debugging
|
|
1145
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_user_invitation_action_email_put ...'
|
|
1146
|
+
end
|
|
1147
|
+
# verify the required parameter 'action' is set
|
|
1148
|
+
if @api_client.config.client_side_validation && action.nil?
|
|
1149
|
+
fail ArgumentError, "Missing the required parameter 'action' when calling MasterAccountApi.corporate_user_invitation_action_email_put"
|
|
1150
|
+
end
|
|
1151
|
+
# verify the required parameter 'email' is set
|
|
1152
|
+
if @api_client.config.client_side_validation && email.nil?
|
|
1153
|
+
fail ArgumentError, "Missing the required parameter 'email' when calling MasterAccountApi.corporate_user_invitation_action_email_put"
|
|
1154
|
+
end
|
|
1155
|
+
# resource path
|
|
1156
|
+
local_var_path = '/corporate/user/invitation/{action}/{email}'.sub('{' + 'action' + '}', action.to_s).sub('{' + 'email' + '}', email.to_s)
|
|
1157
|
+
|
|
1158
|
+
# query parameters
|
|
1159
|
+
query_params = {}
|
|
1160
|
+
|
|
1161
|
+
# header parameters
|
|
1162
|
+
header_params = {}
|
|
1163
|
+
# HTTP header 'Accept' (if needed)
|
|
1164
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1165
|
+
# HTTP header 'Content-Type'
|
|
1166
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1167
|
+
|
|
1168
|
+
# form parameters
|
|
1169
|
+
form_params = {}
|
|
1170
|
+
|
|
1171
|
+
# http body (model)
|
|
1172
|
+
post_body = nil
|
|
1173
|
+
auth_names = ['api-key', 'partner-key']
|
|
1174
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1175
|
+
:header_params => header_params,
|
|
1176
|
+
:query_params => query_params,
|
|
1177
|
+
:form_params => form_params,
|
|
1178
|
+
:body => post_body,
|
|
1179
|
+
:auth_names => auth_names,
|
|
1180
|
+
:return_type => 'InlineResponse200')
|
|
1181
|
+
if @api_client.config.debugging
|
|
1182
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_user_invitation_action_email_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1183
|
+
end
|
|
1184
|
+
return data, status_code, headers
|
|
1185
|
+
end
|
|
1186
|
+
# Revoke an admin user
|
|
1187
|
+
# This endpoint allows to revoke/remove an invited member of your Admin account
|
|
1188
|
+
# @param email Email of the invited user
|
|
1189
|
+
# @param [Hash] opts the optional parameters
|
|
1190
|
+
# @return [nil]
|
|
1191
|
+
def corporate_user_revoke_email_delete(email, opts = {})
|
|
1192
|
+
corporate_user_revoke_email_delete_with_http_info(email, opts)
|
|
1193
|
+
nil
|
|
1194
|
+
end
|
|
1195
|
+
|
|
1196
|
+
# Revoke an admin user
|
|
1197
|
+
# This endpoint allows to revoke/remove an invited member of your Admin account
|
|
1198
|
+
# @param email Email of the invited user
|
|
1199
|
+
# @param [Hash] opts the optional parameters
|
|
1200
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1201
|
+
def corporate_user_revoke_email_delete_with_http_info(email, opts = {})
|
|
1202
|
+
if @api_client.config.debugging
|
|
1203
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_user_revoke_email_delete ...'
|
|
1204
|
+
end
|
|
1205
|
+
# verify the required parameter 'email' is set
|
|
1206
|
+
if @api_client.config.client_side_validation && email.nil?
|
|
1207
|
+
fail ArgumentError, "Missing the required parameter 'email' when calling MasterAccountApi.corporate_user_revoke_email_delete"
|
|
1208
|
+
end
|
|
1209
|
+
# resource path
|
|
1210
|
+
local_var_path = '/corporate/user/revoke/{email}'.sub('{' + 'email' + '}', email.to_s)
|
|
1211
|
+
|
|
1212
|
+
# query parameters
|
|
1213
|
+
query_params = {}
|
|
1214
|
+
|
|
1215
|
+
# header parameters
|
|
1216
|
+
header_params = {}
|
|
1217
|
+
# HTTP header 'Accept' (if needed)
|
|
1218
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1219
|
+
# HTTP header 'Content-Type'
|
|
1220
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1221
|
+
|
|
1222
|
+
# form parameters
|
|
1223
|
+
form_params = {}
|
|
1224
|
+
|
|
1225
|
+
# http body (model)
|
|
1226
|
+
post_body = nil
|
|
1227
|
+
auth_names = ['api-key', 'partner-key']
|
|
1228
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
1229
|
+
:header_params => header_params,
|
|
1230
|
+
:query_params => query_params,
|
|
1231
|
+
:form_params => form_params,
|
|
1232
|
+
:body => post_body,
|
|
1233
|
+
:auth_names => auth_names)
|
|
1234
|
+
if @api_client.config.debugging
|
|
1235
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#corporate_user_revoke_email_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1236
|
+
end
|
|
1237
|
+
return data, status_code, headers
|
|
1238
|
+
end
|
|
1239
|
+
# Get user activity logs
|
|
1240
|
+
# @param [Hash] opts the optional parameters
|
|
1241
|
+
# @option opts [String] :start_date 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.
|
|
530
1242
|
# @option opts [String] :end_date 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.
|
|
1243
|
+
# @option opts [String] :email Enter the user's email address to filter their activity in the account.
|
|
531
1244
|
# @option opts [Integer] :limit Number of documents per page (default to 10)
|
|
532
1245
|
# @option opts [Integer] :offset Index of the first document in the page. (default to 0)
|
|
533
1246
|
# @return [GetAccountActivity]
|
|
@@ -540,6 +1253,7 @@ module Brevo
|
|
|
540
1253
|
# @param [Hash] opts the optional parameters
|
|
541
1254
|
# @option opts [String] :start_date 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.
|
|
542
1255
|
# @option opts [String] :end_date 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.
|
|
1256
|
+
# @option opts [String] :email Enter the user's email address to filter their activity in the account.
|
|
543
1257
|
# @option opts [Integer] :limit Number of documents per page
|
|
544
1258
|
# @option opts [Integer] :offset Index of the first document in the page.
|
|
545
1259
|
# @return [Array<(GetAccountActivity, Fixnum, Hash)>] GetAccountActivity data, response status code and response headers
|
|
@@ -562,6 +1276,7 @@ module Brevo
|
|
|
562
1276
|
query_params = {}
|
|
563
1277
|
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
|
564
1278
|
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
|
1279
|
+
query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
|
|
565
1280
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
566
1281
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
567
1282
|
|
|
@@ -590,5 +1305,209 @@ module Brevo
|
|
|
590
1305
|
end
|
|
591
1306
|
return data, status_code, headers
|
|
592
1307
|
end
|
|
1308
|
+
# Get the list of all admin users
|
|
1309
|
+
# This endpoint allows you to list all Admin users of your Admin account
|
|
1310
|
+
# @param [Hash] opts the optional parameters
|
|
1311
|
+
# @return [GetCorporateInvitedUsersList]
|
|
1312
|
+
def get_corporate_invited_users_list(opts = {})
|
|
1313
|
+
data, _status_code, _headers = get_corporate_invited_users_list_with_http_info(opts)
|
|
1314
|
+
data
|
|
1315
|
+
end
|
|
1316
|
+
|
|
1317
|
+
# Get the list of all admin users
|
|
1318
|
+
# This endpoint allows you to list all Admin users of your Admin account
|
|
1319
|
+
# @param [Hash] opts the optional parameters
|
|
1320
|
+
# @return [Array<(GetCorporateInvitedUsersList, Fixnum, Hash)>] GetCorporateInvitedUsersList data, response status code and response headers
|
|
1321
|
+
def get_corporate_invited_users_list_with_http_info(opts = {})
|
|
1322
|
+
if @api_client.config.debugging
|
|
1323
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.get_corporate_invited_users_list ...'
|
|
1324
|
+
end
|
|
1325
|
+
# resource path
|
|
1326
|
+
local_var_path = '/corporate/invited/users'
|
|
1327
|
+
|
|
1328
|
+
# query parameters
|
|
1329
|
+
query_params = {}
|
|
1330
|
+
|
|
1331
|
+
# header parameters
|
|
1332
|
+
header_params = {}
|
|
1333
|
+
# HTTP header 'Accept' (if needed)
|
|
1334
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1335
|
+
# HTTP header 'Content-Type'
|
|
1336
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1337
|
+
|
|
1338
|
+
# form parameters
|
|
1339
|
+
form_params = {}
|
|
1340
|
+
|
|
1341
|
+
# http body (model)
|
|
1342
|
+
post_body = nil
|
|
1343
|
+
auth_names = ['api-key', 'partner-key']
|
|
1344
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1345
|
+
:header_params => header_params,
|
|
1346
|
+
:query_params => query_params,
|
|
1347
|
+
:form_params => form_params,
|
|
1348
|
+
:body => post_body,
|
|
1349
|
+
:auth_names => auth_names,
|
|
1350
|
+
:return_type => 'GetCorporateInvitedUsersList')
|
|
1351
|
+
if @api_client.config.debugging
|
|
1352
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#get_corporate_invited_users_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1353
|
+
end
|
|
1354
|
+
return data, status_code, headers
|
|
1355
|
+
end
|
|
1356
|
+
# Check admin user permissions
|
|
1357
|
+
# This endpoint will provide the list of admin user permissions
|
|
1358
|
+
# @param email Email of the invited user
|
|
1359
|
+
# @param [Hash] opts the optional parameters
|
|
1360
|
+
# @return [GetCorporateUserPermission]
|
|
1361
|
+
def get_corporate_user_permission(email, opts = {})
|
|
1362
|
+
data, _status_code, _headers = get_corporate_user_permission_with_http_info(email, opts)
|
|
1363
|
+
data
|
|
1364
|
+
end
|
|
1365
|
+
|
|
1366
|
+
# Check admin user permissions
|
|
1367
|
+
# This endpoint will provide the list of admin user permissions
|
|
1368
|
+
# @param email Email of the invited user
|
|
1369
|
+
# @param [Hash] opts the optional parameters
|
|
1370
|
+
# @return [Array<(GetCorporateUserPermission, Fixnum, Hash)>] GetCorporateUserPermission data, response status code and response headers
|
|
1371
|
+
def get_corporate_user_permission_with_http_info(email, opts = {})
|
|
1372
|
+
if @api_client.config.debugging
|
|
1373
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.get_corporate_user_permission ...'
|
|
1374
|
+
end
|
|
1375
|
+
# verify the required parameter 'email' is set
|
|
1376
|
+
if @api_client.config.client_side_validation && email.nil?
|
|
1377
|
+
fail ArgumentError, "Missing the required parameter 'email' when calling MasterAccountApi.get_corporate_user_permission"
|
|
1378
|
+
end
|
|
1379
|
+
# resource path
|
|
1380
|
+
local_var_path = '/corporate/user/{email}/permissions'.sub('{' + 'email' + '}', email.to_s)
|
|
1381
|
+
|
|
1382
|
+
# query parameters
|
|
1383
|
+
query_params = {}
|
|
1384
|
+
|
|
1385
|
+
# header parameters
|
|
1386
|
+
header_params = {}
|
|
1387
|
+
# HTTP header 'Accept' (if needed)
|
|
1388
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1389
|
+
# HTTP header 'Content-Type'
|
|
1390
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1391
|
+
|
|
1392
|
+
# form parameters
|
|
1393
|
+
form_params = {}
|
|
1394
|
+
|
|
1395
|
+
# http body (model)
|
|
1396
|
+
post_body = nil
|
|
1397
|
+
auth_names = ['api-key', 'partner-key']
|
|
1398
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1399
|
+
:header_params => header_params,
|
|
1400
|
+
:query_params => query_params,
|
|
1401
|
+
:form_params => form_params,
|
|
1402
|
+
:body => post_body,
|
|
1403
|
+
:auth_names => auth_names,
|
|
1404
|
+
:return_type => 'GetCorporateUserPermission')
|
|
1405
|
+
if @api_client.config.debugging
|
|
1406
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#get_corporate_user_permission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1407
|
+
end
|
|
1408
|
+
return data, status_code, headers
|
|
1409
|
+
end
|
|
1410
|
+
# Get the list of groups
|
|
1411
|
+
# This endpoint allows you to list all groups created on your Admin account.
|
|
1412
|
+
# @param [Hash] opts the optional parameters
|
|
1413
|
+
# @return [Array<InlineResponse2001>]
|
|
1414
|
+
def get_sub_account_groups(opts = {})
|
|
1415
|
+
data, _status_code, _headers = get_sub_account_groups_with_http_info(opts)
|
|
1416
|
+
data
|
|
1417
|
+
end
|
|
1418
|
+
|
|
1419
|
+
# Get the list of groups
|
|
1420
|
+
# This endpoint allows you to list all groups created on your Admin account.
|
|
1421
|
+
# @param [Hash] opts the optional parameters
|
|
1422
|
+
# @return [Array<(Array<InlineResponse2001>, Fixnum, Hash)>] Array<InlineResponse2001> data, response status code and response headers
|
|
1423
|
+
def get_sub_account_groups_with_http_info(opts = {})
|
|
1424
|
+
if @api_client.config.debugging
|
|
1425
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.get_sub_account_groups ...'
|
|
1426
|
+
end
|
|
1427
|
+
# resource path
|
|
1428
|
+
local_var_path = '/corporate/groups'
|
|
1429
|
+
|
|
1430
|
+
# query parameters
|
|
1431
|
+
query_params = {}
|
|
1432
|
+
|
|
1433
|
+
# header parameters
|
|
1434
|
+
header_params = {}
|
|
1435
|
+
# HTTP header 'Accept' (if needed)
|
|
1436
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1437
|
+
# HTTP header 'Content-Type'
|
|
1438
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1439
|
+
|
|
1440
|
+
# form parameters
|
|
1441
|
+
form_params = {}
|
|
1442
|
+
|
|
1443
|
+
# http body (model)
|
|
1444
|
+
post_body = nil
|
|
1445
|
+
auth_names = ['api-key', 'partner-key']
|
|
1446
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1447
|
+
:header_params => header_params,
|
|
1448
|
+
:query_params => query_params,
|
|
1449
|
+
:form_params => form_params,
|
|
1450
|
+
:body => post_body,
|
|
1451
|
+
:auth_names => auth_names,
|
|
1452
|
+
:return_type => 'Array<InlineResponse2001>')
|
|
1453
|
+
if @api_client.config.debugging
|
|
1454
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#get_sub_account_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1455
|
+
end
|
|
1456
|
+
return data, status_code, headers
|
|
1457
|
+
end
|
|
1458
|
+
# Send invitation to an admin user
|
|
1459
|
+
# `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.
|
|
1460
|
+
# @param send_invitation Payload to send an invitation
|
|
1461
|
+
# @param [Hash] opts the optional parameters
|
|
1462
|
+
# @return [InviteAdminUser]
|
|
1463
|
+
def invite_admin_user(send_invitation, opts = {})
|
|
1464
|
+
data, _status_code, _headers = invite_admin_user_with_http_info(send_invitation, opts)
|
|
1465
|
+
data
|
|
1466
|
+
end
|
|
1467
|
+
|
|
1468
|
+
# Send invitation to an admin user
|
|
1469
|
+
# `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.
|
|
1470
|
+
# @param send_invitation Payload to send an invitation
|
|
1471
|
+
# @param [Hash] opts the optional parameters
|
|
1472
|
+
# @return [Array<(InviteAdminUser, Fixnum, Hash)>] InviteAdminUser data, response status code and response headers
|
|
1473
|
+
def invite_admin_user_with_http_info(send_invitation, opts = {})
|
|
1474
|
+
if @api_client.config.debugging
|
|
1475
|
+
@api_client.config.logger.debug 'Calling API: MasterAccountApi.invite_admin_user ...'
|
|
1476
|
+
end
|
|
1477
|
+
# verify the required parameter 'send_invitation' is set
|
|
1478
|
+
if @api_client.config.client_side_validation && send_invitation.nil?
|
|
1479
|
+
fail ArgumentError, "Missing the required parameter 'send_invitation' when calling MasterAccountApi.invite_admin_user"
|
|
1480
|
+
end
|
|
1481
|
+
# resource path
|
|
1482
|
+
local_var_path = '/corporate/user/invitation/send'
|
|
1483
|
+
|
|
1484
|
+
# query parameters
|
|
1485
|
+
query_params = {}
|
|
1486
|
+
|
|
1487
|
+
# header parameters
|
|
1488
|
+
header_params = {}
|
|
1489
|
+
# HTTP header 'Accept' (if needed)
|
|
1490
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1491
|
+
# HTTP header 'Content-Type'
|
|
1492
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1493
|
+
|
|
1494
|
+
# form parameters
|
|
1495
|
+
form_params = {}
|
|
1496
|
+
|
|
1497
|
+
# http body (model)
|
|
1498
|
+
post_body = @api_client.object_to_http_body(send_invitation)
|
|
1499
|
+
auth_names = ['api-key', 'partner-key']
|
|
1500
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
1501
|
+
:header_params => header_params,
|
|
1502
|
+
:query_params => query_params,
|
|
1503
|
+
:form_params => form_params,
|
|
1504
|
+
:body => post_body,
|
|
1505
|
+
:auth_names => auth_names,
|
|
1506
|
+
:return_type => 'InviteAdminUser')
|
|
1507
|
+
if @api_client.config.debugging
|
|
1508
|
+
@api_client.config.logger.debug "API called: MasterAccountApi#invite_admin_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1509
|
+
end
|
|
1510
|
+
return data, status_code, headers
|
|
1511
|
+
end
|
|
593
1512
|
end
|
|
594
1513
|
end
|