brevo 2.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 +7 -0
- data/Gemfile +7 -0
- data/LICENSE.md +21 -0
- data/README.md +655 -0
- data/Rakefile +8 -0
- data/brevo.gemspec +46 -0
- data/docs/AbTestCampaignResult.md +15 -0
- data/docs/AbTestCampaignResultClickedLinks.md +9 -0
- data/docs/AbTestCampaignResultStatistics.md +13 -0
- data/docs/AbTestVersionClicks.md +7 -0
- data/docs/AbTestVersionClicksInner.md +10 -0
- data/docs/AbTestVersionStats.md +9 -0
- data/docs/AccountApi.md +125 -0
- data/docs/AddChildDomain.md +8 -0
- data/docs/AddContactToList.md +9 -0
- data/docs/AddCredits.md +9 -0
- data/docs/AuthenticateDomainModel.md +9 -0
- data/docs/BlockDomain.md +8 -0
- data/docs/Body.md +10 -0
- data/docs/Body1.md +10 -0
- data/docs/Body10.md +11 -0
- data/docs/Body11.md +8 -0
- data/docs/Body12.md +11 -0
- data/docs/Body2.md +11 -0
- data/docs/Body3.md +9 -0
- data/docs/Body4.md +9 -0
- data/docs/Body5.md +11 -0
- data/docs/Body6.md +18 -0
- data/docs/Body7.md +17 -0
- data/docs/Body8.md +13 -0
- data/docs/Body9.md +8 -0
- data/docs/BodyVariablesItems.md +7 -0
- data/docs/CompaniesApi.md +425 -0
- data/docs/CompaniesList.md +8 -0
- data/docs/Company.md +11 -0
- data/docs/CompanyAttributes.md +7 -0
- data/docs/CompanyAttributesInner.md +12 -0
- data/docs/ComponentItems.md +9 -0
- data/docs/ContactsApi.md +1767 -0
- data/docs/ConversationsApi.md +542 -0
- data/docs/ConversationsMessage.md +17 -0
- data/docs/ConversationsMessageFile.md +12 -0
- data/docs/ConversationsMessageFileImageInfo.md +10 -0
- data/docs/CouponsApi.md +305 -0
- data/docs/CreateApiKeyRequest.md +9 -0
- data/docs/CreateApiKeyResponse.md +9 -0
- data/docs/CreateAttribute.md +11 -0
- data/docs/CreateAttributeEnumeration.md +9 -0
- data/docs/CreateCategoryModel.md +8 -0
- data/docs/CreateChild.md +13 -0
- data/docs/CreateContact.md +15 -0
- data/docs/CreateCouponCollection.md +9 -0
- data/docs/CreateCoupons.md +9 -0
- data/docs/CreateDoiContact.md +13 -0
- data/docs/CreateDomain.md +8 -0
- data/docs/CreateDomainModel.md +11 -0
- data/docs/CreateDomainModelDnsRecords.md +9 -0
- data/docs/CreateDomainModelDnsRecordsDkimRecord.md +11 -0
- data/docs/CreateEmailCampaign.md +38 -0
- data/docs/CreateEmailCampaignRecipients.md +10 -0
- data/docs/CreateEmailCampaignSender.md +10 -0
- data/docs/CreateExternalFeed.md +16 -0
- data/docs/CreateList.md +9 -0
- data/docs/CreateModel.md +8 -0
- data/docs/CreateProductModel.md +8 -0
- data/docs/CreateReseller.md +9 -0
- data/docs/CreateSender.md +10 -0
- data/docs/CreateSenderIps.md +10 -0
- data/docs/CreateSenderModel.md +10 -0
- data/docs/CreateSmsCampaign.md +15 -0
- data/docs/CreateSmsCampaignRecipients.md +9 -0
- data/docs/CreateSmtpEmail.md +9 -0
- data/docs/CreateSmtpTemplate.md +17 -0
- data/docs/CreateSmtpTemplateSender.md +10 -0
- data/docs/CreateSubAccount.md +11 -0
- data/docs/CreateSubAccountResponse.md +8 -0
- data/docs/CreateUpdateBatchCategory.md +9 -0
- data/docs/CreateUpdateBatchCategoryModel.md +9 -0
- data/docs/CreateUpdateBatchProducts.md +9 -0
- data/docs/CreateUpdateBatchProductsModel.md +9 -0
- data/docs/CreateUpdateCategories.md +11 -0
- data/docs/CreateUpdateCategory.md +12 -0
- data/docs/CreateUpdateContactModel.md +8 -0
- data/docs/CreateUpdateFolder.md +8 -0
- data/docs/CreateUpdateProduct.md +18 -0
- data/docs/CreateUpdateProducts.md +17 -0
- data/docs/CreateWebhook.md +12 -0
- data/docs/CreateWhatsAppCampaign.md +11 -0
- data/docs/CreateWhatsAppCampaignRecipients.md +10 -0
- data/docs/CreateWhatsAppTemplate.md +13 -0
- data/docs/CreatedBatchId.md +8 -0
- data/docs/CreatedProcessId.md +8 -0
- data/docs/Deal.md +11 -0
- data/docs/DealAttributes.md +7 -0
- data/docs/DealAttributesInner.md +12 -0
- data/docs/DealsApi.md +588 -0
- data/docs/DealsList.md +8 -0
- data/docs/DeleteHardbounces.md +10 -0
- data/docs/DomainsApi.md +292 -0
- data/docs/EcommerceApi.md +675 -0
- data/docs/EmailCampaignsApi.md +801 -0
- data/docs/EmailExportRecipients.md +9 -0
- data/docs/ErrorModel.md +9 -0
- data/docs/ExportWebhooksHistory.md +16 -0
- data/docs/ExternalFeedsApi.md +322 -0
- data/docs/FileData.md +14 -0
- data/docs/FileDownloadableLink.md +8 -0
- data/docs/FileList.md +7 -0
- data/docs/FilesApi.md +318 -0
- data/docs/GetAccount.md +15 -0
- data/docs/GetAccountActivity.md +8 -0
- data/docs/GetAccountActivityLogs.md +12 -0
- data/docs/GetAccountMarketingAutomation.md +9 -0
- data/docs/GetAccountPlan.md +13 -0
- data/docs/GetAccountRelay.md +9 -0
- data/docs/GetAccountRelayData.md +10 -0
- data/docs/GetAggregatedReport.md +20 -0
- data/docs/GetAllExternalFeeds.md +9 -0
- data/docs/GetAllExternalFeedsFeeds.md +19 -0
- data/docs/GetAttributes.md +8 -0
- data/docs/GetAttributesAttributes.md +12 -0
- data/docs/GetAttributesEnumeration.md +9 -0
- data/docs/GetBlockedDomains.md +8 -0
- data/docs/GetCampaignOverview.md +21 -0
- data/docs/GetCampaignRecipients.md +9 -0
- data/docs/GetCampaignStats.md +23 -0
- data/docs/GetCategories.md +9 -0
- data/docs/GetCategoryDetails.md +13 -0
- data/docs/GetChildAccountCreationStatus.md +8 -0
- data/docs/GetChildDomain.md +9 -0
- data/docs/GetChildDomains.md +7 -0
- data/docs/GetChildInfo.md +16 -0
- data/docs/GetChildInfoApiKeys.md +9 -0
- data/docs/GetChildInfoApiKeysV2.md +9 -0
- data/docs/GetChildInfoApiKeysV3.md +9 -0
- data/docs/GetChildInfoCredits.md +9 -0
- data/docs/GetChildInfoStatistics.md +10 -0
- data/docs/GetChildrenList.md +9 -0
- data/docs/GetClient.md +11 -0
- data/docs/GetContactCampaignStats.md +16 -0
- data/docs/GetContactCampaignStatsClicked.md +9 -0
- data/docs/GetContactCampaignStatsOpened.md +11 -0
- data/docs/GetContactCampaignStatsTransacAttributes.md +10 -0
- data/docs/GetContactCampaignStatsUnsubscriptions.md +9 -0
- data/docs/GetContactDetails.md +16 -0
- data/docs/GetContacts.md +9 -0
- data/docs/GetCouponCollection.md +13 -0
- data/docs/GetDeviceBrowserStats.md +11 -0
- data/docs/GetDomainConfigurationModel.md +11 -0
- data/docs/GetDomainsList.md +8 -0
- data/docs/GetDomainsListDomains.md +12 -0
- data/docs/GetEmailCampaign.md +39 -0
- data/docs/GetEmailCampaigns.md +9 -0
- data/docs/GetEmailEventReport.md +8 -0
- data/docs/GetEmailEventReportEvents.md +18 -0
- data/docs/GetExtendedCampaignOverview.md +37 -0
- data/docs/GetExtendedCampaignOverviewSender.md +10 -0
- data/docs/GetExtendedCampaignStats.md +15 -0
- data/docs/GetExtendedCampaignStatsGlobalStats.md +7 -0
- data/docs/GetExtendedClient.md +12 -0
- data/docs/GetExtendedClientAddress.md +11 -0
- data/docs/GetExtendedContactDetails.md +17 -0
- data/docs/GetExtendedContactDetailsStatistics.md +16 -0
- data/docs/GetExtendedContactDetailsStatisticsClicked.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsDelivered.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsLinks.md +11 -0
- data/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsOpened.md +11 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +10 -0
- data/docs/GetExtendedList.md +16 -0
- data/docs/GetExtendedListCampaignStats.md +9 -0
- data/docs/GetExternalFeedByUUID.md +19 -0
- data/docs/GetExternalFeedByUUIDHeaders.md +9 -0
- data/docs/GetFolder.md +12 -0
- data/docs/GetFolderLists.md +9 -0
- data/docs/GetFolders.md +9 -0
- data/docs/GetInboundEmailEvents.md +8 -0
- data/docs/GetInboundEmailEventsByUuid.md +15 -0
- data/docs/GetInboundEmailEventsByUuidAttachments.md +11 -0
- data/docs/GetInboundEmailEventsByUuidLogs.md +9 -0
- data/docs/GetInboundEmailEventsEvents.md +11 -0
- data/docs/GetInvitedUsersList.md +8 -0
- data/docs/GetInvitedUsersListFeatureAccess.md +10 -0
- data/docs/GetInvitedUsersListUsers.md +11 -0
- data/docs/GetIp.md +11 -0
- data/docs/GetIpFromSender.md +11 -0
- data/docs/GetIps.md +8 -0
- data/docs/GetIpsFromSender.md +8 -0
- data/docs/GetList.md +12 -0
- data/docs/GetLists.md +9 -0
- data/docs/GetProcess.md +11 -0
- data/docs/GetProcesses.md +9 -0
- data/docs/GetProductDetails.md +22 -0
- data/docs/GetProducts.md +9 -0
- data/docs/GetReports.md +8 -0
- data/docs/GetReportsReports.md +20 -0
- data/docs/GetScheduledEmailByBatchId.md +9 -0
- data/docs/GetScheduledEmailByBatchIdBatches.md +10 -0
- data/docs/GetScheduledEmailByMessageId.md +10 -0
- data/docs/GetSegments.md +9 -0
- data/docs/GetSegmentsSegments.md +11 -0
- data/docs/GetSendersList.md +8 -0
- data/docs/GetSendersListIps.md +10 -0
- data/docs/GetSendersListSenders.md +12 -0
- data/docs/GetSharedTemplateUrl.md +8 -0
- data/docs/GetSmsCampaign.md +17 -0
- data/docs/GetSmsCampaignOverview.md +15 -0
- data/docs/GetSmsCampaignRecipients.md +7 -0
- data/docs/GetSmsCampaignStats.md +14 -0
- data/docs/GetSmsCampaigns.md +9 -0
- data/docs/GetSmsEventReport.md +8 -0
- data/docs/GetSmsEventReportEvents.md +14 -0
- data/docs/GetSmtpTemplateOverview.md +20 -0
- data/docs/GetSmtpTemplateOverviewSender.md +10 -0
- data/docs/GetSmtpTemplates.md +9 -0
- data/docs/GetSsoToken.md +8 -0
- data/docs/GetStatsByBrowser.md +7 -0
- data/docs/GetStatsByDevice.md +11 -0
- data/docs/GetStatsByDomain.md +7 -0
- data/docs/GetTransacAggregatedSmsReport.md +17 -0
- data/docs/GetTransacBlockedContacts.md +9 -0
- data/docs/GetTransacBlockedContactsContacts.md +11 -0
- data/docs/GetTransacBlockedContactsReason.md +9 -0
- data/docs/GetTransacEmailContent.md +14 -0
- data/docs/GetTransacEmailContentEvents.md +9 -0
- data/docs/GetTransacEmailsList.md +9 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +15 -0
- data/docs/GetTransacSmsReport.md +8 -0
- data/docs/GetTransacSmsReportReports.md +17 -0
- data/docs/GetUserPermission.md +10 -0
- data/docs/GetUserPermissionPrivileges.md +9 -0
- data/docs/GetWATemplates.md +9 -0
- data/docs/GetWATemplatesTemplates.md +15 -0
- data/docs/GetWebhook.md +14 -0
- data/docs/GetWebhooks.md +8 -0
- data/docs/GetWhatsAppConfig.md +13 -0
- data/docs/GetWhatsappCampaignOverview.md +16 -0
- data/docs/GetWhatsappCampaigns.md +9 -0
- data/docs/GetWhatsappCampaignsCampaigns.md +18 -0
- data/docs/GetWhatsappEventReport.md +8 -0
- data/docs/GetWhatsappEventReportEvents.md +15 -0
- data/docs/InboundParsingApi.md +199 -0
- data/docs/InlineResponse200.md +8 -0
- data/docs/InlineResponse2001.md +10 -0
- data/docs/InlineResponse201.md +8 -0
- data/docs/InlineResponse2011.md +8 -0
- data/docs/InlineResponse2012.md +8 -0
- data/docs/InlineResponse2013.md +8 -0
- data/docs/InlineResponse2014.md +8 -0
- data/docs/ManageIp.md +8 -0
- data/docs/MasterAccountApi.md +611 -0
- data/docs/MasterDetailsResponse.md +14 -0
- data/docs/MasterDetailsResponseBillingInfo.md +11 -0
- data/docs/MasterDetailsResponseBillingInfoAddress.md +12 -0
- data/docs/MasterDetailsResponseBillingInfoName.md +9 -0
- data/docs/MasterDetailsResponsePlanInfo.md +13 -0
- data/docs/MasterDetailsResponsePlanInfoFeatures.md +12 -0
- data/docs/Note.md +14 -0
- data/docs/NoteData.md +11 -0
- data/docs/NoteId.md +8 -0
- data/docs/NoteList.md +7 -0
- data/docs/NotesApi.md +312 -0
- data/docs/Order.md +16 -0
- data/docs/OrderBatch.md +9 -0
- data/docs/OrderBilling.md +14 -0
- data/docs/OrderProducts.md +11 -0
- data/docs/Otp.md +8 -0
- data/docs/Pipeline.md +10 -0
- data/docs/PipelineStage.md +9 -0
- data/docs/Pipelines.md +7 -0
- data/docs/PostContactInfo.md +8 -0
- data/docs/PostContactInfoContacts.md +11 -0
- data/docs/PostSendFailed.md +12 -0
- data/docs/PostSendSmsTestFailed.md +11 -0
- data/docs/ProcessApi.md +129 -0
- data/docs/RemainingCreditModel.md +9 -0
- data/docs/RemainingCreditModelChild.md +9 -0
- data/docs/RemainingCreditModelReseller.md +9 -0
- data/docs/RemoveContactFromList.md +10 -0
- data/docs/RemoveCredits.md +9 -0
- data/docs/RequestContactExport.md +10 -0
- data/docs/RequestContactExportCustomContactFilter.md +13 -0
- data/docs/RequestContactImport.md +17 -0
- data/docs/RequestContactImportJsonBody.md +9 -0
- data/docs/RequestContactImportNewList.md +9 -0
- data/docs/RequestSMSRecipientExport.md +9 -0
- data/docs/ResellerApi.md +964 -0
- data/docs/SMSCampaignsApi.md +613 -0
- data/docs/ScheduleSmtpEmail.md +10 -0
- data/docs/SendReport.md +9 -0
- data/docs/SendReportEmail.md +9 -0
- data/docs/SendSms.md +12 -0
- data/docs/SendSmtpEmail.md +23 -0
- data/docs/SendSmtpEmailAttachment.md +10 -0
- data/docs/SendSmtpEmailBcc.md +9 -0
- data/docs/SendSmtpEmailCc.md +9 -0
- data/docs/SendSmtpEmailMessageVersions.md +13 -0
- data/docs/SendSmtpEmailReplyTo.md +9 -0
- data/docs/SendSmtpEmailReplyTo1.md +9 -0
- data/docs/SendSmtpEmailSender.md +10 -0
- data/docs/SendSmtpEmailTo.md +9 -0
- data/docs/SendSmtpEmailTo1.md +9 -0
- data/docs/SendTestEmail.md +8 -0
- data/docs/SendTestSms.md +8 -0
- data/docs/SendTransacSms.md +15 -0
- data/docs/SendWhatsappMessage.md +11 -0
- data/docs/SendersApi.md +417 -0
- data/docs/SsoTokenRequest.md +11 -0
- data/docs/SubAccountAppsToggleRequest.md +20 -0
- data/docs/SubAccountDetailsResponse.md +11 -0
- data/docs/SubAccountDetailsResponsePlanInfo.md +10 -0
- data/docs/SubAccountDetailsResponsePlanInfoCredits.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeatures.md +10 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +9 -0
- data/docs/SubAccountUpdatePlanRequest.md +9 -0
- data/docs/SubAccountUpdatePlanRequestCredits.md +8 -0
- data/docs/SubAccountUpdatePlanRequestFeatures.md +10 -0
- data/docs/SubAccountsResponse.md +9 -0
- data/docs/SubAccountsResponseSubAccounts.md +11 -0
- data/docs/Task.md +13 -0
- data/docs/TaskList.md +8 -0
- data/docs/TaskReminder.md +10 -0
- data/docs/TaskTypes.md +9 -0
- data/docs/TasksApi.md +376 -0
- data/docs/TransactionalEmailsApi.md +1390 -0
- data/docs/TransactionalSMSApi.md +273 -0
- data/docs/TransactionalWhatsAppApi.md +143 -0
- data/docs/UpdateAttribute.md +9 -0
- data/docs/UpdateAttributeEnumeration.md +9 -0
- data/docs/UpdateBatchContacts.md +8 -0
- data/docs/UpdateBatchContactsContacts.md +17 -0
- data/docs/UpdateBatchContactsModel.md +9 -0
- data/docs/UpdateCampaignStatus.md +8 -0
- data/docs/UpdateChild.md +12 -0
- data/docs/UpdateChildAccountStatus.md +11 -0
- data/docs/UpdateChildDomain.md +8 -0
- data/docs/UpdateContact.md +14 -0
- data/docs/UpdateCouponCollection.md +8 -0
- data/docs/UpdateEmailCampaign.md +38 -0
- data/docs/UpdateEmailCampaignRecipients.md +10 -0
- data/docs/UpdateEmailCampaignSender.md +10 -0
- data/docs/UpdateExternalFeed.md +16 -0
- data/docs/UpdateList.md +9 -0
- data/docs/UpdateSender.md +10 -0
- data/docs/UpdateSmsCampaign.md +15 -0
- data/docs/UpdateSmtpTemplate.md +17 -0
- data/docs/UpdateSmtpTemplateSender.md +10 -0
- data/docs/UpdateWebhook.md +11 -0
- data/docs/UpdateWhatsAppCampaign.md +11 -0
- data/docs/UploadImageModel.md +8 -0
- data/docs/UploadImageToGallery.md +9 -0
- data/docs/UserApi.md +118 -0
- data/docs/VariablesItems.md +10 -0
- data/docs/WebhooksApi.md +362 -0
- data/docs/WhatsAppCampaignsApi.md +543 -0
- data/docs/WhatsappCampStats.md +12 -0
- data/docs/WhatsappCampTemplate.md +18 -0
- data/lib/brevo/api/account_api.rb +145 -0
- data/lib/brevo/api/companies_api.rb +419 -0
- data/lib/brevo/api/contacts_api.rb +1735 -0
- data/lib/brevo/api/conversations_api.rb +514 -0
- data/lib/brevo/api/coupons_api.rb +316 -0
- data/lib/brevo/api/deals_api.rb +564 -0
- data/lib/brevo/api/domains_api.rb +282 -0
- data/lib/brevo/api/ecommerce_api.rb +655 -0
- data/lib/brevo/api/email_campaigns_api.rb +785 -0
- data/lib/brevo/api/external_feeds_api.rb +336 -0
- data/lib/brevo/api/files_api.rb +323 -0
- data/lib/brevo/api/inbound_parsing_api.rb +218 -0
- data/lib/brevo/api/master_account_api.rb +594 -0
- data/lib/brevo/api/notes_api.rb +318 -0
- data/lib/brevo/api/process_api.rb +151 -0
- data/lib/brevo/api/reseller_api.rb +923 -0
- data/lib/brevo/api/senders_api.rb +388 -0
- data/lib/brevo/api/sms_campaigns_api.rb +603 -0
- data/lib/brevo/api/tasks_api.rb +385 -0
- data/lib/brevo/api/transactional_emails_api.rb +1370 -0
- data/lib/brevo/api/transactional_sms_api.rb +290 -0
- data/lib/brevo/api/transactional_whats_app_api.rb +173 -0
- data/lib/brevo/api/user_api.rb +131 -0
- data/lib/brevo/api/webhooks_api.rb +357 -0
- data/lib/brevo/api/whats_app_campaigns_api.rb +534 -0
- data/lib/brevo/api_client.rb +392 -0
- data/lib/brevo/api_error.rb +38 -0
- data/lib/brevo/configuration.rb +216 -0
- data/lib/brevo/models/ab_test_campaign_result.rb +299 -0
- data/lib/brevo/models/ab_test_campaign_result_clicked_links.rb +203 -0
- data/lib/brevo/models/ab_test_campaign_result_statistics.rb +259 -0
- data/lib/brevo/models/ab_test_version_clicks.rb +176 -0
- data/lib/brevo/models/ab_test_version_clicks_inner.rb +220 -0
- data/lib/brevo/models/ab_test_version_stats.rb +206 -0
- data/lib/brevo/models/add_child_domain.rb +185 -0
- data/lib/brevo/models/add_contact_to_list.rb +199 -0
- data/lib/brevo/models/add_credits.rb +195 -0
- data/lib/brevo/models/authenticate_domain_model.rb +205 -0
- data/lib/brevo/models/block_domain.rb +190 -0
- data/lib/brevo/models/body.rb +210 -0
- data/lib/brevo/models/body_1.rb +205 -0
- data/lib/brevo/models/body_10.rb +225 -0
- data/lib/brevo/models/body_11.rb +190 -0
- data/lib/brevo/models/body_12.rb +215 -0
- data/lib/brevo/models/body_2.rb +223 -0
- data/lib/brevo/models/body_3.rb +200 -0
- data/lib/brevo/models/body_4.rb +195 -0
- data/lib/brevo/models/body_5.rb +223 -0
- data/lib/brevo/models/body_6.rb +320 -0
- data/lib/brevo/models/body_7.rb +281 -0
- data/lib/brevo/models/body_8.rb +245 -0
- data/lib/brevo/models/body_9.rb +190 -0
- data/lib/brevo/models/body_variables_items.rb +175 -0
- data/lib/brevo/models/companies_list.rb +188 -0
- data/lib/brevo/models/company.rb +220 -0
- data/lib/brevo/models/company_attributes.rb +176 -0
- data/lib/brevo/models/company_attributes_inner.rb +223 -0
- data/lib/brevo/models/component_items.rb +193 -0
- data/lib/brevo/models/conversations_message.rb +324 -0
- data/lib/brevo/models/conversations_message_file.rb +239 -0
- data/lib/brevo/models/conversations_message_file_image_info.rb +236 -0
- data/lib/brevo/models/create_api_key_request.rb +200 -0
- data/lib/brevo/models/create_api_key_response.rb +195 -0
- data/lib/brevo/models/create_attribute.rb +251 -0
- data/lib/brevo/models/create_attribute_enumeration.rb +205 -0
- data/lib/brevo/models/create_category_model.rb +185 -0
- data/lib/brevo/models/create_child.rb +294 -0
- data/lib/brevo/models/create_contact.rb +261 -0
- data/lib/brevo/models/create_coupon_collection.rb +205 -0
- data/lib/brevo/models/create_coupons.rb +206 -0
- data/lib/brevo/models/create_doi_contact.rb +259 -0
- data/lib/brevo/models/create_domain.rb +190 -0
- data/lib/brevo/models/create_domain_model.rb +219 -0
- data/lib/brevo/models/create_domain_model_dns_records.rb +193 -0
- data/lib/brevo/models/create_domain_model_dns_records_dkim_record.rb +211 -0
- data/lib/brevo/models/create_email_campaign.rb +607 -0
- data/lib/brevo/models/create_email_campaign_recipients.rb +212 -0
- data/lib/brevo/models/create_email_campaign_sender.rb +211 -0
- data/lib/brevo/models/create_external_feed.rb +339 -0
- data/lib/brevo/models/create_list.rb +205 -0
- data/lib/brevo/models/create_model.rb +190 -0
- data/lib/brevo/models/create_product_model.rb +185 -0
- data/lib/brevo/models/create_reseller.rb +200 -0
- data/lib/brevo/models/create_sender.rb +217 -0
- data/lib/brevo/models/create_sender_ips.rb +239 -0
- data/lib/brevo/models/create_sender_model.rb +210 -0
- data/lib/brevo/models/create_sms_campaign.rb +290 -0
- data/lib/brevo/models/create_sms_campaign_recipients.rb +204 -0
- data/lib/brevo/models/create_smtp_email.rb +196 -0
- data/lib/brevo/models/create_smtp_template.rb +289 -0
- data/lib/brevo/models/create_smtp_template_sender.rb +206 -0
- data/lib/brevo/models/create_sub_account.rb +259 -0
- data/lib/brevo/models/create_sub_account_response.rb +190 -0
- data/lib/brevo/models/create_update_batch_category.rb +202 -0
- data/lib/brevo/models/create_update_batch_category_model.rb +195 -0
- data/lib/brevo/models/create_update_batch_products.rb +202 -0
- data/lib/brevo/models/create_update_batch_products_model.rb +195 -0
- data/lib/brevo/models/create_update_categories.rb +220 -0
- data/lib/brevo/models/create_update_category.rb +232 -0
- data/lib/brevo/models/create_update_contact_model.rb +185 -0
- data/lib/brevo/models/create_update_folder.rb +185 -0
- data/lib/brevo/models/create_update_product.rb +301 -0
- data/lib/brevo/models/create_update_products.rb +289 -0
- data/lib/brevo/models/create_webhook.rb +273 -0
- data/lib/brevo/models/create_whats_app_campaign.rb +234 -0
- data/lib/brevo/models/create_whats_app_campaign_recipients.rb +212 -0
- data/lib/brevo/models/create_whats_app_template.rb +289 -0
- data/lib/brevo/models/created_batch_id.rb +190 -0
- data/lib/brevo/models/created_process_id.rb +190 -0
- data/lib/brevo/models/deal.rb +220 -0
- data/lib/brevo/models/deal_attributes.rb +176 -0
- data/lib/brevo/models/deal_attributes_inner.rb +223 -0
- data/lib/brevo/models/deals_list.rb +188 -0
- data/lib/brevo/models/delete_hardbounces.rb +205 -0
- data/lib/brevo/models/email_export_recipients.rb +234 -0
- data/lib/brevo/models/error_model.rb +239 -0
- data/lib/brevo/models/export_webhooks_history.rb +309 -0
- data/lib/brevo/models/file_data.rb +246 -0
- data/lib/brevo/models/file_downloadable_link.rb +190 -0
- data/lib/brevo/models/file_list.rb +176 -0
- data/lib/brevo/models/get_account.rb +289 -0
- data/lib/brevo/models/get_account_activity.rb +187 -0
- data/lib/brevo/models/get_account_activity_logs.rb +250 -0
- data/lib/brevo/models/get_account_marketing_automation.rb +200 -0
- data/lib/brevo/models/get_account_plan.rb +296 -0
- data/lib/brevo/models/get_account_relay.rb +205 -0
- data/lib/brevo/models/get_account_relay_data.rb +221 -0
- data/lib/brevo/models/get_aggregated_report.rb +305 -0
- data/lib/brevo/models/get_all_external_feeds.rb +196 -0
- data/lib/brevo/models/get_all_external_feeds_feeds.rb +404 -0
- data/lib/brevo/models/get_attributes.rb +192 -0
- data/lib/brevo/models/get_attributes_attributes.rb +283 -0
- data/lib/brevo/models/get_attributes_enumeration.rb +205 -0
- data/lib/brevo/models/get_blocked_domains.rb +193 -0
- data/lib/brevo/models/get_campaign_overview.rb +381 -0
- data/lib/brevo/models/get_campaign_recipients.rb +207 -0
- data/lib/brevo/models/get_campaign_stats.rb +390 -0
- data/lib/brevo/models/get_categories.rb +206 -0
- data/lib/brevo/models/get_category_details.rb +255 -0
- data/lib/brevo/models/get_child_account_creation_status.rb +190 -0
- data/lib/brevo/models/get_child_domain.rb +195 -0
- data/lib/brevo/models/get_child_domains.rb +175 -0
- data/lib/brevo/models/get_child_info.rb +289 -0
- data/lib/brevo/models/get_child_info_api_keys.rb +203 -0
- data/lib/brevo/models/get_child_info_api_keys_v2.rb +205 -0
- data/lib/brevo/models/get_child_info_api_keys_v3.rb +205 -0
- data/lib/brevo/models/get_child_info_credits.rb +196 -0
- data/lib/brevo/models/get_child_info_statistics.rb +206 -0
- data/lib/brevo/models/get_children_list.rb +197 -0
- data/lib/brevo/models/get_client.rb +235 -0
- data/lib/brevo/models/get_contact_campaign_stats.rb +273 -0
- data/lib/brevo/models/get_contact_campaign_stats_clicked.rb +206 -0
- data/lib/brevo/models/get_contact_campaign_stats_opened.rb +235 -0
- data/lib/brevo/models/get_contact_campaign_stats_transac_attributes.rb +220 -0
- data/lib/brevo/models/get_contact_campaign_stats_unsubscriptions.rb +209 -0
- data/lib/brevo/models/get_contact_details.rb +307 -0
- data/lib/brevo/models/get_contacts.rb +206 -0
- data/lib/brevo/models/get_coupon_collection.rb +265 -0
- data/lib/brevo/models/get_device_browser_stats.rb +235 -0
- data/lib/brevo/models/get_domain_configuration_model.rb +234 -0
- data/lib/brevo/models/get_domains_list.rb +187 -0
- data/lib/brevo/models/get_domains_list_domains.rb +245 -0
- data/lib/brevo/models/get_email_campaign.rb +608 -0
- data/lib/brevo/models/get_email_campaigns.rb +196 -0
- data/lib/brevo/models/get_email_event_report.rb +186 -0
- data/lib/brevo/models/get_email_event_report_events.rb +339 -0
- data/lib/brevo/models/get_extended_campaign_overview.rb +580 -0
- data/lib/brevo/models/get_extended_campaign_overview_sender.rb +205 -0
- data/lib/brevo/models/get_extended_campaign_stats.rb +295 -0
- data/lib/brevo/models/get_extended_campaign_stats_global_stats.rb +176 -0
- data/lib/brevo/models/get_extended_client.rb +249 -0
- data/lib/brevo/models/get_extended_client_address.rb +236 -0
- data/lib/brevo/models/get_extended_contact_details.rb +321 -0
- data/lib/brevo/models/get_extended_contact_details_statistics.rb +281 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_clicked.rb +207 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_delivered.rb +205 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_links.rb +235 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_messages_sent.rb +205 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_opened.rb +235 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_unsubscriptions.rb +210 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +200 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +215 -0
- data/lib/brevo/models/get_extended_list.rb +301 -0
- data/lib/brevo/models/get_extended_list_campaign_stats.rb +204 -0
- data/lib/brevo/models/get_external_feed_by_uuid.rb +404 -0
- data/lib/brevo/models/get_external_feed_by_uuid_headers.rb +195 -0
- data/lib/brevo/models/get_folder.rb +250 -0
- data/lib/brevo/models/get_folder_lists.rb +196 -0
- data/lib/brevo/models/get_folders.rb +196 -0
- data/lib/brevo/models/get_inbound_email_events.rb +186 -0
- data/lib/brevo/models/get_inbound_email_events_by_uuid.rb +259 -0
- data/lib/brevo/models/get_inbound_email_events_by_uuid_attachments.rb +215 -0
- data/lib/brevo/models/get_inbound_email_events_by_uuid_logs.rb +229 -0
- data/lib/brevo/models/get_inbound_email_events_events.rb +235 -0
- data/lib/brevo/models/get_invited_users_list.rb +187 -0
- data/lib/brevo/models/get_invited_users_list_feature_access.rb +206 -0
- data/lib/brevo/models/get_invited_users_list_users.rb +234 -0
- data/lib/brevo/models/get_ip.rb +235 -0
- data/lib/brevo/models/get_ip_from_sender.rb +235 -0
- data/lib/brevo/models/get_ips.rb +192 -0
- data/lib/brevo/models/get_ips_from_sender.rb +192 -0
- data/lib/brevo/models/get_list.rb +250 -0
- data/lib/brevo/models/get_lists.rb +197 -0
- data/lib/brevo/models/get_process.rb +264 -0
- data/lib/brevo/models/get_processes.rb +197 -0
- data/lib/brevo/models/get_product_details.rb +357 -0
- data/lib/brevo/models/get_products.rb +206 -0
- data/lib/brevo/models/get_reports.rb +186 -0
- data/lib/brevo/models/get_reports_reports.rb +370 -0
- data/lib/brevo/models/get_scheduled_email_by_batch_id.rb +196 -0
- data/lib/brevo/models/get_scheduled_email_by_batch_id_batches.rb +254 -0
- data/lib/brevo/models/get_scheduled_email_by_message_id.rb +254 -0
- data/lib/brevo/models/get_segments.rb +194 -0
- data/lib/brevo/models/get_segments_segments.rb +215 -0
- data/lib/brevo/models/get_senders_list.rb +187 -0
- data/lib/brevo/models/get_senders_list_ips.rb +220 -0
- data/lib/brevo/models/get_senders_list_senders.rb +247 -0
- data/lib/brevo/models/get_shared_template_url.rb +190 -0
- data/lib/brevo/models/get_sms_campaign.rb +352 -0
- data/lib/brevo/models/get_sms_campaign_overview.rb +324 -0
- data/lib/brevo/models/get_sms_campaign_recipients.rb +175 -0
- data/lib/brevo/models/get_sms_campaign_stats.rb +280 -0
- data/lib/brevo/models/get_sms_campaigns.rb +196 -0
- data/lib/brevo/models/get_sms_event_report.rb +186 -0
- data/lib/brevo/models/get_sms_event_report_events.rb +278 -0
- data/lib/brevo/models/get_smtp_template_overview.rb +364 -0
- data/lib/brevo/models/get_smtp_template_overview_sender.rb +205 -0
- data/lib/brevo/models/get_smtp_templates.rb +196 -0
- data/lib/brevo/models/get_sso_token.rb +190 -0
- data/lib/brevo/models/get_stats_by_browser.rb +175 -0
- data/lib/brevo/models/get_stats_by_device.rb +223 -0
- data/lib/brevo/models/get_stats_by_domain.rb +175 -0
- data/lib/brevo/models/get_transac_aggregated_sms_report.rb +275 -0
- data/lib/brevo/models/get_transac_blocked_contacts.rb +196 -0
- data/lib/brevo/models/get_transac_blocked_contacts_contacts.rb +234 -0
- data/lib/brevo/models/get_transac_blocked_contacts_reason.rb +230 -0
- data/lib/brevo/models/get_transac_email_content.rb +277 -0
- data/lib/brevo/models/get_transac_email_content_events.rb +205 -0
- data/lib/brevo/models/get_transac_emails_list.rb +196 -0
- data/lib/brevo/models/get_transac_emails_list_transactional_emails.rb +282 -0
- data/lib/brevo/models/get_transac_sms_report.rb +186 -0
- data/lib/brevo/models/get_transac_sms_report_reports.rb +275 -0
- data/lib/brevo/models/get_user_permission.rb +223 -0
- data/lib/brevo/models/get_user_permission_privileges.rb +205 -0
- data/lib/brevo/models/get_wa_templates.rb +206 -0
- data/lib/brevo/models/get_wa_templates_templates.rb +290 -0
- data/lib/brevo/models/get_webhook.rb +315 -0
- data/lib/brevo/models/get_webhooks.rb +191 -0
- data/lib/brevo/models/get_whats_app_config.rb +281 -0
- data/lib/brevo/models/get_whatsapp_campaign_overview.rb +332 -0
- data/lib/brevo/models/get_whatsapp_campaigns.rb +196 -0
- data/lib/brevo/models/get_whatsapp_campaigns_campaigns.rb +353 -0
- data/lib/brevo/models/get_whatsapp_event_report.rb +186 -0
- data/lib/brevo/models/get_whatsapp_event_report_events.rb +314 -0
- data/lib/brevo/models/inline_response_200.rb +191 -0
- data/lib/brevo/models/inline_response_200_1.rb +220 -0
- data/lib/brevo/models/inline_response_201.rb +191 -0
- data/lib/brevo/models/inline_response_201_1.rb +191 -0
- data/lib/brevo/models/inline_response_201_2.rb +190 -0
- data/lib/brevo/models/inline_response_201_3.rb +190 -0
- data/lib/brevo/models/inline_response_201_4.rb +190 -0
- data/lib/brevo/models/manage_ip.rb +185 -0
- data/lib/brevo/models/master_details_response.rb +243 -0
- data/lib/brevo/models/master_details_response_billing_info.rb +214 -0
- data/lib/brevo/models/master_details_response_billing_info_address.rb +226 -0
- data/lib/brevo/models/master_details_response_billing_info_name.rb +196 -0
- data/lib/brevo/models/master_details_response_plan_info.rb +272 -0
- data/lib/brevo/models/master_details_response_plan_info_features.rb +225 -0
- data/lib/brevo/models/note.rb +283 -0
- data/lib/brevo/models/note_data.rb +255 -0
- data/lib/brevo/models/note_id.rb +186 -0
- data/lib/brevo/models/note_list.rb +176 -0
- data/lib/brevo/models/order.rb +297 -0
- data/lib/brevo/models/order_batch.rb +202 -0
- data/lib/brevo/models/order_billing.rb +246 -0
- data/lib/brevo/models/order_products.rb +231 -0
- data/lib/brevo/models/otp.rb +185 -0
- data/lib/brevo/models/pipeline.rb +208 -0
- data/lib/brevo/models/pipeline_stage.rb +196 -0
- data/lib/brevo/models/pipelines.rb +176 -0
- data/lib/brevo/models/post_contact_info.rb +189 -0
- data/lib/brevo/models/post_contact_info_contacts.rb +217 -0
- data/lib/brevo/models/post_send_failed.rb +238 -0
- data/lib/brevo/models/post_send_sms_test_failed.rb +227 -0
- data/lib/brevo/models/remaining_credit_model.rb +203 -0
- data/lib/brevo/models/remaining_credit_model_child.rb +206 -0
- data/lib/brevo/models/remaining_credit_model_reseller.rb +205 -0
- data/lib/brevo/models/remove_contact_from_list.rb +209 -0
- data/lib/brevo/models/remove_credits.rb +195 -0
- data/lib/brevo/models/request_contact_export.rb +211 -0
- data/lib/brevo/models/request_contact_export_custom_contact_filter.rb +294 -0
- data/lib/brevo/models/request_contact_import.rb +286 -0
- data/lib/brevo/models/request_contact_import_json_body.rb +194 -0
- data/lib/brevo/models/request_contact_import_new_list.rb +196 -0
- data/lib/brevo/models/request_sms_recipient_export.rb +234 -0
- data/lib/brevo/models/schedule_smtp_email.rb +206 -0
- data/lib/brevo/models/send_report.rb +235 -0
- data/lib/brevo/models/send_report_email.rb +208 -0
- data/lib/brevo/models/send_sms.rb +233 -0
- data/lib/brevo/models/send_smtp_email.rb +345 -0
- data/lib/brevo/models/send_smtp_email_attachment.rb +220 -0
- data/lib/brevo/models/send_smtp_email_bcc.rb +200 -0
- data/lib/brevo/models/send_smtp_email_cc.rb +200 -0
- data/lib/brevo/models/send_smtp_email_message_versions.rb +247 -0
- data/lib/brevo/models/send_smtp_email_reply_to.rb +201 -0
- data/lib/brevo/models/send_smtp_email_reply_to_1.rb +201 -0
- data/lib/brevo/models/send_smtp_email_sender.rb +206 -0
- data/lib/brevo/models/send_smtp_email_to.rb +200 -0
- data/lib/brevo/models/send_smtp_email_to_1.rb +200 -0
- data/lib/brevo/models/send_test_email.rb +187 -0
- data/lib/brevo/models/send_test_sms.rb +185 -0
- data/lib/brevo/models/send_transac_sms.rb +327 -0
- data/lib/brevo/models/send_whatsapp_message.rb +227 -0
- data/lib/brevo/models/sso_token_request.rb +254 -0
- data/lib/brevo/models/sub_account_apps_toggle_request.rb +306 -0
- data/lib/brevo/models/sub_account_details_response.rb +214 -0
- data/lib/brevo/models/sub_account_details_response_plan_info.rb +204 -0
- data/lib/brevo/models/sub_account_details_response_plan_info_credits.rb +195 -0
- data/lib/brevo/models/sub_account_details_response_plan_info_credits_emails.rb +196 -0
- data/lib/brevo/models/sub_account_details_response_plan_info_features.rb +203 -0
- data/lib/brevo/models/sub_account_details_response_plan_info_features_inbox.rb +196 -0
- data/lib/brevo/models/sub_account_details_response_plan_info_features_landing_page.rb +196 -0
- data/lib/brevo/models/sub_account_details_response_plan_info_features_users.rb +196 -0
- data/lib/brevo/models/sub_account_update_plan_request.rb +194 -0
- data/lib/brevo/models/sub_account_update_plan_request_credits.rb +186 -0
- data/lib/brevo/models/sub_account_update_plan_request_features.rb +206 -0
- data/lib/brevo/models/sub_accounts_response.rb +196 -0
- data/lib/brevo/models/sub_accounts_response_sub_accounts.rb +235 -0
- data/lib/brevo/models/task.rb +252 -0
- data/lib/brevo/models/task_list.rb +188 -0
- data/lib/brevo/models/task_reminder.rb +257 -0
- data/lib/brevo/models/task_types.rb +196 -0
- data/lib/brevo/models/update_attribute.rb +197 -0
- data/lib/brevo/models/update_attribute_enumeration.rb +205 -0
- data/lib/brevo/models/update_batch_contacts.rb +187 -0
- data/lib/brevo/models/update_batch_contacts_contacts.rb +283 -0
- data/lib/brevo/models/update_batch_contacts_model.rb +197 -0
- data/lib/brevo/models/update_campaign_status.rb +220 -0
- data/lib/brevo/models/update_child.rb +225 -0
- data/lib/brevo/models/update_child_account_status.rb +215 -0
- data/lib/brevo/models/update_child_domain.rb +185 -0
- data/lib/brevo/models/update_contact.rb +251 -0
- data/lib/brevo/models/update_coupon_collection.rb +190 -0
- data/lib/brevo/models/update_email_campaign.rb +597 -0
- data/lib/brevo/models/update_email_campaign_recipients.rb +212 -0
- data/lib/brevo/models/update_email_campaign_sender.rb +206 -0
- data/lib/brevo/models/update_external_feed.rb +327 -0
- data/lib/brevo/models/update_list.rb +195 -0
- data/lib/brevo/models/update_sender.rb +207 -0
- data/lib/brevo/models/update_sms_campaign.rb +271 -0
- data/lib/brevo/models/update_smtp_template.rb +274 -0
- data/lib/brevo/models/update_smtp_template_sender.rb +206 -0
- data/lib/brevo/models/update_webhook.rb +239 -0
- data/lib/brevo/models/update_whats_app_campaign.rb +250 -0
- data/lib/brevo/models/upload_image_model.rb +190 -0
- data/lib/brevo/models/upload_image_to_gallery.rb +200 -0
- data/lib/brevo/models/variables_items.rb +202 -0
- data/lib/brevo/models/whatsapp_camp_stats.rb +245 -0
- data/lib/brevo/models/whatsapp_camp_template.rb +287 -0
- data/lib/brevo/version.rb +15 -0
- data/lib/brevo.rb +395 -0
- data/spec/api/account_api_spec.rb +59 -0
- data/spec/api/companies_api_spec.rb +119 -0
- data/spec/api/contacts_api_spec.rb +387 -0
- data/spec/api/conversations_api_spec.rb +140 -0
- data/spec/api/coupons_api_spec.rb +93 -0
- data/spec/api/deals_api_spec.rb +151 -0
- data/spec/api/domains_api_spec.rb +89 -0
- data/spec/api/ecommerce_api_spec.rb +173 -0
- data/spec/api/email_campaigns_api_spec.rb +196 -0
- data/spec/api/external_feeds_api_spec.rb +102 -0
- data/spec/api/files_api_spec.rb +99 -0
- data/spec/api/inbound_parsing_api_spec.rb +76 -0
- data/spec/api/master_account_api_spec.rb +158 -0
- data/spec/api/notes_api_spec.rb +97 -0
- data/spec/api/process_api_spec.rb +59 -0
- data/spec/api/reseller_api_spec.rb +223 -0
- data/spec/api/senders_api_spec.rb +114 -0
- data/spec/api/sms_campaigns_api_spec.rb +157 -0
- data/spec/api/tasks_api_spec.rb +113 -0
- data/spec/api/transactional_emails_api_spec.rb +330 -0
- data/spec/api/transactional_sms_api_spec.rb +94 -0
- data/spec/api/transactional_whats_app_api_spec.rb +66 -0
- data/spec/api/user_api_spec.rb +56 -0
- data/spec/api/webhooks_api_spec.rb +104 -0
- data/spec/api/whats_app_campaigns_api_spec.rb +142 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
- data/spec/models/ab_test_campaign_result_spec.rb +91 -0
- data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
- data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
- data/spec/models/ab_test_version_clicks_spec.rb +35 -0
- data/spec/models/ab_test_version_stats_spec.rb +47 -0
- data/spec/models/add_child_domain_spec.rb +41 -0
- data/spec/models/add_contact_to_list_spec.rb +47 -0
- data/spec/models/add_credits_spec.rb +47 -0
- data/spec/models/authenticate_domain_model_spec.rb +47 -0
- data/spec/models/block_domain_spec.rb +41 -0
- data/spec/models/body_10_spec.rb +59 -0
- data/spec/models/body_11_spec.rb +41 -0
- data/spec/models/body_12_spec.rb +59 -0
- data/spec/models/body_1_spec.rb +53 -0
- data/spec/models/body_2_spec.rb +59 -0
- data/spec/models/body_3_spec.rb +47 -0
- data/spec/models/body_4_spec.rb +47 -0
- data/spec/models/body_5_spec.rb +59 -0
- data/spec/models/body_6_spec.rb +101 -0
- data/spec/models/body_7_spec.rb +95 -0
- data/spec/models/body_8_spec.rb +71 -0
- data/spec/models/body_9_spec.rb +41 -0
- data/spec/models/body_spec.rb +53 -0
- data/spec/models/body_variables_items_spec.rb +35 -0
- data/spec/models/companies_list_spec.rb +41 -0
- data/spec/models/company_attributes_inner_spec.rb +65 -0
- data/spec/models/company_attributes_spec.rb +35 -0
- data/spec/models/company_spec.rb +59 -0
- data/spec/models/component_items_spec.rb +47 -0
- data/spec/models/conversations_message_file_image_info_spec.rb +53 -0
- data/spec/models/conversations_message_file_spec.rb +65 -0
- data/spec/models/conversations_message_spec.rb +99 -0
- data/spec/models/create_api_key_request_spec.rb +47 -0
- data/spec/models/create_api_key_response_spec.rb +47 -0
- data/spec/models/create_attribute_enumeration_spec.rb +47 -0
- data/spec/models/create_attribute_spec.rb +63 -0
- data/spec/models/create_category_model_spec.rb +41 -0
- data/spec/models/create_child_spec.rb +75 -0
- data/spec/models/create_contact_spec.rb +83 -0
- data/spec/models/create_coupon_collection_spec.rb +47 -0
- data/spec/models/create_coupons_spec.rb +47 -0
- data/spec/models/create_doi_contact_spec.rb +71 -0
- data/spec/models/create_domain_model_dns_records_dkim_record_spec.rb +59 -0
- data/spec/models/create_domain_model_dns_records_spec.rb +47 -0
- data/spec/models/create_domain_model_spec.rb +59 -0
- data/spec/models/create_domain_spec.rb +41 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +53 -0
- data/spec/models/create_email_campaign_sender_spec.rb +53 -0
- data/spec/models/create_email_campaign_spec.rb +225 -0
- data/spec/models/create_external_feed_spec.rb +93 -0
- data/spec/models/create_list_spec.rb +47 -0
- data/spec/models/create_model_spec.rb +41 -0
- data/spec/models/create_product_model_spec.rb +41 -0
- data/spec/models/create_reseller_spec.rb +47 -0
- data/spec/models/create_sender_ips_spec.rb +53 -0
- data/spec/models/create_sender_model_spec.rb +53 -0
- data/spec/models/create_sender_spec.rb +53 -0
- data/spec/models/create_sms_campaign_recipients_spec.rb +47 -0
- data/spec/models/create_sms_campaign_spec.rb +83 -0
- data/spec/models/create_smtp_email_spec.rb +47 -0
- data/spec/models/create_smtp_template_sender_spec.rb +53 -0
- data/spec/models/create_smtp_template_spec.rb +95 -0
- data/spec/models/create_sub_account_response_spec.rb +41 -0
- data/spec/models/create_sub_account_spec.rb +63 -0
- data/spec/models/create_update_batch_category_model_spec.rb +47 -0
- data/spec/models/create_update_batch_category_spec.rb +47 -0
- data/spec/models/create_update_batch_products_model_spec.rb +47 -0
- data/spec/models/create_update_batch_products_spec.rb +47 -0
- data/spec/models/create_update_categories_spec.rb +59 -0
- data/spec/models/create_update_category_spec.rb +65 -0
- data/spec/models/create_update_contact_model_spec.rb +41 -0
- data/spec/models/create_update_folder_spec.rb +41 -0
- data/spec/models/create_update_product_spec.rb +101 -0
- data/spec/models/create_update_products_spec.rb +95 -0
- data/spec/models/create_webhook_spec.rb +73 -0
- data/spec/models/create_whats_app_campaign_recipients_spec.rb +53 -0
- data/spec/models/create_whats_app_campaign_spec.rb +59 -0
- data/spec/models/create_whats_app_template_spec.rb +75 -0
- data/spec/models/created_batch_id_spec.rb +41 -0
- data/spec/models/created_process_id_spec.rb +41 -0
- data/spec/models/deal_attributes_inner_spec.rb +65 -0
- data/spec/models/deal_attributes_spec.rb +35 -0
- data/spec/models/deal_spec.rb +59 -0
- data/spec/models/deals_list_spec.rb +41 -0
- data/spec/models/delete_hardbounces_spec.rb +53 -0
- data/spec/models/email_export_recipients_spec.rb +51 -0
- data/spec/models/error_model_spec.rb +51 -0
- data/spec/models/export_webhooks_history_spec.rb +93 -0
- data/spec/models/file_data_spec.rb +77 -0
- data/spec/models/file_downloadable_link_spec.rb +41 -0
- data/spec/models/file_list_spec.rb +35 -0
- data/spec/models/get_account_activity_logs_spec.rb +65 -0
- data/spec/models/get_account_activity_spec.rb +41 -0
- data/spec/models/get_account_marketing_automation_spec.rb +47 -0
- data/spec/models/get_account_plan_spec.rb +79 -0
- data/spec/models/get_account_relay_data_spec.rb +53 -0
- data/spec/models/get_account_relay_spec.rb +47 -0
- data/spec/models/get_account_spec.rb +83 -0
- data/spec/models/get_aggregated_report_spec.rb +113 -0
- data/spec/models/get_all_external_feeds_feeds_spec.rb +111 -0
- data/spec/models/get_all_external_feeds_spec.rb +47 -0
- data/spec/models/get_attributes_attributes_spec.rb +73 -0
- data/spec/models/get_attributes_enumeration_spec.rb +47 -0
- data/spec/models/get_attributes_spec.rb +41 -0
- data/spec/models/get_blocked_domains_spec.rb +41 -0
- data/spec/models/get_campaign_overview_spec.rb +127 -0
- data/spec/models/get_campaign_recipients_spec.rb +47 -0
- data/spec/models/get_campaign_stats_spec.rb +131 -0
- data/spec/models/get_categories_spec.rb +47 -0
- data/spec/models/get_category_details_spec.rb +71 -0
- data/spec/models/get_child_account_creation_status_spec.rb +41 -0
- data/spec/models/get_child_domain_spec.rb +47 -0
- data/spec/models/get_child_domains_spec.rb +35 -0
- data/spec/models/get_child_info_api_keys_spec.rb +47 -0
- data/spec/models/get_child_info_api_keys_v2_spec.rb +47 -0
- data/spec/models/get_child_info_api_keys_v3_spec.rb +47 -0
- data/spec/models/get_child_info_credits_spec.rb +47 -0
- data/spec/models/get_child_info_spec.rb +89 -0
- data/spec/models/get_child_info_statistics_spec.rb +53 -0
- data/spec/models/get_children_list_spec.rb +47 -0
- data/spec/models/get_client_spec.rb +59 -0
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +47 -0
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +59 -0
- data/spec/models/get_contact_campaign_stats_spec.rb +89 -0
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +53 -0
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +47 -0
- data/spec/models/get_contact_details_spec.rb +89 -0
- data/spec/models/get_contacts_spec.rb +47 -0
- data/spec/models/get_coupon_collection_spec.rb +71 -0
- data/spec/models/get_device_browser_stats_spec.rb +59 -0
- data/spec/models/get_domain_configuration_model_spec.rb +59 -0
- data/spec/models/get_domains_list_domains_spec.rb +65 -0
- data/spec/models/get_domains_list_spec.rb +41 -0
- data/spec/models/get_email_campaign_spec.rb +235 -0
- data/spec/models/get_email_campaigns_spec.rb +47 -0
- data/spec/models/get_email_event_report_events_spec.rb +105 -0
- data/spec/models/get_email_event_report_spec.rb +41 -0
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +53 -0
- data/spec/models/get_extended_campaign_overview_spec.rb +223 -0
- data/spec/models/get_extended_campaign_stats_global_stats_spec.rb +35 -0
- data/spec/models/get_extended_campaign_stats_spec.rb +83 -0
- data/spec/models/get_extended_client_address_spec.rb +59 -0
- data/spec/models/get_extended_client_spec.rb +65 -0
- data/spec/models/get_extended_contact_details_spec.rb +95 -0
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_delivered_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +59 -0
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +59 -0
- data/spec/models/get_extended_contact_details_statistics_spec.rb +89 -0
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +53 -0
- data/spec/models/get_extended_list_campaign_stats_spec.rb +47 -0
- data/spec/models/get_extended_list_spec.rb +89 -0
- data/spec/models/get_external_feed_by_uuid_headers_spec.rb +47 -0
- data/spec/models/get_external_feed_by_uuid_spec.rb +111 -0
- data/spec/models/get_folder_lists_spec.rb +47 -0
- data/spec/models/get_folder_spec.rb +65 -0
- data/spec/models/get_folders_spec.rb +47 -0
- data/spec/models/get_inbound_email_events_by_uuid_attachments_spec.rb +59 -0
- data/spec/models/get_inbound_email_events_by_uuid_logs_spec.rb +51 -0
- data/spec/models/get_inbound_email_events_by_uuid_spec.rb +83 -0
- data/spec/models/get_inbound_email_events_events_spec.rb +59 -0
- data/spec/models/get_inbound_email_events_spec.rb +41 -0
- data/spec/models/get_invited_users_list_feature_access_spec.rb +53 -0
- data/spec/models/get_invited_users_list_spec.rb +41 -0
- data/spec/models/get_invited_users_list_users_spec.rb +59 -0
- data/spec/models/get_ip_from_sender_spec.rb +59 -0
- data/spec/models/get_ip_spec.rb +59 -0
- data/spec/models/get_ips_from_sender_spec.rb +41 -0
- data/spec/models/get_ips_spec.rb +41 -0
- data/spec/models/get_list_spec.rb +65 -0
- data/spec/models/get_lists_spec.rb +47 -0
- data/spec/models/get_process_spec.rb +63 -0
- data/spec/models/get_processes_spec.rb +47 -0
- data/spec/models/get_product_details_spec.rb +125 -0
- data/spec/models/get_products_spec.rb +47 -0
- data/spec/models/get_reports_reports_spec.rb +113 -0
- data/spec/models/get_reports_spec.rb +41 -0
- data/spec/models/get_scheduled_email_by_batch_id_batches_spec.rb +57 -0
- data/spec/models/get_scheduled_email_by_batch_id_spec.rb +47 -0
- data/spec/models/get_scheduled_email_by_message_id_spec.rb +57 -0
- data/spec/models/get_segments_segments_spec.rb +59 -0
- data/spec/models/get_segments_spec.rb +47 -0
- data/spec/models/get_senders_list_ips_spec.rb +53 -0
- data/spec/models/get_senders_list_senders_spec.rb +65 -0
- data/spec/models/get_senders_list_spec.rb +41 -0
- data/spec/models/get_shared_template_url_spec.rb +41 -0
- data/spec/models/get_sms_campaign_overview_spec.rb +87 -0
- data/spec/models/get_sms_campaign_recipients_spec.rb +35 -0
- data/spec/models/get_sms_campaign_spec.rb +99 -0
- data/spec/models/get_sms_campaign_stats_spec.rb +77 -0
- data/spec/models/get_sms_campaigns_spec.rb +47 -0
- data/spec/models/get_sms_event_report_events_spec.rb +81 -0
- data/spec/models/get_sms_event_report_spec.rb +41 -0
- data/spec/models/get_smtp_template_overview_sender_spec.rb +53 -0
- data/spec/models/get_smtp_template_overview_spec.rb +113 -0
- data/spec/models/get_smtp_templates_spec.rb +47 -0
- data/spec/models/get_sso_token_spec.rb +41 -0
- data/spec/models/get_stats_by_browser_spec.rb +35 -0
- data/spec/models/get_stats_by_device_spec.rb +59 -0
- data/spec/models/get_stats_by_domain_spec.rb +35 -0
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +95 -0
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
- data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
- data/spec/models/get_transac_email_content_events_spec.rb +47 -0
- data/spec/models/get_transac_email_content_spec.rb +77 -0
- data/spec/models/get_transac_emails_list_spec.rb +47 -0
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +83 -0
- data/spec/models/get_transac_sms_report_reports_spec.rb +95 -0
- data/spec/models/get_transac_sms_report_spec.rb +41 -0
- data/spec/models/get_user_permission_privileges_spec.rb +47 -0
- data/spec/models/get_user_permission_spec.rb +53 -0
- data/spec/models/get_wa_templates_spec.rb +47 -0
- data/spec/models/get_wa_templates_templates_spec.rb +83 -0
- data/spec/models/get_webhook_spec.rb +81 -0
- data/spec/models/get_webhooks_spec.rb +41 -0
- data/spec/models/get_whats_app_config_spec.rb +79 -0
- data/spec/models/get_whatsapp_campaign_overview_spec.rb +93 -0
- data/spec/models/get_whatsapp_campaigns_campaigns_spec.rb +105 -0
- data/spec/models/get_whatsapp_campaigns_spec.rb +47 -0
- data/spec/models/get_whatsapp_event_report_events_spec.rb +87 -0
- data/spec/models/get_whatsapp_event_report_spec.rb +41 -0
- data/spec/models/inline_response_200_1_spec.rb +53 -0
- data/spec/models/inline_response_200_spec.rb +41 -0
- data/spec/models/inline_response_201_1_spec.rb +41 -0
- data/spec/models/inline_response_201_2_spec.rb +41 -0
- data/spec/models/inline_response_201_3_spec.rb +41 -0
- data/spec/models/inline_response_201_4_spec.rb +41 -0
- data/spec/models/inline_response_201_spec.rb +41 -0
- data/spec/models/manage_ip_spec.rb +41 -0
- data/spec/models/master_details_response_billing_info_address_spec.rb +65 -0
- data/spec/models/master_details_response_billing_info_name_spec.rb +47 -0
- data/spec/models/master_details_response_billing_info_spec.rb +59 -0
- data/spec/models/master_details_response_plan_info_features_spec.rb +65 -0
- data/spec/models/master_details_response_plan_info_spec.rb +75 -0
- data/spec/models/master_details_response_spec.rb +77 -0
- data/spec/models/note_data_spec.rb +59 -0
- data/spec/models/note_id_spec.rb +41 -0
- data/spec/models/note_list_spec.rb +35 -0
- data/spec/models/note_spec.rb +77 -0
- data/spec/models/order_batch_spec.rb +47 -0
- data/spec/models/order_billing_spec.rb +77 -0
- data/spec/models/order_products_spec.rb +59 -0
- data/spec/models/order_spec.rb +89 -0
- data/spec/models/otp_spec.rb +41 -0
- data/spec/models/pipeline_spec.rb +53 -0
- data/spec/models/pipeline_stage_spec.rb +47 -0
- data/spec/models/pipelines_spec.rb +35 -0
- data/spec/models/post_contact_info_contacts_spec.rb +59 -0
- data/spec/models/post_contact_info_spec.rb +41 -0
- data/spec/models/post_send_failed_spec.rb +65 -0
- data/spec/models/post_send_sms_test_failed_spec.rb +59 -0
- data/spec/models/remaining_credit_model_child_spec.rb +47 -0
- data/spec/models/remaining_credit_model_reseller_spec.rb +47 -0
- data/spec/models/remaining_credit_model_spec.rb +47 -0
- data/spec/models/remove_contact_from_list_spec.rb +53 -0
- data/spec/models/remove_credits_spec.rb +47 -0
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
- data/spec/models/request_contact_export_spec.rb +53 -0
- data/spec/models/request_contact_import_json_body_spec.rb +47 -0
- data/spec/models/request_contact_import_new_list_spec.rb +47 -0
- data/spec/models/request_contact_import_spec.rb +95 -0
- data/spec/models/request_sms_recipient_export_spec.rb +51 -0
- data/spec/models/schedule_smtp_email_spec.rb +53 -0
- data/spec/models/send_report_email_spec.rb +47 -0
- data/spec/models/send_report_spec.rb +51 -0
- data/spec/models/send_sms_spec.rb +65 -0
- data/spec/models/send_smtp_email_attachment_spec.rb +53 -0
- data/spec/models/send_smtp_email_bcc_spec.rb +47 -0
- data/spec/models/send_smtp_email_cc_spec.rb +47 -0
- data/spec/models/send_smtp_email_message_versions_spec.rb +71 -0
- data/spec/models/send_smtp_email_reply_to_1_spec.rb +47 -0
- data/spec/models/send_smtp_email_reply_to_spec.rb +47 -0
- data/spec/models/send_smtp_email_sender_spec.rb +53 -0
- data/spec/models/send_smtp_email_spec.rb +131 -0
- data/spec/models/send_smtp_email_to_1_spec.rb +47 -0
- data/spec/models/send_smtp_email_to_spec.rb +47 -0
- data/spec/models/send_test_email_spec.rb +41 -0
- data/spec/models/send_test_sms_spec.rb +41 -0
- data/spec/models/send_transac_sms_spec.rb +87 -0
- data/spec/models/send_whatsapp_message_spec.rb +59 -0
- data/spec/models/sso_token_request_spec.rb +63 -0
- data/spec/models/sub_account_apps_toggle_request_spec.rb +113 -0
- data/spec/models/sub_account_details_response_plan_info_credits_emails_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_credits_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_inbox_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_landing_page_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_spec.rb +53 -0
- data/spec/models/sub_account_details_response_plan_info_features_users_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_spec.rb +53 -0
- data/spec/models/sub_account_details_response_spec.rb +59 -0
- data/spec/models/sub_account_update_plan_request_credits_spec.rb +41 -0
- data/spec/models/sub_account_update_plan_request_features_spec.rb +53 -0
- data/spec/models/sub_account_update_plan_request_spec.rb +47 -0
- data/spec/models/sub_accounts_response_spec.rb +47 -0
- data/spec/models/sub_accounts_response_sub_accounts_spec.rb +59 -0
- data/spec/models/task_list_spec.rb +41 -0
- data/spec/models/task_reminder_spec.rb +57 -0
- data/spec/models/task_spec.rb +71 -0
- data/spec/models/task_types_spec.rb +47 -0
- data/spec/models/update_attribute_enumeration_spec.rb +47 -0
- data/spec/models/update_attribute_spec.rb +47 -0
- data/spec/models/update_batch_contacts_contacts_spec.rb +95 -0
- data/spec/models/update_batch_contacts_model_spec.rb +47 -0
- data/spec/models/update_batch_contacts_spec.rb +41 -0
- data/spec/models/update_campaign_status_spec.rb +45 -0
- data/spec/models/update_child_account_status_spec.rb +59 -0
- data/spec/models/update_child_domain_spec.rb +41 -0
- data/spec/models/update_child_spec.rb +65 -0
- data/spec/models/update_contact_spec.rb +77 -0
- data/spec/models/update_coupon_collection_spec.rb +41 -0
- data/spec/models/update_email_campaign_recipients_spec.rb +53 -0
- data/spec/models/update_email_campaign_sender_spec.rb +53 -0
- data/spec/models/update_email_campaign_spec.rb +225 -0
- data/spec/models/update_external_feed_spec.rb +93 -0
- data/spec/models/update_list_spec.rb +47 -0
- data/spec/models/update_sender_spec.rb +53 -0
- data/spec/models/update_sms_campaign_spec.rb +83 -0
- data/spec/models/update_smtp_template_sender_spec.rb +53 -0
- data/spec/models/update_smtp_template_spec.rb +95 -0
- data/spec/models/update_webhook_spec.rb +63 -0
- data/spec/models/update_whats_app_campaign_spec.rb +63 -0
- data/spec/models/upload_image_model_spec.rb +41 -0
- data/spec/models/upload_image_to_gallery_spec.rb +47 -0
- data/spec/models/variables_items_spec.rb +53 -0
- data/spec/models/whatsapp_camp_stats_spec.rb +65 -0
- data/spec/models/whatsapp_camp_template_spec.rb +101 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1683 -0
|
@@ -0,0 +1,801 @@
|
|
|
1
|
+
# Brevo::EmailCampaignsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.brevo.com/v3*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_email_campaign**](EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
|
|
8
|
+
[**delete_email_campaign**](EmailCampaignsApi.md#delete_email_campaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
|
|
9
|
+
[**email_export_recipients**](EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign
|
|
10
|
+
[**get_ab_test_campaign_result**](EmailCampaignsApi.md#get_ab_test_campaign_result) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results
|
|
11
|
+
[**get_email_campaign**](EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report
|
|
12
|
+
[**get_email_campaigns**](EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created email campaigns
|
|
13
|
+
[**get_shared_template_url**](EmailCampaignsApi.md#get_shared_template_url) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url
|
|
14
|
+
[**send_email_campaign_now**](EmailCampaignsApi.md#send_email_campaign_now) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId
|
|
15
|
+
[**send_report**](EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign
|
|
16
|
+
[**send_test_email**](EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
|
|
17
|
+
[**update_campaign_status**](EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status
|
|
18
|
+
[**update_email_campaign**](EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign
|
|
19
|
+
[**upload_image_to_gallery**](EmailCampaignsApi.md#upload_image_to_gallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
# **create_email_campaign**
|
|
23
|
+
> CreateModel create_email_campaign(email_campaigns)
|
|
24
|
+
|
|
25
|
+
Create an email campaign
|
|
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::EmailCampaignsApi.new
|
|
45
|
+
|
|
46
|
+
email_campaigns = Brevo::CreateEmailCampaign.new # CreateEmailCampaign | Values to create a campaign
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
begin
|
|
50
|
+
#Create an email campaign
|
|
51
|
+
result = api_instance.create_email_campaign(email_campaigns)
|
|
52
|
+
p result
|
|
53
|
+
rescue Brevo::ApiError => e
|
|
54
|
+
puts "Exception when calling EmailCampaignsApi->create_email_campaign: #{e}"
|
|
55
|
+
end
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Parameters
|
|
59
|
+
|
|
60
|
+
Name | Type | Description | Notes
|
|
61
|
+
------------- | ------------- | ------------- | -------------
|
|
62
|
+
**email_campaigns** | [**CreateEmailCampaign**](CreateEmailCampaign.md)| Values to create a campaign |
|
|
63
|
+
|
|
64
|
+
### Return type
|
|
65
|
+
|
|
66
|
+
[**CreateModel**](CreateModel.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_email_campaign**
|
|
80
|
+
> delete_email_campaign(campaign_id)
|
|
81
|
+
|
|
82
|
+
Delete an email campaign
|
|
83
|
+
|
|
84
|
+
### Example
|
|
85
|
+
```ruby
|
|
86
|
+
# load the gem
|
|
87
|
+
require 'brevo'
|
|
88
|
+
# setup authorization
|
|
89
|
+
Brevo.configure do |config|
|
|
90
|
+
# Configure API key authorization: api-key
|
|
91
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
92
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
93
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
94
|
+
|
|
95
|
+
# Configure API key authorization: partner-key
|
|
96
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
97
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
98
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
api_instance = Brevo::EmailCampaignsApi.new
|
|
102
|
+
|
|
103
|
+
campaign_id = 789 # Integer | id of the campaign
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
begin
|
|
107
|
+
#Delete an email campaign
|
|
108
|
+
api_instance.delete_email_campaign(campaign_id)
|
|
109
|
+
rescue Brevo::ApiError => e
|
|
110
|
+
puts "Exception when calling EmailCampaignsApi->delete_email_campaign: #{e}"
|
|
111
|
+
end
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Parameters
|
|
115
|
+
|
|
116
|
+
Name | Type | Description | Notes
|
|
117
|
+
------------- | ------------- | ------------- | -------------
|
|
118
|
+
**campaign_id** | **Integer**| id of the campaign |
|
|
119
|
+
|
|
120
|
+
### Return type
|
|
121
|
+
|
|
122
|
+
nil (empty response body)
|
|
123
|
+
|
|
124
|
+
### Authorization
|
|
125
|
+
|
|
126
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
127
|
+
|
|
128
|
+
### HTTP request headers
|
|
129
|
+
|
|
130
|
+
- **Content-Type**: application/json
|
|
131
|
+
- **Accept**: application/json
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
# **email_export_recipients**
|
|
136
|
+
> CreatedProcessId email_export_recipients(campaign_id, opts)
|
|
137
|
+
|
|
138
|
+
Export the recipients of an email campaign
|
|
139
|
+
|
|
140
|
+
### Example
|
|
141
|
+
```ruby
|
|
142
|
+
# load the gem
|
|
143
|
+
require 'brevo'
|
|
144
|
+
# setup authorization
|
|
145
|
+
Brevo.configure do |config|
|
|
146
|
+
# Configure API key authorization: api-key
|
|
147
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
148
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
149
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
150
|
+
|
|
151
|
+
# Configure API key authorization: partner-key
|
|
152
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
153
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
154
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
api_instance = Brevo::EmailCampaignsApi.new
|
|
158
|
+
|
|
159
|
+
campaign_id = 789 # Integer | Id of the campaign
|
|
160
|
+
|
|
161
|
+
opts = {
|
|
162
|
+
recipient_export: Brevo::EmailExportRecipients.new # EmailExportRecipients | Values to send for a recipient export request
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
begin
|
|
166
|
+
#Export the recipients of an email campaign
|
|
167
|
+
result = api_instance.email_export_recipients(campaign_id, opts)
|
|
168
|
+
p result
|
|
169
|
+
rescue Brevo::ApiError => e
|
|
170
|
+
puts "Exception when calling EmailCampaignsApi->email_export_recipients: #{e}"
|
|
171
|
+
end
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### Parameters
|
|
175
|
+
|
|
176
|
+
Name | Type | Description | Notes
|
|
177
|
+
------------- | ------------- | ------------- | -------------
|
|
178
|
+
**campaign_id** | **Integer**| Id of the campaign |
|
|
179
|
+
**recipient_export** | [**EmailExportRecipients**](EmailExportRecipients.md)| Values to send for a recipient export request | [optional]
|
|
180
|
+
|
|
181
|
+
### Return type
|
|
182
|
+
|
|
183
|
+
[**CreatedProcessId**](CreatedProcessId.md)
|
|
184
|
+
|
|
185
|
+
### Authorization
|
|
186
|
+
|
|
187
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
188
|
+
|
|
189
|
+
### HTTP request headers
|
|
190
|
+
|
|
191
|
+
- **Content-Type**: application/json
|
|
192
|
+
- **Accept**: application/json
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
# **get_ab_test_campaign_result**
|
|
197
|
+
> AbTestCampaignResult get_ab_test_campaign_result(campaign_id)
|
|
198
|
+
|
|
199
|
+
Get an A/B test email campaign results
|
|
200
|
+
|
|
201
|
+
Obtain winning version of an A/B test email campaign
|
|
202
|
+
|
|
203
|
+
### Example
|
|
204
|
+
```ruby
|
|
205
|
+
# load the gem
|
|
206
|
+
require 'brevo'
|
|
207
|
+
# setup authorization
|
|
208
|
+
Brevo.configure do |config|
|
|
209
|
+
# Configure API key authorization: api-key
|
|
210
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
211
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
212
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
213
|
+
|
|
214
|
+
# Configure API key authorization: partner-key
|
|
215
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
216
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
217
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
218
|
+
end
|
|
219
|
+
|
|
220
|
+
api_instance = Brevo::EmailCampaignsApi.new
|
|
221
|
+
|
|
222
|
+
campaign_id = 789 # Integer | Id of the A/B test campaign
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
begin
|
|
226
|
+
#Get an A/B test email campaign results
|
|
227
|
+
result = api_instance.get_ab_test_campaign_result(campaign_id)
|
|
228
|
+
p result
|
|
229
|
+
rescue Brevo::ApiError => e
|
|
230
|
+
puts "Exception when calling EmailCampaignsApi->get_ab_test_campaign_result: #{e}"
|
|
231
|
+
end
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
### Parameters
|
|
235
|
+
|
|
236
|
+
Name | Type | Description | Notes
|
|
237
|
+
------------- | ------------- | ------------- | -------------
|
|
238
|
+
**campaign_id** | **Integer**| Id of the A/B test campaign |
|
|
239
|
+
|
|
240
|
+
### Return type
|
|
241
|
+
|
|
242
|
+
[**AbTestCampaignResult**](AbTestCampaignResult.md)
|
|
243
|
+
|
|
244
|
+
### Authorization
|
|
245
|
+
|
|
246
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
247
|
+
|
|
248
|
+
### HTTP request headers
|
|
249
|
+
|
|
250
|
+
- **Content-Type**: application/json
|
|
251
|
+
- **Accept**: application/json
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
# **get_email_campaign**
|
|
256
|
+
> GetEmailCampaign get_email_campaign(campaign_id, opts)
|
|
257
|
+
|
|
258
|
+
Get an email campaign report
|
|
259
|
+
|
|
260
|
+
### Example
|
|
261
|
+
```ruby
|
|
262
|
+
# load the gem
|
|
263
|
+
require 'brevo'
|
|
264
|
+
# setup authorization
|
|
265
|
+
Brevo.configure do |config|
|
|
266
|
+
# Configure API key authorization: api-key
|
|
267
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
268
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
269
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
270
|
+
|
|
271
|
+
# Configure API key authorization: partner-key
|
|
272
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
273
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
274
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
275
|
+
end
|
|
276
|
+
|
|
277
|
+
api_instance = Brevo::EmailCampaignsApi.new
|
|
278
|
+
|
|
279
|
+
campaign_id = 789 # Integer | Id of the campaign
|
|
280
|
+
|
|
281
|
+
opts = {
|
|
282
|
+
statistics: 'statistics_example', # String | Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.
|
|
283
|
+
utm_value: 'utm_value_example' # String | Get email campaign report on the basis of custom UTM Value.**You can use either campaignId or utmValue to fetch campaign report.To use utmValue filter pass campaignId as empty.**
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
begin
|
|
287
|
+
#Get an email campaign report
|
|
288
|
+
result = api_instance.get_email_campaign(campaign_id, opts)
|
|
289
|
+
p result
|
|
290
|
+
rescue Brevo::ApiError => e
|
|
291
|
+
puts "Exception when calling EmailCampaignsApi->get_email_campaign: #{e}"
|
|
292
|
+
end
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
### Parameters
|
|
296
|
+
|
|
297
|
+
Name | Type | Description | Notes
|
|
298
|
+
------------- | ------------- | ------------- | -------------
|
|
299
|
+
**campaign_id** | **Integer**| Id of the campaign |
|
|
300
|
+
**statistics** | **String**| Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. | [optional]
|
|
301
|
+
**utm_value** | **String**| Get email campaign report on the basis of custom UTM Value.**You can use either campaignId or utmValue to fetch campaign report.To use utmValue filter pass campaignId as empty.** | [optional]
|
|
302
|
+
|
|
303
|
+
### Return type
|
|
304
|
+
|
|
305
|
+
[**GetEmailCampaign**](GetEmailCampaign.md)
|
|
306
|
+
|
|
307
|
+
### Authorization
|
|
308
|
+
|
|
309
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
310
|
+
|
|
311
|
+
### HTTP request headers
|
|
312
|
+
|
|
313
|
+
- **Content-Type**: application/json
|
|
314
|
+
- **Accept**: application/json
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
# **get_email_campaigns**
|
|
319
|
+
> GetEmailCampaigns get_email_campaigns(opts)
|
|
320
|
+
|
|
321
|
+
Return all your created email campaigns
|
|
322
|
+
|
|
323
|
+
### Example
|
|
324
|
+
```ruby
|
|
325
|
+
# load the gem
|
|
326
|
+
require 'brevo'
|
|
327
|
+
# setup authorization
|
|
328
|
+
Brevo.configure do |config|
|
|
329
|
+
# Configure API key authorization: api-key
|
|
330
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
331
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
332
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
333
|
+
|
|
334
|
+
# Configure API key authorization: partner-key
|
|
335
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
336
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
337
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
338
|
+
end
|
|
339
|
+
|
|
340
|
+
api_instance = Brevo::EmailCampaignsApi.new
|
|
341
|
+
|
|
342
|
+
opts = {
|
|
343
|
+
type: 'type_example', # String | Filter on the type of the campaigns
|
|
344
|
+
status: 'status_example', # String | Filter on the status of the campaign
|
|
345
|
+
statistics: 'statistics_example', # String | Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.
|
|
346
|
+
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
|
347
|
+
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
|
348
|
+
limit: 50, # Integer | Number of documents per page
|
|
349
|
+
offset: 0, # Integer | Index of the first document in the page
|
|
350
|
+
sort: 'desc', # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
351
|
+
exclude_html_content: true # BOOLEAN | Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
begin
|
|
355
|
+
#Return all your created email campaigns
|
|
356
|
+
result = api_instance.get_email_campaigns(opts)
|
|
357
|
+
p result
|
|
358
|
+
rescue Brevo::ApiError => e
|
|
359
|
+
puts "Exception when calling EmailCampaignsApi->get_email_campaigns: #{e}"
|
|
360
|
+
end
|
|
361
|
+
```
|
|
362
|
+
|
|
363
|
+
### Parameters
|
|
364
|
+
|
|
365
|
+
Name | Type | Description | Notes
|
|
366
|
+
------------- | ------------- | ------------- | -------------
|
|
367
|
+
**type** | **String**| Filter on the type of the campaigns | [optional]
|
|
368
|
+
**status** | **String**| Filter on the status of the campaign | [optional]
|
|
369
|
+
**statistics** | **String**| Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. | [optional]
|
|
370
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
|
371
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
|
372
|
+
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
|
373
|
+
**offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
|
|
374
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
|
375
|
+
**exclude_html_content** | **BOOLEAN**| Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body | [optional]
|
|
376
|
+
|
|
377
|
+
### Return type
|
|
378
|
+
|
|
379
|
+
[**GetEmailCampaigns**](GetEmailCampaigns.md)
|
|
380
|
+
|
|
381
|
+
### Authorization
|
|
382
|
+
|
|
383
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
384
|
+
|
|
385
|
+
### HTTP request headers
|
|
386
|
+
|
|
387
|
+
- **Content-Type**: application/json
|
|
388
|
+
- **Accept**: application/json
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
# **get_shared_template_url**
|
|
393
|
+
> GetSharedTemplateUrl get_shared_template_url(campaign_id)
|
|
394
|
+
|
|
395
|
+
Get a shared template url
|
|
396
|
+
|
|
397
|
+
Get a unique URL to share & import an email template from one Brevo account to another.
|
|
398
|
+
|
|
399
|
+
### Example
|
|
400
|
+
```ruby
|
|
401
|
+
# load the gem
|
|
402
|
+
require 'brevo'
|
|
403
|
+
# setup authorization
|
|
404
|
+
Brevo.configure do |config|
|
|
405
|
+
# Configure API key authorization: api-key
|
|
406
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
407
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
408
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
409
|
+
|
|
410
|
+
# Configure API key authorization: partner-key
|
|
411
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
412
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
413
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
414
|
+
end
|
|
415
|
+
|
|
416
|
+
api_instance = Brevo::EmailCampaignsApi.new
|
|
417
|
+
|
|
418
|
+
campaign_id = 789 # Integer | Id of the campaign or template
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
begin
|
|
422
|
+
#Get a shared template url
|
|
423
|
+
result = api_instance.get_shared_template_url(campaign_id)
|
|
424
|
+
p result
|
|
425
|
+
rescue Brevo::ApiError => e
|
|
426
|
+
puts "Exception when calling EmailCampaignsApi->get_shared_template_url: #{e}"
|
|
427
|
+
end
|
|
428
|
+
```
|
|
429
|
+
|
|
430
|
+
### Parameters
|
|
431
|
+
|
|
432
|
+
Name | Type | Description | Notes
|
|
433
|
+
------------- | ------------- | ------------- | -------------
|
|
434
|
+
**campaign_id** | **Integer**| Id of the campaign or template |
|
|
435
|
+
|
|
436
|
+
### Return type
|
|
437
|
+
|
|
438
|
+
[**GetSharedTemplateUrl**](GetSharedTemplateUrl.md)
|
|
439
|
+
|
|
440
|
+
### Authorization
|
|
441
|
+
|
|
442
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
443
|
+
|
|
444
|
+
### HTTP request headers
|
|
445
|
+
|
|
446
|
+
- **Content-Type**: application/json
|
|
447
|
+
- **Accept**: application/json
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
# **send_email_campaign_now**
|
|
452
|
+
> send_email_campaign_now(campaign_id)
|
|
453
|
+
|
|
454
|
+
Send an email campaign immediately, based on campaignId
|
|
455
|
+
|
|
456
|
+
### Example
|
|
457
|
+
```ruby
|
|
458
|
+
# load the gem
|
|
459
|
+
require 'brevo'
|
|
460
|
+
# setup authorization
|
|
461
|
+
Brevo.configure do |config|
|
|
462
|
+
# Configure API key authorization: api-key
|
|
463
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
464
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
465
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
466
|
+
|
|
467
|
+
# Configure API key authorization: partner-key
|
|
468
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
469
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
470
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
471
|
+
end
|
|
472
|
+
|
|
473
|
+
api_instance = Brevo::EmailCampaignsApi.new
|
|
474
|
+
|
|
475
|
+
campaign_id = 789 # Integer | Id of the campaign
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
begin
|
|
479
|
+
#Send an email campaign immediately, based on campaignId
|
|
480
|
+
api_instance.send_email_campaign_now(campaign_id)
|
|
481
|
+
rescue Brevo::ApiError => e
|
|
482
|
+
puts "Exception when calling EmailCampaignsApi->send_email_campaign_now: #{e}"
|
|
483
|
+
end
|
|
484
|
+
```
|
|
485
|
+
|
|
486
|
+
### Parameters
|
|
487
|
+
|
|
488
|
+
Name | Type | Description | Notes
|
|
489
|
+
------------- | ------------- | ------------- | -------------
|
|
490
|
+
**campaign_id** | **Integer**| Id of the campaign |
|
|
491
|
+
|
|
492
|
+
### Return type
|
|
493
|
+
|
|
494
|
+
nil (empty response body)
|
|
495
|
+
|
|
496
|
+
### Authorization
|
|
497
|
+
|
|
498
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
499
|
+
|
|
500
|
+
### HTTP request headers
|
|
501
|
+
|
|
502
|
+
- **Content-Type**: application/json
|
|
503
|
+
- **Accept**: application/json
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
# **send_report**
|
|
508
|
+
> send_report(campaign_id, send_report)
|
|
509
|
+
|
|
510
|
+
Send the report of a campaign
|
|
511
|
+
|
|
512
|
+
A PDF will be sent to the specified email addresses
|
|
513
|
+
|
|
514
|
+
### Example
|
|
515
|
+
```ruby
|
|
516
|
+
# load the gem
|
|
517
|
+
require 'brevo'
|
|
518
|
+
# setup authorization
|
|
519
|
+
Brevo.configure do |config|
|
|
520
|
+
# Configure API key authorization: api-key
|
|
521
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
522
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
523
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
524
|
+
|
|
525
|
+
# Configure API key authorization: partner-key
|
|
526
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
527
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
528
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
529
|
+
end
|
|
530
|
+
|
|
531
|
+
api_instance = Brevo::EmailCampaignsApi.new
|
|
532
|
+
|
|
533
|
+
campaign_id = 789 # Integer | Id of the campaign
|
|
534
|
+
|
|
535
|
+
send_report = Brevo::SendReport.new # SendReport | Values for send a report
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
begin
|
|
539
|
+
#Send the report of a campaign
|
|
540
|
+
api_instance.send_report(campaign_id, send_report)
|
|
541
|
+
rescue Brevo::ApiError => e
|
|
542
|
+
puts "Exception when calling EmailCampaignsApi->send_report: #{e}"
|
|
543
|
+
end
|
|
544
|
+
```
|
|
545
|
+
|
|
546
|
+
### Parameters
|
|
547
|
+
|
|
548
|
+
Name | Type | Description | Notes
|
|
549
|
+
------------- | ------------- | ------------- | -------------
|
|
550
|
+
**campaign_id** | **Integer**| Id of the campaign |
|
|
551
|
+
**send_report** | [**SendReport**](SendReport.md)| Values for send a report |
|
|
552
|
+
|
|
553
|
+
### Return type
|
|
554
|
+
|
|
555
|
+
nil (empty response body)
|
|
556
|
+
|
|
557
|
+
### Authorization
|
|
558
|
+
|
|
559
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
560
|
+
|
|
561
|
+
### HTTP request headers
|
|
562
|
+
|
|
563
|
+
- **Content-Type**: application/json
|
|
564
|
+
- **Accept**: application/json
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
# **send_test_email**
|
|
569
|
+
> send_test_email(campaign_id, email_to)
|
|
570
|
+
|
|
571
|
+
Send an email campaign to your test list
|
|
572
|
+
|
|
573
|
+
### Example
|
|
574
|
+
```ruby
|
|
575
|
+
# load the gem
|
|
576
|
+
require 'brevo'
|
|
577
|
+
# setup authorization
|
|
578
|
+
Brevo.configure do |config|
|
|
579
|
+
# Configure API key authorization: api-key
|
|
580
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
581
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
582
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
583
|
+
|
|
584
|
+
# Configure API key authorization: partner-key
|
|
585
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
586
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
587
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
588
|
+
end
|
|
589
|
+
|
|
590
|
+
api_instance = Brevo::EmailCampaignsApi.new
|
|
591
|
+
|
|
592
|
+
campaign_id = 789 # Integer | Id of the campaign
|
|
593
|
+
|
|
594
|
+
email_to = Brevo::SendTestEmail.new # SendTestEmail |
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
begin
|
|
598
|
+
#Send an email campaign to your test list
|
|
599
|
+
api_instance.send_test_email(campaign_id, email_to)
|
|
600
|
+
rescue Brevo::ApiError => e
|
|
601
|
+
puts "Exception when calling EmailCampaignsApi->send_test_email: #{e}"
|
|
602
|
+
end
|
|
603
|
+
```
|
|
604
|
+
|
|
605
|
+
### Parameters
|
|
606
|
+
|
|
607
|
+
Name | Type | Description | Notes
|
|
608
|
+
------------- | ------------- | ------------- | -------------
|
|
609
|
+
**campaign_id** | **Integer**| Id of the campaign |
|
|
610
|
+
**email_to** | [**SendTestEmail**](SendTestEmail.md)| |
|
|
611
|
+
|
|
612
|
+
### Return type
|
|
613
|
+
|
|
614
|
+
nil (empty response body)
|
|
615
|
+
|
|
616
|
+
### Authorization
|
|
617
|
+
|
|
618
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
619
|
+
|
|
620
|
+
### HTTP request headers
|
|
621
|
+
|
|
622
|
+
- **Content-Type**: application/json
|
|
623
|
+
- **Accept**: application/json
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
# **update_campaign_status**
|
|
628
|
+
> update_campaign_status(campaign_id, status)
|
|
629
|
+
|
|
630
|
+
Update an email campaign status
|
|
631
|
+
|
|
632
|
+
### Example
|
|
633
|
+
```ruby
|
|
634
|
+
# load the gem
|
|
635
|
+
require 'brevo'
|
|
636
|
+
# setup authorization
|
|
637
|
+
Brevo.configure do |config|
|
|
638
|
+
# Configure API key authorization: api-key
|
|
639
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
640
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
641
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
642
|
+
|
|
643
|
+
# Configure API key authorization: partner-key
|
|
644
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
645
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
646
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
647
|
+
end
|
|
648
|
+
|
|
649
|
+
api_instance = Brevo::EmailCampaignsApi.new
|
|
650
|
+
|
|
651
|
+
campaign_id = 789 # Integer | Id of the campaign
|
|
652
|
+
|
|
653
|
+
status = Brevo::UpdateCampaignStatus.new # UpdateCampaignStatus | Status of the campaign
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
begin
|
|
657
|
+
#Update an email campaign status
|
|
658
|
+
api_instance.update_campaign_status(campaign_id, status)
|
|
659
|
+
rescue Brevo::ApiError => e
|
|
660
|
+
puts "Exception when calling EmailCampaignsApi->update_campaign_status: #{e}"
|
|
661
|
+
end
|
|
662
|
+
```
|
|
663
|
+
|
|
664
|
+
### Parameters
|
|
665
|
+
|
|
666
|
+
Name | Type | Description | Notes
|
|
667
|
+
------------- | ------------- | ------------- | -------------
|
|
668
|
+
**campaign_id** | **Integer**| Id of the campaign |
|
|
669
|
+
**status** | [**UpdateCampaignStatus**](UpdateCampaignStatus.md)| Status of the campaign |
|
|
670
|
+
|
|
671
|
+
### Return type
|
|
672
|
+
|
|
673
|
+
nil (empty response body)
|
|
674
|
+
|
|
675
|
+
### Authorization
|
|
676
|
+
|
|
677
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
678
|
+
|
|
679
|
+
### HTTP request headers
|
|
680
|
+
|
|
681
|
+
- **Content-Type**: application/json
|
|
682
|
+
- **Accept**: application/json
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
# **update_email_campaign**
|
|
687
|
+
> update_email_campaign(campaign_id, email_campaign)
|
|
688
|
+
|
|
689
|
+
Update an email campaign
|
|
690
|
+
|
|
691
|
+
### Example
|
|
692
|
+
```ruby
|
|
693
|
+
# load the gem
|
|
694
|
+
require 'brevo'
|
|
695
|
+
# setup authorization
|
|
696
|
+
Brevo.configure do |config|
|
|
697
|
+
# Configure API key authorization: api-key
|
|
698
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
699
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
700
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
701
|
+
|
|
702
|
+
# Configure API key authorization: partner-key
|
|
703
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
704
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
705
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
706
|
+
end
|
|
707
|
+
|
|
708
|
+
api_instance = Brevo::EmailCampaignsApi.new
|
|
709
|
+
|
|
710
|
+
campaign_id = 789 # Integer | Id of the campaign
|
|
711
|
+
|
|
712
|
+
email_campaign = Brevo::UpdateEmailCampaign.new # UpdateEmailCampaign | Values to update a campaign
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
begin
|
|
716
|
+
#Update an email campaign
|
|
717
|
+
api_instance.update_email_campaign(campaign_id, email_campaign)
|
|
718
|
+
rescue Brevo::ApiError => e
|
|
719
|
+
puts "Exception when calling EmailCampaignsApi->update_email_campaign: #{e}"
|
|
720
|
+
end
|
|
721
|
+
```
|
|
722
|
+
|
|
723
|
+
### Parameters
|
|
724
|
+
|
|
725
|
+
Name | Type | Description | Notes
|
|
726
|
+
------------- | ------------- | ------------- | -------------
|
|
727
|
+
**campaign_id** | **Integer**| Id of the campaign |
|
|
728
|
+
**email_campaign** | [**UpdateEmailCampaign**](UpdateEmailCampaign.md)| Values to update a campaign |
|
|
729
|
+
|
|
730
|
+
### Return type
|
|
731
|
+
|
|
732
|
+
nil (empty response body)
|
|
733
|
+
|
|
734
|
+
### Authorization
|
|
735
|
+
|
|
736
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
737
|
+
|
|
738
|
+
### HTTP request headers
|
|
739
|
+
|
|
740
|
+
- **Content-Type**: application/json
|
|
741
|
+
- **Accept**: application/json
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
# **upload_image_to_gallery**
|
|
746
|
+
> UploadImageModel upload_image_to_gallery(upload_image)
|
|
747
|
+
|
|
748
|
+
Upload an image to your account's image gallery
|
|
749
|
+
|
|
750
|
+
### Example
|
|
751
|
+
```ruby
|
|
752
|
+
# load the gem
|
|
753
|
+
require 'brevo'
|
|
754
|
+
# setup authorization
|
|
755
|
+
Brevo.configure do |config|
|
|
756
|
+
# Configure API key authorization: api-key
|
|
757
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
758
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
759
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
760
|
+
|
|
761
|
+
# Configure API key authorization: partner-key
|
|
762
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
763
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
764
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
765
|
+
end
|
|
766
|
+
|
|
767
|
+
api_instance = Brevo::EmailCampaignsApi.new
|
|
768
|
+
|
|
769
|
+
upload_image = Brevo::UploadImageToGallery.new # UploadImageToGallery | Parameters to upload an image
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
begin
|
|
773
|
+
#Upload an image to your account's image gallery
|
|
774
|
+
result = api_instance.upload_image_to_gallery(upload_image)
|
|
775
|
+
p result
|
|
776
|
+
rescue Brevo::ApiError => e
|
|
777
|
+
puts "Exception when calling EmailCampaignsApi->upload_image_to_gallery: #{e}"
|
|
778
|
+
end
|
|
779
|
+
```
|
|
780
|
+
|
|
781
|
+
### Parameters
|
|
782
|
+
|
|
783
|
+
Name | Type | Description | Notes
|
|
784
|
+
------------- | ------------- | ------------- | -------------
|
|
785
|
+
**upload_image** | [**UploadImageToGallery**](UploadImageToGallery.md)| Parameters to upload an image |
|
|
786
|
+
|
|
787
|
+
### Return type
|
|
788
|
+
|
|
789
|
+
[**UploadImageModel**](UploadImageModel.md)
|
|
790
|
+
|
|
791
|
+
### Authorization
|
|
792
|
+
|
|
793
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
794
|
+
|
|
795
|
+
### HTTP request headers
|
|
796
|
+
|
|
797
|
+
- **Content-Type**: application/json
|
|
798
|
+
- **Accept**: application/json
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
|