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
|
@@ -0,0 +1,613 @@
|
|
|
1
|
+
# Brevo::SMSCampaignsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.brevo.com/v3*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_sms_campaign**](SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
|
|
8
|
+
[**delete_sms_campaign**](SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign
|
|
9
|
+
[**get_sms_campaign**](SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
|
|
10
|
+
[**get_sms_campaigns**](SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns
|
|
11
|
+
[**request_sms_recipient_export**](SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients
|
|
12
|
+
[**send_sms_campaign_now**](SMSCampaignsApi.md#send_sms_campaign_now) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
|
|
13
|
+
[**send_sms_report**](SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report
|
|
14
|
+
[**send_test_sms**](SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign
|
|
15
|
+
[**update_sms_campaign**](SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign
|
|
16
|
+
[**update_sms_campaign_status**](SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
# **create_sms_campaign**
|
|
20
|
+
> CreateModel create_sms_campaign(create_sms_campaign)
|
|
21
|
+
|
|
22
|
+
Creates an SMS campaign
|
|
23
|
+
|
|
24
|
+
### Example
|
|
25
|
+
```ruby
|
|
26
|
+
# load the gem
|
|
27
|
+
require 'brevo'
|
|
28
|
+
# setup authorization
|
|
29
|
+
Brevo.configure do |config|
|
|
30
|
+
# Configure API key authorization: api-key
|
|
31
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
32
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
33
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
34
|
+
|
|
35
|
+
# Configure API key authorization: partner-key
|
|
36
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
37
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
38
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
api_instance = Brevo::SMSCampaignsApi.new
|
|
42
|
+
|
|
43
|
+
create_sms_campaign = Brevo::CreateSmsCampaign.new # CreateSmsCampaign | Values to create an SMS Campaign
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
begin
|
|
47
|
+
#Creates an SMS campaign
|
|
48
|
+
result = api_instance.create_sms_campaign(create_sms_campaign)
|
|
49
|
+
p result
|
|
50
|
+
rescue Brevo::ApiError => e
|
|
51
|
+
puts "Exception when calling SMSCampaignsApi->create_sms_campaign: #{e}"
|
|
52
|
+
end
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Parameters
|
|
56
|
+
|
|
57
|
+
Name | Type | Description | Notes
|
|
58
|
+
------------- | ------------- | ------------- | -------------
|
|
59
|
+
**create_sms_campaign** | [**CreateSmsCampaign**](CreateSmsCampaign.md)| Values to create an SMS Campaign |
|
|
60
|
+
|
|
61
|
+
### Return type
|
|
62
|
+
|
|
63
|
+
[**CreateModel**](CreateModel.md)
|
|
64
|
+
|
|
65
|
+
### Authorization
|
|
66
|
+
|
|
67
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
68
|
+
|
|
69
|
+
### HTTP request headers
|
|
70
|
+
|
|
71
|
+
- **Content-Type**: application/json
|
|
72
|
+
- **Accept**: application/json
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
# **delete_sms_campaign**
|
|
77
|
+
> delete_sms_campaign(campaign_id)
|
|
78
|
+
|
|
79
|
+
Delete an SMS campaign
|
|
80
|
+
|
|
81
|
+
### Example
|
|
82
|
+
```ruby
|
|
83
|
+
# load the gem
|
|
84
|
+
require 'brevo'
|
|
85
|
+
# setup authorization
|
|
86
|
+
Brevo.configure do |config|
|
|
87
|
+
# Configure API key authorization: api-key
|
|
88
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
89
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
90
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
91
|
+
|
|
92
|
+
# Configure API key authorization: partner-key
|
|
93
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
94
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
95
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
api_instance = Brevo::SMSCampaignsApi.new
|
|
99
|
+
|
|
100
|
+
campaign_id = 789 # Integer | id of the SMS campaign
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
begin
|
|
104
|
+
#Delete an SMS campaign
|
|
105
|
+
api_instance.delete_sms_campaign(campaign_id)
|
|
106
|
+
rescue Brevo::ApiError => e
|
|
107
|
+
puts "Exception when calling SMSCampaignsApi->delete_sms_campaign: #{e}"
|
|
108
|
+
end
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### Parameters
|
|
112
|
+
|
|
113
|
+
Name | Type | Description | Notes
|
|
114
|
+
------------- | ------------- | ------------- | -------------
|
|
115
|
+
**campaign_id** | **Integer**| id of the SMS campaign |
|
|
116
|
+
|
|
117
|
+
### Return type
|
|
118
|
+
|
|
119
|
+
nil (empty response body)
|
|
120
|
+
|
|
121
|
+
### Authorization
|
|
122
|
+
|
|
123
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
124
|
+
|
|
125
|
+
### HTTP request headers
|
|
126
|
+
|
|
127
|
+
- **Content-Type**: application/json
|
|
128
|
+
- **Accept**: application/json
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
# **get_sms_campaign**
|
|
133
|
+
> GetSmsCampaign get_sms_campaign(campaign_id)
|
|
134
|
+
|
|
135
|
+
Get an SMS campaign
|
|
136
|
+
|
|
137
|
+
### Example
|
|
138
|
+
```ruby
|
|
139
|
+
# load the gem
|
|
140
|
+
require 'brevo'
|
|
141
|
+
# setup authorization
|
|
142
|
+
Brevo.configure do |config|
|
|
143
|
+
# Configure API key authorization: api-key
|
|
144
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
145
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
146
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
147
|
+
|
|
148
|
+
# Configure API key authorization: partner-key
|
|
149
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
150
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
151
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
api_instance = Brevo::SMSCampaignsApi.new
|
|
155
|
+
|
|
156
|
+
campaign_id = 789 # Integer | id of the SMS campaign
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
begin
|
|
160
|
+
#Get an SMS campaign
|
|
161
|
+
result = api_instance.get_sms_campaign(campaign_id)
|
|
162
|
+
p result
|
|
163
|
+
rescue Brevo::ApiError => e
|
|
164
|
+
puts "Exception when calling SMSCampaignsApi->get_sms_campaign: #{e}"
|
|
165
|
+
end
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
### Parameters
|
|
169
|
+
|
|
170
|
+
Name | Type | Description | Notes
|
|
171
|
+
------------- | ------------- | ------------- | -------------
|
|
172
|
+
**campaign_id** | **Integer**| id of the SMS campaign |
|
|
173
|
+
|
|
174
|
+
### Return type
|
|
175
|
+
|
|
176
|
+
[**GetSmsCampaign**](GetSmsCampaign.md)
|
|
177
|
+
|
|
178
|
+
### Authorization
|
|
179
|
+
|
|
180
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
181
|
+
|
|
182
|
+
### HTTP request headers
|
|
183
|
+
|
|
184
|
+
- **Content-Type**: application/json
|
|
185
|
+
- **Accept**: application/json
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
# **get_sms_campaigns**
|
|
190
|
+
> GetSmsCampaigns get_sms_campaigns(opts)
|
|
191
|
+
|
|
192
|
+
Returns the information for all your created SMS campaigns
|
|
193
|
+
|
|
194
|
+
### Example
|
|
195
|
+
```ruby
|
|
196
|
+
# load the gem
|
|
197
|
+
require 'brevo'
|
|
198
|
+
# setup authorization
|
|
199
|
+
Brevo.configure do |config|
|
|
200
|
+
# Configure API key authorization: api-key
|
|
201
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
202
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
203
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
204
|
+
|
|
205
|
+
# Configure API key authorization: partner-key
|
|
206
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
207
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
208
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
api_instance = Brevo::SMSCampaignsApi.new
|
|
212
|
+
|
|
213
|
+
opts = {
|
|
214
|
+
status: 'status_example', # String | Status of campaign.
|
|
215
|
+
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
|
216
|
+
end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
|
217
|
+
limit: 500, # Integer | Number limitation for the result returned
|
|
218
|
+
offset: 0, # Integer | Beginning point in the list to retrieve from.
|
|
219
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
begin
|
|
223
|
+
#Returns the information for all your created SMS campaigns
|
|
224
|
+
result = api_instance.get_sms_campaigns(opts)
|
|
225
|
+
p result
|
|
226
|
+
rescue Brevo::ApiError => e
|
|
227
|
+
puts "Exception when calling SMSCampaignsApi->get_sms_campaigns: #{e}"
|
|
228
|
+
end
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
### Parameters
|
|
232
|
+
|
|
233
|
+
Name | Type | Description | Notes
|
|
234
|
+
------------- | ------------- | ------------- | -------------
|
|
235
|
+
**status** | **String**| Status of campaign. | [optional]
|
|
236
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
|
237
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
|
238
|
+
**limit** | **Integer**| Number limitation for the result returned | [optional] [default to 500]
|
|
239
|
+
**offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
|
|
240
|
+
**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]
|
|
241
|
+
|
|
242
|
+
### Return type
|
|
243
|
+
|
|
244
|
+
[**GetSmsCampaigns**](GetSmsCampaigns.md)
|
|
245
|
+
|
|
246
|
+
### Authorization
|
|
247
|
+
|
|
248
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
249
|
+
|
|
250
|
+
### HTTP request headers
|
|
251
|
+
|
|
252
|
+
- **Content-Type**: application/json
|
|
253
|
+
- **Accept**: application/json
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
# **request_sms_recipient_export**
|
|
258
|
+
> CreatedProcessId request_sms_recipient_export(campaign_id, opts)
|
|
259
|
+
|
|
260
|
+
Export an SMS campaign's recipients
|
|
261
|
+
|
|
262
|
+
It returns the background process ID which on completion calls the notify URL that you have set in the input.
|
|
263
|
+
|
|
264
|
+
### Example
|
|
265
|
+
```ruby
|
|
266
|
+
# load the gem
|
|
267
|
+
require 'brevo'
|
|
268
|
+
# setup authorization
|
|
269
|
+
Brevo.configure do |config|
|
|
270
|
+
# Configure API key authorization: api-key
|
|
271
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
272
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
273
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
274
|
+
|
|
275
|
+
# Configure API key authorization: partner-key
|
|
276
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
277
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
278
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
279
|
+
end
|
|
280
|
+
|
|
281
|
+
api_instance = Brevo::SMSCampaignsApi.new
|
|
282
|
+
|
|
283
|
+
campaign_id = 789 # Integer | id of the campaign
|
|
284
|
+
|
|
285
|
+
opts = {
|
|
286
|
+
recipient_export: Brevo::RequestSmsRecipientExport.new # RequestSmsRecipientExport | Values to send for a recipient export request
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
begin
|
|
290
|
+
#Export an SMS campaign's recipients
|
|
291
|
+
result = api_instance.request_sms_recipient_export(campaign_id, opts)
|
|
292
|
+
p result
|
|
293
|
+
rescue Brevo::ApiError => e
|
|
294
|
+
puts "Exception when calling SMSCampaignsApi->request_sms_recipient_export: #{e}"
|
|
295
|
+
end
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
### Parameters
|
|
299
|
+
|
|
300
|
+
Name | Type | Description | Notes
|
|
301
|
+
------------- | ------------- | ------------- | -------------
|
|
302
|
+
**campaign_id** | **Integer**| id of the campaign |
|
|
303
|
+
**recipient_export** | [**RequestSmsRecipientExport**](RequestSmsRecipientExport.md)| Values to send for a recipient export request | [optional]
|
|
304
|
+
|
|
305
|
+
### Return type
|
|
306
|
+
|
|
307
|
+
[**CreatedProcessId**](CreatedProcessId.md)
|
|
308
|
+
|
|
309
|
+
### Authorization
|
|
310
|
+
|
|
311
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
312
|
+
|
|
313
|
+
### HTTP request headers
|
|
314
|
+
|
|
315
|
+
- **Content-Type**: application/json
|
|
316
|
+
- **Accept**: application/json
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
# **send_sms_campaign_now**
|
|
321
|
+
> send_sms_campaign_now(campaign_id)
|
|
322
|
+
|
|
323
|
+
Send your SMS campaign immediately
|
|
324
|
+
|
|
325
|
+
### Example
|
|
326
|
+
```ruby
|
|
327
|
+
# load the gem
|
|
328
|
+
require 'brevo'
|
|
329
|
+
# setup authorization
|
|
330
|
+
Brevo.configure do |config|
|
|
331
|
+
# Configure API key authorization: api-key
|
|
332
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
333
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
334
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
335
|
+
|
|
336
|
+
# Configure API key authorization: partner-key
|
|
337
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
338
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
339
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
340
|
+
end
|
|
341
|
+
|
|
342
|
+
api_instance = Brevo::SMSCampaignsApi.new
|
|
343
|
+
|
|
344
|
+
campaign_id = 789 # Integer | id of the campaign
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
begin
|
|
348
|
+
#Send your SMS campaign immediately
|
|
349
|
+
api_instance.send_sms_campaign_now(campaign_id)
|
|
350
|
+
rescue Brevo::ApiError => e
|
|
351
|
+
puts "Exception when calling SMSCampaignsApi->send_sms_campaign_now: #{e}"
|
|
352
|
+
end
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
### Parameters
|
|
356
|
+
|
|
357
|
+
Name | Type | Description | Notes
|
|
358
|
+
------------- | ------------- | ------------- | -------------
|
|
359
|
+
**campaign_id** | **Integer**| id of the campaign |
|
|
360
|
+
|
|
361
|
+
### Return type
|
|
362
|
+
|
|
363
|
+
nil (empty response body)
|
|
364
|
+
|
|
365
|
+
### Authorization
|
|
366
|
+
|
|
367
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
368
|
+
|
|
369
|
+
### HTTP request headers
|
|
370
|
+
|
|
371
|
+
- **Content-Type**: application/json
|
|
372
|
+
- **Accept**: application/json
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
# **send_sms_report**
|
|
377
|
+
> send_sms_report(campaign_id, send_report)
|
|
378
|
+
|
|
379
|
+
Send an SMS campaign's report
|
|
380
|
+
|
|
381
|
+
Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
|
|
382
|
+
|
|
383
|
+
### Example
|
|
384
|
+
```ruby
|
|
385
|
+
# load the gem
|
|
386
|
+
require 'brevo'
|
|
387
|
+
# setup authorization
|
|
388
|
+
Brevo.configure do |config|
|
|
389
|
+
# Configure API key authorization: api-key
|
|
390
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
391
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
392
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
393
|
+
|
|
394
|
+
# Configure API key authorization: partner-key
|
|
395
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
396
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
397
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
398
|
+
end
|
|
399
|
+
|
|
400
|
+
api_instance = Brevo::SMSCampaignsApi.new
|
|
401
|
+
|
|
402
|
+
campaign_id = 789 # Integer | id of the campaign
|
|
403
|
+
|
|
404
|
+
send_report = Brevo::SendReport.new # SendReport | Values for send a report
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
begin
|
|
408
|
+
#Send an SMS campaign's report
|
|
409
|
+
api_instance.send_sms_report(campaign_id, send_report)
|
|
410
|
+
rescue Brevo::ApiError => e
|
|
411
|
+
puts "Exception when calling SMSCampaignsApi->send_sms_report: #{e}"
|
|
412
|
+
end
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
### Parameters
|
|
416
|
+
|
|
417
|
+
Name | Type | Description | Notes
|
|
418
|
+
------------- | ------------- | ------------- | -------------
|
|
419
|
+
**campaign_id** | **Integer**| id of the campaign |
|
|
420
|
+
**send_report** | [**SendReport**](SendReport.md)| Values for send a report |
|
|
421
|
+
|
|
422
|
+
### Return type
|
|
423
|
+
|
|
424
|
+
nil (empty response body)
|
|
425
|
+
|
|
426
|
+
### Authorization
|
|
427
|
+
|
|
428
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
429
|
+
|
|
430
|
+
### HTTP request headers
|
|
431
|
+
|
|
432
|
+
- **Content-Type**: application/json
|
|
433
|
+
- **Accept**: application/json
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
# **send_test_sms**
|
|
438
|
+
> send_test_sms(campaign_id, phone_number)
|
|
439
|
+
|
|
440
|
+
Send a test SMS campaign
|
|
441
|
+
|
|
442
|
+
### Example
|
|
443
|
+
```ruby
|
|
444
|
+
# load the gem
|
|
445
|
+
require 'brevo'
|
|
446
|
+
# setup authorization
|
|
447
|
+
Brevo.configure do |config|
|
|
448
|
+
# Configure API key authorization: api-key
|
|
449
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
450
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
451
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
452
|
+
|
|
453
|
+
# Configure API key authorization: partner-key
|
|
454
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
455
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
456
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
457
|
+
end
|
|
458
|
+
|
|
459
|
+
api_instance = Brevo::SMSCampaignsApi.new
|
|
460
|
+
|
|
461
|
+
campaign_id = 789 # Integer | Id of the SMS campaign
|
|
462
|
+
|
|
463
|
+
phone_number = Brevo::SendTestSms.new # SendTestSms | Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
begin
|
|
467
|
+
#Send a test SMS campaign
|
|
468
|
+
api_instance.send_test_sms(campaign_id, phone_number)
|
|
469
|
+
rescue Brevo::ApiError => e
|
|
470
|
+
puts "Exception when calling SMSCampaignsApi->send_test_sms: #{e}"
|
|
471
|
+
end
|
|
472
|
+
```
|
|
473
|
+
|
|
474
|
+
### Parameters
|
|
475
|
+
|
|
476
|
+
Name | Type | Description | Notes
|
|
477
|
+
------------- | ------------- | ------------- | -------------
|
|
478
|
+
**campaign_id** | **Integer**| Id of the SMS campaign |
|
|
479
|
+
**phone_number** | [**SendTestSms**](SendTestSms.md)| Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted |
|
|
480
|
+
|
|
481
|
+
### Return type
|
|
482
|
+
|
|
483
|
+
nil (empty response body)
|
|
484
|
+
|
|
485
|
+
### Authorization
|
|
486
|
+
|
|
487
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
488
|
+
|
|
489
|
+
### HTTP request headers
|
|
490
|
+
|
|
491
|
+
- **Content-Type**: application/json
|
|
492
|
+
- **Accept**: application/json
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
# **update_sms_campaign**
|
|
497
|
+
> update_sms_campaign(campaign_id, update_sms_campaign)
|
|
498
|
+
|
|
499
|
+
Update an SMS campaign
|
|
500
|
+
|
|
501
|
+
### Example
|
|
502
|
+
```ruby
|
|
503
|
+
# load the gem
|
|
504
|
+
require 'brevo'
|
|
505
|
+
# setup authorization
|
|
506
|
+
Brevo.configure do |config|
|
|
507
|
+
# Configure API key authorization: api-key
|
|
508
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
509
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
510
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
511
|
+
|
|
512
|
+
# Configure API key authorization: partner-key
|
|
513
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
514
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
515
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
516
|
+
end
|
|
517
|
+
|
|
518
|
+
api_instance = Brevo::SMSCampaignsApi.new
|
|
519
|
+
|
|
520
|
+
campaign_id = 789 # Integer | id of the SMS campaign
|
|
521
|
+
|
|
522
|
+
update_sms_campaign = Brevo::UpdateSmsCampaign.new # UpdateSmsCampaign | Values to update an SMS Campaign
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
begin
|
|
526
|
+
#Update an SMS campaign
|
|
527
|
+
api_instance.update_sms_campaign(campaign_id, update_sms_campaign)
|
|
528
|
+
rescue Brevo::ApiError => e
|
|
529
|
+
puts "Exception when calling SMSCampaignsApi->update_sms_campaign: #{e}"
|
|
530
|
+
end
|
|
531
|
+
```
|
|
532
|
+
|
|
533
|
+
### Parameters
|
|
534
|
+
|
|
535
|
+
Name | Type | Description | Notes
|
|
536
|
+
------------- | ------------- | ------------- | -------------
|
|
537
|
+
**campaign_id** | **Integer**| id of the SMS campaign |
|
|
538
|
+
**update_sms_campaign** | [**UpdateSmsCampaign**](UpdateSmsCampaign.md)| Values to update an SMS Campaign |
|
|
539
|
+
|
|
540
|
+
### Return type
|
|
541
|
+
|
|
542
|
+
nil (empty response body)
|
|
543
|
+
|
|
544
|
+
### Authorization
|
|
545
|
+
|
|
546
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
547
|
+
|
|
548
|
+
### HTTP request headers
|
|
549
|
+
|
|
550
|
+
- **Content-Type**: application/json
|
|
551
|
+
- **Accept**: application/json
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
# **update_sms_campaign_status**
|
|
556
|
+
> update_sms_campaign_status(campaign_id, status)
|
|
557
|
+
|
|
558
|
+
Update a campaign's status
|
|
559
|
+
|
|
560
|
+
### Example
|
|
561
|
+
```ruby
|
|
562
|
+
# load the gem
|
|
563
|
+
require 'brevo'
|
|
564
|
+
# setup authorization
|
|
565
|
+
Brevo.configure do |config|
|
|
566
|
+
# Configure API key authorization: api-key
|
|
567
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
568
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
569
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
570
|
+
|
|
571
|
+
# Configure API key authorization: partner-key
|
|
572
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
573
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
574
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
575
|
+
end
|
|
576
|
+
|
|
577
|
+
api_instance = Brevo::SMSCampaignsApi.new
|
|
578
|
+
|
|
579
|
+
campaign_id = 789 # Integer | id of the campaign
|
|
580
|
+
|
|
581
|
+
status = Brevo::UpdateCampaignStatus.new # UpdateCampaignStatus | Status of the campaign.
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
begin
|
|
585
|
+
#Update a campaign's status
|
|
586
|
+
api_instance.update_sms_campaign_status(campaign_id, status)
|
|
587
|
+
rescue Brevo::ApiError => e
|
|
588
|
+
puts "Exception when calling SMSCampaignsApi->update_sms_campaign_status: #{e}"
|
|
589
|
+
end
|
|
590
|
+
```
|
|
591
|
+
|
|
592
|
+
### Parameters
|
|
593
|
+
|
|
594
|
+
Name | Type | Description | Notes
|
|
595
|
+
------------- | ------------- | ------------- | -------------
|
|
596
|
+
**campaign_id** | **Integer**| id of the campaign |
|
|
597
|
+
**status** | [**UpdateCampaignStatus**](UpdateCampaignStatus.md)| Status of the campaign. |
|
|
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
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Brevo::ScheduleSmtpEmail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**message_id** | **String** | Message ID of the transactional email scheduled | [optional]
|
|
7
|
+
**message_ids** | **Array<String>** | | [optional]
|
|
8
|
+
**batch_id** | **String** | Batch ID of the batch transactional email scheduled | [optional]
|
|
9
|
+
|
|
10
|
+
|
data/docs/SendReport.md
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Brevo::SendReport
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**language** | **String** | Language of email content for campaign report sending. | [optional] [default to 'fr']
|
|
7
|
+
**email** | [**SendReportEmail**](SendReportEmail.md) | |
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Brevo::SendReportEmail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**to** | **Array<String>** | Email addresses of the recipients |
|
|
7
|
+
**body** | **String** | Custom text message to be presented in the report email. |
|
|
8
|
+
|
|
9
|
+
|
data/docs/SendSms.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Brevo::SendSms
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**reference** | **String** | |
|
|
7
|
+
**message_id** | **Integer** | |
|
|
8
|
+
**sms_count** | **Integer** | Count of SMS's to send multiple text messages | [optional]
|
|
9
|
+
**used_credits** | **Float** | SMS credits used per text message | [optional]
|
|
10
|
+
**remaining_credits** | **Float** | Remaining SMS credits of the user | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Brevo::SendSmtpEmail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional]
|
|
7
|
+
**to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] | [optional]
|
|
8
|
+
**bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
|
|
9
|
+
**cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
|
|
10
|
+
**html_content** | **String** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional]
|
|
11
|
+
**text_content** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional]
|
|
12
|
+
**subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
|
|
13
|
+
**reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
|
|
14
|
+
**attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass and xlsm ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
|
|
15
|
+
**headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\", \"idempotencyKey\":\"abc-123\"}`. | [optional]
|
|
16
|
+
**template_id** | **Integer** | Id of the template. | [optional]
|
|
17
|
+
**params** | **Object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional]
|
|
18
|
+
**message_versions** | [**Array<SendSmtpEmailMessageVersions>**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a mail. templateId can be customized only if global parameter contains templateId. htmlContent and textContent can be customized only if any of the two, htmlContent or textContent, is present in global parameters. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 2000. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.brevo.com/docs/batch-send-transactional-emails | [optional]
|
|
19
|
+
**tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
|
|
20
|
+
**scheduled_at** | **DateTime** | UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery. **Please note this feature is currently a public beta**. | [optional]
|
|
21
|
+
**batch_id** | **String** | Valid UUIDv4 batch id to identify the scheduled batches transactional email. If not passed we will create a valid UUIDv4 batch id at our end. | [optional]
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Brevo::SendSmtpEmailAttachment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**url** | **String** | Absolute url of the attachment (no local file). | [optional]
|
|
7
|
+
**content** | **String** | Base64 encoded chunk data of the attachment generated on the fly | [optional]
|
|
8
|
+
**name** | **String** | Required if content is passed. Name of the attachment | [optional]
|
|
9
|
+
|
|
10
|
+
|