brevo 3.0.0 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +210 -39
- 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/Body1.md +2 -2
- data/docs/Body10.md +4 -10
- data/docs/Body11.md +4 -6
- data/docs/Body12.md +4 -1
- data/docs/Body13.md +11 -4
- data/docs/Body14.md +10 -1
- data/docs/Body15.md +4 -2
- 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 -1
- data/docs/Body3.md +2 -3
- data/docs/Body4.md +1 -3
- data/docs/Body5.md +2 -4
- data/docs/Body6.md +5 -2
- data/docs/Body7.md +5 -2
- data/docs/Body8.md +4 -4
- data/docs/Body9.md +5 -11
- data/docs/Cart.md +9 -0
- data/docs/CompaniesApi.md +183 -58
- data/docs/Configuration.md +8 -0
- data/docs/ContactBalancesResp.md +11 -0
- data/docs/ContactErrorModel.md +10 -0
- data/docs/ContactsApi.md +103 -24
- 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 +1 -1
- data/docs/CorporateuseremailpermissionsPrivileges.md +9 -0
- data/docs/CouponsApi.md +4 -4
- 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/CreateDoiContact.md +1 -1
- 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 +2 -1
- data/docs/DealsApi.md +131 -6
- data/docs/EcommerceApi.md +155 -36
- data/docs/EmailCampaignsApi.md +2 -2
- data/docs/ErrorResponse.md +8 -0
- data/docs/EventIdentifiers.md +5 -5
- 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/GetCorporateInvitedUsersListFeatureAccess.md +5 -0
- data/docs/GetCorporateUserPermissionFeatureAccess.md +5 -0
- data/docs/GetEmailCampaign.md +4 -0
- data/docs/GetExtendedCampaignOverview.md +4 -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/InlineResponse2003.md +1 -3
- 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/InlineResponse400.md +8 -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 +304 -7
- 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/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/RemoveContactFromList.md +4 -3
- data/docs/RequestContactExport.md +5 -1
- data/docs/RequestContactExportCustomContactFilter.md +2 -1
- data/docs/RewardApi.md +664 -0
- data/docs/SendSmtpEmail.md +19 -18
- data/docs/SendTransacSms.md +1 -1
- data/docs/SendTransacSmsTag.md +8 -0
- data/docs/SetConfigDisplayCurrency.md +8 -0
- 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 +4 -4
- 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 +60 -2
- data/docs/TransactionalSMSApi.md +51 -0
- 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/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/UserApi.md +2 -2
- data/docs/ValidationErrors.md +7 -0
- 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 +167 -47
- data/lib/brevo/api/contacts_api.rb +122 -36
- data/lib/brevo/api/conversations_api.rb +3 -3
- data/lib/brevo/api/coupons_api.rb +9 -6
- data/lib/brevo/api/deals_api.rb +121 -1
- data/lib/brevo/api/domains_api.rb +1 -1
- data/lib/brevo/api/ecommerce_api.rb +159 -41
- data/lib/brevo/api/email_campaigns_api.rb +5 -5
- data/lib/brevo/api/events_api.rb +1 -1
- data/lib/brevo/api/external_feeds_api.rb +1 -1
- 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 +278 -7
- 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 +1 -1
- data/lib/brevo/api/tier_api.rb +653 -0
- data/lib/brevo/api/transactional_emails_api.rb +55 -3
- data/lib/brevo/api/transactional_sms_api.rb +48 -3
- data/lib/brevo/api/transactional_whats_app_api.rb +3 -3
- data/lib/brevo/api/user_api.rb +5 -5
- data/lib/brevo/api/webhooks_api.rb +1 -1
- data/lib/brevo/api/whats_app_campaigns_api.rb +1 -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 +1 -1
- data/lib/brevo/models/body_1.rb +25 -20
- data/lib/brevo/models/body_10.rb +31 -88
- data/lib/brevo/models/body_11.rb +34 -60
- data/lib/brevo/models/body_12.rb +47 -14
- data/lib/brevo/models/body_13.rb +131 -36
- data/lib/brevo/models/body_14.rb +105 -14
- data/lib/brevo/models/body_15.rb +34 -4
- 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 +28 -13
- data/lib/brevo/models/body_3.rb +21 -29
- data/lib/brevo/models/body_4.rb +16 -29
- data/lib/brevo/models/body_5.rb +26 -43
- data/lib/brevo/models/body_6.rb +41 -7
- data/lib/brevo/models/body_7.rb +41 -7
- data/lib/brevo/models/body_8.rb +20 -20
- data/lib/brevo/models/body_9.rb +92 -124
- 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/{add_credits.rb → conversations_message_from.rb} +16 -17
- data/lib/brevo/models/{remove_credits.rb → conversations_message_reply_to.rb} +16 -17
- data/lib/brevo/models/conversations_message_to.rb +193 -0
- data/lib/brevo/models/conversion_source_metrics.rb +4 -4
- data/lib/brevo/models/conversion_source_product.rb +1 -1
- data/lib/brevo/models/corporate_group_details_response.rb +1 -1
- data/lib/brevo/models/corporate_group_details_response_group.rb +1 -1
- data/lib/brevo/models/corporate_group_details_response_subaccounts.rb +1 -1
- data/lib/brevo/models/corporate_group_details_response_users.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/brevo/models/create_domain_model_dns_records.rb +1 -1
- 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_reseller.rb → create_payment_response.rb} +20 -20
- 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 +27 -3
- 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 +1 -1
- 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 +1 -1
- data/lib/brevo/models/event_identifiers.rb +21 -31
- data/lib/brevo/models/export_webhooks_history.rb +1 -1
- 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 -1
- data/lib/brevo/models/get_contacts.rb +1 -1
- data/lib/brevo/models/get_corporate_invited_users_list.rb +1 -1
- data/lib/brevo/models/get_corporate_invited_users_list_feature_access.rb +65 -5
- data/lib/brevo/models/get_corporate_invited_users_list_groups.rb +1 -1
- data/lib/brevo/models/get_corporate_invited_users_list_users.rb +1 -1
- data/lib/brevo/models/get_corporate_user_permission.rb +1 -1
- data/lib/brevo/models/get_corporate_user_permission_feature_access.rb +65 -5
- data/lib/brevo/models/get_corporate_user_permission_groups.rb +1 -1
- data/lib/brevo/models/get_coupon_collection.rb +1 -1
- 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 -1
- 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_orders.rb +1 -1
- 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 +1 -1
- data/lib/brevo/models/get_webhook_auth.rb +1 -1
- data/lib/brevo/models/get_webhook_headers.rb +1 -1
- 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 +1 -1
- data/lib/brevo/models/inline_response_200_1.rb +1 -1
- data/lib/brevo/models/inline_response_200_2.rb +1 -1
- data/lib/brevo/models/inline_response_200_3.rb +6 -31
- 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 -1
- data/lib/brevo/models/inline_response_201_1.rb +1 -1
- data/lib/brevo/models/inline_response_201_2.rb +1 -1
- data/lib/brevo/models/inline_response_201_3.rb +1 -1
- data/lib/brevo/models/inline_response_201_4.rb +1 -1
- data/lib/brevo/models/inline_response_201_5.rb +1 -1
- data/lib/brevo/models/inline_response_400.rb +184 -0
- data/lib/brevo/models/invite_admin_user.rb +1 -1
- data/lib/brevo/models/invite_admin_user_privileges.rb +3 -3
- data/lib/brevo/models/inviteuser.rb +1 -1
- data/lib/brevo/models/inviteuser_privileges.rb +3 -3
- 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/{get_children_list.rb → main_code_count_http_response.rb} +4 -16
- 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/{remaining_credit_model_child.rb → main_reward_configurations.rb} +27 -28
- 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 +1 -1
- 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 +1 -1
- 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/put_revoke_user_permission.rb +1 -1
- data/lib/brevo/models/putresendcancelinvitation.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/brevo/models/sub_account_apps_toggle_request.rb +1 -1
- 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 +1 -1
- data/lib/brevo/models/sub_account_details_response_plan_info_features_landing_page.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +146 -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 +37 -11
- data/spec/api/contacts_api_spec.rb +29 -9
- data/spec/api/conversations_api_spec.rb +2 -2
- data/spec/api/coupons_api_spec.rb +3 -3
- data/spec/api/deals_api_spec.rb +27 -1
- data/spec/api/domains_api_spec.rb +1 -1
- data/spec/api/ecommerce_api_spec.rb +40 -16
- data/spec/api/email_campaigns_api_spec.rb +2 -2
- data/spec/api/events_api_spec.rb +1 -1
- data/spec/api/external_feeds_api_spec.rb +1 -1
- 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 +66 -4
- 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 +1 -1
- data/spec/api/tier_api_spec.rb +170 -0
- data/spec/api/transactional_emails_api_spec.rb +13 -2
- data/spec/api/transactional_sms_api_spec.rb +11 -1
- data/spec/api/transactional_whats_app_api_spec.rb +1 -1
- data/spec/api/user_api_spec.rb +3 -3
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/api/whats_app_campaigns_api_spec.rb +1 -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 +4 -40
- data/spec/models/body_11_spec.rb +5 -17
- data/spec/models/body_12_spec.rb +20 -2
- data/spec/models/body_13_spec.rb +47 -5
- data/spec/models/body_14_spec.rb +56 -2
- data/spec/models/body_15_spec.rb +13 -1
- 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 -3
- data/spec/models/body_2_spec.rb +8 -2
- data/spec/models/body_3_spec.rb +3 -9
- data/spec/models/body_4_spec.rb +2 -14
- data/spec/models/body_5_spec.rb +3 -15
- data/spec/models/body_6_spec.rb +19 -1
- data/spec/models/body_7_spec.rb +19 -1
- data/spec/models/body_8_spec.rb +3 -3
- data/spec/models/body_9_spec.rb +14 -42
- data/spec/models/body_spec.rb +1 -1
- 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 +2 -2
- data/spec/models/conversion_source_product_spec.rb +1 -1
- data/spec/models/corporate_group_details_response_group_spec.rb +1 -1
- data/spec/models/corporate_group_details_response_spec.rb +1 -1
- data/spec/models/corporate_group_details_response_subaccounts_spec.rb +1 -1
- data/spec/models/corporate_group_details_response_users_spec.rb +1 -1
- 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 +1 -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 +1 -1
- data/spec/models/create_domain_model_spec.rb +1 -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 +11 -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 +1 -1
- 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 +4 -4
- data/spec/models/event_spec.rb +1 -1
- data/spec/models/export_webhooks_history_spec.rb +1 -1
- 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 +31 -1
- data/spec/models/get_corporate_invited_users_list_groups_spec.rb +1 -1
- data/spec/models/get_corporate_invited_users_list_spec.rb +1 -1
- data/spec/models/get_corporate_invited_users_list_users_spec.rb +1 -1
- data/spec/models/get_corporate_user_permission_feature_access_spec.rb +31 -1
- data/spec/models/get_corporate_user_permission_groups_spec.rb +1 -1
- data/spec/models/get_corporate_user_permission_spec.rb +1 -1
- data/spec/models/get_coupon_collection_spec.rb +1 -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_orders_spec.rb +1 -1
- 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_webhook_auth_spec.rb +1 -1
- data/spec/models/get_webhook_headers_spec.rb +1 -1
- data/spec/models/get_webhook_spec.rb +1 -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 +1 -1
- data/spec/models/inline_response_200_2_spec.rb +1 -1
- data/spec/models/inline_response_200_3_spec.rb +1 -13
- 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/{get_child_info_api_keys_spec.rb → inline_response_200_6_spec.rb} +9 -9
- 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 +1 -1
- 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 +1 -1
- data/spec/models/inline_response_201_4_spec.rb +1 -1
- data/spec/models/inline_response_201_5_spec.rb +1 -1
- 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 +3 -3
- data/spec/models/invite_admin_user_spec.rb +1 -1
- data/spec/models/inviteuser_privileges_spec.rb +3 -3
- data/spec/models/inviteuser_spec.rb +1 -1
- 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/{get_children_list_spec.rb → main_code_count_http_response_spec.rb} +7 -13
- 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/{get_child_info_api_keys_v2_spec.rb → main_reward_page_spec.rb} +9 -9
- 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_v3_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 +1 -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 +1 -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 +1 -1
- data/spec/models/putresendcancelinvitation_spec.rb +1 -1
- 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 +1 -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 +1 -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 +1 -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 +1 -1
- 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 +1 -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 +1 -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 +931 -433
- data/docs/AddCredits.md +0 -9
- data/docs/CreateReseller.md +0 -9
- data/docs/GetChildAccountCreationStatus.md +0 -8
- data/docs/GetChildInfo.md +0 -16
- data/docs/GetChildInfoApiKeys.md +0 -9
- data/docs/GetChildInfoApiKeysV2.md +0 -9
- data/docs/GetChildInfoApiKeysV3.md +0 -9
- data/docs/GetChildInfoCredits.md +0 -9
- data/docs/GetChildInfoStatistics.md +0 -10
- data/docs/GetChildrenList.md +0 -9
- data/docs/RemainingCreditModel.md +0 -9
- data/docs/RemainingCreditModelChild.md +0 -9
- data/docs/RemainingCreditModelReseller.md +0 -9
- data/docs/RemoveCredits.md +0 -9
- data/docs/ResellerApi.md +0 -964
- data/docs/UpdateChildAccountStatus.md +0 -11
- data/docs/UpdateChildDomain.md +0 -8
- data/lib/brevo/api/reseller_api.rb +0 -923
- data/lib/brevo/models/get_child_info_statistics.rb +0 -206
- data/spec/api/reseller_api_spec.rb +0 -223
- data/spec/models/get_child_info_credits_spec.rb +0 -47
- data/spec/models/remaining_credit_model_spec.rb +0 -47
data/docs/ProgramApi.md
ADDED
|
@@ -0,0 +1,695 @@
|
|
|
1
|
+
# Brevo::ProgramApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.brevo.com/v3*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_new_lp**](ProgramApi.md#create_new_lp) | **POST** /loyalty/config/programs | Create loyalty program
|
|
8
|
+
[**delete_contact_members**](ProgramApi.md#delete_contact_members) | **DELETE** /loyalty/config/programs/{pid}/subscription-members | Delete subscription member
|
|
9
|
+
[**delete_loyalty_program**](ProgramApi.md#delete_loyalty_program) | **DELETE** /loyalty/config/programs/{pid} | Delete Loyalty Program
|
|
10
|
+
[**get_loyalty_program_info**](ProgramApi.md#get_loyalty_program_info) | **GET** /loyalty/config/programs/{pid} | Get loyalty program Info
|
|
11
|
+
[**get_lp_list**](ProgramApi.md#get_lp_list) | **GET** /loyalty/config/programs | Get loyalty program list
|
|
12
|
+
[**get_parameter_subscription_info**](ProgramApi.md#get_parameter_subscription_info) | **GET** /loyalty/config/programs/{pid}/account-info | Get Subscription Data
|
|
13
|
+
[**partially_update_loyalty_program**](ProgramApi.md#partially_update_loyalty_program) | **PATCH** /loyalty/config/programs/{pid} | Partially update loyalty program
|
|
14
|
+
[**publish_loyalty_program**](ProgramApi.md#publish_loyalty_program) | **POST** /loyalty/config/programs/{pid}/publish | Publish loyalty program
|
|
15
|
+
[**subscribe_member_to_a_subscription**](ProgramApi.md#subscribe_member_to_a_subscription) | **POST** /loyalty/config/programs/{pid}/subscription-members | Create subscription member
|
|
16
|
+
[**subscribe_to_loyalty_program**](ProgramApi.md#subscribe_to_loyalty_program) | **POST** /loyalty/config/programs/{pid}/subscriptions | Create subscription
|
|
17
|
+
[**update_loyalty_program**](ProgramApi.md#update_loyalty_program) | **PUT** /loyalty/config/programs/{pid} | Update loyalty program
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
# **create_new_lp**
|
|
21
|
+
> LoyaltyProgram create_new_lp(body)
|
|
22
|
+
|
|
23
|
+
Create loyalty program
|
|
24
|
+
|
|
25
|
+
Creates loyalty program
|
|
26
|
+
|
|
27
|
+
### Example
|
|
28
|
+
```ruby
|
|
29
|
+
# load the gem
|
|
30
|
+
require 'brevo'
|
|
31
|
+
# setup authorization
|
|
32
|
+
Brevo.configure do |config|
|
|
33
|
+
# Configure API key authorization: api-key
|
|
34
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
35
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
36
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
37
|
+
|
|
38
|
+
# Configure API key authorization: partner-key
|
|
39
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
40
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
41
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
api_instance = Brevo::ProgramApi.new
|
|
45
|
+
|
|
46
|
+
body = Brevo::CreateLoyaltyProgramPayload.new # CreateLoyaltyProgramPayload | Create Loyalty Program Payload
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
begin
|
|
50
|
+
#Create loyalty program
|
|
51
|
+
result = api_instance.create_new_lp(body)
|
|
52
|
+
p result
|
|
53
|
+
rescue Brevo::ApiError => e
|
|
54
|
+
puts "Exception when calling ProgramApi->create_new_lp: #{e}"
|
|
55
|
+
end
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Parameters
|
|
59
|
+
|
|
60
|
+
Name | Type | Description | Notes
|
|
61
|
+
------------- | ------------- | ------------- | -------------
|
|
62
|
+
**body** | [**CreateLoyaltyProgramPayload**](CreateLoyaltyProgramPayload.md)| Create Loyalty Program Payload |
|
|
63
|
+
|
|
64
|
+
### Return type
|
|
65
|
+
|
|
66
|
+
[**LoyaltyProgram**](LoyaltyProgram.md)
|
|
67
|
+
|
|
68
|
+
### Authorization
|
|
69
|
+
|
|
70
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
71
|
+
|
|
72
|
+
### HTTP request headers
|
|
73
|
+
|
|
74
|
+
- **Content-Type**: application/json
|
|
75
|
+
- **Accept**: application/json
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
# **delete_contact_members**
|
|
80
|
+
> delete_contact_members(pid, member_contact_ids)
|
|
81
|
+
|
|
82
|
+
Delete subscription member
|
|
83
|
+
|
|
84
|
+
Deletes member from a subscription
|
|
85
|
+
|
|
86
|
+
### Example
|
|
87
|
+
```ruby
|
|
88
|
+
# load the gem
|
|
89
|
+
require 'brevo'
|
|
90
|
+
# setup authorization
|
|
91
|
+
Brevo.configure do |config|
|
|
92
|
+
# Configure API key authorization: api-key
|
|
93
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
94
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
95
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
96
|
+
|
|
97
|
+
# Configure API key authorization: partner-key
|
|
98
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
99
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
100
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
api_instance = Brevo::ProgramApi.new
|
|
104
|
+
|
|
105
|
+
pid = 'pid_example' # String | Loyalty Program Id
|
|
106
|
+
|
|
107
|
+
member_contact_ids = 'member_contact_ids_example' # String | Member Contact Ids
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
begin
|
|
111
|
+
#Delete subscription member
|
|
112
|
+
api_instance.delete_contact_members(pid, member_contact_ids)
|
|
113
|
+
rescue Brevo::ApiError => e
|
|
114
|
+
puts "Exception when calling ProgramApi->delete_contact_members: #{e}"
|
|
115
|
+
end
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### Parameters
|
|
119
|
+
|
|
120
|
+
Name | Type | Description | Notes
|
|
121
|
+
------------- | ------------- | ------------- | -------------
|
|
122
|
+
**pid** | [**String**](.md)| Loyalty Program Id |
|
|
123
|
+
**member_contact_ids** | **String**| Member Contact Ids |
|
|
124
|
+
|
|
125
|
+
### Return type
|
|
126
|
+
|
|
127
|
+
nil (empty response body)
|
|
128
|
+
|
|
129
|
+
### Authorization
|
|
130
|
+
|
|
131
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
132
|
+
|
|
133
|
+
### HTTP request headers
|
|
134
|
+
|
|
135
|
+
- **Content-Type**: application/json
|
|
136
|
+
- **Accept**: application/json
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
# **delete_loyalty_program**
|
|
141
|
+
> delete_loyalty_program(pid)
|
|
142
|
+
|
|
143
|
+
Delete Loyalty Program
|
|
144
|
+
|
|
145
|
+
Deletes Loyalty Program
|
|
146
|
+
|
|
147
|
+
### Example
|
|
148
|
+
```ruby
|
|
149
|
+
# load the gem
|
|
150
|
+
require 'brevo'
|
|
151
|
+
# setup authorization
|
|
152
|
+
Brevo.configure do |config|
|
|
153
|
+
# Configure API key authorization: api-key
|
|
154
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
155
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
156
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
157
|
+
|
|
158
|
+
# Configure API key authorization: partner-key
|
|
159
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
160
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
161
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
api_instance = Brevo::ProgramApi.new
|
|
165
|
+
|
|
166
|
+
pid = 'pid_example' # String | Loyalty Program Id
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
begin
|
|
170
|
+
#Delete Loyalty Program
|
|
171
|
+
api_instance.delete_loyalty_program(pid)
|
|
172
|
+
rescue Brevo::ApiError => e
|
|
173
|
+
puts "Exception when calling ProgramApi->delete_loyalty_program: #{e}"
|
|
174
|
+
end
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Parameters
|
|
178
|
+
|
|
179
|
+
Name | Type | Description | Notes
|
|
180
|
+
------------- | ------------- | ------------- | -------------
|
|
181
|
+
**pid** | [**String**](.md)| Loyalty Program Id |
|
|
182
|
+
|
|
183
|
+
### Return type
|
|
184
|
+
|
|
185
|
+
nil (empty response body)
|
|
186
|
+
|
|
187
|
+
### Authorization
|
|
188
|
+
|
|
189
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
190
|
+
|
|
191
|
+
### HTTP request headers
|
|
192
|
+
|
|
193
|
+
- **Content-Type**: application/json
|
|
194
|
+
- **Accept**: application/json
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
# **get_loyalty_program_info**
|
|
199
|
+
> LoyaltyProgram get_loyalty_program_info(pid)
|
|
200
|
+
|
|
201
|
+
Get loyalty program Info
|
|
202
|
+
|
|
203
|
+
Returns loyalty program
|
|
204
|
+
|
|
205
|
+
### Example
|
|
206
|
+
```ruby
|
|
207
|
+
# load the gem
|
|
208
|
+
require 'brevo'
|
|
209
|
+
# setup authorization
|
|
210
|
+
Brevo.configure do |config|
|
|
211
|
+
# Configure API key authorization: api-key
|
|
212
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
213
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
214
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
215
|
+
|
|
216
|
+
# Configure API key authorization: partner-key
|
|
217
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
218
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
219
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
220
|
+
end
|
|
221
|
+
|
|
222
|
+
api_instance = Brevo::ProgramApi.new
|
|
223
|
+
|
|
224
|
+
pid = 'pid_example' # String | Loyalty Program Id
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
begin
|
|
228
|
+
#Get loyalty program Info
|
|
229
|
+
result = api_instance.get_loyalty_program_info(pid)
|
|
230
|
+
p result
|
|
231
|
+
rescue Brevo::ApiError => e
|
|
232
|
+
puts "Exception when calling ProgramApi->get_loyalty_program_info: #{e}"
|
|
233
|
+
end
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
### Parameters
|
|
237
|
+
|
|
238
|
+
Name | Type | Description | Notes
|
|
239
|
+
------------- | ------------- | ------------- | -------------
|
|
240
|
+
**pid** | [**String**](.md)| Loyalty Program Id |
|
|
241
|
+
|
|
242
|
+
### Return type
|
|
243
|
+
|
|
244
|
+
[**LoyaltyProgram**](LoyaltyProgram.md)
|
|
245
|
+
|
|
246
|
+
### Authorization
|
|
247
|
+
|
|
248
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
249
|
+
|
|
250
|
+
### HTTP request headers
|
|
251
|
+
|
|
252
|
+
- **Content-Type**: application/json
|
|
253
|
+
- **Accept**: application/json
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
# **get_lp_list**
|
|
258
|
+
> LoyaltyProgramPage get_lp_list(opts)
|
|
259
|
+
|
|
260
|
+
Get loyalty program list
|
|
261
|
+
|
|
262
|
+
Returns list of loyalty programs
|
|
263
|
+
|
|
264
|
+
### Example
|
|
265
|
+
```ruby
|
|
266
|
+
# load the gem
|
|
267
|
+
require 'brevo'
|
|
268
|
+
# setup authorization
|
|
269
|
+
Brevo.configure do |config|
|
|
270
|
+
# Configure API key authorization: api-key
|
|
271
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
272
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
273
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
274
|
+
|
|
275
|
+
# Configure API key authorization: partner-key
|
|
276
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
277
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
278
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
279
|
+
end
|
|
280
|
+
|
|
281
|
+
api_instance = Brevo::ProgramApi.new
|
|
282
|
+
|
|
283
|
+
opts = {
|
|
284
|
+
limit: 56, # Integer | Number of documents per page
|
|
285
|
+
offset: 56, # Integer | Index of the first document in the page
|
|
286
|
+
sort_field: 'sort_field_example', # String | Sort documents by field
|
|
287
|
+
sort: 'sort_example' # String | Sort the documents in the ascending or descending order
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
begin
|
|
291
|
+
#Get loyalty program list
|
|
292
|
+
result = api_instance.get_lp_list(opts)
|
|
293
|
+
p result
|
|
294
|
+
rescue Brevo::ApiError => e
|
|
295
|
+
puts "Exception when calling ProgramApi->get_lp_list: #{e}"
|
|
296
|
+
end
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
### Parameters
|
|
300
|
+
|
|
301
|
+
Name | Type | Description | Notes
|
|
302
|
+
------------- | ------------- | ------------- | -------------
|
|
303
|
+
**limit** | **Integer**| Number of documents per page | [optional]
|
|
304
|
+
**offset** | **Integer**| Index of the first document in the page | [optional]
|
|
305
|
+
**sort_field** | **String**| Sort documents by field | [optional]
|
|
306
|
+
**sort** | **String**| Sort the documents in the ascending or descending order | [optional]
|
|
307
|
+
|
|
308
|
+
### Return type
|
|
309
|
+
|
|
310
|
+
[**LoyaltyProgramPage**](LoyaltyProgramPage.md)
|
|
311
|
+
|
|
312
|
+
### Authorization
|
|
313
|
+
|
|
314
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
315
|
+
|
|
316
|
+
### HTTP request headers
|
|
317
|
+
|
|
318
|
+
- **Content-Type**: application/json
|
|
319
|
+
- **Accept**: application/json
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
# **get_parameter_subscription_info**
|
|
324
|
+
> SubscriptionHandlerInfo get_parameter_subscription_info(pid, opts)
|
|
325
|
+
|
|
326
|
+
Get Subscription Data
|
|
327
|
+
|
|
328
|
+
Get Information of balances, tiers, rewards and subscription members for a subscription
|
|
329
|
+
|
|
330
|
+
### Example
|
|
331
|
+
```ruby
|
|
332
|
+
# load the gem
|
|
333
|
+
require 'brevo'
|
|
334
|
+
# setup authorization
|
|
335
|
+
Brevo.configure do |config|
|
|
336
|
+
# Configure API key authorization: api-key
|
|
337
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
338
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
339
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
340
|
+
|
|
341
|
+
# Configure API key authorization: partner-key
|
|
342
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
343
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
344
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
345
|
+
end
|
|
346
|
+
|
|
347
|
+
api_instance = Brevo::ProgramApi.new
|
|
348
|
+
|
|
349
|
+
pid = 'pid_example' # String | Loyalty Program Id
|
|
350
|
+
|
|
351
|
+
opts = {
|
|
352
|
+
contact_id: 'contact_id_example', # String | Contact Id
|
|
353
|
+
params: 'params_example', # String | Filter List
|
|
354
|
+
loyalty_subscription_id: 'loyalty_subscription_id_example' # String | Loyalty Subscription Id
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
begin
|
|
358
|
+
#Get Subscription Data
|
|
359
|
+
result = api_instance.get_parameter_subscription_info(pid, opts)
|
|
360
|
+
p result
|
|
361
|
+
rescue Brevo::ApiError => e
|
|
362
|
+
puts "Exception when calling ProgramApi->get_parameter_subscription_info: #{e}"
|
|
363
|
+
end
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
### Parameters
|
|
367
|
+
|
|
368
|
+
Name | Type | Description | Notes
|
|
369
|
+
------------- | ------------- | ------------- | -------------
|
|
370
|
+
**pid** | [**String**](.md)| Loyalty Program Id |
|
|
371
|
+
**contact_id** | **String**| Contact Id | [optional]
|
|
372
|
+
**params** | **String**| Filter List | [optional]
|
|
373
|
+
**loyalty_subscription_id** | **String**| Loyalty Subscription Id | [optional]
|
|
374
|
+
|
|
375
|
+
### Return type
|
|
376
|
+
|
|
377
|
+
[**SubscriptionHandlerInfo**](SubscriptionHandlerInfo.md)
|
|
378
|
+
|
|
379
|
+
### Authorization
|
|
380
|
+
|
|
381
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
382
|
+
|
|
383
|
+
### HTTP request headers
|
|
384
|
+
|
|
385
|
+
- **Content-Type**: application/json
|
|
386
|
+
- **Accept**: application/json
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
# **partially_update_loyalty_program**
|
|
391
|
+
> LoyaltyProgram partially_update_loyalty_program(pid, body)
|
|
392
|
+
|
|
393
|
+
Partially update loyalty program
|
|
394
|
+
|
|
395
|
+
Partially updates loyalty program
|
|
396
|
+
|
|
397
|
+
### Example
|
|
398
|
+
```ruby
|
|
399
|
+
# load the gem
|
|
400
|
+
require 'brevo'
|
|
401
|
+
# setup authorization
|
|
402
|
+
Brevo.configure do |config|
|
|
403
|
+
# Configure API key authorization: api-key
|
|
404
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
405
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
406
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
407
|
+
|
|
408
|
+
# Configure API key authorization: partner-key
|
|
409
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
410
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
411
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
412
|
+
end
|
|
413
|
+
|
|
414
|
+
api_instance = Brevo::ProgramApi.new
|
|
415
|
+
|
|
416
|
+
pid = 'pid_example' # String | Loyalty Program Id
|
|
417
|
+
|
|
418
|
+
body = Brevo::PatchLoyaltyProgramPayload.new # PatchLoyaltyProgramPayload | Loyalty Program Payload
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
begin
|
|
422
|
+
#Partially update loyalty program
|
|
423
|
+
result = api_instance.partially_update_loyalty_program(pid, body)
|
|
424
|
+
p result
|
|
425
|
+
rescue Brevo::ApiError => e
|
|
426
|
+
puts "Exception when calling ProgramApi->partially_update_loyalty_program: #{e}"
|
|
427
|
+
end
|
|
428
|
+
```
|
|
429
|
+
|
|
430
|
+
### Parameters
|
|
431
|
+
|
|
432
|
+
Name | Type | Description | Notes
|
|
433
|
+
------------- | ------------- | ------------- | -------------
|
|
434
|
+
**pid** | [**String**](.md)| Loyalty Program Id |
|
|
435
|
+
**body** | [**PatchLoyaltyProgramPayload**](PatchLoyaltyProgramPayload.md)| Loyalty Program Payload |
|
|
436
|
+
|
|
437
|
+
### Return type
|
|
438
|
+
|
|
439
|
+
[**LoyaltyProgram**](LoyaltyProgram.md)
|
|
440
|
+
|
|
441
|
+
### Authorization
|
|
442
|
+
|
|
443
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
444
|
+
|
|
445
|
+
### HTTP request headers
|
|
446
|
+
|
|
447
|
+
- **Content-Type**: application/json
|
|
448
|
+
- **Accept**: application/json
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
# **publish_loyalty_program**
|
|
453
|
+
> publish_loyalty_program(pid)
|
|
454
|
+
|
|
455
|
+
Publish loyalty program
|
|
456
|
+
|
|
457
|
+
Publishes loyalty program
|
|
458
|
+
|
|
459
|
+
### Example
|
|
460
|
+
```ruby
|
|
461
|
+
# load the gem
|
|
462
|
+
require 'brevo'
|
|
463
|
+
# setup authorization
|
|
464
|
+
Brevo.configure do |config|
|
|
465
|
+
# Configure API key authorization: api-key
|
|
466
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
467
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
468
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
469
|
+
|
|
470
|
+
# Configure API key authorization: partner-key
|
|
471
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
472
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
473
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
474
|
+
end
|
|
475
|
+
|
|
476
|
+
api_instance = Brevo::ProgramApi.new
|
|
477
|
+
|
|
478
|
+
pid = 'pid_example' # String | Loyalty Program Id
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
begin
|
|
482
|
+
#Publish loyalty program
|
|
483
|
+
api_instance.publish_loyalty_program(pid)
|
|
484
|
+
rescue Brevo::ApiError => e
|
|
485
|
+
puts "Exception when calling ProgramApi->publish_loyalty_program: #{e}"
|
|
486
|
+
end
|
|
487
|
+
```
|
|
488
|
+
|
|
489
|
+
### Parameters
|
|
490
|
+
|
|
491
|
+
Name | Type | Description | Notes
|
|
492
|
+
------------- | ------------- | ------------- | -------------
|
|
493
|
+
**pid** | [**String**](.md)| Loyalty Program Id |
|
|
494
|
+
|
|
495
|
+
### Return type
|
|
496
|
+
|
|
497
|
+
nil (empty response body)
|
|
498
|
+
|
|
499
|
+
### Authorization
|
|
500
|
+
|
|
501
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
502
|
+
|
|
503
|
+
### HTTP request headers
|
|
504
|
+
|
|
505
|
+
- **Content-Type**: application/json
|
|
506
|
+
- **Accept**: application/json
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
# **subscribe_member_to_a_subscription**
|
|
511
|
+
> SubscriptionMember subscribe_member_to_a_subscription(pid, body)
|
|
512
|
+
|
|
513
|
+
Create subscription member
|
|
514
|
+
|
|
515
|
+
Add member to a subscription
|
|
516
|
+
|
|
517
|
+
### Example
|
|
518
|
+
```ruby
|
|
519
|
+
# load the gem
|
|
520
|
+
require 'brevo'
|
|
521
|
+
# setup authorization
|
|
522
|
+
Brevo.configure do |config|
|
|
523
|
+
# Configure API key authorization: api-key
|
|
524
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
525
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
526
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
527
|
+
|
|
528
|
+
# Configure API key authorization: partner-key
|
|
529
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
530
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
531
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
532
|
+
end
|
|
533
|
+
|
|
534
|
+
api_instance = Brevo::ProgramApi.new
|
|
535
|
+
|
|
536
|
+
pid = 'pid_example' # String | Loyalty Program Id
|
|
537
|
+
|
|
538
|
+
body = Brevo::AddSubscriptionMemberPayload.new # AddSubscriptionMemberPayload | Add Subscription Member Payload
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
begin
|
|
542
|
+
#Create subscription member
|
|
543
|
+
result = api_instance.subscribe_member_to_a_subscription(pid, body)
|
|
544
|
+
p result
|
|
545
|
+
rescue Brevo::ApiError => e
|
|
546
|
+
puts "Exception when calling ProgramApi->subscribe_member_to_a_subscription: #{e}"
|
|
547
|
+
end
|
|
548
|
+
```
|
|
549
|
+
|
|
550
|
+
### Parameters
|
|
551
|
+
|
|
552
|
+
Name | Type | Description | Notes
|
|
553
|
+
------------- | ------------- | ------------- | -------------
|
|
554
|
+
**pid** | [**String**](.md)| Loyalty Program Id |
|
|
555
|
+
**body** | [**AddSubscriptionMemberPayload**](AddSubscriptionMemberPayload.md)| Add Subscription Member Payload |
|
|
556
|
+
|
|
557
|
+
### Return type
|
|
558
|
+
|
|
559
|
+
[**SubscriptionMember**](SubscriptionMember.md)
|
|
560
|
+
|
|
561
|
+
### Authorization
|
|
562
|
+
|
|
563
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
564
|
+
|
|
565
|
+
### HTTP request headers
|
|
566
|
+
|
|
567
|
+
- **Content-Type**: application/json
|
|
568
|
+
- **Accept**: application/json
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
# **subscribe_to_loyalty_program**
|
|
573
|
+
> Subscription subscribe_to_loyalty_program(pid, body)
|
|
574
|
+
|
|
575
|
+
Create subscription
|
|
576
|
+
|
|
577
|
+
Subscribes to a loyalty program
|
|
578
|
+
|
|
579
|
+
### Example
|
|
580
|
+
```ruby
|
|
581
|
+
# load the gem
|
|
582
|
+
require 'brevo'
|
|
583
|
+
# setup authorization
|
|
584
|
+
Brevo.configure do |config|
|
|
585
|
+
# Configure API key authorization: api-key
|
|
586
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
587
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
588
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
589
|
+
|
|
590
|
+
# Configure API key authorization: partner-key
|
|
591
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
592
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
593
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
594
|
+
end
|
|
595
|
+
|
|
596
|
+
api_instance = Brevo::ProgramApi.new
|
|
597
|
+
|
|
598
|
+
pid = 'pid_example' # String | Loyalty Program Id
|
|
599
|
+
|
|
600
|
+
body = Brevo::CreateSubscriptionPayload.new # CreateSubscriptionPayload | Create Subscription Payload
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
begin
|
|
604
|
+
#Create subscription
|
|
605
|
+
result = api_instance.subscribe_to_loyalty_program(pid, body)
|
|
606
|
+
p result
|
|
607
|
+
rescue Brevo::ApiError => e
|
|
608
|
+
puts "Exception when calling ProgramApi->subscribe_to_loyalty_program: #{e}"
|
|
609
|
+
end
|
|
610
|
+
```
|
|
611
|
+
|
|
612
|
+
### Parameters
|
|
613
|
+
|
|
614
|
+
Name | Type | Description | Notes
|
|
615
|
+
------------- | ------------- | ------------- | -------------
|
|
616
|
+
**pid** | [**String**](.md)| Loyalty Program Id |
|
|
617
|
+
**body** | [**CreateSubscriptionPayload**](CreateSubscriptionPayload.md)| Create Subscription Payload |
|
|
618
|
+
|
|
619
|
+
### Return type
|
|
620
|
+
|
|
621
|
+
[**Subscription**](Subscription.md)
|
|
622
|
+
|
|
623
|
+
### Authorization
|
|
624
|
+
|
|
625
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
626
|
+
|
|
627
|
+
### HTTP request headers
|
|
628
|
+
|
|
629
|
+
- **Content-Type**: application/json
|
|
630
|
+
- **Accept**: application/json
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
# **update_loyalty_program**
|
|
635
|
+
> LoyaltyProgram update_loyalty_program(pid, body)
|
|
636
|
+
|
|
637
|
+
Update loyalty program
|
|
638
|
+
|
|
639
|
+
Updates loyalty program
|
|
640
|
+
|
|
641
|
+
### Example
|
|
642
|
+
```ruby
|
|
643
|
+
# load the gem
|
|
644
|
+
require 'brevo'
|
|
645
|
+
# setup authorization
|
|
646
|
+
Brevo.configure do |config|
|
|
647
|
+
# Configure API key authorization: api-key
|
|
648
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
649
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
650
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
651
|
+
|
|
652
|
+
# Configure API key authorization: partner-key
|
|
653
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
654
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
655
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
656
|
+
end
|
|
657
|
+
|
|
658
|
+
api_instance = Brevo::ProgramApi.new
|
|
659
|
+
|
|
660
|
+
pid = 'pid_example' # String | Loyalty Program Id
|
|
661
|
+
|
|
662
|
+
body = Brevo::UpdateLoyaltyProgramPayload.new # UpdateLoyaltyProgramPayload | Update Loyalty Program Payload
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
begin
|
|
666
|
+
#Update loyalty program
|
|
667
|
+
result = api_instance.update_loyalty_program(pid, body)
|
|
668
|
+
p result
|
|
669
|
+
rescue Brevo::ApiError => e
|
|
670
|
+
puts "Exception when calling ProgramApi->update_loyalty_program: #{e}"
|
|
671
|
+
end
|
|
672
|
+
```
|
|
673
|
+
|
|
674
|
+
### Parameters
|
|
675
|
+
|
|
676
|
+
Name | Type | Description | Notes
|
|
677
|
+
------------- | ------------- | ------------- | -------------
|
|
678
|
+
**pid** | [**String**](.md)| Loyalty Program Id |
|
|
679
|
+
**body** | [**UpdateLoyaltyProgramPayload**](UpdateLoyaltyProgramPayload.md)| Update Loyalty Program Payload |
|
|
680
|
+
|
|
681
|
+
### Return type
|
|
682
|
+
|
|
683
|
+
[**LoyaltyProgram**](LoyaltyProgram.md)
|
|
684
|
+
|
|
685
|
+
### Authorization
|
|
686
|
+
|
|
687
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
688
|
+
|
|
689
|
+
### HTTP request headers
|
|
690
|
+
|
|
691
|
+
- **Content-Type**: application/json
|
|
692
|
+
- **Accept**: application/json
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
|
|
@@ -3,8 +3,9 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**emails** | **Array<String>** | Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. | [optional]
|
|
7
|
-
**ids** | **Array<Integer>** | Mandatory if Emails are not passed, ignored otherwise.
|
|
8
|
-
**
|
|
6
|
+
**emails** | **Array<String>** | Required if 'all' is false and EXT_ID attributes, IDs are not passed. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. | [optional]
|
|
7
|
+
**ids** | **Array<Integer>** | Mandatory if Emails, EXT_ID attributes are not passed, ignored otherwise. Contact IDs to add to a list. You can pass a maximum of 150 Ids for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
|
|
8
|
+
**ext_ids** | **Array<String>** | Mandatory if 'all' is false and Emails, IDs are not passed, ignored otherwise. EXT_ID attributes to add to a list. You can pass a maximum of 150 extIds for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
|
|
9
|
+
**all** | **BOOLEAN** | Required if none of 'emails', EXT_ID attributes or 'ids' are passed. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress | [optional]
|
|
9
10
|
|
|
10
11
|
|