brevo-ruby 1.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 +651 -0
- data/Rakefile +8 -0
- data/brevo-ruby.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 +37 -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 +536 -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 +799 -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 +20 -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 +38 -0
- data/docs/GetEmailCampaigns.md +9 -0
- data/docs/GetEmailEventReport.md +8 -0
- data/docs/GetEmailEventReportEvents.md +18 -0
- data/docs/GetExtendedCampaignOverview.md +36 -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 +549 -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/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 +10 -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 +37 -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-ruby/api/account_api.rb +145 -0
- data/lib/brevo-ruby/api/companies_api.rb +419 -0
- data/lib/brevo-ruby/api/contacts_api.rb +1735 -0
- data/lib/brevo-ruby/api/conversations_api.rb +514 -0
- data/lib/brevo-ruby/api/coupons_api.rb +316 -0
- data/lib/brevo-ruby/api/deals_api.rb +518 -0
- data/lib/brevo-ruby/api/domains_api.rb +282 -0
- data/lib/brevo-ruby/api/ecommerce_api.rb +655 -0
- data/lib/brevo-ruby/api/email_campaigns_api.rb +782 -0
- data/lib/brevo-ruby/api/external_feeds_api.rb +336 -0
- data/lib/brevo-ruby/api/files_api.rb +323 -0
- data/lib/brevo-ruby/api/inbound_parsing_api.rb +218 -0
- data/lib/brevo-ruby/api/master_account_api.rb +535 -0
- data/lib/brevo-ruby/api/notes_api.rb +318 -0
- data/lib/brevo-ruby/api/process_api.rb +151 -0
- data/lib/brevo-ruby/api/reseller_api.rb +923 -0
- data/lib/brevo-ruby/api/senders_api.rb +388 -0
- data/lib/brevo-ruby/api/sms_campaigns_api.rb +603 -0
- data/lib/brevo-ruby/api/tasks_api.rb +385 -0
- data/lib/brevo-ruby/api/transactional_emails_api.rb +1370 -0
- data/lib/brevo-ruby/api/transactional_sms_api.rb +290 -0
- data/lib/brevo-ruby/api/transactional_whats_app_api.rb +173 -0
- data/lib/brevo-ruby/api/user_api.rb +131 -0
- data/lib/brevo-ruby/api/webhooks_api.rb +357 -0
- data/lib/brevo-ruby/api/whats_app_campaigns_api.rb +534 -0
- data/lib/brevo-ruby/api_client.rb +392 -0
- data/lib/brevo-ruby/api_error.rb +38 -0
- data/lib/brevo-ruby/configuration.rb +216 -0
- data/lib/brevo-ruby/models/ab_test_campaign_result.rb +299 -0
- data/lib/brevo-ruby/models/ab_test_campaign_result_clicked_links.rb +203 -0
- data/lib/brevo-ruby/models/ab_test_campaign_result_statistics.rb +259 -0
- data/lib/brevo-ruby/models/ab_test_version_clicks.rb +176 -0
- data/lib/brevo-ruby/models/ab_test_version_clicks_inner.rb +220 -0
- data/lib/brevo-ruby/models/ab_test_version_stats.rb +206 -0
- data/lib/brevo-ruby/models/add_child_domain.rb +185 -0
- data/lib/brevo-ruby/models/add_contact_to_list.rb +199 -0
- data/lib/brevo-ruby/models/add_credits.rb +195 -0
- data/lib/brevo-ruby/models/authenticate_domain_model.rb +205 -0
- data/lib/brevo-ruby/models/block_domain.rb +190 -0
- data/lib/brevo-ruby/models/body.rb +210 -0
- data/lib/brevo-ruby/models/body_1.rb +205 -0
- data/lib/brevo-ruby/models/body_10.rb +225 -0
- data/lib/brevo-ruby/models/body_11.rb +190 -0
- data/lib/brevo-ruby/models/body_12.rb +215 -0
- data/lib/brevo-ruby/models/body_2.rb +223 -0
- data/lib/brevo-ruby/models/body_3.rb +200 -0
- data/lib/brevo-ruby/models/body_4.rb +195 -0
- data/lib/brevo-ruby/models/body_5.rb +223 -0
- data/lib/brevo-ruby/models/body_6.rb +320 -0
- data/lib/brevo-ruby/models/body_7.rb +281 -0
- data/lib/brevo-ruby/models/body_8.rb +245 -0
- data/lib/brevo-ruby/models/body_9.rb +190 -0
- data/lib/brevo-ruby/models/body_variables_items.rb +175 -0
- data/lib/brevo-ruby/models/companies_list.rb +188 -0
- data/lib/brevo-ruby/models/company.rb +220 -0
- data/lib/brevo-ruby/models/company_attributes.rb +176 -0
- data/lib/brevo-ruby/models/company_attributes_inner.rb +223 -0
- data/lib/brevo-ruby/models/component_items.rb +193 -0
- data/lib/brevo-ruby/models/conversations_message.rb +324 -0
- data/lib/brevo-ruby/models/conversations_message_file.rb +239 -0
- data/lib/brevo-ruby/models/conversations_message_file_image_info.rb +236 -0
- data/lib/brevo-ruby/models/create_api_key_request.rb +200 -0
- data/lib/brevo-ruby/models/create_api_key_response.rb +195 -0
- data/lib/brevo-ruby/models/create_attribute.rb +251 -0
- data/lib/brevo-ruby/models/create_attribute_enumeration.rb +205 -0
- data/lib/brevo-ruby/models/create_category_model.rb +185 -0
- data/lib/brevo-ruby/models/create_child.rb +294 -0
- data/lib/brevo-ruby/models/create_contact.rb +261 -0
- data/lib/brevo-ruby/models/create_coupon_collection.rb +205 -0
- data/lib/brevo-ruby/models/create_coupons.rb +206 -0
- data/lib/brevo-ruby/models/create_doi_contact.rb +259 -0
- data/lib/brevo-ruby/models/create_domain.rb +190 -0
- data/lib/brevo-ruby/models/create_domain_model.rb +219 -0
- data/lib/brevo-ruby/models/create_domain_model_dns_records.rb +193 -0
- data/lib/brevo-ruby/models/create_domain_model_dns_records_dkim_record.rb +211 -0
- data/lib/brevo-ruby/models/create_email_campaign.rb +597 -0
- data/lib/brevo-ruby/models/create_email_campaign_recipients.rb +212 -0
- data/lib/brevo-ruby/models/create_email_campaign_sender.rb +211 -0
- data/lib/brevo-ruby/models/create_external_feed.rb +339 -0
- data/lib/brevo-ruby/models/create_list.rb +205 -0
- data/lib/brevo-ruby/models/create_model.rb +190 -0
- data/lib/brevo-ruby/models/create_product_model.rb +185 -0
- data/lib/brevo-ruby/models/create_reseller.rb +200 -0
- data/lib/brevo-ruby/models/create_sender.rb +217 -0
- data/lib/brevo-ruby/models/create_sender_ips.rb +239 -0
- data/lib/brevo-ruby/models/create_sender_model.rb +210 -0
- data/lib/brevo-ruby/models/create_sms_campaign.rb +290 -0
- data/lib/brevo-ruby/models/create_sms_campaign_recipients.rb +204 -0
- data/lib/brevo-ruby/models/create_smtp_email.rb +196 -0
- data/lib/brevo-ruby/models/create_smtp_template.rb +289 -0
- data/lib/brevo-ruby/models/create_smtp_template_sender.rb +206 -0
- data/lib/brevo-ruby/models/create_sub_account.rb +259 -0
- data/lib/brevo-ruby/models/create_sub_account_response.rb +190 -0
- data/lib/brevo-ruby/models/create_update_batch_category.rb +202 -0
- data/lib/brevo-ruby/models/create_update_batch_category_model.rb +195 -0
- data/lib/brevo-ruby/models/create_update_batch_products.rb +202 -0
- data/lib/brevo-ruby/models/create_update_batch_products_model.rb +195 -0
- data/lib/brevo-ruby/models/create_update_categories.rb +220 -0
- data/lib/brevo-ruby/models/create_update_category.rb +232 -0
- data/lib/brevo-ruby/models/create_update_contact_model.rb +185 -0
- data/lib/brevo-ruby/models/create_update_folder.rb +185 -0
- data/lib/brevo-ruby/models/create_update_product.rb +301 -0
- data/lib/brevo-ruby/models/create_update_products.rb +289 -0
- data/lib/brevo-ruby/models/create_webhook.rb +273 -0
- data/lib/brevo-ruby/models/create_whats_app_campaign.rb +234 -0
- data/lib/brevo-ruby/models/create_whats_app_campaign_recipients.rb +212 -0
- data/lib/brevo-ruby/models/create_whats_app_template.rb +289 -0
- data/lib/brevo-ruby/models/created_batch_id.rb +190 -0
- data/lib/brevo-ruby/models/created_process_id.rb +190 -0
- data/lib/brevo-ruby/models/deal.rb +220 -0
- data/lib/brevo-ruby/models/deal_attributes.rb +176 -0
- data/lib/brevo-ruby/models/deal_attributes_inner.rb +223 -0
- data/lib/brevo-ruby/models/deals_list.rb +188 -0
- data/lib/brevo-ruby/models/delete_hardbounces.rb +205 -0
- data/lib/brevo-ruby/models/email_export_recipients.rb +234 -0
- data/lib/brevo-ruby/models/error_model.rb +239 -0
- data/lib/brevo-ruby/models/export_webhooks_history.rb +309 -0
- data/lib/brevo-ruby/models/file_data.rb +246 -0
- data/lib/brevo-ruby/models/file_downloadable_link.rb +190 -0
- data/lib/brevo-ruby/models/file_list.rb +176 -0
- data/lib/brevo-ruby/models/get_account.rb +289 -0
- data/lib/brevo-ruby/models/get_account_activity.rb +187 -0
- data/lib/brevo-ruby/models/get_account_activity_logs.rb +250 -0
- data/lib/brevo-ruby/models/get_account_marketing_automation.rb +200 -0
- data/lib/brevo-ruby/models/get_account_plan.rb +296 -0
- data/lib/brevo-ruby/models/get_account_relay.rb +205 -0
- data/lib/brevo-ruby/models/get_account_relay_data.rb +221 -0
- data/lib/brevo-ruby/models/get_aggregated_report.rb +305 -0
- data/lib/brevo-ruby/models/get_all_external_feeds.rb +196 -0
- data/lib/brevo-ruby/models/get_all_external_feeds_feeds.rb +404 -0
- data/lib/brevo-ruby/models/get_attributes.rb +192 -0
- data/lib/brevo-ruby/models/get_attributes_attributes.rb +283 -0
- data/lib/brevo-ruby/models/get_attributes_enumeration.rb +205 -0
- data/lib/brevo-ruby/models/get_blocked_domains.rb +193 -0
- data/lib/brevo-ruby/models/get_campaign_overview.rb +371 -0
- data/lib/brevo-ruby/models/get_campaign_recipients.rb +207 -0
- data/lib/brevo-ruby/models/get_campaign_stats.rb +390 -0
- data/lib/brevo-ruby/models/get_categories.rb +206 -0
- data/lib/brevo-ruby/models/get_category_details.rb +255 -0
- data/lib/brevo-ruby/models/get_child_account_creation_status.rb +190 -0
- data/lib/brevo-ruby/models/get_child_domain.rb +195 -0
- data/lib/brevo-ruby/models/get_child_domains.rb +175 -0
- data/lib/brevo-ruby/models/get_child_info.rb +289 -0
- data/lib/brevo-ruby/models/get_child_info_api_keys.rb +203 -0
- data/lib/brevo-ruby/models/get_child_info_api_keys_v2.rb +205 -0
- data/lib/brevo-ruby/models/get_child_info_api_keys_v3.rb +205 -0
- data/lib/brevo-ruby/models/get_child_info_credits.rb +196 -0
- data/lib/brevo-ruby/models/get_child_info_statistics.rb +206 -0
- data/lib/brevo-ruby/models/get_children_list.rb +197 -0
- data/lib/brevo-ruby/models/get_client.rb +235 -0
- data/lib/brevo-ruby/models/get_contact_campaign_stats.rb +273 -0
- data/lib/brevo-ruby/models/get_contact_campaign_stats_clicked.rb +206 -0
- data/lib/brevo-ruby/models/get_contact_campaign_stats_opened.rb +235 -0
- data/lib/brevo-ruby/models/get_contact_campaign_stats_transac_attributes.rb +220 -0
- data/lib/brevo-ruby/models/get_contact_campaign_stats_unsubscriptions.rb +209 -0
- data/lib/brevo-ruby/models/get_contact_details.rb +307 -0
- data/lib/brevo-ruby/models/get_contacts.rb +206 -0
- data/lib/brevo-ruby/models/get_coupon_collection.rb +265 -0
- data/lib/brevo-ruby/models/get_device_browser_stats.rb +235 -0
- data/lib/brevo-ruby/models/get_domain_configuration_model.rb +234 -0
- data/lib/brevo-ruby/models/get_domains_list.rb +187 -0
- data/lib/brevo-ruby/models/get_domains_list_domains.rb +245 -0
- data/lib/brevo-ruby/models/get_email_campaign.rb +598 -0
- data/lib/brevo-ruby/models/get_email_campaigns.rb +196 -0
- data/lib/brevo-ruby/models/get_email_event_report.rb +186 -0
- data/lib/brevo-ruby/models/get_email_event_report_events.rb +339 -0
- data/lib/brevo-ruby/models/get_extended_campaign_overview.rb +570 -0
- data/lib/brevo-ruby/models/get_extended_campaign_overview_sender.rb +205 -0
- data/lib/brevo-ruby/models/get_extended_campaign_stats.rb +295 -0
- data/lib/brevo-ruby/models/get_extended_campaign_stats_global_stats.rb +176 -0
- data/lib/brevo-ruby/models/get_extended_client.rb +249 -0
- data/lib/brevo-ruby/models/get_extended_client_address.rb +236 -0
- data/lib/brevo-ruby/models/get_extended_contact_details.rb +321 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics.rb +281 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_clicked.rb +207 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_delivered.rb +205 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_links.rb +235 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_messages_sent.rb +205 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_opened.rb +235 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_unsubscriptions.rb +210 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +200 -0
- data/lib/brevo-ruby/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +215 -0
- data/lib/brevo-ruby/models/get_extended_list.rb +301 -0
- data/lib/brevo-ruby/models/get_extended_list_campaign_stats.rb +204 -0
- data/lib/brevo-ruby/models/get_external_feed_by_uuid.rb +404 -0
- data/lib/brevo-ruby/models/get_external_feed_by_uuid_headers.rb +195 -0
- data/lib/brevo-ruby/models/get_folder.rb +250 -0
- data/lib/brevo-ruby/models/get_folder_lists.rb +196 -0
- data/lib/brevo-ruby/models/get_folders.rb +196 -0
- data/lib/brevo-ruby/models/get_inbound_email_events.rb +186 -0
- data/lib/brevo-ruby/models/get_inbound_email_events_by_uuid.rb +259 -0
- data/lib/brevo-ruby/models/get_inbound_email_events_by_uuid_attachments.rb +215 -0
- data/lib/brevo-ruby/models/get_inbound_email_events_by_uuid_logs.rb +229 -0
- data/lib/brevo-ruby/models/get_inbound_email_events_events.rb +235 -0
- data/lib/brevo-ruby/models/get_invited_users_list.rb +187 -0
- data/lib/brevo-ruby/models/get_invited_users_list_feature_access.rb +206 -0
- data/lib/brevo-ruby/models/get_invited_users_list_users.rb +234 -0
- data/lib/brevo-ruby/models/get_ip.rb +235 -0
- data/lib/brevo-ruby/models/get_ip_from_sender.rb +235 -0
- data/lib/brevo-ruby/models/get_ips.rb +192 -0
- data/lib/brevo-ruby/models/get_ips_from_sender.rb +192 -0
- data/lib/brevo-ruby/models/get_list.rb +250 -0
- data/lib/brevo-ruby/models/get_lists.rb +197 -0
- data/lib/brevo-ruby/models/get_process.rb +264 -0
- data/lib/brevo-ruby/models/get_processes.rb +197 -0
- data/lib/brevo-ruby/models/get_product_details.rb +357 -0
- data/lib/brevo-ruby/models/get_products.rb +206 -0
- data/lib/brevo-ruby/models/get_reports.rb +186 -0
- data/lib/brevo-ruby/models/get_reports_reports.rb +370 -0
- data/lib/brevo-ruby/models/get_scheduled_email_by_batch_id.rb +196 -0
- data/lib/brevo-ruby/models/get_scheduled_email_by_batch_id_batches.rb +254 -0
- data/lib/brevo-ruby/models/get_scheduled_email_by_message_id.rb +254 -0
- data/lib/brevo-ruby/models/get_segments.rb +194 -0
- data/lib/brevo-ruby/models/get_segments_segments.rb +215 -0
- data/lib/brevo-ruby/models/get_senders_list.rb +187 -0
- data/lib/brevo-ruby/models/get_senders_list_ips.rb +220 -0
- data/lib/brevo-ruby/models/get_senders_list_senders.rb +247 -0
- data/lib/brevo-ruby/models/get_shared_template_url.rb +190 -0
- data/lib/brevo-ruby/models/get_sms_campaign.rb +352 -0
- data/lib/brevo-ruby/models/get_sms_campaign_overview.rb +324 -0
- data/lib/brevo-ruby/models/get_sms_campaign_recipients.rb +175 -0
- data/lib/brevo-ruby/models/get_sms_campaign_stats.rb +280 -0
- data/lib/brevo-ruby/models/get_sms_campaigns.rb +196 -0
- data/lib/brevo-ruby/models/get_sms_event_report.rb +186 -0
- data/lib/brevo-ruby/models/get_sms_event_report_events.rb +278 -0
- data/lib/brevo-ruby/models/get_smtp_template_overview.rb +364 -0
- data/lib/brevo-ruby/models/get_smtp_template_overview_sender.rb +205 -0
- data/lib/brevo-ruby/models/get_smtp_templates.rb +196 -0
- data/lib/brevo-ruby/models/get_sso_token.rb +190 -0
- data/lib/brevo-ruby/models/get_stats_by_browser.rb +175 -0
- data/lib/brevo-ruby/models/get_stats_by_device.rb +223 -0
- data/lib/brevo-ruby/models/get_stats_by_domain.rb +175 -0
- data/lib/brevo-ruby/models/get_transac_aggregated_sms_report.rb +275 -0
- data/lib/brevo-ruby/models/get_transac_blocked_contacts.rb +196 -0
- data/lib/brevo-ruby/models/get_transac_blocked_contacts_contacts.rb +234 -0
- data/lib/brevo-ruby/models/get_transac_blocked_contacts_reason.rb +230 -0
- data/lib/brevo-ruby/models/get_transac_email_content.rb +277 -0
- data/lib/brevo-ruby/models/get_transac_email_content_events.rb +205 -0
- data/lib/brevo-ruby/models/get_transac_emails_list.rb +196 -0
- data/lib/brevo-ruby/models/get_transac_emails_list_transactional_emails.rb +282 -0
- data/lib/brevo-ruby/models/get_transac_sms_report.rb +186 -0
- data/lib/brevo-ruby/models/get_transac_sms_report_reports.rb +275 -0
- data/lib/brevo-ruby/models/get_user_permission.rb +223 -0
- data/lib/brevo-ruby/models/get_user_permission_privileges.rb +205 -0
- data/lib/brevo-ruby/models/get_wa_templates.rb +206 -0
- data/lib/brevo-ruby/models/get_wa_templates_templates.rb +290 -0
- data/lib/brevo-ruby/models/get_webhook.rb +315 -0
- data/lib/brevo-ruby/models/get_webhooks.rb +191 -0
- data/lib/brevo-ruby/models/get_whats_app_config.rb +281 -0
- data/lib/brevo-ruby/models/get_whatsapp_campaign_overview.rb +332 -0
- data/lib/brevo-ruby/models/get_whatsapp_campaigns.rb +196 -0
- data/lib/brevo-ruby/models/get_whatsapp_campaigns_campaigns.rb +353 -0
- data/lib/brevo-ruby/models/get_whatsapp_event_report.rb +186 -0
- data/lib/brevo-ruby/models/get_whatsapp_event_report_events.rb +314 -0
- data/lib/brevo-ruby/models/inline_response_200.rb +191 -0
- data/lib/brevo-ruby/models/inline_response_200_1.rb +220 -0
- data/lib/brevo-ruby/models/inline_response_201.rb +191 -0
- data/lib/brevo-ruby/models/inline_response_201_1.rb +191 -0
- data/lib/brevo-ruby/models/inline_response_201_2.rb +190 -0
- data/lib/brevo-ruby/models/inline_response_201_3.rb +190 -0
- data/lib/brevo-ruby/models/inline_response_201_4.rb +190 -0
- data/lib/brevo-ruby/models/manage_ip.rb +185 -0
- data/lib/brevo-ruby/models/master_details_response.rb +243 -0
- data/lib/brevo-ruby/models/master_details_response_billing_info.rb +214 -0
- data/lib/brevo-ruby/models/master_details_response_billing_info_address.rb +226 -0
- data/lib/brevo-ruby/models/master_details_response_billing_info_name.rb +196 -0
- data/lib/brevo-ruby/models/master_details_response_plan_info.rb +272 -0
- data/lib/brevo-ruby/models/master_details_response_plan_info_features.rb +225 -0
- data/lib/brevo-ruby/models/note.rb +283 -0
- data/lib/brevo-ruby/models/note_data.rb +255 -0
- data/lib/brevo-ruby/models/note_id.rb +186 -0
- data/lib/brevo-ruby/models/note_list.rb +176 -0
- data/lib/brevo-ruby/models/order.rb +297 -0
- data/lib/brevo-ruby/models/order_batch.rb +202 -0
- data/lib/brevo-ruby/models/order_billing.rb +246 -0
- data/lib/brevo-ruby/models/order_products.rb +231 -0
- data/lib/brevo-ruby/models/otp.rb +185 -0
- data/lib/brevo-ruby/models/pipeline.rb +208 -0
- data/lib/brevo-ruby/models/pipeline_stage.rb +196 -0
- data/lib/brevo-ruby/models/pipelines.rb +176 -0
- data/lib/brevo-ruby/models/post_contact_info.rb +189 -0
- data/lib/brevo-ruby/models/post_contact_info_contacts.rb +217 -0
- data/lib/brevo-ruby/models/post_send_failed.rb +238 -0
- data/lib/brevo-ruby/models/post_send_sms_test_failed.rb +227 -0
- data/lib/brevo-ruby/models/remaining_credit_model.rb +203 -0
- data/lib/brevo-ruby/models/remaining_credit_model_child.rb +206 -0
- data/lib/brevo-ruby/models/remaining_credit_model_reseller.rb +205 -0
- data/lib/brevo-ruby/models/remove_contact_from_list.rb +209 -0
- data/lib/brevo-ruby/models/remove_credits.rb +195 -0
- data/lib/brevo-ruby/models/request_contact_export.rb +211 -0
- data/lib/brevo-ruby/models/request_contact_export_custom_contact_filter.rb +294 -0
- data/lib/brevo-ruby/models/request_contact_import.rb +286 -0
- data/lib/brevo-ruby/models/request_contact_import_new_list.rb +196 -0
- data/lib/brevo-ruby/models/request_sms_recipient_export.rb +234 -0
- data/lib/brevo-ruby/models/schedule_smtp_email.rb +206 -0
- data/lib/brevo-ruby/models/send_report.rb +235 -0
- data/lib/brevo-ruby/models/send_report_email.rb +208 -0
- data/lib/brevo-ruby/models/send_sms.rb +233 -0
- data/lib/brevo-ruby/models/send_smtp_email.rb +345 -0
- data/lib/brevo-ruby/models/send_smtp_email_attachment.rb +220 -0
- data/lib/brevo-ruby/models/send_smtp_email_bcc.rb +200 -0
- data/lib/brevo-ruby/models/send_smtp_email_cc.rb +200 -0
- data/lib/brevo-ruby/models/send_smtp_email_message_versions.rb +247 -0
- data/lib/brevo-ruby/models/send_smtp_email_reply_to.rb +201 -0
- data/lib/brevo-ruby/models/send_smtp_email_reply_to_1.rb +201 -0
- data/lib/brevo-ruby/models/send_smtp_email_sender.rb +206 -0
- data/lib/brevo-ruby/models/send_smtp_email_to.rb +200 -0
- data/lib/brevo-ruby/models/send_smtp_email_to_1.rb +200 -0
- data/lib/brevo-ruby/models/send_test_email.rb +187 -0
- data/lib/brevo-ruby/models/send_test_sms.rb +185 -0
- data/lib/brevo-ruby/models/send_transac_sms.rb +327 -0
- data/lib/brevo-ruby/models/send_whatsapp_message.rb +227 -0
- data/lib/brevo-ruby/models/sso_token_request.rb +244 -0
- data/lib/brevo-ruby/models/sub_account_details_response.rb +214 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info.rb +204 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_credits.rb +195 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_credits_emails.rb +196 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features.rb +203 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features_inbox.rb +196 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features_landing_page.rb +196 -0
- data/lib/brevo-ruby/models/sub_account_details_response_plan_info_features_users.rb +196 -0
- data/lib/brevo-ruby/models/sub_account_update_plan_request.rb +194 -0
- data/lib/brevo-ruby/models/sub_account_update_plan_request_credits.rb +186 -0
- data/lib/brevo-ruby/models/sub_account_update_plan_request_features.rb +206 -0
- data/lib/brevo-ruby/models/sub_accounts_response.rb +196 -0
- data/lib/brevo-ruby/models/sub_accounts_response_sub_accounts.rb +235 -0
- data/lib/brevo-ruby/models/task.rb +252 -0
- data/lib/brevo-ruby/models/task_list.rb +188 -0
- data/lib/brevo-ruby/models/task_reminder.rb +257 -0
- data/lib/brevo-ruby/models/task_types.rb +196 -0
- data/lib/brevo-ruby/models/update_attribute.rb +197 -0
- data/lib/brevo-ruby/models/update_attribute_enumeration.rb +205 -0
- data/lib/brevo-ruby/models/update_batch_contacts.rb +187 -0
- data/lib/brevo-ruby/models/update_batch_contacts_contacts.rb +283 -0
- data/lib/brevo-ruby/models/update_batch_contacts_model.rb +197 -0
- data/lib/brevo-ruby/models/update_campaign_status.rb +220 -0
- data/lib/brevo-ruby/models/update_child.rb +225 -0
- data/lib/brevo-ruby/models/update_child_account_status.rb +215 -0
- data/lib/brevo-ruby/models/update_child_domain.rb +185 -0
- data/lib/brevo-ruby/models/update_contact.rb +251 -0
- data/lib/brevo-ruby/models/update_coupon_collection.rb +190 -0
- data/lib/brevo-ruby/models/update_email_campaign.rb +587 -0
- data/lib/brevo-ruby/models/update_email_campaign_recipients.rb +212 -0
- data/lib/brevo-ruby/models/update_email_campaign_sender.rb +206 -0
- data/lib/brevo-ruby/models/update_external_feed.rb +327 -0
- data/lib/brevo-ruby/models/update_list.rb +195 -0
- data/lib/brevo-ruby/models/update_sender.rb +207 -0
- data/lib/brevo-ruby/models/update_sms_campaign.rb +271 -0
- data/lib/brevo-ruby/models/update_smtp_template.rb +274 -0
- data/lib/brevo-ruby/models/update_smtp_template_sender.rb +206 -0
- data/lib/brevo-ruby/models/update_webhook.rb +239 -0
- data/lib/brevo-ruby/models/update_whats_app_campaign.rb +250 -0
- data/lib/brevo-ruby/models/upload_image_model.rb +190 -0
- data/lib/brevo-ruby/models/upload_image_to_gallery.rb +200 -0
- data/lib/brevo-ruby/models/variables_items.rb +202 -0
- data/lib/brevo-ruby/models/whatsapp_camp_stats.rb +245 -0
- data/lib/brevo-ruby/models/whatsapp_camp_template.rb +287 -0
- data/lib/brevo-ruby/version.rb +15 -0
- data/lib/brevo-ruby.rb +393 -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 +141 -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 +195 -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 +145 -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 +219 -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 +121 -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 +229 -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 +217 -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_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 +57 -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 +219 -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 +1675 -0
|
@@ -0,0 +1,1390 @@
|
|
|
1
|
+
# BrevoRuby::TransactionalEmailsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.brevo.com/v3*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**block_new_domain**](TransactionalEmailsApi.md#block_new_domain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
|
|
8
|
+
[**create_smtp_template**](TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
|
|
9
|
+
[**delete_blocked_domain**](TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
|
|
10
|
+
[**delete_hardbounces**](TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
|
|
11
|
+
[**delete_scheduled_email_by_id**](TransactionalEmailsApi.md#delete_scheduled_email_by_id) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId
|
|
12
|
+
[**delete_smtp_template**](TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
|
|
13
|
+
[**get_aggregated_smtp_report**](TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
|
|
14
|
+
[**get_blocked_domains**](TransactionalEmailsApi.md#get_blocked_domains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
|
|
15
|
+
[**get_email_event_report**](TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
|
|
16
|
+
[**get_scheduled_email_by_batch_id**](TransactionalEmailsApi.md#get_scheduled_email_by_batch_id) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId
|
|
17
|
+
[**get_scheduled_email_by_message_id**](TransactionalEmailsApi.md#get_scheduled_email_by_message_id) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId
|
|
18
|
+
[**get_smtp_report**](TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
|
|
19
|
+
[**get_smtp_template**](TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
|
|
20
|
+
[**get_smtp_templates**](TransactionalEmailsApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
|
|
21
|
+
[**get_transac_blocked_contacts**](TransactionalEmailsApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
|
|
22
|
+
[**get_transac_email_content**](TransactionalEmailsApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
|
|
23
|
+
[**get_transac_emails_list**](TransactionalEmailsApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
|
|
24
|
+
[**send_test_template**](TransactionalEmailsApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
|
|
25
|
+
[**send_transac_email**](TransactionalEmailsApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
|
|
26
|
+
[**smtp_blocked_contacts_email_delete**](TransactionalEmailsApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
|
|
27
|
+
[**smtp_log_message_id_delete**](TransactionalEmailsApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
|
|
28
|
+
[**update_smtp_template**](TransactionalEmailsApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
# **block_new_domain**
|
|
32
|
+
> block_new_domain(block_domain)
|
|
33
|
+
|
|
34
|
+
Add a new domain to the list of blocked domains
|
|
35
|
+
|
|
36
|
+
Blocks a new domain in order to avoid messages being sent to the same
|
|
37
|
+
|
|
38
|
+
### Example
|
|
39
|
+
```ruby
|
|
40
|
+
# load the gem
|
|
41
|
+
require 'brevo-ruby'
|
|
42
|
+
# setup authorization
|
|
43
|
+
BrevoRuby.configure do |config|
|
|
44
|
+
# Configure API key authorization: api-key
|
|
45
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
46
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
47
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
48
|
+
|
|
49
|
+
# Configure API key authorization: partner-key
|
|
50
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
51
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
52
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
56
|
+
|
|
57
|
+
block_domain = BrevoRuby::BlockDomain.new # BlockDomain |
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
begin
|
|
61
|
+
#Add a new domain to the list of blocked domains
|
|
62
|
+
api_instance.block_new_domain(block_domain)
|
|
63
|
+
rescue BrevoRuby::ApiError => e
|
|
64
|
+
puts "Exception when calling TransactionalEmailsApi->block_new_domain: #{e}"
|
|
65
|
+
end
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Parameters
|
|
69
|
+
|
|
70
|
+
Name | Type | Description | Notes
|
|
71
|
+
------------- | ------------- | ------------- | -------------
|
|
72
|
+
**block_domain** | [**BlockDomain**](BlockDomain.md)| |
|
|
73
|
+
|
|
74
|
+
### Return type
|
|
75
|
+
|
|
76
|
+
nil (empty response body)
|
|
77
|
+
|
|
78
|
+
### Authorization
|
|
79
|
+
|
|
80
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
81
|
+
|
|
82
|
+
### HTTP request headers
|
|
83
|
+
|
|
84
|
+
- **Content-Type**: application/json
|
|
85
|
+
- **Accept**: application/json
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
# **create_smtp_template**
|
|
90
|
+
> CreateModel create_smtp_template(smtp_template)
|
|
91
|
+
|
|
92
|
+
Create an email template
|
|
93
|
+
|
|
94
|
+
### Example
|
|
95
|
+
```ruby
|
|
96
|
+
# load the gem
|
|
97
|
+
require 'brevo-ruby'
|
|
98
|
+
# setup authorization
|
|
99
|
+
BrevoRuby.configure do |config|
|
|
100
|
+
# Configure API key authorization: api-key
|
|
101
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
102
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
103
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
104
|
+
|
|
105
|
+
# Configure API key authorization: partner-key
|
|
106
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
107
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
108
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
112
|
+
|
|
113
|
+
smtp_template = BrevoRuby::CreateSmtpTemplate.new # CreateSmtpTemplate | values to update in transactional email template
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
begin
|
|
117
|
+
#Create an email template
|
|
118
|
+
result = api_instance.create_smtp_template(smtp_template)
|
|
119
|
+
p result
|
|
120
|
+
rescue BrevoRuby::ApiError => e
|
|
121
|
+
puts "Exception when calling TransactionalEmailsApi->create_smtp_template: #{e}"
|
|
122
|
+
end
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### Parameters
|
|
126
|
+
|
|
127
|
+
Name | Type | Description | Notes
|
|
128
|
+
------------- | ------------- | ------------- | -------------
|
|
129
|
+
**smtp_template** | [**CreateSmtpTemplate**](CreateSmtpTemplate.md)| values to update in transactional email template |
|
|
130
|
+
|
|
131
|
+
### Return type
|
|
132
|
+
|
|
133
|
+
[**CreateModel**](CreateModel.md)
|
|
134
|
+
|
|
135
|
+
### Authorization
|
|
136
|
+
|
|
137
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
138
|
+
|
|
139
|
+
### HTTP request headers
|
|
140
|
+
|
|
141
|
+
- **Content-Type**: application/json
|
|
142
|
+
- **Accept**: application/json
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
# **delete_blocked_domain**
|
|
147
|
+
> delete_blocked_domain(domain)
|
|
148
|
+
|
|
149
|
+
Unblock an existing domain from the list of blocked domains
|
|
150
|
+
|
|
151
|
+
Unblocks an existing domain from the list of blocked domains
|
|
152
|
+
|
|
153
|
+
### Example
|
|
154
|
+
```ruby
|
|
155
|
+
# load the gem
|
|
156
|
+
require 'brevo-ruby'
|
|
157
|
+
# setup authorization
|
|
158
|
+
BrevoRuby.configure do |config|
|
|
159
|
+
# Configure API key authorization: api-key
|
|
160
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
161
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
162
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
163
|
+
|
|
164
|
+
# Configure API key authorization: partner-key
|
|
165
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
166
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
167
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
171
|
+
|
|
172
|
+
domain = 'domain_example' # String | The name of the domain to be deleted
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
begin
|
|
176
|
+
#Unblock an existing domain from the list of blocked domains
|
|
177
|
+
api_instance.delete_blocked_domain(domain)
|
|
178
|
+
rescue BrevoRuby::ApiError => e
|
|
179
|
+
puts "Exception when calling TransactionalEmailsApi->delete_blocked_domain: #{e}"
|
|
180
|
+
end
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
### Parameters
|
|
184
|
+
|
|
185
|
+
Name | Type | Description | Notes
|
|
186
|
+
------------- | ------------- | ------------- | -------------
|
|
187
|
+
**domain** | **String**| The name of the domain to be deleted |
|
|
188
|
+
|
|
189
|
+
### Return type
|
|
190
|
+
|
|
191
|
+
nil (empty response body)
|
|
192
|
+
|
|
193
|
+
### Authorization
|
|
194
|
+
|
|
195
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
196
|
+
|
|
197
|
+
### HTTP request headers
|
|
198
|
+
|
|
199
|
+
- **Content-Type**: application/json
|
|
200
|
+
- **Accept**: application/json
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
# **delete_hardbounces**
|
|
205
|
+
> delete_hardbounces(opts)
|
|
206
|
+
|
|
207
|
+
Delete hardbounces
|
|
208
|
+
|
|
209
|
+
Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
|
|
210
|
+
|
|
211
|
+
### Example
|
|
212
|
+
```ruby
|
|
213
|
+
# load the gem
|
|
214
|
+
require 'brevo-ruby'
|
|
215
|
+
# setup authorization
|
|
216
|
+
BrevoRuby.configure do |config|
|
|
217
|
+
# Configure API key authorization: api-key
|
|
218
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
219
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
220
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
221
|
+
|
|
222
|
+
# Configure API key authorization: partner-key
|
|
223
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
224
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
225
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
226
|
+
end
|
|
227
|
+
|
|
228
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
229
|
+
|
|
230
|
+
opts = {
|
|
231
|
+
delete_hardbounces: BrevoRuby::DeleteHardbounces.new # DeleteHardbounces | values to delete hardbounces
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
begin
|
|
235
|
+
#Delete hardbounces
|
|
236
|
+
api_instance.delete_hardbounces(opts)
|
|
237
|
+
rescue BrevoRuby::ApiError => e
|
|
238
|
+
puts "Exception when calling TransactionalEmailsApi->delete_hardbounces: #{e}"
|
|
239
|
+
end
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
### Parameters
|
|
243
|
+
|
|
244
|
+
Name | Type | Description | Notes
|
|
245
|
+
------------- | ------------- | ------------- | -------------
|
|
246
|
+
**delete_hardbounces** | [**DeleteHardbounces**](DeleteHardbounces.md)| values to delete hardbounces | [optional]
|
|
247
|
+
|
|
248
|
+
### Return type
|
|
249
|
+
|
|
250
|
+
nil (empty response body)
|
|
251
|
+
|
|
252
|
+
### Authorization
|
|
253
|
+
|
|
254
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
255
|
+
|
|
256
|
+
### HTTP request headers
|
|
257
|
+
|
|
258
|
+
- **Content-Type**: application/json
|
|
259
|
+
- **Accept**: application/json
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
# **delete_scheduled_email_by_id**
|
|
264
|
+
> delete_scheduled_email_by_id(identifier)
|
|
265
|
+
|
|
266
|
+
Delete scheduled emails by batchId or messageId
|
|
267
|
+
|
|
268
|
+
Delete scheduled batch of emails by batchId or single scheduled email by messageId
|
|
269
|
+
|
|
270
|
+
### Example
|
|
271
|
+
```ruby
|
|
272
|
+
# load the gem
|
|
273
|
+
require 'brevo-ruby'
|
|
274
|
+
# setup authorization
|
|
275
|
+
BrevoRuby.configure do |config|
|
|
276
|
+
# Configure API key authorization: api-key
|
|
277
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
278
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
279
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
280
|
+
|
|
281
|
+
# Configure API key authorization: partner-key
|
|
282
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
283
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
284
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
288
|
+
|
|
289
|
+
identifier = 'identifier_example' # String | The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email.
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
begin
|
|
293
|
+
#Delete scheduled emails by batchId or messageId
|
|
294
|
+
api_instance.delete_scheduled_email_by_id(identifier)
|
|
295
|
+
rescue BrevoRuby::ApiError => e
|
|
296
|
+
puts "Exception when calling TransactionalEmailsApi->delete_scheduled_email_by_id: #{e}"
|
|
297
|
+
end
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
### Parameters
|
|
301
|
+
|
|
302
|
+
Name | Type | Description | Notes
|
|
303
|
+
------------- | ------------- | ------------- | -------------
|
|
304
|
+
**identifier** | **String**| The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. |
|
|
305
|
+
|
|
306
|
+
### Return type
|
|
307
|
+
|
|
308
|
+
nil (empty response body)
|
|
309
|
+
|
|
310
|
+
### Authorization
|
|
311
|
+
|
|
312
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
313
|
+
|
|
314
|
+
### HTTP request headers
|
|
315
|
+
|
|
316
|
+
- **Content-Type**: application/json
|
|
317
|
+
- **Accept**: application/json
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
# **delete_smtp_template**
|
|
322
|
+
> delete_smtp_template(template_id)
|
|
323
|
+
|
|
324
|
+
Delete an inactive email template
|
|
325
|
+
|
|
326
|
+
### Example
|
|
327
|
+
```ruby
|
|
328
|
+
# load the gem
|
|
329
|
+
require 'brevo-ruby'
|
|
330
|
+
# setup authorization
|
|
331
|
+
BrevoRuby.configure do |config|
|
|
332
|
+
# Configure API key authorization: api-key
|
|
333
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
334
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
335
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
336
|
+
|
|
337
|
+
# Configure API key authorization: partner-key
|
|
338
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
339
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
340
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
341
|
+
end
|
|
342
|
+
|
|
343
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
344
|
+
|
|
345
|
+
template_id = 789 # Integer | id of the template
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
begin
|
|
349
|
+
#Delete an inactive email template
|
|
350
|
+
api_instance.delete_smtp_template(template_id)
|
|
351
|
+
rescue BrevoRuby::ApiError => e
|
|
352
|
+
puts "Exception when calling TransactionalEmailsApi->delete_smtp_template: #{e}"
|
|
353
|
+
end
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
### Parameters
|
|
357
|
+
|
|
358
|
+
Name | Type | Description | Notes
|
|
359
|
+
------------- | ------------- | ------------- | -------------
|
|
360
|
+
**template_id** | **Integer**| id of the template |
|
|
361
|
+
|
|
362
|
+
### Return type
|
|
363
|
+
|
|
364
|
+
nil (empty response body)
|
|
365
|
+
|
|
366
|
+
### Authorization
|
|
367
|
+
|
|
368
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
369
|
+
|
|
370
|
+
### HTTP request headers
|
|
371
|
+
|
|
372
|
+
- **Content-Type**: application/json
|
|
373
|
+
- **Accept**: application/json
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
# **get_aggregated_smtp_report**
|
|
378
|
+
> GetAggregatedReport get_aggregated_smtp_report(opts)
|
|
379
|
+
|
|
380
|
+
Get your transactional email activity aggregated over a period of time
|
|
381
|
+
|
|
382
|
+
This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
|
|
383
|
+
|
|
384
|
+
### Example
|
|
385
|
+
```ruby
|
|
386
|
+
# load the gem
|
|
387
|
+
require 'brevo-ruby'
|
|
388
|
+
# setup authorization
|
|
389
|
+
BrevoRuby.configure do |config|
|
|
390
|
+
# Configure API key authorization: api-key
|
|
391
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
392
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
393
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
394
|
+
|
|
395
|
+
# Configure API key authorization: partner-key
|
|
396
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
397
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
398
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
399
|
+
end
|
|
400
|
+
|
|
401
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
402
|
+
|
|
403
|
+
opts = {
|
|
404
|
+
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
|
405
|
+
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
|
406
|
+
days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
407
|
+
tag: 'tag_example' # String | Tag of the emails
|
|
408
|
+
}
|
|
409
|
+
|
|
410
|
+
begin
|
|
411
|
+
#Get your transactional email activity aggregated over a period of time
|
|
412
|
+
result = api_instance.get_aggregated_smtp_report(opts)
|
|
413
|
+
p result
|
|
414
|
+
rescue BrevoRuby::ApiError => e
|
|
415
|
+
puts "Exception when calling TransactionalEmailsApi->get_aggregated_smtp_report: #{e}"
|
|
416
|
+
end
|
|
417
|
+
```
|
|
418
|
+
|
|
419
|
+
### Parameters
|
|
420
|
+
|
|
421
|
+
Name | Type | Description | Notes
|
|
422
|
+
------------- | ------------- | ------------- | -------------
|
|
423
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
|
|
424
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
|
|
425
|
+
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
|
426
|
+
**tag** | **String**| Tag of the emails | [optional]
|
|
427
|
+
|
|
428
|
+
### Return type
|
|
429
|
+
|
|
430
|
+
[**GetAggregatedReport**](GetAggregatedReport.md)
|
|
431
|
+
|
|
432
|
+
### Authorization
|
|
433
|
+
|
|
434
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
435
|
+
|
|
436
|
+
### HTTP request headers
|
|
437
|
+
|
|
438
|
+
- **Content-Type**: application/json
|
|
439
|
+
- **Accept**: application/json
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
# **get_blocked_domains**
|
|
444
|
+
> GetBlockedDomains get_blocked_domains
|
|
445
|
+
|
|
446
|
+
Get the list of blocked domains
|
|
447
|
+
|
|
448
|
+
Get the list of blocked domains
|
|
449
|
+
|
|
450
|
+
### Example
|
|
451
|
+
```ruby
|
|
452
|
+
# load the gem
|
|
453
|
+
require 'brevo-ruby'
|
|
454
|
+
# setup authorization
|
|
455
|
+
BrevoRuby.configure do |config|
|
|
456
|
+
# Configure API key authorization: api-key
|
|
457
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
458
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
459
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
460
|
+
|
|
461
|
+
# Configure API key authorization: partner-key
|
|
462
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
463
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
464
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
465
|
+
end
|
|
466
|
+
|
|
467
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
468
|
+
|
|
469
|
+
begin
|
|
470
|
+
#Get the list of blocked domains
|
|
471
|
+
result = api_instance.get_blocked_domains
|
|
472
|
+
p result
|
|
473
|
+
rescue BrevoRuby::ApiError => e
|
|
474
|
+
puts "Exception when calling TransactionalEmailsApi->get_blocked_domains: #{e}"
|
|
475
|
+
end
|
|
476
|
+
```
|
|
477
|
+
|
|
478
|
+
### Parameters
|
|
479
|
+
This endpoint does not need any parameter.
|
|
480
|
+
|
|
481
|
+
### Return type
|
|
482
|
+
|
|
483
|
+
[**GetBlockedDomains**](GetBlockedDomains.md)
|
|
484
|
+
|
|
485
|
+
### Authorization
|
|
486
|
+
|
|
487
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
488
|
+
|
|
489
|
+
### HTTP request headers
|
|
490
|
+
|
|
491
|
+
- **Content-Type**: application/json
|
|
492
|
+
- **Accept**: application/json
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
# **get_email_event_report**
|
|
497
|
+
> GetEmailEventReport get_email_event_report(opts)
|
|
498
|
+
|
|
499
|
+
Get all your transactional email activity (unaggregated events)
|
|
500
|
+
|
|
501
|
+
This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
|
|
502
|
+
|
|
503
|
+
### Example
|
|
504
|
+
```ruby
|
|
505
|
+
# load the gem
|
|
506
|
+
require 'brevo-ruby'
|
|
507
|
+
# setup authorization
|
|
508
|
+
BrevoRuby.configure do |config|
|
|
509
|
+
# Configure API key authorization: api-key
|
|
510
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
511
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
512
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
513
|
+
|
|
514
|
+
# Configure API key authorization: partner-key
|
|
515
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
516
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
517
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
518
|
+
end
|
|
519
|
+
|
|
520
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
521
|
+
|
|
522
|
+
opts = {
|
|
523
|
+
limit: 2500, # Integer | Number limitation for the result returned
|
|
524
|
+
offset: 0, # Integer | Beginning point in the list to retrieve from.
|
|
525
|
+
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
|
526
|
+
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
|
527
|
+
days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
528
|
+
email: 'email_example', # String | Filter the report for a specific email addresses
|
|
529
|
+
event: 'event_example', # String | Filter the report for a specific event type
|
|
530
|
+
tags: 'tags_example', # String | Filter the report for tags (serialized and urlencoded array)
|
|
531
|
+
message_id: 'message_id_example', # String | Filter on a specific message id
|
|
532
|
+
template_id: 789, # Integer | Filter on a specific template id
|
|
533
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
begin
|
|
537
|
+
#Get all your transactional email activity (unaggregated events)
|
|
538
|
+
result = api_instance.get_email_event_report(opts)
|
|
539
|
+
p result
|
|
540
|
+
rescue BrevoRuby::ApiError => e
|
|
541
|
+
puts "Exception when calling TransactionalEmailsApi->get_email_event_report: #{e}"
|
|
542
|
+
end
|
|
543
|
+
```
|
|
544
|
+
|
|
545
|
+
### Parameters
|
|
546
|
+
|
|
547
|
+
Name | Type | Description | Notes
|
|
548
|
+
------------- | ------------- | ------------- | -------------
|
|
549
|
+
**limit** | **Integer**| Number limitation for the result returned | [optional] [default to 2500]
|
|
550
|
+
**offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
|
|
551
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
|
|
552
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
|
|
553
|
+
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
|
554
|
+
**email** | **String**| Filter the report for a specific email addresses | [optional]
|
|
555
|
+
**event** | **String**| Filter the report for a specific event type | [optional]
|
|
556
|
+
**tags** | **String**| Filter the report for tags (serialized and urlencoded array) | [optional]
|
|
557
|
+
**message_id** | **String**| Filter on a specific message id | [optional]
|
|
558
|
+
**template_id** | **Integer**| Filter on a specific template id | [optional]
|
|
559
|
+
**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]
|
|
560
|
+
|
|
561
|
+
### Return type
|
|
562
|
+
|
|
563
|
+
[**GetEmailEventReport**](GetEmailEventReport.md)
|
|
564
|
+
|
|
565
|
+
### Authorization
|
|
566
|
+
|
|
567
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
568
|
+
|
|
569
|
+
### HTTP request headers
|
|
570
|
+
|
|
571
|
+
- **Content-Type**: application/json
|
|
572
|
+
- **Accept**: application/json
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
# **get_scheduled_email_by_batch_id**
|
|
577
|
+
> GetScheduledEmailByBatchId get_scheduled_email_by_batch_id(batch_id, opts)
|
|
578
|
+
|
|
579
|
+
Fetch scheduled emails by batchId
|
|
580
|
+
|
|
581
|
+
Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old)
|
|
582
|
+
|
|
583
|
+
### Example
|
|
584
|
+
```ruby
|
|
585
|
+
# load the gem
|
|
586
|
+
require 'brevo-ruby'
|
|
587
|
+
# setup authorization
|
|
588
|
+
BrevoRuby.configure do |config|
|
|
589
|
+
# Configure API key authorization: api-key
|
|
590
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
591
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
592
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
593
|
+
|
|
594
|
+
# Configure API key authorization: partner-key
|
|
595
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
596
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
597
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
598
|
+
end
|
|
599
|
+
|
|
600
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
601
|
+
|
|
602
|
+
batch_id = 'batch_id_example' # String | The batchId of scheduled emails batch (Should be a valid UUIDv4)
|
|
603
|
+
|
|
604
|
+
opts = {
|
|
605
|
+
start_date: Date.parse('2013-10-20'), # Date | Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
|
|
606
|
+
end_date: Date.parse('2013-10-20'), # Date | Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
|
607
|
+
sort: 'desc', # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
608
|
+
status: 'status_example', # String | Filter the records by `status` of the scheduled email batch or message.
|
|
609
|
+
limit: 100, # Integer | Number of documents returned per page
|
|
610
|
+
offset: 0 # Integer | Index of the first document on the page
|
|
611
|
+
}
|
|
612
|
+
|
|
613
|
+
begin
|
|
614
|
+
#Fetch scheduled emails by batchId
|
|
615
|
+
result = api_instance.get_scheduled_email_by_batch_id(batch_id, opts)
|
|
616
|
+
p result
|
|
617
|
+
rescue BrevoRuby::ApiError => e
|
|
618
|
+
puts "Exception when calling TransactionalEmailsApi->get_scheduled_email_by_batch_id: #{e}"
|
|
619
|
+
end
|
|
620
|
+
```
|
|
621
|
+
|
|
622
|
+
### Parameters
|
|
623
|
+
|
|
624
|
+
Name | Type | Description | Notes
|
|
625
|
+
------------- | ------------- | ------------- | -------------
|
|
626
|
+
**batch_id** | **String**| The batchId of scheduled emails batch (Should be a valid UUIDv4) |
|
|
627
|
+
**start_date** | **Date**| Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional]
|
|
628
|
+
**end_date** | **Date**| Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
|
629
|
+
**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]
|
|
630
|
+
**status** | **String**| Filter the records by `status` of the scheduled email batch or message. | [optional]
|
|
631
|
+
**limit** | **Integer**| Number of documents returned per page | [optional] [default to 100]
|
|
632
|
+
**offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
|
|
633
|
+
|
|
634
|
+
### Return type
|
|
635
|
+
|
|
636
|
+
[**GetScheduledEmailByBatchId**](GetScheduledEmailByBatchId.md)
|
|
637
|
+
|
|
638
|
+
### Authorization
|
|
639
|
+
|
|
640
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
641
|
+
|
|
642
|
+
### HTTP request headers
|
|
643
|
+
|
|
644
|
+
- **Content-Type**: application/json
|
|
645
|
+
- **Accept**: application/json
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
# **get_scheduled_email_by_message_id**
|
|
650
|
+
> GetScheduledEmailByMessageId get_scheduled_email_by_message_id(message_id, opts)
|
|
651
|
+
|
|
652
|
+
Fetch scheduled email by messageId
|
|
653
|
+
|
|
654
|
+
Fetch scheduled email by messageId (Can retrieve data upto 30 days old)
|
|
655
|
+
|
|
656
|
+
### Example
|
|
657
|
+
```ruby
|
|
658
|
+
# load the gem
|
|
659
|
+
require 'brevo-ruby'
|
|
660
|
+
# setup authorization
|
|
661
|
+
BrevoRuby.configure do |config|
|
|
662
|
+
# Configure API key authorization: api-key
|
|
663
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
664
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
665
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
666
|
+
|
|
667
|
+
# Configure API key authorization: partner-key
|
|
668
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
669
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
670
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
671
|
+
end
|
|
672
|
+
|
|
673
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
674
|
+
|
|
675
|
+
message_id = 'message_id_example' # String | The messageId of scheduled email
|
|
676
|
+
|
|
677
|
+
opts = {
|
|
678
|
+
start_date: Date.parse('2013-10-20'), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
|
|
679
|
+
end_date: Date.parse('2013-10-20') # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
|
680
|
+
}
|
|
681
|
+
|
|
682
|
+
begin
|
|
683
|
+
#Fetch scheduled email by messageId
|
|
684
|
+
result = api_instance.get_scheduled_email_by_message_id(message_id, opts)
|
|
685
|
+
p result
|
|
686
|
+
rescue BrevoRuby::ApiError => e
|
|
687
|
+
puts "Exception when calling TransactionalEmailsApi->get_scheduled_email_by_message_id: #{e}"
|
|
688
|
+
end
|
|
689
|
+
```
|
|
690
|
+
|
|
691
|
+
### Parameters
|
|
692
|
+
|
|
693
|
+
Name | Type | Description | Notes
|
|
694
|
+
------------- | ------------- | ------------- | -------------
|
|
695
|
+
**message_id** | **String**| The messageId of scheduled email |
|
|
696
|
+
**start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional]
|
|
697
|
+
**end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
|
698
|
+
|
|
699
|
+
### Return type
|
|
700
|
+
|
|
701
|
+
[**GetScheduledEmailByMessageId**](GetScheduledEmailByMessageId.md)
|
|
702
|
+
|
|
703
|
+
### Authorization
|
|
704
|
+
|
|
705
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
706
|
+
|
|
707
|
+
### HTTP request headers
|
|
708
|
+
|
|
709
|
+
- **Content-Type**: application/json
|
|
710
|
+
- **Accept**: application/json
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
# **get_smtp_report**
|
|
715
|
+
> GetReports get_smtp_report(opts)
|
|
716
|
+
|
|
717
|
+
Get your transactional email activity aggregated per day
|
|
718
|
+
|
|
719
|
+
### Example
|
|
720
|
+
```ruby
|
|
721
|
+
# load the gem
|
|
722
|
+
require 'brevo-ruby'
|
|
723
|
+
# setup authorization
|
|
724
|
+
BrevoRuby.configure do |config|
|
|
725
|
+
# Configure API key authorization: api-key
|
|
726
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
727
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
728
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
729
|
+
|
|
730
|
+
# Configure API key authorization: partner-key
|
|
731
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
732
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
733
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
734
|
+
end
|
|
735
|
+
|
|
736
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
737
|
+
|
|
738
|
+
opts = {
|
|
739
|
+
limit: 10, # Integer | Number of documents returned per page
|
|
740
|
+
offset: 0, # Integer | Index of the first document on the page
|
|
741
|
+
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
|
|
742
|
+
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
|
|
743
|
+
days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
|
744
|
+
tag: 'tag_example', # String | Tag of the emails
|
|
745
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
746
|
+
}
|
|
747
|
+
|
|
748
|
+
begin
|
|
749
|
+
#Get your transactional email activity aggregated per day
|
|
750
|
+
result = api_instance.get_smtp_report(opts)
|
|
751
|
+
p result
|
|
752
|
+
rescue BrevoRuby::ApiError => e
|
|
753
|
+
puts "Exception when calling TransactionalEmailsApi->get_smtp_report: #{e}"
|
|
754
|
+
end
|
|
755
|
+
```
|
|
756
|
+
|
|
757
|
+
### Parameters
|
|
758
|
+
|
|
759
|
+
Name | Type | Description | Notes
|
|
760
|
+
------------- | ------------- | ------------- | -------------
|
|
761
|
+
**limit** | **Integer**| Number of documents returned per page | [optional] [default to 10]
|
|
762
|
+
**offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
|
|
763
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional]
|
|
764
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
|
|
765
|
+
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
|
766
|
+
**tag** | **String**| Tag of the emails | [optional]
|
|
767
|
+
**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]
|
|
768
|
+
|
|
769
|
+
### Return type
|
|
770
|
+
|
|
771
|
+
[**GetReports**](GetReports.md)
|
|
772
|
+
|
|
773
|
+
### Authorization
|
|
774
|
+
|
|
775
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
776
|
+
|
|
777
|
+
### HTTP request headers
|
|
778
|
+
|
|
779
|
+
- **Content-Type**: application/json
|
|
780
|
+
- **Accept**: application/json
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
# **get_smtp_template**
|
|
785
|
+
> GetSmtpTemplateOverview get_smtp_template(template_id)
|
|
786
|
+
|
|
787
|
+
Returns the template information
|
|
788
|
+
|
|
789
|
+
### Example
|
|
790
|
+
```ruby
|
|
791
|
+
# load the gem
|
|
792
|
+
require 'brevo-ruby'
|
|
793
|
+
# setup authorization
|
|
794
|
+
BrevoRuby.configure do |config|
|
|
795
|
+
# Configure API key authorization: api-key
|
|
796
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
797
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
798
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
799
|
+
|
|
800
|
+
# Configure API key authorization: partner-key
|
|
801
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
802
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
803
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
804
|
+
end
|
|
805
|
+
|
|
806
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
807
|
+
|
|
808
|
+
template_id = 789 # Integer | id of the template
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
begin
|
|
812
|
+
#Returns the template information
|
|
813
|
+
result = api_instance.get_smtp_template(template_id)
|
|
814
|
+
p result
|
|
815
|
+
rescue BrevoRuby::ApiError => e
|
|
816
|
+
puts "Exception when calling TransactionalEmailsApi->get_smtp_template: #{e}"
|
|
817
|
+
end
|
|
818
|
+
```
|
|
819
|
+
|
|
820
|
+
### Parameters
|
|
821
|
+
|
|
822
|
+
Name | Type | Description | Notes
|
|
823
|
+
------------- | ------------- | ------------- | -------------
|
|
824
|
+
**template_id** | **Integer**| id of the template |
|
|
825
|
+
|
|
826
|
+
### Return type
|
|
827
|
+
|
|
828
|
+
[**GetSmtpTemplateOverview**](GetSmtpTemplateOverview.md)
|
|
829
|
+
|
|
830
|
+
### Authorization
|
|
831
|
+
|
|
832
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
833
|
+
|
|
834
|
+
### HTTP request headers
|
|
835
|
+
|
|
836
|
+
- **Content-Type**: application/json
|
|
837
|
+
- **Accept**: application/json
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
# **get_smtp_templates**
|
|
842
|
+
> GetSmtpTemplates get_smtp_templates(opts)
|
|
843
|
+
|
|
844
|
+
Get the list of email templates
|
|
845
|
+
|
|
846
|
+
### Example
|
|
847
|
+
```ruby
|
|
848
|
+
# load the gem
|
|
849
|
+
require 'brevo-ruby'
|
|
850
|
+
# setup authorization
|
|
851
|
+
BrevoRuby.configure do |config|
|
|
852
|
+
# Configure API key authorization: api-key
|
|
853
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
854
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
855
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
856
|
+
|
|
857
|
+
# Configure API key authorization: partner-key
|
|
858
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
859
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
860
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
861
|
+
end
|
|
862
|
+
|
|
863
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
864
|
+
|
|
865
|
+
opts = {
|
|
866
|
+
template_status: true, # BOOLEAN | Filter on the status of the template. Active = true, inactive = false
|
|
867
|
+
limit: 50, # Integer | Number of documents returned per page
|
|
868
|
+
offset: 0, # Integer | Index of the first document in the page
|
|
869
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
870
|
+
}
|
|
871
|
+
|
|
872
|
+
begin
|
|
873
|
+
#Get the list of email templates
|
|
874
|
+
result = api_instance.get_smtp_templates(opts)
|
|
875
|
+
p result
|
|
876
|
+
rescue BrevoRuby::ApiError => e
|
|
877
|
+
puts "Exception when calling TransactionalEmailsApi->get_smtp_templates: #{e}"
|
|
878
|
+
end
|
|
879
|
+
```
|
|
880
|
+
|
|
881
|
+
### Parameters
|
|
882
|
+
|
|
883
|
+
Name | Type | Description | Notes
|
|
884
|
+
------------- | ------------- | ------------- | -------------
|
|
885
|
+
**template_status** | **BOOLEAN**| Filter on the status of the template. Active = true, inactive = false | [optional]
|
|
886
|
+
**limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
|
|
887
|
+
**offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
|
|
888
|
+
**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]
|
|
889
|
+
|
|
890
|
+
### Return type
|
|
891
|
+
|
|
892
|
+
[**GetSmtpTemplates**](GetSmtpTemplates.md)
|
|
893
|
+
|
|
894
|
+
### Authorization
|
|
895
|
+
|
|
896
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
897
|
+
|
|
898
|
+
### HTTP request headers
|
|
899
|
+
|
|
900
|
+
- **Content-Type**: application/json
|
|
901
|
+
- **Accept**: application/json
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
# **get_transac_blocked_contacts**
|
|
906
|
+
> GetTransacBlockedContacts get_transac_blocked_contacts(opts)
|
|
907
|
+
|
|
908
|
+
Get the list of blocked or unsubscribed transactional contacts
|
|
909
|
+
|
|
910
|
+
### Example
|
|
911
|
+
```ruby
|
|
912
|
+
# load the gem
|
|
913
|
+
require 'brevo-ruby'
|
|
914
|
+
# setup authorization
|
|
915
|
+
BrevoRuby.configure do |config|
|
|
916
|
+
# Configure API key authorization: api-key
|
|
917
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
918
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
919
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
920
|
+
|
|
921
|
+
# Configure API key authorization: partner-key
|
|
922
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
923
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
924
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
925
|
+
end
|
|
926
|
+
|
|
927
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
928
|
+
|
|
929
|
+
opts = {
|
|
930
|
+
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
|
|
931
|
+
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
|
|
932
|
+
limit: 50, # Integer | Number of documents returned per page
|
|
933
|
+
offset: 0, # Integer | Index of the first document on the page
|
|
934
|
+
senders: ['senders_example'], # Array<String> | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
|
|
935
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
936
|
+
}
|
|
937
|
+
|
|
938
|
+
begin
|
|
939
|
+
#Get the list of blocked or unsubscribed transactional contacts
|
|
940
|
+
result = api_instance.get_transac_blocked_contacts(opts)
|
|
941
|
+
p result
|
|
942
|
+
rescue BrevoRuby::ApiError => e
|
|
943
|
+
puts "Exception when calling TransactionalEmailsApi->get_transac_blocked_contacts: #{e}"
|
|
944
|
+
end
|
|
945
|
+
```
|
|
946
|
+
|
|
947
|
+
### Parameters
|
|
948
|
+
|
|
949
|
+
Name | Type | Description | Notes
|
|
950
|
+
------------- | ------------- | ------------- | -------------
|
|
951
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts | [optional]
|
|
952
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts | [optional]
|
|
953
|
+
**limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
|
|
954
|
+
**offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
|
|
955
|
+
**senders** | [**Array<String>**](String.md)| Comma separated list of emails of the senders from which contacts are blocked or unsubscribed | [optional]
|
|
956
|
+
**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]
|
|
957
|
+
|
|
958
|
+
### Return type
|
|
959
|
+
|
|
960
|
+
[**GetTransacBlockedContacts**](GetTransacBlockedContacts.md)
|
|
961
|
+
|
|
962
|
+
### Authorization
|
|
963
|
+
|
|
964
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
965
|
+
|
|
966
|
+
### HTTP request headers
|
|
967
|
+
|
|
968
|
+
- **Content-Type**: application/json
|
|
969
|
+
- **Accept**: application/json
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
# **get_transac_email_content**
|
|
974
|
+
> GetTransacEmailContent get_transac_email_content(uuid)
|
|
975
|
+
|
|
976
|
+
Get the personalized content of a sent transactional email
|
|
977
|
+
|
|
978
|
+
### Example
|
|
979
|
+
```ruby
|
|
980
|
+
# load the gem
|
|
981
|
+
require 'brevo-ruby'
|
|
982
|
+
# setup authorization
|
|
983
|
+
BrevoRuby.configure do |config|
|
|
984
|
+
# Configure API key authorization: api-key
|
|
985
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
986
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
987
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
988
|
+
|
|
989
|
+
# Configure API key authorization: partner-key
|
|
990
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
991
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
992
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
993
|
+
end
|
|
994
|
+
|
|
995
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
996
|
+
|
|
997
|
+
uuid = 'uuid_example' # String | Unique id of the transactional email that has been sent to a particular contact
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
begin
|
|
1001
|
+
#Get the personalized content of a sent transactional email
|
|
1002
|
+
result = api_instance.get_transac_email_content(uuid)
|
|
1003
|
+
p result
|
|
1004
|
+
rescue BrevoRuby::ApiError => e
|
|
1005
|
+
puts "Exception when calling TransactionalEmailsApi->get_transac_email_content: #{e}"
|
|
1006
|
+
end
|
|
1007
|
+
```
|
|
1008
|
+
|
|
1009
|
+
### Parameters
|
|
1010
|
+
|
|
1011
|
+
Name | Type | Description | Notes
|
|
1012
|
+
------------- | ------------- | ------------- | -------------
|
|
1013
|
+
**uuid** | **String**| Unique id of the transactional email that has been sent to a particular contact |
|
|
1014
|
+
|
|
1015
|
+
### Return type
|
|
1016
|
+
|
|
1017
|
+
[**GetTransacEmailContent**](GetTransacEmailContent.md)
|
|
1018
|
+
|
|
1019
|
+
### Authorization
|
|
1020
|
+
|
|
1021
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1022
|
+
|
|
1023
|
+
### HTTP request headers
|
|
1024
|
+
|
|
1025
|
+
- **Content-Type**: application/json
|
|
1026
|
+
- **Accept**: application/json
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
# **get_transac_emails_list**
|
|
1031
|
+
> GetTransacEmailsList get_transac_emails_list(opts)
|
|
1032
|
+
|
|
1033
|
+
Get the list of transactional emails on the basis of allowed filters
|
|
1034
|
+
|
|
1035
|
+
This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
|
|
1036
|
+
|
|
1037
|
+
### Example
|
|
1038
|
+
```ruby
|
|
1039
|
+
# load the gem
|
|
1040
|
+
require 'brevo-ruby'
|
|
1041
|
+
# setup authorization
|
|
1042
|
+
BrevoRuby.configure do |config|
|
|
1043
|
+
# Configure API key authorization: api-key
|
|
1044
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1045
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1046
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1047
|
+
|
|
1048
|
+
# Configure API key authorization: partner-key
|
|
1049
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1050
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1051
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1052
|
+
end
|
|
1053
|
+
|
|
1054
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
1055
|
+
|
|
1056
|
+
opts = {
|
|
1057
|
+
email: 'email_example', # String | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
|
|
1058
|
+
template_id: 789, # Integer | Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
|
|
1059
|
+
message_id: 'message_id_example', # String | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
|
|
1060
|
+
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
|
|
1061
|
+
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
|
1062
|
+
sort: 'desc', # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
1063
|
+
limit: 500, # Integer | Number of documents returned per page
|
|
1064
|
+
offset: 0 # Integer | Index of the first document in the page
|
|
1065
|
+
}
|
|
1066
|
+
|
|
1067
|
+
begin
|
|
1068
|
+
#Get the list of transactional emails on the basis of allowed filters
|
|
1069
|
+
result = api_instance.get_transac_emails_list(opts)
|
|
1070
|
+
p result
|
|
1071
|
+
rescue BrevoRuby::ApiError => e
|
|
1072
|
+
puts "Exception when calling TransactionalEmailsApi->get_transac_emails_list: #{e}"
|
|
1073
|
+
end
|
|
1074
|
+
```
|
|
1075
|
+
|
|
1076
|
+
### Parameters
|
|
1077
|
+
|
|
1078
|
+
Name | Type | Description | Notes
|
|
1079
|
+
------------- | ------------- | ------------- | -------------
|
|
1080
|
+
**email** | **String**| Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. | [optional]
|
|
1081
|
+
**template_id** | **Integer**| Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. | [optional]
|
|
1082
|
+
**message_id** | **String**| Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | [optional]
|
|
1083
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
|
1084
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
|
1085
|
+
**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]
|
|
1086
|
+
**limit** | **Integer**| Number of documents returned per page | [optional] [default to 500]
|
|
1087
|
+
**offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
|
|
1088
|
+
|
|
1089
|
+
### Return type
|
|
1090
|
+
|
|
1091
|
+
[**GetTransacEmailsList**](GetTransacEmailsList.md)
|
|
1092
|
+
|
|
1093
|
+
### Authorization
|
|
1094
|
+
|
|
1095
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1096
|
+
|
|
1097
|
+
### HTTP request headers
|
|
1098
|
+
|
|
1099
|
+
- **Content-Type**: application/json
|
|
1100
|
+
- **Accept**: application/json
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
# **send_test_template**
|
|
1105
|
+
> send_test_template(template_id, send_test_email)
|
|
1106
|
+
|
|
1107
|
+
Send a template to your test list
|
|
1108
|
+
|
|
1109
|
+
### Example
|
|
1110
|
+
```ruby
|
|
1111
|
+
# load the gem
|
|
1112
|
+
require 'brevo-ruby'
|
|
1113
|
+
# setup authorization
|
|
1114
|
+
BrevoRuby.configure do |config|
|
|
1115
|
+
# Configure API key authorization: api-key
|
|
1116
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1117
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1118
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1119
|
+
|
|
1120
|
+
# Configure API key authorization: partner-key
|
|
1121
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1122
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1123
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1124
|
+
end
|
|
1125
|
+
|
|
1126
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
1127
|
+
|
|
1128
|
+
template_id = 789 # Integer | Id of the template
|
|
1129
|
+
|
|
1130
|
+
send_test_email = BrevoRuby::SendTestEmail.new # SendTestEmail |
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
begin
|
|
1134
|
+
#Send a template to your test list
|
|
1135
|
+
api_instance.send_test_template(template_id, send_test_email)
|
|
1136
|
+
rescue BrevoRuby::ApiError => e
|
|
1137
|
+
puts "Exception when calling TransactionalEmailsApi->send_test_template: #{e}"
|
|
1138
|
+
end
|
|
1139
|
+
```
|
|
1140
|
+
|
|
1141
|
+
### Parameters
|
|
1142
|
+
|
|
1143
|
+
Name | Type | Description | Notes
|
|
1144
|
+
------------- | ------------- | ------------- | -------------
|
|
1145
|
+
**template_id** | **Integer**| Id of the template |
|
|
1146
|
+
**send_test_email** | [**SendTestEmail**](SendTestEmail.md)| |
|
|
1147
|
+
|
|
1148
|
+
### Return type
|
|
1149
|
+
|
|
1150
|
+
nil (empty response body)
|
|
1151
|
+
|
|
1152
|
+
### Authorization
|
|
1153
|
+
|
|
1154
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1155
|
+
|
|
1156
|
+
### HTTP request headers
|
|
1157
|
+
|
|
1158
|
+
- **Content-Type**: application/json
|
|
1159
|
+
- **Accept**: application/json
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
# **send_transac_email**
|
|
1164
|
+
> CreateSmtpEmail send_transac_email(send_smtp_email)
|
|
1165
|
+
|
|
1166
|
+
Send a transactional email
|
|
1167
|
+
|
|
1168
|
+
### Example
|
|
1169
|
+
```ruby
|
|
1170
|
+
# load the gem
|
|
1171
|
+
require 'brevo-ruby'
|
|
1172
|
+
# setup authorization
|
|
1173
|
+
BrevoRuby.configure do |config|
|
|
1174
|
+
# Configure API key authorization: api-key
|
|
1175
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1176
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1177
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1178
|
+
|
|
1179
|
+
# Configure API key authorization: partner-key
|
|
1180
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1181
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1182
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1183
|
+
end
|
|
1184
|
+
|
|
1185
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
1186
|
+
|
|
1187
|
+
send_smtp_email = BrevoRuby::SendSmtpEmail.new # SendSmtpEmail | Values to send a transactional email
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
begin
|
|
1191
|
+
#Send a transactional email
|
|
1192
|
+
result = api_instance.send_transac_email(send_smtp_email)
|
|
1193
|
+
p result
|
|
1194
|
+
rescue BrevoRuby::ApiError => e
|
|
1195
|
+
puts "Exception when calling TransactionalEmailsApi->send_transac_email: #{e}"
|
|
1196
|
+
end
|
|
1197
|
+
```
|
|
1198
|
+
|
|
1199
|
+
### Parameters
|
|
1200
|
+
|
|
1201
|
+
Name | Type | Description | Notes
|
|
1202
|
+
------------- | ------------- | ------------- | -------------
|
|
1203
|
+
**send_smtp_email** | [**SendSmtpEmail**](SendSmtpEmail.md)| Values to send a transactional email |
|
|
1204
|
+
|
|
1205
|
+
### Return type
|
|
1206
|
+
|
|
1207
|
+
[**CreateSmtpEmail**](CreateSmtpEmail.md)
|
|
1208
|
+
|
|
1209
|
+
### Authorization
|
|
1210
|
+
|
|
1211
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1212
|
+
|
|
1213
|
+
### HTTP request headers
|
|
1214
|
+
|
|
1215
|
+
- **Content-Type**: application/json
|
|
1216
|
+
- **Accept**: application/json
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
# **smtp_blocked_contacts_email_delete**
|
|
1221
|
+
> smtp_blocked_contacts_email_delete(email)
|
|
1222
|
+
|
|
1223
|
+
Unblock or resubscribe a transactional contact
|
|
1224
|
+
|
|
1225
|
+
### Example
|
|
1226
|
+
```ruby
|
|
1227
|
+
# load the gem
|
|
1228
|
+
require 'brevo-ruby'
|
|
1229
|
+
# setup authorization
|
|
1230
|
+
BrevoRuby.configure do |config|
|
|
1231
|
+
# Configure API key authorization: api-key
|
|
1232
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1233
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1234
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1235
|
+
|
|
1236
|
+
# Configure API key authorization: partner-key
|
|
1237
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1238
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1239
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1240
|
+
end
|
|
1241
|
+
|
|
1242
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
1243
|
+
|
|
1244
|
+
email = 'email_example' # String | contact email (urlencoded) to unblock.
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
begin
|
|
1248
|
+
#Unblock or resubscribe a transactional contact
|
|
1249
|
+
api_instance.smtp_blocked_contacts_email_delete(email)
|
|
1250
|
+
rescue BrevoRuby::ApiError => e
|
|
1251
|
+
puts "Exception when calling TransactionalEmailsApi->smtp_blocked_contacts_email_delete: #{e}"
|
|
1252
|
+
end
|
|
1253
|
+
```
|
|
1254
|
+
|
|
1255
|
+
### Parameters
|
|
1256
|
+
|
|
1257
|
+
Name | Type | Description | Notes
|
|
1258
|
+
------------- | ------------- | ------------- | -------------
|
|
1259
|
+
**email** | **String**| contact email (urlencoded) to unblock. |
|
|
1260
|
+
|
|
1261
|
+
### Return type
|
|
1262
|
+
|
|
1263
|
+
nil (empty response body)
|
|
1264
|
+
|
|
1265
|
+
### Authorization
|
|
1266
|
+
|
|
1267
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1268
|
+
|
|
1269
|
+
### HTTP request headers
|
|
1270
|
+
|
|
1271
|
+
- **Content-Type**: application/json
|
|
1272
|
+
- **Accept**: application/json
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
|
|
1276
|
+
# **smtp_log_message_id_delete**
|
|
1277
|
+
> smtp_log_message_id_delete(message_id)
|
|
1278
|
+
|
|
1279
|
+
Delete an SMTP transactional log
|
|
1280
|
+
|
|
1281
|
+
### Example
|
|
1282
|
+
```ruby
|
|
1283
|
+
# load the gem
|
|
1284
|
+
require 'brevo-ruby'
|
|
1285
|
+
# setup authorization
|
|
1286
|
+
BrevoRuby.configure do |config|
|
|
1287
|
+
# Configure API key authorization: api-key
|
|
1288
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1289
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1290
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1291
|
+
|
|
1292
|
+
# Configure API key authorization: partner-key
|
|
1293
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1294
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1295
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1296
|
+
end
|
|
1297
|
+
|
|
1298
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
1299
|
+
|
|
1300
|
+
message_id = 'message_id_example' # String | MessageId of the transactional log to delete
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
begin
|
|
1304
|
+
#Delete an SMTP transactional log
|
|
1305
|
+
api_instance.smtp_log_message_id_delete(message_id)
|
|
1306
|
+
rescue BrevoRuby::ApiError => e
|
|
1307
|
+
puts "Exception when calling TransactionalEmailsApi->smtp_log_message_id_delete: #{e}"
|
|
1308
|
+
end
|
|
1309
|
+
```
|
|
1310
|
+
|
|
1311
|
+
### Parameters
|
|
1312
|
+
|
|
1313
|
+
Name | Type | Description | Notes
|
|
1314
|
+
------------- | ------------- | ------------- | -------------
|
|
1315
|
+
**message_id** | **String**| MessageId of the transactional log to delete |
|
|
1316
|
+
|
|
1317
|
+
### Return type
|
|
1318
|
+
|
|
1319
|
+
nil (empty response body)
|
|
1320
|
+
|
|
1321
|
+
### Authorization
|
|
1322
|
+
|
|
1323
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1324
|
+
|
|
1325
|
+
### HTTP request headers
|
|
1326
|
+
|
|
1327
|
+
- **Content-Type**: application/json
|
|
1328
|
+
- **Accept**: application/json
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
# **update_smtp_template**
|
|
1333
|
+
> update_smtp_template(template_id, smtp_template)
|
|
1334
|
+
|
|
1335
|
+
Update an email template
|
|
1336
|
+
|
|
1337
|
+
### Example
|
|
1338
|
+
```ruby
|
|
1339
|
+
# load the gem
|
|
1340
|
+
require 'brevo-ruby'
|
|
1341
|
+
# setup authorization
|
|
1342
|
+
BrevoRuby.configure do |config|
|
|
1343
|
+
# Configure API key authorization: api-key
|
|
1344
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1345
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1346
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1347
|
+
|
|
1348
|
+
# Configure API key authorization: partner-key
|
|
1349
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1350
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1351
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1352
|
+
end
|
|
1353
|
+
|
|
1354
|
+
api_instance = BrevoRuby::TransactionalEmailsApi.new
|
|
1355
|
+
|
|
1356
|
+
template_id = 789 # Integer | id of the template
|
|
1357
|
+
|
|
1358
|
+
smtp_template = BrevoRuby::UpdateSmtpTemplate.new # UpdateSmtpTemplate | values to update in transactional email template
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
begin
|
|
1362
|
+
#Update an email template
|
|
1363
|
+
api_instance.update_smtp_template(template_id, smtp_template)
|
|
1364
|
+
rescue BrevoRuby::ApiError => e
|
|
1365
|
+
puts "Exception when calling TransactionalEmailsApi->update_smtp_template: #{e}"
|
|
1366
|
+
end
|
|
1367
|
+
```
|
|
1368
|
+
|
|
1369
|
+
### Parameters
|
|
1370
|
+
|
|
1371
|
+
Name | Type | Description | Notes
|
|
1372
|
+
------------- | ------------- | ------------- | -------------
|
|
1373
|
+
**template_id** | **Integer**| id of the template |
|
|
1374
|
+
**smtp_template** | [**UpdateSmtpTemplate**](UpdateSmtpTemplate.md)| values to update in transactional email template |
|
|
1375
|
+
|
|
1376
|
+
### Return type
|
|
1377
|
+
|
|
1378
|
+
nil (empty response body)
|
|
1379
|
+
|
|
1380
|
+
### Authorization
|
|
1381
|
+
|
|
1382
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1383
|
+
|
|
1384
|
+
### HTTP request headers
|
|
1385
|
+
|
|
1386
|
+
- **Content-Type**: application/json
|
|
1387
|
+
- **Accept**: application/json
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
|