brevo 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/LICENSE.md +21 -0
- data/README.md +655 -0
- data/Rakefile +8 -0
- data/brevo.gemspec +46 -0
- data/docs/AbTestCampaignResult.md +15 -0
- data/docs/AbTestCampaignResultClickedLinks.md +9 -0
- data/docs/AbTestCampaignResultStatistics.md +13 -0
- data/docs/AbTestVersionClicks.md +7 -0
- data/docs/AbTestVersionClicksInner.md +10 -0
- data/docs/AbTestVersionStats.md +9 -0
- data/docs/AccountApi.md +125 -0
- data/docs/AddChildDomain.md +8 -0
- data/docs/AddContactToList.md +9 -0
- data/docs/AddCredits.md +9 -0
- data/docs/AuthenticateDomainModel.md +9 -0
- data/docs/BlockDomain.md +8 -0
- data/docs/Body.md +10 -0
- data/docs/Body1.md +10 -0
- data/docs/Body10.md +11 -0
- data/docs/Body11.md +8 -0
- data/docs/Body12.md +11 -0
- data/docs/Body2.md +11 -0
- data/docs/Body3.md +9 -0
- data/docs/Body4.md +9 -0
- data/docs/Body5.md +11 -0
- data/docs/Body6.md +18 -0
- data/docs/Body7.md +17 -0
- data/docs/Body8.md +13 -0
- data/docs/Body9.md +8 -0
- data/docs/BodyVariablesItems.md +7 -0
- data/docs/CompaniesApi.md +425 -0
- data/docs/CompaniesList.md +8 -0
- data/docs/Company.md +11 -0
- data/docs/CompanyAttributes.md +7 -0
- data/docs/CompanyAttributesInner.md +12 -0
- data/docs/ComponentItems.md +9 -0
- data/docs/ContactsApi.md +1767 -0
- data/docs/ConversationsApi.md +542 -0
- data/docs/ConversationsMessage.md +17 -0
- data/docs/ConversationsMessageFile.md +12 -0
- data/docs/ConversationsMessageFileImageInfo.md +10 -0
- data/docs/CouponsApi.md +305 -0
- data/docs/CreateApiKeyRequest.md +9 -0
- data/docs/CreateApiKeyResponse.md +9 -0
- data/docs/CreateAttribute.md +11 -0
- data/docs/CreateAttributeEnumeration.md +9 -0
- data/docs/CreateCategoryModel.md +8 -0
- data/docs/CreateChild.md +13 -0
- data/docs/CreateContact.md +15 -0
- data/docs/CreateCouponCollection.md +9 -0
- data/docs/CreateCoupons.md +9 -0
- data/docs/CreateDoiContact.md +13 -0
- data/docs/CreateDomain.md +8 -0
- data/docs/CreateDomainModel.md +11 -0
- data/docs/CreateDomainModelDnsRecords.md +9 -0
- data/docs/CreateDomainModelDnsRecordsDkimRecord.md +11 -0
- data/docs/CreateEmailCampaign.md +38 -0
- data/docs/CreateEmailCampaignRecipients.md +10 -0
- data/docs/CreateEmailCampaignSender.md +10 -0
- data/docs/CreateExternalFeed.md +16 -0
- data/docs/CreateList.md +9 -0
- data/docs/CreateModel.md +8 -0
- data/docs/CreateProductModel.md +8 -0
- data/docs/CreateReseller.md +9 -0
- data/docs/CreateSender.md +10 -0
- data/docs/CreateSenderIps.md +10 -0
- data/docs/CreateSenderModel.md +10 -0
- data/docs/CreateSmsCampaign.md +15 -0
- data/docs/CreateSmsCampaignRecipients.md +9 -0
- data/docs/CreateSmtpEmail.md +9 -0
- data/docs/CreateSmtpTemplate.md +17 -0
- data/docs/CreateSmtpTemplateSender.md +10 -0
- data/docs/CreateSubAccount.md +11 -0
- data/docs/CreateSubAccountResponse.md +8 -0
- data/docs/CreateUpdateBatchCategory.md +9 -0
- data/docs/CreateUpdateBatchCategoryModel.md +9 -0
- data/docs/CreateUpdateBatchProducts.md +9 -0
- data/docs/CreateUpdateBatchProductsModel.md +9 -0
- data/docs/CreateUpdateCategories.md +11 -0
- data/docs/CreateUpdateCategory.md +12 -0
- data/docs/CreateUpdateContactModel.md +8 -0
- data/docs/CreateUpdateFolder.md +8 -0
- data/docs/CreateUpdateProduct.md +18 -0
- data/docs/CreateUpdateProducts.md +17 -0
- data/docs/CreateWebhook.md +12 -0
- data/docs/CreateWhatsAppCampaign.md +11 -0
- data/docs/CreateWhatsAppCampaignRecipients.md +10 -0
- data/docs/CreateWhatsAppTemplate.md +13 -0
- data/docs/CreatedBatchId.md +8 -0
- data/docs/CreatedProcessId.md +8 -0
- data/docs/Deal.md +11 -0
- data/docs/DealAttributes.md +7 -0
- data/docs/DealAttributesInner.md +12 -0
- data/docs/DealsApi.md +588 -0
- data/docs/DealsList.md +8 -0
- data/docs/DeleteHardbounces.md +10 -0
- data/docs/DomainsApi.md +292 -0
- data/docs/EcommerceApi.md +675 -0
- data/docs/EmailCampaignsApi.md +801 -0
- data/docs/EmailExportRecipients.md +9 -0
- data/docs/ErrorModel.md +9 -0
- data/docs/ExportWebhooksHistory.md +16 -0
- data/docs/ExternalFeedsApi.md +322 -0
- data/docs/FileData.md +14 -0
- data/docs/FileDownloadableLink.md +8 -0
- data/docs/FileList.md +7 -0
- data/docs/FilesApi.md +318 -0
- data/docs/GetAccount.md +15 -0
- data/docs/GetAccountActivity.md +8 -0
- data/docs/GetAccountActivityLogs.md +12 -0
- data/docs/GetAccountMarketingAutomation.md +9 -0
- data/docs/GetAccountPlan.md +13 -0
- data/docs/GetAccountRelay.md +9 -0
- data/docs/GetAccountRelayData.md +10 -0
- data/docs/GetAggregatedReport.md +20 -0
- data/docs/GetAllExternalFeeds.md +9 -0
- data/docs/GetAllExternalFeedsFeeds.md +19 -0
- data/docs/GetAttributes.md +8 -0
- data/docs/GetAttributesAttributes.md +12 -0
- data/docs/GetAttributesEnumeration.md +9 -0
- data/docs/GetBlockedDomains.md +8 -0
- data/docs/GetCampaignOverview.md +21 -0
- data/docs/GetCampaignRecipients.md +9 -0
- data/docs/GetCampaignStats.md +23 -0
- data/docs/GetCategories.md +9 -0
- data/docs/GetCategoryDetails.md +13 -0
- data/docs/GetChildAccountCreationStatus.md +8 -0
- data/docs/GetChildDomain.md +9 -0
- data/docs/GetChildDomains.md +7 -0
- data/docs/GetChildInfo.md +16 -0
- data/docs/GetChildInfoApiKeys.md +9 -0
- data/docs/GetChildInfoApiKeysV2.md +9 -0
- data/docs/GetChildInfoApiKeysV3.md +9 -0
- data/docs/GetChildInfoCredits.md +9 -0
- data/docs/GetChildInfoStatistics.md +10 -0
- data/docs/GetChildrenList.md +9 -0
- data/docs/GetClient.md +11 -0
- data/docs/GetContactCampaignStats.md +16 -0
- data/docs/GetContactCampaignStatsClicked.md +9 -0
- data/docs/GetContactCampaignStatsOpened.md +11 -0
- data/docs/GetContactCampaignStatsTransacAttributes.md +10 -0
- data/docs/GetContactCampaignStatsUnsubscriptions.md +9 -0
- data/docs/GetContactDetails.md +16 -0
- data/docs/GetContacts.md +9 -0
- data/docs/GetCouponCollection.md +13 -0
- data/docs/GetDeviceBrowserStats.md +11 -0
- data/docs/GetDomainConfigurationModel.md +11 -0
- data/docs/GetDomainsList.md +8 -0
- data/docs/GetDomainsListDomains.md +12 -0
- data/docs/GetEmailCampaign.md +39 -0
- data/docs/GetEmailCampaigns.md +9 -0
- data/docs/GetEmailEventReport.md +8 -0
- data/docs/GetEmailEventReportEvents.md +18 -0
- data/docs/GetExtendedCampaignOverview.md +37 -0
- data/docs/GetExtendedCampaignOverviewSender.md +10 -0
- data/docs/GetExtendedCampaignStats.md +15 -0
- data/docs/GetExtendedCampaignStatsGlobalStats.md +7 -0
- data/docs/GetExtendedClient.md +12 -0
- data/docs/GetExtendedClientAddress.md +11 -0
- data/docs/GetExtendedContactDetails.md +17 -0
- data/docs/GetExtendedContactDetailsStatistics.md +16 -0
- data/docs/GetExtendedContactDetailsStatisticsClicked.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsDelivered.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsLinks.md +11 -0
- data/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsOpened.md +11 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +9 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +10 -0
- data/docs/GetExtendedList.md +16 -0
- data/docs/GetExtendedListCampaignStats.md +9 -0
- data/docs/GetExternalFeedByUUID.md +19 -0
- data/docs/GetExternalFeedByUUIDHeaders.md +9 -0
- data/docs/GetFolder.md +12 -0
- data/docs/GetFolderLists.md +9 -0
- data/docs/GetFolders.md +9 -0
- data/docs/GetInboundEmailEvents.md +8 -0
- data/docs/GetInboundEmailEventsByUuid.md +15 -0
- data/docs/GetInboundEmailEventsByUuidAttachments.md +11 -0
- data/docs/GetInboundEmailEventsByUuidLogs.md +9 -0
- data/docs/GetInboundEmailEventsEvents.md +11 -0
- data/docs/GetInvitedUsersList.md +8 -0
- data/docs/GetInvitedUsersListFeatureAccess.md +10 -0
- data/docs/GetInvitedUsersListUsers.md +11 -0
- data/docs/GetIp.md +11 -0
- data/docs/GetIpFromSender.md +11 -0
- data/docs/GetIps.md +8 -0
- data/docs/GetIpsFromSender.md +8 -0
- data/docs/GetList.md +12 -0
- data/docs/GetLists.md +9 -0
- data/docs/GetProcess.md +11 -0
- data/docs/GetProcesses.md +9 -0
- data/docs/GetProductDetails.md +22 -0
- data/docs/GetProducts.md +9 -0
- data/docs/GetReports.md +8 -0
- data/docs/GetReportsReports.md +20 -0
- data/docs/GetScheduledEmailByBatchId.md +9 -0
- data/docs/GetScheduledEmailByBatchIdBatches.md +10 -0
- data/docs/GetScheduledEmailByMessageId.md +10 -0
- data/docs/GetSegments.md +9 -0
- data/docs/GetSegmentsSegments.md +11 -0
- data/docs/GetSendersList.md +8 -0
- data/docs/GetSendersListIps.md +10 -0
- data/docs/GetSendersListSenders.md +12 -0
- data/docs/GetSharedTemplateUrl.md +8 -0
- data/docs/GetSmsCampaign.md +17 -0
- data/docs/GetSmsCampaignOverview.md +15 -0
- data/docs/GetSmsCampaignRecipients.md +7 -0
- data/docs/GetSmsCampaignStats.md +14 -0
- data/docs/GetSmsCampaigns.md +9 -0
- data/docs/GetSmsEventReport.md +8 -0
- data/docs/GetSmsEventReportEvents.md +14 -0
- data/docs/GetSmtpTemplateOverview.md +20 -0
- data/docs/GetSmtpTemplateOverviewSender.md +10 -0
- data/docs/GetSmtpTemplates.md +9 -0
- data/docs/GetSsoToken.md +8 -0
- data/docs/GetStatsByBrowser.md +7 -0
- data/docs/GetStatsByDevice.md +11 -0
- data/docs/GetStatsByDomain.md +7 -0
- data/docs/GetTransacAggregatedSmsReport.md +17 -0
- data/docs/GetTransacBlockedContacts.md +9 -0
- data/docs/GetTransacBlockedContactsContacts.md +11 -0
- data/docs/GetTransacBlockedContactsReason.md +9 -0
- data/docs/GetTransacEmailContent.md +14 -0
- data/docs/GetTransacEmailContentEvents.md +9 -0
- data/docs/GetTransacEmailsList.md +9 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +15 -0
- data/docs/GetTransacSmsReport.md +8 -0
- data/docs/GetTransacSmsReportReports.md +17 -0
- data/docs/GetUserPermission.md +10 -0
- data/docs/GetUserPermissionPrivileges.md +9 -0
- data/docs/GetWATemplates.md +9 -0
- data/docs/GetWATemplatesTemplates.md +15 -0
- data/docs/GetWebhook.md +14 -0
- data/docs/GetWebhooks.md +8 -0
- data/docs/GetWhatsAppConfig.md +13 -0
- data/docs/GetWhatsappCampaignOverview.md +16 -0
- data/docs/GetWhatsappCampaigns.md +9 -0
- data/docs/GetWhatsappCampaignsCampaigns.md +18 -0
- data/docs/GetWhatsappEventReport.md +8 -0
- data/docs/GetWhatsappEventReportEvents.md +15 -0
- data/docs/InboundParsingApi.md +199 -0
- data/docs/InlineResponse200.md +8 -0
- data/docs/InlineResponse2001.md +10 -0
- data/docs/InlineResponse201.md +8 -0
- data/docs/InlineResponse2011.md +8 -0
- data/docs/InlineResponse2012.md +8 -0
- data/docs/InlineResponse2013.md +8 -0
- data/docs/InlineResponse2014.md +8 -0
- data/docs/ManageIp.md +8 -0
- data/docs/MasterAccountApi.md +611 -0
- data/docs/MasterDetailsResponse.md +14 -0
- data/docs/MasterDetailsResponseBillingInfo.md +11 -0
- data/docs/MasterDetailsResponseBillingInfoAddress.md +12 -0
- data/docs/MasterDetailsResponseBillingInfoName.md +9 -0
- data/docs/MasterDetailsResponsePlanInfo.md +13 -0
- data/docs/MasterDetailsResponsePlanInfoFeatures.md +12 -0
- data/docs/Note.md +14 -0
- data/docs/NoteData.md +11 -0
- data/docs/NoteId.md +8 -0
- data/docs/NoteList.md +7 -0
- data/docs/NotesApi.md +312 -0
- data/docs/Order.md +16 -0
- data/docs/OrderBatch.md +9 -0
- data/docs/OrderBilling.md +14 -0
- data/docs/OrderProducts.md +11 -0
- data/docs/Otp.md +8 -0
- data/docs/Pipeline.md +10 -0
- data/docs/PipelineStage.md +9 -0
- data/docs/Pipelines.md +7 -0
- data/docs/PostContactInfo.md +8 -0
- data/docs/PostContactInfoContacts.md +11 -0
- data/docs/PostSendFailed.md +12 -0
- data/docs/PostSendSmsTestFailed.md +11 -0
- data/docs/ProcessApi.md +129 -0
- data/docs/RemainingCreditModel.md +9 -0
- data/docs/RemainingCreditModelChild.md +9 -0
- data/docs/RemainingCreditModelReseller.md +9 -0
- data/docs/RemoveContactFromList.md +10 -0
- data/docs/RemoveCredits.md +9 -0
- data/docs/RequestContactExport.md +10 -0
- data/docs/RequestContactExportCustomContactFilter.md +13 -0
- data/docs/RequestContactImport.md +17 -0
- data/docs/RequestContactImportJsonBody.md +9 -0
- data/docs/RequestContactImportNewList.md +9 -0
- data/docs/RequestSMSRecipientExport.md +9 -0
- data/docs/ResellerApi.md +964 -0
- data/docs/SMSCampaignsApi.md +613 -0
- data/docs/ScheduleSmtpEmail.md +10 -0
- data/docs/SendReport.md +9 -0
- data/docs/SendReportEmail.md +9 -0
- data/docs/SendSms.md +12 -0
- data/docs/SendSmtpEmail.md +23 -0
- data/docs/SendSmtpEmailAttachment.md +10 -0
- data/docs/SendSmtpEmailBcc.md +9 -0
- data/docs/SendSmtpEmailCc.md +9 -0
- data/docs/SendSmtpEmailMessageVersions.md +13 -0
- data/docs/SendSmtpEmailReplyTo.md +9 -0
- data/docs/SendSmtpEmailReplyTo1.md +9 -0
- data/docs/SendSmtpEmailSender.md +10 -0
- data/docs/SendSmtpEmailTo.md +9 -0
- data/docs/SendSmtpEmailTo1.md +9 -0
- data/docs/SendTestEmail.md +8 -0
- data/docs/SendTestSms.md +8 -0
- data/docs/SendTransacSms.md +15 -0
- data/docs/SendWhatsappMessage.md +11 -0
- data/docs/SendersApi.md +417 -0
- data/docs/SsoTokenRequest.md +11 -0
- data/docs/SubAccountAppsToggleRequest.md +20 -0
- data/docs/SubAccountDetailsResponse.md +11 -0
- data/docs/SubAccountDetailsResponsePlanInfo.md +10 -0
- data/docs/SubAccountDetailsResponsePlanInfoCredits.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeatures.md +10 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +9 -0
- data/docs/SubAccountUpdatePlanRequest.md +9 -0
- data/docs/SubAccountUpdatePlanRequestCredits.md +8 -0
- data/docs/SubAccountUpdatePlanRequestFeatures.md +10 -0
- data/docs/SubAccountsResponse.md +9 -0
- data/docs/SubAccountsResponseSubAccounts.md +11 -0
- data/docs/Task.md +13 -0
- data/docs/TaskList.md +8 -0
- data/docs/TaskReminder.md +10 -0
- data/docs/TaskTypes.md +9 -0
- data/docs/TasksApi.md +376 -0
- data/docs/TransactionalEmailsApi.md +1390 -0
- data/docs/TransactionalSMSApi.md +273 -0
- data/docs/TransactionalWhatsAppApi.md +143 -0
- data/docs/UpdateAttribute.md +9 -0
- data/docs/UpdateAttributeEnumeration.md +9 -0
- data/docs/UpdateBatchContacts.md +8 -0
- data/docs/UpdateBatchContactsContacts.md +17 -0
- data/docs/UpdateBatchContactsModel.md +9 -0
- data/docs/UpdateCampaignStatus.md +8 -0
- data/docs/UpdateChild.md +12 -0
- data/docs/UpdateChildAccountStatus.md +11 -0
- data/docs/UpdateChildDomain.md +8 -0
- data/docs/UpdateContact.md +14 -0
- data/docs/UpdateCouponCollection.md +8 -0
- data/docs/UpdateEmailCampaign.md +38 -0
- data/docs/UpdateEmailCampaignRecipients.md +10 -0
- data/docs/UpdateEmailCampaignSender.md +10 -0
- data/docs/UpdateExternalFeed.md +16 -0
- data/docs/UpdateList.md +9 -0
- data/docs/UpdateSender.md +10 -0
- data/docs/UpdateSmsCampaign.md +15 -0
- data/docs/UpdateSmtpTemplate.md +17 -0
- data/docs/UpdateSmtpTemplateSender.md +10 -0
- data/docs/UpdateWebhook.md +11 -0
- data/docs/UpdateWhatsAppCampaign.md +11 -0
- data/docs/UploadImageModel.md +8 -0
- data/docs/UploadImageToGallery.md +9 -0
- data/docs/UserApi.md +118 -0
- data/docs/VariablesItems.md +10 -0
- data/docs/WebhooksApi.md +362 -0
- data/docs/WhatsAppCampaignsApi.md +543 -0
- data/docs/WhatsappCampStats.md +12 -0
- data/docs/WhatsappCampTemplate.md +18 -0
- data/lib/brevo/api/account_api.rb +145 -0
- data/lib/brevo/api/companies_api.rb +419 -0
- data/lib/brevo/api/contacts_api.rb +1735 -0
- data/lib/brevo/api/conversations_api.rb +514 -0
- data/lib/brevo/api/coupons_api.rb +316 -0
- data/lib/brevo/api/deals_api.rb +564 -0
- data/lib/brevo/api/domains_api.rb +282 -0
- data/lib/brevo/api/ecommerce_api.rb +655 -0
- data/lib/brevo/api/email_campaigns_api.rb +785 -0
- data/lib/brevo/api/external_feeds_api.rb +336 -0
- data/lib/brevo/api/files_api.rb +323 -0
- data/lib/brevo/api/inbound_parsing_api.rb +218 -0
- data/lib/brevo/api/master_account_api.rb +594 -0
- data/lib/brevo/api/notes_api.rb +318 -0
- data/lib/brevo/api/process_api.rb +151 -0
- data/lib/brevo/api/reseller_api.rb +923 -0
- data/lib/brevo/api/senders_api.rb +388 -0
- data/lib/brevo/api/sms_campaigns_api.rb +603 -0
- data/lib/brevo/api/tasks_api.rb +385 -0
- data/lib/brevo/api/transactional_emails_api.rb +1370 -0
- data/lib/brevo/api/transactional_sms_api.rb +290 -0
- data/lib/brevo/api/transactional_whats_app_api.rb +173 -0
- data/lib/brevo/api/user_api.rb +131 -0
- data/lib/brevo/api/webhooks_api.rb +357 -0
- data/lib/brevo/api/whats_app_campaigns_api.rb +534 -0
- data/lib/brevo/api_client.rb +392 -0
- data/lib/brevo/api_error.rb +38 -0
- data/lib/brevo/configuration.rb +216 -0
- data/lib/brevo/models/ab_test_campaign_result.rb +299 -0
- data/lib/brevo/models/ab_test_campaign_result_clicked_links.rb +203 -0
- data/lib/brevo/models/ab_test_campaign_result_statistics.rb +259 -0
- data/lib/brevo/models/ab_test_version_clicks.rb +176 -0
- data/lib/brevo/models/ab_test_version_clicks_inner.rb +220 -0
- data/lib/brevo/models/ab_test_version_stats.rb +206 -0
- data/lib/brevo/models/add_child_domain.rb +185 -0
- data/lib/brevo/models/add_contact_to_list.rb +199 -0
- data/lib/brevo/models/add_credits.rb +195 -0
- data/lib/brevo/models/authenticate_domain_model.rb +205 -0
- data/lib/brevo/models/block_domain.rb +190 -0
- data/lib/brevo/models/body.rb +210 -0
- data/lib/brevo/models/body_1.rb +205 -0
- data/lib/brevo/models/body_10.rb +225 -0
- data/lib/brevo/models/body_11.rb +190 -0
- data/lib/brevo/models/body_12.rb +215 -0
- data/lib/brevo/models/body_2.rb +223 -0
- data/lib/brevo/models/body_3.rb +200 -0
- data/lib/brevo/models/body_4.rb +195 -0
- data/lib/brevo/models/body_5.rb +223 -0
- data/lib/brevo/models/body_6.rb +320 -0
- data/lib/brevo/models/body_7.rb +281 -0
- data/lib/brevo/models/body_8.rb +245 -0
- data/lib/brevo/models/body_9.rb +190 -0
- data/lib/brevo/models/body_variables_items.rb +175 -0
- data/lib/brevo/models/companies_list.rb +188 -0
- data/lib/brevo/models/company.rb +220 -0
- data/lib/brevo/models/company_attributes.rb +176 -0
- data/lib/brevo/models/company_attributes_inner.rb +223 -0
- data/lib/brevo/models/component_items.rb +193 -0
- data/lib/brevo/models/conversations_message.rb +324 -0
- data/lib/brevo/models/conversations_message_file.rb +239 -0
- data/lib/brevo/models/conversations_message_file_image_info.rb +236 -0
- data/lib/brevo/models/create_api_key_request.rb +200 -0
- data/lib/brevo/models/create_api_key_response.rb +195 -0
- data/lib/brevo/models/create_attribute.rb +251 -0
- data/lib/brevo/models/create_attribute_enumeration.rb +205 -0
- data/lib/brevo/models/create_category_model.rb +185 -0
- data/lib/brevo/models/create_child.rb +294 -0
- data/lib/brevo/models/create_contact.rb +261 -0
- data/lib/brevo/models/create_coupon_collection.rb +205 -0
- data/lib/brevo/models/create_coupons.rb +206 -0
- data/lib/brevo/models/create_doi_contact.rb +259 -0
- data/lib/brevo/models/create_domain.rb +190 -0
- data/lib/brevo/models/create_domain_model.rb +219 -0
- data/lib/brevo/models/create_domain_model_dns_records.rb +193 -0
- data/lib/brevo/models/create_domain_model_dns_records_dkim_record.rb +211 -0
- data/lib/brevo/models/create_email_campaign.rb +607 -0
- data/lib/brevo/models/create_email_campaign_recipients.rb +212 -0
- data/lib/brevo/models/create_email_campaign_sender.rb +211 -0
- data/lib/brevo/models/create_external_feed.rb +339 -0
- data/lib/brevo/models/create_list.rb +205 -0
- data/lib/brevo/models/create_model.rb +190 -0
- data/lib/brevo/models/create_product_model.rb +185 -0
- data/lib/brevo/models/create_reseller.rb +200 -0
- data/lib/brevo/models/create_sender.rb +217 -0
- data/lib/brevo/models/create_sender_ips.rb +239 -0
- data/lib/brevo/models/create_sender_model.rb +210 -0
- data/lib/brevo/models/create_sms_campaign.rb +290 -0
- data/lib/brevo/models/create_sms_campaign_recipients.rb +204 -0
- data/lib/brevo/models/create_smtp_email.rb +196 -0
- data/lib/brevo/models/create_smtp_template.rb +289 -0
- data/lib/brevo/models/create_smtp_template_sender.rb +206 -0
- data/lib/brevo/models/create_sub_account.rb +259 -0
- data/lib/brevo/models/create_sub_account_response.rb +190 -0
- data/lib/brevo/models/create_update_batch_category.rb +202 -0
- data/lib/brevo/models/create_update_batch_category_model.rb +195 -0
- data/lib/brevo/models/create_update_batch_products.rb +202 -0
- data/lib/brevo/models/create_update_batch_products_model.rb +195 -0
- data/lib/brevo/models/create_update_categories.rb +220 -0
- data/lib/brevo/models/create_update_category.rb +232 -0
- data/lib/brevo/models/create_update_contact_model.rb +185 -0
- data/lib/brevo/models/create_update_folder.rb +185 -0
- data/lib/brevo/models/create_update_product.rb +301 -0
- data/lib/brevo/models/create_update_products.rb +289 -0
- data/lib/brevo/models/create_webhook.rb +273 -0
- data/lib/brevo/models/create_whats_app_campaign.rb +234 -0
- data/lib/brevo/models/create_whats_app_campaign_recipients.rb +212 -0
- data/lib/brevo/models/create_whats_app_template.rb +289 -0
- data/lib/brevo/models/created_batch_id.rb +190 -0
- data/lib/brevo/models/created_process_id.rb +190 -0
- data/lib/brevo/models/deal.rb +220 -0
- data/lib/brevo/models/deal_attributes.rb +176 -0
- data/lib/brevo/models/deal_attributes_inner.rb +223 -0
- data/lib/brevo/models/deals_list.rb +188 -0
- data/lib/brevo/models/delete_hardbounces.rb +205 -0
- data/lib/brevo/models/email_export_recipients.rb +234 -0
- data/lib/brevo/models/error_model.rb +239 -0
- data/lib/brevo/models/export_webhooks_history.rb +309 -0
- data/lib/brevo/models/file_data.rb +246 -0
- data/lib/brevo/models/file_downloadable_link.rb +190 -0
- data/lib/brevo/models/file_list.rb +176 -0
- data/lib/brevo/models/get_account.rb +289 -0
- data/lib/brevo/models/get_account_activity.rb +187 -0
- data/lib/brevo/models/get_account_activity_logs.rb +250 -0
- data/lib/brevo/models/get_account_marketing_automation.rb +200 -0
- data/lib/brevo/models/get_account_plan.rb +296 -0
- data/lib/brevo/models/get_account_relay.rb +205 -0
- data/lib/brevo/models/get_account_relay_data.rb +221 -0
- data/lib/brevo/models/get_aggregated_report.rb +305 -0
- data/lib/brevo/models/get_all_external_feeds.rb +196 -0
- data/lib/brevo/models/get_all_external_feeds_feeds.rb +404 -0
- data/lib/brevo/models/get_attributes.rb +192 -0
- data/lib/brevo/models/get_attributes_attributes.rb +283 -0
- data/lib/brevo/models/get_attributes_enumeration.rb +205 -0
- data/lib/brevo/models/get_blocked_domains.rb +193 -0
- data/lib/brevo/models/get_campaign_overview.rb +381 -0
- data/lib/brevo/models/get_campaign_recipients.rb +207 -0
- data/lib/brevo/models/get_campaign_stats.rb +390 -0
- data/lib/brevo/models/get_categories.rb +206 -0
- data/lib/brevo/models/get_category_details.rb +255 -0
- data/lib/brevo/models/get_child_account_creation_status.rb +190 -0
- data/lib/brevo/models/get_child_domain.rb +195 -0
- data/lib/brevo/models/get_child_domains.rb +175 -0
- data/lib/brevo/models/get_child_info.rb +289 -0
- data/lib/brevo/models/get_child_info_api_keys.rb +203 -0
- data/lib/brevo/models/get_child_info_api_keys_v2.rb +205 -0
- data/lib/brevo/models/get_child_info_api_keys_v3.rb +205 -0
- data/lib/brevo/models/get_child_info_credits.rb +196 -0
- data/lib/brevo/models/get_child_info_statistics.rb +206 -0
- data/lib/brevo/models/get_children_list.rb +197 -0
- data/lib/brevo/models/get_client.rb +235 -0
- data/lib/brevo/models/get_contact_campaign_stats.rb +273 -0
- data/lib/brevo/models/get_contact_campaign_stats_clicked.rb +206 -0
- data/lib/brevo/models/get_contact_campaign_stats_opened.rb +235 -0
- data/lib/brevo/models/get_contact_campaign_stats_transac_attributes.rb +220 -0
- data/lib/brevo/models/get_contact_campaign_stats_unsubscriptions.rb +209 -0
- data/lib/brevo/models/get_contact_details.rb +307 -0
- data/lib/brevo/models/get_contacts.rb +206 -0
- data/lib/brevo/models/get_coupon_collection.rb +265 -0
- data/lib/brevo/models/get_device_browser_stats.rb +235 -0
- data/lib/brevo/models/get_domain_configuration_model.rb +234 -0
- data/lib/brevo/models/get_domains_list.rb +187 -0
- data/lib/brevo/models/get_domains_list_domains.rb +245 -0
- data/lib/brevo/models/get_email_campaign.rb +608 -0
- data/lib/brevo/models/get_email_campaigns.rb +196 -0
- data/lib/brevo/models/get_email_event_report.rb +186 -0
- data/lib/brevo/models/get_email_event_report_events.rb +339 -0
- data/lib/brevo/models/get_extended_campaign_overview.rb +580 -0
- data/lib/brevo/models/get_extended_campaign_overview_sender.rb +205 -0
- data/lib/brevo/models/get_extended_campaign_stats.rb +295 -0
- data/lib/brevo/models/get_extended_campaign_stats_global_stats.rb +176 -0
- data/lib/brevo/models/get_extended_client.rb +249 -0
- data/lib/brevo/models/get_extended_client_address.rb +236 -0
- data/lib/brevo/models/get_extended_contact_details.rb +321 -0
- data/lib/brevo/models/get_extended_contact_details_statistics.rb +281 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_clicked.rb +207 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_delivered.rb +205 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_links.rb +235 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_messages_sent.rb +205 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_opened.rb +235 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_unsubscriptions.rb +210 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +200 -0
- data/lib/brevo/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +215 -0
- data/lib/brevo/models/get_extended_list.rb +301 -0
- data/lib/brevo/models/get_extended_list_campaign_stats.rb +204 -0
- data/lib/brevo/models/get_external_feed_by_uuid.rb +404 -0
- data/lib/brevo/models/get_external_feed_by_uuid_headers.rb +195 -0
- data/lib/brevo/models/get_folder.rb +250 -0
- data/lib/brevo/models/get_folder_lists.rb +196 -0
- data/lib/brevo/models/get_folders.rb +196 -0
- data/lib/brevo/models/get_inbound_email_events.rb +186 -0
- data/lib/brevo/models/get_inbound_email_events_by_uuid.rb +259 -0
- data/lib/brevo/models/get_inbound_email_events_by_uuid_attachments.rb +215 -0
- data/lib/brevo/models/get_inbound_email_events_by_uuid_logs.rb +229 -0
- data/lib/brevo/models/get_inbound_email_events_events.rb +235 -0
- data/lib/brevo/models/get_invited_users_list.rb +187 -0
- data/lib/brevo/models/get_invited_users_list_feature_access.rb +206 -0
- data/lib/brevo/models/get_invited_users_list_users.rb +234 -0
- data/lib/brevo/models/get_ip.rb +235 -0
- data/lib/brevo/models/get_ip_from_sender.rb +235 -0
- data/lib/brevo/models/get_ips.rb +192 -0
- data/lib/brevo/models/get_ips_from_sender.rb +192 -0
- data/lib/brevo/models/get_list.rb +250 -0
- data/lib/brevo/models/get_lists.rb +197 -0
- data/lib/brevo/models/get_process.rb +264 -0
- data/lib/brevo/models/get_processes.rb +197 -0
- data/lib/brevo/models/get_product_details.rb +357 -0
- data/lib/brevo/models/get_products.rb +206 -0
- data/lib/brevo/models/get_reports.rb +186 -0
- data/lib/brevo/models/get_reports_reports.rb +370 -0
- data/lib/brevo/models/get_scheduled_email_by_batch_id.rb +196 -0
- data/lib/brevo/models/get_scheduled_email_by_batch_id_batches.rb +254 -0
- data/lib/brevo/models/get_scheduled_email_by_message_id.rb +254 -0
- data/lib/brevo/models/get_segments.rb +194 -0
- data/lib/brevo/models/get_segments_segments.rb +215 -0
- data/lib/brevo/models/get_senders_list.rb +187 -0
- data/lib/brevo/models/get_senders_list_ips.rb +220 -0
- data/lib/brevo/models/get_senders_list_senders.rb +247 -0
- data/lib/brevo/models/get_shared_template_url.rb +190 -0
- data/lib/brevo/models/get_sms_campaign.rb +352 -0
- data/lib/brevo/models/get_sms_campaign_overview.rb +324 -0
- data/lib/brevo/models/get_sms_campaign_recipients.rb +175 -0
- data/lib/brevo/models/get_sms_campaign_stats.rb +280 -0
- data/lib/brevo/models/get_sms_campaigns.rb +196 -0
- data/lib/brevo/models/get_sms_event_report.rb +186 -0
- data/lib/brevo/models/get_sms_event_report_events.rb +278 -0
- data/lib/brevo/models/get_smtp_template_overview.rb +364 -0
- data/lib/brevo/models/get_smtp_template_overview_sender.rb +205 -0
- data/lib/brevo/models/get_smtp_templates.rb +196 -0
- data/lib/brevo/models/get_sso_token.rb +190 -0
- data/lib/brevo/models/get_stats_by_browser.rb +175 -0
- data/lib/brevo/models/get_stats_by_device.rb +223 -0
- data/lib/brevo/models/get_stats_by_domain.rb +175 -0
- data/lib/brevo/models/get_transac_aggregated_sms_report.rb +275 -0
- data/lib/brevo/models/get_transac_blocked_contacts.rb +196 -0
- data/lib/brevo/models/get_transac_blocked_contacts_contacts.rb +234 -0
- data/lib/brevo/models/get_transac_blocked_contacts_reason.rb +230 -0
- data/lib/brevo/models/get_transac_email_content.rb +277 -0
- data/lib/brevo/models/get_transac_email_content_events.rb +205 -0
- data/lib/brevo/models/get_transac_emails_list.rb +196 -0
- data/lib/brevo/models/get_transac_emails_list_transactional_emails.rb +282 -0
- data/lib/brevo/models/get_transac_sms_report.rb +186 -0
- data/lib/brevo/models/get_transac_sms_report_reports.rb +275 -0
- data/lib/brevo/models/get_user_permission.rb +223 -0
- data/lib/brevo/models/get_user_permission_privileges.rb +205 -0
- data/lib/brevo/models/get_wa_templates.rb +206 -0
- data/lib/brevo/models/get_wa_templates_templates.rb +290 -0
- data/lib/brevo/models/get_webhook.rb +315 -0
- data/lib/brevo/models/get_webhooks.rb +191 -0
- data/lib/brevo/models/get_whats_app_config.rb +281 -0
- data/lib/brevo/models/get_whatsapp_campaign_overview.rb +332 -0
- data/lib/brevo/models/get_whatsapp_campaigns.rb +196 -0
- data/lib/brevo/models/get_whatsapp_campaigns_campaigns.rb +353 -0
- data/lib/brevo/models/get_whatsapp_event_report.rb +186 -0
- data/lib/brevo/models/get_whatsapp_event_report_events.rb +314 -0
- data/lib/brevo/models/inline_response_200.rb +191 -0
- data/lib/brevo/models/inline_response_200_1.rb +220 -0
- data/lib/brevo/models/inline_response_201.rb +191 -0
- data/lib/brevo/models/inline_response_201_1.rb +191 -0
- data/lib/brevo/models/inline_response_201_2.rb +190 -0
- data/lib/brevo/models/inline_response_201_3.rb +190 -0
- data/lib/brevo/models/inline_response_201_4.rb +190 -0
- data/lib/brevo/models/manage_ip.rb +185 -0
- data/lib/brevo/models/master_details_response.rb +243 -0
- data/lib/brevo/models/master_details_response_billing_info.rb +214 -0
- data/lib/brevo/models/master_details_response_billing_info_address.rb +226 -0
- data/lib/brevo/models/master_details_response_billing_info_name.rb +196 -0
- data/lib/brevo/models/master_details_response_plan_info.rb +272 -0
- data/lib/brevo/models/master_details_response_plan_info_features.rb +225 -0
- data/lib/brevo/models/note.rb +283 -0
- data/lib/brevo/models/note_data.rb +255 -0
- data/lib/brevo/models/note_id.rb +186 -0
- data/lib/brevo/models/note_list.rb +176 -0
- data/lib/brevo/models/order.rb +297 -0
- data/lib/brevo/models/order_batch.rb +202 -0
- data/lib/brevo/models/order_billing.rb +246 -0
- data/lib/brevo/models/order_products.rb +231 -0
- data/lib/brevo/models/otp.rb +185 -0
- data/lib/brevo/models/pipeline.rb +208 -0
- data/lib/brevo/models/pipeline_stage.rb +196 -0
- data/lib/brevo/models/pipelines.rb +176 -0
- data/lib/brevo/models/post_contact_info.rb +189 -0
- data/lib/brevo/models/post_contact_info_contacts.rb +217 -0
- data/lib/brevo/models/post_send_failed.rb +238 -0
- data/lib/brevo/models/post_send_sms_test_failed.rb +227 -0
- data/lib/brevo/models/remaining_credit_model.rb +203 -0
- data/lib/brevo/models/remaining_credit_model_child.rb +206 -0
- data/lib/brevo/models/remaining_credit_model_reseller.rb +205 -0
- data/lib/brevo/models/remove_contact_from_list.rb +209 -0
- data/lib/brevo/models/remove_credits.rb +195 -0
- data/lib/brevo/models/request_contact_export.rb +211 -0
- data/lib/brevo/models/request_contact_export_custom_contact_filter.rb +294 -0
- data/lib/brevo/models/request_contact_import.rb +286 -0
- data/lib/brevo/models/request_contact_import_json_body.rb +194 -0
- data/lib/brevo/models/request_contact_import_new_list.rb +196 -0
- data/lib/brevo/models/request_sms_recipient_export.rb +234 -0
- data/lib/brevo/models/schedule_smtp_email.rb +206 -0
- data/lib/brevo/models/send_report.rb +235 -0
- data/lib/brevo/models/send_report_email.rb +208 -0
- data/lib/brevo/models/send_sms.rb +233 -0
- data/lib/brevo/models/send_smtp_email.rb +345 -0
- data/lib/brevo/models/send_smtp_email_attachment.rb +220 -0
- data/lib/brevo/models/send_smtp_email_bcc.rb +200 -0
- data/lib/brevo/models/send_smtp_email_cc.rb +200 -0
- data/lib/brevo/models/send_smtp_email_message_versions.rb +247 -0
- data/lib/brevo/models/send_smtp_email_reply_to.rb +201 -0
- data/lib/brevo/models/send_smtp_email_reply_to_1.rb +201 -0
- data/lib/brevo/models/send_smtp_email_sender.rb +206 -0
- data/lib/brevo/models/send_smtp_email_to.rb +200 -0
- data/lib/brevo/models/send_smtp_email_to_1.rb +200 -0
- data/lib/brevo/models/send_test_email.rb +187 -0
- data/lib/brevo/models/send_test_sms.rb +185 -0
- data/lib/brevo/models/send_transac_sms.rb +327 -0
- data/lib/brevo/models/send_whatsapp_message.rb +227 -0
- data/lib/brevo/models/sso_token_request.rb +254 -0
- data/lib/brevo/models/sub_account_apps_toggle_request.rb +306 -0
- data/lib/brevo/models/sub_account_details_response.rb +214 -0
- data/lib/brevo/models/sub_account_details_response_plan_info.rb +204 -0
- data/lib/brevo/models/sub_account_details_response_plan_info_credits.rb +195 -0
- data/lib/brevo/models/sub_account_details_response_plan_info_credits_emails.rb +196 -0
- data/lib/brevo/models/sub_account_details_response_plan_info_features.rb +203 -0
- data/lib/brevo/models/sub_account_details_response_plan_info_features_inbox.rb +196 -0
- data/lib/brevo/models/sub_account_details_response_plan_info_features_landing_page.rb +196 -0
- data/lib/brevo/models/sub_account_details_response_plan_info_features_users.rb +196 -0
- data/lib/brevo/models/sub_account_update_plan_request.rb +194 -0
- data/lib/brevo/models/sub_account_update_plan_request_credits.rb +186 -0
- data/lib/brevo/models/sub_account_update_plan_request_features.rb +206 -0
- data/lib/brevo/models/sub_accounts_response.rb +196 -0
- data/lib/brevo/models/sub_accounts_response_sub_accounts.rb +235 -0
- data/lib/brevo/models/task.rb +252 -0
- data/lib/brevo/models/task_list.rb +188 -0
- data/lib/brevo/models/task_reminder.rb +257 -0
- data/lib/brevo/models/task_types.rb +196 -0
- data/lib/brevo/models/update_attribute.rb +197 -0
- data/lib/brevo/models/update_attribute_enumeration.rb +205 -0
- data/lib/brevo/models/update_batch_contacts.rb +187 -0
- data/lib/brevo/models/update_batch_contacts_contacts.rb +283 -0
- data/lib/brevo/models/update_batch_contacts_model.rb +197 -0
- data/lib/brevo/models/update_campaign_status.rb +220 -0
- data/lib/brevo/models/update_child.rb +225 -0
- data/lib/brevo/models/update_child_account_status.rb +215 -0
- data/lib/brevo/models/update_child_domain.rb +185 -0
- data/lib/brevo/models/update_contact.rb +251 -0
- data/lib/brevo/models/update_coupon_collection.rb +190 -0
- data/lib/brevo/models/update_email_campaign.rb +597 -0
- data/lib/brevo/models/update_email_campaign_recipients.rb +212 -0
- data/lib/brevo/models/update_email_campaign_sender.rb +206 -0
- data/lib/brevo/models/update_external_feed.rb +327 -0
- data/lib/brevo/models/update_list.rb +195 -0
- data/lib/brevo/models/update_sender.rb +207 -0
- data/lib/brevo/models/update_sms_campaign.rb +271 -0
- data/lib/brevo/models/update_smtp_template.rb +274 -0
- data/lib/brevo/models/update_smtp_template_sender.rb +206 -0
- data/lib/brevo/models/update_webhook.rb +239 -0
- data/lib/brevo/models/update_whats_app_campaign.rb +250 -0
- data/lib/brevo/models/upload_image_model.rb +190 -0
- data/lib/brevo/models/upload_image_to_gallery.rb +200 -0
- data/lib/brevo/models/variables_items.rb +202 -0
- data/lib/brevo/models/whatsapp_camp_stats.rb +245 -0
- data/lib/brevo/models/whatsapp_camp_template.rb +287 -0
- data/lib/brevo/version.rb +15 -0
- data/lib/brevo.rb +395 -0
- data/spec/api/account_api_spec.rb +59 -0
- data/spec/api/companies_api_spec.rb +119 -0
- data/spec/api/contacts_api_spec.rb +387 -0
- data/spec/api/conversations_api_spec.rb +140 -0
- data/spec/api/coupons_api_spec.rb +93 -0
- data/spec/api/deals_api_spec.rb +151 -0
- data/spec/api/domains_api_spec.rb +89 -0
- data/spec/api/ecommerce_api_spec.rb +173 -0
- data/spec/api/email_campaigns_api_spec.rb +196 -0
- data/spec/api/external_feeds_api_spec.rb +102 -0
- data/spec/api/files_api_spec.rb +99 -0
- data/spec/api/inbound_parsing_api_spec.rb +76 -0
- data/spec/api/master_account_api_spec.rb +158 -0
- data/spec/api/notes_api_spec.rb +97 -0
- data/spec/api/process_api_spec.rb +59 -0
- data/spec/api/reseller_api_spec.rb +223 -0
- data/spec/api/senders_api_spec.rb +114 -0
- data/spec/api/sms_campaigns_api_spec.rb +157 -0
- data/spec/api/tasks_api_spec.rb +113 -0
- data/spec/api/transactional_emails_api_spec.rb +330 -0
- data/spec/api/transactional_sms_api_spec.rb +94 -0
- data/spec/api/transactional_whats_app_api_spec.rb +66 -0
- data/spec/api/user_api_spec.rb +56 -0
- data/spec/api/webhooks_api_spec.rb +104 -0
- data/spec/api/whats_app_campaigns_api_spec.rb +142 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
- data/spec/models/ab_test_campaign_result_spec.rb +91 -0
- data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
- data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
- data/spec/models/ab_test_version_clicks_spec.rb +35 -0
- data/spec/models/ab_test_version_stats_spec.rb +47 -0
- data/spec/models/add_child_domain_spec.rb +41 -0
- data/spec/models/add_contact_to_list_spec.rb +47 -0
- data/spec/models/add_credits_spec.rb +47 -0
- data/spec/models/authenticate_domain_model_spec.rb +47 -0
- data/spec/models/block_domain_spec.rb +41 -0
- data/spec/models/body_10_spec.rb +59 -0
- data/spec/models/body_11_spec.rb +41 -0
- data/spec/models/body_12_spec.rb +59 -0
- data/spec/models/body_1_spec.rb +53 -0
- data/spec/models/body_2_spec.rb +59 -0
- data/spec/models/body_3_spec.rb +47 -0
- data/spec/models/body_4_spec.rb +47 -0
- data/spec/models/body_5_spec.rb +59 -0
- data/spec/models/body_6_spec.rb +101 -0
- data/spec/models/body_7_spec.rb +95 -0
- data/spec/models/body_8_spec.rb +71 -0
- data/spec/models/body_9_spec.rb +41 -0
- data/spec/models/body_spec.rb +53 -0
- data/spec/models/body_variables_items_spec.rb +35 -0
- data/spec/models/companies_list_spec.rb +41 -0
- data/spec/models/company_attributes_inner_spec.rb +65 -0
- data/spec/models/company_attributes_spec.rb +35 -0
- data/spec/models/company_spec.rb +59 -0
- data/spec/models/component_items_spec.rb +47 -0
- data/spec/models/conversations_message_file_image_info_spec.rb +53 -0
- data/spec/models/conversations_message_file_spec.rb +65 -0
- data/spec/models/conversations_message_spec.rb +99 -0
- data/spec/models/create_api_key_request_spec.rb +47 -0
- data/spec/models/create_api_key_response_spec.rb +47 -0
- data/spec/models/create_attribute_enumeration_spec.rb +47 -0
- data/spec/models/create_attribute_spec.rb +63 -0
- data/spec/models/create_category_model_spec.rb +41 -0
- data/spec/models/create_child_spec.rb +75 -0
- data/spec/models/create_contact_spec.rb +83 -0
- data/spec/models/create_coupon_collection_spec.rb +47 -0
- data/spec/models/create_coupons_spec.rb +47 -0
- data/spec/models/create_doi_contact_spec.rb +71 -0
- data/spec/models/create_domain_model_dns_records_dkim_record_spec.rb +59 -0
- data/spec/models/create_domain_model_dns_records_spec.rb +47 -0
- data/spec/models/create_domain_model_spec.rb +59 -0
- data/spec/models/create_domain_spec.rb +41 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +53 -0
- data/spec/models/create_email_campaign_sender_spec.rb +53 -0
- data/spec/models/create_email_campaign_spec.rb +225 -0
- data/spec/models/create_external_feed_spec.rb +93 -0
- data/spec/models/create_list_spec.rb +47 -0
- data/spec/models/create_model_spec.rb +41 -0
- data/spec/models/create_product_model_spec.rb +41 -0
- data/spec/models/create_reseller_spec.rb +47 -0
- data/spec/models/create_sender_ips_spec.rb +53 -0
- data/spec/models/create_sender_model_spec.rb +53 -0
- data/spec/models/create_sender_spec.rb +53 -0
- data/spec/models/create_sms_campaign_recipients_spec.rb +47 -0
- data/spec/models/create_sms_campaign_spec.rb +83 -0
- data/spec/models/create_smtp_email_spec.rb +47 -0
- data/spec/models/create_smtp_template_sender_spec.rb +53 -0
- data/spec/models/create_smtp_template_spec.rb +95 -0
- data/spec/models/create_sub_account_response_spec.rb +41 -0
- data/spec/models/create_sub_account_spec.rb +63 -0
- data/spec/models/create_update_batch_category_model_spec.rb +47 -0
- data/spec/models/create_update_batch_category_spec.rb +47 -0
- data/spec/models/create_update_batch_products_model_spec.rb +47 -0
- data/spec/models/create_update_batch_products_spec.rb +47 -0
- data/spec/models/create_update_categories_spec.rb +59 -0
- data/spec/models/create_update_category_spec.rb +65 -0
- data/spec/models/create_update_contact_model_spec.rb +41 -0
- data/spec/models/create_update_folder_spec.rb +41 -0
- data/spec/models/create_update_product_spec.rb +101 -0
- data/spec/models/create_update_products_spec.rb +95 -0
- data/spec/models/create_webhook_spec.rb +73 -0
- data/spec/models/create_whats_app_campaign_recipients_spec.rb +53 -0
- data/spec/models/create_whats_app_campaign_spec.rb +59 -0
- data/spec/models/create_whats_app_template_spec.rb +75 -0
- data/spec/models/created_batch_id_spec.rb +41 -0
- data/spec/models/created_process_id_spec.rb +41 -0
- data/spec/models/deal_attributes_inner_spec.rb +65 -0
- data/spec/models/deal_attributes_spec.rb +35 -0
- data/spec/models/deal_spec.rb +59 -0
- data/spec/models/deals_list_spec.rb +41 -0
- data/spec/models/delete_hardbounces_spec.rb +53 -0
- data/spec/models/email_export_recipients_spec.rb +51 -0
- data/spec/models/error_model_spec.rb +51 -0
- data/spec/models/export_webhooks_history_spec.rb +93 -0
- data/spec/models/file_data_spec.rb +77 -0
- data/spec/models/file_downloadable_link_spec.rb +41 -0
- data/spec/models/file_list_spec.rb +35 -0
- data/spec/models/get_account_activity_logs_spec.rb +65 -0
- data/spec/models/get_account_activity_spec.rb +41 -0
- data/spec/models/get_account_marketing_automation_spec.rb +47 -0
- data/spec/models/get_account_plan_spec.rb +79 -0
- data/spec/models/get_account_relay_data_spec.rb +53 -0
- data/spec/models/get_account_relay_spec.rb +47 -0
- data/spec/models/get_account_spec.rb +83 -0
- data/spec/models/get_aggregated_report_spec.rb +113 -0
- data/spec/models/get_all_external_feeds_feeds_spec.rb +111 -0
- data/spec/models/get_all_external_feeds_spec.rb +47 -0
- data/spec/models/get_attributes_attributes_spec.rb +73 -0
- data/spec/models/get_attributes_enumeration_spec.rb +47 -0
- data/spec/models/get_attributes_spec.rb +41 -0
- data/spec/models/get_blocked_domains_spec.rb +41 -0
- data/spec/models/get_campaign_overview_spec.rb +127 -0
- data/spec/models/get_campaign_recipients_spec.rb +47 -0
- data/spec/models/get_campaign_stats_spec.rb +131 -0
- data/spec/models/get_categories_spec.rb +47 -0
- data/spec/models/get_category_details_spec.rb +71 -0
- data/spec/models/get_child_account_creation_status_spec.rb +41 -0
- data/spec/models/get_child_domain_spec.rb +47 -0
- data/spec/models/get_child_domains_spec.rb +35 -0
- data/spec/models/get_child_info_api_keys_spec.rb +47 -0
- data/spec/models/get_child_info_api_keys_v2_spec.rb +47 -0
- data/spec/models/get_child_info_api_keys_v3_spec.rb +47 -0
- data/spec/models/get_child_info_credits_spec.rb +47 -0
- data/spec/models/get_child_info_spec.rb +89 -0
- data/spec/models/get_child_info_statistics_spec.rb +53 -0
- data/spec/models/get_children_list_spec.rb +47 -0
- data/spec/models/get_client_spec.rb +59 -0
- data/spec/models/get_contact_campaign_stats_clicked_spec.rb +47 -0
- data/spec/models/get_contact_campaign_stats_opened_spec.rb +59 -0
- data/spec/models/get_contact_campaign_stats_spec.rb +89 -0
- data/spec/models/get_contact_campaign_stats_transac_attributes_spec.rb +53 -0
- data/spec/models/get_contact_campaign_stats_unsubscriptions_spec.rb +47 -0
- data/spec/models/get_contact_details_spec.rb +89 -0
- data/spec/models/get_contacts_spec.rb +47 -0
- data/spec/models/get_coupon_collection_spec.rb +71 -0
- data/spec/models/get_device_browser_stats_spec.rb +59 -0
- data/spec/models/get_domain_configuration_model_spec.rb +59 -0
- data/spec/models/get_domains_list_domains_spec.rb +65 -0
- data/spec/models/get_domains_list_spec.rb +41 -0
- data/spec/models/get_email_campaign_spec.rb +235 -0
- data/spec/models/get_email_campaigns_spec.rb +47 -0
- data/spec/models/get_email_event_report_events_spec.rb +105 -0
- data/spec/models/get_email_event_report_spec.rb +41 -0
- data/spec/models/get_extended_campaign_overview_sender_spec.rb +53 -0
- data/spec/models/get_extended_campaign_overview_spec.rb +223 -0
- data/spec/models/get_extended_campaign_stats_global_stats_spec.rb +35 -0
- data/spec/models/get_extended_campaign_stats_spec.rb +83 -0
- data/spec/models/get_extended_client_address_spec.rb +59 -0
- data/spec/models/get_extended_client_spec.rb +65 -0
- data/spec/models/get_extended_contact_details_spec.rb +95 -0
- data/spec/models/get_extended_contact_details_statistics_clicked_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_delivered_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_links_spec.rb +59 -0
- data/spec/models/get_extended_contact_details_statistics_messages_sent_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +59 -0
- data/spec/models/get_extended_contact_details_statistics_spec.rb +89 -0
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb +53 -0
- data/spec/models/get_extended_list_campaign_stats_spec.rb +47 -0
- data/spec/models/get_extended_list_spec.rb +89 -0
- data/spec/models/get_external_feed_by_uuid_headers_spec.rb +47 -0
- data/spec/models/get_external_feed_by_uuid_spec.rb +111 -0
- data/spec/models/get_folder_lists_spec.rb +47 -0
- data/spec/models/get_folder_spec.rb +65 -0
- data/spec/models/get_folders_spec.rb +47 -0
- data/spec/models/get_inbound_email_events_by_uuid_attachments_spec.rb +59 -0
- data/spec/models/get_inbound_email_events_by_uuid_logs_spec.rb +51 -0
- data/spec/models/get_inbound_email_events_by_uuid_spec.rb +83 -0
- data/spec/models/get_inbound_email_events_events_spec.rb +59 -0
- data/spec/models/get_inbound_email_events_spec.rb +41 -0
- data/spec/models/get_invited_users_list_feature_access_spec.rb +53 -0
- data/spec/models/get_invited_users_list_spec.rb +41 -0
- data/spec/models/get_invited_users_list_users_spec.rb +59 -0
- data/spec/models/get_ip_from_sender_spec.rb +59 -0
- data/spec/models/get_ip_spec.rb +59 -0
- data/spec/models/get_ips_from_sender_spec.rb +41 -0
- data/spec/models/get_ips_spec.rb +41 -0
- data/spec/models/get_list_spec.rb +65 -0
- data/spec/models/get_lists_spec.rb +47 -0
- data/spec/models/get_process_spec.rb +63 -0
- data/spec/models/get_processes_spec.rb +47 -0
- data/spec/models/get_product_details_spec.rb +125 -0
- data/spec/models/get_products_spec.rb +47 -0
- data/spec/models/get_reports_reports_spec.rb +113 -0
- data/spec/models/get_reports_spec.rb +41 -0
- data/spec/models/get_scheduled_email_by_batch_id_batches_spec.rb +57 -0
- data/spec/models/get_scheduled_email_by_batch_id_spec.rb +47 -0
- data/spec/models/get_scheduled_email_by_message_id_spec.rb +57 -0
- data/spec/models/get_segments_segments_spec.rb +59 -0
- data/spec/models/get_segments_spec.rb +47 -0
- data/spec/models/get_senders_list_ips_spec.rb +53 -0
- data/spec/models/get_senders_list_senders_spec.rb +65 -0
- data/spec/models/get_senders_list_spec.rb +41 -0
- data/spec/models/get_shared_template_url_spec.rb +41 -0
- data/spec/models/get_sms_campaign_overview_spec.rb +87 -0
- data/spec/models/get_sms_campaign_recipients_spec.rb +35 -0
- data/spec/models/get_sms_campaign_spec.rb +99 -0
- data/spec/models/get_sms_campaign_stats_spec.rb +77 -0
- data/spec/models/get_sms_campaigns_spec.rb +47 -0
- data/spec/models/get_sms_event_report_events_spec.rb +81 -0
- data/spec/models/get_sms_event_report_spec.rb +41 -0
- data/spec/models/get_smtp_template_overview_sender_spec.rb +53 -0
- data/spec/models/get_smtp_template_overview_spec.rb +113 -0
- data/spec/models/get_smtp_templates_spec.rb +47 -0
- data/spec/models/get_sso_token_spec.rb +41 -0
- data/spec/models/get_stats_by_browser_spec.rb +35 -0
- data/spec/models/get_stats_by_device_spec.rb +59 -0
- data/spec/models/get_stats_by_domain_spec.rb +35 -0
- data/spec/models/get_transac_aggregated_sms_report_spec.rb +95 -0
- data/spec/models/get_transac_blocked_contacts_contacts_spec.rb +59 -0
- data/spec/models/get_transac_blocked_contacts_reason_spec.rb +51 -0
- data/spec/models/get_transac_blocked_contacts_spec.rb +47 -0
- data/spec/models/get_transac_email_content_events_spec.rb +47 -0
- data/spec/models/get_transac_email_content_spec.rb +77 -0
- data/spec/models/get_transac_emails_list_spec.rb +47 -0
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +83 -0
- data/spec/models/get_transac_sms_report_reports_spec.rb +95 -0
- data/spec/models/get_transac_sms_report_spec.rb +41 -0
- data/spec/models/get_user_permission_privileges_spec.rb +47 -0
- data/spec/models/get_user_permission_spec.rb +53 -0
- data/spec/models/get_wa_templates_spec.rb +47 -0
- data/spec/models/get_wa_templates_templates_spec.rb +83 -0
- data/spec/models/get_webhook_spec.rb +81 -0
- data/spec/models/get_webhooks_spec.rb +41 -0
- data/spec/models/get_whats_app_config_spec.rb +79 -0
- data/spec/models/get_whatsapp_campaign_overview_spec.rb +93 -0
- data/spec/models/get_whatsapp_campaigns_campaigns_spec.rb +105 -0
- data/spec/models/get_whatsapp_campaigns_spec.rb +47 -0
- data/spec/models/get_whatsapp_event_report_events_spec.rb +87 -0
- data/spec/models/get_whatsapp_event_report_spec.rb +41 -0
- data/spec/models/inline_response_200_1_spec.rb +53 -0
- data/spec/models/inline_response_200_spec.rb +41 -0
- data/spec/models/inline_response_201_1_spec.rb +41 -0
- data/spec/models/inline_response_201_2_spec.rb +41 -0
- data/spec/models/inline_response_201_3_spec.rb +41 -0
- data/spec/models/inline_response_201_4_spec.rb +41 -0
- data/spec/models/inline_response_201_spec.rb +41 -0
- data/spec/models/manage_ip_spec.rb +41 -0
- data/spec/models/master_details_response_billing_info_address_spec.rb +65 -0
- data/spec/models/master_details_response_billing_info_name_spec.rb +47 -0
- data/spec/models/master_details_response_billing_info_spec.rb +59 -0
- data/spec/models/master_details_response_plan_info_features_spec.rb +65 -0
- data/spec/models/master_details_response_plan_info_spec.rb +75 -0
- data/spec/models/master_details_response_spec.rb +77 -0
- data/spec/models/note_data_spec.rb +59 -0
- data/spec/models/note_id_spec.rb +41 -0
- data/spec/models/note_list_spec.rb +35 -0
- data/spec/models/note_spec.rb +77 -0
- data/spec/models/order_batch_spec.rb +47 -0
- data/spec/models/order_billing_spec.rb +77 -0
- data/spec/models/order_products_spec.rb +59 -0
- data/spec/models/order_spec.rb +89 -0
- data/spec/models/otp_spec.rb +41 -0
- data/spec/models/pipeline_spec.rb +53 -0
- data/spec/models/pipeline_stage_spec.rb +47 -0
- data/spec/models/pipelines_spec.rb +35 -0
- data/spec/models/post_contact_info_contacts_spec.rb +59 -0
- data/spec/models/post_contact_info_spec.rb +41 -0
- data/spec/models/post_send_failed_spec.rb +65 -0
- data/spec/models/post_send_sms_test_failed_spec.rb +59 -0
- data/spec/models/remaining_credit_model_child_spec.rb +47 -0
- data/spec/models/remaining_credit_model_reseller_spec.rb +47 -0
- data/spec/models/remaining_credit_model_spec.rb +47 -0
- data/spec/models/remove_contact_from_list_spec.rb +53 -0
- data/spec/models/remove_credits_spec.rb +47 -0
- data/spec/models/request_contact_export_custom_contact_filter_spec.rb +83 -0
- data/spec/models/request_contact_export_spec.rb +53 -0
- data/spec/models/request_contact_import_json_body_spec.rb +47 -0
- data/spec/models/request_contact_import_new_list_spec.rb +47 -0
- data/spec/models/request_contact_import_spec.rb +95 -0
- data/spec/models/request_sms_recipient_export_spec.rb +51 -0
- data/spec/models/schedule_smtp_email_spec.rb +53 -0
- data/spec/models/send_report_email_spec.rb +47 -0
- data/spec/models/send_report_spec.rb +51 -0
- data/spec/models/send_sms_spec.rb +65 -0
- data/spec/models/send_smtp_email_attachment_spec.rb +53 -0
- data/spec/models/send_smtp_email_bcc_spec.rb +47 -0
- data/spec/models/send_smtp_email_cc_spec.rb +47 -0
- data/spec/models/send_smtp_email_message_versions_spec.rb +71 -0
- data/spec/models/send_smtp_email_reply_to_1_spec.rb +47 -0
- data/spec/models/send_smtp_email_reply_to_spec.rb +47 -0
- data/spec/models/send_smtp_email_sender_spec.rb +53 -0
- data/spec/models/send_smtp_email_spec.rb +131 -0
- data/spec/models/send_smtp_email_to_1_spec.rb +47 -0
- data/spec/models/send_smtp_email_to_spec.rb +47 -0
- data/spec/models/send_test_email_spec.rb +41 -0
- data/spec/models/send_test_sms_spec.rb +41 -0
- data/spec/models/send_transac_sms_spec.rb +87 -0
- data/spec/models/send_whatsapp_message_spec.rb +59 -0
- data/spec/models/sso_token_request_spec.rb +63 -0
- data/spec/models/sub_account_apps_toggle_request_spec.rb +113 -0
- data/spec/models/sub_account_details_response_plan_info_credits_emails_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_credits_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_inbox_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_landing_page_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_spec.rb +53 -0
- data/spec/models/sub_account_details_response_plan_info_features_users_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_spec.rb +53 -0
- data/spec/models/sub_account_details_response_spec.rb +59 -0
- data/spec/models/sub_account_update_plan_request_credits_spec.rb +41 -0
- data/spec/models/sub_account_update_plan_request_features_spec.rb +53 -0
- data/spec/models/sub_account_update_plan_request_spec.rb +47 -0
- data/spec/models/sub_accounts_response_spec.rb +47 -0
- data/spec/models/sub_accounts_response_sub_accounts_spec.rb +59 -0
- data/spec/models/task_list_spec.rb +41 -0
- data/spec/models/task_reminder_spec.rb +57 -0
- data/spec/models/task_spec.rb +71 -0
- data/spec/models/task_types_spec.rb +47 -0
- data/spec/models/update_attribute_enumeration_spec.rb +47 -0
- data/spec/models/update_attribute_spec.rb +47 -0
- data/spec/models/update_batch_contacts_contacts_spec.rb +95 -0
- data/spec/models/update_batch_contacts_model_spec.rb +47 -0
- data/spec/models/update_batch_contacts_spec.rb +41 -0
- data/spec/models/update_campaign_status_spec.rb +45 -0
- data/spec/models/update_child_account_status_spec.rb +59 -0
- data/spec/models/update_child_domain_spec.rb +41 -0
- data/spec/models/update_child_spec.rb +65 -0
- data/spec/models/update_contact_spec.rb +77 -0
- data/spec/models/update_coupon_collection_spec.rb +41 -0
- data/spec/models/update_email_campaign_recipients_spec.rb +53 -0
- data/spec/models/update_email_campaign_sender_spec.rb +53 -0
- data/spec/models/update_email_campaign_spec.rb +225 -0
- data/spec/models/update_external_feed_spec.rb +93 -0
- data/spec/models/update_list_spec.rb +47 -0
- data/spec/models/update_sender_spec.rb +53 -0
- data/spec/models/update_sms_campaign_spec.rb +83 -0
- data/spec/models/update_smtp_template_sender_spec.rb +53 -0
- data/spec/models/update_smtp_template_spec.rb +95 -0
- data/spec/models/update_webhook_spec.rb +63 -0
- data/spec/models/update_whats_app_campaign_spec.rb +63 -0
- data/spec/models/upload_image_model_spec.rb +41 -0
- data/spec/models/upload_image_to_gallery_spec.rb +47 -0
- data/spec/models/variables_items_spec.rb +53 -0
- data/spec/models/whatsapp_camp_stats_spec.rb +65 -0
- data/spec/models/whatsapp_camp_template_spec.rb +101 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1683 -0
data/docs/ContactsApi.md
ADDED
|
@@ -0,0 +1,1767 @@
|
|
|
1
|
+
# Brevo::ContactsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.brevo.com/v3*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**add_contact_to_list**](ContactsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
|
8
|
+
[**create_attribute**](ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
|
9
|
+
[**create_contact**](ContactsApi.md#create_contact) | **POST** /contacts | Create a contact
|
|
10
|
+
[**create_doi_contact**](ContactsApi.md#create_doi_contact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow
|
|
11
|
+
[**create_folder**](ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
|
|
12
|
+
[**create_list**](ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
|
|
13
|
+
[**delete_attribute**](ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
|
14
|
+
[**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{identifier} | Delete a contact
|
|
15
|
+
[**delete_folder**](ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
|
16
|
+
[**delete_list**](ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
|
|
17
|
+
[**get_attributes**](ContactsApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
|
|
18
|
+
[**get_contact_info**](ContactsApi.md#get_contact_info) | **GET** /contacts/{identifier} | Get a contact's details
|
|
19
|
+
[**get_contact_stats**](ContactsApi.md#get_contact_stats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
|
|
20
|
+
[**get_contacts**](ContactsApi.md#get_contacts) | **GET** /contacts | Get all the contacts
|
|
21
|
+
[**get_contacts_from_list**](ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
|
|
22
|
+
[**get_folder**](ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
|
23
|
+
[**get_folder_lists**](ContactsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
|
24
|
+
[**get_folders**](ContactsApi.md#get_folders) | **GET** /contacts/folders | Get all folders
|
|
25
|
+
[**get_list**](ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details
|
|
26
|
+
[**get_lists**](ContactsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
|
|
27
|
+
[**get_segments**](ContactsApi.md#get_segments) | **GET** /contacts/segments | Get all the Segments
|
|
28
|
+
[**import_contacts**](ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts
|
|
29
|
+
[**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
|
|
30
|
+
[**request_contact_export**](ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
|
|
31
|
+
[**update_attribute**](ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
|
32
|
+
[**update_batch_contacts**](ContactsApi.md#update_batch_contacts) | **POST** /contacts/batch | Update multiple contacts
|
|
33
|
+
[**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{identifier} | Update a contact
|
|
34
|
+
[**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
|
35
|
+
[**update_list**](ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
# **add_contact_to_list**
|
|
39
|
+
> PostContactInfo add_contact_to_list(list_id, contact_emails)
|
|
40
|
+
|
|
41
|
+
Add existing contacts to a list
|
|
42
|
+
|
|
43
|
+
### Example
|
|
44
|
+
```ruby
|
|
45
|
+
# load the gem
|
|
46
|
+
require 'brevo'
|
|
47
|
+
# setup authorization
|
|
48
|
+
Brevo.configure do |config|
|
|
49
|
+
# Configure API key authorization: api-key
|
|
50
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
51
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
52
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
53
|
+
|
|
54
|
+
# Configure API key authorization: partner-key
|
|
55
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
56
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
57
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
api_instance = Brevo::ContactsApi.new
|
|
61
|
+
|
|
62
|
+
list_id = 789 # Integer | Id of the list
|
|
63
|
+
|
|
64
|
+
contact_emails = Brevo::AddContactToList.new # AddContactToList | Emails addresses OR IDs of the contacts
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
begin
|
|
68
|
+
#Add existing contacts to a list
|
|
69
|
+
result = api_instance.add_contact_to_list(list_id, contact_emails)
|
|
70
|
+
p result
|
|
71
|
+
rescue Brevo::ApiError => e
|
|
72
|
+
puts "Exception when calling ContactsApi->add_contact_to_list: #{e}"
|
|
73
|
+
end
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### Parameters
|
|
77
|
+
|
|
78
|
+
Name | Type | Description | Notes
|
|
79
|
+
------------- | ------------- | ------------- | -------------
|
|
80
|
+
**list_id** | **Integer**| Id of the list |
|
|
81
|
+
**contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts |
|
|
82
|
+
|
|
83
|
+
### Return type
|
|
84
|
+
|
|
85
|
+
[**PostContactInfo**](PostContactInfo.md)
|
|
86
|
+
|
|
87
|
+
### Authorization
|
|
88
|
+
|
|
89
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
90
|
+
|
|
91
|
+
### HTTP request headers
|
|
92
|
+
|
|
93
|
+
- **Content-Type**: application/json
|
|
94
|
+
- **Accept**: application/json
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
# **create_attribute**
|
|
99
|
+
> create_attribute(attribute_category, attribute_name, create_attribute)
|
|
100
|
+
|
|
101
|
+
Create contact attribute
|
|
102
|
+
|
|
103
|
+
### Example
|
|
104
|
+
```ruby
|
|
105
|
+
# load the gem
|
|
106
|
+
require 'brevo'
|
|
107
|
+
# setup authorization
|
|
108
|
+
Brevo.configure do |config|
|
|
109
|
+
# Configure API key authorization: api-key
|
|
110
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
111
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
112
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
113
|
+
|
|
114
|
+
# Configure API key authorization: partner-key
|
|
115
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
116
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
117
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
api_instance = Brevo::ContactsApi.new
|
|
121
|
+
|
|
122
|
+
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
|
123
|
+
|
|
124
|
+
attribute_name = 'attribute_name_example' # String | Name of the attribute
|
|
125
|
+
|
|
126
|
+
create_attribute = Brevo::CreateAttribute.new # CreateAttribute | Values to create an attribute
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
begin
|
|
130
|
+
#Create contact attribute
|
|
131
|
+
api_instance.create_attribute(attribute_category, attribute_name, create_attribute)
|
|
132
|
+
rescue Brevo::ApiError => e
|
|
133
|
+
puts "Exception when calling ContactsApi->create_attribute: #{e}"
|
|
134
|
+
end
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Parameters
|
|
138
|
+
|
|
139
|
+
Name | Type | Description | Notes
|
|
140
|
+
------------- | ------------- | ------------- | -------------
|
|
141
|
+
**attribute_category** | **String**| Category of the attribute |
|
|
142
|
+
**attribute_name** | **String**| Name of the attribute |
|
|
143
|
+
**create_attribute** | [**CreateAttribute**](CreateAttribute.md)| Values to create an attribute |
|
|
144
|
+
|
|
145
|
+
### Return type
|
|
146
|
+
|
|
147
|
+
nil (empty response body)
|
|
148
|
+
|
|
149
|
+
### Authorization
|
|
150
|
+
|
|
151
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
152
|
+
|
|
153
|
+
### HTTP request headers
|
|
154
|
+
|
|
155
|
+
- **Content-Type**: application/json
|
|
156
|
+
- **Accept**: application/json
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
# **create_contact**
|
|
161
|
+
> CreateUpdateContactModel create_contact(create_contact)
|
|
162
|
+
|
|
163
|
+
Create a contact
|
|
164
|
+
|
|
165
|
+
### Example
|
|
166
|
+
```ruby
|
|
167
|
+
# load the gem
|
|
168
|
+
require 'brevo'
|
|
169
|
+
# setup authorization
|
|
170
|
+
Brevo.configure do |config|
|
|
171
|
+
# Configure API key authorization: api-key
|
|
172
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
173
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
174
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
175
|
+
|
|
176
|
+
# Configure API key authorization: partner-key
|
|
177
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
178
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
179
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
api_instance = Brevo::ContactsApi.new
|
|
183
|
+
|
|
184
|
+
create_contact = Brevo::CreateContact.new # CreateContact | Values to create a contact
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
begin
|
|
188
|
+
#Create a contact
|
|
189
|
+
result = api_instance.create_contact(create_contact)
|
|
190
|
+
p result
|
|
191
|
+
rescue Brevo::ApiError => e
|
|
192
|
+
puts "Exception when calling ContactsApi->create_contact: #{e}"
|
|
193
|
+
end
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### Parameters
|
|
197
|
+
|
|
198
|
+
Name | Type | Description | Notes
|
|
199
|
+
------------- | ------------- | ------------- | -------------
|
|
200
|
+
**create_contact** | [**CreateContact**](CreateContact.md)| Values to create a contact |
|
|
201
|
+
|
|
202
|
+
### Return type
|
|
203
|
+
|
|
204
|
+
[**CreateUpdateContactModel**](CreateUpdateContactModel.md)
|
|
205
|
+
|
|
206
|
+
### Authorization
|
|
207
|
+
|
|
208
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
209
|
+
|
|
210
|
+
### HTTP request headers
|
|
211
|
+
|
|
212
|
+
- **Content-Type**: application/json
|
|
213
|
+
- **Accept**: application/json
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
# **create_doi_contact**
|
|
218
|
+
> create_doi_contact(create_doi_contact)
|
|
219
|
+
|
|
220
|
+
Create Contact via DOI (Double-Opt-In) Flow
|
|
221
|
+
|
|
222
|
+
### Example
|
|
223
|
+
```ruby
|
|
224
|
+
# load the gem
|
|
225
|
+
require 'brevo'
|
|
226
|
+
# setup authorization
|
|
227
|
+
Brevo.configure do |config|
|
|
228
|
+
# Configure API key authorization: api-key
|
|
229
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
230
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
231
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
232
|
+
|
|
233
|
+
# Configure API key authorization: partner-key
|
|
234
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
235
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
236
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
237
|
+
end
|
|
238
|
+
|
|
239
|
+
api_instance = Brevo::ContactsApi.new
|
|
240
|
+
|
|
241
|
+
create_doi_contact = Brevo::CreateDoiContact.new # CreateDoiContact | Values to create the Double opt-in (DOI) contact
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
begin
|
|
245
|
+
#Create Contact via DOI (Double-Opt-In) Flow
|
|
246
|
+
api_instance.create_doi_contact(create_doi_contact)
|
|
247
|
+
rescue Brevo::ApiError => e
|
|
248
|
+
puts "Exception when calling ContactsApi->create_doi_contact: #{e}"
|
|
249
|
+
end
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
### Parameters
|
|
253
|
+
|
|
254
|
+
Name | Type | Description | Notes
|
|
255
|
+
------------- | ------------- | ------------- | -------------
|
|
256
|
+
**create_doi_contact** | [**CreateDoiContact**](CreateDoiContact.md)| Values to create the Double opt-in (DOI) contact |
|
|
257
|
+
|
|
258
|
+
### Return type
|
|
259
|
+
|
|
260
|
+
nil (empty response body)
|
|
261
|
+
|
|
262
|
+
### Authorization
|
|
263
|
+
|
|
264
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
265
|
+
|
|
266
|
+
### HTTP request headers
|
|
267
|
+
|
|
268
|
+
- **Content-Type**: application/json
|
|
269
|
+
- **Accept**: application/json
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
# **create_folder**
|
|
274
|
+
> CreateModel create_folder(create_folder)
|
|
275
|
+
|
|
276
|
+
Create a folder
|
|
277
|
+
|
|
278
|
+
### Example
|
|
279
|
+
```ruby
|
|
280
|
+
# load the gem
|
|
281
|
+
require 'brevo'
|
|
282
|
+
# setup authorization
|
|
283
|
+
Brevo.configure do |config|
|
|
284
|
+
# Configure API key authorization: api-key
|
|
285
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
286
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
287
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
288
|
+
|
|
289
|
+
# Configure API key authorization: partner-key
|
|
290
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
291
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
292
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
293
|
+
end
|
|
294
|
+
|
|
295
|
+
api_instance = Brevo::ContactsApi.new
|
|
296
|
+
|
|
297
|
+
create_folder = Brevo::CreateUpdateFolder.new # CreateUpdateFolder | Name of the folder
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
begin
|
|
301
|
+
#Create a folder
|
|
302
|
+
result = api_instance.create_folder(create_folder)
|
|
303
|
+
p result
|
|
304
|
+
rescue Brevo::ApiError => e
|
|
305
|
+
puts "Exception when calling ContactsApi->create_folder: #{e}"
|
|
306
|
+
end
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
### Parameters
|
|
310
|
+
|
|
311
|
+
Name | Type | Description | Notes
|
|
312
|
+
------------- | ------------- | ------------- | -------------
|
|
313
|
+
**create_folder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder |
|
|
314
|
+
|
|
315
|
+
### Return type
|
|
316
|
+
|
|
317
|
+
[**CreateModel**](CreateModel.md)
|
|
318
|
+
|
|
319
|
+
### Authorization
|
|
320
|
+
|
|
321
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
322
|
+
|
|
323
|
+
### HTTP request headers
|
|
324
|
+
|
|
325
|
+
- **Content-Type**: application/json
|
|
326
|
+
- **Accept**: application/json
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
# **create_list**
|
|
331
|
+
> CreateModel create_list(create_list)
|
|
332
|
+
|
|
333
|
+
Create a list
|
|
334
|
+
|
|
335
|
+
### Example
|
|
336
|
+
```ruby
|
|
337
|
+
# load the gem
|
|
338
|
+
require 'brevo'
|
|
339
|
+
# setup authorization
|
|
340
|
+
Brevo.configure do |config|
|
|
341
|
+
# Configure API key authorization: api-key
|
|
342
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
343
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
344
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
345
|
+
|
|
346
|
+
# Configure API key authorization: partner-key
|
|
347
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
348
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
349
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
350
|
+
end
|
|
351
|
+
|
|
352
|
+
api_instance = Brevo::ContactsApi.new
|
|
353
|
+
|
|
354
|
+
create_list = Brevo::CreateList.new # CreateList | Values to create a list
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
begin
|
|
358
|
+
#Create a list
|
|
359
|
+
result = api_instance.create_list(create_list)
|
|
360
|
+
p result
|
|
361
|
+
rescue Brevo::ApiError => e
|
|
362
|
+
puts "Exception when calling ContactsApi->create_list: #{e}"
|
|
363
|
+
end
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
### Parameters
|
|
367
|
+
|
|
368
|
+
Name | Type | Description | Notes
|
|
369
|
+
------------- | ------------- | ------------- | -------------
|
|
370
|
+
**create_list** | [**CreateList**](CreateList.md)| Values to create a list |
|
|
371
|
+
|
|
372
|
+
### Return type
|
|
373
|
+
|
|
374
|
+
[**CreateModel**](CreateModel.md)
|
|
375
|
+
|
|
376
|
+
### Authorization
|
|
377
|
+
|
|
378
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
379
|
+
|
|
380
|
+
### HTTP request headers
|
|
381
|
+
|
|
382
|
+
- **Content-Type**: application/json
|
|
383
|
+
- **Accept**: application/json
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
# **delete_attribute**
|
|
388
|
+
> delete_attribute(attribute_category, attribute_name)
|
|
389
|
+
|
|
390
|
+
Delete an attribute
|
|
391
|
+
|
|
392
|
+
### Example
|
|
393
|
+
```ruby
|
|
394
|
+
# load the gem
|
|
395
|
+
require 'brevo'
|
|
396
|
+
# setup authorization
|
|
397
|
+
Brevo.configure do |config|
|
|
398
|
+
# Configure API key authorization: api-key
|
|
399
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
400
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
401
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
402
|
+
|
|
403
|
+
# Configure API key authorization: partner-key
|
|
404
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
405
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
406
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
407
|
+
end
|
|
408
|
+
|
|
409
|
+
api_instance = Brevo::ContactsApi.new
|
|
410
|
+
|
|
411
|
+
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
|
412
|
+
|
|
413
|
+
attribute_name = 'attribute_name_example' # String | Name of the existing attribute
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
begin
|
|
417
|
+
#Delete an attribute
|
|
418
|
+
api_instance.delete_attribute(attribute_category, attribute_name)
|
|
419
|
+
rescue Brevo::ApiError => e
|
|
420
|
+
puts "Exception when calling ContactsApi->delete_attribute: #{e}"
|
|
421
|
+
end
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
### Parameters
|
|
425
|
+
|
|
426
|
+
Name | Type | Description | Notes
|
|
427
|
+
------------- | ------------- | ------------- | -------------
|
|
428
|
+
**attribute_category** | **String**| Category of the attribute |
|
|
429
|
+
**attribute_name** | **String**| Name of the existing attribute |
|
|
430
|
+
|
|
431
|
+
### Return type
|
|
432
|
+
|
|
433
|
+
nil (empty response body)
|
|
434
|
+
|
|
435
|
+
### Authorization
|
|
436
|
+
|
|
437
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
438
|
+
|
|
439
|
+
### HTTP request headers
|
|
440
|
+
|
|
441
|
+
- **Content-Type**: application/json
|
|
442
|
+
- **Accept**: application/json
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
# **delete_contact**
|
|
447
|
+
> delete_contact(identifier)
|
|
448
|
+
|
|
449
|
+
Delete a contact
|
|
450
|
+
|
|
451
|
+
### Example
|
|
452
|
+
```ruby
|
|
453
|
+
# load the gem
|
|
454
|
+
require 'brevo'
|
|
455
|
+
# setup authorization
|
|
456
|
+
Brevo.configure do |config|
|
|
457
|
+
# Configure API key authorization: api-key
|
|
458
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
459
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
460
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
461
|
+
|
|
462
|
+
# Configure API key authorization: partner-key
|
|
463
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
464
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
465
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
466
|
+
end
|
|
467
|
+
|
|
468
|
+
api_instance = Brevo::ContactsApi.new
|
|
469
|
+
|
|
470
|
+
identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
begin
|
|
474
|
+
#Delete a contact
|
|
475
|
+
api_instance.delete_contact(identifier)
|
|
476
|
+
rescue Brevo::ApiError => e
|
|
477
|
+
puts "Exception when calling ContactsApi->delete_contact: #{e}"
|
|
478
|
+
end
|
|
479
|
+
```
|
|
480
|
+
|
|
481
|
+
### Parameters
|
|
482
|
+
|
|
483
|
+
Name | Type | Description | Notes
|
|
484
|
+
------------- | ------------- | ------------- | -------------
|
|
485
|
+
**identifier** | **String**| Email (urlencoded) OR ID of the contact |
|
|
486
|
+
|
|
487
|
+
### Return type
|
|
488
|
+
|
|
489
|
+
nil (empty response body)
|
|
490
|
+
|
|
491
|
+
### Authorization
|
|
492
|
+
|
|
493
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
494
|
+
|
|
495
|
+
### HTTP request headers
|
|
496
|
+
|
|
497
|
+
- **Content-Type**: application/json
|
|
498
|
+
- **Accept**: application/json
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
# **delete_folder**
|
|
503
|
+
> delete_folder(folder_id)
|
|
504
|
+
|
|
505
|
+
Delete a folder (and all its lists)
|
|
506
|
+
|
|
507
|
+
### Example
|
|
508
|
+
```ruby
|
|
509
|
+
# load the gem
|
|
510
|
+
require 'brevo'
|
|
511
|
+
# setup authorization
|
|
512
|
+
Brevo.configure do |config|
|
|
513
|
+
# Configure API key authorization: api-key
|
|
514
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
515
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
516
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
517
|
+
|
|
518
|
+
# Configure API key authorization: partner-key
|
|
519
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
520
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
521
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
522
|
+
end
|
|
523
|
+
|
|
524
|
+
api_instance = Brevo::ContactsApi.new
|
|
525
|
+
|
|
526
|
+
folder_id = 789 # Integer | Id of the folder
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
begin
|
|
530
|
+
#Delete a folder (and all its lists)
|
|
531
|
+
api_instance.delete_folder(folder_id)
|
|
532
|
+
rescue Brevo::ApiError => e
|
|
533
|
+
puts "Exception when calling ContactsApi->delete_folder: #{e}"
|
|
534
|
+
end
|
|
535
|
+
```
|
|
536
|
+
|
|
537
|
+
### Parameters
|
|
538
|
+
|
|
539
|
+
Name | Type | Description | Notes
|
|
540
|
+
------------- | ------------- | ------------- | -------------
|
|
541
|
+
**folder_id** | **Integer**| Id of the folder |
|
|
542
|
+
|
|
543
|
+
### Return type
|
|
544
|
+
|
|
545
|
+
nil (empty response body)
|
|
546
|
+
|
|
547
|
+
### Authorization
|
|
548
|
+
|
|
549
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
550
|
+
|
|
551
|
+
### HTTP request headers
|
|
552
|
+
|
|
553
|
+
- **Content-Type**: application/json
|
|
554
|
+
- **Accept**: application/json
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
# **delete_list**
|
|
559
|
+
> delete_list(list_id)
|
|
560
|
+
|
|
561
|
+
Delete a list
|
|
562
|
+
|
|
563
|
+
### Example
|
|
564
|
+
```ruby
|
|
565
|
+
# load the gem
|
|
566
|
+
require 'brevo'
|
|
567
|
+
# setup authorization
|
|
568
|
+
Brevo.configure do |config|
|
|
569
|
+
# Configure API key authorization: api-key
|
|
570
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
571
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
572
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
573
|
+
|
|
574
|
+
# Configure API key authorization: partner-key
|
|
575
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
576
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
577
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
578
|
+
end
|
|
579
|
+
|
|
580
|
+
api_instance = Brevo::ContactsApi.new
|
|
581
|
+
|
|
582
|
+
list_id = 789 # Integer | Id of the list
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
begin
|
|
586
|
+
#Delete a list
|
|
587
|
+
api_instance.delete_list(list_id)
|
|
588
|
+
rescue Brevo::ApiError => e
|
|
589
|
+
puts "Exception when calling ContactsApi->delete_list: #{e}"
|
|
590
|
+
end
|
|
591
|
+
```
|
|
592
|
+
|
|
593
|
+
### Parameters
|
|
594
|
+
|
|
595
|
+
Name | Type | Description | Notes
|
|
596
|
+
------------- | ------------- | ------------- | -------------
|
|
597
|
+
**list_id** | **Integer**| Id of the list |
|
|
598
|
+
|
|
599
|
+
### Return type
|
|
600
|
+
|
|
601
|
+
nil (empty response body)
|
|
602
|
+
|
|
603
|
+
### Authorization
|
|
604
|
+
|
|
605
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
606
|
+
|
|
607
|
+
### HTTP request headers
|
|
608
|
+
|
|
609
|
+
- **Content-Type**: application/json
|
|
610
|
+
- **Accept**: application/json
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
# **get_attributes**
|
|
615
|
+
> GetAttributes get_attributes
|
|
616
|
+
|
|
617
|
+
List all attributes
|
|
618
|
+
|
|
619
|
+
### Example
|
|
620
|
+
```ruby
|
|
621
|
+
# load the gem
|
|
622
|
+
require 'brevo'
|
|
623
|
+
# setup authorization
|
|
624
|
+
Brevo.configure do |config|
|
|
625
|
+
# Configure API key authorization: api-key
|
|
626
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
627
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
628
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
629
|
+
|
|
630
|
+
# Configure API key authorization: partner-key
|
|
631
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
632
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
633
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
634
|
+
end
|
|
635
|
+
|
|
636
|
+
api_instance = Brevo::ContactsApi.new
|
|
637
|
+
|
|
638
|
+
begin
|
|
639
|
+
#List all attributes
|
|
640
|
+
result = api_instance.get_attributes
|
|
641
|
+
p result
|
|
642
|
+
rescue Brevo::ApiError => e
|
|
643
|
+
puts "Exception when calling ContactsApi->get_attributes: #{e}"
|
|
644
|
+
end
|
|
645
|
+
```
|
|
646
|
+
|
|
647
|
+
### Parameters
|
|
648
|
+
This endpoint does not need any parameter.
|
|
649
|
+
|
|
650
|
+
### Return type
|
|
651
|
+
|
|
652
|
+
[**GetAttributes**](GetAttributes.md)
|
|
653
|
+
|
|
654
|
+
### Authorization
|
|
655
|
+
|
|
656
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
657
|
+
|
|
658
|
+
### HTTP request headers
|
|
659
|
+
|
|
660
|
+
- **Content-Type**: application/json
|
|
661
|
+
- **Accept**: application/json
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
# **get_contact_info**
|
|
666
|
+
> GetExtendedContactDetails get_contact_info(identifier, opts)
|
|
667
|
+
|
|
668
|
+
Get a contact's details
|
|
669
|
+
|
|
670
|
+
Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.brevo.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.
|
|
671
|
+
|
|
672
|
+
### Example
|
|
673
|
+
```ruby
|
|
674
|
+
# load the gem
|
|
675
|
+
require 'brevo'
|
|
676
|
+
# setup authorization
|
|
677
|
+
Brevo.configure do |config|
|
|
678
|
+
# Configure API key authorization: api-key
|
|
679
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
680
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
681
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
682
|
+
|
|
683
|
+
# Configure API key authorization: partner-key
|
|
684
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
685
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
686
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
687
|
+
end
|
|
688
|
+
|
|
689
|
+
api_instance = Brevo::ContactsApi.new
|
|
690
|
+
|
|
691
|
+
identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact OR its SMS attribute value
|
|
692
|
+
|
|
693
|
+
opts = {
|
|
694
|
+
start_date: 'start_date_example', # String | **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
|
|
695
|
+
end_date: 'end_date_example' # String | **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate.
|
|
696
|
+
}
|
|
697
|
+
|
|
698
|
+
begin
|
|
699
|
+
#Get a contact's details
|
|
700
|
+
result = api_instance.get_contact_info(identifier, opts)
|
|
701
|
+
p result
|
|
702
|
+
rescue Brevo::ApiError => e
|
|
703
|
+
puts "Exception when calling ContactsApi->get_contact_info: #{e}"
|
|
704
|
+
end
|
|
705
|
+
```
|
|
706
|
+
|
|
707
|
+
### Parameters
|
|
708
|
+
|
|
709
|
+
Name | Type | Description | Notes
|
|
710
|
+
------------- | ------------- | ------------- | -------------
|
|
711
|
+
**identifier** | **String**| Email (urlencoded) OR ID of the contact OR its SMS attribute value |
|
|
712
|
+
**start_date** | **String**| **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
|
|
713
|
+
**end_date** | **String**| **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. | [optional]
|
|
714
|
+
|
|
715
|
+
### Return type
|
|
716
|
+
|
|
717
|
+
[**GetExtendedContactDetails**](GetExtendedContactDetails.md)
|
|
718
|
+
|
|
719
|
+
### Authorization
|
|
720
|
+
|
|
721
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
722
|
+
|
|
723
|
+
### HTTP request headers
|
|
724
|
+
|
|
725
|
+
- **Content-Type**: application/json
|
|
726
|
+
- **Accept**: application/json
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
# **get_contact_stats**
|
|
731
|
+
> GetContactCampaignStats get_contact_stats(identifier, opts)
|
|
732
|
+
|
|
733
|
+
Get email campaigns' statistics for a contact
|
|
734
|
+
|
|
735
|
+
### Example
|
|
736
|
+
```ruby
|
|
737
|
+
# load the gem
|
|
738
|
+
require 'brevo'
|
|
739
|
+
# setup authorization
|
|
740
|
+
Brevo.configure do |config|
|
|
741
|
+
# Configure API key authorization: api-key
|
|
742
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
743
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
744
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
745
|
+
|
|
746
|
+
# Configure API key authorization: partner-key
|
|
747
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
748
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
749
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
750
|
+
end
|
|
751
|
+
|
|
752
|
+
api_instance = Brevo::ContactsApi.new
|
|
753
|
+
|
|
754
|
+
identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
|
|
755
|
+
|
|
756
|
+
opts = {
|
|
757
|
+
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
|
|
758
|
+
end_date: 'end_date_example' # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days
|
|
759
|
+
}
|
|
760
|
+
|
|
761
|
+
begin
|
|
762
|
+
#Get email campaigns' statistics for a contact
|
|
763
|
+
result = api_instance.get_contact_stats(identifier, opts)
|
|
764
|
+
p result
|
|
765
|
+
rescue Brevo::ApiError => e
|
|
766
|
+
puts "Exception when calling ContactsApi->get_contact_stats: #{e}"
|
|
767
|
+
end
|
|
768
|
+
```
|
|
769
|
+
|
|
770
|
+
### Parameters
|
|
771
|
+
|
|
772
|
+
Name | Type | Description | Notes
|
|
773
|
+
------------- | ------------- | ------------- | -------------
|
|
774
|
+
**identifier** | **String**| Email (urlencoded) OR ID of the contact |
|
|
775
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
|
|
776
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days | [optional]
|
|
777
|
+
|
|
778
|
+
### Return type
|
|
779
|
+
|
|
780
|
+
[**GetContactCampaignStats**](GetContactCampaignStats.md)
|
|
781
|
+
|
|
782
|
+
### Authorization
|
|
783
|
+
|
|
784
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
785
|
+
|
|
786
|
+
### HTTP request headers
|
|
787
|
+
|
|
788
|
+
- **Content-Type**: application/json
|
|
789
|
+
- **Accept**: application/json
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
# **get_contacts**
|
|
794
|
+
> GetContacts get_contacts(opts)
|
|
795
|
+
|
|
796
|
+
Get all the contacts
|
|
797
|
+
|
|
798
|
+
### Example
|
|
799
|
+
```ruby
|
|
800
|
+
# load the gem
|
|
801
|
+
require 'brevo'
|
|
802
|
+
# setup authorization
|
|
803
|
+
Brevo.configure do |config|
|
|
804
|
+
# Configure API key authorization: api-key
|
|
805
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
806
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
807
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
808
|
+
|
|
809
|
+
# Configure API key authorization: partner-key
|
|
810
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
811
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
812
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
813
|
+
end
|
|
814
|
+
|
|
815
|
+
api_instance = Brevo::ContactsApi.new
|
|
816
|
+
|
|
817
|
+
opts = {
|
|
818
|
+
limit: 50, # Integer | Number of documents per page
|
|
819
|
+
offset: 0, # Integer | Index of the first document of the page
|
|
820
|
+
modified_since: 'modified_since_example', # String | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
|
821
|
+
created_since: 'created_since_example', # String | Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
|
822
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
823
|
+
}
|
|
824
|
+
|
|
825
|
+
begin
|
|
826
|
+
#Get all the contacts
|
|
827
|
+
result = api_instance.get_contacts(opts)
|
|
828
|
+
p result
|
|
829
|
+
rescue Brevo::ApiError => e
|
|
830
|
+
puts "Exception when calling ContactsApi->get_contacts: #{e}"
|
|
831
|
+
end
|
|
832
|
+
```
|
|
833
|
+
|
|
834
|
+
### Parameters
|
|
835
|
+
|
|
836
|
+
Name | Type | Description | Notes
|
|
837
|
+
------------- | ------------- | ------------- | -------------
|
|
838
|
+
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
|
839
|
+
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
|
840
|
+
**modified_since** | **String**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
|
841
|
+
**created_since** | **String**| Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
|
842
|
+
**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]
|
|
843
|
+
|
|
844
|
+
### Return type
|
|
845
|
+
|
|
846
|
+
[**GetContacts**](GetContacts.md)
|
|
847
|
+
|
|
848
|
+
### Authorization
|
|
849
|
+
|
|
850
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
851
|
+
|
|
852
|
+
### HTTP request headers
|
|
853
|
+
|
|
854
|
+
- **Content-Type**: application/json
|
|
855
|
+
- **Accept**: application/json
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
# **get_contacts_from_list**
|
|
860
|
+
> GetContacts get_contacts_from_list(list_id, opts)
|
|
861
|
+
|
|
862
|
+
Get contacts in a list
|
|
863
|
+
|
|
864
|
+
### Example
|
|
865
|
+
```ruby
|
|
866
|
+
# load the gem
|
|
867
|
+
require 'brevo'
|
|
868
|
+
# setup authorization
|
|
869
|
+
Brevo.configure do |config|
|
|
870
|
+
# Configure API key authorization: api-key
|
|
871
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
872
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
873
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
874
|
+
|
|
875
|
+
# Configure API key authorization: partner-key
|
|
876
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
877
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
878
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
879
|
+
end
|
|
880
|
+
|
|
881
|
+
api_instance = Brevo::ContactsApi.new
|
|
882
|
+
|
|
883
|
+
list_id = 789 # Integer | Id of the list
|
|
884
|
+
|
|
885
|
+
opts = {
|
|
886
|
+
modified_since: 'modified_since_example', # String | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
|
887
|
+
limit: 50, # Integer | Number of documents per page
|
|
888
|
+
offset: 0, # Integer | Index of the first document of the page
|
|
889
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
890
|
+
}
|
|
891
|
+
|
|
892
|
+
begin
|
|
893
|
+
#Get contacts in a list
|
|
894
|
+
result = api_instance.get_contacts_from_list(list_id, opts)
|
|
895
|
+
p result
|
|
896
|
+
rescue Brevo::ApiError => e
|
|
897
|
+
puts "Exception when calling ContactsApi->get_contacts_from_list: #{e}"
|
|
898
|
+
end
|
|
899
|
+
```
|
|
900
|
+
|
|
901
|
+
### Parameters
|
|
902
|
+
|
|
903
|
+
Name | Type | Description | Notes
|
|
904
|
+
------------- | ------------- | ------------- | -------------
|
|
905
|
+
**list_id** | **Integer**| Id of the list |
|
|
906
|
+
**modified_since** | **String**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
|
907
|
+
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
|
908
|
+
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
|
909
|
+
**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]
|
|
910
|
+
|
|
911
|
+
### Return type
|
|
912
|
+
|
|
913
|
+
[**GetContacts**](GetContacts.md)
|
|
914
|
+
|
|
915
|
+
### Authorization
|
|
916
|
+
|
|
917
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
918
|
+
|
|
919
|
+
### HTTP request headers
|
|
920
|
+
|
|
921
|
+
- **Content-Type**: application/json
|
|
922
|
+
- **Accept**: application/json
|
|
923
|
+
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
# **get_folder**
|
|
927
|
+
> GetFolder get_folder(folder_id)
|
|
928
|
+
|
|
929
|
+
Returns a folder's details
|
|
930
|
+
|
|
931
|
+
### Example
|
|
932
|
+
```ruby
|
|
933
|
+
# load the gem
|
|
934
|
+
require 'brevo'
|
|
935
|
+
# setup authorization
|
|
936
|
+
Brevo.configure do |config|
|
|
937
|
+
# Configure API key authorization: api-key
|
|
938
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
939
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
940
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
941
|
+
|
|
942
|
+
# Configure API key authorization: partner-key
|
|
943
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
944
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
945
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
946
|
+
end
|
|
947
|
+
|
|
948
|
+
api_instance = Brevo::ContactsApi.new
|
|
949
|
+
|
|
950
|
+
folder_id = 789 # Integer | id of the folder
|
|
951
|
+
|
|
952
|
+
|
|
953
|
+
begin
|
|
954
|
+
#Returns a folder's details
|
|
955
|
+
result = api_instance.get_folder(folder_id)
|
|
956
|
+
p result
|
|
957
|
+
rescue Brevo::ApiError => e
|
|
958
|
+
puts "Exception when calling ContactsApi->get_folder: #{e}"
|
|
959
|
+
end
|
|
960
|
+
```
|
|
961
|
+
|
|
962
|
+
### Parameters
|
|
963
|
+
|
|
964
|
+
Name | Type | Description | Notes
|
|
965
|
+
------------- | ------------- | ------------- | -------------
|
|
966
|
+
**folder_id** | **Integer**| id of the folder |
|
|
967
|
+
|
|
968
|
+
### Return type
|
|
969
|
+
|
|
970
|
+
[**GetFolder**](GetFolder.md)
|
|
971
|
+
|
|
972
|
+
### Authorization
|
|
973
|
+
|
|
974
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
975
|
+
|
|
976
|
+
### HTTP request headers
|
|
977
|
+
|
|
978
|
+
- **Content-Type**: application/json
|
|
979
|
+
- **Accept**: application/json
|
|
980
|
+
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
# **get_folder_lists**
|
|
984
|
+
> GetFolderLists get_folder_lists(folder_id, opts)
|
|
985
|
+
|
|
986
|
+
Get lists in a folder
|
|
987
|
+
|
|
988
|
+
### Example
|
|
989
|
+
```ruby
|
|
990
|
+
# load the gem
|
|
991
|
+
require 'brevo'
|
|
992
|
+
# setup authorization
|
|
993
|
+
Brevo.configure do |config|
|
|
994
|
+
# Configure API key authorization: api-key
|
|
995
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
996
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
997
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
998
|
+
|
|
999
|
+
# Configure API key authorization: partner-key
|
|
1000
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1001
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1002
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1003
|
+
end
|
|
1004
|
+
|
|
1005
|
+
api_instance = Brevo::ContactsApi.new
|
|
1006
|
+
|
|
1007
|
+
folder_id = 789 # Integer | Id of the folder
|
|
1008
|
+
|
|
1009
|
+
opts = {
|
|
1010
|
+
limit: 10, # Integer | Number of documents per page
|
|
1011
|
+
offset: 0, # Integer | Index of the first document of the page
|
|
1012
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
1013
|
+
}
|
|
1014
|
+
|
|
1015
|
+
begin
|
|
1016
|
+
#Get lists in a folder
|
|
1017
|
+
result = api_instance.get_folder_lists(folder_id, opts)
|
|
1018
|
+
p result
|
|
1019
|
+
rescue Brevo::ApiError => e
|
|
1020
|
+
puts "Exception when calling ContactsApi->get_folder_lists: #{e}"
|
|
1021
|
+
end
|
|
1022
|
+
```
|
|
1023
|
+
|
|
1024
|
+
### Parameters
|
|
1025
|
+
|
|
1026
|
+
Name | Type | Description | Notes
|
|
1027
|
+
------------- | ------------- | ------------- | -------------
|
|
1028
|
+
**folder_id** | **Integer**| Id of the folder |
|
|
1029
|
+
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
|
1030
|
+
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
|
1031
|
+
**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]
|
|
1032
|
+
|
|
1033
|
+
### Return type
|
|
1034
|
+
|
|
1035
|
+
[**GetFolderLists**](GetFolderLists.md)
|
|
1036
|
+
|
|
1037
|
+
### Authorization
|
|
1038
|
+
|
|
1039
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1040
|
+
|
|
1041
|
+
### HTTP request headers
|
|
1042
|
+
|
|
1043
|
+
- **Content-Type**: application/json
|
|
1044
|
+
- **Accept**: application/json
|
|
1045
|
+
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
# **get_folders**
|
|
1049
|
+
> GetFolders get_folders(limit, offset, opts)
|
|
1050
|
+
|
|
1051
|
+
Get all folders
|
|
1052
|
+
|
|
1053
|
+
### Example
|
|
1054
|
+
```ruby
|
|
1055
|
+
# load the gem
|
|
1056
|
+
require 'brevo'
|
|
1057
|
+
# setup authorization
|
|
1058
|
+
Brevo.configure do |config|
|
|
1059
|
+
# Configure API key authorization: api-key
|
|
1060
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1061
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1062
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1063
|
+
|
|
1064
|
+
# Configure API key authorization: partner-key
|
|
1065
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1066
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1067
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1068
|
+
end
|
|
1069
|
+
|
|
1070
|
+
api_instance = Brevo::ContactsApi.new
|
|
1071
|
+
|
|
1072
|
+
limit = 10 # Integer | Number of documents per page
|
|
1073
|
+
|
|
1074
|
+
offset = 0 # Integer | Index of the first document of the page
|
|
1075
|
+
|
|
1076
|
+
opts = {
|
|
1077
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
1078
|
+
}
|
|
1079
|
+
|
|
1080
|
+
begin
|
|
1081
|
+
#Get all folders
|
|
1082
|
+
result = api_instance.get_folders(limit, offset, opts)
|
|
1083
|
+
p result
|
|
1084
|
+
rescue Brevo::ApiError => e
|
|
1085
|
+
puts "Exception when calling ContactsApi->get_folders: #{e}"
|
|
1086
|
+
end
|
|
1087
|
+
```
|
|
1088
|
+
|
|
1089
|
+
### Parameters
|
|
1090
|
+
|
|
1091
|
+
Name | Type | Description | Notes
|
|
1092
|
+
------------- | ------------- | ------------- | -------------
|
|
1093
|
+
**limit** | **Integer**| Number of documents per page | [default to 10]
|
|
1094
|
+
**offset** | **Integer**| Index of the first document of the page | [default to 0]
|
|
1095
|
+
**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]
|
|
1096
|
+
|
|
1097
|
+
### Return type
|
|
1098
|
+
|
|
1099
|
+
[**GetFolders**](GetFolders.md)
|
|
1100
|
+
|
|
1101
|
+
### Authorization
|
|
1102
|
+
|
|
1103
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1104
|
+
|
|
1105
|
+
### HTTP request headers
|
|
1106
|
+
|
|
1107
|
+
- **Content-Type**: application/json
|
|
1108
|
+
- **Accept**: application/json
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
# **get_list**
|
|
1113
|
+
> GetExtendedList get_list(list_id)
|
|
1114
|
+
|
|
1115
|
+
Get a list's details
|
|
1116
|
+
|
|
1117
|
+
### Example
|
|
1118
|
+
```ruby
|
|
1119
|
+
# load the gem
|
|
1120
|
+
require 'brevo'
|
|
1121
|
+
# setup authorization
|
|
1122
|
+
Brevo.configure do |config|
|
|
1123
|
+
# Configure API key authorization: api-key
|
|
1124
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1125
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1126
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1127
|
+
|
|
1128
|
+
# Configure API key authorization: partner-key
|
|
1129
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1130
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1131
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1132
|
+
end
|
|
1133
|
+
|
|
1134
|
+
api_instance = Brevo::ContactsApi.new
|
|
1135
|
+
|
|
1136
|
+
list_id = 789 # Integer | Id of the list
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
begin
|
|
1140
|
+
#Get a list's details
|
|
1141
|
+
result = api_instance.get_list(list_id)
|
|
1142
|
+
p result
|
|
1143
|
+
rescue Brevo::ApiError => e
|
|
1144
|
+
puts "Exception when calling ContactsApi->get_list: #{e}"
|
|
1145
|
+
end
|
|
1146
|
+
```
|
|
1147
|
+
|
|
1148
|
+
### Parameters
|
|
1149
|
+
|
|
1150
|
+
Name | Type | Description | Notes
|
|
1151
|
+
------------- | ------------- | ------------- | -------------
|
|
1152
|
+
**list_id** | **Integer**| Id of the list |
|
|
1153
|
+
|
|
1154
|
+
### Return type
|
|
1155
|
+
|
|
1156
|
+
[**GetExtendedList**](GetExtendedList.md)
|
|
1157
|
+
|
|
1158
|
+
### Authorization
|
|
1159
|
+
|
|
1160
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1161
|
+
|
|
1162
|
+
### HTTP request headers
|
|
1163
|
+
|
|
1164
|
+
- **Content-Type**: application/json
|
|
1165
|
+
- **Accept**: application/json
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
# **get_lists**
|
|
1170
|
+
> GetLists get_lists(opts)
|
|
1171
|
+
|
|
1172
|
+
Get all the lists
|
|
1173
|
+
|
|
1174
|
+
### Example
|
|
1175
|
+
```ruby
|
|
1176
|
+
# load the gem
|
|
1177
|
+
require 'brevo'
|
|
1178
|
+
# setup authorization
|
|
1179
|
+
Brevo.configure do |config|
|
|
1180
|
+
# Configure API key authorization: api-key
|
|
1181
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1182
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1183
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1184
|
+
|
|
1185
|
+
# Configure API key authorization: partner-key
|
|
1186
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1187
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1188
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1189
|
+
end
|
|
1190
|
+
|
|
1191
|
+
api_instance = Brevo::ContactsApi.new
|
|
1192
|
+
|
|
1193
|
+
opts = {
|
|
1194
|
+
limit: 10, # Integer | Number of documents per page
|
|
1195
|
+
offset: 0, # Integer | Index of the first document of the page
|
|
1196
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
1197
|
+
}
|
|
1198
|
+
|
|
1199
|
+
begin
|
|
1200
|
+
#Get all the lists
|
|
1201
|
+
result = api_instance.get_lists(opts)
|
|
1202
|
+
p result
|
|
1203
|
+
rescue Brevo::ApiError => e
|
|
1204
|
+
puts "Exception when calling ContactsApi->get_lists: #{e}"
|
|
1205
|
+
end
|
|
1206
|
+
```
|
|
1207
|
+
|
|
1208
|
+
### Parameters
|
|
1209
|
+
|
|
1210
|
+
Name | Type | Description | Notes
|
|
1211
|
+
------------- | ------------- | ------------- | -------------
|
|
1212
|
+
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
|
1213
|
+
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
|
1214
|
+
**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]
|
|
1215
|
+
|
|
1216
|
+
### Return type
|
|
1217
|
+
|
|
1218
|
+
[**GetLists**](GetLists.md)
|
|
1219
|
+
|
|
1220
|
+
### Authorization
|
|
1221
|
+
|
|
1222
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1223
|
+
|
|
1224
|
+
### HTTP request headers
|
|
1225
|
+
|
|
1226
|
+
- **Content-Type**: application/json
|
|
1227
|
+
- **Accept**: application/json
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
# **get_segments**
|
|
1232
|
+
> GetSegments get_segments(limit, offset, opts)
|
|
1233
|
+
|
|
1234
|
+
Get all the Segments
|
|
1235
|
+
|
|
1236
|
+
### Example
|
|
1237
|
+
```ruby
|
|
1238
|
+
# load the gem
|
|
1239
|
+
require 'brevo'
|
|
1240
|
+
# setup authorization
|
|
1241
|
+
Brevo.configure do |config|
|
|
1242
|
+
# Configure API key authorization: api-key
|
|
1243
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1244
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1245
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1246
|
+
|
|
1247
|
+
# Configure API key authorization: partner-key
|
|
1248
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1249
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1250
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1251
|
+
end
|
|
1252
|
+
|
|
1253
|
+
api_instance = Brevo::ContactsApi.new
|
|
1254
|
+
|
|
1255
|
+
limit = 10 # Integer | Number of documents per page
|
|
1256
|
+
|
|
1257
|
+
offset = 0 # Integer | Index of the first document of the page
|
|
1258
|
+
|
|
1259
|
+
opts = {
|
|
1260
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
1261
|
+
}
|
|
1262
|
+
|
|
1263
|
+
begin
|
|
1264
|
+
#Get all the Segments
|
|
1265
|
+
result = api_instance.get_segments(limit, offset, opts)
|
|
1266
|
+
p result
|
|
1267
|
+
rescue Brevo::ApiError => e
|
|
1268
|
+
puts "Exception when calling ContactsApi->get_segments: #{e}"
|
|
1269
|
+
end
|
|
1270
|
+
```
|
|
1271
|
+
|
|
1272
|
+
### Parameters
|
|
1273
|
+
|
|
1274
|
+
Name | Type | Description | Notes
|
|
1275
|
+
------------- | ------------- | ------------- | -------------
|
|
1276
|
+
**limit** | **Integer**| Number of documents per page | [default to 10]
|
|
1277
|
+
**offset** | **Integer**| Index of the first document of the page | [default to 0]
|
|
1278
|
+
**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]
|
|
1279
|
+
|
|
1280
|
+
### Return type
|
|
1281
|
+
|
|
1282
|
+
[**GetSegments**](GetSegments.md)
|
|
1283
|
+
|
|
1284
|
+
### Authorization
|
|
1285
|
+
|
|
1286
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1287
|
+
|
|
1288
|
+
### HTTP request headers
|
|
1289
|
+
|
|
1290
|
+
- **Content-Type**: application/json
|
|
1291
|
+
- **Accept**: application/json
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
# **import_contacts**
|
|
1296
|
+
> CreatedProcessId import_contacts(request_contact_import)
|
|
1297
|
+
|
|
1298
|
+
Import contacts
|
|
1299
|
+
|
|
1300
|
+
It returns the background process ID which on completion calls the notify URL that you have set in the input.
|
|
1301
|
+
|
|
1302
|
+
### Example
|
|
1303
|
+
```ruby
|
|
1304
|
+
# load the gem
|
|
1305
|
+
require 'brevo'
|
|
1306
|
+
# setup authorization
|
|
1307
|
+
Brevo.configure do |config|
|
|
1308
|
+
# Configure API key authorization: api-key
|
|
1309
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1310
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1311
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1312
|
+
|
|
1313
|
+
# Configure API key authorization: partner-key
|
|
1314
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1315
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1316
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1317
|
+
end
|
|
1318
|
+
|
|
1319
|
+
api_instance = Brevo::ContactsApi.new
|
|
1320
|
+
|
|
1321
|
+
request_contact_import = Brevo::RequestContactImport.new # RequestContactImport | Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns``
|
|
1322
|
+
|
|
1323
|
+
|
|
1324
|
+
begin
|
|
1325
|
+
#Import contacts
|
|
1326
|
+
result = api_instance.import_contacts(request_contact_import)
|
|
1327
|
+
p result
|
|
1328
|
+
rescue Brevo::ApiError => e
|
|
1329
|
+
puts "Exception when calling ContactsApi->import_contacts: #{e}"
|
|
1330
|
+
end
|
|
1331
|
+
```
|
|
1332
|
+
|
|
1333
|
+
### Parameters
|
|
1334
|
+
|
|
1335
|
+
Name | Type | Description | Notes
|
|
1336
|
+
------------- | ------------- | ------------- | -------------
|
|
1337
|
+
**request_contact_import** | [**RequestContactImport**](RequestContactImport.md)| Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` |
|
|
1338
|
+
|
|
1339
|
+
### Return type
|
|
1340
|
+
|
|
1341
|
+
[**CreatedProcessId**](CreatedProcessId.md)
|
|
1342
|
+
|
|
1343
|
+
### Authorization
|
|
1344
|
+
|
|
1345
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1346
|
+
|
|
1347
|
+
### HTTP request headers
|
|
1348
|
+
|
|
1349
|
+
- **Content-Type**: application/json
|
|
1350
|
+
- **Accept**: application/json
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
|
|
1354
|
+
# **remove_contact_from_list**
|
|
1355
|
+
> PostContactInfo remove_contact_from_list(list_id, contact_emails)
|
|
1356
|
+
|
|
1357
|
+
Delete a contact from a list
|
|
1358
|
+
|
|
1359
|
+
### Example
|
|
1360
|
+
```ruby
|
|
1361
|
+
# load the gem
|
|
1362
|
+
require 'brevo'
|
|
1363
|
+
# setup authorization
|
|
1364
|
+
Brevo.configure do |config|
|
|
1365
|
+
# Configure API key authorization: api-key
|
|
1366
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1367
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1368
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1369
|
+
|
|
1370
|
+
# Configure API key authorization: partner-key
|
|
1371
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1372
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1373
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1374
|
+
end
|
|
1375
|
+
|
|
1376
|
+
api_instance = Brevo::ContactsApi.new
|
|
1377
|
+
|
|
1378
|
+
list_id = 789 # Integer | Id of the list
|
|
1379
|
+
|
|
1380
|
+
contact_emails = Brevo::RemoveContactFromList.new # RemoveContactFromList | Emails addresses OR IDs of the contacts
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
begin
|
|
1384
|
+
#Delete a contact from a list
|
|
1385
|
+
result = api_instance.remove_contact_from_list(list_id, contact_emails)
|
|
1386
|
+
p result
|
|
1387
|
+
rescue Brevo::ApiError => e
|
|
1388
|
+
puts "Exception when calling ContactsApi->remove_contact_from_list: #{e}"
|
|
1389
|
+
end
|
|
1390
|
+
```
|
|
1391
|
+
|
|
1392
|
+
### Parameters
|
|
1393
|
+
|
|
1394
|
+
Name | Type | Description | Notes
|
|
1395
|
+
------------- | ------------- | ------------- | -------------
|
|
1396
|
+
**list_id** | **Integer**| Id of the list |
|
|
1397
|
+
**contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts |
|
|
1398
|
+
|
|
1399
|
+
### Return type
|
|
1400
|
+
|
|
1401
|
+
[**PostContactInfo**](PostContactInfo.md)
|
|
1402
|
+
|
|
1403
|
+
### Authorization
|
|
1404
|
+
|
|
1405
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1406
|
+
|
|
1407
|
+
### HTTP request headers
|
|
1408
|
+
|
|
1409
|
+
- **Content-Type**: application/json
|
|
1410
|
+
- **Accept**: application/json
|
|
1411
|
+
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
# **request_contact_export**
|
|
1415
|
+
> CreatedProcessId request_contact_export(request_contact_export)
|
|
1416
|
+
|
|
1417
|
+
Export contacts
|
|
1418
|
+
|
|
1419
|
+
It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.
|
|
1420
|
+
|
|
1421
|
+
### Example
|
|
1422
|
+
```ruby
|
|
1423
|
+
# load the gem
|
|
1424
|
+
require 'brevo'
|
|
1425
|
+
# setup authorization
|
|
1426
|
+
Brevo.configure do |config|
|
|
1427
|
+
# Configure API key authorization: api-key
|
|
1428
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1429
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1430
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1431
|
+
|
|
1432
|
+
# Configure API key authorization: partner-key
|
|
1433
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1434
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1435
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1436
|
+
end
|
|
1437
|
+
|
|
1438
|
+
api_instance = Brevo::ContactsApi.new
|
|
1439
|
+
|
|
1440
|
+
request_contact_export = Brevo::RequestContactExport.new # RequestContactExport | Values to request a contact export
|
|
1441
|
+
|
|
1442
|
+
|
|
1443
|
+
begin
|
|
1444
|
+
#Export contacts
|
|
1445
|
+
result = api_instance.request_contact_export(request_contact_export)
|
|
1446
|
+
p result
|
|
1447
|
+
rescue Brevo::ApiError => e
|
|
1448
|
+
puts "Exception when calling ContactsApi->request_contact_export: #{e}"
|
|
1449
|
+
end
|
|
1450
|
+
```
|
|
1451
|
+
|
|
1452
|
+
### Parameters
|
|
1453
|
+
|
|
1454
|
+
Name | Type | Description | Notes
|
|
1455
|
+
------------- | ------------- | ------------- | -------------
|
|
1456
|
+
**request_contact_export** | [**RequestContactExport**](RequestContactExport.md)| Values to request a contact export |
|
|
1457
|
+
|
|
1458
|
+
### Return type
|
|
1459
|
+
|
|
1460
|
+
[**CreatedProcessId**](CreatedProcessId.md)
|
|
1461
|
+
|
|
1462
|
+
### Authorization
|
|
1463
|
+
|
|
1464
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1465
|
+
|
|
1466
|
+
### HTTP request headers
|
|
1467
|
+
|
|
1468
|
+
- **Content-Type**: application/json
|
|
1469
|
+
- **Accept**: application/json
|
|
1470
|
+
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
# **update_attribute**
|
|
1474
|
+
> update_attribute(attribute_category, attribute_name, update_attribute)
|
|
1475
|
+
|
|
1476
|
+
Update contact attribute
|
|
1477
|
+
|
|
1478
|
+
### Example
|
|
1479
|
+
```ruby
|
|
1480
|
+
# load the gem
|
|
1481
|
+
require 'brevo'
|
|
1482
|
+
# setup authorization
|
|
1483
|
+
Brevo.configure do |config|
|
|
1484
|
+
# Configure API key authorization: api-key
|
|
1485
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1486
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1487
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1488
|
+
|
|
1489
|
+
# Configure API key authorization: partner-key
|
|
1490
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1491
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1492
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1493
|
+
end
|
|
1494
|
+
|
|
1495
|
+
api_instance = Brevo::ContactsApi.new
|
|
1496
|
+
|
|
1497
|
+
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
|
1498
|
+
|
|
1499
|
+
attribute_name = 'attribute_name_example' # String | Name of the existing attribute
|
|
1500
|
+
|
|
1501
|
+
update_attribute = Brevo::UpdateAttribute.new # UpdateAttribute | Values to update an attribute
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
begin
|
|
1505
|
+
#Update contact attribute
|
|
1506
|
+
api_instance.update_attribute(attribute_category, attribute_name, update_attribute)
|
|
1507
|
+
rescue Brevo::ApiError => e
|
|
1508
|
+
puts "Exception when calling ContactsApi->update_attribute: #{e}"
|
|
1509
|
+
end
|
|
1510
|
+
```
|
|
1511
|
+
|
|
1512
|
+
### Parameters
|
|
1513
|
+
|
|
1514
|
+
Name | Type | Description | Notes
|
|
1515
|
+
------------- | ------------- | ------------- | -------------
|
|
1516
|
+
**attribute_category** | **String**| Category of the attribute |
|
|
1517
|
+
**attribute_name** | **String**| Name of the existing attribute |
|
|
1518
|
+
**update_attribute** | [**UpdateAttribute**](UpdateAttribute.md)| Values to update an attribute |
|
|
1519
|
+
|
|
1520
|
+
### Return type
|
|
1521
|
+
|
|
1522
|
+
nil (empty response body)
|
|
1523
|
+
|
|
1524
|
+
### Authorization
|
|
1525
|
+
|
|
1526
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1527
|
+
|
|
1528
|
+
### HTTP request headers
|
|
1529
|
+
|
|
1530
|
+
- **Content-Type**: application/json
|
|
1531
|
+
- **Accept**: application/json
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
|
|
1535
|
+
# **update_batch_contacts**
|
|
1536
|
+
> update_batch_contacts(update_batch_contacts)
|
|
1537
|
+
|
|
1538
|
+
Update multiple contacts
|
|
1539
|
+
|
|
1540
|
+
### Example
|
|
1541
|
+
```ruby
|
|
1542
|
+
# load the gem
|
|
1543
|
+
require 'brevo'
|
|
1544
|
+
# setup authorization
|
|
1545
|
+
Brevo.configure do |config|
|
|
1546
|
+
# Configure API key authorization: api-key
|
|
1547
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1548
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1549
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1550
|
+
|
|
1551
|
+
# Configure API key authorization: partner-key
|
|
1552
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1553
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1554
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1555
|
+
end
|
|
1556
|
+
|
|
1557
|
+
api_instance = Brevo::ContactsApi.new
|
|
1558
|
+
|
|
1559
|
+
update_batch_contacts = Brevo::UpdateBatchContacts.new # UpdateBatchContacts | Values to update multiple contacts
|
|
1560
|
+
|
|
1561
|
+
|
|
1562
|
+
begin
|
|
1563
|
+
#Update multiple contacts
|
|
1564
|
+
api_instance.update_batch_contacts(update_batch_contacts)
|
|
1565
|
+
rescue Brevo::ApiError => e
|
|
1566
|
+
puts "Exception when calling ContactsApi->update_batch_contacts: #{e}"
|
|
1567
|
+
end
|
|
1568
|
+
```
|
|
1569
|
+
|
|
1570
|
+
### Parameters
|
|
1571
|
+
|
|
1572
|
+
Name | Type | Description | Notes
|
|
1573
|
+
------------- | ------------- | ------------- | -------------
|
|
1574
|
+
**update_batch_contacts** | [**UpdateBatchContacts**](UpdateBatchContacts.md)| Values to update multiple contacts |
|
|
1575
|
+
|
|
1576
|
+
### Return type
|
|
1577
|
+
|
|
1578
|
+
nil (empty response body)
|
|
1579
|
+
|
|
1580
|
+
### Authorization
|
|
1581
|
+
|
|
1582
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1583
|
+
|
|
1584
|
+
### HTTP request headers
|
|
1585
|
+
|
|
1586
|
+
- **Content-Type**: application/json
|
|
1587
|
+
- **Accept**: application/json
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
|
|
1591
|
+
# **update_contact**
|
|
1592
|
+
> update_contact(identifier, update_contact)
|
|
1593
|
+
|
|
1594
|
+
Update a contact
|
|
1595
|
+
|
|
1596
|
+
### Example
|
|
1597
|
+
```ruby
|
|
1598
|
+
# load the gem
|
|
1599
|
+
require 'brevo'
|
|
1600
|
+
# setup authorization
|
|
1601
|
+
Brevo.configure do |config|
|
|
1602
|
+
# Configure API key authorization: api-key
|
|
1603
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1604
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1605
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1606
|
+
|
|
1607
|
+
# Configure API key authorization: partner-key
|
|
1608
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1609
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1610
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1611
|
+
end
|
|
1612
|
+
|
|
1613
|
+
api_instance = Brevo::ContactsApi.new
|
|
1614
|
+
|
|
1615
|
+
identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
|
|
1616
|
+
|
|
1617
|
+
update_contact = Brevo::UpdateContact.new # UpdateContact | Values to update a contact
|
|
1618
|
+
|
|
1619
|
+
|
|
1620
|
+
begin
|
|
1621
|
+
#Update a contact
|
|
1622
|
+
api_instance.update_contact(identifier, update_contact)
|
|
1623
|
+
rescue Brevo::ApiError => e
|
|
1624
|
+
puts "Exception when calling ContactsApi->update_contact: #{e}"
|
|
1625
|
+
end
|
|
1626
|
+
```
|
|
1627
|
+
|
|
1628
|
+
### Parameters
|
|
1629
|
+
|
|
1630
|
+
Name | Type | Description | Notes
|
|
1631
|
+
------------- | ------------- | ------------- | -------------
|
|
1632
|
+
**identifier** | **String**| Email (urlencoded) OR ID of the contact |
|
|
1633
|
+
**update_contact** | [**UpdateContact**](UpdateContact.md)| Values to update a contact |
|
|
1634
|
+
|
|
1635
|
+
### Return type
|
|
1636
|
+
|
|
1637
|
+
nil (empty response body)
|
|
1638
|
+
|
|
1639
|
+
### Authorization
|
|
1640
|
+
|
|
1641
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1642
|
+
|
|
1643
|
+
### HTTP request headers
|
|
1644
|
+
|
|
1645
|
+
- **Content-Type**: application/json
|
|
1646
|
+
- **Accept**: application/json
|
|
1647
|
+
|
|
1648
|
+
|
|
1649
|
+
|
|
1650
|
+
# **update_folder**
|
|
1651
|
+
> update_folder(folder_id, update_folder)
|
|
1652
|
+
|
|
1653
|
+
Update a folder
|
|
1654
|
+
|
|
1655
|
+
### Example
|
|
1656
|
+
```ruby
|
|
1657
|
+
# load the gem
|
|
1658
|
+
require 'brevo'
|
|
1659
|
+
# setup authorization
|
|
1660
|
+
Brevo.configure do |config|
|
|
1661
|
+
# Configure API key authorization: api-key
|
|
1662
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1663
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1664
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1665
|
+
|
|
1666
|
+
# Configure API key authorization: partner-key
|
|
1667
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1668
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1669
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1670
|
+
end
|
|
1671
|
+
|
|
1672
|
+
api_instance = Brevo::ContactsApi.new
|
|
1673
|
+
|
|
1674
|
+
folder_id = 789 # Integer | Id of the folder
|
|
1675
|
+
|
|
1676
|
+
update_folder = Brevo::CreateUpdateFolder.new # CreateUpdateFolder | Name of the folder
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
begin
|
|
1680
|
+
#Update a folder
|
|
1681
|
+
api_instance.update_folder(folder_id, update_folder)
|
|
1682
|
+
rescue Brevo::ApiError => e
|
|
1683
|
+
puts "Exception when calling ContactsApi->update_folder: #{e}"
|
|
1684
|
+
end
|
|
1685
|
+
```
|
|
1686
|
+
|
|
1687
|
+
### Parameters
|
|
1688
|
+
|
|
1689
|
+
Name | Type | Description | Notes
|
|
1690
|
+
------------- | ------------- | ------------- | -------------
|
|
1691
|
+
**folder_id** | **Integer**| Id of the folder |
|
|
1692
|
+
**update_folder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder |
|
|
1693
|
+
|
|
1694
|
+
### Return type
|
|
1695
|
+
|
|
1696
|
+
nil (empty response body)
|
|
1697
|
+
|
|
1698
|
+
### Authorization
|
|
1699
|
+
|
|
1700
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1701
|
+
|
|
1702
|
+
### HTTP request headers
|
|
1703
|
+
|
|
1704
|
+
- **Content-Type**: application/json
|
|
1705
|
+
- **Accept**: application/json
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
# **update_list**
|
|
1710
|
+
> update_list(list_id, update_list)
|
|
1711
|
+
|
|
1712
|
+
Update a list
|
|
1713
|
+
|
|
1714
|
+
### Example
|
|
1715
|
+
```ruby
|
|
1716
|
+
# load the gem
|
|
1717
|
+
require 'brevo'
|
|
1718
|
+
# setup authorization
|
|
1719
|
+
Brevo.configure do |config|
|
|
1720
|
+
# Configure API key authorization: api-key
|
|
1721
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
1722
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1723
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
1724
|
+
|
|
1725
|
+
# Configure API key authorization: partner-key
|
|
1726
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
1727
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1728
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
1729
|
+
end
|
|
1730
|
+
|
|
1731
|
+
api_instance = Brevo::ContactsApi.new
|
|
1732
|
+
|
|
1733
|
+
list_id = 789 # Integer | Id of the list
|
|
1734
|
+
|
|
1735
|
+
update_list = Brevo::UpdateList.new # UpdateList | Values to update a list
|
|
1736
|
+
|
|
1737
|
+
|
|
1738
|
+
begin
|
|
1739
|
+
#Update a list
|
|
1740
|
+
api_instance.update_list(list_id, update_list)
|
|
1741
|
+
rescue Brevo::ApiError => e
|
|
1742
|
+
puts "Exception when calling ContactsApi->update_list: #{e}"
|
|
1743
|
+
end
|
|
1744
|
+
```
|
|
1745
|
+
|
|
1746
|
+
### Parameters
|
|
1747
|
+
|
|
1748
|
+
Name | Type | Description | Notes
|
|
1749
|
+
------------- | ------------- | ------------- | -------------
|
|
1750
|
+
**list_id** | **Integer**| Id of the list |
|
|
1751
|
+
**update_list** | [**UpdateList**](UpdateList.md)| Values to update a list |
|
|
1752
|
+
|
|
1753
|
+
### Return type
|
|
1754
|
+
|
|
1755
|
+
nil (empty response body)
|
|
1756
|
+
|
|
1757
|
+
### Authorization
|
|
1758
|
+
|
|
1759
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
1760
|
+
|
|
1761
|
+
### HTTP request headers
|
|
1762
|
+
|
|
1763
|
+
- **Content-Type**: application/json
|
|
1764
|
+
- **Accept**: application/json
|
|
1765
|
+
|
|
1766
|
+
|
|
1767
|
+
|